f4263bff6a72ef9fc044bf89f779e50f8ab3c559
[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 .endlist
4652
4653 .ecindex IIDclo1
4654 .ecindex IIDclo2
4655
4656
4657 . ////////////////////////////////////////////////////////////////////////////
4658 . Insert a stylized DocBook comment here, to identify the end of the command
4659 . line options. This is for the benefit of the Perl script that automatically
4660 . creates a man page for the options.
4661 . ////////////////////////////////////////////////////////////////////////////
4662
4663 .literal xml
4664 <!-- === End of command line options === -->
4665 .literal off
4666
4667
4668
4669
4670
4671 . ////////////////////////////////////////////////////////////////////////////
4672 . ////////////////////////////////////////////////////////////////////////////
4673
4674
4675 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4676          "The runtime configuration file"
4677
4678 .cindex "run time configuration"
4679 .cindex "configuration file" "general description"
4680 .cindex "CONFIGURE_FILE"
4681 .cindex "configuration file" "errors in"
4682 .cindex "error" "in configuration file"
4683 .cindex "return code" "for bad configuration"
4684 Exim uses a single run time configuration file that is read whenever an Exim
4685 binary is executed. Note that in normal operation, this happens frequently,
4686 because Exim is designed to operate in a distributed manner, without central
4687 control.
4688
4689 If a syntax error is detected while reading the configuration file, Exim
4690 writes a message on the standard error, and exits with a non-zero return code.
4691 The message is also written to the panic log. &*Note*&: Only simple syntax
4692 errors can be detected at this time. The values of any expanded options are
4693 not checked until the expansion happens, even when the expansion does not
4694 actually alter the string.
4695
4696 The name of the configuration file is compiled into the binary for security
4697 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4698 most configurations, this specifies a single file. However, it is permitted to
4699 give a colon-separated list of file names, in which case Exim uses the first
4700 existing file in the list.
4701
4702 .cindex "EXIM_USER"
4703 .cindex "EXIM_GROUP"
4704 .cindex "CONFIGURE_OWNER"
4705 .cindex "CONFIGURE_GROUP"
4706 .cindex "configuration file" "ownership"
4707 .cindex "ownership" "configuration file"
4708 The run time configuration file must be owned by root or by the user that is
4709 specified at compile time by the CONFIGURE_OWNER option (if set). The
4710 configuration file must not be world-writeable, or group-writeable unless its
4711 group is the root group or the one specified at compile time by the
4712 CONFIGURE_GROUP option.
4713
4714 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4715 to root, anybody who is able to edit the run time configuration file has an
4716 easy way to run commands as root. If you specify a user or group in the
4717 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4718 who are members of that group will trivially be able to obtain root privileges.
4719
4720 Up to Exim version 4.72, the run time configuration file was also permitted to
4721 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4722 since it offered a simple privilege escalation for any attacker who managed to
4723 compromise the Exim user account.
4724
4725 A default configuration file, which will work correctly in simple situations,
4726 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4727 defines just one file name, the installation process copies the default
4728 configuration to a new file of that name if it did not previously exist. If
4729 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4730 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4731 configuration.
4732
4733
4734
4735 .section "Using a different configuration file" "SECID40"
4736 .cindex "configuration file" "alternate"
4737 A one-off alternate configuration can be specified by the &%-C%& command line
4738 option, which may specify a single file or a list of files. However, when
4739 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4740 unless the argument for &%-C%& is identical to the built-in value from
4741 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4742 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4743 is useful mainly for checking the syntax of configuration files before
4744 installing them. No owner or group checks are done on a configuration file
4745 specified by &%-C%&, if root privilege has been dropped.
4746
4747 Even the Exim user is not trusted to specify an arbitrary configuration file
4748 with the &%-C%& option to be used with root privileges, unless that file is
4749 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4750 testing a configuration using &%-C%& right through message reception and
4751 delivery, even if the caller is root. The reception works, but by that time,
4752 Exim is running as the Exim user, so when it re-execs to regain privilege for
4753 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4754 can test reception and delivery using two separate commands (one to put a
4755 message on the queue, using &%-odq%&, and another to do the delivery, using
4756 &%-M%&).
4757
4758 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4759 prefix string with which any file named in a &%-C%& command line option must
4760 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4761 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4762 name can be used with &%-C%&.
4763
4764 One-off changes to a configuration can be specified by the &%-D%& command line
4765 option, which defines and overrides values for macros used inside the
4766 configuration file. However, like &%-C%&, the use of this option by a
4767 non-privileged user causes Exim to discard its root privilege.
4768 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4769 completely disabled, and its use causes an immediate error exit.
4770
4771 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4772 to declare certain macro names trusted, such that root privilege will not
4773 necessarily be discarded.
4774 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4775 considered safe and, if &%-D%& only supplies macros from this list, and the
4776 values are acceptable, then Exim will not give up root privilege if the caller
4777 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4778 transition mechanism and is expected to be removed in the future.  Acceptable
4779 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4780
4781 Some sites may wish to use the same Exim binary on different machines that
4782 share a file system, but to use different configuration files on each machine.
4783 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4784 looks for a file whose name is the configuration file name followed by a dot
4785 and the machine's node name, as obtained from the &[uname()]& function. If this
4786 file does not exist, the standard name is tried. This processing occurs for
4787 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4788
4789 In some esoteric situations different versions of Exim may be run under
4790 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4791 help with this. See the comments in &_src/EDITME_& for details.
4792
4793
4794
4795 .section "Configuration file format" "SECTconffilfor"
4796 .cindex "configuration file" "format of"
4797 .cindex "format" "configuration file"
4798 Exim's configuration file is divided into a number of different parts. General
4799 option settings must always appear at the start of the file. The other parts
4800 are all optional, and may appear in any order. Each part other than the first
4801 is introduced by the word &"begin"& followed by the name of the part. The
4802 optional parts are:
4803
4804 .ilist
4805 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4806 &<<CHAPACL>>&).
4807 .next
4808 .cindex "AUTH" "configuration"
4809 &'authenticators'&: Configuration settings for the authenticator drivers. These
4810 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4811 .next
4812 &'routers'&: Configuration settings for the router drivers. Routers process
4813 addresses and determine how the message is to be delivered (see chapters
4814 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4815 .next
4816 &'transports'&: Configuration settings for the transport drivers. Transports
4817 define mechanisms for copying messages to destinations (see chapters
4818 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4819 .next
4820 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4821 If there is no retry section, or if it is empty (that is, no retry rules are
4822 defined), Exim will not retry deliveries. In this situation, temporary errors
4823 are treated the same as permanent errors. Retry rules are discussed in chapter
4824 &<<CHAPretry>>&.
4825 .next
4826 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4827 when new addresses are generated during delivery. Rewriting is discussed in
4828 chapter &<<CHAPrewrite>>&.
4829 .next
4830 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4831 want to use this feature, you must set
4832 .code
4833 LOCAL_SCAN_HAS_OPTIONS=yes
4834 .endd
4835 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4836 facility are given in chapter &<<CHAPlocalscan>>&.
4837 .endlist
4838
4839 .cindex "configuration file" "leading white space in"
4840 .cindex "configuration file" "trailing white space in"
4841 .cindex "white space" "in configuration file"
4842 Leading and trailing white space in configuration lines is always ignored.
4843
4844 Blank lines in the file, and lines starting with a # character (ignoring
4845 leading white space) are treated as comments and are ignored. &*Note*&: A
4846 # character other than at the beginning of a line is not treated specially,
4847 and does not introduce a comment.
4848
4849 Any non-comment line can be continued by ending it with a backslash. Note that
4850 the general rule for white space means that trailing white space after the
4851 backslash and leading white space at the start of continuation
4852 lines is ignored. Comment lines beginning with # (but not empty lines) may
4853 appear in the middle of a sequence of continuation lines.
4854
4855 A convenient way to create a configuration file is to start from the
4856 default, which is supplied in &_src/configure.default_&, and add, delete, or
4857 change settings as required.
4858
4859 The ACLs, retry rules, and rewriting rules have their own syntax which is
4860 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4861 respectively. The other parts of the configuration file have some syntactic
4862 items in common, and these are described below, from section &<<SECTcos>>&
4863 onwards. Before that, the inclusion, macro, and conditional facilities are
4864 described.
4865
4866
4867
4868 .section "File inclusions in the configuration file" "SECID41"
4869 .cindex "inclusions in configuration file"
4870 .cindex "configuration file" "including other files"
4871 .cindex "&`.include`& in configuration file"
4872 .cindex "&`.include_if_exists`& in configuration file"
4873 You can include other files inside Exim's run time configuration file by
4874 using this syntax:
4875 .display
4876 &`.include`& <&'file name'&>
4877 &`.include_if_exists`& <&'file name'&>
4878 .endd
4879 on a line by itself. Double quotes round the file name are optional. If you use
4880 the first form, a configuration error occurs if the file does not exist; the
4881 second form does nothing for non-existent files. In all cases, an absolute file
4882 name is required.
4883
4884 Includes may be nested to any depth, but remember that Exim reads its
4885 configuration file often, so it is a good idea to keep them to a minimum.
4886 If you change the contents of an included file, you must HUP the daemon,
4887 because an included file is read only when the configuration itself is read.
4888
4889 The processing of inclusions happens early, at a physical line level, so, like
4890 comment lines, an inclusion can be used in the middle of an option setting,
4891 for example:
4892 .code
4893 hosts_lookup = a.b.c \
4894                .include /some/file
4895 .endd
4896 Include processing happens after macro processing (see below). Its effect is to
4897 process the lines of the included file as if they occurred inline where the
4898 inclusion appears.
4899
4900
4901
4902 .section "Macros in the configuration file" "SECTmacrodefs"
4903 .cindex "macro" "description of"
4904 .cindex "configuration file" "macros"
4905 If a line in the main part of the configuration (that is, before the first
4906 &"begin"& line) begins with an upper case letter, it is taken as a macro
4907 definition, and must be of the form
4908 .display
4909 <&'name'&> = <&'rest of line'&>
4910 .endd
4911 The name must consist of letters, digits, and underscores, and need not all be
4912 in upper case, though that is recommended. The rest of the line, including any
4913 continuations, is the replacement text, and has leading and trailing white
4914 space removed. Quotes are not removed. The replacement text can never end with
4915 a backslash character, but this doesn't seem to be a serious limitation.
4916
4917 Macros may also be defined between router, transport, authenticator, or ACL
4918 definitions. They may not, however, be defined within an individual driver or
4919 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4920
4921 .section "Macro substitution" "SECID42"
4922 Once a macro is defined, all subsequent lines in the file (and any included
4923 files) are scanned for the macro name; if there are several macros, the line is
4924 scanned for each in turn, in the order in which the macros are defined. The
4925 replacement text is not re-scanned for the current macro, though it is scanned
4926 for subsequently defined macros. For this reason, a macro name may not contain
4927 the name of a previously defined macro as a substring. You could, for example,
4928 define
4929 .display
4930 &`ABCD_XYZ = `&<&'something'&>
4931 &`ABCD = `&<&'something else'&>
4932 .endd
4933 but putting the definitions in the opposite order would provoke a configuration
4934 error. Macro expansion is applied to individual physical lines from the file,
4935 before checking for line continuation or file inclusion (see above). If a line
4936 consists solely of a macro name, and the expansion of the macro is empty, the
4937 line is ignored. A macro at the start of a line may turn the line into a
4938 comment line or a &`.include`& line.
4939
4940
4941 .section "Redefining macros" "SECID43"
4942 Once defined, the value of a macro can be redefined later in the configuration
4943 (or in an included file). Redefinition is specified by using &'=='& instead of
4944 &'='&. For example:
4945 .code
4946 MAC =  initial value
4947 ...
4948 MAC == updated value
4949 .endd
4950 Redefinition does not alter the order in which the macros are applied to the
4951 subsequent lines of the configuration file. It is still the same order in which
4952 the macros were originally defined. All that changes is the macro's value.
4953 Redefinition makes it possible to accumulate values. For example:
4954 .code
4955 MAC =  initial value
4956 ...
4957 MAC == MAC and something added
4958 .endd
4959 This can be helpful in situations where the configuration file is built
4960 from a number of other files.
4961
4962 .section "Overriding macro values" "SECID44"
4963 The values set for macros in the configuration file can be overridden by the
4964 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4965 used, unless called by root or the Exim user. A definition on the command line
4966 using the &%-D%& option causes all definitions and redefinitions within the
4967 file to be ignored.
4968
4969
4970
4971 .section "Example of macro usage" "SECID45"
4972 As an example of macro usage, consider a configuration where aliases are looked
4973 up in a MySQL database. It helps to keep the file less cluttered if long
4974 strings such as SQL statements are defined separately as macros, for example:
4975 .code
4976 ALIAS_QUERY = select mailbox from user where \
4977               login='${quote_mysql:$local_part}';
4978 .endd
4979 This can then be used in a &(redirect)& router setting like this:
4980 .code
4981 data = ${lookup mysql{ALIAS_QUERY}}
4982 .endd
4983 In earlier versions of Exim macros were sometimes used for domain, host, or
4984 address lists. In Exim 4 these are handled better by named lists &-- see
4985 section &<<SECTnamedlists>>&.
4986
4987
4988 .section "Conditional skips in the configuration file" "SECID46"
4989 .cindex "configuration file" "conditional skips"
4990 .cindex "&`.ifdef`&"
4991 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4992 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4993 portions of the configuration file. The processing happens whenever the file is
4994 read (that is, when an Exim binary starts to run).
4995
4996 The implementation is very simple. Instances of the first four directives must
4997 be followed by text that includes the names of one or macros. The condition
4998 that is tested is whether or not any macro substitution has taken place in the
4999 line. Thus:
5000 .code
5001 .ifdef AAA
5002 message_size_limit = 50M
5003 .else
5004 message_size_limit = 100M
5005 .endif
5006 .endd
5007 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5008 otherwise. If there is more than one macro named on the line, the condition
5009 is true if any of them are defined. That is, it is an &"or"& condition. To
5010 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5011
5012 Although you can use a macro expansion to generate one of these directives,
5013 it is not very useful, because the condition &"there was a macro substitution
5014 in this line"& will always be true.
5015
5016 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5017 to clarify complicated nestings.
5018
5019
5020
5021 .section "Common option syntax" "SECTcos"
5022 .cindex "common option syntax"
5023 .cindex "syntax of common options"
5024 .cindex "configuration file" "common option syntax"
5025 For the main set of options, driver options, and &[local_scan()]& options,
5026 each setting is on a line by itself, and starts with a name consisting of
5027 lower-case letters and underscores. Many options require a data value, and in
5028 these cases the name must be followed by an equals sign (with optional white
5029 space) and then the value. For example:
5030 .code
5031 qualify_domain = mydomain.example.com
5032 .endd
5033 .cindex "hiding configuration option values"
5034 .cindex "configuration options" "hiding value of"
5035 .cindex "options" "hiding value of"
5036 Some option settings may contain sensitive data, for example, passwords for
5037 accessing databases. To stop non-admin users from using the &%-bP%& command
5038 line option to read these values, you can precede the option settings with the
5039 word &"hide"&. For example:
5040 .code
5041 hide mysql_servers = localhost/users/admin/secret-password
5042 .endd
5043 For non-admin users, such options are displayed like this:
5044 .code
5045 mysql_servers = <value not displayable>
5046 .endd
5047 If &"hide"& is used on a driver option, it hides the value of that option on
5048 all instances of the same driver.
5049
5050 The following sections describe the syntax used for the different data types
5051 that are found in option settings.
5052
5053
5054 .section "Boolean options" "SECID47"
5055 .cindex "format" "boolean"
5056 .cindex "boolean configuration values"
5057 .oindex "&%no_%&&'xxx'&"
5058 .oindex "&%not_%&&'xxx'&"
5059 Options whose type is given as boolean are on/off switches. There are two
5060 different ways of specifying such options: with and without a data value. If
5061 the option name is specified on its own without data, the switch is turned on;
5062 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5063 boolean options may be followed by an equals sign and one of the words
5064 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5065 the following two settings have exactly the same effect:
5066 .code
5067 queue_only
5068 queue_only = true
5069 .endd
5070 The following two lines also have the same (opposite) effect:
5071 .code
5072 no_queue_only
5073 queue_only = false
5074 .endd
5075 You can use whichever syntax you prefer.
5076
5077
5078
5079
5080 .section "Integer values" "SECID48"
5081 .cindex "integer configuration values"
5082 .cindex "format" "integer"
5083 If an option's type is given as &"integer"&, the value can be given in decimal,
5084 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5085 number is assumed. Otherwise, it is treated as an octal number unless it starts
5086 with the characters &"0x"&, in which case the remainder is interpreted as a
5087 hexadecimal number.
5088
5089 If an integer value is followed by the letter K, it is multiplied by 1024; if
5090 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5091 of integer option settings are output, values which are an exact multiple of
5092 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5093 and M. The printing style is independent of the actual input format that was
5094 used.
5095
5096
5097 .section "Octal integer values" "SECID49"
5098 .cindex "integer format"
5099 .cindex "format" "octal integer"
5100 If an option's type is given as &"octal integer"&, its value is always
5101 interpreted as an octal number, whether or not it starts with the digit zero.
5102 Such options are always output in octal.
5103
5104
5105 .section "Fixed point numbers" "SECID50"
5106 .cindex "fixed point configuration values"
5107 .cindex "format" "fixed point"
5108 If an option's type is given as &"fixed-point"&, its value must be a decimal
5109 integer, optionally followed by a decimal point and up to three further digits.
5110
5111
5112
5113 .section "Time intervals" "SECTtimeformat"
5114 .cindex "time interval" "specifying in configuration"
5115 .cindex "format" "time interval"
5116 A time interval is specified as a sequence of numbers, each followed by one of
5117 the following letters, with no intervening white space:
5118
5119 .table2 30pt
5120 .irow &%s%& seconds
5121 .irow &%m%& minutes
5122 .irow &%h%& hours
5123 .irow &%d%& days
5124 .irow &%w%& weeks
5125 .endtable
5126
5127 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5128 intervals are output in the same format. Exim does not restrict the values; it
5129 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5130
5131
5132
5133 .section "String values" "SECTstrings"
5134 .cindex "string" "format of configuration values"
5135 .cindex "format" "string"
5136 If an option's type is specified as &"string"&, the value can be specified with
5137 or without double-quotes. If it does not start with a double-quote, the value
5138 consists of the remainder of the line plus any continuation lines, starting at
5139 the first character after any leading white space, with trailing white space
5140 removed, and with no interpretation of the characters in the string. Because
5141 Exim removes comment lines (those beginning with #) at an early stage, they can
5142 appear in the middle of a multi-line string. The following two settings are
5143 therefore equivalent:
5144 .code
5145 trusted_users = uucp:mail
5146 trusted_users = uucp:\
5147                 # This comment line is ignored
5148                 mail
5149 .endd
5150 .cindex "string" "quoted"
5151 .cindex "escape characters in quoted strings"
5152 If a string does start with a double-quote, it must end with a closing
5153 double-quote, and any backslash characters other than those used for line
5154 continuation are interpreted as escape characters, as follows:
5155
5156 .table2 100pt
5157 .irow &`\\`&                     "single backslash"
5158 .irow &`\n`&                     "newline"
5159 .irow &`\r`&                     "carriage return"
5160 .irow &`\t`&                     "tab"
5161 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5162 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5163                                    character"
5164 .endtable
5165
5166 If a backslash is followed by some other character, including a double-quote
5167 character, that character replaces the pair.
5168
5169 Quoting is necessary only if you want to make use of the backslash escapes to
5170 insert special characters, or if you need to specify a value with leading or
5171 trailing spaces. These cases are rare, so quoting is almost never needed in
5172 current versions of Exim. In versions of Exim before 3.14, quoting was required
5173 in order to continue lines, so you may come across older configuration files
5174 and examples that apparently quote unnecessarily.
5175
5176
5177 .section "Expanded strings" "SECID51"
5178 .cindex "expansion" "definition of"
5179 Some strings in the configuration file are subjected to &'string expansion'&,
5180 by which means various parts of the string may be changed according to the
5181 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5182 is as just described; in particular, the handling of backslashes in quoted
5183 strings is done as part of the input process, before expansion takes place.
5184 However, backslash is also an escape character for the expander, so any
5185 backslashes that are required for that reason must be doubled if they are
5186 within a quoted configuration string.
5187
5188
5189 .section "User and group names" "SECID52"
5190 .cindex "user name" "format of"
5191 .cindex "format" "user name"
5192 .cindex "groups" "name format"
5193 .cindex "format" "group name"
5194 User and group names are specified as strings, using the syntax described
5195 above, but the strings are interpreted specially. A user or group name must
5196 either consist entirely of digits, or be a name that can be looked up using the
5197 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5198
5199
5200 .section "List construction" "SECTlistconstruct"
5201 .cindex "list" "syntax of in configuration"
5202 .cindex "format" "list item in configuration"
5203 .cindex "string" "list, definition of"
5204 The data for some configuration options is a list of items, with colon as the
5205 default separator. Many of these options are shown with type &"string list"& in
5206 the descriptions later in this document. Others are listed as &"domain list"&,
5207 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5208 are all the same; however, those other than &"string list"& are subject to
5209 particular kinds of interpretation, as described in chapter
5210 &<<CHAPdomhosaddlists>>&.
5211
5212 In all these cases, the entire list is treated as a single string as far as the
5213 input syntax is concerned. The &%trusted_users%& setting in section
5214 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5215 in a list, it must be entered as two colons. Leading and trailing white space
5216 on each item in a list is ignored. This makes it possible to include items that
5217 start with a colon, and in particular, certain forms of IPv6 address. For
5218 example, the list
5219 .code
5220 local_interfaces = 127.0.0.1 : ::::1
5221 .endd
5222 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5223
5224 &*Note*&: Although leading and trailing white space is ignored in individual
5225 list items, it is not ignored when parsing the list. The space after the first
5226 colon in the example above is necessary. If it were not there, the list would
5227 be interpreted as the two items 127.0.0.1:: and 1.
5228
5229 .section "Changing list separators" "SECID53"
5230 .cindex "list separator" "changing"
5231 .cindex "IPv6" "addresses in lists"
5232 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5233 introduced to allow the separator character to be changed. If a list begins
5234 with a left angle bracket, followed by any punctuation character, that
5235 character is used instead of colon as the list separator. For example, the list
5236 above can be rewritten to use a semicolon separator like this:
5237 .code
5238 local_interfaces = <; 127.0.0.1 ; ::1
5239 .endd
5240 This facility applies to all lists, with the exception of the list in
5241 &%log_file_path%&. It is recommended that the use of non-colon separators be
5242 confined to circumstances where they really are needed.
5243
5244 .cindex "list separator" "newline as"
5245 .cindex "newline" "as list separator"
5246 It is also possible to use newline and other control characters (those with
5247 code values less than 32, plus DEL) as separators in lists. Such separators
5248 must be provided literally at the time the list is processed. For options that
5249 are string-expanded, you can write the separator using a normal escape
5250 sequence. This will be processed by the expander before the string is
5251 interpreted as a list. For example, if a newline-separated list of domains is
5252 generated by a lookup, you can process it directly by a line such as this:
5253 .code
5254 domains = <\n ${lookup mysql{.....}}
5255 .endd
5256 This avoids having to change the list separator in such data. You are unlikely
5257 to want to use a control character as a separator in an option that is not
5258 expanded, because the value is literal text. However, it can be done by giving
5259 the value in quotes. For example:
5260 .code
5261 local_interfaces = "<\n 127.0.0.1 \n ::1"
5262 .endd
5263 Unlike printing character separators, which can be included in list items by
5264 doubling, it is not possible to include a control character as data when it is
5265 set as the separator. Two such characters in succession are interpreted as
5266 enclosing an empty list item.
5267
5268
5269
5270 .section "Empty items in lists" "SECTempitelis"
5271 .cindex "list" "empty item in"
5272 An empty item at the end of a list is always ignored. In other words, trailing
5273 separator characters are ignored. Thus, the list in
5274 .code
5275 senders = user@domain :
5276 .endd
5277 contains only a single item. If you want to include an empty string as one item
5278 in a list, it must not be the last item. For example, this list contains three
5279 items, the second of which is empty:
5280 .code
5281 senders = user1@domain : : user2@domain
5282 .endd
5283 &*Note*&: There must be white space between the two colons, as otherwise they
5284 are interpreted as representing a single colon data character (and the list
5285 would then contain just one item). If you want to specify a list that contains
5286 just one, empty item, you can do it as in this example:
5287 .code
5288 senders = :
5289 .endd
5290 In this case, the first item is empty, and the second is discarded because it
5291 is at the end of the list.
5292
5293
5294
5295
5296 .section "Format of driver configurations" "SECTfordricon"
5297 .cindex "drivers" "configuration format"
5298 There are separate parts in the configuration for defining routers, transports,
5299 and authenticators. In each part, you are defining a number of driver
5300 instances, each with its own set of options. Each driver instance is defined by
5301 a sequence of lines like this:
5302 .display
5303 <&'instance name'&>:
5304   <&'option'&>
5305   ...
5306   <&'option'&>
5307 .endd
5308 In the following example, the instance name is &(localuser)&, and it is
5309 followed by three options settings:
5310 .code
5311 localuser:
5312   driver = accept
5313   check_local_user
5314   transport = local_delivery
5315 .endd
5316 For each driver instance, you specify which Exim code module it uses &-- by the
5317 setting of the &%driver%& option &-- and (optionally) some configuration
5318 settings. For example, in the case of transports, if you want a transport to
5319 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5320 a local file you would use the &(appendfile)& driver. Each of the drivers is
5321 described in detail in its own separate chapter later in this manual.
5322
5323 You can have several routers, transports, or authenticators that are based on
5324 the same underlying driver (each must have a different instance name).
5325
5326 The order in which routers are defined is important, because addresses are
5327 passed to individual routers one by one, in order. The order in which
5328 transports are defined does not matter at all. The order in which
5329 authenticators are defined is used only when Exim, as a client, is searching
5330 them to find one that matches an authentication mechanism offered by the
5331 server.
5332
5333 .cindex "generic options"
5334 .cindex "options" "generic &-- definition of"
5335 Within a driver instance definition, there are two kinds of option: &'generic'&
5336 and &'private'&. The generic options are those that apply to all drivers of the
5337 same type (that is, all routers, all transports or all authenticators). The
5338 &%driver%& option is a generic option that must appear in every definition.
5339 .cindex "private options"
5340 The private options are special for each driver, and none need appear, because
5341 they all have default values.
5342
5343 The options may appear in any order, except that the &%driver%& option must
5344 precede any private options, since these depend on the particular driver. For
5345 this reason, it is recommended that &%driver%& always be the first option.
5346
5347 Driver instance names, which are used for reference in log entries and
5348 elsewhere, can be any sequence of letters, digits, and underscores (starting
5349 with a letter) and must be unique among drivers of the same type. A router and
5350 a transport (for example) can each have the same name, but no two router
5351 instances can have the same name. The name of a driver instance should not be
5352 confused with the name of the underlying driver module. For example, the
5353 configuration lines:
5354 .code
5355 remote_smtp:
5356   driver = smtp
5357 .endd
5358 create an instance of the &(smtp)& transport driver whose name is
5359 &(remote_smtp)&. The same driver code can be used more than once, with
5360 different instance names and different option settings each time. A second
5361 instance of the &(smtp)& transport, with different options, might be defined
5362 thus:
5363 .code
5364 special_smtp:
5365   driver = smtp
5366   port = 1234
5367   command_timeout = 10s
5368 .endd
5369 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5370 these transport instances from routers, and these names would appear in log
5371 lines.
5372
5373 Comment lines may be present in the middle of driver specifications. The full
5374 list of option settings for any particular driver instance, including all the
5375 defaulted values, can be extracted by making use of the &%-bP%& command line
5376 option.
5377
5378
5379
5380
5381
5382
5383 . ////////////////////////////////////////////////////////////////////////////
5384 . ////////////////////////////////////////////////////////////////////////////
5385
5386 .chapter "The default configuration file" "CHAPdefconfil"
5387 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5388 .cindex "default" "configuration file &""walk through""&"
5389 The default configuration file supplied with Exim as &_src/configure.default_&
5390 is sufficient for a host with simple mail requirements. As an introduction to
5391 the way Exim is configured, this chapter &"walks through"& the default
5392 configuration, giving brief explanations of the settings. Detailed descriptions
5393 of the options are given in subsequent chapters. The default configuration file
5394 itself contains extensive comments about ways you might want to modify the
5395 initial settings. However, note that there are many options that are not
5396 mentioned at all in the default configuration.
5397
5398
5399
5400 .section "Main configuration settings" "SECTdefconfmain"
5401 The main (global) configuration option settings must always come first in the
5402 file. The first thing you'll see in the file, after some initial comments, is
5403 the line
5404 .code
5405 # primary_hostname =
5406 .endd
5407 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5408 to know the official, fully qualified name of your host, and this is where you
5409 can specify it. However, in most cases you do not need to set this option. When
5410 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5411
5412 The first three non-comment configuration lines are as follows:
5413 .code
5414 domainlist local_domains    = @
5415 domainlist relay_to_domains =
5416 hostlist   relay_from_hosts = 127.0.0.1
5417 .endd
5418 These are not, in fact, option settings. They are definitions of two named
5419 domain lists and one named host list. Exim allows you to give names to lists of
5420 domains, hosts, and email addresses, in order to make it easier to manage the
5421 configuration file (see section &<<SECTnamedlists>>&).
5422
5423 The first line defines a domain list called &'local_domains'&; this is used
5424 later in the configuration to identify domains that are to be delivered
5425 on the local host.
5426
5427 .cindex "@ in a domain list"
5428 There is just one item in this list, the string &"@"&. This is a special form
5429 of entry which means &"the name of the local host"&. Thus, if the local host is
5430 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5431 be delivered locally. Because the local host's name is referenced indirectly,
5432 the same configuration file can be used on different hosts.
5433
5434 The second line defines a domain list called &'relay_to_domains'&, but the
5435 list itself is empty. Later in the configuration we will come to the part that
5436 controls mail relaying through the local host; it allows relaying to any
5437 domains in this list. By default, therefore, no relaying on the basis of a mail
5438 domain is permitted.
5439
5440 The third line defines a host list called &'relay_from_hosts'&. This list is
5441 used later in the configuration to permit relaying from any host or IP address
5442 that matches the list. The default contains just the IP address of the IPv4
5443 loopback interface, which means that processes on the local host are able to
5444 submit mail for relaying by sending it over TCP/IP to that interface. No other
5445 hosts are permitted to submit messages for relaying.
5446
5447 Just to be sure there's no misunderstanding: at this point in the configuration
5448 we aren't actually setting up any controls. We are just defining some domains
5449 and hosts that will be used in the controls that are specified later.
5450
5451 The next two configuration lines are genuine option settings:
5452 .code
5453 acl_smtp_rcpt = acl_check_rcpt
5454 acl_smtp_data = acl_check_data
5455 .endd
5456 These options specify &'Access Control Lists'& (ACLs) that are to be used
5457 during an incoming SMTP session for every recipient of a message (every RCPT
5458 command), and after the contents of the message have been received,
5459 respectively. The names of the lists are &'acl_check_rcpt'& and
5460 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5461 section of the configuration. The RCPT ACL controls which recipients are
5462 accepted for an incoming message &-- if a configuration does not provide an ACL
5463 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5464 contents of a message to be checked.
5465
5466 Two commented-out option settings are next:
5467 .code
5468 # av_scanner = clamd:/tmp/clamd
5469 # spamd_address = 127.0.0.1 783
5470 .endd
5471 These are example settings that can be used when Exim is compiled with the
5472 content-scanning extension. The first specifies the interface to the virus
5473 scanner, and the second specifies the interface to SpamAssassin. Further
5474 details are given in chapter &<<CHAPexiscan>>&.
5475
5476 Three more commented-out option settings follow:
5477 .code
5478 # tls_advertise_hosts = *
5479 # tls_certificate = /etc/ssl/exim.crt
5480 # tls_privatekey = /etc/ssl/exim.pem
5481 .endd
5482 These are example settings that can be used when Exim is compiled with
5483 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5484 first one specifies the list of clients that are allowed to use TLS when
5485 connecting to this server; in this case the wildcard means all clients. The
5486 other options specify where Exim should find its TLS certificate and private
5487 key, which together prove the server's identity to any clients that connect.
5488 More details are given in chapter &<<CHAPTLS>>&.
5489
5490 Another two commented-out option settings follow:
5491 .code
5492 # daemon_smtp_ports = 25 : 465 : 587
5493 # tls_on_connect_ports = 465
5494 .endd
5495 .cindex "port" "465 and 587"
5496 .cindex "port" "for message submission"
5497 .cindex "message" "submission, ports for"
5498 .cindex "ssmtp protocol"
5499 .cindex "smtps protocol"
5500 .cindex "SMTP" "ssmtp protocol"
5501 .cindex "SMTP" "smtps protocol"
5502 These options provide better support for roaming users who wish to use this
5503 server for message submission. They are not much use unless you have turned on
5504 TLS (as described in the previous paragraph) and authentication (about which
5505 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5506 on end-user networks, so RFC 4409 specifies that message submission should use
5507 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5508 configured to use port 587 correctly, so these settings also enable the
5509 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5510 &<<SECTsupobssmt>>&).
5511
5512 Two more commented-out options settings follow:
5513 .code
5514 # qualify_domain =
5515 # qualify_recipient =
5516 .endd
5517 The first of these specifies a domain that Exim uses when it constructs a
5518 complete email address from a local login name. This is often needed when Exim
5519 receives a message from a local process. If you do not set &%qualify_domain%&,
5520 the value of &%primary_hostname%& is used. If you set both of these options,
5521 you can have different qualification domains for sender and recipient
5522 addresses. If you set only the first one, its value is used in both cases.
5523
5524 .cindex "domain literal" "recognizing format"
5525 The following line must be uncommented if you want Exim to recognize
5526 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5527 (an IP address within square brackets) instead of a named domain.
5528 .code
5529 # allow_domain_literals
5530 .endd
5531 The RFCs still require this form, but many people think that in the modern
5532 Internet it makes little sense to permit mail to be sent to specific hosts by
5533 quoting their IP addresses. This ancient format has been used by people who
5534 try to abuse hosts by using them for unwanted relaying. However, some
5535 people believe there are circumstances (for example, messages addressed to
5536 &'postmaster'&) where domain literals are still useful.
5537
5538 The next configuration line is a kind of trigger guard:
5539 .code
5540 never_users = root
5541 .endd
5542 It specifies that no delivery must ever be run as the root user. The normal
5543 convention is to set up &'root'& as an alias for the system administrator. This
5544 setting is a guard against slips in the configuration.
5545 The list of users specified by &%never_users%& is not, however, the complete
5546 list; the build-time configuration in &_Local/Makefile_& has an option called
5547 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5548 contents of &%never_users%& are added to this list. By default
5549 FIXED_NEVER_USERS also specifies root.
5550
5551 When a remote host connects to Exim in order to send mail, the only information
5552 Exim has about the host's identity is its IP address. The next configuration
5553 line,
5554 .code
5555 host_lookup = *
5556 .endd
5557 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5558 in order to get a host name. This improves the quality of the logging
5559 information, but if you feel it is too expensive, you can remove it entirely,
5560 or restrict the lookup to hosts on &"nearby"& networks.
5561 Note that it is not always possible to find a host name from an IP address,
5562 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5563 unreachable.
5564
5565 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5566 1413 (hence their names):
5567 .code
5568 rfc1413_hosts = *
5569 rfc1413_query_timeout = 0s
5570 .endd
5571 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5572 Few hosts offer RFC1413 service these days; calls have to be
5573 terminated by a timeout and this needlessly delays the startup
5574 of an incoming SMTP connection.
5575 If you have hosts for which you trust RFC1413 and need this
5576 information, you can change this.
5577
5578 This line enables an efficiency SMTP option.  It is negotiated by clients
5579 and not expected to cause problems but can be disabled if needed.
5580 .code
5581 prdr_enable = true
5582 .endd
5583
5584 When Exim receives messages over SMTP connections, it expects all addresses to
5585 be fully qualified with a domain, as required by the SMTP definition. However,
5586 if you are running a server to which simple clients submit messages, you may
5587 find that they send unqualified addresses. The two commented-out options:
5588 .code
5589 # sender_unqualified_hosts =
5590 # recipient_unqualified_hosts =
5591 .endd
5592 show how you can specify hosts that are permitted to send unqualified sender
5593 and recipient addresses, respectively.
5594
5595 The &%percent_hack_domains%& option is also commented out:
5596 .code
5597 # percent_hack_domains =
5598 .endd
5599 It provides a list of domains for which the &"percent hack"& is to operate.
5600 This is an almost obsolete form of explicit email routing. If you do not know
5601 anything about it, you can safely ignore this topic.
5602
5603 The last two settings in the main part of the default configuration are
5604 concerned with messages that have been &"frozen"& on Exim's queue. When a
5605 message is frozen, Exim no longer continues to try to deliver it. Freezing
5606 occurs when a bounce message encounters a permanent failure because the sender
5607 address of the original message that caused the bounce is invalid, so the
5608 bounce cannot be delivered. This is probably the most common case, but there
5609 are also other conditions that cause freezing, and frozen messages are not
5610 always bounce messages.
5611 .code
5612 ignore_bounce_errors_after = 2d
5613 timeout_frozen_after = 7d
5614 .endd
5615 The first of these options specifies that failing bounce messages are to be
5616 discarded after 2 days on the queue. The second specifies that any frozen
5617 message (whether a bounce message or not) is to be timed out (and discarded)
5618 after a week. In this configuration, the first setting ensures that no failing
5619 bounce message ever lasts a week.
5620
5621
5622
5623 .section "ACL configuration" "SECID54"
5624 .cindex "default" "ACLs"
5625 .cindex "&ACL;" "default configuration"
5626 In the default configuration, the ACL section follows the main configuration.
5627 It starts with the line
5628 .code
5629 begin acl
5630 .endd
5631 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5632 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5633 and &%acl_smtp_data%& above.
5634
5635 .cindex "RCPT" "ACL for"
5636 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5637 RCPT command specifies one of the message's recipients. The ACL statements
5638 are considered in order, until the recipient address is either accepted or
5639 rejected. The RCPT command is then accepted or rejected, according to the
5640 result of the ACL processing.
5641 .code
5642 acl_check_rcpt:
5643 .endd
5644 This line, consisting of a name terminated by a colon, marks the start of the
5645 ACL, and names it.
5646 .code
5647 accept  hosts = :
5648 .endd
5649 This ACL statement accepts the recipient if the sending host matches the list.
5650 But what does that strange list mean? It doesn't actually contain any host
5651 names or IP addresses. The presence of the colon puts an empty item in the
5652 list; Exim matches this only if the incoming message did not come from a remote
5653 host, because in that case, the remote hostname is empty. The colon is
5654 important. Without it, the list itself is empty, and can never match anything.
5655
5656 What this statement is doing is to accept unconditionally all recipients in
5657 messages that are submitted by SMTP from local processes using the standard
5658 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5659 manner.
5660 .code
5661 deny    message       = Restricted characters in address
5662         domains       = +local_domains
5663         local_parts   = ^[.] : ^.*[@%!/|]
5664
5665 deny    message       = Restricted characters in address
5666         domains       = !+local_domains
5667         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5668 .endd
5669 These statements are concerned with local parts that contain any of the
5670 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5671 Although these characters are entirely legal in local parts (in the case of
5672 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5673 in Internet mail addresses.
5674
5675 The first three have in the past been associated with explicitly routed
5676 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5677 option). Addresses containing these characters are regularly tried by spammers
5678 in an attempt to bypass relaying restrictions, and also by open relay testing
5679 programs. Unless you really need them it is safest to reject these characters
5680 at this early stage. This configuration is heavy-handed in rejecting these
5681 characters for all messages it accepts from remote hosts. This is a deliberate
5682 policy of being as safe as possible.
5683
5684 The first rule above is stricter, and is applied to messages that are addressed
5685 to one of the local domains handled by this host. This is implemented by the
5686 first condition, which restricts it to domains that are listed in the
5687 &'local_domains'& domain list. The &"+"& character is used to indicate a
5688 reference to a named list. In this configuration, there is just one domain in
5689 &'local_domains'&, but in general there may be many.
5690
5691 The second condition on the first statement uses two regular expressions to
5692 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5693 or &"|"&. If you have local accounts that include these characters, you will
5694 have to modify this rule.
5695
5696 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5697 allows them because they have been encountered in practice. (Consider the
5698 common convention of local parts constructed as
5699 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5700 the author of Exim, who has no second initial.) However, a local part starting
5701 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5702 file name (for example, for a mailing list). This is also true for local parts
5703 that contain slashes. A pipe symbol can also be troublesome if the local part
5704 is incorporated unthinkingly into a shell command line.
5705
5706 The second rule above applies to all other domains, and is less strict. This
5707 allows your own users to send outgoing messages to sites that use slashes
5708 and vertical bars in their local parts. It blocks local parts that begin
5709 with a dot, slash, or vertical bar, but allows these characters within the
5710 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5711 and &"!"& is blocked, as before. The motivation here is to prevent your users
5712 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5713 .code
5714 accept  local_parts   = postmaster
5715         domains       = +local_domains
5716 .endd
5717 This statement, which has two conditions, accepts an incoming address if the
5718 local part is &'postmaster'& and the domain is one of those listed in the
5719 &'local_domains'& domain list. The &"+"& character is used to indicate a
5720 reference to a named list. In this configuration, there is just one domain in
5721 &'local_domains'&, but in general there may be many.
5722
5723 The presence of this statement means that mail to postmaster is never blocked
5724 by any of the subsequent tests. This can be helpful while sorting out problems
5725 in cases where the subsequent tests are incorrectly denying access.
5726 .code
5727 require verify        = sender
5728 .endd
5729 This statement requires the sender address to be verified before any subsequent
5730 ACL statement can be used. If verification fails, the incoming recipient
5731 address is refused. Verification consists of trying to route the address, to
5732 see if a bounce message could be delivered to it. In the case of remote
5733 addresses, basic verification checks only the domain, but &'callouts'& can be
5734 used for more verification if required. Section &<<SECTaddressverification>>&
5735 discusses the details of address verification.
5736 .code
5737 accept  hosts         = +relay_from_hosts
5738         control       = submission
5739 .endd
5740 This statement accepts the address if the message is coming from one of the
5741 hosts that are defined as being allowed to relay through this host. Recipient
5742 verification is omitted here, because in many cases the clients are dumb MUAs
5743 that do not cope well with SMTP error responses. For the same reason, the
5744 second line specifies &"submission mode"& for messages that are accepted. This
5745 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5746 messages that are deficient in some way, for example, because they lack a
5747 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5748 probably add recipient verification here, and disable submission mode.
5749 .code
5750 accept  authenticated = *
5751         control       = submission
5752 .endd
5753 This statement accepts the address if the client host has authenticated itself.
5754 Submission mode is again specified, on the grounds that such messages are most
5755 likely to come from MUAs. The default configuration does not define any
5756 authenticators, though it does include some nearly complete commented-out
5757 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5758 fact authenticate until you complete the authenticator definitions.
5759 .code
5760 require message = relay not permitted
5761         domains = +local_domains : +relay_to_domains
5762 .endd
5763 This statement rejects the address if its domain is neither a local domain nor
5764 one of the domains for which this host is a relay.
5765 .code
5766 require verify = recipient
5767 .endd
5768 This statement requires the recipient address to be verified; if verification
5769 fails, the address is rejected.
5770 .code
5771 # deny    message     = rejected because $sender_host_address \
5772 #                       is in a black list at $dnslist_domain\n\
5773 #                       $dnslist_text
5774 #         dnslists    = black.list.example
5775 #
5776 # warn    dnslists    = black.list.example
5777 #         add_header  = X-Warning: $sender_host_address is in \
5778 #                       a black list at $dnslist_domain
5779 #         log_message = found in $dnslist_domain
5780 .endd
5781 These commented-out lines are examples of how you could configure Exim to check
5782 sending hosts against a DNS black list. The first statement rejects messages
5783 from blacklisted hosts, whereas the second just inserts a warning header
5784 line.
5785 .code
5786 # require verify = csa
5787 .endd
5788 This commented-out line is an example of how you could turn on client SMTP
5789 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5790 records.
5791 .code
5792 accept
5793 .endd
5794 The final statement in the first ACL unconditionally accepts any recipient
5795 address that has successfully passed all the previous tests.
5796 .code
5797 acl_check_data:
5798 .endd
5799 This line marks the start of the second ACL, and names it. Most of the contents
5800 of this ACL are commented out:
5801 .code
5802 # deny    malware   = *
5803 #         message   = This message contains a virus \
5804 #                     ($malware_name).
5805 .endd
5806 These lines are examples of how to arrange for messages to be scanned for
5807 viruses when Exim has been compiled with the content-scanning extension, and a
5808 suitable virus scanner is installed. If the message is found to contain a
5809 virus, it is rejected with the given custom error message.
5810 .code
5811 # warn    spam      = nobody
5812 #         message   = X-Spam_score: $spam_score\n\
5813 #                     X-Spam_score_int: $spam_score_int\n\
5814 #                     X-Spam_bar: $spam_bar\n\
5815 #                     X-Spam_report: $spam_report
5816 .endd
5817 These lines are an example of how to arrange for messages to be scanned by
5818 SpamAssassin when Exim has been compiled with the content-scanning extension,
5819 and SpamAssassin has been installed. The SpamAssassin check is run with
5820 &`nobody`& as its user parameter, and the results are added to the message as a
5821 series of extra header line. In this case, the message is not rejected,
5822 whatever the spam score.
5823 .code
5824 accept
5825 .endd
5826 This final line in the DATA ACL accepts the message unconditionally.
5827
5828
5829 .section "Router configuration" "SECID55"
5830 .cindex "default" "routers"
5831 .cindex "routers" "default"
5832 The router configuration comes next in the default configuration, introduced
5833 by the line
5834 .code
5835 begin routers
5836 .endd
5837 Routers are the modules in Exim that make decisions about where to send
5838 messages. An address is passed to each router in turn, until it is either
5839 accepted, or failed. This means that the order in which you define the routers
5840 matters. Each router is fully described in its own chapter later in this
5841 manual. Here we give only brief overviews.
5842 .code
5843 # domain_literal:
5844 #   driver = ipliteral
5845 #   domains = !+local_domains
5846 #   transport = remote_smtp
5847 .endd
5848 .cindex "domain literal" "default router"
5849 This router is commented out because the majority of sites do not want to
5850 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5851 you uncomment this router, you also need to uncomment the setting of
5852 &%allow_domain_literals%& in the main part of the configuration.
5853 .code
5854 dnslookup:
5855   driver = dnslookup
5856   domains = ! +local_domains
5857   transport = remote_smtp
5858   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5859   no_more
5860 .endd
5861 The first uncommented router handles addresses that do not involve any local
5862 domains. This is specified by the line
5863 .code
5864 domains = ! +local_domains
5865 .endd
5866 The &%domains%& option lists the domains to which this router applies, but the
5867 exclamation mark is a negation sign, so the router is used only for domains
5868 that are not in the domain list called &'local_domains'& (which was defined at
5869 the start of the configuration). The plus sign before &'local_domains'&
5870 indicates that it is referring to a named list. Addresses in other domains are
5871 passed on to the following routers.
5872
5873 The name of the router driver is &(dnslookup)&,
5874 and is specified by the &%driver%& option. Do not be confused by the fact that
5875 the name of this router instance is the same as the name of the driver. The
5876 instance name is arbitrary, but the name set in the &%driver%& option must be
5877 one of the driver modules that is in the Exim binary.
5878
5879 The &(dnslookup)& router routes addresses by looking up their domains in the
5880 DNS in order to obtain a list of hosts to which the address is routed. If the
5881 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5882 specified by the &%transport%& option. If the router does not find the domain
5883 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5884 the address fails and is bounced.
5885
5886 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5887 be entirely ignored. This option is present because a number of cases have been
5888 encountered where MX records in the DNS point to host names
5889 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5890 Completely ignoring these IP addresses causes Exim to fail to route the
5891 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5892 continue to try to deliver the message periodically until the address timed
5893 out.
5894 .code
5895 system_aliases:
5896   driver = redirect
5897   allow_fail
5898   allow_defer
5899   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5900 # user = exim
5901   file_transport = address_file
5902   pipe_transport = address_pipe
5903 .endd
5904 Control reaches this and subsequent routers only for addresses in the local
5905 domains. This router checks to see whether the local part is defined as an
5906 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5907 data that it looks up from that file. If no data is found for the local part,
5908 the value of the &%data%& option is empty, causing the address to be passed to
5909 the next router.
5910
5911 &_/etc/aliases_& is a conventional name for the system aliases file that is
5912 often used. That is why it is referenced by from the default configuration
5913 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5914 &_Local/Makefile_& before building Exim.
5915 .code
5916 userforward:
5917   driver = redirect
5918   check_local_user
5919 # local_part_suffix = +* : -*
5920 # local_part_suffix_optional
5921   file = $home/.forward
5922 # allow_filter
5923   no_verify
5924   no_expn
5925   check_ancestor
5926   file_transport = address_file
5927   pipe_transport = address_pipe
5928   reply_transport = address_reply
5929 .endd
5930 This is the most complicated router in the default configuration. It is another
5931 redirection router, but this time it is looking for forwarding data set up by
5932 individual users. The &%check_local_user%& setting specifies a check that the
5933 local part of the address is the login name of a local user. If it is not, the
5934 router is skipped. The two commented options that follow &%check_local_user%&,
5935 namely:
5936 .code
5937 # local_part_suffix = +* : -*
5938 # local_part_suffix_optional
5939 .endd
5940 .vindex "&$local_part_suffix$&"
5941 show how you can specify the recognition of local part suffixes. If the first
5942 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5943 by any sequence of characters, is removed from the local part and placed in the
5944 variable &$local_part_suffix$&. The second suffix option specifies that the
5945 presence of a suffix in the local part is optional. When a suffix is present,
5946 the check for a local login uses the local part with the suffix removed.
5947
5948 When a local user account is found, the file called &_.forward_& in the user's
5949 home directory is consulted. If it does not exist, or is empty, the router
5950 declines. Otherwise, the contents of &_.forward_& are interpreted as
5951 redirection data (see chapter &<<CHAPredirect>>& for more details).
5952
5953 .cindex "Sieve filter" "enabling in default router"
5954 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5955 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5956 is commented out by default), the contents of the file are interpreted as a set
5957 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5958 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5959 separate document entitled &'Exim's interfaces to mail filtering'&.
5960
5961 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5962 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5963 There are two reasons for doing this:
5964
5965 .olist
5966 Whether or not a local user has a &_.forward_& file is not really relevant when
5967 checking an address for validity; it makes sense not to waste resources doing
5968 unnecessary work.
5969 .next
5970 More importantly, when Exim is verifying addresses or handling an EXPN
5971 command during an SMTP session, it is running as the Exim user, not as root.
5972 The group is the Exim group, and no additional groups are set up.
5973 It may therefore not be possible for Exim to read users' &_.forward_& files at
5974 this time.
5975 .endlist
5976
5977 The setting of &%check_ancestor%& prevents the router from generating a new
5978 address that is the same as any previous address that was redirected. (This
5979 works round a problem concerning a bad interaction between aliasing and
5980 forwarding &-- see section &<<SECTredlocmai>>&).
5981
5982 The final three option settings specify the transports that are to be used when
5983 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5984 auto-reply, respectively. For example, if a &_.forward_& file contains
5985 .code
5986 a.nother@elsewhere.example, /home/spqr/archive
5987 .endd
5988 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5989 transport.
5990 .code
5991 localuser:
5992   driver = accept
5993   check_local_user
5994 # local_part_suffix = +* : -*
5995 # local_part_suffix_optional
5996   transport = local_delivery
5997 .endd
5998 The final router sets up delivery into local mailboxes, provided that the local
5999 part is the name of a local login, by accepting the address and assigning it to
6000 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6001 routers, so the address is bounced. The commented suffix settings fulfil the
6002 same purpose as they do for the &(userforward)& router.
6003
6004
6005 .section "Transport configuration" "SECID56"
6006 .cindex "default" "transports"
6007 .cindex "transports" "default"
6008 Transports define mechanisms for actually delivering messages. They operate
6009 only when referenced from routers, so the order in which they are defined does
6010 not matter. The transports section of the configuration starts with
6011 .code
6012 begin transports
6013 .endd
6014 One remote transport and four local transports are defined.
6015 .code
6016 remote_smtp:
6017   driver = smtp
6018   hosts_try_prdr = *
6019 .endd
6020 This transport is used for delivering messages over SMTP connections.
6021 The list of remote hosts comes from the router.
6022 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6023 It is negotiated between client and server
6024 and not expected to cause problems but can be disabled if needed.
6025 All other options are defaulted.
6026 .code
6027 local_delivery:
6028   driver = appendfile
6029   file = /var/mail/$local_part
6030   delivery_date_add
6031   envelope_to_add
6032   return_path_add
6033 # group = mail
6034 # mode = 0660
6035 .endd
6036 This &(appendfile)& transport is used for local delivery to user mailboxes in
6037 traditional BSD mailbox format. By default it runs under the uid and gid of the
6038 local user, which requires the sticky bit to be set on the &_/var/mail_&
6039 directory. Some systems use the alternative approach of running mail deliveries
6040 under a particular group instead of using the sticky bit. The commented options
6041 show how this can be done.
6042
6043 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6044 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6045 similarly-named options above.
6046 .code
6047 address_pipe:
6048   driver = pipe
6049   return_output
6050 .endd
6051 This transport is used for handling deliveries to pipes that are generated by
6052 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6053 option specifies that any output generated by the pipe is to be returned to the
6054 sender.
6055 .code
6056 address_file:
6057   driver = appendfile
6058   delivery_date_add
6059   envelope_to_add
6060   return_path_add
6061 .endd
6062 This transport is used for handling deliveries to files that are generated by
6063 redirection. The name of the file is not specified in this instance of
6064 &(appendfile)&, because it comes from the &(redirect)& router.
6065 .code
6066 address_reply:
6067   driver = autoreply
6068 .endd
6069 This transport is used for handling automatic replies generated by users'
6070 filter files.
6071
6072
6073
6074 .section "Default retry rule" "SECID57"
6075 .cindex "retry" "default rule"
6076 .cindex "default" "retry rule"
6077 The retry section of the configuration file contains rules which affect the way
6078 Exim retries deliveries that cannot be completed at the first attempt. It is
6079 introduced by the line
6080 .code
6081 begin retry
6082 .endd
6083 In the default configuration, there is just one rule, which applies to all
6084 errors:
6085 .code
6086 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6087 .endd
6088 This causes any temporarily failing address to be retried every 15 minutes for
6089 2 hours, then at intervals starting at one hour and increasing by a factor of
6090 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6091 is not delivered after 4 days of temporary failure, it is bounced.
6092
6093 If the retry section is removed from the configuration, or is empty (that is,
6094 if no retry rules are defined), Exim will not retry deliveries. This turns
6095 temporary errors into permanent errors.
6096
6097
6098 .section "Rewriting configuration" "SECID58"
6099 The rewriting section of the configuration, introduced by
6100 .code
6101 begin rewrite
6102 .endd
6103 contains rules for rewriting addresses in messages as they arrive. There are no
6104 rewriting rules in the default configuration file.
6105
6106
6107
6108 .section "Authenticators configuration" "SECTdefconfauth"
6109 .cindex "AUTH" "configuration"
6110 The authenticators section of the configuration, introduced by
6111 .code
6112 begin authenticators
6113 .endd
6114 defines mechanisms for the use of the SMTP AUTH command. The default
6115 configuration file contains two commented-out example authenticators
6116 which support plaintext username/password authentication using the
6117 standard PLAIN mechanism and the traditional but non-standard LOGIN
6118 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6119 to support most MUA software.
6120
6121 The example PLAIN authenticator looks like this:
6122 .code
6123 #PLAIN:
6124 #  driver                  = plaintext
6125 #  server_set_id           = $auth2
6126 #  server_prompts          = :
6127 #  server_condition        = Authentication is not yet configured
6128 #  server_advertise_condition = ${if def:tls_in_cipher }
6129 .endd
6130 And the example LOGIN authenticator looks like this:
6131 .code
6132 #LOGIN:
6133 #  driver                  = plaintext
6134 #  server_set_id           = $auth1
6135 #  server_prompts          = <| Username: | Password:
6136 #  server_condition        = Authentication is not yet configured
6137 #  server_advertise_condition = ${if def:tls_in_cipher }
6138 .endd
6139
6140 The &%server_set_id%& option makes Exim remember the authenticated username
6141 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6142 &%server_prompts%& option configures the &(plaintext)& authenticator so
6143 that it implements the details of the specific authentication mechanism,
6144 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6145 when Exim offers authentication to clients; in the examples, this is only
6146 when TLS or SSL has been started, so to enable the authenticators you also
6147 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6148
6149 The &%server_condition%& setting defines how to verify that the username and
6150 password are correct. In the examples it just produces an error message.
6151 To make the authenticators work, you can use a string expansion
6152 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6153
6154 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6155 usercode and password are in different positions.
6156 Chapter &<<CHAPplaintext>>& covers both.
6157
6158 .ecindex IIDconfiwal
6159
6160
6161
6162 . ////////////////////////////////////////////////////////////////////////////
6163 . ////////////////////////////////////////////////////////////////////////////
6164
6165 .chapter "Regular expressions" "CHAPregexp"
6166
6167 .cindex "regular expressions" "library"
6168 .cindex "PCRE"
6169 Exim supports the use of regular expressions in many of its options. It
6170 uses the PCRE regular expression library; this provides regular expression
6171 matching that is compatible with Perl 5. The syntax and semantics of
6172 regular expressions is discussed in many Perl reference books, and also in
6173 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6174 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6175
6176 The documentation for the syntax and semantics of the regular expressions that
6177 are supported by PCRE is included in the PCRE distribution, and no further
6178 description is included here. The PCRE functions are called from Exim using
6179 the default option settings (that is, with no PCRE options set), except that
6180 the PCRE_CASELESS option is set when the matching is required to be
6181 case-insensitive.
6182
6183 In most cases, when a regular expression is required in an Exim configuration,
6184 it has to start with a circumflex, in order to distinguish it from plain text
6185 or an &"ends with"& wildcard. In this example of a configuration setting, the
6186 second item in the colon-separated list is a regular expression.
6187 .code
6188 domains = a.b.c : ^\\d{3} : *.y.z : ...
6189 .endd
6190 The doubling of the backslash is required because of string expansion that
6191 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6192 of this issue, and a way of avoiding the need for doubling backslashes. The
6193 regular expression that is eventually used in this example contains just one
6194 backslash. The circumflex is included in the regular expression, and has the
6195 normal effect of &"anchoring"& it to the start of the string that is being
6196 matched.
6197
6198 There are, however, two cases where a circumflex is not required for the
6199 recognition of a regular expression: these are the &%match%& condition in a
6200 string expansion, and the &%matches%& condition in an Exim filter file. In
6201 these cases, the relevant string is always treated as a regular expression; if
6202 it does not start with a circumflex, the expression is not anchored, and can
6203 match anywhere in the subject string.
6204
6205 In all cases, if you want a regular expression to match at the end of a string,
6206 you must code the $ metacharacter to indicate this. For example:
6207 .code
6208 domains = ^\\d{3}\\.example
6209 .endd
6210 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6211 You need to use:
6212 .code
6213 domains = ^\\d{3}\\.example\$
6214 .endd
6215 if you want &'example'& to be the top-level domain. The backslash before the
6216 $ is needed because string expansion also interprets dollar characters.
6217
6218
6219
6220 . ////////////////////////////////////////////////////////////////////////////
6221 . ////////////////////////////////////////////////////////////////////////////
6222
6223 .chapter "File and database lookups" "CHAPfdlookup"
6224 .scindex IIDfidalo1 "file" "lookups"
6225 .scindex IIDfidalo2 "database" "lookups"
6226 .cindex "lookup" "description of"
6227 Exim can be configured to look up data in files or databases as it processes
6228 messages. Two different kinds of syntax are used:
6229
6230 .olist
6231 A string that is to be expanded may contain explicit lookup requests. These
6232 cause parts of the string to be replaced by data that is obtained from the
6233 lookup. Lookups of this type are conditional expansion items. Different results
6234 can be defined for the cases of lookup success and failure. See chapter
6235 &<<CHAPexpand>>&, where string expansions are described in detail.
6236 .next
6237 Lists of domains, hosts, and email addresses can contain lookup requests as a
6238 way of avoiding excessively long linear lists. In this case, the data that is
6239 returned by the lookup is often (but not always) discarded; whether the lookup
6240 succeeds or fails is what really counts. These kinds of list are described in
6241 chapter &<<CHAPdomhosaddlists>>&.
6242 .endlist
6243
6244 String expansions, lists, and lookups interact with each other in such a way
6245 that there is no order in which to describe any one of them that does not
6246 involve references to the others. Each of these three chapters makes more sense
6247 if you have read the other two first. If you are reading this for the first
6248 time, be aware that some of it will make a lot more sense after you have read
6249 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6250
6251 .section "Examples of different lookup syntax" "SECID60"
6252 It is easy to confuse the two different kinds of lookup, especially as the
6253 lists that may contain the second kind are always expanded before being
6254 processed as lists. Therefore, they may also contain lookups of the first kind.
6255 Be careful to distinguish between the following two examples:
6256 .code
6257 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6258 domains = lsearch;/some/file
6259 .endd
6260 The first uses a string expansion, the result of which must be a domain list.
6261 No strings have been specified for a successful or a failing lookup; the
6262 defaults in this case are the looked-up data and an empty string, respectively.
6263 The expansion takes place before the string is processed as a list, and the
6264 file that is searched could contain lines like this:
6265 .code
6266 192.168.3.4: domain1:domain2:...
6267 192.168.1.9: domain3:domain4:...
6268 .endd
6269 When the lookup succeeds, the result of the expansion is a list of domains (and
6270 possibly other types of item that are allowed in domain lists).
6271
6272 In the second example, the lookup is a single item in a domain list. It causes
6273 Exim to use a lookup to see if the domain that is being processed can be found
6274 in the file. The file could contains lines like this:
6275 .code
6276 domain1:
6277 domain2:
6278 .endd
6279 Any data that follows the keys is not relevant when checking that the domain
6280 matches the list item.
6281
6282 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6283 Consider a file containing lines like this:
6284 .code
6285 192.168.5.6: lsearch;/another/file
6286 .endd
6287 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6288 first &%domains%& setting above generates the second setting, which therefore
6289 causes a second lookup to occur.
6290
6291 The rest of this chapter describes the different lookup types that are
6292 available. Any of them can be used in any part of the configuration where a
6293 lookup is permitted.
6294
6295
6296 .section "Lookup types" "SECID61"
6297 .cindex "lookup" "types of"
6298 .cindex "single-key lookup" "definition of"
6299 Two different types of data lookup are implemented:
6300
6301 .ilist
6302 The &'single-key'& type requires the specification of a file in which to look,
6303 and a single key to search for. The key must be a non-empty string for the
6304 lookup to succeed. The lookup type determines how the file is searched.
6305 .next
6306 .cindex "query-style lookup" "definition of"
6307 The &'query-style'& type accepts a generalized database query. No particular
6308 key value is assumed by Exim for query-style lookups. You can use whichever
6309 Exim variables you need to construct the database query.
6310 .endlist
6311
6312 The code for each lookup type is in a separate source file that is included in
6313 the binary of Exim only if the corresponding compile-time option is set. The
6314 default settings in &_src/EDITME_& are:
6315 .code
6316 LOOKUP_DBM=yes
6317 LOOKUP_LSEARCH=yes
6318 .endd
6319 which means that only linear searching and DBM lookups are included by default.
6320 For some types of lookup (e.g. SQL databases), you need to install appropriate
6321 libraries and header files before building Exim.
6322
6323
6324
6325
6326 .section "Single-key lookup types" "SECTsinglekeylookups"
6327 .cindex "lookup" "single-key types"
6328 .cindex "single-key lookup" "list of types"
6329 The following single-key lookup types are implemented:
6330
6331 .ilist
6332 .cindex "cdb" "description of"
6333 .cindex "lookup" "cdb"
6334 .cindex "binary zero" "in lookup key"
6335 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6336 string without a terminating binary zero. The cdb format is designed for
6337 indexed files that are read frequently and never updated, except by total
6338 re-creation. As such, it is particularly suitable for large files containing
6339 aliases or other indexed data referenced by an MTA. Information about cdb can
6340 be found in several places:
6341 .display
6342 &url(http://www.pobox.com/~djb/cdb.html)
6343 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6344 &url(http://packages.debian.org/stable/utils/freecdb.html)
6345 .endd
6346 A cdb distribution is not needed in order to build Exim with cdb support,
6347 because the code for reading cdb files is included directly in Exim itself.
6348 However, no means of building or testing cdb files is provided with Exim, so
6349 you need to obtain a cdb distribution in order to do this.
6350 .next
6351 .cindex "DBM" "lookup type"
6352 .cindex "lookup" "dbm"
6353 .cindex "binary zero" "in lookup key"
6354 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6355 DBM file by looking up the record with the given key. A terminating binary
6356 zero is included in the key that is passed to the DBM library. See section
6357 &<<SECTdb>>& for a discussion of DBM libraries.
6358
6359 .cindex "Berkeley DB library" "file format"
6360 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6361 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6362 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6363 the DB_UNKNOWN option. This enables it to handle any of the types of database
6364 that the library supports, and can be useful for accessing DBM files created by
6365 other applications. (For earlier DB versions, DB_HASH is always used.)
6366 .next
6367 .cindex "lookup" "dbmjz"
6368 .cindex "lookup" "dbm &-- embedded NULs"
6369 .cindex "sasldb2"
6370 .cindex "dbmjz lookup type"
6371 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6372 interpreted as an Exim list; the elements of the list are joined together with
6373 ASCII NUL characters to form the lookup key.  An example usage would be to
6374 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6375 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6376 &(cram_md5)& authenticator.
6377 .next
6378 .cindex "lookup" "dbmnz"
6379 .cindex "lookup" "dbm &-- terminating zero"
6380 .cindex "binary zero" "in lookup key"
6381 .cindex "Courier"
6382 .cindex "&_/etc/userdbshadow.dat_&"
6383 .cindex "dbmnz lookup type"
6384 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6385 is not included in the key that is passed to the DBM library. You may need this
6386 if you want to look up data in files that are created by or shared with some
6387 other application that does not use terminating zeros. For example, you need to
6388 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6389 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6390 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6391 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6392 .next
6393 .cindex "lookup" "dsearch"
6394 .cindex "dsearch lookup type"
6395 &(dsearch)&: The given file must be a directory; this is searched for an entry
6396 whose name is the key by calling the &[lstat()]& function. The key may not
6397 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6398 the lookup is the name of the entry, which may be a file, directory,
6399 symbolic link, or any other kind of directory entry. An example of how this
6400 lookup can be used to support virtual domains is given in section
6401 &<<SECTvirtualdomains>>&.
6402 .next
6403 .cindex "lookup" "iplsearch"
6404 .cindex "iplsearch lookup type"
6405 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6406 terminated by a colon or white space or the end of the line. The keys in the
6407 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6408 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6409 being interpreted as a key terminator. For example:
6410 .code
6411 1.2.3.4:           data for 1.2.3.4
6412 192.168.0.0/16:    data for 192.168.0.0/16
6413 "abcd::cdab":      data for abcd::cdab
6414 "abcd:abcd::/32"   data for abcd:abcd::/32
6415 .endd
6416 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6417 file is searched linearly, using the CIDR masks where present, until a matching
6418 key is found. The first key that matches is used; there is no attempt to find a
6419 &"best"& match. Apart from the way the keys are matched, the processing for
6420 &(iplsearch)& is the same as for &(lsearch)&.
6421
6422 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6423 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6424 lookup types support only literal keys.
6425
6426 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6427 the implicit key is the host's IP address rather than its name (see section
6428 &<<SECThoslispatsikey>>&).
6429 .next
6430 .cindex "linear search"
6431 .cindex "lookup" "lsearch"
6432 .cindex "lsearch lookup type"
6433 .cindex "case sensitivity" "in lsearch lookup"
6434 &(lsearch)&: The given file is a text file that is searched linearly for a
6435 line beginning with the search key, terminated by a colon or white space or the
6436 end of the line. The search is case-insensitive; that is, upper and lower case
6437 letters are treated as the same. The first occurrence of the key that is found
6438 in the file is used.
6439
6440 White space between the key and the colon is permitted. The remainder of the
6441 line, with leading and trailing white space removed, is the data. This can be
6442 continued onto subsequent lines by starting them with any amount of white
6443 space, but only a single space character is included in the data at such a
6444 junction. If the data begins with a colon, the key must be terminated by a
6445 colon, for example:
6446 .code
6447 baduser:  :fail:
6448 .endd
6449 Empty lines and lines beginning with # are ignored, even if they occur in the
6450 middle of an item. This is the traditional textual format of alias files. Note
6451 that the keys in an &(lsearch)& file are literal strings. There is no
6452 wildcarding of any kind.
6453
6454 .cindex "lookup" "lsearch &-- colons in keys"
6455 .cindex "white space" "in lsearch key"
6456 In most &(lsearch)& files, keys are not required to contain colons or #
6457 characters, or white space. However, if you need this feature, it is available.
6458 If a key begins with a doublequote character, it is terminated only by a
6459 matching quote (or end of line), and the normal escaping rules apply to its
6460 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6461 quoted keys (exactly as for unquoted keys). There is no special handling of
6462 quotes for the data part of an &(lsearch)& line.
6463
6464 .next
6465 .cindex "NIS lookup type"
6466 .cindex "lookup" "NIS"
6467 .cindex "binary zero" "in lookup key"
6468 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6469 the given key, without a terminating binary zero. There is a variant called
6470 &(nis0)& which does include the terminating binary zero in the key. This is
6471 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6472 aliases; the full map names must be used.
6473
6474 .next
6475 .cindex "wildlsearch lookup type"
6476 .cindex "lookup" "wildlsearch"
6477 .cindex "nwildlsearch lookup type"
6478 .cindex "lookup" "nwildlsearch"
6479 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6480 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6481 the file may be wildcarded. The difference between these two lookup types is
6482 that for &(wildlsearch)&, each key in the file is string-expanded before being
6483 used, whereas for &(nwildlsearch)&, no expansion takes place.
6484
6485 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6486 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6487 file that are regular expressions can be made case-sensitive by the use of
6488 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6489
6490 . ==== As this is a nested list, any displays it contains must be indented
6491 . ==== as otherwise they are too far to the left.
6492
6493 .olist
6494 The string may begin with an asterisk to mean &"ends with"&. For example:
6495 .code
6496     *.a.b.c       data for anything.a.b.c
6497     *fish         data for anythingfish
6498 .endd
6499 .next
6500 The string may begin with a circumflex to indicate a regular expression. For
6501 example, for &(wildlsearch)&:
6502 .code
6503     ^\N\d+\.a\.b\N    data for <digits>.a.b
6504 .endd
6505 Note the use of &`\N`& to disable expansion of the contents of the regular
6506 expression. If you are using &(nwildlsearch)&, where the keys are not
6507 string-expanded, the equivalent entry is:
6508 .code
6509     ^\d+\.a\.b        data for <digits>.a.b
6510 .endd
6511 The case-insensitive flag is set at the start of compiling the regular
6512 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6513 For example, to make the entire pattern case-sensitive:
6514 .code
6515     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6516 .endd
6517
6518 If the regular expression contains white space or colon characters, you must
6519 either quote it (see &(lsearch)& above), or represent these characters in other
6520 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6521 colon. This may be easier than quoting, because if you quote, you have to
6522 escape all the backslashes inside the quotes.
6523
6524 &*Note*&: It is not possible to capture substrings in a regular expression
6525 match for later use, because the results of all lookups are cached. If a lookup
6526 is repeated, the result is taken from the cache, and no actual pattern matching
6527 takes place. The values of all the numeric variables are unset after a
6528 &((n)wildlsearch)& match.
6529
6530 .next
6531 Although I cannot see it being of much use, the general matching function that
6532 is used to implement &((n)wildlsearch)& means that the string may begin with a
6533 lookup name terminated by a semicolon, and followed by lookup data. For
6534 example:
6535 .code
6536     cdb;/some/file  data for keys that match the file
6537 .endd
6538 The data that is obtained from the nested lookup is discarded.
6539 .endlist olist
6540
6541 Keys that do not match any of these patterns are interpreted literally. The
6542 continuation rules for the data are the same as for &(lsearch)&, and keys may
6543 be followed by optional colons.
6544
6545 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6546 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6547 lookup types support only literal keys.
6548 .endlist ilist
6549
6550
6551 .section "Query-style lookup types" "SECID62"
6552 .cindex "lookup" "query-style types"
6553 .cindex "query-style lookup" "list of types"
6554 The supported query-style lookup types are listed below. Further details about
6555 many of them are given in later sections.
6556
6557 .ilist
6558 .cindex "DNS" "as a lookup type"
6559 .cindex "lookup" "DNS"
6560 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6561 are given in the supplied query. The resulting data is the contents of the
6562 records. See section &<<SECTdnsdb>>&.
6563 .next
6564 .cindex "InterBase lookup type"
6565 .cindex "lookup" "InterBase"
6566 &(ibase)&: This does a lookup in an InterBase database.
6567 .next
6568 .cindex "LDAP" "lookup type"
6569 .cindex "lookup" "LDAP"
6570 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6571 returns attributes from a single entry. There is a variant called &(ldapm)&
6572 that permits values from multiple entries to be returned. A third variant
6573 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6574 any attribute values. See section &<<SECTldap>>&.
6575 .next
6576 .cindex "MySQL" "lookup type"
6577 .cindex "lookup" "MySQL"
6578 &(mysql)&: The format of the query is an SQL statement that is passed to a
6579 MySQL database. See section &<<SECTsql>>&.
6580 .next
6581 .cindex "NIS+ lookup type"
6582 .cindex "lookup" "NIS+"
6583 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6584 the field to be returned. See section &<<SECTnisplus>>&.
6585 .next
6586 .cindex "Oracle" "lookup type"
6587 .cindex "lookup" "Oracle"
6588 &(oracle)&: The format of the query is an SQL statement that is passed to an
6589 Oracle database. See section &<<SECTsql>>&.
6590 .next
6591 .cindex "lookup" "passwd"
6592 .cindex "passwd lookup type"
6593 .cindex "&_/etc/passwd_&"
6594 &(passwd)& is a query-style lookup with queries that are just user names. The
6595 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6596 success, the result string is the same as you would get from an &(lsearch)&
6597 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6598 password value. For example:
6599 .code
6600 *:42:42:King Rat:/home/kr:/bin/bash
6601 .endd
6602 .next
6603 .cindex "PostgreSQL lookup type"
6604 .cindex "lookup" "PostgreSQL"
6605 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6606 PostgreSQL database. See section &<<SECTsql>>&.
6607
6608 .next
6609 .cindex "sqlite lookup type"
6610 .cindex "lookup" "sqlite"
6611 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6612 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6613
6614 .next
6615 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6616 not likely to be useful in normal operation.
6617 .next
6618 .cindex "whoson lookup type"
6619 .cindex "lookup" "whoson"
6620 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6621 allows a server to check whether a particular (dynamically allocated) IP
6622 address is currently allocated to a known (trusted) user and, optionally, to
6623 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6624 at one time for &"POP before SMTP"& authentication, but that approach has been
6625 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6626 &"POP before SMTP"& checking using ACL statements such as
6627 .code
6628 require condition = \
6629   ${lookup whoson {$sender_host_address}{yes}{no}}
6630 .endd
6631 The query consists of a single IP address. The value returned is the name of
6632 the authenticated user, which is stored in the variable &$value$&. However, in
6633 this example, the data in &$value$& is not used; the result of the lookup is
6634 one of the fixed strings &"yes"& or &"no"&.
6635 .endlist
6636
6637
6638
6639 .section "Temporary errors in lookups" "SECID63"
6640 .cindex "lookup" "temporary error in"
6641 Lookup functions can return temporary error codes if the lookup cannot be
6642 completed. For example, an SQL or LDAP database might be unavailable. For this
6643 reason, it is not advisable to use a lookup that might do this for critical
6644 options such as a list of local domains.
6645
6646 When a lookup cannot be completed in a router or transport, delivery
6647 of the message (to the relevant address) is deferred, as for any other
6648 temporary error. In other circumstances Exim may assume the lookup has failed,
6649 or may give up altogether.
6650
6651
6652
6653 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6654 .cindex "wildcard lookups"
6655 .cindex "lookup" "default values"
6656 .cindex "lookup" "wildcard"
6657 .cindex "lookup" "* added to type"
6658 .cindex "default" "in single-key lookups"
6659 In this context, a &"default value"& is a value specified by the administrator
6660 that is to be used if a lookup fails.
6661
6662 &*Note:*& This section applies only to single-key lookups. For query-style
6663 lookups, the facilities of the query language must be used. An attempt to
6664 specify a default for a query-style lookup provokes an error.
6665
6666 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6667 and the initial lookup fails, the key &"*"& is looked up in the file to
6668 provide a default value. See also the section on partial matching below.
6669
6670 .cindex "*@ with single-key lookup"
6671 .cindex "lookup" "*@ added to type"
6672 .cindex "alias file" "per-domain default"
6673 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6674 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6675 character, a second lookup is done with everything before the last @ replaced
6676 by *. This makes it possible to provide per-domain defaults in alias files
6677 that include the domains in the keys. If the second lookup fails (or doesn't
6678 take place because there is no @ in the key), &"*"& is looked up.
6679 For example, a &(redirect)& router might contain:
6680 .code
6681 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6682 .endd
6683 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6684 looks up these keys, in this order:
6685 .code
6686 jane@eyre.example
6687 *@eyre.example
6688 *
6689 .endd
6690 The data is taken from whichever key it finds first. &*Note*&: In an
6691 &(lsearch)& file, this does not mean the first of these keys in the file. A
6692 complete scan is done for each key, and only if it is not found at all does
6693 Exim move on to try the next key.
6694
6695
6696
6697 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6698 .cindex "partial matching"
6699 .cindex "wildcard lookups"
6700 .cindex "lookup" "partial matching"
6701 .cindex "lookup" "wildcard"
6702 .cindex "asterisk" "in search type"
6703 The normal operation of a single-key lookup is to search the file for an exact
6704 match with the given key. However, in a number of situations where domains are
6705 being looked up, it is useful to be able to do partial matching. In this case,
6706 information in the file that has a key starting with &"*."& is matched by any
6707 domain that ends with the components that follow the full stop. For example, if
6708 a key in a DBM file is
6709 .code
6710 *.dates.fict.example
6711 .endd
6712 then when partial matching is enabled this is matched by (amongst others)
6713 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6714 by &'dates.fict.example'&, if that does not appear as a separate key in the
6715 file.
6716
6717 &*Note*&: Partial matching is not available for query-style lookups. It is
6718 also not available for any lookup items in address lists (see section
6719 &<<SECTaddresslist>>&).
6720
6721 Partial matching is implemented by doing a series of separate lookups using
6722 keys constructed by modifying the original subject key. This means that it can
6723 be used with any of the single-key lookup types, provided that
6724 partial matching keys
6725 beginning with a special prefix (default &"*."&) are included in the data file.
6726 Keys in the file that do not begin with the prefix are matched only by
6727 unmodified subject keys when partial matching is in use.
6728
6729 Partial matching is requested by adding the string &"partial-"& to the front of
6730 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6731 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6732 is added at the start of the subject key, and it is looked up again. If that
6733 fails, further lookups are tried with dot-separated components removed from the
6734 start of the subject key, one-by-one, and &"*."& added on the front of what
6735 remains.
6736
6737 A minimum number of two non-* components are required. This can be adjusted
6738 by including a number before the hyphen in the search type. For example,
6739 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6740 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6741 subject key is &'2250.dates.fict.example'& then the following keys are looked
6742 up when the minimum number of non-* components is two:
6743 .code
6744 2250.dates.fict.example
6745 *.2250.dates.fict.example
6746 *.dates.fict.example
6747 *.fict.example
6748 .endd
6749 As soon as one key in the sequence is successfully looked up, the lookup
6750 finishes.
6751
6752 .cindex "lookup" "partial matching &-- changing prefix"
6753 .cindex "prefix" "for partial matching"
6754 The use of &"*."& as the partial matching prefix is a default that can be
6755 changed. The motivation for this feature is to allow Exim to operate with file
6756 formats that are used by other MTAs. A different prefix can be supplied in
6757 parentheses instead of the hyphen after &"partial"&. For example:
6758 .code
6759 domains = partial(.)lsearch;/some/file
6760 .endd
6761 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6762 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6763 components is unchanged). The prefix may consist of any punctuation characters
6764 other than a closing parenthesis. It may be empty, for example:
6765 .code
6766 domains = partial1()cdb;/some/file
6767 .endd
6768 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6769 &`a.b.c`&, &`b.c`&, and &`c`&.
6770
6771 If &"partial0"& is specified, what happens at the end (when the lookup with
6772 just one non-wild component has failed, and the original key is shortened right
6773 down to the null string) depends on the prefix:
6774
6775 .ilist
6776 If the prefix has zero length, the whole lookup fails.
6777 .next
6778 If the prefix has length 1, a lookup for just the prefix is done. For
6779 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6780 .next
6781 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6782 remainder is looked up. With the default prefix, therefore, the final lookup is
6783 for &"*"& on its own.
6784 .next
6785 Otherwise, the whole prefix is looked up.
6786 .endlist
6787
6788
6789 If the search type ends in &"*"& or &"*@"& (see section
6790 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6791 this implies happens after all partial lookups have failed. If &"partial0"& is
6792 specified, adding &"*"& to the search type has no effect with the default
6793 prefix, because the &"*"& key is already included in the sequence of partial
6794 lookups. However, there might be a use for lookup types such as
6795 &"partial0(.)lsearch*"&.
6796
6797 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6798 in domain lists and the like. Partial matching works only in terms of
6799 dot-separated components; a key such as &`*fict.example`&
6800 in a database file is useless, because the asterisk in a partial matching
6801 subject key is always followed by a dot.
6802
6803
6804
6805
6806 .section "Lookup caching" "SECID64"
6807 .cindex "lookup" "caching"
6808 .cindex "caching" "lookup data"
6809 Exim caches all lookup results in order to avoid needless repetition of
6810 lookups. However, because (apart from the daemon) Exim operates as a collection
6811 of independent, short-lived processes, this caching applies only within a
6812 single Exim process. There is no inter-process lookup caching facility.
6813
6814 For single-key lookups, Exim keeps the relevant files open in case there is
6815 another lookup that needs them. In some types of configuration this can lead to
6816 many files being kept open for messages with many recipients. To avoid hitting
6817 the operating system limit on the number of simultaneously open files, Exim
6818 closes the least recently used file when it needs to open more files than its
6819 own internal limit, which can be changed via the &%lookup_open_max%& option.
6820
6821 The single-key lookup files are closed and the lookup caches are flushed at
6822 strategic points during delivery &-- for example, after all routing is
6823 complete.
6824
6825
6826
6827
6828 .section "Quoting lookup data" "SECID65"
6829 .cindex "lookup" "quoting"
6830 .cindex "quoting" "in lookups"
6831 When data from an incoming message is included in a query-style lookup, there
6832 is the possibility of special characters in the data messing up the syntax of
6833 the query. For example, a NIS+ query that contains
6834 .code
6835 [name=$local_part]
6836 .endd
6837 will be broken if the local part happens to contain a closing square bracket.
6838 For NIS+, data can be enclosed in double quotes like this:
6839 .code
6840 [name="$local_part"]
6841 .endd
6842 but this still leaves the problem of a double quote in the data. The rule for
6843 NIS+ is that double quotes must be doubled. Other lookup types have different
6844 rules, and to cope with the differing requirements, an expansion operator
6845 of the following form is provided:
6846 .code
6847 ${quote_<lookup-type>:<string>}
6848 .endd
6849 For example, the safest way to write the NIS+ query is
6850 .code
6851 [name="${quote_nisplus:$local_part}"]
6852 .endd
6853 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6854 operator can be used for all lookup types, but has no effect for single-key
6855 lookups, since no quoting is ever needed in their key strings.
6856
6857
6858
6859
6860 .section "More about dnsdb" "SECTdnsdb"
6861 .cindex "dnsdb lookup"
6862 .cindex "lookup" "dnsdb"
6863 .cindex "DNS" "as a lookup type"
6864 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6865 of a record type and a domain name, separated by an equals sign. For example,
6866 an expansion string could contain:
6867 .code
6868 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6869 .endd
6870 If the lookup succeeds, the result is placed in &$value$&, which in this case
6871 is used on its own as the result. If the lookup does not succeed, the
6872 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6873 &<<SECTforexpfai>>& for an explanation of what this means.
6874
6875 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6876 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6877 configured). If no type is given, TXT is assumed. When the type is PTR,
6878 the data can be an IP address, written as normal; inversion and the addition of
6879 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6880 .code
6881 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6882 .endd
6883 If the data for a PTR record is not a syntactically valid IP address, it is not
6884 altered and nothing is added.
6885
6886 For any record type, if multiple records are found (or, for A6 lookups, if a
6887 single record leads to multiple addresses), the data is returned as a
6888 concatenation, with newline as the default separator. The order, of course,
6889 depends on the DNS resolver. You can specify a different separator character
6890 between multiple records by putting a right angle-bracket followed immediately
6891 by the new separator at the start of the query. For example:
6892 .code
6893 ${lookup dnsdb{>: a=host1.example}}
6894 .endd
6895 It is permitted to specify a space as the separator character. Further
6896 white space is ignored.
6897
6898 .cindex "MX record" "in &(dnsdb)& lookup"
6899 .cindex "SRV record" "in &(dnsdb)& lookup"
6900 For an MX lookup, both the preference value and the host name are returned for
6901 each record, separated by a space. For an SRV lookup, the priority, weight,
6902 port, and host name are returned for each record, separated by spaces.
6903 An alternate field separator can be specified using a comma after the main
6904 separator character, followed immediately by the field separator.
6905
6906 .cindex "TXT record" "in &(dnsdb)& lookup"
6907 .cindex "SPF record" "in &(dnsdb)& lookup"
6908 For TXT records with multiple items of data, only the first item is returned,
6909 unless a separator for them is specified using a comma after the separator
6910 character followed immediately by the TXT record item separator. To concatenate
6911 items without a separator, use a semicolon instead. For SPF records the
6912 default behaviour is to concatenate multiple items without using a separator.
6913 .code
6914 ${lookup dnsdb{>\n,: txt=a.b.example}}
6915 ${lookup dnsdb{>\n; txt=a.b.example}}
6916 ${lookup dnsdb{spf=example.org}}
6917 .endd
6918 It is permitted to specify a space as the separator character. Further
6919 white space is ignored.
6920
6921 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6922 .cindex "dnsdb modifiers"
6923 .cindex "modifiers" "dnsdb"
6924 .cindex "options" "dnsdb"
6925 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6926 each followed by a comma,
6927 that may appear before the record type.
6928
6929 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6930 temporary DNS error for any of them, the behaviour is controlled by
6931 a defer-option modifier.
6932 The possible keywords are
6933 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6934 With &"strict"& behaviour, any temporary DNS error causes the
6935 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6936 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6937 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6938 error causes the whole lookup to defer only if none of the other lookups
6939 succeed. The default is &"lax"&, so the following lookups are equivalent:
6940 .code
6941 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6942 ${lookup dnsdb{a=one.host.com:two.host.com}}
6943 .endd
6944 Thus, in the default case, as long as at least one of the DNS lookups
6945 yields some data, the lookup succeeds.
6946
6947 .cindex "DNSSEC" "dns lookup"
6948 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6949 The possible keywords are
6950 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6951 With &"strict"& or &"lax"& DNSSEC information is requested
6952 with the lookup.
6953 With &"strict"& a response from the DNS resolver that
6954 is not labelled as authenticated data
6955 is treated as equivalent to a temporary DNS error.
6956 The default is &"never"&.
6957
6958 See also the &$lookup_dnssec_authenticated$& variable.
6959
6960
6961 .section "Pseudo dnsdb record types" "SECID66"
6962 .cindex "MX record" "in &(dnsdb)& lookup"
6963 By default, both the preference value and the host name are returned for
6964 each MX record, separated by a space. If you want only host names, you can use
6965 the pseudo-type MXH:
6966 .code
6967 ${lookup dnsdb{mxh=a.b.example}}
6968 .endd
6969 In this case, the preference values are omitted, and just the host names are
6970 returned.
6971
6972 .cindex "name server for enclosing domain"
6973 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6974 records on the given domain, but if none are found, it removes the first
6975 component of the domain name, and tries again. This process continues until NS
6976 records are found or there are no more components left (or there is a DNS
6977 error). In other words, it may return the name servers for a top-level domain,
6978 but it never returns the root name servers. If there are no NS records for the
6979 top-level domain, the lookup fails. Consider these examples:
6980 .code
6981 ${lookup dnsdb{zns=xxx.quercite.com}}
6982 ${lookup dnsdb{zns=xxx.edu}}
6983 .endd
6984 Assuming that in each case there are no NS records for the full domain name,
6985 the first returns the name servers for &%quercite.com%&, and the second returns
6986 the name servers for &%edu%&.
6987
6988 You should be careful about how you use this lookup because, unless the
6989 top-level domain does not exist, the lookup always returns some host names. The
6990 sort of use to which this might be put is for seeing if the name servers for a
6991 given domain are on a blacklist. You can probably assume that the name servers
6992 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6993 such a list.
6994
6995 .cindex "CSA" "in &(dnsdb)& lookup"
6996 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6997 records according to the CSA rules, which are described in section
6998 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6999 not sufficient because of the extra parent domain search behaviour of CSA. The
7000 result of a successful lookup such as:
7001 .code
7002 ${lookup dnsdb {csa=$sender_helo_name}}
7003 .endd
7004 has two space-separated fields: an authorization code and a target host name.
7005 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7006 authorization required but absent, or &"?"& for unknown.
7007
7008 .cindex "A+" "in &(dnsdb)& lookup"
7009 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
7010 and then an A lookup.  All results are returned; defer processing
7011 (see below) is handled separately for each lookup.  Example:
7012 .code
7013 ${lookup dnsdb {>; a+=$sender_helo_name}}
7014 .endd
7015
7016
7017 .section "Multiple dnsdb lookups" "SECID67"
7018 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7019 However, you can specify a list of domains or IP addresses in a single
7020 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7021 the default separator, but with the ability to change this. For example:
7022 .code
7023 ${lookup dnsdb{one.domain.com:two.domain.com}}
7024 ${lookup dnsdb{a=one.host.com:two.host.com}}
7025 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7026 .endd
7027 In order to retain backwards compatibility, there is one special case: if
7028 the lookup type is PTR and no change of separator is specified, Exim looks
7029 to see if the rest of the string is precisely one IPv6 address. In this
7030 case, it does not treat it as a list.
7031
7032 The data from each lookup is concatenated, with newline separators by default,
7033 in the same way that multiple DNS records for a single item are handled. A
7034 different separator can be specified, as described above.
7035
7036
7037
7038
7039 .section "More about LDAP" "SECTldap"
7040 .cindex "LDAP" "lookup, more about"
7041 .cindex "lookup" "LDAP"
7042 .cindex "Solaris" "LDAP"
7043 The original LDAP implementation came from the University of Michigan; this has
7044 become &"Open LDAP"&, and there are now two different releases. Another
7045 implementation comes from Netscape, and Solaris 7 and subsequent releases
7046 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7047 the lookup function level, their error handling is different. For this reason
7048 it is necessary to set a compile-time variable when building Exim with LDAP, to
7049 indicate which LDAP library is in use. One of the following should appear in
7050 your &_Local/Makefile_&:
7051 .code
7052 LDAP_LIB_TYPE=UMICHIGAN
7053 LDAP_LIB_TYPE=OPENLDAP1
7054 LDAP_LIB_TYPE=OPENLDAP2
7055 LDAP_LIB_TYPE=NETSCAPE
7056 LDAP_LIB_TYPE=SOLARIS
7057 .endd
7058 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7059 same interface as the University of Michigan version.
7060
7061 There are three LDAP lookup types in Exim. These behave slightly differently in
7062 the way they handle the results of a query:
7063
7064 .ilist
7065 &(ldap)& requires the result to contain just one entry; if there are more, it
7066 gives an error.
7067 .next
7068 &(ldapdn)& also requires the result to contain just one entry, but it is the
7069 Distinguished Name that is returned rather than any attribute values.
7070 .next
7071 &(ldapm)& permits the result to contain more than one entry; the attributes
7072 from all of them are returned.
7073 .endlist
7074
7075
7076 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7077 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7078 the data returned by a successful lookup is described in the next section.
7079 First we explain how LDAP queries are coded.
7080
7081
7082 .section "Format of LDAP queries" "SECTforldaque"
7083 .cindex "LDAP" "query format"
7084 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7085 the configuration of a &(redirect)& router one might have this setting:
7086 .code
7087 data = ${lookup ldap \
7088   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7089   c=UK?mailbox?base?}}
7090 .endd
7091 .cindex "LDAP" "with TLS"
7092 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7093 secure (encrypted) LDAP connections. The second of these ensures that an
7094 encrypted TLS connection is used.
7095
7096 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7097 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7098 See the &%ldap_start_tls%& option.
7099
7100 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7101 controlled. Every part of the TLS configuration can be configured by settings in
7102 &_exim.conf_&. Depending on the version of the client libraries installed on
7103 your system, some of the initialization may have required setting options in
7104 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7105 certificates. This revealed a nuance where the current UID that exim was
7106 running as could affect which config files it read. With Exim 4.83, these
7107 methods become optional, only taking effect if not specifically set in
7108 &_exim.conf_&.
7109
7110
7111 .section "LDAP quoting" "SECID68"
7112 .cindex "LDAP" "quoting"
7113 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7114 and the second because the LDAP query is represented as a URL. Furthermore,
7115 within an LDAP query, two different kinds of quoting are required. For this
7116 reason, there are two different LDAP-specific quoting operators.
7117
7118 The &%quote_ldap%& operator is designed for use on strings that are part of
7119 filter specifications. Conceptually, it first does the following conversions on
7120 the string:
7121 .code
7122 *   =>   \2A
7123 (   =>   \28
7124 )   =>   \29
7125 \   =>   \5C
7126 .endd
7127 in accordance with RFC 2254. The resulting string is then quoted according
7128 to the rules for URLs, that is, all non-alphanumeric characters except
7129 .code
7130 ! $ ' - . _ ( ) * +
7131 .endd
7132 are converted to their hex values, preceded by a percent sign. For example:
7133 .code
7134 ${quote_ldap: a(bc)*, a<yz>; }
7135 .endd
7136 yields
7137 .code
7138 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7139 .endd
7140 Removing the URL quoting, this is (with a leading and a trailing space):
7141 .code
7142 a\28bc\29\2A, a<yz>;
7143 .endd
7144 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7145 base DN specifications in queries. Conceptually, it first converts the string
7146 by inserting a backslash in front of any of the following characters:
7147 .code
7148 , + " \ < > ;
7149 .endd
7150 It also inserts a backslash before any leading spaces or # characters, and
7151 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7152 is then quoted according to the rules for URLs. For example:
7153 .code
7154 ${quote_ldap_dn: a(bc)*, a<yz>; }
7155 .endd
7156 yields
7157 .code
7158 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7159 .endd
7160 Removing the URL quoting, this is (with a trailing space):
7161 .code
7162 \ a(bc)*\, a\<yz\>\;\
7163 .endd
7164 There are some further comments about quoting in the section on LDAP
7165 authentication below.
7166
7167
7168 .section "LDAP connections" "SECID69"
7169 .cindex "LDAP" "connections"
7170 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7171 is in use, via a Unix domain socket. The example given above does not specify
7172 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7173 by starting it with
7174 .code
7175 ldap://<hostname>:<port>/...
7176 .endd
7177 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7178 used. When no server is specified in a query, a list of default servers is
7179 taken from the &%ldap_default_servers%& configuration option. This supplies a
7180 colon-separated list of servers which are tried in turn until one successfully
7181 handles a query, or there is a serious error. Successful handling either
7182 returns the requested data, or indicates that it does not exist. Serious errors
7183 are syntactical, or multiple values when only a single value is expected.
7184 Errors which cause the next server to be tried are connection failures, bind
7185 failures, and timeouts.
7186
7187 For each server name in the list, a port number can be given. The standard way
7188 of specifying a host and port is to use a colon separator (RFC 1738). Because
7189 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7190 doubled. For example
7191 .code
7192 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7193 .endd
7194 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7195 to the LDAP library with no server name, and the library's default (normally
7196 the local host) is used.
7197
7198 If you are using the OpenLDAP library, you can connect to an LDAP server using
7199 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7200 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7201 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7202 not available.
7203
7204 For this type of connection, instead of a host name for the server, a pathname
7205 for the socket is required, and the port number is not relevant. The pathname
7206 can be specified either as an item in &%ldap_default_servers%&, or inline in
7207 the query. In the former case, you can have settings such as
7208 .code
7209 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7210 .endd
7211 When the pathname is given in the query, you have to escape the slashes as
7212 &`%2F`& to fit in with the LDAP URL syntax. For example:
7213 .code
7214 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7215 .endd
7216 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7217 a pathname, it uses the Unix domain socket code, even if the query actually
7218 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7219 socket connection. This behaviour means that you can use a setting of
7220 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7221 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7222 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7223 backup host.
7224
7225 If an explicit &`ldapi`& type is given in a query when a host name is
7226 specified, an error is diagnosed. However, if there are more items in
7227 &%ldap_default_servers%&, they are tried. In other words:
7228
7229 .ilist
7230 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7231 interface.
7232 .next
7233 Using &`ldapi`& with a host name causes an error.
7234 .endlist
7235
7236
7237 Using &`ldapi`& with no host or path in the query, and no setting of
7238 &%ldap_default_servers%&, does whatever the library does by default.
7239
7240
7241
7242 .section "LDAP authentication and control information" "SECID70"
7243 .cindex "LDAP" "authentication"
7244 The LDAP URL syntax provides no way of passing authentication and other control
7245 information to the server. To make this possible, the URL in an LDAP query may
7246 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7247 spaces. If a value contains spaces it must be enclosed in double quotes, and
7248 when double quotes are used, backslash is interpreted in the usual way inside
7249 them. The following names are recognized:
7250 .display
7251 &`DEREFERENCE`&  set the dereferencing parameter
7252 &`NETTIME    `&  set a timeout for a network operation
7253 &`USER       `&  set the DN, for authenticating the LDAP bind
7254 &`PASS       `&  set the password, likewise
7255 &`REFERRALS  `&  set the referrals parameter
7256 &`SERVERS    `&  set alternate server list for this query only
7257 &`SIZE       `&  set the limit for the number of entries returned
7258 &`TIME       `&  set the maximum waiting time for a query
7259 .endd
7260 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7261 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7262 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7263 library from trying to follow referrals issued by the LDAP server.
7264
7265 The name CONNECT is an obsolete name for NETTIME, retained for
7266 backwards compatibility. This timeout (specified as a number of seconds) is
7267 enforced from the client end for operations that can be carried out over a
7268 network. Specifically, it applies to network connections and calls to the
7269 &'ldap_result()'& function. If the value is greater than zero, it is used if
7270 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7271 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7272 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7273 Netscape SDK; for OpenLDAP no action is taken.
7274
7275 The TIME parameter (also a number of seconds) is passed to the server to
7276 set a server-side limit on the time taken to complete a search.
7277
7278 The SERVERS parameter allows you to specify an alternate list of ldap servers
7279 to use for an individual lookup.  The global ldap_servers option provides a
7280 default list of ldap servers, and a single lookup can specify a single ldap
7281 server to use.  But when you need to do a lookup with a list of servers that is
7282 different than the default list (maybe different order, maybe a completely
7283 different set of servers), the SERVERS parameter allows you to specify this
7284 alternate list (colon-separated).
7285
7286 Here is an example of an LDAP query in an Exim lookup that uses some of these
7287 values. This is a single line, folded to fit on the page:
7288 .code
7289 ${lookup ldap
7290   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7291   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7292   {$value}fail}
7293 .endd
7294 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7295 any of the auxiliary data. Exim configuration settings that include lookups
7296 which contain password information should be preceded by &"hide"& to prevent
7297 non-admin users from using the &%-bP%& option to see their values.
7298
7299 The auxiliary data items may be given in any order. The default is no
7300 connection timeout (the system timeout is used), no user or password, no limit
7301 on the number of entries returned, and no time limit on queries.
7302
7303 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7304 removes any URL quoting that it may contain before passing it LDAP. Apparently
7305 some libraries do this for themselves, but some do not. Removing the URL
7306 quoting has two advantages:
7307
7308 .ilist
7309 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7310 DNs as with DNs inside actual queries.
7311 .next
7312 It permits spaces inside USER= DNs.
7313 .endlist
7314
7315 For example, a setting such as
7316 .code
7317 USER=cn=${quote_ldap_dn:$1}
7318 .endd
7319 should work even if &$1$& contains spaces.
7320
7321 Expanded data for the PASS= value should be quoted using the &%quote%&
7322 expansion operator, rather than the LDAP quote operators. The only reason this
7323 field needs quoting is to ensure that it conforms to the Exim syntax, which
7324 does not allow unquoted spaces. For example:
7325 .code
7326 PASS=${quote:$3}
7327 .endd
7328 The LDAP authentication mechanism can be used to check passwords as part of
7329 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7330 &<<CHAPexpand>>&.
7331
7332
7333
7334 .section "Format of data returned by LDAP" "SECID71"
7335 .cindex "LDAP" "returned data formats"
7336 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7337 as a sequence of values, for example
7338 .code
7339 cn=manager, o=University of Cambridge, c=UK
7340 .endd
7341 The &(ldap)& lookup type generates an error if more than one entry matches the
7342 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7343 the result between the data from different entries. It is possible for multiple
7344 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7345 you know that whatever values are returned all came from a single entry in the
7346 directory.
7347
7348 In the common case where you specify a single attribute in your LDAP query, the
7349 result is not quoted, and does not contain the attribute name. If the attribute
7350 has multiple values, they are separated by commas.
7351
7352 If you specify multiple attributes, the result contains space-separated, quoted
7353 strings, each preceded by the attribute name and an equals sign. Within the
7354 quotes, the quote character, backslash, and newline are escaped with
7355 backslashes, and commas are used to separate multiple values for the attribute.
7356 Any commas in attribute values are doubled
7357 (permitting treatment of the values as a comma-separated list).
7358 Apart from the escaping, the string within quotes takes the same form as the
7359 output when a single attribute is requested. Specifying no attributes is the
7360 same as specifying all of an entry's attributes.
7361
7362 Here are some examples of the output format. The first line of each pair is an
7363 LDAP query, and the second is the data that is returned. The attribute called
7364 &%attr1%& has two values, one of them with an embedded comma, whereas
7365 &%attr2%& has only one value:
7366 .code
7367 ldap:///o=base?attr1?sub?(uid=fred)
7368 value1.1,value1,,2
7369
7370 ldap:///o=base?attr2?sub?(uid=fred)
7371 value two
7372
7373 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7374 attr1="value1.1,value1,,2" attr2="value two"
7375
7376 ldap:///o=base??sub?(uid=fred)
7377 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7378 .endd
7379 You can
7380 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7381 results of LDAP lookups.
7382 The &%extract%& operator in string expansions can be used to pick out
7383 individual fields from data that consists of &'key'&=&'value'& pairs.
7384 The &%listextract%& operator should be used to pick out individual values
7385 of attributes, even when only a single value is expected.
7386 The doubling of embedded commas allows you to use the returned data as a
7387 comma separated list (using the "<," syntax for changing the input list separator).
7388
7389
7390
7391
7392 .section "More about NIS+" "SECTnisplus"
7393 .cindex "NIS+ lookup type"
7394 .cindex "lookup" "NIS+"
7395 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7396 and field name. If this is given, the result of a successful query is the
7397 contents of the named field; otherwise the result consists of a concatenation
7398 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7399 values containing spaces are quoted. For example, the query
7400 .code
7401 [name=mg1456],passwd.org_dir
7402 .endd
7403 might return the string
7404 .code
7405 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7406 home=/home/mg1456 shell=/bin/bash shadow=""
7407 .endd
7408 (split over two lines here to fit on the page), whereas
7409 .code
7410 [name=mg1456],passwd.org_dir:gcos
7411 .endd
7412 would just return
7413 .code
7414 Martin Guerre
7415 .endd
7416 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7417 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7418 operator is to double any quote characters within the text.
7419
7420
7421
7422 .section "SQL lookups" "SECTsql"
7423 .cindex "SQL lookup types"
7424 .cindex "MySQL" "lookup type"
7425 .cindex "PostgreSQL lookup type"
7426 .cindex "lookup" "MySQL"
7427 .cindex "lookup" "PostgreSQL"
7428 .cindex "Oracle" "lookup type"
7429 .cindex "lookup" "Oracle"
7430 .cindex "InterBase lookup type"
7431 .cindex "lookup" "InterBase"
7432 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7433 databases. Queries for these databases contain SQL statements, so an example
7434 might be
7435 .code
7436 ${lookup mysql{select mailbox from users where id='userx'}\
7437   {$value}fail}
7438 .endd
7439 If the result of the query contains more than one field, the data for each
7440 field in the row is returned, preceded by its name, so the result of
7441 .code
7442 ${lookup pgsql{select home,name from users where id='userx'}\
7443   {$value}}
7444 .endd
7445 might be
7446 .code
7447 home=/home/userx name="Mister X"
7448 .endd
7449 Empty values and values containing spaces are double quoted, with embedded
7450 quotes escaped by a backslash. If the result of the query contains just one
7451 field, the value is passed back verbatim, without a field name, for example:
7452 .code
7453 Mister X
7454 .endd
7455 If the result of the query yields more than one row, it is all concatenated,
7456 with a newline between the data for each row.
7457
7458
7459 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7460 .cindex "MySQL" "lookup type"
7461 .cindex "PostgreSQL lookup type"
7462 .cindex "lookup" "MySQL"
7463 .cindex "lookup" "PostgreSQL"
7464 .cindex "Oracle" "lookup type"
7465 .cindex "lookup" "Oracle"
7466 .cindex "InterBase lookup type"
7467 .cindex "lookup" "InterBase"
7468 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7469 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7470 option (as appropriate) must be set to a colon-separated list of server
7471 information.
7472 (For MySQL and PostgreSQL only, the global option need not be set if all
7473 queries contain their own server information &-- see section
7474 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7475 items: host name, database name, user name, and password. In the case of
7476 Oracle, the host name field is used for the &"service name"&, and the database
7477 name field is not used and should be empty. For example:
7478 .code
7479 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7480 .endd
7481 Because password data is sensitive, you should always precede the setting with
7482 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7483 option. Here is an example where two MySQL servers are listed:
7484 .code
7485 hide mysql_servers = localhost/users/root/secret:\
7486                      otherhost/users/root/othersecret
7487 .endd
7488 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7489 because this is a colon-separated list, the colon has to be doubled. For each
7490 query, these parameter groups are tried in order until a connection is made and
7491 a query is successfully processed. The result of a query may be that no data is
7492 found, but that is still a successful query. In other words, the list of
7493 servers provides a backup facility, not a list of different places to look.
7494
7495 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7496 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7497 respectively, and the characters single-quote, double-quote, and backslash
7498 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7499 addition, escapes the percent and underscore characters. This cannot be done
7500 for MySQL because these escapes are not recognized in contexts where these
7501 characters are not special.
7502
7503 .section "Specifying the server in the query" "SECTspeserque"
7504 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7505 it is possible to specify a list of servers with an individual query. This is
7506 done by starting the query with
7507 .display
7508 &`servers=`&&'server1:server2:server3:...'&&`;`&
7509 .endd
7510 Each item in the list may take one of two forms:
7511 .olist
7512 If it contains no slashes it is assumed to be just a host name. The appropriate
7513 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7514 of the same name, and the remaining parameters (database, user, password) are
7515 taken from there.
7516 .next
7517 If it contains any slashes, it is taken as a complete parameter set.
7518 .endlist
7519 The list of servers is used in exactly the same way as the global list.
7520 Once a connection to a server has happened and a query has been
7521 successfully executed, processing of the lookup ceases.
7522
7523 This feature is intended for use in master/slave situations where updates
7524 are occurring and you want to update the master rather than a slave. If the
7525 master is in the list as a backup for reading, you might have a global setting
7526 like this:
7527 .code
7528 mysql_servers = slave1/db/name/pw:\
7529                 slave2/db/name/pw:\
7530                 master/db/name/pw
7531 .endd
7532 In an updating lookup, you could then write:
7533 .code
7534 ${lookup mysql{servers=master; UPDATE ...} }
7535 .endd
7536 That query would then be sent only to the master server. If, on the other hand,
7537 the master is not to be used for reading, and so is not present in the global
7538 option, you can still update it by a query of this form:
7539 .code
7540 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7541 .endd
7542
7543
7544 .section "Special MySQL features" "SECID73"
7545 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7546 causes a connection to the server on the local host by means of a Unix domain
7547 socket. An alternate socket can be specified in parentheses. The full syntax of
7548 each item in &%mysql_servers%& is:
7549 .display
7550 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7551   <&'user'&>/<&'password'&>
7552 .endd
7553 Any of the three sub-parts of the first field can be omitted. For normal use on
7554 the local host it can be left blank or set to just &"localhost"&.
7555
7556 No database need be supplied &-- but if it is absent here, it must be given in
7557 the queries.
7558
7559 If a MySQL query is issued that does not request any data (an insert, update,
7560 or delete command), the result of the lookup is the number of rows affected.
7561
7562 &*Warning*&: This can be misleading. If an update does not actually change
7563 anything (for example, setting a field to the value it already has), the result
7564 is zero because no rows are affected.
7565
7566
7567 .section "Special PostgreSQL features" "SECID74"
7568 PostgreSQL lookups can also use Unix domain socket connections to the database.
7569 This is usually faster and costs less CPU time than a TCP/IP connection.
7570 However it can be used only if the mail server runs on the same machine as the
7571 database server. A configuration line for PostgreSQL via Unix domain sockets
7572 looks like this:
7573 .code
7574 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7575 .endd
7576 In other words, instead of supplying a host name, a path to the socket is
7577 given. The path name is enclosed in parentheses so that its slashes aren't
7578 visually confused with the delimiters for the other server parameters.
7579
7580 If a PostgreSQL query is issued that does not request any data (an insert,
7581 update, or delete command), the result of the lookup is the number of rows
7582 affected.
7583
7584 .section "More about SQLite" "SECTsqlite"
7585 .cindex "lookup" "SQLite"
7586 .cindex "sqlite lookup type"
7587 SQLite is different to the other SQL lookups because a file name is required in
7588 addition to the SQL query. An SQLite database is a single file, and there is no
7589 daemon as in the other SQL databases. The interface to Exim requires the name
7590 of the file, as an absolute path, to be given at the start of the query. It is
7591 separated from the query by white space. This means that the path name cannot
7592 contain white space. Here is a lookup expansion example:
7593 .code
7594 ${lookup sqlite {/some/thing/sqlitedb \
7595   select name from aliases where id='userx';}}
7596 .endd
7597 In a list, the syntax is similar. For example:
7598 .code
7599 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7600    select * from relays where ip='$sender_host_address';
7601 .endd
7602 The only character affected by the &%quote_sqlite%& operator is a single
7603 quote, which it doubles.
7604
7605 The SQLite library handles multiple simultaneous accesses to the database
7606 internally. Multiple readers are permitted, but only one process can
7607 update at once. Attempts to access the database while it is being updated
7608 are rejected after a timeout period, during which the SQLite library
7609 waits for the lock to be released. In Exim, the default timeout is set
7610 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7611 option.
7612 .ecindex IIDfidalo1
7613 .ecindex IIDfidalo2
7614
7615
7616 . ////////////////////////////////////////////////////////////////////////////
7617 . ////////////////////////////////////////////////////////////////////////////
7618
7619 .chapter "Domain, host, address, and local part lists" &&&
7620          "CHAPdomhosaddlists" &&&
7621          "Domain, host, and address lists"
7622 .scindex IIDdohoadli "lists of domains; hosts; etc."
7623 A number of Exim configuration options contain lists of domains, hosts,
7624 email addresses, or local parts. For example, the &%hold_domains%& option
7625 contains a list of domains whose delivery is currently suspended. These lists
7626 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7627 arguments to expansion conditions such as &%match_domain%&.
7628
7629 Each item in one of these lists is a pattern to be matched against a domain,
7630 host, email address, or local part, respectively. In the sections below, the
7631 different types of pattern for each case are described, but first we cover some
7632 general facilities that apply to all four kinds of list.
7633
7634
7635
7636 .section "Expansion of lists" "SECID75"
7637 .cindex "expansion" "of lists"
7638 Each list is expanded as a single string before it is used. The result of
7639 expansion must be a list, possibly containing empty items, which is split up
7640 into separate items for matching. By default, colon is the separator character,
7641 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7642 &<<SECTempitelis>>& for details of the list syntax; the second of these
7643 discusses the way to specify empty list items.
7644
7645
7646 If the string expansion is forced to fail, Exim behaves as if the item it is
7647 testing (domain, host, address, or local part) is not in the list. Other
7648 expansion failures cause temporary errors.
7649
7650 If an item in a list is a regular expression, backslashes, dollars and possibly
7651 other special characters in the expression must be protected against
7652 misinterpretation by the string expander. The easiest way to do this is to use
7653 the &`\N`& expansion feature to indicate that the contents of the regular
7654 expression should not be expanded. For example, in an ACL you might have:
7655 .code
7656 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7657                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7658 .endd
7659 The first item is a regular expression that is protected from expansion by
7660 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7661 senders based on the receiving domain.
7662
7663
7664
7665
7666 .section "Negated items in lists" "SECID76"
7667 .cindex "list" "negation"
7668 .cindex "negation" "in lists"
7669 Items in a list may be positive or negative. Negative items are indicated by a
7670 leading exclamation mark, which may be followed by optional white space. A list
7671 defines a set of items (domains, etc). When Exim processes one of these lists,
7672 it is trying to find out whether a domain, host, address, or local part
7673 (respectively) is in the set that is defined by the list. It works like this:
7674
7675 The list is scanned from left to right. If a positive item is matched, the
7676 subject that is being checked is in the set; if a negative item is matched, the
7677 subject is not in the set. If the end of the list is reached without the
7678 subject having matched any of the patterns, it is in the set if the last item
7679 was a negative one, but not if it was a positive one. For example, the list in
7680 .code
7681 domainlist relay_to_domains = !a.b.c : *.b.c
7682 .endd
7683 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7684 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7685 list is positive. However, if the setting were
7686 .code
7687 domainlist relay_to_domains = !a.b.c
7688 .endd
7689 then all domains other than &'a.b.c'& would match because the last item in the
7690 list is negative. In other words, a list that ends with a negative item behaves
7691 as if it had an extra item &`:*`& on the end.
7692
7693 Another way of thinking about positive and negative items in lists is to read
7694 the connector as &"or"& after a positive item and as &"and"& after a negative
7695 item.
7696
7697
7698
7699 .section "File names in lists" "SECTfilnamlis"
7700 .cindex "list" "file name in"
7701 If an item in a domain, host, address, or local part list is an absolute file
7702 name (beginning with a slash character), each line of the file is read and
7703 processed as if it were an independent item in the list, except that further
7704 file names are not allowed,
7705 and no expansion of the data from the file takes place.
7706 Empty lines in the file are ignored, and the file may also contain comment
7707 lines:
7708
7709 .ilist
7710 For domain and host lists, if a # character appears anywhere in a line of the
7711 file, it and all following characters are ignored.
7712 .next
7713 Because local parts may legitimately contain # characters, a comment in an
7714 address list or local part list file is recognized only if # is preceded by
7715 white space or the start of the line. For example:
7716 .code
7717 not#comment@x.y.z   # but this is a comment
7718 .endd
7719 .endlist
7720
7721 Putting a file name in a list has the same effect as inserting each line of the
7722 file as an item in the list (blank lines and comments excepted). However, there
7723 is one important difference: the file is read each time the list is processed,
7724 so if its contents vary over time, Exim's behaviour changes.
7725
7726 If a file name is preceded by an exclamation mark, the sense of any match
7727 within the file is inverted. For example, if
7728 .code
7729 hold_domains = !/etc/nohold-domains
7730 .endd
7731 and the file contains the lines
7732 .code
7733 !a.b.c
7734 *.b.c
7735 .endd
7736 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7737 any domain matching &`*.b.c`& is not.
7738
7739
7740
7741 .section "An lsearch file is not an out-of-line list" "SECID77"
7742 As will be described in the sections that follow, lookups can be used in lists
7743 to provide indexed methods of checking list membership. There has been some
7744 confusion about the way &(lsearch)& lookups work in lists. Because
7745 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7746 sometimes thought that it is allowed to contain wild cards and other kinds of
7747 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7748 always fixed strings, just as for any other single-key lookup type.
7749
7750 If you want to use a file to contain wild-card patterns that form part of a
7751 list, just give the file name on its own, without a search type, as described
7752 in the previous section. You could also use the &(wildlsearch)& or
7753 &(nwildlsearch)&, but there is no advantage in doing this.
7754
7755
7756
7757
7758 .section "Named lists" "SECTnamedlists"
7759 .cindex "named lists"
7760 .cindex "list" "named"
7761 A list of domains, hosts, email addresses, or local parts can be given a name
7762 which is then used to refer to the list elsewhere in the configuration. This is
7763 particularly convenient if the same list is required in several different
7764 places. It also allows lists to be given meaningful names, which can improve
7765 the readability of the configuration. For example, it is conventional to define
7766 a domain list called &'local_domains'& for all the domains that are handled
7767 locally on a host, using a configuration line such as
7768 .code
7769 domainlist local_domains = localhost:my.dom.example
7770 .endd
7771 Named lists are referenced by giving their name preceded by a plus sign, so,
7772 for example, a router that is intended to handle local domains would be
7773 configured with the line
7774 .code
7775 domains = +local_domains
7776 .endd
7777 The first router in a configuration is often one that handles all domains
7778 except the local ones, using a configuration with a negated item like this:
7779 .code
7780 dnslookup:
7781   driver = dnslookup
7782   domains = ! +local_domains
7783   transport = remote_smtp
7784   no_more
7785 .endd
7786 The four kinds of named list are created by configuration lines starting with
7787 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7788 respectively. Then there follows the name that you are defining, followed by an
7789 equals sign and the list itself. For example:
7790 .code
7791 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7792 addresslist bad_senders = cdb;/etc/badsenders
7793 .endd
7794 A named list may refer to other named lists:
7795 .code
7796 domainlist  dom1 = first.example : second.example
7797 domainlist  dom2 = +dom1 : third.example
7798 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7799 .endd
7800 &*Warning*&: If the last item in a referenced list is a negative one, the
7801 effect may not be what you intended, because the negation does not propagate
7802 out to the higher level. For example, consider:
7803 .code
7804 domainlist  dom1 = !a.b
7805 domainlist  dom2 = +dom1 : *.b
7806 .endd
7807 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7808 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7809 means it matches the second list as well. The effect is not the same as
7810 .code
7811 domainlist  dom2 = !a.b : *.b
7812 .endd
7813 where &'x.y'& does not match. It's best to avoid negation altogether in
7814 referenced lists if you can.
7815
7816 Named lists may have a performance advantage. When Exim is routing an
7817 address or checking an incoming message, it caches the result of tests on named
7818 lists. So, if you have a setting such as
7819 .code
7820 domains = +local_domains
7821 .endd
7822 on several of your routers
7823 or in several ACL statements,
7824 the actual test is done only for the first one. However, the caching works only
7825 if there are no expansions within the list itself or any sublists that it
7826 references. In other words, caching happens only for lists that are known to be
7827 the same each time they are referenced.
7828
7829 By default, there may be up to 16 named lists of each type. This limit can be
7830 extended by changing a compile-time variable. The use of domain and host lists
7831 is recommended for concepts such as local domains, relay domains, and relay
7832 hosts. The default configuration is set up like this.
7833
7834
7835
7836 .section "Named lists compared with macros" "SECID78"
7837 .cindex "list" "named compared with macro"
7838 .cindex "macro" "compared with named list"
7839 At first sight, named lists might seem to be no different from macros in the
7840 configuration file. However, macros are just textual substitutions. If you
7841 write
7842 .code
7843 ALIST = host1 : host2
7844 auth_advertise_hosts = !ALIST
7845 .endd
7846 it probably won't do what you want, because that is exactly the same as
7847 .code
7848 auth_advertise_hosts = !host1 : host2
7849 .endd
7850 Notice that the second host name is not negated. However, if you use a host
7851 list, and write
7852 .code
7853 hostlist alist = host1 : host2
7854 auth_advertise_hosts = ! +alist
7855 .endd
7856 the negation applies to the whole list, and so that is equivalent to
7857 .code
7858 auth_advertise_hosts = !host1 : !host2
7859 .endd
7860
7861
7862 .section "Named list caching" "SECID79"
7863 .cindex "list" "caching of named"
7864 .cindex "caching" "named lists"
7865 While processing a message, Exim caches the result of checking a named list if
7866 it is sure that the list is the same each time. In practice, this means that
7867 the cache operates only if the list contains no $ characters, which guarantees
7868 that it will not change when it is expanded. Sometimes, however, you may have
7869 an expanded list that you know will be the same each time within a given
7870 message. For example:
7871 .code
7872 domainlist special_domains = \
7873            ${lookup{$sender_host_address}cdb{/some/file}}
7874 .endd
7875 This provides a list of domains that depends only on the sending host's IP
7876 address. If this domain list is referenced a number of times (for example,
7877 in several ACL lines, or in several routers) the result of the check is not
7878 cached by default, because Exim does not know that it is going to be the
7879 same list each time.
7880
7881 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7882 cache the result anyway. For example:
7883 .code
7884 domainlist_cache special_domains = ${lookup{...
7885 .endd
7886 If you do this, you should be absolutely sure that caching is going to do
7887 the right thing in all cases. When in doubt, leave it out.
7888
7889
7890
7891 .section "Domain lists" "SECTdomainlist"
7892 .cindex "domain list" "patterns for"
7893 .cindex "list" "domain list"
7894 Domain lists contain patterns that are to be matched against a mail domain.
7895 The following types of item may appear in domain lists:
7896
7897 .ilist
7898 .cindex "primary host name"
7899 .cindex "host name" "matched in domain list"
7900 .oindex "&%primary_hostname%&"
7901 .cindex "domain list" "matching primary host name"
7902 .cindex "@ in a domain list"
7903 If a pattern consists of a single @ character, it matches the local host name,
7904 as set by the &%primary_hostname%& option (or defaulted). This makes it
7905 possible to use the same configuration file on several different hosts that
7906 differ only in their names.
7907 .next
7908 .cindex "@[] in a domain list"
7909 .cindex "domain list" "matching local IP interfaces"
7910 .cindex "domain literal"
7911 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7912 in square brackets (as in an email address that contains a domain literal), but
7913 only if that IP address is recognized as local for email routing purposes. The
7914 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7915 control which of a host's several IP addresses are treated as local.
7916 In today's Internet, the use of domain literals is controversial.
7917 .next
7918 .cindex "@mx_any"
7919 .cindex "@mx_primary"
7920 .cindex "@mx_secondary"
7921 .cindex "domain list" "matching MX pointers to local host"
7922 If a pattern consists of the string &`@mx_any`& it matches any domain that
7923 has an MX record pointing to the local host or to any host that is listed in
7924 .oindex "&%hosts_treat_as_local%&"
7925 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7926 are similar, except that the first matches only when a primary MX target is the
7927 local host, and the second only when no primary MX target is the local host,
7928 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7929 preference value &-- there may of course be more than one of them.
7930
7931 The MX lookup that takes place when matching a pattern of this type is
7932 performed with the resolver options for widening names turned off. Thus, for
7933 example, a single-component domain will &'not'& be expanded by adding the
7934 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7935 options of the &(dnslookup)& router for a discussion of domain widening.
7936
7937 Sometimes you may want to ignore certain IP addresses when using one of these
7938 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7939 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7940 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7941 on a router). For example:
7942 .code
7943 domains = @mx_any/ignore=127.0.0.1
7944 .endd
7945 This example matches any domain that has an MX record pointing to one of
7946 the local host's IP addresses other than 127.0.0.1.
7947
7948 The list of IP addresses is in fact processed by the same code that processes
7949 host lists, so it may contain CIDR-coded network specifications and it may also
7950 contain negative items.
7951
7952 Because the list of IP addresses is a sublist within a domain list, you have to
7953 be careful about delimiters if there is more than one address. Like any other
7954 list, the default delimiter can be changed. Thus, you might have:
7955 .code
7956 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7957           an.other.domain : ...
7958 .endd
7959 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7960 involved, it is easiest to change the delimiter for the main list as well:
7961 .code
7962 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7963           an.other.domain ? ...
7964 .endd
7965 .next
7966 .cindex "asterisk" "in domain list"
7967 .cindex "domain list" "asterisk in"
7968 .cindex "domain list" "matching &""ends with""&"
7969 If a pattern starts with an asterisk, the remaining characters of the pattern
7970 are compared with the terminating characters of the domain. The use of &"*"& in
7971 domain lists differs from its use in partial matching lookups. In a domain
7972 list, the character following the asterisk need not be a dot, whereas partial
7973 matching works only in terms of dot-separated components. For example, a domain
7974 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7975 &'cipher.key.ex'&.
7976
7977 .next
7978 .cindex "regular expressions" "in domain list"
7979 .cindex "domain list" "matching regular expression"
7980 If a pattern starts with a circumflex character, it is treated as a regular
7981 expression, and matched against the domain using a regular expression matching
7982 function. The circumflex is treated as part of the regular expression.
7983 Email domains are case-independent, so this regular expression match is by
7984 default case-independent, but you can make it case-dependent by starting it
7985 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7986 are given in chapter &<<CHAPregexp>>&.
7987
7988 &*Warning*&: Because domain lists are expanded before being processed, you
7989 must escape any backslash and dollar characters in the regular expression, or
7990 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7991 it is not to be expanded (unless you really do want to build a regular
7992 expression by expansion, of course).
7993 .next
7994 .cindex "lookup" "in domain list"
7995 .cindex "domain list" "matching by lookup"
7996 If a pattern starts with the name of a single-key lookup type followed by a
7997 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7998 must be a file name in a suitable format for the lookup type. For example, for
7999 &"cdb;"& it must be an absolute path:
8000 .code
8001 domains = cdb;/etc/mail/local_domains.cdb
8002 .endd
8003 The appropriate type of lookup is done on the file using the domain name as the
8004 key. In most cases, the data that is looked up is not used; Exim is interested
8005 only in whether or not the key is present in the file. However, when a lookup
8006 is used for the &%domains%& option on a router
8007 or a &%domains%& condition in an ACL statement, the data is preserved in the
8008 &$domain_data$& variable and can be referred to in other router options or
8009 other statements in the same ACL.
8010
8011 .next
8012 Any of the single-key lookup type names may be preceded by
8013 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8014 .code
8015 domains = partial-dbm;/partial/domains
8016 .endd
8017 This causes partial matching logic to be invoked; a description of how this
8018 works is given in section &<<SECTpartiallookup>>&.
8019
8020 .next
8021 .cindex "asterisk" "in lookup type"
8022 Any of the single-key lookup types may be followed by an asterisk. This causes
8023 a default lookup for a key consisting of a single asterisk to be done if the
8024 original lookup fails. This is not a useful feature when using a domain list to
8025 select particular domains (because any domain would match), but it might have
8026 value if the result of the lookup is being used via the &$domain_data$&
8027 expansion variable.
8028 .next
8029 If the pattern starts with the name of a query-style lookup type followed by a
8030 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8031 pattern must be an appropriate query for the lookup type, as described in
8032 chapter &<<CHAPfdlookup>>&. For example:
8033 .code
8034 hold_domains = mysql;select domain from holdlist \
8035   where domain = '${quote_mysql:$domain}';
8036 .endd
8037 In most cases, the data that is looked up is not used (so for an SQL query, for
8038 example, it doesn't matter what field you select). Exim is interested only in
8039 whether or not the query succeeds. However, when a lookup is used for the
8040 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8041 variable and can be referred to in other options.
8042 .next
8043 .cindex "domain list" "matching literal domain name"
8044 If none of the above cases apply, a caseless textual comparison is made
8045 between the pattern and the domain.
8046 .endlist
8047
8048 Here is an example that uses several different kinds of pattern:
8049 .code
8050 domainlist funny_domains = \
8051   @ : \
8052   lib.unseen.edu : \
8053   *.foundation.fict.example : \
8054   \N^[1-2]\d{3}\.fict\.example$\N : \
8055   partial-dbm;/opt/data/penguin/book : \
8056   nis;domains.byname : \
8057   nisplus;[name=$domain,status=local],domains.org_dir
8058 .endd
8059 There are obvious processing trade-offs among the various matching modes. Using
8060 an asterisk is faster than a regular expression, and listing a few names
8061 explicitly probably is too. The use of a file or database lookup is expensive,
8062 but may be the only option if hundreds of names are required. Because the
8063 patterns are tested in order, it makes sense to put the most commonly matched
8064 patterns earlier.
8065
8066
8067
8068 .section "Host lists" "SECThostlist"
8069 .cindex "host list" "patterns in"
8070 .cindex "list" "host list"
8071 Host lists are used to control what remote hosts are allowed to do. For
8072 example, some hosts may be allowed to use the local host as a relay, and some
8073 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8074 two different ways, by name or by IP address. In a host list, some types of
8075 pattern are matched to a host name, and some are matched to an IP address.
8076 You need to be particularly careful with this when single-key lookups are
8077 involved, to ensure that the right value is being used as the key.
8078
8079
8080 .section "Special host list patterns" "SECID80"
8081 .cindex "empty item in hosts list"
8082 .cindex "host list" "empty string in"
8083 If a host list item is the empty string, it matches only when no remote host is
8084 involved. This is the case when a message is being received from a local
8085 process using SMTP on the standard input, that is, when a TCP/IP connection is
8086 not used.
8087
8088 .cindex "asterisk" "in host list"
8089 The special pattern &"*"& in a host list matches any host or no host. Neither
8090 the IP address nor the name is actually inspected.
8091
8092
8093
8094 .section "Host list patterns that match by IP address" "SECThoslispatip"
8095 .cindex "host list" "matching IP addresses"
8096 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8097 the incoming address actually appears in the IPv6 host as
8098 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8099 list, it is converted into a traditional IPv4 address first. (Not all operating
8100 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8101 concerns.)
8102
8103 The following types of pattern in a host list check the remote host by
8104 inspecting its IP address:
8105
8106 .ilist
8107 If the pattern is a plain domain name (not a regular expression, not starting
8108 with *, not a lookup of any kind), Exim calls the operating system function
8109 to find the associated IP address(es). Exim uses the newer
8110 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8111 This typically causes a forward DNS lookup of the name. The result is compared
8112 with the IP address of the subject host.
8113
8114 If there is a temporary problem (such as a DNS timeout) with the host name
8115 lookup, a temporary error occurs. For example, if the list is being used in an
8116 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8117 temporary SMTP error code. If no IP address can be found for the host name,
8118 what happens is described in section &<<SECTbehipnot>>& below.
8119
8120 .next
8121 .cindex "@ in a host list"
8122 If the pattern is &"@"&, the primary host name is substituted and used as a
8123 domain name, as just described.
8124
8125 .next
8126 If the pattern is an IP address, it is matched against the IP address of the
8127 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8128 IPv6 addresses can be given in colon-separated format, but the colons have to
8129 be doubled so as not to be taken as item separators when the default list
8130 separator is used. IPv6 addresses are recognized even when Exim is compiled
8131 without IPv6 support. This means that if they appear in a host list on an
8132 IPv4-only host, Exim will not treat them as host names. They are just addresses
8133 that can never match a client host.
8134
8135 .next
8136 .cindex "@[] in a host list"
8137 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8138 the local host. For example, if the local host is an IPv4 host with one
8139 interface address 10.45.23.56, these two ACL statements have the same effect:
8140 .code
8141 accept hosts = 127.0.0.1 : 10.45.23.56
8142 accept hosts = @[]
8143 .endd
8144 .next
8145 .cindex "CIDR notation"
8146 If the pattern is an IP address followed by a slash and a mask length (for
8147 example 10.11.42.0/24), it is matched against the IP address of the subject
8148 host under the given mask. This allows, an entire network of hosts to be
8149 included (or excluded) by a single item. The mask uses CIDR notation; it
8150 specifies the number of address bits that must match, starting from the most
8151 significant end of the address.
8152
8153 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8154 of a range of addresses. It is the number of bits in the network portion of the
8155 address. The above example specifies a 24-bit netmask, so it matches all 256
8156 addresses in the 10.11.42.0 network. An item such as
8157 .code
8158 192.168.23.236/31
8159 .endd
8160 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8161 32 for an IPv4 address is the same as no mask at all; just a single address
8162 matches.
8163
8164 Here is another example which shows an IPv4 and an IPv6 network:
8165 .code
8166 recipient_unqualified_hosts = 192.168.0.0/16: \
8167                               3ffe::ffff::836f::::/48
8168 .endd
8169 The doubling of list separator characters applies only when these items
8170 appear inline in a host list. It is not required when indirecting via a file.
8171 For example:
8172 .code
8173 recipient_unqualified_hosts = /opt/exim/unqualnets
8174 .endd
8175 could make use of a file containing
8176 .code
8177 172.16.0.0/12
8178 3ffe:ffff:836f::/48
8179 .endd
8180 to have exactly the same effect as the previous example. When listing IPv6
8181 addresses inline, it is usually more convenient to use the facility for
8182 changing separator characters. This list contains the same two networks:
8183 .code
8184 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8185                                  3ffe:ffff:836f::/48
8186 .endd
8187 The separator is changed to semicolon by the leading &"<;"& at the start of the
8188 list.
8189 .endlist
8190
8191
8192
8193 .section "Host list patterns for single-key lookups by host address" &&&
8194          "SECThoslispatsikey"
8195 .cindex "host list" "lookup of IP address"
8196 When a host is to be identified by a single-key lookup of its complete IP
8197 address, the pattern takes this form:
8198 .display
8199 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8200 .endd
8201 For example:
8202 .code
8203 hosts_lookup = net-cdb;/hosts-by-ip.db
8204 .endd
8205 The text form of the IP address of the subject host is used as the lookup key.
8206 IPv6 addresses are converted to an unabbreviated form, using lower case
8207 letters, with dots as separators because colon is the key terminator in
8208 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8209 quoting the keys, but this is a facility that was added later.] The data
8210 returned by the lookup is not used.
8211
8212 .cindex "IP address" "masking"
8213 .cindex "host list" "masked IP address"
8214 Single-key lookups can also be performed using masked IP addresses, using
8215 patterns of this form:
8216 .display
8217 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8218 .endd
8219 For example:
8220 .code
8221 net24-dbm;/networks.db
8222 .endd
8223 The IP address of the subject host is masked using <&'number'&> as the mask
8224 length. A textual string is constructed from the masked value, followed by the
8225 mask, and this is used as the lookup key. For example, if the host's IP address
8226 is 192.168.34.6, the key that is looked up for the above example is
8227 &"192.168.34.0/24"&.
8228
8229 When an IPv6 address is converted to a string, dots are normally used instead
8230 of colons, so that keys in &(lsearch)& files need not contain colons (which
8231 terminate &(lsearch)& keys). This was implemented some time before the ability
8232 to quote keys was made available in &(lsearch)& files. However, the more
8233 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8234 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8235 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8236 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8237 addresses are always used.
8238
8239 Ideally, it would be nice to tidy up this anomalous situation by changing to
8240 colons in all cases, given that quoting is now available for &(lsearch)&.
8241 However, this would be an incompatible change that might break some existing
8242 configurations.
8243
8244 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8245 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8246 the former case the key strings include the mask value, whereas in the latter
8247 case the IP address is used on its own.
8248
8249
8250
8251 .section "Host list patterns that match by host name" "SECThoslispatnam"
8252 .cindex "host" "lookup failures"
8253 .cindex "unknown host name"
8254 .cindex "host list" "matching host name"
8255 There are several types of pattern that require Exim to know the name of the
8256 remote host. These are either wildcard patterns or lookups by name. (If a
8257 complete hostname is given without any wildcarding, it is used to find an IP
8258 address to match against, as described in section &<<SECThoslispatip>>&
8259 above.)
8260
8261 If the remote host name is not already known when Exim encounters one of these
8262 patterns, it has to be found from the IP address.
8263 Although many sites on the Internet are conscientious about maintaining reverse
8264 DNS data for their hosts, there are also many that do not do this.
8265 Consequently, a name cannot always be found, and this may lead to unwanted
8266 effects. Take care when configuring host lists with wildcarded name patterns.
8267 Consider what will happen if a name cannot be found.
8268
8269 Because of the problems of determining host names from IP addresses, matching
8270 against host names is not as common as matching against IP addresses.
8271
8272 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8273 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8274 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8275 are done can be changed by setting the &%host_lookup_order%& option. For
8276 security, once Exim has found one or more names, it looks up the IP addresses
8277 for these names and compares them with the IP address that it started with.
8278 Only those names whose IP addresses match are accepted. Any other names are
8279 discarded. If no names are left, Exim behaves as if the host name cannot be
8280 found. In the most common case there is only one name and one IP address.
8281
8282 There are some options that control what happens if a host name cannot be
8283 found. These are described in section &<<SECTbehipnot>>& below.
8284
8285 .cindex "host" "alias for"
8286 .cindex "alias for host"
8287 As a result of aliasing, hosts may have more than one name. When processing any
8288 of the following types of pattern, all the host's names are checked:
8289
8290 .ilist
8291 .cindex "asterisk" "in host list"
8292 If a pattern starts with &"*"& the remainder of the item must match the end of
8293 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8294 &'.b.c'&. This special simple form is provided because this is a very common
8295 requirement. Other kinds of wildcarding require the use of a regular
8296 expression.
8297 .next
8298 .cindex "regular expressions" "in host list"
8299 .cindex "host list" "regular expression in"
8300 If the item starts with &"^"& it is taken to be a regular expression which is
8301 matched against the host name. Host names are case-independent, so this regular
8302 expression match is by default case-independent, but you can make it
8303 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8304 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8305 example,
8306 .code
8307 ^(a|b)\.c\.d$
8308 .endd
8309 is a regular expression that matches either of the two hosts &'a.c.d'& or
8310 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8311 that backslash and dollar characters are not misinterpreted as part of the
8312 string expansion. The simplest way to do this is to use &`\N`& to mark that
8313 part of the string as non-expandable. For example:
8314 .code
8315 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8316 .endd
8317 &*Warning*&: If you want to match a complete host name, you must include the
8318 &`$`& terminating metacharacter in the regular expression, as in the above
8319 example. Without it, a match at the start of the host name is all that is
8320 required.
8321 .endlist
8322
8323
8324
8325
8326 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8327 .cindex "host" "lookup failures, permanent"
8328 While processing a host list, Exim may need to look up an IP address from a
8329 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8330 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8331 behaviour when it fails to find the information it is seeking is the same.
8332
8333 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8334 apply to temporary DNS errors, whose handling is described in the next section.
8335
8336 .cindex "&`+include_unknown`&"
8337 .cindex "&`+ignore_unknown`&"
8338 Exim parses a host list from left to right. If it encounters a permanent
8339 lookup failure in any item in the host list before it has found a match,
8340 Exim treats it as a failure and the default behavior is as if the host
8341 does not match the list. This may not always be what you want to happen.
8342 To change Exim's behaviour, the special items &`+include_unknown`& or
8343 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8344 not recognized in an indirected file).
8345
8346 .ilist
8347 If any item that follows &`+include_unknown`& requires information that
8348 cannot found, Exim behaves as if the host does match the list. For example,
8349 .code
8350 host_reject_connection = +include_unknown:*.enemy.ex
8351 .endd
8352 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8353 any hosts whose name it cannot find.
8354
8355 .next
8356 If any item that follows &`+ignore_unknown`& requires information that cannot
8357 be found, Exim ignores that item and proceeds to the rest of the list. For
8358 example:
8359 .code
8360 accept hosts = +ignore_unknown : friend.example : \
8361                192.168.4.5
8362 .endd
8363 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8364 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8365 name can be found for 192.168.4.5, it is rejected.
8366 .endlist
8367
8368 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8369 list. The effect of each one lasts until the next, or until the end of the
8370 list.
8371
8372 .section "Mixing wildcarded host names and addresses in host lists" &&&
8373          "SECTmixwilhos"
8374 .cindex "host list" "mixing names and addresses in"
8375
8376 This section explains the host/ip processing logic with the same concepts
8377 as the previous section, but specifically addresses what happens when a
8378 wildcarded hostname is one of the items in the hostlist.
8379
8380 .ilist
8381 If you have name lookups or wildcarded host names and
8382 IP addresses in the same host list, you should normally put the IP
8383 addresses first. For example, in an ACL you could have:
8384 .code
8385 accept hosts = 10.9.8.7 : *.friend.example
8386 .endd
8387 The reason you normally would order it this way lies in the
8388 left-to-right way that Exim processes lists.  It can test IP addresses
8389 without doing any DNS lookups, but when it reaches an item that requires
8390 a host name, it fails if it cannot find a host name to compare with the
8391 pattern. If the above list is given in the opposite order, the
8392 &%accept%& statement fails for a host whose name cannot be found, even
8393 if its IP address is 10.9.8.7.
8394
8395 .next
8396 If you really do want to do the name check first, and still recognize the IP
8397 address, you can rewrite the ACL like this:
8398 .code
8399 accept hosts = *.friend.example
8400 accept hosts = 10.9.8.7
8401 .endd
8402 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8403 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8404 &`+ignore_unknown`&, which was discussed in depth in the first example in
8405 this section.
8406 .endlist
8407
8408
8409 .section "Temporary DNS errors when looking up host information" &&&
8410          "SECTtemdnserr"
8411 .cindex "host" "lookup failures, temporary"
8412 .cindex "&`+include_defer`&"
8413 .cindex "&`+ignore_defer`&"
8414 A temporary DNS lookup failure normally causes a defer action (except when
8415 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8416 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8417 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8418 section. These options should be used with care, probably only in non-critical
8419 host lists such as whitelists.
8420
8421
8422
8423 .section "Host list patterns for single-key lookups by host name" &&&
8424          "SECThoslispatnamsk"
8425 .cindex "unknown host name"
8426 .cindex "host list" "matching host name"
8427 If a pattern is of the form
8428 .display
8429 <&'single-key-search-type'&>;<&'search-data'&>
8430 .endd
8431 for example
8432 .code
8433 dbm;/host/accept/list
8434 .endd
8435 a single-key lookup is performed, using the host name as its key. If the
8436 lookup succeeds, the host matches the item. The actual data that is looked up
8437 is not used.
8438
8439 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8440 keys in the file, not IP addresses. If you want to do lookups based on IP
8441 addresses, you must precede the search type with &"net-"& (see section
8442 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8443 two items in the same list, one doing an address lookup and one doing a name
8444 lookup, both using the same file.
8445
8446
8447
8448 .section "Host list patterns for query-style lookups" "SECID81"
8449 If a pattern is of the form
8450 .display
8451 <&'query-style-search-type'&>;<&'query'&>
8452 .endd
8453 the query is obeyed, and if it succeeds, the host matches the item. The actual
8454 data that is looked up is not used. The variables &$sender_host_address$& and
8455 &$sender_host_name$& can be used in the query. For example:
8456 .code
8457 hosts_lookup = pgsql;\
8458   select ip from hostlist where ip='$sender_host_address'
8459 .endd
8460 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8461 can use the &%sg%& expansion item to change this if you need to. If you want to
8462 use masked IP addresses in database queries, you can use the &%mask%& expansion
8463 operator.
8464
8465 If the query contains a reference to &$sender_host_name$&, Exim automatically
8466 looks up the host name if it has not already done so. (See section
8467 &<<SECThoslispatnam>>& for comments on finding host names.)
8468
8469 Historical note: prior to release 4.30, Exim would always attempt to find a
8470 host name before running the query, unless the search type was preceded by
8471 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8472 still recognized for query-style lookups, but its presence or absence has no
8473 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8474 See section &<<SECThoslispatsikey>>&.)
8475
8476
8477
8478
8479
8480 .section "Address lists" "SECTaddresslist"
8481 .cindex "list" "address list"
8482 .cindex "address list" "empty item"
8483 .cindex "address list" "patterns"
8484 Address lists contain patterns that are matched against mail addresses. There
8485 is one special case to be considered: the sender address of a bounce message is
8486 always empty. You can test for this by providing an empty item in an address
8487 list. For example, you can set up a router to process bounce messages by
8488 using this option setting:
8489 .code
8490 senders = :
8491 .endd
8492 The presence of the colon creates an empty item. If you do not provide any
8493 data, the list is empty and matches nothing. The empty sender can also be
8494 detected by a regular expression that matches an empty string,
8495 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8496
8497 Non-empty items in an address list can be straightforward email addresses. For
8498 example:
8499 .code
8500 senders = jbc@askone.example : hs@anacreon.example
8501 .endd
8502 A certain amount of wildcarding is permitted. If a pattern contains an @
8503 character, but is not a regular expression and does not begin with a
8504 semicolon-terminated lookup type (described below), the local part of the
8505 subject address is compared with the local part of the pattern, which may start
8506 with an asterisk. If the local parts match, the domain is checked in exactly
8507 the same way as for a pattern in a domain list. For example, the domain can be
8508 wildcarded, refer to a named list, or be a lookup:
8509 .code
8510 deny senders = *@*.spamming.site:\
8511                *@+hostile_domains:\
8512                bozo@partial-lsearch;/list/of/dodgy/sites:\
8513                *@dbm;/bad/domains.db
8514 .endd
8515 .cindex "local part" "starting with !"
8516 .cindex "address list" "local part starting with !"
8517 If a local part that begins with an exclamation mark is required, it has to be
8518 specified using a regular expression, because otherwise the exclamation mark is
8519 treated as a sign of negation, as is standard in lists.
8520
8521 If a non-empty pattern that is not a regular expression or a lookup does not
8522 contain an @ character, it is matched against the domain part of the subject
8523 address. The only two formats that are recognized this way are a literal
8524 domain, or a domain pattern that starts with *. In both these cases, the effect
8525 is the same as if &`*@`& preceded the pattern. For example:
8526 .code
8527 deny senders = enemy.domain : *.enemy.domain
8528 .endd
8529
8530 The following kinds of more complicated address list pattern can match any
8531 address, including the empty address that is characteristic of bounce message
8532 senders:
8533
8534 .ilist
8535 .cindex "regular expressions" "in address list"
8536 .cindex "address list" "regular expression in"
8537 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8538 done against the complete address, with the pattern as the regular expression.
8539 You must take care that backslash and dollar characters are not misinterpreted
8540 as part of the string expansion. The simplest way to do this is to use &`\N`&
8541 to mark that part of the string as non-expandable. For example:
8542 .code
8543 deny senders = \N^.*this.*@example\.com$\N : \
8544                \N^\d{8}.+@spamhaus.example$\N : ...
8545 .endd
8546 The &`\N`& sequences are removed by the expansion, so these items do indeed
8547 start with &"^"& by the time they are being interpreted as address patterns.
8548
8549 .next
8550 .cindex "address list" "lookup for complete address"
8551 Complete addresses can be looked up by using a pattern that starts with a
8552 lookup type terminated by a semicolon, followed by the data for the lookup. For
8553 example:
8554 .code
8555 deny senders = cdb;/etc/blocked.senders : \
8556   mysql;select address from blocked where \
8557   address='${quote_mysql:$sender_address}'
8558 .endd
8559 Both query-style and single-key lookup types can be used. For a single-key
8560 lookup type, Exim uses the complete address as the key. However, empty keys are
8561 not supported for single-key lookups, so a match against the empty address
8562 always fails. This restriction does not apply to query-style lookups.
8563
8564 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8565 cannot be used, and is ignored if specified, with an entry being written to the
8566 panic log.
8567 .cindex "*@ with single-key lookup"
8568 However, you can configure lookup defaults, as described in section
8569 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8570 default. For example, with this lookup:
8571 .code
8572 accept senders = lsearch*@;/some/file
8573 .endd
8574 the file could contains lines like this:
8575 .code
8576 user1@domain1.example
8577 *@domain2.example
8578 .endd
8579 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8580 that are tried is:
8581 .code
8582 nimrod@jaeger.example
8583 *@jaeger.example
8584 *
8585 .endd
8586 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8587 would mean that every address matches, thus rendering the test useless.
8588
8589 &*Warning 2*&: Do not confuse these two kinds of item:
8590 .code
8591 deny recipients = dbm*@;/some/file
8592 deny recipients = *@dbm;/some/file
8593 .endd
8594 The first does a whole address lookup, with defaulting, as just described,
8595 because it starts with a lookup type. The second matches the local part and
8596 domain independently, as described in a bullet point below.
8597 .endlist
8598
8599
8600 The following kinds of address list pattern can match only non-empty addresses.
8601 If the subject address is empty, a match against any of these pattern types
8602 always fails.
8603
8604
8605 .ilist
8606 .cindex "@@ with single-key lookup"
8607 .cindex "address list" "@@ lookup type"
8608 .cindex "address list" "split local part and domain"
8609 If a pattern starts with &"@@"& followed by a single-key lookup item
8610 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8611 split into a local part and a domain. The domain is looked up in the file. If
8612 it is not found, there is no match. If it is found, the data that is looked up
8613 from the file is treated as a colon-separated list of local part patterns, each
8614 of which is matched against the subject local part in turn.
8615
8616 .cindex "asterisk" "in address list"
8617 The lookup may be a partial one, and/or one involving a search for a default
8618 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8619 patterns that are looked up can be regular expressions or begin with &"*"&, or
8620 even be further lookups. They may also be independently negated. For example,
8621 with
8622 .code
8623 deny senders = @@dbm;/etc/reject-by-domain
8624 .endd
8625 the data from which the DBM file is built could contain lines like
8626 .code
8627 baddomain.com:  !postmaster : *
8628 .endd
8629 to reject all senders except &%postmaster%& from that domain.
8630
8631 .cindex "local part" "starting with !"
8632 If a local part that actually begins with an exclamation mark is required, it
8633 has to be specified using a regular expression. In &(lsearch)& files, an entry
8634 may be split over several lines by indenting the second and subsequent lines,
8635 but the separating colon must still be included at line breaks. White space
8636 surrounding the colons is ignored. For example:
8637 .code
8638 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8639   spammer3 : spammer4
8640 .endd
8641 As in all colon-separated lists in Exim, a colon can be included in an item by
8642 doubling.
8643
8644 If the last item in the list starts with a right angle-bracket, the remainder
8645 of the item is taken as a new key to look up in order to obtain a continuation
8646 list of local parts. The new key can be any sequence of characters. Thus one
8647 might have entries like
8648 .code
8649 aol.com: spammer1 : spammer 2 : >*
8650 xyz.com: spammer3 : >*
8651 *:       ^\d{8}$
8652 .endd
8653 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8654 local parts for all domains, in addition to the specific local parts listed for
8655 each domain. Of course, using this feature costs another lookup each time a
8656 chain is followed, but the effort needed to maintain the data is reduced.
8657
8658 .cindex "loop" "in lookups"
8659 It is possible to construct loops using this facility, and in order to catch
8660 them, the chains may be no more than fifty items long.
8661
8662 .next
8663 The @@<&'lookup'&> style of item can also be used with a query-style
8664 lookup, but in this case, the chaining facility is not available. The lookup
8665 can only return a single list of local parts.
8666 .endlist
8667
8668 &*Warning*&: There is an important difference between the address list items
8669 in these two examples:
8670 .code
8671 senders = +my_list
8672 senders = *@+my_list
8673 .endd
8674 In the first one, &`my_list`& is a named address list, whereas in the second
8675 example it is a named domain list.
8676
8677
8678
8679
8680 .section "Case of letters in address lists" "SECTcasletadd"
8681 .cindex "case of local parts"
8682 .cindex "address list" "case forcing"
8683 .cindex "case forcing in address lists"
8684 Domains in email addresses are always handled caselessly, but for local parts
8685 case may be significant on some systems (see &%caseful_local_part%& for how
8686 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8687 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8688 blocking lists should be done in a case-independent manner. Since most address
8689 lists in Exim are used for this kind of control, Exim attempts to do this by
8690 default.
8691
8692 The domain portion of an address is always lowercased before matching it to an
8693 address list. The local part is lowercased by default, and any string
8694 comparisons that take place are done caselessly. This means that the data in
8695 the address list itself, in files included as plain file names, and in any file
8696 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8697 keys in files that are looked up by a search type other than &(lsearch)& (which
8698 works caselessly) must be in lower case, because these lookups are not
8699 case-independent.
8700
8701 .cindex "&`+caseful`&"
8702 To allow for the possibility of caseful address list matching, if an item in
8703 an address list is the string &"+caseful"&, the original case of the local
8704 part is restored for any comparisons that follow, and string comparisons are no
8705 longer case-independent. This does not affect the domain, which remains in
8706 lower case. However, although independent matches on the domain alone are still
8707 performed caselessly, regular expressions that match against an entire address
8708 become case-sensitive after &"+caseful"& has been seen.
8709
8710
8711
8712 .section "Local part lists" "SECTlocparlis"
8713 .cindex "list" "local part list"
8714 .cindex "local part" "list"
8715 Case-sensitivity in local part lists is handled in the same way as for address
8716 lists, as just described. The &"+caseful"& item can be used if required. In a
8717 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8718 set false, the subject is lowercased and the matching is initially
8719 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8720 matching in the local part list, but not elsewhere in the router. If
8721 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8722 option is case-sensitive from the start.
8723
8724 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8725 comments are handled in the same way as address lists &-- they are recognized
8726 only if the # is preceded by white space or the start of the line.
8727 Otherwise, local part lists are matched in the same way as domain lists, except
8728 that the special items that refer to the local host (&`@`&, &`@[]`&,
8729 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8730 Refer to section &<<SECTdomainlist>>& for details of the other available item
8731 types.
8732 .ecindex IIDdohoadli
8733
8734
8735
8736
8737 . ////////////////////////////////////////////////////////////////////////////
8738 . ////////////////////////////////////////////////////////////////////////////
8739
8740 .chapter "String expansions" "CHAPexpand"
8741 .scindex IIDstrexp "expansion" "of strings"
8742 Many strings in Exim's run time configuration are expanded before use. Some of
8743 them are expanded every time they are used; others are expanded only once.
8744
8745 When a string is being expanded it is copied verbatim from left to right except
8746 when a dollar or backslash character is encountered. A dollar specifies the
8747 start of a portion of the string that is interpreted and replaced as described
8748 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8749 escape character, as described in the following section.
8750
8751 Whether a string is expanded depends upon the context.  Usually this is solely
8752 dependent upon the option for which a value is sought; in this documentation,
8753 options for which string expansion is performed are marked with &dagger; after
8754 the data type.  ACL rules always expand strings.  A couple of expansion
8755 conditions do not expand some of the brace-delimited branches, for security
8756 reasons.
8757
8758
8759
8760 .section "Literal text in expanded strings" "SECTlittext"
8761 .cindex "expansion" "including literal text"
8762 An uninterpreted dollar can be included in an expanded string by putting a
8763 backslash in front of it. A backslash can be used to prevent any special
8764 character being treated specially in an expansion, including backslash itself.
8765 If the string appears in quotes in the configuration file, two backslashes are
8766 required because the quotes themselves cause interpretation of backslashes when
8767 the string is read in (see section &<<SECTstrings>>&).
8768
8769 .cindex "expansion" "non-expandable substrings"
8770 A portion of the string can specified as non-expandable by placing it between
8771 two occurrences of &`\N`&. This is particularly useful for protecting regular
8772 expressions, which often contain backslashes and dollar signs. For example:
8773 .code
8774 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8775 .endd
8776 On encountering the first &`\N`&, the expander copies subsequent characters
8777 without interpretation until it reaches the next &`\N`& or the end of the
8778 string.
8779
8780
8781
8782 .section "Character escape sequences in expanded strings" "SECID82"
8783 .cindex "expansion" "escape sequences"
8784 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8785 expanded string is recognized as an escape sequence for the character newline,
8786 carriage return, or tab, respectively. A backslash followed by up to three
8787 octal digits is recognized as an octal encoding for a single character, and a
8788 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8789 encoding.
8790
8791 These escape sequences are also recognized in quoted strings when they are read
8792 in. Their interpretation in expansions as well is useful for unquoted strings,
8793 and for other cases such as looked-up strings that are then expanded.
8794
8795
8796 .section "Testing string expansions" "SECID83"
8797 .cindex "expansion" "testing"
8798 .cindex "testing" "string expansion"
8799 .oindex "&%-be%&"
8800 Many expansions can be tested by calling Exim with the &%-be%& option. This
8801 takes the command arguments, or lines from the standard input if there are no
8802 arguments, runs them through the string expansion code, and writes the results
8803 to the standard output. Variables based on configuration values are set up, but
8804 since no message is being processed, variables such as &$local_part$& have no
8805 value. Nevertheless the &%-be%& option can be useful for checking out file and
8806 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8807 and &%nhash%&.
8808
8809 Exim gives up its root privilege when it is called with the &%-be%& option, and
8810 instead runs under the uid and gid it was called with, to prevent users from
8811 using &%-be%& for reading files to which they do not have access.
8812
8813 .oindex "&%-bem%&"
8814 If you want to test expansions that include variables whose values are taken
8815 from a message, there are two other options that can be used. The &%-bem%&
8816 option is like &%-be%& except that it is followed by a file name. The file is
8817 read as a message before doing the test expansions. For example:
8818 .code
8819 exim -bem /tmp/test.message '$h_subject:'
8820 .endd
8821 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8822 Exim message identifier. For example:
8823 .code
8824 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8825 .endd
8826 This loads the message from Exim's spool before doing the test expansions, and
8827 is therefore restricted to admin users.
8828
8829
8830 .section "Forced expansion failure" "SECTforexpfai"
8831 .cindex "expansion" "forced failure"
8832 A number of expansions that are described in the following section have
8833 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8834 (which are sometimes called &"curly brackets"&). Which of the two strings is
8835 used depends on some condition that is evaluated as part of the expansion. If,
8836 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8837 the entire string expansion fails in a way that can be detected by the code
8838 that requested the expansion. This is called &"forced expansion failure"&, and
8839 its consequences depend on the circumstances. In some cases it is no different
8840 from any other expansion failure, but in others a different action may be
8841 taken. Such variations are mentioned in the documentation of the option that is
8842 being expanded.
8843
8844
8845
8846
8847 .section "Expansion items" "SECTexpansionitems"
8848 The following items are recognized in expanded strings. White space may be used
8849 between sub-items that are keywords or substrings enclosed in braces inside an
8850 outer set of braces, to improve readability. &*Warning*&: Within braces,
8851 white space is significant.
8852
8853 .vlist
8854 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8855 .cindex "expansion" "variables"
8856 Substitute the contents of the named variable, for example:
8857 .code
8858 $local_part
8859 ${domain}
8860 .endd
8861 The second form can be used to separate the name from subsequent alphanumeric
8862 characters. This form (using braces) is available only for variables; it does
8863 &'not'& apply to message headers. The names of the variables are given in
8864 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8865 given, the expansion fails.
8866
8867 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8868 .cindex "expansion" "operators"
8869 The string is first itself expanded, and then the operation specified by
8870 <&'op'&> is applied to it. For example:
8871 .code
8872 ${lc:$local_part}
8873 .endd
8874 The string starts with the first character after the colon, which may be
8875 leading white space. A list of operators is given in section &<<SECTexpop>>&
8876 below. The operator notation is used for simple expansion items that have just
8877 one argument, because it reduces the number of braces and therefore makes the
8878 string easier to understand.
8879
8880 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8881 This item inserts &"basic"& header lines. It is described with the &%header%&
8882 expansion item below.
8883
8884
8885 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8886 .cindex "expansion" "calling an acl"
8887 .cindex "&%acl%&" "call from expansion"
8888 The name and zero to nine argument strings are first expanded separately.  The expanded
8889 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8890 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8891 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8892 and may use the variables; if another acl expansion is used the values
8893 are restored after it returns.  If the ACL sets
8894 a value using a "message =" modifier and returns accept or deny, the value becomes
8895 the result of the expansion.
8896 If no message is set and the ACL returns accept or deny
8897 the expansion result is an empty string.
8898 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8899
8900
8901 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8902        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8903 .cindex "expansion" "extracting cerificate fields"
8904 .cindex "&%certextract%&" "certificate fields"
8905 .cindex "certificate" "extracting fields"
8906 The <&'certificate'&> must be a variable of type certificate.
8907 The field name is expanded and used to retrive the relevant field from
8908 the certificate.  Supported fields are:
8909 .display
8910 &`version        `&
8911 &`serial_number  `&
8912 &`subject        `& RFC4514 DN
8913 &`issuer         `& RFC4514 DN
8914 &`notbefore      `& time
8915 &`notafter       `& time
8916 &`sig_algorithm  `&
8917 &`signature      `&
8918 &`subj_altname   `& tagged list
8919 &`ocsp_uri       `& list
8920 &`crl_uri        `& list
8921 .endd
8922 If the field is found,
8923 <&'string2'&> is expanded, and replaces the whole item;
8924 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8925 variable &$value$& contains the value that has been extracted. Afterwards, it
8926 is restored to any previous value it might have had.
8927
8928 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8929 key is not found. If {<&'string2'&>} is also omitted, the value that was
8930 extracted is used.
8931
8932 Some field names take optional modifiers, appended and separated by commas.
8933
8934 The field selectors marked as "RFC4514" above
8935 output a Distinguished Name string which is
8936 not quite
8937 parseable by Exim as a comma-separated tagged list
8938 (the exceptions being elements containin commas).
8939 RDN elements of a single type may be selected by
8940 a modifier of the type label; if so the expansion
8941 result is a list (newline-separated by default).
8942 The separator may be changed by another modifer of
8943 a right angle-bracket followed immediately by the new separator.
8944 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8945
8946 The field selectors marked as "time" above
8947 take an optional modifier of "int"
8948 for which the result is the number of seconds since epoch.
8949 Otherwise the result is a human-readable string
8950 in the timezone selected by the main "timezone" option.
8951
8952 The field selectors marked as "list" above return a list,
8953 newline-separated by default,
8954 (embedded separator characters in elements are doubled).
8955 The separator may be changed by a modifier of
8956 a right angle-bracket followed immediately by the new separator.
8957
8958 The field selectors marked as "tagged" above
8959 prefix each list element with a type string and an equals sign.
8960 Elements of only one type may be selected by a modifier
8961 which is one of "dns", "uri" or "mail";
8962 if so the elenment tags are omitted.
8963
8964 If not otherwise noted field values are presented in human-readable form.
8965
8966 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8967        {*&<&'arg'&>&*}...}*&"
8968 .cindex &%dlfunc%&
8969 This expansion dynamically loads and then calls a locally-written C function.
8970 This functionality is available only if Exim is compiled with
8971 .code
8972 EXPAND_DLFUNC=yes
8973 .endd
8974 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8975 object so that it doesn't reload the same object file in the same Exim process
8976 (but of course Exim does start new processes frequently).
8977
8978 There may be from zero to eight arguments to the function. When compiling
8979 a local function that is to be called in this way, &_local_scan.h_& should be
8980 included. The Exim variables and functions that are defined by that API
8981 are also available for dynamically loaded functions. The function itself
8982 must have the following type:
8983 .code
8984 int dlfunction(uschar **yield, int argc, uschar *argv[])
8985 .endd
8986 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8987 function should return one of the following values:
8988
8989 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8990 into the expanded string that is being built.
8991
8992 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8993 from &'yield'&, if it is set.
8994
8995 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8996 taken from &'yield'& if it is set.
8997
8998 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8999
9000 When compiling a function that is to be used in this way with gcc,
9001 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9002 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9003
9004 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9005        {*&<&'string3'&>&*}}*&"
9006 .cindex "expansion" "extracting substrings by key"
9007 .cindex "&%extract%&" "substrings by key"
9008 The key and <&'string1'&> are first expanded separately. Leading and trailing
9009 white space is removed from the key (but not from any of the strings). The key
9010 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9011 form:
9012 .display
9013 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9014 .endd
9015 .vindex "&$value$&"
9016 where the equals signs and spaces (but not both) are optional. If any of the
9017 values contain white space, they must be enclosed in double quotes, and any
9018 values that are enclosed in double quotes are subject to escape processing as
9019 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9020 for the value that corresponds to the key. The search is case-insensitive. If
9021 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9022 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9023 variable &$value$& contains the value that has been extracted. Afterwards, it
9024 is restored to any previous value it might have had.
9025
9026 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9027 key is not found. If {<&'string2'&>} is also omitted, the value that was
9028 extracted is used. Thus, for example, these two expansions are identical, and
9029 yield &"2001"&:
9030 .code
9031 ${extract{gid}{uid=1984 gid=2001}}
9032 ${extract{gid}{uid=1984 gid=2001}{$value}}
9033 .endd
9034 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9035 appear, for example:
9036 .code
9037 ${extract{Z}{A=... B=...}{$value} fail }
9038 .endd
9039 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9040 {<&'string2'&>} must be present for &"fail"& to be recognized.
9041
9042
9043 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9044         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9045 .cindex "expansion" "extracting substrings by number"
9046 .cindex "&%extract%&" "substrings by number"
9047 The <&'number'&> argument must consist entirely of decimal digits,
9048 apart from leading and trailing white space, which is ignored.
9049 This is what distinguishes this form of &%extract%& from the previous kind. It
9050 behaves in the same way, except that, instead of extracting a named field, it
9051 extracts from <&'string1'&> the field whose number is given as the first
9052 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9053 <&'string3'&> as before.
9054
9055 The fields in the string are separated by any one of the characters in the
9056 separator string. These may include space or tab characters.
9057 The first field is numbered one. If the number is negative, the fields are
9058 counted from the end of the string, with the rightmost one numbered -1. If the
9059 number given is zero, the entire string is returned. If the modulus of the
9060 number is greater than the number of fields in the string, the result is the
9061 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9062 provided. For example:
9063 .code
9064 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9065 .endd
9066 yields &"42"&, and
9067 .code
9068 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9069 .endd
9070 yields &"99"&. Two successive separators mean that the field between them is
9071 empty (for example, the fifth field above).
9072
9073
9074 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9075 .cindex "list" "selecting by condition"
9076 .cindex "expansion" "selecting from list by condition"
9077 .vindex "&$item$&"
9078 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9079 default, but the separator can be changed in the usual way. For each item
9080 in this list, its value is place in &$item$&, and then the condition is
9081 evaluated. If the condition is true, &$item$& is added to the output as an
9082 item in a new list; if the condition is false, the item is discarded. The
9083 separator used for the output list is the same as the one used for the
9084 input, but a separator setting is not included in the output. For example:
9085 .code
9086 ${filter{a:b:c}{!eq{$item}{b}}
9087 .endd
9088 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9089 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9090
9091
9092 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9093 .cindex "hash function" "textual"
9094 .cindex "expansion" "textual hash"
9095 This is a textual hashing function, and was the first to be implemented in
9096 early versions of Exim. In current releases, there are other hashing functions
9097 (numeric, MD5, and SHA-1), which are described below.
9098
9099 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9100 <&'n'&>. If you are using fixed values for these numbers, that is, if
9101 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9102 use the simpler operator notation that avoids some of the braces:
9103 .code
9104 ${hash_<n>_<m>:<string>}
9105 .endd
9106 The second number is optional (in both notations). If <&'n'&> is greater than
9107 or equal to the length of the string, the expansion item returns the string.
9108 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9109 function to the string. The new string consists of characters taken from the
9110 first <&'m'&> characters of the string
9111 .code
9112 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9113 .endd
9114 If <&'m'&> is not present the value 26 is used, so that only lower case
9115 letters appear. For example:
9116 .display
9117 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9118 &`$hash{5}{monty}}           `&   yields  &`monty`&
9119 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9120 .endd
9121
9122 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9123         &*$h_*&<&'header&~name'&>&*:*&" &&&
9124        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9125         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9126        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9127         &*$rh_*&<&'header&~name'&>&*:*&"
9128 .cindex "expansion" "header insertion"
9129 .vindex "&$header_$&"
9130 .vindex "&$bheader_$&"
9131 .vindex "&$rheader_$&"
9132 .cindex "header lines" "in expansion strings"
9133 .cindex "header lines" "character sets"
9134 .cindex "header lines" "decoding"
9135 Substitute the contents of the named message header line, for example
9136 .code
9137 $header_reply-to:
9138 .endd
9139 The newline that terminates a header line is not included in the expansion, but
9140 internal newlines (caused by splitting the header line over several physical
9141 lines) may be present.
9142
9143 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9144 the data in the header line is interpreted.
9145
9146 .ilist
9147 .cindex "white space" "in header lines"
9148 &%rheader%& gives the original &"raw"& content of the header line, with no
9149 processing at all, and without the removal of leading and trailing white space.
9150
9151 .next
9152 .cindex "base64 encoding" "in header lines"
9153 &%bheader%& removes leading and trailing white space, and then decodes base64
9154 or quoted-printable MIME &"words"& within the header text, but does no
9155 character set translation. If decoding of what looks superficially like a MIME
9156 &"word"& fails, the raw string is returned. If decoding
9157 .cindex "binary zero" "in header line"
9158 produces a binary zero character, it is replaced by a question mark &-- this is
9159 what Exim does for binary zeros that are actually received in header lines.
9160
9161 .next
9162 &%header%& tries to translate the string as decoded by &%bheader%& to a
9163 standard character set. This is an attempt to produce the same string as would
9164 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9165 returned. Translation is attempted only on operating systems that support the
9166 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9167 a system Makefile or in &_Local/Makefile_&.
9168 .endlist ilist
9169
9170 In a filter file, the target character set for &%header%& can be specified by a
9171 command of the following form:
9172 .code
9173 headers charset "UTF-8"
9174 .endd
9175 This command affects all references to &$h_$& (or &$header_$&) expansions in
9176 subsequently obeyed filter commands. In the absence of this command, the target
9177 character set in a filter is taken from the setting of the &%headers_charset%&
9178 option in the runtime configuration. The value of this option defaults to the
9179 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9180 ISO-8859-1.
9181
9182 Header names follow the syntax of RFC 2822, which states that they may contain
9183 any printing characters except space and colon. Consequently, curly brackets
9184 &'do not'& terminate header names, and should not be used to enclose them as
9185 if they were variables. Attempting to do so causes a syntax error.
9186
9187 Only header lines that are common to all copies of a message are visible to
9188 this mechanism. These are the original header lines that are received with the
9189 message, and any that are added by an ACL statement or by a system
9190 filter. Header lines that are added to a particular copy of a message by a
9191 router or transport are not accessible.
9192
9193 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9194 before the DATA ACL, because the header structure is not set up until the
9195 message is received. Header lines that are added in a RCPT ACL (for example)
9196 are saved until the message's incoming header lines are available, at which
9197 point they are added. When a DATA ACL is running, however, header lines added
9198 by earlier ACLs are visible.
9199
9200 Upper case and lower case letters are synonymous in header names. If the
9201 following character is white space, the terminating colon may be omitted, but
9202 this is not recommended, because you may then forget it when it is needed. When
9203 white space terminates the header name, it is included in the expanded string.
9204 If the message does not contain the given header, the expansion item is
9205 replaced by an empty string. (See the &%def%& condition in section
9206 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9207
9208 If there is more than one header with the same name, they are all concatenated
9209 to form the substitution string, up to a maximum length of 64K. Unless
9210 &%rheader%& is being used, leading and trailing white space is removed from
9211 each header before concatenation, and a completely empty header is ignored. A
9212 newline character is then inserted between non-empty headers, but there is no
9213 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9214 those headers that contain lists of addresses, a comma is also inserted at the
9215 junctions between headers. This does not happen for the &%rheader%& expansion.
9216
9217
9218 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9219 .cindex "expansion" "hmac hashing"
9220 .cindex &%hmac%&
9221 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9222 shared secret and some text into a message authentication code, as specified in
9223 RFC 2104. This differs from &`${md5:secret_text...}`& or
9224 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9225 cryptographic hash, allowing for authentication that is not possible with MD5
9226 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9227 present. For example:
9228 .code
9229 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9230 .endd
9231 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9232 produces:
9233 .code
9234 dd97e3ba5d1a61b5006108f8c8252953
9235 .endd
9236 As an example of how this might be used, you might put in the main part of
9237 an Exim configuration:
9238 .code
9239 SPAMSCAN_SECRET=cohgheeLei2thahw
9240 .endd
9241 In a router or a transport you could then have:
9242 .code
9243 headers_add = \
9244   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9245   ${hmac{md5}{SPAMSCAN_SECRET}\
9246   {${primary_hostname},${message_exim_id},$h_message-id:}}
9247 .endd
9248 Then given a message, you can check where it was scanned by looking at the
9249 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9250 this header line is authentic by recomputing the authentication code from the
9251 host name, message ID and the &'Message-id:'& header line. This can be done
9252 using Exim's &%-be%& option, or by other means, for example by using the
9253 &'hmac_md5_hex()'& function in Perl.
9254
9255
9256 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9257 .cindex "expansion" "conditional"
9258 .cindex "&%if%&, expansion item"
9259 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9260 item; otherwise <&'string2'&> is used. The available conditions are described
9261 in section &<<SECTexpcond>>& below. For example:
9262 .code
9263 ${if eq {$local_part}{postmaster} {yes}{no} }
9264 .endd
9265 The second string need not be present; if it is not and the condition is not
9266 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9267 be present instead of the second string (without any curly brackets). In this
9268 case, the expansion is forced to fail if the condition is not true (see section
9269 &<<SECTforexpfai>>&).
9270
9271 If both strings are omitted, the result is the string &`true`& if the condition
9272 is true, and the empty string if the condition is false. This makes it less
9273 cumbersome to write custom ACL and router conditions. For example, instead of
9274 .code
9275 condition = ${if >{$acl_m4}{3}{true}{false}}
9276 .endd
9277 you can use
9278 .code
9279 condition = ${if >{$acl_m4}{3}}
9280 .endd
9281
9282 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9283 .cindex "expansion" "string truncation"
9284 .cindex "&%length%& expansion item"
9285 The &%length%& item is used to extract the initial portion of a string. Both
9286 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9287 you are using a fixed value for the number, that is, if <&'string1'&> does not
9288 change when expanded, you can use the simpler operator notation that avoids
9289 some of the braces:
9290 .code
9291 ${length_<n>:<string>}
9292 .endd
9293 The result of this item is either the first <&'n'&> characters or the whole
9294 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9295 &%strlen%&, which gives the length of a string.
9296
9297
9298 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9299         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9300 .cindex "expansion" "extracting list elements by number"
9301 .cindex "&%listextract%&" "extract list elements by number"
9302 .cindex "list" "extracting elements by number"
9303 The <&'number'&> argument must consist entirely of decimal digits,
9304 apart from an optional leading minus,
9305 and leading and trailing white space (which is ignored).
9306
9307 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9308 default, but the separator can be changed in the usual way.
9309
9310 The first field of the list is numbered one.
9311 If the number is negative, the fields are
9312 counted from the end of the list, with the rightmost one numbered -1.
9313 The numbered element of the list is extracted and placed in &$value$&,
9314 then <&'string2'&> is expanded as the result.
9315
9316 If the modulus of the
9317 number is zero or greater than the number of fields in the string,
9318 the result is the expansion of <&'string3'&>.
9319
9320 For example:
9321 .code
9322 ${listextract{2}{x:42:99}}
9323 .endd
9324 yields &"42"&, and
9325 .code
9326 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9327 .endd
9328 yields &"result: 99"&.
9329
9330 If {<&'string3'&>} is omitted, an empty string is used for string3.
9331 If {<&'string2'&>} is also omitted, the value that was
9332 extracted is used.
9333 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9334
9335
9336 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9337         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9338 This is the first of one of two different types of lookup item, which are both
9339 described in the next item.
9340
9341 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9342         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9343 .cindex "expansion" "lookup in"
9344 .cindex "file" "lookups"
9345 .cindex "lookup" "in expanded string"
9346 The two forms of lookup item specify data lookups in files and databases, as
9347 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9348 lookups, and the second is used for query-style lookups. The <&'key'&>,
9349 <&'file'&>, and <&'query'&> strings are expanded before use.
9350
9351 If there is any white space in a lookup item which is part of a filter command,
9352 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9353 other place where white space is significant, the lookup item must be enclosed
9354 in double quotes. The use of data lookups in users' filter files may be locked
9355 out by the system administrator.
9356
9357 .vindex "&$value$&"
9358 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9359 During its expansion, the variable &$value$& contains the data returned by the
9360 lookup. Afterwards it reverts to the value it had previously (at the outer
9361 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9362 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9363 string on failure. If <&'string2'&> is provided, it can itself be a nested
9364 lookup, thus providing a mechanism for looking up a default value when the
9365 original lookup fails.
9366
9367 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9368 data for the outer lookup while the parameters of the second lookup are
9369 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9370 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9371 appear, and in this case, if the lookup fails, the entire expansion is forced
9372 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9373 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9374 successful lookup, and nothing in the case of failure.
9375
9376 For single-key lookups, the string &"partial"& is permitted to precede the
9377 search type in order to do partial matching, and * or *@ may follow a search
9378 type to request default lookups if the key does not match (see sections
9379 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9380
9381 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9382 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9383 and non-wild parts of the key during the expansion of the replacement text.
9384 They return to their previous values at the end of the lookup item.
9385
9386 This example looks up the postmaster alias in the conventional alias file:
9387 .code
9388 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9389 .endd
9390 This example uses NIS+ to look up the full name of the user corresponding to
9391 the local part of an address, forcing the expansion to fail if it is not found:
9392 .code
9393 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9394   {$value}fail}
9395 .endd
9396
9397
9398 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9399 .cindex "expansion" "list creation"
9400 .vindex "&$item$&"
9401 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9402 default, but the separator can be changed in the usual way. For each item
9403 in this list, its value is place in &$item$&, and then <&'string2'&> is
9404 expanded and added to the output as an item in a new list. The separator used
9405 for the output list is the same as the one used for the input, but a separator
9406 setting is not included in the output. For example:
9407 .code
9408 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9409 .endd
9410 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9411 value of &$item$& is restored to what it was before. See also the &*filter*&
9412 and &*reduce*& expansion items.
9413
9414 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9415 .cindex "expansion" "numeric hash"
9416 .cindex "hash function" "numeric"
9417 The three strings are expanded; the first two must yield numbers. Call them
9418 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9419 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9420 can use the simpler operator notation that avoids some of the braces:
9421 .code
9422 ${nhash_<n>_<m>:<string>}
9423 .endd
9424 The second number is optional (in both notations). If there is only one number,
9425 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9426 processed by a div/mod hash function that returns two numbers, separated by a
9427 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9428 example,
9429 .code
9430 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9431 .endd
9432 returns the string &"6/33"&.
9433
9434
9435
9436 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9437 .cindex "Perl" "use in expanded string"
9438 .cindex "expansion" "calling Perl from"
9439 This item is available only if Exim has been built to include an embedded Perl
9440 interpreter. The subroutine name and the arguments are first separately
9441 expanded, and then the Perl subroutine is called with those arguments. No
9442 additional arguments need be given; the maximum number permitted, including the
9443 name of the subroutine, is nine.
9444
9445 The return value of the subroutine is inserted into the expanded string, unless
9446 the return value is &%undef%&. In that case, the expansion fails in the same
9447 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9448 Whatever you return is evaluated in a scalar context. For example, if you
9449 return the name of a Perl vector, the return value is the size of the vector,
9450 not its contents.
9451
9452 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9453 with the error message that was passed to &%die%&. More details of the embedded
9454 Perl facility are given in chapter &<<CHAPperl>>&.
9455
9456 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9457 out the use of this expansion item in filter files.
9458
9459
9460 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9461 .cindex "&%prvs%& expansion item"
9462 The first argument is a complete email address and the second is secret
9463 keystring. The third argument, specifying a key number, is optional. If absent,
9464 it defaults to 0. The result of the expansion is a prvs-signed email address,
9465 to be typically used with the &%return_path%& option on an &(smtp)& transport
9466 as part of a bounce address tag validation (BATV) scheme. For more discussion
9467 and an example, see section &<<SECTverifyPRVS>>&.
9468
9469 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9470         {*&<&'string'&>&*}}*&"
9471 .cindex "&%prvscheck%& expansion item"
9472 This expansion item is the complement of the &%prvs%& item. It is used for
9473 checking prvs-signed addresses. If the expansion of the first argument does not
9474 yield a syntactically valid prvs-signed address, the whole item expands to the
9475 empty string. When the first argument does expand to a syntactically valid
9476 prvs-signed address, the second argument is expanded, with the prvs-decoded
9477 version of the address and the key number extracted from the address in the
9478 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9479
9480 These two variables can be used in the expansion of the second argument to
9481 retrieve the secret. The validity of the prvs-signed address is then checked
9482 against the secret. The result is stored in the variable &$prvscheck_result$&,
9483 which is empty for failure or &"1"& for success.
9484
9485 The third argument is optional; if it is missing, it defaults to an empty
9486 string. This argument is now expanded. If the result is an empty string, the
9487 result of the expansion is the decoded version of the address. This is the case
9488 whether or not the signature was valid. Otherwise, the result of the expansion
9489 is the expansion of the third argument.
9490
9491 All three variables can be used in the expansion of the third argument.
9492 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9493 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9494
9495 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9496 .cindex "expansion" "inserting an entire file"
9497 .cindex "file" "inserting into expansion"
9498 .cindex "&%readfile%& expansion item"
9499 The file name and end-of-line string are first expanded separately. The file is
9500 then read, and its contents replace the entire item. All newline characters in
9501 the file are replaced by the end-of-line string if it is present. Otherwise,
9502 newlines are left in the string.
9503 String expansion is not applied to the contents of the file. If you want this,
9504 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9505 the string expansion fails.
9506
9507 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9508 locks out the use of this expansion item in filter files.
9509
9510
9511
9512 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9513         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9514 .cindex "expansion" "inserting from a socket"
9515 .cindex "socket, use of in expansion"
9516 .cindex "&%readsocket%& expansion item"
9517 This item inserts data from a Unix domain or TCP socket into the expanded
9518 string. The minimal way of using it uses just two arguments, as in these
9519 examples:
9520 .code
9521 ${readsocket{/socket/name}{request string}}
9522 ${readsocket{inet:some.host:1234}{request string}}
9523 .endd
9524 For a Unix domain socket, the first substring must be the path to the socket.
9525 For an Internet socket, the first substring must contain &`inet:`& followed by
9526 a host name or IP address, followed by a colon and a port, which can be a
9527 number or the name of a TCP port in &_/etc/services_&. An IP address may
9528 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9529 example:
9530 .code
9531 ${readsocket{inet:[::1]:1234}{request string}}
9532 .endd
9533 Only a single host name may be given, but if looking it up yields more than
9534 one IP address, they are each tried in turn until a connection is made. For
9535 both kinds of socket, Exim makes a connection, writes the request string
9536 (unless it is an empty string) and reads from the socket until an end-of-file
9537 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9538 extend what can be done. Firstly, you can vary the timeout. For example:
9539 .code
9540 ${readsocket{/socket/name}{request string}{3s}}
9541 .endd
9542 A fourth argument allows you to change any newlines that are in the data
9543 that is read, in the same way as for &%readfile%& (see above). This example
9544 turns them into spaces:
9545 .code
9546 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9547 .endd
9548 As with all expansions, the substrings are expanded before the processing
9549 happens. Errors in these sub-expansions cause the expansion to fail. In
9550 addition, the following errors can occur:
9551
9552 .ilist
9553 Failure to create a socket file descriptor;
9554 .next
9555 Failure to connect the socket;
9556 .next
9557 Failure to write the request string;
9558 .next
9559 Timeout on reading from the socket.
9560 .endlist
9561
9562 By default, any of these errors causes the expansion to fail. However, if
9563 you supply a fifth substring, it is expanded and used when any of the above
9564 errors occurs. For example:
9565 .code
9566 ${readsocket{/socket/name}{request string}{3s}{\n}\
9567   {socket failure}}
9568 .endd
9569 You can test for the existence of a Unix domain socket by wrapping this
9570 expansion in &`${if exists`&, but there is a race condition between that test
9571 and the actual opening of the socket, so it is safer to use the fifth argument
9572 if you want to be absolutely sure of avoiding an expansion error for a
9573 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9574
9575 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9576 locks out the use of this expansion item in filter files.
9577
9578
9579 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9580 .cindex "expansion" "reducing a list to a scalar"
9581 .cindex "list" "reducing to a scalar"
9582 .vindex "&$value$&"
9583 .vindex "&$item$&"
9584 This operation reduces a list to a single, scalar string. After expansion,
9585 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9586 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9587 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9588 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9589 them. The result of that expansion is assigned to &$value$& before the next
9590 iteration. When the end of the list is reached, the final value of &$value$& is
9591 added to the expansion output. The &*reduce*& expansion item can be used in a
9592 number of ways. For example, to add up a list of numbers:
9593 .code
9594 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9595 .endd
9596 The result of that expansion would be &`6`&. The maximum of a list of numbers
9597 can be found:
9598 .code
9599 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9600 .endd
9601 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9602 restored to what they were before. See also the &*filter*& and &*map*&
9603 expansion items.
9604
9605 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9606 This item inserts &"raw"& header lines. It is described with the &%header%&
9607 expansion item above.
9608
9609 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9610         {*&<&'string2'&>&*}}*&"
9611 .cindex "expansion" "running a command"
9612 .cindex "&%run%& expansion item"
9613 The command and its arguments are first expanded as one string. The string is
9614 split apart into individual arguments by spaces, and then the command is run
9615 in a separate process, but under the same uid and gid.  As in other command
9616 executions from Exim, a shell is not used by default. If the command requires
9617 a shell, you must explicitly code it.
9618
9619 Since the arguments are split by spaces, when there is a variable expansion
9620 which has an empty result, it will cause the situation that the argument will
9621 simply be omitted when the program is actually executed by Exim. If the
9622 script/program requires a specific number of arguments and the expanded
9623 variable could possibly result in this empty expansion, the variable must be
9624 quoted. This is more difficult if the expanded variable itself could result
9625 in a string containing quotes, because it would interfere with the quotes
9626 around the command arguments. A possible guard against this is to wrap the
9627 variable in the &%sg%& operator to change any quote marks to some other
9628 character.
9629
9630 The standard input for the command exists, but is empty. The standard output
9631 and standard error are set to the same file descriptor.
9632 .cindex "return code" "from &%run%& expansion"
9633 .vindex "&$value$&"
9634 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9635 and replaces the entire item; during this expansion, the standard output/error
9636 from the command is in the variable &$value$&. If the command fails,
9637 <&'string2'&>, if present, is expanded and used. Once again, during the
9638 expansion, the standard output/error from the command is in the variable
9639 &$value$&.
9640
9641 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9642 can be the word &"fail"& (not in braces) to force expansion failure if the
9643 command does not succeed. If both strings are omitted, the result is contents
9644 of the standard output/error on success, and nothing on failure.
9645
9646 .vindex "&$run_in_acl$&"
9647 The standard output/error of the command is put in the variable &$value$&.
9648 In this ACL example, the output of a command is logged for the admin to
9649 troubleshoot:
9650 .code
9651 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9652       log_message  = Output of id: $value
9653 .endd
9654 If the command requires shell idioms, such as the > redirect operator, the
9655 shell must be invoked directly, such as with:
9656 .code
9657 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9658 .endd
9659
9660 .vindex "&$runrc$&"
9661 The return code from the command is put in the variable &$runrc$&, and this
9662 remains set afterwards, so in a filter file you can do things like this:
9663 .code
9664 if "${run{x y z}{}}$runrc" is 1 then ...
9665   elif $runrc is 2 then ...
9666   ...
9667 endif
9668 .endd
9669 If execution of the command fails (for example, the command does not exist),
9670 the return code is 127 &-- the same code that shells use for non-existent
9671 commands.
9672
9673 &*Warning*&: In a router or transport, you cannot assume the order in which
9674 option values are expanded, except for those preconditions whose order of
9675 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9676 by the expansion of one option, and use it in another.
9677
9678 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9679 out the use of this expansion item in filter files.
9680
9681
9682 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9683 .cindex "expansion" "string substitution"
9684 .cindex "&%sg%& expansion item"
9685 This item works like Perl's substitution operator (s) with the global (/g)
9686 option; hence its name. However, unlike the Perl equivalent, Exim does not
9687 modify the subject string; instead it returns the modified string for insertion
9688 into the overall expansion. The item takes three arguments: the subject string,
9689 a regular expression, and a substitution string. For example:
9690 .code
9691 ${sg{abcdefabcdef}{abc}{xyz}}
9692 .endd
9693 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9694 if any $ or \ characters are required in the regular expression or in the
9695 substitution string, they have to be escaped. For example:
9696 .code
9697 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9698 .endd
9699 yields &"defabc"&, and
9700 .code
9701 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9702 .endd
9703 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9704 the regular expression from string expansion.
9705
9706
9707
9708 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9709 .cindex sorting a list
9710 .cindex list sorting
9711 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9712 default, but the separator can be changed in the usual way.
9713 The <&'comparator'&> argument is interpreted as the operator
9714 of a two-argument expansion condition.
9715 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9716 The comparison should return true when applied to two values
9717 if the first value should sort before the second value.
9718 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9719 the element being placed in &$item$&,
9720 to give values for comparison.
9721
9722 The item result is a sorted list,
9723 with the original list separator,
9724 of the list elements (in full) of the original.
9725
9726 Examples:
9727 .code
9728 ${sort{3:2:1:4}{<}{$item}}
9729 .endd
9730 sorts a list of numbers, and
9731 .code
9732 ${sort {$lookup dnsdb{>:,,mx=example.com}} {<} {${listextract{1}{<,$item}}}}
9733 .endd
9734 will sort an MX lookup into priority order.
9735
9736
9737 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9738 .cindex "&%substr%& expansion item"
9739 .cindex "substring extraction"
9740 .cindex "expansion" "substring extraction"
9741 The three strings are expanded; the first two must yield numbers. Call them
9742 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9743 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9744 can use the simpler operator notation that avoids some of the braces:
9745 .code
9746 ${substr_<n>_<m>:<string>}
9747 .endd
9748 The second number is optional (in both notations).
9749 If it is absent in the simpler format, the preceding underscore must also be
9750 omitted.
9751
9752 The &%substr%& item can be used to extract more general substrings than
9753 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9754 length required. For example
9755 .code
9756 ${substr{3}{2}{$local_part}}
9757 .endd
9758 If the starting offset is greater than the string length the result is the
9759 null string; if the length plus starting offset is greater than the string
9760 length, the result is the right-hand part of the string, starting from the
9761 given offset. The first character in the string has offset zero.
9762
9763 The &%substr%& expansion item can take negative offset values to count
9764 from the right-hand end of its operand. The last character is offset -1, the
9765 second-last is offset -2, and so on. Thus, for example,
9766 .code
9767 ${substr{-5}{2}{1234567}}
9768 .endd
9769 yields &"34"&. If the absolute value of a negative offset is greater than the
9770 length of the string, the substring starts at the beginning of the string, and
9771 the length is reduced by the amount of overshoot. Thus, for example,
9772 .code
9773 ${substr{-5}{2}{12}}
9774 .endd
9775 yields an empty string, but
9776 .code
9777 ${substr{-3}{2}{12}}
9778 .endd
9779 yields &"1"&.
9780
9781 When the second number is omitted from &%substr%&, the remainder of the string
9782 is taken if the offset is positive. If it is negative, all characters in the
9783 string preceding the offset point are taken. For example, an offset of -1 and
9784 no length, as in these semantically identical examples:
9785 .code
9786 ${substr_-1:abcde}
9787 ${substr{-1}{abcde}}
9788 .endd
9789 yields all but the last character of the string, that is, &"abcd"&.
9790
9791
9792
9793 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9794         {*&<&'replacements'&>&*}}*&"
9795 .cindex "expansion" "character translation"
9796 .cindex "&%tr%& expansion item"
9797 This item does single-character translation on its subject string. The second
9798 argument is a list of characters to be translated in the subject string. Each
9799 matching character is replaced by the corresponding character from the
9800 replacement list. For example
9801 .code
9802 ${tr{abcdea}{ac}{13}}
9803 .endd
9804 yields &`1b3de1`&. If there are duplicates in the second character string, the
9805 last occurrence is used. If the third string is shorter than the second, its
9806 last character is replicated. However, if it is empty, no translation takes
9807 place.
9808 .endlist
9809
9810
9811
9812 .section "Expansion operators" "SECTexpop"
9813 .cindex "expansion" "operators"
9814 For expansion items that perform transformations on a single argument string,
9815 the &"operator"& notation is used because it is simpler and uses fewer braces.
9816 The substring is first expanded before the operation is applied to it. The
9817 following operations can be performed:
9818
9819 .vlist
9820 .vitem &*${address:*&<&'string'&>&*}*&
9821 .cindex "expansion" "RFC 2822 address handling"
9822 .cindex "&%address%& expansion item"
9823 The string is interpreted as an RFC 2822 address, as it might appear in a
9824 header line, and the effective address is extracted from it. If the string does
9825 not parse successfully, the result is empty.
9826
9827
9828 .vitem &*${addresses:*&<&'string'&>&*}*&
9829 .cindex "expansion" "RFC 2822 address handling"
9830 .cindex "&%addresses%& expansion item"
9831 The string (after expansion) is interpreted as a list of addresses in RFC
9832 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9833 operative address (&'local-part@domain'&) is extracted from each item, and the
9834 result of the expansion is a colon-separated list, with appropriate
9835 doubling of colons should any happen to be present in the email addresses.
9836 Syntactically invalid RFC2822 address items are omitted from the output.
9837
9838 It is possible to specify a character other than colon for the output
9839 separator by starting the string with > followed by the new separator
9840 character. For example:
9841 .code
9842 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9843 .endd
9844 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9845 expansion item, which extracts the working address from a single RFC2822
9846 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9847 processing lists.
9848
9849 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9850 a strict interpretation of header line formatting.  Exim parses the bare,
9851 unquoted portion of an email address and if it finds a comma, treats it as an
9852 email address seperator. For the example header line:
9853 .code
9854 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9855 .endd
9856 The first example below demonstrates that Q-encoded email addresses are parsed
9857 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9858 It does not see the comma because it's still encoded as "=2C".  The second
9859 example below is passed the contents of &`$header_from:`&, meaning it gets
9860 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9861 The third example shows that the presence of a comma is skipped when it is
9862 quoted.
9863 .code
9864 # exim -be '${addresses:From: \
9865 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9866 user@example.com
9867 # exim -be '${addresses:From: Last, First <user@example.com>}'
9868 Last:user@example.com
9869 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9870 user@example.com
9871 .endd
9872
9873 .vitem &*${base62:*&<&'digits'&>&*}*&
9874 .cindex "&%base62%& expansion item"
9875 .cindex "expansion" "conversion to base 62"
9876 The string must consist entirely of decimal digits. The number is converted to
9877 base 62 and output as a string of six characters, including leading zeros. In
9878 the few operating environments where Exim uses base 36 instead of base 62 for
9879 its message identifiers (because those systems do not have case-sensitive file
9880 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9881 be absolutely clear: this is &'not'& base64 encoding.
9882
9883 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9884 .cindex "&%base62d%& expansion item"
9885 .cindex "expansion" "conversion to base 62"
9886 The string must consist entirely of base-62 digits, or, in operating
9887 environments where Exim uses base 36 instead of base 62 for its message
9888 identifiers, base-36 digits. The number is converted to decimal and output as a
9889 string.
9890
9891
9892 .vitem &*${domain:*&<&'string'&>&*}*&
9893 .cindex "domain" "extraction"
9894 .cindex "expansion" "domain extraction"
9895 The string is interpreted as an RFC 2822 address and the domain is extracted
9896 from it. If the string does not parse successfully, the result is empty.
9897
9898
9899 .vitem &*${escape:*&<&'string'&>&*}*&
9900 .cindex "expansion" "escaping non-printing characters"
9901 .cindex "&%escape%& expansion item"
9902 If the string contains any non-printing characters, they are converted to
9903 escape sequences starting with a backslash. Whether characters with the most
9904 significant bit set (so-called &"8-bit characters"&) count as printing or not
9905 is controlled by the &%print_topbitchars%& option.
9906
9907
9908 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9909 .cindex "expansion" "expression evaluation"
9910 .cindex "expansion" "arithmetic expression"
9911 .cindex "&%eval%& expansion item"
9912 These items supports simple arithmetic and bitwise logical operations in
9913 expansion strings. The string (after expansion) must be a conventional
9914 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9915 logical operators, and parentheses. All operations are carried out using
9916 integer arithmetic. The operator priorities are as follows (the same as in the
9917 C programming language):
9918 .table2 70pt 300pt
9919 .irow &'highest:'& "not (~), negate (-)"
9920 .irow ""   "multiply (*), divide (/), remainder (%)"
9921 .irow ""   "plus (+), minus (-)"
9922 .irow ""   "shift-left (<<), shift-right (>>)"
9923 .irow ""   "and (&&)"
9924 .irow ""   "xor (^)"
9925 .irow &'lowest:'&  "or (|)"
9926 .endtable
9927 Binary operators with the same priority are evaluated from left to right. White
9928 space is permitted before or after operators.
9929
9930 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9931 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9932 decimal, even if they start with a leading zero; hexadecimal numbers are not
9933 permitted. This can be useful when processing numbers extracted from dates or
9934 times, which often do have leading zeros.
9935
9936 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9937 or 1024*1024*1024,
9938 respectively. Negative numbers are supported. The result of the computation is
9939 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9940
9941 .display
9942 &`${eval:1+1}            `&  yields 2
9943 &`${eval:1+2*3}          `&  yields 7
9944 &`${eval:(1+2)*3}        `&  yields 9
9945 &`${eval:2+42%5}         `&  yields 4
9946 &`${eval:0xc&amp;5}          `&  yields 4
9947 &`${eval:0xc|5}          `&  yields 13
9948 &`${eval:0xc^5}          `&  yields 9
9949 &`${eval:0xc>>1}         `&  yields 6
9950 &`${eval:0xc<<1}         `&  yields 24
9951 &`${eval:~255&amp;0x1234}    `&  yields 4608
9952 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9953 .endd
9954
9955 As a more realistic example, in an ACL you might have
9956 .code
9957 deny   message = Too many bad recipients
9958        condition =                    \
9959          ${if and {                   \
9960            {>{$rcpt_count}{10}}       \
9961            {                          \
9962            <                          \
9963              {$recipients_count}      \
9964              {${eval:$rcpt_count/2}}  \
9965            }                          \
9966          }{yes}{no}}
9967 .endd
9968 The condition is true if there have been more than 10 RCPT commands and
9969 fewer than half of them have resulted in a valid recipient.
9970
9971
9972 .vitem &*${expand:*&<&'string'&>&*}*&
9973 .cindex "expansion" "re-expansion of substring"
9974 The &%expand%& operator causes a string to be expanded for a second time. For
9975 example,
9976 .code
9977 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9978 .endd
9979 first looks up a string in a file while expanding the operand for &%expand%&,
9980 and then re-expands what it has found.
9981
9982
9983 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9984 .cindex "Unicode"
9985 .cindex "UTF-8" "conversion from"
9986 .cindex "expansion" "UTF-8 conversion"
9987 .cindex "&%from_utf8%& expansion item"
9988 The world is slowly moving towards Unicode, although there are no standards for
9989 email yet. However, other applications (including some databases) are starting
9990 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9991 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9992 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9993 the result is an undefined sequence of bytes.
9994
9995 Unicode code points with values less than 256 are compatible with ASCII and
9996 ISO-8859-1 (also known as Latin-1).
9997 For example, character 169 is the copyright symbol in both cases, though the
9998 way it is encoded is different. In UTF-8, more than one byte is needed for
9999 characters with code values greater than 127, whereas ISO-8859-1 is a
10000 single-byte encoding (but thereby limited to 256 characters). This makes
10001 translation from UTF-8 to ISO-8859-1 straightforward.
10002
10003
10004 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10005 .cindex "hash function" "textual"
10006 .cindex "expansion" "textual hash"
10007 The &%hash%& operator is a simpler interface to the hashing function that can
10008 be used when the two parameters are fixed numbers (as opposed to strings that
10009 change when expanded). The effect is the same as
10010 .code
10011 ${hash{<n>}{<m>}{<string>}}
10012 .endd
10013 See the description of the general &%hash%& item above for details. The
10014 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10015
10016
10017
10018 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10019 .cindex "base64 encoding" "conversion from hex"
10020 .cindex "expansion" "hex to base64"
10021 .cindex "&%hex2b64%& expansion item"
10022 This operator converts a hex string into one that is base64 encoded. This can
10023 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10024
10025
10026
10027 .vitem &*${hexquote:*&<&'string'&>&*}*&
10028 .cindex "quoting" "hex-encoded unprintable characters"
10029 .cindex "&%hexquote%& expansion item"
10030 This operator converts non-printable characters in a string into a hex
10031 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10032 as is, and other byte values are converted to &`\xNN`&, for example a
10033 byte value 127 is converted to &`\x7f`&.
10034
10035
10036 .vitem &*${lc:*&<&'string'&>&*}*&
10037 .cindex "case forcing in strings"
10038 .cindex "string" "case forcing"
10039 .cindex "lower casing"
10040 .cindex "expansion" "case forcing"
10041 .cindex "&%lc%& expansion item"
10042 This forces the letters in the string into lower-case, for example:
10043 .code
10044 ${lc:$local_part}
10045 .endd
10046
10047 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10048 .cindex "expansion" "string truncation"
10049 .cindex "&%length%& expansion item"
10050 The &%length%& operator is a simpler interface to the &%length%& function that
10051 can be used when the parameter is a fixed number (as opposed to a string that
10052 changes when expanded). The effect is the same as
10053 .code
10054 ${length{<number>}{<string>}}
10055 .endd
10056 See the description of the general &%length%& item above for details. Note that
10057 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10058 when &%length%& is used as an operator.
10059
10060
10061 .vitem &*${listcount:*&<&'string'&>&*}*&
10062 .cindex "expansion" "list item count"
10063 .cindex "list" "item count"
10064 .cindex "list" "count of items"
10065 .cindex "&%listcount%& expansion item"
10066 The string is interpreted as a list and the number of items is returned.
10067
10068
10069 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10070 .cindex "expansion" "named list"
10071 .cindex "&%listnamed%& expansion item"
10072 The name is interpreted as a named list and the content of the list is returned,
10073 expanding any referenced lists, re-quoting as needed for colon-separation.
10074 If the optional type is given it must be one of "a", "d", "h" or "l"
10075 and selects address-, domain-, host- or localpart- lists to search among respectively.
10076 Otherwise all types are searched in an undefined order and the first
10077 matching list is returned.
10078
10079
10080 .vitem &*${local_part:*&<&'string'&>&*}*&
10081 .cindex "expansion" "local part extraction"
10082 .cindex "&%local_part%& expansion item"
10083 The string is interpreted as an RFC 2822 address and the local part is
10084 extracted from it. If the string does not parse successfully, the result is
10085 empty.
10086
10087
10088 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10089 .cindex "masked IP address"
10090 .cindex "IP address" "masking"
10091 .cindex "CIDR notation"
10092 .cindex "expansion" "IP address masking"
10093 .cindex "&%mask%& expansion item"
10094 If the form of the string to be operated on is not an IP address followed by a
10095 slash and an integer (that is, a network address in CIDR notation), the
10096 expansion fails. Otherwise, this operator converts the IP address to binary,
10097 masks off the least significant bits according to the bit count, and converts
10098 the result back to text, with mask appended. For example,
10099 .code
10100 ${mask:10.111.131.206/28}
10101 .endd
10102 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10103 be mostly used for looking up masked addresses in files, the result for an IPv6
10104 address uses dots to separate components instead of colons, because colon
10105 terminates a key string in lsearch files. So, for example,
10106 .code
10107 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10108 .endd
10109 returns the string
10110 .code
10111 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10112 .endd
10113 Letters in IPv6 addresses are always output in lower case.
10114
10115
10116 .vitem &*${md5:*&<&'string'&>&*}*&
10117 .cindex "MD5 hash"
10118 .cindex "expansion" "MD5 hash"
10119 .cindex "certificate fingerprint"
10120 .cindex "&%md5%& expansion item"
10121 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10122 as a 32-digit hexadecimal number, in which any letters are in lower case.
10123
10124
10125 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10126 .cindex "expansion" "numeric hash"
10127 .cindex "hash function" "numeric"
10128 The &%nhash%& operator is a simpler interface to the numeric hashing function
10129 that can be used when the two parameters are fixed numbers (as opposed to
10130 strings that change when expanded). The effect is the same as
10131 .code
10132 ${nhash{<n>}{<m>}{<string>}}
10133 .endd
10134 See the description of the general &%nhash%& item above for details.
10135
10136
10137 .vitem &*${quote:*&<&'string'&>&*}*&
10138 .cindex "quoting" "in string expansions"
10139 .cindex "expansion" "quoting"
10140 .cindex "&%quote%& expansion item"
10141 The &%quote%& operator puts its argument into double quotes if it
10142 is an empty string or
10143 contains anything other than letters, digits, underscores, dots, and hyphens.
10144 Any occurrences of double quotes and backslashes are escaped with a backslash.
10145 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10146 respectively For example,
10147 .code
10148 ${quote:ab"*"cd}
10149 .endd
10150 becomes
10151 .code
10152 "ab\"*\"cd"
10153 .endd
10154 The place where this is useful is when the argument is a substitution from a
10155 variable or a message header.
10156
10157 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10158 .cindex "&%quote_local_part%& expansion item"
10159 This operator is like &%quote%&, except that it quotes the string only if
10160 required to do so by the rules of RFC 2822 for quoting local parts. For
10161 example, a plus sign would not cause quoting (but it would for &%quote%&).
10162 If you are creating a new email address from the contents of &$local_part$&
10163 (or any other unknown data), you should always use this operator.
10164
10165
10166 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10167 .cindex "quoting" "lookup-specific"
10168 This operator applies lookup-specific quoting rules to the string. Each
10169 query-style lookup type has its own quoting rules which are described with
10170 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10171 .code
10172 ${quote_ldap:two * two}
10173 .endd
10174 returns
10175 .code
10176 two%20%5C2A%20two
10177 .endd
10178 For single-key lookup types, no quoting is ever necessary and this operator
10179 yields an unchanged string.
10180
10181
10182 .vitem &*${randint:*&<&'n'&>&*}*&
10183 .cindex "random number"
10184 This operator returns a somewhat random number which is less than the
10185 supplied number and is at least 0.  The quality of this randomness depends
10186 on how Exim was built; the values are not suitable for keying material.
10187 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10188 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10189 for versions of GnuTLS with that function.
10190 Otherwise, the implementation may be arc4random(), random() seeded by
10191 srandomdev() or srandom(), or a custom implementation even weaker than
10192 random().
10193
10194
10195 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10196 .cindex "expansion" "IP address"
10197 This operator reverses an IP address; for IPv4 addresses, the result is in
10198 dotted-quad decimal form, while for IPv6 addreses the result is in
10199 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10200 for DNS.  For example,
10201 .code
10202 ${reverse_ip:192.0.2.4}
10203 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10204 .endd
10205 returns
10206 .code
10207 4.2.0.192
10208 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
10209 .endd
10210
10211
10212 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10213 .cindex "expansion" "RFC 2047"
10214 .cindex "RFC 2047" "expansion operator"
10215 .cindex "&%rfc2047%& expansion item"
10216 This operator encodes text according to the rules of RFC 2047. This is an
10217 encoding that is used in header lines to encode non-ASCII characters. It is
10218 assumed that the input string is in the encoding specified by the
10219 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10220 contains only characters in the range 33&--126, and no instances of the
10221 characters
10222 .code
10223 ? = ( ) < > @ , ; : \ " . [ ] _
10224 .endd
10225 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10226 string, using as many &"encoded words"& as necessary to encode all the
10227 characters.
10228
10229
10230 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10231 .cindex "expansion" "RFC 2047"
10232 .cindex "RFC 2047" "decoding"
10233 .cindex "&%rfc2047d%& expansion item"
10234 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10235 bytes are replaced by question marks. Characters are converted into the
10236 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10237 not recognized unless &%check_rfc2047_length%& is set false.
10238
10239 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10240 access a header line, RFC 2047 decoding is done automatically. You do not need
10241 to use this operator as well.
10242
10243
10244
10245 .vitem &*${rxquote:*&<&'string'&>&*}*&
10246 .cindex "quoting" "in regular expressions"
10247 .cindex "regular expressions" "quoting"
10248 .cindex "&%rxquote%& expansion item"
10249 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10250 characters in its argument. This is useful when substituting the values of
10251 variables or headers inside regular expressions.
10252
10253
10254 .vitem &*${sha1:*&<&'string'&>&*}*&
10255 .cindex "SHA-1 hash"
10256 .cindex "expansion" "SHA-1 hashing"
10257 .cindex "certificate fingerprint"
10258 .cindex "&%sha2%& expansion item"
10259 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10260 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10261
10262
10263 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10264 .cindex "SHA-256 hash"
10265 .cindex "certificate fingerprint"
10266 .cindex "expansion" "SHA-256 hashing"
10267 .cindex "&%sha256%& expansion item"
10268 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10269 certificate,
10270 and returns
10271 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10272 Only arguments which are a single variable of certificate type are supported.
10273
10274
10275 .vitem &*${stat:*&<&'string'&>&*}*&
10276 .cindex "expansion" "statting a file"
10277 .cindex "file" "extracting characteristics"
10278 .cindex "&%stat%& expansion item"
10279 The string, after expansion, must be a file path. A call to the &[stat()]&
10280 function is made for this path. If &[stat()]& fails, an error occurs and the
10281 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10282 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10283 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10284 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10285 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10286 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10287 can extract individual fields using the &%extract%& expansion item.
10288
10289 The use of the &%stat%& expansion in users' filter files can be locked out by
10290 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10291 systems for files larger than 2GB.
10292
10293 .vitem &*${str2b64:*&<&'string'&>&*}*&
10294 .cindex "expansion" "base64 encoding"
10295 .cindex "base64 encoding" "in string expansion"
10296 .cindex "&%str2b64%& expansion item"
10297 This operator converts a string into one that is base64 encoded.
10298
10299
10300
10301 .vitem &*${strlen:*&<&'string'&>&*}*&
10302 .cindex "expansion" "string length"
10303 .cindex "string" "length in expansion"
10304 .cindex "&%strlen%& expansion item"
10305 The item is replace by the length of the expanded string, expressed as a
10306 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10307
10308
10309 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10310 .cindex "&%substr%& expansion item"
10311 .cindex "substring extraction"
10312 .cindex "expansion" "substring expansion"
10313 The &%substr%& operator is a simpler interface to the &%substr%& function that
10314 can be used when the two parameters are fixed numbers (as opposed to strings
10315 that change when expanded). The effect is the same as
10316 .code
10317 ${substr{<start>}{<length>}{<string>}}
10318 .endd
10319 See the description of the general &%substr%& item above for details. The
10320 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10321
10322 .vitem &*${time_eval:*&<&'string'&>&*}*&
10323 .cindex "&%time_eval%& expansion item"
10324 .cindex "time interval" "decoding"
10325 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10326 seconds.
10327
10328 .vitem &*${time_interval:*&<&'string'&>&*}*&
10329 .cindex "&%time_interval%& expansion item"
10330 .cindex "time interval" "formatting"
10331 The argument (after sub-expansion) must be a sequence of decimal digits that
10332 represents an interval of time as a number of seconds. It is converted into a
10333 number of larger units and output in Exim's normal time format, for example,
10334 &`1w3d4h2m6s`&.
10335
10336 .vitem &*${uc:*&<&'string'&>&*}*&
10337 .cindex "case forcing in strings"
10338 .cindex "string" "case forcing"
10339 .cindex "upper casing"
10340 .cindex "expansion" "case forcing"
10341 .cindex "&%uc%& expansion item"
10342 This forces the letters in the string into upper-case.
10343
10344 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10345 .cindex "correction of invalid utf-8 sequences in strings"
10346 .cindex "utf-8" "utf-8 sequences"
10347 .cindex "incorrect utf-8"
10348 .cindex "expansion" "utf-8 forcing"
10349 .cindex "&%utf8clean%& expansion item"
10350 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10351 .endlist
10352
10353
10354
10355
10356
10357
10358 .section "Expansion conditions" "SECTexpcond"
10359 .scindex IIDexpcond "expansion" "conditions"
10360 The following conditions are available for testing by the &%${if%& construct
10361 while expanding strings:
10362
10363 .vlist
10364 .vitem &*!*&<&'condition'&>
10365 .cindex "expansion" "negating a condition"
10366 .cindex "negation" "in expansion condition"
10367 Preceding any condition with an exclamation mark negates the result of the
10368 condition.
10369
10370 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10371 .cindex "numeric comparison"
10372 .cindex "expansion" "numeric comparison"
10373 There are a number of symbolic operators for doing numeric comparisons. They
10374 are:
10375 .display
10376 &`=   `&   equal
10377 &`==  `&   equal
10378 &`>   `&   greater
10379 &`>=  `&   greater or equal
10380 &`<   `&   less
10381 &`<=  `&   less or equal
10382 .endd
10383 For example:
10384 .code
10385 ${if >{$message_size}{10M} ...
10386 .endd
10387 Note that the general negation operator provides for inequality testing. The
10388 two strings must take the form of optionally signed decimal integers,
10389 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10390 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10391 As a special case, the numerical value of an empty string is taken as
10392 zero.
10393
10394 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10395 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10396 10M, not if 10M is larger than &$message_size$&.
10397
10398
10399 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10400         {*&<&'arg2'&>&*}...}*&
10401 .cindex "expansion" "calling an acl"
10402 .cindex "&%acl%&" "expansion condition"
10403 The name and zero to nine argument strings are first expanded separately.  The expanded
10404 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10405 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10406 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10407 and may use the variables; if another acl expansion is used the values
10408 are restored after it returns.  If the ACL sets
10409 a value using a "message =" modifier the variable $value becomes
10410 the result of the expansion, otherwise it is empty.
10411 If the ACL returns accept the condition is true; if deny, false.
10412 If the ACL returns defer the result is a forced-fail.
10413
10414 .vitem &*bool&~{*&<&'string'&>&*}*&
10415 .cindex "expansion" "boolean parsing"
10416 .cindex "&%bool%& expansion condition"
10417 This condition turns a string holding a true or false representation into
10418 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10419 (case-insensitively); also integer numbers map to true if non-zero,
10420 false if zero.
10421 An empty string is treated as false.
10422 Leading and trailing whitespace is ignored;
10423 thus a string consisting only of whitespace is false.
10424 All other string values will result in expansion failure.
10425
10426 When combined with ACL variables, this expansion condition will let you
10427 make decisions in one place and act on those decisions in another place.
10428 For example:
10429 .code
10430 ${if bool{$acl_m_privileged_sender} ...
10431 .endd
10432
10433
10434 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10435 .cindex "expansion" "boolean parsing"
10436 .cindex "&%bool_lax%& expansion condition"
10437 Like &%bool%&, this condition turns a string into a boolean state.  But
10438 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10439 loose definition that the Router &%condition%& option uses.  The empty string
10440 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10441 true.  Leading and trailing whitespace is ignored.
10442
10443 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10444
10445 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10446 .cindex "expansion" "encrypted comparison"
10447 .cindex "encrypted strings, comparing"
10448 .cindex "&%crypteq%& expansion condition"
10449 This condition is included in the Exim binary if it is built to support any
10450 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10451 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10452 included in the binary.
10453
10454 The &%crypteq%& condition has two arguments. The first is encrypted and
10455 compared against the second, which is already encrypted. The second string may
10456 be in the LDAP form for storing encrypted strings, which starts with the
10457 encryption type in curly brackets, followed by the data. If the second string
10458 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10459 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10460 Typically this will be a field from a password file. An example of an encrypted
10461 string in LDAP form is:
10462 .code
10463 {md5}CY9rzUYh03PK3k6DJie09g==
10464 .endd
10465 If such a string appears directly in an expansion, the curly brackets have to
10466 be quoted, because they are part of the expansion syntax. For example:
10467 .code
10468 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10469 .endd
10470 The following encryption types (whose names are matched case-independently) are
10471 supported:
10472
10473 .ilist
10474 .cindex "MD5 hash"
10475 .cindex "base64 encoding" "in encrypted password"
10476 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10477 printable characters to compare with the remainder of the second string. If the
10478 length of the comparison string is 24, Exim assumes that it is base64 encoded
10479 (as in the above example). If the length is 32, Exim assumes that it is a
10480 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10481 comparison fails.
10482
10483 .next
10484 .cindex "SHA-1 hash"
10485 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10486 printable characters to compare with the remainder of the second string. If the
10487 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10488 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10489 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10490
10491 .next
10492 .cindex "&[crypt()]&"
10493 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10494 only the first eight characters of the password. However, in modern operating
10495 systems this is no longer true, and in many cases the entire password is used,
10496 whatever its length.
10497
10498 .next
10499 .cindex "&[crypt16()]&"
10500 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10501 use up to 16 characters of the password in some operating systems. Again, in
10502 modern operating systems, more characters may be used.
10503 .endlist
10504 Exim has its own version of &[crypt16()]&, which is just a double call to
10505 &[crypt()]&. For operating systems that have their own version, setting
10506 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10507 operating system version instead of its own. This option is set by default in
10508 the OS-dependent &_Makefile_& for those operating systems that are known to
10509 support &[crypt16()]&.
10510
10511 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10512 it was not using the same algorithm as some operating systems' versions. It
10513 turns out that as well as &[crypt16()]& there is a function called
10514 &[bigcrypt()]& in some operating systems. This may or may not use the same
10515 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10516
10517 However, since there is now a move away from the traditional &[crypt()]&
10518 functions towards using SHA1 and other algorithms, tidying up this area of
10519 Exim is seen as very low priority.
10520
10521 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10522 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10523 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10524 default is &`{crypt}`&. Whatever the default, you can always use either
10525 function by specifying it explicitly in curly brackets.
10526
10527 .vitem &*def:*&<&'variable&~name'&>
10528 .cindex "expansion" "checking for empty variable"
10529 .cindex "&%def%& expansion condition"
10530 The &%def%& condition must be followed by the name of one of the expansion
10531 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10532 variable does not contain the empty string. For example:
10533 .code
10534 ${if def:sender_ident {from $sender_ident}}
10535 .endd
10536 Note that the variable name is given without a leading &%$%& character. If the
10537 variable does not exist, the expansion fails.
10538
10539 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10540         &~&*def:h_*&<&'header&~name'&>&*:*&"
10541 .cindex "expansion" "checking header line existence"
10542 This condition is true if a message is being processed and the named header
10543 exists in the message. For example,
10544 .code
10545 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10546 .endd
10547 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10548 the header name must be terminated by a colon if white space does not follow.
10549
10550 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10551        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10552 .cindex "string" "comparison"
10553 .cindex "expansion" "string comparison"
10554 .cindex "&%eq%& expansion condition"
10555 .cindex "&%eqi%& expansion condition"
10556 The two substrings are first expanded. The condition is true if the two
10557 resulting strings are identical. For &%eq%& the comparison includes the case of
10558 letters, whereas for &%eqi%& the comparison is case-independent.
10559
10560 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10561 .cindex "expansion" "file existence test"
10562 .cindex "file" "existence test"
10563 .cindex "&%exists%&, expansion condition"
10564 The substring is first expanded and then interpreted as an absolute path. The
10565 condition is true if the named file (or directory) exists. The existence test
10566 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10567 users' filter files may be locked out by the system administrator.
10568
10569 .vitem &*first_delivery*&
10570 .cindex "delivery" "first"
10571 .cindex "first delivery"
10572 .cindex "expansion" "first delivery test"
10573 .cindex "&%first_delivery%& expansion condition"
10574 This condition, which has no data, is true during a message's first delivery
10575 attempt. It is false during any subsequent delivery attempts.
10576
10577
10578 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10579        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10580 .cindex "list" "iterative conditions"
10581 .cindex "expansion" "&*forall*& condition"
10582 .cindex "expansion" "&*forany*& condition"
10583 .vindex "&$item$&"
10584 These conditions iterate over a list. The first argument is expanded to form
10585 the list. By default, the list separator is a colon, but it can be changed by
10586 the normal method. The second argument is interpreted as a condition that is to
10587 be applied to each item in the list in turn. During the interpretation of the
10588 condition, the current list item is placed in a variable called &$item$&.
10589 .ilist
10590 For &*forany*&, interpretation stops if the condition is true for any item, and
10591 the result of the whole condition is true. If the condition is false for all
10592 items in the list, the overall condition is false.
10593 .next
10594 For &*forall*&, interpretation stops if the condition is false for any item,
10595 and the result of the whole condition is false. If the condition is true for
10596 all items in the list, the overall condition is true.
10597 .endlist
10598 Note that negation of &*forany*& means that the condition must be false for all
10599 items for the overall condition to succeed, and negation of &*forall*& means
10600 that the condition must be false for at least one item. In this example, the
10601 list separator is changed to a comma:
10602 .code
10603 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10604 .endd
10605 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10606 being processed, to enable these expansion items to be nested.
10607
10608 To scan a named list, expand it with the &*listnamed*& operator.
10609
10610
10611 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10612        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10613 .cindex "string" "comparison"
10614 .cindex "expansion" "string comparison"
10615 .cindex "&%ge%& expansion condition"
10616 .cindex "&%gei%& expansion condition"
10617 The two substrings are first expanded. The condition is true if the first
10618 string is lexically greater than or equal to the second string. For &%ge%& the
10619 comparison includes the case of letters, whereas for &%gei%& the comparison is
10620 case-independent.
10621
10622 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10623        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10624 .cindex "string" "comparison"
10625 .cindex "expansion" "string comparison"
10626 .cindex "&%gt%& expansion condition"
10627 .cindex "&%gti%& expansion condition"
10628 The two substrings are first expanded. The condition is true if the first
10629 string is lexically greater than the second string. For &%gt%& the comparison
10630 includes the case of letters, whereas for &%gti%& the comparison is
10631 case-independent.
10632
10633 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10634        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10635 .cindex "string" "comparison"
10636 .cindex "list" "iterative conditions"
10637 Both strings are expanded; the second string is treated as a list of simple
10638 strings; if the first string is a member of the second, then the condition
10639 is true.
10640
10641 These are simpler to use versions of the more powerful &*forany*& condition.
10642 Examples, and the &*forany*& equivalents:
10643 .code
10644 ${if inlist{needle}{foo:needle:bar}}
10645   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10646 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10647   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10648 .endd
10649
10650 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10651        &*isip4&~{*&<&'string'&>&*}*& &&&
10652        &*isip6&~{*&<&'string'&>&*}*&
10653 .cindex "IP address" "testing string format"
10654 .cindex "string" "testing for IP address"
10655 .cindex "&%isip%& expansion condition"
10656 .cindex "&%isip4%& expansion condition"
10657 .cindex "&%isip6%& expansion condition"
10658 The substring is first expanded, and then tested to see if it has the form of
10659 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10660 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10661
10662 For an IPv4 address, the test is for four dot-separated components, each of
10663 which consists of from one to three digits. For an IPv6 address, up to eight
10664 colon-separated components are permitted, each containing from one to four
10665 hexadecimal digits. There may be fewer than eight components if an empty
10666 component (adjacent colons) is present. Only one empty component is permitted.
10667
10668 &*Note*&: The checks are just on the form of the address; actual numerical
10669 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10670 check. The main use of these tests is to distinguish between IP addresses and
10671 host names, or between IPv4 and IPv6 addresses. For example, you could use
10672 .code
10673 ${if isip4{$sender_host_address}...
10674 .endd
10675 to test which IP version an incoming SMTP connection is using.
10676
10677 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10678 .cindex "LDAP" "use for authentication"
10679 .cindex "expansion" "LDAP authentication test"
10680 .cindex "&%ldapauth%& expansion condition"
10681 This condition supports user authentication using LDAP. See section
10682 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10683 queries. For this use, the query must contain a user name and password. The
10684 query itself is not used, and can be empty. The condition is true if the
10685 password is not empty, and the user name and password are accepted by the LDAP
10686 server. An empty password is rejected without calling LDAP because LDAP binds
10687 with an empty password are considered anonymous regardless of the username, and
10688 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10689 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10690 this can be used.
10691
10692
10693 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10694        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10695 .cindex "string" "comparison"
10696 .cindex "expansion" "string comparison"
10697 .cindex "&%le%& expansion condition"
10698 .cindex "&%lei%& expansion condition"
10699 The two substrings are first expanded. The condition is true if the first
10700 string is lexically less than or equal to the second string. For &%le%& the
10701 comparison includes the case of letters, whereas for &%lei%& the comparison is
10702 case-independent.
10703
10704 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10705        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10706 .cindex "string" "comparison"
10707 .cindex "expansion" "string comparison"
10708 .cindex "&%lt%& expansion condition"
10709 .cindex "&%lti%& expansion condition"
10710 The two substrings are first expanded. The condition is true if the first
10711 string is lexically less than the second string. For &%lt%& the comparison
10712 includes the case of letters, whereas for &%lti%& the comparison is
10713 case-independent.
10714
10715
10716 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10717 .cindex "expansion" "regular expression comparison"
10718 .cindex "regular expressions" "match in expanded string"
10719 .cindex "&%match%& expansion condition"
10720 The two substrings are first expanded. The second is then treated as a regular
10721 expression and applied to the first. Because of the pre-expansion, if the
10722 regular expression contains dollar, or backslash characters, they must be
10723 escaped. Care must also be taken if the regular expression contains braces
10724 (curly brackets). A closing brace must be escaped so that it is not taken as a
10725 premature termination of <&'string2'&>. The easiest approach is to use the
10726 &`\N`& feature to disable expansion of the regular expression.
10727 For example,
10728 .code
10729 ${if match {$local_part}{\N^\d{3}\N} ...
10730 .endd
10731 If the whole expansion string is in double quotes, further escaping of
10732 backslashes is also required.
10733
10734 The condition is true if the regular expression match succeeds.
10735 The regular expression is not required to begin with a circumflex
10736 metacharacter, but if there is no circumflex, the expression is not anchored,
10737 and it may match anywhere in the subject, not just at the start. If you want
10738 the pattern to match at the end of the subject, you must include the &`$`&
10739 metacharacter at an appropriate point.
10740
10741 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10742 At the start of an &%if%& expansion the values of the numeric variable
10743 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10744 succeeds causes them to be reset to the substrings of that condition and they
10745 will have these values during the expansion of the success string. At the end
10746 of the &%if%& expansion, the previous values are restored. After testing a
10747 combination of conditions using &%or%&, the subsequent values of the numeric
10748 variables are those of the condition that succeeded.
10749
10750 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10751 .cindex "&%match_address%& expansion condition"
10752 See &*match_local_part*&.
10753
10754 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10755 .cindex "&%match_domain%& expansion condition"
10756 See &*match_local_part*&.
10757
10758 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10759 .cindex "&%match_ip%& expansion condition"
10760 This condition matches an IP address to a list of IP address patterns. It must
10761 be followed by two argument strings. The first (after expansion) must be an IP
10762 address or an empty string. The second (not expanded) is a restricted host
10763 list that can match only an IP address, not a host name. For example:
10764 .code
10765 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10766 .endd
10767 The specific types of host list item that are permitted in the list are:
10768
10769 .ilist
10770 An IP address, optionally with a CIDR mask.
10771 .next
10772 A single asterisk, which matches any IP address.
10773 .next
10774 An empty item, which matches only if the IP address is empty. This could be
10775 useful for testing for a locally submitted message or one from specific hosts
10776 in a single test such as
10777 . ==== As this is a nested list, any displays it contains must be indented
10778 . ==== as otherwise they are too far to the left. This comment applies to
10779 . ==== the use of xmlto plus fop. There's no problem when formatting with
10780 . ==== sdop, with or without the extra indent.
10781 .code
10782   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10783 .endd
10784 where the first item in the list is the empty string.
10785 .next
10786 The item @[] matches any of the local host's interface addresses.
10787 .next
10788 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10789 even if &`net-`& is not specified. There is never any attempt to turn the IP
10790 address into a host name. The most common type of linear search for
10791 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10792 masks. For example:
10793 .code
10794   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10795 .endd
10796 It is of course possible to use other kinds of lookup, and in such a case, you
10797 do need to specify the &`net-`& prefix if you want to specify a specific
10798 address mask, for example:
10799 .code
10800   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10801 .endd
10802 However, unless you are combining a &%match_ip%& condition with others, it is
10803 just as easy to use the fact that a lookup is itself a condition, and write:
10804 .code
10805   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10806 .endd
10807 .endlist ilist
10808
10809 Note that <&'string2'&> is not itself subject to string expansion, unless
10810 Exim was built with the EXPAND_LISTMATCH_RHS option.
10811
10812 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10813
10814 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10815 .cindex "domain list" "in expansion condition"
10816 .cindex "address list" "in expansion condition"
10817 .cindex "local part" "list, in expansion condition"
10818 .cindex "&%match_local_part%& expansion condition"
10819 This condition, together with &%match_address%& and &%match_domain%&, make it
10820 possible to test domain, address, and local part lists within expansions. Each
10821 condition requires two arguments: an item and a list to match. A trivial
10822 example is:
10823 .code
10824 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10825 .endd
10826 In each case, the second argument may contain any of the allowable items for a
10827 list of the appropriate type. Also, because the second argument (after
10828 expansion) is a standard form of list, it is possible to refer to a named list.
10829 Thus, you can use conditions like this:
10830 .code
10831 ${if match_domain{$domain}{+local_domains}{...
10832 .endd
10833 .cindex "&`+caseful`&"
10834 For address lists, the matching starts off caselessly, but the &`+caseful`&
10835 item can be used, as in all address lists, to cause subsequent items to
10836 have their local parts matched casefully. Domains are always matched
10837 caselessly.
10838
10839 Note that <&'string2'&> is not itself subject to string expansion, unless
10840 Exim was built with the EXPAND_LISTMATCH_RHS option.
10841
10842 &*Note*&: Host lists are &'not'& supported in this way. This is because
10843 hosts have two identities: a name and an IP address, and it is not clear
10844 how to specify cleanly how such a test would work. However, IP addresses can be
10845 matched using &%match_ip%&.
10846
10847 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10848 .cindex "PAM authentication"
10849 .cindex "AUTH" "with PAM"
10850 .cindex "Solaris" "PAM support"
10851 .cindex "expansion" "PAM authentication test"
10852 .cindex "&%pam%& expansion condition"
10853 &'Pluggable Authentication Modules'&
10854 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10855 available in the latest releases of Solaris and in some GNU/Linux
10856 distributions. The Exim support, which is intended for use in conjunction with
10857 the SMTP AUTH command, is available only if Exim is compiled with
10858 .code
10859 SUPPORT_PAM=yes
10860 .endd
10861 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10862 in some releases of GNU/Linux &%-ldl%& is also needed.
10863
10864 The argument string is first expanded, and the result must be a
10865 colon-separated list of strings. Leading and trailing white space is ignored.
10866 The PAM module is initialized with the service name &"exim"& and the user name
10867 taken from the first item in the colon-separated data string (<&'string1'&>).
10868 The remaining items in the data string are passed over in response to requests
10869 from the authentication function. In the simple case there will only be one
10870 request, for a password, so the data consists of just two strings.
10871
10872 There can be problems if any of the strings are permitted to contain colon
10873 characters. In the usual way, these have to be doubled to avoid being taken as
10874 separators. If the data is being inserted from a variable, the &%sg%& expansion
10875 item can be used to double any existing colons. For example, the configuration
10876 of a LOGIN authenticator might contain this setting:
10877 .code
10878 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10879 .endd
10880 For a PLAIN authenticator you could use:
10881 .code
10882 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10883 .endd
10884 In some operating systems, PAM authentication can be done only from a process
10885 running as root. Since Exim is running as the Exim user when receiving
10886 messages, this means that PAM cannot be used directly in those systems.
10887 A patched version of the &'pam_unix'& module that comes with the
10888 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10889 The patched module allows one special uid/gid combination, in addition to root,
10890 to authenticate. If you build the patched module to allow the Exim user and
10891 group, PAM can then be used from an Exim authenticator.
10892
10893
10894 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10895 .cindex "&'pwcheck'& daemon"
10896 .cindex "Cyrus"
10897 .cindex "expansion" "&'pwcheck'& authentication test"
10898 .cindex "&%pwcheck%& expansion condition"
10899 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10900 This is one way of making it possible for passwords to be checked by a process
10901 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10902 deprecated. Its replacement is &'saslauthd'& (see below).
10903
10904 The pwcheck support is not included in Exim by default. You need to specify
10905 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10906 building Exim. For example:
10907 .code
10908 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10909 .endd
10910 You do not need to install the full Cyrus software suite in order to use
10911 the pwcheck daemon. You can compile and install just the daemon alone
10912 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10913 access to the &_/var/pwcheck_& directory.
10914
10915 The &%pwcheck%& condition takes one argument, which must be the user name and
10916 password, separated by a colon. For example, in a LOGIN authenticator
10917 configuration, you might have this:
10918 .code
10919 server_condition = ${if pwcheck{$auth1:$auth2}}
10920 .endd
10921 Again, for a PLAIN authenticator configuration, this would be:
10922 .code
10923 server_condition = ${if pwcheck{$auth2:$auth3}}
10924 .endd
10925 .vitem &*queue_running*&
10926 .cindex "queue runner" "detecting when delivering from"
10927 .cindex "expansion" "queue runner test"
10928 .cindex "&%queue_running%& expansion condition"
10929 This condition, which has no data, is true during delivery attempts that are
10930 initiated by queue runner processes, and false otherwise.
10931
10932
10933 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10934 .cindex "Radius"
10935 .cindex "expansion" "Radius authentication"
10936 .cindex "&%radius%& expansion condition"
10937 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10938 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10939 the Radius client configuration file in order to build Exim with Radius
10940 support.
10941
10942 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10943 library, using the original API. If you are using release 0.4.0 or later of
10944 this library, you need to set
10945 .code
10946 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10947 .endd
10948 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10949 &%libradius%& library that comes with FreeBSD. To do this, set
10950 .code
10951 RADIUS_LIB_TYPE=RADLIB
10952 .endd
10953 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10954 You may also have to supply a suitable setting in EXTRALIBS so that the
10955 Radius library can be found when Exim is linked.
10956
10957 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10958 Radius client library, which calls the Radius server. The condition is true if
10959 the authentication is successful. For example:
10960 .code
10961 server_condition = ${if radius{<arguments>}}
10962 .endd
10963
10964
10965 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10966         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10967 .cindex "&'saslauthd'& daemon"
10968 .cindex "Cyrus"
10969 .cindex "expansion" "&'saslauthd'& authentication test"
10970 .cindex "&%saslauthd%& expansion condition"
10971 This condition supports user authentication using the Cyrus &'saslauthd'&
10972 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10973 Using this daemon is one way of making it possible for passwords to be checked
10974 by a process that is not running as root.
10975
10976 The saslauthd support is not included in Exim by default. You need to specify
10977 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10978 building Exim. For example:
10979 .code
10980 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10981 .endd
10982 You do not need to install the full Cyrus software suite in order to use
10983 the saslauthd daemon. You can compile and install just the daemon alone
10984 from the Cyrus SASL library.
10985
10986 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10987 two are mandatory. For example:
10988 .code
10989 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10990 .endd
10991 The service and the realm are optional (which is why the arguments are enclosed
10992 in their own set of braces). For details of the meaning of the service and
10993 realm, and how to run the daemon, consult the Cyrus documentation.
10994 .endlist vlist
10995
10996
10997
10998 .section "Combining expansion conditions" "SECID84"
10999 .cindex "expansion" "combining conditions"
11000 Several conditions can be tested at once by combining them using the &%and%&
11001 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11002 conditions on their own, and precede their lists of sub-conditions. Each
11003 sub-condition must be enclosed in braces within the overall braces that contain
11004 the list. No repetition of &%if%& is used.
11005
11006
11007 .vlist
11008 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11009 .cindex "&""or""& expansion condition"
11010 .cindex "expansion" "&""or""& of conditions"
11011 The sub-conditions are evaluated from left to right. The condition is true if
11012 any one of the sub-conditions is true.
11013 For example,
11014 .code
11015 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11016 .endd
11017 When a true sub-condition is found, the following ones are parsed but not
11018 evaluated. If there are several &"match"& sub-conditions the values of the
11019 numeric variables afterwards are taken from the first one that succeeds.
11020
11021 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11022 .cindex "&""and""& expansion condition"
11023 .cindex "expansion" "&""and""& of conditions"
11024 The sub-conditions are evaluated from left to right. The condition is true if
11025 all of the sub-conditions are true. If there are several &"match"&
11026 sub-conditions, the values of the numeric variables afterwards are taken from
11027 the last one. When a false sub-condition is found, the following ones are
11028 parsed but not evaluated.
11029 .endlist
11030 .ecindex IIDexpcond
11031
11032
11033
11034
11035 .section "Expansion variables" "SECTexpvar"
11036 .cindex "expansion" "variables, list of"
11037 This section contains an alphabetical list of all the expansion variables. Some
11038 of them are available only when Exim is compiled with specific options such as
11039 support for TLS or the content scanning extension.
11040
11041 .vlist
11042 .vitem "&$0$&, &$1$&, etc"
11043 .cindex "numerical variables (&$1$& &$2$& etc)"
11044 When a &%match%& expansion condition succeeds, these variables contain the
11045 captured substrings identified by the regular expression during subsequent
11046 processing of the success string of the containing &%if%& expansion item.
11047 However, they do not retain their values afterwards; in fact, their previous
11048 values are restored at the end of processing an &%if%& item. The numerical
11049 variables may also be set externally by some other matching process which
11050 precedes the expansion of the string. For example, the commands available in
11051 Exim filter files include an &%if%& command with its own regular expression
11052 matching condition.
11053
11054 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11055 Within an acl condition, expansion condition or expansion item
11056 any arguments are copied to these variables,
11057 any unused variables being made empty.
11058
11059 .vitem "&$acl_c...$&"
11060 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11061 can be given any name that starts with &$acl_c$& and is at least six characters
11062 long, but the sixth character must be either a digit or an underscore. For
11063 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11064 variables persist throughout the lifetime of an SMTP connection. They can be
11065 used to pass information between ACLs and between different invocations of the
11066 same ACL. When a message is received, the values of these variables are saved
11067 with the message, and can be accessed by filters, routers, and transports
11068 during subsequent delivery.
11069
11070 .vitem "&$acl_m...$&"
11071 These variables are like the &$acl_c...$& variables, except that their values
11072 are reset after a message has been received. Thus, if several messages are
11073 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11074 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11075 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11076 message is received, the values of these variables are saved with the message,
11077 and can be accessed by filters, routers, and transports during subsequent
11078 delivery.
11079
11080 .vitem &$acl_narg$&
11081 Within an acl condition, expansion condition or expansion item
11082 this variable has the number of arguments.
11083
11084 .vitem &$acl_verify_message$&
11085 .vindex "&$acl_verify_message$&"
11086 After an address verification has failed, this variable contains the failure
11087 message. It retains its value for use in subsequent modifiers. The message can
11088 be preserved by coding like this:
11089 .code
11090 warn !verify = sender
11091      set acl_m0 = $acl_verify_message
11092 .endd
11093 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11094 &%log_message%& modifiers, to include information about the verification
11095 failure.
11096
11097 .vitem &$address_data$&
11098 .vindex "&$address_data$&"
11099 This variable is set by means of the &%address_data%& option in routers. The
11100 value then remains with the address while it is processed by subsequent routers
11101 and eventually a transport. If the transport is handling multiple addresses,
11102 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11103 for more details. &*Note*&: The contents of &$address_data$& are visible in
11104 user filter files.
11105
11106 If &$address_data$& is set when the routers are called from an ACL to verify
11107 a recipient address, the final value is still in the variable for subsequent
11108 conditions and modifiers of the ACL statement. If routing the address caused it
11109 to be redirected to just one address, the child address is also routed as part
11110 of the verification, and in this case the final value of &$address_data$& is
11111 from the child's routing.
11112
11113 If &$address_data$& is set when the routers are called from an ACL to verify a
11114 sender address, the final value is also preserved, but this time in
11115 &$sender_address_data$&, to distinguish it from data from a recipient
11116 address.
11117
11118 In both cases (recipient and sender verification), the value does not persist
11119 after the end of the current ACL statement. If you want to preserve
11120 these values for longer, you can save them in ACL variables.
11121
11122 .vitem &$address_file$&
11123 .vindex "&$address_file$&"
11124 When, as a result of aliasing, forwarding, or filtering, a message is directed
11125 to a specific file, this variable holds the name of the file when the transport
11126 is running. At other times, the variable is empty. For example, using the
11127 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11128 .code
11129 /home/r2d2/savemail
11130 .endd
11131 then when the &(address_file)& transport is running, &$address_file$&
11132 contains the text string &`/home/r2d2/savemail`&.
11133 .cindex "Sieve filter" "value of &$address_file$&"
11134 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11135 then up to the transport configuration to generate an appropriate absolute path
11136 to the relevant file.
11137
11138 .vitem &$address_pipe$&
11139 .vindex "&$address_pipe$&"
11140 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11141 this variable holds the pipe command when the transport is running.
11142
11143 .vitem "&$auth1$& &-- &$auth3$&"
11144 .vindex "&$auth1$&, &$auth2$&, etc"
11145 These variables are used in SMTP authenticators (see chapters
11146 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11147
11148 .vitem &$authenticated_id$&
11149 .cindex "authentication" "id"
11150 .vindex "&$authenticated_id$&"
11151 When a server successfully authenticates a client it may be configured to
11152 preserve some of the authentication information in the variable
11153 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11154 user/password authenticator configuration might preserve the user name for use
11155 in the routers. Note that this is not the same information that is saved in
11156 &$sender_host_authenticated$&.
11157 When a message is submitted locally (that is, not over a TCP connection)
11158 the value of &$authenticated_id$& is normally the login name of the calling
11159 process. However, a trusted user can override this by means of the &%-oMai%&
11160 command line option.
11161
11162 .vitem &$authenticated_fail_id$&
11163 .cindex "authentication" "fail" "id"
11164 .vindex "&$authenticated_fail_id$&"
11165 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11166 will contain the failed authentication id. If more than one authentication
11167 id is attempted, it will contain only the last one. The variable is
11168 available for processing in the ACL's, generally the quit or notquit ACL.
11169 A message to a local recipient could still be accepted without requiring
11170 authentication, which means this variable could also be visible in all of
11171 the ACL's as well.
11172
11173
11174 .vitem &$authenticated_sender$&
11175 .cindex "sender" "authenticated"
11176 .cindex "authentication" "sender"
11177 .cindex "AUTH" "on MAIL command"
11178 .vindex "&$authenticated_sender$&"
11179 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11180 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11181 described in section &<<SECTauthparamail>>&. Unless the data is the string
11182 &"<>"&, it is set as the authenticated sender of the message, and the value is
11183 available during delivery in the &$authenticated_sender$& variable. If the
11184 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11185
11186 .vindex "&$qualify_domain$&"
11187 When a message is submitted locally (that is, not over a TCP connection), the
11188 value of &$authenticated_sender$& is an address constructed from the login
11189 name of the calling process and &$qualify_domain$&, except that a trusted user
11190 can override this by means of the &%-oMas%& command line option.
11191
11192
11193 .vitem &$authentication_failed$&
11194 .cindex "authentication" "failure"
11195 .vindex "&$authentication_failed$&"
11196 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11197 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11198 possible to distinguish between &"did not try to authenticate"&
11199 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11200 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11201 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11202 negative response to an AUTH command, including (for example) an attempt to use
11203 an undefined mechanism.
11204
11205 .vitem &$av_failed$&
11206 .cindex "content scanning" "AV scanner failure"
11207 This variable is available when Exim is compiled with the content-scanning
11208 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11209 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11210 the ACL malware condition.
11211
11212 .vitem &$body_linecount$&
11213 .cindex "message body" "line count"
11214 .cindex "body of message" "line count"
11215 .vindex "&$body_linecount$&"
11216 When a message is being received or delivered, this variable contains the
11217 number of lines in the message's body. See also &$message_linecount$&.
11218
11219 .vitem &$body_zerocount$&
11220 .cindex "message body" "binary zero count"
11221 .cindex "body of message" "binary zero count"
11222 .cindex "binary zero" "in message body"
11223 .vindex "&$body_zerocount$&"
11224 When a message is being received or delivered, this variable contains the
11225 number of binary zero bytes (ASCII NULs) in the message's body.
11226
11227 .vitem &$bounce_recipient$&
11228 .vindex "&$bounce_recipient$&"
11229 This is set to the recipient address of a bounce message while Exim is creating
11230 it. It is useful if a customized bounce message text file is in use (see
11231 chapter &<<CHAPemsgcust>>&).
11232
11233 .vitem &$bounce_return_size_limit$&
11234 .vindex "&$bounce_return_size_limit$&"
11235 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11236 up to a multiple of 1000. It is useful when a customized error message text
11237 file is in use (see chapter &<<CHAPemsgcust>>&).
11238
11239 .vitem &$caller_gid$&
11240 .cindex "gid (group id)" "caller"
11241 .vindex "&$caller_gid$&"
11242 The real group id under which the process that called Exim was running. This is
11243 not the same as the group id of the originator of a message (see
11244 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11245 incarnation normally contains the Exim gid.
11246
11247 .vitem &$caller_uid$&
11248 .cindex "uid (user id)" "caller"
11249 .vindex "&$caller_uid$&"
11250 The real user id under which the process that called Exim was running. This is
11251 not the same as the user id of the originator of a message (see
11252 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11253 incarnation normally contains the Exim uid.
11254
11255 .vitem &$compile_date$&
11256 .vindex "&$compile_date$&"
11257 The date on which the Exim binary was compiled.
11258
11259 .vitem &$compile_number$&
11260 .vindex "&$compile_number$&"
11261 The building process for Exim keeps a count of the number
11262 of times it has been compiled. This serves to distinguish different
11263 compilations of the same version of the program.
11264
11265 .new
11266 .vitem &$config_dir$&
11267 .vindex "&$config_dir$&"
11268 The directory name of the main configuration file. That is, the content of
11269 &$config_file$& with the last component stripped. The value does not
11270 contain the trailing slash. If &$config_file$& does not contain a slash,
11271 &$config_dir$& is ".".
11272
11273 .vitem &$config_file$&
11274 .vindex "&$config_file$&"
11275 The name of the main configuration file Exim is using.
11276 .wen
11277
11278 .vitem &$demime_errorlevel$&
11279 .vindex "&$demime_errorlevel$&"
11280 This variable is available when Exim is compiled with
11281 the content-scanning extension and the obsolete &%demime%& condition. For
11282 details, see section &<<SECTdemimecond>>&.
11283
11284 .vitem &$demime_reason$&
11285 .vindex "&$demime_reason$&"
11286 This variable is available when Exim is compiled with the
11287 content-scanning extension and the obsolete &%demime%& condition. For details,
11288 see section &<<SECTdemimecond>>&.
11289
11290 .vitem &$dnslist_domain$& &&&
11291        &$dnslist_matched$& &&&
11292        &$dnslist_text$& &&&
11293        &$dnslist_value$&
11294 .vindex "&$dnslist_domain$&"
11295 .vindex "&$dnslist_matched$&"
11296 .vindex "&$dnslist_text$&"
11297 .vindex "&$dnslist_value$&"
11298 .cindex "black list (DNS)"
11299 When a DNS (black) list lookup succeeds, these variables are set to contain
11300 the following data from the lookup: the list's domain name, the key that was
11301 looked up, the contents of any associated TXT record, and the value from the
11302 main A record. See section &<<SECID204>>& for more details.
11303
11304 .vitem &$domain$&
11305 .vindex "&$domain$&"
11306 When an address is being routed, or delivered on its own, this variable
11307 contains the domain. Uppercase letters in the domain are converted into lower
11308 case for &$domain$&.
11309
11310 Global address rewriting happens when a message is received, so the value of
11311 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11312 is set during user filtering, but not during system filtering, because a
11313 message may have many recipients and the system filter is called just once.
11314
11315 When more than one address is being delivered at once (for example, several
11316 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11317 have the same domain. Transports can be restricted to handling only one domain
11318 at a time if the value of &$domain$& is required at transport time &-- this is
11319 the default for local transports. For further details of the environment in
11320 which local transports are run, see chapter &<<CHAPenvironment>>&.
11321
11322 .oindex "&%delay_warning_condition%&"
11323 At the end of a delivery, if all deferred addresses have the same domain, it is
11324 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11325
11326 The &$domain$& variable is also used in some other circumstances:
11327
11328 .ilist
11329 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11330 the recipient address. The domain of the &'sender'& address is in
11331 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11332 normally set during the running of the MAIL ACL. However, if the sender address
11333 is verified with a callout during the MAIL ACL, the sender domain is placed in
11334 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11335 the &(smtp)& transport.
11336
11337 .next
11338 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11339 &$domain$& contains the domain portion of the address that is being rewritten;
11340 it can be used in the expansion of the replacement address, for example, to
11341 rewrite domains by file lookup.
11342
11343 .next
11344 With one important exception, whenever a domain list is being scanned,
11345 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11346 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11347 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11348 that, in a RCPT ACL, the sender domain list can be dependent on the
11349 recipient domain (which is what is in &$domain$& at this time).
11350
11351 .next
11352 .cindex "ETRN" "value of &$domain$&"
11353 .oindex "&%smtp_etrn_command%&"
11354 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11355 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11356 .endlist
11357
11358
11359 .vitem &$domain_data$&
11360 .vindex "&$domain_data$&"
11361 When the &%domains%& option on a router matches a domain by
11362 means of a lookup, the data read by the lookup is available during the running
11363 of the router as &$domain_data$&. In addition, if the driver routes the
11364 address to a transport, the value is available in that transport. If the
11365 transport is handling multiple addresses, the value from the first address is
11366 used.
11367
11368 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11369 domain by means of a lookup. The data read by the lookup is available during
11370 the rest of the ACL statement. In all other situations, this variable expands
11371 to nothing.
11372
11373 .vitem &$exim_gid$&
11374 .vindex "&$exim_gid$&"
11375 This variable contains the numerical value of the Exim group id.
11376
11377 .vitem &$exim_path$&
11378 .vindex "&$exim_path$&"
11379 This variable contains the path to the Exim binary.
11380
11381 .vitem &$exim_uid$&
11382 .vindex "&$exim_uid$&"
11383 This variable contains the numerical value of the Exim user id.
11384
11385 .new
11386 .vitem &$exim_version$&
11387 .vindex "&$exim_uid$&"
11388 This variable contains the version string of the Exim build.
11389 The first character is a major version number, currently 4.
11390 Then after a dot, the next group of digits is a minor version number.
11391 There may be other characters following the minor version.
11392 .wen
11393
11394 .vitem &$found_extension$&
11395 .vindex "&$found_extension$&"
11396 This variable is available when Exim is compiled with the
11397 content-scanning extension and the obsolete &%demime%& condition. For details,
11398 see section &<<SECTdemimecond>>&.
11399
11400 .vitem &$header_$&<&'name'&>
11401 This is not strictly an expansion variable. It is expansion syntax for
11402 inserting the message header line with the given name. Note that the name must
11403 be terminated by colon or white space, because it may contain a wide variety of
11404 characters. Note also that braces must &'not'& be used.
11405
11406 .vitem &$headers_added$&
11407 .vindex "&$headers_added$&"
11408 Within an ACL this variable contains the headers added so far by
11409 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11410 The headers are a newline-separated list.
11411
11412 .vitem &$home$&
11413 .vindex "&$home$&"
11414 When the &%check_local_user%& option is set for a router, the user's home
11415 directory is placed in &$home$& when the check succeeds. In particular, this
11416 means it is set during the running of users' filter files. A router may also
11417 explicitly set a home directory for use by a transport; this can be overridden
11418 by a setting on the transport itself.
11419
11420 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11421 of the environment variable HOME.
11422
11423 .vitem &$host$&
11424 .vindex "&$host$&"
11425 If a router assigns an address to a transport (any transport), and passes a
11426 list of hosts with the address, the value of &$host$& when the transport starts
11427 to run is the name of the first host on the list. Note that this applies both
11428 to local and remote transports.
11429
11430 .cindex "transport" "filter"
11431 .cindex "filter" "transport filter"
11432 For the &(smtp)& transport, if there is more than one host, the value of
11433 &$host$& changes as the transport works its way through the list. In
11434 particular, when the &(smtp)& transport is expanding its options for encryption
11435 using TLS, or for specifying a transport filter (see chapter
11436 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11437 is connected.
11438
11439 When used in the client part of an authenticator configuration (see chapter
11440 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11441 client is connected.
11442
11443
11444 .vitem &$host_address$&
11445 .vindex "&$host_address$&"
11446 This variable is set to the remote host's IP address whenever &$host$& is set
11447 for a remote connection. It is also set to the IP address that is being checked
11448 when the &%ignore_target_hosts%& option is being processed.
11449
11450 .vitem &$host_data$&
11451 .vindex "&$host_data$&"
11452 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11453 result of the lookup is made available in the &$host_data$& variable. This
11454 allows you, for example, to do things like this:
11455 .code
11456 deny  hosts = net-lsearch;/some/file
11457 message = $host_data
11458 .endd
11459 .vitem &$host_lookup_deferred$&
11460 .cindex "host name" "lookup, failure of"
11461 .vindex "&$host_lookup_deferred$&"
11462 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11463 message comes from a remote host and there is an attempt to look up the host's
11464 name from its IP address, and the attempt is not successful, one of these
11465 variables is set to &"1"&.
11466
11467 .ilist
11468 If the lookup receives a definite negative response (for example, a DNS lookup
11469 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11470
11471 .next
11472 If there is any kind of problem during the lookup, such that Exim cannot
11473 tell whether or not the host name is defined (for example, a timeout for a DNS
11474 lookup), &$host_lookup_deferred$& is set to &"1"&.
11475 .endlist ilist
11476
11477 Looking up a host's name from its IP address consists of more than just a
11478 single reverse lookup. Exim checks that a forward lookup of at least one of the
11479 names it receives from a reverse lookup yields the original IP address. If this
11480 is not the case, Exim does not accept the looked up name(s), and
11481 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11482 IP address (for example, the existence of a PTR record in the DNS) is not
11483 sufficient on its own for the success of a host name lookup. If the reverse
11484 lookup succeeds, but there is a lookup problem such as a timeout when checking
11485 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11486 &"1"&. See also &$sender_host_name$&.
11487
11488 .vitem &$host_lookup_failed$&
11489 .vindex "&$host_lookup_failed$&"
11490 See &$host_lookup_deferred$&.
11491
11492 .vitem &$host_port$&
11493 .vindex "&$host_port$&"
11494 This variable is set to the remote host's TCP port whenever &$host$& is set
11495 for an outbound connection.
11496
11497
11498 .vitem &$inode$&
11499 .vindex "&$inode$&"
11500 The only time this variable is set is while expanding the &%directory_file%&
11501 option in the &(appendfile)& transport. The variable contains the inode number
11502 of the temporary file which is about to be renamed. It can be used to construct
11503 a unique name for the file.
11504
11505 .vitem &$interface_address$&
11506 .vindex "&$interface_address$&"
11507 This is an obsolete name for &$received_ip_address$&.
11508
11509 .vitem &$interface_port$&
11510 .vindex "&$interface_port$&"
11511 This is an obsolete name for &$received_port$&.
11512
11513 .vitem &$item$&
11514 .vindex "&$item$&"
11515 This variable is used during the expansion of &*forall*& and &*forany*&
11516 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11517 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11518 empty.
11519
11520 .vitem &$ldap_dn$&
11521 .vindex "&$ldap_dn$&"
11522 This variable, which is available only when Exim is compiled with LDAP support,
11523 contains the DN from the last entry in the most recently successful LDAP
11524 lookup.
11525
11526 .vitem &$load_average$&
11527 .vindex "&$load_average$&"
11528 This variable contains the system load average, multiplied by 1000 so that it
11529 is an integer. For example, if the load average is 0.21, the value of the
11530 variable is 210. The value is recomputed every time the variable is referenced.
11531
11532 .vitem &$local_part$&
11533 .vindex "&$local_part$&"
11534 When an address is being routed, or delivered on its own, this
11535 variable contains the local part. When a number of addresses are being
11536 delivered together (for example, multiple RCPT commands in an SMTP
11537 session), &$local_part$& is not set.
11538
11539 Global address rewriting happens when a message is received, so the value of
11540 &$local_part$& during routing and delivery is the value after rewriting.
11541 &$local_part$& is set during user filtering, but not during system filtering,
11542 because a message may have many recipients and the system filter is called just
11543 once.
11544
11545 .vindex "&$local_part_prefix$&"
11546 .vindex "&$local_part_suffix$&"
11547 If a local part prefix or suffix has been recognized, it is not included in the
11548 value of &$local_part$& during routing and subsequent delivery. The values of
11549 any prefix or suffix are in &$local_part_prefix$& and
11550 &$local_part_suffix$&, respectively.
11551
11552 When a message is being delivered to a file, pipe, or autoreply transport as a
11553 result of aliasing or forwarding, &$local_part$& is set to the local part of
11554 the parent address, not to the file name or command (see &$address_file$& and
11555 &$address_pipe$&).
11556
11557 When an ACL is running for a RCPT command, &$local_part$& contains the
11558 local part of the recipient address.
11559
11560 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11561 &$local_part$& contains the local part of the address that is being rewritten;
11562 it can be used in the expansion of the replacement address, for example.
11563
11564 In all cases, all quoting is removed from the local part. For example, for both
11565 the addresses
11566 .code
11567 "abc:xyz"@test.example
11568 abc\:xyz@test.example
11569 .endd
11570 the value of &$local_part$& is
11571 .code
11572 abc:xyz
11573 .endd
11574 If you use &$local_part$& to create another address, you should always wrap it
11575 inside a quoting operator. For example, in a &(redirect)& router you could
11576 have:
11577 .code
11578 data = ${quote_local_part:$local_part}@new.domain.example
11579 .endd
11580 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11581 to process local parts in a case-dependent manner in a router, you can set the
11582 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11583
11584 .vitem &$local_part_data$&
11585 .vindex "&$local_part_data$&"
11586 When the &%local_parts%& option on a router matches a local part by means of a
11587 lookup, the data read by the lookup is available during the running of the
11588 router as &$local_part_data$&. In addition, if the driver routes the address
11589 to a transport, the value is available in that transport. If the transport is
11590 handling multiple addresses, the value from the first address is used.
11591
11592 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11593 matches a local part by means of a lookup. The data read by the lookup is
11594 available during the rest of the ACL statement. In all other situations, this
11595 variable expands to nothing.
11596
11597 .vitem &$local_part_prefix$&
11598 .vindex "&$local_part_prefix$&"
11599 When an address is being routed or delivered, and a
11600 specific prefix for the local part was recognized, it is available in this
11601 variable, having been removed from &$local_part$&.
11602
11603 .vitem &$local_part_suffix$&
11604 .vindex "&$local_part_suffix$&"
11605 When an address is being routed or delivered, and a
11606 specific suffix for the local part was recognized, it is available in this
11607 variable, having been removed from &$local_part$&.
11608
11609 .vitem &$local_scan_data$&
11610 .vindex "&$local_scan_data$&"
11611 This variable contains the text returned by the &[local_scan()]& function when
11612 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11613
11614 .vitem &$local_user_gid$&
11615 .vindex "&$local_user_gid$&"
11616 See &$local_user_uid$&.
11617
11618 .vitem &$local_user_uid$&
11619 .vindex "&$local_user_uid$&"
11620 This variable and &$local_user_gid$& are set to the uid and gid after the
11621 &%check_local_user%& router precondition succeeds. This means that their values
11622 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11623 and &%condition%&), for the &%address_data%& expansion, and for any
11624 router-specific expansions. At all other times, the values in these variables
11625 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11626
11627 .vitem &$localhost_number$&
11628 .vindex "&$localhost_number$&"
11629 This contains the expanded value of the
11630 &%localhost_number%& option. The expansion happens after the main options have
11631 been read.
11632
11633 .vitem &$log_inodes$&
11634 .vindex "&$log_inodes$&"
11635 The number of free inodes in the disk partition where Exim's
11636 log files are being written. The value is recalculated whenever the variable is
11637 referenced. If the relevant file system does not have the concept of inodes,
11638 the value of is -1. See also the &%check_log_inodes%& option.
11639
11640 .vitem &$log_space$&
11641 .vindex "&$log_space$&"
11642 The amount of free space (as a number of kilobytes) in the disk
11643 partition where Exim's log files are being written. The value is recalculated
11644 whenever the variable is referenced. If the operating system does not have the
11645 ability to find the amount of free space (only true for experimental systems),
11646 the space value is -1. See also the &%check_log_space%& option.
11647
11648
11649 .vitem &$lookup_dnssec_authenticated$&
11650 .vindex "&$lookup_dnssec_authenticated$&"
11651 This variable is set after a DNS lookup done by
11652 a dnsdb lookup expansion, dnslookup router or smtp transport.
11653 It will be empty if &(DNSSEC)& was not requested,
11654 &"no"& if the result was not labelled as authenticated data
11655 and &"yes"& if it was.
11656
11657 .vitem &$mailstore_basename$&
11658 .vindex "&$mailstore_basename$&"
11659 This variable is set only when doing deliveries in &"mailstore"& format in the
11660 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11661 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11662 contains the basename of the files that are being written, that is, the name
11663 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11664 variable is empty.
11665
11666 .vitem &$malware_name$&
11667 .vindex "&$malware_name$&"
11668 This variable is available when Exim is compiled with the
11669 content-scanning extension. It is set to the name of the virus that was found
11670 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11671
11672 .vitem &$max_received_linelength$&
11673 .vindex "&$max_received_linelength$&"
11674 .cindex "maximum" "line length"
11675 .cindex "line length" "maximum"
11676 This variable contains the number of bytes in the longest line that was
11677 received as part of the message, not counting the line termination
11678 character(s).
11679
11680 .vitem &$message_age$&
11681 .cindex "message" "age of"
11682 .vindex "&$message_age$&"
11683 This variable is set at the start of a delivery attempt to contain the number
11684 of seconds since the message was received. It does not change during a single
11685 delivery attempt.
11686
11687 .vitem &$message_body$&
11688 .cindex "body of message" "expansion variable"
11689 .cindex "message body" "in expansion"
11690 .cindex "binary zero" "in message body"
11691 .vindex "&$message_body$&"
11692 .oindex "&%message_body_visible%&"
11693 This variable contains the initial portion of a message's body while it is
11694 being delivered, and is intended mainly for use in filter files. The maximum
11695 number of characters of the body that are put into the variable is set by the
11696 &%message_body_visible%& configuration option; the default is 500.
11697
11698 .oindex "&%message_body_newlines%&"
11699 By default, newlines are converted into spaces in &$message_body$&, to make it
11700 easier to search for phrases that might be split over a line break. However,
11701 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11702 zeros are always converted into spaces.
11703
11704 .vitem &$message_body_end$&
11705 .cindex "body of message" "expansion variable"
11706 .cindex "message body" "in expansion"
11707 .vindex "&$message_body_end$&"
11708 This variable contains the final portion of a message's
11709 body while it is being delivered. The format and maximum size are as for
11710 &$message_body$&.
11711
11712 .vitem &$message_body_size$&
11713 .cindex "body of message" "size"
11714 .cindex "message body" "size"
11715 .vindex "&$message_body_size$&"
11716 When a message is being delivered, this variable contains the size of the body
11717 in bytes. The count starts from the character after the blank line that
11718 separates the body from the header. Newlines are included in the count. See
11719 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11720
11721 .vitem &$message_exim_id$&
11722 .vindex "&$message_exim_id$&"
11723 When a message is being received or delivered, this variable contains the
11724 unique message id that is generated and used by Exim to identify the message.
11725 An id is not created for a message until after its header has been successfully
11726 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11727 line; it is the local id that Exim assigns to the message, for example:
11728 &`1BXTIK-0001yO-VA`&.
11729
11730 .vitem &$message_headers$&
11731 .vindex &$message_headers$&
11732 This variable contains a concatenation of all the header lines when a message
11733 is being processed, except for lines added by routers or transports. The header
11734 lines are separated by newline characters. Their contents are decoded in the
11735 same way as a header line that is inserted by &%bheader%&.
11736
11737 .vitem &$message_headers_raw$&
11738 .vindex &$message_headers_raw$&
11739 This variable is like &$message_headers$& except that no processing of the
11740 contents of header lines is done.
11741
11742 .vitem &$message_id$&
11743 This is an old name for &$message_exim_id$&. It is now deprecated.
11744
11745 .vitem &$message_linecount$&
11746 .vindex "&$message_linecount$&"
11747 This variable contains the total number of lines in the header and body of the
11748 message. Compare &$body_linecount$&, which is the count for the body only.
11749 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11750 number of lines received. Before delivery happens (that is, before filters,
11751 routers, and transports run) the count is increased to include the
11752 &'Received:'& header line that Exim standardly adds, and also any other header
11753 lines that are added by ACLs. The blank line that separates the message header
11754 from the body is not counted.
11755
11756 As with the special case of &$message_size$&, during the expansion of the
11757 appendfile transport's maildir_tag option in maildir format, the value of
11758 &$message_linecount$& is the precise size of the number of newlines in the
11759 file that has been written (minus one for the blank line between the
11760 header and the body).
11761
11762 Here is an example of the use of this variable in a DATA ACL:
11763 .code
11764 deny message   = Too many lines in message header
11765      condition = \
11766       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11767 .endd
11768 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11769 message has not yet been received.
11770
11771 .vitem &$message_size$&
11772 .cindex "size" "of message"
11773 .cindex "message" "size"
11774 .vindex "&$message_size$&"
11775 When a message is being processed, this variable contains its size in bytes. In
11776 most cases, the size includes those headers that were received with the
11777 message, but not those (such as &'Envelope-to:'&) that are added to individual
11778 deliveries as they are written. However, there is one special case: during the
11779 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11780 doing a delivery in maildir format, the value of &$message_size$& is the
11781 precise size of the file that has been written. See also
11782 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11783
11784 .cindex "RCPT" "value of &$message_size$&"
11785 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11786 contains the size supplied on the MAIL command, or -1 if no size was given. The
11787 value may not, of course, be truthful.
11788
11789 .vitem &$mime_$&&'xxx'&
11790 A number of variables whose names start with &$mime$& are
11791 available when Exim is compiled with the content-scanning extension. For
11792 details, see section &<<SECTscanmimepart>>&.
11793
11794 .vitem "&$n0$& &-- &$n9$&"
11795 These variables are counters that can be incremented by means
11796 of the &%add%& command in filter files.
11797
11798 .vitem &$original_domain$&
11799 .vindex "&$domain$&"
11800 .vindex "&$original_domain$&"
11801 When a top-level address is being processed for delivery, this contains the
11802 same value as &$domain$&. However, if a &"child"& address (for example,
11803 generated by an alias, forward, or filter file) is being processed, this
11804 variable contains the domain of the original address (lower cased). This
11805 differs from &$parent_domain$& only when there is more than one level of
11806 aliasing or forwarding. When more than one address is being delivered in a
11807 single transport run, &$original_domain$& is not set.
11808
11809 If a new address is created by means of a &%deliver%& command in a system
11810 filter, it is set up with an artificial &"parent"& address. This has the local
11811 part &'system-filter'& and the default qualify domain.
11812
11813 .vitem &$original_local_part$&
11814 .vindex "&$local_part$&"
11815 .vindex "&$original_local_part$&"
11816 When a top-level address is being processed for delivery, this contains the
11817 same value as &$local_part$&, unless a prefix or suffix was removed from the
11818 local part, because &$original_local_part$& always contains the full local
11819 part. When a &"child"& address (for example, generated by an alias, forward, or
11820 filter file) is being processed, this variable contains the full local part of
11821 the original address.
11822
11823 If the router that did the redirection processed the local part
11824 case-insensitively, the value in &$original_local_part$& is in lower case.
11825 This variable differs from &$parent_local_part$& only when there is more than
11826 one level of aliasing or forwarding. When more than one address is being
11827 delivered in a single transport run, &$original_local_part$& is not set.
11828
11829 If a new address is created by means of a &%deliver%& command in a system
11830 filter, it is set up with an artificial &"parent"& address. This has the local
11831 part &'system-filter'& and the default qualify domain.
11832
11833 .vitem &$originator_gid$&
11834 .cindex "gid (group id)" "of originating user"
11835 .cindex "sender" "gid"
11836 .vindex "&$caller_gid$&"
11837 .vindex "&$originator_gid$&"
11838 This variable contains the value of &$caller_gid$& that was set when the
11839 message was received. For messages received via the command line, this is the
11840 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11841 normally the gid of the Exim user.
11842
11843 .vitem &$originator_uid$&
11844 .cindex "uid (user id)" "of originating user"
11845 .cindex "sender" "uid"
11846 .vindex "&$caller_uid$&"
11847 .vindex "&$originaltor_uid$&"
11848 The value of &$caller_uid$& that was set when the message was received. For
11849 messages received via the command line, this is the uid of the sending user.
11850 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11851 user.
11852
11853 .vitem &$parent_domain$&
11854 .vindex "&$parent_domain$&"
11855 This variable is similar to &$original_domain$& (see
11856 above), except that it refers to the immediately preceding parent address.
11857
11858 .vitem &$parent_local_part$&
11859 .vindex "&$parent_local_part$&"
11860 This variable is similar to &$original_local_part$&
11861 (see above), except that it refers to the immediately preceding parent address.
11862
11863 .vitem &$pid$&
11864 .cindex "pid (process id)" "of current process"
11865 .vindex "&$pid$&"
11866 This variable contains the current process id.
11867
11868 .vitem &$pipe_addresses$&
11869 .cindex "filter" "transport filter"
11870 .cindex "transport" "filter"
11871 .vindex "&$pipe_addresses$&"
11872 This is not an expansion variable, but is mentioned here because the string
11873 &`$pipe_addresses`& is handled specially in the command specification for the
11874 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11875 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11876 It cannot be used in general expansion strings, and provokes an &"unknown
11877 variable"& error if encountered.
11878
11879 .vitem &$primary_hostname$&
11880 .vindex "&$primary_hostname$&"
11881 This variable contains the value set by &%primary_hostname%& in the
11882 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11883 a single-component name, Exim calls &[gethostbyname()]& (or
11884 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11885 qualified host name. See also &$smtp_active_hostname$&.
11886
11887
11888 .vitem &$prvscheck_address$&
11889 This variable is used in conjunction with the &%prvscheck%& expansion item,
11890 which is described in sections &<<SECTexpansionitems>>& and
11891 &<<SECTverifyPRVS>>&.
11892
11893 .vitem &$prvscheck_keynum$&
11894 This variable is used in conjunction with the &%prvscheck%& expansion item,
11895 which is described in sections &<<SECTexpansionitems>>& and
11896 &<<SECTverifyPRVS>>&.
11897
11898 .vitem &$prvscheck_result$&
11899 This variable is used in conjunction with the &%prvscheck%& expansion item,
11900 which is described in sections &<<SECTexpansionitems>>& and
11901 &<<SECTverifyPRVS>>&.
11902
11903 .vitem &$qualify_domain$&
11904 .vindex "&$qualify_domain$&"
11905 The value set for the &%qualify_domain%& option in the configuration file.
11906
11907 .vitem &$qualify_recipient$&
11908 .vindex "&$qualify_recipient$&"
11909 The value set for the &%qualify_recipient%& option in the configuration file,
11910 or if not set, the value of &$qualify_domain$&.
11911
11912 .vitem &$rcpt_count$&
11913 .vindex "&$rcpt_count$&"
11914 When a message is being received by SMTP, this variable contains the number of
11915 RCPT commands received for the current message. If this variable is used in a
11916 RCPT ACL, its value includes the current command.
11917
11918 .vitem &$rcpt_defer_count$&
11919 .vindex "&$rcpt_defer_count$&"
11920 .cindex "4&'xx'& responses" "count of"
11921 When a message is being received by SMTP, this variable contains the number of
11922 RCPT commands in the current message that have previously been rejected with a
11923 temporary (4&'xx'&) response.
11924
11925 .vitem &$rcpt_fail_count$&
11926 .vindex "&$rcpt_fail_count$&"
11927 When a message is being received by SMTP, this variable contains the number of
11928 RCPT commands in the current message that have previously been rejected with a
11929 permanent (5&'xx'&) response.
11930
11931 .vitem &$received_count$&
11932 .vindex "&$received_count$&"
11933 This variable contains the number of &'Received:'& header lines in the message,
11934 including the one added by Exim (so its value is always greater than zero). It
11935 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11936 delivering.
11937
11938 .vitem &$received_for$&
11939 .vindex "&$received_for$&"
11940 If there is only a single recipient address in an incoming message, this
11941 variable contains that address when the &'Received:'& header line is being
11942 built. The value is copied after recipient rewriting has happened, but before
11943 the &[local_scan()]& function is run.
11944
11945 .vitem &$received_ip_address$&
11946 .vindex "&$received_ip_address$&"
11947 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11948 variable is set to the address of the local IP interface, and &$received_port$&
11949 is set to the local port number. (The remote IP address and port are in
11950 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11951 the port value is -1 unless it has been set using the &%-oMi%& command line
11952 option.
11953
11954 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11955 could be used, for example, to make the file name for a TLS certificate depend
11956 on which interface and/or port is being used for the incoming connection. The
11957 values of &$received_ip_address$& and &$received_port$& are saved with any
11958 messages that are received, thus making these variables available at delivery
11959 time.
11960 For outbound connections see &$sending_ip_address$&.
11961
11962 .vitem &$received_port$&
11963 .vindex "&$received_port$&"
11964 See &$received_ip_address$&.
11965
11966 .vitem &$received_protocol$&
11967 .vindex "&$received_protocol$&"
11968 When a message is being processed, this variable contains the name of the
11969 protocol by which it was received. Most of the names used by Exim are defined
11970 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11971 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11972 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11973 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11974 connection and the client was successfully authenticated.
11975
11976 Exim uses the protocol name &"smtps"& for the case when encryption is
11977 automatically set up on connection without the use of STARTTLS (see
11978 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11979 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11980 where the client initially uses EHLO, sets up an encrypted connection using
11981 STARTTLS, and then uses HELO afterwards.
11982
11983 The &%-oMr%& option provides a way of specifying a custom protocol name for
11984 messages that are injected locally by trusted callers. This is commonly used to
11985 identify messages that are being re-injected after some kind of scanning.
11986
11987 .vitem &$received_time$&
11988 .vindex "&$received_time$&"
11989 This variable contains the date and time when the current message was received,
11990 as a number of seconds since the start of the Unix epoch.
11991
11992 .vitem &$recipient_data$&
11993 .vindex "&$recipient_data$&"
11994 This variable is set after an indexing lookup success in an ACL &%recipients%&
11995 condition. It contains the data from the lookup, and the value remains set
11996 until the next &%recipients%& test. Thus, you can do things like this:
11997 .display
11998 &`require recipients  = cdb*@;/some/file`&
11999 &`deny    `&&'some further test involving'& &`$recipient_data`&
12000 .endd
12001 &*Warning*&: This variable is set only when a lookup is used as an indexing
12002 method in the address list, using the semicolon syntax as in the example above.
12003 The variable is not set for a lookup that is used as part of the string
12004 expansion that all such lists undergo before being interpreted.
12005
12006 .vitem &$recipient_verify_failure$&
12007 .vindex "&$recipient_verify_failure$&"
12008 In an ACL, when a recipient verification fails, this variable contains
12009 information about the failure. It is set to one of the following words:
12010
12011 .ilist
12012 &"qualify"&: The address was unqualified (no domain), and the message
12013 was neither local nor came from an exempted host.
12014
12015 .next
12016 &"route"&: Routing failed.
12017
12018 .next
12019 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12020 or before the MAIL command (that is, on initial connection, HELO, or
12021 MAIL).
12022
12023 .next
12024 &"recipient"&: The RCPT command in a callout was rejected.
12025 .next
12026
12027 &"postmaster"&: The postmaster check in a callout was rejected.
12028 .endlist
12029
12030 The main use of this variable is expected to be to distinguish between
12031 rejections of MAIL and rejections of RCPT.
12032
12033 .vitem &$recipients$&
12034 .vindex "&$recipients$&"
12035 This variable contains a list of envelope recipients for a message. A comma and
12036 a space separate the addresses in the replacement text. However, the variable
12037 is not generally available, to prevent exposure of Bcc recipients in
12038 unprivileged users' filter files. You can use &$recipients$& only in these
12039 cases:
12040
12041 .olist
12042 In a system filter file.
12043 .next
12044 In the ACLs associated with the DATA command and with non-SMTP messages, that
12045 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12046 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12047 &%acl_not_smtp_mime%&.
12048 .next
12049 From within a &[local_scan()]& function.
12050 .endlist
12051
12052
12053 .vitem &$recipients_count$&
12054 .vindex "&$recipients_count$&"
12055 When a message is being processed, this variable contains the number of
12056 envelope recipients that came with the message. Duplicates are not excluded
12057 from the count. While a message is being received over SMTP, the number
12058 increases for each accepted recipient. It can be referenced in an ACL.
12059
12060
12061 .vitem &$regex_match_string$&
12062 .vindex "&$regex_match_string$&"
12063 This variable is set to contain the matching regular expression after a
12064 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12065
12066
12067 .vitem &$reply_address$&
12068 .vindex "&$reply_address$&"
12069 When a message is being processed, this variable contains the contents of the
12070 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12071 contents of the &'From:'& header line. Apart from the removal of leading
12072 white space, the value is not processed in any way. In particular, no RFC 2047
12073 decoding or character code translation takes place.
12074
12075 .vitem &$return_path$&
12076 .vindex "&$return_path$&"
12077 When a message is being delivered, this variable contains the return path &--
12078 the sender field that will be sent as part of the envelope. It is not enclosed
12079 in <> characters. At the start of routing an address, &$return_path$& has the
12080 same value as &$sender_address$&, but if, for example, an incoming message to a
12081 mailing list has been expanded by a router which specifies a different address
12082 for bounce messages, &$return_path$& subsequently contains the new bounce
12083 address, whereas &$sender_address$& always contains the original sender address
12084 that was received with the message. In other words, &$sender_address$& contains
12085 the incoming envelope sender, and &$return_path$& contains the outgoing
12086 envelope sender.
12087
12088 .vitem &$return_size_limit$&
12089 .vindex "&$return_size_limit$&"
12090 This is an obsolete name for &$bounce_return_size_limit$&.
12091
12092 .vitem &$router_name$&
12093 .cindex "router" "name"
12094 .cindex "name" "of router"
12095 .vindex "&$router_name$&"
12096 During the running of a router this variable contains its name.
12097
12098 .vitem &$runrc$&
12099 .cindex "return code" "from &%run%& expansion"
12100 .vindex "&$runrc$&"
12101 This variable contains the return code from a command that is run by the
12102 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12103 assume the order in which option values are expanded, except for those
12104 preconditions whose order of testing is documented. Therefore, you cannot
12105 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12106 another.
12107
12108 .vitem &$self_hostname$&
12109 .oindex "&%self%&" "value of host name"
12110 .vindex "&$self_hostname$&"
12111 When an address is routed to a supposedly remote host that turns out to be the
12112 local host, what happens is controlled by the &%self%& generic router option.
12113 One of its values causes the address to be passed to another router. When this
12114 happens, &$self_hostname$& is set to the name of the local host that the
12115 original router encountered. In other circumstances its contents are null.
12116
12117 .vitem &$sender_address$&
12118 .vindex "&$sender_address$&"
12119 When a message is being processed, this variable contains the sender's address
12120 that was received in the message's envelope. The case of letters in the address
12121 is retained, in both the local part and the domain. For bounce messages, the
12122 value of this variable is the empty string. See also &$return_path$&.
12123
12124 .vitem &$sender_address_data$&
12125 .vindex "&$address_data$&"
12126 .vindex "&$sender_address_data$&"
12127 If &$address_data$& is set when the routers are called from an ACL to verify a
12128 sender address, the final value is preserved in &$sender_address_data$&, to
12129 distinguish it from data from a recipient address. The value does not persist
12130 after the end of the current ACL statement. If you want to preserve it for
12131 longer, you can save it in an ACL variable.
12132
12133 .vitem &$sender_address_domain$&
12134 .vindex "&$sender_address_domain$&"
12135 The domain portion of &$sender_address$&.
12136
12137 .vitem &$sender_address_local_part$&
12138 .vindex "&$sender_address_local_part$&"
12139 The local part portion of &$sender_address$&.
12140
12141 .vitem &$sender_data$&
12142 .vindex "&$sender_data$&"
12143 This variable is set after a lookup success in an ACL &%senders%& condition or
12144 in a router &%senders%& option. It contains the data from the lookup, and the
12145 value remains set until the next &%senders%& test. Thus, you can do things like
12146 this:
12147 .display
12148 &`require senders      = cdb*@;/some/file`&
12149 &`deny    `&&'some further test involving'& &`$sender_data`&
12150 .endd
12151 &*Warning*&: This variable is set only when a lookup is used as an indexing
12152 method in the address list, using the semicolon syntax as in the example above.
12153 The variable is not set for a lookup that is used as part of the string
12154 expansion that all such lists undergo before being interpreted.
12155
12156 .vitem &$sender_fullhost$&
12157 .vindex "&$sender_fullhost$&"
12158 When a message is received from a remote host, this variable contains the host
12159 name and IP address in a single string. It ends with the IP address in square
12160 brackets, followed by a colon and a port number if the logging of ports is
12161 enabled. The format of the rest of the string depends on whether the host
12162 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12163 looking up its IP address. (Looking up the IP address can be forced by the
12164 &%host_lookup%& option, independent of verification.) A plain host name at the
12165 start of the string is a verified host name; if this is not present,
12166 verification either failed or was not requested. A host name in parentheses is
12167 the argument of a HELO or EHLO command. This is omitted if it is identical to
12168 the verified host name or to the host's IP address in square brackets.
12169
12170 .vitem &$sender_helo_name$&
12171 .vindex "&$sender_helo_name$&"
12172 When a message is received from a remote host that has issued a HELO or EHLO
12173 command, the argument of that command is placed in this variable. It is also
12174 set if HELO or EHLO is used when a message is received using SMTP locally via
12175 the &%-bs%& or &%-bS%& options.
12176
12177 .vitem &$sender_host_address$&
12178 .vindex "&$sender_host_address$&"
12179 When a message is received from a remote host using SMTP,
12180 this variable contains that
12181 host's IP address. For locally non-SMTP submitted messages, it is empty.
12182
12183 .vitem &$sender_host_authenticated$&
12184 .vindex "&$sender_host_authenticated$&"
12185 This variable contains the name (not the public name) of the authenticator
12186 driver that successfully authenticated the client from which the message was
12187 received. It is empty if there was no successful authentication. See also
12188 &$authenticated_id$&.
12189
12190 .vitem &$sender_host_dnssec$&
12191 .vindex "&$sender_host_dnssec$&"
12192 If an attempt to populate &$sender_host_name$& has been made
12193 (by reference, &%hosts_lookup%& or
12194 otherwise) then this boolean will have been set true if, and only if, the
12195 resolver library states that the reverse DNS was authenticated data.  At all
12196 other times, this variable is false.
12197
12198 It is likely that you will need to coerce DNSSEC support on in the resolver
12199 library, by setting:
12200 .code
12201 dns_dnssec_ok = 1
12202 .endd
12203
12204 Exim does not perform DNSSEC validation itself, instead leaving that to a
12205 validating resolver (eg, unbound, or bind with suitable configuration).
12206
12207 Exim does not (currently) check to see if the forward DNS was also secured
12208 with DNSSEC, only the reverse DNS.
12209
12210 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12211 mechanism in the list, then this variable will be false.
12212
12213
12214 .vitem &$sender_host_name$&
12215 .vindex "&$sender_host_name$&"
12216 When a message is received from a remote host, this variable contains the
12217 host's name as obtained by looking up its IP address. For messages received by
12218 other means, this variable is empty.
12219
12220 .vindex "&$host_lookup_failed$&"
12221 If the host name has not previously been looked up, a reference to
12222 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12223 A looked up name is accepted only if it leads back to the original IP address
12224 via a forward lookup. If either the reverse or the forward lookup fails to find
12225 any data, or if the forward lookup does not yield the original IP address,
12226 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12227
12228 .vindex "&$host_lookup_deferred$&"
12229 However, if either of the lookups cannot be completed (for example, there is a
12230 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12231 &$host_lookup_failed$& remains set to &"0"&.
12232
12233 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12234 host name again if there is a subsequent reference to &$sender_host_name$&
12235 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12236 is set to &"1"&.
12237
12238 Exim does not automatically look up every calling host's name. If you want
12239 maximum efficiency, you should arrange your configuration so that it avoids
12240 these lookups altogether. The lookup happens only if one or more of the
12241 following are true:
12242
12243 .ilist
12244 A string containing &$sender_host_name$& is expanded.
12245 .next
12246 The calling host matches the list in &%host_lookup%&. In the default
12247 configuration, this option is set to *, so it must be changed if lookups are
12248 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12249 .next
12250 Exim needs the host name in order to test an item in a host list. The items
12251 that require this are described in sections &<<SECThoslispatnam>>& and
12252 &<<SECThoslispatnamsk>>&.
12253 .next
12254 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12255 In this case, the host name is required to compare with the name quoted in any
12256 EHLO or HELO commands that the client issues.
12257 .next
12258 The remote host issues a EHLO or HELO command that quotes one of the
12259 domains in &%helo_lookup_domains%&. The default value of this option is
12260 . ==== As this is a nested list, any displays it contains must be indented
12261 . ==== as otherwise they are too far to the left.
12262 .code
12263   helo_lookup_domains = @ : @[]
12264 .endd
12265 which causes a lookup if a remote host (incorrectly) gives the server's name or
12266 IP address in an EHLO or HELO command.
12267 .endlist
12268
12269
12270 .vitem &$sender_host_port$&
12271 .vindex "&$sender_host_port$&"
12272 When a message is received from a remote host, this variable contains the port
12273 number that was used on the remote host.
12274
12275 .vitem &$sender_ident$&
12276 .vindex "&$sender_ident$&"
12277 When a message is received from a remote host, this variable contains the
12278 identification received in response to an RFC 1413 request. When a message has
12279 been received locally, this variable contains the login name of the user that
12280 called Exim.
12281
12282 .vitem &$sender_rate_$&&'xxx'&
12283 A number of variables whose names begin &$sender_rate_$& are set as part of the
12284 &%ratelimit%& ACL condition. Details are given in section
12285 &<<SECTratelimiting>>&.
12286
12287 .vitem &$sender_rcvhost$&
12288 .cindex "DNS" "reverse lookup"
12289 .cindex "reverse DNS lookup"
12290 .vindex "&$sender_rcvhost$&"
12291 This is provided specifically for use in &'Received:'& headers. It starts with
12292 either the verified host name (as obtained from a reverse DNS lookup) or, if
12293 there is no verified host name, the IP address in square brackets. After that
12294 there may be text in parentheses. When the first item is a verified host name,
12295 the first thing in the parentheses is the IP address in square brackets,
12296 followed by a colon and a port number if port logging is enabled. When the
12297 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12298 the parentheses.
12299
12300 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12301 was used and its argument was not identical to the real host name or IP
12302 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12303 all three items are present in the parentheses, a newline and tab are inserted
12304 into the string, to improve the formatting of the &'Received:'& header.
12305
12306 .vitem &$sender_verify_failure$&
12307 .vindex "&$sender_verify_failure$&"
12308 In an ACL, when a sender verification fails, this variable contains information
12309 about the failure. The details are the same as for
12310 &$recipient_verify_failure$&.
12311
12312 .vitem &$sending_ip_address$&
12313 .vindex "&$sending_ip_address$&"
12314 This variable is set whenever an outgoing SMTP connection to another host has
12315 been set up. It contains the IP address of the local interface that is being
12316 used. This is useful if a host that has more than one IP address wants to take
12317 on different personalities depending on which one is being used. For incoming
12318 connections, see &$received_ip_address$&.
12319
12320 .vitem &$sending_port$&
12321 .vindex "&$sending_port$&"
12322 This variable is set whenever an outgoing SMTP connection to another host has
12323 been set up. It contains the local port that is being used. For incoming
12324 connections, see &$received_port$&.
12325
12326 .vitem &$smtp_active_hostname$&
12327 .vindex "&$smtp_active_hostname$&"
12328 During an incoming SMTP session, this variable contains the value of the active
12329 host name, as specified by the &%smtp_active_hostname%& option. The value of
12330 &$smtp_active_hostname$& is saved with any message that is received, so its
12331 value can be consulted during routing and delivery.
12332
12333 .vitem &$smtp_command$&
12334 .vindex "&$smtp_command$&"
12335 During the processing of an incoming SMTP command, this variable contains the
12336 entire command. This makes it possible to distinguish between HELO and EHLO in
12337 the HELO ACL, and also to distinguish between commands such as these:
12338 .code
12339 MAIL FROM:<>
12340 MAIL FROM: <>
12341 .endd
12342 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12343 command, the address in &$smtp_command$& is the original address before any
12344 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12345 the address after SMTP-time rewriting.
12346
12347 .vitem &$smtp_command_argument$&
12348 .cindex "SMTP" "command, argument for"
12349 .vindex "&$smtp_command_argument$&"
12350 While an ACL is running to check an SMTP command, this variable contains the
12351 argument, that is, the text that follows the command name, with leading white
12352 space removed. Following the introduction of &$smtp_command$&, this variable is
12353 somewhat redundant, but is retained for backwards compatibility.
12354
12355 .vitem &$smtp_count_at_connection_start$&
12356 .vindex "&$smtp_count_at_connection_start$&"
12357 This variable is set greater than zero only in processes spawned by the Exim
12358 daemon for handling incoming SMTP connections. The name is deliberately long,
12359 in order to emphasize what the contents are. When the daemon accepts a new
12360 connection, it increments this variable. A copy of the variable is passed to
12361 the child process that handles the connection, but its value is fixed, and
12362 never changes. It is only an approximation of how many incoming connections
12363 there actually are, because many other connections may come and go while a
12364 single connection is being processed. When a child process terminates, the
12365 daemon decrements its copy of the variable.
12366
12367 .vitem "&$sn0$& &-- &$sn9$&"
12368 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12369 that were current at the end of the system filter file. This allows a system
12370 filter file to set values that can be tested in users' filter files. For
12371 example, a system filter could set a value indicating how likely it is that a
12372 message is junk mail.
12373
12374 .vitem &$spam_$&&'xxx'&
12375 A number of variables whose names start with &$spam$& are available when Exim
12376 is compiled with the content-scanning extension. For details, see section
12377 &<<SECTscanspamass>>&.
12378
12379
12380 .vitem &$spool_directory$&
12381 .vindex "&$spool_directory$&"
12382 The name of Exim's spool directory.
12383
12384 .vitem &$spool_inodes$&
12385 .vindex "&$spool_inodes$&"
12386 The number of free inodes in the disk partition where Exim's spool files are
12387 being written. The value is recalculated whenever the variable is referenced.
12388 If the relevant file system does not have the concept of inodes, the value of
12389 is -1. See also the &%check_spool_inodes%& option.
12390
12391 .vitem &$spool_space$&
12392 .vindex "&$spool_space$&"
12393 The amount of free space (as a number of kilobytes) in the disk partition where
12394 Exim's spool files are being written. The value is recalculated whenever the
12395 variable is referenced. If the operating system does not have the ability to
12396 find the amount of free space (only true for experimental systems), the space
12397 value is -1. For example, to check in an ACL that there is at least 50
12398 megabytes free on the spool, you could write:
12399 .code
12400 condition = ${if > {$spool_space}{50000}}
12401 .endd
12402 See also the &%check_spool_space%& option.
12403
12404
12405 .vitem &$thisaddress$&
12406 .vindex "&$thisaddress$&"
12407 This variable is set only during the processing of the &%foranyaddress%&
12408 command in a filter file. Its use is explained in the description of that
12409 command, which can be found in the separate document entitled &'Exim's
12410 interfaces to mail filtering'&.
12411
12412 .vitem &$tls_in_bits$&
12413 .vindex "&$tls_in_bits$&"
12414 Contains an approximation of the TLS cipher's bit-strength
12415 on the inbound connection; the meaning of
12416 this depends upon the TLS implementation used.
12417 If TLS has not been negotiated, the value will be 0.
12418 The value of this is automatically fed into the Cyrus SASL authenticator
12419 when acting as a server, to specify the "external SSF" (a SASL term).
12420
12421 The deprecated &$tls_bits$& variable refers to the inbound side
12422 except when used in the context of an outbound SMTP delivery, when it refers to
12423 the outbound.
12424
12425 .vitem &$tls_out_bits$&
12426 .vindex "&$tls_out_bits$&"
12427 Contains an approximation of the TLS cipher's bit-strength
12428 on an outbound SMTP connection; the meaning of
12429 this depends upon the TLS implementation used.
12430 If TLS has not been negotiated, the value will be 0.
12431
12432 .vitem &$tls_in_ourcert$&
12433 .vindex "&$tls_in_ourcert$&"
12434 This variable refers to the certificate presented to the peer of an
12435 inbound connection when the message was received.
12436 It is only useful as the argument of a
12437 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12438 or a &%def%& condition.
12439
12440 .vitem &$tls_in_peercert$&
12441 .vindex "&$tls_in_peercert$&"
12442 This variable refers to the certificate presented by the peer of an
12443 inbound connection when the message was received.
12444 It is only useful as the argument of a
12445 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12446 or a &%def%& condition.
12447
12448 .vitem &$tls_out_ourcert$&
12449 .vindex "&$tls_out_ourcert$&"
12450 This variable refers to the certificate presented to the peer of an
12451 outbound connection.  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_peercert$&
12456 .vindex "&$tls_out_peercert$&"
12457 This variable refers to the certificate presented by 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_in_certificate_verified$&
12463 .vindex "&$tls_in_certificate_verified$&"
12464 This variable is set to &"1"& if a TLS certificate was verified when the
12465 message was received, and &"0"& otherwise.
12466
12467 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12468 except when used in the context of an outbound SMTP delivery, when it refers to
12469 the outbound.
12470
12471 .vitem &$tls_out_certificate_verified$&
12472 .vindex "&$tls_out_certificate_verified$&"
12473 This variable is set to &"1"& if a TLS certificate was verified when an
12474 outbound SMTP connection was made,
12475 and &"0"& otherwise.
12476
12477 .vitem &$tls_in_cipher$&
12478 .vindex "&$tls_in_cipher$&"
12479 .vindex "&$tls_cipher$&"
12480 When a message is received from a remote host over an encrypted SMTP
12481 connection, this variable is set to the cipher suite that was negotiated, for
12482 example DES-CBC3-SHA. In other circumstances, in particular, for message
12483 received over unencrypted connections, the variable is empty. Testing
12484 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12485 non-encrypted connections during ACL processing.
12486
12487 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12488 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12489 becomes the same as &$tls_out_cipher$&.
12490
12491 .vitem &$tls_out_cipher$&
12492 .vindex "&$tls_out_cipher$&"
12493 This variable is
12494 cleared before any outgoing SMTP connection is made,
12495 and then set to the outgoing cipher suite if one is negotiated. See chapter
12496 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12497 details of the &(smtp)& transport.
12498
12499 .vitem &$tls_in_ocsp$&
12500 .vindex "&$tls_in_ocsp$&"
12501 When a message is received from a remote client connection
12502 the result of any OCSP request from the client is encoded in this variable:
12503 .code
12504 0 OCSP proof was not requested (default value)
12505 1 No response to request
12506 2 Response not verified
12507 3 Verification failed
12508 4 Verification succeeded
12509 .endd
12510
12511 .vitem &$tls_out_ocsp$&
12512 .vindex "&$tls_out_ocsp$&"
12513 When a message is sent to a remote host connection
12514 the result of any OCSP request made is encoded in this variable.
12515 See &$tls_in_ocsp$& for values.
12516
12517 .vitem &$tls_in_peerdn$&
12518 .vindex "&$tls_in_peerdn$&"
12519 .vindex "&$tls_peerdn$&"
12520 When a message is received from a remote host over an encrypted SMTP
12521 connection, and Exim is configured to request a certificate from the client,
12522 the value of the Distinguished Name of the certificate is made available in the
12523 &$tls_in_peerdn$& during subsequent processing.
12524
12525 The deprecated &$tls_peerdn$& variable refers to the inbound side
12526 except when used in the context of an outbound SMTP delivery, when it refers to
12527 the outbound.
12528
12529 .vitem &$tls_out_peerdn$&
12530 .vindex "&$tls_out_peerdn$&"
12531 When a message is being delivered to a remote host over an encrypted SMTP
12532 connection, and Exim is configured to request a certificate from the server,
12533 the value of the Distinguished Name of the certificate is made available in the
12534 &$tls_out_peerdn$& during subsequent processing.
12535
12536 .vitem &$tls_in_sni$&
12537 .vindex "&$tls_in_sni$&"
12538 .vindex "&$tls_sni$&"
12539 .cindex "TLS" "Server Name Indication"
12540 When a TLS session is being established, if the client sends the Server
12541 Name Indication extension, the value will be placed in this variable.
12542 If the variable appears in &%tls_certificate%& then this option and
12543 some others, described in &<<SECTtlssni>>&,
12544 will be re-expanded early in the TLS session, to permit
12545 a different certificate to be presented (and optionally a different key to be
12546 used) to the client, based upon the value of the SNI extension.
12547
12548 The deprecated &$tls_sni$& variable refers to the inbound side
12549 except when used in the context of an outbound SMTP delivery, when it refers to
12550 the outbound.
12551
12552 .vitem &$tls_out_sni$&
12553 .vindex "&$tls_out_sni$&"
12554 .cindex "TLS" "Server Name Indication"
12555 During outbound
12556 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12557 the transport.
12558
12559 .vitem &$tod_bsdinbox$&
12560 .vindex "&$tod_bsdinbox$&"
12561 The time of day and the date, in the format required for BSD-style mailbox
12562 files, for example: Thu Oct 17 17:14:09 1995.
12563
12564 .vitem &$tod_epoch$&
12565 .vindex "&$tod_epoch$&"
12566 The time and date as a number of seconds since the start of the Unix epoch.
12567
12568 .vitem &$tod_epoch_l$&
12569 .vindex "&$tod_epoch_l$&"
12570 The time and date as a number of microseconds since the start of the Unix epoch.
12571
12572 .vitem &$tod_full$&
12573 .vindex "&$tod_full$&"
12574 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12575 +0100. The timezone is always given as a numerical offset from UTC, with
12576 positive values used for timezones that are ahead (east) of UTC, and negative
12577 values for those that are behind (west).
12578
12579 .vitem &$tod_log$&
12580 .vindex "&$tod_log$&"
12581 The time and date in the format used for writing Exim's log files, for example:
12582 1995-10-12 15:32:29, but without a timezone.
12583
12584 .vitem &$tod_logfile$&
12585 .vindex "&$tod_logfile$&"
12586 This variable contains the date in the format yyyymmdd. This is the format that
12587 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12588 flag.
12589
12590 .vitem &$tod_zone$&
12591 .vindex "&$tod_zone$&"
12592 This variable contains the numerical value of the local timezone, for example:
12593 -0500.
12594
12595 .vitem &$tod_zulu$&
12596 .vindex "&$tod_zulu$&"
12597 This variable contains the UTC date and time in &"Zulu"& format, as specified
12598 by ISO 8601, for example: 20030221154023Z.
12599
12600 .vitem &$transport_name$&
12601 .cindex "transport" "name"
12602 .cindex "name" "of transport"
12603 .vindex "&$transport_name$&"
12604 During the running of a transport, this variable contains its name.
12605
12606 .vitem &$value$&
12607 .vindex "&$value$&"
12608 This variable contains the result of an expansion lookup, extraction operation,
12609 or external command, as described above. It is also used during a
12610 &*reduce*& expansion.
12611
12612 .vitem &$verify_mode$&
12613 .vindex "&$verify_mode$&"
12614 While a router or transport is being run in verify mode
12615 or for cutthrough delivery,
12616 contains "S" for sender-verification or "R" for recipient-verification.
12617 Otherwise, empty.
12618
12619 .vitem &$version_number$&
12620 .vindex "&$version_number$&"
12621 The version number of Exim.
12622
12623 .vitem &$warn_message_delay$&
12624 .vindex "&$warn_message_delay$&"
12625 This variable is set only during the creation of a message warning about a
12626 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12627
12628 .vitem &$warn_message_recipients$&
12629 .vindex "&$warn_message_recipients$&"
12630 This variable is set only during the creation of a message warning about a
12631 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12632 .endlist
12633 .ecindex IIDstrexp
12634
12635
12636
12637 . ////////////////////////////////////////////////////////////////////////////
12638 . ////////////////////////////////////////////////////////////////////////////
12639
12640 .chapter "Embedded Perl" "CHAPperl"
12641 .scindex IIDperl "Perl" "calling from Exim"
12642 Exim can be built to include an embedded Perl interpreter. When this is done,
12643 Perl subroutines can be called as part of the string expansion process. To make
12644 use of the Perl support, you need version 5.004 or later of Perl installed on
12645 your system. To include the embedded interpreter in the Exim binary, include
12646 the line
12647 .code
12648 EXIM_PERL = perl.o
12649 .endd
12650 in your &_Local/Makefile_& and then build Exim in the normal way.
12651
12652
12653 .section "Setting up so Perl can be used" "SECID85"
12654 .oindex "&%perl_startup%&"
12655 Access to Perl subroutines is via a global configuration option called
12656 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12657 no &%perl_startup%& option in the Exim configuration file then no Perl
12658 interpreter is started and there is almost no overhead for Exim (since none of
12659 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12660 option then the associated value is taken to be Perl code which is executed in
12661 a newly created Perl interpreter.
12662
12663 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12664 need backslashes before any characters to escape special meanings. The option
12665 should usually be something like
12666 .code
12667 perl_startup = do '/etc/exim.pl'
12668 .endd
12669 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12670 use from Exim. Exim can be configured either to start up a Perl interpreter as
12671 soon as it is entered, or to wait until the first time it is needed. Starting
12672 the interpreter at the beginning ensures that it is done while Exim still has
12673 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12674 fact used in a particular run. Also, note that this does not mean that Exim is
12675 necessarily running as root when Perl is called at a later time. By default,
12676 the interpreter is started only when it is needed, but this can be changed in
12677 two ways:
12678
12679 .ilist
12680 .oindex "&%perl_at_start%&"
12681 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12682 a startup when Exim is entered.
12683 .next
12684 The command line option &%-ps%& also requests a startup when Exim is entered,
12685 overriding the setting of &%perl_at_start%&.
12686 .endlist
12687
12688 There is also a command line option &%-pd%& (for delay) which suppresses the
12689 initial startup, even if &%perl_at_start%& is set.
12690
12691
12692 .section "Calling Perl subroutines" "SECID86"
12693 When the configuration file includes a &%perl_startup%& option you can make use
12694 of the string expansion item to call the Perl subroutines that are defined
12695 by the &%perl_startup%& code. The operator is used in any of the following
12696 forms:
12697 .code
12698 ${perl{foo}}
12699 ${perl{foo}{argument}}
12700 ${perl{foo}{argument1}{argument2} ... }
12701 .endd
12702 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12703 arguments may be passed. Passing more than this results in an expansion failure
12704 with an error message of the form
12705 .code
12706 Too many arguments passed to Perl subroutine "foo" (max is 8)
12707 .endd
12708 The return value of the Perl subroutine is evaluated in a scalar context before
12709 it is passed back to Exim to be inserted into the expanded string. If the
12710 return value is &'undef'&, the expansion is forced to fail in the same way as
12711 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12712 by obeying Perl's &%die%& function, the expansion fails with the error message
12713 that was passed to &%die%&.
12714
12715
12716 .section "Calling Exim functions from Perl" "SECID87"
12717 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12718 is available to call back into Exim's string expansion function. For example,
12719 the Perl code
12720 .code
12721 my $lp = Exim::expand_string('$local_part');
12722 .endd
12723 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12724 Note those are single quotes and not double quotes to protect against
12725 &$local_part$& being interpolated as a Perl variable.
12726
12727 If the string expansion is forced to fail by a &"fail"& item, the result of
12728 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12729 expansion string, the Perl call from the original expansion string fails with
12730 an appropriate error message, in the same way as if &%die%& were used.
12731
12732 .cindex "debugging" "from embedded Perl"
12733 .cindex "log" "writing from embedded Perl"
12734 Two other Exim functions are available for use from within Perl code.
12735 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12736 debugging is enabled. If you want a newline at the end, you must supply it.
12737 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12738 timestamp. In this case, you should not supply a terminating newline.
12739
12740
12741 .section "Use of standard output and error by Perl" "SECID88"
12742 .cindex "Perl" "standard output and error"
12743 You should not write to the standard error or output streams from within your
12744 Perl code, as it is not defined how these are set up. In versions of Exim
12745 before 4.50, it is possible for the standard output or error to refer to the
12746 SMTP connection during message reception via the daemon. Writing to this stream
12747 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12748 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12749 avoided, but the output is lost.
12750
12751 .cindex "Perl" "use of &%warn%&"
12752 The Perl &%warn%& statement writes to the standard error stream by default.
12753 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12754 you have no control. When Exim starts up the Perl interpreter, it arranges for
12755 output from the &%warn%& statement to be written to the Exim main log. You can
12756 change this by including appropriate Perl magic somewhere in your Perl code.
12757 For example, to discard &%warn%& output completely, you need this:
12758 .code
12759 $SIG{__WARN__} = sub { };
12760 .endd
12761 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12762 example, the code for the subroutine is empty, so it does nothing, but you can
12763 include any Perl code that you like. The text of the &%warn%& message is passed
12764 as the first subroutine argument.
12765 .ecindex IIDperl
12766
12767
12768 . ////////////////////////////////////////////////////////////////////////////
12769 . ////////////////////////////////////////////////////////////////////////////
12770
12771 .chapter "Starting the daemon and the use of network interfaces" &&&
12772          "CHAPinterfaces" &&&
12773          "Starting the daemon"
12774 .cindex "daemon" "starting"
12775 .cindex "interface" "listening"
12776 .cindex "network interface"
12777 .cindex "interface" "network"
12778 .cindex "IP address" "for listening"
12779 .cindex "daemon" "listening IP addresses"
12780 .cindex "TCP/IP" "setting listening interfaces"
12781 .cindex "TCP/IP" "setting listening ports"
12782 A host that is connected to a TCP/IP network may have one or more physical
12783 hardware network interfaces. Each of these interfaces may be configured as one
12784 or more &"logical"& interfaces, which are the entities that a program actually
12785 works with. Each of these logical interfaces is associated with an IP address.
12786 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12787 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12788 knowledge about the host's interfaces for use in three different circumstances:
12789
12790 .olist
12791 When a listening daemon is started, Exim needs to know which interfaces
12792 and ports to listen on.
12793 .next
12794 When Exim is routing an address, it needs to know which IP addresses
12795 are associated with local interfaces. This is required for the correct
12796 processing of MX lists by removing the local host and others with the
12797 same or higher priority values. Also, Exim needs to detect cases
12798 when an address is routed to an IP address that in fact belongs to the
12799 local host. Unless the &%self%& router option or the &%allow_localhost%&
12800 option of the smtp transport is set (as appropriate), this is treated
12801 as an error situation.
12802 .next
12803 When Exim connects to a remote host, it may need to know which interface to use
12804 for the outgoing connection.
12805 .endlist
12806
12807
12808 Exim's default behaviour is likely to be appropriate in the vast majority
12809 of cases. If your host has only one interface, and you want all its IP
12810 addresses to be treated in the same way, and you are using only the
12811 standard SMTP port, you should not need to take any special action. The
12812 rest of this chapter does not apply to you.
12813
12814 In a more complicated situation you may want to listen only on certain
12815 interfaces, or on different ports, and for this reason there are a number of
12816 options that can be used to influence Exim's behaviour. The rest of this
12817 chapter describes how they operate.
12818
12819 When a message is received over TCP/IP, the interface and port that were
12820 actually used are set in &$received_ip_address$& and &$received_port$&.
12821
12822
12823
12824 .section "Starting a listening daemon" "SECID89"
12825 When a listening daemon is started (by means of the &%-bd%& command line
12826 option), the interfaces and ports on which it listens are controlled by the
12827 following options:
12828
12829 .ilist
12830 &%daemon_smtp_ports%& contains a list of default ports
12831 or service names.
12832 (For backward compatibility, this option can also be specified in the singular.)
12833 .next
12834 &%local_interfaces%& contains list of interface IP addresses on which to
12835 listen. Each item may optionally also specify a port.
12836 .endlist
12837
12838 The default list separator in both cases is a colon, but this can be changed as
12839 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12840 it is usually best to change the separator to avoid having to double all the
12841 colons. For example:
12842 .code
12843 local_interfaces = <; 127.0.0.1 ; \
12844                       192.168.23.65 ; \
12845                       ::1 ; \
12846                       3ffe:ffff:836f::fe86:a061
12847 .endd
12848 There are two different formats for specifying a port along with an IP address
12849 in &%local_interfaces%&:
12850
12851 .olist
12852 The port is added onto the address with a dot separator. For example, to listen
12853 on port 1234 on two different IP addresses:
12854 .code
12855 local_interfaces = <; 192.168.23.65.1234 ; \
12856                       3ffe:ffff:836f::fe86:a061.1234
12857 .endd
12858 .next
12859 The IP address is enclosed in square brackets, and the port is added
12860 with a colon separator, for example:
12861 .code
12862 local_interfaces = <; [192.168.23.65]:1234 ; \
12863                       [3ffe:ffff:836f::fe86:a061]:1234
12864 .endd
12865 .endlist
12866
12867 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12868 default setting contains just one port:
12869 .code
12870 daemon_smtp_ports = smtp
12871 .endd
12872 If more than one port is listed, each interface that does not have its own port
12873 specified listens on all of them. Ports that are listed in
12874 &%daemon_smtp_ports%& can be identified either by name (defined in
12875 &_/etc/services_&) or by number. However, when ports are given with individual
12876 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12877
12878
12879
12880 .section "Special IP listening addresses" "SECID90"
12881 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12882 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12883 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12884 instead of setting up separate listening sockets for each interface. The
12885 default value of &%local_interfaces%& is
12886 .code
12887 local_interfaces = 0.0.0.0
12888 .endd
12889 when Exim is built without IPv6 support; otherwise it is:
12890 .code
12891 local_interfaces = <; ::0 ; 0.0.0.0
12892 .endd
12893 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12894
12895
12896
12897 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12898 The &%-oX%& command line option can be used to override the values of
12899 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12900 instance. Another way of doing this would be to use macros and the &%-D%&
12901 option. However, &%-oX%& can be used by any admin user, whereas modification of
12902 the runtime configuration by &%-D%& is allowed only when the caller is root or
12903 exim.
12904
12905 The value of &%-oX%& is a list of items. The default colon separator can be
12906 changed in the usual way if required. If there are any items that do not
12907 contain dots or colons (that is, are not IP addresses), the value of
12908 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12909 items that do contain dots or colons, the value of &%local_interfaces%& is
12910 replaced by those items. Thus, for example,
12911 .code
12912 -oX 1225
12913 .endd
12914 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12915 whereas
12916 .code
12917 -oX 192.168.34.5.1125
12918 .endd
12919 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12920 (However, since &%local_interfaces%& now contains no items without ports, the
12921 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12922
12923
12924
12925 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12926 .cindex "ssmtp protocol"
12927 .cindex "smtps protocol"
12928 .cindex "SMTP" "ssmtp protocol"
12929 .cindex "SMTP" "smtps protocol"
12930 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12931 before the STARTTLS command was standardized for SMTP. Some legacy clients
12932 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12933 list of port numbers or service names,
12934 connections to those ports must use SSMTP. The most
12935 common use of this option is expected to be
12936 .code
12937 tls_on_connect_ports = 465
12938 .endd
12939 because 465 is the usual port number used by the legacy clients. There is also
12940 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12941 this way when a daemon is started.
12942
12943 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12944 daemon to listen on those ports. You must still specify them in
12945 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12946 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12947 connections via the daemon.)
12948
12949
12950
12951
12952 .section "IPv6 address scopes" "SECID92"
12953 .cindex "IPv6" "address scopes"
12954 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12955 can, in principle, have the same link-local IPv6 address on different
12956 interfaces. Thus, additional information is needed, over and above the IP
12957 address, to distinguish individual interfaces. A convention of using a
12958 percent sign followed by something (often the interface name) has been
12959 adopted in some cases, leading to addresses like this:
12960 .code
12961 fe80::202:b3ff:fe03:45c1%eth0
12962 .endd
12963 To accommodate this usage, a percent sign followed by an arbitrary string is
12964 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12965 to convert a textual IPv6 address for actual use. This function recognizes the
12966 percent convention in operating systems that support it, and it processes the
12967 address appropriately. Unfortunately, some older libraries have problems with
12968 &[getaddrinfo()]&. If
12969 .code
12970 IPV6_USE_INET_PTON=yes
12971 .endd
12972 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12973 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12974 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12975 function.) Of course, this means that the additional functionality of
12976 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12977
12978 .section "Disabling IPv6" "SECID93"
12979 .cindex "IPv6" "disabling"
12980 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12981 run on a host whose kernel does not support IPv6. The binary will fall back to
12982 using IPv4, but it may waste resources looking up AAAA records, and trying to
12983 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12984 .oindex "&%disable_ipv6%&"
12985 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12986 activities take place. AAAA records are never looked up, and any IPv6 addresses
12987 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12988 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12989 to handle IPv6 literal addresses.
12990
12991 On the other hand, when IPv6 is in use, there may be times when you want to
12992 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12993 option to globally suppress the lookup of AAAA records for specified domains,
12994 and you can use the &%ignore_target_hosts%& generic router option to ignore
12995 IPv6 addresses in an individual router.
12996
12997
12998
12999 .section "Examples of starting a listening daemon" "SECID94"
13000 The default case in an IPv6 environment is
13001 .code
13002 daemon_smtp_ports = smtp
13003 local_interfaces = <; ::0 ; 0.0.0.0
13004 .endd
13005 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13006 Either one or two sockets may be used, depending on the characteristics of
13007 the TCP/IP stack. (This is complicated and messy; for more information,
13008 read the comments in the &_daemon.c_& source file.)
13009
13010 To specify listening on ports 25 and 26 on all interfaces:
13011 .code
13012 daemon_smtp_ports = 25 : 26
13013 .endd
13014 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13015 .code
13016 local_interfaces = <; ::0.25     ; ::0.26 \
13017                       0.0.0.0.25 ; 0.0.0.0.26
13018 .endd
13019 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13020 IPv4 loopback address only:
13021 .code
13022 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13023 .endd
13024 To specify listening on the default port on specific interfaces only:
13025 .code
13026 local_interfaces = 10.0.0.67 : 192.168.34.67
13027 .endd
13028 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13029
13030
13031
13032 .section "Recognizing the local host" "SECTreclocipadd"
13033 The &%local_interfaces%& option is also used when Exim needs to determine
13034 whether or not an IP address refers to the local host. That is, the IP
13035 addresses of all the interfaces on which a daemon is listening are always
13036 treated as local.
13037
13038 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13039 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13040 available interfaces from the operating system, and extracts the relevant
13041 (that is, IPv4 or IPv6) addresses to use for checking.
13042
13043 Some systems set up large numbers of virtual interfaces in order to provide
13044 many virtual web servers. In this situation, you may want to listen for
13045 email on only a few of the available interfaces, but nevertheless treat all
13046 interfaces as local when routing. You can do this by setting
13047 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13048 &"all"& wildcard values. These addresses are recognized as local, but are not
13049 used for listening. Consider this example:
13050 .code
13051 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13052                       192.168.53.235 ; \
13053                       3ffe:2101:12:1:a00:20ff:fe86:a061
13054
13055 extra_local_interfaces = <; ::0 ; 0.0.0.0
13056 .endd
13057 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13058 address, but all available interface addresses are treated as local when
13059 Exim is routing.
13060
13061 In some environments the local host name may be in an MX list, but with an IP
13062 address that is not assigned to any local interface. In other cases it may be
13063 desirable to treat other host names as if they referred to the local host. Both
13064 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13065 This contains host names rather than IP addresses. When a host is referenced
13066 during routing, either via an MX record or directly, it is treated as the local
13067 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13068 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13069
13070
13071
13072 .section "Delivering to a remote host" "SECID95"
13073 Delivery to a remote host is handled by the smtp transport. By default, it
13074 allows the system's TCP/IP functions to choose which interface to use (if
13075 there is more than one) when connecting to a remote host. However, the
13076 &%interface%& option can be set to specify which interface is used. See the
13077 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13078 details.
13079
13080
13081
13082
13083 . ////////////////////////////////////////////////////////////////////////////
13084 . ////////////////////////////////////////////////////////////////////////////
13085
13086 .chapter "Main configuration" "CHAPmainconfig"
13087 .scindex IIDconfima "configuration file" "main section"
13088 .scindex IIDmaiconf "main configuration"
13089 The first part of the run time configuration file contains three types of item:
13090
13091 .ilist
13092 Macro definitions: These lines start with an upper case letter. See section
13093 &<<SECTmacrodefs>>& for details of macro processing.
13094 .next
13095 Named list definitions: These lines start with one of the words &"domainlist"&,
13096 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13097 section &<<SECTnamedlists>>&.
13098 .next
13099 Main configuration settings: Each setting occupies one line of the file
13100 (with possible continuations). If any setting is preceded by the word
13101 &"hide"&, the &%-bP%& command line option displays its value to admin users
13102 only. See section &<<SECTcos>>& for a description of the syntax of these option
13103 settings.
13104 .endlist
13105
13106 This chapter specifies all the main configuration options, along with their
13107 types and default values. For ease of finding a particular option, they appear
13108 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13109 are now so many options, they are first listed briefly in functional groups, as
13110 an aid to finding the name of the option you are looking for. Some options are
13111 listed in more than one group.
13112
13113 .section "Miscellaneous" "SECID96"
13114 .table2
13115 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13116 .row &%disable_ipv6%&                "do no IPv6 processing"
13117 .row &%keep_malformed%&              "for broken files &-- should not happen"
13118 .row &%localhost_number%&            "for unique message ids in clusters"
13119 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13120 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13121 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13122 .row &%print_topbitchars%&           "top-bit characters are printing"
13123 .row &%timezone%&                    "force time zone"
13124 .endtable
13125
13126
13127 .section "Exim parameters" "SECID97"
13128 .table2
13129 .row &%exim_group%&                  "override compiled-in value"
13130 .row &%exim_path%&                   "override compiled-in value"
13131 .row &%exim_user%&                   "override compiled-in value"
13132 .row &%primary_hostname%&            "default from &[uname()]&"
13133 .row &%split_spool_directory%&       "use multiple directories"
13134 .row &%spool_directory%&             "override compiled-in value"
13135 .endtable
13136
13137
13138
13139 .section "Privilege controls" "SECID98"
13140 .table2
13141 .row &%admin_groups%&                "groups that are Exim admin users"
13142 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13143 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13144 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13145 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13146 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13147 .row &%never_users%&                 "do not run deliveries as these"
13148 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13149 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13150 .row &%trusted_groups%&              "groups that are trusted"
13151 .row &%trusted_users%&               "users that are trusted"
13152 .endtable
13153
13154
13155
13156 .section "Logging" "SECID99"
13157 .table2
13158 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13159 .row &%log_file_path%&               "override compiled-in value"
13160 .row &%log_selector%&                "set/unset optional logging"
13161 .row &%log_timezone%&                "add timezone to log lines"
13162 .row &%message_logs%&                "create per-message logs"
13163 .row &%preserve_message_logs%&       "after message completion"
13164 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13165 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13166 .row &%syslog_facility%&             "set syslog &""facility""& field"
13167 .row &%syslog_processname%&          "set syslog &""ident""& field"
13168 .row &%syslog_timestamp%&            "timestamp syslog lines"
13169 .row &%write_rejectlog%&             "control use of message log"
13170 .endtable
13171
13172
13173
13174 .section "Frozen messages" "SECID100"
13175 .table2
13176 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13177 .row &%freeze_tell%&                 "send message when freezing"
13178 .row &%move_frozen_messages%&        "to another directory"
13179 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13180 .endtable
13181
13182
13183
13184 .section "Data lookups" "SECID101"
13185 .table2
13186 .row &%ibase_servers%&               "InterBase servers"
13187 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13188 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13189 .row &%ldap_cert_file%&              "client cert file for LDAP"
13190 .row &%ldap_cert_key%&               "client key file for LDAP"
13191 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13192 .row &%ldap_default_servers%&        "used if no server in query"
13193 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13194 .row &%ldap_start_tls%&              "require TLS within LDAP"
13195 .row &%ldap_version%&                "set protocol version"
13196 .row &%lookup_open_max%&             "lookup files held open"
13197 .row &%mysql_servers%&               "default MySQL servers"
13198 .row &%oracle_servers%&              "Oracle servers"
13199 .row &%pgsql_servers%&               "default PostgreSQL servers"
13200 .row &%sqlite_lock_timeout%&         "as it says"
13201 .endtable
13202
13203
13204
13205 .section "Message ids" "SECID102"
13206 .table2
13207 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13208 .row &%message_id_header_text%&      "ditto"
13209 .endtable
13210
13211
13212
13213 .section "Embedded Perl Startup" "SECID103"
13214 .table2
13215 .row &%perl_at_start%&               "always start the interpreter"
13216 .row &%perl_startup%&                "code to obey when starting Perl"
13217 .endtable
13218
13219
13220
13221 .section "Daemon" "SECID104"
13222 .table2
13223 .row &%daemon_smtp_ports%&           "default ports"
13224 .row &%daemon_startup_retries%&      "number of times to retry"
13225 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13226 .row &%extra_local_interfaces%&      "not necessarily listened on"
13227 .row &%local_interfaces%&            "on which to listen, with optional ports"
13228 .row &%pid_file_path%&               "override compiled-in value"
13229 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13230 .endtable
13231
13232
13233
13234 .section "Resource control" "SECID105"
13235 .table2
13236 .row &%check_log_inodes%&            "before accepting a message"
13237 .row &%check_log_space%&             "before accepting a message"
13238 .row &%check_spool_inodes%&          "before accepting a message"
13239 .row &%check_spool_space%&           "before accepting a message"
13240 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13241 .row &%queue_only_load%&             "queue incoming if load high"
13242 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13243 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13244 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13245 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13246 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13247 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13248 .row &%smtp_accept_max_per_connection%& "messages per connection"
13249 .row &%smtp_accept_max_per_host%&    "connections from one host"
13250 .row &%smtp_accept_queue%&           "queue mail if more connections"
13251 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13252                                            connection"
13253 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13254 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13255 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13256 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13257 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13258 .endtable
13259
13260
13261
13262 .section "Policy controls" "SECID106"
13263 .table2
13264 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13265 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13266 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13267 .row &%acl_smtp_auth%&               "ACL for AUTH"
13268 .row &%acl_smtp_connect%&            "ACL for connection"
13269 .row &%acl_smtp_data%&               "ACL for DATA"
13270 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13271 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13272 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13273 .row &%acl_smtp_expn%&               "ACL for EXPN"
13274 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13275 .row &%acl_smtp_mail%&               "ACL for MAIL"
13276 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13277 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13278 .row &%acl_smtp_predata%&            "ACL for start of data"
13279 .row &%acl_smtp_quit%&               "ACL for QUIT"
13280 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13281 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13282 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13283 .row &%av_scanner%&                  "specify virus scanner"
13284 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13285                                       words""&"
13286 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13287 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13288 .row &%header_maxsize%&              "total size of message header"
13289 .row &%header_line_maxsize%&         "individual header line limit"
13290 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13291 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13292 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13293 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13294 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13295 .row &%host_lookup%&                 "host name looked up for these hosts"
13296 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13297 .row &%host_reject_connection%&      "reject connection from these hosts"
13298 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13299 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13300 .row &%message_size_limit%&          "for all messages"
13301 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13302 .row &%spamd_address%&               "set interface to SpamAssassin"
13303 .row &%strict_acl_vars%&             "object to unset ACL variables"
13304 .endtable
13305
13306
13307
13308 .section "Callout cache" "SECID107"
13309 .table2
13310 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13311                                          item"
13312 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13313                                          item"
13314 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13315 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13316 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13317 .endtable
13318
13319
13320
13321 .section "TLS" "SECID108"
13322 .table2
13323 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13324 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13325 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13326 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13327 .row &%tls_certificate%&             "location of server certificate"
13328 .row &%tls_crl%&                     "certificate revocation list"
13329 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13330 .row &%tls_dhparam%&                 "DH parameters for server"
13331 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13332 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13333 .row &%tls_privatekey%&              "location of server private key"
13334 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13335 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13336 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13337 .row &%tls_verify_certificates%&     "expected client certificates"
13338 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13339 .endtable
13340
13341
13342
13343 .section "Local user handling" "SECID109"
13344 .table2
13345 .row &%finduser_retries%&            "useful in NIS environments"
13346 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13347 .row &%gecos_pattern%&               "ditto"
13348 .row &%max_username_length%&         "for systems that truncate"
13349 .row &%unknown_login%&               "used when no login name found"
13350 .row &%unknown_username%&            "ditto"
13351 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13352 .row &%uucp_from_sender%&            "ditto"
13353 .endtable
13354
13355
13356
13357 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13358 .table2
13359 .row &%header_maxsize%&              "total size of message header"
13360 .row &%header_line_maxsize%&         "individual header line limit"
13361 .row &%message_size_limit%&          "applies to all messages"
13362 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13363 .row &%received_header_text%&        "expanded to make &'Received:'&"
13364 .row &%received_headers_max%&        "for mail loop detection"
13365 .row &%recipients_max%&              "limit per message"
13366 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13367 .endtable
13368
13369
13370
13371
13372 .section "Non-SMTP incoming messages" "SECID111"
13373 .table2
13374 .row &%receive_timeout%&             "for non-SMTP messages"
13375 .endtable
13376
13377
13378
13379
13380
13381 .section "Incoming SMTP messages" "SECID112"
13382 See also the &'Policy controls'& section above.
13383
13384 .table2
13385 .row &%host_lookup%&                 "host name looked up for these hosts"
13386 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13387 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13388 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13389 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13390 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13391 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13392 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13393 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13394 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13395 .row &%smtp_accept_max_per_connection%& "messages per connection"
13396 .row &%smtp_accept_max_per_host%&    "connections from one host"
13397 .row &%smtp_accept_queue%&           "queue mail if more connections"
13398 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13399                                            connection"
13400 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13401 .row &%smtp_active_hostname%&        "host name to use in messages"
13402 .row &%smtp_banner%&                 "text for welcome banner"
13403 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13404 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13405 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13406 .row &%smtp_etrn_command%&           "what to run for ETRN"
13407 .row &%smtp_etrn_serialize%&         "only one at once"
13408 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13409 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13410 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13411 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13412 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13413 .row &%smtp_receive_timeout%&        "per command or data line"
13414 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13415 .row &%smtp_return_error_details%&   "give detail on rejections"
13416 .endtable
13417
13418
13419
13420 .section "SMTP extensions" "SECID113"
13421 .table2
13422 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13423 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13424 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13425 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13426 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13427 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13428 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13429 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13430 .endtable
13431
13432
13433
13434 .section "Processing messages" "SECID114"
13435 .table2
13436 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13437 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13438 .row &%allow_utf8_domains%&          "in addresses"
13439 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13440                                       words""&"
13441 .row &%delivery_date_remove%&        "from incoming messages"
13442 .row &%envelope_to_remove%&          "from incoming messages"
13443 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13444 .row &%headers_charset%&             "default for translations"
13445 .row &%qualify_domain%&              "default for senders"
13446 .row &%qualify_recipient%&           "default for recipients"
13447 .row &%return_path_remove%&          "from incoming messages"
13448 .row &%strip_excess_angle_brackets%& "in addresses"
13449 .row &%strip_trailing_dot%&          "at end of addresses"
13450 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13451 .endtable
13452
13453
13454
13455 .section "System filter" "SECID115"
13456 .table2
13457 .row &%system_filter%&               "locate system filter"
13458 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13459                                             directory"
13460 .row &%system_filter_file_transport%& "transport for delivery to a file"
13461 .row &%system_filter_group%&         "group for filter running"
13462 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13463 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13464 .row &%system_filter_user%&          "user for filter running"
13465 .endtable
13466
13467
13468
13469 .section "Routing and delivery" "SECID116"
13470 .table2
13471 .row &%disable_ipv6%&                "do no IPv6 processing"
13472 .row &%dns_again_means_nonexist%&    "for broken domains"
13473 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13474 .row &%dns_dnssec_ok%&               "parameter for resolver"
13475 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13476 .row &%dns_retrans%&                 "parameter for resolver"
13477 .row &%dns_retry%&                   "parameter for resolver"
13478 .row &%dns_use_edns0%&               "parameter for resolver"
13479 .row &%hold_domains%&                "hold delivery for these domains"
13480 .row &%local_interfaces%&            "for routing checks"
13481 .row &%queue_domains%&               "no immediate delivery for these"
13482 .row &%queue_only%&                  "no immediate delivery at all"
13483 .row &%queue_only_file%&             "no immediate delivery if file exists"
13484 .row &%queue_only_load%&             "no immediate delivery if load is high"
13485 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13486 .row &%queue_only_override%&         "allow command line to override"
13487 .row &%queue_run_in_order%&          "order of arrival"
13488 .row &%queue_run_max%&               "of simultaneous queue runners"
13489 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13490 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13491 .row &%remote_sort_domains%&         "order of remote deliveries"
13492 .row &%retry_data_expire%&           "timeout for retry data"
13493 .row &%retry_interval_max%&          "safety net for retry rules"
13494 .endtable
13495
13496
13497
13498 .section "Bounce and warning messages" "SECID117"
13499 .table2
13500 .row &%bounce_message_file%&         "content of bounce"
13501 .row &%bounce_message_text%&         "content of bounce"
13502 .row &%bounce_return_body%&          "include body if returning message"
13503 .row &%bounce_return_message%&       "include original message in bounce"
13504 .row &%bounce_return_size_limit%&    "limit on returned message"
13505 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13506 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13507 .row &%errors_copy%&                 "copy bounce messages"
13508 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13509 .row &%delay_warning%&               "time schedule"
13510 .row &%delay_warning_condition%&     "condition for warning messages"
13511 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13512 .row &%smtp_return_error_details%&   "give detail on rejections"
13513 .row &%warn_message_file%&           "content of warning message"
13514 .endtable
13515
13516
13517
13518 .section "Alphabetical list of main options" "SECTalomo"
13519 Those options that undergo string expansion before use are marked with
13520 &dagger;.
13521
13522 .option accept_8bitmime main boolean true
13523 .cindex "8BITMIME"
13524 .cindex "8-bit characters"
13525 .cindex "log" "selectors"
13526 .cindex "log" "8BITMIME"
13527 This option causes Exim to send 8BITMIME in its response to an SMTP
13528 EHLO command, and to accept the BODY= parameter on MAIL commands.
13529 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13530 takes no steps to do anything special with messages received by this route.
13531
13532 Historically Exim kept this option off by default, but the maintainers
13533 feel that in today's Internet, this causes more problems than it solves.
13534 It now defaults to true.
13535 A more detailed analysis of the issues is provided by Dan Bernstein:
13536 .display
13537 &url(http://cr.yp.to/smtp/8bitmime.html)
13538 .endd
13539
13540 To log received 8BITMIME status use
13541 .code
13542 log_selector = +8bitmime
13543 .endd
13544
13545 .option acl_not_smtp main string&!! unset
13546 .cindex "&ACL;" "for non-SMTP messages"
13547 .cindex "non-SMTP messages" "ACLs for"
13548 This option defines the ACL that is run when a non-SMTP message has been
13549 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13550 further details.
13551
13552 .option acl_not_smtp_mime main string&!! unset
13553 This option defines the ACL that is run for individual MIME parts of non-SMTP
13554 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13555 SMTP messages.
13556
13557 .option acl_not_smtp_start main string&!! unset
13558 .cindex "&ACL;" "at start of non-SMTP message"
13559 .cindex "non-SMTP messages" "ACLs for"
13560 This option defines the ACL that is run before Exim starts reading a
13561 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13562
13563 .option acl_smtp_auth main string&!! unset
13564 .cindex "&ACL;" "setting up for SMTP commands"
13565 .cindex "AUTH" "ACL for"
13566 This option defines the ACL that is run when an SMTP AUTH command is
13567 received. See chapter &<<CHAPACL>>& for further details.
13568
13569 .option acl_smtp_connect main string&!! unset
13570 .cindex "&ACL;" "on SMTP connection"
13571 This option defines the ACL that is run when an SMTP connection is received.
13572 See chapter &<<CHAPACL>>& for further details.
13573
13574 .option acl_smtp_data main string&!! unset
13575 .cindex "DATA" "ACL for"
13576 This option defines the ACL that is run after an SMTP DATA command has been
13577 processed and the message itself has been received, but before the final
13578 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13579
13580 .new
13581 .option acl_smtp_data_prdr main string&!! accept
13582 .cindex "PRDR" "ACL for"
13583 .cindex "DATA" "PRDR ACL for"
13584 .cindex "&ACL;" "PRDR-related"
13585 .cindex "&ACL;" "per-user data processing"
13586 .wen
13587 This option defines the ACL that,
13588 if the PRDR feature has been negotiated,
13589 is run for each recipient after an SMTP DATA command has been
13590 processed and the message itself has been received, but before the
13591 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13592
13593 .option acl_smtp_etrn main string&!! unset
13594 .cindex "ETRN" "ACL for"
13595 This option defines the ACL that is run when an SMTP ETRN command is
13596 received. See chapter &<<CHAPACL>>& for further details.
13597
13598 .option acl_smtp_expn main string&!! unset
13599 .cindex "EXPN" "ACL for"
13600 This option defines the ACL that is run when an SMTP EXPN command is
13601 received. See chapter &<<CHAPACL>>& for further details.
13602
13603 .option acl_smtp_helo main string&!! unset
13604 .cindex "EHLO" "ACL for"
13605 .cindex "HELO" "ACL for"
13606 This option defines the ACL that is run when an SMTP EHLO or HELO
13607 command is received. See chapter &<<CHAPACL>>& for further details.
13608
13609
13610 .option acl_smtp_mail main string&!! unset
13611 .cindex "MAIL" "ACL for"
13612 This option defines the ACL that is run when an SMTP MAIL command is
13613 received. See chapter &<<CHAPACL>>& for further details.
13614
13615 .option acl_smtp_mailauth main string&!! unset
13616 .cindex "AUTH" "on MAIL command"
13617 This option defines the ACL that is run when there is an AUTH parameter on
13618 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13619 &<<CHAPSMTPAUTH>>& for details of authentication.
13620
13621 .option acl_smtp_mime main string&!! unset
13622 .cindex "MIME content scanning" "ACL for"
13623 This option is available when Exim is built with the content-scanning
13624 extension. It defines the ACL that is run for each MIME part in a message. See
13625 section &<<SECTscanmimepart>>& for details.
13626
13627 .option acl_smtp_predata main string&!! unset
13628 This option defines the ACL that is run when an SMTP DATA command is
13629 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13630 further details.
13631
13632 .option acl_smtp_quit main string&!! unset
13633 .cindex "QUIT, ACL for"
13634 This option defines the ACL that is run when an SMTP QUIT command is
13635 received. See chapter &<<CHAPACL>>& for further details.
13636
13637 .option acl_smtp_rcpt main string&!! unset
13638 .cindex "RCPT" "ACL for"
13639 This option defines the ACL that is run when an SMTP RCPT command is
13640 received. See chapter &<<CHAPACL>>& for further details.
13641
13642 .option acl_smtp_starttls main string&!! unset
13643 .cindex "STARTTLS, ACL for"
13644 This option defines the ACL that is run when an SMTP STARTTLS command is
13645 received. See chapter &<<CHAPACL>>& for further details.
13646
13647 .option acl_smtp_vrfy main string&!! unset
13648 .cindex "VRFY" "ACL for"
13649 This option defines the ACL that is run when an SMTP VRFY command is
13650 received. See chapter &<<CHAPACL>>& for further details.
13651
13652 .option admin_groups main "string list&!!" unset
13653 .cindex "admin user"
13654 This option is expanded just once, at the start of Exim's processing. If the
13655 current group or any of the supplementary groups of an Exim caller is in this
13656 colon-separated list, the caller has admin privileges. If all your system
13657 programmers are in a specific group, for example, you can give them all Exim
13658 admin privileges by putting that group in &%admin_groups%&. However, this does
13659 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13660 To permit this, you have to add individuals to the Exim group.
13661
13662 .option allow_domain_literals main boolean false
13663 .cindex "domain literal"
13664 If this option is set, the RFC 2822 domain literal format is permitted in
13665 email addresses. The option is not set by default, because the domain literal
13666 format is not normally required these days, and few people know about it. It
13667 has, however, been exploited by mail abusers.
13668
13669 Unfortunately, it seems that some DNS black list maintainers are using this
13670 format to report black listing to postmasters. If you want to accept messages
13671 addressed to your hosts by IP address, you need to set
13672 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13673 domains (defined in the named domain list &%local_domains%& in the default
13674 configuration). This &"magic string"& matches the domain literal form of all
13675 the local host's IP addresses.
13676
13677
13678 .option allow_mx_to_ip main boolean false
13679 .cindex "MX record" "pointing to IP address"
13680 It appears that more and more DNS zone administrators are breaking the rules
13681 and putting domain names that look like IP addresses on the right hand side of
13682 MX records. Exim follows the rules and rejects this, giving an error message
13683 that explains the mis-configuration. However, some other MTAs support this
13684 practice, so to avoid &"Why can't Exim do this?"& complaints,
13685 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13686 recommended, except when you have no other choice.
13687
13688 .option allow_utf8_domains main boolean false
13689 .cindex "domain" "UTF-8 characters in"
13690 .cindex "UTF-8" "in domain name"
13691 Lots of discussion is going on about internationalized domain names. One
13692 camp is strongly in favour of just using UTF-8 characters, and it seems
13693 that at least two other MTAs permit this. This option allows Exim users to
13694 experiment if they wish.
13695
13696 If it is set true, Exim's domain parsing function allows valid
13697 UTF-8 multicharacters to appear in domain name components, in addition to
13698 letters, digits, and hyphens. However, just setting this option is not
13699 enough; if you want to look up these domain names in the DNS, you must also
13700 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13701 suitable setting is:
13702 .code
13703 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13704   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13705 .endd
13706 Alternatively, you can just disable this feature by setting
13707 .code
13708 dns_check_names_pattern =
13709 .endd
13710 That is, set the option to an empty string so that no check is done.
13711
13712
13713 .option auth_advertise_hosts main "host list&!!" *
13714 .cindex "authentication" "advertising"
13715 .cindex "AUTH" "advertising"
13716 If any server authentication mechanisms are configured, Exim advertises them in
13717 response to an EHLO command only if the calling host matches this list.
13718 Otherwise, Exim does not advertise AUTH.
13719 Exim does not accept AUTH commands from clients to which it has not
13720 advertised the availability of AUTH. The advertising of individual
13721 authentication mechanisms can be controlled by the use of the
13722 &%server_advertise_condition%& generic authenticator option on the individual
13723 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13724
13725 Certain mail clients (for example, Netscape) require the user to provide a name
13726 and password for authentication if AUTH is advertised, even though it may
13727 not be needed (the host may accept messages from hosts on its local LAN without
13728 authentication, for example). The &%auth_advertise_hosts%& option can be used
13729 to make these clients more friendly by excluding them from the set of hosts to
13730 which Exim advertises AUTH.
13731
13732 .cindex "AUTH" "advertising when encrypted"
13733 If you want to advertise the availability of AUTH only when the connection
13734 is encrypted using TLS, you can make use of the fact that the value of this
13735 option is expanded, with a setting like this:
13736 .code
13737 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13738 .endd
13739 .vindex "&$tls_in_cipher$&"
13740 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13741 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13742 expansion is *, which matches all hosts.
13743
13744
13745 .option auto_thaw main time 0s
13746 .cindex "thawing messages"
13747 .cindex "unfreezing messages"
13748 If this option is set to a time greater than zero, a queue runner will try a
13749 new delivery attempt on any frozen message, other than a bounce message, if
13750 this much time has passed since it was frozen. This may result in the message
13751 being re-frozen if nothing has changed since the last attempt. It is a way of
13752 saying &"keep on trying, even though there are big problems"&.
13753
13754 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13755 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13756 thought to be very useful any more, and its use should probably be avoided.
13757
13758
13759 .option av_scanner main string "see below"
13760 This option is available if Exim is built with the content-scanning extension.
13761 It specifies which anti-virus scanner to use. The default value is:
13762 .code
13763 sophie:/var/run/sophie
13764 .endd
13765 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13766 before use. See section &<<SECTscanvirus>>& for further details.
13767
13768
13769 .option bi_command main string unset
13770 .oindex "&%-bi%&"
13771 This option supplies the name of a command that is run when Exim is called with
13772 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13773 just the command name, it is not a complete command line. If an argument is
13774 required, it must come from the &%-oA%& command line option.
13775
13776
13777 .option bounce_message_file main string unset
13778 .cindex "bounce message" "customizing"
13779 .cindex "customizing" "bounce message"
13780 This option defines a template file containing paragraphs of text to be used
13781 for constructing bounce messages.  Details of the file's contents are given in
13782 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13783
13784
13785 .option bounce_message_text main string unset
13786 When this option is set, its contents are included in the default bounce
13787 message immediately after &"This message was created automatically by mail
13788 delivery software."& It is not used if &%bounce_message_file%& is set.
13789
13790 .option bounce_return_body main boolean true
13791 .cindex "bounce message" "including body"
13792 This option controls whether the body of an incoming message is included in a
13793 bounce message when &%bounce_return_message%& is true. The default setting
13794 causes the entire message, both header and body, to be returned (subject to the
13795 value of &%bounce_return_size_limit%&). If this option is false, only the
13796 message header is included. In the case of a non-SMTP message containing an
13797 error that is detected during reception, only those header lines preceding the
13798 point at which the error was detected are returned.
13799 .cindex "bounce message" "including original"
13800
13801 .option bounce_return_message main boolean true
13802 If this option is set false, none of the original message is included in
13803 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13804 &%bounce_return_body%&.
13805
13806
13807 .option bounce_return_size_limit main integer 100K
13808 .cindex "size" "of bounce, limit"
13809 .cindex "bounce message" "size limit"
13810 .cindex "limit" "bounce message size"
13811 This option sets a limit in bytes on the size of messages that are returned to
13812 senders as part of bounce messages when &%bounce_return_message%& is true. The
13813 limit should be less than the value of the global &%message_size_limit%& and of
13814 any &%message_size_limit%& settings on transports, to allow for the bounce text
13815 that Exim generates. If this option is set to zero there is no limit.
13816
13817 When the body of any message that is to be included in a bounce message is
13818 greater than the limit, it is truncated, and a comment pointing this out is
13819 added at the top. The actual cutoff may be greater than the value given, owing
13820 to the use of buffering for transferring the message in chunks (typically 8K in
13821 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13822 messages.
13823
13824 .option bounce_sender_authentication main string unset
13825 .cindex "bounce message" "sender authentication"
13826 .cindex "authentication" "bounce message"
13827 .cindex "AUTH" "on bounce message"
13828 This option provides an authenticated sender address that is sent with any
13829 bounce messages generated by Exim that are sent over an authenticated SMTP
13830 connection. A typical setting might be:
13831 .code
13832 bounce_sender_authentication = mailer-daemon@my.domain.example
13833 .endd
13834 which would cause bounce messages to be sent using the SMTP command:
13835 .code
13836 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13837 .endd
13838 The value of &%bounce_sender_authentication%& must always be a complete email
13839 address.
13840
13841 .option callout_domain_negative_expire main time 3h
13842 .cindex "caching" "callout timeouts"
13843 .cindex "callout" "caching timeouts"
13844 This option specifies the expiry time for negative callout cache data for a
13845 domain. See section &<<SECTcallver>>& for details of callout verification, and
13846 section &<<SECTcallvercache>>& for details of the caching.
13847
13848
13849 .option callout_domain_positive_expire main time 7d
13850 This option specifies the expiry time for positive callout cache data for a
13851 domain. See section &<<SECTcallver>>& for details of callout verification, and
13852 section &<<SECTcallvercache>>& for details of the caching.
13853
13854
13855 .option callout_negative_expire main time 2h
13856 This option specifies the expiry time for negative callout cache data for an
13857 address. See section &<<SECTcallver>>& for details of callout verification, and
13858 section &<<SECTcallvercache>>& for details of the caching.
13859
13860
13861 .option callout_positive_expire main time 24h
13862 This option specifies the expiry time for positive callout cache data for an
13863 address. See section &<<SECTcallver>>& for details of callout verification, and
13864 section &<<SECTcallvercache>>& for details of the caching.
13865
13866
13867 .option callout_random_local_part main string&!! "see below"
13868 This option defines the &"random"& local part that can be used as part of
13869 callout verification. The default value is
13870 .code
13871 $primary_hostname-$tod_epoch-testing
13872 .endd
13873 See section &<<CALLaddparcall>>& for details of how this value is used.
13874
13875
13876 .option check_log_inodes main integer 0
13877 See &%check_spool_space%& below.
13878
13879
13880 .option check_log_space main integer 0
13881 See &%check_spool_space%& below.
13882
13883 .oindex "&%check_rfc2047_length%&"
13884 .cindex "RFC 2047" "disabling length check"
13885 .option check_rfc2047_length main boolean true
13886 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13887 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13888 word; strings to be encoded that exceed this length are supposed to use
13889 multiple encoded words. By default, Exim does not recognize encoded words that
13890 exceed the maximum length. However, it seems that some software, in violation
13891 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13892 set false, Exim recognizes encoded words of any length.
13893
13894
13895 .option check_spool_inodes main integer 0
13896 See &%check_spool_space%& below.
13897
13898
13899 .option check_spool_space main integer 0
13900 .cindex "checking disk space"
13901 .cindex "disk space, checking"
13902 .cindex "spool directory" "checking space"
13903 The four &%check_...%& options allow for checking of disk resources before a
13904 message is accepted.
13905
13906 .vindex "&$log_inodes$&"
13907 .vindex "&$log_space$&"
13908 .vindex "&$spool_inodes$&"
13909 .vindex "&$spool_space$&"
13910 When any of these options are set, they apply to all incoming messages. If you
13911 want to apply different checks to different kinds of message, you can do so by
13912 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13913 &$spool_space$& in an ACL with appropriate additional conditions.
13914
13915
13916 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13917 either value is greater than zero, for example:
13918 .code
13919 check_spool_space = 10M
13920 check_spool_inodes = 100
13921 .endd
13922 The spool partition is the one that contains the directory defined by
13923 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13924 transit.
13925
13926 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13927 files are written if either is greater than zero. These should be set only if
13928 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13929
13930 If there is less space or fewer inodes than requested, Exim refuses to accept
13931 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13932 error response to the MAIL command. If ESMTP is in use and there was a
13933 SIZE parameter on the MAIL command, its value is added to the
13934 &%check_spool_space%& value, and the check is performed even if
13935 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13936
13937 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13938 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13939
13940 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13941 failure a message is written to stderr and Exim exits with a non-zero code, as
13942 it obviously cannot send an error message of any kind.
13943
13944 .option daemon_smtp_ports main string &`smtp`&
13945 .cindex "port" "for daemon"
13946 .cindex "TCP/IP" "setting listening ports"
13947 This option specifies one or more default SMTP ports on which the Exim daemon
13948 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13949 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13950
13951 .option daemon_startup_retries main integer 9
13952 .cindex "daemon startup, retrying"
13953 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13954 the daemon at startup when it cannot immediately bind a listening socket
13955 (typically because the socket is already in use): &%daemon_startup_retries%&
13956 defines the number of retries after the first failure, and
13957 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13958
13959 .option daemon_startup_sleep main time 30s
13960 See &%daemon_startup_retries%&.
13961
13962 .option delay_warning main "time list" 24h
13963 .cindex "warning of delay"
13964 .cindex "delay warning, specifying"
13965 When a message is delayed, Exim sends a warning message to the sender at
13966 intervals specified by this option. The data is a colon-separated list of times
13967 after which to send warning messages. If the value of the option is an empty
13968 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13969 message has been on the queue for longer than the last time, the last interval
13970 between the times is used to compute subsequent warning times. For example,
13971 with
13972 .code
13973 delay_warning = 4h:8h:24h
13974 .endd
13975 the first message is sent after 4 hours, the second after 8 hours, and
13976 the third one after 24 hours. After that, messages are sent every 16 hours,
13977 because that is the interval between the last two times on the list. If you set
13978 just one time, it specifies the repeat interval. For example, with:
13979 .code
13980 delay_warning = 6h
13981 .endd
13982 messages are repeated every six hours. To stop warnings after a given time, set
13983 a very large time at the end of the list. For example:
13984 .code
13985 delay_warning = 2h:12h:99d
13986 .endd
13987 Note that the option is only evaluated at the time a delivery attempt fails,
13988 which depends on retry and queue-runner configuration.
13989 Typically retries will be configured more frequently than warning messages.
13990
13991 .option delay_warning_condition main string&!! "see below"
13992 .vindex "&$domain$&"
13993 The string is expanded at the time a warning message might be sent. If all the
13994 deferred addresses have the same domain, it is set in &$domain$& during the
13995 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13996 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13997 &"false"& (the comparison being done caselessly) then the warning message is
13998 not sent. The default is:
13999 .code
14000 delay_warning_condition = ${if or {\
14001   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14002   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14003   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14004   } {no}{yes}}
14005 .endd
14006 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14007 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14008 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14009 &"auto-replied"& in an &'Auto-Submitted:'& header.
14010
14011 .option deliver_drop_privilege main boolean false
14012 .cindex "unprivileged delivery"
14013 .cindex "delivery" "unprivileged"
14014 If this option is set true, Exim drops its root privilege at the start of a
14015 delivery process, and runs as the Exim user throughout. This severely restricts
14016 the kinds of local delivery that are possible, but is viable in certain types
14017 of configuration. There is a discussion about the use of root privilege in
14018 chapter &<<CHAPsecurity>>&.
14019
14020 .option deliver_queue_load_max main fixed-point unset
14021 .cindex "load average"
14022 .cindex "queue runner" "abandoning"
14023 When this option is set, a queue run is abandoned if the system load average
14024 becomes greater than the value of the option. The option has no effect on
14025 ancient operating systems on which Exim cannot determine the load average.
14026 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14027
14028
14029 .option delivery_date_remove main boolean true
14030 .cindex "&'Delivery-date:'& header line"
14031 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14032 message when it is delivered, in exactly the same way as &'Return-path:'& is
14033 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14034 should not be present in incoming messages, and this option causes them to be
14035 removed at the time the message is received, to avoid any problems that might
14036 occur when a delivered message is subsequently sent on to some other recipient.
14037
14038 .option disable_fsync main boolean false
14039 .cindex "&[fsync()]&, disabling"
14040 This option is available only if Exim was built with the compile-time option
14041 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14042 a runtime configuration generates an &"unknown option"& error. You should not
14043 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14044 really, really, really understand what you are doing. &'No pre-compiled
14045 distributions of Exim should ever make this option available.'&
14046
14047 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14048 updated files' data to be written to disc before continuing. Unexpected events
14049 such as crashes and power outages may cause data to be lost or scrambled.
14050 Here be Dragons. &*Beware.*&
14051
14052
14053 .option disable_ipv6 main boolean false
14054 .cindex "IPv6" "disabling"
14055 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14056 activities take place. AAAA records are never looked up, and any IPv6 addresses
14057 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14058 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14059 to handle IPv6 literal addresses.
14060
14061
14062 .option dns_again_means_nonexist main "domain list&!!" unset
14063 .cindex "DNS" "&""try again""& response; overriding"
14064 DNS lookups give a &"try again"& response for the DNS errors
14065 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14066 keep trying to deliver a message, or to give repeated temporary errors to
14067 incoming mail. Sometimes the effect is caused by a badly set up name server and
14068 may persist for a long time. If a domain which exhibits this problem matches
14069 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14070 This option should be used with care. You can make it apply to reverse lookups
14071 by a setting such as this:
14072 .code
14073 dns_again_means_nonexist = *.in-addr.arpa
14074 .endd
14075 This option applies to all DNS lookups that Exim does. It also applies when the
14076 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14077 since these are most likely to be caused by DNS lookup problems. The
14078 &(dnslookup)& router has some options of its own for controlling what happens
14079 when lookups for MX or SRV records give temporary errors. These more specific
14080 options are applied after this global option.
14081
14082 .option dns_check_names_pattern main string "see below"
14083 .cindex "DNS" "pre-check of name syntax"
14084 When this option is set to a non-empty string, it causes Exim to check domain
14085 names for characters that are not allowed in host names before handing them to
14086 the DNS resolver, because some resolvers give temporary errors for names that
14087 contain unusual characters. If a domain name contains any unwanted characters,
14088 a &"not found"& result is forced, and the resolver is not called. The check is
14089 done by matching the domain name against a regular expression, which is the
14090 value of this option. The default pattern is
14091 .code
14092 dns_check_names_pattern = \
14093   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14094 .endd
14095 which permits only letters, digits, slashes, and hyphens in components, but
14096 they must start and end with a letter or digit. Slashes are not, in fact,
14097 permitted in host names, but they are found in certain NS records (which can be
14098 accessed in Exim by using a &%dnsdb%& lookup). If you set
14099 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14100 empty string.
14101
14102 .option dns_csa_search_limit main integer 5
14103 This option controls the depth of parental searching for CSA SRV records in the
14104 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14105
14106 .option dns_csa_use_reverse main boolean true
14107 This option controls whether or not an IP address, given as a CSA domain, is
14108 reversed and looked up in the reverse DNS, as described in more detail in
14109 section &<<SECTverifyCSA>>&.
14110
14111
14112 .option dns_dnssec_ok main integer -1
14113 .cindex "DNS" "resolver options"
14114 .cindex "DNS" "DNSSEC"
14115 If this option is set to a non-negative number then Exim will initialise the
14116 DNS resolver library to either use or not use DNSSEC, overriding the system
14117 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14118
14119 If the resolver library does not support DNSSEC then this option has no effect.
14120
14121
14122 .option dns_ipv4_lookup main "domain list&!!" unset
14123 .cindex "IPv6" "DNS lookup for AAAA records"
14124 .cindex "DNS" "IPv6 lookup for AAAA records"
14125 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14126 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14127 (A records) when trying to find IP addresses for hosts, unless the host's
14128 domain matches this list.
14129
14130 This is a fudge to help with name servers that give big delays or otherwise do
14131 not work for the AAAA record type. In due course, when the world's name
14132 servers have all been upgraded, there should be no need for this option.
14133
14134
14135 .option dns_retrans main time 0s
14136 .cindex "DNS" "resolver options"
14137 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14138 retransmission and retry parameters for DNS lookups. Values of zero (the
14139 defaults) leave the system default settings unchanged. The first value is the
14140 time between retries, and the second is the number of retries. It isn't
14141 totally clear exactly how these settings affect the total time a DNS lookup may
14142 take. I haven't found any documentation about timeouts on DNS lookups; these
14143 parameter values are available in the external resolver interface structure,
14144 but nowhere does it seem to describe how they are used or what you might want
14145 to set in them.
14146
14147
14148 .option dns_retry main integer 0
14149 See &%dns_retrans%& above.
14150
14151
14152 .option dns_use_edns0 main integer -1
14153 .cindex "DNS" "resolver options"
14154 .cindex "DNS" "EDNS0"
14155 If this option is set to a non-negative number then Exim will initialise the
14156 DNS resolver library to either use or not use EDNS0 extensions, overriding
14157 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14158 on.
14159
14160 If the resolver library does not support EDNS0 then this option has no effect.
14161
14162
14163 .option drop_cr main boolean false
14164 This is an obsolete option that is now a no-op. It used to affect the way Exim
14165 handled CR and LF characters in incoming messages. What happens now is
14166 described in section &<<SECTlineendings>>&.
14167
14168 .new
14169 .option dsn_advertise_hosts main "host list&!!" unset
14170 .cindex "bounce messages" "success"
14171 .cindex "DSN" "success"
14172 .cindex "Delivery Status Notification" "success"
14173 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14174 and accepted from, these hosts.
14175 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14176 and RET and ORCPT options on MAIL FROM commands.
14177 A NOTIFY=SUCCESS option requests success-DSN messages.
14178 A NOTIFY= option with no argument requests that no delay or failure DSNs
14179 are sent.
14180 .wen
14181
14182 .option dsn_from main "string&!!" "see below"
14183 .cindex "&'From:'& header line" "in bounces"
14184 .cindex "bounce messages" "&'From:'& line, specifying"
14185 This option can be used to vary the contents of &'From:'& header lines in
14186 bounces and other automatically generated messages (&"Delivery Status
14187 Notifications"& &-- hence the name of the option). The default setting is:
14188 .code
14189 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14190 .endd
14191 The value is expanded every time it is needed. If the expansion fails, a
14192 panic is logged, and the default value is used.
14193
14194 .option envelope_to_remove main boolean true
14195 .cindex "&'Envelope-to:'& header line"
14196 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14197 message when it is delivered, in exactly the same way as &'Return-path:'& is
14198 handled. &'Envelope-to:'& records the original recipient address from the
14199 messages's envelope that caused the delivery to happen. Such headers should not
14200 be present in incoming messages, and this option causes them to be removed at
14201 the time the message is received, to avoid any problems that might occur when a
14202 delivered message is subsequently sent on to some other recipient.
14203
14204
14205 .option errors_copy main "string list&!!" unset
14206 .cindex "bounce message" "copy to other address"
14207 .cindex "copy of bounce message"
14208 Setting this option causes Exim to send bcc copies of bounce messages that it
14209 generates to other addresses. &*Note*&: This does not apply to bounce messages
14210 coming from elsewhere. The value of the option is a colon-separated list of
14211 items. Each item consists of a pattern, terminated by white space, followed by
14212 a comma-separated list of email addresses. If a pattern contains spaces, it
14213 must be enclosed in double quotes.
14214
14215 Each pattern is processed in the same way as a single item in an address list
14216 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14217 the bounce message, the message is copied to the addresses on the list. The
14218 items are scanned in order, and once a matching one is found, no further items
14219 are examined. For example:
14220 .code
14221 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14222               rqps@mydomain   hostmaster@mydomain.example,\
14223                               postmaster@mydomain.example
14224 .endd
14225 .vindex "&$domain$&"
14226 .vindex "&$local_part$&"
14227 The address list is expanded before use. The expansion variables &$local_part$&
14228 and &$domain$& are set from the original recipient of the error message, and if
14229 there was any wildcard matching in the pattern, the expansion
14230 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14231 variables &$0$&, &$1$&, etc. are set in the normal way.
14232
14233
14234 .option errors_reply_to main string unset
14235 .cindex "bounce message" "&'Reply-to:'& in"
14236 By default, Exim's bounce and delivery warning messages contain the header line
14237 .display
14238 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14239 .endd
14240 .oindex &%quota_warn_message%&
14241 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14242 A warning message that is generated by the &%quota_warn_message%& option in an
14243 &(appendfile)& transport may contain its own &'From:'& header line that
14244 overrides the default.
14245
14246 Experience shows that people reply to bounce messages. If the
14247 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14248 and warning messages. For example:
14249 .code
14250 errors_reply_to = postmaster@my.domain.example
14251 .endd
14252 The value of the option is not expanded. It must specify a valid RFC 2822
14253 address. However, if a warning message that is generated by the
14254 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14255 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14256 not used.
14257
14258
14259 .option exim_group main string "compile-time configured"
14260 .cindex "gid (group id)" "Exim's own"
14261 .cindex "Exim group"
14262 This option changes the gid under which Exim runs when it gives up root
14263 privilege. The default value is compiled into the binary. The value of this
14264 option is used only when &%exim_user%& is also set. Unless it consists entirely
14265 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14266 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14267 security issues.
14268
14269
14270 .option exim_path main string "see below"
14271 .cindex "Exim binary, path name"
14272 This option specifies the path name of the Exim binary, which is used when Exim
14273 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14274 the directory configured at compile time by the BIN_DIRECTORY setting. It
14275 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14276 other place.
14277 &*Warning*&: Do not use a macro to define the value of this option, because
14278 you will break those Exim utilities that scan the configuration file to find
14279 where the binary is. (They then use the &%-bP%& option to extract option
14280 settings such as the value of &%spool_directory%&.)
14281
14282
14283 .option exim_user main string "compile-time configured"
14284 .cindex "uid (user id)" "Exim's own"
14285 .cindex "Exim user"
14286 This option changes the uid under which Exim runs when it gives up root
14287 privilege. The default value is compiled into the binary. Ownership of the run
14288 time configuration file and the use of the &%-C%& and &%-D%& command line
14289 options is checked against the values in the binary, not what is set here.
14290
14291 Unless it consists entirely of digits, the string is looked up using
14292 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14293 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14294 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14295
14296
14297 .option extra_local_interfaces main "string list" unset
14298 This option defines network interfaces that are to be considered local when
14299 routing, but which are not used for listening by the daemon. See section
14300 &<<SECTreclocipadd>>& for details.
14301
14302
14303 . Allow this long option name to split; give it unsplit as a fifth argument
14304 . for the automatic .oindex that is generated by .option.
14305
14306 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14307          extract_addresses_remove_arguments
14308 .oindex "&%-t%&"
14309 .cindex "command line" "addresses with &%-t%&"
14310 .cindex "Sendmail compatibility" "&%-t%& option"
14311 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14312 are present on the command line when the &%-t%& option is used to build an
14313 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14314 line addresses are removed from the recipients list. This is also how Smail
14315 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14316 command line addresses are added to those obtained from the header lines. When
14317 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14318 argument headers. If it is set false, Exim adds rather than removes argument
14319 addresses.
14320
14321
14322 .option finduser_retries main integer 0
14323 .cindex "NIS, retrying user lookups"
14324 On systems running NIS or other schemes in which user and group information is
14325 distributed from a remote system, there can be times when &[getpwnam()]& and
14326 related functions fail, even when given valid data, because things time out.
14327 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14328 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14329 many extra times to find a user or a group, waiting for one second between
14330 retries.
14331
14332 .cindex "&_/etc/passwd_&" "multiple reading of"
14333 You should not set this option greater than zero if your user information is in
14334 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14335 search the file multiple times for non-existent users, and also cause delay.
14336
14337
14338
14339 .option freeze_tell main "string list, comma separated" unset
14340 .cindex "freezing messages" "sending a message when freezing"
14341 On encountering certain errors, or when configured to do so in a system filter,
14342 ACL, or special router, Exim freezes a message. This means that no further
14343 delivery attempts take place until an administrator thaws the message, or the
14344 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14345 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14346 warning message whenever it freezes something, unless the message it is
14347 freezing is a locally-generated bounce message. (Without this exception there
14348 is the possibility of looping.) The warning message is sent to the addresses
14349 supplied as the comma-separated value of this option. If several of the
14350 message's addresses cause freezing, only a single message is sent. If the
14351 freezing was automatic, the reason(s) for freezing can be found in the message
14352 log. If you configure freezing in a filter or ACL, you must arrange for any
14353 logging that you require.
14354
14355
14356 .option gecos_name main string&!! unset
14357 .cindex "HP-UX"
14358 .cindex "&""gecos""& field, parsing"
14359 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14360 password file to hold other information in addition to users' real names. Exim
14361 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14362 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14363 of the field are used unchanged, except that, if an ampersand is encountered,
14364 it is replaced by the user's login name with the first character forced to
14365 upper case, since this is a convention that is observed on many systems.
14366
14367 When these options are set, &%gecos_pattern%& is treated as a regular
14368 expression that is to be applied to the field (again with && replaced by the
14369 login name), and if it matches, &%gecos_name%& is expanded and used as the
14370 user's name.
14371
14372 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14373 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14374 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14375 name terminates at the first comma, the following can be used:
14376 .code
14377 gecos_pattern = ([^,]*)
14378 gecos_name = $1
14379 .endd
14380
14381 .option gecos_pattern main string unset
14382 See &%gecos_name%& above.
14383
14384
14385 .option gnutls_compat_mode main boolean unset
14386 This option controls whether GnuTLS is used in compatibility mode in an Exim
14387 server. This reduces security slightly, but improves interworking with older
14388 implementations of TLS.
14389
14390
14391 option gnutls_allow_auto_pkcs11 main boolean unset
14392 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14393 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14394
14395 See
14396 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14397 for documentation.
14398
14399
14400
14401 .option headers_charset main string "see below"
14402 This option sets a default character set for translating from encoded MIME
14403 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14404 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14405 ultimate default is ISO-8859-1. For more details see the description of header
14406 insertions in section &<<SECTexpansionitems>>&.
14407
14408
14409
14410 .option header_maxsize main integer "see below"
14411 .cindex "header section" "maximum size of"
14412 .cindex "limit" "size of message header section"
14413 This option controls the overall maximum size of a message's header
14414 section. The default is the value of HEADER_MAXSIZE in
14415 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14416 sections are rejected.
14417
14418
14419 .option header_line_maxsize main integer 0
14420 .cindex "header lines" "maximum size of"
14421 .cindex "limit" "size of one header line"
14422 This option limits the length of any individual header line in a message, after
14423 all the continuations have been joined together. Messages with individual
14424 header lines that are longer than the limit are rejected. The default value of
14425 zero means &"no limit"&.
14426
14427
14428
14429
14430 .option helo_accept_junk_hosts main "host list&!!" unset
14431 .cindex "HELO" "accepting junk data"
14432 .cindex "EHLO" "accepting junk data"
14433 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14434 mail, and gives an error response for invalid data. Unfortunately, there are
14435 some SMTP clients that send syntactic junk. They can be accommodated by setting
14436 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14437 if you want to do semantic checking.
14438 See also &%helo_allow_chars%& for a way of extending the permitted character
14439 set.
14440
14441
14442 .option helo_allow_chars main string unset
14443 .cindex "HELO" "underscores in"
14444 .cindex "EHLO" "underscores in"
14445 .cindex "underscore in EHLO/HELO"
14446 This option can be set to a string of rogue characters that are permitted in
14447 all EHLO and HELO names in addition to the standard letters, digits,
14448 hyphens, and dots. If you really must allow underscores, you can set
14449 .code
14450 helo_allow_chars = _
14451 .endd
14452 Note that the value is one string, not a list.
14453
14454
14455 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14456 .cindex "HELO" "forcing reverse lookup"
14457 .cindex "EHLO" "forcing reverse lookup"
14458 If the domain given by a client in a HELO or EHLO command matches this
14459 list, a reverse lookup is done in order to establish the host's true name. The
14460 default forces a lookup if the client host gives the server's name or any of
14461 its IP addresses (in brackets), something that broken clients have been seen to
14462 do.
14463
14464
14465 .option helo_try_verify_hosts main "host list&!!" unset
14466 .cindex "HELO verifying" "optional"
14467 .cindex "EHLO" "verifying, optional"
14468 By default, Exim just checks the syntax of HELO and EHLO commands (see
14469 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14470 to do more extensive checking of the data supplied by these commands. The ACL
14471 condition &`verify = helo`& is provided to make this possible.
14472 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14473 to force the check to occur. From release 4.53 onwards, this is no longer
14474 necessary. If the check has not been done before &`verify = helo`& is
14475 encountered, it is done at that time. Consequently, this option is obsolete.
14476 Its specification is retained here for backwards compatibility.
14477
14478 When an EHLO or HELO command is received, if the calling host matches
14479 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14480 EHLO command either:
14481
14482 .ilist
14483 is an IP literal matching the calling address of the host, or
14484 .next
14485 .cindex "DNS" "reverse lookup"
14486 .cindex "reverse DNS lookup"
14487 matches the host name that Exim obtains by doing a reverse lookup of the
14488 calling host address, or
14489 .next
14490 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14491 available) yields the calling host address.
14492 .endlist
14493
14494 However, the EHLO or HELO command is not rejected if any of the checks
14495 fail. Processing continues, but the result of the check is remembered, and can
14496 be detected later in an ACL by the &`verify = helo`& condition.
14497
14498 .option helo_verify_hosts main "host list&!!" unset
14499 .cindex "HELO verifying" "mandatory"
14500 .cindex "EHLO" "verifying, mandatory"
14501 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14502 backwards compatibility. For hosts that match this option, Exim checks the host
14503 name given in the HELO or EHLO in the same way as for
14504 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14505 rejected with a 550 error, and entries are written to the main and reject logs.
14506 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14507 error.
14508
14509 .option hold_domains main "domain list&!!" unset
14510 .cindex "domain" "delaying delivery"
14511 .cindex "delivery" "delaying certain domains"
14512 This option allows mail for particular domains to be held on the queue
14513 manually. The option is overridden if a message delivery is forced with the
14514 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14515 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14516 item in &%hold_domains%&, no routing or delivery for that address is done, and
14517 it is deferred every time the message is looked at.
14518
14519 This option is intended as a temporary operational measure for delaying the
14520 delivery of mail while some problem is being sorted out, or some new
14521 configuration tested. If you just want to delay the processing of some
14522 domains until a queue run occurs, you should use &%queue_domains%& or
14523 &%queue_smtp_domains%&, not &%hold_domains%&.
14524
14525 A setting of &%hold_domains%& does not override Exim's code for removing
14526 messages from the queue if they have been there longer than the longest retry
14527 time in any retry rule. If you want to hold messages for longer than the normal
14528 retry times, insert a dummy retry rule with a long retry time.
14529
14530
14531 .option host_lookup main "host list&!!" unset
14532 .cindex "host name" "lookup, forcing"
14533 Exim does not look up the name of a calling host from its IP address unless it
14534 is required to compare against some host list, or the host matches
14535 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14536 option (which normally contains IP addresses rather than host names). The
14537 default configuration file contains
14538 .code
14539 host_lookup = *
14540 .endd
14541 which causes a lookup to happen for all hosts. If the expense of these lookups
14542 is felt to be too great, the setting can be changed or removed.
14543
14544 After a successful reverse lookup, Exim does a forward lookup on the name it
14545 has obtained, to verify that it yields the IP address that it started with. If
14546 this check fails, Exim behaves as if the name lookup failed.
14547
14548 .vindex "&$host_lookup_failed$&"
14549 .vindex "&$sender_host_name$&"
14550 After any kind of failure, the host name (in &$sender_host_name$&) remains
14551 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14552 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14553 &`verify = reverse_host_lookup`& in ACLs.
14554
14555
14556 .option host_lookup_order main "string list" &`bydns:byaddr`&
14557 This option specifies the order of different lookup methods when Exim is trying
14558 to find a host name from an IP address. The default is to do a DNS lookup
14559 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14560 if that fails. You can change the order of these lookups, or omit one entirely,
14561 if you want.
14562
14563 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14564 multiple PTR records in the DNS and the IP address is not listed in
14565 &_/etc/hosts_&. Different operating systems give different results in this
14566 case. That is why the default tries a DNS lookup first.
14567
14568
14569
14570 .option host_reject_connection main "host list&!!" unset
14571 .cindex "host" "rejecting connections from"
14572 If this option is set, incoming SMTP calls from the hosts listed are rejected
14573 as soon as the connection is made.
14574 This option is obsolete, and retained only for backward compatibility, because
14575 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14576 connections immediately.
14577
14578 The ability to give an immediate rejection (either by this option or using an
14579 ACL) is provided for use in unusual cases. Many hosts will just try again,
14580 sometimes without much delay. Normally, it is better to use an ACL to reject
14581 incoming messages at a later stage, such as after RCPT commands. See
14582 chapter &<<CHAPACL>>&.
14583
14584
14585 .option hosts_connection_nolog main "host list&!!" unset
14586 .cindex "host" "not logging connections from"
14587 This option defines a list of hosts for which connection logging does not
14588 happen, even though the &%smtp_connection%& log selector is set. For example,
14589 you might want not to log SMTP connections from local processes, or from
14590 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14591 the daemon; you should therefore strive to restrict its value to a short inline
14592 list of IP addresses and networks. To disable logging SMTP connections from
14593 local processes, you must create a host list with an empty item. For example:
14594 .code
14595 hosts_connection_nolog = :
14596 .endd
14597 If the &%smtp_connection%& log selector is not set, this option has no effect.
14598
14599
14600
14601 .option hosts_treat_as_local main "domain list&!!" unset
14602 .cindex "local host" "domains treated as"
14603 .cindex "host" "treated as local"
14604 If this option is set, any host names that match the domain list are treated as
14605 if they were the local host when Exim is scanning host lists obtained from MX
14606 records
14607 or other sources. Note that the value of this option is a domain list, not a
14608 host list, because it is always used to check host names, not IP addresses.
14609
14610 This option also applies when Exim is matching the special items
14611 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14612 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14613 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14614 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14615 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14616 interfaces and recognizing the local host.
14617
14618
14619 .option ibase_servers main "string list" unset
14620 .cindex "InterBase" "server list"
14621 This option provides a list of InterBase servers and associated connection data,
14622 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14623 The option is available only if Exim has been built with InterBase support.
14624
14625
14626
14627 .option ignore_bounce_errors_after main time 10w
14628 .cindex "bounce message" "discarding"
14629 .cindex "discarding bounce message"
14630 This option affects the processing of bounce messages that cannot be delivered,
14631 that is, those that suffer a permanent delivery failure. (Bounce messages that
14632 suffer temporary delivery failures are of course retried in the usual way.)
14633
14634 After a permanent delivery failure, bounce messages are frozen,
14635 because there is no sender to whom they can be returned. When a frozen bounce
14636 message has been on the queue for more than the given time, it is unfrozen at
14637 the next queue run, and a further delivery is attempted. If delivery fails
14638 again, the bounce message is discarded. This makes it possible to keep failed
14639 bounce messages around for a shorter time than the normal maximum retry time
14640 for frozen messages. For example,
14641 .code
14642 ignore_bounce_errors_after = 12h
14643 .endd
14644 retries failed bounce message deliveries after 12 hours, discarding any further
14645 failures. If the value of this option is set to a zero time period, bounce
14646 failures are discarded immediately. Setting a very long time (as in the default
14647 value) has the effect of disabling this option. For ways of automatically
14648 dealing with other kinds of frozen message, see &%auto_thaw%& and
14649 &%timeout_frozen_after%&.
14650
14651
14652 .option ignore_fromline_hosts main "host list&!!" unset
14653 .cindex "&""From""& line"
14654 .cindex "UUCP" "&""From""& line"
14655 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14656 the headers of a message. By default this is treated as the start of the
14657 message's body, which means that any following headers are not recognized as
14658 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14659 match those hosts that insist on sending it. If the sender is actually a local
14660 process rather than a remote host, and is using &%-bs%& to inject the messages,
14661 &%ignore_fromline_local%& must be set to achieve this effect.
14662
14663
14664 .option ignore_fromline_local main boolean false
14665 See &%ignore_fromline_hosts%& above.
14666
14667
14668 .option keep_malformed main time 4d
14669 This option specifies the length of time to keep messages whose spool files
14670 have been corrupted in some way. This should, of course, never happen. At the
14671 next attempt to deliver such a message, it gets removed. The incident is
14672 logged.
14673
14674
14675 .option ldap_ca_cert_dir main string unset
14676 .cindex "LDAP", "TLS CA certificate directory"
14677 This option indicates which directory contains CA certificates for verifying
14678 a TLS certificate presented by an LDAP server.
14679 While Exim does not provide a default value, your SSL library may.
14680 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14681 and constrained to be a directory.
14682
14683
14684 .option ldap_ca_cert_file main string unset
14685 .cindex "LDAP", "TLS CA certificate file"
14686 This option indicates which file contains CA certificates for verifying
14687 a TLS certificate presented by an LDAP server.
14688 While Exim does not provide a default value, your SSL library may.
14689 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14690 and constrained to be a file.
14691
14692
14693 .option ldap_cert_file main string unset
14694 .cindex "LDAP" "TLS client certificate file"
14695 This option indicates which file contains an TLS client certificate which
14696 Exim should present to the LDAP server during TLS negotiation.
14697 Should be used together with &%ldap_cert_key%&.
14698
14699
14700 .option ldap_cert_key main string unset
14701 .cindex "LDAP" "TLS client key file"
14702 This option indicates which file contains the secret/private key to use
14703 to prove identity to the LDAP server during TLS negotiation.
14704 Should be used together with &%ldap_cert_file%&, which contains the
14705 identity to be proven.
14706
14707
14708 .option ldap_cipher_suite main string unset
14709 .cindex "LDAP" "TLS cipher suite"
14710 This controls the TLS cipher-suite negotiation during TLS negotiation with
14711 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14712 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14713
14714
14715 .option ldap_default_servers main "string list" unset
14716 .cindex "LDAP" "default servers"
14717 This option provides a list of LDAP servers which are tried in turn when an
14718 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14719 details of LDAP queries. This option is available only when Exim has been built
14720 with LDAP support.
14721
14722
14723 .option ldap_require_cert main string unset.
14724 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14725 This should be one of the values "hard", "demand", "allow", "try" or "never".
14726 A value other than one of these is interpreted as "never".
14727 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14728 Although Exim does not set a default, the LDAP library probably defaults
14729 to hard/demand.
14730
14731
14732 .option ldap_start_tls main boolean false
14733 .cindex "LDAP" "whether or not to negotiate TLS"
14734 If set, Exim will attempt to negotiate TLS with the LDAP server when
14735 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14736 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14737 of SSL-on-connect.
14738 In the event of failure to negotiate TLS, the action taken is controlled
14739 by &%ldap_require_cert%&.
14740
14741
14742 .option ldap_version main integer unset
14743 .cindex "LDAP" "protocol version, forcing"
14744 This option can be used to force Exim to set a specific protocol version for
14745 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14746 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14747 the LDAP headers; otherwise it is 2. This option is available only when Exim
14748 has been built with LDAP support.
14749
14750
14751
14752 .option local_from_check main boolean true
14753 .cindex "&'Sender:'& header line" "disabling addition of"
14754 .cindex "&'From:'& header line" "disabling checking of"
14755 When a message is submitted locally (that is, not over a TCP/IP connection) by
14756 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14757 checks that the &'From:'& header line matches the login of the calling user and
14758 the domain specified by &%qualify_domain%&.
14759
14760 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14761 locally submitted message is automatically qualified by Exim, unless the
14762 &%-bnq%& command line option is used.
14763
14764 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14765 on the local part. If the &'From:'& header line does not match, Exim adds a
14766 &'Sender:'& header with an address constructed from the calling user's login
14767 and the default qualify domain.
14768
14769 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14770 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14771 &'Sender:'& header lines supplied by untrusted users, you must also set
14772 &%local_sender_retain%& to be true.
14773
14774 .cindex "envelope sender"
14775 These options affect only the header lines in the message. The envelope sender
14776 is still forced to be the login id at the qualify domain unless
14777 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14778
14779 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14780 request similar header line checking. See section &<<SECTthesenhea>>&, which
14781 has more details about &'Sender:'& processing.
14782
14783
14784
14785
14786 .option local_from_prefix main string unset
14787 When Exim checks the &'From:'& header line of locally submitted messages for
14788 matching the login id (see &%local_from_check%& above), it can be configured to
14789 ignore certain prefixes and suffixes in the local part of the address. This is
14790 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14791 appropriate lists, in the same form as the &%local_part_prefix%& and
14792 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14793 example, if
14794 .code
14795 local_from_prefix = *-
14796 .endd
14797 is set, a &'From:'& line containing
14798 .code
14799 From: anything-user@your.domain.example
14800 .endd
14801 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14802 matches the actual sender address that is constructed from the login name and
14803 qualify domain.
14804
14805
14806 .option local_from_suffix main string unset
14807 See &%local_from_prefix%& above.
14808
14809
14810 .option local_interfaces main "string list" "see below"
14811 This option controls which network interfaces are used by the daemon for
14812 listening; they are also used to identify the local host when routing. Chapter
14813 &<<CHAPinterfaces>>& contains a full description of this option and the related
14814 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14815 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14816 &%local_interfaces%& is
14817 .code
14818 local_interfaces = 0.0.0.0
14819 .endd
14820 when Exim is built without IPv6 support; otherwise it is
14821 .code
14822 local_interfaces = <; ::0 ; 0.0.0.0
14823 .endd
14824
14825 .option local_scan_timeout main time 5m
14826 .cindex "timeout" "for &[local_scan()]& function"
14827 .cindex "&[local_scan()]& function" "timeout"
14828 This timeout applies to the &[local_scan()]& function (see chapter
14829 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14830 the incoming message is rejected with a temporary error if it is an SMTP
14831 message. For a non-SMTP message, the message is dropped and Exim ends with a
14832 non-zero code. The incident is logged on the main and reject logs.
14833
14834
14835
14836 .option local_sender_retain main boolean false
14837 .cindex "&'Sender:'& header line" "retaining from local submission"
14838 When a message is submitted locally (that is, not over a TCP/IP connection) by
14839 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14840 do not want this to happen, you must set &%local_sender_retain%&, and you must
14841 also set &%local_from_check%& to be false (Exim will complain if you do not).
14842 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14843 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14844
14845
14846
14847
14848 .option localhost_number main string&!! unset
14849 .cindex "host" "locally unique number for"
14850 .cindex "message ids" "with multiple hosts"
14851 .vindex "&$localhost_number$&"
14852 Exim's message ids are normally unique only within the local host. If
14853 uniqueness among a set of hosts is required, each host must set a different
14854 value for the &%localhost_number%& option. The string is expanded immediately
14855 after reading the configuration file (so that a number can be computed from the
14856 host name, for example) and the result of the expansion must be a number in the
14857 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14858 systems). This is available in subsequent string expansions via the variable
14859 &$localhost_number$&. When &%localhost_number is set%&, the final two
14860 characters of the message id, instead of just being a fractional part of the
14861 time, are computed from the time and the local host number as described in
14862 section &<<SECTmessiden>>&.
14863
14864
14865
14866 .option log_file_path main "string list&!!" "set at compile time"
14867 .cindex "log" "file path for"
14868 This option sets the path which is used to determine the names of Exim's log
14869 files, or indicates that logging is to be to syslog, or both. It is expanded
14870 when Exim is entered, so it can, for example, contain a reference to the host
14871 name. If no specific path is set for the log files at compile or run time, they
14872 are written in a sub-directory called &_log_& in Exim's spool directory.
14873 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14874 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14875 used. If this string is fixed at your installation (contains no expansion
14876 variables) it is recommended that you do not set this option in the
14877 configuration file, but instead supply the path using LOG_FILE_PATH in
14878 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14879 early on &-- in particular, failure to read the configuration file.
14880
14881
14882 .option log_selector main string unset
14883 .cindex "log" "selectors"
14884 This option can be used to reduce or increase the number of things that Exim
14885 writes to its log files. Its argument is made up of names preceded by plus or
14886 minus characters. For example:
14887 .code
14888 log_selector = +arguments -retry_defer
14889 .endd
14890 A list of possible names and what they control is given in the chapter on
14891 logging, in section &<<SECTlogselector>>&.
14892
14893
14894 .option log_timezone main boolean false
14895 .cindex "log" "timezone for entries"
14896 .vindex "&$tod_log$&"
14897 .vindex "&$tod_zone$&"
14898 By default, the timestamps on log lines are in local time without the
14899 timezone. This means that if your timezone changes twice a year, the timestamps
14900 in log lines are ambiguous for an hour when the clocks go back. One way of
14901 avoiding this problem is to set the timezone to UTC. An alternative is to set
14902 &%log_timezone%& true. This turns on the addition of the timezone offset to
14903 timestamps in log lines. Turning on this option can add quite a lot to the size
14904 of log files because each line is extended by 6 characters. Note that the
14905 &$tod_log$& variable contains the log timestamp without the zone, but there is
14906 another variable called &$tod_zone$& that contains just the timezone offset.
14907
14908
14909 .option lookup_open_max main integer 25
14910 .cindex "too many open files"
14911 .cindex "open files, too many"
14912 .cindex "file" "too many open"
14913 .cindex "lookup" "maximum open files"
14914 .cindex "limit" "open files for lookups"
14915 This option limits the number of simultaneously open files for single-key
14916 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14917 Exim normally keeps these files open during routing, because often the same
14918 file is required several times. If the limit is reached, Exim closes the least
14919 recently used file. Note that if you are using the &'ndbm'& library, it
14920 actually opens two files for each logical DBM database, though it still counts
14921 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14922 open files"& errors with NDBM, you need to reduce the value of
14923 &%lookup_open_max%&.
14924
14925
14926 .option max_username_length main integer 0
14927 .cindex "length of login name"
14928 .cindex "user name" "maximum length"
14929 .cindex "limit" "user name length"
14930 Some operating systems are broken in that they truncate long arguments to
14931 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14932 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14933 an argument that is longer behaves as if &[getpwnam()]& failed.
14934
14935
14936 .option message_body_newlines main bool false
14937 .cindex "message body" "newlines in variables"
14938 .cindex "newline" "in message body variables"
14939 .vindex "&$message_body$&"
14940 .vindex "&$message_body_end$&"
14941 By default, newlines in the message body are replaced by spaces when setting
14942 the &$message_body$& and &$message_body_end$& expansion variables. If this
14943 option is set true, this no longer happens.
14944
14945
14946 .option message_body_visible main integer 500
14947 .cindex "body of message" "visible size"
14948 .cindex "message body" "visible size"
14949 .vindex "&$message_body$&"
14950 .vindex "&$message_body_end$&"
14951 This option specifies how much of a message's body is to be included in the
14952 &$message_body$& and &$message_body_end$& expansion variables.
14953
14954
14955 .option message_id_header_domain main string&!! unset
14956 .cindex "&'Message-ID:'& header line"
14957 If this option is set, the string is expanded and used as the right hand side
14958 (domain) of the &'Message-ID:'& header that Exim creates if a
14959 locally-originated incoming message does not have one. &"Locally-originated"&
14960 means &"not received over TCP/IP."&
14961 Otherwise, the primary host name is used.
14962 Only letters, digits, dot and hyphen are accepted; any other characters are
14963 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14964 empty string, the option is ignored.
14965
14966
14967 .option message_id_header_text main string&!! unset
14968 If this variable is set, the string is expanded and used to augment the text of
14969 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14970 message does not have one. The text of this header is required by RFC 2822 to
14971 take the form of an address. By default, Exim uses its internal message id as
14972 the local part, and the primary host name as the domain. If this option is set,
14973 it is expanded, and provided the expansion is not forced to fail, and does not
14974 yield an empty string, the result is inserted into the header immediately
14975 before the @, separated from the internal message id by a dot. Any characters
14976 that are illegal in an address are automatically converted into hyphens. This
14977 means that variables such as &$tod_log$& can be used, because the spaces and
14978 colons will become hyphens.
14979
14980
14981 .option message_logs main boolean true
14982 .cindex "message logs" "disabling"
14983 .cindex "log" "message log; disabling"
14984 If this option is turned off, per-message log files are not created in the
14985 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14986 Exim, by reducing the number of files involved in handling a message from a
14987 minimum of four (header spool file, body spool file, delivery journal, and
14988 per-message log) to three. The other major I/O activity is Exim's main log,
14989 which is not affected by this option.
14990
14991
14992 .option message_size_limit main string&!! 50M
14993 .cindex "message" "size limit"
14994 .cindex "limit" "message size"
14995 .cindex "size" "of message, limit"
14996 This option limits the maximum size of message that Exim will process. The
14997 value is expanded for each incoming connection so, for example, it can be made
14998 to depend on the IP address of the remote host for messages arriving via
14999 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15000 optionally followed by K or M.
15001
15002 &*Note*&: This limit cannot be made to depend on a message's sender or any
15003 other properties of an individual message, because it has to be advertised in
15004 the server's response to EHLO. String expansion failure causes a temporary
15005 error. A value of zero means no limit, but its use is not recommended. See also
15006 &%bounce_return_size_limit%&.
15007
15008 Incoming SMTP messages are failed with a 552 error if the limit is
15009 exceeded; locally-generated messages either get a stderr message or a delivery
15010 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15011 an oversized message is logged in both the main and the reject logs. See also
15012 the generic transport option &%message_size_limit%&, which limits the size of
15013 message that an individual transport can process.
15014
15015 If you use a virus-scanner and set this option to to a value larger than the
15016 maximum size that your virus-scanner is configured to support, you may get
15017 failures triggered by large mails.  The right size to configure for the
15018 virus-scanner depends upon what data is passed and the options in use but it's
15019 probably safest to just set it to a little larger than this value.  Eg, with a
15020 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15021 some problems may result.
15022
15023 A value of 0 will disable size limit checking; Exim will still advertise the
15024 SIZE extension in an EHLO response, but without a limit, so as to permit
15025 SMTP clients to still indicate the message size along with the MAIL verb.
15026
15027
15028 .option move_frozen_messages main boolean false
15029 .cindex "frozen messages" "moving"
15030 This option, which is available only if Exim has been built with the setting
15031 .code
15032 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15033 .endd
15034 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15035 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15036 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15037 standard utilities for handling such moved messages, and they do not show up in
15038 lists generated by &%-bp%& or by the Exim monitor.
15039
15040
15041 .option mua_wrapper main boolean false
15042 Setting this option true causes Exim to run in a very restrictive mode in which
15043 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15044 contains a full description of this facility.
15045
15046
15047
15048 .option mysql_servers main "string list" unset
15049 .cindex "MySQL" "server list"
15050 This option provides a list of MySQL servers and associated connection data, to
15051 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15052 option is available only if Exim has been built with MySQL support.
15053
15054
15055 .option never_users main "string list&!!" unset
15056 This option is expanded just once, at the start of Exim's processing. Local
15057 message deliveries are normally run in processes that are setuid to the
15058 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15059 It is usually desirable to prevent any deliveries from running as root, as a
15060 safety precaution.
15061
15062 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15063 list of users that must not be used for local deliveries. This list is fixed in
15064 the binary and cannot be overridden by the configuration file. By default, it
15065 contains just the single user name &"root"&. The &%never_users%& runtime option
15066 can be used to add more users to the fixed list.
15067
15068 If a message is to be delivered as one of the users on the fixed list or the
15069 &%never_users%& list, an error occurs, and delivery is deferred. A common
15070 example is
15071 .code
15072 never_users = root:daemon:bin
15073 .endd
15074 Including root is redundant if it is also on the fixed list, but it does no
15075 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15076 transport driver.
15077
15078
15079 .option openssl_options main "string list" "+no_sslv2"
15080 .cindex "OpenSSL "compatibility options"
15081 This option allows an administrator to adjust the SSL options applied
15082 by OpenSSL to connections.  It is given as a space-separated list of items,
15083 each one to be +added or -subtracted from the current value.
15084
15085 This option is only available if Exim is built against OpenSSL.  The values
15086 available for this option vary according to the age of your OpenSSL install.
15087 The &"all"& value controls a subset of flags which are available, typically
15088 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15089 list the values known on your system and Exim should support all the
15090 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15091 names lose the leading &"SSL_OP_"& and are lower-cased.
15092
15093 Note that adjusting the options can have severe impact upon the security of
15094 SSL as used by Exim.  It is possible to disable safety checks and shoot
15095 yourself in the foot in various unpleasant ways.  This option should not be
15096 adjusted lightly.  An unrecognised item will be detected at startup, by
15097 invoking Exim with the &%-bV%& flag.
15098
15099 The option affects Exim operating both as a server and as a client.
15100
15101 Historical note: prior to release 4.80, Exim defaulted this value to
15102 "+dont_insert_empty_fragments", which may still be needed for compatibility
15103 with some clients, but which lowers security by increasing exposure to
15104 some now infamous attacks.
15105
15106 Examples:
15107 .code
15108 # Make both old MS and old Eudora happy:
15109 openssl_options = -all +microsoft_big_sslv3_buffer \
15110                        +dont_insert_empty_fragments
15111
15112 # Disable older protocol versions:
15113 openssl_options = +no_sslv2 +no_sslv3
15114 .endd
15115
15116 Possible options may include:
15117 .ilist
15118 &`all`&
15119 .next
15120 &`allow_unsafe_legacy_renegotiation`&
15121 .next
15122 &`cipher_server_preference`&
15123 .next
15124 &`dont_insert_empty_fragments`&
15125 .next
15126 &`ephemeral_rsa`&
15127 .next
15128 &`legacy_server_connect`&
15129 .next
15130 &`microsoft_big_sslv3_buffer`&
15131 .next
15132 &`microsoft_sess_id_bug`&
15133 .next
15134 &`msie_sslv2_rsa_padding`&
15135 .next
15136 &`netscape_challenge_bug`&
15137 .next
15138 &`netscape_reuse_cipher_change_bug`&
15139 .next
15140 &`no_compression`&
15141 .next
15142 &`no_session_resumption_on_renegotiation`&
15143 .next
15144 &`no_sslv2`&
15145 .next
15146 &`no_sslv3`&
15147 .next
15148 &`no_ticket`&
15149 .next
15150 &`no_tlsv1`&
15151 .next
15152 &`no_tlsv1_1`&
15153 .next
15154 &`no_tlsv1_2`&
15155 .next
15156 &`safari_ecdhe_ecdsa_bug`&
15157 .next
15158 &`single_dh_use`&
15159 .next
15160 &`single_ecdh_use`&
15161 .next
15162 &`ssleay_080_client_dh_bug`&
15163 .next
15164 &`sslref2_reuse_cert_type_bug`&
15165 .next
15166 &`tls_block_padding_bug`&
15167 .next
15168 &`tls_d5_bug`&
15169 .next
15170 &`tls_rollback_bug`&
15171 .endlist
15172
15173 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15174 all clients connecting using the MacOS SecureTransport TLS facility prior
15175 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15176 to negotiate TLS then this option value might help, provided that your OpenSSL
15177 release is new enough to contain this work-around.  This may be a situation
15178 where you have to upgrade OpenSSL to get buggy clients working.
15179
15180
15181 .option oracle_servers main "string list" unset
15182 .cindex "Oracle" "server list"
15183 This option provides a list of Oracle servers and associated connection data,
15184 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15185 The option is available only if Exim has been built with Oracle support.
15186
15187
15188 .option percent_hack_domains main "domain list&!!" unset
15189 .cindex "&""percent hack""&"
15190 .cindex "source routing" "in email address"
15191 .cindex "address" "source-routed"
15192 The &"percent hack"& is the convention whereby a local part containing a
15193 percent sign is re-interpreted as a new email address, with the percent
15194 replaced by @. This is sometimes called &"source routing"&, though that term is
15195 also applied to RFC 2822 addresses that begin with an @ character. If this
15196 option is set, Exim implements the percent facility for those domains listed,
15197 but no others. This happens before an incoming SMTP address is tested against
15198 an ACL.
15199
15200 &*Warning*&: The &"percent hack"& has often been abused by people who are
15201 trying to get round relaying restrictions. For this reason, it is best avoided
15202 if at all possible. Unfortunately, a number of less security-conscious MTAs
15203 implement it unconditionally. If you are running Exim on a gateway host, and
15204 routing mail through to internal MTAs without processing the local parts, it is
15205 a good idea to reject recipient addresses with percent characters in their
15206 local parts. Exim's default configuration does this.
15207
15208
15209 .option perl_at_start main boolean false
15210 This option is available only when Exim is built with an embedded Perl
15211 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15212
15213
15214 .option perl_startup main string unset
15215 This option is available only when Exim is built with an embedded Perl
15216 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15217
15218
15219 .option pgsql_servers main "string list" unset
15220 .cindex "PostgreSQL lookup type" "server list"
15221 This option provides a list of PostgreSQL servers and associated connection
15222 data, to be used in conjunction with &(pgsql)& lookups (see section
15223 &<<SECID72>>&). The option is available only if Exim has been built with
15224 PostgreSQL support.
15225
15226
15227 .option pid_file_path main string&!! "set at compile time"
15228 .cindex "daemon" "pid file path"
15229 .cindex "pid file, path for"
15230 This option sets the name of the file to which the Exim daemon writes its
15231 process id. The string is expanded, so it can contain, for example, references
15232 to the host name:
15233 .code
15234 pid_file_path = /var/log/$primary_hostname/exim.pid
15235 .endd
15236 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15237 spool directory.
15238 The value set by the option can be overridden by the &%-oP%& command line
15239 option. A pid file is not written if a &"non-standard"& daemon is run by means
15240 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15241
15242
15243 .option pipelining_advertise_hosts main "host list&!!" *
15244 .cindex "PIPELINING" "suppressing advertising"
15245 This option can be used to suppress the advertisement of the SMTP
15246 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15247 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15248 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15249 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15250 that clients will use it; &"out of order"& commands that are &"expected"& do
15251 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15252
15253
15254 .option prdr_enable main boolean false
15255 .cindex "PRDR" "enabling on server"
15256 This option can be used to enable the Per-Recipient Data Response extension
15257 to SMTP, defined by Eric Hall.
15258 If the option is set, PRDR is advertised by Exim when operating as a server.
15259 If the client requests PRDR, and more than one recipient, for a message 
15260 an additional ACL is called for each recipient after the message content
15261 is recieved.  See section &<<SECTPRDRACL>>&.
15262
15263 .option preserve_message_logs main boolean false
15264 .cindex "message logs" "preserving"
15265 If this option is set, message log files are not deleted when messages are
15266 completed. Instead, they are moved to a sub-directory of the spool directory
15267 called &_msglog.OLD_&, where they remain available for statistical or debugging
15268 purposes. This is a dangerous option to set on systems with any appreciable
15269 volume of mail. Use with care!
15270
15271
15272 .option primary_hostname main string "see below"
15273 .cindex "name" "of local host"
15274 .cindex "host" "name of local"
15275 .cindex "local host" "name of"
15276 .vindex "&$primary_hostname$&"
15277 This specifies the name of the current host. It is used in the default EHLO or
15278 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15279 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15280 The value is also used by default in some SMTP response messages from an Exim
15281 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15282
15283 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15284 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15285 contains only one component, Exim passes it to &[gethostbyname()]& (or
15286 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15287 version. The variable &$primary_hostname$& contains the host name, whether set
15288 explicitly by this option, or defaulted.
15289
15290
15291 .option print_topbitchars main boolean false
15292 .cindex "printing characters"
15293 .cindex "8-bit characters"
15294 By default, Exim considers only those characters whose codes lie in the range
15295 32&--126 to be printing characters. In a number of circumstances (for example,
15296 when writing log entries) non-printing characters are converted into escape
15297 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15298 is set, code values of 128 and above are also considered to be printing
15299 characters.
15300
15301 This option also affects the header syntax checks performed by the
15302 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15303 the user's full name when constructing From: and Sender: addresses (as
15304 described in section &<<SECTconstr>>&). Setting this option can cause
15305 Exim to generate eight bit message headers that do not conform to the
15306 standards.
15307
15308
15309 .option process_log_path main string unset
15310 .cindex "process log path"
15311 .cindex "log" "process log"
15312 .cindex "&'exiwhat'&"
15313 This option sets the name of the file to which an Exim process writes its
15314 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15315 utility script. If this option is unset, the file called &_exim-process.info_&
15316 in Exim's spool directory is used. The ability to specify the name explicitly
15317 can be useful in environments where two different Exims are running, using
15318 different spool directories.
15319
15320
15321 .option prod_requires_admin main boolean true
15322 .oindex "&%-M%&"
15323 .oindex "&%-R%&"
15324 .oindex "&%-q%&"
15325 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15326 admin user unless &%prod_requires_admin%& is set false. See also
15327 &%queue_list_requires_admin%&.
15328
15329
15330 .option qualify_domain main string "see below"
15331 .cindex "domain" "for qualifying addresses"
15332 .cindex "address" "qualification"
15333 This option specifies the domain name that is added to any envelope sender
15334 addresses that do not have a domain qualification. It also applies to
15335 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15336 are accepted by default only for locally-generated messages. Qualification is
15337 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15338 locally-generated messages, unless the &%-bnq%& command line option is used.
15339
15340 Messages from external sources must always contain fully qualified addresses,
15341 unless the sending host matches &%sender_unqualified_hosts%& or
15342 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15343 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15344 necessary. Internally, Exim always works with fully qualified envelope
15345 addresses. If &%qualify_domain%& is not set, it defaults to the
15346 &%primary_hostname%& value.
15347
15348
15349 .option qualify_recipient main string "see below"
15350 This option allows you to specify a different domain for qualifying recipient
15351 addresses to the one that is used for senders. See &%qualify_domain%& above.
15352
15353
15354
15355 .option queue_domains main "domain list&!!" unset
15356 .cindex "domain" "specifying non-immediate delivery"
15357 .cindex "queueing incoming messages"
15358 .cindex "message" "queueing certain domains"
15359 This option lists domains for which immediate delivery is not required.
15360 A delivery process is started whenever a message is received, but only those
15361 domains that do not match are processed. All other deliveries wait until the
15362 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15363
15364
15365 .option queue_list_requires_admin main boolean true
15366 .oindex "&%-bp%&"
15367 The &%-bp%& command-line option, which lists the messages that are on the
15368 queue, requires the caller to be an admin user unless
15369 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15370
15371
15372 .option queue_only main boolean false
15373 .cindex "queueing incoming messages"
15374 .cindex "message" "queueing unconditionally"
15375 If &%queue_only%& is set, a delivery process is not automatically started
15376 whenever a message is received. Instead, the message waits on the queue for the
15377 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15378 delivered immediately when certain conditions (such as heavy load) occur.
15379
15380 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15381 and &%-odi%& command line options override &%queue_only%& unless
15382 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15383 &%queue_only_load%&, and &%smtp_accept_queue%&.
15384
15385
15386 .option queue_only_file main string unset
15387 .cindex "queueing incoming messages"
15388 .cindex "message" "queueing by file existence"
15389 This option can be set to a colon-separated list of absolute path names, each
15390 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15391 it tests for the existence of each listed path using a call to &[stat()]&. For
15392 each path that exists, the corresponding queueing option is set.
15393 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15394 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15395 .code
15396 queue_only_file = smtp/some/file
15397 .endd
15398 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15399 &_/some/file_& exists.
15400
15401
15402 .option queue_only_load main fixed-point unset
15403 .cindex "load average"
15404 .cindex "queueing incoming messages"
15405 .cindex "message" "queueing by load"
15406 If the system load average is higher than this value, incoming messages from
15407 all sources are queued, and no automatic deliveries are started. If this
15408 happens during local or remote SMTP input, all subsequent messages received on
15409 the same SMTP connection are queued by default, whatever happens to the load in
15410 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15411 false.
15412
15413 Deliveries will subsequently be performed by queue runner processes. This
15414 option has no effect on ancient operating systems on which Exim cannot
15415 determine the load average. See also &%deliver_queue_load_max%& and
15416 &%smtp_load_reserve%&.
15417
15418
15419 .option queue_only_load_latch main boolean true
15420 .cindex "load average" "re-evaluating per message"
15421 When this option is true (the default), once one message has been queued
15422 because the load average is higher than the value set by &%queue_only_load%&,
15423 all subsequent messages received on the same SMTP connection are also queued.
15424 This is a deliberate choice; even though the load average may fall below the
15425 threshold, it doesn't seem right to deliver later messages on the same
15426 connection when not delivering earlier ones. However, there are special
15427 circumstances such as very long-lived connections from scanning appliances
15428 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15429 should be set false. This causes the value of the load average to be
15430 re-evaluated for each message.
15431
15432
15433 .option queue_only_override main boolean true
15434 .cindex "queueing incoming messages"
15435 When this option is true, the &%-od%&&'x'& command line options override the
15436 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15437 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15438 to override; they are accepted, but ignored.
15439
15440
15441 .option queue_run_in_order main boolean false
15442 .cindex "queue runner" "processing messages in order"
15443 If this option is set, queue runs happen in order of message arrival instead of
15444 in an arbitrary order. For this to happen, a complete list of the entire queue
15445 must be set up before the deliveries start. When the queue is all held in a
15446 single directory (the default), a single list is created for both the ordered
15447 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15448 single list is not created when &%queue_run_in_order%& is false. In this case,
15449 the sub-directories are processed one at a time (in a random order), and this
15450 avoids setting up one huge list for the whole queue. Thus, setting
15451 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15452 when the queue is large, because of the extra work in setting up the single,
15453 large list. In most situations, &%queue_run_in_order%& should not be set.
15454
15455
15456
15457 .option queue_run_max main integer 5
15458 .cindex "queue runner" "maximum number of"
15459 This controls the maximum number of queue runner processes that an Exim daemon
15460 can run simultaneously. This does not mean that it starts them all at once,
15461 but rather that if the maximum number are still running when the time comes to
15462 start another one, it refrains from starting another one. This can happen with
15463 very large queues and/or very sluggish deliveries. This option does not,
15464 however, interlock with other processes, so additional queue runners can be
15465 started by other means, or by killing and restarting the daemon.
15466
15467 Setting this option to zero does not suppress queue runs; rather, it disables
15468 the limit, allowing any number of simultaneous queue runner processes to be
15469 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15470 the daemon's command line.
15471
15472 .option queue_smtp_domains main "domain list&!!" unset
15473 .cindex "queueing incoming messages"
15474 .cindex "message" "queueing remote deliveries"
15475 When this option is set, a delivery process is started whenever a message is
15476 received, routing is performed, and local deliveries take place.
15477 However, if any SMTP deliveries are required for domains that match
15478 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15479 message waits on the queue for the next queue run. Since routing of the message
15480 has taken place, Exim knows to which remote hosts it must be delivered, and so
15481 when the queue run happens, multiple messages for the same host are delivered
15482 over a single SMTP connection. The &%-odqs%& command line option causes all
15483 SMTP deliveries to be queued in this way, and is equivalent to setting
15484 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15485 &%queue_domains%&.
15486
15487
15488 .option receive_timeout main time 0s
15489 .cindex "timeout" "for non-SMTP input"
15490 This option sets the timeout for accepting a non-SMTP message, that is, the
15491 maximum time that Exim waits when reading a message on the standard input. If
15492 the value is zero, it will wait for ever. This setting is overridden by the
15493 &%-or%& command line option. The timeout for incoming SMTP messages is
15494 controlled by &%smtp_receive_timeout%&.
15495
15496 .option received_header_text main string&!! "see below"
15497 .cindex "customizing" "&'Received:'& header"
15498 .cindex "&'Received:'& header line" "customizing"
15499 This string defines the contents of the &'Received:'& message header that is
15500 added to each message, except for the timestamp, which is automatically added
15501 on at the end (preceded by a semicolon). The string is expanded each time it is
15502 used. If the expansion yields an empty string, no &'Received:'& header line is
15503 added to the message. Otherwise, the string should start with the text
15504 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15505 header lines. The default setting is:
15506
15507 .code
15508 received_header_text = Received: \
15509   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15510   {${if def:sender_ident \
15511   {from ${quote_local_part:$sender_ident} }}\
15512   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15513   by $primary_hostname \
15514   ${if def:received_protocol {with $received_protocol}} \
15515   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15516   (Exim $version_number)\n\t\
15517   ${if def:sender_address \
15518   {(envelope-from <$sender_address>)\n\t}}\
15519   id $message_exim_id\
15520   ${if def:received_for {\n\tfor $received_for}}
15521 .endd
15522
15523 The reference to the TLS cipher is omitted when Exim is built without TLS
15524 support. The use of conditional expansions ensures that this works for both
15525 locally generated messages and messages received from remote hosts, giving
15526 header lines such as the following:
15527 .code
15528 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15529 by marley.carol.example with esmtp (Exim 4.00)
15530 (envelope-from <bob@carol.example>)
15531 id 16IOWa-00019l-00
15532 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15533 Received: by scrooge.carol.example with local (Exim 4.00)
15534 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15535 .endd
15536 Until the body of the message has been received, the timestamp is the time when
15537 the message started to be received. Once the body has arrived, and all policy
15538 checks have taken place, the timestamp is updated to the time at which the
15539 message was accepted.
15540
15541
15542 .option received_headers_max main integer 30
15543 .cindex "loop" "prevention"
15544 .cindex "mail loop prevention"
15545 .cindex "&'Received:'& header line" "counting"
15546 When a message is to be delivered, the number of &'Received:'& headers is
15547 counted, and if it is greater than this parameter, a mail loop is assumed to
15548 have occurred, the delivery is abandoned, and an error message is generated.
15549 This applies to both local and remote deliveries.
15550
15551
15552 .option recipient_unqualified_hosts main "host list&!!" unset
15553 .cindex "unqualified addresses"
15554 .cindex "host" "unqualified addresses from"
15555 This option lists those hosts from which Exim is prepared to accept unqualified
15556 recipient addresses in message envelopes. The addresses are made fully
15557 qualified by the addition of the &%qualify_recipient%& value. This option also
15558 affects message header lines. Exim does not reject unqualified recipient
15559 addresses in headers, but it qualifies them only if the message came from a
15560 host that matches &%recipient_unqualified_hosts%&,
15561 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15562 option was not set.
15563
15564
15565 .option recipients_max main integer 0
15566 .cindex "limit" "number of recipients"
15567 .cindex "recipient" "maximum number"
15568 If this option is set greater than zero, it specifies the maximum number of
15569 original recipients for any message. Additional recipients that are generated
15570 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15571 all recipients over the limit; earlier recipients are delivered as normal.
15572 Non-SMTP messages with too many recipients are failed, and no deliveries are
15573 done.
15574
15575 .cindex "RCPT" "maximum number of incoming"
15576 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15577 RCPT commands in a single message.
15578
15579
15580 .option recipients_max_reject main boolean false
15581 If this option is set true, Exim rejects SMTP messages containing too many
15582 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15583 error to the eventual DATA command. Otherwise (the default) it gives a 452
15584 error to the surplus RCPT commands and accepts the message on behalf of the
15585 initial set of recipients. The remote server should then re-send the message
15586 for the remaining recipients at a later time.
15587
15588
15589 .option remote_max_parallel main integer 2
15590 .cindex "delivery" "parallelism for remote"
15591 This option controls parallel delivery of one message to a number of remote
15592 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15593 does all the remote deliveries for a message one by one. Otherwise, if a single
15594 message has to be delivered to more than one remote host, or if several copies
15595 have to be sent to the same remote host, up to &%remote_max_parallel%&
15596 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15597 deliveries are required, the maximum number of processes are started, and as
15598 each one finishes, another is begun. The order of starting processes is the
15599 same as if sequential delivery were being done, and can be controlled by the
15600 &%remote_sort_domains%& option. If parallel delivery takes place while running
15601 with debugging turned on, the debugging output from each delivery process is
15602 tagged with its process id.
15603
15604 This option controls only the maximum number of parallel deliveries for one
15605 message in one Exim delivery process. Because Exim has no central queue
15606 manager, there is no way of controlling the total number of simultaneous
15607 deliveries if the configuration allows a delivery attempt as soon as a message
15608 is received.
15609
15610 .cindex "number of deliveries"
15611 .cindex "delivery" "maximum number of"
15612 If you want to control the total number of deliveries on the system, you
15613 need to set the &%queue_only%& option. This ensures that all incoming messages
15614 are added to the queue without starting a delivery process. Then set up an Exim
15615 daemon to start queue runner processes at appropriate intervals (probably
15616 fairly often, for example, every minute), and limit the total number of queue
15617 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15618 delivers only one message at a time, the maximum number of deliveries that can
15619 then take place at once is &%queue_run_max%& multiplied by
15620 &%remote_max_parallel%&.
15621
15622 If it is purely remote deliveries you want to control, use
15623 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15624 doing the SMTP routing before queueing, so that several messages for the same
15625 host will eventually get delivered down the same connection.
15626
15627
15628 .option remote_sort_domains main "domain list&!!" unset
15629 .cindex "sorting remote deliveries"
15630 .cindex "delivery" "sorting remote"
15631 When there are a number of remote deliveries for a message, they are sorted by
15632 domain into the order given by this list. For example,
15633 .code
15634 remote_sort_domains = *.cam.ac.uk:*.uk
15635 .endd
15636 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15637 then to those in the &%uk%& domain, then to any others.
15638
15639
15640 .option retry_data_expire main time 7d
15641 .cindex "hints database" "data expiry"
15642 This option sets a &"use before"& time on retry information in Exim's hints
15643 database. Any older retry data is ignored. This means that, for example, once a
15644 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15645 past failures.
15646
15647
15648 .option retry_interval_max main time 24h
15649 .cindex "retry" "limit on interval"
15650 .cindex "limit" "on retry interval"
15651 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15652 intervals between delivery attempts for messages that cannot be delivered
15653 straight away. This option sets an overall limit to the length of time between
15654 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15655 the default value.
15656
15657
15658 .option return_path_remove main boolean true
15659 .cindex "&'Return-path:'& header line" "removing"
15660 RFC 2821, section 4.4, states that an SMTP server must insert a
15661 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15662 The &'Return-path:'& header preserves the sender address as received in the
15663 MAIL command. This description implies that this header should not be present
15664 in an incoming message. If &%return_path_remove%& is true, any existing
15665 &'Return-path:'& headers are removed from messages at the time they are
15666 received. Exim's transports have options for adding &'Return-path:'& headers at
15667 the time of delivery. They are normally used only for final local deliveries.
15668
15669
15670 .option return_size_limit main integer 100K
15671 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15672
15673
15674 .new
15675 .option rfc1413_hosts main "host list&!!" @[]
15676 .cindex "RFC 1413"
15677 .cindex "host" "for RFC 1413 calls"
15678 RFC 1413 identification calls are made to any client host which matches
15679 an item in the list.
15680 The default value specifies just this host, being any local interface
15681 for the system.
15682 .wen
15683
15684 .new
15685 .option rfc1413_query_timeout main time 0s
15686 .wen
15687 .cindex "RFC 1413" "query timeout"
15688 .cindex "timeout" "for RFC 1413 call"
15689 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15690 no RFC 1413 calls are ever made.
15691
15692
15693 .option sender_unqualified_hosts main "host list&!!" unset
15694 .cindex "unqualified addresses"
15695 .cindex "host" "unqualified addresses from"
15696 This option lists those hosts from which Exim is prepared to accept unqualified
15697 sender addresses. The addresses are made fully qualified by the addition of
15698 &%qualify_domain%&. This option also affects message header lines. Exim does
15699 not reject unqualified addresses in headers that contain sender addresses, but
15700 it qualifies them only if the message came from a host that matches
15701 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15702 using TCP/IP), and the &%-bnq%& option was not set.
15703
15704
15705 .option smtp_accept_keepalive main boolean true
15706 .cindex "keepalive" "on incoming connection"
15707 This option controls the setting of the SO_KEEPALIVE option on incoming
15708 TCP/IP socket connections. When set, it causes the kernel to probe idle
15709 connections periodically, by sending packets with &"old"& sequence numbers. The
15710 other end of the connection should send an acknowledgment if the connection is
15711 still okay or a reset if the connection has been aborted. The reason for doing
15712 this is that it has the beneficial effect of freeing up certain types of
15713 connection that can get stuck when the remote host is disconnected without
15714 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15715 hours to detect unreachable hosts.
15716
15717
15718
15719 .option smtp_accept_max main integer 20
15720 .cindex "limit" "incoming SMTP connections"
15721 .cindex "SMTP" "incoming connection count"
15722 .cindex "inetd"
15723 This option specifies the maximum number of simultaneous incoming SMTP calls
15724 that Exim will accept. It applies only to the listening daemon; there is no
15725 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15726 value is set to zero, no limit is applied. However, it is required to be
15727 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15728 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15729
15730 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15731 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15732 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15733 and &%smtp_load_reserve%& are then checked before accepting the connection.
15734
15735
15736 .option smtp_accept_max_nonmail main integer 10
15737 .cindex "limit" "non-mail SMTP commands"
15738 .cindex "SMTP" "limiting non-mail commands"
15739 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15740 the connection if there are too many. This option defines &"too many"&. The
15741 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15742 client looping sending EHLO, for example. The check is applied only if the
15743 client host matches &%smtp_accept_max_nonmail_hosts%&.
15744
15745 When a new message is expected, one occurrence of RSET is not counted. This
15746 allows a client to send one RSET between messages (this is not necessary,
15747 but some clients do it). Exim also allows one uncounted occurrence of HELO
15748 or EHLO, and one occurrence of STARTTLS between messages. After
15749 starting up a TLS session, another EHLO is expected, and so it too is not
15750 counted. The first occurrence of AUTH in a connection, or immediately
15751 following STARTTLS is not counted. Otherwise, all commands other than
15752 MAIL, RCPT, DATA, and QUIT are counted.
15753
15754
15755 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15756 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15757 check by setting this option. The default value makes it apply to all hosts. By
15758 changing the value, you can exclude any badly-behaved hosts that you have to
15759 live with.
15760
15761
15762 . Allow this long option name to split; give it unsplit as a fifth argument
15763 . for the automatic .oindex that is generated by .option.
15764 . We insert " &~&~" which is both pretty nasty visually and results in
15765 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15766 . zero-width-space, which would be nicer visually and results in (at least)
15767 . html that Firefox will split on when it's forced to reflow (rather than
15768 . inserting a horizontal scrollbar).  However, the text is still not
15769 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15770 . the option name to split.
15771
15772 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15773          smtp_accept_max_per_connection
15774 .cindex "SMTP" "limiting incoming message count"
15775 .cindex "limit" "messages per SMTP connection"
15776 The value of this option limits the number of MAIL commands that Exim is
15777 prepared to accept over a single SMTP connection, whether or not each command
15778 results in the transfer of a message. After the limit is reached, a 421
15779 response is given to subsequent MAIL commands. This limit is a safety
15780 precaution against a client that goes mad (incidents of this type have been
15781 seen).
15782
15783
15784 .option smtp_accept_max_per_host main string&!! unset
15785 .cindex "limit" "SMTP connections from one host"
15786 .cindex "host" "limiting SMTP connections from"
15787 This option restricts the number of simultaneous IP connections from a single
15788 host (strictly, from a single IP address) to the Exim daemon. The option is
15789 expanded, to enable different limits to be applied to different hosts by
15790 reference to &$sender_host_address$&. Once the limit is reached, additional
15791 connection attempts from the same host are rejected with error code 421. This
15792 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15793 of zero imposes no limit. If this option is set greater than zero, it is
15794 required that &%smtp_accept_max%& be non-zero.
15795
15796 &*Warning*&: When setting this option you should not use any expansion
15797 constructions that take an appreciable amount of time. The expansion and test
15798 happen in the main daemon loop, in order to reject additional connections
15799 without forking additional processes (otherwise a denial-of-service attack
15800 could cause a vast number or processes to be created). While the daemon is
15801 doing this processing, it cannot accept any other incoming connections.
15802
15803
15804
15805 .option smtp_accept_queue main integer 0
15806 .cindex "SMTP" "incoming connection count"
15807 .cindex "queueing incoming messages"
15808 .cindex "message" "queueing by SMTP connection count"
15809 If the number of simultaneous incoming SMTP connections being handled via the
15810 listening daemon exceeds this value, messages received by SMTP are just placed
15811 on the queue; no delivery processes are started automatically. The count is
15812 fixed at the start of an SMTP connection. It cannot be updated in the
15813 subprocess that receives messages, and so the queueing or not queueing applies
15814 to all messages received in the same connection.
15815
15816 A value of zero implies no limit, and clearly any non-zero value is useful only
15817 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15818 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15819 various &%-od%&&'x'& command line options.
15820
15821
15822 . See the comment on smtp_accept_max_per_connection
15823
15824 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15825          smtp_accept_queue_per_connection
15826 .cindex "queueing incoming messages"
15827 .cindex "message" "queueing by message count"
15828 This option limits the number of delivery processes that Exim starts
15829 automatically when receiving messages via SMTP, whether via the daemon or by
15830 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15831 and the number of messages received in a single SMTP session exceeds this
15832 number, subsequent messages are placed on the queue, but no delivery processes
15833 are started. This helps to limit the number of Exim processes when a server
15834 restarts after downtime and there is a lot of mail waiting for it on other
15835 systems. On large systems, the default should probably be increased, and on
15836 dial-in client systems it should probably be set to zero (that is, disabled).
15837
15838
15839 .option smtp_accept_reserve main integer 0
15840 .cindex "SMTP" "incoming call count"
15841 .cindex "host" "reserved"
15842 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15843 number of SMTP connections that are reserved for connections from the hosts
15844 that are specified in &%smtp_reserve_hosts%&. The value set in
15845 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15846 restricted to this number of connections; the option specifies a minimum number
15847 of connection slots for them, not a maximum. It is a guarantee that this group
15848 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15849 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15850 individual host.
15851
15852 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15853 set to 5, once there are 45 active connections (from any hosts), new
15854 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15855 provided the other criteria for acceptance are met.
15856
15857
15858 .option smtp_active_hostname main string&!! unset
15859 .cindex "host" "name in SMTP responses"
15860 .cindex "SMTP" "host name in responses"
15861 .vindex "&$primary_hostname$&"
15862 This option is provided for multi-homed servers that want to masquerade as
15863 several different hosts. At the start of an incoming SMTP connection, its value
15864 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15865 responses. For example, it is used as domain name in the response to an
15866 incoming HELO or EHLO command.
15867
15868 .vindex "&$smtp_active_hostname$&"
15869 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15870 is saved with any messages that are received. It is therefore available for use
15871 in routers and transports when the message is later delivered.
15872
15873 If this option is unset, or if its expansion is forced to fail, or if the
15874 expansion results in an empty string, the value of &$primary_hostname$& is
15875 used. Other expansion failures cause a message to be written to the main and
15876 panic logs, and the SMTP command receives a temporary error. Typically, the
15877 value of &%smtp_active_hostname%& depends on the incoming interface address.
15878 For example:
15879 .code
15880 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15881   {cox.mydomain}{box.mydomain}}
15882 .endd
15883
15884 Although &$smtp_active_hostname$& is primarily concerned with incoming
15885 messages, it is also used as the default for HELO commands in callout
15886 verification if there is no remote transport from which to obtain a
15887 &%helo_data%& value.
15888
15889 .option smtp_banner main string&!! "see below"
15890 .cindex "SMTP" "welcome banner"
15891 .cindex "banner for SMTP"
15892 .cindex "welcome banner for SMTP"
15893 .cindex "customizing" "SMTP banner"
15894 This string, which is expanded every time it is used, is output as the initial
15895 positive response to an SMTP connection. The default setting is:
15896 .code
15897 smtp_banner = $smtp_active_hostname ESMTP Exim \
15898   $version_number $tod_full
15899 .endd
15900 Failure to expand the string causes a panic error. If you want to create a
15901 multiline response to the initial SMTP connection, use &"\n"& in the string at
15902 appropriate points, but not at the end. Note that the 220 code is not included
15903 in this string. Exim adds it automatically (several times in the case of a
15904 multiline response).
15905
15906
15907 .option smtp_check_spool_space main boolean true
15908 .cindex "checking disk space"
15909 .cindex "disk space, checking"
15910 .cindex "spool directory" "checking space"
15911 When this option is set, if an incoming SMTP session encounters the SIZE
15912 option on a MAIL command, it checks that there is enough space in the
15913 spool directory's partition to accept a message of that size, while still
15914 leaving free the amount specified by &%check_spool_space%& (even if that value
15915 is zero). If there isn't enough space, a temporary error code is returned.
15916
15917
15918 .option smtp_connect_backlog main integer 20
15919 .cindex "connection backlog"
15920 .cindex "SMTP" "connection backlog"
15921 .cindex "backlog of connections"
15922 This option specifies a maximum number of waiting SMTP connections. Exim passes
15923 this value to the TCP/IP system when it sets up its listener. Once this number
15924 of connections are waiting for the daemon's attention, subsequent connection
15925 attempts are refused at the TCP/IP level. At least, that is what the manuals
15926 say; in some circumstances such connection attempts have been observed to time
15927 out instead. For large systems it is probably a good idea to increase the
15928 value (to 50, say). It also gives some protection against denial-of-service
15929 attacks by SYN flooding.
15930
15931
15932 .option smtp_enforce_sync main boolean true
15933 .cindex "SMTP" "synchronization checking"
15934 .cindex "synchronization checking in SMTP"
15935 The SMTP protocol specification requires the client to wait for a response from
15936 the server at certain points in the dialogue. Without PIPELINING these
15937 synchronization points are after every command; with PIPELINING they are
15938 fewer, but they still exist.
15939
15940 Some spamming sites send out a complete set of SMTP commands without waiting
15941 for any response. Exim protects against this by rejecting a message if the
15942 client has sent further input when it should not have. The error response &"554
15943 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15944 for this error cannot be perfect because of transmission delays (unexpected
15945 input may be on its way but not yet received when Exim checks). However, it
15946 does detect many instances.
15947
15948 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15949 If you want to disable the check selectively (for example, only for certain
15950 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15951 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15952
15953
15954
15955 .option smtp_etrn_command main string&!! unset
15956 .cindex "ETRN" "command to be run"
15957 .vindex "&$domain$&"
15958 If this option is set, the given command is run whenever an SMTP ETRN
15959 command is received from a host that is permitted to issue such commands (see
15960 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15961 are independently expanded. The expansion variable &$domain$& is set to the
15962 argument of the ETRN command, and no syntax checking is done on it. For
15963 example:
15964 .code
15965 smtp_etrn_command = /etc/etrn_command $domain \
15966                     $sender_host_address
15967 .endd
15968 A new process is created to run the command, but Exim does not wait for it to
15969 complete. Consequently, its status cannot be checked. If the command cannot be
15970 run, a line is written to the panic log, but the ETRN caller still receives
15971 a 250 success response. Exim is normally running under its own uid when
15972 receiving SMTP, so it is not possible for it to change the uid before running
15973 the command.
15974
15975
15976 .option smtp_etrn_serialize main boolean true
15977 .cindex "ETRN" "serializing"
15978 When this option is set, it prevents the simultaneous execution of more than
15979 one identical command as a result of ETRN in an SMTP connection. See
15980 section &<<SECTETRN>>& for details.
15981
15982
15983 .option smtp_load_reserve main fixed-point unset
15984 .cindex "load average"
15985 If the system load average ever gets higher than this, incoming SMTP calls are
15986 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15987 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15988 the load is over the limit. The option has no effect on ancient operating
15989 systems on which Exim cannot determine the load average. See also
15990 &%deliver_queue_load_max%& and &%queue_only_load%&.
15991
15992
15993
15994 .option smtp_max_synprot_errors main integer 3
15995 .cindex "SMTP" "limiting syntax and protocol errors"
15996 .cindex "limit" "SMTP syntax and protocol errors"
15997 Exim rejects SMTP commands that contain syntax or protocol errors. In
15998 particular, a syntactically invalid email address, as in this command:
15999 .code
16000 RCPT TO:<abc xyz@a.b.c>
16001 .endd
16002 causes immediate rejection of the command, before any other tests are done.
16003 (The ACL cannot be run if there is no valid address to set up for it.) An
16004 example of a protocol error is receiving RCPT before MAIL. If there are
16005 too many syntax or protocol errors in one SMTP session, the connection is
16006 dropped. The limit is set by this option.
16007
16008 .cindex "PIPELINING" "expected errors"
16009 When the PIPELINING extension to SMTP is in use, some protocol errors are
16010 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16011 Exim assumes that PIPELINING will be used if it advertises it (see
16012 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16013 not count towards the limit.
16014
16015
16016
16017 .option smtp_max_unknown_commands main integer 3
16018 .cindex "SMTP" "limiting unknown commands"
16019 .cindex "limit" "unknown SMTP commands"
16020 If there are too many unrecognized commands in an incoming SMTP session, an
16021 Exim server drops the connection. This is a defence against some kinds of abuse
16022 that subvert web
16023 clients
16024 into making connections to SMTP ports; in these circumstances, a number of
16025 non-SMTP command lines are sent first.
16026
16027
16028
16029 .option smtp_ratelimit_hosts main "host list&!!" unset
16030 .cindex "SMTP" "rate limiting"
16031 .cindex "limit" "rate of message arrival"
16032 .cindex "RCPT" "rate limiting"
16033 Some sites find it helpful to be able to limit the rate at which certain hosts
16034 can send them messages, and the rate at which an individual message can specify
16035 recipients.
16036
16037 Exim has two rate-limiting facilities. This section describes the older
16038 facility, which can limit rates within a single connection. The newer
16039 &%ratelimit%& ACL condition can limit rates across all connections. See section
16040 &<<SECTratelimiting>>& for details of the newer facility.
16041
16042 When a host matches &%smtp_ratelimit_hosts%&, the values of
16043 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16044 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16045 respectively. Each option, if set, must contain a set of four comma-separated
16046 values:
16047
16048 .ilist
16049 A threshold, before which there is no rate limiting.
16050 .next
16051 An initial time delay. Unlike other times in Exim, numbers with decimal
16052 fractional parts are allowed here.
16053 .next
16054 A factor by which to increase the delay each time.
16055 .next
16056 A maximum value for the delay. This should normally be less than 5 minutes,
16057 because after that time, the client is liable to timeout the SMTP command.
16058 .endlist
16059
16060 For example, these settings have been used successfully at the site which
16061 first suggested this feature, for controlling mail from their customers:
16062 .code
16063 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16064 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16065 .endd
16066 The first setting specifies delays that are applied to MAIL commands after
16067 two have been received over a single connection. The initial delay is 0.5
16068 seconds, increasing by a factor of 1.05 each time. The second setting applies
16069 delays to RCPT commands when more than four occur in a single message.
16070
16071
16072 .option smtp_ratelimit_mail main string unset
16073 See &%smtp_ratelimit_hosts%& above.
16074
16075
16076 .option smtp_ratelimit_rcpt main string unset
16077 See &%smtp_ratelimit_hosts%& above.
16078
16079
16080 .option smtp_receive_timeout main time 5m
16081 .cindex "timeout" "for SMTP input"
16082 .cindex "SMTP" "input timeout"
16083 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16084 input, including batch SMTP. If a line of input (either an SMTP command or a
16085 data line) is not received within this time, the SMTP connection is dropped and
16086 the message is abandoned.
16087 A line is written to the log containing one of the following messages:
16088 .code
16089 SMTP command timeout on connection from...
16090 SMTP data timeout on connection from...
16091 .endd
16092 The former means that Exim was expecting to read an SMTP command; the latter
16093 means that it was in the DATA phase, reading the contents of a message.
16094
16095
16096 .oindex "&%-os%&"
16097 The value set by this option can be overridden by the
16098 &%-os%& command-line option. A setting of zero time disables the timeout, but
16099 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16100 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16101 timeout is controlled by &%receive_timeout%& and &%-or%&.
16102
16103
16104 .option smtp_reserve_hosts main "host list&!!" unset
16105 This option defines hosts for which SMTP connections are reserved; see
16106 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16107
16108
16109 .option smtp_return_error_details main boolean false
16110 .cindex "SMTP" "details policy failures"
16111 .cindex "policy control" "rejection, returning details"
16112 In the default state, Exim uses bland messages such as
16113 &"Administrative prohibition"& when it rejects SMTP commands for policy
16114 reasons. Many sysadmins like this because it gives away little information
16115 to spammers. However, some other sysadmins who are applying strict checking
16116 policies want to give out much fuller information about failures. Setting
16117 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16118 example, instead of &"Administrative prohibition"&, it might give:
16119 .code
16120 550-Rejected after DATA: '>' missing at end of address:
16121 550 failing address in "From" header is: <user@dom.ain
16122 .endd
16123
16124 .option spamd_address main string "see below"
16125 This option is available when Exim is compiled with the content-scanning
16126 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16127 The default value is
16128 .code
16129 127.0.0.1 783
16130 .endd
16131 See section &<<SECTscanspamass>>& for more details.
16132
16133
16134
16135 .option split_spool_directory main boolean false
16136 .cindex "multiple spool directories"
16137 .cindex "spool directory" "split"
16138 .cindex "directories, multiple"
16139 If this option is set, it causes Exim to split its input directory into 62
16140 subdirectories, each with a single alphanumeric character as its name. The
16141 sixth character of the message id is used to allocate messages to
16142 subdirectories; this is the least significant base-62 digit of the time of
16143 arrival of the message.
16144
16145 Splitting up the spool in this way may provide better performance on systems
16146 where there are long mail queues, by reducing the number of files in any one
16147 directory. The msglog directory is also split up in a similar way to the input
16148 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16149 are still placed in the single directory &_msglog.OLD_&.
16150
16151 It is not necessary to take any special action for existing messages when
16152 changing &%split_spool_directory%&. Exim notices messages that are in the
16153 &"wrong"& place, and continues to process them. If the option is turned off
16154 after a period of being on, the subdirectories will eventually empty and be
16155 automatically deleted.
16156
16157 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16158 changes. Instead of creating a list of all messages in the queue, and then
16159 trying to deliver each one in turn, it constructs a list of those in one
16160 sub-directory and tries to deliver them, before moving on to the next
16161 sub-directory. The sub-directories are processed in a random order. This
16162 spreads out the scanning of the input directories, and uses less memory. It is
16163 particularly beneficial when there are lots of messages on the queue. However,
16164 if &%queue_run_in_order%& is set, none of this new processing happens. The
16165 entire queue has to be scanned and sorted before any deliveries can start.
16166
16167
16168 .option spool_directory main string&!! "set at compile time"
16169 .cindex "spool directory" "path to"
16170 This defines the directory in which Exim keeps its spool, that is, the messages
16171 it is waiting to deliver. The default value is taken from the compile-time
16172 configuration setting, if there is one. If not, this option must be set. The
16173 string is expanded, so it can contain, for example, a reference to
16174 &$primary_hostname$&.
16175
16176 If the spool directory name is fixed on your installation, it is recommended
16177 that you set it at build time rather than from this option, particularly if the
16178 log files are being written to the spool directory (see &%log_file_path%&).
16179 Otherwise log files cannot be used for errors that are detected early on, such
16180 as failures in the configuration file.
16181
16182 By using this option to override the compiled-in path, it is possible to run
16183 tests of Exim without using the standard spool.
16184
16185 .option sqlite_lock_timeout main time 5s
16186 .cindex "sqlite lookup type" "lock timeout"
16187 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16188 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16189
16190 .option strict_acl_vars main boolean false
16191 .cindex "&ACL;" "variables, handling unset"
16192 This option controls what happens if a syntactically valid but undefined ACL
16193 variable is referenced. If it is false (the default), an empty string
16194 is substituted; if it is true, an error is generated. See section
16195 &<<SECTaclvariables>>& for details of ACL variables.
16196
16197 .option strip_excess_angle_brackets main boolean false
16198 .cindex "angle brackets, excess"
16199 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16200 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16201 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16202 passed on to another MTA, the excess angle brackets are not passed on. If this
16203 option is not set, multiple pairs of angle brackets cause a syntax error.
16204
16205
16206 .option strip_trailing_dot main boolean false
16207 .cindex "trailing dot on domain"
16208 .cindex "dot" "trailing on domain"
16209 If this option is set, a trailing dot at the end of a domain in an address is
16210 ignored. If this is in the envelope and the message is passed on to another
16211 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16212 domain causes a syntax error.
16213 However, addresses in header lines are checked only when an ACL requests header
16214 syntax checking.
16215
16216
16217 .option syslog_duplication main boolean true
16218 .cindex "syslog" "duplicate log lines; suppressing"
16219 When Exim is logging to syslog, it writes the log lines for its three
16220 separate logs at different syslog priorities so that they can in principle
16221 be separated on the logging hosts. Some installations do not require this
16222 separation, and in those cases, the duplication of certain log lines is a
16223 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16224 particular log line is written to syslog. For lines that normally go to
16225 both the main log and the reject log, the reject log version (possibly
16226 containing message header lines) is written, at LOG_NOTICE priority.
16227 Lines that normally go to both the main and the panic log are written at
16228 the LOG_ALERT priority.
16229
16230
16231 .option syslog_facility main string unset
16232 .cindex "syslog" "facility; setting"
16233 This option sets the syslog &"facility"& name, used when Exim is logging to
16234 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16235 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16236 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16237 details of Exim's logging.
16238
16239
16240
16241 .option syslog_processname main string &`exim`&
16242 .cindex "syslog" "process name; setting"
16243 This option sets the syslog &"ident"& name, used when Exim is logging to
16244 syslog. The value must be no longer than 32 characters. See chapter
16245 &<<CHAPlog>>& for details of Exim's logging.
16246
16247
16248
16249 .option syslog_timestamp main boolean true
16250 .cindex "syslog" "timestamps"
16251 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16252 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16253 details of Exim's logging.
16254
16255
16256 .option system_filter main string&!! unset
16257 .cindex "filter" "system filter"
16258 .cindex "system filter" "specifying"
16259 .cindex "Sieve filter" "not available for system filter"
16260 This option specifies an Exim filter file that is applied to all messages at
16261 the start of each delivery attempt, before any routing is done. System filters
16262 must be Exim filters; they cannot be Sieve filters. If the system filter
16263 generates any deliveries to files or pipes, or any new mail messages, the
16264 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16265 which transports are to be used. Details of this facility are given in chapter
16266 &<<CHAPsystemfilter>>&.
16267
16268
16269 .option system_filter_directory_transport main string&!! unset
16270 .vindex "&$address_file$&"
16271 This sets the name of the transport driver that is to be used when the
16272 &%save%& command in a system message filter specifies a path ending in &"/"&,
16273 implying delivery of each message into a separate file in some directory.
16274 During the delivery, the variable &$address_file$& contains the path name.
16275
16276
16277 .option system_filter_file_transport main string&!! unset
16278 .cindex "file" "transport for system filter"
16279 This sets the name of the transport driver that is to be used when the &%save%&
16280 command in a system message filter specifies a path not ending in &"/"&. During
16281 the delivery, the variable &$address_file$& contains the path name.
16282
16283 .option system_filter_group main string unset
16284 .cindex "gid (group id)" "system filter"
16285 This option is used only when &%system_filter_user%& is also set. It sets the
16286 gid under which the system filter is run, overriding any gid that is associated
16287 with the user. The value may be numerical or symbolic.
16288
16289 .option system_filter_pipe_transport main string&!! unset
16290 .cindex "&(pipe)& transport" "for system filter"
16291 .vindex "&$address_pipe$&"
16292 This specifies the transport driver that is to be used when a &%pipe%& command
16293 is used in a system filter. During the delivery, the variable &$address_pipe$&
16294 contains the pipe command.
16295
16296
16297 .option system_filter_reply_transport main string&!! unset
16298 .cindex "&(autoreply)& transport" "for system filter"
16299 This specifies the transport driver that is to be used when a &%mail%& command
16300 is used in a system filter.
16301
16302
16303 .option system_filter_user main string unset
16304 .cindex "uid (user id)" "system filter"
16305 If this option is set to root, the system filter is run in the main Exim
16306 delivery process, as root.  Otherwise, the system filter runs in a separate
16307 process, as the given user, defaulting to the Exim run-time user.
16308 Unless the string consists entirely of digits, it
16309 is looked up in the password data. Failure to find the named user causes a
16310 configuration error. The gid is either taken from the password data, or
16311 specified by &%system_filter_group%&. When the uid is specified numerically,
16312 &%system_filter_group%& is required to be set.
16313
16314 If the system filter generates any pipe, file, or reply deliveries, the uid
16315 under which the filter is run is used when transporting them, unless a
16316 transport option overrides.
16317
16318
16319 .option tcp_nodelay main boolean true
16320 .cindex "daemon" "TCP_NODELAY on sockets"
16321 .cindex "Nagle algorithm"
16322 .cindex "TCP_NODELAY on listening sockets"
16323 If this option is set false, it stops the Exim daemon setting the
16324 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16325 turns off the &"Nagle algorithm"&, which is a way of improving network
16326 performance in interactive (character-by-character) situations. Turning it off
16327 should improve Exim's performance a bit, so that is what happens by default.
16328 However, it appears that some broken clients cannot cope, and time out. Hence
16329 this option. It affects only those sockets that are set up for listening by the
16330 daemon. Sockets created by the smtp transport for delivering mail always set
16331 TCP_NODELAY.
16332
16333
16334 .option timeout_frozen_after main time 0s
16335 .cindex "frozen messages" "timing out"
16336 .cindex "timeout" "frozen messages"
16337 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16338 message of any kind that has been on the queue for longer than the given time
16339 is automatically cancelled at the next queue run. If the frozen message is a
16340 bounce message, it is just discarded; otherwise, a bounce is sent to the
16341 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16342 If you want to timeout frozen bounce messages earlier than other kinds of
16343 frozen message, see &%ignore_bounce_errors_after%&.
16344
16345 &*Note:*& the default value of zero means no timeouts; with this setting,
16346 frozen messages remain on the queue forever (except for any frozen bounce
16347 messages that are released by &%ignore_bounce_errors_after%&).
16348
16349
16350 .option timezone main string unset
16351 .cindex "timezone, setting"
16352 The value of &%timezone%& is used to set the environment variable TZ while
16353 running Exim (if it is different on entry). This ensures that all timestamps
16354 created by Exim are in the required timezone. If you want all your timestamps
16355 to be in UTC (aka GMT) you should set
16356 .code
16357 timezone = UTC
16358 .endd
16359 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16360 or, if that is not set, from the value of the TZ environment variable when Exim
16361 is built. If &%timezone%& is set to the empty string, either at build or run
16362 time, any existing TZ variable is removed from the environment when Exim
16363 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16364 unfortunately not all, operating systems.
16365
16366
16367 .option tls_advertise_hosts main "host list&!!" unset
16368 .cindex "TLS" "advertising"
16369 .cindex "encryption" "on SMTP connection"
16370 .cindex "SMTP" "encrypted connection"
16371 When Exim is built with support for TLS encrypted connections, the availability
16372 of the STARTTLS command to set up an encrypted session is advertised in
16373 response to EHLO only to those client hosts that match this option. See
16374 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16375
16376
16377 .option tls_certificate main string&!! unset
16378 .cindex "TLS" "server certificate; location of"
16379 .cindex "certificate" "server, location of"
16380 The value of this option is expanded, and must then be the absolute path to a
16381 file which contains the server's certificates. The server's private key is also
16382 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16383 &<<CHAPTLS>>& for further details.
16384
16385 &*Note*&: The certificates defined by this option are used only when Exim is
16386 receiving incoming messages as a server. If you want to supply certificates for
16387 use when sending messages as a client, you must set the &%tls_certificate%&
16388 option in the relevant &(smtp)& transport.
16389
16390 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16391 if the OpenSSL build supports TLS extensions and the TLS client sends the
16392 Server Name Indication extension, then this option and others documented in
16393 &<<SECTtlssni>>& will be re-expanded.
16394
16395 .option tls_crl main string&!! unset
16396 .cindex "TLS" "server certificate revocation list"
16397 .cindex "certificate" "revocation list for server"
16398 This option specifies a certificate revocation list. The expanded value must
16399 be the name of a file that contains a CRL in PEM format.
16400
16401 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16402
16403
16404 .option tls_dh_max_bits main integer 2236
16405 .cindex "TLS" "D-H bit count"
16406 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16407 the chosen TLS library.  That value might prove to be too high for
16408 interoperability.  This option provides a maximum clamp on the value
16409 suggested, trading off security for interoperability.
16410
16411 The value must be at least 1024.
16412
16413 The value 2236 was chosen because, at time of adding the option, it was the
16414 hard-coded maximum value supported by the NSS cryptographic library, as used
16415 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16416
16417 If you prefer more security and are willing to break some clients, raise this
16418 number.
16419
16420 Note that the value passed to GnuTLS for *generating* a new prime may be a
16421 little less than this figure, because GnuTLS is inexact and may produce a
16422 larger prime than requested.
16423
16424
16425 .option tls_dhparam main string&!! unset
16426 .cindex "TLS" "D-H parameters for server"
16427 The value of this option is expanded and indicates the source of DH parameters
16428 to be used by Exim.
16429
16430 If it is a filename starting with a &`/`&, then it names a file from which DH
16431 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16432 PKCS#3 representation of the DH prime.  If the file does not exist, for
16433 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16434 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16435 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16436 and treated as though the &%tls_dhparam%& were set to "none".
16437
16438 If this option expands to the string "none", then no DH parameters will be
16439 loaded by Exim.
16440
16441 If this option expands to the string "historic" and Exim is using GnuTLS, then
16442 Exim will attempt to load a file from inside the spool directory.  If the file
16443 does not exist, Exim will attempt to create it.
16444 See section &<<SECTgnutlsparam>>& for further details.
16445
16446 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16447 a default DH prime; the default is the 2048 bit prime described in section
16448 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16449 in IKE is assigned number 23.
16450
16451 Otherwise, the option must expand to the name used by Exim for any of a number
16452 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16453 "ike" followed by the number used by IKE, of "default" which corresponds to
16454 "ike23".
16455
16456 The available primes are:
16457 &`ike1`&, &`ike2`&, &`ike5`&,
16458 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16459 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16460
16461 Some of these will be too small to be accepted by clients.
16462 Some may be too large to be accepted by clients.
16463
16464 The TLS protocol does not negotiate an acceptable size for this; clients tend
16465 to hard-drop connections if what is offered by the server is unacceptable,
16466 whether too large or too small, and there's no provision for the client to
16467 tell the server what these constraints are.  Thus, as a server operator, you
16468 need to make an educated guess as to what is most likely to work for your
16469 userbase.
16470
16471 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16472 is most likely to maximise interoperability.  The upper bound comes from
16473 applications using the Mozilla Network Security Services (NSS) library, which
16474 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16475 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16476 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16477 acceptable bound from 1024 to 2048.
16478
16479
16480 .option tls_ocsp_file main string&!! unset
16481 This option
16482 must if set expand to the absolute path to a file which contains a current
16483 status proof for the server's certificate, as obtained from the
16484 Certificate Authority.
16485
16486
16487 .option tls_on_connect_ports main "string list" unset
16488 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16489 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16490 set up without waiting for the client to issue a STARTTLS command. For
16491 further details, see section &<<SECTsupobssmt>>&.
16492
16493
16494
16495 .option tls_privatekey main string&!! unset
16496 .cindex "TLS" "server private key; location of"
16497 The value of this option is expanded, and must then be the absolute path to a
16498 file which contains the server's private key. If this option is unset, or if
16499 the expansion is forced to fail, or the result is an empty string, the private
16500 key is assumed to be in the same file as the server's certificates. See chapter
16501 &<<CHAPTLS>>& for further details.
16502
16503 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16504
16505
16506 .option tls_remember_esmtp main boolean false
16507 .cindex "TLS" "esmtp state; remembering"
16508 .cindex "TLS" "broken clients"
16509 If this option is set true, Exim violates the RFCs by remembering that it is in
16510 &"esmtp"& state after successfully negotiating a TLS session. This provides
16511 support for broken clients that fail to send a new EHLO after starting a
16512 TLS session.
16513
16514
16515 .option tls_require_ciphers main string&!! unset
16516 .cindex "TLS" "requiring specific ciphers"
16517 .cindex "cipher" "requiring specific"
16518 This option controls which ciphers can be used for incoming TLS connections.
16519 The &(smtp)& transport has an option of the same name for controlling outgoing
16520 connections. This option is expanded for each connection, so can be varied for
16521 different clients if required. The value of this option must be a list of
16522 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16523 in somewhat different ways. If GnuTLS is being used, the client controls the
16524 preference order of the available ciphers. Details are given in sections
16525 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16526
16527
16528 .option tls_try_verify_hosts main "host list&!!" unset
16529 .cindex "TLS" "client certificate verification"
16530 .cindex "certificate" "verification of client"
16531 See &%tls_verify_hosts%& below.
16532
16533
16534 .new
16535 .option tls_verify_certificates main string&!! system
16536 .cindex "TLS" "client certificate verification"
16537 .cindex "certificate" "verification of client"
16538 The value of this option is expanded, and must then be either the
16539 word "system"
16540 or the absolute path to
16541 a file or directory containing permitted certificates for clients that
16542 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16543
16544 The "system" value for the option will use a
16545 system default location compiled into the SSL library.
16546 This is not available for GnuTLS versions preceding 3.0.20,
16547 and will be taken as empty; an explicit location
16548 must be specified.
16549
16550 The use of a directory for the option value is not avilable for GnuTLS versions
16551 preceding 3.3.6 and a single file must be used.
16552
16553 With OpenSSL the certificates specified
16554 explicitly
16555 either by file or directory
16556 are added to those given by the system default location.
16557 .wen
16558
16559 These certificates should be for the certificate authorities trusted, rather
16560 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16561 the value is a file then the certificates are sent by Exim as a server to
16562 connecting clients, defining the list of accepted certificate authorities.
16563 Thus the values defined should be considered public data.  To avoid this,
16564 use the explicit directory version.
16565
16566 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16567
16568 A forced expansion failure or setting to an empty string is equivalent to
16569 being unset.
16570
16571
16572 .option tls_verify_hosts main "host list&!!" unset
16573 .cindex "TLS" "client certificate verification"
16574 .cindex "certificate" "verification of client"
16575 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16576 certificates from clients. The expected certificates are defined by
16577 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16578 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16579 &%tls_verify_certificates%& is not set.
16580
16581 Any client that matches &%tls_verify_hosts%& is constrained by
16582 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16583 present one of the listed certificates. If it does not, the connection is
16584 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16585 the host to use TLS. It can still send SMTP commands through unencrypted
16586 connections. Forcing a client to use TLS has to be done separately using an
16587 ACL to reject inappropriate commands when the connection is not encrypted.
16588
16589 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16590 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16591 certificate and checks it against &%tls_verify_certificates%&, but does not
16592 abort the connection if there is no certificate or if it does not match. This
16593 state can be detected in an ACL, which makes it possible to implement policies
16594 such as &"accept for relay only if a verified certificate has been received,
16595 but accept for local delivery if encrypted, even without a verified
16596 certificate"&.
16597
16598 Client hosts that match neither of these lists are not asked to present
16599 certificates.
16600
16601
16602 .option trusted_groups main "string list&!!" unset
16603 .cindex "trusted groups"
16604 .cindex "groups" "trusted"
16605 This option is expanded just once, at the start of Exim's processing. If this
16606 option is set, any process that is running in one of the listed groups, or
16607 which has one of them as a supplementary group, is trusted. The groups can be
16608 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16609 details of what trusted callers are permitted to do. If neither
16610 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16611 are trusted.
16612
16613 .option trusted_users main "string list&!!" unset
16614 .cindex "trusted users"
16615 .cindex "user" "trusted"
16616 This option is expanded just once, at the start of Exim's processing. If this
16617 option is set, any process that is running as one of the listed users is
16618 trusted. The users can be specified numerically or by name. See section
16619 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16620 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16621 Exim user are trusted.
16622
16623 .option unknown_login main string&!! unset
16624 .cindex "uid (user id)" "unknown caller"
16625 .vindex "&$caller_uid$&"
16626 This is a specialized feature for use in unusual configurations. By default, if
16627 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16628 gives up. The &%unknown_login%& option can be used to set a login name to be
16629 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16630 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16631 is used for the user's real name (gecos field), unless this has been set by the
16632 &%-F%& option.
16633
16634 .option unknown_username main string unset
16635 See &%unknown_login%&.
16636
16637 .option untrusted_set_sender main "address list&!!" unset
16638 .cindex "trusted users"
16639 .cindex "sender" "setting by untrusted user"
16640 .cindex "untrusted user setting sender"
16641 .cindex "user" "untrusted setting sender"
16642 .cindex "envelope sender"
16643 When an untrusted user submits a message to Exim using the standard input, Exim
16644 normally creates an envelope sender address from the user's login and the
16645 default qualification domain. Data from the &%-f%& option (for setting envelope
16646 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16647 is used) is ignored.
16648
16649 However, untrusted users are permitted to set an empty envelope sender address,
16650 to declare that a message should never generate any bounces. For example:
16651 .code
16652 exim -f '<>' user@domain.example
16653 .endd
16654 .vindex "&$sender_ident$&"
16655 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16656 other envelope sender addresses in a controlled way. When it is set, untrusted
16657 users are allowed to set envelope sender addresses that match any of the
16658 patterns in the list. Like all address lists, the string is expanded. The
16659 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16660 users to setting senders that start with their login ids
16661 followed by a hyphen
16662 by a setting like this:
16663 .code
16664 untrusted_set_sender = ^$sender_ident-
16665 .endd
16666 If you want to allow untrusted users to set envelope sender addresses without
16667 restriction, you can use
16668 .code
16669 untrusted_set_sender = *
16670 .endd
16671 The &%untrusted_set_sender%& option applies to all forms of local input, but
16672 only to the setting of the envelope sender. It does not permit untrusted users
16673 to use the other options which trusted user can use to override message
16674 parameters. Furthermore, it does not stop Exim from removing an existing
16675 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16676 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16677 overriding these actions. The handling of the &'Sender:'& header is also
16678 described in section &<<SECTthesenhea>>&.
16679
16680 The log line for a message's arrival shows the envelope sender following
16681 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16682 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16683 envelope sender address, the user's login is shown in parentheses after the
16684 sender address.
16685
16686
16687 .option uucp_from_pattern main string "see below"
16688 .cindex "&""From""& line"
16689 .cindex "UUCP" "&""From""& line"
16690 Some applications that pass messages to an MTA via a command line interface use
16691 an initial line starting with &"From&~"& to pass the envelope sender. In
16692 particular, this is used by UUCP software. Exim recognizes such a line by means
16693 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16694 matches, the sender address is constructed by expanding the contents of
16695 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16696 default pattern recognizes lines in the following two forms:
16697 .code
16698 From ph10 Fri Jan  5 12:35 GMT 1996
16699 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16700 .endd
16701 The pattern can be seen by running
16702 .code
16703 exim -bP uucp_from_pattern
16704 .endd
16705 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16706 year in the second case. The first word after &"From&~"& is matched in the
16707 regular expression by a parenthesized subpattern. The default value for
16708 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16709 (&"ph10"& in the example above) as the message's sender. See also
16710 &%ignore_fromline_hosts%&.
16711
16712
16713 .option uucp_from_sender main string&!! &`$1`&
16714 See &%uucp_from_pattern%& above.
16715
16716
16717 .option warn_message_file main string unset
16718 .cindex "warning of delay" "customizing the message"
16719 .cindex "customizing" "warning message"
16720 This option defines a template file containing paragraphs of text to be used
16721 for constructing the warning message which is sent by Exim when a message has
16722 been on the queue for a specified amount of time, as specified by
16723 &%delay_warning%&. Details of the file's contents are given in chapter
16724 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16725
16726
16727 .option write_rejectlog main boolean true
16728 .cindex "reject log" "disabling"
16729 If this option is set false, Exim no longer writes anything to the reject log.
16730 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16731 .ecindex IIDconfima
16732 .ecindex IIDmaiconf
16733
16734
16735
16736
16737 . ////////////////////////////////////////////////////////////////////////////
16738 . ////////////////////////////////////////////////////////////////////////////
16739
16740 .chapter "Generic options for routers" "CHAProutergeneric"
16741 .scindex IIDgenoprou1 "options" "generic; for routers"
16742 .scindex IIDgenoprou2 "generic options" "router"
16743 This chapter describes the generic options that apply to all routers.
16744 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16745
16746 For a general description of how a router operates, see sections
16747 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16748 which the preconditions are tested. The order of expansion of the options that
16749 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16750 &%headers_remove%&, &%transport%&.
16751
16752
16753
16754 .option address_data routers string&!! unset
16755 .cindex "router" "data attached to address"
16756 The string is expanded just before the router is run, that is, after all the
16757 precondition tests have succeeded. If the expansion is forced to fail, the
16758 router declines, the value of &%address_data%& remains unchanged, and the
16759 &%more%& option controls what happens next. Other expansion failures cause
16760 delivery of the address to be deferred.
16761
16762 .vindex "&$address_data$&"
16763 When the expansion succeeds, the value is retained with the address, and can be
16764 accessed using the variable &$address_data$& in the current router, subsequent
16765 routers, and the eventual transport.
16766
16767 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16768 that runs a user's filter file, the contents of &$address_data$& are accessible
16769 in the filter. This is not normally a problem, because such data is usually
16770 either not confidential or it &"belongs"& to the current user, but if you do
16771 put confidential data into &$address_data$& you need to remember this point.
16772
16773 Even if the router declines or passes, the value of &$address_data$& remains
16774 with the address, though it can be changed by another &%address_data%& setting
16775 on a subsequent router. If a router generates child addresses, the value of
16776 &$address_data$& propagates to them. This also applies to the special kind of
16777 &"child"& that is generated by a router with the &%unseen%& option.
16778
16779 The idea of &%address_data%& is that you can use it to look up a lot of data
16780 for the address once, and then pick out parts of the data later. For example,
16781 you could use a single LDAP lookup to return a string of the form
16782 .code
16783 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16784 .endd
16785 In the transport you could pick out the mailbox by a setting such as
16786 .code
16787 file = ${extract{mailbox}{$address_data}}
16788 .endd
16789 This makes the configuration file less messy, and also reduces the number of
16790 lookups (though Exim does cache lookups).
16791
16792 .vindex "&$sender_address_data$&"
16793 .vindex "&$address_data$&"
16794 The &%address_data%& facility is also useful as a means of passing information
16795 from one router to another, and from a router to a transport. In addition, if
16796 &$address_data$& is set by a router when verifying a recipient address from an
16797 ACL, it remains available for use in the rest of the ACL statement. After
16798 verifying a sender, the value is transferred to &$sender_address_data$&.
16799
16800
16801
16802 .option address_test routers&!? boolean true
16803 .oindex "&%-bt%&"
16804 .cindex "router" "skipping when address testing"
16805 If this option is set false, the router is skipped when routing is being tested
16806 by means of the &%-bt%& command line option. This can be a convenience when
16807 your first router sends messages to an external scanner, because it saves you
16808 having to set the &"already scanned"& indicator when testing real address
16809 routing.
16810
16811
16812
16813 .option cannot_route_message routers string&!! unset
16814 .cindex "router" "customizing &""cannot route""& message"
16815 .cindex "customizing" "&""cannot route""& message"
16816 This option specifies a text message that is used when an address cannot be
16817 routed because Exim has run out of routers. The default message is
16818 &"Unrouteable address"&. This option is useful only on routers that have
16819 &%more%& set false, or on the very last router in a configuration, because the
16820 value that is used is taken from the last router that is considered. This
16821 includes a router that is skipped because its preconditions are not met, as
16822 well as a router that declines. For example, using the default configuration,
16823 you could put:
16824 .code
16825 cannot_route_message = Remote domain not found in DNS
16826 .endd
16827 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16828 and
16829 .code
16830 cannot_route_message = Unknown local user
16831 .endd
16832 on the final router that checks for local users. If string expansion fails for
16833 this option, the default message is used. Unless the expansion failure was
16834 explicitly forced, a message about the failure is written to the main and panic
16835 logs, in addition to the normal message about the routing failure.
16836
16837
16838 .option caseful_local_part routers boolean false
16839 .cindex "case of local parts"
16840 .cindex "router" "case of local parts"
16841 By default, routers handle the local parts of addresses in a case-insensitive
16842 manner, though the actual case is preserved for transmission with the message.
16843 If you want the case of letters to be significant in a router, you must set
16844 this option true. For individual router options that contain address or local
16845 part lists (for example, &%local_parts%&), case-sensitive matching can be
16846 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16847 more details.
16848
16849 .vindex "&$local_part$&"
16850 .vindex "&$original_local_part$&"
16851 .vindex "&$parent_local_part$&"
16852 The value of the &$local_part$& variable is forced to lower case while a
16853 router is running unless &%caseful_local_part%& is set. When a router assigns
16854 an address to a transport, the value of &$local_part$& when the transport runs
16855 is the same as it was in the router. Similarly, when a router generates child
16856 addresses by aliasing or forwarding, the values of &$original_local_part$&
16857 and &$parent_local_part$& are those that were used by the redirecting router.
16858
16859 This option applies to the processing of an address by a router. When a
16860 recipient address is being processed in an ACL, there is a separate &%control%&
16861 modifier that can be used to specify case-sensitive processing within the ACL
16862 (see section &<<SECTcontrols>>&).
16863
16864
16865
16866 .option check_local_user routers&!? boolean false
16867 .cindex "local user, checking in router"
16868 .cindex "router" "checking for local user"
16869 .cindex "&_/etc/passwd_&"
16870 .vindex "&$home$&"
16871 When this option is true, Exim checks that the local part of the recipient
16872 address (with affixes removed if relevant) is the name of an account on the
16873 local system. The check is done by calling the &[getpwnam()]& function rather
16874 than trying to read &_/etc/passwd_& directly. This means that other methods of
16875 holding password data (such as NIS) are supported. If the local part is a local
16876 user, &$home$& is set from the password data, and can be tested in other
16877 preconditions that are evaluated after this one (the order of evaluation is
16878 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16879 overridden by &%router_home_directory%&. If the local part is not a local user,
16880 the router is skipped.
16881
16882 If you want to check that the local part is either the name of a local user
16883 or matches something else, you cannot combine &%check_local_user%& with a
16884 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16885 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16886 setting to achieve this. For example:
16887 .code
16888 local_parts = passwd;$local_part : lsearch;/etc/other/users
16889 .endd
16890 Note, however, that the side effects of &%check_local_user%& (such as setting
16891 up a home directory) do not occur when a &(passwd)& lookup is used in a
16892 &%local_parts%& (or any other) precondition.
16893
16894
16895
16896 .option condition routers&!? string&!! unset
16897 .cindex "router" "customized precondition"
16898 This option specifies a general precondition test that has to succeed for the
16899 router to be called. The &%condition%& option is the last precondition to be
16900 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16901 result is a forced failure, or an empty string, or one of the strings &"0"& or
16902 &"no"& or &"false"& (checked without regard to the case of the letters), the
16903 router is skipped, and the address is offered to the next one.
16904
16905 If the result is any other value, the router is run (as this is the last
16906 precondition to be evaluated, all the other preconditions must be true).
16907
16908 This option is unusual in that multiple &%condition%& options may be present.
16909 All &%condition%& options must succeed.
16910
16911 The &%condition%& option provides a means of applying custom conditions to the
16912 running of routers. Note that in the case of a simple conditional expansion,
16913 the default expansion values are exactly what is wanted. For example:
16914 .code
16915 condition = ${if >{$message_age}{600}}
16916 .endd
16917 Because of the default behaviour of the string expansion, this is equivalent to
16918 .code
16919 condition = ${if >{$message_age}{600}{true}{}}
16920 .endd
16921
16922 A multiple condition example, which succeeds:
16923 .code
16924 condition = ${if >{$message_age}{600}}
16925 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16926 condition = foobar
16927 .endd
16928
16929 If the expansion fails (other than forced failure) delivery is deferred. Some
16930 of the other precondition options are common special cases that could in fact
16931 be specified using &%condition%&.
16932
16933 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16934 are far older, and use one set of semantics.  ACLs are newer and when
16935 they were created, the ACL &%condition%& process was given far stricter
16936 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
16937 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
16938 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
16939 Router rules processing behavior.
16940
16941 This is best illustrated in an example:
16942 .code
16943 # If used in an ACL condition will fail with a syntax error, but
16944 # in a router condition any extra characters are treated as a string
16945
16946 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16947 true {yes} {no}}
16948
16949 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16950  {yes} {no}}
16951 .endd
16952 In each example above, the &%if%& statement actually ends after
16953 &"{google.com}}"&.  Since no true or false braces were defined, the
16954 default &%if%& behavior is to return a boolean true or a null answer
16955 (which evaluates to false). The rest of the line is then treated as a
16956 string. So the first example resulted in the boolean answer &"true"&
16957 with the string &" {yes} {no}}"& appended to it. The second example
16958 resulted in the null output (indicating false) with the string
16959 &" {yes} {no}}"& appended to it.
16960
16961 In fact you can put excess forward braces in too.  In the router
16962 &%condition%&, Exim's parser only looks for &"{"& symbols when they
16963 mean something, like after a &"$"& or when required as part of a
16964 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16965 string characters.
16966
16967 Thus, in a Router, the above expansion strings will both always evaluate
16968 true, as the result of expansion is a non-empty string which doesn't
16969 match an explicit false value.  This can be tricky to debug.  By
16970 contrast, in an ACL either of those strings will always result in an
16971 expansion error because the result doesn't look sufficiently boolean.
16972
16973
16974 .option debug_print routers string&!! unset
16975 .cindex "testing" "variables in drivers"
16976 If this option is set and debugging is enabled (see the &%-d%& command line
16977 option) or in address-testing mode (see the &%-bt%& command line option),
16978 the string is expanded and included in the debugging output.
16979 If expansion of the string fails, the error message is written to the debugging
16980 output, and Exim carries on processing.
16981 This option is provided to help with checking out the values of variables and
16982 so on when debugging router configurations. For example, if a &%condition%&
16983 option appears not to be working, &%debug_print%& can be used to output the
16984 variables it references. The output happens after checks for &%domains%&,
16985 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16986 are tested. A newline is added to the text if it does not end with one.
16987 The variable &$router_name$& contains the name of the router.
16988
16989
16990
16991 .option disable_logging routers boolean false
16992 If this option is set true, nothing is logged for any routing errors
16993 or for any deliveries caused by this router. You should not set this option
16994 unless you really, really know what you are doing. See also the generic
16995 transport option of the same name.
16996
16997
16998 .option domains routers&!? "domain list&!!" unset
16999 .cindex "router" "restricting to specific domains"
17000 .vindex "&$domain_data$&"
17001 If this option is set, the router is skipped unless the current domain matches
17002 the list. If the match is achieved by means of a file lookup, the data that the
17003 lookup returned for the domain is placed in &$domain_data$& for use in string
17004 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17005 a list of the order in which preconditions are evaluated.
17006
17007
17008
17009 .option driver routers string unset
17010 This option must always be set. It specifies which of the available routers is
17011 to be used.
17012
17013
17014 .new
17015 .option dsn_lasthop routers boolean false
17016 .cindex "DSN" "success"
17017 .cindex "Delivery Status Notification" "success"
17018 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17019 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17020 instead send a success DSN as if the next hop does not support DSN.
17021 Not effective on redirect routers.
17022 .wen
17023
17024
17025
17026 .option errors_to routers string&!! unset
17027 .cindex "envelope sender"
17028 .cindex "router" "changing address for errors"
17029 If a router successfully handles an address, it may assign the address to a
17030 transport for delivery or it may generate child addresses. In both cases, if
17031 there is a delivery problem during later processing, the resulting bounce
17032 message is sent to the address that results from expanding this string,
17033 provided that the address verifies successfully. The &%errors_to%& option is
17034 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17035
17036 The &%errors_to%& setting associated with an address can be overridden if it
17037 subsequently passes through other routers that have their own &%errors_to%&
17038 settings, or if the message is delivered by a transport with a &%return_path%&
17039 setting.
17040
17041 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17042 the expansion fails to verify, the errors address associated with the incoming
17043 address is used. At top level, this is the envelope sender. A non-forced
17044 expansion failure causes delivery to be deferred.
17045
17046 If an address for which &%errors_to%& has been set ends up being delivered over
17047 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17048 any bounces that are generated by other MTAs on the delivery route are also
17049 sent there. You can set &%errors_to%& to the empty string by either of these
17050 settings:
17051 .code
17052 errors_to =
17053 errors_to = ""
17054 .endd
17055 An expansion item that yields an empty string has the same effect. If you do
17056 this, a locally detected delivery error for addresses processed by this router
17057 no longer gives rise to a bounce message; the error is discarded. If the
17058 address is delivered to a remote host, the return path is set to &`<>`&, unless
17059 overridden by the &%return_path%& option on the transport.
17060
17061 .vindex "&$address_data$&"
17062 If for some reason you want to discard local errors, but use a non-empty
17063 MAIL command for remote delivery, you can preserve the original return
17064 path in &$address_data$& in the router, and reinstate it in the transport by
17065 setting &%return_path%&.
17066
17067 The most common use of &%errors_to%& is to direct mailing list bounces to the
17068 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17069 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17070
17071
17072
17073 .option expn routers&!? boolean true
17074 .cindex "address" "testing"
17075 .cindex "testing" "addresses"
17076 .cindex "EXPN" "router skipping"
17077 .cindex "router" "skipping for EXPN"
17078 If this option is turned off, the router is skipped when testing an address
17079 as a result of processing an SMTP EXPN command. You might, for example,
17080 want to turn it off on a router for users' &_.forward_& files, while leaving it
17081 on for the system alias file.
17082 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17083 are evaluated.
17084
17085 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17086 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17087 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17088
17089
17090
17091 .option fail_verify routers boolean false
17092 .cindex "router" "forcing verification failure"
17093 Setting this option has the effect of setting both &%fail_verify_sender%& and
17094 &%fail_verify_recipient%& to the same value.
17095
17096
17097
17098 .option fail_verify_recipient routers boolean false
17099 If this option is true and an address is accepted by this router when
17100 verifying a recipient, verification fails.
17101
17102
17103
17104 .option fail_verify_sender routers boolean false
17105 If this option is true and an address is accepted by this router when
17106 verifying a sender, verification fails.
17107
17108
17109
17110 .option fallback_hosts routers "string list" unset
17111 .cindex "router" "fallback hosts"
17112 .cindex "fallback" "hosts specified on router"
17113 String expansion is not applied to this option. The argument must be a
17114 colon-separated list of host names or IP addresses. The list separator can be
17115 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17116 each name or address. In fact, the format of each item is exactly the same as
17117 defined for the list of hosts in a &(manualroute)& router (see section
17118 &<<SECTformatonehostitem>>&).
17119
17120 If a router queues an address for a remote transport, this host list is
17121 associated with the address, and used instead of the transport's fallback host
17122 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17123 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17124 transport for further details.
17125
17126
17127 .option group routers string&!! "see below"
17128 .cindex "gid (group id)" "local delivery"
17129 .cindex "local transports" "uid and gid"
17130 .cindex "transport" "local"
17131 .cindex "router" "setting group"
17132 When a router queues an address for a transport, and the transport does not
17133 specify a group, the group given here is used when running the delivery
17134 process.
17135 The group may be specified numerically or by name. If expansion fails, the
17136 error is logged and delivery is deferred.
17137 The default is unset, unless &%check_local_user%& is set, when the default
17138 is taken from the password information. See also &%initgroups%& and &%user%&
17139 and the discussion in chapter &<<CHAPenvironment>>&.
17140
17141
17142
17143 .option headers_add routers list&!! unset
17144 .cindex "header lines" "adding"
17145 .cindex "router" "adding header lines"
17146 This option specifies a list of text headers, newline-separated,
17147 that is associated with any addresses that are accepted by the router.
17148 Each item is separately expanded, at routing time.  However, this
17149 option has no effect when an address is just being verified. The way in which
17150 the text is used to add header lines at transport time is described in section
17151 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17152 message is in the process of being transported. This means that references to
17153 header lines in string expansions in the transport's configuration do not
17154 &"see"& the added header lines.
17155
17156 The &%headers_add%& option is expanded after &%errors_to%&, but before
17157 &%headers_remove%& and &%transport%&. If an item is empty, or if
17158 an item expansion is forced to fail, the item has no effect. Other expansion
17159 failures are treated as configuration errors.
17160
17161 Unlike most options, &%headers_add%& can be specified multiple times
17162 for a router; all listed headers are added.
17163
17164 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17165 router that has the &%one_time%& option set.
17166
17167 .cindex "duplicate addresses"
17168 .oindex "&%unseen%&"
17169 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17170 additions are deleted when the address is passed on to subsequent routers.
17171 For a &%redirect%& router, if a generated address is the same as the incoming
17172 address, this can lead to duplicate addresses with different header
17173 modifications. Exim does not do duplicate deliveries (except, in certain
17174 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17175 which of the duplicates is discarded, so this ambiguous situation should be
17176 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17177
17178
17179
17180 .option headers_remove routers list&!! unset
17181 .cindex "header lines" "removing"
17182 .cindex "router" "removing header lines"
17183 This option specifies a list of text headers, colon-separated,
17184 that is associated with any addresses that are accepted by the router.
17185 Each item is separately expanded, at routing time.  However, this
17186 option has no effect when an address is just being verified. The way in which
17187 the text is used to remove header lines at transport time is described in
17188 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17189 the message is in the process of being transported. This means that references
17190 to header lines in string expansions in the transport's configuration still
17191 &"see"& the original header lines.
17192
17193 The &%headers_remove%& option is expanded after &%errors_to%& and
17194 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17195 the item has no effect. Other expansion failures are treated as configuration
17196 errors.
17197
17198 Unlike most options, &%headers_remove%& can be specified multiple times
17199 for a router; all listed headers are removed.
17200
17201 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17202 router that has the &%one_time%& option set.
17203
17204 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17205 removal requests are deleted when the address is passed on to subsequent
17206 routers, and this can lead to problems with duplicates -- see the similar
17207 warning for &%headers_add%& above.
17208
17209
17210 .option ignore_target_hosts routers "host list&!!" unset
17211 .cindex "IP address" "discarding"
17212 .cindex "router" "discarding IP addresses"
17213 Although this option is a host list, it should normally contain IP address
17214 entries rather than names. If any host that is looked up by the router has an
17215 IP address that matches an item in this list, Exim behaves as if that IP
17216 address did not exist. This option allows you to cope with rogue DNS entries
17217 like
17218 .code
17219 remote.domain.example.  A  127.0.0.1
17220 .endd
17221 by setting
17222 .code
17223 ignore_target_hosts = 127.0.0.1
17224 .endd
17225 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17226 discarded in this way, the router declines. In a conventional configuration, an
17227 attempt to mail to such a domain would normally provoke the &"unrouteable
17228 domain"& error, and an attempt to verify an address in the domain would fail.
17229 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17230 router declines if presented with one of the listed addresses.
17231
17232 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17233 means of the first or the second of the following settings, respectively:
17234 .code
17235 ignore_target_hosts = 0.0.0.0/0
17236 ignore_target_hosts = <; 0::0/0
17237 .endd
17238 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17239 in the second line matches all IPv6 addresses.
17240
17241 This option may also be useful for ignoring link-local and site-local IPv6
17242 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17243 is expanded before use as a list, it is possible to make it dependent on the
17244 domain that is being routed.
17245
17246 .vindex "&$host_address$&"
17247 During its expansion, &$host_address$& is set to the IP address that is being
17248 checked.
17249
17250 .option initgroups routers boolean false
17251 .cindex "additional groups"
17252 .cindex "groups" "additional"
17253 .cindex "local transports" "uid and gid"
17254 .cindex "transport" "local"
17255 If the router queues an address for a transport, and this option is true, and
17256 the uid supplied by the router is not overridden by the transport, the
17257 &[initgroups()]& function is called when running the transport to ensure that
17258 any additional groups associated with the uid are set up. See also &%group%&
17259 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17260
17261
17262
17263 .option local_part_prefix routers&!? "string list" unset
17264 .cindex "router" "prefix for local part"
17265 .cindex "prefix" "for local part, used in router"
17266 If this option is set, the router is skipped unless the local part starts with
17267 one of the given strings, or &%local_part_prefix_optional%& is true. See
17268 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17269 evaluated.
17270
17271 The list is scanned from left to right, and the first prefix that matches is
17272 used. A limited form of wildcard is available; if the prefix begins with an
17273 asterisk, it matches the longest possible sequence of arbitrary characters at
17274 the start of the local part. An asterisk should therefore always be followed by
17275 some character that does not occur in normal local parts.
17276 .cindex "multiple mailboxes"
17277 .cindex "mailbox" "multiple"
17278 Wildcarding can be used to set up multiple user mailboxes, as described in
17279 section &<<SECTmulbox>>&.
17280
17281 .vindex "&$local_part$&"
17282 .vindex "&$local_part_prefix$&"
17283 During the testing of the &%local_parts%& option, and while the router is
17284 running, the prefix is removed from the local part, and is available in the
17285 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17286 the router accepts the address, this remains true during subsequent delivery by
17287 a transport. In particular, the local part that is transmitted in the RCPT
17288 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17289 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17290 the relevant transport.
17291
17292 When an address is being verified, &%local_part_prefix%& affects only the
17293 behaviour of the router. If the callout feature of verification is in use, this
17294 means that the full address, including the prefix, will be used during the
17295 callout.
17296
17297 The prefix facility is commonly used to handle local parts of the form
17298 &%owner-something%&. Another common use is to support local parts of the form
17299 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17300 to tell a user their forwarding is broken &-- by placing a router like this one
17301 immediately before the router that handles &_.forward_& files:
17302 .code
17303 real_localuser:
17304   driver = accept
17305   local_part_prefix = real-
17306   check_local_user
17307   transport = local_delivery
17308 .endd
17309 For security, it would probably be a good idea to restrict the use of this
17310 router to locally-generated messages, using a condition such as this:
17311 .code
17312   condition = ${if match {$sender_host_address}\
17313                          {\N^(|127\.0\.0\.1)$\N}}
17314 .endd
17315
17316 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17317 both conditions must be met if not optional. Care must be taken if wildcards
17318 are used in both a prefix and a suffix on the same router. Different
17319 separator characters must be used to avoid ambiguity.
17320
17321
17322 .option local_part_prefix_optional routers boolean false
17323 See &%local_part_prefix%& above.
17324
17325
17326
17327 .option local_part_suffix routers&!? "string list" unset
17328 .cindex "router" "suffix for local part"
17329 .cindex "suffix for local part" "used in router"
17330 This option operates in the same way as &%local_part_prefix%&, except that the
17331 local part must end (rather than start) with the given string, the
17332 &%local_part_suffix_optional%& option determines whether the suffix is
17333 mandatory, and the wildcard * character, if present, must be the last
17334 character of the suffix. This option facility is commonly used to handle local
17335 parts of the form &%something-request%& and multiple user mailboxes of the form
17336 &%username-foo%&.
17337
17338
17339 .option local_part_suffix_optional routers boolean false
17340 See &%local_part_suffix%& above.
17341
17342
17343
17344 .option local_parts routers&!? "local part list&!!" unset
17345 .cindex "router" "restricting to specific local parts"
17346 .cindex "local part" "checking in router"
17347 The router is run only if the local part of the address matches the list.
17348 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17349 are evaluated, and
17350 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17351 string is expanded, it is possible to make it depend on the domain, for
17352 example:
17353 .code
17354 local_parts = dbm;/usr/local/specials/$domain
17355 .endd
17356 .vindex "&$local_part_data$&"
17357 If the match is achieved by a lookup, the data that the lookup returned
17358 for the local part is placed in the variable &$local_part_data$& for use in
17359 expansions of the router's private options. You might use this option, for
17360 example, if you have a large number of local virtual domains, and you want to
17361 send all postmaster mail to the same place without having to set up an alias in
17362 each virtual domain:
17363 .code
17364 postmaster:
17365   driver = redirect
17366   local_parts = postmaster
17367   data = postmaster@real.domain.example
17368 .endd
17369
17370
17371 .option log_as_local routers boolean "see below"
17372 .cindex "log" "delivery line"
17373 .cindex "delivery" "log line format"
17374 Exim has two logging styles for delivery, the idea being to make local
17375 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17376 recipient address is given just as the local part, without a domain. The use of
17377 this style is controlled by this option. It defaults to true for the &(accept)&
17378 router, and false for all the others. This option applies only when a
17379 router assigns an address to a transport. It has no effect on routers that
17380 redirect addresses.
17381
17382
17383
17384 .option more routers boolean&!! true
17385 The result of string expansion for this option must be a valid boolean value,
17386 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17387 result causes an error, and delivery is deferred. If the expansion is forced to
17388 fail, the default value for the option (true) is used. Other failures cause
17389 delivery to be deferred.
17390
17391 If this option is set false, and the router declines to handle the address, no
17392 further routers are tried, routing fails, and the address is bounced.
17393 .oindex "&%self%&"
17394 However, if the router explicitly passes an address to the following router by
17395 means of the setting
17396 .code
17397 self = pass
17398 .endd
17399 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17400 does not affect the behaviour if one of the precondition tests fails. In that
17401 case, the address is always passed to the next router.
17402
17403 Note that &%address_data%& is not considered to be a precondition. If its
17404 expansion is forced to fail, the router declines, and the value of &%more%&
17405 controls what happens next.
17406
17407
17408 .option pass_on_timeout routers boolean false
17409 .cindex "timeout" "of router"
17410 .cindex "router" "timeout"
17411 If a router times out during a host lookup, it normally causes deferral of the
17412 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17413 router, overriding &%no_more%&. This may be helpful for systems that are
17414 intermittently connected to the Internet, or those that want to pass to a smart
17415 host any messages that cannot immediately be delivered.
17416
17417 There are occasional other temporary errors that can occur while doing DNS
17418 lookups. They are treated in the same way as a timeout, and this option
17419 applies to all of them.
17420
17421
17422
17423 .option pass_router routers string unset
17424 .cindex "router" "go to after &""pass""&"
17425 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17426 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17427 routing to continue, and overriding a false setting of &%more%&. When one of
17428 these routers returns &"pass"&, the address is normally handed on to the next
17429 router in sequence. This can be changed by setting &%pass_router%& to the name
17430 of another router. However (unlike &%redirect_router%&) the named router must
17431 be below the current router, to avoid loops. Note that this option applies only
17432 to the special case of &"pass"&. It does not apply when a router returns
17433 &"decline"& because it cannot handle an address.
17434
17435
17436
17437 .option redirect_router routers string unset
17438 .cindex "router" "start at after redirection"
17439 Sometimes an administrator knows that it is pointless to reprocess addresses
17440 generated from alias or forward files with the same router again. For
17441 example, if an alias file translates real names into login ids there is no
17442 point searching the alias file a second time, especially if it is a large file.
17443
17444 The &%redirect_router%& option can be set to the name of any router instance.
17445 It causes the routing of any generated addresses to start at the named router
17446 instead of at the first router. This option has no effect if the router in
17447 which it is set does not generate new addresses.
17448
17449
17450
17451 .option require_files routers&!? "string list&!!" unset
17452 .cindex "file" "requiring for router"
17453 .cindex "router" "requiring file existence"
17454 This option provides a general mechanism for predicating the running of a
17455 router on the existence or non-existence of certain files or directories.
17456 Before running a router, as one of its precondition tests, Exim works its way
17457 through the &%require_files%& list, expanding each item separately.
17458
17459 Because the list is split before expansion, any colons in expansion items must
17460 be doubled, or the facility for using a different list separator must be used.
17461 If any expansion is forced to fail, the item is ignored. Other expansion
17462 failures cause routing of the address to be deferred.
17463
17464 If any expanded string is empty, it is ignored. Otherwise, except as described
17465 below, each string must be a fully qualified file path, optionally preceded by
17466 &"!"&. The paths are passed to the &[stat()]& function to test for the
17467 existence of the files or directories. The router is skipped if any paths not
17468 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17469
17470 .cindex "NFS"
17471 If &[stat()]& cannot determine whether a file exists or not, delivery of
17472 the message is deferred. This can happen when NFS-mounted filesystems are
17473 unavailable.
17474
17475 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17476 options, so you cannot use it to check for the existence of a file in which to
17477 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17478 full list of the order in which preconditions are evaluated.) However, as
17479 these options are all expanded, you can use the &%exists%& expansion condition
17480 to make such tests. The &%require_files%& option is intended for checking files
17481 that the router may be going to use internally, or which are needed by a
17482 transport (for example &_.procmailrc_&).
17483
17484 During delivery, the &[stat()]& function is run as root, but there is a
17485 facility for some checking of the accessibility of a file by another user.
17486 This is not a proper permissions check, but just a &"rough"& check that
17487 operates as follows:
17488
17489 If an item in a &%require_files%& list does not contain any forward slash
17490 characters, it is taken to be the user (and optional group, separated by a
17491 comma) to be checked for subsequent files in the list. If no group is specified
17492 but the user is specified symbolically, the gid associated with the uid is
17493 used. For example:
17494 .code
17495 require_files = mail:/some/file
17496 require_files = $local_part:$home/.procmailrc
17497 .endd
17498 If a user or group name in a &%require_files%& list does not exist, the
17499 &%require_files%& condition fails.
17500
17501 Exim performs the check by scanning along the components of the file path, and
17502 checking the access for the given uid and gid. It checks for &"x"& access on
17503 directories, and &"r"& access on the final file. Note that this means that file
17504 access control lists, if the operating system has them, are ignored.
17505
17506 &*Warning 1*&: When the router is being run to verify addresses for an
17507 incoming SMTP message, Exim is not running as root, but under its own uid. This
17508 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17509 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17510 user is not permitted to read one of the directories on the file's path.
17511
17512 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17513 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17514 without root access. In this case, if a check for access by a particular user
17515 is requested, Exim creates a subprocess that runs as that user, and tries the
17516 check again in that process.
17517
17518 The default action for handling an unresolved EACCES is to consider it to
17519 be caused by a configuration error, and routing is deferred because the
17520 existence or non-existence of the file cannot be determined. However, in some
17521 circumstances it may be desirable to treat this condition as if the file did
17522 not exist. If the file name (or the exclamation mark that precedes the file
17523 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17524 as if the file did not exist. For example:
17525 .code
17526 require_files = +/some/file
17527 .endd
17528 If the router is not an essential part of verification (for example, it
17529 handles users' &_.forward_& files), another solution is to set the &%verify%&
17530 option false so that the router is skipped when verifying.
17531
17532
17533
17534 .option retry_use_local_part routers boolean "see below"
17535 .cindex "hints database" "retry keys"
17536 .cindex "local part" "in retry keys"
17537 When a delivery suffers a temporary routing failure, a retry record is created
17538 in Exim's hints database. For addresses whose routing depends only on the
17539 domain, the key for the retry record should not involve the local part, but for
17540 other addresses, both the domain and the local part should be included.
17541 Usually, remote routing is of the former kind, and local routing is of the
17542 latter kind.
17543
17544 This option controls whether the local part is used to form the key for retry
17545 hints for addresses that suffer temporary errors while being handled by this
17546 router. The default value is true for any router that has &%check_local_user%&
17547 set, and false otherwise. Note that this option does not apply to hints keys
17548 for transport delays; they are controlled by a generic transport option of the
17549 same name.
17550
17551 The setting of &%retry_use_local_part%& applies only to the router on which it
17552 appears. If the router generates child addresses, they are routed
17553 independently; this setting does not become attached to them.
17554
17555
17556
17557 .option router_home_directory routers string&!! unset
17558 .cindex "router" "home directory for"
17559 .cindex "home directory" "for router"
17560 .vindex "&$home$&"
17561 This option sets a home directory for use while the router is running. (Compare
17562 &%transport_home_directory%&, which sets a home directory for later
17563 transporting.) In particular, if used on a &(redirect)& router, this option
17564 sets a value for &$home$& while a filter is running. The value is expanded;
17565 forced expansion failure causes the option to be ignored &-- other failures
17566 cause the router to defer.
17567
17568 Expansion of &%router_home_directory%& happens immediately after the
17569 &%check_local_user%& test (if configured), before any further expansions take
17570 place.
17571 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17572 are evaluated.)
17573 While the router is running, &%router_home_directory%& overrides the value of
17574 &$home$& that came from &%check_local_user%&.
17575
17576 When a router accepts an address and assigns it to a local transport (including
17577 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17578 delivery), the home directory setting for the transport is taken from the first
17579 of these values that is set:
17580
17581 .ilist
17582 The &%home_directory%& option on the transport;
17583 .next
17584 The &%transport_home_directory%& option on the router;
17585 .next
17586 The password data if &%check_local_user%& is set on the router;
17587 .next
17588 The &%router_home_directory%& option on the router.
17589 .endlist
17590
17591 In other words, &%router_home_directory%& overrides the password data for the
17592 router, but not for the transport.
17593
17594
17595
17596 .option self routers string freeze
17597 .cindex "MX record" "pointing to local host"
17598 .cindex "local host" "MX pointing to"
17599 This option applies to those routers that use a recipient address to find a
17600 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17601 and &(manualroute)& routers.
17602 Certain configurations of the &(queryprogram)& router can also specify a list
17603 of remote hosts.
17604 Usually such routers are configured to send the message to a remote host via an
17605 &(smtp)& transport. The &%self%& option specifies what happens when the first
17606 host on the list turns out to be the local host.
17607 The way in which Exim checks for the local host is described in section
17608 &<<SECTreclocipadd>>&.
17609
17610 Normally this situation indicates either an error in Exim's configuration (for
17611 example, the router should be configured not to process this domain), or an
17612 error in the DNS (for example, the MX should not point to this host). For this
17613 reason, the default action is to log the incident, defer the address, and
17614 freeze the message. The following alternatives are provided for use in special
17615 cases:
17616
17617 .vlist
17618 .vitem &%defer%&
17619 Delivery of the message is tried again later, but the message is not frozen.
17620
17621 .vitem "&%reroute%&: <&'domain'&>"
17622 The domain is changed to the given domain, and the address is passed back to
17623 be reprocessed by the routers. No rewriting of headers takes place. This
17624 behaviour is essentially a redirection.
17625
17626 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17627 The domain is changed to the given domain, and the address is passed back to be
17628 reprocessed by the routers. Any headers that contain the original domain are
17629 rewritten.
17630
17631 .vitem &%pass%&
17632 .oindex "&%more%&"
17633 .vindex "&$self_hostname$&"
17634 The router passes the address to the next router, or to the router named in the
17635 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17636 subsequent routing and delivery, the variable &$self_hostname$& contains the
17637 name of the local host that the router encountered. This can be used to
17638 distinguish between different cases for hosts with multiple names. The
17639 combination
17640 .code
17641 self = pass
17642 no_more
17643 .endd
17644 ensures that only those addresses that routed to the local host are passed on.
17645 Without &%no_more%&, addresses that were declined for other reasons would also
17646 be passed to the next router.
17647
17648 .vitem &%fail%&
17649 Delivery fails and an error report is generated.
17650
17651 .vitem &%send%&
17652 .cindex "local host" "sending to"
17653 The anomaly is ignored and the address is queued for the transport. This
17654 setting should be used with extreme caution. For an &(smtp)& transport, it
17655 makes sense only in cases where the program that is listening on the SMTP port
17656 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17657 different configuration file that handles the domain in another way.
17658 .endlist
17659
17660
17661
17662 .option senders routers&!? "address list&!!" unset
17663 .cindex "router" "checking senders"
17664 If this option is set, the router is skipped unless the message's sender
17665 address matches something on the list.
17666 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17667 are evaluated.
17668
17669 There are issues concerning verification when the running of routers is
17670 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17671 setting, it sets the sender to the null string. When using the &%-bt%& option
17672 to check a configuration file, it is necessary also to use the &%-f%& option to
17673 set an appropriate sender. For incoming mail, the sender is unset when
17674 verifying the sender, but is available when verifying any recipients. If the
17675 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17676 matters.
17677
17678
17679 .option translate_ip_address routers string&!! unset
17680 .cindex "IP address" "translating"
17681 .cindex "packet radio"
17682 .cindex "router" "IP address translation"
17683 There exist some rare networking situations (for example, packet radio) where
17684 it is helpful to be able to translate IP addresses generated by normal routing
17685 mechanisms into other IP addresses, thus performing a kind of manual IP
17686 routing. This should be done only if the normal IP routing of the TCP/IP stack
17687 is inadequate or broken. Because this is an extremely uncommon requirement, the
17688 code to support this option is not included in the Exim binary unless
17689 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17690
17691 .vindex "&$host_address$&"
17692 The &%translate_ip_address%& string is expanded for every IP address generated
17693 by the router, with the generated address set in &$host_address$&. If the
17694 expansion is forced to fail, no action is taken.
17695 For any other expansion error, delivery of the message is deferred.
17696 If the result of the expansion is an IP address, that replaces the original
17697 address; otherwise the result is assumed to be a host name &-- this is looked
17698 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17699 produce one or more replacement IP addresses. For example, to subvert all IP
17700 addresses in some specific networks, this could be added to a router:
17701 .code
17702 translate_ip_address = \
17703   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17704     {$value}fail}}
17705 .endd
17706 The file would contain lines like
17707 .code
17708 10.2.3.128/26    some.host
17709 10.8.4.34/26     10.44.8.15
17710 .endd
17711 You should not make use of this facility unless you really understand what you
17712 are doing.
17713
17714
17715
17716 .option transport routers string&!! unset
17717 This option specifies the transport to be used when a router accepts an address
17718 and sets it up for delivery. A transport is never needed if a router is used
17719 only for verification. The value of the option is expanded at routing time,
17720 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17721 and result must be the name of one of the configured transports. If it is not,
17722 delivery is deferred.
17723
17724 The &%transport%& option is not used by the &(redirect)& router, but it does
17725 have some private options that set up transports for pipe and file deliveries
17726 (see chapter &<<CHAPredirect>>&).
17727
17728
17729
17730 .option transport_current_directory routers string&!! unset
17731 .cindex "current directory for local transport"
17732 This option associates a current directory with any address that is routed
17733 to a local transport. This can happen either because a transport is
17734 explicitly configured for the router, or because it generates a delivery to a
17735 file or a pipe. During the delivery process (that is, at transport time), this
17736 option string is expanded and is set as the current directory, unless
17737 overridden by a setting on the transport.
17738 If the expansion fails for any reason, including forced failure, an error is
17739 logged, and delivery is deferred.
17740 See chapter &<<CHAPenvironment>>& for details of the local delivery
17741 environment.
17742
17743
17744
17745
17746 .option transport_home_directory routers string&!! "see below"
17747 .cindex "home directory" "for local transport"
17748 This option associates a home directory with any address that is routed to a
17749 local transport. This can happen either because a transport is explicitly
17750 configured for the router, or because it generates a delivery to a file or a
17751 pipe. During the delivery process (that is, at transport time), the option
17752 string is expanded and is set as the home directory, unless overridden by a
17753 setting of &%home_directory%& on the transport.
17754 If the expansion fails for any reason, including forced failure, an error is
17755 logged, and delivery is deferred.
17756
17757 If the transport does not specify a home directory, and
17758 &%transport_home_directory%& is not set for the router, the home directory for
17759 the transport is taken from the password data if &%check_local_user%& is set for
17760 the router. Otherwise it is taken from &%router_home_directory%& if that option
17761 is set; if not, no home directory is set for the transport.
17762
17763 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17764 environment.
17765
17766
17767
17768
17769 .option unseen routers boolean&!! false
17770 .cindex "router" "carrying on after success"
17771 The result of string expansion for this option must be a valid boolean value,
17772 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17773 result causes an error, and delivery is deferred. If the expansion is forced to
17774 fail, the default value for the option (false) is used. Other failures cause
17775 delivery to be deferred.
17776
17777 When this option is set true, routing does not cease if the router accepts the
17778 address. Instead, a copy of the incoming address is passed to the next router,
17779 overriding a false setting of &%more%&. There is little point in setting
17780 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17781 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17782 sometimes true and sometimes false).
17783
17784 .cindex "copy of message (&%unseen%& option)"
17785 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17786 qualifier in filter files. It can be used to cause copies of messages to be
17787 delivered to some other destination, while also carrying out a normal delivery.
17788 In effect, the current address is made into a &"parent"& that has two children
17789 &-- one that is delivered as specified by this router, and a clone that goes on
17790 to be routed further. For this reason, &%unseen%& may not be combined with the
17791 &%one_time%& option in a &(redirect)& router.
17792
17793 &*Warning*&: Header lines added to the address (or specified for removal) by
17794 this router or by previous routers affect the &"unseen"& copy of the message
17795 only. The clone that continues to be processed by further routers starts with
17796 no added headers and none specified for removal. For a &%redirect%& router, if
17797 a generated address is the same as the incoming address, this can lead to
17798 duplicate addresses with different header modifications. Exim does not do
17799 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17800 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17801 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17802 &%redirect%& router may be of help.
17803
17804 Unlike the handling of header modifications, any data that was set by the
17805 &%address_data%& option in the current or previous routers &'is'& passed on to
17806 subsequent routers.
17807
17808
17809 .option user routers string&!! "see below"
17810 .cindex "uid (user id)" "local delivery"
17811 .cindex "local transports" "uid and gid"
17812 .cindex "transport" "local"
17813 .cindex "router" "user for filter processing"
17814 .cindex "filter" "user for processing"
17815 When a router queues an address for a transport, and the transport does not
17816 specify a user, the user given here is used when running the delivery process.
17817 The user may be specified numerically or by name. If expansion fails, the
17818 error is logged and delivery is deferred.
17819 This user is also used by the &(redirect)& router when running a filter file.
17820 The default is unset, except when &%check_local_user%& is set. In this case,
17821 the default is taken from the password information. If the user is specified as
17822 a name, and &%group%& is not set, the group associated with the user is used.
17823 See also &%initgroups%& and &%group%& and the discussion in chapter
17824 &<<CHAPenvironment>>&.
17825
17826
17827
17828 .option verify routers&!? boolean true
17829 Setting this option has the effect of setting &%verify_sender%& and
17830 &%verify_recipient%& to the same value.
17831
17832
17833 .option verify_only routers&!? boolean false
17834 .cindex "EXPN" "with &%verify_only%&"
17835 .oindex "&%-bv%&"
17836 .cindex "router" "used only when verifying"
17837 If this option is set, the router is used only when verifying an address,
17838 delivering in cutthrough mode or
17839 testing with the &%-bv%& option, not when actually doing a delivery, testing
17840 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17841 restricted to verifying only senders or recipients by means of
17842 &%verify_sender%& and &%verify_recipient%&.
17843
17844 &*Warning*&: When the router is being run to verify addresses for an incoming
17845 SMTP message, Exim is not running as root, but under its own uid. If the router
17846 accesses any files, you need to make sure that they are accessible to the Exim
17847 user or group.
17848
17849
17850 .option verify_recipient routers&!? boolean true
17851 If this option is false, the router is skipped when verifying recipient
17852 addresses,
17853 delivering in cutthrough mode
17854 or testing recipient verification using &%-bv%&.
17855 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17856 are evaluated.
17857 See also the &$verify_mode$& variable.
17858
17859
17860 .option verify_sender routers&!? boolean true
17861 If this option is false, the router is skipped when verifying sender addresses
17862 or testing sender verification using &%-bvs%&.
17863 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17864 are evaluated.
17865 See also the &$verify_mode$& variable.
17866 .ecindex IIDgenoprou1
17867 .ecindex IIDgenoprou2
17868
17869
17870
17871
17872
17873
17874 . ////////////////////////////////////////////////////////////////////////////
17875 . ////////////////////////////////////////////////////////////////////////////
17876
17877 .chapter "The accept router" "CHID4"
17878 .cindex "&(accept)& router"
17879 .cindex "routers" "&(accept)&"
17880 The &(accept)& router has no private options of its own. Unless it is being
17881 used purely for verification (see &%verify_only%&) a transport is required to
17882 be defined by the generic &%transport%& option. If the preconditions that are
17883 specified by generic options are met, the router accepts the address and queues
17884 it for the given transport. The most common use of this router is for setting
17885 up deliveries to local mailboxes. For example:
17886 .code
17887 localusers:
17888   driver = accept
17889   domains = mydomain.example
17890   check_local_user
17891   transport = local_delivery
17892 .endd
17893 The &%domains%& condition in this example checks the domain of the address, and
17894 &%check_local_user%& checks that the local part is the login of a local user.
17895 When both preconditions are met, the &(accept)& router runs, and queues the
17896 address for the &(local_delivery)& transport.
17897
17898
17899
17900
17901
17902
17903 . ////////////////////////////////////////////////////////////////////////////
17904 . ////////////////////////////////////////////////////////////////////////////
17905
17906 .chapter "The dnslookup router" "CHAPdnslookup"
17907 .scindex IIDdnsrou1 "&(dnslookup)& router"
17908 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17909 The &(dnslookup)& router looks up the hosts that handle mail for the
17910 recipient's domain in the DNS. A transport must always be set for this router,
17911 unless &%verify_only%& is set.
17912
17913 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17914 SRV records. If none are found, or if SRV support is not configured,
17915 MX records are looked up. If no MX records exist, address records are sought.
17916 However, &%mx_domains%& can be set to disable the direct use of address
17917 records.
17918
17919 MX records of equal priority are sorted by Exim into a random order. Exim then
17920 looks for address records for the host names obtained from MX or SRV records.
17921 When a host has more than one IP address, they are sorted into a random order,
17922 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17923 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17924 generic option, the router declines.
17925
17926 Unless they have the highest priority (lowest MX value), MX records that point
17927 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17928 are discarded, together with any other MX records of equal or lower priority.
17929
17930 .cindex "MX record" "pointing to local host"
17931 .cindex "local host" "MX pointing to"
17932 .oindex "&%self%&" "in &(dnslookup)& router"
17933 If the host pointed to by the highest priority MX record, or looked up as an
17934 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17935 happens is controlled by the generic &%self%& option.
17936
17937
17938 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17939 There have been problems with DNS servers when SRV records are looked up.
17940 Some mis-behaving servers return a DNS error or timeout when a non-existent
17941 SRV record is sought. Similar problems have in the past been reported for
17942 MX records. The global &%dns_again_means_nonexist%& option can help with this
17943 problem, but it is heavy-handed because it is a global option.
17944
17945 For this reason, there are two options, &%srv_fail_domains%& and
17946 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17947 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17948 an attempt to look up an SRV or MX record causes one of these results, and the
17949 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17950 such record"&. In the case of an SRV lookup, this means that the router
17951 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17952 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17953 case routing fails.
17954
17955
17956 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17957 .cindex "&(dnslookup)& router" "declines"
17958 There are a few cases where a &(dnslookup)& router will decline to accept
17959 an address; if such a router is expected to handle "all remaining non-local
17960 domains", then it is important to set &%no_more%&.
17961
17962 Reasons for a &(dnslookup)& router to decline currently include:
17963 .ilist
17964 The domain does not exist in DNS
17965 .next
17966 The domain exists but the MX record's host part is just "."; this is a common
17967 convention (borrowed from SRV) used to indicate that there is no such service
17968 for this domain and to not fall back to trying A/AAAA records.
17969 .next
17970 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17971 .next
17972 MX record points to a non-existent host.
17973 .next
17974 MX record points to an IP address and the main section option
17975 &%allow_mx_to_ip%& is not set.
17976 .next
17977 MX records exist and point to valid hosts, but all hosts resolve only to
17978 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17979 .next
17980 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17981 &%dns_check_names_pattern%& for handling one variant of this)
17982 .next
17983 &%check_secondary_mx%& is set on this router but the local host can
17984 not be found in the MX records (see below)
17985 .endlist
17986
17987
17988
17989
17990 .section "Private options for dnslookup" "SECID118"
17991 .cindex "options" "&(dnslookup)& router"
17992 The private options for the &(dnslookup)& router are as follows:
17993
17994 .option check_secondary_mx dnslookup boolean false
17995 .cindex "MX record" "checking for secondary"
17996 If this option is set, the router declines unless the local host is found in
17997 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17998 process domains for which the local host is a secondary mail exchanger
17999 differently to other domains. The way in which Exim decides whether a host is
18000 the local host is described in section &<<SECTreclocipadd>>&.
18001
18002
18003 .option check_srv dnslookup string&!! unset
18004 .cindex "SRV record" "enabling use of"
18005 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18006 addition to MX and address records. The support is disabled by default. To
18007 enable SRV support, set the &%check_srv%& option to the name of the service
18008 required. For example,
18009 .code
18010 check_srv = smtp
18011 .endd
18012 looks for SRV records that refer to the normal smtp service. The option is
18013 expanded, so the service name can vary from message to message or address
18014 to address. This might be helpful if SRV records are being used for a
18015 submission service. If the expansion is forced to fail, the &%check_srv%&
18016 option is ignored, and the router proceeds to look for MX records in the
18017 normal way.
18018
18019 When the expansion succeeds, the router searches first for SRV records for
18020 the given service (it assumes TCP protocol). A single SRV record with a
18021 host name that consists of just a single dot indicates &"no such service for
18022 this domain"&; if this is encountered, the router declines. If other kinds of
18023 SRV record are found, they are used to construct a host list for delivery
18024 according to the rules of RFC 2782. MX records are not sought in this case.
18025
18026 When no SRV records are found, MX records (and address records) are sought in
18027 the traditional way. In other words, SRV records take precedence over MX
18028 records, just as MX records take precedence over address records. Note that
18029 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18030 defined it. It is apparently believed that MX records are sufficient for email
18031 and that SRV records should not be used for this purpose. However, SRV records
18032 have an additional &"weight"& feature which some people might find useful when
18033 trying to split an SMTP load between hosts of different power.
18034
18035 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18036 when there is a DNS lookup error.
18037
18038
18039
18040 .option dnssec_request_domains dnslookup "domain list&!!" unset
18041 .cindex "MX record" "security"
18042 .cindex "DNSSEC" "MX lookup"
18043 .cindex "security" "MX lookup"
18044 .cindex "DNS" "DNSSEC"
18045 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18046 the dnssec request bit set.
18047 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18048
18049
18050
18051 .option dnssec_require_domains dnslookup "domain list&!!" unset
18052 .cindex "MX record" "security"
18053 .cindex "DNSSEC" "MX lookup"
18054 .cindex "security" "MX lookup"
18055 .cindex "DNS" "DNSSEC"
18056 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18057 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18058 (AD bit) set wil be ignored and logged as a host-lookup failure.
18059 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18060
18061
18062
18063 .option mx_domains dnslookup "domain list&!!" unset
18064 .cindex "MX record" "required to exist"
18065 .cindex "SRV record" "required to exist"
18066 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18067 record in order to be recognized. (The name of this option could be improved.)
18068 For example, if all the mail hosts in &'fict.example'& are known to have MX
18069 records, except for those in &'discworld.fict.example'&, you could use this
18070 setting:
18071 .code
18072 mx_domains = ! *.discworld.fict.example : *.fict.example
18073 .endd
18074 This specifies that messages addressed to a domain that matches the list but
18075 has no MX record should be bounced immediately instead of being routed using
18076 the address record.
18077
18078
18079 .option mx_fail_domains dnslookup "domain list&!!" unset
18080 If the DNS lookup for MX records for one of the domains in this list causes a
18081 DNS lookup error, Exim behaves as if no MX records were found. See section
18082 &<<SECTprowitdnsloo>>& for more discussion.
18083
18084
18085
18086
18087 .option qualify_single dnslookup boolean true
18088 .cindex "DNS" "resolver options"
18089 .cindex "DNS" "qualifying single-component names"
18090 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18091 lookups. Typically, but not standardly, this causes the resolver to qualify
18092 single-component names with the default domain. For example, on a machine
18093 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18094 &'thesaurus.ref.example'& inside the resolver. For details of what your
18095 resolver actually does, consult your man pages for &'resolver'& and
18096 &'resolv.conf'&.
18097
18098
18099
18100 .option rewrite_headers dnslookup boolean true
18101 .cindex "rewriting" "header lines"
18102 .cindex "header lines" "rewriting"
18103 If the domain name in the address that is being processed is not fully
18104 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18105 an address is specified as &'dormouse@teaparty'&, the domain might be
18106 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18107 occur as a result of setting the &%widen_domains%& option. If
18108 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18109 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18110 header lines of the message are rewritten with the full domain name.
18111
18112 This option should be turned off only when it is known that no message is
18113 ever going to be sent outside an environment where the abbreviation makes
18114 sense.
18115
18116 When an MX record is looked up in the DNS and matches a wildcard record, name
18117 servers normally return a record containing the name that has been looked up,
18118 making it impossible to detect whether a wildcard was present or not. However,
18119 some name servers have recently been seen to return the wildcard entry. If the
18120 name returned by a DNS lookup begins with an asterisk, it is not used for
18121 header rewriting.
18122
18123
18124 .option same_domain_copy_routing dnslookup boolean false
18125 .cindex "address" "copying routing"
18126 Addresses with the same domain are normally routed by the &(dnslookup)& router
18127 to the same list of hosts. However, this cannot be presumed, because the router
18128 options and preconditions may refer to the local part of the address. By
18129 default, therefore, Exim routes each address in a message independently. DNS
18130 servers run caches, so repeated DNS lookups are not normally expensive, and in
18131 any case, personal messages rarely have more than a few recipients.
18132
18133 If you are running mailing lists with large numbers of subscribers at the same
18134 domain, and you are using a &(dnslookup)& router which is independent of the
18135 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18136 lookups for identical domains in one message. In this case, when &(dnslookup)&
18137 routes an address to a remote transport, any other unrouted addresses in the
18138 message that have the same domain are automatically given the same routing
18139 without processing them independently,
18140 provided the following conditions are met:
18141
18142 .ilist
18143 No router that processed the address specified &%headers_add%& or
18144 &%headers_remove%&.
18145 .next
18146 The router did not change the address in any way, for example, by &"widening"&
18147 the domain.
18148 .endlist
18149
18150
18151
18152
18153 .option search_parents dnslookup boolean false
18154 .cindex "DNS" "resolver options"
18155 When this option is true, the resolver option RES_DNSRCH is set for DNS
18156 lookups. This is different from the &%qualify_single%& option in that it
18157 applies to domains containing dots. Typically, but not standardly, it causes
18158 the resolver to search for the name in the current domain and in parent
18159 domains. For example, on a machine in the &'fict.example'& domain, if looking
18160 up &'teaparty.wonderland'& failed, the resolver would try
18161 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18162 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18163
18164 Setting this option true can cause problems in domains that have a wildcard MX
18165 record, because any domain that does not have its own MX record matches the
18166 local wildcard.
18167
18168
18169
18170 .option srv_fail_domains dnslookup "domain list&!!" unset
18171 If the DNS lookup for SRV records for one of the domains in this list causes a
18172 DNS lookup error, Exim behaves as if no SRV records were found. See section
18173 &<<SECTprowitdnsloo>>& for more discussion.
18174
18175
18176
18177
18178 .option widen_domains dnslookup "string list" unset
18179 .cindex "domain" "partial; widening"
18180 If a DNS lookup fails and this option is set, each of its strings in turn is
18181 added onto the end of the domain, and the lookup is tried again. For example,
18182 if
18183 .code
18184 widen_domains = fict.example:ref.example
18185 .endd
18186 is set and a lookup of &'klingon.dictionary'& fails,
18187 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18188 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18189 and &%search_parents%& options can cause some widening to be undertaken inside
18190 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18191 when verifying, unless &%rewrite_headers%& is false (not the default).
18192
18193
18194 .section "Effect of qualify_single and search_parents" "SECID119"
18195 When a domain from an envelope recipient is changed by the resolver as a result
18196 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18197 corresponding address in the message's header lines unless &%rewrite_headers%&
18198 is set false. Exim then re-routes the address, using the full domain.
18199
18200 These two options affect only the DNS lookup that takes place inside the router
18201 for the domain of the address that is being routed. They do not affect lookups
18202 such as that implied by
18203 .code
18204 domains = @mx_any
18205 .endd
18206 that may happen while processing a router precondition before the router is
18207 entered. No widening ever takes place for these lookups.
18208 .ecindex IIDdnsrou1
18209 .ecindex IIDdnsrou2
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219 . ////////////////////////////////////////////////////////////////////////////
18220 . ////////////////////////////////////////////////////////////////////////////
18221
18222 .chapter "The ipliteral router" "CHID5"
18223 .cindex "&(ipliteral)& router"
18224 .cindex "domain literal" "routing"
18225 .cindex "routers" "&(ipliteral)&"
18226 This router has no private options. Unless it is being used purely for
18227 verification (see &%verify_only%&) a transport is required to be defined by the
18228 generic &%transport%& option. The router accepts the address if its domain part
18229 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18230 router handles the address
18231 .code
18232 root@[192.168.1.1]
18233 .endd
18234 by setting up delivery to the host with that IP address. IPv4 domain literals
18235 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18236 are similar, but the address is preceded by &`ipv6:`&. For example:
18237 .code
18238 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18239 .endd
18240 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18241 grounds that sooner or later somebody will try it.
18242
18243 .oindex "&%self%&" "in &(ipliteral)& router"
18244 If the IP address matches something in &%ignore_target_hosts%&, the router
18245 declines. If an IP literal turns out to refer to the local host, the generic
18246 &%self%& option determines what happens.
18247
18248 The RFCs require support for domain literals; however, their use is
18249 controversial in today's Internet. If you want to use this router, you must
18250 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18251 Exim will not recognize the domain literal syntax in addresses.
18252
18253
18254
18255 . ////////////////////////////////////////////////////////////////////////////
18256 . ////////////////////////////////////////////////////////////////////////////
18257
18258 .chapter "The iplookup router" "CHID6"
18259 .cindex "&(iplookup)& router"
18260 .cindex "routers" "&(iplookup)&"
18261 The &(iplookup)& router was written to fulfil a specific requirement in
18262 Cambridge University (which in fact no longer exists). For this reason, it is
18263 not included in the binary of Exim by default. If you want to include it, you
18264 must set
18265 .code
18266 ROUTER_IPLOOKUP=yes
18267 .endd
18268 in your &_Local/Makefile_& configuration file.
18269
18270 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18271 connection to one or more specific hosts. The host can then return the same or
18272 a different address &-- in effect rewriting the recipient address in the
18273 message's envelope. The new address is then passed on to subsequent routers. If
18274 this process fails, the address can be passed on to other routers, or delivery
18275 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18276 must not be specified for it.
18277
18278 .cindex "options" "&(iplookup)& router"
18279 .option hosts iplookup string unset
18280 This option must be supplied. Its value is a colon-separated list of host
18281 names. The hosts are looked up using &[gethostbyname()]&
18282 (or &[getipnodebyname()]& when available)
18283 and are tried in order until one responds to the query. If none respond, what
18284 happens is controlled by &%optional%&.
18285
18286
18287 .option optional iplookup boolean false
18288 If &%optional%& is true, if no response is obtained from any host, the address
18289 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18290 delivery to the address is deferred.
18291
18292
18293 .option port iplookup integer 0
18294 .cindex "port" "&(iplookup)& router"
18295 This option must be supplied. It specifies the port number for the TCP or UDP
18296 call.
18297
18298
18299 .option protocol iplookup string udp
18300 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18301 protocols is to be used.
18302
18303
18304 .option query iplookup string&!! "see below"
18305 This defines the content of the query that is sent to the remote hosts. The
18306 default value is:
18307 .code
18308 $local_part@$domain $local_part@$domain
18309 .endd
18310 The repetition serves as a way of checking that a response is to the correct
18311 query in the default case (see &%response_pattern%& below).
18312
18313
18314 .option reroute iplookup string&!! unset
18315 If this option is not set, the rerouted address is precisely the byte string
18316 returned by the remote host, up to the first white space, if any. If set, the
18317 string is expanded to form the rerouted address. It can include parts matched
18318 in the response by &%response_pattern%& by means of numeric variables such as
18319 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18320 whether or not a pattern is in use. In all cases, the rerouted address must end
18321 up in the form &'local_part@domain'&.
18322
18323
18324 .option response_pattern iplookup string unset
18325 This option can be set to a regular expression that is applied to the string
18326 returned from the remote host. If the pattern does not match the response, the
18327 router declines. If &%response_pattern%& is not set, no checking of the
18328 response is done, unless the query was defaulted, in which case there is a
18329 check that the text returned after the first white space is the original
18330 address. This checks that the answer that has been received is in response to
18331 the correct question. For example, if the response is just a new domain, the
18332 following could be used:
18333 .code
18334 response_pattern = ^([^@]+)$
18335 reroute = $local_part@$1
18336 .endd
18337
18338 .option timeout iplookup time 5s
18339 This specifies the amount of time to wait for a response from the remote
18340 machine. The same timeout is used for the &[connect()]& function for a TCP
18341 call. It does not apply to UDP.
18342
18343
18344
18345
18346 . ////////////////////////////////////////////////////////////////////////////
18347 . ////////////////////////////////////////////////////////////////////////////
18348
18349 .chapter "The manualroute router" "CHID7"
18350 .scindex IIDmanrou1 "&(manualroute)& router"
18351 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18352 .cindex "domain" "manually routing"
18353 The &(manualroute)& router is so-called because it provides a way of manually
18354 routing an address according to its domain. It is mainly used when you want to
18355 route addresses to remote hosts according to your own rules, bypassing the
18356 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18357 route to local transports, a facility that may be useful if you want to save
18358 messages for dial-in hosts in local files.
18359
18360 The &(manualroute)& router compares a list of domain patterns with the domain
18361 it is trying to route. If there is no match, the router declines. Each pattern
18362 has associated with it a list of hosts and some other optional data, which may
18363 include a transport. The combination of a pattern and its data is called a
18364 &"routing rule"&. For patterns that do not have an associated transport, the
18365 generic &%transport%& option must specify a transport, unless the router is
18366 being used purely for verification (see &%verify_only%&).
18367
18368 .vindex "&$host$&"
18369 In the case of verification, matching the domain pattern is sufficient for the
18370 router to accept the address. When actually routing an address for delivery,
18371 an address that matches a domain pattern is queued for the associated
18372 transport. If the transport is not a local one, a host list must be associated
18373 with the pattern; IP addresses are looked up for the hosts, and these are
18374 passed to the transport along with the mail address. For local transports, a
18375 host list is optional. If it is present, it is passed in &$host$& as a single
18376 text string.
18377
18378 The list of routing rules can be provided as an inline string in
18379 &%route_list%&, or the data can be obtained by looking up the domain in a file
18380 or database by setting &%route_data%&. Only one of these settings may appear in
18381 any one instance of &(manualroute)&. The format of routing rules is described
18382 below, following the list of private options.
18383
18384
18385 .section "Private options for manualroute" "SECTprioptman"
18386
18387 .cindex "options" "&(manualroute)& router"
18388 The private options for the &(manualroute)& router are as follows:
18389
18390 .option host_all_ignored manualroute string defer
18391 See &%host_find_failed%&.
18392
18393 .option host_find_failed manualroute string freeze
18394 This option controls what happens when &(manualroute)& tries to find an IP
18395 address for a host, and the host does not exist. The option can be set to one
18396 of the following values:
18397 .code
18398 decline
18399 defer
18400 fail
18401 freeze
18402 ignore
18403 pass
18404 .endd
18405 The default (&"freeze"&) assumes that this state is a serious configuration
18406 error. The difference between &"pass"& and &"decline"& is that the former
18407 forces the address to be passed to the next router (or the router defined by
18408 &%pass_router%&),
18409 .oindex "&%more%&"
18410 overriding &%no_more%&, whereas the latter passes the address to the next
18411 router only if &%more%& is true.
18412
18413 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18414 cannot be found. If all the hosts in the list are ignored, the behaviour is
18415 controlled by the &%host_all_ignored%& option. This takes the same values
18416 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18417
18418 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18419 state; if a host lookup gets a temporary error, delivery is deferred unless the
18420 generic &%pass_on_timeout%& option is set.
18421
18422
18423 .option hosts_randomize manualroute boolean false
18424 .cindex "randomized host list"
18425 .cindex "host" "list of; randomized"
18426 If this option is set, the order of the items in a host list in a routing rule
18427 is randomized each time the list is used, unless an option in the routing rule
18428 overrides (see below). Randomizing the order of a host list can be used to do
18429 crude load sharing. However, if more than one mail address is routed by the
18430 same router to the same host list, the host lists are considered to be the same
18431 (even though they may be randomized into different orders) for the purpose of
18432 deciding whether to batch the deliveries into a single SMTP transaction.
18433
18434 When &%hosts_randomize%& is true, a host list may be split
18435 into groups whose order is separately randomized. This makes it possible to
18436 set up MX-like behaviour. The boundaries between groups are indicated by an
18437 item that is just &`+`& in the host list. For example:
18438 .code
18439 route_list = * host1:host2:host3:+:host4:host5
18440 .endd
18441 The order of the first three hosts and the order of the last two hosts is
18442 randomized for each use, but the first three always end up before the last two.
18443 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18444 randomized host list is passed to an &(smtp)& transport that also has
18445 &%hosts_randomize set%&, the list is not re-randomized.
18446
18447
18448 .option route_data manualroute string&!! unset
18449 If this option is set, it must expand to yield the data part of a routing rule.
18450 Typically, the expansion string includes a lookup based on the domain. For
18451 example:
18452 .code
18453 route_data = ${lookup{$domain}dbm{/etc/routes}}
18454 .endd
18455 If the expansion is forced to fail, or the result is an empty string, the
18456 router declines. Other kinds of expansion failure cause delivery to be
18457 deferred.
18458
18459
18460 .option route_list manualroute "string list" unset
18461 This string is a list of routing rules, in the form defined below. Note that,
18462 unlike most string lists, the items are separated by semicolons. This is so
18463 that they may contain colon-separated host lists.
18464
18465
18466 .option same_domain_copy_routing manualroute boolean false
18467 .cindex "address" "copying routing"
18468 Addresses with the same domain are normally routed by the &(manualroute)&
18469 router to the same list of hosts. However, this cannot be presumed, because the
18470 router options and preconditions may refer to the local part of the address. By
18471 default, therefore, Exim routes each address in a message independently. DNS
18472 servers run caches, so repeated DNS lookups are not normally expensive, and in
18473 any case, personal messages rarely have more than a few recipients.
18474
18475 If you are running mailing lists with large numbers of subscribers at the same
18476 domain, and you are using a &(manualroute)& router which is independent of the
18477 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18478 lookups for identical domains in one message. In this case, when
18479 &(manualroute)& routes an address to a remote transport, any other unrouted
18480 addresses in the message that have the same domain are automatically given the
18481 same routing without processing them independently. However, this is only done
18482 if &%headers_add%& and &%headers_remove%& are unset.
18483
18484
18485
18486
18487 .section "Routing rules in route_list" "SECID120"
18488 The value of &%route_list%& is a string consisting of a sequence of routing
18489 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18490 entered as two semicolons. Alternatively, the list separator can be changed as
18491 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18492 Empty rules are ignored. The format of each rule is
18493 .display
18494 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18495 .endd
18496 The following example contains two rules, each with a simple domain pattern and
18497 no options:
18498 .code
18499 route_list = \
18500   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18501   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18502 .endd
18503 The three parts of a rule are separated by white space. The pattern and the
18504 list of hosts can be enclosed in quotes if necessary, and if they are, the
18505 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18506 single domain pattern, which is the only mandatory item in the rule. The
18507 pattern is in the same format as one item in a domain list (see section
18508 &<<SECTdomainlist>>&),
18509 except that it may not be the name of an interpolated file.
18510 That is, it may be wildcarded, or a regular expression, or a file or database
18511 lookup (with semicolons doubled, because of the use of semicolon as a separator
18512 in a &%route_list%&).
18513
18514 The rules in &%route_list%& are searched in order until one of the patterns
18515 matches the domain that is being routed. The list of hosts and then options are
18516 then used as described below. If there is no match, the router declines. When
18517 &%route_list%& is set, &%route_data%& must not be set.
18518
18519
18520
18521 .section "Routing rules in route_data" "SECID121"
18522 The use of &%route_list%& is convenient when there are only a small number of
18523 routing rules. For larger numbers, it is easier to use a file or database to
18524 hold the routing information, and use the &%route_data%& option instead.
18525 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18526 Most commonly, &%route_data%& is set as a string that contains an
18527 expansion lookup. For example, suppose we place two routing rules in a file
18528 like this:
18529 .code
18530 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18531 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18532 .endd
18533 This data can be accessed by setting
18534 .code
18535 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18536 .endd
18537 Failure of the lookup results in an empty string, causing the router to
18538 decline. However, you do not have to use a lookup in &%route_data%&. The only
18539 requirement is that the result of expanding the string is a list of hosts,
18540 possibly followed by options, separated by white space. The list of hosts must
18541 be enclosed in quotes if it contains white space.
18542
18543
18544
18545
18546 .section "Format of the list of hosts" "SECID122"
18547 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18548 always separately expanded before use. If the expansion fails, the router
18549 declines. The result of the expansion must be a colon-separated list of names
18550 and/or IP addresses, optionally also including ports. The format of each item
18551 in the list is described in the next section. The list separator can be changed
18552 as described in section &<<SECTlistconstruct>>&.
18553
18554 If the list of hosts was obtained from a &%route_list%& item, the following
18555 variables are set during its expansion:
18556
18557 .ilist
18558 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18559 If the domain was matched against a regular expression, the numeric variables
18560 &$1$&, &$2$&, etc. may be set. For example:
18561 .code
18562 route_list = ^domain(\d+)   host-$1.text.example
18563 .endd
18564 .next
18565 &$0$& is always set to the entire domain.
18566 .next
18567 &$1$& is also set when partial matching is done in a file lookup.
18568
18569 .next
18570 .vindex "&$value$&"
18571 If the pattern that matched the domain was a lookup item, the data that was
18572 looked up is available in the expansion variable &$value$&. For example:
18573 .code
18574 route_list = lsearch;;/some/file.routes  $value
18575 .endd
18576 .endlist
18577
18578 Note the doubling of the semicolon in the pattern that is necessary because
18579 semicolon is the default route list separator.
18580
18581
18582
18583 .section "Format of one host item" "SECTformatonehostitem"
18584 Each item in the list of hosts is either a host name or an IP address,
18585 optionally with an attached port number. When no port is given, an IP address
18586 is not enclosed in brackets. When a port is specified, it overrides the port
18587 specification on the transport. The port is separated from the name or address
18588 by a colon. This leads to some complications:
18589
18590 .ilist
18591 Because colon is the default separator for the list of hosts, either
18592 the colon that specifies a port must be doubled, or the list separator must
18593 be changed. The following two examples have the same effect:
18594 .code
18595 route_list = * "host1.tld::1225 : host2.tld::1226"
18596 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18597 .endd
18598 .next
18599 When IPv6 addresses are involved, it gets worse, because they contain
18600 colons of their own. To make this case easier, it is permitted to
18601 enclose an IP address (either v4 or v6) in square brackets if a port
18602 number follows. For example:
18603 .code
18604 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18605 .endd
18606 .endlist
18607
18608 .section "How the list of hosts is used" "SECThostshowused"
18609 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18610 the hosts is tried, in the order specified, when carrying out the SMTP
18611 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18612 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18613 transport.
18614
18615 Hosts may be listed by name or by IP address. An unadorned name in the list of
18616 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18617 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18618 records in the DNS. For example:
18619 .code
18620 route_list = *  x.y.z:p.q.r/MX:e.f.g
18621 .endd
18622 If this feature is used with a port specifier, the port must come last. For
18623 example:
18624 .code
18625 route_list = *  dom1.tld/mx::1225
18626 .endd
18627 If the &%hosts_randomize%& option is set, the order of the items in the list is
18628 randomized before any lookups are done. Exim then scans the list; for any name
18629 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18630 be an interface on the local host and the item is not the first in the list,
18631 Exim discards it and any subsequent items. If it is the first item, what
18632 happens is controlled by the
18633 .oindex "&%self%&" "in &(manualroute)& router"
18634 &%self%& option of the router.
18635
18636 A name on the list that is followed by &`/MX`& is replaced with the list of
18637 hosts obtained by looking up MX records for the name. This is always a DNS
18638 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18639 below) are not relevant here. The order of these hosts is determined by the
18640 preference values in the MX records, according to the usual rules. Because
18641 randomizing happens before the MX lookup, it does not affect the order that is
18642 defined by MX preferences.
18643
18644 If the local host is present in the sublist obtained from MX records, but is
18645 not the most preferred host in that list, it and any equally or less
18646 preferred hosts are removed before the sublist is inserted into the main list.
18647
18648 If the local host is the most preferred host in the MX list, what happens
18649 depends on where in the original list of hosts the &`/MX`& item appears. If it
18650 is not the first item (that is, there are previous hosts in the main list),
18651 Exim discards this name and any subsequent items in the main list.
18652
18653 If the MX item is first in the list of hosts, and the local host is the
18654 most preferred host, what happens is controlled by the &%self%& option of the
18655 router.
18656
18657 DNS failures when lookup up the MX records are treated in the same way as DNS
18658 failures when looking up IP addresses: &%pass_on_timeout%& and
18659 &%host_find_failed%& are used when relevant.
18660
18661 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18662 whether obtained from an MX lookup or not.
18663
18664
18665
18666 .section "How the options are used" "SECThowoptused"
18667 The options are a sequence of words; in practice no more than three are ever
18668 present. One of the words can be the name of a transport; this overrides the
18669 &%transport%& option on the router for this particular routing rule only. The
18670 other words (if present) control randomization of the list of hosts on a
18671 per-rule basis, and how the IP addresses of the hosts are to be found when
18672 routing to a remote transport. These options are as follows:
18673
18674 .ilist
18675 &%randomize%&: randomize the order of the hosts in this list, overriding the
18676 setting of &%hosts_randomize%& for this routing rule only.
18677 .next
18678 &%no_randomize%&: do not randomize the order of the hosts in this list,
18679 overriding the setting of &%hosts_randomize%& for this routing rule only.
18680 .next
18681 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18682 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18683 also look in &_/etc/hosts_& or other sources of information.
18684 .next
18685 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18686 no address records are found. If there is a temporary DNS error (such as a
18687 timeout), delivery is deferred.
18688 .endlist
18689
18690 For example:
18691 .code
18692 route_list = domain1  host1:host2:host3  randomize bydns;\
18693              domain2  host4:host5
18694 .endd
18695 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18696 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18697 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18698 or &[gethostbyname()]&, and the result of the lookup is the result of that
18699 call.
18700
18701 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18702 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18703 instead of TRY_AGAIN. That is why the default action is to try a DNS
18704 lookup first. Only if that gives a definite &"no such host"& is the local
18705 function called.
18706
18707
18708
18709 If no IP address for a host can be found, what happens is controlled by the
18710 &%host_find_failed%& option.
18711
18712 .vindex "&$host$&"
18713 When an address is routed to a local transport, IP addresses are not looked up.
18714 The host list is passed to the transport in the &$host$& variable.
18715
18716
18717
18718 .section "Manualroute examples" "SECID123"
18719 In some of the examples that follow, the presence of the &%remote_smtp%&
18720 transport, as defined in the default configuration file, is assumed:
18721
18722 .ilist
18723 .cindex "smart host" "example router"
18724 The &(manualroute)& router can be used to forward all external mail to a
18725 &'smart host'&. If you have set up, in the main part of the configuration, a
18726 named domain list that contains your local domains, for example:
18727 .code
18728 domainlist local_domains = my.domain.example
18729 .endd
18730 You can arrange for all other domains to be routed to a smart host by making
18731 your first router something like this:
18732 .code
18733 smart_route:
18734   driver = manualroute
18735   domains = !+local_domains
18736   transport = remote_smtp
18737   route_list = * smarthost.ref.example
18738 .endd
18739 This causes all non-local addresses to be sent to the single host
18740 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18741 they are tried in order
18742 (but you can use &%hosts_randomize%& to vary the order each time).
18743 Another way of configuring the same thing is this:
18744 .code
18745 smart_route:
18746   driver = manualroute
18747   transport = remote_smtp
18748   route_list = !+local_domains  smarthost.ref.example
18749 .endd
18750 There is no difference in behaviour between these two routers as they stand.
18751 However, they behave differently if &%no_more%& is added to them. In the first
18752 example, the router is skipped if the domain does not match the &%domains%&
18753 precondition; the following router is always tried. If the router runs, it
18754 always matches the domain and so can never decline. Therefore, &%no_more%&
18755 would have no effect. In the second case, the router is never skipped; it
18756 always runs. However, if it doesn't match the domain, it declines. In this case
18757 &%no_more%& would prevent subsequent routers from running.
18758
18759 .next
18760 .cindex "mail hub example"
18761 A &'mail hub'& is a host which receives mail for a number of domains via MX
18762 records in the DNS and delivers it via its own private routing mechanism. Often
18763 the final destinations are behind a firewall, with the mail hub being the one
18764 machine that can connect to machines both inside and outside the firewall. The
18765 &(manualroute)& router is usually used on a mail hub to route incoming messages
18766 to the correct hosts. For a small number of domains, the routing can be inline,
18767 using the &%route_list%& option, but for a larger number a file or database
18768 lookup is easier to manage.
18769
18770 If the domain names are in fact the names of the machines to which the mail is
18771 to be sent by the mail hub, the configuration can be quite simple. For
18772 example:
18773 .code
18774 hub_route:
18775   driver = manualroute
18776   transport = remote_smtp
18777   route_list = *.rhodes.tvs.example  $domain
18778 .endd
18779 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18780 whose names are the same as the mail domains. A similar approach can be taken
18781 if the host name can be obtained from the domain name by a string manipulation
18782 that the expansion facilities can handle. Otherwise, a lookup based on the
18783 domain can be used to find the host:
18784 .code
18785 through_firewall:
18786   driver = manualroute
18787   transport = remote_smtp
18788   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18789 .endd
18790 The result of the lookup must be the name or IP address of the host (or
18791 hosts) to which the address is to be routed. If the lookup fails, the route
18792 data is empty, causing the router to decline. The address then passes to the
18793 next router.
18794
18795 .next
18796 .cindex "batched SMTP output example"
18797 .cindex "SMTP" "batched outgoing; example"
18798 You can use &(manualroute)& to deliver messages to pipes or files in batched
18799 SMTP format for onward transportation by some other means. This is one way of
18800 storing mail for a dial-up host when it is not connected. The route list entry
18801 can be as simple as a single domain name in a configuration like this:
18802 .code
18803 save_in_file:
18804   driver = manualroute
18805   transport = batchsmtp_appendfile
18806   route_list = saved.domain.example
18807 .endd
18808 though often a pattern is used to pick up more than one domain. If there are
18809 several domains or groups of domains with different transport requirements,
18810 different transports can be listed in the routing information:
18811 .code
18812 save_in_file:
18813   driver = manualroute
18814   route_list = \
18815     *.saved.domain1.example  $domain  batch_appendfile; \
18816     *.saved.domain2.example  \
18817       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18818       batch_pipe
18819 .endd
18820 .vindex "&$domain$&"
18821 .vindex "&$host$&"
18822 The first of these just passes the domain in the &$host$& variable, which
18823 doesn't achieve much (since it is also in &$domain$&), but the second does a
18824 file lookup to find a value to pass, causing the router to decline to handle
18825 the address if the lookup fails.
18826
18827 .next
18828 .cindex "UUCP" "example of router for"
18829 Routing mail directly to UUCP software is a specific case of the use of
18830 &(manualroute)& in a gateway to another mail environment. This is an example of
18831 one way it can be done:
18832 .code
18833 # Transport
18834 uucp:
18835   driver = pipe
18836   user = nobody
18837   command = /usr/local/bin/uux -r - \
18838     ${substr_-5:$host}!rmail ${local_part}
18839   return_fail_output = true
18840
18841 # Router
18842 uucphost:
18843   transport = uucp
18844   driver = manualroute
18845   route_data = \
18846     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18847 .endd
18848 The file &_/usr/local/exim/uucphosts_& contains entries like
18849 .code
18850 darksite.ethereal.example:           darksite.UUCP
18851 .endd
18852 It can be set up more simply without adding and removing &".UUCP"& but this way
18853 makes clear the distinction between the domain name
18854 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18855 .endlist
18856 .ecindex IIDmanrou1
18857 .ecindex IIDmanrou2
18858
18859
18860
18861
18862
18863
18864
18865
18866 . ////////////////////////////////////////////////////////////////////////////
18867 . ////////////////////////////////////////////////////////////////////////////
18868
18869 .chapter "The queryprogram router" "CHAPdriverlast"
18870 .scindex IIDquerou1 "&(queryprogram)& router"
18871 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18872 .cindex "routing" "by external program"
18873 The &(queryprogram)& router routes an address by running an external command
18874 and acting on its output. This is an expensive way to route, and is intended
18875 mainly for use in lightly-loaded systems, or for performing experiments.
18876 However, if it is possible to use the precondition options (&%domains%&,
18877 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18878 be used in special cases, even on a busy host. There are the following private
18879 options:
18880 .cindex "options" "&(queryprogram)& router"
18881
18882 .option command queryprogram string&!! unset
18883 This option must be set. It specifies the command that is to be run. The
18884 command is split up into a command name and arguments, and then each is
18885 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18886 &<<CHAPpipetransport>>&).
18887
18888
18889 .option command_group queryprogram string unset
18890 .cindex "gid (group id)" "in &(queryprogram)& router"
18891 This option specifies a gid to be set when running the command while routing an
18892 address for deliver. It must be set if &%command_user%& specifies a numerical
18893 uid. If it begins with a digit, it is interpreted as the numerical value of the
18894 gid. Otherwise it is looked up using &[getgrnam()]&.
18895
18896
18897 .option command_user queryprogram string unset
18898 .cindex "uid (user id)" "for &(queryprogram)&"
18899 This option must be set. It specifies the uid which is set when running the
18900 command while routing an address for delivery. If the value begins with a digit,
18901 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18902 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18903 not set, a value for the gid also.
18904
18905 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18906 root, which it does during a normal delivery in a conventional configuration.
18907 However, when an address is being verified during message reception, Exim is
18908 usually running as the Exim user, not as root. If the &(queryprogram)& router
18909 is called from a non-root process, Exim cannot change uid or gid before running
18910 the command. In this circumstance the command runs under the current uid and
18911 gid.
18912
18913
18914 .option current_directory queryprogram string /
18915 This option specifies an absolute path which is made the current directory
18916 before running the command.
18917
18918
18919 .option timeout queryprogram time 1h
18920 If the command does not complete within the timeout period, its process group
18921 is killed and the message is frozen. A value of zero time specifies no
18922 timeout.
18923
18924
18925 The standard output of the command is connected to a pipe, which is read when
18926 the command terminates. It should consist of a single line of output,
18927 containing up to five fields, separated by white space. The maximum length of
18928 the line is 1023 characters. Longer lines are silently truncated. The first
18929 field is one of the following words (case-insensitive):
18930
18931 .ilist
18932 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18933 below).
18934 .next
18935 &'Decline'&: the router declines; pass the address to the next router, unless
18936 &%no_more%& is set.
18937 .next
18938 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18939 subsequent text on the line is an error message. If the router is run as part
18940 of address verification during an incoming SMTP message, the message is
18941 included in the SMTP response.
18942 .next
18943 &'Defer'&: routing could not be completed at this time; try again later. Any
18944 subsequent text on the line is an error message which is logged. It is not
18945 included in any SMTP response.
18946 .next
18947 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18948 .next
18949 &'Pass'&: pass the address to the next router (or the router specified by
18950 &%pass_router%&), overriding &%no_more%&.
18951 .next
18952 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18953 new addresses, which are routed independently, starting with the first router,
18954 or the router specified by &%redirect_router%&, if set.
18955 .endlist
18956
18957 When the first word is &'accept'&, the remainder of the line consists of a
18958 number of keyed data values, as follows (split into two lines here, to fit on
18959 the page):
18960 .code
18961 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18962 LOOKUP=byname|bydns DATA=<text>
18963 .endd
18964 The data items can be given in any order, and all are optional. If no transport
18965 is included, the transport specified by the generic &%transport%& option is
18966 used. The list of hosts and the lookup type are needed only if the transport is
18967 an &(smtp)& transport that does not itself supply a list of hosts.
18968
18969 The format of the list of hosts is the same as for the &(manualroute)& router.
18970 As well as host names and IP addresses with optional port numbers, as described
18971 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18972 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18973 (see section &<<SECThostshowused>>&).
18974
18975 If the lookup type is not specified, Exim behaves as follows when trying to
18976 find an IP address for each host: First, a DNS lookup is done. If this yields
18977 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18978 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18979 result of the lookup is the result of that call.
18980
18981 .vindex "&$address_data$&"
18982 If the DATA field is set, its value is placed in the &$address_data$&
18983 variable. For example, this return line
18984 .code
18985 accept hosts=x1.y.example:x2.y.example data="rule1"
18986 .endd
18987 routes the address to the default transport, passing a list of two hosts. When
18988 the transport runs, the string &"rule1"& is in &$address_data$&.
18989 .ecindex IIDquerou1
18990 .ecindex IIDquerou2
18991
18992
18993
18994
18995 . ////////////////////////////////////////////////////////////////////////////
18996 . ////////////////////////////////////////////////////////////////////////////
18997
18998 .chapter "The redirect router" "CHAPredirect"
18999 .scindex IIDredrou1 "&(redirect)& router"
19000 .scindex IIDredrou2 "routers" "&(redirect)&"
19001 .cindex "alias file" "in a &(redirect)& router"
19002 .cindex "address redirection" "&(redirect)& router"
19003 The &(redirect)& router handles several kinds of address redirection. Its most
19004 common uses are for resolving local part aliases from a central alias file
19005 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19006 files, but it has many other potential uses. The incoming address can be
19007 redirected in several different ways:
19008
19009 .ilist
19010 It can be replaced by one or more new addresses which are themselves routed
19011 independently.
19012 .next
19013 It can be routed to be delivered to a given file or directory.
19014 .next
19015 It can be routed to be delivered to a specified pipe command.
19016 .next
19017 It can cause an automatic reply to be generated.
19018 .next
19019 It can be forced to fail, optionally with a custom error message.
19020 .next
19021 It can be temporarily deferred, optionally with a custom message.
19022 .next
19023 It can be discarded.
19024 .endlist
19025
19026 The generic &%transport%& option must not be set for &(redirect)& routers.
19027 However, there are some private options which define transports for delivery to
19028 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19029 &%pipe_transport%& and &%reply_transport%& descriptions below.
19030
19031 .new
19032 If success DSNs have been requested
19033 .cindex "DSN" "success"
19034 .cindex "Delivery Status Notification" "success"
19035 redirection triggers one and the DSN options are not passed any further.
19036 .wen
19037
19038
19039
19040 .section "Redirection data" "SECID124"
19041 The router operates by interpreting a text string which it obtains either by
19042 expanding the contents of the &%data%& option, or by reading the entire
19043 contents of a file whose name is given in the &%file%& option. These two
19044 options are mutually exclusive. The first is commonly used for handling system
19045 aliases, in a configuration like this:
19046 .code
19047 system_aliases:
19048   driver = redirect
19049   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19050 .endd
19051 If the lookup fails, the expanded string in this example is empty. When the
19052 expansion of &%data%& results in an empty string, the router declines. A forced
19053 expansion failure also causes the router to decline; other expansion failures
19054 cause delivery to be deferred.
19055
19056 A configuration using &%file%& is commonly used for handling users'
19057 &_.forward_& files, like this:
19058 .code
19059 userforward:
19060   driver = redirect
19061   check_local_user
19062   file = $home/.forward
19063   no_verify
19064 .endd
19065 If the file does not exist, or causes no action to be taken (for example, it is
19066 empty or consists only of comments), the router declines. &*Warning*&: This
19067 is not the case when the file contains syntactically valid items that happen to
19068 yield empty addresses, for example, items containing only RFC 2822 address
19069 comments.
19070
19071
19072
19073 .section "Forward files and address verification" "SECID125"
19074 .cindex "address redirection" "while verifying"
19075 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19076 &_.forward_& files, as in the example above. There are two reasons for this:
19077
19078 .ilist
19079 When Exim is receiving an incoming SMTP message from a remote host, it is
19080 running under the Exim uid, not as root. Exim is unable to change uid to read
19081 the file as the user, and it may not be able to read it as the Exim user. So in
19082 practice the router may not be able to operate.
19083 .next
19084 However, even when the router can operate, the existence of a &_.forward_& file
19085 is unimportant when verifying an address. What should be checked is whether the
19086 local part is a valid user name or not. Cutting out the redirection processing
19087 saves some resources.
19088 .endlist
19089
19090
19091
19092
19093
19094
19095 .section "Interpreting redirection data" "SECID126"
19096 .cindex "Sieve filter" "specifying in redirection data"
19097 .cindex "filter" "specifying in redirection data"
19098 The contents of the data string, whether obtained from &%data%& or &%file%&,
19099 can be interpreted in two different ways:
19100
19101 .ilist
19102 If the &%allow_filter%& option is set true, and the data begins with the text
19103 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19104 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19105 respectively. Details of the syntax and semantics of filter files are described
19106 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19107 document is intended for use by end users.
19108 .next
19109 Otherwise, the data must be a comma-separated list of redirection items, as
19110 described in the next section.
19111 .endlist
19112
19113 When a message is redirected to a file (a &"mail folder"&), the file name given
19114 in a non-filter redirection list must always be an absolute path. A filter may
19115 generate a relative path &-- how this is handled depends on the transport's
19116 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19117 for the &(appendfile)& transport.
19118
19119
19120
19121 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19122 .cindex "address redirection" "non-filter list items"
19123 When the redirection data is not an Exim or Sieve filter, for example, if it
19124 comes from a conventional alias or forward file, it consists of a list of
19125 addresses, file names, pipe commands, or certain special items (see section
19126 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19127 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19128 depending on their default values. The items in the list are separated by
19129 commas or newlines.
19130 If a comma is required in an item, the entire item must be enclosed in double
19131 quotes.
19132
19133 Lines starting with a # character are comments, and are ignored, and # may
19134 also appear following a comma, in which case everything between the # and the
19135 next newline character is ignored.
19136
19137 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19138 double quotes are retained because some forms of mail address require their use
19139 (but never to enclose the entire address). In the following description,
19140 &"item"& refers to what remains after any surrounding double quotes have been
19141 removed.
19142
19143 .vindex "&$local_part$&"
19144 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19145 and the expansion contains a reference to &$local_part$&, you should make use
19146 of the &%quote_local_part%& expansion operator, in case the local part contains
19147 special characters. For example, to redirect all mail for the domain
19148 &'obsolete.example'&, retaining the existing local part, you could use this
19149 setting:
19150 .code
19151 data = ${quote_local_part:$local_part}@newdomain.example
19152 .endd
19153
19154
19155 .section "Redirecting to a local mailbox" "SECTredlocmai"
19156 .cindex "routing" "loops in"
19157 .cindex "loop" "while routing, avoidance of"
19158 .cindex "address redirection" "to local mailbox"
19159 A redirection item may safely be the same as the address currently under
19160 consideration. This does not cause a routing loop, because a router is
19161 automatically skipped if any ancestor of the address that is being processed
19162 is the same as the current address and was processed by the current router.
19163 Such an address is therefore passed to the following routers, so it is handled
19164 as if there were no redirection. When making this loop-avoidance test, the
19165 complete local part, including any prefix or suffix, is used.
19166
19167 .cindex "address redirection" "local part without domain"
19168 Specifying the same local part without a domain is a common usage in personal
19169 filter files when the user wants to have messages delivered to the local
19170 mailbox and also forwarded elsewhere. For example, the user whose login is
19171 &'cleo'& might have a &_.forward_& file containing this:
19172 .code
19173 cleo, cleopatra@egypt.example
19174 .endd
19175 .cindex "backslash in alias file"
19176 .cindex "alias file" "backslash in"
19177 For compatibility with other MTAs, such unqualified local parts may be
19178 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19179 it does make a difference if more than one domain is being handled
19180 synonymously.
19181
19182 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19183 2822 address that does not include a domain, the item is qualified using the
19184 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19185 addresses are qualified using the value in &%qualify_recipient%&, but you can
19186 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19187
19188 Care must be taken if there are alias names for local users.
19189 Consider an MTA handling a single local domain where the system alias file
19190 contains:
19191 .code
19192 Sam.Reman: spqr
19193 .endd
19194 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19195 messages in the local mailbox, and also forward copies elsewhere. He creates
19196 this forward file:
19197 .code
19198 Sam.Reman, spqr@reme.elsewhere.example
19199 .endd
19200 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19201 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19202 second time round, because it has previously routed it,
19203 and the following routers presumably cannot handle the alias. The forward file
19204 should really contain
19205 .code
19206 spqr, spqr@reme.elsewhere.example
19207 .endd
19208 but because this is such a common error, the &%check_ancestor%& option (see
19209 below) exists to provide a way to get round it. This is normally set on a
19210 &(redirect)& router that is handling users' &_.forward_& files.
19211
19212
19213
19214 .section "Special items in redirection lists" "SECTspecitredli"
19215 In addition to addresses, the following types of item may appear in redirection
19216 lists (that is, in non-filter redirection data):
19217
19218 .ilist
19219 .cindex "pipe" "in redirection list"
19220 .cindex "address redirection" "to pipe"
19221 An item is treated as a pipe command if it begins with &"|"& and does not parse
19222 as a valid RFC 2822 address that includes a domain. A transport for running the
19223 command must be specified by the &%pipe_transport%& option.
19224 Normally, either the router or the transport specifies a user and a group under
19225 which to run the delivery. The default is to use the Exim user and group.
19226
19227 Single or double quotes can be used for enclosing the individual arguments of
19228 the pipe command; no interpretation of escapes is done for single quotes. If
19229 the command contains a comma character, it is necessary to put the whole item
19230 in double quotes, for example:
19231 .code
19232 "|/some/command ready,steady,go"
19233 .endd
19234 since items in redirection lists are terminated by commas. Do not, however,
19235 quote just the command. An item such as
19236 .code
19237 |"/some/command ready,steady,go"
19238 .endd
19239 is interpreted as a pipe with a rather strange command name, and no arguments.
19240
19241 Note that the above example assumes that the text comes from a lookup source
19242 of some sort, so that the quotes are part of the data.  If composing a
19243 redirect router with a &%data%& option directly specifying this command, the
19244 quotes will be used by the configuration parser to define the extent of one
19245 string, but will not be passed down into the redirect router itself.  There
19246 are two main approaches to get around this: escape quotes to be part of the
19247 data itself, or avoid using this mechanism and instead create a custom
19248 transport with the &%command%& option set and reference that transport from
19249 an &%accept%& router.
19250
19251 .next
19252 .cindex "file" "in redirection list"
19253 .cindex "address redirection" "to file"
19254 An item is interpreted as a path name if it begins with &"/"& and does not
19255 parse as a valid RFC 2822 address that includes a domain. For example,
19256 .code
19257 /home/world/minbari
19258 .endd
19259 is treated as a file name, but
19260 .code
19261 /s=molari/o=babylon/@x400gate.way
19262 .endd
19263 is treated as an address. For a file name, a transport must be specified using
19264 the &%file_transport%& option. However, if the generated path name ends with a
19265 forward slash character, it is interpreted as a directory name rather than a
19266 file name, and &%directory_transport%& is used instead.
19267
19268 Normally, either the router or the transport specifies a user and a group under
19269 which to run the delivery. The default is to use the Exim user and group.
19270
19271 .cindex "&_/dev/null_&"
19272 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19273 bypassed at a high level, and the log entry shows &"**bypassed**"&
19274 instead of a transport name. In this case the user and group are not used.
19275
19276 .next
19277 .cindex "included address list"
19278 .cindex "address redirection" "included external list"
19279 If an item is of the form
19280 .code
19281 :include:<path name>
19282 .endd
19283 a list of further items is taken from the given file and included at that
19284 point. &*Note*&: Such a file can not be a filter file; it is just an
19285 out-of-line addition to the list. The items in the included list are separated
19286 by commas or newlines and are not subject to expansion. If this is the first
19287 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19288 the alias name. This example is incorrect:
19289 .code
19290 list1    :include:/opt/lists/list1
19291 .endd
19292 It must be given as
19293 .code
19294 list1:   :include:/opt/lists/list1
19295 .endd
19296 .next
19297 .cindex "address redirection" "to black hole"
19298 Sometimes you want to throw away mail to a particular local part. Making the
19299 &%data%& option expand to an empty string does not work, because that causes
19300 the router to decline. Instead, the alias item
19301 .cindex "black hole"
19302 .cindex "abandoning mail"
19303 &':blackhole:'& can be used. It does what its name implies. No delivery is
19304 done, and no error message is generated. This has the same effect as specifing
19305 &_/dev/null_& as a destination, but it can be independently disabled.
19306
19307 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19308 delivery is done for the original local part, even if other redirection items
19309 are present. If you are generating a multi-item list (for example, by reading a
19310 database) and need the ability to provide a no-op item, you must use
19311 &_/dev/null_&.
19312
19313 .next
19314 .cindex "delivery" "forcing failure"
19315 .cindex "delivery" "forcing deferral"
19316 .cindex "failing delivery" "forcing"
19317 .cindex "deferred delivery, forcing"
19318 .cindex "customizing" "failure message"
19319 An attempt to deliver a particular address can be deferred or forced to fail by
19320 redirection items of the form
19321 .code
19322 :defer:
19323 :fail:
19324 .endd
19325 respectively. When a redirection list contains such an item, it applies
19326 to the entire redirection; any other items in the list are ignored. Any
19327 text following &':fail:'& or &':defer:'& is placed in the error text
19328 associated with the failure. For example, an alias file might contain:
19329 .code
19330 X.Employee:  :fail: Gone away, no forwarding address
19331 .endd
19332 In the case of an address that is being verified from an ACL or as the subject
19333 of a
19334 .cindex "VRFY" "error text, display of"
19335 VRFY command, the text is included in the SMTP error response by
19336 default.
19337 .cindex "EXPN" "error text, display of"
19338 The text is not included in the response to an EXPN command. In non-SMTP cases
19339 the text is included in the error message that Exim generates.
19340
19341 .cindex "SMTP" "error codes"
19342 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19343 &':fail:'&. However, if the message starts with three digits followed by a
19344 space, optionally followed by an extended code of the form &'n.n.n'&, also
19345 followed by a space, and the very first digit is the same as the default error
19346 code, the code from the message is used instead. If the very first digit is
19347 incorrect, a panic error is logged, and the default code is used. You can
19348 suppress the use of the supplied code in a redirect router by setting the
19349 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19350 ignored.
19351
19352 .vindex "&$acl_verify_message$&"
19353 In an ACL, an explicitly provided message overrides the default, but the
19354 default message is available in the variable &$acl_verify_message$& and can
19355 therefore be included in a custom message if this is desired.
19356
19357 Normally the error text is the rest of the redirection list &-- a comma does
19358 not terminate it &-- but a newline does act as a terminator. Newlines are not
19359 normally present in alias expansions. In &(lsearch)& lookups they are removed
19360 as part of the continuation process, but they may exist in other kinds of
19361 lookup and in &':include:'& files.
19362
19363 During routing for message delivery (as opposed to verification), a redirection
19364 containing &':fail:'& causes an immediate failure of the incoming address,
19365 whereas &':defer:'& causes the message to remain on the queue so that a
19366 subsequent delivery attempt can happen at a later time. If an address is
19367 deferred for too long, it will ultimately fail, because the normal retry
19368 rules still apply.
19369
19370 .next
19371 .cindex "alias file" "exception to default"
19372 Sometimes it is useful to use a single-key search type with a default (see
19373 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19374 for exceptions to the default. These can be handled by aliasing them to
19375 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19376 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19377 results in an empty redirection list has the same effect.
19378 .endlist
19379
19380
19381 .section "Duplicate addresses" "SECTdupaddr"
19382 .cindex "duplicate addresses"
19383 .cindex "address duplicate, discarding"
19384 .cindex "pipe" "duplicated"
19385 Exim removes duplicate addresses from the list to which it is delivering, so as
19386 to deliver just one copy to each address. This does not apply to deliveries
19387 routed to pipes by different immediate parent addresses, but an indirect
19388 aliasing scheme of the type
19389 .code
19390 pipe:       |/some/command $local_part
19391 localpart1: pipe
19392 localpart2: pipe
19393 .endd
19394 does not work with a message that is addressed to both local parts, because
19395 when the second is aliased to the intermediate local part &"pipe"& it gets
19396 discarded as being the same as a previously handled address. However, a scheme
19397 such as
19398 .code
19399 localpart1: |/some/command $local_part
19400 localpart2: |/some/command $local_part
19401 .endd
19402 does result in two different pipe deliveries, because the immediate parents of
19403 the pipes are distinct.
19404
19405
19406
19407 .section "Repeated redirection expansion" "SECID128"
19408 .cindex "repeated redirection expansion"
19409 .cindex "address redirection" "repeated for each delivery attempt"
19410 When a message cannot be delivered to all of its recipients immediately,
19411 leading to two or more delivery attempts, redirection expansion is carried out
19412 afresh each time for those addresses whose children were not all previously
19413 delivered. If redirection is being used as a mailing list, this can lead to new
19414 members of the list receiving copies of old messages. The &%one_time%& option
19415 can be used to avoid this.
19416
19417
19418 .section "Errors in redirection lists" "SECID129"
19419 .cindex "address redirection" "errors"
19420 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19421 error is skipped, and an entry is written to the main log. This may be useful
19422 for mailing lists that are automatically managed. Otherwise, if an error is
19423 detected while generating the list of new addresses, the original address is
19424 deferred. See also &%syntax_errors_to%&.
19425
19426
19427
19428 .section "Private options for the redirect router" "SECID130"
19429
19430 .cindex "options" "&(redirect)& router"
19431 The private options for the &(redirect)& router are as follows:
19432
19433
19434 .option allow_defer redirect boolean false
19435 Setting this option allows the use of &':defer:'& in non-filter redirection
19436 data, or the &%defer%& command in an Exim filter file.
19437
19438
19439 .option allow_fail redirect boolean false
19440 .cindex "failing delivery" "from filter"
19441 If this option is true, the &':fail:'& item can be used in a redirection list,
19442 and the &%fail%& command may be used in an Exim filter file.
19443
19444
19445 .option allow_filter redirect boolean false
19446 .cindex "filter" "enabling use of"
19447 .cindex "Sieve filter" "enabling use of"
19448 Setting this option allows Exim to interpret redirection data that starts with
19449 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19450 are some features of Exim filter files that some administrators may wish to
19451 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19452
19453 It is also possible to lock out Exim filters or Sieve filters while allowing
19454 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19455
19456
19457 The filter is run using the uid and gid set by the generic &%user%& and
19458 &%group%& options. These take their defaults from the password data if
19459 &%check_local_user%& is set, so in the normal case of users' personal filter
19460 files, the filter is run as the relevant user. When &%allow_filter%& is set
19461 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19462
19463
19464
19465 .option allow_freeze redirect boolean false
19466 .cindex "freezing messages" "allowing in filter"
19467 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19468 This command is more normally encountered in system filters, and is disabled by
19469 default for redirection filters because it isn't something you usually want to
19470 let ordinary users do.
19471
19472
19473
19474 .option check_ancestor redirect boolean false
19475 This option is concerned with handling generated addresses that are the same
19476 as some address in the list of redirection ancestors of the current address.
19477 Although it is turned off by default in the code, it is set in the default
19478 configuration file for handling users' &_.forward_& files. It is recommended
19479 for this use of the &(redirect)& router.
19480
19481 When &%check_ancestor%& is set, if a generated address (including the domain)
19482 is the same as any ancestor of the current address, it is replaced by a copy of
19483 the current address. This helps in the case where local part A is aliased to B,
19484 and B has a &_.forward_& file pointing back to A. For example, within a single
19485 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19486 &_&~jb/.forward_& contains:
19487 .code
19488 \Joe.Bloggs, <other item(s)>
19489 .endd
19490 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19491 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19492 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19493 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19494 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19495 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19496 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19497 original address. See also the &%repeat_use%& option below.
19498
19499
19500 .option check_group redirect boolean "see below"
19501 When the &%file%& option is used, the group owner of the file is checked only
19502 when this option is set. The permitted groups are those listed in the
19503 &%owngroups%& option, together with the user's default group if
19504 &%check_local_user%& is set. If the file has the wrong group, routing is
19505 deferred. The default setting for this option is true if &%check_local_user%&
19506 is set and the &%modemask%& option permits the group write bit, or if the
19507 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19508
19509
19510
19511 .option check_owner redirect boolean "see below"
19512 When the &%file%& option is used, the owner of the file is checked only when
19513 this option is set. If &%check_local_user%& is set, the local user is
19514 permitted; otherwise the owner must be one of those listed in the &%owners%&
19515 option. The default value for this option is true if &%check_local_user%& or
19516 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19517
19518
19519 .option data redirect string&!! unset
19520 This option is mutually exclusive with &%file%&. One or other of them must be
19521 set, but not both. The contents of &%data%& are expanded, and then used as the
19522 list of forwarding items, or as a set of filtering instructions. If the
19523 expansion is forced to fail, or the result is an empty string or a string that
19524 has no effect (consists entirely of comments), the router declines.
19525
19526 When filtering instructions are used, the string must begin with &"#Exim
19527 filter"&, and all comments in the string, including this initial one, must be
19528 terminated with newline characters. For example:
19529 .code
19530 data = #Exim filter\n\
19531        if $h_to: contains Exim then save $home/mail/exim endif
19532 .endd
19533 If you are reading the data from a database where newlines cannot be included,
19534 you can use the &${sg}$& expansion item to turn the escape string of your
19535 choice into a newline.
19536
19537
19538 .option directory_transport redirect string&!! unset
19539 A &(redirect)& router sets up a direct delivery to a directory when a path name
19540 ending with a slash is specified as a new &"address"&. The transport used is
19541 specified by this option, which, after expansion, must be the name of a
19542 configured transport. This should normally be an &(appendfile)& transport.
19543
19544
19545 .option file redirect string&!! unset
19546 This option specifies the name of a file that contains the redirection data. It
19547 is mutually exclusive with the &%data%& option. The string is expanded before
19548 use; if the expansion is forced to fail, the router declines. Other expansion
19549 failures cause delivery to be deferred. The result of a successful expansion
19550 must be an absolute path. The entire file is read and used as the redirection
19551 data. If the data is an empty string or a string that has no effect (consists
19552 entirely of comments), the router declines.
19553
19554 .cindex "NFS" "checking for file existence"
19555 If the attempt to open the file fails with a &"does not exist"& error, Exim
19556 runs a check on the containing directory,
19557 unless &%ignore_enotdir%& is true (see below).
19558 If the directory does not appear to exist, delivery is deferred. This can
19559 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19560 is a mount problem. If the containing directory does exist, but the file does
19561 not, the router declines.
19562
19563
19564 .option file_transport redirect string&!! unset
19565 .vindex "&$address_file$&"
19566 A &(redirect)& router sets up a direct delivery to a file when a path name not
19567 ending in a slash is specified as a new &"address"&. The transport used is
19568 specified by this option, which, after expansion, must be the name of a
19569 configured transport. This should normally be an &(appendfile)& transport. When
19570 it is running, the file name is in &$address_file$&.
19571
19572
19573 .option filter_prepend_home redirect boolean true
19574 When this option is true, if a &(save)& command in an Exim filter specifies a
19575 relative path, and &$home$& is defined, it is automatically prepended to the
19576 relative path. If this option is set false, this action does not happen. The
19577 relative path is then passed to the transport unmodified.
19578
19579
19580 .option forbid_blackhole redirect boolean false
19581 If this option is true, the &':blackhole:'& item may not appear in a
19582 redirection list.
19583
19584
19585 .option forbid_exim_filter redirect boolean false
19586 If this option is set true, only Sieve filters are permitted when
19587 &%allow_filter%& is true.
19588
19589
19590
19591
19592 .option forbid_file redirect boolean false
19593 .cindex "delivery" "to file; forbidding"
19594 .cindex "Sieve filter" "forbidding delivery to a file"
19595 .cindex "Sieve filter" "&""keep""& facility; disabling"
19596 If this option is true, this router may not generate a new address that
19597 specifies delivery to a local file or directory, either from a filter or from a
19598 conventional forward file. This option is forced to be true if &%one_time%& is
19599 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19600 locks out the Sieve's &"keep"& facility.
19601
19602
19603 .option forbid_filter_dlfunc redirect boolean false
19604 .cindex "filter" "locking out certain features"
19605 If this option is true, string expansions in Exim filters are not allowed to
19606 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19607 functions.
19608
19609 .option forbid_filter_existstest redirect boolean false
19610 .cindex "expansion" "statting a file"
19611 If this option is true, string expansions in Exim filters are not allowed to
19612 make use of the &%exists%& condition or the &%stat%& expansion item.
19613
19614 .option forbid_filter_logwrite redirect boolean false
19615 If this option is true, use of the logging facility in Exim filters is not
19616 permitted. Logging is in any case available only if the filter is being run
19617 under some unprivileged uid (which is normally the case for ordinary users'
19618 &_.forward_& files).
19619
19620
19621 .option forbid_filter_lookup redirect boolean false
19622 If this option is true, string expansions in Exim filter files are not allowed
19623 to make use of &%lookup%& items.
19624
19625
19626 .option forbid_filter_perl redirect boolean false
19627 This option has an effect only if Exim is built with embedded Perl support. If
19628 it is true, string expansions in Exim filter files are not allowed to make use
19629 of the embedded Perl support.
19630
19631
19632 .option forbid_filter_readfile redirect boolean false
19633 If this option is true, string expansions in Exim filter files are not allowed
19634 to make use of &%readfile%& items.
19635
19636
19637 .option forbid_filter_readsocket redirect boolean false
19638 If this option is true, string expansions in Exim filter files are not allowed
19639 to make use of &%readsocket%& items.
19640
19641
19642 .option forbid_filter_reply redirect boolean false
19643 If this option is true, this router may not generate an automatic reply
19644 message. Automatic replies can be generated only from Exim or Sieve filter
19645 files, not from traditional forward files. This option is forced to be true if
19646 &%one_time%& is set.
19647
19648
19649 .option forbid_filter_run redirect boolean false
19650 If this option is true, string expansions in Exim filter files are not allowed
19651 to make use of &%run%& items.
19652
19653
19654 .option forbid_include redirect boolean false
19655 If this option is true, items of the form
19656 .code
19657 :include:<path name>
19658 .endd
19659 are not permitted in non-filter redirection lists.
19660
19661
19662 .option forbid_pipe redirect boolean false
19663 .cindex "delivery" "to pipe; forbidding"
19664 If this option is true, this router may not generate a new address which
19665 specifies delivery to a pipe, either from an Exim filter or from a conventional
19666 forward file. This option is forced to be true if &%one_time%& is set.
19667
19668
19669 .option forbid_sieve_filter redirect boolean false
19670 If this option is set true, only Exim filters are permitted when
19671 &%allow_filter%& is true.
19672
19673
19674 .cindex "SMTP" "error codes"
19675 .option forbid_smtp_code redirect boolean false
19676 If this option is set true, any SMTP error codes that are present at the start
19677 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19678 the default codes (451 and 550, respectively) are always used.
19679
19680
19681
19682
19683 .option hide_child_in_errmsg redirect boolean false
19684 .cindex "bounce message" "redirection details; suppressing"
19685 If this option is true, it prevents Exim from quoting a child address if it
19686 generates a bounce or delay message for it. Instead it says &"an address
19687 generated from <&'the top level address'&>"&. Of course, this applies only to
19688 bounces generated locally. If a message is forwarded to another host, &'its'&
19689 bounce may well quote the generated address.
19690
19691
19692 .option ignore_eacces redirect boolean false
19693 .cindex "EACCES"
19694 If this option is set and an attempt to open a redirection file yields the
19695 EACCES error (permission denied), the &(redirect)& router behaves as if the
19696 file did not exist.
19697
19698
19699 .option ignore_enotdir redirect boolean false
19700 .cindex "ENOTDIR"
19701 If this option is set and an attempt to open a redirection file yields the
19702 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19703 router behaves as if the file did not exist.
19704
19705 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19706 router that has the &%file%& option set discovers that the file does not exist
19707 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19708 against unmounted NFS directories. If the parent can not be statted, delivery
19709 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19710 is set, because that option tells Exim to ignore &"something on the path is not
19711 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19712 that some operating systems give ENOENT where others give ENOTDIR.
19713
19714
19715
19716 .option include_directory redirect string unset
19717 If this option is set, the path names of any &':include:'& items in a
19718 redirection list must start with this directory.
19719
19720
19721 .option modemask redirect "octal integer" 022
19722 This specifies mode bits which must not be set for a file specified by the
19723 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19724
19725
19726 .option one_time redirect boolean false
19727 .cindex "one-time aliasing/forwarding expansion"
19728 .cindex "alias file" "one-time expansion"
19729 .cindex "forward file" "one-time expansion"
19730 .cindex "mailing lists" "one-time expansion"
19731 .cindex "address redirection" "one-time expansion"
19732 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19733 files each time it tries to deliver a message causes a problem when one or more
19734 of the generated addresses fails be delivered at the first attempt. The problem
19735 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19736 but of what happens when the redirection list changes during the time that the
19737 message is on Exim's queue. This is particularly true in the case of mailing
19738 lists, where new subscribers might receive copies of messages that were posted
19739 before they subscribed.
19740
19741 If &%one_time%& is set and any addresses generated by the router fail to
19742 deliver at the first attempt, the failing addresses are added to the message as
19743 &"top level"& addresses, and the parent address that generated them is marked
19744 &"delivered"&. Thus, redirection does not happen again at the next delivery
19745 attempt.
19746
19747 &*Warning 1*&: Any header line addition or removal that is specified by this
19748 router would be lost if delivery did not succeed at the first attempt. For this
19749 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19750 permitted when &%one_time%& is set.
19751
19752 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19753 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19754 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19755
19756 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19757 &%one_time%&.
19758
19759 The original top-level address is remembered with each of the generated
19760 addresses, and is output in any log messages. However, any intermediate parent
19761 addresses are not recorded. This makes a difference to the log only if
19762 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19763 typically be used for mailing lists, where there is normally just one level of
19764 expansion.
19765
19766
19767 .option owners redirect "string list" unset
19768 .cindex "ownership" "alias file"
19769 .cindex "ownership" "forward file"
19770 .cindex "alias file" "ownership"
19771 .cindex "forward file" "ownership"
19772 This specifies a list of permitted owners for the file specified by &%file%&.
19773 This list is in addition to the local user when &%check_local_user%& is set.
19774 See &%check_owner%& above.
19775
19776
19777 .option owngroups redirect "string list" unset
19778 This specifies a list of permitted groups for the file specified by &%file%&.
19779 The list is in addition to the local user's primary group when
19780 &%check_local_user%& is set. See &%check_group%& above.
19781
19782
19783 .option pipe_transport redirect string&!! unset
19784 .vindex "&$address_pipe$&"
19785 A &(redirect)& router sets up a direct delivery to a pipe when a string
19786 starting with a vertical bar character is specified as a new &"address"&. The
19787 transport used is specified by this option, which, after expansion, must be the
19788 name of a configured transport. This should normally be a &(pipe)& transport.
19789 When the transport is run, the pipe command is in &$address_pipe$&.
19790
19791
19792 .option qualify_domain redirect string&!! unset
19793 .vindex "&$qualify_recipient$&"
19794 If this option is set, and an unqualified address (one without a domain) is
19795 generated, and that address would normally be qualified by the global setting
19796 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19797 expanding this string. If the expansion fails, the router declines. If you want
19798 to revert to the default, you can have the expansion generate
19799 &$qualify_recipient$&.
19800
19801 This option applies to all unqualified addresses generated by Exim filters,
19802 but for traditional &_.forward_& files, it applies only to addresses that are
19803 not preceded by a backslash. Sieve filters cannot generate unqualified
19804 addresses.
19805
19806 .option qualify_preserve_domain redirect boolean false
19807 .cindex "domain" "in redirection; preserving"
19808 .cindex "preserving domain in redirection"
19809 .cindex "address redirection" "domain; preserving"
19810 If this option is set, the router's local &%qualify_domain%& option must not be
19811 set (a configuration error occurs if it is). If an unqualified address (one
19812 without a domain) is generated, it is qualified with the domain of the parent
19813 address (the immediately preceding ancestor) instead of the global
19814 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19815 this applies whether or not the address is preceded by a backslash.
19816
19817
19818 .option repeat_use redirect boolean true
19819 If this option is set false, the router is skipped for a child address that has
19820 any ancestor that was routed by this router. This test happens before any of
19821 the other preconditions are tested. Exim's default anti-looping rules skip
19822 only when the ancestor is the same as the current address. See also
19823 &%check_ancestor%& above and the generic &%redirect_router%& option.
19824
19825
19826 .option reply_transport redirect string&!! unset
19827 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19828 &%vacation%& command is used in a filter file. The transport used is specified
19829 by this option, which, after expansion, must be the name of a configured
19830 transport. This should normally be an &(autoreply)& transport. Other transports
19831 are unlikely to do anything sensible or useful.
19832
19833
19834 .option rewrite redirect boolean true
19835 .cindex "address redirection" "disabling rewriting"
19836 If this option is set false, addresses generated by the router are not
19837 subject to address rewriting. Otherwise, they are treated like new addresses
19838 and are rewritten according to the global rewriting rules.
19839
19840
19841 .option sieve_subaddress redirect string&!! unset
19842 The value of this option is passed to a Sieve filter to specify the
19843 :subaddress part of an address.
19844
19845 .option sieve_useraddress redirect string&!! unset
19846 The value of this option is passed to a Sieve filter to specify the :user part
19847 of an address. However, if it is unset, the entire original local part
19848 (including any prefix or suffix) is used for :user.
19849
19850
19851 .option sieve_vacation_directory redirect string&!! unset
19852 .cindex "Sieve filter" "vacation directory"
19853 To enable the &"vacation"& extension for Sieve filters, you must set
19854 &%sieve_vacation_directory%& to the directory where vacation databases are held
19855 (do not put anything else in that directory), and ensure that the
19856 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19857 needs their own directory; Exim will create it if necessary.
19858
19859
19860
19861 .option skip_syntax_errors redirect boolean false
19862 .cindex "forward file" "broken"
19863 .cindex "address redirection" "broken files"
19864 .cindex "alias file" "broken"
19865 .cindex "broken alias or forward files"
19866 .cindex "ignoring faulty addresses"
19867 .cindex "skipping faulty addresses"
19868 .cindex "error" "skipping bad syntax"
19869 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19870 non-filter redirection data are skipped, and each failing address is logged. If
19871 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19872 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19873 are expanded and placed at the head of the error message generated by
19874 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19875 be the same address as the generic &%errors_to%& option. The
19876 &%skip_syntax_errors%& option is often used when handling mailing lists.
19877
19878 If all the addresses in a redirection list are skipped because of syntax
19879 errors, the router declines to handle the original address, and it is passed to
19880 the following routers.
19881
19882 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19883 error in the filter causes filtering to be abandoned without any action being
19884 taken. The incident is logged, and the router declines to handle the address,
19885 so it is passed to the following routers.
19886
19887 .cindex "Sieve filter" "syntax errors in"
19888 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19889 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19890 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19891
19892 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19893 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19894 option, used with an address that does not get redirected, can be used to
19895 notify users of these errors, by means of a router like this:
19896 .code
19897 userforward:
19898   driver = redirect
19899   allow_filter
19900   check_local_user
19901   file = $home/.forward
19902   file_transport = address_file
19903   pipe_transport = address_pipe
19904   reply_transport = address_reply
19905   no_verify
19906   skip_syntax_errors
19907   syntax_errors_to = real-$local_part@$domain
19908   syntax_errors_text = \
19909    This is an automatically generated message. An error has\n\
19910    been found in your .forward file. Details of the error are\n\
19911    reported below. While this error persists, you will receive\n\
19912    a copy of this message for every message that is addressed\n\
19913    to you. If your .forward file is a filter file, or if it is\n\
19914    a non-filter file containing no valid forwarding addresses,\n\
19915    a copy of each incoming message will be put in your normal\n\
19916    mailbox. If a non-filter file contains at least one valid\n\
19917    forwarding address, forwarding to the valid addresses will\n\
19918    happen, and those will be the only deliveries that occur.
19919 .endd
19920 You also need a router to ensure that local addresses that are prefixed by
19921 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19922 put this immediately before the &(userforward)& router:
19923 .code
19924 real_localuser:
19925   driver = accept
19926   check_local_user
19927   local_part_prefix = real-
19928   transport = local_delivery
19929 .endd
19930 For security, it would probably be a good idea to restrict the use of this
19931 router to locally-generated messages, using a condition such as this:
19932 .code
19933   condition = ${if match {$sender_host_address}\
19934                          {\N^(|127\.0\.0\.1)$\N}}
19935 .endd
19936
19937
19938 .option syntax_errors_text redirect string&!! unset
19939 See &%skip_syntax_errors%& above.
19940
19941
19942 .option syntax_errors_to redirect string unset
19943 See &%skip_syntax_errors%& above.
19944 .ecindex IIDredrou1
19945 .ecindex IIDredrou2
19946
19947
19948
19949
19950
19951
19952 . ////////////////////////////////////////////////////////////////////////////
19953 . ////////////////////////////////////////////////////////////////////////////
19954
19955 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19956          "Environment for local transports"
19957 .scindex IIDenvlotra1 "local transports" "environment for"
19958 .scindex IIDenvlotra2 "environment for local transports"
19959 .scindex IIDenvlotra3 "transport" "local; environment for"
19960 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19961 transport can be thought of as similar to a pipe.) Exim always runs transports
19962 in subprocesses, under specified uids and gids. Typical deliveries to local
19963 mailboxes run under the uid and gid of the local user.
19964
19965 Exim also sets a specific current directory while running the transport; for
19966 some transports a home directory setting is also relevant. The &(pipe)&
19967 transport is the only one that sets up environment variables; see section
19968 &<<SECTpipeenv>>& for details.
19969
19970 The values used for the uid, gid, and the directories may come from several
19971 different places. In many cases, the router that handles the address associates
19972 settings with that address as a result of its &%check_local_user%&, &%group%&,
19973 or &%user%& options. However, values may also be given in the transport's own
19974 configuration, and these override anything that comes from the router.
19975
19976
19977
19978 .section "Concurrent deliveries" "SECID131"
19979 .cindex "concurrent deliveries"
19980 .cindex "simultaneous deliveries"
19981 If two different messages for the same local recipient arrive more or less
19982 simultaneously, the two delivery processes are likely to run concurrently. When
19983 the &(appendfile)& transport is used to write to a file, Exim applies locking
19984 rules to stop concurrent processes from writing to the same file at the same
19985 time.
19986
19987 However, when you use a &(pipe)& transport, it is up to you to arrange any
19988 locking that is needed. Here is a silly example:
19989 .code
19990 my_transport:
19991   driver = pipe
19992   command = /bin/sh -c 'cat >>/some/file'
19993 .endd
19994 This is supposed to write the message at the end of the file. However, if two
19995 messages arrive at the same time, the file will be scrambled. You can use the
19996 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19997 file using the same algorithm that Exim itself uses.
19998
19999
20000
20001
20002 .section "Uids and gids" "SECTenvuidgid"
20003 .cindex "local transports" "uid and gid"
20004 .cindex "transport" "local; uid and gid"
20005 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20006 overrides any group that the router set in the address, even if &%user%& is not
20007 set for the transport. This makes it possible, for example, to run local mail
20008 delivery under the uid of the recipient (set by the router), but in a special
20009 group (set by the transport). For example:
20010 .code
20011 # Routers ...
20012 # User/group are set by check_local_user in this router
20013 local_users:
20014   driver = accept
20015   check_local_user
20016   transport = group_delivery
20017
20018 # Transports ...
20019 # This transport overrides the group
20020 group_delivery:
20021   driver = appendfile
20022   file = /var/spool/mail/$local_part
20023   group = mail
20024 .endd
20025 If &%user%& is set for a transport, its value overrides what is set in the
20026 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20027 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20028 set.
20029
20030 .oindex "&%initgroups%&"
20031 When the uid is taken from the transport's configuration, the &[initgroups()]&
20032 function is called for the groups associated with that uid if the
20033 &%initgroups%& option is set for the transport. When the uid is not specified
20034 by the transport, but is associated with the address by a router, the option
20035 for calling &[initgroups()]& is taken from the router configuration.
20036
20037 .cindex "&(pipe)& transport" "uid for"
20038 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20039 is set and &%user%& is not set, the uid of the process that called Exim to
20040 receive the message is used, and if &%group%& is not set, the corresponding
20041 original gid is also used.
20042
20043 This is the detailed preference order for obtaining a gid; the first of the
20044 following that is set is used:
20045
20046 .ilist
20047 A &%group%& setting of the transport;
20048 .next
20049 A &%group%& setting of the router;
20050 .next
20051 A gid associated with a user setting of the router, either as a result of
20052 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20053 .next
20054 The group associated with a non-numeric &%user%& setting of the transport;
20055 .next
20056 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20057 the uid is the creator's uid;
20058 .next
20059 The Exim gid if the Exim uid is being used as a default.
20060 .endlist
20061
20062 If, for example, the user is specified numerically on the router and there are
20063 no group settings, no gid is available. In this situation, an error occurs.
20064 This is different for the uid, for which there always is an ultimate default.
20065 The first of the following that is set is used:
20066
20067 .ilist
20068 A &%user%& setting of the transport;
20069 .next
20070 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20071 .next
20072 A &%user%& setting of the router;
20073 .next
20074 A &%check_local_user%& setting of the router;
20075 .next
20076 The Exim uid.
20077 .endlist
20078
20079 Of course, an error will still occur if the uid that is chosen is on the
20080 &%never_users%& list.
20081
20082
20083
20084
20085
20086 .section "Current and home directories" "SECID132"
20087 .cindex "current directory for local transport"
20088 .cindex "home directory" "for local transport"
20089 .cindex "transport" "local; home directory for"
20090 .cindex "transport" "local; current directory for"
20091 Routers may set current and home directories for local transports by means of
20092 the &%transport_current_directory%& and &%transport_home_directory%& options.
20093 However, if the transport's &%current_directory%& or &%home_directory%& options
20094 are set, they override the router's values. In detail, the home directory
20095 for a local transport is taken from the first of these values that is set:
20096
20097 .ilist
20098 The &%home_directory%& option on the transport;
20099 .next
20100 The &%transport_home_directory%& option on the router;
20101 .next
20102 The password data if &%check_local_user%& is set on the router;
20103 .next
20104 The &%router_home_directory%& option on the router.
20105 .endlist
20106
20107 The current directory is taken from the first of these values that is set:
20108
20109 .ilist
20110 The &%current_directory%& option on the transport;
20111 .next
20112 The &%transport_current_directory%& option on the router.
20113 .endlist
20114
20115
20116 If neither the router nor the transport sets a current directory, Exim uses the
20117 value of the home directory, if it is set. Otherwise it sets the current
20118 directory to &_/_& before running a local transport.
20119
20120
20121
20122 .section "Expansion variables derived from the address" "SECID133"
20123 .vindex "&$domain$&"
20124 .vindex "&$local_part$&"
20125 .vindex "&$original_domain$&"
20126 Normally a local delivery is handling a single address, and in that case the
20127 variables such as &$domain$& and &$local_part$& are set during local
20128 deliveries. However, in some circumstances more than one address may be handled
20129 at once (for example, while writing batch SMTP for onward transmission by some
20130 other means). In this case, the variables associated with the local part are
20131 never set, &$domain$& is set only if all the addresses have the same domain,
20132 and &$original_domain$& is never set.
20133 .ecindex IIDenvlotra1
20134 .ecindex IIDenvlotra2
20135 .ecindex IIDenvlotra3
20136
20137
20138
20139
20140
20141
20142
20143 . ////////////////////////////////////////////////////////////////////////////
20144 . ////////////////////////////////////////////////////////////////////////////
20145
20146 .chapter "Generic options for transports" "CHAPtransportgeneric"
20147 .scindex IIDgenoptra1 "generic options" "transport"
20148 .scindex IIDgenoptra2 "options" "generic; for transports"
20149 .scindex IIDgenoptra3 "transport" "generic options for"
20150 The following generic options apply to all transports:
20151
20152
20153 .option body_only transports boolean false
20154 .cindex "transport" "body only"
20155 .cindex "message" "transporting body only"
20156 .cindex "body of message" "transporting"
20157 If this option is set, the message's headers are not transported. It is
20158 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20159 or &(pipe)& transports, the settings of &%message_prefix%& and
20160 &%message_suffix%& should be checked, because this option does not
20161 automatically suppress them.
20162
20163
20164 .option current_directory transports string&!! unset
20165 .cindex "transport" "current directory for"
20166 This specifies the current directory that is to be set while running the
20167 transport, overriding any value that may have been set by the router.
20168 If the expansion fails for any reason, including forced failure, an error is
20169 logged, and delivery is deferred.
20170
20171
20172 .option disable_logging transports boolean false
20173 If this option is set true, nothing is logged for any
20174 deliveries by the transport or for any
20175 transport errors. You should not set this option unless you really, really know
20176 what you are doing.
20177
20178
20179 .option debug_print transports string&!! unset
20180 .cindex "testing" "variables in drivers"
20181 If this option is set and debugging is enabled (see the &%-d%& command line
20182 option), the string is expanded and included in the debugging output when the
20183 transport is run.
20184 If expansion of the string fails, the error message is written to the debugging
20185 output, and Exim carries on processing.
20186 This facility is provided to help with checking out the values of variables and
20187 so on when debugging driver configurations. For example, if a &%headers_add%&
20188 option is not working properly, &%debug_print%& could be used to output the
20189 variables it references. A newline is added to the text if it does not end with
20190 one.
20191 The variables &$transport_name$& and &$router_name$& contain the name of the
20192 transport and the router that called it.
20193
20194 .option delivery_date_add transports boolean false
20195 .cindex "&'Delivery-date:'& header line"
20196 If this option is true, a &'Delivery-date:'& header is added to the message.
20197 This gives the actual time the delivery was made. As this is not a standard
20198 header, Exim has a configuration option (&%delivery_date_remove%&) which
20199 requests its removal from incoming messages, so that delivered messages can
20200 safely be resent to other recipients.
20201
20202
20203 .option driver transports string unset
20204 This specifies which of the available transport drivers is to be used.
20205 There is no default, and this option must be set for every transport.
20206
20207
20208 .option envelope_to_add transports boolean false
20209 .cindex "&'Envelope-to:'& header line"
20210 If this option is true, an &'Envelope-to:'& header is added to the message.
20211 This gives the original address(es) in the incoming envelope that caused this
20212 delivery to happen. More than one address may be present if the transport is
20213 configured to handle several addresses at once, or if more than one original
20214 address was redirected to the same final address. As this is not a standard
20215 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20216 its removal from incoming messages, so that delivered messages can safely be
20217 resent to other recipients.
20218
20219
20220 .option group transports string&!! "Exim group"
20221 .cindex "transport" "group; specifying"
20222 This option specifies a gid for running the transport process, overriding any
20223 value that the router supplies, and also overriding any value associated with
20224 &%user%& (see below).
20225
20226
20227 .option headers_add transports list&!! unset
20228 .cindex "header lines" "adding in transport"
20229 .cindex "transport" "header lines; adding"
20230 This option specifies a list of text headers, newline-separated,
20231 which are (separately) expanded and added to the header
20232 portion of a message as it is transported, as described in section
20233 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20234 routers. If the result of the expansion is an empty string, or if the expansion
20235 is forced to fail, no action is taken. Other expansion failures are treated as
20236 errors and cause the delivery to be deferred.
20237
20238 Unlike most options, &%headers_add%& can be specified multiple times
20239 for a transport; all listed headers are added.
20240
20241
20242 .option headers_only transports boolean false
20243 .cindex "transport" "header lines only"
20244 .cindex "message" "transporting headers only"
20245 .cindex "header lines" "transporting"
20246 If this option is set, the message's body is not transported. It is mutually
20247 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20248 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20249 checked, since this option does not automatically suppress them.
20250
20251
20252 .option headers_remove transports list&!! unset
20253 .cindex "header lines" "removing"
20254 .cindex "transport" "header lines; removing"
20255 This option specifies a list of header names, colon-separated;
20256 these headers are omitted from the message as it is transported, as described
20257 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20258 routers.
20259 Each list item is separately expanded.
20260 If the result of the expansion is an empty string, or if the expansion
20261 is forced to fail, no action is taken. Other expansion failures are treated as
20262 errors and cause the delivery to be deferred.
20263
20264 Unlike most options, &%headers_remove%& can be specified multiple times
20265 for a router; all listed headers are removed.
20266
20267
20268
20269 .option headers_rewrite transports string unset
20270 .cindex "transport" "header lines; rewriting"
20271 .cindex "rewriting" "at transport time"
20272 This option allows addresses in header lines to be rewritten at transport time,
20273 that is, as the message is being copied to its destination. The contents of the
20274 option are a colon-separated list of rewriting rules. Each rule is in exactly
20275 the same form as one of the general rewriting rules that are applied when a
20276 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20277 example,
20278 .code
20279 headers_rewrite = a@b c@d f : \
20280                   x@y w@z
20281 .endd
20282 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20283 &'w@z'& in all address-bearing header lines. The rules are applied to the
20284 header lines just before they are written out at transport time, so they affect
20285 only those copies of the message that pass through the transport. However, only
20286 the message's original header lines, and any that were added by a system
20287 filter, are rewritten. If a router or transport adds header lines, they are not
20288 affected by this option. These rewriting rules are &'not'& applied to the
20289 envelope. You can change the return path using &%return_path%&, but you cannot
20290 change envelope recipients at this time.
20291
20292
20293 .option home_directory transports string&!! unset
20294 .cindex "transport" "home directory for"
20295 .vindex "&$home$&"
20296 This option specifies a home directory setting for a local transport,
20297 overriding any value that may be set by the router. The home directory is
20298 placed in &$home$& while expanding the transport's private options. It is also
20299 used as the current directory if no current directory is set by the
20300 &%current_directory%& option on the transport or the
20301 &%transport_current_directory%& option on the router. If the expansion fails
20302 for any reason, including forced failure, an error is logged, and delivery is
20303 deferred.
20304
20305
20306 .option initgroups transports boolean false
20307 .cindex "additional groups"
20308 .cindex "groups" "additional"
20309 .cindex "transport" "group; additional"
20310 If this option is true and the uid for the delivery process is provided by the
20311 transport, the &[initgroups()]& function is called when running the transport
20312 to ensure that any additional groups associated with the uid are set up.
20313
20314
20315 .option message_size_limit transports string&!! 0
20316 .cindex "limit" "message size per transport"
20317 .cindex "size" "of message, limit"
20318 .cindex "transport" "message size; limiting"
20319 This option controls the size of messages passed through the transport. It is
20320 expanded before use; the result of the expansion must be a sequence of decimal
20321 digits, optionally followed by K or M. If the expansion fails for any reason,
20322 including forced failure, or if the result is not of the required form,
20323 delivery is deferred. If the value is greater than zero and the size of a
20324 message exceeds this limit, the address is failed. If there is any chance that
20325 the resulting bounce message could be routed to the same transport, you should
20326 ensure that &%return_size_limit%& is less than the transport's
20327 &%message_size_limit%&, as otherwise the bounce message will fail to get
20328 delivered.
20329
20330
20331
20332 .option rcpt_include_affixes transports boolean false
20333 .cindex "prefix" "for local part, including in envelope"
20334 .cindex "suffix for local part" "including in envelope"
20335 .cindex "local part" "prefix"
20336 .cindex "local part" "suffix"
20337 When this option is false (the default), and an address that has had any
20338 affixes (prefixes or suffixes) removed from the local part is delivered by any
20339 form of SMTP or LMTP, the affixes are not included. For example, if a router
20340 that contains
20341 .code
20342 local_part_prefix = *-
20343 .endd
20344 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20345 is delivered with
20346 .code
20347 RCPT TO:<xyz@some.domain>
20348 .endd
20349 This is also the case when an ACL-time callout is being used to verify a
20350 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20351 whole local part is included in the RCPT command. This option applies to BSMTP
20352 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20353 &(lmtp)& and &(smtp)& transports.
20354
20355
20356 .option retry_use_local_part transports boolean "see below"
20357 .cindex "hints database" "retry keys"
20358 When a delivery suffers a temporary failure, a retry record is created
20359 in Exim's hints database. For remote deliveries, the key for the retry record
20360 is based on the name and/or IP address of the failing remote host. For local
20361 deliveries, the key is normally the entire address, including both the local
20362 part and the domain. This is suitable for most common cases of local delivery
20363 temporary failure &-- for example, exceeding a mailbox quota should delay only
20364 deliveries to that mailbox, not to the whole domain.
20365
20366 However, in some special cases you may want to treat a temporary local delivery
20367 as a failure associated with the domain, and not with a particular local part.
20368 (For example, if you are storing all mail for some domain in files.) You can do
20369 this by setting &%retry_use_local_part%& false.
20370
20371 For all the local transports, its default value is true. For remote transports,
20372 the default value is false for tidiness, but changing the value has no effect
20373 on a remote transport in the current implementation.
20374
20375
20376 .option return_path transports string&!! unset
20377 .cindex "envelope sender"
20378 .cindex "transport" "return path; changing"
20379 .cindex "return path" "changing in transport"
20380 If this option is set, the string is expanded at transport time and replaces
20381 the existing return path (envelope sender) value in the copy of the message
20382 that is being delivered. An empty return path is permitted. This feature is
20383 designed for remote deliveries, where the value of this option is used in the
20384 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20385 only effect is to change the address that is placed in the &'Return-path:'&
20386 header line, if one is added to the message (see the next option).
20387
20388 &*Note:*& A changed return path is not logged unless you add
20389 &%return_path_on_delivery%& to the log selector.
20390
20391 .vindex "&$return_path$&"
20392 The expansion can refer to the existing value via &$return_path$&. This is
20393 either the message's envelope sender, or an address set by the
20394 &%errors_to%& option on a router. If the expansion is forced to fail, no
20395 replacement occurs; if it fails for another reason, delivery is deferred. This
20396 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20397 section &<<SECTverp>>&.
20398
20399 &*Note*&: If a delivery error is detected locally, including the case when a
20400 remote server rejects a message at SMTP time, the bounce message is not sent to
20401 the value of this option. It is sent to the previously set errors address.
20402 This defaults to the incoming sender address, but can be changed by setting
20403 &%errors_to%& in a router.
20404
20405
20406
20407 .option return_path_add transports boolean false
20408 .cindex "&'Return-path:'& header line"
20409 If this option is true, a &'Return-path:'& header is added to the message.
20410 Although the return path is normally available in the prefix line of BSD
20411 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20412 have easy access to it.
20413
20414 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20415 the delivery SMTP server makes the final delivery"&. This implies that this
20416 header should not be present in incoming messages. Exim has a configuration
20417 option, &%return_path_remove%&, which requests removal of this header from
20418 incoming messages, so that delivered messages can safely be resent to other
20419 recipients.
20420
20421
20422 .option shadow_condition transports string&!! unset
20423 See &%shadow_transport%& below.
20424
20425
20426 .option shadow_transport transports string unset
20427 .cindex "shadow transport"
20428 .cindex "transport" "shadow"
20429 A local transport may set the &%shadow_transport%& option to the name of
20430 another local transport. Shadow remote transports are not supported.
20431
20432 Whenever a delivery to the main transport succeeds, and either
20433 &%shadow_condition%& is unset, or its expansion does not result in the empty
20434 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20435 passed to the shadow transport, with the same delivery address or addresses. If
20436 expansion fails, no action is taken except that non-forced expansion failures
20437 cause a log line to be written.
20438
20439 The result of the shadow transport is discarded and does not affect the
20440 subsequent processing of the message. Only a single level of shadowing is
20441 provided; the &%shadow_transport%& option is ignored on any transport when it
20442 is running as a shadow. Options concerned with output from pipes are also
20443 ignored. The log line for the successful delivery has an item added on the end,
20444 of the form
20445 .code
20446 ST=<shadow transport name>
20447 .endd
20448 If the shadow transport did not succeed, the error message is put in
20449 parentheses afterwards. Shadow transports can be used for a number of different
20450 purposes, including keeping more detailed log information than Exim normally
20451 provides, and implementing automatic acknowledgment policies based on message
20452 headers that some sites insist on.
20453
20454
20455 .option transport_filter transports string&!! unset
20456 .cindex "transport" "filter"
20457 .cindex "filter" "transport filter"
20458 This option sets up a filtering (in the Unix shell sense) process for messages
20459 at transport time. It should not be confused with mail filtering as set up by
20460 individual users or via a system filter.
20461
20462 When the message is about to be written out, the command specified by
20463 &%transport_filter%& is started up in a separate, parallel process, and
20464 the entire message, including the header lines, is passed to it on its standard
20465 input (this in fact is done from a third process, to avoid deadlock). The
20466 command must be specified as an absolute path.
20467
20468 The lines of the message that are written to the transport filter are
20469 terminated by newline (&"\n"&). The message is passed to the filter before any
20470 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20471 lines beginning with a dot, and also before any processing implied by the
20472 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20473 &(pipe)& transports.
20474
20475 The standard error for the filter process is set to the same destination as its
20476 standard output; this is read and written to the message's ultimate
20477 destination. The process that writes the message to the filter, the
20478 filter itself, and the original process that reads the result and delivers it
20479 are all run in parallel, like a shell pipeline.
20480
20481 The filter can perform any transformations it likes, but of course should take
20482 care not to break RFC 2822 syntax. Exim does not check the result, except to
20483 test for a final newline when SMTP is in use. All messages transmitted over
20484 SMTP must end with a newline, so Exim supplies one if it is missing.
20485
20486 .cindex "content scanning" "per user"
20487 A transport filter can be used to provide content-scanning on a per-user basis
20488 at delivery time if the only required effect of the scan is to modify the
20489 message. For example, a content scan could insert a new header line containing
20490 a spam score. This could be interpreted by a filter in the user's MUA. It is
20491 not possible to discard a message at this stage.
20492
20493 .cindex "SMTP" "SIZE"
20494 A problem might arise if the filter increases the size of a message that is
20495 being sent down an SMTP connection. If the receiving SMTP server has indicated
20496 support for the SIZE parameter, Exim will have sent the size of the message
20497 at the start of the SMTP session. If what is actually sent is substantially
20498 more, the server might reject the message. This can be worked round by setting
20499 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20500 additions to the message, or to disable the use of SIZE altogether.
20501
20502 .vindex "&$pipe_addresses$&"
20503 The value of the &%transport_filter%& option is the command string for starting
20504 the filter, which is run directly from Exim, not under a shell. The string is
20505 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20506 Exim breaks it up into arguments and then expands each argument separately (see
20507 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20508 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20509 of arguments, one for each address that applies to this delivery. (This isn't
20510 an ideal name for this feature here, but as it was already implemented for the
20511 &(pipe)& transport, it seemed sensible not to change it.)
20512
20513 .vindex "&$host$&"
20514 .vindex "&$host_address$&"
20515 The expansion variables &$host$& and &$host_address$& are available when the
20516 transport is a remote one. They contain the name and IP address of the host to
20517 which the message is being sent. For example:
20518 .code
20519 transport_filter = /some/directory/transport-filter.pl \
20520   $host $host_address $sender_address $pipe_addresses
20521 .endd
20522
20523 Two problems arise if you want to use more complicated expansion items to
20524 generate transport filter commands, both of which due to the fact that the
20525 command is split up &'before'& expansion.
20526 .ilist
20527 If an expansion item contains white space, you must quote it, so that it is all
20528 part of the same command item. If the entire option setting is one such
20529 expansion item, you have to take care what kind of quoting you use. For
20530 example:
20531 .code
20532 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20533 .endd
20534 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20535 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20536 stripped by Exim when it read the option's value. When the value is used, if
20537 the single quotes were missing, the line would be split into two items,
20538 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20539 Exim tried to expand the first one.
20540 .next
20541 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20542 expansion cannot generate multiple arguments, or a command name followed by
20543 arguments. Consider this example:
20544 .code
20545 transport_filter = ${lookup{$host}lsearch{/a/file}\
20546                     {$value}{/bin/cat}}
20547 .endd
20548 The result of the lookup is interpreted as the name of the command, even
20549 if it contains white space. The simplest way round this is to use a shell:
20550 .code
20551 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20552                                {$value}{/bin/cat}}
20553 .endd
20554 .endlist
20555
20556 The filter process is run under the same uid and gid as the normal delivery.
20557 For remote deliveries this is the Exim uid/gid by default. The command should
20558 normally yield a zero return code. Transport filters are not supposed to fail.
20559 A non-zero code is taken to mean that the transport filter encountered some
20560 serious problem. Delivery of the message is deferred; the message remains on
20561 the queue and is tried again later. It is not possible to cause a message to be
20562 bounced from a transport filter.
20563
20564 If a transport filter is set on an autoreply transport, the original message is
20565 passed through the filter as it is being copied into the newly generated
20566 message, which happens if the &%return_message%& option is set.
20567
20568
20569 .option transport_filter_timeout transports time 5m
20570 .cindex "transport" "filter, timeout"
20571 When Exim is reading the output of a transport filter, it applies a timeout
20572 that can be set by this option. Exceeding the timeout is normally treated as a
20573 temporary delivery failure. However, if a transport filter is used with a
20574 &(pipe)& transport, a timeout in the transport filter is treated in the same
20575 way as a timeout in the pipe command itself. By default, a timeout is a hard
20576 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20577 becomes a temporary error.
20578
20579
20580 .option user transports string&!! "Exim user"
20581 .cindex "uid (user id)" "local delivery"
20582 .cindex "transport" "user, specifying"
20583 This option specifies the user under whose uid the delivery process is to be
20584 run, overriding any uid that may have been set by the router. If the user is
20585 given as a name, the uid is looked up from the password data, and the
20586 associated group is taken as the value of the gid to be used if the &%group%&
20587 option is not set.
20588
20589 For deliveries that use local transports, a user and group are normally
20590 specified explicitly or implicitly (for example, as a result of
20591 &%check_local_user%&) by the router or transport.
20592
20593 .cindex "hints database" "access by remote transport"
20594 For remote transports, you should leave this option unset unless you really are
20595 sure you know what you are doing. When a remote transport is running, it needs
20596 to be able to access Exim's hints databases, because each host may have its own
20597 retry data.
20598 .ecindex IIDgenoptra1
20599 .ecindex IIDgenoptra2
20600 .ecindex IIDgenoptra3
20601
20602
20603
20604
20605
20606
20607 . ////////////////////////////////////////////////////////////////////////////
20608 . ////////////////////////////////////////////////////////////////////////////
20609
20610 .chapter "Address batching in local transports" "CHAPbatching" &&&
20611          "Address batching"
20612 .cindex "transport" "local; address batching in"
20613 The only remote transport (&(smtp)&) is normally configured to handle more than
20614 one address at a time, so that when several addresses are routed to the same
20615 remote host, just one copy of the message is sent. Local transports, however,
20616 normally handle one address at a time. That is, a separate instance of the
20617 transport is run for each address that is routed to the transport. A separate
20618 copy of the message is delivered each time.
20619
20620 .cindex "batched local delivery"
20621 .oindex "&%batch_max%&"
20622 .oindex "&%batch_id%&"
20623 In special cases, it may be desirable to handle several addresses at once in a
20624 local transport, for example:
20625
20626 .ilist
20627 In an &(appendfile)& transport, when storing messages in files for later
20628 delivery by some other means, a single copy of the message with multiple
20629 recipients saves space.
20630 .next
20631 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20632 a single copy saves time, and is the normal way LMTP is expected to work.
20633 .next
20634 In a &(pipe)& transport, when passing the message
20635 to a scanner program or
20636 to some other delivery mechanism such as UUCP, multiple recipients may be
20637 acceptable.
20638 .endlist
20639
20640 These three local transports all have the same options for controlling multiple
20641 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20642 repeating the information for each transport, these options are described here.
20643
20644 The &%batch_max%& option specifies the maximum number of addresses that can be
20645 delivered together in a single run of the transport. Its default value is one
20646 (no batching). When more than one address is routed to a transport that has a
20647 &%batch_max%& value greater than one, the addresses are delivered in a batch
20648 (that is, in a single run of the transport with multiple recipients), subject
20649 to certain conditions:
20650
20651 .ilist
20652 .vindex "&$local_part$&"
20653 If any of the transport's options contain a reference to &$local_part$&, no
20654 batching is possible.
20655 .next
20656 .vindex "&$domain$&"
20657 If any of the transport's options contain a reference to &$domain$&, only
20658 addresses with the same domain are batched.
20659 .next
20660 .cindex "customizing" "batching condition"
20661 If &%batch_id%& is set, it is expanded for each address, and only those
20662 addresses with the same expanded value are batched. This allows you to specify
20663 customized batching conditions. Failure of the expansion for any reason,
20664 including forced failure, disables batching, but it does not stop the delivery
20665 from taking place.
20666 .next
20667 Batched addresses must also have the same errors address (where to send
20668 delivery errors), the same header additions and removals, the same user and
20669 group for the transport, and if a host list is present, the first host must
20670 be the same.
20671 .endlist
20672
20673 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20674 both when the file or pipe command is specified in the transport, and when it
20675 is specified by a &(redirect)& router, but all the batched addresses must of
20676 course be routed to the same file or pipe command. These two transports have an
20677 option called &%use_bsmtp%&, which causes them to deliver the message in
20678 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20679 &%check_string%& and &%escape_string%& options are forced to the values
20680 .code
20681 check_string = "."
20682 escape_string = ".."
20683 .endd
20684 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20685 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20686 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20687
20688 .cindex "&'Envelope-to:'& header line"
20689 If the generic &%envelope_to_add%& option is set for a batching transport, the
20690 &'Envelope-to:'& header that is added to the message contains all the addresses
20691 that are being processed together. If you are using a batching &(appendfile)&
20692 transport without &%use_bsmtp%&, the only way to preserve the recipient
20693 addresses is to set the &%envelope_to_add%& option.
20694
20695 .cindex "&(pipe)& transport" "with multiple addresses"
20696 .vindex "&$pipe_addresses$&"
20697 If you are using a &(pipe)& transport without BSMTP, and setting the
20698 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20699 the command. This is not a true variable; it is a bit of magic that causes each
20700 of the recipient addresses to be inserted into the command as a separate
20701 argument. This provides a way of accessing all the addresses that are being
20702 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20703 are specified by a &(redirect)& router.
20704
20705
20706
20707
20708 . ////////////////////////////////////////////////////////////////////////////
20709 . ////////////////////////////////////////////////////////////////////////////
20710
20711 .chapter "The appendfile transport" "CHAPappendfile"
20712 .scindex IIDapptra1 "&(appendfile)& transport"
20713 .scindex IIDapptra2 "transports" "&(appendfile)&"
20714 .cindex "directory creation"
20715 .cindex "creating directories"
20716 The &(appendfile)& transport delivers a message by appending it to an existing
20717 file, or by creating an entirely new file in a specified directory. Single
20718 files to which messages are appended can be in the traditional Unix mailbox
20719 format, or optionally in the MBX format supported by the Pine MUA and
20720 University of Washington IMAP daemon, &'inter alia'&. When each message is
20721 being delivered as a separate file, &"maildir"& format can optionally be used
20722 to give added protection against failures that happen part-way through the
20723 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20724 supported. For all file formats, Exim attempts to create as many levels of
20725 directory as necessary, provided that &%create_directory%& is set.
20726
20727 The code for the optional formats is not included in the Exim binary by
20728 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20729 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20730 included.
20731
20732 .cindex "quota" "system"
20733 Exim recognizes system quota errors, and generates an appropriate message. Exim
20734 also supports its own quota control within the transport, for use when the
20735 system facility is unavailable or cannot be used for some reason.
20736
20737 If there is an error while appending to a file (for example, quota exceeded or
20738 partition filled), Exim attempts to reset the file's length and last
20739 modification time back to what they were before. If there is an error while
20740 creating an entirely new file, the new file is removed.
20741
20742 Before appending to a file, a number of security checks are made, and the
20743 file is locked. A detailed description is given below, after the list of
20744 private options.
20745
20746 The &(appendfile)& transport is most commonly used for local deliveries to
20747 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20748 putting messages into files for remote delivery by some means other than Exim.
20749 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20750 option).
20751
20752
20753
20754 .section "The file and directory options" "SECTfildiropt"
20755 The &%file%& option specifies a single file, to which the message is appended;
20756 the &%directory%& option specifies a directory, in which a new file containing
20757 the message is created. Only one of these two options can be set, and for
20758 normal deliveries to mailboxes, one of them &'must'& be set.
20759
20760 .vindex "&$address_file$&"
20761 .vindex "&$local_part$&"
20762 However, &(appendfile)& is also used for delivering messages to files or
20763 directories whose names (or parts of names) are obtained from alias,
20764 forwarding, or filtering operations (for example, a &%save%& command in a
20765 user's Exim filter). When such a transport is running, &$local_part$& contains
20766 the local part that was aliased or forwarded, and &$address_file$& contains the
20767 name (or partial name) of the file or directory generated by the redirection
20768 operation. There are two cases:
20769
20770 .ilist
20771 If neither &%file%& nor &%directory%& is set, the redirection operation
20772 must specify an absolute path (one that begins with &`/`&). This is the most
20773 common case when users with local accounts use filtering to sort mail into
20774 different folders. See for example, the &(address_file)& transport in the
20775 default configuration. If the path ends with a slash, it is assumed to be the
20776 name of a directory. A delivery to a directory can also be forced by setting
20777 &%maildir_format%& or &%mailstore_format%&.
20778 .next
20779 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20780 used to determine the file or directory name for the delivery. Normally, the
20781 contents of &$address_file$& are used in some way in the string expansion.
20782 .endlist
20783
20784
20785 .cindex "Sieve filter" "configuring &(appendfile)&"
20786 .cindex "Sieve filter" "relative mailbox path handling"
20787 As an example of the second case, consider an environment where users do not
20788 have home directories. They may be permitted to use Exim filter commands of the
20789 form:
20790 .code
20791 save folder23
20792 .endd
20793 or Sieve filter commands of the form:
20794 .code
20795 require "fileinto";
20796 fileinto "folder23";
20797 .endd
20798 In this situation, the expansion of &%file%& or &%directory%& in the transport
20799 must transform the relative path into an appropriate absolute file name. In the
20800 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20801 is used as a result of a &"keep"& action in the filter. This example shows one
20802 way of handling this requirement:
20803 .code
20804 file = ${if eq{$address_file}{inbox} \
20805             {/var/mail/$local_part} \
20806             {${if eq{${substr_0_1:$address_file}}{/} \
20807                   {$address_file} \
20808                   {$home/mail/$address_file} \
20809             }} \
20810        }
20811 .endd
20812 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20813 location, absolute paths are used without change, and other folders are in the
20814 &_mail_& directory within the home directory.
20815
20816 &*Note 1*&: While processing an Exim filter, a relative path such as
20817 &_folder23_& is turned into an absolute path if a home directory is known to
20818 the router. In particular, this is the case if &%check_local_user%& is set. If
20819 you want to prevent this happening at routing time, you can set
20820 &%router_home_directory%& empty. This forces the router to pass the relative
20821 path to the transport.
20822
20823 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20824 the &%file%& or &%directory%& option is still used if it is set.
20825
20826
20827
20828
20829 .section "Private options for appendfile" "SECID134"
20830 .cindex "options" "&(appendfile)& transport"
20831
20832
20833
20834 .option allow_fifo appendfile boolean false
20835 .cindex "fifo (named pipe)"
20836 .cindex "named pipe (fifo)"
20837 .cindex "pipe" "named (fifo)"
20838 Setting this option permits delivery to named pipes (FIFOs) as well as to
20839 regular files. If no process is reading the named pipe at delivery time, the
20840 delivery is deferred.
20841
20842
20843 .option allow_symlink appendfile boolean false
20844 .cindex "symbolic link" "to mailbox"
20845 .cindex "mailbox" "symbolic link"
20846 By default, &(appendfile)& will not deliver if the path name for the file is
20847 that of a symbolic link. Setting this option relaxes that constraint, but there
20848 are security issues involved in the use of symbolic links. Be sure you know
20849 what you are doing if you set this. Details of exactly what this option affects
20850 are included in the discussion which follows this list of options.
20851
20852
20853 .option batch_id appendfile string&!! unset
20854 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20855 However, batching is automatically disabled for &(appendfile)& deliveries that
20856 happen as a result of forwarding or aliasing or other redirection directly to a
20857 file.
20858
20859
20860 .option batch_max appendfile integer 1
20861 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20862
20863
20864 .option check_group appendfile boolean false
20865 When this option is set, the group owner of the file defined by the &%file%&
20866 option is checked to see that it is the same as the group under which the
20867 delivery process is running. The default setting is false because the default
20868 file mode is 0600, which means that the group is irrelevant.
20869
20870
20871 .option check_owner appendfile boolean true
20872 When this option is set, the owner of the file defined by the &%file%& option
20873 is checked to ensure that it is the same as the user under which the delivery
20874 process is running.
20875
20876
20877 .option check_string appendfile string "see below"
20878 .cindex "&""From""& line"
20879 As &(appendfile)& writes the message, the start of each line is tested for
20880 matching &%check_string%&, and if it does, the initial matching characters are
20881 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20882 a literal string, not a regular expression, and the case of any letters it
20883 contains is significant.
20884
20885 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20886 are forced to &"."& and &".."& respectively, and any settings in the
20887 configuration are ignored. Otherwise, they default to &"From&~"& and
20888 &">From&~"& when the &%file%& option is set, and unset when any of the
20889 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20890
20891 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20892 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20893 &"From&~"& indicates the start of a new message. All four options need changing
20894 if another format is used. For example, to deliver to mailboxes in MMDF format:
20895 .cindex "MMDF format mailbox"
20896 .cindex "mailbox" "MMDF format"
20897 .code
20898 check_string = "\1\1\1\1\n"
20899 escape_string = "\1\1\1\1 \n"
20900 message_prefix = "\1\1\1\1\n"
20901 message_suffix = "\1\1\1\1\n"
20902 .endd
20903 .option create_directory appendfile boolean true
20904 .cindex "directory creation"
20905 When this option is true, Exim attempts to create any missing superior
20906 directories for the file that it is about to write. A created directory's mode
20907 is given by the &%directory_mode%& option.
20908
20909 The group ownership of a newly created directory is highly dependent on the
20910 operating system (and possibly the file system) that is being used. For
20911 example, in Solaris, if the parent directory has the setgid bit set, its group
20912 is propagated to the child; if not, the currently set group is used. However,
20913 in FreeBSD, the parent's group is always used.
20914
20915
20916
20917 .option create_file appendfile string anywhere
20918 This option constrains the location of files and directories that are created
20919 by this transport. It applies to files defined by the &%file%& option and
20920 directories defined by the &%directory%& option. In the case of maildir
20921 delivery, it applies to the top level directory, not the maildir directories
20922 beneath.
20923
20924 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20925 &"belowhome"&. In the second and third cases, a home directory must have been
20926 set for the transport. This option is not useful when an explicit file name is
20927 given for normal mailbox deliveries. It is intended for the case when file
20928 names are generated from users' &_.forward_& files. These are usually handled
20929 by an &(appendfile)& transport called &%address_file%&. See also
20930 &%file_must_exist%&.
20931
20932
20933 .option directory appendfile string&!! unset
20934 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20935 or &%directory%& must be set, unless the delivery is the direct result of a
20936 redirection (see section &<<SECTfildiropt>>&).
20937
20938 When &%directory%& is set, the string is expanded, and the message is delivered
20939 into a new file or files in or below the given directory, instead of being
20940 appended to a single mailbox file. A number of different formats are provided
20941 (see &%maildir_format%& and &%mailstore_format%&), and see section
20942 &<<SECTopdir>>& for further details of this form of delivery.
20943
20944
20945 .option directory_file appendfile string&!! "see below"
20946 .cindex "base62"
20947 .vindex "&$inode$&"
20948 When &%directory%& is set, but neither &%maildir_format%& nor
20949 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20950 whose name is obtained by expanding this string. The default value is:
20951 .code
20952 q${base62:$tod_epoch}-$inode
20953 .endd
20954 This generates a unique name from the current time, in base 62 form, and the
20955 inode of the file. The variable &$inode$& is available only when expanding this
20956 option.
20957
20958
20959 .option directory_mode appendfile "octal integer" 0700
20960 If &(appendfile)& creates any directories as a result of the
20961 &%create_directory%& option, their mode is specified by this option.
20962
20963
20964 .option escape_string appendfile string "see description"
20965 See &%check_string%& above.
20966
20967
20968 .option file appendfile string&!! unset
20969 This option is mutually exclusive with the &%directory%& option, but one of
20970 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20971 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20972 specifies a single file, to which the message is appended. One or more of
20973 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20974 &%file%&.
20975
20976 .cindex "NFS" "lock file"
20977 .cindex "locking files"
20978 .cindex "lock files"
20979 If you are using more than one host to deliver over NFS into the same
20980 mailboxes, you should always use lock files.
20981
20982 The string value is expanded for each delivery, and must yield an absolute
20983 path. The most common settings of this option are variations on one of these
20984 examples:
20985 .code
20986 file = /var/spool/mail/$local_part
20987 file = /home/$local_part/inbox
20988 file = $home/inbox
20989 .endd
20990 .cindex "&""sticky""& bit"
20991 In the first example, all deliveries are done into the same directory. If Exim
20992 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20993 create a file in the directory, so the &"sticky"& bit must be turned on for
20994 deliveries to be possible, or alternatively the &%group%& option can be used to
20995 run the delivery under a group id which has write access to the directory.
20996
20997
20998
20999 .option file_format appendfile string unset
21000 .cindex "file" "mailbox; checking existing format"
21001 This option requests the transport to check the format of an existing file
21002 before adding to it. The check consists of matching a specific string at the
21003 start of the file. The value of the option consists of an even number of
21004 colon-separated strings. The first of each pair is the test string, and the
21005 second is the name of a transport. If the transport associated with a matched
21006 string is not the current transport, control is passed over to the other
21007 transport. For example, suppose the standard &(local_delivery)& transport has
21008 this added to it:
21009 .code
21010 file_format = "From       : local_delivery :\
21011                \1\1\1\1\n : local_mmdf_delivery"
21012 .endd
21013 Mailboxes that begin with &"From"& are still handled by this transport, but if
21014 a mailbox begins with four binary ones followed by a newline, control is passed
21015 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21016 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21017 is assumed to match the current transport. If the start of a mailbox doesn't
21018 match any string, or if the transport named for a given string is not defined,
21019 delivery is deferred.
21020
21021
21022 .option file_must_exist appendfile boolean false
21023 If this option is true, the file specified by the &%file%& option must exist.
21024 A temporary error occurs if it does not, causing delivery to be deferred.
21025 If this option is false, the file is created if it does not exist.
21026
21027
21028 .option lock_fcntl_timeout appendfile time 0s
21029 .cindex "timeout" "mailbox locking"
21030 .cindex "mailbox" "locking, blocking and non-blocking"
21031 .cindex "locking files"
21032 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21033 when locking an open mailbox file. If the call fails, the delivery process
21034 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21035 Non-blocking calls are used so that the file is not kept open during the wait
21036 for the lock; the reason for this is to make it as safe as possible for
21037 deliveries over NFS in the case when processes might be accessing an NFS
21038 mailbox without using a lock file. This should not be done, but
21039 misunderstandings and hence misconfigurations are not unknown.
21040
21041 On a busy system, however, the performance of a non-blocking lock approach is
21042 not as good as using a blocking lock with a timeout. In this case, the waiting
21043 is done inside the system call, and Exim's delivery process acquires the lock
21044 and can proceed as soon as the previous lock holder releases it.
21045
21046 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21047 timeout, are used. There may still be some retrying: the maximum number of
21048 retries is
21049 .code
21050 (lock_retries * lock_interval) / lock_fcntl_timeout
21051 .endd
21052 rounded up to the next whole number. In other words, the total time during
21053 which &(appendfile)& is trying to get a lock is roughly the same, unless
21054 &%lock_fcntl_timeout%& is set very large.
21055
21056 You should consider setting this option if you are getting a lot of delayed
21057 local deliveries because of errors of the form
21058 .code
21059 failed to lock mailbox /some/file (fcntl)
21060 .endd
21061
21062 .option lock_flock_timeout appendfile time 0s
21063 This timeout applies to file locking when using &[flock()]& (see
21064 &%use_flock%&); the timeout operates in a similar manner to
21065 &%lock_fcntl_timeout%&.
21066
21067
21068 .option lock_interval appendfile time 3s
21069 This specifies the time to wait between attempts to lock the file. See below
21070 for details of locking.
21071
21072
21073 .option lock_retries appendfile integer 10
21074 This specifies the maximum number of attempts to lock the file. A value of zero
21075 is treated as 1. See below for details of locking.
21076
21077
21078 .option lockfile_mode appendfile "octal integer" 0600
21079 This specifies the mode of the created lock file, when a lock file is being
21080 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21081
21082
21083 .option lockfile_timeout appendfile time 30m
21084 .cindex "timeout" "mailbox locking"
21085 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21086 exists and is older than this value, it is assumed to have been left behind by
21087 accident, and Exim attempts to remove it.
21088
21089
21090 .option mailbox_filecount appendfile string&!! unset
21091 .cindex "mailbox" "specifying size of"
21092 .cindex "size" "of mailbox"
21093 If this option is set, it is expanded, and the result is taken as the current
21094 number of files in the mailbox. It must be a decimal number, optionally
21095 followed by K or M. This provides a way of obtaining this information from an
21096 external source that maintains the data.
21097
21098
21099 .option mailbox_size appendfile string&!! unset
21100 .cindex "mailbox" "specifying size of"
21101 .cindex "size" "of mailbox"
21102 If this option is set, it is expanded, and the result is taken as the current
21103 size the mailbox. It must be a decimal number, optionally followed by K or M.
21104 This provides a way of obtaining this information from an external source that
21105 maintains the data. This is likely to be helpful for maildir deliveries where
21106 it is computationally expensive to compute the size of a mailbox.
21107
21108
21109
21110 .option maildir_format appendfile boolean false
21111 .cindex "maildir format" "specifying"
21112 If this option is set with the &%directory%& option, the delivery is into a new
21113 file, in the &"maildir"& format that is used by other mail software. When the
21114 transport is activated directly from a &(redirect)& router (for example, the
21115 &(address_file)& transport in the default configuration), setting
21116 &%maildir_format%& causes the path received from the router to be treated as a
21117 directory, whether or not it ends with &`/`&. This option is available only if
21118 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21119 &<<SECTmaildirdelivery>>& below for further details.
21120
21121
21122 .option maildir_quota_directory_regex appendfile string "See below"
21123 .cindex "maildir format" "quota; directories included in"
21124 .cindex "quota" "maildir; directories included in"
21125 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21126 a regular expression for specifying directories, relative to the quota
21127 directory (see &%quota_directory%&), that should be included in the quota
21128 calculation. The default value is:
21129 .code
21130 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21131 .endd
21132 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21133 (directories whose names begin with a dot). If you want to exclude the
21134 &_Trash_&
21135 folder from the count (as some sites do), you need to change this setting to
21136 .code
21137 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21138 .endd
21139 This uses a negative lookahead in the regular expression to exclude the
21140 directory whose name is &_.Trash_&. When a directory is excluded from quota
21141 calculations, quota processing is bypassed for any messages that are delivered
21142 directly into that directory.
21143
21144
21145 .option maildir_retries appendfile integer 10
21146 This option specifies the number of times to retry when writing a file in
21147 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21148
21149
21150 .option maildir_tag appendfile string&!! unset
21151 This option applies only to deliveries in maildir format, and is described in
21152 section &<<SECTmaildirdelivery>>& below.
21153
21154
21155 .option maildir_use_size_file appendfile&!! boolean false
21156 .cindex "maildir format" "&_maildirsize_& file"
21157 The result of string expansion for this option must be a valid boolean value.
21158 If it is true, it enables support for &_maildirsize_& files. Exim
21159 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21160 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21161 value is zero. See &%maildir_quota_directory_regex%& above and section
21162 &<<SECTmaildirdelivery>>& below for further details.
21163
21164 .option maildirfolder_create_regex appendfile string unset
21165 .cindex "maildir format" "&_maildirfolder_& file"
21166 .cindex "&_maildirfolder_&, creating"
21167 The value of this option is a regular expression. If it is unset, it has no
21168 effect. Otherwise, before a maildir delivery takes place, the pattern is
21169 matched against the name of the maildir directory, that is, the directory
21170 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21171 delivery. If there is a match, Exim checks for the existence of a file called
21172 &_maildirfolder_& in the directory, and creates it if it does not exist.
21173 See section &<<SECTmaildirdelivery>>& for more details.
21174
21175
21176 .option mailstore_format appendfile boolean false
21177 .cindex "mailstore format" "specifying"
21178 If this option is set with the &%directory%& option, the delivery is into two
21179 new files in  &"mailstore"& format. The option is available only if
21180 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21181 below for further details.
21182
21183
21184 .option mailstore_prefix appendfile string&!! unset
21185 This option applies only to deliveries in mailstore format, and is described in
21186 section &<<SECTopdir>>& below.
21187
21188
21189 .option mailstore_suffix appendfile string&!! unset
21190 This option applies only to deliveries in mailstore format, and is described in
21191 section &<<SECTopdir>>& below.
21192
21193
21194 .option mbx_format appendfile boolean false
21195 .cindex "locking files"
21196 .cindex "file" "locking"
21197 .cindex "file" "MBX format"
21198 .cindex "MBX format, specifying"
21199 This option is available only if Exim has been compiled with SUPPORT_MBX
21200 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21201 the message is appended to the mailbox file in MBX format instead of
21202 traditional Unix format. This format is supported by Pine4 and its associated
21203 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21204
21205 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21206 automatically changed by the use of &%mbx_format%&. They should normally be set
21207 empty when using MBX format, so this option almost always appears in this
21208 combination:
21209 .code
21210 mbx_format = true
21211 message_prefix =
21212 message_suffix =
21213 .endd
21214 If none of the locking options are mentioned in the configuration,
21215 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21216 is possible to specify the other kinds of locking with &%mbx_format%&, but
21217 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21218 interworks with &'c-client'&, providing for shared access to the mailbox. It
21219 should not be used if any program that does not use this form of locking is
21220 going to access the mailbox, nor should it be used if the mailbox file is NFS
21221 mounted, because it works only when the mailbox is accessed from a single host.
21222
21223 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21224 the standard version of &'c-client'&, because as long as it has a mailbox open
21225 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21226 append messages to it.
21227
21228
21229 .option message_prefix appendfile string&!! "see below"
21230 .cindex "&""From""& line"
21231 The string specified here is expanded and output at the start of every message.
21232 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21233 in which case it is:
21234 .code
21235 message_prefix = "From ${if def:return_path{$return_path}\
21236   {MAILER-DAEMON}} $tod_bsdinbox\n"
21237 .endd
21238 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21239 &`\n`& to &`\r\n`& in &%message_prefix%&.
21240
21241 .option message_suffix appendfile string&!! "see below"
21242 The string specified here is expanded and output at the end of every message.
21243 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21244 in which case it is a single newline character. The suffix can be suppressed by
21245 setting
21246 .code
21247 message_suffix =
21248 .endd
21249 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21250 &`\n`& to &`\r\n`& in &%message_suffix%&.
21251
21252 .option mode appendfile "octal integer" 0600
21253 If the output file is created, it is given this mode. If it already exists and
21254 has wider permissions, they are reduced to this mode. If it has narrower
21255 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21256 if the delivery is the result of a &%save%& command in a filter file specifying
21257 a particular mode, the mode of the output file is always forced to take that
21258 value, and this option is ignored.
21259
21260
21261 .option mode_fail_narrower appendfile boolean true
21262 This option applies in the case when an existing mailbox file has a narrower
21263 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21264 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21265 continues with the delivery attempt, using the existing mode of the file.
21266
21267
21268 .option notify_comsat appendfile boolean false
21269 If this option is true, the &'comsat'& daemon is notified after every
21270 successful delivery to a user mailbox. This is the daemon that notifies logged
21271 on users about incoming mail.
21272
21273
21274 .option quota appendfile string&!! unset
21275 .cindex "quota" "imposed by Exim"
21276 This option imposes a limit on the size of the file to which Exim is appending,
21277 or to the total space used in the directory tree when the &%directory%& option
21278 is set. In the latter case, computation of the space used is expensive, because
21279 all the files in the directory (and any sub-directories) have to be
21280 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21281 &%maildir_use_size_file%& for ways to avoid this in environments where users
21282 have no shell access to their mailboxes).
21283
21284 As there is no interlock against two simultaneous deliveries into a
21285 multi-file mailbox, it is possible for the quota to be overrun in this case.
21286 For single-file mailboxes, of course, an interlock is a necessity.
21287
21288 A file's size is taken as its &'used'& value. Because of blocking effects, this
21289 may be a lot less than the actual amount of disk space allocated to the file.
21290 If the sizes of a number of files are being added up, the rounding effect can
21291 become quite noticeable, especially on systems that have large block sizes.
21292 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21293 the obvious value which users understand most easily.
21294
21295 The value of the option is expanded, and must then be a numerical value
21296 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21297 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21298 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21299 be handled.
21300
21301 &*Note*&: A value of zero is interpreted as &"no quota"&.
21302
21303 The expansion happens while Exim is running as root, before it changes uid for
21304 the delivery. This means that files that are inaccessible to the end user can
21305 be used to hold quota values that are looked up in the expansion. When delivery
21306 fails because this quota is exceeded, the handling of the error is as for
21307 system quota failures.
21308
21309 By default, Exim's quota checking mimics system quotas, and restricts the
21310 mailbox to the specified maximum size, though the value is not accurate to the
21311 last byte, owing to separator lines and additional headers that may get added
21312 during message delivery. When a mailbox is nearly full, large messages may get
21313 refused even though small ones are accepted, because the size of the current
21314 message is added to the quota when the check is made. This behaviour can be
21315 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21316 for exceeding the quota does not include the current message. Thus, deliveries
21317 continue until the quota has been exceeded; thereafter, no further messages are
21318 delivered. See also &%quota_warn_threshold%&.
21319
21320
21321 .option quota_directory appendfile string&!! unset
21322 This option defines the directory to check for quota purposes when delivering
21323 into individual files. The default is the delivery directory, or, if a file
21324 called &_maildirfolder_& exists in a maildir directory, the parent of the
21325 delivery directory.
21326
21327
21328 .option quota_filecount appendfile string&!! 0
21329 This option applies when the &%directory%& option is set. It limits the total
21330 number of files in the directory (compare the inode limit in system quotas). It
21331 can only be used if &%quota%& is also set. The value is expanded; an expansion
21332 failure causes delivery to be deferred. A value of zero is interpreted as
21333 &"no quota"&.
21334
21335
21336 .option quota_is_inclusive appendfile boolean true
21337 See &%quota%& above.
21338
21339
21340 .option quota_size_regex appendfile string unset
21341 This option applies when one of the delivery modes that writes a separate file
21342 for each message is being used. When Exim wants to find the size of one of
21343 these files in order to test the quota, it first checks &%quota_size_regex%&.
21344 If this is set to a regular expression that matches the file name, and it
21345 captures one string, that string is interpreted as a representation of the
21346 file's size. The value of &%quota_size_regex%& is not expanded.
21347
21348 This feature is useful only when users have no shell access to their mailboxes
21349 &-- otherwise they could defeat the quota simply by renaming the files. This
21350 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21351 the file length to the file name. For example:
21352 .code
21353 maildir_tag = ,S=$message_size
21354 quota_size_regex = ,S=(\d+)
21355 .endd
21356 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21357 number of lines in the message.
21358
21359 The regular expression should not assume that the length is at the end of the
21360 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21361 sometimes add other information onto the ends of message file names.
21362
21363 Section &<<SECID136>>& contains further information.
21364
21365
21366 .option quota_warn_message appendfile string&!! "see below"
21367 See below for the use of this option. If it is not set when
21368 &%quota_warn_threshold%& is set, it defaults to
21369 .code
21370 quota_warn_message = "\
21371   To: $local_part@$domain\n\
21372   Subject: Your mailbox\n\n\
21373   This message is automatically created \
21374   by mail delivery software.\n\n\
21375   The size of your mailbox has exceeded \
21376   a warning threshold that is\n\
21377   set by the system administrator.\n"
21378 .endd
21379
21380
21381 .option quota_warn_threshold appendfile string&!! 0
21382 .cindex "quota" "warning threshold"
21383 .cindex "mailbox" "size warning"
21384 .cindex "size" "of mailbox"
21385 This option is expanded in the same way as &%quota%& (see above). If the
21386 resulting value is greater than zero, and delivery of the message causes the
21387 size of the file or total space in the directory tree to cross the given
21388 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21389 may be specified as a percentage of it by following the value with a percent
21390 sign. For example:
21391 .code
21392 quota = 10M
21393 quota_warn_threshold = 75%
21394 .endd
21395 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21396 percent sign is ignored.
21397
21398 The warning message itself is specified by the &%quota_warn_message%& option,
21399 and it must start with a &'To:'& header line containing the recipient(s) of the
21400 warning message. These do not necessarily have to include the recipient(s) of
21401 the original message. A &'Subject:'& line should also normally be supplied. You
21402 can include any other header lines that you want. If you do not include a
21403 &'From:'& line, the default is:
21404 .code
21405 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21406 .endd
21407 .oindex &%errors_reply_to%&
21408 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21409 option.
21410
21411 The &%quota%& option does not have to be set in order to use this option; they
21412 are independent of one another except when the threshold is specified as a
21413 percentage.
21414
21415
21416 .option use_bsmtp appendfile boolean false
21417 .cindex "envelope sender"
21418 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21419 format, with the envelope sender and recipient(s) included as SMTP commands. If
21420 you want to include a leading HELO command with such messages, you can do
21421 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21422 for details of batch SMTP.
21423
21424
21425 .option use_crlf appendfile boolean false
21426 .cindex "carriage return"
21427 .cindex "linefeed"
21428 This option causes lines to be terminated with the two-character CRLF sequence
21429 (carriage return, linefeed) instead of just a linefeed character. In the case
21430 of batched SMTP, the byte sequence written to the file is then an exact image
21431 of what would be sent down a real SMTP connection.
21432
21433 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21434 (which are used to supply the traditional &"From&~"& and blank line separators
21435 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21436 carriage return characters if these are needed. In cases where these options
21437 have non-empty defaults, the values end with a single linefeed, so they must be
21438 changed to end with &`\r\n`& if &%use_crlf%& is set.
21439
21440
21441 .option use_fcntl_lock appendfile boolean "see below"
21442 This option controls the use of the &[fcntl()]& function to lock a file for
21443 exclusive use when a message is being appended. It is set by default unless
21444 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21445 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21446 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21447
21448
21449 .option use_flock_lock appendfile boolean false
21450 This option is provided to support the use of &[flock()]& for file locking, for
21451 the few situations where it is needed. Most modern operating systems support
21452 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21453 each other. Exim uses &[fcntl()]& locking by default.
21454
21455 This option is required only if you are using an operating system where
21456 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21457 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21458 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21459
21460 .cindex "Solaris" "&[flock()]& support"
21461 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21462 have it (and some, I think, provide a not quite right version built on top of
21463 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21464 the ability to use it, and any attempt to do so will cause a configuration
21465 error.
21466
21467 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21468 is just being mapped onto &[fcntl()]& by the OS).
21469
21470
21471 .option use_lockfile appendfile boolean "see below"
21472 If this option is turned off, Exim does not attempt to create a lock file when
21473 appending to a mailbox file. In this situation, the only locking is by
21474 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21475 sure that every MUA that is ever going to look at your users' mailboxes uses
21476 &[fcntl()]& rather than a lock file, and even then only when you are not
21477 delivering over NFS from more than one host.
21478
21479 .cindex "NFS" "lock file"
21480 In order to append to an NFS file safely from more than one host, it is
21481 necessary to take out a lock &'before'& opening the file, and the lock file
21482 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21483 file corruption.
21484
21485 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21486 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21487 except when &%mbx_format%& is set.
21488
21489
21490 .option use_mbx_lock appendfile boolean "see below"
21491 This option is available only if Exim has been compiled with SUPPORT_MBX
21492 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21493 locking rules be used. It is set by default if &%mbx_format%& is set and none
21494 of the locking options are mentioned in the configuration. The locking rules
21495 are the same as are used by the &'c-client'& library that underlies Pine and
21496 the IMAP4 and POP daemons that come with it (see the discussion below). The
21497 rules allow for shared access to the mailbox. However, this kind of locking
21498 does not work when the mailbox is NFS mounted.
21499
21500 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21501 &%use_flock_lock%& to control what kind of locking is used in implementing the
21502 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21503 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21504
21505
21506
21507
21508 .section "Operational details for appending" "SECTopappend"
21509 .cindex "appending to a file"
21510 .cindex "file" "appending"
21511 Before appending to a file, the following preparations are made:
21512
21513 .ilist
21514 If the name of the file is &_/dev/null_&, no action is taken, and a success
21515 return is given.
21516
21517 .next
21518 .cindex "directory creation"
21519 If any directories on the file's path are missing, Exim creates them if the
21520 &%create_directory%& option is set. A created directory's mode is given by the
21521 &%directory_mode%& option.
21522
21523 .next
21524 If &%file_format%& is set, the format of an existing file is checked. If this
21525 indicates that a different transport should be used, control is passed to that
21526 transport.
21527
21528 .next
21529 .cindex "file" "locking"
21530 .cindex "locking files"
21531 .cindex "NFS" "lock file"
21532 If &%use_lockfile%& is set, a lock file is built in a way that will work
21533 reliably over NFS, as follows:
21534
21535 .olist
21536 Create a &"hitching post"& file whose name is that of the lock file with the
21537 current time, primary host name, and process id added, by opening for writing
21538 as a new file. If this fails with an access error, delivery is deferred.
21539 .next
21540 Close the hitching post file, and hard link it to the lock file name.
21541 .next
21542 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21543 Unlink the hitching post name.
21544 .next
21545 Otherwise, use &[stat()]& to get information about the hitching post file, and
21546 then unlink hitching post name. If the number of links is exactly two, creation
21547 of the lock file succeeded but something (for example, an NFS server crash and
21548 restart) caused this fact not to be communicated to the &[link()]& call.
21549 .next
21550 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21551 up to &%lock_retries%& times. However, since any program that writes to a
21552 mailbox should complete its task very quickly, it is reasonable to time out old
21553 lock files that are normally the result of user agent and system crashes. If an
21554 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21555 it before trying again.
21556 .endlist olist
21557
21558 .next
21559 A call is made to &[lstat()]& to discover whether the main file exists, and if
21560 so, what its characteristics are. If &[lstat()]& fails for any reason other
21561 than non-existence, delivery is deferred.
21562
21563 .next
21564 .cindex "symbolic link" "to mailbox"
21565 .cindex "mailbox" "symbolic link"
21566 If the file does exist and is a symbolic link, delivery is deferred, unless the
21567 &%allow_symlink%& option is set, in which case the ownership of the link is
21568 checked, and then &[stat()]& is called to find out about the real file, which
21569 is then subjected to the checks below. The check on the top-level link
21570 ownership prevents one user creating a link for another's mailbox in a sticky
21571 directory, though allowing symbolic links in this case is definitely not a good
21572 idea. If there is a chain of symbolic links, the intermediate ones are not
21573 checked.
21574
21575 .next
21576 If the file already exists but is not a regular file, or if the file's owner
21577 and group (if the group is being checked &-- see &%check_group%& above) are
21578 different from the user and group under which the delivery is running,
21579 delivery is deferred.
21580
21581 .next
21582 If the file's permissions are more generous than specified, they are reduced.
21583 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21584 is set false, in which case the delivery is tried using the existing
21585 permissions.
21586
21587 .next
21588 The file's inode number is saved, and the file is then opened for appending.
21589 If this fails because the file has vanished, &(appendfile)& behaves as if it
21590 hadn't existed (see below). For any other failures, delivery is deferred.
21591
21592 .next
21593 If the file is opened successfully, check that the inode number hasn't
21594 changed, that it is still a regular file, and that the owner and permissions
21595 have not changed. If anything is wrong, defer delivery and freeze the message.
21596
21597 .next
21598 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21599 option is set. Otherwise, check that the file is being created in a permitted
21600 directory if the &%create_file%& option is set (deferring on failure), and then
21601 open for writing as a new file, with the O_EXCL and O_CREAT options,
21602 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21603 set). In this case, which can happen if the link points to a non-existent file,
21604 the file is opened for writing using O_CREAT but not O_EXCL, because
21605 that prevents link following.
21606
21607 .next
21608 .cindex "loop" "while file testing"
21609 If opening fails because the file exists, obey the tests given above for
21610 existing files. However, to avoid looping in a situation where the file is
21611 being continuously created and destroyed, the exists/not-exists loop is broken
21612 after 10 repetitions, and the message is then frozen.
21613
21614 .next
21615 If opening fails with any other error, defer delivery.
21616
21617 .next
21618 .cindex "file" "locking"
21619 .cindex "locking files"
21620 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21621 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21622 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21623 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21624 file, and an exclusive lock on the file whose name is
21625 .code
21626 /tmp/.<device-number>.<inode-number>
21627 .endd
21628 using the device and inode numbers of the open mailbox file, in accordance with
21629 the MBX locking rules. This file is created with a mode that is specified by
21630 the &%lockfile_mode%& option.
21631
21632 If Exim fails to lock the file, there are two possible courses of action,
21633 depending on the value of the locking timeout. This is obtained from
21634 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21635
21636 If the timeout value is zero, the file is closed, Exim waits for
21637 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21638 to lock it again. This happens up to &%lock_retries%& times, after which the
21639 delivery is deferred.
21640
21641 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21642 &[flock()]& are used (with the given timeout), so there has already been some
21643 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21644 immediately. It retries up to
21645 .code
21646 (lock_retries * lock_interval) / <timeout>
21647 .endd
21648 times (rounded up).
21649 .endlist
21650
21651 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21652 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21653
21654
21655 .section "Operational details for delivery to a new file" "SECTopdir"
21656 .cindex "delivery" "to single file"
21657 .cindex "&""From""& line"
21658 When the &%directory%& option is set instead of &%file%&, each message is
21659 delivered into a newly-created file or set of files. When &(appendfile)& is
21660 activated directly from a &(redirect)& router, neither &%file%& nor
21661 &%directory%& is normally set, because the path for delivery is supplied by the
21662 router. (See for example, the &(address_file)& transport in the default
21663 configuration.) In this case, delivery is to a new file if either the path name
21664 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21665
21666 No locking is required while writing the message to a new file, so the various
21667 locking options of the transport are ignored. The &"From"& line that by default
21668 separates messages in a single file is not normally needed, nor is the escaping
21669 of message lines that start with &"From"&, and there is no need to ensure a
21670 newline at the end of each message. Consequently, the default values for
21671 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21672 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21673
21674 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21675 the files in the delivery directory by default. However, you can specify a
21676 different directory by setting &%quota_directory%&. Also, for maildir
21677 deliveries (see below) the &_maildirfolder_& convention is honoured.
21678
21679
21680 .cindex "maildir format"
21681 .cindex "mailstore format"
21682 There are three different ways in which delivery to individual files can be
21683 done, controlled by the settings of the &%maildir_format%& and
21684 &%mailstore_format%& options. Note that code to support maildir or mailstore
21685 formats is not included in the binary unless SUPPORT_MAILDIR or
21686 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21687
21688 .cindex "directory creation"
21689 In all three cases an attempt is made to create the directory and any necessary
21690 sub-directories if they do not exist, provided that the &%create_directory%&
21691 option is set (the default). The location of a created directory can be
21692 constrained by setting &%create_file%&. A created directory's mode is given by
21693 the &%directory_mode%& option. If creation fails, or if the
21694 &%create_directory%& option is not set when creation is required, delivery is
21695 deferred.
21696
21697
21698
21699 .section "Maildir delivery" "SECTmaildirdelivery"
21700 .cindex "maildir format" "description of"
21701 If the &%maildir_format%& option is true, Exim delivers each message by writing
21702 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21703 directory that is defined by the &%directory%& option (the &"delivery
21704 directory"&). If the delivery is successful, the file is renamed into the
21705 &_new_& subdirectory.
21706
21707 In the file name, <&'stime'&> is the current time of day in seconds, and
21708 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21709 Exim checks that the time-of-day clock has moved on by at least one microsecond
21710 before terminating the delivery process. This guarantees uniqueness for the
21711 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21712 opening it. If any response other than ENOENT (does not exist) is given,
21713 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21714
21715 Before Exim carries out a maildir delivery, it ensures that subdirectories
21716 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21717 do not exist, Exim tries to create them and any superior directories in their
21718 path, subject to the &%create_directory%& and &%create_file%& options. If the
21719 &%maildirfolder_create_regex%& option is set, and the regular expression it
21720 contains matches the delivery directory, Exim also ensures that a file called
21721 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21722 &_maildirfolder_& file cannot be created, delivery is deferred.
21723
21724 These features make it possible to use Exim to create all the necessary files
21725 and directories in a maildir mailbox, including subdirectories for maildir++
21726 folders. Consider this example:
21727 .code
21728 maildir_format = true
21729 directory = /var/mail/$local_part\
21730            ${if eq{$local_part_suffix}{}{}\
21731            {/.${substr_1:$local_part_suffix}}}
21732 maildirfolder_create_regex = /\.[^/]+$
21733 .endd
21734 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21735 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21736 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21737 not match this name, so Exim will not look for or create the file
21738 &_/var/mail/pimbo/maildirfolder_&, though it will create
21739 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21740
21741 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21742 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21743 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21744 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21745 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21746
21747 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21748 not inadvertently match the toplevel maildir directory, because a
21749 &_maildirfolder_& file at top level would completely break quota calculations.
21750
21751 .cindex "quota" "in maildir delivery"
21752 .cindex "maildir++"
21753 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21754 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21755 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21756 Exim assumes the directory is a maildir++ folder directory, which is one level
21757 down from the user's top level mailbox directory. This causes it to start at
21758 the parent directory instead of the current directory when calculating the
21759 amount of space used.
21760
21761 One problem with delivering into a multi-file mailbox is that it is
21762 computationally expensive to compute the size of the mailbox for quota
21763 checking. Various approaches have been taken to reduce the amount of work
21764 needed. The next two sections describe two of them. A third alternative is to
21765 use some external process for maintaining the size data, and use the expansion
21766 of the &%mailbox_size%& option as a way of importing it into Exim.
21767
21768
21769
21770
21771 .section "Using tags to record message sizes" "SECID135"
21772 If &%maildir_tag%& is set, the string is expanded for each delivery.
21773 When the maildir file is renamed into the &_new_& sub-directory, the
21774 tag is added to its name. However, if adding the tag takes the length of the
21775 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21776 the tag is dropped and the maildir file is created with no tag.
21777
21778
21779 .vindex "&$message_size$&"
21780 Tags can be used to encode the size of files in their names; see
21781 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21782 happens after the message has been written. The value of the &$message_size$&
21783 variable is set to the number of bytes actually written. If the expansion is
21784 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21785 be deferred. The expanded tag may contain any printing characters except &"/"&.
21786 Non-printing characters in the string are ignored; if the resulting string is
21787 empty, it is ignored. If it starts with an alphanumeric character, a leading
21788 colon is inserted; this default has not proven to be the path that popular
21789 maildir implementations have chosen (but changing it in Exim would break
21790 backwards compatibility).
21791
21792 For one common implementation, you might set:
21793 .code
21794 maildir_tag = ,S=${message_size}
21795 .endd
21796 but you should check the documentation of the other software to be sure.
21797
21798 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21799 as this allows Exim to extract the size from your tag, instead of having to
21800 &[stat()]& each message file.
21801
21802
21803 .section "Using a maildirsize file" "SECID136"
21804 .cindex "quota" "in maildir delivery"
21805 .cindex "maildir format" "&_maildirsize_& file"
21806 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21807 storing quota and message size information in a file called &_maildirsize_&
21808 within the toplevel maildir directory. If this file does not exist, Exim
21809 creates it, setting the quota from the &%quota%& option of the transport. If
21810 the maildir directory itself does not exist, it is created before any attempt
21811 to write a &_maildirsize_& file.
21812
21813 The &_maildirsize_& file is used to hold information about the sizes of
21814 messages in the maildir, thus speeding up quota calculations. The quota value
21815 in the file is just a cache; if the quota is changed in the transport, the new
21816 value overrides the cached value when the next message is delivered. The cache
21817 is maintained for the benefit of other programs that access the maildir and
21818 need to know the quota.
21819
21820 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21821 file is maintained (with a zero quota setting), but no quota is imposed.
21822
21823 A regular expression is available for controlling which directories in the
21824 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21825 See the description of the &%maildir_quota_directory_regex%& option above for
21826 details.
21827
21828
21829 .section "Mailstore delivery" "SECID137"
21830 .cindex "mailstore format" "description of"
21831 If the &%mailstore_format%& option is true, each message is written as two
21832 files in the given directory. A unique base name is constructed from the
21833 message id and the current delivery process, and the files that are written use
21834 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21835 contains the message's envelope, and the &_.msg_& file contains the message
21836 itself. The base name is placed in the variable &$mailstore_basename$&.
21837
21838 During delivery, the envelope is first written to a file with the suffix
21839 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21840 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21841 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21842 file before accessing either of them. An alternative approach is to wait for
21843 the absence of a &_.tmp_& file.
21844
21845 The envelope file starts with any text defined by the &%mailstore_prefix%&
21846 option, expanded and terminated by a newline if there isn't one. Then follows
21847 the sender address on one line, then all the recipient addresses, one per line.
21848 There can be more than one recipient only if the &%batch_max%& option is set
21849 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21850 appended to the file, followed by a newline if it does not end with one.
21851
21852 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21853 failure, it is ignored. Other expansion errors are treated as serious
21854 configuration errors, and delivery is deferred. The variable
21855 &$mailstore_basename$& is available for use during these expansions.
21856
21857
21858 .section "Non-special new file delivery" "SECID138"
21859 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21860 file is created directly in the named directory. For example, when delivering
21861 messages into files in batched SMTP format for later delivery to some host (see
21862 section &<<SECTbatchSMTP>>&), a setting such as
21863 .code
21864 directory = /var/bsmtp/$host
21865 .endd
21866 might be used. A message is written to a file with a temporary name, which is
21867 then renamed when the delivery is complete. The final name is obtained by
21868 expanding the contents of the &%directory_file%& option.
21869 .ecindex IIDapptra1
21870 .ecindex IIDapptra2
21871
21872
21873
21874
21875
21876
21877 . ////////////////////////////////////////////////////////////////////////////
21878 . ////////////////////////////////////////////////////////////////////////////
21879
21880 .chapter "The autoreply transport" "CHID8"
21881 .scindex IIDauttra1 "transports" "&(autoreply)&"
21882 .scindex IIDauttra2 "&(autoreply)& transport"
21883 The &(autoreply)& transport is not a true transport in that it does not cause
21884 the message to be transmitted. Instead, it generates a new mail message as an
21885 automatic reply to the incoming message. &'References:'& and
21886 &'Auto-Submitted:'& header lines are included. These are constructed according
21887 to the rules in RFCs 2822 and 3834, respectively.
21888
21889 If the router that passes the message to this transport does not have the
21890 &%unseen%& option set, the original message (for the current recipient) is not
21891 delivered anywhere. However, when the &%unseen%& option is set on the router
21892 that passes the message to this transport, routing of the address continues, so
21893 another router can set up a normal message delivery.
21894
21895
21896 The &(autoreply)& transport is usually run as the result of mail filtering, a
21897 &"vacation"& message being the standard example. However, it can also be run
21898 directly from a router like any other transport. To reduce the possibility of
21899 message cascades, messages created by the &(autoreply)& transport always have
21900 empty envelope sender addresses, like bounce messages.
21901
21902 The parameters of the message to be sent can be specified in the configuration
21903 by options described below. However, these are used only when the address
21904 passed to the transport does not contain its own reply information. When the
21905 transport is run as a consequence of a
21906 &%mail%&
21907 or &%vacation%& command in a filter file, the parameters of the message are
21908 supplied by the filter, and passed with the address. The transport's options
21909 that define the message are then ignored (so they are not usually set in this
21910 case). The message is specified entirely by the filter or by the transport; it
21911 is never built from a mixture of options. However, the &%file_optional%&,
21912 &%mode%&, and &%return_message%& options apply in all cases.
21913
21914 &(Autoreply)& is implemented as a local transport. When used as a result of a
21915 command in a user's filter file, &(autoreply)& normally runs under the uid and
21916 gid of the user, and with appropriate current and home directories (see chapter
21917 &<<CHAPenvironment>>&).
21918
21919 There is a subtle difference between routing a message to a &(pipe)& transport
21920 that generates some text to be returned to the sender, and routing it to an
21921 &(autoreply)& transport. This difference is noticeable only if more than one
21922 address from the same message is so handled. In the case of a pipe, the
21923 separate outputs from the different addresses are gathered up and returned to
21924 the sender in a single message, whereas if &(autoreply)& is used, a separate
21925 message is generated for each address that is passed to it.
21926
21927 Non-printing characters are not permitted in the header lines generated for the
21928 message that &(autoreply)& creates, with the exception of newlines that are
21929 immediately followed by white space. If any non-printing characters are found,
21930 the transport defers.
21931 Whether characters with the top bit set count as printing characters or not is
21932 controlled by the &%print_topbitchars%& global option.
21933
21934 If any of the generic options for manipulating headers (for example,
21935 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21936 of the original message that is included in the generated message when
21937 &%return_message%& is set. They do not apply to the generated message itself.
21938
21939 .vindex "&$sender_address$&"
21940 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21941 the message, indicating that there were no recipients, it does not treat this
21942 as an error. This means that autoreplies sent to &$sender_address$& when this
21943 is empty (because the incoming message is a bounce message) do not cause
21944 problems. They are just discarded.
21945
21946
21947
21948 .section "Private options for autoreply" "SECID139"
21949 .cindex "options" "&(autoreply)& transport"
21950
21951 .option bcc autoreply string&!! unset
21952 This specifies the addresses that are to receive &"blind carbon copies"& of the
21953 message when the message is specified by the transport.
21954
21955
21956 .option cc autoreply string&!! unset
21957 This specifies recipients of the message and the contents of the &'Cc:'& header
21958 when the message is specified by the transport.
21959
21960
21961 .option file autoreply string&!! unset
21962 The contents of the file are sent as the body of the message when the message
21963 is specified by the transport. If both &%file%& and &%text%& are set, the text
21964 string comes first.
21965
21966
21967 .option file_expand autoreply boolean false
21968 If this is set, the contents of the file named by the &%file%& option are
21969 subjected to string expansion as they are added to the message.
21970
21971
21972 .option file_optional autoreply boolean false
21973 If this option is true, no error is generated if the file named by the &%file%&
21974 option or passed with the address does not exist or cannot be read.
21975
21976
21977 .option from autoreply string&!! unset
21978 This specifies the contents of the &'From:'& header when the message is
21979 specified by the transport.
21980
21981
21982 .option headers autoreply string&!! unset
21983 This specifies additional RFC 2822 headers that are to be added to the message
21984 when the message is specified by the transport. Several can be given by using
21985 &"\n"& to separate them. There is no check on the format.
21986
21987
21988 .option log autoreply string&!! unset
21989 This option names a file in which a record of every message sent is logged when
21990 the message is specified by the transport.
21991
21992
21993 .option mode autoreply "octal integer" 0600
21994 If either the log file or the &"once"& file has to be created, this mode is
21995 used.
21996
21997
21998 .option never_mail autoreply "address list&!!" unset
21999 If any run of the transport creates a message with a recipient that matches any
22000 item in the list, that recipient is quietly discarded. If all recipients are
22001 discarded, no message is created. This applies both when the recipients are
22002 generated by a filter and when they are specified in the transport.
22003
22004
22005
22006 .option once autoreply string&!! unset
22007 This option names a file or DBM database in which a record of each &'To:'&
22008 recipient is kept when the message is specified by the transport. &*Note*&:
22009 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22010
22011 If &%once%& is unset, or is set to an empty string, the message is always sent.
22012 By default, if &%once%& is set to a non-empty file name, the message
22013 is not sent if a potential recipient is already listed in the database.
22014 However, if the &%once_repeat%& option specifies a time greater than zero, the
22015 message is sent if that much time has elapsed since a message was last sent to
22016 this recipient. A setting of zero time for &%once_repeat%& (the default)
22017 prevents a message from being sent a second time &-- in this case, zero means
22018 infinity.
22019
22020 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22021 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22022 greater than zero, it changes the way Exim implements the &%once%& option.
22023 Instead of using a DBM file to record every recipient it sends to, it uses a
22024 regular file, whose size will never get larger than the given value.
22025
22026 In the file, Exim keeps a linear list of recipient addresses and the times at
22027 which they were sent messages. If the file is full when a new address needs to
22028 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22029 means that a given recipient may receive multiple messages, but at
22030 unpredictable intervals that depend on the rate of turnover of addresses in the
22031 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22032
22033
22034 .option once_file_size autoreply integer 0
22035 See &%once%& above.
22036
22037
22038 .option once_repeat autoreply time&!! 0s
22039 See &%once%& above.
22040 After expansion, the value of this option must be a valid time value.
22041
22042
22043 .option reply_to autoreply string&!! unset
22044 This specifies the contents of the &'Reply-To:'& header when the message is
22045 specified by the transport.
22046
22047
22048 .option return_message autoreply boolean false
22049 If this is set, a copy of the original message is returned with the new
22050 message, subject to the maximum size set in the &%return_size_limit%& global
22051 configuration option.
22052
22053
22054 .option subject autoreply string&!! unset
22055 This specifies the contents of the &'Subject:'& header when the message is
22056 specified by the transport. It is tempting to quote the original subject in
22057 automatic responses. For example:
22058 .code
22059 subject = Re: $h_subject:
22060 .endd
22061 There is a danger in doing this, however. It may allow a third party to
22062 subscribe your users to an opt-in mailing list, provided that the list accepts
22063 bounce messages as subscription confirmations. Well-managed lists require a
22064 non-bounce message to confirm a subscription, so the danger is relatively
22065 small.
22066
22067
22068
22069 .option text autoreply string&!! unset
22070 This specifies a single string to be used as the body of the message when the
22071 message is specified by the transport. If both &%text%& and &%file%& are set,
22072 the text comes first.
22073
22074
22075 .option to autoreply string&!! unset
22076 This specifies recipients of the message and the contents of the &'To:'& header
22077 when the message is specified by the transport.
22078 .ecindex IIDauttra1
22079 .ecindex IIDauttra2
22080
22081
22082
22083
22084 . ////////////////////////////////////////////////////////////////////////////
22085 . ////////////////////////////////////////////////////////////////////////////
22086
22087 .chapter "The lmtp transport" "CHAPLMTP"
22088 .cindex "transports" "&(lmtp)&"
22089 .cindex "&(lmtp)& transport"
22090 .cindex "LMTP" "over a pipe"
22091 .cindex "LMTP" "over a socket"
22092 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22093 specified command
22094 or by interacting with a Unix domain socket.
22095 This transport is something of a cross between the &(pipe)& and &(smtp)&
22096 transports. Exim also has support for using LMTP over TCP/IP; this is
22097 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22098 to be of minority interest, the default build-time configure in &_src/EDITME_&
22099 has it commented out. You need to ensure that
22100 .code
22101 TRANSPORT_LMTP=yes
22102 .endd
22103 .cindex "options" "&(lmtp)& transport"
22104 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22105 included in the Exim binary. The private options of the &(lmtp)& transport are
22106 as follows:
22107
22108 .option batch_id lmtp string&!! unset
22109 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22110
22111
22112 .option batch_max lmtp integer 1
22113 This limits the number of addresses that can be handled in a single delivery.
22114 Most LMTP servers can handle several addresses at once, so it is normally a
22115 good idea to increase this value. See the description of local delivery
22116 batching in chapter &<<CHAPbatching>>&.
22117
22118
22119 .option command lmtp string&!! unset
22120 This option must be set if &%socket%& is not set. The string is a command which
22121 is run in a separate process. It is split up into a command name and list of
22122 arguments, each of which is separately expanded (so expansion cannot change the
22123 number of arguments). The command is run directly, not via a shell. The message
22124 is passed to the new process using the standard input and output to operate the
22125 LMTP protocol.
22126
22127 .option ignore_quota lmtp boolean false
22128 .cindex "LMTP" "ignoring quota errors"
22129 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22130 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22131 in its response to the LHLO command.
22132
22133 .option socket lmtp string&!! unset
22134 This option must be set if &%command%& is not set. The result of expansion must
22135 be the name of a Unix domain socket. The transport connects to the socket and
22136 delivers the message to it using the LMTP protocol.
22137
22138
22139 .option timeout lmtp time 5m
22140 The transport is aborted if the created process or Unix domain socket does not
22141 respond to LMTP commands or message input within this timeout. Delivery
22142 is deferred, and will be tried again later. Here is an example of a typical
22143 LMTP transport:
22144 .code
22145 lmtp:
22146   driver = lmtp
22147   command = /some/local/lmtp/delivery/program
22148   batch_max = 20
22149   user = exim
22150 .endd
22151 This delivers up to 20 addresses at a time, in a mixture of domains if
22152 necessary, running as the user &'exim'&.
22153
22154
22155
22156 . ////////////////////////////////////////////////////////////////////////////
22157 . ////////////////////////////////////////////////////////////////////////////
22158
22159 .chapter "The pipe transport" "CHAPpipetransport"
22160 .scindex IIDpiptra1 "transports" "&(pipe)&"
22161 .scindex IIDpiptra2 "&(pipe)& transport"
22162 The &(pipe)& transport is used to deliver messages via a pipe to a command
22163 running in another process. One example is the use of &(pipe)& as a
22164 pseudo-remote transport for passing messages to some other delivery mechanism
22165 (such as UUCP). Another is the use by individual users to automatically process
22166 their incoming messages. The &(pipe)& transport can be used in one of the
22167 following ways:
22168
22169 .ilist
22170 .vindex "&$local_part$&"
22171 A router routes one address to a transport in the normal way, and the
22172 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22173 contains the local part of the address (as usual), and the command that is run
22174 is specified by the &%command%& option on the transport.
22175 .next
22176 .vindex "&$pipe_addresses$&"
22177 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22178 transport can handle more than one address in a single run. In this case, when
22179 more than one address is routed to the transport, &$local_part$& is not set
22180 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22181 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22182 that are routed to the transport.
22183 .next
22184 .vindex "&$address_pipe$&"
22185 A router redirects an address directly to a pipe command (for example, from an
22186 alias or forward file). In this case, &$address_pipe$& contains the text of the
22187 pipe command, and the &%command%& option on the transport is ignored unless
22188 &%force_command%& is set. If only one address is being transported
22189 (&%batch_max%& is not greater than one, or only one address was redirected to
22190 this pipe command), &$local_part$& contains the local part that was redirected.
22191 .endlist
22192
22193
22194 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22195 deliver messages over pipes using the LMTP interactive protocol. This is
22196 implemented by the &(lmtp)& transport.
22197
22198 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22199 &_.forward_& file, the command runs under the uid and gid of that user. In
22200 other cases, the uid and gid have to be specified explicitly, either on the
22201 transport or on the router that handles the address. Current and &"home"&
22202 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22203 details of the local delivery environment and chapter &<<CHAPbatching>>&
22204 for a discussion of local delivery batching.
22205
22206
22207 .section "Concurrent delivery" "SECID140"
22208 If two messages arrive at almost the same time, and both are routed to a pipe
22209 delivery, the two pipe transports may be run concurrently. You must ensure that
22210 any pipe commands you set up are robust against this happening. If the commands
22211 write to a file, the &%exim_lock%& utility might be of use.
22212
22213
22214
22215
22216 .section "Returned status and data" "SECID141"
22217 .cindex "&(pipe)& transport" "returned data"
22218 If the command exits with a non-zero return code, the delivery is deemed to
22219 have failed, unless either the &%ignore_status%& option is set (in which case
22220 the return code is treated as zero), or the return code is one of those listed
22221 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22222 later"&. In this case, delivery is deferred. Details of a permanent failure are
22223 logged, but are not included in the bounce message, which merely contains
22224 &"local delivery failed"&.
22225
22226 If the command exits on a signal and the &%freeze_signal%& option is set then
22227 the message will be frozen in the queue. If that option is not set, a bounce
22228 will be sent as normal.
22229
22230 If the return code is greater than 128 and the command being run is a shell
22231 script, it normally means that the script was terminated by a signal whose
22232 value is the return code minus 128. The &%freeze_signal%& option does not
22233 apply in this case.
22234
22235 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22236 return code is set to 127. This is the value that a shell returns if it is
22237 asked to run a non-existent command. The wording for the log line suggests that
22238 a non-existent command may be the problem.
22239
22240 The &%return_output%& option can affect the result of a pipe delivery. If it is
22241 set and the command produces any output on its standard output or standard
22242 error streams, the command is considered to have failed, even if it gave a zero
22243 return code or if &%ignore_status%& is set. The output from the command is
22244 included as part of the bounce message. The &%return_fail_output%& option is
22245 similar, except that output is returned only when the command exits with a
22246 failure return code, that is, a value other than zero or a code that matches
22247 &%temp_errors%&.
22248
22249
22250
22251 .section "How the command is run" "SECThowcommandrun"
22252 .cindex "&(pipe)& transport" "path for command"
22253 The command line is (by default) broken down into a command name and arguments
22254 by the &(pipe)& transport itself. The &%allow_commands%& and
22255 &%restrict_to_path%& options can be used to restrict the commands that may be
22256 run.
22257
22258 .cindex "quoting" "in pipe command"
22259 Unquoted arguments are delimited by white space. If an argument appears in
22260 double quotes, backslash is interpreted as an escape character in the usual
22261 way. If an argument appears in single quotes, no escaping is done.
22262
22263 String expansion is applied to the command line except when it comes from a
22264 traditional &_.forward_& file (commands from a filter file are expanded). The
22265 expansion is applied to each argument in turn rather than to the whole line.
22266 For this reason, any string expansion item that contains white space must be
22267 quoted so as to be contained within a single argument. A setting such as
22268 .code
22269 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22270 .endd
22271 will not work, because the expansion item gets split between several
22272 arguments. You have to write
22273 .code
22274 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22275 .endd
22276 to ensure that it is all in one argument. The expansion is done in this way,
22277 argument by argument, so that the number of arguments cannot be changed as a
22278 result of expansion, and quotes or backslashes in inserted variables do not
22279 interact with external quoting. However, this leads to problems if you want to
22280 generate multiple arguments (or the command name plus arguments) from a single
22281 expansion. In this situation, the simplest solution is to use a shell. For
22282 example:
22283 .code
22284 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22285 .endd
22286
22287 .cindex "transport" "filter"
22288 .cindex "filter" "transport filter"
22289 .vindex "&$pipe_addresses$&"
22290 Special handling takes place when an argument consists of precisely the text
22291 &`$pipe_addresses`&. This is not a general expansion variable; the only
22292 place this string is recognized is when it appears as an argument for a pipe or
22293 transport filter command. It causes each address that is being handled to be
22294 inserted in the argument list at that point &'as a separate argument'&. This
22295 avoids any problems with spaces or shell metacharacters, and is of use when a
22296 &(pipe)& transport is handling groups of addresses in a batch.
22297
22298 If &%force_command%& is enabled on the transport, Special handling takes place
22299 for an argument that consists of precisely the text &`$address_pipe`&.  It
22300 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22301 argument is inserted in the argument list at that point
22302 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22303 the only item in the argument; in fact, if it were then &%force_command%&
22304 should behave as a no-op.  Rather, it should be used to adjust the command
22305 run while preserving the argument vector separation.
22306
22307 After splitting up into arguments and expansion, the resulting command is run
22308 in a subprocess directly from the transport, &'not'& under a shell. The
22309 message that is being delivered is supplied on the standard input, and the
22310 standard output and standard error are both connected to a single pipe that is
22311 read by Exim. The &%max_output%& option controls how much output the command
22312 may produce, and the &%return_output%& and &%return_fail_output%& options
22313 control what is done with it.
22314
22315 Not running the command under a shell (by default) lessens the security risks
22316 in cases when a command from a user's filter file is built out of data that was
22317 taken from an incoming message. If a shell is required, it can of course be
22318 explicitly specified as the command to be run. However, there are circumstances
22319 where existing commands (for example, in &_.forward_& files) expect to be run
22320 under a shell and cannot easily be modified. To allow for these cases, there is
22321 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22322 works. Instead of breaking up the command line as just described, it expands it
22323 as a single string and passes the result to &_/bin/sh_&. The
22324 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22325 with &%use_shell%&, and the whole mechanism is inherently less secure.
22326
22327
22328
22329 .section "Environment variables" "SECTpipeenv"
22330 .cindex "&(pipe)& transport" "environment for command"
22331 .cindex "environment for pipe transport"
22332 The environment variables listed below are set up when the command is invoked.
22333 This list is a compromise for maximum compatibility with other MTAs. Note that
22334 the &%environment%& option can be used to add additional variables to this
22335 environment.
22336 .display
22337 &`DOMAIN            `&   the domain of the address
22338 &`HOME              `&   the home directory, if set
22339 &`HOST              `&   the host name when called from a router (see below)
22340 &`LOCAL_PART        `&   see below
22341 &`LOCAL_PART_PREFIX `&   see below
22342 &`LOCAL_PART_SUFFIX `&   see below
22343 &`LOGNAME           `&   see below
22344 &`MESSAGE_ID        `&   Exim's local ID for the message
22345 &`PATH              `&   as specified by the &%path%& option below
22346 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22347 &`RECIPIENT         `&   the complete recipient address
22348 &`SENDER            `&   the sender of the message (empty if a bounce)
22349 &`SHELL             `&   &`/bin/sh`&
22350 &`TZ                `&   the value of the &%timezone%& option, if set
22351 &`USER              `&   see below
22352 .endd
22353 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22354 router, LOCAL_PART is set to the local part of the address. When it is
22355 called as a result of a forward or alias expansion, LOCAL_PART is set to
22356 the local part of the address that was expanded. In both cases, any affixes are
22357 removed from the local part, and made available in LOCAL_PART_PREFIX and
22358 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22359 same value as LOCAL_PART for compatibility with other MTAs.
22360
22361 .cindex "HOST"
22362 HOST is set only when a &(pipe)& transport is called from a router that
22363 associates hosts with an address, typically when using &(pipe)& as a
22364 pseudo-remote transport. HOST is set to the first host name specified by
22365 the router.
22366
22367 .cindex "HOME"
22368 If the transport's generic &%home_directory%& option is set, its value is used
22369 for the HOME environment variable. Otherwise, a home directory may be set
22370 by the router's &%transport_home_directory%& option, which defaults to the
22371 user's home directory if &%check_local_user%& is set.
22372
22373
22374 .section "Private options for pipe" "SECID142"
22375 .cindex "options" "&(pipe)& transport"
22376
22377
22378
22379 .option allow_commands pipe "string list&!!" unset
22380 .cindex "&(pipe)& transport" "permitted commands"
22381 The string is expanded, and is then interpreted as a colon-separated list of
22382 permitted commands. If &%restrict_to_path%& is not set, the only commands
22383 permitted are those in the &%allow_commands%& list. They need not be absolute
22384 paths; the &%path%& option is still used for relative paths. If
22385 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22386 in the &%allow_commands%& list, or a name without any slashes that is found on
22387 the path. In other words, if neither &%allow_commands%& nor
22388 &%restrict_to_path%& is set, there is no restriction on the command, but
22389 otherwise only commands that are permitted by one or the other are allowed. For
22390 example, if
22391 .code
22392 allow_commands = /usr/bin/vacation
22393 .endd
22394 and &%restrict_to_path%& is not set, the only permitted command is
22395 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22396 &%use_shell%& is set.
22397
22398
22399 .option batch_id pipe string&!! unset
22400 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22401
22402
22403 .option batch_max pipe integer 1
22404 This limits the number of addresses that can be handled in a single delivery.
22405 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22406
22407
22408 .option check_string pipe string unset
22409 As &(pipe)& writes the message, the start of each line is tested for matching
22410 &%check_string%&, and if it does, the initial matching characters are replaced
22411 by the contents of &%escape_string%&, provided both are set. The value of
22412 &%check_string%& is a literal string, not a regular expression, and the case of
22413 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22414 of &%check_string%& and &%escape_string%& are forced to values that implement
22415 the SMTP escaping protocol. Any settings made in the configuration file are
22416 ignored.
22417
22418
22419 .option command pipe string&!! unset
22420 This option need not be set when &(pipe)& is being used to deliver to pipes
22421 obtained directly from address redirections. In other cases, the option must be
22422 set, to provide a command to be run. It need not yield an absolute path (see
22423 the &%path%& option below). The command is split up into separate arguments by
22424 Exim, and each argument is separately expanded, as described in section
22425 &<<SECThowcommandrun>>& above.
22426
22427
22428 .option environment pipe string&!! unset
22429 .cindex "&(pipe)& transport" "environment for command"
22430 .cindex "environment for &(pipe)& transport"
22431 This option is used to add additional variables to the environment in which the
22432 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22433 a string which is expanded, and then interpreted as a colon-separated list of
22434 environment settings of the form <&'name'&>=<&'value'&>.
22435
22436
22437 .option escape_string pipe string unset
22438 See &%check_string%& above.
22439
22440
22441 .option freeze_exec_fail pipe boolean false
22442 .cindex "exec failure"
22443 .cindex "failure of exec"
22444 .cindex "&(pipe)& transport" "failure of exec"
22445 Failure to exec the command in a pipe transport is by default treated like
22446 any other failure while running the command. However, if &%freeze_exec_fail%&
22447 is set, failure to exec is treated specially, and causes the message to be
22448 frozen, whatever the setting of &%ignore_status%&.
22449
22450
22451 .option freeze_signal pipe boolean false
22452 .cindex "signal exit"
22453 .cindex "&(pipe)& transport", "signal exit"
22454 Normally if the process run by a command in a pipe transport exits on a signal,
22455 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22456 frozen in Exim's queue instead.
22457
22458
22459 .option force_command pipe boolean false
22460 .cindex "force command"
22461 .cindex "&(pipe)& transport", "force command"
22462 Normally when a router redirects an address directly to a pipe command
22463 the &%command%& option on the transport is ignored.  If &%force_command%&
22464 is set, the &%command%& option will used. This is especially
22465 useful for forcing a wrapper or additional argument to be added to the
22466 command. For example:
22467 .code
22468 command = /usr/bin/remote_exec myhost -- $address_pipe
22469 force_command
22470 .endd
22471
22472 Note that &$address_pipe$& is handled specially in &%command%& when
22473 &%force_command%& is set, expanding out to the original argument vector as
22474 separate items, similarly to a Unix shell &`"$@"`& construct.
22475
22476 .option ignore_status pipe boolean false
22477 If this option is true, the status returned by the subprocess that is set up to
22478 run the command is ignored, and Exim behaves as if zero had been returned.
22479 Otherwise, a non-zero status or termination by signal causes an error return
22480 from the transport unless the status value is one of those listed in
22481 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22482
22483 &*Note*&: This option does not apply to timeouts, which do not return a status.
22484 See the &%timeout_defer%& option for how timeouts are handled.
22485
22486 .option log_defer_output pipe boolean false
22487 .cindex "&(pipe)& transport" "logging output"
22488 If this option is set, and the status returned by the command is
22489 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22490 and any output was produced, the first line of it is written to the main log.
22491
22492
22493 .option log_fail_output pipe boolean false
22494 If this option is set, and the command returns any output, and also ends with a
22495 return code that is neither zero nor one of the return codes listed in
22496 &%temp_errors%& (that is, the delivery failed), the first line of output is
22497 written to the main log. This option and &%log_output%& are mutually exclusive.
22498 Only one of them may be set.
22499
22500
22501
22502 .option log_output pipe boolean false
22503 If this option is set and the command returns any output, the first line of
22504 output is written to the main log, whatever the return code. This option and
22505 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22506
22507
22508
22509 .option max_output pipe integer 20K
22510 This specifies the maximum amount of output that the command may produce on its
22511 standard output and standard error file combined. If the limit is exceeded, the
22512 process running the command is killed. This is intended as a safety measure to
22513 catch runaway processes. The limit is applied independently of the settings of
22514 the options that control what is done with such output (for example,
22515 &%return_output%&). Because of buffering effects, the amount of output may
22516 exceed the limit by a small amount before Exim notices.
22517
22518
22519 .option message_prefix pipe string&!! "see below"
22520 The string specified here is expanded and output at the start of every message.
22521 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22522 .code
22523 message_prefix = \
22524   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22525   ${tod_bsdinbox}\n
22526 .endd
22527 .cindex "Cyrus"
22528 .cindex "&%tmail%&"
22529 .cindex "&""From""& line"
22530 This is required by the commonly used &_/usr/bin/vacation_& program.
22531 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22532 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22533 setting
22534 .code
22535 message_prefix =
22536 .endd
22537 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22538 &`\n`& to &`\r\n`& in &%message_prefix%&.
22539
22540
22541 .option message_suffix pipe string&!! "see below"
22542 The string specified here is expanded and output at the end of every message.
22543 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22544 The suffix can be suppressed by setting
22545 .code
22546 message_suffix =
22547 .endd
22548 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22549 &`\n`& to &`\r\n`& in &%message_suffix%&.
22550
22551
22552 .option path pipe string "see below"
22553 This option specifies the string that is set up in the PATH environment
22554 variable of the subprocess. The default is:
22555 .code
22556 /bin:/usr/bin
22557 .endd
22558 If the &%command%& option does not yield an absolute path name, the command is
22559 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22560 apply to a command specified as a transport filter.
22561
22562
22563 .option permit_coredump pipe boolean false
22564 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22565 a core-dump of a pipe command, enable this command.  This enables core-dumps
22566 during delivery and affects both the Exim binary and the pipe command run.
22567 It is recommended that this option remain off unless and until you have a need
22568 for it and that this only be enabled when needed, as the risk of excessive
22569 resource consumption can be quite high.  Note also that Exim is typically
22570 installed as a setuid binary and most operating systems will inhibit coredumps
22571 of these by default, so further OS-specific action may be required.
22572
22573
22574 .option pipe_as_creator pipe boolean false
22575 .cindex "uid (user id)" "local delivery"
22576 If the generic &%user%& option is not set and this option is true, the delivery
22577 process is run under the uid that was in force when Exim was originally called
22578 to accept the message. If the group id is not otherwise set (via the generic
22579 &%group%& option), the gid that was in force when Exim was originally called to
22580 accept the message is used.
22581
22582
22583 .option restrict_to_path pipe boolean false
22584 When this option is set, any command name not listed in &%allow_commands%& must
22585 contain no slashes. The command is searched for only in the directories listed
22586 in the &%path%& option. This option is intended for use in the case when a pipe
22587 command has been generated from a user's &_.forward_& file. This is usually
22588 handled by a &(pipe)& transport called &%address_pipe%&.
22589
22590
22591 .option return_fail_output pipe boolean false
22592 If this option is true, and the command produced any output and ended with a
22593 return code other than zero or one of the codes listed in &%temp_errors%& (that
22594 is, the delivery failed), the output is returned in the bounce message.
22595 However, if the message has a null sender (that is, it is itself a bounce
22596 message), output from the command is discarded. This option and
22597 &%return_output%& are mutually exclusive. Only one of them may be set.
22598
22599
22600
22601 .option return_output pipe boolean false
22602 If this option is true, and the command produced any output, the delivery is
22603 deemed to have failed whatever the return code from the command, and the output
22604 is returned in the bounce message. Otherwise, the output is just discarded.
22605 However, if the message has a null sender (that is, it is a bounce message),
22606 output from the command is always discarded, whatever the setting of this
22607 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22608 of them may be set.
22609
22610
22611
22612 .option temp_errors pipe "string list" "see below"
22613 .cindex "&(pipe)& transport" "temporary failure"
22614 This option contains either a colon-separated list of numbers, or a single
22615 asterisk. If &%ignore_status%& is false
22616 and &%return_output%& is not set,
22617 and the command exits with a non-zero return code, the failure is treated as
22618 temporary and the delivery is deferred if the return code matches one of the
22619 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22620 codes are treated as permanent errors. The default setting contains the codes
22621 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22622 compiled on a system that does not define these macros, it assumes values of 75
22623 and 73, respectively.
22624
22625
22626 .option timeout pipe time 1h
22627 If the command fails to complete within this time, it is killed. This normally
22628 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22629 specifies no timeout. In order to ensure that any subprocesses created by the
22630 command are also killed, Exim makes the initial process a process group leader,
22631 and kills the whole process group on a timeout. However, this can be defeated
22632 if one of the processes starts a new process group.
22633
22634 .option timeout_defer pipe boolean false
22635 A timeout in a &(pipe)& transport, either in the command that the transport
22636 runs, or in a transport filter that is associated with it, is by default
22637 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22638 is set true, both kinds of timeout become temporary errors, causing the
22639 delivery to be deferred.
22640
22641 .option umask pipe "octal integer" 022
22642 This specifies the umask setting for the subprocess that runs the command.
22643
22644
22645 .option use_bsmtp pipe boolean false
22646 .cindex "envelope sender"
22647 If this option is set true, the &(pipe)& transport writes messages in &"batch
22648 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22649 commands. If you want to include a leading HELO command with such messages,
22650 you can do so by setting the &%message_prefix%& option. See section
22651 &<<SECTbatchSMTP>>& for details of batch SMTP.
22652
22653 .option use_classresources pipe boolean false
22654 .cindex "class resources (BSD)"
22655 This option is available only when Exim is running on FreeBSD, NetBSD, or
22656 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22657 resource limits when a &(pipe)& transport is run to perform a delivery. The
22658 limits for the uid under which the pipe is to run are obtained from the login
22659 class database.
22660
22661
22662 .option use_crlf pipe boolean false
22663 .cindex "carriage return"
22664 .cindex "linefeed"
22665 This option causes lines to be terminated with the two-character CRLF sequence
22666 (carriage return, linefeed) instead of just a linefeed character. In the case
22667 of batched SMTP, the byte sequence written to the pipe is then an exact image
22668 of what would be sent down a real SMTP connection.
22669
22670 The contents of the &%message_prefix%& and &%message_suffix%& options are
22671 written verbatim, so must contain their own carriage return characters if these
22672 are needed. When &%use_bsmtp%& is not set, the default values for both
22673 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22674 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22675
22676
22677 .option use_shell pipe boolean false
22678 .vindex "&$pipe_addresses$&"
22679 If this option is set, it causes the command to be passed to &_/bin/sh_&
22680 instead of being run directly from the transport, as described in section
22681 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22682 where the command is expected to be run under a shell and cannot easily be
22683 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22684 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22685 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22686 its &%-c%& option.
22687
22688
22689
22690 .section "Using an external local delivery agent" "SECID143"
22691 .cindex "local delivery" "using an external agent"
22692 .cindex "&'procmail'&"
22693 .cindex "external local delivery"
22694 .cindex "delivery" "&'procmail'&"
22695 .cindex "delivery" "by external agent"
22696 The &(pipe)& transport can be used to pass all messages that require local
22697 delivery to a separate local delivery agent such as &%procmail%&. When doing
22698 this, care must be taken to ensure that the pipe is run under an appropriate
22699 uid and gid. In some configurations one wants this to be a uid that is trusted
22700 by the delivery agent to supply the correct sender of the message. It may be
22701 necessary to recompile or reconfigure the delivery agent so that it trusts an
22702 appropriate user. The following is an example transport and router
22703 configuration for &%procmail%&:
22704 .code
22705 # transport
22706 procmail_pipe:
22707   driver = pipe
22708   command = /usr/local/bin/procmail -d $local_part
22709   return_path_add
22710   delivery_date_add
22711   envelope_to_add
22712   check_string = "From "
22713   escape_string = ">From "
22714   umask = 077
22715   user = $local_part
22716   group = mail
22717
22718 # router
22719 procmail:
22720   driver = accept
22721   check_local_user
22722   transport = procmail_pipe
22723 .endd
22724 In this example, the pipe is run as the local user, but with the group set to
22725 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22726 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22727 user to supply a correct sender address. If you do not specify either a
22728 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22729 home directory is the user's home directory by default.
22730
22731 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22732 .code
22733 IFS=" "
22734 .endd
22735 as shown in some &%procmail%& documentation, because Exim does not by default
22736 use a shell to run pipe commands.
22737
22738 .cindex "Cyrus"
22739 The next example shows a transport and a router for a system where local
22740 deliveries are handled by the Cyrus IMAP server.
22741 .code
22742 # transport
22743 local_delivery_cyrus:
22744   driver = pipe
22745   command = /usr/cyrus/bin/deliver \
22746             -m ${substr_1:$local_part_suffix} -- $local_part
22747   user = cyrus
22748   group = mail
22749   return_output
22750   log_output
22751   message_prefix =
22752   message_suffix =
22753
22754 # router
22755 local_user_cyrus:
22756   driver = accept
22757   check_local_user
22758   local_part_suffix = .*
22759   transport = local_delivery_cyrus
22760 .endd
22761 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22762 &%return_output%& to cause any text written by Cyrus to be returned to the
22763 sender.
22764 .ecindex IIDpiptra1
22765 .ecindex IIDpiptra2
22766
22767
22768 . ////////////////////////////////////////////////////////////////////////////
22769 . ////////////////////////////////////////////////////////////////////////////
22770
22771 .chapter "The smtp transport" "CHAPsmtptrans"
22772 .scindex IIDsmttra1 "transports" "&(smtp)&"
22773 .scindex IIDsmttra2 "&(smtp)& transport"
22774 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22775 or LMTP protocol. The list of hosts to try can either be taken from the address
22776 that is being processed (having been set up by the router), or specified
22777 explicitly for the transport. Timeout and retry processing (see chapter
22778 &<<CHAPretry>>&) is applied to each IP address independently.
22779
22780
22781 .section "Multiple messages on a single connection" "SECID144"
22782 The sending of multiple messages over a single TCP/IP connection can arise in
22783 two ways:
22784
22785 .ilist
22786 If a message contains more than &%max_rcpt%& (see below) addresses that are
22787 routed to the same host, more than one copy of the message has to be sent to
22788 that host. In this situation, multiple copies may be sent in a single run of
22789 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22790 does when it has too many addresses to send in one message also depends on the
22791 value of the global &%remote_max_parallel%& option. Details are given in
22792 section &<<SECToutSMTPTCP>>&.)
22793 .next
22794 .cindex "hints database" "remembering routing"
22795 When a message has been successfully delivered over a TCP/IP connection, Exim
22796 looks in its hints database to see if there are any other messages awaiting a
22797 connection to the same host. If there are, a new delivery process is started
22798 for one of them, and the current TCP/IP connection is passed on to it. The new
22799 process may in turn send multiple copies and possibly create yet another
22800 process.
22801 .endlist
22802
22803
22804 For each copy sent over the same TCP/IP connection, a sequence counter is
22805 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22806 no further messages are sent over that connection.
22807
22808
22809
22810 .section "Use of the $host and $host_address variables" "SECID145"
22811 .vindex "&$host$&"
22812 .vindex "&$host_address$&"
22813 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22814 &$host_address$& are the name and IP address of the first host on the host list
22815 passed by the router. However, when the transport is about to connect to a
22816 specific host, and while it is connected to that host, &$host$& and
22817 &$host_address$& are set to the values for that host. These are the values
22818 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22819 &%serialize_hosts%&, and the various TLS options are expanded.
22820
22821
22822 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22823 .vindex &$tls_bits$&
22824 .vindex &$tls_cipher$&
22825 .vindex &$tls_peerdn$&
22826 .vindex &$tls_sni$&
22827 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22828 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22829 are the values that were set when the message was received.
22830 These are the values that are used for options that are expanded before any
22831 SMTP connections are made. Just before each connection is made, these four
22832 variables are emptied. If TLS is subsequently started, they are set to the
22833 appropriate values for the outgoing connection, and these are the values that
22834 are in force when any authenticators are run and when the
22835 &%authenticated_sender%& option is expanded.
22836
22837 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22838 and will be removed in a future release.
22839
22840
22841 .section "Private options for smtp" "SECID146"
22842 .cindex "options" "&(smtp)& transport"
22843 The private options of the &(smtp)& transport are as follows:
22844
22845
22846 .option address_retry_include_sender smtp boolean true
22847 .cindex "4&'xx'& responses" "retrying after"
22848 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22849 is the combination of sender and recipient that is delayed in subsequent queue
22850 runs until the retry time is reached. You can delay the recipient without
22851 reference to the sender (which is what earlier versions of Exim did), by
22852 setting &%address_retry_include_sender%& false. However, this can lead to
22853 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22854
22855 .option allow_localhost smtp boolean false
22856 .cindex "local host" "sending to"
22857 .cindex "fallback" "hosts specified on transport"
22858 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22859 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22860 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22861 the delivery anyway. This should be used only in special cases when the
22862 configuration ensures that no looping will result (for example, a differently
22863 configured Exim is listening on the port to which the message is sent).
22864
22865
22866 .option authenticated_sender smtp string&!! unset
22867 .cindex "Cyrus"
22868 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22869 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22870 overriding any existing authenticated sender value. If the string expansion is
22871 forced to fail, the option is ignored. Other expansion failures cause delivery
22872 to be deferred. If the result of expansion is an empty string, that is also
22873 ignored.
22874
22875 The expansion happens after the outgoing connection has been made and TLS
22876 started, if required. This means that the &$host$&, &$host_address$&,
22877 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22878 particular connection.
22879
22880 If the SMTP session is not authenticated, the expansion of
22881 &%authenticated_sender%& still happens (and can cause the delivery to be
22882 deferred if it fails), but no AUTH= item is added to MAIL commands
22883 unless &%authenticated_sender_force%& is true.
22884
22885 This option allows you to use the &(smtp)& transport in LMTP mode to
22886 deliver mail to Cyrus IMAP and provide the proper local part as the
22887 &"authenticated sender"&, via a setting such as:
22888 .code
22889 authenticated_sender = $local_part
22890 .endd
22891 This removes the need for IMAP subfolders to be assigned special ACLs to
22892 allow direct delivery to those subfolders.
22893
22894 Because of expected uses such as that just described for Cyrus (when no
22895 domain is involved), there is no checking on the syntax of the provided
22896 value.
22897
22898
22899 .option authenticated_sender_force smtp boolean false
22900 If this option is set true, the &%authenticated_sender%& option's value
22901 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22902 authenticated as a client.
22903
22904
22905 .option command_timeout smtp time 5m
22906 This sets a timeout for receiving a response to an SMTP command that has been
22907 sent out. It is also used when waiting for the initial banner line from the
22908 remote host. Its value must not be zero.
22909
22910
22911 .option connect_timeout smtp time 5m
22912 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22913 to a remote host. A setting of zero allows the system timeout (typically
22914 several minutes) to act. To have any effect, the value of this option must be
22915 less than the system timeout. However, it has been observed that on some
22916 systems there is no system timeout, which is why the default value for this
22917 option is 5 minutes, a value recommended by RFC 1123.
22918
22919
22920 .option connection_max_messages smtp integer 500
22921 .cindex "SMTP" "passed connection"
22922 .cindex "SMTP" "multiple deliveries"
22923 .cindex "multiple SMTP deliveries"
22924 This controls the maximum number of separate message deliveries that are sent
22925 over a single TCP/IP connection. If the value is zero, there is no limit.
22926 For testing purposes, this value can be overridden by the &%-oB%& command line
22927 option.
22928
22929
22930 .option data_timeout smtp time 5m
22931 This sets a timeout for the transmission of each block in the data portion of
22932 the message. As a result, the overall timeout for a message depends on the size
22933 of the message. Its value must not be zero. See also &%final_timeout%&.
22934
22935
22936 .option delay_after_cutoff smtp boolean true
22937 This option controls what happens when all remote IP addresses for a given
22938 domain have been inaccessible for so long that they have passed their retry
22939 cutoff times.
22940
22941 In the default state, if the next retry time has not been reached for any of
22942 them, the address is bounced without trying any deliveries. In other words,
22943 Exim delays retrying an IP address after the final cutoff time until a new
22944 retry time is reached, and can therefore bounce an address without ever trying
22945 a delivery, when machines have been down for a long time. Some people are
22946 unhappy at this prospect, so...
22947
22948 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22949 addresses are past their final cutoff time, Exim tries to deliver to those
22950 IP addresses that have not been tried since the message arrived. If there are
22951 none, of if they all fail, the address is bounced. In other words, it does not
22952 delay when a new message arrives, but immediately tries those expired IP
22953 addresses that haven't been tried since the message arrived. If there is a
22954 continuous stream of messages for the dead hosts, unsetting
22955 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22956 to them.
22957
22958
22959 .option dns_qualify_single smtp boolean true
22960 If the &%hosts%& or &%fallback_hosts%& option is being used,
22961 and the &%gethostbyname%& option is false,
22962 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22963 in chapter &<<CHAPdnslookup>>& for more details.
22964
22965
22966 .option dns_search_parents smtp boolean false
22967 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22968 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22969 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22970 details.
22971
22972
22973 .option dnssec_request_domains smtp "domain list&!!" unset
22974 .cindex "MX record" "security"
22975 .cindex "DNSSEC" "MX lookup"
22976 .cindex "security" "MX lookup"
22977 .cindex "DNS" "DNSSEC"
22978 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22979 the dnssec request bit set.
22980 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22981
22982
22983
22984 .option dnssec_require_domains smtp "domain list&!!" unset
22985 .cindex "MX record" "security"
22986 .cindex "DNSSEC" "MX lookup"
22987 .cindex "security" "MX lookup"
22988 .cindex "DNS" "DNSSEC"
22989 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22990 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22991 (AD bit) set wil be ignored and logged as a host-lookup failure.
22992 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22993
22994
22995
22996 .option dscp smtp string&!! unset
22997 .cindex "DCSP" "outbound"
22998 This option causes the DSCP value associated with a socket to be set to one
22999 of a number of fixed strings or to numeric value.
23000 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23001 Common values include &`throughput`&, &`mincost`&, and on newer systems
23002 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23003
23004 The outbound packets from Exim will be marked with this value in the header
23005 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23006 that these values will have any effect, not be stripped by networking
23007 equipment, or do much of anything without cooperation with your Network
23008 Engineer and those of all network operators between the source and destination.
23009
23010
23011 .option fallback_hosts smtp "string list" unset
23012 .cindex "fallback" "hosts specified on transport"
23013 String expansion is not applied to this option. The argument must be a
23014 colon-separated list of host names or IP addresses, optionally also including
23015 port numbers, though the separator can be changed, as described in section
23016 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23017 item in a &%route_list%& setting for the &(manualroute)& router, as described
23018 in section &<<SECTformatonehostitem>>&.
23019
23020 Fallback hosts can also be specified on routers, which associate them with the
23021 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23022 &%fallback_hosts%& specified on the transport is used only if the address does
23023 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23024 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23025 However, &%hosts_randomize%& does apply to fallback host lists.
23026
23027 If Exim is unable to deliver to any of the hosts for a particular address, and
23028 the errors are not permanent rejections, the address is put on a separate
23029 transport queue with its host list replaced by the fallback hosts, unless the
23030 address was routed via MX records and the current host was in the original MX
23031 list. In that situation, the fallback host list is not used.
23032
23033 Once normal deliveries are complete, the fallback queue is delivered by
23034 re-running the same transports with the new host lists. If several failing
23035 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23036 copy of the message is sent.
23037
23038 The resolution of the host names on the fallback list is controlled by the
23039 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23040 both to cases when the host list comes with the address and when it is taken
23041 from &%hosts%&. This option provides a &"use a smart host only if delivery
23042 fails"& facility.
23043
23044
23045 .option final_timeout smtp time 10m
23046 This is the timeout that applies while waiting for the response to the final
23047 line containing just &"."& that terminates a message. Its value must not be
23048 zero.
23049
23050 .option gethostbyname smtp boolean false
23051 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23052 being used, names are looked up using &[gethostbyname()]&
23053 (or &[getipnodebyname()]& when available)
23054 instead of using the DNS. Of course, that function may in fact use the DNS, but
23055 it may also consult other sources of information such as &_/etc/hosts_&.
23056
23057 .option gnutls_compat_mode smtp boolean unset
23058 This option controls whether GnuTLS is used in compatibility mode in an Exim
23059 server. This reduces security slightly, but improves interworking with older
23060 implementations of TLS.
23061
23062 .option helo_data smtp string&!! "see below"
23063 .cindex "HELO" "argument, setting"
23064 .cindex "EHLO" "argument, setting"
23065 .cindex "LHLO argument setting"
23066 The value of this option is expanded after a connection to a another host has
23067 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23068 command that starts the outgoing SMTP or LMTP session. The default value of the
23069 option is:
23070 .code
23071 $primary_hostname
23072 .endd
23073 During the expansion, the variables &$host$& and &$host_address$& are set to
23074 the identity of the remote host, and the variables &$sending_ip_address$& and
23075 &$sending_port$& are set to the local IP address and port number that are being
23076 used. These variables can be used to generate different values for different
23077 servers or different local IP addresses. For example, if you want the string
23078 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23079 interface address, you could use this:
23080 .code
23081 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23082   {$primary_hostname}}
23083 .endd
23084 The use of &%helo_data%& applies both to sending messages and when doing
23085 callouts.
23086
23087 .option hosts smtp "string list&!!" unset
23088 Hosts are associated with an address by a router such as &(dnslookup)&, which
23089 finds the hosts by looking up the address domain in the DNS, or by
23090 &(manualroute)&, which has lists of hosts in its configuration. However,
23091 email addresses can be passed to the &(smtp)& transport by any router, and not
23092 all of them can provide an associated list of hosts.
23093
23094 The &%hosts%& option specifies a list of hosts to be used if the address being
23095 processed does not have any hosts associated with it. The hosts specified by
23096 &%hosts%& are also used, whether or not the address has its own hosts, if
23097 &%hosts_override%& is set.
23098
23099 The string is first expanded, before being interpreted as a colon-separated
23100 list of host names or IP addresses, possibly including port numbers. The
23101 separator may be changed to something other than colon, as described in section
23102 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23103 item in a &%route_list%& setting for the &(manualroute)& router, as described
23104 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23105 of the &(manualroute)& router is not available here.
23106
23107 If the expansion fails, delivery is deferred. Unless the failure was caused by
23108 the inability to complete a lookup, the error is logged to the panic log as
23109 well as the main log. Host names are looked up either by searching directly for
23110 address records in the DNS or by calling &[gethostbyname()]& (or
23111 &[getipnodebyname()]& when available), depending on the setting of the
23112 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23113 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23114 address are used.
23115
23116 During delivery, the hosts are tried in order, subject to their retry status,
23117 unless &%hosts_randomize%& is set.
23118
23119
23120 .option hosts_avoid_esmtp smtp "host list&!!" unset
23121 .cindex "ESMTP, avoiding use of"
23122 .cindex "HELO" "forcing use of"
23123 .cindex "EHLO" "avoiding use of"
23124 .cindex "PIPELINING" "avoiding the use of"
23125 This option is for use with broken hosts that announce ESMTP facilities (for
23126 example, PIPELINING) and then fail to implement them properly. When a host
23127 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23128 start of the SMTP session. This means that it cannot use any of the ESMTP
23129 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23130
23131
23132 .option hosts_avoid_pipelining smtp "host list&!!" unset
23133 .cindex "PIPELINING" "avoiding the use of"
23134 Exim will not use the SMTP PIPELINING extension when delivering to any host
23135 that matches this list, even if the server host advertises PIPELINING support.
23136
23137
23138 .option hosts_avoid_tls smtp "host list&!!" unset
23139 .cindex "TLS" "avoiding for certain hosts"
23140 Exim will not try to start a TLS session when delivering to any host that
23141 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23142
23143 .option hosts_verify_avoid_tls smtp "host list&!!" *
23144 .cindex "TLS" "avoiding for certain hosts"
23145 Exim will not try to start a TLS session for a verify callout,
23146 or when delivering in cutthrough mode,
23147 to any host that matches this list.
23148 Note that the default is to not use TLS.
23149
23150
23151 .option hosts_max_try smtp integer 5
23152 .cindex "host" "maximum number to try"
23153 .cindex "limit" "number of hosts tried"
23154 .cindex "limit" "number of MX tried"
23155 .cindex "MX record" "maximum tried"
23156 This option limits the number of IP addresses that are tried for any one
23157 delivery in cases where there are temporary delivery errors. Section
23158 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23159
23160
23161 .option hosts_max_try_hardlimit smtp integer 50
23162 This is an additional check on the maximum number of IP addresses that Exim
23163 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23164 why it exists.
23165
23166
23167
23168 .option hosts_nopass_tls smtp "host list&!!" unset
23169 .cindex "TLS" "passing connection"
23170 .cindex "multiple SMTP deliveries"
23171 .cindex "TLS" "multiple message deliveries"
23172 For any host that matches this list, a connection on which a TLS session has
23173 been started will not be passed to a new delivery process for sending another
23174 message on the same connection. See section &<<SECTmulmessam>>& for an
23175 explanation of when this might be needed.
23176
23177
23178 .option hosts_override smtp boolean false
23179 If this option is set and the &%hosts%& option is also set, any hosts that are
23180 attached to the address are ignored, and instead the hosts specified by the
23181 &%hosts%& option are always used. This option does not apply to
23182 &%fallback_hosts%&.
23183
23184
23185 .option hosts_randomize smtp boolean false
23186 .cindex "randomized host list"
23187 .cindex "host" "list of; randomized"
23188 .cindex "fallback" "randomized hosts"
23189 If this option is set, and either the list of hosts is taken from the
23190 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23191 were not obtained from MX records (this includes fallback hosts from the
23192 router), and were not randomized by the router, the order of trying the hosts
23193 is randomized each time the transport runs. Randomizing the order of a host
23194 list can be used to do crude load sharing.
23195
23196 When &%hosts_randomize%& is true, a host list may be split into groups whose
23197 order is separately randomized. This makes it possible to set up MX-like
23198 behaviour. The boundaries between groups are indicated by an item that is just
23199 &`+`& in the host list. For example:
23200 .code
23201 hosts = host1:host2:host3:+:host4:host5
23202 .endd
23203 The order of the first three hosts and the order of the last two hosts is
23204 randomized for each use, but the first three always end up before the last two.
23205 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23206
23207 .option hosts_require_auth smtp "host list&!!" unset
23208 .cindex "authentication" "required by client"
23209 This option provides a list of servers for which authentication must succeed
23210 before Exim will try to transfer a message. If authentication fails for
23211 servers which are not in this list, Exim tries to send unauthenticated. If
23212 authentication fails for one of these servers, delivery is deferred. This
23213 temporary error is detectable in the retry rules, so it can be turned into a
23214 hard failure if required. See also &%hosts_try_auth%&, and chapter
23215 &<<CHAPSMTPAUTH>>& for details of authentication.
23216
23217
23218 .option hosts_request_ocsp smtp "host list&!!" *
23219 .cindex "TLS" "requiring for certain servers"
23220 Exim will request a Certificate Status on a
23221 TLS session for any host that matches this list.
23222 &%tls_verify_certificates%& should also be set for the transport.
23223
23224 .option hosts_require_ocsp smtp "host list&!!" unset
23225 .cindex "TLS" "requiring for certain servers"
23226 Exim will request, and check for a valid Certificate Status being given, on a
23227 TLS session for any host that matches this list.
23228 &%tls_verify_certificates%& should also be set for the transport.
23229
23230 .option hosts_require_tls smtp "host list&!!" unset
23231 .cindex "TLS" "requiring for certain servers"
23232 Exim will insist on using a TLS session when delivering to any host that
23233 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23234 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23235 incoming messages, use an appropriate ACL.
23236
23237 .option hosts_try_auth smtp "host list&!!" unset
23238 .cindex "authentication" "optional in client"
23239 This option provides a list of servers to which, provided they announce
23240 authentication support, Exim will attempt to authenticate as a client when it
23241 connects. If authentication fails, Exim will try to transfer the message
23242 unauthenticated. See also &%hosts_require_auth%&, and chapter
23243 &<<CHAPSMTPAUTH>>& for details of authentication.
23244
23245 .new
23246 .option hosts_try_prdr smtp "host list&!!" *
23247 .cindex "PRDR" "enabling, optional in client"
23248 This option provides a list of servers to which, provided they announce
23249 PRDR support, Exim will attempt to negotiate PRDR
23250 for multi-recipient messages.
23251 The option can usually be left as default.
23252 .wen
23253
23254 .option interface smtp "string list&!!" unset
23255 .cindex "bind IP address"
23256 .cindex "IP address" "binding"
23257 .vindex "&$host$&"
23258 .vindex "&$host_address$&"
23259 This option specifies which interface to bind to when making an outgoing SMTP
23260 call. The value is an IP address, not an interface name such as
23261 &`eth0`&. Do not confuse this with the interface address that was used when a
23262 message was received, which is in &$received_ip_address$&, formerly known as
23263 &$interface_address$&. The name was changed to minimize confusion with the
23264 outgoing interface address. There is no variable that contains an outgoing
23265 interface address because, unless it is set by this option, its value is
23266 unknown.
23267
23268 During the expansion of the &%interface%& option the variables &$host$& and
23269 &$host_address$& refer to the host to which a connection is about to be made
23270 during the expansion of the string. Forced expansion failure, or an empty
23271 string result causes the option to be ignored. Otherwise, after expansion, the
23272 string must be a list of IP addresses, colon-separated by default, but the
23273 separator can be changed in the usual way. For example:
23274 .code
23275 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23276 .endd
23277 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23278 connection. If none of them are the correct type, the option is ignored. If
23279 &%interface%& is not set, or is ignored, the system's IP functions choose which
23280 interface to use if the host has more than one.
23281
23282
23283 .option keepalive smtp boolean true
23284 .cindex "keepalive" "on outgoing connection"
23285 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23286 connections. When set, it causes the kernel to probe idle connections
23287 periodically, by sending packets with &"old"& sequence numbers. The other end
23288 of the connection should send a acknowledgment if the connection is still okay
23289 or a reset if the connection has been aborted. The reason for doing this is
23290 that it has the beneficial effect of freeing up certain types of connection
23291 that can get stuck when the remote host is disconnected without tidying up the
23292 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23293 unreachable hosts.
23294
23295
23296 .option lmtp_ignore_quota smtp boolean false
23297 .cindex "LMTP" "ignoring quota errors"
23298 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23299 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23300 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23301
23302 .option max_rcpt smtp integer 100
23303 .cindex "RCPT" "maximum number of outgoing"
23304 This option limits the number of RCPT commands that are sent in a single
23305 SMTP message transaction. Each set of addresses is treated independently, and
23306 so can cause parallel connections to the same host if &%remote_max_parallel%&
23307 permits this.
23308
23309
23310 .option multi_domain smtp boolean&!! true
23311 .vindex "&$domain$&"
23312 When this option is set, the &(smtp)& transport can handle a number of
23313 addresses containing a mixture of different domains provided they all resolve
23314 to the same list of hosts. Turning the option off restricts the transport to
23315 handling only one domain at a time. This is useful if you want to use
23316 &$domain$& in an expansion for the transport, because it is set only when there
23317 is a single domain involved in a remote delivery.
23318
23319 .new
23320 It is expanded per-address and can depend on any of
23321 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23322 &$host$&, &$host_address$& and &$host_port$&.
23323 .wen
23324
23325 .option port smtp string&!! "see below"
23326 .cindex "port" "sending TCP/IP"
23327 .cindex "TCP/IP" "setting outgoing port"
23328 This option specifies the TCP/IP port on the server to which Exim connects.
23329 &*Note:*& Do not confuse this with the port that was used when a message was
23330 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23331 The name was changed to minimize confusion with the outgoing port. There is no
23332 variable that contains an outgoing port.
23333
23334 If the value of this option begins with a digit it is taken as a port number;
23335 otherwise it is looked up using &[getservbyname()]&. The default value is
23336 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23337 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23338 is deferred.
23339
23340
23341
23342 .option protocol smtp string smtp
23343 .cindex "LMTP" "over TCP/IP"
23344 .cindex "ssmtp protocol" "outbound"
23345 .cindex "TLS" "SSL-on-connect outbound"
23346 .vindex "&$port$&"
23347 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23348 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23349 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23350 deliveries into closed message stores. Exim also has support for running LMTP
23351 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23352
23353 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23354 changes to &"smtps"&, and the transport initiates TLS immediately after
23355 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23356 The Internet standards bodies strongly discourage use of this mode.
23357
23358
23359 .option retry_include_ip_address smtp boolean&!! true
23360 Exim normally includes both the host name and the IP address in the key it
23361 constructs for indexing retry data after a temporary delivery failure. This
23362 means that when one of several IP addresses for a host is failing, it gets
23363 tried periodically (controlled by the retry rules), but use of the other IP
23364 addresses is not affected.
23365
23366 However, in some dialup environments hosts are assigned a different IP address
23367 each time they connect. In this situation the use of the IP address as part of
23368 the retry key leads to undesirable behaviour. Setting this option false causes
23369 Exim to use only the host name.
23370 .new
23371 Since it is expanded it can be made to depend on the host or domain.
23372 .wen
23373
23374
23375 .option serialize_hosts smtp "host list&!!" unset
23376 .cindex "serializing connections"
23377 .cindex "host" "serializing connections"
23378 Because Exim operates in a distributed manner, if several messages for the same
23379 host arrive at around the same time, more than one simultaneous connection to
23380 the remote host can occur. This is not usually a problem except when there is a
23381 slow link between the hosts. In that situation it may be helpful to restrict
23382 Exim to one connection at a time. This can be done by setting
23383 &%serialize_hosts%& to match the relevant hosts.
23384
23385 .cindex "hints database" "serializing deliveries to a host"
23386 Exim implements serialization by means of a hints database in which a record is
23387 written whenever a process connects to one of the restricted hosts. The record
23388 is deleted when the connection is completed. Obviously there is scope for
23389 records to get left lying around if there is a system or program crash. To
23390 guard against this, Exim ignores any records that are more than six hours old.
23391
23392 If you set up this kind of serialization, you should also arrange to delete the
23393 relevant hints database whenever your system reboots. The names of the files
23394 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23395 may be one or two files, depending on the type of DBM in use. The same files
23396 are used for ETRN serialization.
23397
23398
23399 .option size_addition smtp integer 1024
23400 .cindex "SMTP" "SIZE"
23401 .cindex "message" "size issue for transport filter"
23402 .cindex "size" "of message"
23403 .cindex "transport" "filter"
23404 .cindex "filter" "transport filter"
23405 If a remote SMTP server indicates that it supports the SIZE option of the
23406 MAIL command, Exim uses this to pass over the message size at the start of
23407 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23408 sends, to allow for headers and other text that may be added during delivery by
23409 configuration options or in a transport filter. It may be necessary to increase
23410 this if a lot of text is added to messages.
23411
23412 Alternatively, if the value of &%size_addition%& is set negative, it disables
23413 the use of the SIZE option altogether.
23414
23415
23416 .option tls_certificate smtp string&!! unset
23417 .cindex "TLS" "client certificate, location of"
23418 .cindex "certificate" "client, location of"
23419 .vindex "&$host$&"
23420 .vindex "&$host_address$&"
23421 The value of this option must be the absolute path to a file which contains the
23422 client's certificate, for possible use when sending a message over an encrypted
23423 connection. The values of &$host$& and &$host_address$& are set to the name and
23424 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23425 details of TLS.
23426
23427 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23428 certificate when sending messages as a client. The global option of the same
23429 name specifies the certificate for Exim as a server; it is not automatically
23430 assumed that the same certificate should be used when Exim is operating as a
23431 client.
23432
23433
23434 .option tls_crl smtp string&!! unset
23435 .cindex "TLS" "client certificate revocation list"
23436 .cindex "certificate" "revocation list for client"
23437 This option specifies a certificate revocation list. The expanded value must
23438 be the name of a file that contains a CRL in PEM format.
23439
23440
23441 .option tls_dh_min_bits smtp integer 1024
23442 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23443 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23444 key agreement is negotiated, the server will provide a large prime number
23445 for use.  This option establishes the minimum acceptable size of that number.
23446 If the parameter offered by the server is too small, then the TLS handshake
23447 will fail.
23448
23449 Only supported when using GnuTLS.
23450
23451
23452 .option tls_privatekey smtp string&!! unset
23453 .cindex "TLS" "client private key, location of"
23454 .vindex "&$host$&"
23455 .vindex "&$host_address$&"
23456 The value of this option must be the absolute path to a file which contains the
23457 client's private key. This is used when sending a message over an encrypted
23458 connection using a client certificate. The values of &$host$& and
23459 &$host_address$& are set to the name and address of the server during the
23460 expansion. If this option is unset, or the expansion is forced to fail, or the
23461 result is an empty string, the private key is assumed to be in the same file as
23462 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23463
23464
23465 .option tls_require_ciphers smtp string&!! unset
23466 .cindex "TLS" "requiring specific ciphers"
23467 .cindex "cipher" "requiring specific"
23468 .vindex "&$host$&"
23469 .vindex "&$host_address$&"
23470 The value of this option must be a list of permitted cipher suites, for use
23471 when setting up an outgoing encrypted connection. (There is a global option of
23472 the same name for controlling incoming connections.) The values of &$host$& and
23473 &$host_address$& are set to the name and address of the server during the
23474 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23475 is used in different ways by OpenSSL and GnuTLS (see sections
23476 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23477 ciphers is a preference order.
23478
23479
23480
23481 .option tls_sni smtp string&!! unset
23482 .cindex "TLS" "Server Name Indication"
23483 .vindex "&$tls_sni$&"
23484 If this option is set then it sets the $tls_out_sni variable and causes any
23485 TLS session to pass this value as the Server Name Indication extension to
23486 the remote side, which can be used by the remote side to select an appropriate
23487 certificate and private key for the session.
23488
23489 See &<<SECTtlssni>>& for more information.
23490
23491 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23492 TLS extensions.
23493
23494
23495
23496
23497 .option tls_tempfail_tryclear smtp boolean true
23498 .cindex "4&'xx'& responses" "to STARTTLS"
23499 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23500 setting up a TLS session, this option determines whether or not Exim should try
23501 to deliver the message unencrypted. If it is set false, delivery to the
23502 current host is deferred; if there are other hosts, they are tried. If this
23503 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23504 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23505 TLS negotiation fails, Exim closes the current connection (because it is in an
23506 unknown state), opens a new one to the same host, and then tries the delivery
23507 in clear.
23508
23509
23510 .new
23511 .option tls_try_verify_hosts smtp "host list&!!" *
23512 .wen
23513 .cindex "TLS" "server certificate verification"
23514 .cindex "certificate" "verification of server"
23515 This option gives a list of hosts for which, on encrypted connections,
23516 certificate verification will be tried but need not succeed.
23517 The &%tls_verify_certificates%& option must also be set.
23518 Note that unless the host is in this list
23519 TLS connections will be denied to hosts using self-signed certificates
23520 when &%tls_verify_certificates%& is matched.
23521 The &$tls_out_certificate_verified$& variable is set when
23522 certificate verification succeeds.
23523
23524
23525 .new
23526 .option tls_verify_cert_hostnames smtp "host list&!!" *
23527 .cindex "TLS" "server certificate hostname verification"
23528 .cindex "certificate" "verification of server"
23529 This option give a list of hosts for which,
23530 while verifying the server certificate,
23531 checks will be included on the host name
23532 (note that this will generally be the result of a DNS MX lookup)
23533 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23534 limited to being the initial component of a 3-or-more component FQDN.
23535
23536 There is no equivalent checking on client certificates.
23537 .wen
23538
23539
23540 .new
23541 .option tls_verify_certificates smtp string&!! system
23542 .cindex "TLS" "server certificate verification"
23543 .cindex "certificate" "verification of server"
23544 .vindex "&$host$&"
23545 .vindex "&$host_address$&"
23546 The value of this option must be either the
23547 word "system"
23548 or the absolute path to
23549 a file or directory containing permitted certificates for servers,
23550 for use when setting up an encrypted connection.
23551
23552 The "system" value for the option will use a location compiled into the SSL library.
23553 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23554 is taken as empty and an explicit location
23555 must be specified.
23556
23557 The use of a directory for the option value is not avilable for GnuTLS versions
23558 preceding 3.3.6 and a single file must be used.
23559 .wen
23560
23561 With OpenSSL the certificates specified
23562 explicitly
23563 either by file or directory
23564 are added to those given by the system default location.
23565
23566 The values of &$host$& and
23567 &$host_address$& are set to the name and address of the server during the
23568 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23569
23570 For back-compatability,
23571 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23572 (a single-colon empty list counts as being set)
23573 and certificate verification fails the TLS connection is closed.
23574
23575
23576 .option tls_verify_hosts smtp "host list&!!" unset
23577 .cindex "TLS" "server certificate verification"
23578 .cindex "certificate" "verification of server"
23579 This option gives a list of hosts for which. on encrypted connections,
23580 certificate verification must succeed.
23581 The &%tls_verify_certificates%& option must also be set.
23582 If both this option and &%tls_try_verify_hosts%& are unset
23583 operation is as if this option selected all hosts.
23584
23585
23586
23587
23588 .section "How the limits for the number of hosts to try are used" &&&
23589          "SECTvalhosmax"
23590 .cindex "host" "maximum number to try"
23591 .cindex "limit" "hosts; maximum number tried"
23592 There are two options that are concerned with the number of hosts that are
23593 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23594 &%hosts_max_try_hardlimit%&.
23595
23596
23597 The &%hosts_max_try%& option limits the number of hosts that are tried
23598 for a single delivery. However, despite the term &"host"& in its name, the
23599 option actually applies to each IP address independently. In other words, a
23600 multihomed host is treated as several independent hosts, just as it is for
23601 retrying.
23602
23603 Many of the larger ISPs have multiple MX records which often point to
23604 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23605 created as a result of routing one of these domains.
23606
23607 Trying every single IP address on such a long list does not seem sensible; if
23608 several at the top of the list fail, it is reasonable to assume there is some
23609 problem that is likely to affect all of them. Roughly speaking, the value of
23610 &%hosts_max_try%& is the maximum number that are tried before deferring the
23611 delivery. However, the logic cannot be quite that simple.
23612
23613 Firstly, IP addresses that are skipped because their retry times have not
23614 arrived do not count, and in addition, addresses that are past their retry
23615 limits are also not counted, even when they are tried. This means that when
23616 some IP addresses are past their retry limits, more than the value of
23617 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23618 that all IP addresses are considered before timing out an email address (but
23619 see below for an exception).
23620
23621 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23622 list to see if there is a subsequent host with a different (higher valued) MX.
23623 If there is, that host is considered next, and the current IP address is used
23624 but not counted. This behaviour helps in the case of a domain with a retry rule
23625 that hardly ever delays any hosts, as is now explained:
23626
23627 Consider the case of a long list of hosts with one MX value, and a few with a
23628 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23629 hosts at the top of the list are tried at first. With the default retry rule,
23630 which specifies increasing retry times, the higher MX hosts are eventually
23631 tried when those at the top of the list are skipped because they have not
23632 reached their retry times.
23633
23634 However, it is common practice to put a fixed short retry time on domains for
23635 large ISPs, on the grounds that their servers are rarely down for very long.
23636 Unfortunately, these are exactly the domains that tend to resolve to long lists
23637 of hosts. The short retry time means that the lowest MX hosts are tried every
23638 time. The attempts may be in a different order because of random sorting, but
23639 without the special MX check, the higher MX hosts would never be tried until
23640 all the lower MX hosts had timed out (which might be several days), because
23641 there are always some lower MX hosts that have reached their retry times. With
23642 the special check, Exim considers at least one IP address from each MX value at
23643 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23644 reached.
23645
23646 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23647 particular, Exim normally eventually tries all the IP addresses before timing
23648 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23649 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23650 been set up with hundreds of IP addresses for some domains. It can
23651 take a very long time indeed for an address to time out in these cases.
23652
23653 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23654 Exim never tries more than this number of IP addresses; if it hits this limit
23655 and they are all timed out, the email address is bounced, even though not all
23656 possible IP addresses have been tried.
23657 .ecindex IIDsmttra1
23658 .ecindex IIDsmttra2
23659
23660
23661
23662
23663
23664 . ////////////////////////////////////////////////////////////////////////////
23665 . ////////////////////////////////////////////////////////////////////////////
23666
23667 .chapter "Address rewriting" "CHAPrewrite"
23668 .scindex IIDaddrew "rewriting" "addresses"
23669 There are some circumstances in which Exim automatically rewrites domains in
23670 addresses. The two most common are when an address is given without a domain
23671 (referred to as an &"unqualified address"&) or when an address contains an
23672 abbreviated domain that is expanded by DNS lookup.
23673
23674 Unqualified envelope addresses are accepted only for locally submitted
23675 messages, or for messages that are received from hosts matching
23676 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23677 appropriate. Unqualified addresses in header lines are qualified if they are in
23678 locally submitted messages, or messages from hosts that are permitted to send
23679 unqualified envelope addresses. Otherwise, unqualified addresses in header
23680 lines are neither qualified nor rewritten.
23681
23682 One situation in which Exim does &'not'& automatically rewrite a domain is
23683 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23684 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23685 do this. The new RFCs do not contain this suggestion.
23686
23687
23688 .section "Explicitly configured address rewriting" "SECID147"
23689 This chapter describes the rewriting rules that can be used in the
23690 main rewrite section of the configuration file, and also in the generic
23691 &%headers_rewrite%& option that can be set on any transport.
23692
23693 Some people believe that configured address rewriting is a Mortal Sin.
23694 Others believe that life is not possible without it. Exim provides the
23695 facility; you do not have to use it.
23696
23697 The main rewriting rules that appear in the &"rewrite"& section of the
23698 configuration file are applied to addresses in incoming messages, both envelope
23699 addresses and addresses in header lines. Each rule specifies the types of
23700 address to which it applies.
23701
23702 Whether or not addresses in header lines are rewritten depends on the origin of
23703 the headers and the type of rewriting. Global rewriting, that is, rewriting
23704 rules from the rewrite section of the configuration file, is applied only to
23705 those headers that were received with the message. Header lines that are added
23706 by ACLs or by a system filter or by individual routers or transports (which
23707 are specific to individual recipient addresses) are not rewritten by the global
23708 rules.
23709
23710 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23711 applies all headers except those added by routers and transports. That is, as
23712 well as the headers that were received with the message, it also applies to
23713 headers that were added by an ACL or a system filter.
23714
23715
23716 In general, rewriting addresses from your own system or domain has some
23717 legitimacy. Rewriting other addresses should be done only with great care and
23718 in special circumstances. The author of Exim believes that rewriting should be
23719 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23720 Although it can sometimes be used as a routing tool, this is very strongly
23721 discouraged.
23722
23723 There are two commonly encountered circumstances where rewriting is used, as
23724 illustrated by these examples:
23725
23726 .ilist
23727 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23728 exchange mail with each other behind a firewall, but there is only a single
23729 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23730 &'hitch.fict.example'& when sending mail off-site.
23731 .next
23732 A host rewrites the local parts of its own users so that, for example,
23733 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23734 .endlist
23735
23736
23737
23738 .section "When does rewriting happen?" "SECID148"
23739 .cindex "rewriting" "timing of"
23740 .cindex "&ACL;" "rewriting addresses in"
23741 Configured address rewriting can take place at several different stages of a
23742 message's processing.
23743
23744 .vindex "&$sender_address$&"
23745 At the start of an ACL for MAIL, the sender address may have been rewritten
23746 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23747 ordinary rewrite rules have yet been applied. If, however, the sender address
23748 is verified in the ACL, it is rewritten before verification, and remains
23749 rewritten thereafter. The subsequent value of &$sender_address$& is the
23750 rewritten address. This also applies if sender verification happens in a
23751 RCPT ACL. Otherwise, when the sender address is not verified, it is
23752 rewritten as soon as a message's header lines have been received.
23753
23754 .vindex "&$domain$&"
23755 .vindex "&$local_part$&"
23756 Similarly, at the start of an ACL for RCPT, the current recipient's address
23757 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23758 rewrite rules have yet been applied to it. However, the behaviour is different
23759 from the sender address when a recipient is verified. The address is rewritten
23760 for the verification, but the rewriting is not remembered at this stage. The
23761 value of &$local_part$& and &$domain$& after verification are always the same
23762 as they were before (that is, they contain the unrewritten &-- except for
23763 SMTP-time rewriting &-- address).
23764
23765 As soon as a message's header lines have been received, all the envelope
23766 recipient addresses are permanently rewritten, and rewriting is also applied to
23767 the addresses in the header lines (if configured). This happens before adding
23768 any header lines that were specified in MAIL or RCPT ACLs, and
23769 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23770 before the DATA ACL and &[local_scan()]& functions are run.
23771
23772 When an address is being routed, either for delivery or for verification,
23773 rewriting is applied immediately to child addresses that are generated by
23774 redirection, unless &%no_rewrite%& is set on the router.
23775
23776 .cindex "envelope sender" "rewriting at transport time"
23777 .cindex "rewriting" "at transport time"
23778 .cindex "header lines" "rewriting at transport time"
23779 At transport time, additional rewriting of addresses in header lines can be
23780 specified by setting the generic &%headers_rewrite%& option on a transport.
23781 This option contains rules that are identical in form to those in the rewrite
23782 section of the configuration file. They are applied to the original message
23783 header lines and any that were added by ACLs or a system filter. They are not
23784 applied to header lines that are added by routers or the transport.
23785
23786 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23787 transport option. However, it is not possible to rewrite envelope recipients at
23788 transport time.
23789
23790
23791
23792
23793 .section "Testing the rewriting rules that apply on input" "SECID149"
23794 .cindex "rewriting" "testing"
23795 .cindex "testing" "rewriting"
23796 Exim's input rewriting configuration appears in a part of the run time
23797 configuration file headed by &"begin rewrite"&. It can be tested by the
23798 &%-brw%& command line option. This takes an address (which can be a full RFC
23799 2822 address) as its argument. The output is a list of how the address would be
23800 transformed by the rewriting rules for each of the different places it might
23801 appear in an incoming message, that is, for each different header and for the
23802 envelope sender and recipient fields. For example,
23803 .code
23804 exim -brw ph10@exim.workshop.example
23805 .endd
23806 might produce the output
23807 .code
23808 sender: Philip.Hazel@exim.workshop.example
23809 from: Philip.Hazel@exim.workshop.example
23810 to: ph10@exim.workshop.example
23811 cc: ph10@exim.workshop.example
23812 bcc: ph10@exim.workshop.example
23813 reply-to: Philip.Hazel@exim.workshop.example
23814 env-from: Philip.Hazel@exim.workshop.example
23815 env-to: ph10@exim.workshop.example
23816 .endd
23817 which shows that rewriting has been set up for that address when used in any of
23818 the source fields, but not when it appears as a recipient address. At the
23819 present time, there is no equivalent way of testing rewriting rules that are
23820 set for a particular transport.
23821
23822
23823 .section "Rewriting rules" "SECID150"
23824 .cindex "rewriting" "rules"
23825 The rewrite section of the configuration file consists of lines of rewriting
23826 rules in the form
23827 .display
23828 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23829 .endd
23830 Rewriting rules that are specified for the &%headers_rewrite%& generic
23831 transport option are given as a colon-separated list. Each item in the list
23832 takes the same form as a line in the main rewriting configuration (except that
23833 any colons must be doubled, of course).
23834
23835 The formats of source patterns and replacement strings are described below.
23836 Each is terminated by white space, unless enclosed in double quotes, in which
23837 case normal quoting conventions apply inside the quotes. The flags are single
23838 characters which may appear in any order. Spaces and tabs between them are
23839 ignored.
23840
23841 For each address that could potentially be rewritten, the rules are scanned in
23842 order, and replacements for the address from earlier rules can themselves be
23843 replaced by later rules (but see the &"q"& and &"R"& flags).
23844
23845 The order in which addresses are rewritten is undefined, may change between
23846 releases, and must not be relied on, with one exception: when a message is
23847 received, the envelope sender is always rewritten first, before any header
23848 lines are rewritten. For example, the replacement string for a rewrite of an
23849 address in &'To:'& must not assume that the message's address in &'From:'& has
23850 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23851 that the envelope sender has already been rewritten.
23852
23853 .vindex "&$domain$&"
23854 .vindex "&$local_part$&"
23855 The variables &$local_part$& and &$domain$& can be used in the replacement
23856 string to refer to the address that is being rewritten. Note that lookup-driven
23857 rewriting can be done by a rule of the form
23858 .code
23859 *@*   ${lookup ...
23860 .endd
23861 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23862 refer to the address that is being rewritten.
23863
23864
23865 .section "Rewriting patterns" "SECID151"
23866 .cindex "rewriting" "patterns"
23867 .cindex "address list" "in a rewriting pattern"
23868 The source pattern in a rewriting rule is any item which may appear in an
23869 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23870 single-item address list, which means that it is expanded before being tested
23871 against the address. As always, if you use a regular expression as a pattern,
23872 you must take care to escape dollar and backslash characters, or use the &`\N`&
23873 facility to suppress string expansion within the regular expression.
23874
23875 Domains in patterns should be given in lower case. Local parts in patterns are
23876 case-sensitive. If you want to do case-insensitive matching of local parts, you
23877 can use a regular expression that starts with &`^(?i)`&.
23878
23879 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23880 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23881 depending on the type of match which occurred. These can be used in the
23882 replacement string to insert portions of the incoming address. &$0$& always
23883 refers to the complete incoming address. When a regular expression is used, the
23884 numerical variables are set from its capturing subexpressions. For other types
23885 of pattern they are set as follows:
23886
23887 .ilist
23888 If a local part or domain starts with an asterisk, the numerical variables
23889 refer to the character strings matched by asterisks, with &$1$& associated with
23890 the first asterisk, and &$2$& with the second, if present. For example, if the
23891 pattern
23892 .code
23893 *queen@*.fict.example
23894 .endd
23895 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23896 .code
23897 $0 = hearts-queen@wonderland.fict.example
23898 $1 = hearts-
23899 $2 = wonderland
23900 .endd
23901 Note that if the local part does not start with an asterisk, but the domain
23902 does, it is &$1$& that contains the wild part of the domain.
23903
23904 .next
23905 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23906 of the domain are placed in the next available numerical variables. Suppose,
23907 for example, that the address &'foo@bar.baz.example'& is processed by a
23908 rewriting rule of the form
23909 .display
23910 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23911 .endd
23912 and the key in the file that matches the domain is &`*.baz.example`&. Then
23913 .code
23914 $1 = foo
23915 $2 = bar
23916 $3 = baz.example
23917 .endd
23918 If the address &'foo@baz.example'& is looked up, this matches the same
23919 wildcard file entry, and in this case &$2$& is set to the empty string, but
23920 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23921 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23922 whole domain. For non-partial domain lookups, no numerical variables are set.
23923 .endlist
23924
23925
23926 .section "Rewriting replacements" "SECID152"
23927 .cindex "rewriting" "replacements"
23928 If the replacement string for a rule is a single asterisk, addresses that
23929 match the pattern and the flags are &'not'& rewritten, and no subsequent
23930 rewriting rules are scanned. For example,
23931 .code
23932 hatta@lookingglass.fict.example  *  f
23933 .endd
23934 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23935 &'From:'& headers.
23936
23937 .vindex "&$domain$&"
23938 .vindex "&$local_part$&"
23939 If the replacement string is not a single asterisk, it is expanded, and must
23940 yield a fully qualified address. Within the expansion, the variables
23941 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23942 Any letters they contain retain their original case &-- they are not lower
23943 cased. The numerical variables are set up according to the type of pattern that
23944 matched the address, as described above. If the expansion is forced to fail by
23945 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23946 current rule is abandoned, but subsequent rules may take effect. Any other
23947 expansion failure causes the entire rewriting operation to be abandoned, and an
23948 entry written to the panic log.
23949
23950
23951
23952 .section "Rewriting flags" "SECID153"
23953 There are three different kinds of flag that may appear on rewriting rules:
23954
23955 .ilist
23956 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23957 c, f, h, r, s, t.
23958 .next
23959 A flag that specifies rewriting at SMTP time: S.
23960 .next
23961 Flags that control the rewriting process: Q, q, R, w.
23962 .endlist
23963
23964 For rules that are part of the &%headers_rewrite%& generic transport option,
23965 E, F, T, and S are not permitted.
23966
23967
23968
23969 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23970          "SECID154"
23971 .cindex "rewriting" "flags"
23972 If none of the following flag letters, nor the &"S"& flag (see section
23973 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23974 and to both the sender and recipient fields of the envelope, whereas a
23975 transport-time rewriting rule just applies to all headers. Otherwise, the
23976 rewriting rule is skipped unless the relevant addresses are being processed.
23977 .display
23978 &`E`&       rewrite all envelope fields
23979 &`F`&       rewrite the envelope From field
23980 &`T`&       rewrite the envelope To field
23981 &`b`&       rewrite the &'Bcc:'& header
23982 &`c`&       rewrite the &'Cc:'& header
23983 &`f`&       rewrite the &'From:'& header
23984 &`h`&       rewrite all headers
23985 &`r`&       rewrite the &'Reply-To:'& header
23986 &`s`&       rewrite the &'Sender:'& header
23987 &`t`&       rewrite the &'To:'& header
23988 .endd
23989 "All headers" means all of the headers listed above that can be selected
23990 individually, plus their &'Resent-'& versions. It does not include
23991 other headers such as &'Subject:'& etc.
23992
23993 You should be particularly careful about rewriting &'Sender:'& headers, and
23994 restrict this to special known cases in your own domains.
23995
23996
23997 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23998 .cindex "SMTP" "rewriting malformed addresses"
23999 .cindex "RCPT" "rewriting argument of"
24000 .cindex "MAIL" "rewriting argument of"
24001 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24002 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24003 before any other processing; even before syntax checking. The pattern is
24004 required to be a regular expression, and it is matched against the whole of the
24005 data for the command, including any surrounding angle brackets.
24006
24007 .vindex "&$domain$&"
24008 .vindex "&$local_part$&"
24009 This form of rewrite rule allows for the handling of addresses that are not
24010 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24011 input). Because the input is not required to be a syntactically valid address,
24012 the variables &$local_part$& and &$domain$& are not available during the
24013 expansion of the replacement string. The result of rewriting replaces the
24014 original address in the MAIL or RCPT command.
24015
24016
24017 .section "Flags controlling the rewriting process" "SECID155"
24018 There are four flags which control the way the rewriting process works. These
24019 take effect only when a rule is invoked, that is, when the address is of the
24020 correct type (matches the flags) and matches the pattern:
24021
24022 .ilist
24023 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24024 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24025 absence of &"Q"& the rewritten address must always include a domain.
24026 .next
24027 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24028 even if no rewriting actually takes place because of a &"fail"& in the
24029 expansion. The &"q"& flag is not effective if the address is of the wrong type
24030 (does not match the flags) or does not match the pattern.
24031 .next
24032 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24033 address, up to ten times. It can be combined with the &"q"& flag, to stop
24034 rewriting once it fails to match (after at least one successful rewrite).
24035 .next
24036 .cindex "rewriting" "whole addresses"
24037 When an address in a header is rewritten, the rewriting normally applies only
24038 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24039 left unchanged. For example, rewriting might change
24040 .code
24041 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24042 .endd
24043 into
24044 .code
24045 From: Ford Prefect <prefectf@hitch.fict.example>
24046 .endd
24047 .cindex "RFC 2047"
24048 Sometimes there is a need to replace the whole address item, and this can be
24049 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24050 causes an address in a header line to be rewritten, the entire address is
24051 replaced, not just the working part. The replacement must be a complete RFC
24052 2822 address, including the angle brackets if necessary. If text outside angle
24053 brackets contains a character whose value is greater than 126 or less than 32
24054 (except for tab), the text is encoded according to RFC 2047. The character set
24055 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24056
24057 When the &"w"& flag is set on a rule that causes an envelope address to be
24058 rewritten, all but the working part of the replacement address is discarded.
24059 .endlist
24060
24061
24062 .section "Rewriting examples" "SECID156"
24063 Here is an example of the two common rewriting paradigms:
24064 .code
24065 *@*.hitch.fict.example  $1@hitch.fict.example
24066 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24067                      {$value}fail}@hitch.fict.example bctfrF
24068 .endd
24069 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24070 the string expansion to fail if the lookup does not succeed. In this context it
24071 has the effect of leaving the original address unchanged, but Exim goes on to
24072 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24073 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24074 explicitly, which would cause the rewritten address to be the same as before,
24075 at the cost of a small bit of processing. Not supplying either of these is an
24076 error, since the rewritten address would then contain no local part.
24077
24078 The first example above replaces the domain with a superior, more general
24079 domain. This may not be desirable for certain local parts. If the rule
24080 .code
24081 root@*.hitch.fict.example  *
24082 .endd
24083 were inserted before the first rule, rewriting would be suppressed for the
24084 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24085
24086 Rewriting can be made conditional on a number of tests, by making use of
24087 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24088 messages that originate outside the local host:
24089 .code
24090 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24091                          {$1@hitch.fict.example}fail}"
24092 .endd
24093 The replacement string is quoted in this example because it contains white
24094 space.
24095
24096 .cindex "rewriting" "bang paths"
24097 .cindex "bang paths" "rewriting"
24098 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24099 an address it treats it as an unqualified local part which it qualifies with
24100 the local qualification domain (if the source of the message is local or if the
24101 remote host is permitted to send unqualified addresses). Rewriting can
24102 sometimes be used to handle simple bang paths with a fixed number of
24103 components. For example, the rule
24104 .code
24105 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24106 .endd
24107 rewrites a two-component bang path &'host.name!user'& as the domain address
24108 &'user@host.name'&. However, there is a security implication in using this as
24109 a global rewriting rule for envelope addresses. It can provide a backdoor
24110 method for using your system as a relay, because the incoming addresses appear
24111 to be local. If the bang path addresses are received via SMTP, it is safer to
24112 use the &"S"& flag to rewrite them as they are received, so that relay checking
24113 can be done on the rewritten addresses.
24114 .ecindex IIDaddrew
24115
24116
24117
24118
24119
24120 . ////////////////////////////////////////////////////////////////////////////
24121 . ////////////////////////////////////////////////////////////////////////////
24122
24123 .chapter "Retry configuration" "CHAPretry"
24124 .scindex IIDretconf1 "retry" "configuration, description of"
24125 .scindex IIDregconf2 "configuration file" "retry section"
24126 The &"retry"& section of the runtime configuration file contains a list of
24127 retry rules that control how often Exim tries to deliver messages that cannot
24128 be delivered at the first attempt. If there are no retry rules (the section is
24129 empty or not present), there are no retries. In this situation, temporary
24130 errors are treated as permanent. The default configuration contains a single,
24131 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24132 line option can be used to test which retry rule will be used for a given
24133 address, domain and error.
24134
24135 The most common cause of retries is temporary failure to deliver to a remote
24136 host because the host is down, or inaccessible because of a network problem.
24137 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24138 address) basis, not on a per-message basis. Thus, if one message has recently
24139 been delayed, delivery of a new message to the same host is not immediately
24140 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24141 log selector is set, the message
24142 .cindex "retry" "time not reached"
24143 &"retry time not reached"& is written to the main log whenever a delivery is
24144 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24145 the handling of errors during remote deliveries.
24146
24147 Retry processing applies to routing as well as to delivering, except as covered
24148 in the next paragraph. The retry rules do not distinguish between these
24149 actions. It is not possible, for example, to specify different behaviour for
24150 failures to route the domain &'snark.fict.example'& and failures to deliver to
24151 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24152 added complication, so did not implement it. However, although they share the
24153 same retry rule, the actual retry times for routing and transporting a given
24154 domain are maintained independently.
24155
24156 When a delivery is not part of a queue run (typically an immediate delivery on
24157 receipt of a message), the routers are always run, and local deliveries are
24158 always attempted, even if retry times are set for them. This makes for better
24159 behaviour if one particular message is causing problems (for example, causing
24160 quota overflow, or provoking an error in a filter file). If such a delivery
24161 suffers a temporary failure, the retry data is updated as normal, and
24162 subsequent delivery attempts from queue runs occur only when the retry time for
24163 the local address is reached.
24164
24165 .section "Changing retry rules" "SECID157"
24166 If you change the retry rules in your configuration, you should consider
24167 whether or not to delete the retry data that is stored in Exim's spool area in
24168 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24169 always safe; that is why they are called &"hints"&.
24170
24171 The hints retry data contains suggested retry times based on the previous
24172 rules. In the case of a long-running problem with a remote host, it might
24173 record the fact that the host has timed out. If your new rules increase the
24174 timeout time for such a host, you should definitely remove the old retry data
24175 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24176 messages that it should now be retaining.
24177
24178
24179
24180 .section "Format of retry rules" "SECID158"
24181 .cindex "retry" "rules"
24182 Each retry rule occupies one line and consists of three or four parts,
24183 separated by white space: a pattern, an error name, an optional list of sender
24184 addresses, and a list of retry parameters. The pattern and sender lists must be
24185 enclosed in double quotes if they contain white space. The rules are searched
24186 in order until one is found where the pattern, error name, and sender list (if
24187 present) match the failing host or address, the error that occurred, and the
24188 message's sender, respectively.
24189
24190
24191 The pattern is any single item that may appear in an address list (see section
24192 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24193 which means that it is expanded before being tested against the address that
24194 has been delayed. A negated address list item is permitted. Address
24195 list processing treats a plain domain name as if it were preceded by &"*@"&,
24196 which makes it possible for many retry rules to start with just a domain. For
24197 example,
24198 .code
24199 lookingglass.fict.example        *  F,24h,30m;
24200 .endd
24201 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24202 whereas
24203 .code
24204 alice@lookingglass.fict.example  *  F,24h,30m;
24205 .endd
24206 applies only to temporary failures involving the local part &%alice%&.
24207 In practice, almost all rules start with a domain name pattern without a local
24208 part.
24209
24210 .cindex "regular expressions" "in retry rules"
24211 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24212 must match a complete address, not just a domain, because that is how regular
24213 expressions work in address lists.
24214 .display
24215 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24216 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24217 .endd
24218
24219
24220 .section "Choosing which retry rule to use for address errors" "SECID159"
24221 When Exim is looking for a retry rule after a routing attempt has failed (for
24222 example, after a DNS timeout), each line in the retry configuration is tested
24223 against the complete address only if &%retry_use_local_part%& is set for the
24224 router. Otherwise, only the domain is used, except when matching against a
24225 regular expression, when the local part of the address is replaced with &"*"&.
24226 A domain on its own can match a domain pattern, or a pattern that starts with
24227 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24228 &%check_local_user%& is true, and false for other routers.
24229
24230 Similarly, when Exim is looking for a retry rule after a local delivery has
24231 failed (for example, after a mailbox full error), each line in the retry
24232 configuration is tested against the complete address only if
24233 &%retry_use_local_part%& is set for the transport (it defaults true for all
24234 local transports).
24235
24236 .cindex "4&'xx'& responses" "retry rules for"
24237 However, when Exim is looking for a retry rule after a remote delivery attempt
24238 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24239 whole address is always used as the key when searching the retry rules. The
24240 rule that is found is used to create a retry time for the combination of the
24241 failing address and the message's sender. It is the combination of sender and
24242 recipient that is delayed in subsequent queue runs until its retry time is
24243 reached. You can delay the recipient without regard to the sender by setting
24244 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24245 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24246 commands.
24247
24248
24249
24250 .section "Choosing which retry rule to use for host and message errors" &&&
24251          "SECID160"
24252 For a temporary error that is not related to an individual address (for
24253 example, a connection timeout), each line in the retry configuration is checked
24254 twice. First, the name of the remote host is used as a domain name (preceded by
24255 &"*@"& when matching a regular expression). If this does not match the line,
24256 the domain from the email address is tried in a similar fashion. For example,
24257 suppose the MX records for &'a.b.c.example'& are
24258 .code
24259 a.b.c.example  MX  5  x.y.z.example
24260                MX  6  p.q.r.example
24261                MX  7  m.n.o.example
24262 .endd
24263 and the retry rules are
24264 .code
24265 p.q.r.example    *      F,24h,30m;
24266 a.b.c.example    *      F,4d,45m;
24267 .endd
24268 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24269 first rule matches neither the host nor the domain, so Exim looks at the second
24270 rule. This does not match the host, but it does match the domain, so it is used
24271 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24272 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24273 first retry rule is used, because it matches the host.
24274
24275 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24276 first rule to determine retry times, but for all the other hosts for the domain
24277 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24278 routing to &'a.b.c.example'& suffers a temporary failure.
24279
24280 &*Note*&: The host name is used when matching the patterns, not its IP address.
24281 However, if a message is routed directly to an IP address without the use of a
24282 host name, for example, if a &(manualroute)& router contains a setting such as:
24283 .code
24284 route_list = *.a.example  192.168.34.23
24285 .endd
24286 then the &"host name"& that is used when searching for a retry rule is the
24287 textual form of the IP address.
24288
24289 .section "Retry rules for specific errors" "SECID161"
24290 .cindex "retry" "specific errors; specifying"
24291 The second field in a retry rule is the name of a particular error, or an
24292 asterisk, which matches any error. The errors that can be tested for are:
24293
24294 .vlist
24295 .vitem &%auth_failed%&
24296 Authentication failed when trying to send to a host in the
24297 &%hosts_require_auth%& list in an &(smtp)& transport.
24298
24299 .vitem &%data_4xx%&
24300 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24301 after the command, or after sending the message's data.
24302
24303 .vitem &%mail_4xx%&
24304 A 4&'xx'& error was received for an outgoing MAIL command.
24305
24306 .vitem &%rcpt_4xx%&
24307 A 4&'xx'& error was received for an outgoing RCPT command.
24308 .endlist
24309
24310 For the three 4&'xx'& errors, either the first or both of the x's can be given
24311 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24312 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24313 and have retries every ten minutes with a one-hour timeout, you could set up a
24314 retry rule of this form:
24315 .code
24316 the.domain.name  rcpt_452   F,1h,10m
24317 .endd
24318 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24319 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24320
24321 .vlist
24322 .vitem &%lost_connection%&
24323 A server unexpectedly closed the SMTP connection. There may, of course,
24324 legitimate reasons for this (host died, network died), but if it repeats a lot
24325 for the same host, it indicates something odd.
24326
24327 .vitem &%refused_MX%&
24328 A connection to a host obtained from an MX record was refused.
24329
24330 .vitem &%refused_A%&
24331 A connection to a host not obtained from an MX record was refused.
24332
24333 .vitem &%refused%&
24334 A connection was refused.
24335
24336 .vitem &%timeout_connect_MX%&
24337 A connection attempt to a host obtained from an MX record timed out.
24338
24339 .vitem &%timeout_connect_A%&
24340 A connection attempt to a host not obtained from an MX record timed out.
24341
24342 .vitem &%timeout_connect%&
24343 A connection attempt timed out.
24344
24345 .vitem &%timeout_MX%&
24346 There was a timeout while connecting or during an SMTP session with a host
24347 obtained from an MX record.
24348
24349 .vitem &%timeout_A%&
24350 There was a timeout while connecting or during an SMTP session with a host not
24351 obtained from an MX record.
24352
24353 .vitem &%timeout%&
24354 There was a timeout while connecting or during an SMTP session.
24355
24356 .vitem &%tls_required%&
24357 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24358 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24359 to STARTTLS, or there was a problem setting up the TLS connection.
24360
24361 .vitem &%quota%&
24362 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24363 transport.
24364
24365 .vitem &%quota_%&<&'time'&>
24366 .cindex "quota" "error testing in retry rule"
24367 .cindex "retry" "quota error testing"
24368 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24369 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24370 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24371 for four days.
24372 .endlist
24373
24374 .cindex "mailbox" "time of last read"
24375 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24376 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24377 it should be based on the last time that the user accessed the mailbox.
24378 However, it is not always possible to determine this. Exim uses the following
24379 heuristic rules:
24380
24381 .ilist
24382 If the mailbox is a single file, the time of last access (the &"atime"&) is
24383 used. As no new messages are being delivered (because the mailbox is over
24384 quota), Exim does not access the file, so this is the time of last user access.
24385 .next
24386 .cindex "maildir format" "time of last read"
24387 For a maildir delivery, the time of last modification of the &_new_&
24388 subdirectory is used. As the mailbox is over quota, no new files are created in
24389 the &_new_& subdirectory, because no new messages are being delivered. Any
24390 change to the &_new_& subdirectory is therefore assumed to be the result of an
24391 MUA moving a new message to the &_cur_& directory when it is first read. The
24392 time that is used is therefore the last time that the user read a new message.
24393 .next
24394 For other kinds of multi-file mailbox, the time of last access cannot be
24395 obtained, so a retry rule that uses this type of error field is never matched.
24396 .endlist
24397
24398 The quota errors apply both to system-enforced quotas and to Exim's own quota
24399 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24400 when a local delivery is deferred because a partition is full (the ENOSPC
24401 error).
24402
24403
24404
24405 .section "Retry rules for specified senders" "SECID162"
24406 .cindex "retry" "rules; sender-specific"
24407 You can specify retry rules that apply only when the failing message has a
24408 specific sender. In particular, this can be used to define retry rules that
24409 apply only to bounce messages. The third item in a retry rule can be of this
24410 form:
24411 .display
24412 &`senders=`&<&'address list'&>
24413 .endd
24414 The retry timings themselves are then the fourth item. For example:
24415 .code
24416 *   rcpt_4xx   senders=:   F,1h,30m
24417 .endd
24418 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24419 host. If the address list contains white space, it must be enclosed in quotes.
24420 For example:
24421 .code
24422 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24423 .endd
24424 &*Warning*&: This facility can be unhelpful if it is used for host errors
24425 (which do not depend on the recipient). The reason is that the sender is used
24426 only to match the retry rule. Once the rule has been found for a host error,
24427 its contents are used to set a retry time for the host, and this will apply to
24428 all messages, not just those with specific senders.
24429
24430 When testing retry rules using &%-brt%&, you can supply a sender using the
24431 &%-f%& command line option, like this:
24432 .code
24433 exim -f "" -brt user@dom.ain
24434 .endd
24435 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24436 list is never matched.
24437
24438
24439
24440
24441
24442 .section "Retry parameters" "SECID163"
24443 .cindex "retry" "parameters in rules"
24444 The third (or fourth, if a senders list is present) field in a retry rule is a
24445 sequence of retry parameter sets, separated by semicolons. Each set consists of
24446 .display
24447 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24448 .endd
24449 The letter identifies the algorithm for computing a new retry time; the cutoff
24450 time is the time beyond which this algorithm no longer applies, and the
24451 arguments vary the algorithm's action. The cutoff time is measured from the
24452 time that the first failure for the domain (combined with the local part if
24453 relevant) was detected, not from the time the message was received.
24454
24455 .cindex "retry" "algorithms"
24456 .cindex "retry" "fixed intervals"
24457 .cindex "retry" "increasing intervals"
24458 .cindex "retry" "random intervals"
24459 The available algorithms are:
24460
24461 .ilist
24462 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24463 the interval.
24464 .next
24465 &'G'&: retry at geometrically increasing intervals. The first argument
24466 specifies a starting value for the interval, and the second a multiplier, which
24467 is used to increase the size of the interval at each retry.
24468 .next
24469 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24470 retry, the previous interval is multiplied by the factor in order to get a
24471 maximum for the next interval. The minimum interval is the first argument of
24472 the parameter, and an actual interval is chosen randomly between them. Such a
24473 rule has been found to be helpful in cluster configurations when all the
24474 members of the cluster restart at once, and may therefore synchronize their
24475 queue processing times.
24476 .endlist
24477
24478 When computing the next retry time, the algorithm definitions are scanned in
24479 order until one whose cutoff time has not yet passed is reached. This is then
24480 used to compute a new retry time that is later than the current time. In the
24481 case of fixed interval retries, this simply means adding the interval to the
24482 current time. For geometrically increasing intervals, retry intervals are
24483 computed from the rule's parameters until one that is greater than the previous
24484 interval is found. The main configuration variable
24485 .cindex "limit" "retry interval"
24486 .cindex "retry" "interval, maximum"
24487 .oindex "&%retry_interval_max%&"
24488 &%retry_interval_max%& limits the maximum interval between retries. It
24489 cannot be set greater than &`24h`&, which is its default value.
24490
24491 A single remote domain may have a number of hosts associated with it, and each
24492 host may have more than one IP address. Retry algorithms are selected on the
24493 basis of the domain name, but are applied to each IP address independently. If,
24494 for example, a host has two IP addresses and one is unusable, Exim will
24495 generate retry times for it and will not try to use it until its next retry
24496 time comes. Thus the good IP address is likely to be tried first most of the
24497 time.
24498
24499 .cindex "hints database" "use for retrying"
24500 Retry times are hints rather than promises. Exim does not make any attempt to
24501 run deliveries exactly at the computed times. Instead, a queue runner process
24502 starts delivery processes for delayed messages periodically, and these attempt
24503 new deliveries only for those addresses that have passed their next retry time.
24504 If a new message arrives for a deferred address, an immediate delivery attempt
24505 occurs only if the address has passed its retry time. In the absence of new
24506 messages, the minimum time between retries is the interval between queue runner
24507 processes. There is not much point in setting retry times of five minutes if
24508 your queue runners happen only once an hour, unless there are a significant
24509 number of incoming messages (which might be the case on a system that is
24510 sending everything to a smart host, for example).
24511
24512 The data in the retry hints database can be inspected by using the
24513 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24514 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24515 &'exinext'& utility script can be used to find out what the next retry times
24516 are for the hosts associated with a particular mail domain, and also for local
24517 deliveries that have been deferred.
24518
24519
24520 .section "Retry rule examples" "SECID164"
24521 Here are some example retry rules:
24522 .code
24523 alice@wonderland.fict.example quota_5d  F,7d,3h
24524 wonderland.fict.example       quota_5d
24525 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24526 lookingglass.fict.example     *         F,24h,30m;
24527 *                 refused_A   F,2h,20m;
24528 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24529 .endd
24530 The first rule sets up special handling for mail to
24531 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24532 mailbox has not been read for at least 5 days. Retries continue every three
24533 hours for 7 days. The second rule handles over-quota errors for all other local
24534 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24535 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24536 fail are bounced immediately if the mailbox has not been read for at least 5
24537 days.
24538
24539 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24540 happen every 15 minutes for an hour, then with geometrically increasing
24541 intervals until two days have passed since a delivery first failed. After the
24542 first hour there is a delay of one hour, then two hours, then four hours, and
24543 so on (this is a rather extreme example).
24544
24545 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24546 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24547 all other domains, with special action for connection refusal from hosts that
24548 were not obtained from an MX record.
24549
24550 The final rule in a retry configuration should always have asterisks in the
24551 first two fields so as to provide a general catch-all for any addresses that do
24552 not have their own special handling. This example tries every 15 minutes for 2
24553 hours, then with intervals starting at one hour and increasing by a factor of
24554 1.5 up to 16 hours, then every 8 hours up to 5 days.
24555
24556
24557
24558 .section "Timeout of retry data" "SECID165"
24559 .cindex "timeout" "of retry data"
24560 .oindex "&%retry_data_expire%&"
24561 .cindex "hints database" "data expiry"
24562 .cindex "retry" "timeout of data"
24563 Exim timestamps the data that it writes to its retry hints database. When it
24564 consults the data during a delivery it ignores any that is older than the value
24565 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24566 been tried for 7 days, Exim will try to deliver to it immediately a message
24567 arrives, and if that fails, it will calculate a retry time as if it were
24568 failing for the first time.
24569
24570 This improves the behaviour for messages routed to rarely-used hosts such as MX
24571 backups. If such a host was down at one time, and happens to be down again when
24572 Exim tries a month later, using the old retry data would imply that it had been
24573 down all the time, which is not a justified assumption.
24574
24575 If a host really is permanently dead, this behaviour causes a burst of retries
24576 every now and again, but only if messages routed to it are rare. If there is a
24577 message at least once every 7 days the retry data never expires.
24578
24579
24580
24581
24582 .section "Long-term failures" "SECID166"
24583 .cindex "delivery failure, long-term"
24584 .cindex "retry" "after long-term failure"
24585 Special processing happens when an email address has been failing for so long
24586 that the cutoff time for the last algorithm is reached. For example, using the
24587 default retry rule:
24588 .code
24589 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24590 .endd
24591 the cutoff time is four days. Reaching the retry cutoff is independent of how
24592 long any specific message has been failing; it is the length of continuous
24593 failure for the recipient address that counts.
24594
24595 When the cutoff time is reached for a local delivery, or for all the IP
24596 addresses associated with a remote delivery, a subsequent delivery failure
24597 causes Exim to give up on the address, and a bounce message is generated.
24598 In order to cater for new messages that use the failing address, a next retry
24599 time is still computed from the final algorithm, and is used as follows:
24600
24601 For local deliveries, one delivery attempt is always made for any subsequent
24602 messages. If this delivery fails, the address fails immediately. The
24603 post-cutoff retry time is not used.
24604
24605 If the delivery is remote, there are two possibilities, controlled by the
24606 .oindex "&%delay_after_cutoff%&"
24607 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24608 default. Until the post-cutoff retry time for one of the IP addresses is
24609 reached, the failing email address is bounced immediately, without a delivery
24610 attempt taking place. After that time, one new delivery attempt is made to
24611 those IP addresses that are past their retry times, and if that still fails,
24612 the address is bounced and new retry times are computed.
24613
24614 In other words, when all the hosts for a given email address have been failing
24615 for a long time, Exim bounces rather then defers until one of the hosts' retry
24616 times is reached. Then it tries once, and bounces if that attempt fails. This
24617 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24618 to a broken destination, but if the host does recover, Exim will eventually
24619 notice.
24620
24621 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24622 addresses are past their final cutoff time, Exim tries to deliver to those IP
24623 addresses that have not been tried since the message arrived. If there are
24624 no suitable IP addresses, or if they all fail, the address is bounced. In other
24625 words, it does not delay when a new message arrives, but tries the expired
24626 addresses immediately, unless they have been tried since the message arrived.
24627 If there is a continuous stream of messages for the failing domains, setting
24628 &%delay_after_cutoff%& false means that there will be many more attempts to
24629 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24630 true.
24631
24632 .section "Deliveries that work intermittently" "SECID167"
24633 .cindex "retry" "intermittently working deliveries"
24634 Some additional logic is needed to cope with cases where a host is
24635 intermittently available, or when a message has some attribute that prevents
24636 its delivery when others to the same address get through. In this situation,
24637 because some messages are successfully delivered, the &"retry clock"& for the
24638 host or address keeps getting reset by the successful deliveries, and so
24639 failing messages remain on the queue for ever because the cutoff time is never
24640 reached.
24641
24642 Two exceptional actions are applied to prevent this happening. The first
24643 applies to errors that are related to a message rather than a remote host.
24644 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24645 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24646 commands, and quota failures. For this type of error, if a message's arrival
24647 time is earlier than the &"first failed"& time for the error, the earlier time
24648 is used when scanning the retry rules to decide when to try next and when to
24649 time out the address.
24650
24651 The exceptional second action applies in all cases. If a message has been on
24652 the queue for longer than the cutoff time of any applicable retry rule for a
24653 given address, a delivery is attempted for that address, even if it is not yet
24654 time, and if this delivery fails, the address is timed out. A new retry time is
24655 not computed in this case, so that other messages for the same address are
24656 considered immediately.
24657 .ecindex IIDretconf1
24658 .ecindex IIDregconf2
24659
24660
24661
24662
24663
24664
24665 . ////////////////////////////////////////////////////////////////////////////
24666 . ////////////////////////////////////////////////////////////////////////////
24667
24668 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24669 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24670 .scindex IIDauthconf2 "authentication"
24671 The &"authenticators"& section of Exim's run time configuration is concerned
24672 with SMTP authentication. This facility is an extension to the SMTP protocol,
24673 described in RFC 2554, which allows a client SMTP host to authenticate itself
24674 to a server. This is a common way for a server to recognize clients that are
24675 permitted to use it as a relay. SMTP authentication is not of relevance to the
24676 transfer of mail between servers that have no managerial connection with each
24677 other.
24678
24679 .cindex "AUTH" "description of"
24680 Very briefly, the way SMTP authentication works is as follows:
24681
24682 .ilist
24683 The server advertises a number of authentication &'mechanisms'& in response to
24684 the client's EHLO command.
24685 .next
24686 The client issues an AUTH command, naming a specific mechanism. The command
24687 may, optionally, contain some authentication data.
24688 .next
24689 The server may issue one or more &'challenges'&, to which the client must send
24690 appropriate responses. In simple authentication mechanisms, the challenges are
24691 just prompts for user names and passwords. The server does not have to issue
24692 any challenges &-- in some mechanisms the relevant data may all be transmitted
24693 with the AUTH command.
24694 .next
24695 The server either accepts or denies authentication.
24696 .next
24697 If authentication succeeds, the client may optionally make use of the AUTH
24698 option on the MAIL command to pass an authenticated sender in subsequent
24699 mail transactions. Authentication lasts for the remainder of the SMTP
24700 connection.
24701 .next
24702 If authentication fails, the client may give up, or it may try a different
24703 authentication mechanism, or it may try transferring mail over the
24704 unauthenticated connection.
24705 .endlist
24706
24707 If you are setting up a client, and want to know which authentication
24708 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24709 SMTP port) on the server, and issue an EHLO command. The response to this
24710 includes the list of supported mechanisms. For example:
24711 .display
24712 &`$ `&&*&`telnet server.example 25`&*&
24713 &`Trying 192.168.34.25...`&
24714 &`Connected to server.example.`&
24715 &`Escape character is &#x0027;^]&#x0027;.`&
24716 &`220 server.example ESMTP Exim 4.20 ...`&
24717 &*&`ehlo client.example`&*&
24718 &`250-server.example Hello client.example [10.8.4.5]`&
24719 &`250-SIZE 52428800`&
24720 &`250-PIPELINING`&
24721 &`250-AUTH PLAIN`&
24722 &`250 HELP`&
24723 .endd
24724 The second-last line of this example output shows that the server supports
24725 authentication using the PLAIN mechanism. In Exim, the different authentication
24726 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24727 routers and transports, which authenticators are included in the binary is
24728 controlled by build-time definitions. The following are currently available,
24729 included by setting
24730 .code
24731 AUTH_CRAM_MD5=yes
24732 AUTH_CYRUS_SASL=yes
24733 AUTH_DOVECOT=yes
24734 AUTH_GSASL=yes
24735 AUTH_HEIMDAL_GSSAPI=yes
24736 AUTH_PLAINTEXT=yes
24737 AUTH_SPA=yes
24738 .endd
24739 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24740 authentication mechanism (RFC 2195), and the second provides an interface to
24741 the Cyrus SASL authentication library.
24742 The third is an interface to Dovecot's authentication system, delegating the
24743 work via a socket interface.
24744 The fourth provides an interface to the GNU SASL authentication library, which
24745 provides mechanisms but typically not data sources.
24746 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24747 supporting setting a server keytab.
24748 The sixth can be configured to support
24749 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24750 not formally documented, but used by several MUAs. The seventh authenticator
24751 supports Microsoft's &'Secure Password Authentication'& mechanism.
24752
24753 The authenticators are configured using the same syntax as other drivers (see
24754 section &<<SECTfordricon>>&). If no authenticators are required, no
24755 authentication section need be present in the configuration file. Each
24756 authenticator can in principle have both server and client functions. When Exim
24757 is receiving SMTP mail, it is acting as a server; when it is sending out
24758 messages over SMTP, it is acting as a client. Authenticator configuration
24759 options are provided for use in both these circumstances.
24760
24761 To make it clear which options apply to which situation, the prefixes
24762 &%server_%& and &%client_%& are used on option names that are specific to
24763 either the server or the client function, respectively. Server and client
24764 functions are disabled if none of their options are set. If an authenticator is
24765 to be used for both server and client functions, a single definition, using
24766 both sets of options, is required. For example:
24767 .code
24768 cram:
24769   driver = cram_md5
24770   public_name = CRAM-MD5
24771   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24772   client_name = ph10
24773   client_secret = secret2
24774 .endd
24775 The &%server_%& option is used when Exim is acting as a server, and the
24776 &%client_%& options when it is acting as a client.
24777
24778 Descriptions of the individual authenticators are given in subsequent chapters.
24779 The remainder of this chapter covers the generic options for the
24780 authenticators, followed by general discussion of the way authentication works
24781 in Exim.
24782
24783 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24784 per-mechanism basis.  Please read carefully to determine which variables hold
24785 account labels such as usercodes and which hold passwords or other
24786 authenticating data.
24787
24788 Note that some mechanisms support two different identifiers for accounts: the
24789 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24790 and &'authz'& are commonly encountered.  The American spelling is standard here.
24791 Conceptually, authentication data such as passwords are tied to the identifier
24792 used to authenticate; servers may have rules to permit one user to act as a
24793 second user, so that after login the session is treated as though that second
24794 user had logged in.  That second user is the &'authorization id'&.  A robust
24795 configuration might confirm that the &'authz'& field is empty or matches the
24796 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24797 as verified data, the &'authz'& as an unverified request which the server might
24798 choose to honour.
24799
24800 A &'realm'& is a text string, typically a domain name, presented by a server
24801 to a client to help it select an account and credentials to use.  In some
24802 mechanisms, the client and server provably agree on the realm, but clients
24803 typically can not treat the realm as secure data to be blindly trusted.
24804
24805
24806
24807 .section "Generic options for authenticators" "SECID168"
24808 .cindex "authentication" "generic options"
24809 .cindex "options" "generic; for authenticators"
24810
24811 .option client_condition authenticators string&!! unset
24812 When Exim is authenticating as a client, it skips any authenticator whose
24813 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24814 used, for example, to skip plain text authenticators when the connection is not
24815 encrypted by a setting such as:
24816 .code
24817 client_condition = ${if !eq{$tls_out_cipher}{}}
24818 .endd
24819
24820
24821 .option client_set_id authenticators string&!! unset
24822 When client authentication succeeds, this condition is expanded; the
24823 result is used in the log lines for outbound messasges.
24824 Typically it will be the user name used for authentication.
24825
24826
24827 .option driver authenticators string unset
24828 This option must always be set. It specifies which of the available
24829 authenticators is to be used.
24830
24831
24832 .option public_name authenticators string unset
24833 This option specifies the name of the authentication mechanism that the driver
24834 implements, and by which it is known to the outside world. These names should
24835 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24836 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24837 defaults to the driver's instance name.
24838
24839
24840 .option server_advertise_condition authenticators string&!! unset
24841 When a server is about to advertise an authentication mechanism, the condition
24842 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24843 mechanism is not advertised.
24844 If the expansion fails, the mechanism is not advertised. If the failure was not
24845 forced, and was not caused by a lookup defer, the incident is logged.
24846 See section &<<SECTauthexiser>>& below for further discussion.
24847
24848
24849 .option server_condition authenticators string&!! unset
24850 This option must be set for a &%plaintext%& server authenticator, where it
24851 is used directly to control authentication. See section &<<SECTplainserver>>&
24852 for details.
24853
24854 For the &(gsasl)& authenticator, this option is required for various
24855 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24856
24857 For the other authenticators, &%server_condition%& can be used as an additional
24858 authentication or authorization mechanism that is applied after the other
24859 authenticator conditions succeed. If it is set, it is expanded when the
24860 authenticator would otherwise return a success code. If the expansion is forced
24861 to fail, authentication fails. Any other expansion failure causes a temporary
24862 error code to be returned. If the result of a successful expansion is an empty
24863 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24864 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24865 other result, a temporary error code is returned, with the expanded string as
24866 the error text.
24867
24868
24869 .option server_debug_print authenticators string&!! unset
24870 If this option is set and authentication debugging is enabled (see the &%-d%&
24871 command line option), the string is expanded and included in the debugging
24872 output when the authenticator is run as a server. This can help with checking
24873 out the values of variables.
24874 If expansion of the string fails, the error message is written to the debugging
24875 output, and Exim carries on processing.
24876
24877
24878 .option server_set_id authenticators string&!! unset
24879 .vindex "&$authenticated_id$&"
24880 When an Exim server successfully authenticates a client, this string is
24881 expanded using data from the authentication, and preserved for any incoming
24882 messages in the variable &$authenticated_id$&. It is also included in the log
24883 lines for incoming messages. For example, a user/password authenticator
24884 configuration might preserve the user name that was used to authenticate, and
24885 refer to it subsequently during delivery of the message.
24886 If expansion fails, the option is ignored.
24887
24888
24889 .option server_mail_auth_condition authenticators string&!! unset
24890 This option allows a server to discard authenticated sender addresses supplied
24891 as part of MAIL commands in SMTP connections that are authenticated by the
24892 driver on which &%server_mail_auth_condition%& is set. The option is not used
24893 as part of the authentication process; instead its (unexpanded) value is
24894 remembered for later use.
24895 How it is used is described in the following section.
24896
24897
24898
24899
24900
24901 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24902 .cindex "authentication" "sender; authenticated"
24903 .cindex "AUTH" "on MAIL command"
24904 When a client supplied an AUTH= item on a MAIL command, Exim applies
24905 the following checks before accepting it as the authenticated sender of the
24906 message:
24907
24908 .ilist
24909 If the connection is not using extended SMTP (that is, HELO was used rather
24910 than EHLO), the use of AUTH= is a syntax error.
24911 .next
24912 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24913 .next
24914 .vindex "&$authenticated_sender$&"
24915 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24916 running, the value of &$authenticated_sender$& is set to the value obtained
24917 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24918 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24919 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24920 given for the MAIL command.
24921 .next
24922 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24923 is accepted and placed in &$authenticated_sender$& only if the client has
24924 authenticated.
24925 .next
24926 If the AUTH= value was accepted by either of the two previous rules, and
24927 the client has authenticated, and the authenticator has a setting for the
24928 &%server_mail_auth_condition%&, the condition is checked at this point. The
24929 valued that was saved from the authenticator is expanded. If the expansion
24930 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24931 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24932 the value of &$authenticated_sender$& is retained and passed on with the
24933 message.
24934 .endlist
24935
24936
24937 When &$authenticated_sender$& is set for a message, it is passed on to other
24938 hosts to which Exim authenticates as a client. Do not confuse this value with
24939 &$authenticated_id$&, which is a string obtained from the authentication
24940 process, and which is not usually a complete email address.
24941
24942 .vindex "&$sender_address$&"
24943 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24944 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24945 therefore make use of &$authenticated_sender$&. The converse is not true: the
24946 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24947 ACL is run.
24948
24949
24950
24951 .section "Authentication on an Exim server" "SECTauthexiser"
24952 .cindex "authentication" "on an Exim server"
24953 When Exim receives an EHLO command, it advertises the public names of those
24954 authenticators that are configured as servers, subject to the following
24955 conditions:
24956
24957 .ilist
24958 The client host must match &%auth_advertise_hosts%& (default *).
24959 .next
24960 It the &%server_advertise_condition%& option is set, its expansion must not
24961 yield the empty string, &"0"&, &"no"&, or &"false"&.
24962 .endlist
24963
24964 The order in which the authenticators are defined controls the order in which
24965 the mechanisms are advertised.
24966
24967 Some mail clients (for example, some versions of Netscape) require the user to
24968 provide a name and password for authentication whenever AUTH is advertised,
24969 even though authentication may not in fact be needed (for example, Exim may be
24970 set up to allow unconditional relaying from the client by an IP address check).
24971 You can make such clients more friendly by not advertising AUTH to them.
24972 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24973 that runs for RCPT) to relay without authentication, you should set
24974 .code
24975 auth_advertise_hosts = ! 10.9.8.0/24
24976 .endd
24977 so that no authentication mechanisms are advertised to them.
24978
24979 The &%server_advertise_condition%& controls the advertisement of individual
24980 authentication mechanisms. For example, it can be used to restrict the
24981 advertisement of a particular mechanism to encrypted connections, by a setting
24982 such as:
24983 .code
24984 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24985 .endd
24986 .vindex "&$tls_in_cipher$&"
24987 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24988 yields &"yes"&, which allows the advertisement to happen.
24989
24990 When an Exim server receives an AUTH command from a client, it rejects it
24991 immediately if AUTH was not advertised in response to an earlier EHLO
24992 command. This is the case if
24993
24994 .ilist
24995 The client host does not match &%auth_advertise_hosts%&; or
24996 .next
24997 No authenticators are configured with server options; or
24998 .next
24999 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25000 server authenticators.
25001 .endlist
25002
25003
25004 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25005 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25006 AUTH is accepted from any client host.
25007
25008 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25009 server authentication mechanism that was advertised in response to EHLO and
25010 that matches the one named in the AUTH command. If it finds one, it runs
25011 the appropriate authentication protocol, and authentication either succeeds or
25012 fails. If there is no matching advertised mechanism, the AUTH command is
25013 rejected with a 504 error.
25014
25015 .vindex "&$received_protocol$&"
25016 .vindex "&$sender_host_authenticated$&"
25017 When a message is received from an authenticated host, the value of
25018 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25019 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25020 public name) of the authenticator driver that successfully authenticated the
25021 client from which the message was received. This variable is empty if there was
25022 no successful authentication.
25023
25024
25025
25026
25027 .section "Testing server authentication" "SECID169"
25028 .cindex "authentication" "testing a server"
25029 .cindex "AUTH" "testing a server"
25030 .cindex "base64 encoding" "creating authentication test data"
25031 Exim's &%-bh%& option can be useful for testing server authentication
25032 configurations. The data for the AUTH command has to be sent using base64
25033 encoding. A quick way to produce such data for testing is the following Perl
25034 script:
25035 .code
25036 use MIME::Base64;
25037 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25038 .endd
25039 .cindex "binary zero" "in authentication data"
25040 This interprets its argument as a Perl string, and then encodes it. The
25041 interpretation as a Perl string allows binary zeros, which are required for
25042 some kinds of authentication, to be included in the data. For example, a
25043 command line to run this script on such data might be
25044 .code
25045 encode '\0user\0password'
25046 .endd
25047 Note the use of single quotes to prevent the shell interpreting the
25048 backslashes, so that they can be interpreted by Perl to specify characters
25049 whose code value is zero.
25050
25051 &*Warning 1*&: If either of the user or password strings starts with an octal
25052 digit, you must use three zeros instead of one after the leading backslash. If
25053 you do not, the octal digit that starts your string will be incorrectly
25054 interpreted as part of the code for the first character.
25055
25056 &*Warning 2*&: If there are characters in the strings that Perl interprets
25057 specially, you must use a Perl escape to prevent them being misinterpreted. For
25058 example, a command such as
25059 .code
25060 encode '\0user@domain.com\0pas$$word'
25061 .endd
25062 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25063
25064 If you have the &%mimencode%& command installed, another way to do produce
25065 base64-encoded strings is to run the command
25066 .code
25067 echo -e -n `\0user\0password' | mimencode
25068 .endd
25069 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25070 in the argument, and the &%-n%& option specifies no newline at the end of its
25071 output. However, not all versions of &%echo%& recognize these options, so you
25072 should check your version before relying on this suggestion.
25073
25074
25075
25076 .section "Authentication by an Exim client" "SECID170"
25077 .cindex "authentication" "on an Exim client"
25078 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25079 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25080 announces support for authentication, and the host matches an entry in either
25081 of these options, Exim (as a client) tries to authenticate as follows:
25082
25083 .ilist
25084 For each authenticator that is configured as a client, in the order in which
25085 they are defined in the configuration, it searches the authentication
25086 mechanisms announced by the server for one whose name matches the public name
25087 of the authenticator.
25088 .next
25089 .vindex "&$host$&"
25090 .vindex "&$host_address$&"
25091 When it finds one that matches, it runs the authenticator's client code. The
25092 variables &$host$& and &$host_address$& are available for any string expansions
25093 that the client might do. They are set to the server's name and IP address. If
25094 any expansion is forced to fail, the authentication attempt is abandoned, and
25095 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25096 delivery to be deferred.
25097 .next
25098 If the result of the authentication attempt is a temporary error or a timeout,
25099 Exim abandons trying to send the message to the host for the moment. It will
25100 try again later. If there are any backup hosts available, they are tried in the
25101 usual way.
25102 .next
25103 If the response to authentication is a permanent error (5&'xx'& code), Exim
25104 carries on searching the list of authenticators and tries another one if
25105 possible. If all authentication attempts give permanent errors, or if there are
25106 no attempts because no mechanisms match (or option expansions force failure),
25107 what happens depends on whether the host matches &%hosts_require_auth%& or
25108 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25109 delivery is deferred. The error can be detected in the retry rules, and thereby
25110 turned into a permanent error if you wish. In the second case, Exim tries to
25111 deliver the message unauthenticated.
25112 .endlist
25113
25114 .cindex "AUTH" "on MAIL command"
25115 When Exim has authenticated itself to a remote server, it adds the AUTH
25116 parameter to the MAIL commands it sends, if it has an authenticated sender for
25117 the message. If the message came from a remote host, the authenticated sender
25118 is the one that was receiving on an incoming MAIL command, provided that the
25119 incoming connection was authenticated and the &%server_mail_auth%& condition
25120 allowed the authenticated sender to be retained. If a local process calls Exim
25121 to send a message, the sender address that is built from the login name and
25122 &%qualify_domain%& is treated as authenticated. However, if the
25123 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25124 the authenticated sender that was received with the message.
25125 .ecindex IIDauthconf1
25126 .ecindex IIDauthconf2
25127
25128
25129
25130
25131
25132
25133 . ////////////////////////////////////////////////////////////////////////////
25134 . ////////////////////////////////////////////////////////////////////////////
25135
25136 .chapter "The plaintext authenticator" "CHAPplaintext"
25137 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25138 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25139 The &(plaintext)& authenticator can be configured to support the PLAIN and
25140 LOGIN authentication mechanisms, both of which transfer authentication data as
25141 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25142 security risk; you are strongly advised to insist on the use of SMTP encryption
25143 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25144 use unencrypted plain text, you should not use the same passwords for SMTP
25145 connections as you do for login accounts.
25146
25147 .section "Plaintext options" "SECID171"
25148 .cindex "options" "&(plaintext)& authenticator (server)"
25149 When configured as a server, &(plaintext)& uses the following options:
25150
25151 .option server_condition authenticators string&!! unset
25152 This is actually a global authentication option, but it must be set in order to
25153 configure the &(plaintext)& driver as a server. Its use is described below.
25154
25155 .option server_prompts plaintext string&!! unset
25156 The contents of this option, after expansion, must be a colon-separated list of
25157 prompt strings. If expansion fails, a temporary authentication rejection is
25158 given.
25159
25160 .section "Using plaintext in a server" "SECTplainserver"
25161 .cindex "AUTH" "in &(plaintext)& authenticator"
25162 .cindex "binary zero" "in &(plaintext)& authenticator"
25163 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25164         "in &(plaintext)& authenticator"
25165 .vindex "&$auth1$&, &$auth2$&, etc"
25166 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25167
25168 When running as a server, &(plaintext)& performs the authentication test by
25169 expanding a string. The data sent by the client with the AUTH command, or in
25170 response to subsequent prompts, is base64 encoded, and so may contain any byte
25171 values when decoded. If any data is supplied with the command, it is treated as
25172 a list of strings, separated by NULs (binary zeros), the first three of which
25173 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25174 (neither LOGIN nor PLAIN uses more than three strings).
25175
25176 For compatibility with previous releases of Exim, the values are also placed in
25177 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25178 variables for this purpose is now deprecated, as it can lead to confusion in
25179 string expansions that also use them for other things.
25180
25181 If there are more strings in &%server_prompts%& than the number of strings
25182 supplied with the AUTH command, the remaining prompts are used to obtain more
25183 data. Each response from the client may be a list of NUL-separated strings.
25184
25185 .vindex "&$authenticated_id$&"
25186 Once a sufficient number of data strings have been received,
25187 &%server_condition%& is expanded. If the expansion is forced to fail,
25188 authentication fails. Any other expansion failure causes a temporary error code
25189 to be returned. If the result of a successful expansion is an empty string,
25190 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25191 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25192 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25193 For any other result, a temporary error code is returned, with the expanded
25194 string as the error text
25195
25196 &*Warning*&: If you use a lookup in the expansion to find the user's
25197 password, be sure to make the authentication fail if the user is unknown.
25198 There are good and bad examples at the end of the next section.
25199
25200
25201
25202 .section "The PLAIN authentication mechanism" "SECID172"
25203 .cindex "PLAIN authentication mechanism"
25204 .cindex "authentication" "PLAIN mechanism"
25205 .cindex "binary zero" "in &(plaintext)& authenticator"
25206 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25207 sent as one item of data (that is, one combined string containing two NUL
25208 separators). The data is sent either as part of the AUTH command, or
25209 subsequently in response to an empty prompt from the server.
25210
25211 The second and third strings are a user name and a corresponding password.
25212 Using a single fixed user name and password as an example, this could be
25213 configured as follows:
25214 .code
25215 fixed_plain:
25216   driver = plaintext
25217   public_name = PLAIN
25218   server_prompts = :
25219   server_condition = \
25220     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25221   server_set_id = $auth2
25222 .endd
25223 Note that the default result strings from &%if%& (&"true"& or an empty string)
25224 are exactly what we want here, so they need not be specified. Obviously, if the
25225 password contains expansion-significant characters such as dollar, backslash,
25226 or closing brace, they have to be escaped.
25227
25228 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25229 the end of a string list are ignored). If all the data comes as part of the
25230 AUTH command, as is commonly the case, the prompt is not used. This
25231 authenticator is advertised in the response to EHLO as
25232 .code
25233 250-AUTH PLAIN
25234 .endd
25235 and a client host can authenticate itself by sending the command
25236 .code
25237 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25238 .endd
25239 As this contains three strings (more than the number of prompts), no further
25240 data is required from the client. Alternatively, the client may just send
25241 .code
25242 AUTH PLAIN
25243 .endd
25244 to initiate authentication, in which case the server replies with an empty
25245 prompt. The client must respond with the combined data string.
25246
25247 The data string is base64 encoded, as required by the RFC. This example,
25248 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25249 represents a zero byte. This is split up into three strings, the first of which
25250 is empty. The &%server_condition%& option in the authenticator checks that the
25251 second two are &`username`& and &`mysecret`& respectively.
25252
25253 Having just one fixed user name and password, as in this example, is not very
25254 realistic, though for a small organization with only a handful of
25255 authenticating clients it could make sense.
25256
25257 A more sophisticated instance of this authenticator could use the user name in
25258 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25259 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25260 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25261 This is an incorrect example:
25262 .code
25263 server_condition = \
25264   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25265 .endd
25266 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25267 which it then compares to the supplied password (&$auth3$&). Why is this example
25268 incorrect? It works fine for existing users, but consider what happens if a
25269 non-existent user name is given. The lookup fails, but as no success/failure
25270 strings are given for the lookup, it yields an empty string. Thus, to defeat
25271 the authentication, all a client has to do is to supply a non-existent user
25272 name and an empty password. The correct way of writing this test is:
25273 .code
25274 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25275   {${if eq{$value}{$auth3}}} {false}}
25276 .endd
25277 In this case, if the lookup succeeds, the result is checked; if the lookup
25278 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25279 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25280 always fails if its second argument is empty. However, the second way of
25281 writing the test makes the logic clearer.
25282
25283
25284 .section "The LOGIN authentication mechanism" "SECID173"
25285 .cindex "LOGIN authentication mechanism"
25286 .cindex "authentication" "LOGIN mechanism"
25287 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25288 in a number of programs. No data is sent with the AUTH command. Instead, a
25289 user name and password are supplied separately, in response to prompts. The
25290 plaintext authenticator can be configured to support this as in this example:
25291 .code
25292 fixed_login:
25293   driver = plaintext
25294   public_name = LOGIN
25295   server_prompts = User Name : Password
25296   server_condition = \
25297     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25298   server_set_id = $auth1
25299 .endd
25300 Because of the way plaintext operates, this authenticator accepts data supplied
25301 with the AUTH command (in contravention of the specification of LOGIN), but
25302 if the client does not supply it (as is the case for LOGIN clients), the prompt
25303 strings are used to obtain two data items.
25304
25305 Some clients are very particular about the precise text of the prompts. For
25306 example, Outlook Express is reported to recognize only &"Username:"& and
25307 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25308 strings. It uses the &%ldapauth%& expansion condition to check the user
25309 name and password by binding to an LDAP server:
25310 .code
25311 login:
25312   driver = plaintext
25313   public_name = LOGIN
25314   server_prompts = Username:: : Password::
25315   server_condition = ${if and{{ \
25316     !eq{}{$auth1} }{ \
25317     ldapauth{\
25318       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25319       pass=${quote:$auth2} \
25320       ldap://ldap.example.org/} }} }
25321   server_set_id = uid=$auth1,ou=people,o=example.org
25322 .endd
25323 We have to check that the username is not empty before using it, because LDAP
25324 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25325 operator to correctly quote the DN for authentication. However, the basic
25326 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25327 correct one to use for the password, because quoting is needed only to make
25328 the password conform to the Exim syntax. At the LDAP level, the password is an
25329 uninterpreted string.
25330
25331
25332 .section "Support for different kinds of authentication" "SECID174"
25333 A number of string expansion features are provided for the purpose of
25334 interfacing to different ways of user authentication. These include checking
25335 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25336 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25337 &<<SECTexpcond>>&.
25338
25339
25340
25341
25342 .section "Using plaintext in a client" "SECID175"
25343 .cindex "options" "&(plaintext)& authenticator (client)"
25344 The &(plaintext)& authenticator has two client options:
25345
25346 .option client_ignore_invalid_base64 plaintext boolean false
25347 If the client receives a server prompt that is not a valid base64 string,
25348 authentication is abandoned by default. However, if this option is set true,
25349 the error in the challenge is ignored and the client sends the response as
25350 usual.
25351
25352 .option client_send plaintext string&!! unset
25353 The string is a colon-separated list of authentication data strings. Each
25354 string is independently expanded before being sent to the server. The first
25355 string is sent with the AUTH command; any more strings are sent in response
25356 to prompts from the server. Before each string is expanded, the value of the
25357 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25358 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25359 way. Thus, the prompt that is received in response to sending the first string
25360 (with the AUTH command) can be used in the expansion of the second string, and
25361 so on. If an invalid base64 string is received when
25362 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25363 &$auth$&<&'n'&> variable.
25364
25365 &*Note*&: You cannot use expansion to create multiple strings, because
25366 splitting takes priority and happens first.
25367
25368 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25369 the data, further processing is applied to each string before it is sent. If
25370 there are any single circumflex characters in the string, they are converted to
25371 NULs. Should an actual circumflex be required as data, it must be doubled in
25372 the string.
25373
25374 This is an example of a client configuration that implements the PLAIN
25375 authentication mechanism with a fixed user name and password:
25376 .code
25377 fixed_plain:
25378   driver = plaintext
25379   public_name = PLAIN
25380   client_send = ^username^mysecret
25381 .endd
25382 The lack of colons means that the entire text is sent with the AUTH
25383 command, with the circumflex characters converted to NULs. A similar example
25384 that uses the LOGIN mechanism is:
25385 .code
25386 fixed_login:
25387   driver = plaintext
25388   public_name = LOGIN
25389   client_send = : username : mysecret
25390 .endd
25391 The initial colon means that the first string is empty, so no data is sent with
25392 the AUTH command itself. The remaining strings are sent in response to
25393 prompts.
25394 .ecindex IIDplaiauth1
25395 .ecindex IIDplaiauth2
25396
25397
25398
25399
25400 . ////////////////////////////////////////////////////////////////////////////
25401 . ////////////////////////////////////////////////////////////////////////////
25402
25403 .chapter "The cram_md5 authenticator" "CHID9"
25404 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25405 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25406 .cindex "CRAM-MD5 authentication mechanism"
25407 .cindex "authentication" "CRAM-MD5 mechanism"
25408 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25409 sends a challenge string to the client, and the response consists of a user
25410 name and the CRAM-MD5 digest of the challenge string combined with a secret
25411 string (password) which is known to both server and client. Thus, the secret
25412 is not sent over the network as plain text, which makes this authenticator more
25413 secure than &(plaintext)&. However, the downside is that the secret has to be
25414 available in plain text at either end.
25415
25416
25417 .section "Using cram_md5 as a server" "SECID176"
25418 .cindex "options" "&(cram_md5)& authenticator (server)"
25419 This authenticator has one server option, which must be set to configure the
25420 authenticator as a server:
25421
25422 .option server_secret cram_md5 string&!! unset
25423 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25424 When the server receives the client's response, the user name is placed in
25425 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25426 obtain the password for that user. The server then computes the CRAM-MD5 digest
25427 that the client should have sent, and checks that it received the correct
25428 string. If the expansion of &%server_secret%& is forced to fail, authentication
25429 fails. If the expansion fails for some other reason, a temporary error code is
25430 returned to the client.
25431
25432 For compatibility with previous releases of Exim, the user name is also placed
25433 in &$1$&. However, the use of this variables for this purpose is now
25434 deprecated, as it can lead to confusion in string expansions that also use
25435 numeric variables for other things.
25436
25437 For example, the following authenticator checks that the user name given by the
25438 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25439 user name, authentication fails.
25440 .code
25441 fixed_cram:
25442   driver = cram_md5
25443   public_name = CRAM-MD5
25444   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25445   server_set_id = $auth1
25446 .endd
25447 .vindex "&$authenticated_id$&"
25448 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25449 name in &$authenticated_id$&. A more typical configuration might look up the
25450 secret string in a file, using the user name as the key. For example:
25451 .code
25452 lookup_cram:
25453   driver = cram_md5
25454   public_name = CRAM-MD5
25455   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25456                   {$value}fail}
25457   server_set_id = $auth1
25458 .endd
25459 Note that this expansion explicitly forces failure if the lookup fails
25460 because &$auth1$& contains an unknown user name.
25461
25462 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25463 using the relevant libraries, you need to know the realm to specify in the
25464 lookup and then ask for the &"userPassword"& attribute for that user in that
25465 realm, with:
25466 .code
25467 cyrusless_crammd5:
25468   driver = cram_md5
25469   public_name = CRAM-MD5
25470   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25471                   dbmjz{/etc/sasldb2}}
25472   server_set_id = $auth1
25473 .endd
25474
25475 .section "Using cram_md5 as a client" "SECID177"
25476 .cindex "options" "&(cram_md5)& authenticator (client)"
25477 When used as a client, the &(cram_md5)& authenticator has two options:
25478
25479
25480
25481 .option client_name cram_md5 string&!! "the primary host name"
25482 This string is expanded, and the result used as the user name data when
25483 computing the response to the server's challenge.
25484
25485
25486 .option client_secret cram_md5 string&!! unset
25487 This option must be set for the authenticator to work as a client. Its value is
25488 expanded and the result used as the secret string when computing the response.
25489
25490
25491 .vindex "&$host$&"
25492 .vindex "&$host_address$&"
25493 Different user names and secrets can be used for different servers by referring
25494 to &$host$& or &$host_address$& in the options. Forced failure of either
25495 expansion string is treated as an indication that this authenticator is not
25496 prepared to handle this case. Exim moves on to the next configured client
25497 authenticator. Any other expansion failure causes Exim to give up trying to
25498 send the message to the current server.
25499
25500 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25501 strings, is:
25502 .code
25503 fixed_cram:
25504   driver = cram_md5
25505   public_name = CRAM-MD5
25506   client_name = ph10
25507   client_secret = secret
25508 .endd
25509 .ecindex IIDcramauth1
25510 .ecindex IIDcramauth2
25511
25512
25513
25514 . ////////////////////////////////////////////////////////////////////////////
25515 . ////////////////////////////////////////////////////////////////////////////
25516
25517 .chapter "The cyrus_sasl authenticator" "CHID10"
25518 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25519 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25520 .cindex "Cyrus" "SASL library"
25521 .cindex "Kerberos"
25522 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25523 Digital Ltd (&url(http://www.aldigital.co.uk)).
25524
25525 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25526 library implementation of the RFC 2222 (&"Simple Authentication and Security
25527 Layer"&). This library supports a number of authentication mechanisms,
25528 including PLAIN and LOGIN, but also several others that Exim does not support
25529 directly. In particular, there is support for Kerberos authentication.
25530
25531 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25532 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25533 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25534 name of the driver to determine which mechanism to support.
25535
25536 Where access to some kind of secret file is required, for example in GSSAPI
25537 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25538 user, and that the Cyrus SASL library has no way of escalating privileges
25539 by default. You may also find you need to set environment variables,
25540 depending on the driver you are using.
25541
25542 The application name provided by Exim is &"exim"&, so various SASL options may
25543 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25544 Kerberos, note that because of limitations in the GSSAPI interface,
25545 changing the server keytab might need to be communicated down to the Kerberos
25546 layer independently. The mechanism for doing so is dependent upon the Kerberos
25547 implementation.
25548
25549 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25550 may be set to point to an alternative keytab file. Exim will pass this
25551 variable through from its own inherited environment when started as root or the
25552 Exim user. The keytab file needs to be readable by the Exim user.
25553 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25554 environment variable.  In practice, for those releases, the Cyrus authenticator
25555 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25556 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25557
25558
25559 .section "Using cyrus_sasl as a server" "SECID178"
25560 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25561 (on a successful authentication) into &$auth1$&. For compatibility with
25562 previous releases of Exim, the username is also placed in &$1$&. However, the
25563 use of this variable for this purpose is now deprecated, as it can lead to
25564 confusion in string expansions that also use numeric variables for other
25565 things.
25566
25567
25568 .option server_hostname cyrus_sasl string&!! "see below"
25569 This option selects the hostname that is used when communicating with the
25570 library. The default value is &`$primary_hostname`&. It is up to the underlying
25571 SASL plug-in what it does with this data.
25572
25573
25574 .option server_mech cyrus_sasl string "see below"
25575 This option selects the authentication mechanism this driver should use. The
25576 default is the value of the generic &%public_name%& option. This option allows
25577 you to use a different underlying mechanism from the advertised name. For
25578 example:
25579 .code
25580 sasl:
25581   driver = cyrus_sasl
25582   public_name = X-ANYTHING
25583   server_mech = CRAM-MD5
25584   server_set_id = $auth1
25585 .endd
25586
25587 .option server_realm cyrus_sasl string&!! unset
25588 This specifies the SASL realm that the server claims to be in.
25589
25590
25591 .option server_service cyrus_sasl string &`smtp`&
25592 This is the SASL service that the server claims to implement.
25593
25594
25595 For straightforward cases, you do not need to set any of the authenticator's
25596 private options. All you need to do is to specify an appropriate mechanism as
25597 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25598 PLAIN, you could have two authenticators as follows:
25599 .code
25600 sasl_cram_md5:
25601   driver = cyrus_sasl
25602   public_name = CRAM-MD5
25603   server_set_id = $auth1
25604
25605 sasl_plain:
25606   driver = cyrus_sasl
25607   public_name = PLAIN
25608   server_set_id = $auth2
25609 .endd
25610 Cyrus SASL does implement the LOGIN authentication method, even though it is
25611 not a standard method. It is disabled by default in the source distribution,
25612 but it is present in many binary distributions.
25613 .ecindex IIDcyrauth1
25614 .ecindex IIDcyrauth2
25615
25616
25617
25618
25619 . ////////////////////////////////////////////////////////////////////////////
25620 . ////////////////////////////////////////////////////////////////////////////
25621 .chapter "The dovecot authenticator" "CHAPdovecot"
25622 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25623 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25624 This authenticator is an interface to the authentication facility of the
25625 Dovecot POP/IMAP server, which can support a number of authentication methods.
25626 Note that Dovecot must be configured to use auth-client not auth-userdb.
25627 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25628 to use the same mechanisms for SMTP authentication. This is a server
25629 authenticator only. There is only one option:
25630
25631 .option server_socket dovecot string unset
25632
25633 This option must specify the socket that is the interface to Dovecot
25634 authentication. The &%public_name%& option must specify an authentication
25635 mechanism that Dovecot is configured to support. You can have several
25636 authenticators for different mechanisms. For example:
25637 .code
25638 dovecot_plain:
25639   driver = dovecot
25640   public_name = PLAIN
25641   server_socket = /var/run/dovecot/auth-client
25642   server_set_id = $auth1
25643
25644 dovecot_ntlm:
25645   driver = dovecot
25646   public_name = NTLM
25647   server_socket = /var/run/dovecot/auth-client
25648   server_set_id = $auth1
25649 .endd
25650 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25651 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25652 option is passed in the Dovecot authentication command. If, for a TLS
25653 connection, a client certificate has been verified, the &"valid-client-cert"&
25654 option is passed. When authentication succeeds, the identity of the user
25655 who authenticated is placed in &$auth1$&.
25656 .ecindex IIDdcotauth1
25657 .ecindex IIDdcotauth2
25658
25659
25660 . ////////////////////////////////////////////////////////////////////////////
25661 . ////////////////////////////////////////////////////////////////////////////
25662 .chapter "The gsasl authenticator" "CHAPgsasl"
25663 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25664 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25665 .cindex "authentication" "GNU SASL"
25666 .cindex "authentication" "SASL"
25667 .cindex "authentication" "EXTERNAL"
25668 .cindex "authentication" "ANONYMOUS"
25669 .cindex "authentication" "PLAIN"
25670 .cindex "authentication" "LOGIN"
25671 .cindex "authentication" "DIGEST-MD5"
25672 .cindex "authentication" "CRAM-MD5"
25673 .cindex "authentication" "SCRAM-SHA-1"
25674 The &(gsasl)& authenticator provides server integration for the GNU SASL
25675 library and the mechanisms it provides.  This is new as of the 4.80 release
25676 and there are a few areas where the library does not let Exim smoothly
25677 scale to handle future authentication mechanisms, so no guarantee can be
25678 made that any particular new authentication mechanism will be supported
25679 without code changes in Exim.
25680
25681
25682 .option server_channelbinding gsasl boolean false
25683 Some authentication mechanisms are able to use external context at both ends
25684 of the session to bind the authentication to that context, and fail the
25685 authentication process if that context differs.  Specifically, some TLS
25686 ciphersuites can provide identifying information about the cryptographic
25687 context.
25688
25689 This means that certificate identity and verification becomes a non-issue,
25690 as a man-in-the-middle attack will cause the correct client and server to
25691 see different identifiers and authentication will fail.
25692
25693 This is currently only supported when using the GnuTLS library.  This is
25694 only usable by mechanisms which support "channel binding"; at time of
25695 writing, that's the SCRAM family.
25696
25697 This defaults off to ensure smooth upgrade across Exim releases, in case
25698 this option causes some clients to start failing.  Some future release
25699 of Exim may switch the default to be true.
25700
25701
25702 .option server_hostname gsasl string&!! "see below"
25703 This option selects the hostname that is used when communicating with the
25704 library. The default value is &`$primary_hostname`&.
25705 Some mechanisms will use this data.
25706
25707
25708 .option server_mech gsasl string "see below"
25709 This option selects the authentication mechanism this driver should use. The
25710 default is the value of the generic &%public_name%& option. This option allows
25711 you to use a different underlying mechanism from the advertised name. For
25712 example:
25713 .code
25714 sasl:
25715   driver = gsasl
25716   public_name = X-ANYTHING
25717   server_mech = CRAM-MD5
25718   server_set_id = $auth1
25719 .endd
25720
25721
25722 .option server_password gsasl string&!! unset
25723 Various mechanisms need access to the cleartext password on the server, so
25724 that proof-of-possession can be demonstrated on the wire, without sending
25725 the password itself.
25726
25727 The data available for lookup varies per mechanism.
25728 In all cases, &$auth1$& is set to the &'authentication id'&.
25729 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25730 if available, else the empty string.
25731 The &$auth3$& variable will always be the &'realm'& if available,
25732 else the empty string.
25733
25734 A forced failure will cause authentication to defer.
25735
25736 If using this option, it may make sense to set the &%server_condition%&
25737 option to be simply "true".
25738
25739
25740 .option server_realm gsasl string&!! unset
25741 This specifies the SASL realm that the server claims to be in.
25742 Some mechanisms will use this data.
25743
25744
25745 .option server_scram_iter gsasl string&!! unset
25746 This option provides data for the SCRAM family of mechanisms.
25747 &$auth1$& is not available at evaluation time.
25748 (This may change, as we receive feedback on use)
25749
25750
25751 .option server_scram_salt gsasl string&!! unset
25752 This option provides data for the SCRAM family of mechanisms.
25753 &$auth1$& is not available at evaluation time.
25754 (This may change, as we receive feedback on use)
25755
25756
25757 .option server_service gsasl string &`smtp`&
25758 This is the SASL service that the server claims to implement.
25759 Some mechanisms will use this data.
25760
25761
25762 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25763 .vindex "&$auth1$&, &$auth2$&, etc"
25764 These may be set when evaluating specific options, as detailed above.
25765 They will also be set when evaluating &%server_condition%&.
25766
25767 Unless otherwise stated below, the &(gsasl)& integration will use the following
25768 meanings for these variables:
25769
25770 .ilist
25771 .vindex "&$auth1$&"
25772 &$auth1$&: the &'authentication id'&
25773 .next
25774 .vindex "&$auth2$&"
25775 &$auth2$&: the &'authorization id'&
25776 .next
25777 .vindex "&$auth3$&"
25778 &$auth3$&: the &'realm'&
25779 .endlist
25780
25781 On a per-mechanism basis:
25782
25783 .ilist
25784 .cindex "authentication" "EXTERNAL"
25785 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25786 the &%server_condition%& option must be present.
25787 .next
25788 .cindex "authentication" "ANONYMOUS"
25789 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25790 the &%server_condition%& option must be present.
25791 .next
25792 .cindex "authentication" "GSSAPI"
25793 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25794 &$auth2$& will be set to the &'authorization id'&,
25795 the &%server_condition%& option must be present.
25796 .endlist
25797
25798 An &'anonymous token'& is something passed along as an unauthenticated
25799 identifier; this is analogous to FTP anonymous authentication passing an
25800 email address, or software-identifier@, as the "password".
25801
25802
25803 An example showing the password having the realm specified in the callback
25804 and demonstrating a Cyrus SASL to GSASL migration approach is:
25805 .code
25806 gsasl_cyrusless_crammd5:
25807   driver = gsasl
25808   public_name = CRAM-MD5
25809   server_realm = imap.example.org
25810   server_password = ${lookup{$auth1:$auth3:userPassword}\
25811                     dbmjz{/etc/sasldb2}{$value}fail}
25812   server_set_id = ${quote:$auth1}
25813   server_condition = yes
25814 .endd
25815
25816
25817 . ////////////////////////////////////////////////////////////////////////////
25818 . ////////////////////////////////////////////////////////////////////////////
25819
25820 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25821 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25822 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25823 .cindex "authentication" "GSSAPI"
25824 .cindex "authentication" "Kerberos"
25825 The &(heimdal_gssapi)& authenticator provides server integration for the
25826 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25827 reliably.
25828
25829 .option server_hostname heimdal_gssapi string&!! "see below"
25830 This option selects the hostname that is used, with &%server_service%&,
25831 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25832 identifier.  The default value is &`$primary_hostname`&.
25833
25834 .option server_keytab heimdal_gssapi string&!! unset
25835 If set, then Heimdal will not use the system default keytab (typically
25836 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25837 The value should be a pathname, with no &"file:"& prefix.
25838
25839 .option server_service heimdal_gssapi string&!! "smtp"
25840 This option specifies the service identifier used, in conjunction with
25841 &%server_hostname%&, for building the identifer for finding credentials
25842 from the keytab.
25843
25844
25845 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25846 Beware that these variables will typically include a realm, thus will appear
25847 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25848 not verified, so a malicious client can set it to anything.
25849
25850 The &$auth1$& field should be safely trustable as a value from the Key
25851 Distribution Center.  Note that these are not quite email addresses.
25852 Each identifier is for a role, and so the left-hand-side may include a
25853 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25854
25855 .vindex "&$auth1$&, &$auth2$&, etc"
25856 .ilist
25857 .vindex "&$auth1$&"
25858 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25859 .next
25860 .vindex "&$auth2$&"
25861 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25862 authentication.  If that was empty, this will also be set to the
25863 GSS Display Name.
25864 .endlist
25865
25866
25867 . ////////////////////////////////////////////////////////////////////////////
25868 . ////////////////////////////////////////////////////////////////////////////
25869
25870 .chapter "The spa authenticator" "CHAPspa"
25871 .scindex IIDspaauth1 "&(spa)& authenticator"
25872 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25873 .cindex "authentication" "Microsoft Secure Password"
25874 .cindex "authentication" "NTLM"
25875 .cindex "Microsoft Secure Password Authentication"
25876 .cindex "NTLM authentication"
25877 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25878 Password Authentication'& mechanism,
25879 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25880 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25881 taken from the Samba project (&url(http://www.samba.org)). The code for the
25882 server side was subsequently contributed by Tom Kistner. The mechanism works as
25883 follows:
25884
25885 .ilist
25886 After the AUTH command has been accepted, the client sends an SPA
25887 authentication request based on the user name and optional domain.
25888 .next
25889 The server sends back a challenge.
25890 .next
25891 The client builds a challenge response which makes use of the user's password
25892 and sends it to the server, which then accepts or rejects it.
25893 .endlist
25894
25895 Encryption is used to protect the password in transit.
25896
25897
25898
25899 .section "Using spa as a server" "SECID179"
25900 .cindex "options" "&(spa)& authenticator (server)"
25901 The &(spa)& authenticator has just one server option:
25902
25903 .option server_password spa string&!! unset
25904 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25905 This option is expanded, and the result must be the cleartext password for the
25906 authenticating user, whose name is at this point in &$auth1$&. For
25907 compatibility with previous releases of Exim, the user name is also placed in
25908 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25909 it can lead to confusion in string expansions that also use numeric variables
25910 for other things. For example:
25911 .code
25912 spa:
25913   driver = spa
25914   public_name = NTLM
25915   server_password = \
25916     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25917 .endd
25918 If the expansion is forced to fail, authentication fails. Any other expansion
25919 failure causes a temporary error code to be returned.
25920
25921
25922
25923
25924
25925 .section "Using spa as a client" "SECID180"
25926 .cindex "options" "&(spa)& authenticator (client)"
25927 The &(spa)& authenticator has the following client options:
25928
25929
25930
25931 .option client_domain spa string&!! unset
25932 This option specifies an optional domain for the authentication.
25933
25934
25935 .option client_password spa string&!! unset
25936 This option specifies the user's password, and must be set.
25937
25938
25939 .option client_username spa string&!! unset
25940 This option specifies the user name, and must be set. Here is an example of a
25941 configuration of this authenticator for use with the mail servers at
25942 &'msn.com'&:
25943 .code
25944 msn:
25945   driver = spa
25946   public_name = MSN
25947   client_username = msn/msn_username
25948   client_password = msn_plaintext_password
25949   client_domain = DOMAIN_OR_UNSET
25950 .endd
25951 .ecindex IIDspaauth1
25952 .ecindex IIDspaauth2
25953
25954
25955
25956
25957
25958 . ////////////////////////////////////////////////////////////////////////////
25959 . ////////////////////////////////////////////////////////////////////////////
25960
25961 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25962          "Encrypted SMTP connections"
25963 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25964 .scindex IIDencsmtp2 "SMTP" "encryption"
25965 .cindex "TLS" "on SMTP connection"
25966 .cindex "OpenSSL"
25967 .cindex "GnuTLS"
25968 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25969 Sockets Layer), is implemented by making use of the OpenSSL library or the
25970 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25971 cryptographic code in the Exim distribution itself for implementing TLS. In
25972 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25973 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25974 You also need to understand the basic concepts of encryption at a managerial
25975 level, and in particular, the way that public keys, private keys, and
25976 certificates are used.
25977
25978 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25979 connection is established, the client issues a STARTTLS command. If the
25980 server accepts this, the client and the server negotiate an encryption
25981 mechanism. If the negotiation succeeds, the data that subsequently passes
25982 between them is encrypted.
25983
25984 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25985 and if so, what cipher suite is in use, whether the client supplied a
25986 certificate, and whether or not that certificate was verified. This makes it
25987 possible for an Exim server to deny or accept certain commands based on the
25988 encryption state.
25989
25990 &*Warning*&: Certain types of firewall and certain anti-virus products can
25991 disrupt TLS connections. You need to turn off SMTP scanning for these products
25992 in order to get TLS to work.
25993
25994
25995
25996 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25997          "SECID284"
25998 .cindex "ssmtp protocol"
25999 .cindex "smtps protocol"
26000 .cindex "SMTP" "ssmtp protocol"
26001 .cindex "SMTP" "smtps protocol"
26002 Early implementations of encrypted SMTP used a different TCP port from normal
26003 SMTP, and expected an encryption negotiation to start immediately, instead of
26004 waiting for a STARTTLS command from the client using the standard SMTP
26005 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26006 allocated for this purpose.
26007
26008 This approach was abandoned when encrypted SMTP was standardized, but there are
26009 still some legacy clients that use it. Exim supports these clients by means of
26010 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26011 numbers; the most common use is expected to be:
26012 .code
26013 tls_on_connect_ports = 465
26014 .endd
26015 The port numbers specified by this option apply to all SMTP connections, both
26016 via the daemon and via &'inetd'&. You still need to specify all the ports that
26017 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26018 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26019 an extra port &-- rather, it specifies different behaviour on a port that is
26020 defined elsewhere.
26021
26022 There is also a &%-tls-on-connect%& command line option. This overrides
26023 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26024
26025
26026
26027
26028
26029
26030 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26031 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26032 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26033 followed later, when the first versions of GnuTLS were released. To build Exim
26034 to use GnuTLS, you need to set
26035 .code
26036 USE_GNUTLS=yes
26037 .endd
26038 in Local/Makefile, in addition to
26039 .code
26040 SUPPORT_TLS=yes
26041 .endd
26042 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26043 include files and libraries for GnuTLS can be found.
26044
26045 There are some differences in usage when using GnuTLS instead of OpenSSL:
26046
26047 .ilist
26048 The &%tls_verify_certificates%& option
26049 cannot be the path of a directory
26050 for GnuTLS versions before 3.3.6
26051 (for later versions, or OpenSSL, it can be either).
26052 .next
26053 The default value for &%tls_dhparam%& differs for historical reasons.
26054 .next
26055 .vindex "&$tls_in_peerdn$&"
26056 .vindex "&$tls_out_peerdn$&"
26057 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26058 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26059 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26060 .next
26061 OpenSSL identifies cipher suites using hyphens as separators, for example:
26062 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26063 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26064 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26065 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26066 to handle its own older variants) when processing lists of cipher suites in the
26067 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26068 option).
26069 .next
26070 The &%tls_require_ciphers%& options operate differently, as described in the
26071 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26072 .next
26073 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26074 When using OpenSSL, this option is ignored.
26075 (If an API is found to let OpenSSL be configured in this way,
26076 let the Exim Maintainers know and we'll likely use it).
26077 .next
26078 Some other recently added features may only be available in one or the other.
26079 This should be documented with the feature.  If the documentation does not
26080 explicitly state that the feature is infeasible in the other TLS
26081 implementation, then patches are welcome.
26082 .endlist
26083
26084
26085 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26086 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26087 an explicit path; if the latter, then the text about generation still applies,
26088 but not the chosen filename.
26089 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26090 See the documentation of &%tls_dhparam%& for more information.
26091
26092 GnuTLS uses D-H parameters that may take a substantial amount of time
26093 to compute. It is unreasonable to re-compute them for every TLS session.
26094 Therefore, Exim keeps this data in a file in its spool directory, called
26095 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26096 of bits requested.
26097 The file is owned by the Exim user and is readable only by
26098 its owner. Every Exim process that start up GnuTLS reads the D-H
26099 parameters from this file. If the file does not exist, the first Exim process
26100 that needs it computes the data and writes it to a temporary file which is
26101 renamed once it is complete. It does not matter if several Exim processes do
26102 this simultaneously (apart from wasting a few resources). Once a file is in
26103 place, new Exim processes immediately start using it.
26104
26105 For maximum security, the parameters that are stored in this file should be
26106 recalculated periodically, the frequency depending on your paranoia level.
26107 If you are avoiding using the fixed D-H primes published in RFCs, then you
26108 are concerned about some advanced attacks and will wish to do this; if you do
26109 not regenerate then you might as well stick to the standard primes.
26110
26111 Arranging this is easy in principle; just delete the file when you want new
26112 values to be computed. However, there may be a problem. The calculation of new
26113 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26114 If the system is not very active, &_/dev/random_& may delay returning data
26115 until enough randomness (entropy) is available. This may cause Exim to hang for
26116 a substantial amount of time, causing timeouts on incoming connections.
26117
26118 The solution is to generate the parameters externally to Exim. They are stored
26119 in &_gnutls-params-N_& in PEM format, which means that they can be
26120 generated externally using the &(certtool)& command that is part of GnuTLS.
26121
26122 To replace the parameters with new ones, instead of deleting the file
26123 and letting Exim re-create it, you can generate new parameters using
26124 &(certtool)& and, when this has been done, replace Exim's cache file by
26125 renaming. The relevant commands are something like this:
26126 .code
26127 # ls
26128 [ look for file; assume gnutls-params-2236 is the most recent ]
26129 # rm -f new-params
26130 # touch new-params
26131 # chown exim:exim new-params
26132 # chmod 0600 new-params
26133 # certtool --generate-dh-params --bits 2236 >>new-params
26134 # openssl dhparam -noout -text -in new-params | head
26135 [ check the first line, make sure it's not more than 2236;
26136   if it is, then go back to the start ("rm") and repeat
26137   until the size generated is at most the size requested ]
26138 # chmod 0400 new-params
26139 # mv new-params gnutls-params-2236
26140 .endd
26141 If Exim never has to generate the parameters itself, the possibility of
26142 stalling is removed.
26143
26144 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26145 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26146 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26147 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26148 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26149 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26150 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26151 which applies to all D-H usage, client or server.  If the value returned by
26152 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26153 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26154 limit, which is still much higher than Exim historically used.
26155
26156 The filename and bits used will change as the GnuTLS maintainers change the
26157 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26158 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26159 2432 bits, while NSS is limited to 2236 bits.
26160
26161 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26162 increase the chance of the generated prime actually being within acceptable
26163 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26164 procedure above.  There is no sane procedure available to Exim to double-check
26165 the size of the generated prime, so it might still be too large.
26166
26167
26168 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26169 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26170 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26171 There is a function in the OpenSSL library that can be passed a list of cipher
26172 suites before the cipher negotiation takes place. This specifies which ciphers
26173 are acceptable. The list is colon separated and may contain names like
26174 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26175 directly to this function call.
26176 Many systems will install the OpenSSL manual-pages, so you may have
26177 &'ciphers(1)'& available to you.
26178 The following quotation from the OpenSSL
26179 documentation specifies what forms of item are allowed in the cipher string:
26180
26181 .ilist
26182 It can consist of a single cipher suite such as RC4-SHA.
26183 .next
26184 It can represent a list of cipher suites containing a certain algorithm,
26185 or cipher suites of a certain type. For example SHA1 represents all
26186 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26187 SSL v3 algorithms.
26188 .next
26189 Lists of cipher suites can be combined in a single cipher string using
26190 the + character. This is used as a logical and operation. For example
26191 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26192 algorithms.
26193 .endlist
26194
26195 Each cipher string can be optionally preceded by one of the characters &`!`&,
26196 &`-`& or &`+`&.
26197 .ilist
26198 If &`!`& is used, the ciphers are permanently deleted from the list. The
26199 ciphers deleted can never reappear in the list even if they are explicitly
26200 stated.
26201 .next
26202 If &`-`& is used, the ciphers are deleted from the list, but some or all
26203 of the ciphers can be added again by later options.
26204 .next
26205 If &`+`& is used, the ciphers are moved to the end of the list. This
26206 option does not add any new ciphers; it just moves matching existing ones.
26207 .endlist
26208
26209 If none of these characters is present, the string is interpreted as
26210 a list of ciphers to be appended to the current preference list. If the list
26211 includes any ciphers already present they will be ignored: that is, they will
26212 not be moved to the end of the list.
26213 .endlist
26214
26215 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26216 string:
26217 .code
26218 # note single-quotes to get ! past any shell history expansion
26219 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26220 .endd
26221
26222 This example will let the library defaults be permitted on the MX port, where
26223 there's probably no identity verification anyway, but ups the ante on the
26224 submission ports where the administrator might have some influence on the
26225 choice of clients used:
26226 .code
26227 # OpenSSL variant; see man ciphers(1)
26228 tls_require_ciphers = ${if =={$received_port}{25}\
26229                            {DEFAULT}\
26230                            {HIGH:!MD5:!SHA1}}
26231 .endd
26232
26233
26234
26235 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26236          "SECTreqciphgnu"
26237 .cindex "GnuTLS" "specifying parameters for"
26238 .cindex "TLS" "specifying ciphers (GnuTLS)"
26239 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26240 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26241 .cindex "TLS" "specifying protocols (GnuTLS)"
26242 .cindex "TLS" "specifying priority string (GnuTLS)"
26243 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26244 The GnuTLS library allows the caller to provide a "priority string", documented
26245 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26246 ciphersuite specification in OpenSSL.
26247
26248 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26249 and controls both protocols and ciphers.
26250
26251 The &%tls_require_ciphers%& option is available both as an global option,
26252 controlling how Exim behaves as a server, and also as an option of the
26253 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26254 the value is string expanded.  The resulting string is not an Exim list and
26255 the string is given to the GnuTLS library, so that Exim does not need to be
26256 aware of future feature enhancements of GnuTLS.
26257
26258 Documentation of the strings accepted may be found in the GnuTLS manual, under
26259 "Priority strings".  This is online as
26260 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26261 but beware that this relates to GnuTLS 3, which may be newer than the version
26262 installed on your system.  If you are using GnuTLS 3,
26263 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26264 on that site can be used to test a given string.
26265
26266 For example:
26267 .code
26268 # Disable older versions of protocols
26269 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26270 .endd
26271
26272 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26273 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26274 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26275
26276 This example will let the library defaults be permitted on the MX port, where
26277 there's probably no identity verification anyway, and lowers security further
26278 by increasing compatibility; but this ups the ante on the submission ports
26279 where the administrator might have some influence on the choice of clients
26280 used:
26281 .code
26282 # GnuTLS variant
26283 tls_require_ciphers = ${if =={$received_port}{25}\
26284                            {NORMAL:%COMPAT}\
26285                            {SECURE128}}
26286 .endd
26287
26288
26289 .section "Configuring an Exim server to use TLS" "SECID182"
26290 .cindex "TLS" "configuring an Exim server"
26291 When Exim has been built with TLS support, it advertises the availability of
26292 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26293 but not to any others. The default value of this option is unset, which means
26294 that STARTTLS is not advertised at all. This default is chosen because you
26295 need to set some other options in order to make TLS available, and also it is
26296 sensible for systems that want to use TLS only as a client.
26297
26298 If a client issues a STARTTLS command and there is some configuration
26299 problem in the server, the command is rejected with a 454 error. If the client
26300 persists in trying to issue SMTP commands, all except QUIT are rejected
26301 with the error
26302 .code
26303 554 Security failure
26304 .endd
26305 If a STARTTLS command is issued within an existing TLS session, it is
26306 rejected with a 554 error code.
26307
26308 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26309 match some hosts. You can, of course, set it to * to match all hosts.
26310 However, this is not all you need to do. TLS sessions to a server won't work
26311 without some further configuration at the server end.
26312
26313 It is rumoured that all existing clients that support TLS/SSL use RSA
26314 encryption. To make this work you need to set, in the server,
26315 .code
26316 tls_certificate = /some/file/name
26317 tls_privatekey = /some/file/name
26318 .endd
26319 These options are, in fact, expanded strings, so you can make them depend on
26320 the identity of the client that is connected if you wish. The first file
26321 contains the server's X509 certificate, and the second contains the private key
26322 that goes with it. These files need to be
26323 PEM format and readable by the Exim user, and must
26324 always be given as full path names.
26325 The key must not be password-protected.
26326 They can be the same file if both the
26327 certificate and the key are contained within it. If &%tls_privatekey%& is not
26328 set, or if its expansion is forced to fail or results in an empty string, this
26329 is assumed to be the case. The certificate file may also contain intermediate
26330 certificates that need to be sent to the client to enable it to authenticate
26331 the server's certificate.
26332
26333 If you do not understand about certificates and keys, please try to find a
26334 source of this background information, which is not Exim-specific. (There are a
26335 few comments below in section &<<SECTcerandall>>&.)
26336
26337 &*Note*&: These options do not apply when Exim is operating as a client &--
26338 they apply only in the case of a server. If you need to use a certificate in an
26339 Exim client, you must set the options of the same names in an &(smtp)&
26340 transport.
26341
26342 With just these options, an Exim server will be able to use TLS. It does not
26343 require the client to have a certificate (but see below for how to insist on
26344 this). There is one other option that may be needed in other situations. If
26345 .code
26346 tls_dhparam = /some/file/name
26347 .endd
26348 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26349 with the parameters contained in the file.
26350 Set this to &`none`& to disable use of DH entirely, by making no prime
26351 available:
26352 .code
26353 tls_dhparam = none
26354 .endd
26355 This may also be set to a string identifying a standard prime to be used for
26356 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26357 used is &`ike23`&.  There are a few standard primes available, see the
26358 documentation for &%tls_dhparam%& for the complete list.
26359
26360 See the command
26361 .code
26362 openssl dhparam
26363 .endd
26364 for a way of generating file data.
26365
26366 The strings supplied for these three options are expanded every time a client
26367 host connects. It is therefore possible to use different certificates and keys
26368 for different hosts, if you so wish, by making use of the client's IP address
26369 in &$sender_host_address$& to control the expansion. If a string expansion is
26370 forced to fail, Exim behaves as if the option is not set.
26371
26372 .cindex "cipher" "logging"
26373 .cindex "log" "TLS cipher"
26374 .vindex "&$tls_in_cipher$&"
26375 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26376 an incoming TLS connection. It is included in the &'Received:'& header of an
26377 incoming message (by default &-- you can, of course, change this), and it is
26378 also included in the log line that records a message's arrival, keyed by
26379 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26380 condition can be used to test for specific cipher suites in ACLs.
26381
26382 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26383 can check the name of the cipher suite and vary their actions accordingly. The
26384 cipher suite names vary, depending on which TLS library is being used. For
26385 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26386 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26387 documentation for more details.
26388
26389 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26390 (again depending on the &%tls_cipher%& log selector).
26391
26392
26393 .section "Requesting and verifying client certificates" "SECID183"
26394 .cindex "certificate" "verification of client"
26395 .cindex "TLS" "client certificate verification"
26396 If you want an Exim server to request a certificate when negotiating a TLS
26397 session with a client, you must set either &%tls_verify_hosts%& or
26398 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26399 apply to all TLS connections. For any host that matches one of these options,
26400 Exim requests a certificate as part of the setup of the TLS session. The
26401 contents of the certificate are verified by comparing it with a list of
26402 expected certificates.
26403 .new
26404 These may be the system default set (depending on library version),
26405 .wen
26406 an explicit file or,
26407 depending on library version, a directory, identified by
26408 &%tls_verify_certificates%&.
26409
26410 A file can contain multiple certificates, concatenated end to end. If a
26411 directory is used
26412 (OpenSSL only),
26413 each certificate must be in a separate file, with a name (or a symbolic link)
26414 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26415 certificate. You can compute the relevant hash by running the command
26416 .code
26417 openssl x509 -hash -noout -in /cert/file
26418 .endd
26419 where &_/cert/file_& contains a single certificate.
26420
26421 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26422 what happens if the client does not supply a certificate, or if the certificate
26423 does not match any of the certificates in the collection named by
26424 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26425 attempt to set up a TLS session is aborted, and the incoming connection is
26426 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26427 session continues. ACLs that run for subsequent SMTP commands can detect the
26428 fact that no certificate was verified, and vary their actions accordingly. For
26429 example, you can insist on a certificate before accepting a message for
26430 relaying, but not when the message is destined for local delivery.
26431
26432 .vindex "&$tls_in_peerdn$&"
26433 When a client supplies a certificate (whether it verifies or not), the value of
26434 the Distinguished Name of the certificate is made available in the variable
26435 &$tls_in_peerdn$& during subsequent processing of the message.
26436
26437 .cindex "log" "distinguished name"
26438 Because it is often a long text string, it is not included in the log line or
26439 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26440 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26441 &%received_header_text%& to change the &'Received:'& header. When no
26442 certificate is supplied, &$tls_in_peerdn$& is empty.
26443
26444
26445 .section "Revoked certificates" "SECID184"
26446 .cindex "TLS" "revoked certificates"
26447 .cindex "revocation list"
26448 .cindex "certificate" "revocation list"
26449 .cindex "OCSP" "stapling"
26450 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26451 certificates are revoked. If you have such a list, you can pass it to an Exim
26452 server using the global option called &%tls_crl%& and to an Exim client using
26453 an identically named option for the &(smtp)& transport. In each case, the value
26454 of the option is expanded and must then be the name of a file that contains a
26455 CRL in PEM format.
26456 The downside is that clients have to periodically re-download a potentially huge
26457 file from every certificate authority they know of.
26458
26459 The way with most moving parts at query time is Online Certificate
26460 Status Protocol (OCSP), where the client verifies the certificate
26461 against an OCSP server run by the CA.  This lets the CA track all
26462 usage of the certs.  It requires running software with access to the
26463 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26464 is based on HTTP and can be proxied accordingly.
26465
26466 The only widespread OCSP server implementation (known to this writer)
26467 comes as part of OpenSSL and aborts on an invalid request, such as
26468 connecting to the port and then disconnecting.  This requires
26469 re-entering the passphrase each time some random client does this.
26470
26471 The third way is OCSP Stapling; in this, the server using a certificate
26472 issued by the CA periodically requests an OCSP proof of validity from
26473 the OCSP server, then serves it up inline as part of the TLS
26474 negotiation.   This approach adds no extra round trips, does not let the
26475 CA track users, scales well with number of certs issued by the CA and is
26476 resilient to temporary OCSP server failures, as long as the server
26477 starts retrying to fetch an OCSP proof some time before its current
26478 proof expires.  The downside is that it requires server support.
26479
26480 Unless Exim is built with the support disabled,
26481 or with GnuTLS earlier than version 3.1.3,
26482 support for OCSP stapling is included.
26483
26484 There is a global option called &%tls_ocsp_file%&.
26485 The file specified therein is expected to be in DER format, and contain
26486 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26487 option will be re-expanded for SNI, if the &%tls_certificate%& option
26488 contains &`tls_in_sni`&, as per other TLS options.
26489
26490 Exim does not at this time implement any support for fetching a new OCSP
26491 proof.  The burden is on the administrator to handle this, outside of
26492 Exim.  The file specified should be replaced atomically, so that the
26493 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26494 on each connection, so a new file will be handled transparently on the
26495 next connection.
26496
26497 When built with OpenSSL Exim will check for a valid next update timestamp
26498 in the OCSP proof; if not present, or if the proof has expired, it will be
26499 ignored.
26500
26501 For the client to be able to verify the stapled OCSP the server must
26502 also supply, in its stapled information, any intermediate
26503 certificates for the chain leading to the OCSP proof from the signer
26504 of the server certificate.  There may be zero or one such. These
26505 intermediate certificates should be added to the server OCSP stapling
26506 file named by &%tls_ocsp_file%&.
26507
26508 Note that the proof only covers the terminal server certificate,
26509 not any of the chain from CA to it.
26510
26511 There is no current way to staple a proof for a client certificate.
26512
26513 .code
26514   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26515   OCSP server is supplied.  The server URL may be included in the
26516   server certificate, if the CA is helpful.
26517
26518   One failure mode seen was the OCSP Signer cert expiring before the end
26519   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26520   noted this as invalid overall, but the re-fetch script did not.
26521 .endd
26522
26523
26524
26525
26526 .section "Configuring an Exim client to use TLS" "SECID185"
26527 .cindex "cipher" "logging"
26528 .cindex "log" "TLS cipher"
26529 .cindex "log" "distinguished name"
26530 .cindex "TLS" "configuring an Exim client"
26531 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26532 deliveries as well as to incoming, the latter one causing logging of the
26533 server certificate's DN. The remaining client configuration for TLS is all
26534 within the &(smtp)& transport.
26535
26536 It is not necessary to set any options to have TLS work in the &(smtp)&
26537 transport. If Exim is built with TLS support, and TLS is advertised by a
26538 server, the &(smtp)& transport always tries to start a TLS session. However,
26539 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26540 transport) to a list of server hosts for which TLS should not be used.
26541
26542 If you do not want Exim to attempt to send messages unencrypted when an attempt
26543 to set up an encrypted connection fails in any way, you can set
26544 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26545 those hosts, delivery is always deferred if an encrypted connection cannot be
26546 set up. If there are any other hosts for the address, they are tried in the
26547 usual way.
26548
26549 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26550 the message unencrypted. It always does this if the response to STARTTLS is
26551 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26552 session after a success response code, what happens is controlled by the
26553 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26554 delivery to this host is deferred, and other hosts (if available) are tried. If
26555 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26556 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26557 negotiation fails, Exim closes the current connection (because it is in an
26558 unknown state), opens a new one to the same host, and then tries the delivery
26559 unencrypted.
26560
26561 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26562 transport provide the client with a certificate, which is passed to the server
26563 if it requests it. If the server is Exim, it will request a certificate only if
26564 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26565
26566 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26567 specifies a collection of expected server certificates.
26568 .new
26569 These may be the system default set (depending on library version),
26570 .wen
26571 a file or,
26572 depnding on liibrary version, a directory,
26573 must name a file or,
26574 for OpenSSL only (not GnuTLS), a directory.
26575 The client verifies the server's certificate
26576 against this collection, taking into account any revoked certificates that are
26577 in the list defined by &%tls_crl%&.
26578 Failure to verify fails the TLS connection unless either of the
26579 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26580
26581 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26582 certificate verification to the listed servers.  Verification either must
26583 or need not succeed respectively.
26584
26585 The &(smtp)& transport has two OCSP-related options:
26586 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26587 is requested and required for the connection to proceed.  The default
26588 value is empty.
26589 &%hosts_request_ocsp%&; a host-list for which (additionally)
26590 a Certificate Status is requested (but not necessarily verified).  The default
26591 value is "*" meaning that requests are made unless configured
26592 otherwise.
26593
26594 The host(s) should also be in &%hosts_require_tls%&, and
26595 &%tls_verify_certificates%& configured for the transport,
26596 for OCSP to be relevant.
26597
26598 If
26599 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26600 list of permitted cipher suites. If either of these checks fails, delivery to
26601 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26602 alternative hosts, if any.
26603
26604  &*Note*&:
26605 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26606 is operating as a client. Exim does not assume that a server certificate (set
26607 by the global options of the same name) should also be used when operating as a
26608 client.
26609
26610 .vindex "&$host$&"
26611 .vindex "&$host_address$&"
26612 All the TLS options in the &(smtp)& transport are expanded before use, with
26613 &$host$& and &$host_address$& containing the name and address of the server to
26614 which the client is connected. Forced failure of an expansion causes Exim to
26615 behave as if the relevant option were unset.
26616
26617 .vindex &$tls_out_bits$&
26618 .vindex &$tls_out_cipher$&
26619 .vindex &$tls_out_peerdn$&
26620 .vindex &$tls_out_sni$&
26621 Before an SMTP connection is established, the
26622 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26623 variables are emptied. (Until the first connection, they contain the values
26624 that were set when the message was received.) If STARTTLS is subsequently
26625 successfully obeyed, these variables are set to the relevant values for the
26626 outgoing connection.
26627
26628
26629
26630 .section "Use of TLS Server Name Indication" "SECTtlssni"
26631 .cindex "TLS" "Server Name Indication"
26632 .vindex "&$tls_in_sni$&"
26633 .oindex "&%tls_in_sni%&"
26634 With TLS1.0 or above, there is an extension mechanism by which extra
26635 information can be included at various points in the protocol.  One of these
26636 extensions, documented in RFC 6066 (and before that RFC 4366) is
26637 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26638 client in the initial handshake, so that the server can examine the servername
26639 within and possibly choose to use different certificates and keys (and more)
26640 for this session.
26641
26642 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26643 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26644 address.
26645
26646 With SMTP to MX, there are the same problems here as in choosing the identity
26647 against which to validate a certificate: you can't rely on insecure DNS to
26648 provide the identity which you then cryptographically verify.  So this will
26649 be of limited use in that environment.
26650
26651 With SMTP to Submission, there is a well-defined hostname which clients are
26652 connecting to and can validate certificates against.  Thus clients &*can*&
26653 choose to include this information in the TLS negotiation.  If this becomes
26654 wide-spread, then hosters can choose to present different certificates to
26655 different clients.  Or even negotiate different cipher suites.
26656
26657 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26658 if not empty, will be sent on a TLS session as part of the handshake.  There's
26659 nothing more to it.  Choosing a sensible value not derived insecurely is the
26660 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26661 for the lifetime of the client connection (including during authentication).
26662
26663 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26664 received from a client.
26665 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26666
26667 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26668 option (prior to expansion) then the following options will be re-expanded
26669 during TLS session handshake, to permit alternative values to be chosen:
26670
26671 .ilist
26672 .vindex "&%tls_certificate%&"
26673 &%tls_certificate%&
26674 .next
26675 .vindex "&%tls_crl%&"
26676 &%tls_crl%&
26677 .next
26678 .vindex "&%tls_privatekey%&"
26679 &%tls_privatekey%&
26680 .next
26681 .vindex "&%tls_verify_certificates%&"
26682 &%tls_verify_certificates%&
26683 .next
26684 .vindex "&%tls_ocsp_file%&"
26685 &%tls_ocsp_file%&
26686 .endlist
26687
26688 Great care should be taken to deal with matters of case, various injection
26689 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26690 can always be referenced; it is important to remember that &$tls_sni$& is
26691 arbitrary unverified data provided prior to authentication.
26692
26693 The Exim developers are proceeding cautiously and so far no other TLS options
26694 are re-expanded.
26695
26696 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26697 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26698 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26699 see &`-servername`& in the output, then OpenSSL has support.
26700
26701 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26702 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26703 built, then you have SNI support).
26704
26705
26706
26707 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26708          "SECTmulmessam"
26709 .cindex "multiple SMTP deliveries with TLS"
26710 .cindex "TLS" "multiple message deliveries"
26711 Exim sends multiple messages down the same TCP/IP connection by starting up
26712 an entirely new delivery process for each message, passing the socket from
26713 one process to the next. This implementation does not fit well with the use
26714 of TLS, because there is quite a lot of state information associated with a TLS
26715 connection, not just a socket identification. Passing all the state information
26716 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26717 session before passing the socket to a new process. The new process may then
26718 try to start a new TLS session, and if successful, may try to re-authenticate
26719 if AUTH is in use, before sending the next message.
26720
26721 The RFC is not clear as to whether or not an SMTP session continues in clear
26722 after TLS has been shut down, or whether TLS may be restarted again later, as
26723 just described. However, if the server is Exim, this shutdown and
26724 reinitialization works. It is not known which (if any) other servers operate
26725 successfully if the client closes a TLS session and continues with unencrypted
26726 SMTP, but there are certainly some that do not work. For such servers, Exim
26727 should not pass the socket to another process, because the failure of the
26728 subsequent attempt to use it would cause Exim to record a temporary host error,
26729 and delay other deliveries to that host.
26730
26731 To test for this case, Exim sends an EHLO command to the server after
26732 closing down the TLS session. If this fails in any way, the connection is
26733 closed instead of being passed to a new delivery process, but no retry
26734 information is recorded.
26735
26736 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26737 &(smtp)& transport to match those hosts for which Exim should not pass
26738 connections to new processes if TLS has been used.
26739
26740
26741
26742
26743 .section "Certificates and all that" "SECTcerandall"
26744 .cindex "certificate" "references to discussion"
26745 In order to understand fully how TLS works, you need to know about
26746 certificates, certificate signing, and certificate authorities. This is not the
26747 place to give a tutorial, especially as I do not know very much about it
26748 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26749 to Apache, currently at
26750 .display
26751 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26752 .endd
26753 Other parts of the &'modssl'& documentation are also helpful, and have
26754 links to further files.
26755 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26756 0-201-61598-3), contains both introductory and more in-depth descriptions.
26757 Some sample programs taken from the book are available from
26758 .display
26759 &url(http://www.rtfm.com/openssl-examples/)
26760 .endd
26761
26762
26763 .section "Certificate chains" "SECID186"
26764 The file named by &%tls_certificate%& may contain more than one
26765 certificate. This is useful in the case where the certificate that is being
26766 sent is validated by an intermediate certificate which the other end does
26767 not have. Multiple certificates must be in the correct order in the file.
26768 First the host's certificate itself, then the first intermediate
26769 certificate to validate the issuer of the host certificate, then the next
26770 intermediate certificate to validate the issuer of the first intermediate
26771 certificate, and so on, until finally (optionally) the root certificate.
26772 The root certificate must already be trusted by the recipient for
26773 validation to succeed, of course, but if it's not preinstalled, sending the
26774 root certificate along with the rest makes it available for the user to
26775 install if the receiving end is a client MUA that can interact with a user.
26776
26777 Note that certificates using MD5 are unlikely to work on today's Internet;
26778 even if your libraries allow loading them for use in Exim when acting as a
26779 server, increasingly clients will not accept such certificates.  The error
26780 diagnostics in such a case can be frustratingly vague.
26781
26782
26783
26784 .section "Self-signed certificates" "SECID187"
26785 .cindex "certificate" "self-signed"
26786 You can create a self-signed certificate using the &'req'& command provided
26787 with OpenSSL, like this:
26788 . ==== Do not shorten the duration here without reading and considering
26789 . ==== the text below.  Please leave it at 9999 days.
26790 .code
26791 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26792             -days 9999 -nodes
26793 .endd
26794 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26795 delimited and so can be identified independently. The &%-days%& option
26796 specifies a period for which the certificate is valid. The &%-nodes%& option is
26797 important: if you do not set it, the key is encrypted with a passphrase
26798 that you are prompted for, and any use that is made of the key causes more
26799 prompting for the passphrase. This is not helpful if you are going to use
26800 this certificate and key in an MTA, where prompting is not possible.
26801
26802 . ==== I expect to still be working 26 years from now.  The less technical
26803 . ==== debt I create, in terms of storing up trouble for my later years, the
26804 . ==== happier I will be then.  We really have reached the point where we
26805 . ==== should start, at the very least, provoking thought and making folks
26806 . ==== pause before proceeding, instead of leaving all the fixes until two
26807 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26808 . ==== -pdp, 2012
26809 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26810 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26811 the above command might produce a date in the past.  Think carefully about
26812 the lifetime of the systems you're deploying, and either reduce the duration
26813 of the certificate or reconsider your platform deployment.  (At time of
26814 writing, reducing the duration is the most likely choice, but the inexorable
26815 progression of time takes us steadily towards an era where this will not
26816 be a sensible resolution).
26817
26818 A self-signed certificate made in this way is sufficient for testing, and
26819 may be adequate for all your requirements if you are mainly interested in
26820 encrypting transfers, and not in secure identification.
26821
26822 However, many clients require that the certificate presented by the server be a
26823 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26824 certificate. In this situation, the self-signed certificate described above
26825 must be installed on the client host as a trusted root &'certification
26826 authority'& (CA), and the certificate used by Exim must be a user certificate
26827 signed with that self-signed certificate.
26828
26829 For information on creating self-signed CA certificates and using them to sign
26830 user certificates, see the &'General implementation overview'& chapter of the
26831 Open-source PKI book, available online at
26832 &url(http://ospkibook.sourceforge.net/).
26833 .ecindex IIDencsmtp1
26834 .ecindex IIDencsmtp2
26835
26836
26837
26838 . ////////////////////////////////////////////////////////////////////////////
26839 . ////////////////////////////////////////////////////////////////////////////
26840
26841 .chapter "Access control lists" "CHAPACL"
26842 .scindex IIDacl "&ACL;" "description"
26843 .cindex "control of incoming mail"
26844 .cindex "message" "controlling incoming"
26845 .cindex "policy control" "access control lists"
26846 Access Control Lists (ACLs) are defined in a separate section of the run time
26847 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26848 name, terminated by a colon. Here is a complete ACL section that contains just
26849 one very small ACL:
26850 .code
26851 begin acl
26852 small_acl:
26853   accept   hosts = one.host.only
26854 .endd
26855 You can have as many lists as you like in the ACL section, and the order in
26856 which they appear does not matter. The lists are self-terminating.
26857
26858 The majority of ACLs are used to control Exim's behaviour when it receives
26859 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26860 when a local process submits a message using SMTP by specifying the &%-bs%&
26861 option. The most common use is for controlling which recipients are accepted
26862 in incoming messages. In addition, you can define an ACL that is used to check
26863 local non-SMTP messages. The default configuration file contains an example of
26864 a realistic ACL for checking RCPT commands. This is discussed in chapter
26865 &<<CHAPdefconfil>>&.
26866
26867
26868 .section "Testing ACLs" "SECID188"
26869 The &%-bh%& command line option provides a way of testing your ACL
26870 configuration locally by running a fake SMTP session with which you interact.
26871 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26872 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26873
26874
26875
26876 .section "Specifying when ACLs are used" "SECID189"
26877 .cindex "&ACL;" "options for specifying"
26878 In order to cause an ACL to be used, you have to name it in one of the relevant
26879 options in the main part of the configuration. These options are:
26880 .cindex "AUTH" "ACL for"
26881 .cindex "DATA" "ACLs for"
26882 .cindex "ETRN" "ACL for"
26883 .cindex "EXPN" "ACL for"
26884 .cindex "HELO" "ACL for"
26885 .cindex "EHLO" "ACL for"
26886 .cindex "MAIL" "ACL for"
26887 .cindex "QUIT, ACL for"
26888 .cindex "RCPT" "ACL for"
26889 .cindex "STARTTLS, ACL for"
26890 .cindex "VRFY" "ACL for"
26891 .cindex "SMTP" "connection, ACL for"
26892 .cindex "non-SMTP messages" "ACLs for"
26893 .cindex "MIME content scanning" "ACL for"
26894 .cindex "PRDR" "ACL for"
26895
26896 .table2 140pt
26897 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26898 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26899 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26900 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26901 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26902 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26903 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26904 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26905 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26906 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26907 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26908 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26909 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26910 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26911 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26912 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26913 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26914 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26915 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26916 .endtable
26917
26918 For example, if you set
26919 .code
26920 acl_smtp_rcpt = small_acl
26921 .endd
26922 the little ACL defined above is used whenever Exim receives a RCPT command
26923 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26924 done when RCPT commands arrive. A rejection of RCPT should cause the
26925 sending MTA to give up on the recipient address contained in the RCPT
26926 command, whereas rejection at other times may cause the client MTA to keep on
26927 trying to deliver the message. It is therefore recommended that you do as much
26928 testing as possible at RCPT time.
26929
26930
26931 .section "The non-SMTP ACLs" "SECID190"
26932 .cindex "non-SMTP messages" "ACLs for"
26933 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26934 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26935 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26936 the state of the SMTP connection such as encryption and authentication) are not
26937 relevant and are forbidden in these ACLs. However, the sender and recipients
26938 are known, so the &%senders%& and &%sender_domains%& conditions and the
26939 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26940 &$authenticated_sender$& are also available. You can specify added header lines
26941 in any of these ACLs.
26942
26943 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26944 non-SMTP message, before any of the message has been read. (This is the
26945 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26946 batched SMTP input, it runs after the DATA command has been reached. The
26947 result of this ACL is ignored; it cannot be used to reject a message. If you
26948 really need to, you could set a value in an ACL variable here and reject based
26949 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26950 controls, and in particular, it can be used to set
26951 .code
26952 control = suppress_local_fixups
26953 .endd
26954 This cannot be used in the other non-SMTP ACLs because by the time they are
26955 run, it is too late.
26956
26957 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26958 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26959
26960 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26961 kind of rejection is treated as permanent, because there is no way of sending a
26962 temporary error for these kinds of message.
26963
26964
26965 .section "The SMTP connect ACL" "SECID191"
26966 .cindex "SMTP" "connection, ACL for"
26967 .oindex &%smtp_banner%&
26968 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26969 session, after the test specified by &%host_reject_connection%& (which is now
26970 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26971 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26972 the message override the banner message that is otherwise specified by the
26973 &%smtp_banner%& option.
26974
26975
26976 .section "The EHLO/HELO ACL" "SECID192"
26977 .cindex "EHLO" "ACL for"
26978 .cindex "HELO" "ACL for"
26979 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26980 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26981 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26982 Note that a client may issue more than one EHLO or HELO command in an SMTP
26983 session, and indeed is required to issue a new EHLO or HELO after successfully
26984 setting up encryption following a STARTTLS command.
26985
26986 If the command is accepted by an &%accept%& verb that has a &%message%&
26987 modifier, the message may not contain more than one line (it will be truncated
26988 at the first newline and a panic logged if it does). Such a message cannot
26989 affect the EHLO options that are listed on the second and subsequent lines of
26990 an EHLO response.
26991
26992
26993 .section "The DATA ACLs" "SECID193"
26994 .cindex "DATA" "ACLs for"
26995 Two ACLs are associated with the DATA command, because it is two-stage
26996 command, with two responses being sent to the client.
26997 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26998 is obeyed. This gives you control after all the RCPT commands, but before
26999 the message itself is received. It offers the opportunity to give a negative
27000 response to the DATA command before the data is transmitted. Header lines
27001 added by MAIL or RCPT ACLs are not visible at this time, but any that
27002 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27003
27004 You cannot test the contents of the message, for example, to verify addresses
27005 in the headers, at RCPT time or when the DATA command is received. Such
27006 tests have to appear in the ACL that is run after the message itself has been
27007 received, before the final response to the DATA command is sent. This is
27008 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27009 associated with the DATA command.
27010
27011 For both of these ACLs, it is not possible to reject individual recipients. An
27012 error response rejects the entire message. Unfortunately, it is known that some
27013 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27014 before or after the data) correctly &-- they keep the message on their queues
27015 and try again later, but that is their problem, though it does waste some of
27016 your resources.
27017
27018 The &%acl_smtp_data%& ACL is run after
27019 the &%acl_smtp_data_prdr%&,
27020 the &%acl_smtp_dkim%&
27021 and the &%acl_smtp_mime%& ACLs.
27022
27023 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27024 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27025 enabled (which is the default).
27026
27027 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27028 received, and is executed for each DKIM signature found in a message.  If not
27029 otherwise specified, the default action is to accept.
27030
27031 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27032
27033 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27034
27035
27036 .section "The SMTP MIME ACL" "SECID194"
27037 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27038 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27039
27040 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27041
27042
27043 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27044 .cindex "PRDR" "ACL for"
27045 .oindex "&%prdr_enable%&"
27046 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27047 with PRDR support enabled (which is the default).
27048 It becomes active only when the PRDR feature is negotiated between
27049 client and server for a message, and more than one recipient
27050 has been accepted.
27051
27052 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27053 has been recieved, and is executed once for each recipient of the message
27054 with &$local_part$& and &$domain$& valid.
27055 The test may accept, defer or deny for inividual recipients.
27056 The &%acl_smtp_data%& will still be called after this ACL and
27057 can reject the message overall, even if this ACL has accepted it
27058 for some or all recipients.
27059
27060 PRDR may be used to support per-user content filtering.  Without it
27061 one must defer any recipient after the first that has a different
27062 content-filter configuration.  With PRDR, the RCPT-time check
27063 for this can be disabled when the MAIL-time $smtp_command included
27064 "PRDR".  Any required difference in behaviour of the main DATA-time
27065 ACL should however depend on the PRDR-time ACL having run, as Exim
27066 will avoid doing so in some situations (eg.  single-recipient mails).
27067
27068 See also the &%prdr_enable%& global option
27069 and the &%hosts_try_prdr%& smtp transport option.
27070
27071 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27072 If the ACL is not defined, processing completes as if
27073 the feature was not requested by the client.
27074
27075 .section "The QUIT ACL" "SECTQUITACL"
27076 .cindex "QUIT, ACL for"
27077 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27078 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27079 does not in fact control any access. For this reason, the only verbs that are
27080 permitted are &%accept%& and &%warn%&.
27081
27082 This ACL can be used for tasks such as custom logging at the end of an SMTP
27083 session. For example, you can use ACL variables in other ACLs to count
27084 messages, recipients, etc., and log the totals at QUIT time using one or
27085 more &%logwrite%& modifiers on a &%warn%& verb.
27086
27087 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27088 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27089
27090 You do not need to have a final &%accept%&, but if you do, you can use a
27091 &%message%& modifier to specify custom text that is sent as part of the 221
27092 response to QUIT.
27093
27094 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27095 failure (for example, failure to open a log file, or when Exim is bombing out
27096 because it has detected an unrecoverable error), all SMTP commands from the
27097 client are given temporary error responses until QUIT is received or the
27098 connection is closed. In these special cases, the QUIT ACL does not run.
27099
27100
27101 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27102 .vindex &$acl_smtp_notquit$&
27103 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27104 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27105 trouble, such as being unable to write to its log files, this ACL is not run,
27106 because it might try to do things (such as write to log files) that make the
27107 situation even worse.
27108
27109 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27110 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27111 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27112 and &%warn%&.
27113
27114 .vindex &$smtp_notquit_reason$&
27115 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27116 to a string that indicates the reason for the termination of the SMTP
27117 connection. The possible values are:
27118 .table2
27119 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27120 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27121 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27122 .irow &`connection-lost`&          "The SMTP connection has been lost"
27123 .irow &`data-timeout`&             "Timeout while reading message data"
27124 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27125 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27126 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27127 .irow &`synchronization-error`&    "SMTP synchronization error"
27128 .irow &`tls-failed`&               "TLS failed to start"
27129 .endtable
27130 In most cases when an SMTP connection is closed without having received QUIT,
27131 Exim sends an SMTP response message before actually closing the connection.
27132 With the exception of the &`acl-drop`& case, the default message can be
27133 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27134 &%drop%& verb in another ACL, it is the message from the other ACL that is
27135 used.
27136
27137
27138 .section "Finding an ACL to use" "SECID195"
27139 .cindex "&ACL;" "finding which to use"
27140 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27141 you can use different ACLs in different circumstances. For example,
27142 .code
27143 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27144                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27145 .endd
27146 In the default configuration file there are some example settings for
27147 providing an RFC 4409 message submission service on port 587 and a
27148 non-standard &"smtps"& service on port 465. You can use a string
27149 expansion like this to choose an ACL for MUAs on these ports which is
27150 more appropriate for this purpose than the default ACL on port 25.
27151
27152 The expanded string does not have to be the name of an ACL in the
27153 configuration file; there are other possibilities. Having expanded the
27154 string, Exim searches for an ACL as follows:
27155
27156 .ilist
27157 If the string begins with a slash, Exim uses it as a file name, and reads its
27158 contents as an ACL. The lines are processed in the same way as lines in the
27159 Exim configuration file. In particular, continuation lines are supported, blank
27160 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27161 If the file does not exist or cannot be read, an error occurs (typically
27162 causing a temporary failure of whatever caused the ACL to be run). For example:
27163 .code
27164 acl_smtp_data = /etc/acls/\
27165   ${lookup{$sender_host_address}lsearch\
27166   {/etc/acllist}{$value}{default}}
27167 .endd
27168 This looks up an ACL file to use on the basis of the host's IP address, falling
27169 back to a default if the lookup fails. If an ACL is successfully read from a
27170 file, it is retained in memory for the duration of the Exim process, so that it
27171 can be re-used without having to re-read the file.
27172 .next
27173 If the string does not start with a slash, and does not contain any spaces,
27174 Exim searches the ACL section of the configuration for an ACL whose name
27175 matches the string.
27176 .next
27177 If no named ACL is found, or if the string contains spaces, Exim parses
27178 the string as an inline ACL. This can save typing in cases where you just
27179 want to have something like
27180 .code
27181 acl_smtp_vrfy = accept
27182 .endd
27183 in order to allow free use of the VRFY command. Such a string may contain
27184 newlines; it is processed in the same way as an ACL that is read from a file.
27185 .endlist
27186
27187
27188
27189
27190 .section "ACL return codes" "SECID196"
27191 .cindex "&ACL;" "return codes"
27192 Except for the QUIT ACL, which does not affect the SMTP return code (see
27193 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27194 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27195 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27196 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27197 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27198 This also causes a 4&'xx'& return code.
27199
27200 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27201 &"deny"&, because there is no mechanism for passing temporary errors to the
27202 submitters of non-SMTP messages.
27203
27204
27205 ACLs that are relevant to message reception may also return &"discard"&. This
27206 has the effect of &"accept"&, but causes either the entire message or an
27207 individual recipient address to be discarded. In other words, it is a
27208 blackholing facility. Use it with care.
27209
27210 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27211 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27212 RCPT ACL is to discard just the one recipient address. If there are no
27213 recipients left when the message's data is received, the DATA ACL is not
27214 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27215 remaining recipients. The &"discard"& return is not permitted for the
27216 &%acl_smtp_predata%& ACL.
27217
27218
27219 .cindex "&[local_scan()]& function" "when all recipients discarded"
27220 The &[local_scan()]& function is always run, even if there are no remaining
27221 recipients; it may create new recipients.
27222
27223
27224
27225 .section "Unset ACL options" "SECID197"
27226 .cindex "&ACL;" "unset options"
27227 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27228 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27229 not defined at all. For any defined ACL, the default action when control
27230 reaches the end of the ACL statements is &"deny"&.
27231
27232 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27233 these two are ACLs that are used only for their side effects. They cannot be
27234 used to accept or reject anything.
27235
27236 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27237 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27238 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27239 when the ACL is not defined is &"accept"&.
27240
27241 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27242 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27243 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27244 messages over an SMTP connection. For an example, see the ACL in the default
27245 configuration file.
27246
27247
27248
27249
27250 .section "Data for message ACLs" "SECID198"
27251 .cindex "&ACL;" "data for message ACL"
27252 .vindex &$domain$&
27253 .vindex &$local_part$&
27254 .vindex &$sender_address$&
27255 .vindex &$sender_host_address$&
27256 .vindex &$smtp_command$&
27257 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27258 that contain information about the host and the message's sender (for example,
27259 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27260 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27261 &$local_part$& are set from the argument address. The entire SMTP command
27262 is available in &$smtp_command$&.
27263
27264 When an ACL for the AUTH parameter of MAIL is running, the variables that
27265 contain information about the host are set, but &$sender_address$& is not yet
27266 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27267 how it is used.
27268
27269 .vindex "&$message_size$&"
27270 The &$message_size$& variable is set to the value of the SIZE parameter on
27271 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27272 that parameter is not given. The value is updated to the true message size by
27273 the time the final DATA ACL is run (after the message data has been
27274 received).
27275
27276 .vindex "&$rcpt_count$&"
27277 .vindex "&$recipients_count$&"
27278 The &$rcpt_count$& variable increases by one for each RCPT command received.
27279 The &$recipients_count$& variable increases by one each time a RCPT command is
27280 accepted, so while an ACL for RCPT is being processed, it contains the number
27281 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27282 &$rcpt_count$& contains the total number of RCPT commands, and
27283 &$recipients_count$& contains the total number of accepted recipients.
27284
27285
27286
27287
27288
27289 .section "Data for non-message ACLs" "SECTdatfornon"
27290 .cindex "&ACL;" "data for non-message ACL"
27291 .vindex &$smtp_command_argument$&
27292 .vindex &$smtp_command$&
27293 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27294 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27295 and the entire SMTP command is available in &$smtp_command$&.
27296 These variables can be tested using a &%condition%& condition. For example,
27297 here is an ACL for use with AUTH, which insists that either the session is
27298 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27299 does not permit authentication methods that use cleartext passwords on
27300 unencrypted connections.
27301 .code
27302 acl_check_auth:
27303   accept encrypted = *
27304   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27305                      {CRAM-MD5}}
27306   deny   message   = TLS encryption or CRAM-MD5 required
27307 .endd
27308 (Another way of applying this restriction is to arrange for the authenticators
27309 that use cleartext passwords not to be advertised when the connection is not
27310 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27311 option to do this.)
27312
27313
27314
27315 .section "Format of an ACL" "SECID199"
27316 .cindex "&ACL;" "format of"
27317 .cindex "&ACL;" "verbs, definition of"
27318 An individual ACL consists of a number of statements. Each statement starts
27319 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27320 Modifiers can change the way the verb operates, define error and log messages,
27321 set variables, insert delays, and vary the processing of accepted messages.
27322
27323 If all the conditions are met, the verb is obeyed. The same condition may be
27324 used (with different arguments) more than once in the same statement. This
27325 provides a means of specifying an &"and"& conjunction between conditions. For
27326 example:
27327 .code
27328 deny  dnslists = list1.example
27329 dnslists = list2.example
27330 .endd
27331 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27332 the conditions and modifiers when it reaches a condition that fails. What
27333 happens then depends on the verb (and in one case, on a special modifier). Not
27334 all the conditions make sense at every testing point. For example, you cannot
27335 test a sender address in the ACL that is run for a VRFY command.
27336
27337
27338 .section "ACL verbs" "SECID200"
27339 The ACL verbs are as follows:
27340
27341 .ilist
27342 .cindex "&%accept%& ACL verb"
27343 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27344 of the conditions are not met, what happens depends on whether &%endpass%&
27345 appears among the conditions (for syntax see below). If the failing condition
27346 is before &%endpass%&, control is passed to the next ACL statement; if it is
27347 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27348 check a RCPT command:
27349 .code
27350 accept domains = +local_domains
27351 endpass
27352 verify = recipient
27353 .endd
27354 If the recipient domain does not match the &%domains%& condition, control
27355 passes to the next statement. If it does match, the recipient is verified, and
27356 the command is accepted if verification succeeds. However, if verification
27357 fails, the ACL yields &"deny"&, because the failing condition is after
27358 &%endpass%&.
27359
27360 The &%endpass%& feature has turned out to be confusing to many people, so its
27361 use is not recommended nowadays. It is always possible to rewrite an ACL so
27362 that &%endpass%& is not needed, and it is no longer used in the default
27363 configuration.
27364
27365 .cindex "&%message%& ACL modifier" "with &%accept%&"
27366 If a &%message%& modifier appears on an &%accept%& statement, its action
27367 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27368 (when an &%accept%& verb either accepts or passes control to the next
27369 statement), &%message%& can be used to vary the message that is sent when an
27370 SMTP command is accepted. For example, in a RCPT ACL you could have:
27371 .display
27372 &`accept  `&<&'some conditions'&>
27373 &`        message = OK, I will allow you through today`&
27374 .endd
27375 You can specify an SMTP response code, optionally followed by an &"extended
27376 response code"& at the start of the message, but the first digit must be the
27377 same as would be sent by default, which is 2 for an &%accept%& verb.
27378
27379 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27380 an error message that is used when access is denied. This behaviour is retained
27381 for backward compatibility, but current &"best practice"& is to avoid the use
27382 of &%endpass%&.
27383
27384
27385 .next
27386 .cindex "&%defer%& ACL verb"
27387 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27388 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27389 &%defer%& is the same as &%deny%&, because there is no way of sending a
27390 temporary error. For a RCPT command, &%defer%& is much the same as using a
27391 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27392 be used in any ACL, and even for a recipient it might be a simpler approach.
27393
27394
27395 .next
27396 .cindex "&%deny%& ACL verb"
27397 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27398 the conditions are not met, control is passed to the next ACL statement. For
27399 example,
27400 .code
27401 deny dnslists = blackholes.mail-abuse.org
27402 .endd
27403 rejects commands from hosts that are on a DNS black list.
27404
27405
27406 .next
27407 .cindex "&%discard%& ACL verb"
27408 &%discard%&: This verb behaves like &%accept%&, except that it returns
27409 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27410 that are concerned with receiving messages. When all the conditions are true,
27411 the sending entity receives a &"success"& response. However, &%discard%& causes
27412 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27413 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27414 message's recipients are discarded. Recipients that are discarded before DATA
27415 do not appear in the log line when the &%received_recipients%& log selector is set.
27416
27417 If the &%log_message%& modifier is set when &%discard%& operates,
27418 its contents are added to the line that is automatically written to the log.
27419 The &%message%& modifier operates exactly as it does for &%accept%&.
27420
27421
27422 .next
27423 .cindex "&%drop%& ACL verb"
27424 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27425 forcibly closed after the 5&'xx'& error message has been sent. For example:
27426 .code
27427 drop   message   = I don't take more than 20 RCPTs
27428        condition = ${if > {$rcpt_count}{20}}
27429 .endd
27430 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27431 The connection is always dropped after sending a 550 response.
27432
27433 .next
27434 .cindex "&%require%& ACL verb"
27435 &%require%&: If all the conditions are met, control is passed to the next ACL
27436 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27437 example, when checking a RCPT command,
27438 .code
27439 require message = Sender did not verify
27440         verify  = sender
27441 .endd
27442 passes control to subsequent statements only if the message's sender can be
27443 verified. Otherwise, it rejects the command. Note the positioning of the
27444 &%message%& modifier, before the &%verify%& condition. The reason for this is
27445 discussed in section &<<SECTcondmodproc>>&.
27446
27447 .next
27448 .cindex "&%warn%& ACL verb"
27449 &%warn%&: If all the conditions are true, a line specified by the
27450 &%log_message%& modifier is written to Exim's main log. Control always passes
27451 to the next ACL statement. If any condition is false, the log line is not
27452 written. If an identical log line is requested several times in the same
27453 message, only one copy is actually written to the log. If you want to force
27454 duplicates to be written, use the &%logwrite%& modifier instead.
27455
27456 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27457 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27458 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27459 first failing condition. There is more about adding header lines in section
27460 &<<SECTaddheadacl>>&.
27461
27462 If any condition on a &%warn%& statement cannot be completed (that is, there is
27463 some sort of defer), the log line specified by &%log_message%& is not written.
27464 This does not include the case of a forced failure from a lookup, which
27465 is considered to be a successful completion. After a defer, no further
27466 conditions or modifiers in the &%warn%& statement are processed. The incident
27467 is logged, and the ACL continues to be processed, from the next statement
27468 onwards.
27469
27470
27471 .vindex "&$acl_verify_message$&"
27472 When one of the &%warn%& conditions is an address verification that fails, the
27473 text of the verification failure message is in &$acl_verify_message$&. If you
27474 want this logged, you must set it up explicitly. For example:
27475 .code
27476 warn   !verify = sender
27477        log_message = sender verify failed: $acl_verify_message
27478 .endd
27479 .endlist
27480
27481 At the end of each ACL there is an implicit unconditional &%deny%&.
27482
27483 As you can see from the examples above, the conditions and modifiers are
27484 written one to a line, with the first one on the same line as the verb, and
27485 subsequent ones on following lines. If you have a very long condition, you can
27486 continue it onto several physical lines by the usual backslash continuation
27487 mechanism. It is conventional to align the conditions vertically.
27488
27489
27490
27491 .section "ACL variables" "SECTaclvariables"
27492 .cindex "&ACL;" "variables"
27493 There are some special variables that can be set during ACL processing. They
27494 can be used to pass information between different ACLs, different invocations
27495 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27496 transports, and filters that are used to deliver a message. The names of these
27497 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27498 an underscore, but the remainder of the name can be any sequence of
27499 alphanumeric characters and underscores that you choose. There is no limit on
27500 the number of ACL variables. The two sets act as follows:
27501 .ilist
27502 The values of those variables whose names begin with &$acl_c$& persist
27503 throughout an SMTP connection. They are never reset. Thus, a value that is set
27504 while receiving one message is still available when receiving the next message
27505 on the same SMTP connection.
27506 .next
27507 The values of those variables whose names begin with &$acl_m$& persist only
27508 while a message is being received. They are reset afterwards. They are also
27509 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27510 .endlist
27511
27512 When a message is accepted, the current values of all the ACL variables are
27513 preserved with the message and are subsequently made available at delivery
27514 time. The ACL variables are set by a modifier called &%set%&. For example:
27515 .code
27516 accept hosts = whatever
27517        set acl_m4 = some value
27518 accept authenticated = *
27519        set acl_c_auth = yes
27520 .endd
27521 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27522 be set. If you want to set a variable without taking any action, you can use a
27523 &%warn%& verb without any other modifiers or conditions.
27524
27525 .oindex &%strict_acl_vars%&
27526 What happens if a syntactically valid but undefined ACL variable is
27527 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27528 false (the default), an empty string is substituted; if it is true, an
27529 error is generated.
27530
27531 Versions of Exim before 4.64 have a limited set of numbered variables, but
27532 their names are compatible, so there is no problem with upgrading.
27533
27534
27535 .section "Condition and modifier processing" "SECTcondmodproc"
27536 .cindex "&ACL;" "conditions; processing"
27537 .cindex "&ACL;" "modifiers; processing"
27538 An exclamation mark preceding a condition negates its result. For example:
27539 .code
27540 deny   domains = *.dom.example
27541       !verify  = recipient
27542 .endd
27543 causes the ACL to return &"deny"& if the recipient domain ends in
27544 &'dom.example'& and the recipient address cannot be verified. Sometimes
27545 negation can be used on the right-hand side of a condition. For example, these
27546 two statements are equivalent:
27547 .code
27548 deny  hosts = !192.168.3.4
27549 deny !hosts =  192.168.3.4
27550 .endd
27551 However, for many conditions (&%verify%& being a good example), only left-hand
27552 side negation of the whole condition is possible.
27553
27554 The arguments of conditions and modifiers are expanded. A forced failure
27555 of an expansion causes a condition to be ignored, that is, it behaves as if the
27556 condition is true. Consider these two statements:
27557 .code
27558 accept  senders = ${lookup{$host_name}lsearch\
27559                   {/some/file}{$value}fail}
27560 accept  senders = ${lookup{$host_name}lsearch\
27561                   {/some/file}{$value}{}}
27562 .endd
27563 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27564 the returned list is searched, but if the lookup fails the behaviour is
27565 different in the two cases. The &%fail%& in the first statement causes the
27566 condition to be ignored, leaving no further conditions. The &%accept%& verb
27567 therefore succeeds. The second statement, however, generates an empty list when
27568 the lookup fails. No sender can match an empty list, so the condition fails,
27569 and therefore the &%accept%& also fails.
27570
27571 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27572 specify actions that are taken as the conditions for a statement are checked;
27573 others specify text for messages that are used when access is denied or a
27574 warning is generated. The &%control%& modifier affects the way an incoming
27575 message is handled.
27576
27577 The positioning of the modifiers in an ACL statement is important, because the
27578 processing of a verb ceases as soon as its outcome is known. Only those
27579 modifiers that have already been encountered will take effect. For example,
27580 consider this use of the &%message%& modifier:
27581 .code
27582 require message = Can't verify sender
27583         verify  = sender
27584         message = Can't verify recipient
27585         verify  = recipient
27586         message = This message cannot be used
27587 .endd
27588 If sender verification fails, Exim knows that the result of the statement is
27589 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27590 so its text is used as the error message. If sender verification succeeds, but
27591 recipient verification fails, the second message is used. If recipient
27592 verification succeeds, the third message becomes &"current"&, but is never used
27593 because there are no more conditions to cause failure.
27594
27595 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27596 modifier that is used, because all the conditions must be true for rejection to
27597 happen. Specifying more than one &%message%& modifier does not make sense, and
27598 the message can even be specified after all the conditions. For example:
27599 .code
27600 deny   hosts = ...
27601       !senders = *@my.domain.example
27602        message = Invalid sender from client host
27603 .endd
27604 The &"deny"& result does not happen until the end of the statement is reached,
27605 by which time Exim has set up the message.
27606
27607
27608
27609 .section "ACL modifiers" "SECTACLmodi"
27610 .cindex "&ACL;" "modifiers; list of"
27611 The ACL modifiers are as follows:
27612
27613 .vlist
27614 .vitem &*add_header*&&~=&~<&'text'&>
27615 This modifier specifies one or more header lines that are to be added to an
27616 incoming message, assuming, of course, that the message is ultimately
27617 accepted. For details, see section &<<SECTaddheadacl>>&.
27618
27619 .vitem &*continue*&&~=&~<&'text'&>
27620 .cindex "&%continue%& ACL modifier"
27621 .cindex "database" "updating in ACL"
27622 This modifier does nothing of itself, and processing of the ACL always
27623 continues with the next condition or modifier. The value of &%continue%& is in
27624 the side effects of expanding its argument. Typically this could be used to
27625 update a database. It is really just a syntactic tidiness, to avoid having to
27626 write rather ugly lines like this:
27627 .display
27628 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27629 .endd
27630 Instead, all you need is
27631 .display
27632 &`continue = `&<&'some expansion'&>
27633 .endd
27634
27635 .vitem &*control*&&~=&~<&'text'&>
27636 .cindex "&%control%& ACL modifier"
27637 This modifier affects the subsequent processing of the SMTP connection or of an
27638 incoming message that is accepted. The effect of the first type of control
27639 lasts for the duration of the connection, whereas the effect of the second type
27640 lasts only until the current message has been received. The message-specific
27641 controls always apply to the whole message, not to individual recipients,
27642 even if the &%control%& modifier appears in a RCPT ACL.
27643
27644 As there are now quite a few controls that can be applied, they are described
27645 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27646 in several different ways. For example:
27647
27648 . ==== As this is a nested list, any displays it contains must be indented
27649 . ==== as otherwise they are too far to the left. That comment applies only
27650 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27651 . ==== way.
27652
27653 .ilist
27654 It can be at the end of an &%accept%& statement:
27655 .code
27656     accept  ...some conditions
27657             control = queue_only
27658 .endd
27659 In this case, the control is applied when this statement yields &"accept"&, in
27660 other words, when the conditions are all true.
27661
27662 .next
27663 It can be in the middle of an &%accept%& statement:
27664 .code
27665     accept  ...some conditions...
27666             control = queue_only
27667             ...some more conditions...
27668 .endd
27669 If the first set of conditions are true, the control is applied, even if the
27670 statement does not accept because one of the second set of conditions is false.
27671 In this case, some subsequent statement must yield &"accept"& for the control
27672 to be relevant.
27673
27674 .next
27675 It can be used with &%warn%& to apply the control, leaving the
27676 decision about accepting or denying to a subsequent verb. For
27677 example:
27678 .code
27679     warn    ...some conditions...
27680             control = freeze
27681     accept  ...
27682 .endd
27683 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27684 &%logwrite%&, so it does not add anything to the message and does not write a
27685 log entry.
27686
27687 .next
27688 If you want to apply a control unconditionally, you can use it with a
27689 &%require%& verb. For example:
27690 .code
27691     require  control = no_multiline_responses
27692 .endd
27693 .endlist
27694
27695 .vitem &*delay*&&~=&~<&'time'&>
27696 .cindex "&%delay%& ACL modifier"
27697 .oindex "&%-bh%&"
27698 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27699 the time interval before proceeding. However, when testing Exim using the
27700 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27701 output instead). The time is given in the usual Exim notation, and the delay
27702 happens as soon as the modifier is processed. In an SMTP session, pending
27703 output is flushed before the delay is imposed.
27704
27705 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27706 example:
27707 .code
27708 deny    ...some conditions...
27709         delay = 30s
27710 .endd
27711 The delay happens if all the conditions are true, before the statement returns
27712 &"deny"&. Compare this with:
27713 .code
27714 deny    delay = 30s
27715         ...some conditions...
27716 .endd
27717 which waits for 30s before processing the conditions. The &%delay%& modifier
27718 can also be used with &%warn%& and together with &%control%&:
27719 .code
27720 warn    ...some conditions...
27721         delay = 2m
27722         control = freeze
27723 accept  ...
27724 .endd
27725
27726 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27727 responses to several commands are no longer buffered and sent in one packet (as
27728 they would normally be) because all output is flushed before imposing the
27729 delay. This optimization is disabled so that a number of small delays do not
27730 appear to the client as one large aggregated delay that might provoke an
27731 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27732 using a &%control%& modifier to set &%no_delay_flush%&.
27733
27734
27735 .vitem &*endpass*&
27736 .cindex "&%endpass%& ACL modifier"
27737 This modifier, which has no argument, is recognized only in &%accept%& and
27738 &%discard%& statements. It marks the boundary between the conditions whose
27739 failure causes control to pass to the next statement, and the conditions whose
27740 failure causes the ACL to return &"deny"&. This concept has proved to be
27741 confusing to some people, so the use of &%endpass%& is no longer recommended as
27742 &"best practice"&. See the description of &%accept%& above for more details.
27743
27744
27745 .vitem &*log_message*&&~=&~<&'text'&>
27746 .cindex "&%log_message%& ACL modifier"
27747 This modifier sets up a message that is used as part of the log message if the
27748 ACL denies access or a &%warn%& statement's conditions are true. For example:
27749 .code
27750 require log_message = wrong cipher suite $tls_in_cipher
27751         encrypted   = DES-CBC3-SHA
27752 .endd
27753 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27754 example:
27755 .display
27756 &`discard `&<&'some conditions'&>
27757 &`        log_message = Discarded $local_part@$domain because...`&
27758 .endd
27759 When access is denied, &%log_message%& adds to any underlying error message
27760 that may exist because of a condition failure. For example, while verifying a
27761 recipient address, a &':fail:'& redirection might have already set up a
27762 message.
27763
27764 The message may be defined before the conditions to which it applies, because
27765 the string expansion does not happen until Exim decides that access is to be
27766 denied. This means that any variables that are set by the condition are
27767 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27768 variables are set after a DNS black list lookup succeeds. If the expansion of
27769 &%log_message%& fails, or if the result is an empty string, the modifier is
27770 ignored.
27771
27772 .vindex "&$acl_verify_message$&"
27773 If you want to use a &%warn%& statement to log the result of an address
27774 verification, you can use &$acl_verify_message$& to include the verification
27775 error message.
27776
27777 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27778 the start of the logged message. If the same warning log message is requested
27779 more than once while receiving  a single email message, only one copy is
27780 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27781 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27782 is logged for a successful &%warn%& statement.
27783
27784 If &%log_message%& is not present and there is no underlying error message (for
27785 example, from the failure of address verification), but &%message%& is present,
27786 the &%message%& text is used for logging rejections. However, if any text for
27787 logging contains newlines, only the first line is logged. In the absence of
27788 both &%log_message%& and &%message%&, a default built-in message is used for
27789 logging rejections.
27790
27791
27792 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27793 .cindex "&%log_reject_target%& ACL modifier"
27794 .cindex "logging in ACL" "specifying which log"
27795 This modifier makes it possible to specify which logs are used for messages
27796 about ACL rejections. Its argument is a colon-separated list of words that can
27797 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27798 may be empty, in which case a rejection is not logged at all. For example, this
27799 ACL fragment writes no logging information when access is denied:
27800 .display
27801 &`deny `&<&'some conditions'&>
27802 &`     log_reject_target =`&
27803 .endd
27804 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27805 permanent and temporary rejections. Its effect lasts for the rest of the
27806 current ACL.
27807
27808
27809 .vitem &*logwrite*&&~=&~<&'text'&>
27810 .cindex "&%logwrite%& ACL modifier"
27811 .cindex "logging in ACL" "immediate"
27812 This modifier writes a message to a log file as soon as it is encountered when
27813 processing an ACL. (Compare &%log_message%&, which, except in the case of
27814 &%warn%& and &%discard%&, is used only if the ACL statement denies
27815 access.) The &%logwrite%& modifier can be used to log special incidents in
27816 ACLs. For example:
27817 .display
27818 &`accept `&<&'some special conditions'&>
27819 &`       control  = freeze`&
27820 &`       logwrite = froze message because ...`&
27821 .endd
27822 By default, the message is written to the main log. However, it may begin
27823 with a colon, followed by a comma-separated list of log names, and then
27824 another colon, to specify exactly which logs are to be written. For
27825 example:
27826 .code
27827 logwrite = :main,reject: text for main and reject logs
27828 logwrite = :panic: text for panic log only
27829 .endd
27830
27831
27832 .vitem &*message*&&~=&~<&'text'&>
27833 .cindex "&%message%& ACL modifier"
27834 This modifier sets up a text string that is expanded and used as a response
27835 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27836 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27837 there is some complication if &%endpass%& is involved; see the description of
27838 &%accept%& for details.)
27839
27840 The expansion of the message happens at the time Exim decides that the ACL is
27841 to end, not at the time it processes &%message%&. If the expansion fails, or
27842 generates an empty string, the modifier is ignored. Here is an example where
27843 &%message%& must be specified first, because the ACL ends with a rejection if
27844 the &%hosts%& condition fails:
27845 .code
27846 require  message = Host not recognized
27847          hosts = 10.0.0.0/8
27848 .endd
27849 (Once a condition has failed, no further conditions or modifiers are
27850 processed.)
27851
27852 .cindex "SMTP" "error codes"
27853 .oindex "&%smtp_banner%&
27854 For ACLs that are triggered by SMTP commands, the message is returned as part
27855 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27856 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27857 is accepted. In the case of the connect ACL, accepting with a message modifier
27858 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27859 accept message may not contain more than one line (otherwise it will be
27860 truncated at the first newline and a panic logged), and it cannot affect the
27861 EHLO options.
27862
27863 When SMTP is involved, the message may begin with an overriding response code,
27864 consisting of three digits optionally followed by an &"extended response code"&
27865 of the form &'n.n.n'&, each code being followed by a space. For example:
27866 .code
27867 deny  message = 599 1.2.3 Host not welcome
27868       hosts = 192.168.34.0/24
27869 .endd
27870 The first digit of the supplied response code must be the same as would be sent
27871 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27872 access, but for the predata ACL, note that the default success code is 354, not
27873 2&'xx'&.
27874
27875 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27876 the message modifier cannot override the 221 response code.
27877
27878 The text in a &%message%& modifier is literal; any quotes are taken as
27879 literals, but because the string is expanded, backslash escapes are processed
27880 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27881 response.
27882
27883 .vindex "&$acl_verify_message$&"
27884 For ACLs that are called by an &%acl =%& ACL condition, the message is
27885 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27886
27887 If &%message%& is used on a statement that verifies an address, the message
27888 specified overrides any message that is generated by the verification process.
27889 However, the original message is available in the variable
27890 &$acl_verify_message$&, so you can incorporate it into your message if you
27891 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27892 routers to be passed back as part of the SMTP response, you should either not
27893 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27894
27895 For compatibility with previous releases of Exim, a &%message%& modifier that
27896 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27897 modifier, but this usage is now deprecated. However, &%message%& acts only when
27898 all the conditions are true, wherever it appears in an ACL command, whereas
27899 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27900 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27901 effect.
27902
27903
27904 .vitem &*remove_header*&&~=&~<&'text'&>
27905 This modifier specifies one or more header names in a colon-separated list
27906  that are to be removed from an incoming message, assuming, of course, that
27907 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27908
27909
27910 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27911 .cindex "&%set%& ACL modifier"
27912 This modifier puts a value into one of the ACL variables (see section
27913 &<<SECTaclvariables>>&).
27914
27915
27916 .vitem &*udpsend*&&~=&~<&'parameters'&>
27917 This modifier sends a UDP packet, for purposes such as statistics
27918 collection or behaviour monitoring. The parameters are expanded, and
27919 the result of the expansion must be a colon-separated list consisting
27920 of a destination server, port number, and the packet contents. The
27921 server can be specified as a host name or IPv4 or IPv6 address. The
27922 separator can be changed with the usual angle bracket syntax. For
27923 example, you might want to collect information on which hosts connect
27924 when:
27925 .code
27926 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27927              $tod_zulu $sender_host_address
27928 .endd
27929 .endlist
27930
27931
27932
27933
27934 .section "Use of the control modifier" "SECTcontrols"
27935 .cindex "&%control%& ACL modifier"
27936 The &%control%& modifier supports the following settings:
27937
27938 .vlist
27939 .vitem &*control&~=&~allow_auth_unadvertised*&
27940 This modifier allows a client host to use the SMTP AUTH command even when it
27941 has not been advertised in response to EHLO. Furthermore, because there are
27942 apparently some really broken clients that do this, Exim will accept AUTH after
27943 HELO (rather than EHLO) when this control is set. It should be used only if you
27944 really need it, and you should limit its use to those broken clients that do
27945 not work without it. For example:
27946 .code
27947 warn hosts   = 192.168.34.25
27948      control = allow_auth_unadvertised
27949 .endd
27950 Normally, when an Exim server receives an AUTH command, it checks the name of
27951 the authentication mechanism that is given in the command to ensure that it
27952 matches an advertised mechanism. When this control is set, the check that a
27953 mechanism has been advertised is bypassed. Any configured mechanism can be used
27954 by the client. This control is permitted only in the connection and HELO ACLs.
27955
27956
27957 .vitem &*control&~=&~caseful_local_part*& &&&
27958        &*control&~=&~caselower_local_part*&
27959 .cindex "&ACL;" "case of local part in"
27960 .cindex "case of local parts"
27961 .vindex "&$local_part$&"
27962 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27963 (that is, during RCPT processing). By default, the contents of &$local_part$&
27964 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27965 any uppercase letters in the original local part are restored in &$local_part$&
27966 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27967 is encountered.
27968
27969 These controls affect only the current recipient. Moreover, they apply only to
27970 local part handling that takes place directly in the ACL (for example, as a key
27971 in lookups). If a test to verify the recipient is obeyed, the case-related
27972 handling of the local part during the verification is controlled by the router
27973 configuration (see the &%caseful_local_part%& generic router option).
27974
27975 This facility could be used, for example, to add a spam score to local parts
27976 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27977 spam score:
27978 .code
27979 warn  control = caseful_local_part
27980       set acl_m4 = ${eval:\
27981                      $acl_m4 + \
27982                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27983                     }
27984       control = caselower_local_part
27985 .endd
27986 Notice that we put back the lower cased version afterwards, assuming that
27987 is what is wanted for subsequent tests.
27988
27989
27990 .vitem &*control&~=&~cutthrough_delivery*&
27991 .cindex "&ACL;" "cutthrough routing"
27992 .cindex "cutthrough" "requesting"
27993 This option requests delivery be attempted while the item is being received.
27994
27995 The option usable in the RCPT ACL.
27996 If enabled for a message recieved via smtp and routed to an smtp transport,
27997 and the message has only one recipient,
27998 then the delivery connection is made while the receiving connection is open
27999 and data is copied from one to the other.
28000
28001 If a recipient-verify callout connection is subsequently
28002 requested in the same ACL it is held open and used for the data,
28003 otherwise one is made after the initial RCPT ACL completes.
28004
28005 Note that routers are used in verify mode,
28006 and cannot depend on content of received headers.
28007 Note also that headers cannot be
28008 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28009 Headers may be modified by routers (subject to the above) and transports.
28010
28011 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28012 of outgoing messages is done, because it sends data to the ultimate destination
28013 before the entire message has been received from the source.
28014
28015 Should the ultimate destination system positively accept or reject the mail,
28016 a corresponding indication is given to the source system and nothing is queued.
28017 If there is a temporary error the item is queued for later delivery in the
28018 usual fashion. If the item is successfully delivered in cutthrough mode
28019 the log line is tagged with ">>" rather than "=>" and appears
28020 before the acceptance "<=" line.
28021
28022 Delivery in this mode avoids the generation of a bounce mail to a
28023 (possibly faked)
28024 sender when the destination system is doing content-scan based rejection.
28025
28026
28027 .vitem &*control&~=&~debug/*&<&'options'&>
28028 .cindex "&ACL;" "enabling debug logging"
28029 .cindex "debugging" "enabling from an ACL"
28030 This control turns on debug logging, almost as though Exim had been invoked
28031 with &`-d`&, with the output going to a new logfile, by default called
28032 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28033 may access any variables already defined.  The logging may be adjusted with
28034 the &'opts'& option, which takes the same values as the &`-d`& command-line
28035 option.  Some examples (which depend on variables that don't exist in all
28036 contexts):
28037 .code
28038       control = debug
28039       control = debug/tag=.$sender_host_address
28040       control = debug/opts=+expand+acl
28041       control = debug/tag=.$message_exim_id/opts=+expand
28042 .endd
28043
28044
28045 .vitem &*control&~=&~dkim_disable_verify*&
28046 .cindex "disable DKIM verify"
28047 .cindex "DKIM" "disable verify"
28048 This control turns off DKIM verification processing entirely.  For details on
28049 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28050
28051
28052 .vitem &*control&~=&~dscp/*&<&'value'&>
28053 .cindex "&ACL;" "setting DSCP value"
28054 .cindex "DSCP" "inbound"
28055 This option causes the DSCP value associated with the socket for the inbound
28056 connection to be adjusted to a given value, given as one of a number of fixed
28057 strings or to numeric value.
28058 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28059 Common values include &`throughput`&, &`mincost`&, and on newer systems
28060 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28061
28062 The outbound packets from Exim will be marked with this value in the header
28063 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28064 that these values will have any effect, not be stripped by networking
28065 equipment, or do much of anything without cooperation with your Network
28066 Engineer and those of all network operators between the source and destination.
28067
28068
28069 .vitem &*control&~=&~enforce_sync*& &&&
28070        &*control&~=&~no_enforce_sync*&
28071 .cindex "SMTP" "synchronization checking"
28072 .cindex "synchronization checking in SMTP"
28073 These controls make it possible to be selective about when SMTP synchronization
28074 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28075 state of the switch (it is true by default). See the description of this option
28076 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28077
28078 The effect of these two controls lasts for the remainder of the SMTP
28079 connection. They can appear in any ACL except the one for the non-SMTP
28080 messages. The most straightforward place to put them is in the ACL defined by
28081 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28082 before the first synchronization check. The expected use is to turn off the
28083 synchronization checks for badly-behaved hosts that you nevertheless need to
28084 work with.
28085
28086
28087 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28088 .cindex "fake defer"
28089 .cindex "defer, fake"
28090 This control works in exactly the same way as &%fakereject%& (described below)
28091 except that it causes an SMTP 450 response after the message data instead of a
28092 550 response. You must take care when using &%fakedefer%& because it causes the
28093 messages to be duplicated when the sender retries. Therefore, you should not
28094 use &%fakedefer%& if the message is to be delivered normally.
28095
28096 .vitem &*control&~=&~fakereject/*&<&'message'&>
28097 .cindex "fake rejection"
28098 .cindex "rejection, fake"
28099 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28100 words, only when an SMTP message is being received. If Exim accepts the
28101 message, instead the final 250 response, a 550 rejection message is sent.
28102 However, Exim proceeds to deliver the message as normal. The control applies
28103 only to the current message, not to any subsequent ones that may be received in
28104 the same SMTP connection.
28105
28106 The text for the 550 response is taken from the &%control%& modifier. If no
28107 message is supplied, the following is used:
28108 .code
28109 550-Your message has been rejected but is being
28110 550-kept for evaluation.
28111 550-If it was a legitimate message, it may still be
28112 550 delivered to the target recipient(s).
28113 .endd
28114 This facility should be used with extreme caution.
28115
28116 .vitem &*control&~=&~freeze*&
28117 .cindex "frozen messages" "forcing in ACL"
28118 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28119 other words, only when a message is being received. If the message is accepted,
28120 it is placed on Exim's queue and frozen. The control applies only to the
28121 current message, not to any subsequent ones that may be received in the same
28122 SMTP connection.
28123
28124 This modifier can optionally be followed by &`/no_tell`&. If the global option
28125 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28126 is told about the freezing), provided all the &*control=freeze*& modifiers that
28127 are obeyed for the current message have the &`/no_tell`& option.
28128
28129 .vitem &*control&~=&~no_delay_flush*&
28130 .cindex "SMTP" "output flushing, disabling for delay"
28131 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28132 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28133 use. This control, as long as it is encountered before the &%delay%& modifier,
28134 disables such output flushing.
28135
28136 .vitem &*control&~=&~no_callout_flush*&
28137 .cindex "SMTP" "output flushing, disabling for callout"
28138 Exim normally flushes SMTP output before performing a callout 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 &%verify%& condition
28141 that causes the callout, disables such output flushing.
28142
28143 .vitem &*control&~=&~no_mbox_unspool*&
28144 This control is available when Exim is compiled with the content scanning
28145 extension. Content scanning may require a copy of the current message, or parts
28146 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28147 or spam scanner. Normally, such copies are deleted when they are no longer
28148 needed. If this control is set, the copies are not deleted. The control applies
28149 only to the current message, not to any subsequent ones that may be received in
28150 the same SMTP connection. It is provided for debugging purposes and is unlikely
28151 to be useful in production.
28152
28153 .vitem &*control&~=&~no_multiline_responses*&
28154 .cindex "multiline responses, suppressing"
28155 This control is permitted for any ACL except the one for non-SMTP messages.
28156 It seems that there are broken clients in use that cannot handle multiline
28157 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28158
28159 If this control is set, multiline SMTP responses from ACL rejections are
28160 suppressed. One way of doing this would have been to put out these responses as
28161 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28162 (&"use multiline responses for more"& it says &-- ha!), and some of the
28163 responses might get close to that. So this facility, which is after all only a
28164 sop to broken clients, is implemented by doing two very easy things:
28165
28166 .ilist
28167 Extra information that is normally output as part of a rejection caused by
28168 sender verification failure is omitted. Only the final line (typically &"sender
28169 verification failed"&) is sent.
28170 .next
28171 If a &%message%& modifier supplies a multiline response, only the first
28172 line is output.
28173 .endlist
28174
28175 The setting of the switch can, of course, be made conditional on the
28176 calling host. Its effect lasts until the end of the SMTP connection.
28177
28178 .vitem &*control&~=&~no_pipelining*&
28179 .cindex "PIPELINING" "suppressing advertising"
28180 This control turns off the advertising of the PIPELINING extension to SMTP in
28181 the current session. To be useful, it must be obeyed before Exim sends its
28182 response to an EHLO command. Therefore, it should normally appear in an ACL
28183 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28184 &%pipelining_advertise_hosts%&.
28185
28186 .vitem &*control&~=&~queue_only*&
28187 .oindex "&%queue_only%&"
28188 .cindex "queueing incoming messages"
28189 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28190 other words, only when a message is being received. If the message is accepted,
28191 it is placed on Exim's queue and left there for delivery by a subsequent queue
28192 runner. No immediate delivery process is started. In other words, it has the
28193 effect as the &%queue_only%& global option. However, the control applies only
28194 to the current message, not to any subsequent ones that may be received in the
28195 same SMTP connection.
28196
28197 .vitem &*control&~=&~submission/*&<&'options'&>
28198 .cindex "message" "submission"
28199 .cindex "submission mode"
28200 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28201 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28202 the current message is a submission from a local MUA. In this case, Exim
28203 operates in &"submission mode"&, and applies certain fixups to the message if
28204 necessary. For example, it adds a &'Date:'& header line if one is not present.
28205 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28206 late (the message has already been created).
28207
28208 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28209 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28210 submission mode; the available options for this control are described there.
28211 The control applies only to the current message, not to any subsequent ones
28212 that may be received in the same SMTP connection.
28213
28214 .vitem &*control&~=&~suppress_local_fixups*&
28215 .cindex "submission fixups, suppressing"
28216 This control applies to locally submitted (non TCP/IP) messages, and is the
28217 complement of &`control = submission`&. It disables the fixups that are
28218 normally applied to locally-submitted messages. Specifically:
28219
28220 .ilist
28221 Any &'Sender:'& header line is left alone (in this respect, it is a
28222 dynamic version of &%local_sender_retain%&).
28223 .next
28224 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28225 .next
28226 There is no check that &'From:'& corresponds to the actual sender.
28227 .endlist ilist
28228
28229 This control may be useful when a remotely-originated message is accepted,
28230 passed to some scanning program, and then re-submitted for delivery. It can be
28231 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28232 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28233 data is read.
28234
28235 &*Note:*& This control applies only to the current message, not to any others
28236 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28237 .endlist vlist
28238
28239
28240 .section "Summary of message fixup control" "SECTsummesfix"
28241 All four possibilities for message fixups can be specified:
28242
28243 .ilist
28244 Locally submitted, fixups applied: the default.
28245 .next
28246 Locally submitted, no fixups applied: use
28247 &`control = suppress_local_fixups`&.
28248 .next
28249 Remotely submitted, no fixups applied: the default.
28250 .next
28251 Remotely submitted, fixups applied: use &`control = submission`&.
28252 .endlist
28253
28254
28255
28256 .section "Adding header lines in ACLs" "SECTaddheadacl"
28257 .cindex "header lines" "adding in an ACL"
28258 .cindex "header lines" "position of added lines"
28259 .cindex "&%add_header%& ACL modifier"
28260 The &%add_header%& modifier can be used to add one or more extra header lines
28261 to an incoming message, as in this example:
28262 .code
28263 warn dnslists = sbl.spamhaus.org : \
28264                 dialup.mail-abuse.org
28265      add_header = X-blacklisted-at: $dnslist_domain
28266 .endd
28267 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28268 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28269 receiving a message). The message must ultimately be accepted for
28270 &%add_header%& to have any significant effect. You can use &%add_header%& with
28271 any ACL verb, including &%deny%& (though this is potentially useful only in a
28272 RCPT ACL).
28273
28274 Headers will not be added to the message if the modifier is used in
28275 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28276
28277 Leading and trailing newlines are removed from
28278 the data for the &%add_header%& modifier; if it then
28279 contains one or more newlines that
28280 are not followed by a space or a tab, it is assumed to contain multiple header
28281 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28282 front of any line that is not a valid header line.
28283
28284 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28285 They are added to the message before processing the DATA and MIME ACLs.
28286 However, if an identical header line is requested more than once, only one copy
28287 is actually added to the message. Further header lines may be accumulated
28288 during the DATA and MIME ACLs, after which they are added to the message, again
28289 with duplicates suppressed. Thus, it is possible to add two identical header
28290 lines to an SMTP message, but only if one is added before DATA and one after.
28291 In the case of non-SMTP messages, new headers are accumulated during the
28292 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28293 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28294 are included in the entry that is written to the reject log.
28295
28296 .cindex "header lines" "added; visibility of"
28297 Header lines are not visible in string expansions
28298 of message headers
28299 until they are added to the
28300 message. It follows that header lines defined in the MAIL, RCPT, and predata
28301 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28302 header lines that are added by the DATA or MIME ACLs are not visible in those
28303 ACLs. Because of this restriction, you cannot use header lines as a way of
28304 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28305 this, you can use ACL variables, as described in section
28306 &<<SECTaclvariables>>&.
28307
28308 The list of headers yet to be added is given by the &%$headers_added%& variable.
28309
28310 The &%add_header%& modifier acts immediately as it is encountered during the
28311 processing of an ACL. Notice the difference between these two cases:
28312 .display
28313 &`accept add_header = ADDED: some text`&
28314 &`       `&<&'some condition'&>
28315
28316 &`accept `&<&'some condition'&>
28317 &`       add_header = ADDED: some text`&
28318 .endd
28319 In the first case, the header line is always added, whether or not the
28320 condition is true. In the second case, the header line is added only if the
28321 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28322 ACL statement. All those that are encountered before a condition fails are
28323 honoured.
28324
28325 .cindex "&%warn%& ACL verb"
28326 For compatibility with previous versions of Exim, a &%message%& modifier for a
28327 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28328 effect only if all the conditions are true, even if it appears before some of
28329 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28330 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28331 are present on a &%warn%& verb, both are processed according to their
28332 specifications.
28333
28334 By default, new header lines are added to a message at the end of the existing
28335 header lines. However, you can specify that any particular header line should
28336 be added right at the start (before all the &'Received:'& lines), immediately
28337 after the first block of &'Received:'& lines, or immediately before any line
28338 that is not a &'Received:'& or &'Resent-something:'& header.
28339
28340 This is done by specifying &":at_start:"&, &":after_received:"&, or
28341 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28342 header line, respectively. (Header text cannot start with a colon, as there has
28343 to be a header name first.) For example:
28344 .code
28345 warn add_header = \
28346        :after_received:X-My-Header: something or other...
28347 .endd
28348 If more than one header line is supplied in a single &%add_header%& modifier,
28349 each one is treated independently and can therefore be placed differently. If
28350 you add more than one line at the start, or after the Received: block, they end
28351 up in reverse order.
28352
28353 &*Warning*&: This facility currently applies only to header lines that are
28354 added in an ACL. It does NOT work for header lines that are added in a
28355 system filter or in a router or transport.
28356
28357
28358
28359 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28360 .cindex "header lines" "removing in an ACL"
28361 .cindex "header lines" "position of removed lines"
28362 .cindex "&%remove_header%& ACL modifier"
28363 The &%remove_header%& modifier can be used to remove one or more header lines
28364 from an incoming message, as in this example:
28365 .code
28366 warn   message        = Remove internal headers
28367        remove_header  = x-route-mail1 : x-route-mail2
28368 .endd
28369 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28370 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28371 receiving a message). The message must ultimately be accepted for
28372 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28373 with any ACL verb, including &%deny%&, though this is really not useful for
28374 any verb that doesn't result in a delivered message.
28375
28376 Headers will not be removed to the message if the modifier is used in
28377 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28378
28379 More than one header can be removed at the same time by using a colon separated
28380 list of header names. The header matching is case insensitive. Wildcards are
28381 not permitted, nor is list expansion performed, so you cannot use hostlists to
28382 create a list of headers, however both connection and message variable expansion
28383 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28384 .code
28385 warn   hosts           = +internal_hosts
28386        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28387 warn   message         = Remove internal headers
28388        remove_header   = $acl_c_ihdrs
28389 .endd
28390 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28391 They are removed from the message before processing the DATA and MIME ACLs.
28392 There is no harm in attempting to remove the same header twice nor is removing
28393 a non-existent header. Further header lines to be removed may be accumulated
28394 during the DATA and MIME ACLs, after which they are removed from the message,
28395 if present. In the case of non-SMTP messages, headers to be removed are
28396 accumulated during the non-SMTP ACLs, and are removed from the message after
28397 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28398 ACL, there really is no effect because there is no logging of what headers
28399 would have been removed.
28400
28401 .cindex "header lines" "removed; visibility of"
28402 Header lines are not visible in string expansions until the DATA phase when it
28403 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28404 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28405 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28406 this restriction, you cannot use header lines as a way of controlling data
28407 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28408 you should instead use ACL variables, as described in section
28409 &<<SECTaclvariables>>&.
28410
28411 The &%remove_header%& modifier acts immediately as it is encountered during the
28412 processing of an ACL. Notice the difference between these two cases:
28413 .display
28414 &`accept remove_header = X-Internal`&
28415 &`       `&<&'some condition'&>
28416
28417 &`accept `&<&'some condition'&>
28418 &`       remove_header = X-Internal`&
28419 .endd
28420 In the first case, the header line is always removed, whether or not the
28421 condition is true. In the second case, the header line is removed only if the
28422 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28423 same ACL statement. All those that are encountered before a condition fails
28424 are honoured.
28425
28426 &*Warning*&: This facility currently applies only to header lines that are
28427 present during ACL processing. It does NOT remove header lines that are added
28428 in a system filter or in a router or transport.
28429
28430
28431
28432
28433 .section "ACL conditions" "SECTaclconditions"
28434 .cindex "&ACL;" "conditions; list of"
28435 Some of the conditions listed in this section are available only when Exim is
28436 compiled with the content-scanning extension. They are included here briefly
28437 for completeness. More detailed descriptions can be found in the discussion on
28438 content scanning in chapter &<<CHAPexiscan>>&.
28439
28440 Not all conditions are relevant in all circumstances. For example, testing
28441 senders and recipients does not make sense in an ACL that is being run as the
28442 result of the arrival of an ETRN command, and checks on message headers can be
28443 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28444 can use the same condition (with different parameters) more than once in the
28445 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28446 The conditions are as follows:
28447
28448
28449 .vlist
28450 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28451 .cindex "&ACL;" "nested"
28452 .cindex "&ACL;" "indirect"
28453 .cindex "&ACL;" "arguments"
28454 .cindex "&%acl%& ACL condition"
28455 The possible values of the argument are the same as for the
28456 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28457 &"accept"& the condition is true; if it returns &"deny"& the condition is
28458 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28459 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28460 condition false. This means that further processing of the &%warn%& verb
28461 ceases, but processing of the ACL continues.
28462
28463 If the argument is a named ACL, up to nine space-separated optional values
28464 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28465 and $acl_narg is set to the count of values.
28466 Previous values of these variables are restored after the call returns.
28467 The name and values are expanded separately.
28468 Note that spaces in complex expansions which are used as arguments
28469 will act as argument separators.
28470
28471 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28472 the connection is dropped. If it returns &"discard"&, the verb must be
28473 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28474 conditions are tested.
28475
28476 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28477 loops. This condition allows you to use different ACLs in different
28478 circumstances. For example, different ACLs can be used to handle RCPT commands
28479 for different local users or different local domains.
28480
28481 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28482 .cindex "&%authenticated%& ACL condition"
28483 .cindex "authentication" "ACL checking"
28484 .cindex "&ACL;" "testing for authentication"
28485 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28486 the name of the authenticator is tested against the list. To test for
28487 authentication by any authenticator, you can set
28488 .code
28489 authenticated = *
28490 .endd
28491
28492 .vitem &*condition&~=&~*&<&'string'&>
28493 .cindex "&%condition%& ACL condition"
28494 .cindex "customizing" "ACL condition"
28495 .cindex "&ACL;" "customized test"
28496 .cindex "&ACL;" "testing, customized"
28497 This feature allows you to make up custom conditions. If the result of
28498 expanding the string is an empty string, the number zero, or one of the strings
28499 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28500 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28501 any other value, some error is assumed to have occurred, and the ACL returns
28502 &"defer"&. However, if the expansion is forced to fail, the condition is
28503 ignored. The effect is to treat it as true, whether it is positive or
28504 negative.
28505
28506 .vitem &*decode&~=&~*&<&'location'&>
28507 .cindex "&%decode%& ACL condition"
28508 This condition is available only when Exim is compiled with the
28509 content-scanning extension, and it is allowed only in the ACL defined by
28510 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28511 If all goes well, the condition is true. It is false only if there are
28512 problems such as a syntax error or a memory shortage. For more details, see
28513 chapter &<<CHAPexiscan>>&.
28514
28515 .vitem &*demime&~=&~*&<&'extension&~list'&>
28516 .cindex "&%demime%& ACL condition"
28517 This condition is available only when Exim is compiled with the
28518 content-scanning extension. Its use is described in section
28519 &<<SECTdemimecond>>&.
28520
28521 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28522 .cindex "&%dnslists%& ACL condition"
28523 .cindex "DNS list" "in ACL"
28524 .cindex "black list (DNS)"
28525 .cindex "&ACL;" "testing a DNS list"
28526 This condition checks for entries in DNS black lists. These are also known as
28527 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28528 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28529 different variants of this condition to describe briefly here. See sections
28530 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28531
28532 .vitem &*domains&~=&~*&<&'domain&~list'&>
28533 .cindex "&%domains%& ACL condition"
28534 .cindex "domain" "ACL checking"
28535 .cindex "&ACL;" "testing a recipient domain"
28536 .vindex "&$domain_data$&"
28537 This condition is relevant only after a RCPT command. It checks that the domain
28538 of the recipient address is in the domain list. If percent-hack processing is
28539 enabled, it is done before this test is done. If the check succeeds with a
28540 lookup, the result of the lookup is placed in &$domain_data$& until the next
28541 &%domains%& test.
28542
28543 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28544 use &%domains%& in a DATA ACL.
28545
28546
28547 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28548 .cindex "&%encrypted%& ACL condition"
28549 .cindex "encryption" "checking in an ACL"
28550 .cindex "&ACL;" "testing for encryption"
28551 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28552 name of the cipher suite in use is tested against the list. To test for
28553 encryption without testing for any specific cipher suite(s), set
28554 .code
28555 encrypted = *
28556 .endd
28557
28558
28559 .vitem &*hosts&~=&~*&<&'host&~list'&>
28560 .cindex "&%hosts%& ACL condition"
28561 .cindex "host" "ACL checking"
28562 .cindex "&ACL;" "testing the client host"
28563 This condition tests that the calling host matches the host list. If you have
28564 name lookups or wildcarded host names and IP addresses in the same host list,
28565 you should normally put the IP addresses first. For example, you could have:
28566 .code
28567 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28568 .endd
28569 The lookup in this example uses the host name for its key. This is implied by
28570 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28571 and it wouldn't matter which way round you had these two items.)
28572
28573 The reason for the problem with host names lies in the left-to-right way that
28574 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28575 but when it reaches an item that requires a host name, it fails if it cannot
28576 find a host name to compare with the pattern. If the above list is given in the
28577 opposite order, the &%accept%& statement fails for a host whose name cannot be
28578 found, even if its IP address is 10.9.8.7.
28579
28580 If you really do want to do the name check first, and still recognize the IP
28581 address even if the name lookup fails, you can rewrite the ACL like this:
28582 .code
28583 accept hosts = dbm;/etc/friendly/hosts
28584 accept hosts = 10.9.8.7
28585 .endd
28586 The default action on failing to find the host name is to assume that the host
28587 is not in the list, so the first &%accept%& statement fails. The second
28588 statement can then check the IP address.
28589
28590 .vindex "&$host_data$&"
28591 If a &%hosts%& condition is satisfied by means of a lookup, the result
28592 of the lookup is made available in the &$host_data$& variable. This
28593 allows you, for example, to set up a statement like this:
28594 .code
28595 deny  hosts = net-lsearch;/some/file
28596 message = $host_data
28597 .endd
28598 which gives a custom error message for each denied host.
28599
28600 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28601 .cindex "&%local_parts%& ACL condition"
28602 .cindex "local part" "ACL checking"
28603 .cindex "&ACL;" "testing a local part"
28604 .vindex "&$local_part_data$&"
28605 This condition is relevant only after a RCPT command. It checks that the local
28606 part of the recipient address is in the list. If percent-hack processing is
28607 enabled, it is done before this test. If the check succeeds with a lookup, the
28608 result of the lookup is placed in &$local_part_data$&, which remains set until
28609 the next &%local_parts%& test.
28610
28611 .vitem &*malware&~=&~*&<&'option'&>
28612 .cindex "&%malware%& ACL condition"
28613 .cindex "&ACL;" "virus scanning"
28614 .cindex "&ACL;" "scanning for viruses"
28615 This condition is available only when Exim is compiled with the
28616 content-scanning extension. It causes the incoming message to be scanned for
28617 viruses. For details, see chapter &<<CHAPexiscan>>&.
28618
28619 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28620 .cindex "&%mime_regex%& ACL condition"
28621 .cindex "&ACL;" "testing by regex matching"
28622 This condition is available only when Exim is compiled with the
28623 content-scanning extension, and it is allowed only in the ACL defined by
28624 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28625 with any of the regular expressions. For details, see chapter
28626 &<<CHAPexiscan>>&.
28627
28628 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28629 .cindex "rate limiting"
28630 This condition can be used to limit the rate at which a user or host submits
28631 messages. Details are given in section &<<SECTratelimiting>>&.
28632
28633 .vitem &*recipients&~=&~*&<&'address&~list'&>
28634 .cindex "&%recipients%& ACL condition"
28635 .cindex "recipient" "ACL checking"
28636 .cindex "&ACL;" "testing a recipient"
28637 This condition is relevant only after a RCPT command. It checks the entire
28638 recipient address against a list of recipients.
28639
28640 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28641 .cindex "&%regex%& ACL condition"
28642 .cindex "&ACL;" "testing by regex matching"
28643 This condition is available only when Exim is compiled with the
28644 content-scanning extension, and is available only in the DATA, MIME, and
28645 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28646 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28647
28648 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28649 .cindex "&%sender_domains%& ACL condition"
28650 .cindex "sender" "ACL checking"
28651 .cindex "&ACL;" "testing a sender domain"
28652 .vindex "&$domain$&"
28653 .vindex "&$sender_address_domain$&"
28654 This condition tests the domain of the sender of the message against the given
28655 domain list. &*Note*&: The domain of the sender address is in
28656 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28657 of this condition. This is an exception to the general rule for testing domain
28658 lists. It is done this way so that, if this condition is used in an ACL for a
28659 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28660 influence the sender checking.
28661
28662 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28663 relaying, because sender addresses are easily, and commonly, forged.
28664
28665 .vitem &*senders&~=&~*&<&'address&~list'&>
28666 .cindex "&%senders%& ACL condition"
28667 .cindex "sender" "ACL checking"
28668 .cindex "&ACL;" "testing a sender"
28669 This condition tests the sender of the message against the given list. To test
28670 for a bounce message, which has an empty sender, set
28671 .code
28672 senders = :
28673 .endd
28674 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28675 relaying, because sender addresses are easily, and commonly, forged.
28676
28677 .vitem &*spam&~=&~*&<&'username'&>
28678 .cindex "&%spam%& ACL condition"
28679 .cindex "&ACL;" "scanning for spam"
28680 This condition is available only when Exim is compiled with the
28681 content-scanning extension. It causes the incoming message to be scanned by
28682 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28683
28684 .vitem &*verify&~=&~certificate*&
28685 .cindex "&%verify%& ACL condition"
28686 .cindex "TLS" "client certificate verification"
28687 .cindex "certificate" "verification of client"
28688 .cindex "&ACL;" "certificate verification"
28689 .cindex "&ACL;" "testing a TLS certificate"
28690 This condition is true in an SMTP session if the session is encrypted, and a
28691 certificate was received from the client, and the certificate was verified. The
28692 server requests a certificate only if the client matches &%tls_verify_hosts%&
28693 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28694
28695 .vitem &*verify&~=&~csa*&
28696 .cindex "CSA verification"
28697 This condition checks whether the sending host (the client) is authorized to
28698 send email. Details of how this works are given in section
28699 &<<SECTverifyCSA>>&.
28700
28701 .vitem &*verify&~=&~header_names_ascii*&
28702 .cindex "&%verify%& ACL condition"
28703 .cindex "&ACL;" "verifying header names only ASCII"
28704 .cindex "header lines" "verifying header names only ASCII"
28705 .cindex "verifying" "header names only ASCII"
28706 This condition is relevant only in an ACL that is run after a message has been
28707 received, that is, in an ACL specified by &%acl_smtp_data%& or
28708 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28709 there are no non-ASCII characters, also excluding control characters.  The
28710 allowable characters are decimal ASCII values 33 through 126.
28711
28712 Exim itself will handle headers with non-ASCII characters, but it can cause
28713 problems for downstream applications, so this option will allow their
28714 detection and rejection in the DATA ACL's.
28715
28716 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28717 .cindex "&%verify%& ACL condition"
28718 .cindex "&ACL;" "verifying sender in the header"
28719 .cindex "header lines" "verifying the sender in"
28720 .cindex "sender" "verifying in header"
28721 .cindex "verifying" "sender in header"
28722 This condition is relevant only in an ACL that is run after a message has been
28723 received, that is, in an ACL specified by &%acl_smtp_data%& or
28724 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28725 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28726 is loosely thought of as a &"sender"& address (hence the name of the test).
28727 However, an address that appears in one of these headers need not be an address
28728 that accepts bounce messages; only sender addresses in envelopes are required
28729 to accept bounces. Therefore, if you use the callout option on this check, you
28730 might want to arrange for a non-empty address in the MAIL command.
28731
28732 Details of address verification and the options are given later, starting at
28733 section &<<SECTaddressverification>>& (callouts are described in section
28734 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28735 condition to restrict it to bounce messages only:
28736 .code
28737 deny    senders = :
28738         message = A valid sender header is required for bounces
28739        !verify  = header_sender
28740 .endd
28741
28742 .vitem &*verify&~=&~header_syntax*&
28743 .cindex "&%verify%& ACL condition"
28744 .cindex "&ACL;" "verifying header syntax"
28745 .cindex "header lines" "verifying syntax"
28746 .cindex "verifying" "header syntax"
28747 This condition is relevant only in an ACL that is run after a message has been
28748 received, that is, in an ACL specified by &%acl_smtp_data%& or
28749 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28750 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28751 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28752 permitted only in locally generated messages and from hosts that match
28753 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28754 appropriate.
28755
28756 Note that this condition is a syntax check only. However, a common spamming
28757 ploy used to be to send syntactically invalid headers such as
28758 .code
28759 To: @
28760 .endd
28761 and this condition can be used to reject such messages, though they are not as
28762 common as they used to be.
28763
28764 .vitem &*verify&~=&~helo*&
28765 .cindex "&%verify%& ACL condition"
28766 .cindex "&ACL;" "verifying HELO/EHLO"
28767 .cindex "HELO" "verifying"
28768 .cindex "EHLO" "verifying"
28769 .cindex "verifying" "EHLO"
28770 .cindex "verifying" "HELO"
28771 This condition is true if a HELO or EHLO command has been received from the
28772 client host, and its contents have been verified. If there has been no previous
28773 attempt to verify the HELO/EHLO contents, it is carried out when this
28774 condition is encountered. See the description of the &%helo_verify_hosts%& and
28775 &%helo_try_verify_hosts%& options for details of how to request verification
28776 independently of this condition.
28777
28778 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28779 option), this condition is always true.
28780
28781
28782 .vitem &*verify&~=&~not_blind*&
28783 .cindex "verifying" "not blind"
28784 .cindex "bcc recipients, verifying none"
28785 This condition checks that there are no blind (bcc) recipients in the message.
28786 Every envelope recipient must appear either in a &'To:'& header line or in a
28787 &'Cc:'& header line for this condition to be true. Local parts are checked
28788 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28789 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28790 used only in a DATA or non-SMTP ACL.
28791
28792 There are, of course, many legitimate messages that make use of blind (bcc)
28793 recipients. This check should not be used on its own for blocking messages.
28794
28795
28796 .vitem &*verify&~=&~recipient/*&<&'options'&>
28797 .cindex "&%verify%& ACL condition"
28798 .cindex "&ACL;" "verifying recipient"
28799 .cindex "recipient" "verifying"
28800 .cindex "verifying" "recipient"
28801 .vindex "&$address_data$&"
28802 This condition is relevant only after a RCPT command. It verifies the current
28803 recipient. Details of address verification are given later, starting at section
28804 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28805 of &$address_data$& is the last value that was set while routing the address.
28806 This applies even if the verification fails. When an address that is being
28807 verified is redirected to a single address, verification continues with the new
28808 address, and in that case, the subsequent value of &$address_data$& is the
28809 value for the child address.
28810
28811 .vitem &*verify&~=&~reverse_host_lookup*&
28812 .cindex "&%verify%& ACL condition"
28813 .cindex "&ACL;" "verifying host reverse lookup"
28814 .cindex "host" "verifying reverse lookup"
28815 This condition ensures that a verified host name has been looked up from the IP
28816 address of the client host. (This may have happened already if the host name
28817 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28818 Verification ensures that the host name obtained from a reverse DNS lookup, or
28819 one of its aliases, does, when it is itself looked up in the DNS, yield the
28820 original IP address.
28821
28822 If this condition is used for a locally generated message (that is, when there
28823 is no client host involved), it always succeeds.
28824
28825 .vitem &*verify&~=&~sender/*&<&'options'&>
28826 .cindex "&%verify%& ACL condition"
28827 .cindex "&ACL;" "verifying sender"
28828 .cindex "sender" "verifying"
28829 .cindex "verifying" "sender"
28830 This condition is relevant only after a MAIL or RCPT command, or after a
28831 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28832 the message's sender is empty (that is, this is a bounce message), the
28833 condition is true. Otherwise, the sender address is verified.
28834
28835 .vindex "&$address_data$&"
28836 .vindex "&$sender_address_data$&"
28837 If there is data in the &$address_data$& variable at the end of routing, its
28838 value is placed in &$sender_address_data$& at the end of verification. This
28839 value can be used in subsequent conditions and modifiers in the same ACL
28840 statement. It does not persist after the end of the current statement. If you
28841 want to preserve the value for longer, you can save it in an ACL variable.
28842
28843 Details of verification are given later, starting at section
28844 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28845 to avoid doing it more than once per message.
28846
28847 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28848 .cindex "&%verify%& ACL condition"
28849 This is a variation of the previous option, in which a modified address is
28850 verified as a sender.
28851 .endlist
28852
28853
28854
28855 .section "Using DNS lists" "SECTmorednslists"
28856 .cindex "DNS list" "in ACL"
28857 .cindex "black list (DNS)"
28858 .cindex "&ACL;" "testing a DNS list"
28859 In its simplest form, the &%dnslists%& condition tests whether the calling host
28860 is on at least one of a number of DNS lists by looking up the inverted IP
28861 address in one or more DNS domains. (Note that DNS list domains are not mail
28862 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28863 special options instead.) For example, if the calling host's IP
28864 address is 192.168.62.43, and the ACL statement is
28865 .code
28866 deny dnslists = blackholes.mail-abuse.org : \
28867                 dialups.mail-abuse.org
28868 .endd
28869 the following records are looked up:
28870 .code
28871 43.62.168.192.blackholes.mail-abuse.org
28872 43.62.168.192.dialups.mail-abuse.org
28873 .endd
28874 As soon as Exim finds an existing DNS record, processing of the list stops.
28875 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28876 to test that a host is on more than one list (an &"and"& conjunction), you can
28877 use two separate conditions:
28878 .code
28879 deny dnslists = blackholes.mail-abuse.org
28880      dnslists = dialups.mail-abuse.org
28881 .endd
28882 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28883 behaves as if the host does not match the list item, that is, as if the DNS
28884 record does not exist. If there are further items in the DNS list, they are
28885 processed.
28886
28887 This is usually the required action when &%dnslists%& is used with &%deny%&
28888 (which is the most common usage), because it prevents a DNS failure from
28889 blocking mail. However, you can change this behaviour by putting one of the
28890 following special items in the list:
28891 .display
28892 &`+include_unknown `&   behave as if the item is on the list
28893 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28894 &`+defer_unknown   `&   give a temporary error
28895 .endd
28896 .cindex "&`+include_unknown`&"
28897 .cindex "&`+exclude_unknown`&"
28898 .cindex "&`+defer_unknown`&"
28899 Each of these applies to any subsequent items on the list. For example:
28900 .code
28901 deny dnslists = +defer_unknown : foo.bar.example
28902 .endd
28903 Testing the list of domains stops as soon as a match is found. If you want to
28904 warn for one list and block for another, you can use two different statements:
28905 .code
28906 deny  dnslists = blackholes.mail-abuse.org
28907 warn  message  = X-Warn: sending host is on dialups list
28908       dnslists = dialups.mail-abuse.org
28909 .endd
28910 DNS list lookups are cached by Exim for the duration of the SMTP session,
28911 so a lookup based on the IP address is done at most once for any incoming
28912 connection. Exim does not share information between multiple incoming
28913 connections (but your local name server cache should be active).
28914
28915
28916
28917 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28918 .cindex "DNS list" "keyed by explicit IP address"
28919 By default, the IP address that is used in a DNS list lookup is the IP address
28920 of the calling host. However, you can specify another IP address by listing it
28921 after the domain name, introduced by a slash. For example:
28922 .code
28923 deny dnslists = black.list.tld/192.168.1.2
28924 .endd
28925 This feature is not very helpful with explicit IP addresses; it is intended for
28926 use with IP addresses that are looked up, for example, the IP addresses of the
28927 MX hosts or nameservers of an email sender address. For an example, see section
28928 &<<SECTmulkeyfor>>& below.
28929
28930
28931
28932
28933 .section "DNS lists keyed on domain names" "SECID202"
28934 .cindex "DNS list" "keyed by domain name"
28935 There are some lists that are keyed on domain names rather than inverted IP
28936 addresses (see for example the &'domain based zones'& link at
28937 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28938 with these lists. You can change the name that is looked up in a DNS list by
28939 listing it after the domain name, introduced by a slash. For example,
28940 .code
28941 deny  message  = Sender's domain is listed at $dnslist_domain
28942       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28943 .endd
28944 This particular example is useful only in ACLs that are obeyed after the
28945 RCPT or DATA commands, when a sender address is available. If (for
28946 example) the message's sender is &'user@tld.example'& the name that is looked
28947 up by this example is
28948 .code
28949 tld.example.dsn.rfc-ignorant.org
28950 .endd
28951 A single &%dnslists%& condition can contain entries for both names and IP
28952 addresses. For example:
28953 .code
28954 deny dnslists = sbl.spamhaus.org : \
28955                 dsn.rfc-ignorant.org/$sender_address_domain
28956 .endd
28957 The first item checks the sending host's IP address; the second checks a domain
28958 name. The whole condition is true if either of the DNS lookups succeeds.
28959
28960
28961
28962
28963 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28964 .cindex "DNS list" "multiple keys for"
28965 The syntax described above for looking up explicitly-defined values (either
28966 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28967 name for the DNS list, what follows the slash can in fact be a list of items.
28968 As with all lists in Exim, the default separator is a colon. However, because
28969 this is a sublist within the list of DNS blacklist domains, it is necessary
28970 either to double the separators like this:
28971 .code
28972 dnslists = black.list.tld/name.1::name.2
28973 .endd
28974 or to change the separator character, like this:
28975 .code
28976 dnslists = black.list.tld/<;name.1;name.2
28977 .endd
28978 If an item in the list is an IP address, it is inverted before the DNS
28979 blacklist domain is appended. If it is not an IP address, no inversion
28980 occurs. Consider this condition:
28981 .code
28982 dnslists = black.list.tld/<;192.168.1.2;a.domain
28983 .endd
28984 The DNS lookups that occur are:
28985 .code
28986 2.1.168.192.black.list.tld
28987 a.domain.black.list.tld
28988 .endd
28989 Once a DNS record has been found (that matches a specific IP return
28990 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28991 are done. If there is a temporary DNS error, the rest of the sublist of domains
28992 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28993 only if no other DNS lookup in this sublist succeeds. In other words, a
28994 successful lookup for any of the items in the sublist overrides a temporary
28995 error for a previous item.
28996
28997 The ability to supply a list of items after the slash is in some sense just a
28998 syntactic convenience. These two examples have the same effect:
28999 .code
29000 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29001 dnslists = black.list.tld/a.domain::b.domain
29002 .endd
29003 However, when the data for the list is obtained from a lookup, the second form
29004 is usually much more convenient. Consider this example:
29005 .code
29006 deny message  = The mail servers for the domain \
29007                 $sender_address_domain \
29008                 are listed at $dnslist_domain ($dnslist_value); \
29009                 see $dnslist_text.
29010      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29011                                    ${lookup dnsdb {>|mxh=\
29012                                    $sender_address_domain} }} }
29013 .endd
29014 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29015 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29016 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29017 of expanding the condition might be something like this:
29018 .code
29019 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29020 .endd
29021 Thus, this example checks whether or not the IP addresses of the sender
29022 domain's mail servers are on the Spamhaus black list.
29023
29024 The key that was used for a successful DNS list lookup is put into the variable
29025 &$dnslist_matched$& (see section &<<SECID204>>&).
29026
29027
29028
29029
29030 .section "Data returned by DNS lists" "SECID203"
29031 .cindex "DNS list" "data returned from"
29032 DNS lists are constructed using address records in the DNS. The original RBL
29033 just used the address 127.0.0.1 on the right hand side of each record, but the
29034 RBL+ list and some other lists use a number of values with different meanings.
29035 The values used on the RBL+ list are:
29036 .display
29037 127.1.0.1  RBL
29038 127.1.0.2  DUL
29039 127.1.0.3  DUL and RBL
29040 127.1.0.4  RSS
29041 127.1.0.5  RSS and RBL
29042 127.1.0.6  RSS and DUL
29043 127.1.0.7  RSS and DUL and RBL
29044 .endd
29045 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29046 different values. Some DNS lists may return more than one address record;
29047 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29048
29049
29050 .section "Variables set from DNS lists" "SECID204"
29051 .cindex "expansion" "variables, set from DNS list"
29052 .cindex "DNS list" "variables set from"
29053 .vindex "&$dnslist_domain$&"
29054 .vindex "&$dnslist_matched$&"
29055 .vindex "&$dnslist_text$&"
29056 .vindex "&$dnslist_value$&"
29057 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29058 the name of the overall domain that matched (for example,
29059 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29060 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29061 the DNS record. When the key is an IP address, it is not reversed in
29062 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29063 cases, for example:
29064 .code
29065 deny dnslists = spamhaus.example
29066 .endd
29067 the key is also available in another variable (in this case,
29068 &$sender_host_address$&). In more complicated cases, however, this is not true.
29069 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29070 might generate a dnslists lookup like this:
29071 .code
29072 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29073 .endd
29074 If this condition succeeds, the value in &$dnslist_matched$& might be
29075 &`192.168.6.7`& (for example).
29076
29077 If more than one address record is returned by the DNS lookup, all the IP
29078 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29079 The variable &$dnslist_text$& contains the contents of any associated TXT
29080 record. For lists such as RBL+ the TXT record for a merged entry is often not
29081 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29082 information.
29083
29084 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29085 &-- although these appear before the condition in the ACL, they are not
29086 expanded until after it has failed. For example:
29087 .code
29088 deny    hosts = !+local_networks
29089         message = $sender_host_address is listed \
29090                   at $dnslist_domain
29091         dnslists = rbl-plus.mail-abuse.example
29092 .endd
29093
29094
29095
29096 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29097 .cindex "DNS list" "matching specific returned data"
29098 You can add an equals sign and an IP address after a &%dnslists%& domain name
29099 in order to restrict its action to DNS records with a matching right hand side.
29100 For example,
29101 .code
29102 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29103 .endd
29104 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29105 any address record is considered to be a match. For the moment, we assume
29106 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29107 describes how multiple records are handled.
29108
29109 More than one IP address may be given for checking, using a comma as a
29110 separator. These are alternatives &-- if any one of them matches, the
29111 &%dnslists%& condition is true. For example:
29112 .code
29113 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29114 .endd
29115 If you want to specify a constraining address list and also specify names or IP
29116 addresses to be looked up, the constraining address list must be specified
29117 first. For example:
29118 .code
29119 deny dnslists = dsn.rfc-ignorant.org\
29120                 =127.0.0.2/$sender_address_domain
29121 .endd
29122
29123 If the character &`&&`& is used instead of &`=`&, the comparison for each
29124 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29125 In other words, the listed addresses are used as bit masks. The comparison is
29126 true if all the bits in the mask are present in the address that is being
29127 tested. For example:
29128 .code
29129 dnslists = a.b.c&0.0.0.3
29130 .endd
29131 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29132 want to test whether one bit or another bit is present (as opposed to both
29133 being present), you must use multiple values. For example:
29134 .code
29135 dnslists = a.b.c&0.0.0.1,0.0.0.2
29136 .endd
29137 matches if the final component of the address is an odd number or two times
29138 an odd number.
29139
29140
29141
29142 .section "Negated DNS matching conditions" "SECID205"
29143 You can supply a negative list of IP addresses as part of a &%dnslists%&
29144 condition. Whereas
29145 .code
29146 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29147 .endd
29148 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29149 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29150 .code
29151 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29152 .endd
29153 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29154 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29155 words, the result of the test is inverted if an exclamation mark appears before
29156 the &`=`& (or the &`&&`&) sign.
29157
29158 &*Note*&: This kind of negation is not the same as negation in a domain,
29159 host, or address list (which is why the syntax is different).
29160
29161 If you are using just one list, the negation syntax does not gain you much. The
29162 previous example is precisely equivalent to
29163 .code
29164 deny  dnslists = a.b.c
29165      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29166 .endd
29167 However, if you are using multiple lists, the negation syntax is clearer.
29168 Consider this example:
29169 .code
29170 deny  dnslists = sbl.spamhaus.org : \
29171                  list.dsbl.org : \
29172                  dnsbl.njabl.org!=127.0.0.3 : \
29173                  relays.ordb.org
29174 .endd
29175 Using only positive lists, this would have to be:
29176 .code
29177 deny  dnslists = sbl.spamhaus.org : \
29178                  list.dsbl.org
29179 deny  dnslists = dnsbl.njabl.org
29180      !dnslists = dnsbl.njabl.org=127.0.0.3
29181 deny  dnslists = relays.ordb.org
29182 .endd
29183 which is less clear, and harder to maintain.
29184
29185
29186
29187
29188 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29189 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29190 thereby providing more than one IP address. When an item in a &%dnslists%& list
29191 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29192 the match to specific results from the DNS lookup, there are two ways in which
29193 the checking can be handled. For example, consider the condition:
29194 .code
29195 dnslists = a.b.c=127.0.0.1
29196 .endd
29197 What happens if the DNS lookup for the incoming IP address yields both
29198 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29199 condition true because at least one given value was found, or is it false
29200 because at least one of the found values was not listed? And how does this
29201 affect negated conditions? Both possibilities are provided for with the help of
29202 additional separators &`==`& and &`=&&`&.
29203
29204 .ilist
29205 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29206 IP addresses matches one of the listed addresses. For the example above, the
29207 condition is true because 127.0.0.1 matches.
29208 .next
29209 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29210 looked up IP addresses matches one of the listed addresses. If the condition is
29211 changed to:
29212 .code
29213 dnslists = a.b.c==127.0.0.1
29214 .endd
29215 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29216 false because 127.0.0.2 is not listed. You would need to have:
29217 .code
29218 dnslists = a.b.c==127.0.0.1,127.0.0.2
29219 .endd
29220 for the condition to be true.
29221 .endlist
29222
29223 When &`!`& is used to negate IP address matching, it inverts the result, giving
29224 the precise opposite of the behaviour above. Thus:
29225 .ilist
29226 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29227 addresses matches one of the listed addresses. Consider:
29228 .code
29229 dnslists = a.b.c!&0.0.0.1
29230 .endd
29231 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29232 false because 127.0.0.1 matches.
29233 .next
29234 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29235 looked up IP address that does not match. Consider:
29236 .code
29237 dnslists = a.b.c!=&0.0.0.1
29238 .endd
29239 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29240 true, because 127.0.0.2 does not match. You would need to have:
29241 .code
29242 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29243 .endd
29244 for the condition to be false.
29245 .endlist
29246 When the DNS lookup yields only a single IP address, there is no difference
29247 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29248
29249
29250
29251
29252 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29253 .cindex "DNS list" "information from merged"
29254 When the facility for restricting the matching IP values in a DNS list is used,
29255 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29256 the true reason for rejection. This happens when lists are merged and the IP
29257 address in the A record is used to distinguish them; unfortunately there is
29258 only one TXT record. One way round this is not to use merged lists, but that
29259 can be inefficient because it requires multiple DNS lookups where one would do
29260 in the vast majority of cases when the host of interest is not on any of the
29261 lists.
29262
29263 A less inefficient way of solving this problem is available. If
29264 two domain names, comma-separated, are given, the second is used first to
29265 do an initial check, making use of any IP value restrictions that are set.
29266 If there is a match, the first domain is used, without any IP value
29267 restrictions, to get the TXT record. As a byproduct of this, there is also
29268 a check that the IP being tested is indeed on the first list. The first
29269 domain is the one that is put in &$dnslist_domain$&. For example:
29270 .code
29271 reject message  = \
29272          rejected because $sender_host_address is blacklisted \
29273          at $dnslist_domain\n$dnslist_text
29274        dnslists = \
29275          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29276          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29277 .endd
29278 For the first blacklist item, this starts by doing a lookup in
29279 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29280 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29281 value, and as long as something is found, it looks for the corresponding TXT
29282 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29283 The second blacklist item is processed similarly.
29284
29285 If you are interested in more than one merged list, the same list must be
29286 given several times, but because the results of the DNS lookups are cached,
29287 the DNS calls themselves are not repeated. For example:
29288 .code
29289 reject dnslists = \
29290          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29291          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29292          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29293          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29294 .endd
29295 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29296 values matches (or if no record is found), this is the only lookup that is
29297 done. Only if there is a match is one of the more specific lists consulted.
29298
29299
29300
29301 .section "DNS lists and IPv6" "SECTmorednslistslast"
29302 .cindex "IPv6" "DNS black lists"
29303 .cindex "DNS list" "IPv6 usage"
29304 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29305 nibble by nibble. For example, if the calling host's IP address is
29306 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29307 .code
29308 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29309   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29310 .endd
29311 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29312 lists contain wildcard records, intended for IPv4, that interact badly with
29313 IPv6. For example, the DNS entry
29314 .code
29315 *.3.some.list.example.    A    127.0.0.1
29316 .endd
29317 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29318 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29319
29320 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29321 &%condition%& condition, as in this example:
29322 .code
29323 deny   condition = ${if isip4{$sender_host_address}}
29324        dnslists  = some.list.example
29325 .endd
29326
29327 If an explicit key is being used for a DNS lookup and it may be an IPv6
29328 address you should specify alternate list separators for both the outer
29329 (DNS list name) list and inner (lookup keys) list:
29330 .code
29331        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29332 .endd
29333
29334 .section "Rate limiting incoming messages" "SECTratelimiting"
29335 .cindex "rate limiting" "client sending"
29336 .cindex "limiting client sending rates"
29337 .oindex "&%smtp_ratelimit_*%&"
29338 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29339 which clients can send email. This is more powerful than the
29340 &%smtp_ratelimit_*%& options, because those options control the rate of
29341 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29342 works across all connections (concurrent and sequential) from the same client
29343 host. The syntax of the &%ratelimit%& condition is:
29344 .display
29345 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29346 .endd
29347 If the average client sending rate is less than &'m'& messages per time
29348 period &'p'& then the condition is false; otherwise it is true.
29349
29350 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29351 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29352 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29353 of &'p'&.
29354
29355 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29356 time interval, for example, &`8h`& for eight hours. A larger time constant
29357 means that it takes Exim longer to forget a client's past behaviour. The
29358 parameter &'m'& is the maximum number of messages that a client is permitted to
29359 send in each time interval. It also specifies the number of messages permitted
29360 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29361 constant, you can allow a client to send more messages in a burst without
29362 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29363 both small, messages must be sent at an even rate.
29364
29365 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29366 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29367 when deploying the &%ratelimit%& ACL condition. The script prints usage
29368 instructions when it is run with no arguments.
29369
29370 The key is used to look up the data for calculating the client's average
29371 sending rate. This data is stored in Exim's spool directory, alongside the
29372 retry and other hints databases. The default key is &$sender_host_address$&,
29373 which means Exim computes the sending rate of each client host IP address.
29374 By changing the key you can change how Exim identifies clients for the purpose
29375 of ratelimiting. For example, to limit the sending rate of each authenticated
29376 user, independent of the computer they are sending from, set the key to
29377 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29378 example, &$authenticated_id$& is only meaningful if the client has
29379 authenticated (which you can check with the &%authenticated%& ACL condition).
29380
29381 The lookup key does not have to identify clients: If you want to limit the
29382 rate at which a recipient receives messages, you can use the key
29383 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29384 ACL.
29385
29386 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29387 specifies what Exim measures the rate of, for example messages or recipients
29388 or bytes. You can adjust the measurement using the &%unique=%& and/or
29389 &%count=%& options. You can also control when Exim updates the recorded rate
29390 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29391 separated by a slash, like the other parameters. They may appear in any order.
29392
29393 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29394 any options that alter the meaning of the stored data. The limit &'m'& is not
29395 stored, so you can alter the configured maximum rate and Exim will still
29396 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29397 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29398 behaviour. The lookup key is not affected by changes to the update mode and
29399 the &%count=%& option.
29400
29401
29402 .section "Ratelimit options for what is being measured" "ratoptmea"
29403 .cindex "rate limiting" "per_* options"
29404 The &%per_conn%& option limits the client's connection rate. It is not
29405 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29406 &%acl_not_smtp_start%& ACLs.
29407
29408 The &%per_mail%& option limits the client's rate of sending messages. This is
29409 the default if none of the &%per_*%& options is specified. It can be used in
29410 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29411 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29412
29413 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29414 the same ACLs as the &%per_mail%& option, though it is best to use this option
29415 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29416 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29417 in its MAIL command, which may be inaccurate or completely missing. You can
29418 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29419 in kilobytes, megabytes, or gigabytes, respectively.
29420
29421 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29422 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29423 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29424 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29425 ACLs the rate is updated with the total recipient count in one go. Note that
29426 in either case the rate limiting engine will see a message with many
29427 recipients as a large high-speed burst.
29428
29429 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29430 number of different recipients that the client has sent messages to in the
29431 last time period. That is, if the client repeatedly sends messages to the same
29432 recipient, its measured rate is not increased. This option can only be used in
29433 &%acl_smtp_rcpt%&.
29434
29435 The &%per_cmd%& option causes Exim to recompute the rate every time the
29436 condition is processed. This can be used to limit the rate of any SMTP
29437 command. If it is used in multiple ACLs it can limit the aggregate rate of
29438 multiple different commands.
29439
29440 The &%count=%& option can be used to alter how much Exim adds to the client's
29441 measured rate. For example, the &%per_byte%& option is equivalent to
29442 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29443 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29444 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29445
29446 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29447
29448
29449 .section "Ratelimit update modes" "ratoptupd"
29450 .cindex "rate limiting" "reading data without updating"
29451 You can specify one of three options with the &%ratelimit%& condition to
29452 control when its database is updated. This section describes the &%readonly%&
29453 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29454
29455 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29456 previously-computed rate to check against the limit.
29457
29458 For example, you can test the client's sending rate and deny it access (when
29459 it is too fast) in the connect ACL. If the client passes this check then it
29460 can go on to send a message, in which case its recorded rate will be updated
29461 in the MAIL ACL. Subsequent connections from the same client will check this
29462 new rate.
29463 .code
29464 acl_check_connect:
29465  deny ratelimit = 100 / 5m / readonly
29466     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29467                   (max $sender_rate_limit)
29468 # ...
29469 acl_check_mail:
29470  warn ratelimit = 100 / 5m / strict
29471     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29472                   (max $sender_rate_limit)
29473 .endd
29474
29475 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29476 processing a message then it may increase the client's measured rate more than
29477 it should. For example, this will happen if you check the &%per_rcpt%& option
29478 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29479 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29480 multiple update problems by using the &%readonly%& option on later ratelimit
29481 checks.
29482
29483 The &%per_*%& options described above do not make sense in some ACLs. If you
29484 use a &%per_*%& option in an ACL where it is not normally permitted then the
29485 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29486 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29487 next section) so you must specify the &%readonly%& option explicitly.
29488
29489
29490 .section "Ratelimit options for handling fast clients" "ratoptfast"
29491 .cindex "rate limiting" "strict and leaky modes"
29492 If a client's average rate is greater than the maximum, the rate limiting
29493 engine can react in two possible ways, depending on the presence of the
29494 &%strict%& or &%leaky%& update modes. This is independent of the other
29495 counter-measures (such as rejecting the message) that may be specified by the
29496 rest of the ACL.
29497
29498 The &%leaky%& (default) option means that the client's recorded rate is not
29499 updated if it is above the limit. The effect of this is that Exim measures the
29500 client's average rate of successfully sent email, which cannot be greater than
29501 the maximum allowed. If the client is over the limit it may suffer some
29502 counter-measures (as specified in the ACL), but it will still be able to send
29503 email at the configured maximum rate, whatever the rate of its attempts. This
29504 is generally the better choice if you have clients that retry automatically.
29505 For example, it does not prevent a sender with an over-aggressive retry rate
29506 from getting any email through.
29507
29508 The &%strict%& option means that the client's recorded rate is always
29509 updated. The effect of this is that Exim measures the client's average rate
29510 of attempts to send email, which can be much higher than the maximum it is
29511 actually allowed. If the client is over the limit it may be subjected to
29512 counter-measures by the ACL. It must slow down and allow sufficient time to
29513 pass that its computed rate falls below the maximum before it can send email
29514 again. The time (the number of smoothing periods) it must wait and not
29515 attempt to send mail can be calculated with this formula:
29516 .code
29517         ln(peakrate/maxrate)
29518 .endd
29519
29520
29521 .section "Limiting the rate of different events" "ratoptuniq"
29522 .cindex "rate limiting" "counting unique events"
29523 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29524 rate of different events. For example, the &%per_addr%& option uses this
29525 mechanism to count the number of different recipients that the client has
29526 sent messages to in the last time period; it is equivalent to
29527 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29528 measure the rate that a client uses different sender addresses with the
29529 options &`per_mail/unique=$sender_address`&.
29530
29531 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29532 has seen for that key. The whole set is thrown away when it is older than the
29533 rate smoothing period &'p'&, so each different event is counted at most once
29534 per period. In the &%leaky%& update mode, an event that causes the client to
29535 go over the limit is not added to the set, in the same way that the client's
29536 recorded rate is not updated in the same situation.
29537
29538 When you combine the &%unique=%& and &%readonly%& options, the specific
29539 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29540 rate.
29541
29542 The &%unique=%& mechanism needs more space in the ratelimit database than the
29543 other &%ratelimit%& options in order to store the event set. The number of
29544 unique values is potentially as large as the rate limit, so the extra space
29545 required increases with larger limits.
29546
29547 The uniqueification is not perfect: there is a small probability that Exim
29548 will think a new event has happened before. If the sender's rate is less than
29549 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29550 the measured rate can go above the limit, in which case Exim may under-count
29551 events by a significant margin. Fortunately, if the rate is high enough (2.7
29552 times the limit) that the false positive rate goes above 9%, then Exim will
29553 throw away the over-full event set before the measured rate falls below the
29554 limit. Therefore the only harm should be that exceptionally high sending rates
29555 are logged incorrectly; any countermeasures you configure will be as effective
29556 as intended.
29557
29558
29559 .section "Using rate limiting" "useratlim"
29560 Exim's other ACL facilities are used to define what counter-measures are taken
29561 when the rate limit is exceeded. This might be anything from logging a warning
29562 (for example, while measuring existing sending rates in order to define
29563 policy), through time delays to slow down fast senders, up to rejecting the
29564 message. For example:
29565 .code
29566 # Log all senders' rates
29567 warn ratelimit = 0 / 1h / strict
29568      log_message = Sender rate $sender_rate / $sender_rate_period
29569
29570 # Slow down fast senders; note the need to truncate $sender_rate
29571 # at the decimal point.
29572 warn ratelimit = 100 / 1h / per_rcpt / strict
29573      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29574                    $sender_rate_limit }s
29575
29576 # Keep authenticated users under control
29577 deny authenticated = *
29578      ratelimit = 100 / 1d / strict / $authenticated_id
29579
29580 # System-wide rate limit
29581 defer message = Sorry, too busy. Try again later.
29582      ratelimit = 10 / 1s / $primary_hostname
29583
29584 # Restrict incoming rate from each host, with a default
29585 # set using a macro and special cases looked up in a table.
29586 defer message = Sender rate exceeds $sender_rate_limit \
29587                messages per $sender_rate_period
29588      ratelimit = ${lookup {$sender_host_address} \
29589                    cdb {DB/ratelimits.cdb} \
29590                    {$value} {RATELIMIT} }
29591 .endd
29592 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29593 especially with the &%per_rcpt%& option, you may suffer from a performance
29594 bottleneck caused by locking on the ratelimit hints database. Apart from
29595 making your ACLs less complicated, you can reduce the problem by using a
29596 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29597 this means that Exim will lose its hints data after a reboot (including retry
29598 hints, the callout cache, and ratelimit data).
29599
29600
29601
29602 .section "Address verification" "SECTaddressverification"
29603 .cindex "verifying address" "options for"
29604 .cindex "policy control" "address verification"
29605 Several of the &%verify%& conditions described in section
29606 &<<SECTaclconditions>>& cause addresses to be verified. Section
29607 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29608 The verification conditions can be followed by options that modify the
29609 verification process. The options are separated from the keyword and from each
29610 other by slashes, and some of them contain parameters. For example:
29611 .code
29612 verify = sender/callout
29613 verify = recipient/defer_ok/callout=10s,defer_ok
29614 .endd
29615 The first stage of address verification, which always happens, is to run the
29616 address through the routers, in &"verify mode"&. Routers can detect the
29617 difference between verification and routing for delivery, and their actions can
29618 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29619 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29620 The available options are as follows:
29621
29622 .ilist
29623 If the &%callout%& option is specified, successful routing to one or more
29624 remote hosts is followed by a &"callout"& to those hosts as an additional
29625 check. Callouts and their sub-options are discussed in the next section.
29626 .next
29627 If there is a defer error while doing verification routing, the ACL
29628 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29629 options, the condition is forced to be true instead. Note that this is a main
29630 verification option as well as a suboption for callouts.
29631 .next
29632 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29633 discusses the reporting of sender address verification failures.
29634 .next
29635 The &%success_on_redirect%& option causes verification always to succeed
29636 immediately after a successful redirection. By default, if a redirection
29637 generates just one address, that address is also verified. See further
29638 discussion in section &<<SECTredirwhilveri>>&.
29639 .endlist
29640
29641 .cindex "verifying address" "differentiating failures"
29642 .vindex "&$recipient_verify_failure$&"
29643 .vindex "&$sender_verify_failure$&"
29644 .vindex "&$acl_verify_message$&"
29645 After an address verification failure, &$acl_verify_message$& contains the
29646 error message that is associated with the failure. It can be preserved by
29647 coding like this:
29648 .code
29649 warn  !verify = sender
29650        set acl_m0 = $acl_verify_message
29651 .endd
29652 If you are writing your own custom rejection message or log message when
29653 denying access, you can use this variable to include information about the
29654 verification failure.
29655
29656 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29657 appropriate) contains one of the following words:
29658
29659 .ilist
29660 &%qualify%&: The address was unqualified (no domain), and the message
29661 was neither local nor came from an exempted host.
29662 .next
29663 &%route%&: Routing failed.
29664 .next
29665 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29666 occurred at or before the MAIL command (that is, on initial
29667 connection, HELO, or MAIL).
29668 .next
29669 &%recipient%&: The RCPT command in a callout was rejected.
29670 .next
29671 &%postmaster%&: The postmaster check in a callout was rejected.
29672 .endlist
29673
29674 The main use of these variables is expected to be to distinguish between
29675 rejections of MAIL and rejections of RCPT in callouts.
29676
29677
29678
29679
29680 .section "Callout verification" "SECTcallver"
29681 .cindex "verifying address" "by callout"
29682 .cindex "callout" "verification"
29683 .cindex "SMTP" "callout verification"
29684 For non-local addresses, routing verifies the domain, but is unable to do any
29685 checking of the local part. There are situations where some means of verifying
29686 the local part is desirable. One way this can be done is to make an SMTP
29687 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29688 a subsequent host for a recipient address, to see if the host accepts the
29689 address. We use the term &'callout'& to cover both cases. Note that for a
29690 sender address, the callback is not to the client host that is trying to
29691 deliver the message, but to one of the hosts that accepts incoming mail for the
29692 sender's domain.
29693
29694 Exim does not do callouts by default. If you want them to happen, you must
29695 request them by setting appropriate options on the &%verify%& condition, as
29696 described below. This facility should be used with care, because it can add a
29697 lot of resource usage to the cost of verifying an address. However, Exim does
29698 cache the results of callouts, which helps to reduce the cost. Details of
29699 caching are in section &<<SECTcallvercache>>&.
29700
29701 Recipient callouts are usually used only between hosts that are controlled by
29702 the same administration. For example, a corporate gateway host could use
29703 callouts to check for valid recipients on an internal mailserver. A successful
29704 callout does not guarantee that a real delivery to the address would succeed;
29705 on the other hand, a failing callout does guarantee that a delivery would fail.
29706
29707 If the &%callout%& option is present on a condition that verifies an address, a
29708 second stage of verification occurs if the address is successfully routed to
29709 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29710 &(manualroute)& router, where the router specifies the hosts. However, if a
29711 router that does not set up hosts routes to an &(smtp)& transport with a
29712 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29713 &%hosts_override%& set, its hosts are always used, whether or not the router
29714 supplies a host list.
29715 Callouts are only supported on &(smtp)& transports.
29716
29717 The port that is used is taken from the transport, if it is specified and is a
29718 remote transport. (For routers that do verification only, no transport need be
29719 specified.) Otherwise, the default SMTP port is used. If a remote transport
29720 specifies an outgoing interface, this is used; otherwise the interface is not
29721 specified. Likewise, the text that is used for the HELO command is taken from
29722 the transport's &%helo_data%& option; if there is no transport, the value of
29723 &$smtp_active_hostname$& is used.
29724
29725 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29726 test whether a bounce message could be delivered to the sender address. The
29727 following SMTP commands are sent:
29728 .display
29729 &`HELO `&<&'local host name'&>
29730 &`MAIL FROM:<>`&
29731 &`RCPT TO:`&<&'the address to be tested'&>
29732 &`QUIT`&
29733 .endd
29734 LHLO is used instead of HELO if the transport's &%protocol%& option is
29735 set to &"lmtp"&.
29736
29737 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29738 settings.
29739
29740 A recipient callout check is similar. By default, it also uses an empty address
29741 for the sender. This default is chosen because most hosts do not make use of
29742 the sender address when verifying a recipient. Using the same address means
29743 that a single cache entry can be used for each recipient. Some sites, however,
29744 do make use of the sender address when verifying. These are catered for by the
29745 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29746
29747 If the response to the RCPT command is a 2&'xx'& code, the verification
29748 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29749 Exim tries the next host, if any. If there is a problem with all the remote
29750 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29751 &%callout%& option is given, in which case the condition is forced to succeed.
29752
29753 .cindex "SMTP" "output flushing, disabling for callout"
29754 A callout may take a little time. For this reason, Exim normally flushes SMTP
29755 output before performing a callout in an ACL, to avoid unexpected timeouts in
29756 clients when the SMTP PIPELINING extension is in use. The flushing can be
29757 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29758
29759
29760
29761
29762 .section "Additional parameters for callouts" "CALLaddparcall"
29763 .cindex "callout" "additional parameters for"
29764 The &%callout%& option can be followed by an equals sign and a number of
29765 optional parameters, separated by commas. For example:
29766 .code
29767 verify = recipient/callout=10s,defer_ok
29768 .endd
29769 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29770 separate verify options, is retained for backwards compatibility, but is now
29771 deprecated. The additional parameters for &%callout%& are as follows:
29772
29773
29774 .vlist
29775 .vitem <&'a&~time&~interval'&>
29776 .cindex "callout" "timeout, specifying"
29777 This specifies the timeout that applies for the callout attempt to each host.
29778 For example:
29779 .code
29780 verify = sender/callout=5s
29781 .endd
29782 The default is 30 seconds. The timeout is used for each response from the
29783 remote host. It is also used for the initial connection, unless overridden by
29784 the &%connect%& parameter.
29785
29786
29787 .vitem &*connect&~=&~*&<&'time&~interval'&>
29788 .cindex "callout" "connection timeout, specifying"
29789 This parameter makes it possible to set a different (usually smaller) timeout
29790 for making the SMTP connection. For example:
29791 .code
29792 verify = sender/callout=5s,connect=1s
29793 .endd
29794 If not specified, this timeout defaults to the general timeout value.
29795
29796 .vitem &*defer_ok*&
29797 .cindex "callout" "defer, action on"
29798 When this parameter is present, failure to contact any host, or any other kind
29799 of temporary error, is treated as success by the ACL. However, the cache is not
29800 updated in this circumstance.
29801
29802 .vitem &*fullpostmaster*&
29803 .cindex "callout" "full postmaster check"
29804 This operates like the &%postmaster%& option (see below), but if the check for
29805 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29806 accordance with the specification in RFC 2821. The RFC states that the
29807 unqualified address &'postmaster'& should be accepted.
29808
29809
29810 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29811 .cindex "callout" "sender when verifying header"
29812 When verifying addresses in header lines using the &%header_sender%&
29813 verification option, Exim behaves by default as if the addresses are envelope
29814 sender addresses from a message. Callout verification therefore tests to see
29815 whether a bounce message could be delivered, by using an empty address in the
29816 MAIL command. However, it is arguable that these addresses might never be used
29817 as envelope senders, and could therefore justifiably reject bounce messages
29818 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29819 address to use in the MAIL command. For example:
29820 .code
29821 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29822 .endd
29823 This parameter is available only for the &%header_sender%& verification option.
29824
29825
29826 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29827 .cindex "callout" "overall timeout, specifying"
29828 This parameter sets an overall timeout for performing a callout verification.
29829 For example:
29830 .code
29831 verify = sender/callout=5s,maxwait=30s
29832 .endd
29833 This timeout defaults to four times the callout timeout for individual SMTP
29834 commands. The overall timeout applies when there is more than one host that can
29835 be tried. The timeout is checked before trying the next host. This prevents
29836 very long delays if there are a large number of hosts and all are timing out
29837 (for example, when network connections are timing out).
29838
29839
29840 .vitem &*no_cache*&
29841 .cindex "callout" "cache, suppressing"
29842 .cindex "caching callout, suppressing"
29843 When this parameter is given, the callout cache is neither read nor updated.
29844
29845 .vitem &*postmaster*&
29846 .cindex "callout" "postmaster; checking"
29847 When this parameter is set, a successful callout check is followed by a similar
29848 check for the local part &'postmaster'& at the same domain. If this address is
29849 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29850 the postmaster check is recorded in a cache record; if it is a failure, this is
29851 used to fail subsequent callouts for the domain without a connection being
29852 made, until the cache record expires.
29853
29854 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29855 The postmaster check uses an empty sender in the MAIL command by default.
29856 You can use this parameter to do a postmaster check using a different address.
29857 For example:
29858 .code
29859 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29860 .endd
29861 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29862 one overrides. The &%postmaster%& parameter is equivalent to this example:
29863 .code
29864 require  verify = sender/callout=postmaster_mailfrom=
29865 .endd
29866 &*Warning*&: The caching arrangements for postmaster checking do not take
29867 account of the sender address. It is assumed that either the empty address or
29868 a fixed non-empty address will be used. All that Exim remembers is that the
29869 postmaster check for the domain succeeded or failed.
29870
29871
29872 .vitem &*random*&
29873 .cindex "callout" "&""random""& check"
29874 When this parameter is set, before doing the normal callout check, Exim does a
29875 check for a &"random"& local part at the same domain. The local part is not
29876 really random &-- it is defined by the expansion of the option
29877 &%callout_random_local_part%&, which defaults to
29878 .code
29879 $primary_hostname-$tod_epoch-testing
29880 .endd
29881 The idea here is to try to determine whether the remote host accepts all local
29882 parts without checking. If it does, there is no point in doing callouts for
29883 specific local parts. If the &"random"& check succeeds, the result is saved in
29884 a cache record, and used to force the current and subsequent callout checks to
29885 succeed without a connection being made, until the cache record expires.
29886
29887 .vitem &*use_postmaster*&
29888 .cindex "callout" "sender for recipient check"
29889 This parameter applies to recipient callouts only. For example:
29890 .code
29891 deny  !verify = recipient/callout=use_postmaster
29892 .endd
29893 .vindex "&$qualify_domain$&"
29894 It causes a non-empty postmaster address to be used in the MAIL command when
29895 performing the callout for the recipient, and also for a &"random"& check if
29896 that is configured. The local part of the address is &`postmaster`& and the
29897 domain is the contents of &$qualify_domain$&.
29898
29899 .vitem &*use_sender*&
29900 This option applies to recipient callouts only. For example:
29901 .code
29902 require  verify = recipient/callout=use_sender
29903 .endd
29904 It causes the message's actual sender address to be used in the MAIL
29905 command when performing the callout, instead of an empty address. There is no
29906 need to use this option unless you know that the called hosts make use of the
29907 sender when checking recipients. If used indiscriminately, it reduces the
29908 usefulness of callout caching.
29909 .endlist
29910
29911 If you use any of the parameters that set a non-empty sender for the MAIL
29912 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29913 &%use_sender%&), you should think about possible loops. Recipient checking is
29914 usually done between two hosts that are under the same management, and the host
29915 that receives the callouts is not normally configured to do callouts itself.
29916 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29917 these circumstances.
29918
29919 However, if you use a non-empty sender address for a callout to an arbitrary
29920 host, there is the likelihood that the remote host will itself initiate a
29921 callout check back to your host. As it is checking what appears to be a message
29922 sender, it is likely to use an empty address in MAIL, thus avoiding a
29923 callout loop. However, to be on the safe side it would be best to set up your
29924 own ACLs so that they do not do sender verification checks when the recipient
29925 is the address you use for header sender or postmaster callout checking.
29926
29927 Another issue to think about when using non-empty senders for callouts is
29928 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29929 by the sender/recipient combination; thus, for any given recipient, many more
29930 actual callouts are performed than when an empty sender or postmaster is used.
29931
29932
29933
29934
29935 .section "Callout caching" "SECTcallvercache"
29936 .cindex "hints database" "callout cache"
29937 .cindex "callout" "cache, description of"
29938 .cindex "caching" "callout"
29939 Exim caches the results of callouts in order to reduce the amount of resources
29940 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29941 option. A hints database called &"callout"& is used for the cache. Two
29942 different record types are used: one records the result of a callout check for
29943 a specific address, and the other records information that applies to the
29944 entire domain (for example, that it accepts the local part &'postmaster'&).
29945
29946 When an original callout fails, a detailed SMTP error message is given about
29947 the failure. However, for subsequent failures use the cache data, this message
29948 is not available.
29949
29950 The expiry times for negative and positive address cache records are
29951 independent, and can be set by the global options &%callout_negative_expire%&
29952 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29953
29954 If a host gives a negative response to an SMTP connection, or rejects any
29955 commands up to and including
29956 .code
29957 MAIL FROM:<>
29958 .endd
29959 (but not including the MAIL command with a non-empty address),
29960 any callout attempt is bound to fail. Exim remembers such failures in a
29961 domain cache record, which it uses to fail callouts for the domain without
29962 making new connections, until the domain record times out. There are two
29963 separate expiry times for domain cache records:
29964 &%callout_domain_negative_expire%& (default 3h) and
29965 &%callout_domain_positive_expire%& (default 7d).
29966
29967 Domain records expire when the negative expiry time is reached if callouts
29968 cannot be made for the domain, or if the postmaster check failed.
29969 Otherwise, they expire when the positive expiry time is reached. This
29970 ensures that, for example, a host that stops accepting &"random"& local parts
29971 will eventually be noticed.
29972
29973 The callout caching mechanism is based on the domain of the address that is
29974 being tested. If the domain routes to several hosts, it is assumed that their
29975 behaviour will be the same.
29976
29977
29978
29979 .section "Sender address verification reporting" "SECTsenaddver"
29980 .cindex "verifying" "suppressing error details"
29981 See section &<<SECTaddressverification>>& for a general discussion of
29982 verification. When sender verification fails in an ACL, the details of the
29983 failure are given as additional output lines before the 550 response to the
29984 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29985 you might see:
29986 .code
29987 MAIL FROM:<xyz@abc.example>
29988 250 OK
29989 RCPT TO:<pqr@def.example>
29990 550-Verification failed for <xyz@abc.example>
29991 550-Called:   192.168.34.43
29992 550-Sent:     RCPT TO:<xyz@abc.example>
29993 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29994 550 Sender verification failed
29995 .endd
29996 If more than one RCPT command fails in the same way, the details are given
29997 only for the first of them. However, some administrators do not want to send
29998 out this much information. You can suppress the details by adding
29999 &`/no_details`& to the ACL statement that requests sender verification. For
30000 example:
30001 .code
30002 verify = sender/no_details
30003 .endd
30004
30005 .section "Redirection while verifying" "SECTredirwhilveri"
30006 .cindex "verifying" "redirection while"
30007 .cindex "address redirection" "while verifying"
30008 A dilemma arises when a local address is redirected by aliasing or forwarding
30009 during verification: should the generated addresses themselves be verified,
30010 or should the successful expansion of the original address be enough to verify
30011 it? By default, Exim takes the following pragmatic approach:
30012
30013 .ilist
30014 When an incoming address is redirected to just one child address, verification
30015 continues with the child address, and if that fails to verify, the original
30016 verification also fails.
30017 .next
30018 When an incoming address is redirected to more than one child address,
30019 verification does not continue. A success result is returned.
30020 .endlist
30021
30022 This seems the most reasonable behaviour for the common use of aliasing as a
30023 way of redirecting different local parts to the same mailbox. It means, for
30024 example, that a pair of alias entries of the form
30025 .code
30026 A.Wol:   aw123
30027 aw123:   :fail: Gone away, no forwarding address
30028 .endd
30029 work as expected, with both local parts causing verification failure. When a
30030 redirection generates more than one address, the behaviour is more like a
30031 mailing list, where the existence of the alias itself is sufficient for
30032 verification to succeed.
30033
30034 It is possible, however, to change the default behaviour so that all successful
30035 redirections count as successful verifications, however many new addresses are
30036 generated. This is specified by the &%success_on_redirect%& verification
30037 option. For example:
30038 .code
30039 require verify = recipient/success_on_redirect/callout=10s
30040 .endd
30041 In this example, verification succeeds if a router generates a new address, and
30042 the callout does not occur, because no address was routed to a remote host.
30043
30044 When verification is being tested via the &%-bv%& option, the treatment of
30045 redirections is as just described, unless the &%-v%& or any debugging option is
30046 also specified. In that case, full verification is done for every generated
30047 address and a report is output for each of them.
30048
30049
30050
30051 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30052 .cindex "CSA" "verifying"
30053 Client SMTP Authorization is a system that allows a site to advertise
30054 which machines are and are not permitted to send email. This is done by placing
30055 special SRV records in the DNS; these are looked up using the client's HELO
30056 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30057 Authorization checks in Exim are performed by the ACL condition:
30058 .code
30059 verify = csa
30060 .endd
30061 This fails if the client is not authorized. If there is a DNS problem, or if no
30062 valid CSA SRV record is found, or if the client is authorized, the condition
30063 succeeds. These three cases can be distinguished using the expansion variable
30064 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30065 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30066 be likely to cause problems for legitimate email.
30067
30068 The error messages produced by the CSA code include slightly more
30069 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30070 looking up the CSA SRV record, or problems looking up the CSA target
30071 address record. There are four reasons for &$csa_status$& being &"fail"&:
30072
30073 .ilist
30074 The client's host name is explicitly not authorized.
30075 .next
30076 The client's IP address does not match any of the CSA target IP addresses.
30077 .next
30078 The client's host name is authorized but it has no valid target IP addresses
30079 (for example, the target's addresses are IPv6 and the client is using IPv4).
30080 .next
30081 The client's host name has no CSA SRV record but a parent domain has asserted
30082 that all subdomains must be explicitly authorized.
30083 .endlist
30084
30085 The &%csa%& verification condition can take an argument which is the domain to
30086 use for the DNS query. The default is:
30087 .code
30088 verify = csa/$sender_helo_name
30089 .endd
30090 This implementation includes an extension to CSA. If the query domain
30091 is an address literal such as [192.0.2.95], or if it is a bare IP
30092 address, Exim searches for CSA SRV records in the reverse DNS as if
30093 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30094 meaningful to say:
30095 .code
30096 verify = csa/$sender_host_address
30097 .endd
30098 In fact, this is the check that Exim performs if the client does not say HELO.
30099 This extension can be turned off by setting the main configuration option
30100 &%dns_csa_use_reverse%& to be false.
30101
30102 If a CSA SRV record is not found for the domain itself, a search
30103 is performed through its parent domains for a record which might be
30104 making assertions about subdomains. The maximum depth of this search is limited
30105 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30106 default. Exim does not look for CSA SRV records in a top level domain, so the
30107 default settings handle HELO domains as long as seven
30108 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30109 of legitimate HELO domains.
30110
30111 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30112 direct SRV lookups, this is not sufficient because of the extra parent domain
30113 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30114 addresses into lookups in the reverse DNS space. The result of a successful
30115 lookup such as:
30116 .code
30117 ${lookup dnsdb {csa=$sender_helo_name}}
30118 .endd
30119 has two space-separated fields: an authorization code and a target host name.
30120 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30121 authorization required but absent, or &"?"& for unknown.
30122
30123
30124
30125
30126 .section "Bounce address tag validation" "SECTverifyPRVS"
30127 .cindex "BATV, verifying"
30128 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30129 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30130 Genuine incoming bounce messages should therefore always be addressed to
30131 recipients that have a valid tag. This scheme is a way of detecting unwanted
30132 bounce messages caused by sender address forgeries (often called &"collateral
30133 spam"&), because the recipients of such messages do not include valid tags.
30134
30135 There are two expansion items to help with the implementation of the BATV
30136 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30137 the original envelope sender address by using a simple key to add a hash of the
30138 address and some time-based randomizing information. The &%prvs%& expansion
30139 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30140 The syntax of these expansion items is described in section
30141 &<<SECTexpansionitems>>&.
30142
30143 As an example, suppose the secret per-address keys are stored in an MySQL
30144 database. A query to look up the key for an address could be defined as a macro
30145 like this:
30146 .code
30147 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30148                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30149                 }{$value}}
30150 .endd
30151 Suppose also that the senders who make use of BATV are defined by an address
30152 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30153 use this:
30154 .code
30155 # Bounces: drop unsigned addresses for BATV senders
30156 deny message = This address does not send an unsigned reverse path
30157      senders = :
30158      recipients = +batv_senders
30159
30160 # Bounces: In case of prvs-signed address, check signature.
30161 deny message = Invalid reverse path signature.
30162      senders = :
30163      condition  = ${prvscheck {$local_part@$domain}\
30164                   {PRVSCHECK_SQL}{1}}
30165      !condition = $prvscheck_result
30166 .endd
30167 The first statement rejects recipients for bounce messages that are addressed
30168 to plain BATV sender addresses, because it is known that BATV senders do not
30169 send out messages with plain sender addresses. The second statement rejects
30170 recipients that are prvs-signed, but with invalid signatures (either because
30171 the key is wrong, or the signature has timed out).
30172
30173 A non-prvs-signed address is not rejected by the second statement, because the
30174 &%prvscheck%& expansion yields an empty string if its first argument is not a
30175 prvs-signed address, thus causing the &%condition%& condition to be false. If
30176 the first argument is a syntactically valid prvs-signed address, the yield is
30177 the third string (in this case &"1"&), whether or not the cryptographic and
30178 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30179 of the checks (empty for failure, &"1"& for success).
30180
30181 There is one more issue you must consider when implementing prvs-signing:
30182 you have to ensure that the routers accept prvs-signed addresses and
30183 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30184 router to remove the signature with a configuration along these lines:
30185 .code
30186 batv_redirect:
30187   driver = redirect
30188   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30189 .endd
30190 This works because, if the third argument of &%prvscheck%& is empty, the result
30191 of the expansion of a prvs-signed address is the decoded value of the original
30192 address. This router should probably be the first of your routers that handles
30193 local addresses.
30194
30195 To create BATV-signed addresses in the first place, a transport of this form
30196 can be used:
30197 .code
30198 external_smtp_batv:
30199   driver = smtp
30200   return_path = ${prvs {$return_path} \
30201                        {${lookup mysql{SELECT \
30202                        secret FROM batv_prvs WHERE \
30203                        sender='${quote_mysql:$sender_address}'} \
30204                        {$value}fail}}}
30205 .endd
30206 If no key can be found for the existing return path, no signing takes place.
30207
30208
30209
30210 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30211 .cindex "&ACL;" "relay control"
30212 .cindex "relaying" "control by ACL"
30213 .cindex "policy control" "relay control"
30214 An MTA is said to &'relay'& a message if it receives it from some host and
30215 delivers it directly to another host as a result of a remote address contained
30216 within it. Redirecting a local address via an alias or forward file and then
30217 passing the message on to another host is not relaying,
30218 .cindex "&""percent hack""&"
30219 but a redirection as a result of the &"percent hack"& is.
30220
30221 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30222 A host which is acting as a gateway or an MX backup is concerned with incoming
30223 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30224 a host which is acting as a smart host for a number of clients is concerned
30225 with outgoing relaying from those clients to the Internet at large. Often the
30226 same host is fulfilling both functions,
30227 . ///
30228 . as illustrated in the diagram below,
30229 . ///
30230 but in principle these two kinds of relaying are entirely independent. What is
30231 not wanted is the transmission of mail from arbitrary remote hosts through your
30232 system to arbitrary domains.
30233
30234
30235 You can implement relay control by means of suitable statements in the ACL that
30236 runs for each RCPT command. For convenience, it is often easiest to use
30237 Exim's named list facility to define the domains and hosts involved. For
30238 example, suppose you want to do the following:
30239
30240 .ilist
30241 Deliver a number of domains to mailboxes on the local host (or process them
30242 locally in some other way). Let's say these are &'my.dom1.example'& and
30243 &'my.dom2.example'&.
30244 .next
30245 Relay mail for a number of other domains for which you are the secondary MX.
30246 These might be &'friend1.example'& and &'friend2.example'&.
30247 .next
30248 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30249 Suppose your LAN is 192.168.45.0/24.
30250 .endlist
30251
30252
30253 In the main part of the configuration, you put the following definitions:
30254 .code
30255 domainlist local_domains    = my.dom1.example : my.dom2.example
30256 domainlist relay_to_domains = friend1.example : friend2.example
30257 hostlist   relay_from_hosts = 192.168.45.0/24
30258 .endd
30259 Now you can use these definitions in the ACL that is run for every RCPT
30260 command:
30261 .code
30262 acl_check_rcpt:
30263   accept domains = +local_domains : +relay_to_domains
30264   accept hosts   = +relay_from_hosts
30265 .endd
30266 The first statement accepts any RCPT command that contains an address in
30267 the local or relay domains. For any other domain, control passes to the second
30268 statement, which accepts the command only if it comes from one of the relay
30269 hosts. In practice, you will probably want to make your ACL more sophisticated
30270 than this, for example, by including sender and recipient verification. The
30271 default configuration includes a more comprehensive example, which is described
30272 in chapter &<<CHAPdefconfil>>&.
30273
30274
30275
30276 .section "Checking a relay configuration" "SECTcheralcon"
30277 .cindex "relaying" "checking control of"
30278 You can check the relay characteristics of your configuration in the same way
30279 that you can test any ACL behaviour for an incoming SMTP connection, by using
30280 the &%-bh%& option to run a fake SMTP session with which you interact.
30281
30282 For specifically testing for unwanted relaying, the host
30283 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30284 host from the host on which Exim is running, using the normal telnet port, you
30285 will see a normal telnet connection message and then quite a long delay. Be
30286 patient. The remote host is making an SMTP connection back to your host, and
30287 trying a number of common probes to test for open relay vulnerability. The
30288 results of the tests will eventually appear on your terminal.
30289 .ecindex IIDacl
30290
30291
30292
30293 . ////////////////////////////////////////////////////////////////////////////
30294 . ////////////////////////////////////////////////////////////////////////////
30295
30296 .chapter "Content scanning at ACL time" "CHAPexiscan"
30297 .scindex IIDcosca "content scanning" "at ACL time"
30298 The extension of Exim to include content scanning at ACL time, formerly known
30299 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30300 was integrated into the main source for Exim release 4.50, and Tom continues to
30301 maintain it. Most of the wording of this chapter is taken from Tom's
30302 specification.
30303
30304 It is also possible to scan the content of messages at other times. The
30305 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30306 scanning after all the ACLs have run. A transport filter can be used to scan
30307 messages at delivery time (see the &%transport_filter%& option, described in
30308 chapter &<<CHAPtransportgeneric>>&).
30309
30310 If you want to include the ACL-time content-scanning features when you compile
30311 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30312 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30313
30314 .ilist
30315 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30316 for all MIME parts for SMTP and non-SMTP messages, respectively.
30317 .next
30318 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30319 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30320 run at the end of message reception (the &%acl_smtp_data%& ACL).
30321 .next
30322 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30323 of messages, or parts of messages, for debugging purposes.
30324 .next
30325 Additional expansion variables that are set in the new ACL and by the new
30326 conditions.
30327 .next
30328 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30329 .endlist
30330
30331 There is another content-scanning configuration option for &_Local/Makefile_&,
30332 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30333 condition is compiled, in addition to all the other content-scanning features.
30334
30335 Content-scanning is continually evolving, and new features are still being
30336 added. While such features are still unstable and liable to incompatible
30337 changes, they are made available in Exim by setting options whose names begin
30338 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30339 this manual. You can find out about them by reading the file called
30340 &_doc/experimental.txt_&.
30341
30342 All the content-scanning facilities work on a MBOX copy of the message that is
30343 temporarily created in a file called:
30344 .display
30345 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30346 .endd
30347 The &_.eml_& extension is a friendly hint to virus scanners that they can
30348 expect an MBOX-like structure inside that file. The file is created when the
30349 first content scanning facility is called. Subsequent calls to content
30350 scanning conditions open the same file again. The directory is recursively
30351 removed when the &%acl_smtp_data%& ACL has finished running, unless
30352 .code
30353 control = no_mbox_unspool
30354 .endd
30355 has been encountered. When the MIME ACL decodes files, they are put into the
30356 same directory by default.
30357
30358
30359
30360 .section "Scanning for viruses" "SECTscanvirus"
30361 .cindex "virus scanning"
30362 .cindex "content scanning" "for viruses"
30363 .cindex "content scanning" "the &%malware%& condition"
30364 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30365 It supports a &"generic"& interface to scanners called via the shell, and
30366 specialized interfaces for &"daemon"& type virus scanners, which are resident
30367 in memory and thus are much faster.
30368
30369 .new
30370 A timeout of 2 minutes is applied to a scanner call (by default);
30371 if it expires then a defer action is taken.
30372 .wen
30373
30374 .oindex "&%av_scanner%&"
30375 You can set the &%av_scanner%& option in the main part of the configuration
30376 to specify which scanner to use, together with any additional options that
30377 are needed. The basic syntax is as follows:
30378 .display
30379 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30380 .endd
30381 If you do not set &%av_scanner%&, it defaults to
30382 .code
30383 av_scanner = sophie:/var/run/sophie
30384 .endd
30385 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30386 before use.
30387 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30388 The following scanner types are supported in this release:
30389
30390 .vlist
30391 .new
30392 .vitem &%avast%&
30393 .cindex "virus scanners" "avast"
30394 This is the scanner daemon of Avast. It has been tested with Avast Core
30395 Security (currenty at version 1.1.7).
30396 You can get a trial version at &url(http://www.avast.com) or for Linux
30397 at &url(http://www.avast.com/linux-server-antivirus).
30398 This scanner type takes one option,
30399 which can be either a full path to a UNIX socket,
30400 or host and port specifiers separated by white space.
30401 The host may be a name or an IP address; the port is either a
30402 single number or a pair of numbers with a dash between.
30403 Any further options are given, on separate lines,
30404 to the daemon as options before the main scan command.
30405 For example:
30406 .code
30407 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30408 av_scanner = avast:192.168.2.22 5036
30409 .endd
30410 If you omit the argument, the default path
30411 &_/var/run/avast/scan.sock_&
30412 is used.
30413 If you use a remote host,
30414 you need to make Exim's spool directory available to it,
30415 as the scanner is passed a file path, not file contents.
30416 For information about available commands and their options you may use 
30417 .code
30418 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30419     FLAGS
30420     SENSITIVITY
30421     PACK
30422 .endd
30423 .wen
30424
30425
30426 .vitem &%aveserver%&
30427 .cindex "virus scanners" "Kaspersky"
30428 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30429 at &url(http://www.kaspersky.com). This scanner type takes one option,
30430 which is the path to the daemon's UNIX socket. The default is shown in this
30431 example:
30432 .code
30433 av_scanner = aveserver:/var/run/aveserver
30434 .endd
30435
30436
30437 .vitem &%clamd%&
30438 .cindex "virus scanners" "clamd"
30439 This daemon-type scanner is GPL and free. You can get it at
30440 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30441 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30442 in the MIME ACL. This no longer believed to be necessary. One option is
30443 required: either the path and name of a UNIX socket file, or a hostname or IP
30444 number, and a port, separated by space, as in the second of these examples:
30445 .code
30446 av_scanner = clamd:/opt/clamd/socket
30447 av_scanner = clamd:192.0.2.3 1234
30448 av_scanner = clamd:192.0.2.3 1234:local
30449 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30450 .endd
30451 If the value of av_scanner points to a UNIX socket file or contains the local
30452 keyword, then the ClamAV interface will pass a filename containing the data
30453 to be scanned, which will should normally result in less I/O happening and be
30454 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30455 Exim does not assume that there is a common filesystem with the remote host.
30456 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30457 you be running a version of ClamAV prior to 0.95.
30458
30459 The final example shows that multiple TCP targets can be specified.  Exim will
30460 randomly use one for each incoming email (i.e. it load balances them).  Note
30461 that only TCP targets may be used if specifying a list of scanners; a UNIX
30462 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30463 unavailable, Exim will try the remaining one(s) until it finds one that works.
30464 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30465 not keep track of scanner state between multiple messages, and the scanner
30466 selection is random, so the message will get logged in the mainlog for each
30467 email that the down scanner gets chosen first (message wrapped to be readable):
30468 .code
30469 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30470    clamd: connection to localhost, port 3310 failed
30471    (Connection refused)
30472 .endd
30473
30474 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30475 contributing the code for this scanner.
30476
30477 .vitem &%cmdline%&
30478 .cindex "virus scanners" "command line interface"
30479 This is the keyword for the generic command line scanner interface. It can be
30480 used to attach virus scanners that are invoked from the shell. This scanner
30481 type takes 3 mandatory options:
30482
30483 .olist
30484 The full path and name of the scanner binary, with all command line options,
30485 and a placeholder (&`%s`&) for the directory to scan.
30486
30487 .next
30488 A regular expression to match against the STDOUT and STDERR output of the
30489 virus scanner. If the expression matches, a virus was found. You must make
30490 absolutely sure that this expression matches on &"virus found"&. This is called
30491 the &"trigger"& expression.
30492
30493 .next
30494 Another regular expression, containing exactly one pair of parentheses, to
30495 match the name of the virus found in the scanners output. This is called the
30496 &"name"& expression.
30497 .endlist olist
30498
30499 For example, Sophos Sweep reports a virus on a line like this:
30500 .code
30501 Virus 'W32/Magistr-B' found in file ./those.bat
30502 .endd
30503 For the trigger expression, we can match the phrase &"found in file"&. For the
30504 name expression, we want to extract the W32/Magistr-B string, so we can match
30505 for the single quotes left and right of it. Altogether, this makes the
30506 configuration setting:
30507 .code
30508 av_scanner = cmdline:\
30509              /path/to/sweep -ss -all -rec -archive %s:\
30510              found in file:'(.+)'
30511 .endd
30512 .vitem &%drweb%&
30513 .cindex "virus scanners" "DrWeb"
30514 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30515 takes one option,
30516 either a full path to a UNIX socket,
30517 or host and port specifiers separated by white space.
30518 The host may be a name or an IP address; the port is either a
30519 single number or a pair of numbers with a dash between.
30520 For example:
30521 .code
30522 av_scanner = drweb:/var/run/drwebd.sock
30523 av_scanner = drweb:192.168.2.20 31337
30524 .endd
30525 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30526 is used. Thanks to Alex Miller for contributing the code for this scanner.
30527
30528 .vitem &%f-protd%&
30529 .cindex "virus scanners" "f-protd"
30530 The f-protd scanner is accessed via HTTP over TCP.
30531 One argument is taken, being a space-separated hostname and port number
30532 (or port-range).
30533 For example:
30534 .code
30535 av_scanner = f-protd:localhost 10200-10204
30536 .endd
30537 If you omit the argument, the default values show above are used.
30538
30539 .vitem &%fsecure%&
30540 .cindex "virus scanners" "F-Secure"
30541 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30542 argument which is the path to a UNIX socket. For example:
30543 .code
30544 av_scanner = fsecure:/path/to/.fsav
30545 .endd
30546 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30547 Thelmen for contributing the code for this scanner.
30548
30549 .vitem &%kavdaemon%&
30550 .cindex "virus scanners" "Kaspersky"
30551 This is the scanner daemon of Kaspersky Version 4. This version of the
30552 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30553 scanner type takes one option, which is the path to the daemon's UNIX socket.
30554 For example:
30555 .code
30556 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30557 .endd
30558 The default path is &_/var/run/AvpCtl_&.
30559
30560 .vitem &%mksd%&
30561 .cindex "virus scanners" "mksd"
30562 This is a daemon type scanner that is aimed mainly at Polish users, though some
30563 parts of documentation are now available in English. You can get it at
30564 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30565 the maximum number of processes used simultaneously to scan the attachments,
30566 provided that the demime facility is employed and also provided that mksd has
30567 been run with at least the same number of child processes. For example:
30568 .code
30569 av_scanner = mksd:2
30570 .endd
30571 You can safely omit this option (the default value is 1).
30572
30573 .vitem &%sock%&
30574 .cindex "virus scanners" "simple socket-connected"
30575 This is a general-purpose way of talking to simple scanner daemons
30576 running on the local machine.
30577 There are four options:
30578 an address (which may be an IP addres and port, or the path of a Unix socket),
30579 a commandline to send (may include a single %s which will be replaced with
30580 the path to the mail file to be scanned),
30581 an RE to trigger on from the returned data,
30582 an RE to extract malware_name from the returned data.
30583 For example:
30584 .code
30585 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30586 .endd
30587 Default for the socket specifier is &_/tmp/malware.sock_&.
30588 Default for the commandline is &_%s\n_&.
30589 Both regular-expressions are required.
30590
30591 .vitem &%sophie%&
30592 .cindex "virus scanners" "Sophos and Sophie"
30593 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30594 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30595 for this scanner type is the path to the UNIX socket that Sophie uses for
30596 client communication. For example:
30597 .code
30598 av_scanner = sophie:/tmp/sophie
30599 .endd
30600 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30601 the option.
30602 .endlist
30603
30604 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30605 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30606 ACL.
30607
30608 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30609 makes it possible to use different scanners. See further below for an example.
30610 The &%malware%& condition caches its results, so when you use it multiple times
30611 for the same message, the actual scanning process is only carried out once.
30612 However, using expandable items in &%av_scanner%& disables this caching, in
30613 which case each use of the &%malware%& condition causes a new scan of the
30614 message.
30615
30616 The &%malware%& condition takes a right-hand argument that is expanded before
30617 .new
30618 use and taken as a list, slash-separated by default.
30619 .wen
30620 The first element can then be one of
30621
30622 .ilist
30623 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30624 The condition succeeds if a virus was found, and fail otherwise. This is the
30625 recommended usage.
30626 .next
30627 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30628 the condition fails immediately.
30629 .next
30630 A regular expression, in which case the message is scanned for viruses. The
30631 condition succeeds if a virus is found and its name matches the regular
30632 expression. This allows you to take special actions on certain types of virus.
30633 .new
30634 Note that &"/"& characters in the RE must be doubled due to the list-processing,
30635 unless the separator is changed (in the usual way).
30636 .wen
30637 .endlist
30638
30639 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
30640 messages even if there is a problem with the virus scanner.
30641 Otherwise, such a problem causes the ACL to defer.
30642
30643 .new
30644 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
30645 specify a non-default timeout.  The default is two minutes.
30646 For example:
30647 .code
30648 malware = * / defer_ok / tmo=10s
30649 .endd
30650 A timeout causes the ACL to defer.
30651 .wen
30652
30653 .vindex "&$malware_name$&"
30654 When a virus is found, the condition sets up an expansion variable called
30655 &$malware_name$& that contains the name of the virus. You can use it in a
30656 &%message%& modifier that specifies the error returned to the sender, and/or in
30657 logging data.
30658
30659 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30660 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30661 &%malware%& condition.
30662
30663 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30664 imposed by your anti-virus scanner.
30665
30666 Here is a very simple scanning example:
30667 .code
30668 deny message = This message contains malware ($malware_name)
30669      demime = *
30670      malware = *
30671 .endd
30672 The next example accepts messages when there is a problem with the scanner:
30673 .code
30674 deny message = This message contains malware ($malware_name)
30675      demime = *
30676      malware = */defer_ok
30677 .endd
30678 The next example shows how to use an ACL variable to scan with both sophie and
30679 aveserver. It assumes you have set:
30680 .code
30681 av_scanner = $acl_m0
30682 .endd
30683 in the main Exim configuration.
30684 .code
30685 deny message = This message contains malware ($malware_name)
30686      set acl_m0 = sophie
30687      malware = *
30688
30689 deny message = This message contains malware ($malware_name)
30690      set acl_m0 = aveserver
30691      malware = *
30692 .endd
30693
30694
30695 .section "Scanning with SpamAssassin" "SECTscanspamass"
30696 .cindex "content scanning" "for spam"
30697 .cindex "spam scanning"
30698 .cindex "SpamAssassin"
30699 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30700 score and a report for the message. You can get SpamAssassin at
30701 &url(http://www.spamassassin.org), or, if you have a working Perl
30702 installation, you can use CPAN by running:
30703 .code
30704 perl -MCPAN -e 'install Mail::SpamAssassin'
30705 .endd
30706 SpamAssassin has its own set of configuration files. Please review its
30707 documentation to see how you can tweak it. The default installation should work
30708 nicely, however.
30709
30710 .oindex "&%spamd_address%&"
30711 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30712 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30713 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30714 part of the Exim configuration as follows (example):
30715 .code
30716 spamd_address = 192.168.99.45 387
30717 .endd
30718 You do not need to set this option if you use the default. As of version 2.60,
30719 &%spamd%& also supports communication over UNIX sockets. If you want to use
30720 these, supply &%spamd_address%& with an absolute file name instead of a
30721 address/port pair:
30722 .code
30723 spamd_address = /var/run/spamd_socket
30724 .endd
30725 You can have multiple &%spamd%& servers to improve scalability. These can
30726 reside on other hardware reachable over the network. To specify multiple
30727 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30728 option, separated with colons:
30729 .code
30730 spamd_address = 192.168.2.10 783 : \
30731                 192.168.2.11 783 : \
30732                 192.168.2.12 783
30733 .endd
30734 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30735 fashion. When a server fails to respond to the connection attempt, all other
30736 servers are tried until one succeeds. If no server responds, the &%spam%&
30737 condition defers.
30738
30739 &*Warning*&: It is not possible to use the UNIX socket connection method with
30740 multiple &%spamd%& servers.
30741
30742 The &%spamd_address%& variable is expanded before use if it starts with
30743 a dollar sign. In this case, the expansion may return a string that is
30744 used as the list so that multiple spamd servers can be the result of an
30745 expansion.
30746
30747 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30748 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30749 .code
30750 deny message = This message was classified as SPAM
30751      spam = joe
30752 .endd
30753 The right-hand side of the &%spam%& condition specifies a name. This is
30754 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30755 to scan using a specific profile, but rather use the SpamAssassin system-wide
30756 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30757 However, you must put something on the right-hand side.
30758
30759 The name allows you to use per-domain or per-user antispam profiles in
30760 principle, but this is not straightforward in practice, because a message may
30761 have multiple recipients, not necessarily all in the same domain. Because the
30762 &%spam%& condition has to be called from a DATA ACL in order to be able to
30763 read the contents of the message, the variables &$local_part$& and &$domain$&
30764 are not set.
30765
30766 The right-hand side of the &%spam%& condition is expanded before being used, so
30767 you can put lookups or conditions there. When the right-hand side evaluates to
30768 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30769
30770
30771 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30772 large ones may cause significant performance degradation. As most spam messages
30773 are quite small, it is recommended that you do not scan the big ones. For
30774 example:
30775 .code
30776 deny message = This message was classified as SPAM
30777      condition = ${if < {$message_size}{10K}}
30778      spam = nobody
30779 .endd
30780
30781 The &%spam%& condition returns true if the threshold specified in the user's
30782 SpamAssassin profile has been matched or exceeded. If you want to use the
30783 &%spam%& condition for its side effects (see the variables below), you can make
30784 it always return &"true"& by appending &`:true`& to the username.
30785
30786 .cindex "spam scanning" "returned variables"
30787 When the &%spam%& condition is run, it sets up a number of expansion
30788 variables. These variables are saved with the received message, thus they are
30789 available for use at delivery time.
30790
30791 .vlist
30792 .vitem &$spam_score$&
30793 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30794 for inclusion in log or reject messages.
30795
30796 .vitem &$spam_score_int$&
30797 The spam score of the message, multiplied by ten, as an integer value. For
30798 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30799 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30800 The integer value is useful for numeric comparisons in conditions.
30801
30802 .vitem &$spam_bar$&
30803 A string consisting of a number of &"+"& or &"-"& characters, representing the
30804 integer part of the spam score value. A spam score of 4.4 would have a
30805 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30806 headers, since MUAs can match on such strings.
30807
30808 .vitem &$spam_report$&
30809 A multiline text table, containing the full SpamAssassin report for the
30810 message. Useful for inclusion in headers or reject messages.
30811 .endlist
30812
30813 The &%spam%& condition caches its results unless expansion in
30814 spamd_address was used. If you call it again with the same user name, it
30815 does not scan again, but rather returns the same values as before.
30816
30817 The &%spam%& condition returns DEFER if there is any error while running
30818 the message through SpamAssassin or if the expansion of spamd_address
30819 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30820 statement block), append &`/defer_ok`& to the right-hand side of the
30821 spam condition, like this:
30822 .code
30823 deny message = This message was classified as SPAM
30824      spam    = joe/defer_ok
30825 .endd
30826 This causes messages to be accepted even if there is a problem with &%spamd%&.
30827
30828 Here is a longer, commented example of the use of the &%spam%&
30829 condition:
30830 .code
30831 # put headers in all messages (no matter if spam or not)
30832 warn  spam = nobody:true
30833       add_header = X-Spam-Score: $spam_score ($spam_bar)
30834       add_header = X-Spam-Report: $spam_report
30835
30836 # add second subject line with *SPAM* marker when message
30837 # is over threshold
30838 warn  spam = nobody
30839       add_header = Subject: *SPAM* $h_Subject:
30840
30841 # reject spam at high scores (> 12)
30842 deny  message = This message scored $spam_score spam points.
30843       spam = nobody:true
30844       condition = ${if >{$spam_score_int}{120}{1}{0}}
30845 .endd
30846
30847
30848
30849 .section "Scanning MIME parts" "SECTscanmimepart"
30850 .cindex "content scanning" "MIME parts"
30851 .cindex "MIME content scanning"
30852 .oindex "&%acl_smtp_mime%&"
30853 .oindex "&%acl_not_smtp_mime%&"
30854 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30855 each MIME part of an SMTP message, including multipart types, in the sequence
30856 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30857 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30858 options may both refer to the same ACL if you want the same processing in both
30859 cases.
30860
30861 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30862 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30863 the case of a non-SMTP message. However, a MIME ACL is called only if the
30864 message contains a &'Content-Type:'& header line. When a call to a MIME
30865 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30866 result code is sent to the client. In the case of an SMTP message, the
30867 &%acl_smtp_data%& ACL is not called when this happens.
30868
30869 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30870 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30871 condition to match against the raw MIME part. You can also use the
30872 &%mime_regex%& condition to match against the decoded MIME part (see section
30873 &<<SECTscanregex>>&).
30874
30875 At the start of a MIME ACL, a number of variables are set from the header
30876 information for the relevant MIME part. These are described below. The contents
30877 of the MIME part are not by default decoded into a disk file except for MIME
30878 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30879 part into a disk file, you can use the &%decode%& condition. The general
30880 syntax is:
30881 .display
30882 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30883 .endd
30884 The right hand side is expanded before use. After expansion,
30885 the value can be:
30886
30887 .olist
30888 &"0"& or &"false"&, in which case no decoding is done.
30889 .next
30890 The string &"default"&. In that case, the file is put in the temporary
30891 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30892 a sequential file name consisting of the message id and a sequence number. The
30893 full path and name is available in &$mime_decoded_filename$& after decoding.
30894 .next
30895 A full path name starting with a slash. If the full name is an existing
30896 directory, it is used as a replacement for the default directory. The filename
30897 is then sequentially assigned. If the path does not exist, it is used as
30898 the full path and file name.
30899 .next
30900 If the string does not start with a slash, it is used as the
30901 filename, and the default path is then used.
30902 .endlist
30903 The &%decode%& condition normally succeeds. It is only false for syntax
30904 errors or unusual circumstances such as memory shortages. You can easily decode
30905 a file with its original, proposed filename using
30906 .code
30907 decode = $mime_filename
30908 .endd
30909 However, you should keep in mind that &$mime_filename$& might contain
30910 anything. If you place files outside of the default path, they are not
30911 automatically unlinked.
30912
30913 For RFC822 attachments (these are messages attached to messages, with a
30914 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30915 as for the primary message, only that the &$mime_is_rfc822$& expansion
30916 variable is set (see below). Attached messages are always decoded to disk
30917 before being checked, and the files are unlinked once the check is done.
30918
30919 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30920 used to match regular expressions against raw and decoded MIME parts,
30921 respectively. They are described in section &<<SECTscanregex>>&.
30922
30923 .cindex "MIME content scanning" "returned variables"
30924 The following list describes all expansion variables that are
30925 available in the MIME ACL:
30926
30927 .vlist
30928 .vitem &$mime_boundary$&
30929 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30930 have a boundary string, which is stored in this variable. If the current part
30931 has no boundary parameter in the &'Content-Type:'& header, this variable
30932 contains the empty string.
30933
30934 .vitem &$mime_charset$&
30935 This variable contains the character set identifier, if one was found in the
30936 &'Content-Type:'& header. Examples for charset identifiers are:
30937 .code
30938 us-ascii
30939 gb2312 (Chinese)
30940 iso-8859-1
30941 .endd
30942 Please note that this value is not normalized, so you should do matches
30943 case-insensitively.
30944
30945 .vitem &$mime_content_description$&
30946 This variable contains the normalized content of the &'Content-Description:'&
30947 header. It can contain a human-readable description of the parts content. Some
30948 implementations repeat the filename for attachments here, but they are usually
30949 only used for display purposes.
30950
30951 .vitem &$mime_content_disposition$&
30952 This variable contains the normalized content of the &'Content-Disposition:'&
30953 header. You can expect strings like &"attachment"& or &"inline"& here.
30954
30955 .vitem &$mime_content_id$&
30956 This variable contains the normalized content of the &'Content-ID:'& header.
30957 This is a unique ID that can be used to reference a part from another part.
30958
30959 .vitem &$mime_content_size$&
30960 This variable is set only after the &%decode%& modifier (see above) has been
30961 successfully run. It contains the size of the decoded part in kilobytes. The
30962 size is always rounded up to full kilobytes, so only a completely empty part
30963 has a &$mime_content_size$& of zero.
30964
30965 .vitem &$mime_content_transfer_encoding$&
30966 This variable contains the normalized content of the
30967 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30968 type. Typical values are &"base64"& and &"quoted-printable"&.
30969
30970 .vitem &$mime_content_type$&
30971 If the MIME part has a &'Content-Type:'& header, this variable contains its
30972 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30973 are some examples of popular MIME types, as they may appear in this variable:
30974 .code
30975 text/plain
30976 text/html
30977 application/octet-stream
30978 image/jpeg
30979 audio/midi
30980 .endd
30981 If the MIME part has no &'Content-Type:'& header, this variable contains the
30982 empty string.
30983
30984 .vitem &$mime_decoded_filename$&
30985 This variable is set only after the &%decode%& modifier (see above) has been
30986 successfully run. It contains the full path and file name of the file
30987 containing the decoded data.
30988 .endlist
30989
30990 .cindex "RFC 2047"
30991 .vlist
30992 .vitem &$mime_filename$&
30993 This is perhaps the most important of the MIME variables. It contains a
30994 proposed filename for an attachment, if one was found in either the
30995 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30996 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30997 found, this variable contains the empty string.
30998
30999 .vitem &$mime_is_coverletter$&
31000 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31001 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31002 content in the cover letter, while not restricting attachments at all.
31003
31004 The variable contains 1 (true) for a MIME part believed to be part of the
31005 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31006 follows:
31007
31008 .olist
31009 The outermost MIME part of a message is always a cover letter.
31010
31011 .next
31012 If a multipart/alternative or multipart/related MIME part is a cover letter,
31013 so are all MIME subparts within that multipart.
31014
31015 .next
31016 If any other multipart is a cover letter, the first subpart is a cover letter,
31017 and the rest are attachments.
31018
31019 .next
31020 All parts contained within an attachment multipart are attachments.
31021 .endlist olist
31022
31023 As an example, the following will ban &"HTML mail"& (including that sent with
31024 alternative plain text), while allowing HTML files to be attached. HTML
31025 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31026 .code
31027 deny message = HTML mail is not accepted here
31028 !condition = $mime_is_rfc822
31029 condition = $mime_is_coverletter
31030 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31031 .endd
31032 .vitem &$mime_is_multipart$&
31033 This variable has the value 1 (true) when the current part has the main type
31034 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31035 Since multipart entities only serve as containers for other parts, you may not
31036 want to carry out specific actions on them.
31037
31038 .vitem &$mime_is_rfc822$&
31039 This variable has the value 1 (true) if the current part is not a part of the
31040 checked message itself, but part of an attached message. Attached message
31041 decoding is fully recursive.
31042
31043 .vitem &$mime_part_count$&
31044 This variable is a counter that is raised for each processed MIME part. It
31045 starts at zero for the very first part (which is usually a multipart). The
31046 counter is per-message, so it is reset when processing RFC822 attachments (see
31047 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31048 complete, so you can use it in the DATA ACL to determine the number of MIME
31049 parts of a message. For non-MIME messages, this variable contains the value -1.
31050 .endlist
31051
31052
31053
31054 .section "Scanning with regular expressions" "SECTscanregex"
31055 .cindex "content scanning" "with regular expressions"
31056 .cindex "regular expressions" "content scanning with"
31057 You can specify your own custom regular expression matches on the full body of
31058 the message, or on individual MIME parts.
31059
31060 The &%regex%& condition takes one or more regular expressions as arguments and
31061 matches them against the full message (when called in the DATA ACL) or a raw
31062 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31063 linewise, with a maximum line length of 32K characters. That means you cannot
31064 have multiline matches with the &%regex%& condition.
31065
31066 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31067 to 32K of decoded content (the whole content at once, not linewise). If the
31068 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31069 is decoded automatically when &%mime_regex%& is executed (using default path
31070 and filename values). If the decoded data is larger than  32K, only the first
31071 32K characters are checked.
31072
31073 The regular expressions are passed as a colon-separated list. To include a
31074 literal colon, you must double it. Since the whole right-hand side string is
31075 expanded before being used, you must also escape dollar signs and backslashes
31076 with more backslashes, or use the &`\N`& facility to disable expansion.
31077 Here is a simple example that contains two regular expressions:
31078 .code
31079 deny message = contains blacklisted regex ($regex_match_string)
31080      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31081 .endd
31082 The conditions returns true if any one of the regular expressions matches. The
31083 &$regex_match_string$& expansion variable is then set up and contains the
31084 matching regular expression.
31085
31086 &*Warning*&: With large messages, these conditions can be fairly
31087 CPU-intensive.
31088
31089
31090
31091
31092 .section "The demime condition" "SECTdemimecond"
31093 .cindex "content scanning" "MIME checking"
31094 .cindex "MIME content scanning"
31095 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31096 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31097 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31098 ACL functionality, but provides no additional facilities. Please note that this
31099 condition is deprecated and kept only for backward compatibility. You must set
31100 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31101 use the &%demime%& condition.
31102
31103 The &%demime%& condition unpacks MIME containers in the message. It detects
31104 errors in MIME containers and can match file extensions found in the message
31105 against a list. Using this facility produces files containing the unpacked MIME
31106 parts of the message in the temporary scan directory. If you do antivirus
31107 scanning, it is recommended that you use the &%demime%& condition before the
31108 antivirus (&%malware%&) condition.
31109
31110 On the right-hand side of the &%demime%& condition you can pass a
31111 colon-separated list of file extensions that it should match against. For
31112 example:
31113 .code
31114 deny message = Found blacklisted file attachment
31115      demime  = vbs:com:bat:pif:prf:lnk
31116 .endd
31117 If one of the file extensions is found, the condition is true, otherwise it is
31118 false. If there is a temporary error while demimeing (for example, &"disk
31119 full"&), the condition defers, and the message is temporarily rejected (unless
31120 the condition is on a &%warn%& verb).
31121
31122 The right-hand side is expanded before being treated as a list, so you can have
31123 conditions and lookups there. If it expands to an empty string, &"false"&, or
31124 zero (&"0"&), no demimeing is done and the condition is false.
31125
31126 The &%demime%& condition set the following variables:
31127
31128 .vlist
31129 .vitem &$demime_errorlevel$&
31130 .vindex "&$demime_errorlevel$&"
31131 When an error is detected in a MIME container, this variable contains the
31132 severity of the error, as an integer number. The higher the value, the more
31133 severe the error (the current maximum value is 3). If this variable is unset or
31134 zero, no error occurred.
31135
31136 .vitem &$demime_reason$&
31137 .vindex "&$demime_reason$&"
31138 When &$demime_errorlevel$& is greater than zero, this variable contains a
31139 human-readable text string describing the MIME error that occurred.
31140 .endlist
31141
31142 .vlist
31143 .vitem &$found_extension$&
31144 .vindex "&$found_extension$&"
31145 When the &%demime%& condition is true, this variable contains the file
31146 extension it found.
31147 .endlist
31148
31149 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31150 the &%demime%& condition, and are not changed on subsequent calls.
31151
31152 If you do not want to check for file extensions, but rather use the &%demime%&
31153 condition for unpacking or error checking purposes, pass &"*"& as the
31154 right-hand side value. Here is a more elaborate example of how to use this
31155 facility:
31156 .code
31157 # Reject messages with serious MIME container errors
31158 deny  message = Found MIME error ($demime_reason).
31159       demime = *
31160       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31161
31162 # Reject known virus spreading file extensions.
31163 # Accepting these is pretty much braindead.
31164 deny  message = contains $found_extension file (blacklisted).
31165       demime  = com:vbs:bat:pif:scr
31166
31167 # Freeze .exe and .doc files. Postmaster can
31168 # examine them and eventually thaw them.
31169 deny  log_message = Another $found_extension file.
31170       demime = exe:doc
31171       control = freeze
31172 .endd
31173 .ecindex IIDcosca
31174
31175
31176
31177
31178 . ////////////////////////////////////////////////////////////////////////////
31179 . ////////////////////////////////////////////////////////////////////////////
31180
31181 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31182          "Local scan function"
31183 .scindex IIDlosca "&[local_scan()]& function" "description of"
31184 .cindex "customizing" "input scan using C function"
31185 .cindex "policy control" "by local scan function"
31186 In these days of email worms, viruses, and ever-increasing spam, some sites
31187 want to apply a lot of checking to messages before accepting them.
31188
31189 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31190 passing messages to external virus and spam scanning software. You can also do
31191 a certain amount in Exim itself through string expansions and the &%condition%&
31192 condition in the ACL that runs after the SMTP DATA command or the ACL for
31193 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31194
31195 To allow for further customization to a site's own requirements, there is the
31196 possibility of linking Exim with a private message scanning function, written
31197 in C. If you want to run code that is written in something other than C, you
31198 can of course use a little C stub to call it.
31199
31200 The local scan function is run once for every incoming message, at the point
31201 when Exim is just about to accept the message.
31202 It can therefore be used to control non-SMTP messages from local processes as
31203 well as messages arriving via SMTP.
31204
31205 Exim applies a timeout to calls of the local scan function, and there is an
31206 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31207 Zero means &"no timeout"&.
31208 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31209 before calling the local scan function, so that the most common types of crash
31210 are caught. If the timeout is exceeded or one of those signals is caught, the
31211 incoming message is rejected with a temporary error if it is an SMTP message.
31212 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31213 code. The incident is logged on the main and reject logs.
31214
31215
31216
31217 .section "Building Exim to use a local scan function" "SECID207"
31218 .cindex "&[local_scan()]& function" "building Exim to use"
31219 To make use of the local scan function feature, you must tell Exim where your
31220 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31221 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31222 directory, so you might set
31223 .code
31224 LOCAL_SCAN_SOURCE=Local/local_scan.c
31225 .endd
31226 for example. The function must be called &[local_scan()]&. It is called by
31227 Exim after it has received a message, when the success return code is about to
31228 be sent. This is after all the ACLs have been run. The return code from your
31229 function controls whether the message is actually accepted or not. There is a
31230 commented template function (that just accepts the message) in the file
31231 _src/local_scan.c_.
31232
31233 If you want to make use of Exim's run time configuration file to set options
31234 for your &[local_scan()]& function, you must also set
31235 .code
31236 LOCAL_SCAN_HAS_OPTIONS=yes
31237 .endd
31238 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31239
31240
31241
31242
31243 .section "API for local_scan()" "SECTapiforloc"
31244 .cindex "&[local_scan()]& function" "API description"
31245 You must include this line near the start of your code:
31246 .code
31247 #include "local_scan.h"
31248 .endd
31249 This header file defines a number of variables and other values, and the
31250 prototype for the function itself. Exim is coded to use unsigned char values
31251 almost exclusively, and one of the things this header defines is a shorthand
31252 for &`unsigned char`& called &`uschar`&.
31253 It also contains the following macro definitions, to simplify casting character
31254 strings and pointers to character strings:
31255 .code
31256 #define CS   (char *)
31257 #define CCS  (const char *)
31258 #define CSS  (char **)
31259 #define US   (unsigned char *)
31260 #define CUS  (const unsigned char *)
31261 #define USS  (unsigned char **)
31262 .endd
31263 The function prototype for &[local_scan()]& is:
31264 .code
31265 extern int local_scan(int fd, uschar **return_text);
31266 .endd
31267 The arguments are as follows:
31268
31269 .ilist
31270 &%fd%& is a file descriptor for the file that contains the body of the message
31271 (the -D file). The file is open for reading and writing, but updating it is not
31272 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31273
31274 The descriptor is positioned at character 19 of the file, which is the first
31275 character of the body itself, because the first 19 characters are the message
31276 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31277 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31278 case this changes in some future version.
31279 .next
31280 &%return_text%& is an address which you can use to return a pointer to a text
31281 string at the end of the function. The value it points to on entry is NULL.
31282 .endlist
31283
31284 The function must return an &%int%& value which is one of the following macros:
31285
31286 .vlist
31287 .vitem &`LOCAL_SCAN_ACCEPT`&
31288 .vindex "&$local_scan_data$&"
31289 The message is accepted. If you pass back a string of text, it is saved with
31290 the message, and made available in the variable &$local_scan_data$&. No
31291 newlines are permitted (if there are any, they are turned into spaces) and the
31292 maximum length of text is 1000 characters.
31293
31294 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31295 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31296 queued without immediate delivery, and is frozen.
31297
31298 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31299 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31300 queued without immediate delivery.
31301
31302 .vitem &`LOCAL_SCAN_REJECT`&
31303 The message is rejected; the returned text is used as an error message which is
31304 passed back to the sender and which is also logged. Newlines are permitted &--
31305 they cause a multiline response for SMTP rejections, but are converted to
31306 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31307 used.
31308
31309 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31310 The message is temporarily rejected; the returned text is used as an error
31311 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31312 problem"& is used.
31313
31314 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31315 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31316 message is not written to the reject log. It has the effect of unsetting the
31317 &%rejected_header%& log selector for just this rejection. If
31318 &%rejected_header%& is already unset (see the discussion of the
31319 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31320 same as LOCAL_SCAN_REJECT.
31321
31322 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31323 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31324 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31325 .endlist
31326
31327 If the message is not being received by interactive SMTP, rejections are
31328 reported by writing to &%stderr%& or by sending an email, as configured by the
31329 &%-oe%& command line options.
31330
31331
31332
31333 .section "Configuration options for local_scan()" "SECTconoptloc"
31334 .cindex "&[local_scan()]& function" "configuration options"
31335 It is possible to have option settings in the main configuration file
31336 that set values in static variables in the &[local_scan()]& module. If you
31337 want to do this, you must have the line
31338 .code
31339 LOCAL_SCAN_HAS_OPTIONS=yes
31340 .endd
31341 in your &_Local/Makefile_& when you build Exim. (This line is in
31342 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31343 file, you must define static variables to hold the option values, and a table
31344 to define them.
31345
31346 The table must be a vector called &%local_scan_options%&, of type
31347 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31348 and a pointer to the variable that holds the value. The entries must appear in
31349 alphabetical order. Following &%local_scan_options%& you must also define a
31350 variable called &%local_scan_options_count%& that contains the number of
31351 entries in the table. Here is a short example, showing two kinds of option:
31352 .code
31353 static int my_integer_option = 42;
31354 static uschar *my_string_option = US"a default string";
31355
31356 optionlist local_scan_options[] = {
31357   { "my_integer", opt_int,       &my_integer_option },
31358   { "my_string",  opt_stringptr, &my_string_option }
31359 };
31360
31361 int local_scan_options_count =
31362   sizeof(local_scan_options)/sizeof(optionlist);
31363 .endd
31364 The values of the variables can now be changed from Exim's runtime
31365 configuration file by including a local scan section as in this example:
31366 .code
31367 begin local_scan
31368 my_integer = 99
31369 my_string = some string of text...
31370 .endd
31371 The available types of option data are as follows:
31372
31373 .vlist
31374 .vitem &*opt_bool*&
31375 This specifies a boolean (true/false) option. The address should point to a
31376 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31377 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31378 whether such a variable has been set at all, you can initialize it to
31379 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31380 values.)
31381
31382 .vitem &*opt_fixed*&
31383 This specifies a fixed point number, such as is used for load averages.
31384 The address should point to a variable of type &`int`&. The value is stored
31385 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31386
31387 .vitem &*opt_int*&
31388 This specifies an integer; the address should point to a variable of type
31389 &`int`&. The value may be specified in any of the integer formats accepted by
31390 Exim.
31391
31392 .vitem &*opt_mkint*&
31393 This is the same as &%opt_int%&, except that when such a value is output in a
31394 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31395 printed with the suffix K or M.
31396
31397 .vitem &*opt_octint*&
31398 This also specifies an integer, but the value is always interpreted as an
31399 octal integer, whether or not it starts with the digit zero, and it is
31400 always output in octal.
31401
31402 .vitem &*opt_stringptr*&
31403 This specifies a string value; the address must be a pointer to a
31404 variable that points to a string (for example, of type &`uschar *`&).
31405
31406 .vitem &*opt_time*&
31407 This specifies a time interval value. The address must point to a variable of
31408 type &`int`&. The value that is placed there is a number of seconds.
31409 .endlist
31410
31411 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31412 out the values of all the &[local_scan()]& options.
31413
31414
31415
31416 .section "Available Exim variables" "SECID208"
31417 .cindex "&[local_scan()]& function" "available Exim variables"
31418 The header &_local_scan.h_& gives you access to a number of C variables. These
31419 are the only ones that are guaranteed to be maintained from release to release.
31420 Note, however, that you can obtain the value of any Exim expansion variable,
31421 including &$recipients$&, by calling &'expand_string()'&. The exported
31422 C variables are as follows:
31423
31424 .vlist
31425 .vitem &*int&~body_linecount*&
31426 This variable contains the number of lines in the message's body.
31427
31428 .vitem &*int&~body_zerocount*&
31429 This variable contains the number of binary zero bytes in the message's body.
31430
31431 .vitem &*unsigned&~int&~debug_selector*&
31432 This variable is set to zero when no debugging is taking place. Otherwise, it
31433 is a bitmap of debugging selectors. Two bits are identified for use in
31434 &[local_scan()]&; they are defined as macros:
31435
31436 .ilist
31437 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31438 testing option that is not privileged &-- any caller may set it. All the
31439 other selector bits can be set only by admin users.
31440
31441 .next
31442 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31443 by the &`+local_scan`& debug selector. It is not included in the default set
31444 of debugging bits.
31445 .endlist ilist
31446
31447 Thus, to write to the debugging output only when &`+local_scan`& has been
31448 selected, you should use code like this:
31449 .code
31450 if ((debug_selector & D_local_scan) != 0)
31451   debug_printf("xxx", ...);
31452 .endd
31453 .vitem &*uschar&~*expand_string_message*&
31454 After a failing call to &'expand_string()'& (returned value NULL), the
31455 variable &%expand_string_message%& contains the error message, zero-terminated.
31456
31457 .vitem &*header_line&~*header_list*&
31458 A pointer to a chain of header lines. The &%header_line%& structure is
31459 discussed below.
31460
31461 .vitem &*header_line&~*header_last*&
31462 A pointer to the last of the header lines.
31463
31464 .vitem &*uschar&~*headers_charset*&
31465 The value of the &%headers_charset%& configuration option.
31466
31467 .vitem &*BOOL&~host_checking*&
31468 This variable is TRUE during a host checking session that is initiated by the
31469 &%-bh%& command line option.
31470
31471 .vitem &*uschar&~*interface_address*&
31472 The IP address of the interface that received the message, as a string. This
31473 is NULL for locally submitted messages.
31474
31475 .vitem &*int&~interface_port*&
31476 The port on which this message was received. When testing with the &%-bh%&
31477 command line option, the value of this variable is -1 unless a port has been
31478 specified via the &%-oMi%& option.
31479
31480 .vitem &*uschar&~*message_id*&
31481 This variable contains Exim's message id for the incoming message (the value of
31482 &$message_exim_id$&) as a zero-terminated string.
31483
31484 .vitem &*uschar&~*received_protocol*&
31485 The name of the protocol by which the message was received.
31486
31487 .vitem &*int&~recipients_count*&
31488 The number of accepted recipients.
31489
31490 .vitem &*recipient_item&~*recipients_list*&
31491 .cindex "recipient" "adding in local scan"
31492 .cindex "recipient" "removing in local scan"
31493 The list of accepted recipients, held in a vector of length
31494 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31495 can add additional recipients by calling &'receive_add_recipient()'& (see
31496 below). You can delete recipients by removing them from the vector and
31497 adjusting the value in &%recipients_count%&. In particular, by setting
31498 &%recipients_count%& to zero you remove all recipients. If you then return the
31499 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31500 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31501 and then call &'receive_add_recipient()'& as often as needed.
31502
31503 .vitem &*uschar&~*sender_address*&
31504 The envelope sender address. For bounce messages this is the empty string.
31505
31506 .vitem &*uschar&~*sender_host_address*&
31507 The IP address of the sending host, as a string. This is NULL for
31508 locally-submitted messages.
31509
31510 .vitem &*uschar&~*sender_host_authenticated*&
31511 The name of the authentication mechanism that was used, or NULL if the message
31512 was not received over an authenticated SMTP connection.
31513
31514 .vitem &*uschar&~*sender_host_name*&
31515 The name of the sending host, if known.
31516
31517 .vitem &*int&~sender_host_port*&
31518 The port on the sending host.
31519
31520 .vitem &*BOOL&~smtp_input*&
31521 This variable is TRUE for all SMTP input, including BSMTP.
31522
31523 .vitem &*BOOL&~smtp_batched_input*&
31524 This variable is TRUE for BSMTP input.
31525
31526 .vitem &*int&~store_pool*&
31527 The contents of this variable control which pool of memory is used for new
31528 requests. See section &<<SECTmemhanloc>>& for details.
31529 .endlist
31530
31531
31532 .section "Structure of header lines" "SECID209"
31533 The &%header_line%& structure contains the members listed below.
31534 You can add additional header lines by calling the &'header_add()'& function
31535 (see below). You can cause header lines to be ignored (deleted) by setting
31536 their type to *.
31537
31538
31539 .vlist
31540 .vitem &*struct&~header_line&~*next*&
31541 A pointer to the next header line, or NULL for the last line.
31542
31543 .vitem &*int&~type*&
31544 A code identifying certain headers that Exim recognizes. The codes are printing
31545 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31546 Notice in particular that any header line whose type is * is not transmitted
31547 with the message. This flagging is used for header lines that have been
31548 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31549 lines.) Effectively, * means &"deleted"&.
31550
31551 .vitem &*int&~slen*&
31552 The number of characters in the header line, including the terminating and any
31553 internal newlines.
31554
31555 .vitem &*uschar&~*text*&
31556 A pointer to the text of the header. It always ends with a newline, followed by
31557 a zero byte. Internal newlines are preserved.
31558 .endlist
31559
31560
31561
31562 .section "Structure of recipient items" "SECID210"
31563 The &%recipient_item%& structure contains these members:
31564
31565 .vlist
31566 .vitem &*uschar&~*address*&
31567 This is a pointer to the recipient address as it was received.
31568
31569 .vitem &*int&~pno*&
31570 This is used in later Exim processing when top level addresses are created by
31571 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31572 and must always contain -1 at this stage.
31573
31574 .vitem &*uschar&~*errors_to*&
31575 If this value is not NULL, bounce messages caused by failing to deliver to the
31576 recipient are sent to the address it contains. In other words, it overrides the
31577 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31578 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31579 an unqualified address, Exim qualifies it using the domain from
31580 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31581 is NULL for all recipients.
31582 .endlist
31583
31584
31585
31586 .section "Available Exim functions" "SECID211"
31587 .cindex "&[local_scan()]& function" "available Exim functions"
31588 The header &_local_scan.h_& gives you access to a number of Exim functions.
31589 These are the only ones that are guaranteed to be maintained from release to
31590 release:
31591
31592 .vlist
31593 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31594        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31595
31596 This function creates a child process that runs the command specified by
31597 &%argv%&. The environment for the process is specified by &%envp%&, which can
31598 be NULL if no environment variables are to be passed. A new umask is supplied
31599 for the process in &%newumask%&.
31600
31601 Pipes to the standard input and output of the new process are set up
31602 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31603 standard error is cloned to the standard output. If there are any file
31604 descriptors &"in the way"& in the new process, they are closed. If the final
31605 argument is TRUE, the new process is made into a process group leader.
31606
31607 The function returns the pid of the new process, or -1 if things go wrong.
31608
31609 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31610 This function waits for a child process to terminate, or for a timeout (in
31611 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31612 return value is as follows:
31613
31614 .ilist
31615 >= 0
31616
31617 The process terminated by a normal exit and the value is the process
31618 ending status.
31619
31620 .next
31621 < 0 and > &--256
31622
31623 The process was terminated by a signal and the value is the negation of the
31624 signal number.
31625
31626 .next
31627 &--256
31628
31629 The process timed out.
31630 .next
31631 &--257
31632
31633 The was some other error in wait(); &%errno%& is still set.
31634 .endlist
31635
31636 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31637 This function provide you with a means of submitting a new message to
31638 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31639 want, but this packages it all up for you.) The function creates a pipe,
31640 forks a subprocess that is running
31641 .code
31642 exim -t -oem -oi -f <>
31643 .endd
31644 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31645 that is connected to the standard input. The yield of the function is the PID
31646 of the subprocess. You can then write a message to the file descriptor, with
31647 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31648
31649 When you have finished, call &'child_close()'& to wait for the process to
31650 finish and to collect its ending status. A timeout value of zero is usually
31651 fine in this circumstance. Unless you have made a mistake with the recipient
31652 addresses, you should get a return code of zero.
31653
31654
31655 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31656        *sender_authentication)*&
31657 This function is a more sophisticated version of &'child_open()'&. The command
31658 that it runs is:
31659 .display
31660 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31661 .endd
31662 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31663
31664
31665 .vitem &*void&~debug_printf(char&~*,&~...)*&
31666 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31667 output is written to the standard error stream. If no debugging is selected,
31668 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31669 conditional on the &`local_scan`& debug selector by coding like this:
31670 .code
31671 if ((debug_selector & D_local_scan) != 0)
31672   debug_printf("xxx", ...);
31673 .endd
31674
31675 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31676 This is an interface to Exim's string expansion code. The return value is the
31677 expanded string, or NULL if there was an expansion failure.
31678 The C variable &%expand_string_message%& contains an error message after an
31679 expansion failure. If expansion does not change the string, the return value is
31680 the pointer to the input string. Otherwise, the return value points to a new
31681 block of memory that was obtained by a call to &'store_get()'&. See section
31682 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31683
31684 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31685 This function allows you to an add additional header line at the end of the
31686 existing ones. The first argument is the type, and should normally be a space
31687 character. The second argument is a format string and any number of
31688 substitution arguments as for &[sprintf()]&. You may include internal newlines
31689 if you want, and you must ensure that the string ends with a newline.
31690
31691 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31692         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31693 This function adds a new header line at a specified point in the header
31694 chain. The header itself is specified as for &'header_add()'&.
31695
31696 If &%name%& is NULL, the new header is added at the end of the chain if
31697 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31698 NULL, the header lines are searched for the first non-deleted header that
31699 matches the name. If one is found, the new header is added before it if
31700 &%after%& is false. If &%after%& is true, the new header is added after the
31701 found header and any adjacent subsequent ones with the same name (even if
31702 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31703 option controls where the header is added. If it is true, addition is at the
31704 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31705 headers, or at the top if there are no &'Received:'& headers, you could use
31706 .code
31707 header_add_at_position(TRUE, US"Received", TRUE,
31708   ' ', "X-xxx: ...");
31709 .endd
31710 Normally, there is always at least one non-deleted &'Received:'& header, but
31711 there may not be if &%received_header_text%& expands to an empty string.
31712
31713
31714 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31715 This function removes header lines. If &%occurrence%& is zero or negative, all
31716 occurrences of the header are removed. If occurrence is greater than zero, that
31717 particular instance of the header is removed. If no header(s) can be found that
31718 match the specification, the function does nothing.
31719
31720
31721 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31722         int&~length,&~BOOL&~notdel)*&"
31723 This function tests whether the given header has the given name. It is not just
31724 a string comparison, because white space is permitted between the name and the
31725 colon. If the &%notdel%& argument is true, a false return is forced for all
31726 &"deleted"& headers; otherwise they are not treated specially. For example:
31727 .code
31728 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31729 .endd
31730 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31731 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31732 This function base64-encodes a string, which is passed by address and length.
31733 The text may contain bytes of any value, including zero. The result is passed
31734 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31735 zero-terminated.
31736
31737 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31738 This function decodes a base64-encoded string. Its arguments are a
31739 zero-terminated base64-encoded string and the address of a variable that is set
31740 to point to the result, which is in dynamic memory. The length of the decoded
31741 string is the yield of the function. If the input is invalid base64 data, the
31742 yield is -1. A zero byte is added to the end of the output string to make it
31743 easy to interpret as a C string (assuming it contains no zeros of its own). The
31744 added zero byte is not included in the returned count.
31745
31746 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31747 This function checks for a match in a domain list. Domains are always
31748 matched caselessly. The return value is one of the following:
31749 .display
31750 &`OK     `& match succeeded
31751 &`FAIL   `& match failed
31752 &`DEFER  `& match deferred
31753 .endd
31754 DEFER is usually caused by some kind of lookup defer, such as the
31755 inability to contact a database.
31756
31757 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31758         BOOL&~caseless)*&"
31759 This function checks for a match in a local part list. The third argument
31760 controls case-sensitivity. The return values are as for
31761 &'lss_match_domain()'&.
31762
31763 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31764         BOOL&~caseless)*&"
31765 This function checks for a match in an address list. The third argument
31766 controls the case-sensitivity of the local part match. The domain is always
31767 matched caselessly. The return values are as for &'lss_match_domain()'&.
31768
31769 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31770         uschar&~*list)*&"
31771 This function checks for a match in a host list. The most common usage is
31772 expected to be
31773 .code
31774 lss_match_host(sender_host_name, sender_host_address, ...)
31775 .endd
31776 .vindex "&$sender_host_address$&"
31777 An empty address field matches an empty item in the host list. If the host name
31778 is NULL, the name corresponding to &$sender_host_address$& is automatically
31779 looked up if a host name is required to match an item in the list. The return
31780 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31781 returns ERROR in the case when it had to look up a host name, but the lookup
31782 failed.
31783
31784 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31785         *format,&~...)*&"
31786 This function writes to Exim's log files. The first argument should be zero (it
31787 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31788 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31789 them. It specifies to which log or logs the message is written. The remaining
31790 arguments are a format and relevant insertion arguments. The string should not
31791 contain any newlines, not even at the end.
31792
31793
31794 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31795 This function adds an additional recipient to the message. The first argument
31796 is the recipient address. If it is unqualified (has no domain), it is qualified
31797 with the &%qualify_recipient%& domain. The second argument must always be -1.
31798
31799 This function does not allow you to specify a private &%errors_to%& address (as
31800 described with the structure of &%recipient_item%& above), because it pre-dates
31801 the addition of that field to the structure. However, it is easy to add such a
31802 value afterwards. For example:
31803 .code
31804  receive_add_recipient(US"monitor@mydom.example", -1);
31805  recipients_list[recipients_count-1].errors_to =
31806    US"postmaster@mydom.example";
31807 .endd
31808
31809 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31810 This is a convenience function to remove a named recipient from the list of
31811 recipients. It returns true if a recipient was removed, and false if no
31812 matching recipient could be found. The argument must be a complete email
31813 address.
31814 .endlist
31815
31816
31817 .cindex "RFC 2047"
31818 .vlist
31819 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31820   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31821 This function decodes strings that are encoded according to RFC 2047. Typically
31822 these are the contents of header lines. First, each &"encoded word"& is decoded
31823 from the Q or B encoding into a byte-string. Then, if provided with the name of
31824 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31825 made  to translate the result to the named character set. If this fails, the
31826 binary string is returned with an error message.
31827
31828 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31829 maximum MIME word length is enforced. The third argument is the target
31830 encoding, or NULL if no translation is wanted.
31831
31832 .cindex "binary zero" "in RFC 2047 decoding"
31833 .cindex "RFC 2047" "binary zero in"
31834 If a binary zero is encountered in the decoded string, it is replaced by the
31835 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31836 not be 0 because header lines are handled as zero-terminated strings.
31837
31838 The function returns the result of processing the string, zero-terminated; if
31839 &%lenptr%& is not NULL, the length of the result is set in the variable to
31840 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31841
31842 If an error is encountered, the function returns NULL and uses the &%error%&
31843 argument to return an error message. The variable pointed to by &%error%& is
31844 set to NULL if there is no error; it may be set non-NULL even when the function
31845 returns a non-NULL value if decoding was successful, but there was a problem
31846 with translation.
31847
31848
31849 .vitem &*int&~smtp_fflush(void)*&
31850 This function is used in conjunction with &'smtp_printf()'&, as described
31851 below.
31852
31853 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31854 The arguments of this function are like &[printf()]&; it writes to the SMTP
31855 output stream. You should use this function only when there is an SMTP output
31856 stream, that is, when the incoming message is being received via interactive
31857 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31858 is FALSE. If you want to test for an incoming message from another host (as
31859 opposed to a local process that used the &%-bs%& command line option), you can
31860 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31861 is involved.
31862
31863 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31864 output function, so it can be used for all forms of SMTP connection.
31865
31866 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31867 must start with an appropriate response code: 550 if you are going to return
31868 LOCAL_SCAN_REJECT, 451 if you are going to return
31869 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31870 initial lines of a multi-line response, the code must be followed by a hyphen
31871 to indicate that the line is not the final response line. You must also ensure
31872 that the lines you write terminate with CRLF. For example:
31873 .code
31874 smtp_printf("550-this is some extra info\r\n");
31875 return LOCAL_SCAN_REJECT;
31876 .endd
31877 Note that you can also create multi-line responses by including newlines in
31878 the data returned via the &%return_text%& argument. The added value of using
31879 &'smtp_printf()'& is that, for instance, you could introduce delays between
31880 multiple output lines.
31881
31882 The &'smtp_printf()'& function does not return any error indication, because it
31883 does not automatically flush pending output, and therefore does not test
31884 the state of the stream. (In the main code of Exim, flushing and error
31885 detection is done when Exim is ready for the next SMTP input command.) If
31886 you want to flush the output and check for an error (for example, the
31887 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31888 arguments. It flushes the output stream, and returns a non-zero value if there
31889 is an error.
31890
31891 .vitem &*void&~*store_get(int)*&
31892 This function accesses Exim's internal store (memory) manager. It gets a new
31893 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31894 runs out of memory. See the next section for a discussion of memory handling.
31895
31896 .vitem &*void&~*store_get_perm(int)*&
31897 This function is like &'store_get()'&, but it always gets memory from the
31898 permanent pool. See the next section for a discussion of memory handling.
31899
31900 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31901 See below.
31902
31903 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31904 See below.
31905
31906 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31907 These three functions create strings using Exim's dynamic memory facilities.
31908 The first makes a copy of an entire string. The second copies up to a maximum
31909 number of characters, indicated by the second argument. The third uses a format
31910 and insertion arguments to create a new string. In each case, the result is a
31911 pointer to a new string in the current memory pool. See the next section for
31912 more discussion.
31913 .endlist
31914
31915
31916
31917 .section "More about Exim's memory handling" "SECTmemhanloc"
31918 .cindex "&[local_scan()]& function" "memory handling"
31919 No function is provided for freeing memory, because that is never needed.
31920 The dynamic memory that Exim uses when receiving a message is automatically
31921 recycled if another message is received by the same process (this applies only
31922 to incoming SMTP connections &-- other input methods can supply only one
31923 message at a time). After receiving the last message, a reception process
31924 terminates.
31925
31926 Because it is recycled, the normal dynamic memory cannot be used for holding
31927 data that must be preserved over a number of incoming messages on the same SMTP
31928 connection. However, Exim in fact uses two pools of dynamic memory; the second
31929 one is not recycled, and can be used for this purpose.
31930
31931 If you want to allocate memory that remains available for subsequent messages
31932 in the same SMTP connection, you should set
31933 .code
31934 store_pool = POOL_PERM
31935 .endd
31936 before calling the function that does the allocation. There is no need to
31937 restore the value if you do not need to; however, if you do want to revert to
31938 the normal pool, you can either restore the previous value of &%store_pool%& or
31939 set it explicitly to POOL_MAIN.
31940
31941 The pool setting applies to all functions that get dynamic memory, including
31942 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31943 There is also a convenience function called &'store_get_perm()'& that gets a
31944 block of memory from the permanent pool while preserving the value of
31945 &%store_pool%&.
31946 .ecindex IIDlosca
31947
31948
31949
31950
31951 . ////////////////////////////////////////////////////////////////////////////
31952 . ////////////////////////////////////////////////////////////////////////////
31953
31954 .chapter "System-wide message filtering" "CHAPsystemfilter"
31955 .scindex IIDsysfil1 "filter" "system filter"
31956 .scindex IIDsysfil2 "filtering all mail"
31957 .scindex IIDsysfil3 "system filter"
31958 The previous chapters (on ACLs and the local scan function) describe checks
31959 that can be applied to messages before they are accepted by a host. There is
31960 also a mechanism for checking messages once they have been received, but before
31961 they are delivered. This is called the &'system filter'&.
31962
31963 The system filter operates in a similar manner to users' filter files, but it
31964 is run just once per message (however many recipients the message has).
31965 It should not normally be used as a substitute for routing, because &%deliver%&
31966 commands in a system router provide new envelope recipient addresses.
31967 The system filter must be an Exim filter. It cannot be a Sieve filter.
31968
31969 The system filter is run at the start of a delivery attempt, before any routing
31970 is done. If a message fails to be completely delivered at the first attempt,
31971 the system filter is run again at the start of every retry.
31972 If you want your filter to do something only once per message, you can make use
31973 of the &%first_delivery%& condition in an &%if%& command in the filter to
31974 prevent it happening on retries.
31975
31976 .vindex "&$domain$&"
31977 .vindex "&$local_part$&"
31978 &*Warning*&: Because the system filter runs just once, variables that are
31979 specific to individual recipient addresses, such as &$local_part$& and
31980 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31981 you want to run a centrally-specified filter for each recipient address
31982 independently, you can do so by setting up a suitable &(redirect)& router, as
31983 described in section &<<SECTperaddfil>>& below.
31984
31985
31986 .section "Specifying a system filter" "SECID212"
31987 .cindex "uid (user id)" "system filter"
31988 .cindex "gid (group id)" "system filter"
31989 The name of the file that contains the system filter must be specified by
31990 setting &%system_filter%&. If you want the filter to run under a uid and gid
31991 other than root, you must also set &%system_filter_user%& and
31992 &%system_filter_group%& as appropriate. For example:
31993 .code
31994 system_filter = /etc/mail/exim.filter
31995 system_filter_user = exim
31996 .endd
31997 If a system filter generates any deliveries directly to files or pipes (via the
31998 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31999 specified by setting &%system_filter_file_transport%& and
32000 &%system_filter_pipe_transport%&, respectively. Similarly,
32001 &%system_filter_reply_transport%& must be set to handle any messages generated
32002 by the &%reply%& command.
32003
32004
32005 .section "Testing a system filter" "SECID213"
32006 You can run simple tests of a system filter in the same way as for a user
32007 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32008 are permitted only in system filters are recognized.
32009
32010 If you want to test the combined effect of a system filter and a user filter,
32011 you can use both &%-bF%& and &%-bf%& on the same command line.
32012
32013
32014
32015 .section "Contents of a system filter" "SECID214"
32016 The language used to specify system filters is the same as for users' filter
32017 files. It is described in the separate end-user document &'Exim's interface to
32018 mail filtering'&. However, there are some additional features that are
32019 available only in system filters; these are described in subsequent sections.
32020 If they are encountered in a user's filter file or when testing with &%-bf%&,
32021 they cause errors.
32022
32023 .cindex "frozen messages" "manual thaw; testing in filter"
32024 There are two special conditions which, though available in users' filter
32025 files, are designed for use in system filters. The condition &%first_delivery%&
32026 is true only for the first attempt at delivering a message, and
32027 &%manually_thawed%& is true only if the message has been frozen, and
32028 subsequently thawed by an admin user. An explicit forced delivery counts as a
32029 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32030
32031 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32032 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32033 succeed, it will not be tried again.
32034 If you want Exim to retry an unseen delivery until it succeeds, you should
32035 arrange to set it up every time the filter runs.
32036
32037 When a system filter finishes running, the values of the variables &$n0$& &--
32038 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32039 users' filter files. Thus a system filter can, for example, set up &"scores"&
32040 to which users' filter files can refer.
32041
32042
32043
32044 .section "Additional variable for system filters" "SECID215"
32045 .vindex "&$recipients$&"
32046 The expansion variable &$recipients$&, containing a list of all the recipients
32047 of the message (separated by commas and white space), is available in system
32048 filters. It is not available in users' filters for privacy reasons.
32049
32050
32051
32052 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32053 .cindex "freezing messages"
32054 .cindex "message" "freezing"
32055 .cindex "message" "forced failure"
32056 .cindex "&%fail%&" "in system filter"
32057 .cindex "&%freeze%& in system filter"
32058 .cindex "&%defer%& in system filter"
32059 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32060 always available in system filters, but are not normally enabled in users'
32061 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32062 for the &(redirect)& router.) These commands can optionally be followed by the
32063 word &%text%& and a string containing an error message, for example:
32064 .code
32065 fail text "this message looks like spam to me"
32066 .endd
32067 The keyword &%text%& is optional if the next character is a double quote.
32068
32069 The &%defer%& command defers delivery of the original recipients of the
32070 message. The &%fail%& command causes all the original recipients to be failed,
32071 and a bounce message to be created. The &%freeze%& command suspends all
32072 delivery attempts for the original recipients. In all cases, any new deliveries
32073 that are specified by the filter are attempted as normal after the filter has
32074 run.
32075
32076 The &%freeze%& command is ignored if the message has been manually unfrozen and
32077 not manually frozen since. This means that automatic freezing by a system
32078 filter can be used as a way of checking out suspicious messages. If a message
32079 is found to be all right, manually unfreezing it allows it to be delivered.
32080
32081 .cindex "log" "&%fail%& command log line"
32082 .cindex "&%fail%&" "log line; reducing"
32083 The text given with a fail command is used as part of the bounce message as
32084 well as being written to the log. If the message is quite long, this can fill
32085 up a lot of log space when such failures are common. To reduce the size of the
32086 log message, Exim interprets the text in a special way if it starts with the
32087 two characters &`<<`& and contains &`>>`& later. The text between these two
32088 strings is written to the log, and the rest of the text is used in the bounce
32089 message. For example:
32090 .code
32091 fail "<<filter test 1>>Your message is rejected \
32092      because it contains attachments that we are \
32093      not prepared to receive."
32094 .endd
32095
32096 .cindex "loop" "caused by &%fail%&"
32097 Take great care with the &%fail%& command when basing the decision to fail on
32098 the contents of the message, because the bounce message will of course include
32099 the contents of the original message and will therefore trigger the &%fail%&
32100 command again (causing a mail loop) unless steps are taken to prevent this.
32101 Testing the &%error_message%& condition is one way to prevent this. You could
32102 use, for example
32103 .code
32104 if $message_body contains "this is spam" and not error_message
32105 then fail text "spam is not wanted here" endif
32106 .endd
32107 though of course that might let through unwanted bounce messages. The
32108 alternative is clever checking of the body and/or headers to detect bounces
32109 generated by the filter.
32110
32111 The interpretation of a system filter file ceases after a
32112 &%defer%&,
32113 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32114 set up earlier in the filter file are honoured, so you can use a sequence such
32115 as
32116 .code
32117 mail ...
32118 freeze
32119 .endd
32120 to send a specified message when the system filter is freezing (or deferring or
32121 failing) a message. The normal deliveries for the message do not, of course,
32122 take place.
32123
32124
32125
32126 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32127 .cindex "header lines" "adding; in system filter"
32128 .cindex "header lines" "removing; in system filter"
32129 .cindex "filter" "header lines; adding/removing"
32130 Two filter commands that are available only in system filters are:
32131 .code
32132 headers add <string>
32133 headers remove <string>
32134 .endd
32135 The argument for the &%headers add%& is a string that is expanded and then
32136 added to the end of the message's headers. It is the responsibility of the
32137 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32138 space is ignored, and if the string is otherwise empty, or if the expansion is
32139 forced to fail, the command has no effect.
32140
32141 You can use &"\n"& within the string, followed by white space, to specify
32142 continued header lines. More than one header may be added in one command by
32143 including &"\n"& within the string without any following white space. For
32144 example:
32145 .code
32146 headers add "X-header-1: ....\n  \
32147              continuation of X-header-1 ...\n\
32148              X-header-2: ...."
32149 .endd
32150 Note that the header line continuation white space after the first newline must
32151 be placed before the backslash that continues the input string, because white
32152 space after input continuations is ignored.
32153
32154 The argument for &%headers remove%& is a colon-separated list of header names.
32155 This command applies only to those headers that are stored with the message;
32156 those that are added at delivery time (such as &'Envelope-To:'& and
32157 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32158 header with the same name, they are all removed.
32159
32160 The &%headers%& command in a system filter makes an immediate change to the set
32161 of header lines that was received with the message (with possible additions
32162 from ACL processing). Subsequent commands in the system filter operate on the
32163 modified set, which also forms the basis for subsequent message delivery.
32164 Unless further modified during routing or transporting, this set of headers is
32165 used for all recipients of the message.
32166
32167 During routing and transporting, the variables that refer to the contents of
32168 header lines refer only to those lines that are in this set. Thus, header lines
32169 that are added by a system filter are visible to users' filter files and to all
32170 routers and transports. This contrasts with the manipulation of header lines by
32171 routers and transports, which is not immediate, but which instead is saved up
32172 until the message is actually being written (see section
32173 &<<SECTheadersaddrem>>&).
32174
32175 If the message is not delivered at the first attempt, header lines that were
32176 added by the system filter are stored with the message, and so are still
32177 present at the next delivery attempt. Header lines that were removed are still
32178 present, but marked &"deleted"& so that they are not transported with the
32179 message. For this reason, it is usual to make the &%headers%& command
32180 conditional on &%first_delivery%& so that the set of header lines is not
32181 modified more than once.
32182
32183 Because header modification in a system filter acts immediately, you have to
32184 use an indirect approach if you want to modify the contents of a header line.
32185 For example:
32186 .code
32187 headers add "Old-Subject: $h_subject:"
32188 headers remove "Subject"
32189 headers add "Subject: new subject (was: $h_old-subject:)"
32190 headers remove "Old-Subject"
32191 .endd
32192
32193
32194
32195 .section "Setting an errors address in a system filter" "SECID217"
32196 .cindex "envelope sender"
32197 In a system filter, if a &%deliver%& command is followed by
32198 .code
32199 errors_to <some address>
32200 .endd
32201 in order to change the envelope sender (and hence the error reporting) for that
32202 delivery, any address may be specified. (In a user filter, only the current
32203 user's address can be set.) For example, if some mail is being monitored, you
32204 might use
32205 .code
32206 unseen deliver monitor@spying.example errors_to root@local.example
32207 .endd
32208 to take a copy which would not be sent back to the normal error reporting
32209 address if its delivery failed.
32210
32211
32212
32213 .section "Per-address filtering" "SECTperaddfil"
32214 .vindex "&$domain$&"
32215 .vindex "&$local_part$&"
32216 In contrast to the system filter, which is run just once per message for each
32217 delivery attempt, it is also possible to set up a system-wide filtering
32218 operation that runs once for each recipient address. In this case, variables
32219 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32220 filter file could be made dependent on them. This is an example of a router
32221 which implements such a filter:
32222 .code
32223 central_filter:
32224   check_local_user
32225   driver = redirect
32226   domains = +local_domains
32227   file = /central/filters/$local_part
32228   no_verify
32229   allow_filter
32230   allow_freeze
32231 .endd
32232 The filter is run in a separate process under its own uid. Therefore, either
32233 &%check_local_user%& must be set (as above), in which case the filter is run as
32234 the local user, or the &%user%& option must be used to specify which user to
32235 use. If both are set, &%user%& overrides.
32236
32237 Care should be taken to ensure that none of the commands in the filter file
32238 specify a significant delivery if the message is to go on to be delivered to
32239 its intended recipient. The router will not then claim to have dealt with the
32240 address, so it will be passed on to subsequent routers to be delivered in the
32241 normal way.
32242 .ecindex IIDsysfil1
32243 .ecindex IIDsysfil2
32244 .ecindex IIDsysfil3
32245
32246
32247
32248
32249
32250
32251 . ////////////////////////////////////////////////////////////////////////////
32252 . ////////////////////////////////////////////////////////////////////////////
32253
32254 .chapter "Message processing" "CHAPmsgproc"
32255 .scindex IIDmesproc "message" "general processing"
32256 Exim performs various transformations on the sender and recipient addresses of
32257 all messages that it handles, and also on the messages' header lines. Some of
32258 these are optional and configurable, while others always take place. All of
32259 this processing, except rewriting as a result of routing, and the addition or
32260 removal of header lines while delivering, happens when a message is received,
32261 before it is placed on Exim's queue.
32262
32263 Some of the automatic processing takes place by default only for
32264 &"locally-originated"& messages. This adjective is used to describe messages
32265 that are not received over TCP/IP, but instead are passed to an Exim process on
32266 its standard input. This includes the interactive &"local SMTP"& case that is
32267 set up by the &%-bs%& command line option.
32268
32269 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32270 or ::1) are not considered to be locally-originated. Exim does not treat the
32271 loopback interface specially in any way.
32272
32273 If you want the loopback interface to be treated specially, you must ensure
32274 that there are appropriate entries in your ACLs.
32275
32276
32277
32278
32279 .section "Submission mode for non-local messages" "SECTsubmodnon"
32280 .cindex "message" "submission"
32281 .cindex "submission mode"
32282 Processing that happens automatically for locally-originated messages (unless
32283 &%suppress_local_fixups%& is set) can also be requested for messages that are
32284 received over TCP/IP. The term &"submission mode"& is used to describe this
32285 state. Submission mode is set by the modifier
32286 .code
32287 control = submission
32288 .endd
32289 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32290 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32291 a local submission, and is normally used when the source of the message is
32292 known to be an MUA running on a client host (as opposed to an MTA). For
32293 example, to set submission mode for messages originating on the IPv4 loopback
32294 interface, you could include the following in the MAIL ACL:
32295 .code
32296 warn  hosts = 127.0.0.1
32297       control = submission
32298 .endd
32299 .cindex "&%sender_retain%& submission option"
32300 There are some options that can be used when setting submission mode. A slash
32301 is used to separate options. For example:
32302 .code
32303 control = submission/sender_retain
32304 .endd
32305 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32306 true and &%local_from_check%& false for the current incoming message. The first
32307 of these allows an existing &'Sender:'& header in the message to remain, and
32308 the second suppresses the check to ensure that &'From:'& matches the
32309 authenticated sender. With this setting, Exim still fixes up messages by adding
32310 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32311 attempt to check sender authenticity in header lines.
32312
32313 When &%sender_retain%& is not set, a submission mode setting may specify a
32314 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32315 example:
32316 .code
32317 control = submission/domain=some.domain
32318 .endd
32319 The domain may be empty. How this value is used is described in sections
32320 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32321 that allows you to specify the user's full name for inclusion in a created
32322 &'Sender:'& or &'From:'& header line. For example:
32323 .code
32324 accept authenticated = *
32325        control = submission/domain=wonderland.example/\
32326                             name=${lookup {$authenticated_id} \
32327                                    lsearch {/etc/exim/namelist}}
32328 .endd
32329 Because the name may contain any characters, including slashes, the &%name%&
32330 option must be given last. The remainder of the string is used as the name. For
32331 the example above, if &_/etc/exim/namelist_& contains:
32332 .code
32333 bigegg:  Humpty Dumpty
32334 .endd
32335 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32336 line would be:
32337 .code
32338 Sender: Humpty Dumpty <bigegg@wonderland.example>
32339 .endd
32340 .cindex "return path" "in submission mode"
32341 By default, submission mode forces the return path to the same address as is
32342 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32343 specified, the return path is also left unchanged.
32344
32345 &*Note*&: The changes caused by submission mode take effect after the predata
32346 ACL. This means that any sender checks performed before the fix-ups use the
32347 untrusted sender address specified by the user, not the trusted sender address
32348 specified by submission mode. Although this might be slightly unexpected, it
32349 does mean that you can configure ACL checks to spot that a user is trying to
32350 spoof another's address.
32351
32352 .section "Line endings" "SECTlineendings"
32353 .cindex "line endings"
32354 .cindex "carriage return"
32355 .cindex "linefeed"
32356 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32357 linefeed) is the line ending for messages transmitted over the Internet using
32358 SMTP over TCP/IP. However, within individual operating systems, different
32359 conventions are used. For example, Unix-like systems use just LF, but others
32360 use CRLF or just CR.
32361
32362 Exim was designed for Unix-like systems, and internally, it stores messages
32363 using the system's convention of a single LF as a line terminator. When
32364 receiving a message, all line endings are translated to this standard format.
32365 Originally, it was thought that programs that passed messages directly to an
32366 MTA within an operating system would use that system's convention. Experience
32367 has shown that this is not the case; for example, there are Unix applications
32368 that use CRLF in this circumstance. For this reason, and for compatibility with
32369 other MTAs, the way Exim handles line endings for all messages is now as
32370 follows:
32371
32372 .ilist
32373 LF not preceded by CR is treated as a line ending.
32374 .next
32375 CR is treated as a line ending; if it is immediately followed by LF, the LF
32376 is ignored.
32377 .next
32378 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32379 nor a local message in the state where a line containing only a dot is a
32380 terminator.
32381 .next
32382 If a bare CR is encountered within a header line, an extra space is added after
32383 the line terminator so as not to end the header line. The reasoning behind this
32384 is that bare CRs in header lines are most likely either to be mistakes, or
32385 people trying to play silly games.
32386 .next
32387 If the first header line received in a message ends with CRLF, a subsequent
32388 bare LF in a header line is treated in the same way as a bare CR in a header
32389 line.
32390 .endlist
32391
32392
32393
32394
32395
32396 .section "Unqualified addresses" "SECID218"
32397 .cindex "unqualified addresses"
32398 .cindex "address" "qualification"
32399 By default, Exim expects every envelope address it receives from an external
32400 host to be fully qualified. Unqualified addresses cause negative responses to
32401 SMTP commands. However, because SMTP is used as a means of transporting
32402 messages from MUAs running on personal workstations, there is sometimes a
32403 requirement to accept unqualified addresses from specific hosts or IP networks.
32404
32405 Exim has two options that separately control which hosts may send unqualified
32406 sender or recipient addresses in SMTP commands, namely
32407 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32408 cases, if an unqualified address is accepted, it is qualified by adding the
32409 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32410
32411 .oindex "&%qualify_domain%&"
32412 .oindex "&%qualify_recipient%&"
32413 Unqualified addresses in header lines are automatically qualified for messages
32414 that are locally originated, unless the &%-bnq%& option is given on the command
32415 line. For messages received over SMTP, unqualified addresses in header lines
32416 are qualified only if unqualified addresses are permitted in SMTP commands. In
32417 other words, such qualification is also controlled by
32418 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32419
32420
32421
32422
32423 .section "The UUCP From line" "SECID219"
32424 .cindex "&""From""& line"
32425 .cindex "UUCP" "&""From""& line"
32426 .cindex "sender" "address"
32427 .oindex "&%uucp_from_pattern%&"
32428 .oindex "&%uucp_from_sender%&"
32429 .cindex "envelope sender"
32430 .cindex "Sendmail compatibility" "&""From""& line"
32431 Messages that have come from UUCP (and some other applications) often begin
32432 with a line containing the envelope sender and a timestamp, following the word
32433 &"From"&. Examples of two common formats are:
32434 .code
32435 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32436 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32437 .endd
32438 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32439 Exim recognizes such lines at the start of messages that are submitted to it
32440 via the command line (that is, on the standard input). It does not recognize
32441 such lines in incoming SMTP messages, unless the sending host matches
32442 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32443 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32444 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32445 default value matches the two common cases shown above and puts the address
32446 that follows &"From"& into &$1$&.
32447
32448 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32449 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32450 a trusted user, the message's sender address is constructed by expanding the
32451 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32452 then parsed as an RFC 2822 address. If there is no domain, the local part is
32453 qualified with &%qualify_domain%& unless it is the empty string. However, if
32454 the command line &%-f%& option is used, it overrides the &"From"& line.
32455
32456 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32457 sender address is not changed. This is also the case for incoming SMTP messages
32458 that are permitted to contain &"From"& lines.
32459
32460 Only one &"From"& line is recognized. If there is more than one, the second is
32461 treated as a data line that starts the body of the message, as it is not valid
32462 as a header line. This also happens if a &"From"& line is present in an
32463 incoming SMTP message from a source that is not permitted to send them.
32464
32465
32466
32467 .section "Resent- header lines" "SECID220"
32468 .cindex "&%Resent-%& header lines"
32469 RFC 2822 makes provision for sets of header lines starting with the string
32470 &`Resent-`& to be added to a message when it is resent by the original
32471 recipient to somebody else. These headers are &'Resent-Date:'&,
32472 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32473 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32474
32475 .blockquote
32476 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32477 processing of replies or other such automatic actions on messages.'&
32478 .endblockquote
32479
32480 This leaves things a bit vague as far as other processing actions such as
32481 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32482 follows:
32483
32484 .ilist
32485 A &'Resent-From:'& line that just contains the login id of the submitting user
32486 is automatically rewritten in the same way as &'From:'& (see below).
32487 .next
32488 If there's a rewriting rule for a particular header line, it is also applied to
32489 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32490 &'From:'& also rewrites &'Resent-From:'&.
32491 .next
32492 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32493 also removed.
32494 .next
32495 For a locally-submitted message,
32496 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32497 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32498 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32499 included in log lines in this case.
32500 .next
32501 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32502 &%Resent-%& header lines are present.
32503 .endlist
32504
32505
32506
32507
32508 .section "The Auto-Submitted: header line" "SECID221"
32509 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32510 includes the header line:
32511 .code
32512 Auto-Submitted: auto-replied
32513 .endd
32514
32515 .section "The Bcc: header line" "SECID222"
32516 .cindex "&'Bcc:'& header line"
32517 If Exim is called with the &%-t%& option, to take recipient addresses from a
32518 message's header, it removes any &'Bcc:'& header line that may exist (after
32519 extracting its addresses). If &%-t%& is not present on the command line, any
32520 existing &'Bcc:'& is not removed.
32521
32522
32523 .section "The Date: header line" "SECID223"
32524 .cindex "&'Date:'& header line"
32525 If a locally-generated or submission-mode message has no &'Date:'& header line,
32526 Exim adds one, using the current date and time, unless the
32527 &%suppress_local_fixups%& control has been specified.
32528
32529 .section "The Delivery-date: header line" "SECID224"
32530 .cindex "&'Delivery-date:'& header line"
32531 .oindex "&%delivery_date_remove%&"
32532 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32533 set. Exim can be configured to add them to the final delivery of messages. (See
32534 the generic &%delivery_date_add%& transport option.) They should not be present
32535 in messages in transit. If the &%delivery_date_remove%& configuration option is
32536 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32537 messages.
32538
32539
32540 .section "The Envelope-to: header line" "SECID225"
32541 .cindex "&'Envelope-to:'& header line"
32542 .oindex "&%envelope_to_remove%&"
32543 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32544 Exim can be configured to add them to the final delivery of messages. (See the
32545 generic &%envelope_to_add%& transport option.) They should not be present in
32546 messages in transit. If the &%envelope_to_remove%& configuration option is set
32547 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32548 messages.
32549
32550
32551 .section "The From: header line" "SECTthefrohea"
32552 .cindex "&'From:'& header line"
32553 .cindex "Sendmail compatibility" "&""From""& line"
32554 .cindex "message" "submission"
32555 .cindex "submission mode"
32556 If a submission-mode message does not contain a &'From:'& header line, Exim
32557 adds one if either of the following conditions is true:
32558
32559 .ilist
32560 The envelope sender address is not empty (that is, this is not a bounce
32561 message). The added header line copies the envelope sender address.
32562 .next
32563 .vindex "&$authenticated_id$&"
32564 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32565 .olist
32566 .vindex "&$qualify_domain$&"
32567 If no domain is specified by the submission control, the local part is
32568 &$authenticated_id$& and the domain is &$qualify_domain$&.
32569 .next
32570 If a non-empty domain is specified by the submission control, the local
32571 part is &$authenticated_id$&, and the domain is the specified domain.
32572 .next
32573 If an empty domain is specified by the submission control,
32574 &$authenticated_id$& is assumed to be the complete address.
32575 .endlist
32576 .endlist
32577
32578 A non-empty envelope sender takes precedence.
32579
32580 If a locally-generated incoming message does not contain a &'From:'& header
32581 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32582 containing the sender's address. The calling user's login name and full name
32583 are used to construct the address, as described in section &<<SECTconstr>>&.
32584 They are obtained from the password data by calling &[getpwuid()]& (but see the
32585 &%unknown_login%& configuration option). The address is qualified with
32586 &%qualify_domain%&.
32587
32588 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32589 &'From:'& header line containing just the unqualified login name of the calling
32590 user, this is replaced by an address containing the user's login name and full
32591 name as described in section &<<SECTconstr>>&.
32592
32593
32594 .section "The Message-ID: header line" "SECID226"
32595 .cindex "&'Message-ID:'& header line"
32596 .cindex "message" "submission"
32597 .oindex "&%message_id_header_text%&"
32598 If a locally-generated or submission-mode incoming message does not contain a
32599 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32600 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32601 to the message. If there are any &'Resent-:'& headers in the message, it
32602 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32603 message id, preceded by the letter E to ensure it starts with a letter, and
32604 followed by @ and the primary host name. Additional information can be included
32605 in this header line by setting the &%message_id_header_text%& and/or
32606 &%message_id_header_domain%& options.
32607
32608
32609 .section "The Received: header line" "SECID227"
32610 .cindex "&'Received:'& header line"
32611 A &'Received:'& header line is added at the start of every message. The
32612 contents are defined by the &%received_header_text%& configuration option, and
32613 Exim automatically adds a semicolon and a timestamp to the configured string.
32614
32615 The &'Received:'& header is generated as soon as the message's header lines
32616 have been received. At this stage, the timestamp in the &'Received:'& header
32617 line is the time that the message started to be received. This is the value
32618 that is seen by the DATA ACL and by the &[local_scan()]& function.
32619
32620 Once a message is accepted, the timestamp in the &'Received:'& header line is
32621 changed to the time of acceptance, which is (apart from a small delay while the
32622 -H spool file is written) the earliest time at which delivery could start.
32623
32624
32625 .section "The References: header line" "SECID228"
32626 .cindex "&'References:'& header line"
32627 Messages created by the &(autoreply)& transport include a &'References:'&
32628 header line. This is constructed according to the rules that are described in
32629 section 3.64 of RFC 2822 (which states that replies should contain such a
32630 header line), and section 3.14 of RFC 3834 (which states that automatic
32631 responses are not different in this respect). However, because some mail
32632 processing software does not cope well with very long header lines, no more
32633 than 12 message IDs are copied from the &'References:'& header line in the
32634 incoming message. If there are more than 12, the first one and then the final
32635 11 are copied, before adding the message ID of the incoming message.
32636
32637
32638
32639 .section "The Return-path: header line" "SECID229"
32640 .cindex "&'Return-path:'& header line"
32641 .oindex "&%return_path_remove%&"
32642 &'Return-path:'& header lines are defined as something an MTA may insert when
32643 it does the final delivery of messages. (See the generic &%return_path_add%&
32644 transport option.) Therefore, they should not be present in messages in
32645 transit. If the &%return_path_remove%& configuration option is set (the
32646 default), Exim removes &'Return-path:'& header lines from incoming messages.
32647
32648
32649
32650 .section "The Sender: header line" "SECTthesenhea"
32651 .cindex "&'Sender:'& header line"
32652 .cindex "message" "submission"
32653 For a locally-originated message from an untrusted user, Exim may remove an
32654 existing &'Sender:'& header line, and it may add a new one. You can modify
32655 these actions by setting the &%local_sender_retain%& option true, the
32656 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32657 control setting.
32658
32659 When a local message is received from an untrusted user and
32660 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32661 control has not been set, a check is made to see if the address given in the
32662 &'From:'& header line is the correct (local) sender of the message. The address
32663 that is expected has the login name as the local part and the value of
32664 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32665 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32666 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32667 line is added to the message.
32668
32669 If you set &%local_from_check%& false, this checking does not occur. However,
32670 the removal of an existing &'Sender:'& line still happens, unless you also set
32671 &%local_sender_retain%& to be true. It is not possible to set both of these
32672 options true at the same time.
32673
32674 .cindex "submission mode"
32675 By default, no processing of &'Sender:'& header lines is done for messages
32676 received over TCP/IP or for messages submitted by trusted users. However, when
32677 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32678 not specified on the submission control, the following processing takes place:
32679
32680 .vindex "&$authenticated_id$&"
32681 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32682 authenticated, and &$authenticated_id$& is not empty, a sender address is
32683 created as follows:
32684
32685 .ilist
32686 .vindex "&$qualify_domain$&"
32687 If no domain is specified by the submission control, the local part is
32688 &$authenticated_id$& and the domain is &$qualify_domain$&.
32689 .next
32690 If a non-empty domain is specified by the submission control, the local part
32691 is &$authenticated_id$&, and the domain is the specified domain.
32692 .next
32693 If an empty domain is specified by the submission control,
32694 &$authenticated_id$& is assumed to be the complete address.
32695 .endlist
32696
32697 This address is compared with the address in the &'From:'& header line. If they
32698 are different, a &'Sender:'& header line containing the created address is
32699 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32700 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32701
32702 .cindex "return path" "created from &'Sender:'&"
32703 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32704 the message (the envelope sender address) is changed to be the same address,
32705 except in the case of submission mode when &%sender_retain%& is specified.
32706
32707
32708
32709 .section "Adding and removing header lines in routers and transports" &&&
32710          "SECTheadersaddrem"
32711 .cindex "header lines" "adding; in router or transport"
32712 .cindex "header lines" "removing; in router or transport"
32713 When a message is delivered, the addition and removal of header lines can be
32714 specified in a system filter, or on any of the routers and transports that
32715 process the message. Section &<<SECTaddremheasys>>& contains details about
32716 modifying headers in a system filter. Header lines can also be added in an ACL
32717 as a message is received (see section &<<SECTaddheadacl>>&).
32718
32719 In contrast to what happens in a system filter, header modifications that are
32720 specified on routers and transports apply only to the particular recipient
32721 addresses that are being processed by those routers and transports. These
32722 changes do not actually take place until a copy of the message is being
32723 transported. Therefore, they do not affect the basic set of header lines, and
32724 they do not affect the values of the variables that refer to header lines.
32725
32726 &*Note*&: In particular, this means that any expansions in the configuration of
32727 the transport cannot refer to the modified header lines, because such
32728 expansions all occur before the message is actually transported.
32729
32730 For both routers and transports, the argument of a &%headers_add%&
32731 option must be in the form of one or more RFC 2822 header lines, separated by
32732 newlines (coded as &"\n"&). For example:
32733 .code
32734 headers_add = X-added-header: added by $primary_hostname\n\
32735               X-added-second: another added header line
32736 .endd
32737 Exim does not check the syntax of these added header lines.
32738
32739 Multiple &%headers_add%& options for a single router or transport can be
32740 specified; the values will append to a single list of header lines.
32741 Each header-line is separately expanded.
32742
32743 The argument of a &%headers_remove%& option must consist of a colon-separated
32744 list of header names. This is confusing, because header names themselves are
32745 often terminated by colons. In this case, the colons are the list separators,
32746 not part of the names. For example:
32747 .code
32748 headers_remove = return-receipt-to:acknowledge-to
32749 .endd
32750
32751 Multiple &%headers_remove%& options for a single router or transport can be
32752 specified; the arguments will append to a single header-names list.
32753 Each item is separately expanded.
32754 Note that colons in complex expansions which are used to
32755 form all or part of a &%headers_remove%& list
32756 will act as list separators.
32757
32758 When &%headers_add%& or &%headers_remove%& is specified on a router,
32759 items are expanded at routing time,
32760 and then associated with all addresses that are
32761 accepted by that router, and also with any new addresses that it generates. If
32762 an address passes through several routers as a result of aliasing or
32763 forwarding, the changes are cumulative.
32764
32765 .oindex "&%unseen%&"
32766 However, this does not apply to multiple routers that result from the use of
32767 the &%unseen%& option. Any header modifications that were specified by the
32768 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32769
32770 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32771 settings cannot be delivered together in a batch, so a transport is always
32772 dealing with a set of addresses that have the same header-processing
32773 requirements.
32774
32775 The transport starts by writing the original set of header lines that arrived
32776 with the message, possibly modified by the system filter. As it writes out
32777 these lines, it consults the list of header names that were attached to the
32778 recipient address(es) by &%headers_remove%& options in routers, and it also
32779 consults the transport's own &%headers_remove%& option. Header lines whose
32780 names are on either of these lists are not written out. If there are multiple
32781 instances of any listed header, they are all skipped.
32782
32783 After the remaining original header lines have been written, new header
32784 lines that were specified by routers' &%headers_add%& options are written, in
32785 the order in which they were attached to the address. These are followed by any
32786 header lines specified by the transport's &%headers_add%& option.
32787
32788 This way of handling header line modifications in routers and transports has
32789 the following consequences:
32790
32791 .ilist
32792 The original set of header lines, possibly modified by the system filter,
32793 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32794 to it, at all times.
32795 .next
32796 Header lines that are added by a router's
32797 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32798 expansion syntax in subsequent routers or the transport.
32799 .next
32800 Conversely, header lines that are specified for removal by &%headers_remove%&
32801 in a router remain visible to subsequent routers and the transport.
32802 .next
32803 Headers added to an address by &%headers_add%& in a router cannot be removed by
32804 a later router or by a transport.
32805 .next
32806 An added header can refer to the contents of an original header that is to be
32807 removed, even it has the same name as the added header. For example:
32808 .code
32809 headers_remove = subject
32810 headers_add = Subject: new subject (was: $h_subject:)
32811 .endd
32812 .endlist
32813
32814 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32815 for a &(redirect)& router that has the &%one_time%& option set.
32816
32817
32818
32819
32820
32821 .section "Constructed addresses" "SECTconstr"
32822 .cindex "address" "constructed"
32823 .cindex "constructed address"
32824 When Exim constructs a sender address for a locally-generated message, it uses
32825 the form
32826 .display
32827 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32828 .endd
32829 For example:
32830 .code
32831 Zaphod Beeblebrox <zaphod@end.univ.example>
32832 .endd
32833 The user name is obtained from the &%-F%& command line option if set, or
32834 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32835 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32836 ampersand character, this is replaced by the login name with the first letter
32837 upper cased, as is conventional in a number of operating systems. See the
32838 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32839 The &%unknown_username%& option can be used to specify user names in cases when
32840 there is no password file entry.
32841
32842 .cindex "RFC 2047"
32843 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32844 parts of it if necessary. In addition, if it contains any non-printing
32845 characters, it is encoded as described in RFC 2047, which defines a way of
32846 including non-ASCII characters in header lines. The value of the
32847 &%headers_charset%& option specifies the name of the encoding that is used (the
32848 characters are assumed to be in this encoding). The setting of
32849 &%print_topbitchars%& controls whether characters with the top bit set (that
32850 is, with codes greater than 127) count as printing characters or not.
32851
32852
32853
32854 .section "Case of local parts" "SECID230"
32855 .cindex "case of local parts"
32856 .cindex "local part" "case of"
32857 RFC 2822 states that the case of letters in the local parts of addresses cannot
32858 be assumed to be non-significant. Exim preserves the case of local parts of
32859 addresses, but by default it uses a lower-cased form when it is routing,
32860 because on most Unix systems, usernames are in lower case and case-insensitive
32861 routing is required. However, any particular router can be made to use the
32862 original case for local parts by setting the &%caseful_local_part%& generic
32863 router option.
32864
32865 .cindex "mixed-case login names"
32866 If you must have mixed-case user names on your system, the best way to proceed,
32867 assuming you want case-independent handling of incoming email, is to set up
32868 your first router to convert incoming local parts in your domains to the
32869 correct case by means of a file lookup. For example:
32870 .code
32871 correct_case:
32872   driver = redirect
32873   domains = +local_domains
32874   data = ${lookup{$local_part}cdb\
32875               {/etc/usercased.cdb}{$value}fail}\
32876               @$domain
32877 .endd
32878 For this router, the local part is forced to lower case by the default action
32879 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32880 up a new local part in the correct case. If you then set &%caseful_local_part%&
32881 on any subsequent routers which process your domains, they will operate on
32882 local parts with the correct case in a case-sensitive manner.
32883
32884
32885
32886 .section "Dots in local parts" "SECID231"
32887 .cindex "dot" "in local part"
32888 .cindex "local part" "dots in"
32889 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32890 part may not begin or end with a dot, nor have two consecutive dots in the
32891 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32892 empty components for compatibility.
32893
32894
32895
32896 .section "Rewriting addresses" "SECID232"
32897 .cindex "rewriting" "addresses"
32898 Rewriting of sender and recipient addresses, and addresses in headers, can
32899 happen automatically, or as the result of configuration options, as described
32900 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32901 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32902
32903 Automatic rewriting includes qualification, as mentioned above. The other case
32904 in which it can happen is when an incomplete non-local domain is given. The
32905 routing process may cause this to be expanded into the full domain name. For
32906 example, a header such as
32907 .code
32908 To: hare@teaparty
32909 .endd
32910 might get rewritten as
32911 .code
32912 To: hare@teaparty.wonderland.fict.example
32913 .endd
32914 Rewriting as a result of routing is the one kind of message processing that
32915 does not happen at input time, as it cannot be done until the address has
32916 been routed.
32917
32918 Strictly, one should not do &'any'& deliveries of a message until all its
32919 addresses have been routed, in case any of the headers get changed as a
32920 result of routing. However, doing this in practice would hold up many
32921 deliveries for unreasonable amounts of time, just because one address could not
32922 immediately be routed. Exim therefore does not delay other deliveries when
32923 routing of one or more addresses is deferred.
32924 .ecindex IIDmesproc
32925
32926
32927
32928 . ////////////////////////////////////////////////////////////////////////////
32929 . ////////////////////////////////////////////////////////////////////////////
32930
32931 .chapter "SMTP processing" "CHAPSMTP"
32932 .scindex IIDsmtpproc1 "SMTP" "processing details"
32933 .scindex IIDsmtpproc2 "LMTP" "processing details"
32934 Exim supports a number of different ways of using the SMTP protocol, and its
32935 LMTP variant, which is an interactive protocol for transferring messages into a
32936 closed mail store application. This chapter contains details of how SMTP is
32937 processed. For incoming mail, the following are available:
32938
32939 .ilist
32940 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32941 .next
32942 SMTP over the standard input and output (the &%-bs%& option);
32943 .next
32944 Batched SMTP on the standard input (the &%-bS%& option).
32945 .endlist
32946
32947 For mail delivery, the following are available:
32948
32949 .ilist
32950 SMTP over TCP/IP (the &(smtp)& transport);
32951 .next
32952 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32953 &"lmtp"&);
32954 .next
32955 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32956 transport);
32957 .next
32958 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32959 the &%use_bsmtp%& option set).
32960 .endlist
32961
32962 &'Batched SMTP'& is the name for a process in which batches of messages are
32963 stored in or read from files (or pipes), in a format in which SMTP commands are
32964 used to contain the envelope information.
32965
32966
32967
32968 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32969 .cindex "SMTP" "outgoing over TCP/IP"
32970 .cindex "outgoing SMTP over TCP/IP"
32971 .cindex "LMTP" "over TCP/IP"
32972 .cindex "outgoing LMTP over TCP/IP"
32973 .cindex "EHLO"
32974 .cindex "HELO"
32975 .cindex "SIZE option on MAIL command"
32976 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32977 The &%protocol%& option selects which protocol is to be used, but the actual
32978 processing is the same in both cases.
32979
32980 If, in response to its EHLO command, Exim is told that the SIZE
32981 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32982 command. The value of <&'n'&> is the message size plus the value of the
32983 &%size_addition%& option (default 1024) to allow for additions to the message
32984 such as per-transport header lines, or changes made in a
32985 .cindex "transport" "filter"
32986 .cindex "filter" "transport filter"
32987 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32988 suppressed.
32989
32990 If the remote server advertises support for PIPELINING, Exim uses the
32991 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32992 required for the transaction.
32993
32994 If the remote server advertises support for the STARTTLS command, and Exim
32995 was built to support TLS encryption, it tries to start a TLS session unless the
32996 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32997 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32998 is called for verification.
32999
33000 If the remote server advertises support for the AUTH command, Exim scans
33001 the authenticators configuration for any suitable client settings, as described
33002 in chapter &<<CHAPSMTPAUTH>>&.
33003
33004 .cindex "carriage return"
33005 .cindex "linefeed"
33006 Responses from the remote host are supposed to be terminated by CR followed by
33007 LF. However, there are known to be hosts that do not send CR characters, so in
33008 order to be able to interwork with such hosts, Exim treats LF on its own as a
33009 line terminator.
33010
33011 If a message contains a number of different addresses, all those with the same
33012 characteristics (for example, the same envelope sender) that resolve to the
33013 same set of hosts, in the same order, are sent in a single SMTP transaction,
33014 even if they are for different domains, unless there are more than the setting
33015 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33016 they are split into groups containing no more than &%max_rcpt%&s addresses
33017 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33018 in parallel sessions. The order of hosts with identical MX values is not
33019 significant when checking whether addresses can be batched in this way.
33020
33021 When the &(smtp)& transport suffers a temporary failure that is not
33022 message-related, Exim updates its transport-specific database, which contains
33023 records indexed by host name that remember which messages are waiting for each
33024 particular host. It also updates the retry database with new retry times.
33025
33026 .cindex "hints database" "retry keys"
33027 Exim's retry hints are based on host name plus IP address, so if one address of
33028 a multi-homed host is broken, it will soon be skipped most of the time.
33029 See the next section for more detail about error handling.
33030
33031 .cindex "SMTP" "passed connection"
33032 .cindex "SMTP" "batching over TCP/IP"
33033 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33034 looks in the hints database for the transport to see if there are any queued
33035 messages waiting for the host to which it is connected. If it finds one, it
33036 creates a new Exim process using the &%-MC%& option (which can only be used by
33037 a process running as root or the Exim user) and passes the TCP/IP socket to it
33038 so that it can deliver another message using the same socket. The new process
33039 does only those deliveries that are routed to the connected host, and may in
33040 turn pass the socket on to a third process, and so on.
33041
33042 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33043 limit the number of messages sent down a single TCP/IP connection.
33044
33045 .cindex "asterisk" "after IP address"
33046 The second and subsequent messages delivered down an existing connection are
33047 identified in the main log by the addition of an asterisk after the closing
33048 square bracket of the IP address.
33049
33050
33051
33052
33053 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33054 .cindex "error" "in outgoing SMTP"
33055 .cindex "SMTP" "errors in outgoing"
33056 .cindex "host" "error"
33057 Three different kinds of error are recognized for outgoing SMTP: host errors,
33058 message errors, and recipient errors.
33059
33060 .vlist
33061 .vitem "&*Host errors*&"
33062 A host error is not associated with a particular message or with a
33063 particular recipient of a message. The host errors are:
33064
33065 .ilist
33066 Connection refused or timed out,
33067 .next
33068 Any error response code on connection,
33069 .next
33070 Any error response code to EHLO or HELO,
33071 .next
33072 Loss of connection at any time, except after &"."&,
33073 .next
33074 I/O errors at any time,
33075 .next
33076 Timeouts during the session, other than in response to MAIL, RCPT or
33077 the &"."& at the end of the data.
33078 .endlist ilist
33079
33080 For a host error, a permanent error response on connection, or in response to
33081 EHLO, causes all addresses routed to the host to be failed. Any other host
33082 error causes all addresses to be deferred, and retry data to be created for the
33083 host. It is not tried again, for any message, until its retry time arrives. If
33084 the current set of addresses are not all delivered in this run (to some
33085 alternative host), the message is added to the list of those waiting for this
33086 host, so if it is still undelivered when a subsequent successful delivery is
33087 made to the host, it will be sent down the same SMTP connection.
33088
33089 .vitem "&*Message errors*&"
33090 .cindex "message" "error"
33091 A message error is associated with a particular message when sent to a
33092 particular host, but not with a particular recipient of the message. The
33093 message errors are:
33094
33095 .ilist
33096 Any error response code to MAIL, DATA, or the &"."& that terminates
33097 the data,
33098 .next
33099 Timeout after MAIL,
33100 .next
33101 Timeout or loss of connection after the &"."& that terminates the data. A
33102 timeout after the DATA command itself is treated as a host error, as is loss of
33103 connection at any other time.
33104 .endlist ilist
33105
33106 For a message error, a permanent error response (5&'xx'&) causes all addresses
33107 to be failed, and a delivery error report to be returned to the sender. A
33108 temporary error response (4&'xx'&), or one of the timeouts, causes all
33109 addresses to be deferred. Retry data is not created for the host, but instead,
33110 a retry record for the combination of host plus message id is created. The
33111 message is not added to the list of those waiting for this host. This ensures
33112 that the failing message will not be sent to this host again until the retry
33113 time arrives. However, other messages that are routed to the host are not
33114 affected, so if it is some property of the message that is causing the error,
33115 it will not stop the delivery of other mail.
33116
33117 If the remote host specified support for the SIZE parameter in its response
33118 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33119 over-large message will cause a message error because the error arrives as a
33120 response to MAIL.
33121
33122 .vitem "&*Recipient errors*&"
33123 .cindex "recipient" "error"
33124 A recipient error is associated with a particular recipient of a message. The
33125 recipient errors are:
33126
33127 .ilist
33128 Any error response to RCPT,
33129 .next
33130 Timeout after RCPT.
33131 .endlist
33132
33133 For a recipient error, a permanent error response (5&'xx'&) causes the
33134 recipient address to be failed, and a bounce message to be returned to the
33135 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33136 address to be deferred, and routing retry data to be created for it. This is
33137 used to delay processing of the address in subsequent queue runs, until its
33138 routing retry time arrives. This applies to all messages, but because it
33139 operates only in queue runs, one attempt will be made to deliver a new message
33140 to the failing address before the delay starts to operate. This ensures that,
33141 if the failure is really related to the message rather than the recipient
33142 (&"message too big for this recipient"& is a possible example), other messages
33143 have a chance of getting delivered. If a delivery to the address does succeed,
33144 the retry information gets cleared, so all stuck messages get tried again, and
33145 the retry clock is reset.
33146
33147 The message is not added to the list of those waiting for this host. Use of the
33148 host for other messages is unaffected, and except in the case of a timeout,
33149 other recipients are processed independently, and may be successfully delivered
33150 in the current SMTP session. After a timeout it is of course impossible to
33151 proceed with the session, so all addresses get deferred. However, those other
33152 than the one that failed do not suffer any subsequent retry delays. Therefore,
33153 if one recipient is causing trouble, the others have a chance of getting
33154 through when a subsequent delivery attempt occurs before the failing
33155 recipient's retry time.
33156 .endlist
33157
33158 In all cases, if there are other hosts (or IP addresses) available for the
33159 current set of addresses (for example, from multiple MX records), they are
33160 tried in this run for any undelivered addresses, subject of course to their
33161 own retry data. In other words, recipient error retry data does not take effect
33162 until the next delivery attempt.
33163
33164 Some hosts have been observed to give temporary error responses to every
33165 MAIL command at certain times (&"insufficient space"& has been seen). It
33166 would be nice if such circumstances could be recognized, and defer data for the
33167 host itself created, but this is not possible within the current Exim design.
33168 What actually happens is that retry data for every (host, message) combination
33169 is created.
33170
33171 The reason that timeouts after MAIL and RCPT are treated specially is that
33172 these can sometimes arise as a result of the remote host's verification
33173 procedures. Exim makes this assumption, and treats them as if a temporary error
33174 response had been received. A timeout after &"."& is treated specially because
33175 it is known that some broken implementations fail to recognize the end of the
33176 message if the last character of the last line is a binary zero. Thus, it is
33177 helpful to treat this case as a message error.
33178
33179 Timeouts at other times are treated as host errors, assuming a problem with the
33180 host, or the connection to it. If a timeout after MAIL, RCPT,
33181 or &"."& is really a connection problem, the assumption is that at the next try
33182 the timeout is likely to occur at some other point in the dialogue, causing it
33183 then to be treated as a host error.
33184
33185 There is experimental evidence that some MTAs drop the connection after the
33186 terminating &"."& if they do not like the contents of the message for some
33187 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33188 should be given. That is why Exim treats this case as a message rather than a
33189 host error, in order not to delay other messages to the same host.
33190
33191
33192
33193
33194 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33195 .cindex "SMTP" "incoming over TCP/IP"
33196 .cindex "incoming SMTP over TCP/IP"
33197 .cindex "inetd"
33198 .cindex "daemon"
33199 Incoming SMTP messages can be accepted in one of two ways: by running a
33200 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33201 &_/etc/inetd.conf_& should be like this:
33202 .code
33203 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33204 .endd
33205 Exim distinguishes between this case and the case of a locally running user
33206 agent using the &%-bs%& option by checking whether or not the standard input is
33207 a socket. When it is, either the port must be privileged (less than 1024), or
33208 the caller must be root or the Exim user. If any other user passes a socket
33209 with an unprivileged port number, Exim prints a message on the standard error
33210 stream and exits with an error code.
33211
33212 By default, Exim does not make a log entry when a remote host connects or
33213 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33214 unexpected. It can be made to write such log entries by setting the
33215 &%smtp_connection%& log selector.
33216
33217 .cindex "carriage return"
33218 .cindex "linefeed"
33219 Commands from the remote host are supposed to be terminated by CR followed by
33220 LF. However, there are known to be hosts that do not send CR characters. In
33221 order to be able to interwork with such hosts, Exim treats LF on its own as a
33222 line terminator.
33223 Furthermore, because common code is used for receiving messages from all
33224 sources, a CR on its own is also interpreted as a line terminator. However, the
33225 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33226
33227 .cindex "EHLO" "invalid data"
33228 .cindex "HELO" "invalid data"
33229 One area that sometimes gives rise to problems concerns the EHLO or
33230 HELO commands. Some clients send syntactically invalid versions of these
33231 commands, which Exim rejects by default. (This is nothing to do with verifying
33232 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33233 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33234 match the broken hosts that send invalid commands.
33235
33236 .cindex "SIZE option on MAIL command"
33237 .cindex "MAIL" "SIZE option"
33238 The amount of disk space available is checked whenever SIZE is received on
33239 a MAIL command, independently of whether &%message_size_limit%& or
33240 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33241 false. A temporary error is given if there is not enough space. If
33242 &%check_spool_space%& is set, the check is for that amount of space plus the
33243 value given with SIZE, that is, it checks that the addition of the incoming
33244 message will not reduce the space below the threshold.
33245
33246 When a message is successfully received, Exim includes the local message id in
33247 its response to the final &"."& that terminates the data. If the remote host
33248 logs this text it can help with tracing what has happened to a message.
33249
33250 The Exim daemon can limit the number of simultaneous incoming connections it is
33251 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33252 number of simultaneous incoming connections from a single remote host (see the
33253 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33254 rejected using the SMTP temporary error code 421.
33255
33256 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33257 subprocess has finished, as this can get lost at busy times. Instead, it looks
33258 for completed subprocesses every time it wakes up. Provided there are other
33259 things happening (new incoming calls, starts of queue runs), completed
33260 processes will be noticed and tidied away. On very quiet systems you may
33261 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33262 it will be noticed when the daemon next wakes up.
33263
33264 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33265 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33266 high system load &-- for details see the &%smtp_accept_reserve%&,
33267 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33268 applies in both the daemon and &'inetd'& cases.
33269
33270 Exim normally starts a delivery process for each message received, though this
33271 can be varied by means of the &%-odq%& command line option and the
33272 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33273 number of simultaneously running delivery processes started in this way from
33274 SMTP input can be limited by the &%smtp_accept_queue%& and
33275 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33276 subsequently received messages are just put on the input queue without starting
33277 a delivery process.
33278
33279 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33280 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33281 started up from the &'inetd'& daemon, because in that case each connection is
33282 handled by an entirely independent Exim process. Control by load average is,
33283 however, available with &'inetd'&.
33284
33285 Exim can be configured to verify addresses in incoming SMTP commands as they
33286 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33287 to rewrite addresses at this time &-- before any syntax checking is done. See
33288 section &<<SECTrewriteS>>&.
33289
33290 Exim can also be configured to limit the rate at which a client host submits
33291 MAIL and RCPT commands in a single SMTP session. See the
33292 &%smtp_ratelimit_hosts%& option.
33293
33294
33295
33296 .section "Unrecognized SMTP commands" "SECID234"
33297 .cindex "SMTP" "unrecognized commands"
33298 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33299 commands during a single SMTP connection, it drops the connection after sending
33300 the error response to the last command. The default value for
33301 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33302 abuse that subvert web servers into making connections to SMTP ports; in these
33303 circumstances, a number of non-SMTP lines are sent first.
33304
33305
33306 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33307 .cindex "SMTP" "syntax errors"
33308 .cindex "SMTP" "protocol errors"
33309 A syntax error is detected if an SMTP command is recognized, but there is
33310 something syntactically wrong with its data, for example, a malformed email
33311 address in a RCPT command. Protocol errors include invalid command
33312 sequencing such as RCPT before MAIL. If Exim receives more than
33313 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33314 drops the connection after sending the error response to the last command. The
33315 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33316 broken clients that loop sending bad commands (yes, it has been seen).
33317
33318
33319
33320 .section "Use of non-mail SMTP commands" "SECID236"
33321 .cindex "SMTP" "non-mail commands"
33322 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33323 DATA. Exim counts such commands, and drops the connection if there are too
33324 many of them in a single SMTP session. This action catches some
33325 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33326 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33327 defines what &"too many"& means. Its default value is 10.
33328
33329 When a new message is expected, one occurrence of RSET is not counted. This
33330 allows a client to send one RSET between messages (this is not necessary,
33331 but some clients do it). Exim also allows one uncounted occurrence of HELO
33332 or EHLO, and one occurrence of STARTTLS between messages. After
33333 starting up a TLS session, another EHLO is expected, and so it too is not
33334 counted.
33335
33336 The first occurrence of AUTH in a connection, or immediately following
33337 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33338 RCPT, DATA, and QUIT are counted.
33339
33340 You can control which hosts are subject to the limit set by
33341 &%smtp_accept_max_nonmail%& by setting
33342 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33343 the limit apply to all hosts. This option means that you can exclude any
33344 specific badly-behaved hosts that you have to live with.
33345
33346
33347
33348
33349 .section "The VRFY and EXPN commands" "SECID237"
33350 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33351 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33352 appropriate) in order to decide whether the command should be accepted or not.
33353 If no ACL is defined, the command is rejected.
33354
33355 .cindex "VRFY" "processing"
33356 When VRFY is accepted, it runs exactly the same code as when Exim is
33357 called with the &%-bv%& option.
33358
33359 .cindex "EXPN" "processing"
33360 When EXPN is accepted, a single-level expansion of the address is done.
33361 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33362 than a verification (the &%-bv%& option). If an unqualified local part is given
33363 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33364 of VRFY and EXPN commands are logged on the main and reject logs, and
33365 VRFY verification failures are logged on the main log for consistency with
33366 RCPT failures.
33367
33368
33369
33370 .section "The ETRN command" "SECTETRN"
33371 .cindex "ETRN" "processing"
33372 RFC 1985 describes an SMTP command called ETRN that is designed to
33373 overcome the security problems of the TURN command (which has fallen into
33374 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33375 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33376 should be accepted or not. If no ACL is defined, the command is rejected.
33377
33378 The ETRN command is concerned with &"releasing"& messages that are awaiting
33379 delivery to certain hosts. As Exim does not organize its message queue by host,
33380 the only form of ETRN that is supported by default is the one where the
33381 text starts with the &"#"& prefix, in which case the remainder of the text is
33382 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33383 the &%-R%& option to happen, with the remainder of the ETRN text as its
33384 argument. For example,
33385 .code
33386 ETRN #brigadoon
33387 .endd
33388 runs the command
33389 .code
33390 exim -R brigadoon
33391 .endd
33392 which causes a delivery attempt on all messages with undelivered addresses
33393 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33394 default), Exim prevents the simultaneous execution of more than one queue run
33395 for the same argument string as a result of an ETRN command. This stops
33396 a misbehaving client from starting more than one queue runner at once.
33397
33398 .cindex "hints database" "ETRN serialization"
33399 Exim implements the serialization by means of a hints database in which a
33400 record is written whenever a process is started by ETRN, and deleted when
33401 the process completes. However, Exim does not keep the SMTP session waiting for
33402 the ETRN process to complete. Once ETRN is accepted, the client is sent
33403 a &"success"& return code. Obviously there is scope for hints records to get
33404 left lying around if there is a system or program crash. To guard against this,
33405 Exim ignores any records that are more than six hours old.
33406
33407 .oindex "&%smtp_etrn_command%&"
33408 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33409 used. This specifies a command that is run whenever ETRN is received,
33410 whatever the form of its argument. For
33411 example:
33412 .code
33413 smtp_etrn_command = /etc/etrn_command $domain \
33414                     $sender_host_address
33415 .endd
33416 .vindex "&$domain$&"
33417 The string is split up into arguments which are independently expanded. The
33418 expansion variable &$domain$& is set to the argument of the ETRN command,
33419 and no syntax checking is done on the contents of this argument. Exim does not
33420 wait for the command to complete, so its status code is not checked. Exim runs
33421 under its own uid and gid when receiving incoming SMTP, so it is not possible
33422 for it to change them before running the command.
33423
33424
33425
33426 .section "Incoming local SMTP" "SECID238"
33427 .cindex "SMTP" "local incoming"
33428 Some user agents use SMTP to pass messages to their local MTA using the
33429 standard input and output, as opposed to passing the envelope on the command
33430 line and writing the message to the standard input. This is supported by the
33431 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33432 messages over TCP/IP (including the use of ACLs), except that the envelope
33433 sender given in a MAIL command is ignored unless the caller is trusted. In
33434 an ACL you can detect this form of SMTP input by testing for an empty host
33435 identification. It is common to have this as the first line in the ACL that
33436 runs for RCPT commands:
33437 .code
33438 accept hosts = :
33439 .endd
33440 This accepts SMTP messages from local processes without doing any other tests.
33441
33442
33443
33444 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33445 .cindex "SMTP" "batched outgoing"
33446 .cindex "batched SMTP output"
33447 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33448 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33449 be output in BSMTP format. No SMTP responses are possible for this form of
33450 delivery. All it is doing is using SMTP commands as a way of transmitting the
33451 envelope along with the message.
33452
33453 The message is written to the file or pipe preceded by the SMTP commands
33454 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33455 the message that start with a dot have an extra dot added. The SMTP command
33456 HELO is not normally used. If it is required, the &%message_prefix%& option
33457 can be used to specify it.
33458
33459 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33460 one recipient address at a time by default. However, you can arrange for them
33461 to handle several addresses at once by setting the &%batch_max%& option. When
33462 this is done for BSMTP, messages may contain multiple RCPT commands. See
33463 chapter &<<CHAPbatching>>& for more details.
33464
33465 .vindex "&$host$&"
33466 When one or more addresses are routed to a BSMTP transport by a router that
33467 sets up a host list, the name of the first host on the list is available to the
33468 transport in the variable &$host$&. Here is an example of such a transport and
33469 router:
33470 .code
33471 begin routers
33472 route_append:
33473   driver = manualroute
33474   transport = smtp_appendfile
33475   route_list = domain.example  batch.host.example
33476
33477 begin transports
33478 smtp_appendfile:
33479   driver = appendfile
33480   directory = /var/bsmtp/$host
33481   batch_max = 1000
33482   use_bsmtp
33483   user = exim
33484 .endd
33485 This causes messages addressed to &'domain.example'& to be written in BSMTP
33486 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33487 message (unless there are more than 1000 recipients).
33488
33489
33490
33491 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33492 .cindex "SMTP" "batched incoming"
33493 .cindex "batched SMTP input"
33494 The &%-bS%& command line option causes Exim to accept one or more messages by
33495 reading SMTP on the standard input, but to generate no responses. If the caller
33496 is trusted, the senders in the MAIL commands are believed; otherwise the
33497 sender is always the caller of Exim. Unqualified senders and receivers are not
33498 rejected (there seems little point) but instead just get qualified. HELO
33499 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33500 as NOOP; QUIT quits.
33501
33502 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33503 ACL is run in the same way as for non-SMTP local input.
33504
33505 If an error is detected while reading a message, including a missing &"."& at
33506 the end, Exim gives up immediately. It writes details of the error to the
33507 standard output in a stylized way that the calling program should be able to
33508 make some use of automatically, for example:
33509 .code
33510 554 Unexpected end of file
33511 Transaction started in line 10
33512 Error detected in line 14
33513 .endd
33514 It writes a more verbose version, for human consumption, to the standard error
33515 file, for example:
33516 .code
33517 An error was detected while processing a file of BSMTP input.
33518 The error message was:
33519
33520 501 '>' missing at end of address
33521
33522 The SMTP transaction started in line 10.
33523 The error was detected in line 12.
33524 The SMTP command at fault was:
33525
33526 rcpt to:<malformed@in.com.plete
33527
33528 1 previous message was successfully processed.
33529 The rest of the batch was abandoned.
33530 .endd
33531 The return code from Exim is zero only if there were no errors. It is 1 if some
33532 messages were accepted before an error was detected, and 2 if no messages were
33533 accepted.
33534 .ecindex IIDsmtpproc1
33535 .ecindex IIDsmtpproc2
33536
33537
33538
33539 . ////////////////////////////////////////////////////////////////////////////
33540 . ////////////////////////////////////////////////////////////////////////////
33541
33542 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33543          "Customizing messages"
33544 When a message fails to be delivered, or remains on the queue for more than a
33545 configured amount of time, Exim sends a message to the original sender, or
33546 to an alternative configured address. The text of these messages is built into
33547 the code of Exim, but it is possible to change it, either by adding a single
33548 string, or by replacing each of the paragraphs by text supplied in a file.
33549
33550 The &'From:'& and &'To:'& header lines are automatically generated; you can
33551 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33552 option. Exim also adds the line
33553 .code
33554 Auto-Submitted: auto-generated
33555 .endd
33556 to all warning and bounce messages,
33557
33558
33559 .section "Customizing bounce messages" "SECID239"
33560 .cindex "customizing" "bounce message"
33561 .cindex "bounce message" "customizing"
33562 If &%bounce_message_text%& is set, its contents are included in the default
33563 message immediately after &"This message was created automatically by mail
33564 delivery software."& The string is not expanded. It is not used if
33565 &%bounce_message_file%& is set.
33566
33567 When &%bounce_message_file%& is set, it must point to a template file for
33568 constructing error messages. The file consists of a series of text items,
33569 separated by lines consisting of exactly four asterisks. If the file cannot be
33570 opened, default text is used and a message is written to the main and panic
33571 logs. If any text item in the file is empty, default text is used for that
33572 item.
33573
33574 .vindex "&$bounce_recipient$&"
33575 .vindex "&$bounce_return_size_limit$&"
33576 Each item of text that is read from the file is expanded, and there are two
33577 expansion variables which can be of use here: &$bounce_recipient$& is set to
33578 the recipient of an error message while it is being created, and
33579 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33580 option, rounded to a whole number.
33581
33582 The items must appear in the file in the following order:
33583
33584 .ilist
33585 The first item is included in the headers, and should include at least a
33586 &'Subject:'& header. Exim does not check the syntax of these headers.
33587 .next
33588 The second item forms the start of the error message. After it, Exim lists the
33589 failing addresses with their error messages.
33590 .next
33591 The third item is used to introduce any text from pipe transports that is to be
33592 returned to the sender. It is omitted if there is no such text.
33593 .next
33594 .new
33595 The fourth, fifth and sixth items will be ignored and may be empty.
33596 The fields exist for back-compatibility
33597 .wen
33598 .endlist
33599
33600 The default state (&%bounce_message_file%& unset) is equivalent to the
33601 following file, in which the sixth item is empty. The &'Subject:'& and some
33602 other lines have been split in order to fit them on the page:
33603 .code
33604 Subject: Mail delivery failed
33605   ${if eq{$sender_address}{$bounce_recipient}
33606   {: returning message to sender}}
33607 ****
33608 This message was created automatically by mail delivery software.
33609
33610 A message ${if eq{$sender_address}{$bounce_recipient}
33611   {that you sent }{sent by
33612
33613 <$sender_address>
33614
33615 }}could not be delivered to all of its recipients.
33616 This is a permanent error. The following address(es) failed:
33617 ****
33618 The following text was generated during the delivery attempt(s):
33619 ****
33620 ------ This is a copy of the message, including all the headers.
33621   ------
33622 ****
33623 ------ The body of the message is $message_size characters long;
33624   only the first
33625 ------ $bounce_return_size_limit or so are included here.
33626 ****
33627 .endd
33628 .section "Customizing warning messages" "SECTcustwarn"
33629 .cindex "customizing" "warning message"
33630 .cindex "warning of delay" "customizing the message"
33631 The option &%warn_message_file%& can be pointed at a template file for use when
33632 warnings about message delays are created. In this case there are only three
33633 text sections:
33634
33635 .ilist
33636 The first item is included in the headers, and should include at least a
33637 &'Subject:'& header. Exim does not check the syntax of these headers.
33638 .next
33639 The second item forms the start of the warning message. After it, Exim lists
33640 the delayed addresses.
33641 .next
33642 The third item then ends the message.
33643 .endlist
33644
33645 The default state is equivalent to the following file, except that some lines
33646 have been split here, in order to fit them on the page:
33647 .code
33648 Subject: Warning: message $message_exim_id delayed
33649   $warn_message_delay
33650 ****
33651 This message was created automatically by mail delivery software.
33652
33653 A message ${if eq{$sender_address}{$warn_message_recipients}
33654 {that you sent }{sent by
33655
33656 <$sender_address>
33657
33658 }}has not been delivered to all of its recipients after
33659 more than $warn_message_delay on the queue on $primary_hostname.
33660
33661 The message identifier is:     $message_exim_id
33662 The subject of the message is: $h_subject
33663 The date of the message is:    $h_date
33664
33665 The following address(es) have not yet been delivered:
33666 ****
33667 No action is required on your part. Delivery attempts will
33668 continue for some time, and this warning may be repeated at
33669 intervals if the message remains undelivered. Eventually the
33670 mail delivery software will give up, and when that happens,
33671 the message will be returned to you.
33672 .endd
33673 .vindex "&$warn_message_delay$&"
33674 .vindex "&$warn_message_recipients$&"
33675 However, in the default state the subject and date lines are omitted if no
33676 appropriate headers exist. During the expansion of this file,
33677 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33678 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33679 of recipients for the warning message. There may be more than one if there are
33680 multiple addresses with different &%errors_to%& settings on the routers that
33681 handled them.
33682
33683
33684
33685
33686 . ////////////////////////////////////////////////////////////////////////////
33687 . ////////////////////////////////////////////////////////////////////////////
33688
33689 .chapter "Some common configuration settings" "CHAPcomconreq"
33690 This chapter discusses some configuration settings that seem to be fairly
33691 common. More examples and discussion can be found in the Exim book.
33692
33693
33694
33695 .section "Sending mail to a smart host" "SECID240"
33696 .cindex "smart host" "example router"
33697 If you want to send all mail for non-local domains to a &"smart host"&, you
33698 should replace the default &(dnslookup)& router with a router which does the
33699 routing explicitly:
33700 .code
33701 send_to_smart_host:
33702   driver = manualroute
33703   route_list = !+local_domains smart.host.name
33704   transport = remote_smtp
33705 .endd
33706 You can use the smart host's IP address instead of the name if you wish.
33707 If you are using Exim only to submit messages to a smart host, and not for
33708 receiving incoming messages, you can arrange for it to do the submission
33709 synchronously by setting the &%mua_wrapper%& option (see chapter
33710 &<<CHAPnonqueueing>>&).
33711
33712
33713
33714
33715 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33716 .cindex "mailing lists"
33717 Exim can be used to run simple mailing lists, but for large and/or complicated
33718 requirements, the use of additional specialized mailing list software such as
33719 Majordomo or Mailman is recommended.
33720
33721 The &(redirect)& router can be used to handle mailing lists where each list
33722 is maintained in a separate file, which can therefore be managed by an
33723 independent manager. The &%domains%& router option can be used to run these
33724 lists in a separate domain from normal mail. For example:
33725 .code
33726 lists:
33727   driver = redirect
33728   domains = lists.example
33729   file = /usr/lists/$local_part
33730   forbid_pipe
33731   forbid_file
33732   errors_to = $local_part-request@lists.example
33733   no_more
33734 .endd
33735 This router is skipped for domains other than &'lists.example'&. For addresses
33736 in that domain, it looks for a file that matches the local part. If there is no
33737 such file, the router declines, but because &%no_more%& is set, no subsequent
33738 routers are tried, and so the whole delivery fails.
33739
33740 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33741 expanded into a file name or a pipe delivery, which is usually inappropriate in
33742 a mailing list.
33743
33744 .oindex "&%errors_to%&"
33745 The &%errors_to%& option specifies that any delivery errors caused by addresses
33746 taken from a mailing list are to be sent to the given address rather than the
33747 original sender of the message. However, before acting on this, Exim verifies
33748 the error address, and ignores it if verification fails.
33749
33750 For example, using the configuration above, mail sent to
33751 &'dicts@lists.example'& is passed on to those addresses contained in
33752 &_/usr/lists/dicts_&, with error reports directed to
33753 &'dicts-request@lists.example'&, provided that this address can be verified.
33754 There could be a file called &_/usr/lists/dicts-request_& containing
33755 the address(es) of this particular list's manager(s), but other approaches,
33756 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33757 or &%local_part_suffix%& options) to handle addresses of the form
33758 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33759
33760
33761
33762 .section "Syntax errors in mailing lists" "SECID241"
33763 .cindex "mailing lists" "syntax errors in"
33764 If an entry in redirection data contains a syntax error, Exim normally defers
33765 delivery of the original address. That means that a syntax error in a mailing
33766 list holds up all deliveries to the list. This may not be appropriate when a
33767 list is being maintained automatically from data supplied by users, and the
33768 addresses are not rigorously checked.
33769
33770 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33771 entries that fail to parse, noting the incident in the log. If in addition
33772 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33773 whenever a broken address is skipped. It is usually appropriate to set
33774 &%syntax_errors_to%& to the same address as &%errors_to%&.
33775
33776
33777
33778 .section "Re-expansion of mailing lists" "SECID242"
33779 .cindex "mailing lists" "re-expansion of"
33780 Exim remembers every individual address to which a message has been delivered,
33781 in order to avoid duplication, but it normally stores only the original
33782 recipient addresses with a message. If all the deliveries to a mailing list
33783 cannot be done at the first attempt, the mailing list is re-expanded when the
33784 delivery is next tried. This means that alterations to the list are taken into
33785 account at each delivery attempt, so addresses that have been added to
33786 the list since the message arrived will therefore receive a copy of the
33787 message, even though it pre-dates their subscription.
33788
33789 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33790 on the &(redirect)& router. If this is done, any addresses generated by the
33791 router that fail to deliver at the first attempt are added to the message as
33792 &"top level"& addresses, and the parent address that generated them is marked
33793 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33794 subsequent delivery attempts. The disadvantage of this is that if any of the
33795 failing addresses are incorrect, correcting them in the file has no effect on
33796 pre-existing messages.
33797
33798 The original top-level address is remembered with each of the generated
33799 addresses, and is output in any log messages. However, any intermediate parent
33800 addresses are not recorded. This makes a difference to the log only if the
33801 &%all_parents%& selector is set, but for mailing lists there is normally only
33802 one level of expansion anyway.
33803
33804
33805
33806 .section "Closed mailing lists" "SECID243"
33807 .cindex "mailing lists" "closed"
33808 The examples so far have assumed open mailing lists, to which anybody may
33809 send mail. It is also possible to set up closed lists, where mail is accepted
33810 from specified senders only. This is done by making use of the generic
33811 &%senders%& option to restrict the router that handles the list.
33812
33813 The following example uses the same file as a list of recipients and as a list
33814 of permitted senders. It requires three routers:
33815 .code
33816 lists_request:
33817   driver = redirect
33818   domains = lists.example
33819   local_part_suffix = -request
33820   file = /usr/lists/$local_part$local_part_suffix
33821   no_more
33822
33823 lists_post:
33824   driver = redirect
33825   domains = lists.example
33826   senders = ${if exists {/usr/lists/$local_part}\
33827              {lsearch;/usr/lists/$local_part}{*}}
33828   file = /usr/lists/$local_part
33829   forbid_pipe
33830   forbid_file
33831   errors_to = $local_part-request@lists.example
33832   no_more
33833
33834 lists_closed:
33835   driver = redirect
33836   domains = lists.example
33837   allow_fail
33838   data = :fail: $local_part@lists.example is a closed mailing list
33839 .endd
33840 All three routers have the same &%domains%& setting, so for any other domains,
33841 they are all skipped. The first router runs only if the local part ends in
33842 &%-request%&. It handles messages to the list manager(s) by means of an open
33843 mailing list.
33844
33845 The second router runs only if the &%senders%& precondition is satisfied. It
33846 checks for the existence of a list that corresponds to the local part, and then
33847 checks that the sender is on the list by means of a linear search. It is
33848 necessary to check for the existence of the file before trying to search it,
33849 because otherwise Exim thinks there is a configuration error. If the file does
33850 not exist, the expansion of &%senders%& is *, which matches all senders. This
33851 means that the router runs, but because there is no list, declines, and
33852 &%no_more%& ensures that no further routers are run. The address fails with an
33853 &"unrouteable address"& error.
33854
33855 The third router runs only if the second router is skipped, which happens when
33856 a mailing list exists, but the sender is not on it. This router forcibly fails
33857 the address, giving a suitable error message.
33858
33859
33860
33861
33862 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33863 .cindex "VERP"
33864 .cindex "Variable Envelope Return Paths"
33865 .cindex "envelope sender"
33866 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33867 are a way of helping mailing list administrators discover which subscription
33868 address is the cause of a particular delivery failure. The idea is to encode
33869 the original recipient address in the outgoing envelope sender address, so that
33870 if the message is forwarded by another host and then subsequently bounces, the
33871 original recipient can be extracted from the recipient address of the bounce.
33872
33873 .oindex &%errors_to%&
33874 .oindex &%return_path%&
33875 Envelope sender addresses can be modified by Exim using two different
33876 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33877 list examples), or the &%return_path%& option on a transport. The second of
33878 these is effective only if the message is successfully delivered to another
33879 host; it is not used for errors detected on the local host (see the description
33880 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33881 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33882 .code
33883 verp_smtp:
33884   driver = smtp
33885   max_rcpt = 1
33886   return_path = \
33887     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33888       {$1-request+$local_part=$domain@your.dom.example}fail}
33889 .endd
33890 This has the effect of rewriting the return path (envelope sender) on outgoing
33891 SMTP messages, if the local part of the original return path ends in
33892 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33893 local part and domain of the recipient into the return path. Suppose, for
33894 example, that a message whose return path has been set to
33895 &'somelist-request@your.dom.example'& is sent to
33896 &'subscriber@other.dom.example'&. In the transport, the return path is
33897 rewritten as
33898 .code
33899 somelist-request+subscriber=other.dom.example@your.dom.example
33900 .endd
33901 .vindex "&$local_part$&"
33902 For this to work, you must tell Exim to send multiple copies of messages that
33903 have more than one recipient, so that each copy has just one recipient. This is
33904 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33905 might be sent to several different recipients in the same domain, in which case
33906 &$local_part$& is not available in the transport, because it is not unique.
33907
33908 Unless your host is doing nothing but mailing list deliveries, you should
33909 probably use a separate transport for the VERP deliveries, so as not to use
33910 extra resources in making one-per-recipient copies for other deliveries. This
33911 can easily be done by expanding the &%transport%& option in the router:
33912 .code
33913 dnslookup:
33914   driver = dnslookup
33915   domains = ! +local_domains
33916   transport = \
33917     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33918       {verp_smtp}{remote_smtp}}
33919   no_more
33920 .endd
33921 If you want to change the return path using &%errors_to%& in a router instead
33922 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33923 routers that handle mailing list addresses. This will ensure that all delivery
33924 errors, including those detected on the local host, are sent to the VERP
33925 address.
33926
33927 On a host that does no local deliveries and has no manual routing, only the
33928 &(dnslookup)& router needs to be changed. A special transport is not needed for
33929 SMTP deliveries. Every mailing list recipient has its own return path value,
33930 and so Exim must hand them to the transport one at a time. Here is an example
33931 of a &(dnslookup)& router that implements VERP:
33932 .code
33933 verp_dnslookup:
33934   driver = dnslookup
33935   domains = ! +local_domains
33936   transport = remote_smtp
33937   errors_to = \
33938     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33939      {$1-request+$local_part=$domain@your.dom.example}fail}
33940   no_more
33941 .endd
33942 Before you start sending out messages with VERPed return paths, you must also
33943 configure Exim to accept the bounce messages that come back to those paths.
33944 Typically this is done by setting a &%local_part_suffix%& option for a
33945 router, and using this to route the messages to wherever you want to handle
33946 them.
33947
33948 The overhead incurred in using VERP depends very much on the size of the
33949 message, the number of recipient addresses that resolve to the same remote
33950 host, and the speed of the connection over which the message is being sent. If
33951 a lot of addresses resolve to the same host and the connection is slow, sending
33952 a separate copy of the message for each address may take substantially longer
33953 than sending a single copy with many recipients (for which VERP cannot be
33954 used).
33955
33956
33957
33958
33959
33960
33961 .section "Virtual domains" "SECTvirtualdomains"
33962 .cindex "virtual domains"
33963 .cindex "domain" "virtual"
33964 The phrase &'virtual domain'& is unfortunately used with two rather different
33965 meanings:
33966
33967 .ilist
33968 A domain for which there are no real mailboxes; all valid local parts are
33969 aliases for other email addresses. Common examples are organizational
33970 top-level domains and &"vanity"& domains.
33971 .next
33972 One of a number of independent domains that are all handled by the same host,
33973 with mailboxes on that host, but where the mailbox owners do not necessarily
33974 have login accounts on that host.
33975 .endlist
33976
33977 The first usage is probably more common, and does seem more &"virtual"& than
33978 the second. This kind of domain can be handled in Exim with a straightforward
33979 aliasing router. One approach is to create a separate alias file for each
33980 virtual domain. Exim can test for the existence of the alias file to determine
33981 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33982 to a router of this form:
33983 .code
33984 virtual:
33985   driver = redirect
33986   domains = dsearch;/etc/mail/virtual
33987   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33988   no_more
33989 .endd
33990 The &%domains%& option specifies that the router is to be skipped, unless there
33991 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33992 domain that is being processed. When the router runs, it looks up the local
33993 part in the file to find a new address (or list of addresses). The &%no_more%&
33994 setting ensures that if the lookup fails (leading to &%data%& being an empty
33995 string), Exim gives up on the address without trying any subsequent routers.
33996
33997 This one router can handle all the virtual domains because the alias file names
33998 follow a fixed pattern. Permissions can be arranged so that appropriate people
33999 can edit the different alias files. A successful aliasing operation results in
34000 a new envelope recipient address, which is then routed from scratch.
34001
34002 The other kind of &"virtual"& domain can also be handled in a straightforward
34003 way. One approach is to create a file for each domain containing a list of
34004 valid local parts, and use it in a router like this:
34005 .code
34006 my_domains:
34007   driver = accept
34008   domains = dsearch;/etc/mail/domains
34009   local_parts = lsearch;/etc/mail/domains/$domain
34010   transport = my_mailboxes
34011 .endd
34012 The address is accepted if there is a file for the domain, and the local part
34013 can be found in the file. The &%domains%& option is used to check for the
34014 file's existence because &%domains%& is tested before the &%local_parts%&
34015 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34016 because that option is tested after &%local_parts%&. The transport is as
34017 follows:
34018 .code
34019 my_mailboxes:
34020   driver = appendfile
34021   file = /var/mail/$domain/$local_part
34022   user = mail
34023 .endd
34024 This uses a directory of mailboxes for each domain. The &%user%& setting is
34025 required, to specify which uid is to be used for writing to the mailboxes.
34026
34027 The configuration shown here is just one example of how you might support this
34028 requirement. There are many other ways this kind of configuration can be set
34029 up, for example, by using a database instead of separate files to hold all the
34030 information about the domains.
34031
34032
34033
34034 .section "Multiple user mailboxes" "SECTmulbox"
34035 .cindex "multiple mailboxes"
34036 .cindex "mailbox" "multiple"
34037 .cindex "local part" "prefix"
34038 .cindex "local part" "suffix"
34039 Heavy email users often want to operate with multiple mailboxes, into which
34040 incoming mail is automatically sorted. A popular way of handling this is to
34041 allow users to use multiple sender addresses, so that replies can easily be
34042 identified. Users are permitted to add prefixes or suffixes to their local
34043 parts for this purpose. The wildcard facility of the generic router options
34044 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34045 example, consider this router:
34046 .code
34047 userforward:
34048   driver = redirect
34049   check_local_user
34050   file = $home/.forward
34051   local_part_suffix = -*
34052   local_part_suffix_optional
34053   allow_filter
34054 .endd
34055 .vindex "&$local_part_suffix$&"
34056 It runs a user's &_.forward_& file for all local parts of the form
34057 &'username-*'&. Within the filter file the user can distinguish different
34058 cases by testing the variable &$local_part_suffix$&. For example:
34059 .code
34060 if $local_part_suffix contains -special then
34061 save /home/$local_part/Mail/special
34062 endif
34063 .endd
34064 If the filter file does not exist, or does not deal with such addresses, they
34065 fall through to subsequent routers, and, assuming no subsequent use of the
34066 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34067 control over which suffixes are valid.
34068
34069 Alternatively, a suffix can be used to trigger the use of a different
34070 &_.forward_& file &-- which is the way a similar facility is implemented in
34071 another MTA:
34072 .code
34073 userforward:
34074   driver = redirect
34075   check_local_user
34076   file = $home/.forward$local_part_suffix
34077   local_part_suffix = -*
34078   local_part_suffix_optional
34079   allow_filter
34080 .endd
34081 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34082 example, &_.forward-special_& is used. Once again, if the appropriate file
34083 does not exist, or does not deal with the address, it is passed on to
34084 subsequent routers, which could, if required, look for an unqualified
34085 &_.forward_& file to use as a default.
34086
34087
34088
34089 .section "Simplified vacation processing" "SECID244"
34090 .cindex "vacation processing"
34091 The traditional way of running the &'vacation'& program is for a user to set up
34092 a pipe command in a &_.forward_& file
34093 (see section &<<SECTspecitredli>>& for syntax details).
34094 This is prone to error by inexperienced users. There are two features of Exim
34095 that can be used to make this process simpler for users:
34096
34097 .ilist
34098 A local part prefix such as &"vacation-"& can be specified on a router which
34099 can cause the message to be delivered directly to the &'vacation'& program, or
34100 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34101 &_.forward_& file are then much simpler. For example:
34102 .code
34103 spqr, vacation-spqr
34104 .endd
34105 .next
34106 The &%require_files%& generic router option can be used to trigger a
34107 vacation delivery by checking for the existence of a certain file in the
34108 user's home directory. The &%unseen%& generic option should also be used, to
34109 ensure that the original delivery also proceeds. In this case, all the user has
34110 to do is to create a file called, say, &_.vacation_&, containing a vacation
34111 message.
34112 .endlist
34113
34114 Another advantage of both these methods is that they both work even when the
34115 use of arbitrary pipes by users is locked out.
34116
34117
34118
34119 .section "Taking copies of mail" "SECID245"
34120 .cindex "message" "copying every"
34121 Some installations have policies that require archive copies of all messages to
34122 be made. A single copy of each message can easily be taken by an appropriate
34123 command in a system filter, which could, for example, use a different file for
34124 each day's messages.
34125
34126 There is also a shadow transport mechanism that can be used to take copies of
34127 messages that are successfully delivered by local transports, one copy per
34128 delivery. This could be used, &'inter alia'&, to implement automatic
34129 notification of delivery by sites that insist on doing such things.
34130
34131
34132
34133 .section "Intermittently connected hosts" "SECID246"
34134 .cindex "intermittently connected hosts"
34135 It has become quite common (because it is cheaper) for hosts to connect to the
34136 Internet periodically rather than remain connected all the time. The normal
34137 arrangement is that mail for such hosts accumulates on a system that is
34138 permanently connected.
34139
34140 Exim was designed for use on permanently connected hosts, and so it is not
34141 particularly well-suited to use in an intermittently connected environment.
34142 Nevertheless there are some features that can be used.
34143
34144
34145 .section "Exim on the upstream server host" "SECID247"
34146 It is tempting to arrange for incoming mail for the intermittently connected
34147 host to remain on Exim's queue until the client connects. However, this
34148 approach does not scale very well. Two different kinds of waiting message are
34149 being mixed up in the same queue &-- those that cannot be delivered because of
34150 some temporary problem, and those that are waiting for their destination host
34151 to connect. This makes it hard to manage the queue, as well as wasting
34152 resources, because each queue runner scans the entire queue.
34153
34154 A better approach is to separate off those messages that are waiting for an
34155 intermittently connected host. This can be done by delivering these messages
34156 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34157 format, from where they are transmitted by other software when their
34158 destination connects. This makes it easy to collect all the mail for one host
34159 in a single directory, and to apply local timeout rules on a per-message basis
34160 if required.
34161
34162 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34163 you are doing this, you should configure Exim with a long retry period for the
34164 intermittent host. For example:
34165 .code
34166 cheshire.wonderland.fict.example    *   F,5d,24h
34167 .endd
34168 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34169 which messages it has queued up for that host. Once the intermittent host comes
34170 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34171 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34172 causes all the queued up messages to be delivered, often down a single SMTP
34173 connection. While the host remains connected, any new messages get delivered
34174 immediately.
34175
34176 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34177 issued with a different IP address each time it connects, Exim's retry
34178 mechanisms on the holding host get confused, because the IP address is normally
34179 used as part of the key string for holding retry information. This can be
34180 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34181 Since this has disadvantages for permanently connected hosts, it is best to
34182 arrange a separate transport for the intermittently connected ones.
34183
34184
34185
34186 .section "Exim on the intermittently connected client host" "SECID248"
34187 The value of &%smtp_accept_queue_per_connection%& should probably be
34188 increased, or even set to zero (that is, disabled) on the intermittently
34189 connected host, so that all incoming messages down a single connection get
34190 delivered immediately.
34191
34192 .cindex "SMTP" "passed connection"
34193 .cindex "SMTP" "multiple deliveries"
34194 .cindex "multiple SMTP deliveries"
34195 Mail waiting to be sent from an intermittently connected host will probably
34196 not have been routed, because without a connection DNS lookups are not
34197 possible. This means that if a normal queue run is done at connection time,
34198 each message is likely to be sent in a separate SMTP session. This can be
34199 avoided by starting the queue run with a command line option beginning with
34200 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34201 first pass, routing is done but no deliveries take place. The second pass is a
34202 normal queue run; since all the messages have been previously routed, those
34203 destined for the same host are likely to get sent as multiple deliveries in a
34204 single SMTP connection.
34205
34206
34207
34208 . ////////////////////////////////////////////////////////////////////////////
34209 . ////////////////////////////////////////////////////////////////////////////
34210
34211 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34212          "Exim as a non-queueing client"
34213 .cindex "client, non-queueing"
34214 .cindex "smart host" "suppressing queueing"
34215 On a personal computer, it is a common requirement for all
34216 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34217 configured to operate that way, for all the popular operating systems.
34218 However, there are some MUAs for Unix-like systems that cannot be so
34219 configured: they submit messages using the command line interface of
34220 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34221 messages this way.
34222
34223 If the personal computer runs continuously, there is no problem, because it can
34224 run a conventional MTA that handles delivery to the smart host, and deal with
34225 any delays via its queueing mechanism. However, if the computer does not run
34226 continuously or runs different operating systems at different times, queueing
34227 email is not desirable.
34228
34229 There is therefore a requirement for something that can provide the
34230 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34231 any queueing or retrying facilities. Furthermore, the delivery to the smart
34232 host should be synchronous, so that if it fails, the sending MUA is immediately
34233 informed. In other words, we want something that extends an MUA that submits
34234 to a local MTA via the command line so that it behaves like one that submits
34235 to a remote smart host using TCP/SMTP.
34236
34237 There are a number of applications (for example, there is one called &'ssmtp'&)
34238 that do this job. However, people have found them to be lacking in various
34239 ways. For instance, you might want to allow aliasing and forwarding to be done
34240 before sending a message to the smart host.
34241
34242 Exim already had the necessary infrastructure for doing this job. Just a few
34243 tweaks were needed to make it behave as required, though it is somewhat of an
34244 overkill to use a fully-featured MTA for this purpose.
34245
34246 .oindex "&%mua_wrapper%&"
34247 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34248 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34249 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34250 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34251 compatible router and transport configuration. Typically there will be just one
34252 router and one transport, sending everything to a smart host.
34253
34254 When run in MUA wrapping mode, the behaviour of Exim changes in the
34255 following ways:
34256
34257 .ilist
34258 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34259 In other words, the only way to submit messages is via the command line.
34260 .next
34261 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34262 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34263 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34264 does not finish until the delivery attempt is complete. If the delivery is
34265 successful, a zero return code is given.
34266 .next
34267 Address redirection is permitted, but the final routing for all addresses must
34268 be to the same remote transport, and to the same list of hosts. Furthermore,
34269 the return address (envelope sender) must be the same for all recipients, as
34270 must any added or deleted header lines. In other words, it must be possible to
34271 deliver the message in a single SMTP transaction, however many recipients there
34272 are.
34273 .next
34274 If these conditions are not met, or if routing any address results in a
34275 failure or defer status, or if Exim is unable to deliver all the recipients
34276 successfully to one of the smart hosts, delivery of the entire message fails.
34277 .next
34278 Because no queueing is allowed, all failures are treated as permanent; there
34279 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34280 smart host. Furthermore, because only a single yes/no response can be given to
34281 the caller, it is not possible to deliver to some recipients and not others. If
34282 there is an error (temporary or permanent) for any recipient, all are failed.
34283 .next
34284 If more than one smart host is listed, Exim will try another host after a
34285 connection failure or a timeout, in the normal way. However, if this kind of
34286 failure happens for all the hosts, the delivery fails.
34287 .next
34288 When delivery fails, an error message is written to the standard error stream
34289 (as well as to Exim's log), and Exim exits to the caller with a return code
34290 value 1. The message is expunged from Exim's spool files. No bounce messages
34291 are ever generated.
34292 .next
34293 No retry data is maintained, and any retry rules are ignored.
34294 .next
34295 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34296 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34297 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34298 .endlist
34299
34300 The overall effect is that Exim makes a single synchronous attempt to deliver
34301 the message, failing if there is any kind of problem. Because no local
34302 deliveries are done and no daemon can be run, Exim does not need root
34303 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34304 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34305 the advantages and disadvantages of running without root privilege.
34306
34307
34308
34309
34310 . ////////////////////////////////////////////////////////////////////////////
34311 . ////////////////////////////////////////////////////////////////////////////
34312
34313 .chapter "Log files" "CHAPlog"
34314 .scindex IIDloggen "log" "general description"
34315 .cindex "log" "types of"
34316 Exim writes three different logs, referred to as the main log, the reject log,
34317 and the panic log:
34318
34319 .ilist
34320 .cindex "main log"
34321 The main log records the arrival of each message and each delivery in a single
34322 line in each case. The format is as compact as possible, in an attempt to keep
34323 down the size of log files. Two-character flag sequences make it easy to pick
34324 out these lines. A number of other events are recorded in the main log. Some of
34325 them are optional, in which case the &%log_selector%& option controls whether
34326 they are included or not. A Perl script called &'eximstats'&, which does simple
34327 analysis of main log files, is provided in the Exim distribution (see section
34328 &<<SECTmailstat>>&).
34329 .next
34330 .cindex "reject log"
34331 The reject log records information from messages that are rejected as a result
34332 of a configuration option (that is, for policy reasons).
34333 The first line of each rejection is a copy of the line that is also written to
34334 the main log. Then, if the message's header has been read at the time the log
34335 is written, its contents are written to this log. Only the original header
34336 lines are available; header lines added by ACLs are not logged. You can use the
34337 reject log to check that your policy controls are working correctly; on a busy
34338 host this may be easier than scanning the main log for rejection messages. You
34339 can suppress the writing of the reject log by setting &%write_rejectlog%&
34340 false.
34341 .next
34342 .cindex "panic log"
34343 .cindex "system log"
34344 When certain serious errors occur, Exim writes entries to its panic log. If the
34345 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34346 are usually written to the main log as well, but can get lost amid the mass of
34347 other entries. The panic log should be empty under normal circumstances. It is
34348 therefore a good idea to check it (or to have a &'cron'& script check it)
34349 regularly, in order to become aware of any problems. When Exim cannot open its
34350 panic log, it tries as a last resort to write to the system log (syslog). This
34351 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34352 message itself is written at priority LOG_CRIT.
34353 .endlist
34354
34355 Every log line starts with a timestamp, in the format shown in the following
34356 example. Note that many of the examples shown in this chapter are line-wrapped.
34357 In the log file, this would be all on one line:
34358 .code
34359 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34360   by QUIT
34361 .endd
34362 By default, the timestamps are in the local timezone. There are two
34363 ways of changing this:
34364
34365 .ilist
34366 You can set the &%timezone%& option to a different time zone; in particular, if
34367 you set
34368 .code
34369 timezone = UTC
34370 .endd
34371 the timestamps will be in UTC (aka GMT).
34372 .next
34373 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34374 example:
34375 .code
34376 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34377 .endd
34378 .endlist
34379
34380 .cindex "log" "process ids in"
34381 .cindex "pid (process id)" "in log lines"
34382 Exim does not include its process id in log lines by default, but you can
34383 request that it does so by specifying the &`pid`& log selector (see section
34384 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34385 brackets, immediately after the time and date.
34386
34387
34388
34389
34390 .section "Where the logs are written" "SECTwhelogwri"
34391 .cindex "log" "destination"
34392 .cindex "log" "to file"
34393 .cindex "log" "to syslog"
34394 .cindex "syslog"
34395 The logs may be written to local files, or to syslog, or both. However, it
34396 should be noted that many syslog implementations use UDP as a transport, and
34397 are therefore unreliable in the sense that messages are not guaranteed to
34398 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34399 It has also been reported that on large log files (tens of megabytes) you may
34400 need to tweak syslog to prevent it syncing the file with each write &-- on
34401 Linux this has been seen to make syslog take 90% plus of CPU time.
34402
34403 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34404 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34405 configuration. This latter string is expanded, so it can contain, for example,
34406 references to the host name:
34407 .code
34408 log_file_path = /var/log/$primary_hostname/exim_%slog
34409 .endd
34410 It is generally advisable, however, to set the string in &_Local/Makefile_&
34411 rather than at run time, because then the setting is available right from the
34412 start of Exim's execution. Otherwise, if there's something it wants to log
34413 before it has read the configuration file (for example, an error in the
34414 configuration file) it will not use the path you want, and may not be able to
34415 log at all.
34416
34417 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34418 list, currently limited to at most two items. This is one option where the
34419 facility for changing a list separator may not be used. The list must always be
34420 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34421 otherwise the item must either be an absolute path, containing &`%s`& at the
34422 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34423 implying the use of a default path.
34424
34425 When Exim encounters an empty item in the list, it searches the list defined by
34426 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34427 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34428 mean &"use the path specified at build time"&. It no such item exists, log
34429 files are written in the &_log_& subdirectory of the spool directory. This is
34430 equivalent to the setting:
34431 .code
34432 log_file_path = $spool_directory/log/%slog
34433 .endd
34434 If you do not specify anything at build time or run time, that is where the
34435 logs are written.
34436
34437 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34438 are in use &-- see section &<<SECTdatlogfil>>& below.
34439
34440 Here are some examples of possible settings:
34441 .display
34442 &`LOG_FILE_PATH=syslog                    `& syslog only
34443 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34444 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34445 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34446 .endd
34447 If there are more than two paths in the list, the first is used and a panic
34448 error is logged.
34449
34450
34451
34452 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34453 .cindex "log" "cycling local files"
34454 .cindex "cycling logs"
34455 .cindex "&'exicyclog'&"
34456 .cindex "log" "local files; writing to"
34457 Some operating systems provide centralized and standardized methods for cycling
34458 log files. For those that do not, a utility script called &'exicyclog'& is
34459 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34460 main and reject logs each time it is called. The maximum number of old logs to
34461 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34462
34463 An Exim delivery process opens the main log when it first needs to write to it,
34464 and it keeps the file open in case subsequent entries are required &-- for
34465 example, if a number of different deliveries are being done for the same
34466 message. However, remote SMTP deliveries can take a long time, and this means
34467 that the file may be kept open long after it is renamed if &'exicyclog'& or
34468 something similar is being used to rename log files on a regular basis. To
34469 ensure that a switch of log files is noticed as soon as possible, Exim calls
34470 &[stat()]& on the main log's name before reusing an open file, and if the file
34471 does not exist, or its inode has changed, the old file is closed and Exim
34472 tries to open the main log from scratch. Thus, an old log file may remain open
34473 for quite some time, but no Exim processes should write to it once it has been
34474 renamed.
34475
34476
34477
34478 .section "Datestamped log files" "SECTdatlogfil"
34479 .cindex "log" "datestamped files"
34480 Instead of cycling the main and reject log files by renaming them
34481 periodically, some sites like to use files whose names contain a datestamp,
34482 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34483 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34484 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34485 point where the datestamp is required. For example:
34486 .code
34487 log_file_path = /var/spool/exim/log/%slog-%D
34488 log_file_path = /var/log/exim-%s-%D.log
34489 log_file_path = /var/spool/exim/log/%D-%slog
34490 log_file_path = /var/log/exim/%s.%M
34491 .endd
34492 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34493 examples of names generated by the above examples:
34494 .code
34495 /var/spool/exim/log/mainlog-20021225
34496 /var/log/exim-reject-20021225.log
34497 /var/spool/exim/log/20021225-mainlog
34498 /var/log/exim/main.200212
34499 .endd
34500 When this form of log file is specified, Exim automatically switches to new
34501 files at midnight. It does not make any attempt to compress old logs; you
34502 will need to write your own script if you require this. You should not
34503 run &'exicyclog'& with this form of logging.
34504
34505 The location of the panic log is also determined by &%log_file_path%&, but it
34506 is not datestamped, because rotation of the panic log does not make sense.
34507 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34508 the string. In addition, if it immediately follows a slash, a following
34509 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34510 character is removed. Thus, the four examples above would give these panic
34511 log names:
34512 .code
34513 /var/spool/exim/log/paniclog
34514 /var/log/exim-panic.log
34515 /var/spool/exim/log/paniclog
34516 /var/log/exim/panic
34517 .endd
34518
34519
34520 .section "Logging to syslog" "SECID249"
34521 .cindex "log" "syslog; writing to"
34522 The use of syslog does not change what Exim logs or the format of its messages,
34523 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34524 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34525 that, the same strings are written to syslog as to log files. The syslog
34526 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34527 by default, but you can change these by setting the &%syslog_facility%& and
34528 &%syslog_processname%& options, respectively. If Exim was compiled with
34529 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34530 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34531 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34532 the time and host name to each line.
34533 The three log streams are mapped onto syslog priorities as follows:
34534
34535 .ilist
34536 &'mainlog'& is mapped to LOG_INFO
34537 .next
34538 &'rejectlog'& is mapped to LOG_NOTICE
34539 .next
34540 &'paniclog'& is mapped to LOG_ALERT
34541 .endlist
34542
34543 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34544 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34545 these are routed by syslog to the same place. You can suppress this duplication
34546 by setting &%syslog_duplication%& false.
34547
34548 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34549 entries contain multiple lines when headers are included. To cope with both
34550 these cases, entries written to syslog are split into separate &[syslog()]&
34551 calls at each internal newline, and also after a maximum of
34552 870 data characters. (This allows for a total syslog line length of 1024, when
34553 additions such as timestamps are added.) If you are running a syslog
34554 replacement that can handle lines longer than the 1024 characters allowed by
34555 RFC 3164, you should set
34556 .code
34557 SYSLOG_LONG_LINES=yes
34558 .endd
34559 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34560 lines, but it still splits at internal newlines in &'reject'& log entries.
34561
34562 To make it easy to re-assemble split lines later, each component of a split
34563 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34564 where <&'n'&> is the component number and <&'m'&> is the total number of
34565 components in the entry. The / delimiter is used when the line was split
34566 because it was too long; if it was split because of an internal newline, the \
34567 delimiter is used. For example, supposing the length limit to be 50 instead of
34568 870, the following would be the result of a typical rejection message to
34569 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34570 name, and pid as added by syslog:
34571 .code
34572 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34573 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34574 [3/5]  when scanning for sender: missing or malformed lo
34575 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34576 [5/5] mple>)
34577 .endd
34578 The same error might cause the following lines to be written to &"rejectlog"&
34579 (LOG_NOTICE):
34580 .code
34581 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34582 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34583 [3/18] er when scanning for sender: missing or malformed
34584 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34585 [5\18] .example>)
34586 [6\18] Recipients: ph10@some.domain.cam.example
34587 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34588 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34589 [9\18]        id 16RdAL-0006pc-00
34590 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34591 [11\18] 09:43 +0100
34592 [12\18] F From: <>
34593 [13\18]   Subject: this is a test header
34594 [18\18]   X-something: this is another header
34595 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34596 [16\18] le>
34597 [17\18] B Bcc:
34598 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34599 .endd
34600 Log lines that are neither too long nor contain newlines are written to syslog
34601 without modification.
34602
34603 If only syslog is being used, the Exim monitor is unable to provide a log tail
34604 display, unless syslog is routing &'mainlog'& to a file on the local host and
34605 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34606 where it is.
34607
34608
34609
34610 .section "Log line flags" "SECID250"
34611 One line is written to the main log for each message received, and for each
34612 successful, unsuccessful, and delayed delivery. These lines can readily be
34613 picked out by the distinctive two-character flags that immediately follow the
34614 timestamp. The flags are:
34615 .display
34616 &`<=`&     message arrival
34617 &`=>`&     normal message delivery
34618 &`->`&     additional address in same delivery
34619 &`>>`&     cutthrough message delivery
34620 &`*>`&     delivery suppressed by &%-N%&
34621 &`**`&     delivery failed; address bounced
34622 &`==`&     delivery deferred; temporary problem
34623 .endd
34624
34625
34626 .section "Logging message reception" "SECID251"
34627 .cindex "log" "reception line"
34628 The format of the single-line entry in the main log that is written for every
34629 message received is shown in the basic example below, which is split over
34630 several lines in order to fit it on the page:
34631 .code
34632 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34633   H=mailer.fict.example [192.168.123.123] U=exim
34634   P=smtp S=5678 id=<incoming message id>
34635 .endd
34636 The address immediately following &"<="& is the envelope sender address. A
34637 bounce message is shown with the sender address &"<>"&, and if it is locally
34638 generated, this is followed by an item of the form
34639 .code
34640 R=<message id>
34641 .endd
34642 which is a reference to the message that caused the bounce to be sent.
34643
34644 .cindex "HELO"
34645 .cindex "EHLO"
34646 For messages from other hosts, the H and U fields identify the remote host and
34647 record the RFC 1413 identity of the user that sent the message, if one was
34648 received. The number given in square brackets is the IP address of the sending
34649 host. If there is a single, unparenthesized  host name in the H field, as
34650 above, it has been verified to correspond to the IP address (see the
34651 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34652 by the remote host in the SMTP HELO or EHLO command, and has not been
34653 verified. If verification yields a different name to that given for HELO or
34654 EHLO, the verified name appears first, followed by the HELO or EHLO
34655 name in parentheses.
34656
34657 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34658 without brackets, in the HELO or EHLO command, leading to entries in
34659 the log containing text like these examples:
34660 .code
34661 H=(10.21.32.43) [192.168.8.34]
34662 H=([10.21.32.43]) [192.168.8.34]
34663 .endd
34664 This can be confusing. Only the final address in square brackets can be relied
34665 on.
34666
34667 For locally generated messages (that is, messages not received over TCP/IP),
34668 the H field is omitted, and the U field contains the login name of the caller
34669 of Exim.
34670
34671 .cindex "authentication" "logging"
34672 .cindex "AUTH" "logging"
34673 For all messages, the P field specifies the protocol used to receive the
34674 message. This is the value that is stored in &$received_protocol$&. In the case
34675 of incoming SMTP messages, the value indicates whether or not any SMTP
34676 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34677 session was encrypted, there is an additional X field that records the cipher
34678 suite that was used.
34679
34680 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34681 hosts that have authenticated themselves using the SMTP AUTH command. The first
34682 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34683 there is an additional item A= followed by the name of the authenticator that
34684 was used. If an authenticated identification was set up by the authenticator's
34685 &%server_set_id%& option, this is logged too, separated by a colon from the
34686 authenticator name.
34687
34688 .cindex "size" "of message"
34689 The id field records the existing message id, if present. The size of the
34690 received message is given by the S field. When the message is delivered,
34691 headers may be removed or added, so that the size of delivered copies of the
34692 message may not correspond with this value (and indeed may be different to each
34693 other).
34694
34695 The &%log_selector%& option can be used to request the logging of additional
34696 data when a message is received. See section &<<SECTlogselector>>& below.
34697
34698
34699
34700 .section "Logging deliveries" "SECID252"
34701 .cindex "log" "delivery line"
34702 The format of the single-line entry in the main log that is written for every
34703 delivery is shown in one of the examples below, for local and remote
34704 deliveries, respectively. Each example has been split into two lines in order
34705 to fit it on the page:
34706 .code
34707 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34708   <marv@hitch.fict.example> R=localuser T=local_delivery
34709 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34710   monk@holistic.fict.example R=dnslookup T=remote_smtp
34711   H=holistic.fict.example [192.168.234.234]
34712 .endd
34713 For ordinary local deliveries, the original address is given in angle brackets
34714 after the final delivery address, which might be a pipe or a file. If
34715 intermediate address(es) exist between the original and the final address, the
34716 last of these is given in parentheses after the final address. The R and T
34717 fields record the router and transport that were used to process the address.
34718
34719 If SMTP AUTH was used for the delivery there is an additional item A=
34720 followed by the name of the authenticator that was used.
34721 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34722 option, this is logged too, separated by a colon from the authenticator name.
34723
34724 If a shadow transport was run after a successful local delivery, the log line
34725 for the successful delivery has an item added on the end, of the form
34726 .display
34727 &`ST=<`&&'shadow transport name'&&`>`&
34728 .endd
34729 If the shadow transport did not succeed, the error message is put in
34730 parentheses afterwards.
34731
34732 .cindex "asterisk" "after IP address"
34733 When more than one address is included in a single delivery (for example, two
34734 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34735 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34736 down a single SMTP connection, an asterisk follows the IP address in the log
34737 lines for the second and subsequent messages.
34738
34739 .cindex "delivery" "cutthrough; logging"
34740 .cindex "cutthrough" "logging"
34741 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34742 line precedes the reception line, since cutthrough waits for a possible
34743 rejection from the destination in case it can reject the sourced item.
34744
34745 The generation of a reply message by a filter file gets logged as a
34746 &"delivery"& to the addressee, preceded by &">"&.
34747
34748 The &%log_selector%& option can be used to request the logging of additional
34749 data when a message is delivered. See section &<<SECTlogselector>>& below.
34750
34751
34752 .section "Discarded deliveries" "SECID253"
34753 .cindex "discarded messages"
34754 .cindex "message" "discarded"
34755 .cindex "delivery" "discarded; logging"
34756 When a message is discarded as a result of the command &"seen finish"& being
34757 obeyed in a filter file which generates no deliveries, a log entry of the form
34758 .code
34759 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34760   <low.club@bridge.example> R=userforward
34761 .endd
34762 is written, to record why no deliveries are logged. When a message is discarded
34763 because it is aliased to &":blackhole:"& the log line is like this:
34764 .code
34765 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34766   <hole@nowhere.example> R=blackhole_router
34767 .endd
34768
34769
34770 .section "Deferred deliveries" "SECID254"
34771 When a delivery is deferred, a line of the following form is logged:
34772 .code
34773 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34774   R=dnslookup T=smtp defer (146): Connection refused
34775 .endd
34776 In the case of remote deliveries, the error is the one that was given for the
34777 last IP address that was tried. Details of individual SMTP failures are also
34778 written to the log, so the above line would be preceded by something like
34779 .code
34780 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34781   mail1.endrest.example [192.168.239.239]: Connection refused
34782 .endd
34783 When a deferred address is skipped because its retry time has not been reached,
34784 a message is written to the log, but this can be suppressed by setting an
34785 appropriate value in &%log_selector%&.
34786
34787
34788
34789 .section "Delivery failures" "SECID255"
34790 .cindex "delivery" "failure; logging"
34791 If a delivery fails because an address cannot be routed, a line of the
34792 following form is logged:
34793 .code
34794 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34795   <jim@trek99.example>: unknown mail domain
34796 .endd
34797 If a delivery fails at transport time, the router and transport are shown, and
34798 the response from the remote host is included, as in this example:
34799 .code
34800 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34801   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34802   after pipelined RCPT TO:<ace400@pb.example>: host
34803   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34804   <ace400@pb.example>...Addressee unknown
34805 .endd
34806 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34807 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34808 disabling PIPELINING. The log lines for all forms of delivery failure are
34809 flagged with &`**`&.
34810
34811
34812
34813 .section "Fake deliveries" "SECID256"
34814 .cindex "delivery" "fake; logging"
34815 If a delivery does not actually take place because the &%-N%& option has been
34816 used to suppress it, a normal delivery line is written to the log, except that
34817 &"=>"& is replaced by &"*>"&.
34818
34819
34820
34821 .section "Completion" "SECID257"
34822 A line of the form
34823 .code
34824 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34825 .endd
34826 is written to the main log when a message is about to be removed from the spool
34827 at the end of its processing.
34828
34829
34830
34831
34832 .section "Summary of Fields in Log Lines" "SECID258"
34833 .cindex "log" "summary of fields"
34834 A summary of the field identifiers that are used in log lines is shown in
34835 the following table:
34836 .display
34837 &`A   `&        authenticator name (and optional id and sender)
34838 &`C   `&        SMTP confirmation on delivery
34839 &`    `&        command list for &"no mail in SMTP session"&
34840 &`CV  `&        certificate verification status
34841 &`D   `&        duration of &"no mail in SMTP session"&
34842 &`DN  `&        distinguished name from peer certificate
34843 &`DT  `&        on &`=>`& lines: time taken for a delivery
34844 &`F   `&        sender address (on delivery lines)
34845 &`H   `&        host name and IP address
34846 &`I   `&        local interface used
34847 &`id  `&        message id for incoming message
34848 &`P   `&        on &`<=`& lines: protocol used
34849 &`    `&        on &`=>`& and &`**`& lines: return path
34850 &`QT  `&        on &`=>`& lines: time spent on queue so far
34851 &`    `&        on &"Completed"& lines: time spent on queue
34852 &`R   `&        on &`<=`& lines: reference for local bounce
34853 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34854 &`S   `&        size of message
34855 &`SNI `&        server name indication from TLS client hello
34856 &`ST  `&        shadow transport name
34857 &`T   `&        on &`<=`& lines: message subject (topic)
34858 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34859 &`U   `&        local user or RFC 1413 identity
34860 &`X   `&        TLS cipher suite
34861 .endd
34862
34863
34864 .section "Other log entries" "SECID259"
34865 Various other types of log entry are written from time to time. Most should be
34866 self-explanatory. Among the more common are:
34867
34868 .ilist
34869 .cindex "retry" "time not reached"
34870 &'retry time not reached'&&~&~An address previously suffered a temporary error
34871 during routing or local delivery, and the time to retry has not yet arrived.
34872 This message is not written to an individual message log file unless it happens
34873 during the first delivery attempt.
34874 .next
34875 &'retry time not reached for any host'&&~&~An address previously suffered
34876 temporary errors during remote delivery, and the retry time has not yet arrived
34877 for any of the hosts to which it is routed.
34878 .next
34879 .cindex "spool directory" "file locked"
34880 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34881 some other Exim process is already working on the message. This can be quite
34882 common if queue running processes are started at frequent intervals. The
34883 &'exiwhat'& utility script can be used to find out what Exim processes are
34884 doing.
34885 .next
34886 .cindex "error" "ignored"
34887 &'error ignored'&&~&~There are several circumstances that give rise to this
34888 message:
34889 .olist
34890 Exim failed to deliver a bounce message whose age was greater than
34891 &%ignore_bounce_errors_after%&. The bounce was discarded.
34892 .next
34893 A filter file set up a delivery using the &"noerror"& option, and the delivery
34894 failed. The delivery was discarded.
34895 .next
34896 A delivery set up by a router configured with
34897 . ==== As this is a nested list, any displays it contains must be indented
34898 . ==== as otherwise they are too far to the left.
34899 .code
34900     errors_to = <>
34901 .endd
34902 failed. The delivery was discarded.
34903 .endlist olist
34904 .endlist ilist
34905
34906
34907
34908
34909
34910 .section "Reducing or increasing what is logged" "SECTlogselector"
34911 .cindex "log" "selectors"
34912 By setting the &%log_selector%& global option, you can disable some of Exim's
34913 default logging, or you can request additional logging. The value of
34914 &%log_selector%& is made up of names preceded by plus or minus characters. For
34915 example:
34916 .code
34917 log_selector = +arguments -retry_defer
34918 .endd
34919 The list of optional log items is in the following table, with the default
34920 selection marked by asterisks:
34921 .display
34922 &` 8bitmime                   `&  received 8BITMIME status
34923 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34924 &` address_rewrite            `&  address rewriting
34925 &` all_parents                `&  all parents in => lines
34926 &` arguments                  `&  command line arguments
34927 &`*connection_reject          `&  connection rejections
34928 &`*delay_delivery             `&  immediate delivery delayed
34929 &` deliver_time               `&  time taken to perform delivery
34930 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34931 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34932 &`*etrn                       `&  ETRN commands
34933 &`*host_lookup_failed         `&  as it says
34934 &` ident_timeout              `&  timeout for ident connection
34935 &` incoming_interface         `&  incoming interface on <= lines
34936 &` incoming_port              `&  incoming port on <= lines
34937 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34938 &` outgoing_port              `&  add remote port to => lines
34939 &`*queue_run                  `&  start and end queue runs
34940 &` queue_time                 `&  time on queue for one recipient
34941 &` queue_time_overall         `&  time on queue for whole message
34942 &` pid                        `&  Exim process id
34943 &` received_recipients        `&  recipients on <= lines
34944 &` received_sender            `&  sender on <= lines
34945 &`*rejected_header            `&  header contents on reject log
34946 &`*retry_defer                `&  &"retry time not reached"&
34947 &` return_path_on_delivery    `&  put return path on => and ** lines
34948 &` sender_on_delivery         `&  add sender to => lines
34949 &`*sender_verify_fail         `&  sender verification failures
34950 &`*size_reject                `&  rejection because too big
34951 &`*skip_delivery              `&  delivery skipped in a queue run
34952 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34953 &` smtp_connection            `&  SMTP connections
34954 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34955 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34956 &` smtp_no_mail               `&  session with no MAIL commands
34957 &` smtp_protocol_error        `&  SMTP protocol errors
34958 &` smtp_syntax_error          `&  SMTP syntax errors
34959 &` subject                    `&  contents of &'Subject:'& on <= lines
34960 .new
34961 &`*tls_certificate_verified   `&  certificate verification status
34962 .wen
34963 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34964 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34965 &` tls_sni                    `&  TLS SNI on <= lines
34966 &` unknown_in_list            `&  DNS lookup failed in list match
34967
34968 &` all                        `&  all of the above
34969 .endd
34970 More details on each of these items follows:
34971
34972 .ilist
34973 .cindex "8BITMIME"
34974 .cindex "log" "8BITMIME"
34975 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34976 which may help in tracking down interoperability issues with ancient MTAs
34977 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34978 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34979 &`7BIT`& and &`8BITMIME`& respectively.
34980 .next
34981 .cindex "&%warn%& ACL verb" "log when skipping"
34982 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34983 its conditions cannot be evaluated, a log line to this effect is written if
34984 this log selector is set.
34985 .next
34986 .cindex "log" "rewriting"
34987 .cindex "rewriting" "logging"
34988 &%address_rewrite%&: This applies both to global rewrites and per-transport
34989 rewrites, but not to rewrites in filters run as an unprivileged user (because
34990 such users cannot access the log).
34991 .next
34992 .cindex "log" "full parentage"
34993 &%all_parents%&: Normally only the original and final addresses are logged on
34994 delivery lines; with this selector, intermediate parents are given in
34995 parentheses between them.
34996 .next
34997 .cindex "log" "Exim arguments"
34998 .cindex "Exim arguments, logging"
34999 &%arguments%&: This causes Exim to write the arguments with which it was called
35000 to the main log, preceded by the current working directory. This is a debugging
35001 feature, added to make it easier to find out how certain MUAs call
35002 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35003 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35004 that are empty or that contain white space are quoted. Non-printing characters
35005 are shown as escape sequences. This facility cannot log unrecognized arguments,
35006 because the arguments are checked before the configuration file is read. The
35007 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35008 between the caller and Exim.
35009 .next
35010 .cindex "log" "connection rejections"
35011 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35012 connection is rejected, for whatever reason.
35013 .next
35014 .cindex "log" "delayed delivery"
35015 .cindex "delayed delivery, logging"
35016 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35017 started for an incoming message because the load is too high or too many
35018 messages were received on one connection. Logging does not occur if no delivery
35019 process is started because &%queue_only%& is set or &%-odq%& was used.
35020 .next
35021 .cindex "log" "delivery duration"
35022 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35023 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35024 .next
35025 .cindex "log" "message size on delivery"
35026 .cindex "size" "of message"
35027 &%delivery_size%&: For each delivery, the size of message delivered is added to
35028 the &"=>"& line, tagged with S=.
35029 .next
35030 .cindex "log" "dnslist defer"
35031 .cindex "DNS list" "logging defer"
35032 .cindex "black list (DNS)"
35033 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35034 DNS black list suffers a temporary error.
35035 .next
35036 .cindex "log" "ETRN commands"
35037 .cindex "ETRN" "logging"
35038 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35039 is run to determine whether or not it is actually accepted. An invalid ETRN
35040 command, or one received within a message transaction is not logged by this
35041 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35042 .next
35043 .cindex "log" "host lookup failure"
35044 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35045 any addresses, or when a lookup of an IP address fails to find a host name, a
35046 log line is written. This logging does not apply to direct DNS lookups when
35047 routing email addresses, but it does apply to &"byname"& lookups.
35048 .next
35049 .cindex "log" "ident timeout"
35050 .cindex "RFC 1413" "logging timeout"
35051 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35052 client's ident port times out.
35053 .next
35054 .cindex "log" "incoming interface"
35055 .cindex "interface" "logging"
35056 &%incoming_interface%&: The interface on which a message was received is added
35057 to the &"<="& line as an IP address in square brackets, tagged by I= and
35058 followed by a colon and the port number. The local interface and port are also
35059 added to other SMTP log lines, for example &"SMTP connection from"&, and to
35060 rejection lines.
35061 .next
35062 .cindex "log" "incoming remote port"
35063 .cindex "port" "logging remote"
35064 .cindex "TCP/IP" "logging incoming remote port"
35065 .vindex "&$sender_fullhost$&"
35066 .vindex "&$sender_rcvhost$&"
35067 &%incoming_port%&: The remote port number from which a message was received is
35068 added to log entries and &'Received:'& header lines, following the IP address
35069 in square brackets, and separated from it by a colon. This is implemented by
35070 changing the value that is put in the &$sender_fullhost$& and
35071 &$sender_rcvhost$& variables. Recording the remote port number has become more
35072 important with the widening use of NAT (see RFC 2505).
35073 .next
35074 .cindex "log" "dropped connection"
35075 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35076 connection is unexpectedly dropped.
35077 .next
35078 .cindex "log" "outgoing remote port"
35079 .cindex "port" "logging outgoint remote"
35080 .cindex "TCP/IP" "logging ougtoing remote port"
35081 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35082 containing => tags) following the IP address. This option is not included in
35083 the default setting, because for most ordinary configurations, the remote port
35084 number is always 25 (the SMTP port).
35085 .next
35086 .cindex "log" "process ids in"
35087 .cindex "pid (process id)" "in log lines"
35088 &%pid%&: The current process id is added to every log line, in square brackets,
35089 immediately after the time and date.
35090 .next
35091 .cindex "log" "queue run"
35092 .cindex "queue runner" "logging"
35093 &%queue_run%&: The start and end of every queue run are logged.
35094 .next
35095 .cindex "log" "queue time"
35096 &%queue_time%&: The amount of time the message has been in the queue on the
35097 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35098 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35099 includes reception time as well as the delivery time for the current address.
35100 This means that it may be longer than the difference between the arrival and
35101 delivery log line times, because the arrival log line is not written until the
35102 message has been successfully received.
35103 .next
35104 &%queue_time_overall%&: The amount of time the message has been in the queue on
35105 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35106 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35107 message, so it includes reception time as well as the total delivery time.
35108 .next
35109 .cindex "log" "recipients"
35110 &%received_recipients%&: The recipients of a message are listed in the main log
35111 as soon as the message is received. The list appears at the end of the log line
35112 that is written when a message is received, preceded by the word &"for"&. The
35113 addresses are listed after they have been qualified, but before any rewriting
35114 has taken place.
35115 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35116 in the list.
35117 .next
35118 .cindex "log" "sender reception"
35119 &%received_sender%&: The unrewritten original sender of a message is added to
35120 the end of the log line that records the message's arrival, after the word
35121 &"from"& (before the recipients if &%received_recipients%& is also set).
35122 .next
35123 .cindex "log" "header lines for rejection"
35124 &%rejected_header%&: If a message's header has been received at the time a
35125 rejection is written to the reject log, the complete header is added to the
35126 log. Header logging can be turned off individually for messages that are
35127 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35128 .next
35129 .cindex "log" "retry defer"
35130 &%retry_defer%&: A log line is written if a delivery is deferred because a
35131 retry time has not yet been reached. However, this &"retry time not reached"&
35132 message is always omitted from individual message logs after the first delivery
35133 attempt.
35134 .next
35135 .cindex "log" "return path"
35136 &%return_path_on_delivery%&: The return path that is being transmitted with
35137 the message is included in delivery and bounce lines, using the tag P=.
35138 This is omitted if no delivery actually happens, for example, if routing fails,
35139 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35140 .next
35141 .cindex "log" "sender on delivery"
35142 &%sender_on_delivery%&: The message's sender address is added to every delivery
35143 and bounce line, tagged by F= (for &"from"&).
35144 This is the original sender that was received with the message; it is not
35145 necessarily the same as the outgoing return path.
35146 .next
35147 .cindex "log" "sender verify failure"
35148 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35149 gives details of a sender verification failure is not written. Log lines for
35150 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35151 detail is lost.
35152 .next
35153 .cindex "log" "size rejection"
35154 &%size_reject%&: A log line is written whenever a message is rejected because
35155 it is too big.
35156 .next
35157 .cindex "log" "frozen messages; skipped"
35158 .cindex "frozen messages" "logging skipping"
35159 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35160 queue run because it is frozen or because another process is already delivering
35161 it.
35162 .cindex "&""spool file is locked""&"
35163 The message that is written is &"spool file is locked"&.
35164 .next
35165 .cindex "log" "smtp confirmation"
35166 .cindex "SMTP" "logging confirmation"
35167 .cindex "LMTP" "logging confirmation"
35168 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35169 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35170 A number of MTAs (including Exim) return an identifying string in this
35171 response.
35172 .next
35173 .cindex "log" "SMTP connections"
35174 .cindex "SMTP" "logging connections"
35175 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35176 established or closed, unless the connection is from a host that matches
35177 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35178 only when the closure is unexpected.) This applies to connections from local
35179 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35180 dropped in the middle of a message, a log line is always written, whether or
35181 not this selector is set, but otherwise nothing is written at the start and end
35182 of connections unless this selector is enabled.
35183
35184 For TCP/IP connections to an Exim daemon, the current number of connections is
35185 included in the log message for each new connection, but note that the count is
35186 reset if the daemon is restarted.
35187 Also, because connections are closed (and the closure is logged) in
35188 subprocesses, the count may not include connections that have been closed but
35189 whose termination the daemon has not yet noticed. Thus, while it is possible to
35190 match up the opening and closing of connections in the log, the value of the
35191 logged counts may not be entirely accurate.
35192 .next
35193 .cindex "log" "SMTP transaction; incomplete"
35194 .cindex "SMTP" "logging incomplete transactions"
35195 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35196 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35197 and the message sender plus any accepted recipients are included in the log
35198 line. This can provide evidence of dictionary attacks.
35199 .next
35200 .cindex "log" "non-MAIL SMTP sessions"
35201 .cindex "MAIL" "logging session without"
35202 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35203 connection terminates without having issued a MAIL command. This includes both
35204 the case when the connection is dropped, and the case when QUIT is used. It
35205 does not include cases where the connection is rejected right at the start (by
35206 an ACL, or because there are too many connections, or whatever). These cases
35207 already have their own log lines.
35208
35209 The log line that is written contains the identity of the client in the usual
35210 way, followed by D= and a time, which records the duration of the connection.
35211 If the connection was authenticated, this fact is logged exactly as it is for
35212 an incoming message, with an A= item. If the connection was encrypted, CV=,
35213 DN=, and X= items may appear as they do for an incoming message, controlled by
35214 the same logging options.
35215
35216 Finally, if any SMTP commands were issued during the connection, a C= item
35217 is added to the line, listing the commands that were used. For example,
35218 .code
35219 C=EHLO,QUIT
35220 .endd
35221 shows that the client issued QUIT straight after EHLO. If there were fewer
35222 than 20 commands, they are all listed. If there were more than 20 commands,
35223 the last 20 are listed, preceded by &"..."&. However, with the default
35224 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35225 have been aborted before 20 non-mail commands are processed.
35226 .next
35227 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35228 colon-separated, is appended to the A= item for a message arrival or delivery
35229 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35230 was accepted or used.
35231 .next
35232 .cindex "log" "SMTP protocol error"
35233 .cindex "SMTP" "logging protocol error"
35234 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35235 encountered. Exim does not have perfect detection of all protocol errors
35236 because of transmission delays and the use of pipelining. If PIPELINING has
35237 been advertised to a client, an Exim server assumes that the client will use
35238 it, and therefore it does not count &"expected"& errors (for example, RCPT
35239 received after rejecting MAIL) as protocol errors.
35240 .next
35241 .cindex "SMTP" "logging syntax errors"
35242 .cindex "SMTP" "syntax errors; logging"
35243 .cindex "SMTP" "unknown command; logging"
35244 .cindex "log" "unknown SMTP command"
35245 .cindex "log" "SMTP syntax error"
35246 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35247 encountered. An unrecognized command is treated as a syntax error. For an
35248 external connection, the host identity is given; for an internal connection
35249 using &%-bs%& the sender identification (normally the calling user) is given.
35250 .next
35251 .cindex "log" "subject"
35252 .cindex "subject, logging"
35253 &%subject%&: The subject of the message is added to the arrival log line,
35254 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35255 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35256 specifies whether characters with values greater than 127 should be logged
35257 unchanged, or whether they should be rendered as escape sequences.
35258 .next
35259 .cindex "log" "certificate verification"
35260 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35261 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35262 verified, and &`CV=no`& if not.
35263 .next
35264 .cindex "log" "TLS cipher"
35265 .cindex "TLS" "logging cipher"
35266 &%tls_cipher%&: When a message is sent or received over an encrypted
35267 connection, the cipher suite used is added to the log line, preceded by X=.
35268 .next
35269 .cindex "log" "TLS peer DN"
35270 .cindex "TLS" "logging peer DN"
35271 &%tls_peerdn%&: When a message is sent or received over an encrypted
35272 connection, and a certificate is supplied by the remote host, the peer DN is
35273 added to the log line, preceded by DN=.
35274 .next
35275 .cindex "log" "TLS SNI"
35276 .cindex "TLS" "logging SNI"
35277 &%tls_sni%&: When a message is received over an encrypted connection, and
35278 the remote host provided the Server Name Indication extension, the SNI is
35279 added to the log line, preceded by SNI=.
35280 .next
35281 .cindex "log" "DNS failure in list"
35282 &%unknown_in_list%&: This setting causes a log entry to be written when the
35283 result of a list match is failure because a DNS lookup failed.
35284 .endlist
35285
35286
35287 .section "Message log" "SECID260"
35288 .cindex "message" "log file for"
35289 .cindex "log" "message log; description of"
35290 .cindex "&_msglog_& directory"
35291 .oindex "&%preserve_message_logs%&"
35292 In addition to the general log files, Exim writes a log file for each message
35293 that it handles. The names of these per-message logs are the message ids, and
35294 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35295 message log contains copies of the log lines that apply to the message. This
35296 makes it easier to inspect the status of an individual message without having
35297 to search the main log. A message log is deleted when processing of the message
35298 is complete, unless &%preserve_message_logs%& is set, but this should be used
35299 only with great care because they can fill up your disk very quickly.
35300
35301 On a heavily loaded system, it may be desirable to disable the use of
35302 per-message logs, in order to reduce disk I/O. This can be done by setting the
35303 &%message_logs%& option false.
35304 .ecindex IIDloggen
35305
35306
35307
35308
35309 . ////////////////////////////////////////////////////////////////////////////
35310 . ////////////////////////////////////////////////////////////////////////////
35311
35312 .chapter "Exim utilities" "CHAPutils"
35313 .scindex IIDutils "utilities"
35314 A number of utility scripts and programs are supplied with Exim and are
35315 described in this chapter. There is also the Exim Monitor, which is covered in
35316 the next chapter. The utilities described here are:
35317
35318 .itable none 0 0 3  7* left  15* left  40* left
35319 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35320   "list what Exim processes are doing"
35321 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35322 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35323 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35324 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35325                                                 various criteria"
35326 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35327 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35328   "extract statistics from the log"
35329 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35330   "check address acceptance from given IP"
35331 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35332 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35333 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35334 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35335 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35336 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35337 .endtable
35338
35339 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35340 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35341 &url(http://duncanthrax.net/exilog/) for details.
35342
35343
35344
35345
35346 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35347 .cindex "&'exiwhat'&"
35348 .cindex "process, querying"
35349 .cindex "SIGUSR1"
35350 On operating systems that can restart a system call after receiving a signal
35351 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35352 a line describing what it is doing to the file &_exim-process.info_& in the
35353 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35354 processes it can find, having first emptied the file. It then waits for one
35355 second to allow the Exim processes to react before displaying the results. In
35356 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35357 send the signal to the Exim processes, so it is normally run as root.
35358
35359 &*Warning*&: This is not an efficient process. It is intended for occasional
35360 use by system administrators. It is not sensible, for example, to set up a
35361 script that sends SIGUSR1 signals to Exim processes at short intervals.
35362
35363
35364 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35365 varies in different operating systems. Not only are different options used,
35366 but the format of the output is different. For this reason, there are some
35367 system configuration options that configure exactly how &'exiwhat'& works. If
35368 it doesn't seem to be working for you, check the following compile-time
35369 options:
35370 .display
35371 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35372 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35373 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35374 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35375 .endd
35376 An example of typical output from &'exiwhat'& is
35377 .code
35378 164 daemon: -q1h, listening on port 25
35379 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35380 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35381   [10.19.42.42] (editor@ref.example)
35382 10592 handling incoming call from [192.168.243.242]
35383 10628 accepting a local non-SMTP message
35384 .endd
35385 The first number in the output line is the process number. The third line has
35386 been split here, in order to fit it on the page.
35387
35388
35389
35390 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35391 .cindex "&'exiqgrep'&"
35392 .cindex "queue" "grepping"
35393 This utility is a Perl script contributed by Matt Hubbard. It runs
35394 .code
35395 exim -bpu
35396 .endd
35397 or (in case &*-a*& switch is specified)
35398 .code
35399 exim -bp
35400 .endd
35401 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35402 contain alternate exim configuration the queue management might be using.
35403
35404 to obtain a queue listing, and then greps the output to select messages 
35405 that match given criteria. The following selection options are available:
35406
35407 .vlist
35408 .vitem &*-f*&&~<&'regex'&>
35409 Match the sender address using a case-insensitive search. The field that is
35410 tested is enclosed in angle brackets, so you can test for bounce messages with
35411 .code
35412 exiqgrep -f '^<>$'
35413 .endd
35414 .vitem &*-r*&&~<&'regex'&>
35415 Match a recipient address using a case-insensitve search. The field that is
35416 tested is not enclosed in angle brackets.
35417
35418 .vitem &*-s*&&~<&'regex'&>
35419 Match against the size field.
35420
35421 .vitem &*-y*&&~<&'seconds'&>
35422 Match messages that are younger than the given time.
35423
35424 .vitem &*-o*&&~<&'seconds'&>
35425 Match messages that are older than the given time.
35426
35427 .vitem &*-z*&
35428 Match only frozen messages.
35429
35430 .vitem &*-x*&
35431 Match only non-frozen messages.
35432 .endlist
35433
35434 The following options control the format of the output:
35435
35436 .vlist
35437 .vitem &*-c*&
35438 Display only the count of matching messages.
35439
35440 .vitem &*-l*&
35441 Long format &-- display the full message information as output by Exim. This is
35442 the default.
35443
35444 .vitem &*-i*&
35445 Display message ids only.
35446
35447 .vitem &*-b*&
35448 Brief format &-- one line per message.
35449
35450 .vitem &*-R*&
35451 Display messages in reverse order.
35452
35453 .vitem &*-a*&
35454 Include delivered recipients in queue listing.
35455 .endlist
35456
35457 There is one more option, &%-h%&, which outputs a list of options.
35458
35459
35460
35461 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35462 .cindex "&'exiqsumm'&"
35463 .cindex "queue" "summary"
35464 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35465 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35466 running a command such as
35467 .code
35468 exim -bp | exiqsumm
35469 .endd
35470 The output consists of one line for each domain that has messages waiting for
35471 it, as in the following example:
35472 .code
35473 3   2322   74m   66m  msn.com.example
35474 .endd
35475 Each line lists the number of pending deliveries for a domain, their total
35476 volume, and the length of time that the oldest and the newest messages have
35477 been waiting. Note that the number of pending deliveries is greater than the
35478 number of messages when messages have more than one recipient.
35479
35480 A summary line is output at the end. By default the output is sorted on the
35481 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35482 the output to be sorted by oldest message and by count of messages,
35483 respectively. There are also three options that split the messages for each
35484 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35485 separates frozen messages, and &%-s%& separates messages according to their
35486 sender.
35487
35488 The output of &'exim -bp'& contains the original addresses in the message, so
35489 this also applies to the output from &'exiqsumm'&. No domains from addresses
35490 generated by aliasing or forwarding are included (unless the &%one_time%&
35491 option of the &(redirect)& router has been used to convert them into &"top
35492 level"& addresses).
35493
35494
35495
35496
35497 .section "Extracting specific information from the log (exigrep)" &&&
35498          "SECTextspeinf"
35499 .cindex "&'exigrep'&"
35500 .cindex "log" "extracts; grepping for"
35501 The &'exigrep'& utility is a Perl script that searches one or more main log
35502 files for entries that match a given pattern. When it finds a match, it
35503 extracts all the log entries for the relevant message, not just those that
35504 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35505 given message, or all mail for a given user, or for a given host, for example.
35506 The input files can be in Exim log format or syslog format.
35507 If a matching log line is not associated with a specific message, it is
35508 included in &'exigrep'&'s output without any additional lines. The usage is:
35509 .display
35510 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35511 .endd
35512 If no log file names are given on the command line, the standard input is read.
35513
35514 The &%-t%& argument specifies a number of seconds. It adds an additional
35515 condition for message selection. Messages that are complete are shown only if
35516 they spent more than <&'n'&> seconds on the queue.
35517
35518 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35519 makes it case-sensitive. This may give a performance improvement when searching
35520 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35521 option; with &%-I%& they do not. In both cases it is possible to change the
35522 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35523
35524 The &%-l%& option means &"literal"&, that is, treat all characters in the
35525 pattern as standing for themselves. Otherwise the pattern must be a Perl
35526 regular expression.
35527
35528 The &%-v%& option inverts the matching condition. That is, a line is selected
35529 if it does &'not'& match the pattern.
35530
35531 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35532 that are generated as a result/response to a message that &'exigrep'& matched
35533 normally.
35534
35535 Example of &%-M%&:
35536 user_a sends a message to user_b, which generates a bounce back to user_b. If
35537 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35538 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35539 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35540 when searching for &"user_a"& will show both messages since the bounce is
35541 &"related"& to or a &"result"& of the first message that was found by the
35542 search term.
35543
35544 If the location of a &'zcat'& command is known from the definition of
35545 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35546 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35547
35548
35549 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35550 .cindex "&'exipick'&"
35551 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35552 lists messages from the queue according to a variety of criteria. For details
35553 of &'exipick'&'s facilities, visit the web page at
35554 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35555 the &%--help%& option.
35556
35557
35558 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35559 .cindex "log" "cycling local files"
35560 .cindex "cycling logs"
35561 .cindex "&'exicyclog'&"
35562 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35563 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35564 you are using log files with datestamps in their names (see section
35565 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35566 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35567 There are two command line options for &'exicyclog'&:
35568 .ilist
35569 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35570 default that is set when Exim is built. The default default is 10.
35571 .next
35572 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35573 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35574 overriding the script's default, which is to find the setting from Exim's
35575 configuration.
35576 .endlist
35577
35578 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35579 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35580 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35581 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35582 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35583 logs are handled similarly.
35584
35585 If the limit is greater than 99, the script uses 3-digit numbers such as
35586 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35587 to one that is greater, or &'vice versa'&, you will have to fix the names of
35588 any existing log files.
35589
35590 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35591 the end are deleted. All files with numbers greater than 01 are compressed,
35592 using a compression command which is configured by the COMPRESS_COMMAND
35593 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35594 root &%crontab%& entry of the form
35595 .code
35596 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35597 .endd
35598 assuming you have used the name &"exim"& for the Exim user. You can run
35599 &'exicyclog'& as root if you wish, but there is no need.
35600
35601
35602
35603 .section "Mail statistics (eximstats)" "SECTmailstat"
35604 .cindex "statistics"
35605 .cindex "&'eximstats'&"
35606 A Perl script called &'eximstats'& is provided for extracting statistical
35607 information from log files. The output is either plain text, or HTML.
35608 Exim log files are also supported by the &'Lire'& system produced by the
35609 LogReport Foundation &url(http://www.logreport.org).
35610
35611 The &'eximstats'& script has been hacked about quite a bit over time. The
35612 latest version is the result of some extensive revision by Steve Campbell. A
35613 lot of information is given by default, but there are options for suppressing
35614 various parts of it. Following any options, the arguments to the script are a
35615 list of files, which should be main log files. For example:
35616 .code
35617 eximstats -nr /var/spool/exim/log/mainlog.01
35618 .endd
35619 By default, &'eximstats'& extracts information about the number and volume of
35620 messages received from or delivered to various hosts. The information is sorted
35621 both by message count and by volume, and the top fifty hosts in each category
35622 are listed on the standard output. Similar information, based on email
35623 addresses or domains instead of hosts can be requested by means of various
35624 options. For messages delivered and received locally, similar statistics are
35625 also produced per user.
35626
35627 The output also includes total counts and statistics about delivery errors, and
35628 histograms showing the number of messages received and deliveries made in each
35629 hour of the day. A delivery with more than one address in its envelope (for
35630 example, an SMTP transaction with more than one RCPT command) is counted
35631 as a single delivery by &'eximstats'&.
35632
35633 Though normally more deliveries than receipts are reported (as messages may
35634 have multiple recipients), it is possible for &'eximstats'& to report more
35635 messages received than delivered, even though the queue is empty at the start
35636 and end of the period in question. If an incoming message contains no valid
35637 recipients, no deliveries are recorded for it. A bounce message is handled as
35638 an entirely separate message.
35639
35640 &'eximstats'& always outputs a grand total summary giving the volume and number
35641 of messages received and deliveries made, and the number of hosts involved in
35642 each case. It also outputs the number of messages that were delayed (that is,
35643 not completely delivered at the first attempt), and the number that had at
35644 least one address that failed.
35645
35646 The remainder of the output is in sections that can be independently disabled
35647 or modified by various options. It consists of a summary of deliveries by
35648 transport, histograms of messages received and delivered per time interval
35649 (default per hour), information about the time messages spent on the queue,
35650 a list of relayed messages, lists of the top fifty sending hosts, local
35651 senders, destination hosts, and destination local users by count and by volume,
35652 and a list of delivery errors that occurred.
35653
35654 The relay information lists messages that were actually relayed, that is, they
35655 came from a remote host and were directly delivered to some other remote host,
35656 without being processed (for example, for aliasing or forwarding) locally.
35657
35658 There are quite a few options for &'eximstats'& to control exactly what it
35659 outputs. These are documented in the Perl script itself, and can be extracted
35660 by running the command &(perldoc)& on the script. For example:
35661 .code
35662 perldoc /usr/exim/bin/eximstats
35663 .endd
35664
35665 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35666 .cindex "&'exim_checkaccess'&"
35667 .cindex "policy control" "checking access"
35668 .cindex "checking access"
35669 The &%-bh%& command line argument allows you to run a fake SMTP session with
35670 debugging output, in order to check what Exim is doing when it is applying
35671 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35672 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35673 sometimes you just want to answer the question &"Does this address have
35674 access?"& without bothering with any further details.
35675
35676 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35677 two arguments, an IP address and an email address:
35678 .code
35679 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35680 .endd
35681 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35682 given email address would be accepted in a RCPT command in a TCP/IP
35683 connection from the host with the given IP address. The output of the utility
35684 is either the word &"accepted"&, or the SMTP error response, for example:
35685 .code
35686 Rejected:
35687 550 Relay not permitted
35688 .endd
35689 When running this test, the utility uses &`<>`& as the envelope sender address
35690 for the MAIL command, but you can change this by providing additional
35691 options. These are passed directly to the Exim command. For example, to specify
35692 that the test is to be run with the sender address &'himself@there.example'&
35693 you can use:
35694 .code
35695 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35696                  -f himself@there.example
35697 .endd
35698 Note that these additional Exim command line items must be given after the two
35699 mandatory arguments.
35700
35701 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35702 while running its checks. You can run checks that include callouts by using
35703 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35704
35705
35706
35707 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35708 .cindex "DBM" "building dbm files"
35709 .cindex "building DBM files"
35710 .cindex "&'exim_dbmbuild'&"
35711 .cindex "lower casing"
35712 .cindex "binary zero" "in lookup key"
35713 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35714 the format used by the &(lsearch)& lookup (see section
35715 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35716 names as keys and the remainder of the information as data. The lower-casing
35717 can be prevented by calling the program with the &%-nolc%& option.
35718
35719 A terminating zero is included as part of the key string. This is expected by
35720 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35721 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35722 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35723 files.
35724
35725 The program requires two arguments: the name of the input file (which can be a
35726 single hyphen to indicate the standard input), and the name of the output file.
35727 It creates the output under a temporary name, and then renames it if all went
35728 well.
35729
35730 .cindex "USE_DB"
35731 If the native DB interface is in use (USE_DB is set in a compile-time
35732 configuration file &-- this is common in free versions of Unix) the two file
35733 names must be different, because in this mode the Berkeley DB functions create
35734 a single output file using exactly the name given. For example,
35735 .code
35736 exim_dbmbuild /etc/aliases /etc/aliases.db
35737 .endd
35738 reads the system alias file and creates a DBM version of it in
35739 &_/etc/aliases.db_&.
35740
35741 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35742 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35743 environment, the suffixes are added to the second argument of
35744 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35745 when the Berkeley functions are used in compatibility mode (though this is not
35746 recommended), because in that case it adds a &_.db_& suffix to the file name.
35747
35748 If a duplicate key is encountered, the program outputs a warning, and when it
35749 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35750 option is used. By default, only the first of a set of duplicates is used &--
35751 this makes it compatible with &(lsearch)& lookups. There is an option
35752 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35753 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35754 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35755 return code is 2.
35756
35757
35758
35759
35760 .section "Finding individual retry times (exinext)" "SECTfinindret"
35761 .cindex "retry" "times"
35762 .cindex "&'exinext'&"
35763 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35764 fish specific information out of the retry database. Given a mail domain (or a
35765 complete address), it looks up the hosts for that domain, and outputs any retry
35766 information for the hosts or for the domain. At present, the retry information
35767 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35768 output. For example:
35769 .code
35770 $ exinext piglet@milne.fict.example
35771 kanga.milne.example:192.168.8.1 error 146: Connection refused
35772   first failed: 21-Feb-1996 14:57:34
35773   last tried:   21-Feb-1996 14:57:34
35774   next try at:  21-Feb-1996 15:02:34
35775 roo.milne.example:192.168.8.3 error 146: Connection refused
35776   first failed: 20-Jan-1996 13:12:08
35777   last tried:   21-Feb-1996 11:42:03
35778   next try at:  21-Feb-1996 19:42:03
35779   past final cutoff time
35780 .endd
35781 You can also give &'exinext'& a local part, without a domain, and it
35782 will give any retry information for that local part in your default domain.
35783 A message id can be used to obtain retry information pertaining to a specific
35784 message. This exists only when an attempt to deliver a message to a remote host
35785 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35786 &'exinext'& is not particularly efficient, but then it is not expected to be
35787 run very often.
35788
35789 The &'exinext'& utility calls Exim to find out information such as the location
35790 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35791 passed on to the &'exim'& commands. The first specifies an alternate Exim
35792 configuration file, and the second sets macros for use within the configuration
35793 file. These features are mainly to help in testing, but might also be useful in
35794 environments where more than one configuration file is in use.
35795
35796
35797
35798 .section "Hints database maintenance" "SECThindatmai"
35799 .cindex "hints database" "maintenance"
35800 .cindex "maintaining Exim's hints database"
35801 Three utility programs are provided for maintaining the DBM files that Exim
35802 uses to contain its delivery hint information. Each program requires two
35803 arguments. The first specifies the name of Exim's spool directory, and the
35804 second is the name of the database it is to operate on. These are as follows:
35805
35806 .ilist
35807 &'retry'&: the database of retry information
35808 .next
35809 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35810 for remote hosts
35811 .next
35812 &'callout'&: the callout cache
35813 .next
35814 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35815 .next
35816 &'misc'&: other hints data
35817 .endlist
35818
35819 The &'misc'& database is used for
35820
35821 .ilist
35822 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35823 .next
35824 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35825 &(smtp)& transport)
35826 .endlist
35827
35828
35829
35830 .section "exim_dumpdb" "SECID261"
35831 .cindex "&'exim_dumpdb'&"
35832 The entire contents of a database are written to the standard output by the
35833 &'exim_dumpdb'& program, which has no options or arguments other than the
35834 spool and database names. For example, to dump the retry database:
35835 .code
35836 exim_dumpdb /var/spool/exim retry
35837 .endd
35838 Two lines of output are produced for each entry:
35839 .code
35840 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35841 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35842 .endd
35843 The first item on the first line is the key of the record. It starts with one
35844 of the letters R, or T, depending on whether it refers to a routing or
35845 transport retry. For a local delivery, the next part is the local address; for
35846 a remote delivery it is the name of the remote host, followed by its failing IP
35847 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35848 transport). If the remote port is not the standard one (port 25), it is added
35849 to the IP address. Then there follows an error code, an additional error code,
35850 and a textual description of the error.
35851
35852 The three times on the second line are the time of first failure, the time of
35853 the last delivery attempt, and the computed time for the next attempt. The line
35854 ends with an asterisk if the cutoff time for the last retry rule has been
35855 exceeded.
35856
35857 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35858 consists of a host name followed by a list of ids for messages that are or were
35859 waiting to be delivered to that host. If there are a very large number for any
35860 one host, continuation records, with a sequence number added to the host name,
35861 may be seen. The data in these records is often out of date, because a message
35862 may be routed to several alternative hosts, and Exim makes no effort to keep
35863 cross-references.
35864
35865
35866
35867 .section "exim_tidydb" "SECID262"
35868 .cindex "&'exim_tidydb'&"
35869 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35870 database. If run with no options, it removes all records that are more than 30
35871 days old. The age is calculated from the date and time that the record was last
35872 updated. Note that, in the case of the retry database, it is &'not'& the time
35873 since the first delivery failure. Information about a host that has been down
35874 for more than 30 days will remain in the database, provided that the record is
35875 updated sufficiently often.
35876
35877 The cutoff date can be altered by means of the &%-t%& option, which must be
35878 followed by a time. For example, to remove all records older than a week from
35879 the retry database:
35880 .code
35881 exim_tidydb -t 7d /var/spool/exim retry
35882 .endd
35883 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35884 message ids. In the former these appear as data in records keyed by host &--
35885 they were messages that were waiting for that host &-- and in the latter they
35886 are the keys for retry information for messages that have suffered certain
35887 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35888 message ids in database records are those of messages that are still on the
35889 queue. Message ids for messages that no longer exist are removed from
35890 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35891 For the &'retry'& database, records whose keys are non-existent message ids are
35892 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35893 whenever it removes information from the database.
35894
35895 Certain records are automatically removed by Exim when they are no longer
35896 needed, but others are not. For example, if all the MX hosts for a domain are
35897 down, a retry record is created for each one. If the primary MX host comes back
35898 first, its record is removed when Exim successfully delivers to it, but the
35899 records for the others remain because Exim has not tried to use those hosts.
35900
35901 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35902 hints databases. You should do this at a quiet time of day, because it requires
35903 a database to be locked (and therefore inaccessible to Exim) while it does its
35904 work. Removing records from a DBM file does not normally make the file smaller,
35905 but all the common DBM libraries are able to re-use the space that is released.
35906 After an initial phase of increasing in size, the databases normally reach a
35907 point at which they no longer get any bigger, as long as they are regularly
35908 tidied.
35909
35910 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35911 databases is likely to keep on increasing.
35912
35913
35914
35915
35916 .section "exim_fixdb" "SECID263"
35917 .cindex "&'exim_fixdb'&"
35918 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35919 Its main use is for testing Exim, but it might also be occasionally useful for
35920 getting round problems in a live system. It has no options, and its interface
35921 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35922 key of a database record can then be entered, and the data for that record is
35923 displayed.
35924
35925 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35926 except the &'retry'& database, that is the only operation that can be carried
35927 out. For the &'retry'& database, each field is output preceded by a number, and
35928 data for individual fields can be changed by typing the field number followed
35929 by new data, for example:
35930 .code
35931 > 4 951102:1000
35932 .endd
35933 resets the time of the next delivery attempt. Time values are given as a
35934 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35935 used as optional separators.
35936
35937
35938
35939
35940 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35941 .cindex "mailbox" "maintenance"
35942 .cindex "&'exim_lock'&"
35943 .cindex "locking mailboxes"
35944 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35945 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35946 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35947 a user agent while investigating a problem. The utility requires the name of
35948 the file as its first argument. If the locking is successful, the second
35949 argument is run as a command (using C's &[system()]& function); if there is no
35950 second argument, the value of the SHELL environment variable is used; if this
35951 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35952 is unlocked and the utility ends. The following options are available:
35953
35954 .vlist
35955 .vitem &%-fcntl%&
35956 Use &[fcntl()]& locking on the open mailbox.
35957
35958 .vitem &%-flock%&
35959 Use &[flock()]& locking on the open mailbox, provided the operating system
35960 supports it.
35961
35962 .vitem &%-interval%&
35963 This must be followed by a number, which is a number of seconds; it sets the
35964 interval to sleep between retries (default 3).
35965
35966 .vitem &%-lockfile%&
35967 Create a lock file before opening the mailbox.
35968
35969 .vitem &%-mbx%&
35970 Lock the mailbox using MBX rules.
35971
35972 .vitem &%-q%&
35973 Suppress verification output.
35974
35975 .vitem &%-retries%&
35976 This must be followed by a number; it sets the number of times to try to get
35977 the lock (default 10).
35978
35979 .vitem &%-restore_time%&
35980 This option causes &%exim_lock%& to restore the modified and read times to the
35981 locked file before exiting. This allows you to access a locked mailbox (for
35982 example, to take a backup copy) without disturbing the times that the user
35983 subsequently sees.
35984
35985 .vitem &%-timeout%&
35986 This must be followed by a number, which is a number of seconds; it sets a
35987 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35988 default), a non-blocking call is used.
35989
35990 .vitem &%-v%&
35991 Generate verbose output.
35992 .endlist
35993
35994 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35995 default is to create a lock file and also to use &[fcntl()]& locking on the
35996 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35997 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35998 requires that the directory containing the file be writeable. Locking by lock
35999 file does not last for ever; Exim assumes that a lock file is expired if it is
36000 more than 30 minutes old.
36001
36002 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36003 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36004 to be taken out on the open mailbox, and an exclusive lock on the file
36005 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36006 number of the mailbox file. When the locking is released, if an exclusive lock
36007 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36008
36009 The default output contains verification of the locking that takes place. The
36010 &%-v%& option causes some additional information to be given. The &%-q%& option
36011 suppresses all output except error messages.
36012
36013 A command such as
36014 .code
36015 exim_lock /var/spool/mail/spqr
36016 .endd
36017 runs an interactive shell while the file is locked, whereas
36018 .display
36019 &`exim_lock -q /var/spool/mail/spqr <<End`&
36020 <&'some commands'&>
36021 &`End`&
36022 .endd
36023 runs a specific non-interactive sequence of commands while the file is locked,
36024 suppressing all verification output. A single command can be run by a command
36025 such as
36026 .code
36027 exim_lock -q /var/spool/mail/spqr \
36028   "cp /var/spool/mail/spqr /some/where"
36029 .endd
36030 Note that if a command is supplied, it must be entirely contained within the
36031 second argument &-- hence the quotes.
36032 .ecindex IIDutils
36033
36034
36035 . ////////////////////////////////////////////////////////////////////////////
36036 . ////////////////////////////////////////////////////////////////////////////
36037
36038 .chapter "The Exim monitor" "CHAPeximon"
36039 .scindex IIDeximon "Exim monitor" "description"
36040 .cindex "X-windows"
36041 .cindex "&'eximon'&"
36042 .cindex "Local/eximon.conf"
36043 .cindex "&_exim_monitor/EDITME_&"
36044 The Exim monitor is an application which displays in an X window information
36045 about the state of Exim's queue and what Exim is doing. An admin user can
36046 perform certain operations on messages from this GUI interface; however all
36047 such facilities are also available from the command line, and indeed, the
36048 monitor itself makes use of the command line to perform any actions requested.
36049
36050
36051
36052 .section "Running the monitor" "SECID264"
36053 The monitor is started by running the script called &'eximon'&. This is a shell
36054 script that sets up a number of environment variables, and then runs the
36055 binary called &_eximon.bin_&. The default appearance of the monitor window can
36056 be changed by editing the &_Local/eximon.conf_& file created by editing
36057 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36058 parameters are for.
36059
36060 The parameters that get built into the &'eximon'& script can be overridden for
36061 a particular invocation by setting up environment variables of the same names,
36062 preceded by &`EXIMON_`&. For example, a shell command such as
36063 .code
36064 EXIMON_LOG_DEPTH=400 eximon
36065 .endd
36066 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36067 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36068 overrides the Exim log file configuration. This makes it possible to have
36069 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36070 syslog messages are routed to a file on the local host.
36071
36072 X resources can be used to change the appearance of the window in the normal
36073 way. For example, a resource setting of the form
36074 .code
36075 Eximon*background: gray94
36076 .endd
36077 changes the colour of the background to light grey rather than white. The
36078 stripcharts are drawn with both the data lines and the reference lines in
36079 black. This means that the reference lines are not visible when on top of the
36080 data. However, their colour can be changed by setting a resource called
36081 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36082 For example, if your X server is running Unix, you could set up lighter
36083 reference lines in the stripcharts by obeying
36084 .code
36085 xrdb -merge <<End
36086 Eximon*highlight: gray
36087 End
36088 .endd
36089 .cindex "admin user"
36090 In order to see the contents of messages on the queue, and to operate on them,
36091 &'eximon'& must either be run as root or by an admin user.
36092
36093 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36094 contain X11 resource parameters interpreted by the X11 library.  In addition,
36095 if the first parameter starts with the string "gdb" then it is removed and the
36096 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36097 versioned variants of gdb can be invoked).
36098
36099 The monitor's window is divided into three parts. The first contains one or
36100 more stripcharts and two action buttons, the second contains a &"tail"& of the
36101 main log file, and the third is a display of the queue of messages awaiting
36102 delivery, with two more action buttons. The following sections describe these
36103 different parts of the display.
36104
36105
36106
36107
36108 .section "The stripcharts" "SECID265"
36109 .cindex "stripchart"
36110 The first stripchart is always a count of messages on the queue. Its name can
36111 be configured by setting QUEUE_STRIPCHART_NAME in the
36112 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36113 configuration script by regular expression matches on log file entries, making
36114 it possible to display, for example, counts of messages delivered to certain
36115 hosts or using certain transports. The supplied defaults display counts of
36116 received and delivered messages, and of local and SMTP deliveries. The default
36117 period between stripchart updates is one minute; this can be adjusted by a
36118 parameter in the &_Local/eximon.conf_& file.
36119
36120 The stripchart displays rescale themselves automatically as the value they are
36121 displaying changes. There are always 10 horizontal lines in each chart; the
36122 title string indicates the value of each division when it is greater than one.
36123 For example, &"x2"& means that each division represents a value of 2.
36124
36125 It is also possible to have a stripchart which shows the percentage fullness of
36126 a particular disk partition, which is useful when local deliveries are confined
36127 to a single partition.
36128
36129 .cindex "&%statvfs%& function"
36130 This relies on the availability of the &[statvfs()]& function or equivalent in
36131 the operating system. Most, but not all versions of Unix that support Exim have
36132 this. For this particular stripchart, the top of the chart always represents
36133 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36134 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36135 &_Local/eximon.conf_& file.
36136
36137
36138
36139
36140 .section "Main action buttons" "SECID266"
36141 .cindex "size" "of monitor window"
36142 .cindex "Exim monitor" "window size"
36143 .cindex "window size"
36144 Below the stripcharts there is an action button for quitting the monitor. Next
36145 to this is another button marked &"Size"&. They are placed here so that
36146 shrinking the window to its default minimum size leaves just the queue count
36147 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36148 the window to expand to its maximum size, unless it is already at the maximum,
36149 in which case it is reduced to its minimum.
36150
36151 When expanding to the maximum, if the window cannot be fully seen where it
36152 currently is, it is moved back to where it was the last time it was at full
36153 size. When it is expanding from its minimum size, the old position is
36154 remembered, and next time it is reduced to the minimum it is moved back there.
36155
36156 The idea is that you can keep a reduced window just showing one or two
36157 stripcharts at a convenient place on your screen, easily expand it to show
36158 the full window when required, and just as easily put it back to what it was.
36159 The idea is copied from what the &'twm'& window manager does for its
36160 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36161 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36162
36163 Normally, the monitor starts up with the window at its full size, but it can be
36164 built so that it starts up with the window at its smallest size, by setting
36165 START_SMALL=yes in &_Local/eximon.conf_&.
36166
36167
36168
36169 .section "The log display" "SECID267"
36170 .cindex "log" "tail of; in monitor"
36171 The second section of the window is an area in which a display of the tail of
36172 the main log is maintained.
36173 To save space on the screen, the timestamp on each log line is shortened by
36174 removing the date and, if &%log_timezone%& is set, the timezone.
36175 The log tail is not available when the only destination for logging data is
36176 syslog, unless the syslog lines are routed to a local file whose name is passed
36177 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36178
36179 The log sub-window has a scroll bar at its lefthand side which can be used to
36180 move back to look at earlier text, and the up and down arrow keys also have a
36181 scrolling effect. The amount of log that is kept depends on the setting of
36182 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36183 to use. When this is full, the earlier 50% of data is discarded &-- this is
36184 much more efficient than throwing it away line by line. The sub-window also has
36185 a horizontal scroll bar for accessing the ends of long log lines. This is the
36186 only means of horizontal scrolling; the right and left arrow keys are not
36187 available. Text can be cut from this part of the window using the mouse in the
36188 normal way. The size of this subwindow is controlled by parameters in the
36189 configuration file &_Local/eximon.conf_&.
36190
36191 Searches of the text in the log window can be carried out by means of the ^R
36192 and ^S keystrokes, which default to a reverse and a forward search,
36193 respectively. The search covers only the text that is displayed in the window.
36194 It cannot go further back up the log.
36195
36196 The point from which the search starts is indicated by a caret marker. This is
36197 normally at the end of the text in the window, but can be positioned explicitly
36198 by pointing and clicking with the left mouse button, and is moved automatically
36199 by a successful search. If new text arrives in the window when it is scrolled
36200 back, the caret remains where it is, but if the window is not scrolled back,
36201 the caret is moved to the end of the new text.
36202
36203 Pressing ^R or ^S pops up a window into which the search text can be typed.
36204 There are buttons for selecting forward or reverse searching, for carrying out
36205 the search, and for cancelling. If the &"Search"& button is pressed, the search
36206 happens and the window remains so that further searches can be done. If the
36207 &"Return"& key is pressed, a single search is done and the window is closed. If
36208 ^C is typed the search is cancelled.
36209
36210 The searching facility is implemented using the facilities of the Athena text
36211 widget. By default this pops up a window containing both &"search"& and
36212 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36213 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36214 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36215 provided version of &%TextPop%& when the remaining parts of the text widget
36216 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36217 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36218 on these systems, at the expense of having unwanted items in the search popup
36219 window.
36220
36221
36222
36223 .section "The queue display" "SECID268"
36224 .cindex "queue" "display in monitor"
36225 The bottom section of the monitor window contains a list of all messages that
36226 are on the queue, which includes those currently being received or delivered,
36227 as well as those awaiting delivery. The size of this subwindow is controlled by
36228 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36229 at which it is updated is controlled by another parameter in the same file &--
36230 the default is 5 minutes, since queue scans can be quite expensive. However,
36231 there is an &"Update"& action button just above the display which can be used
36232 to force an update of the queue display at any time.
36233
36234 When a host is down for some time, a lot of pending mail can build up for it,
36235 and this can make it hard to deal with other messages on the queue. To help
36236 with this situation there is a button next to &"Update"& called &"Hide"&. If
36237 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36238 type anything in here and press &"Return"&, the text is added to a chain of
36239 such texts, and if every undelivered address in a message matches at least one
36240 of the texts, the message is not displayed.
36241
36242 If there is an address that does not match any of the texts, all the addresses
36243 are displayed as normal. The matching happens on the ends of addresses so, for
36244 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36245 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36246 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36247 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36248 a hide request is automatically cancelled after one hour.
36249
36250 While the dialogue box is displayed, you can't press any buttons or do anything
36251 else to the monitor window. For this reason, if you want to cut text from the
36252 queue display to use in the dialogue box, you have to do the cutting before
36253 pressing the &"Hide"& button.
36254
36255 The queue display contains, for each unhidden queued message, the length of
36256 time it has been on the queue, the size of the message, the message id, the
36257 message sender, and the first undelivered recipient, all on one line. If it is
36258 a bounce message, the sender is shown as &"<>"&. If there is more than one
36259 recipient to which the message has not yet been delivered, subsequent ones are
36260 listed on additional lines, up to a maximum configured number, following which
36261 an ellipsis is displayed. Recipients that have already received the message are
36262 not shown.
36263
36264 .cindex "frozen messages" "display"
36265 If a message is frozen, an asterisk is displayed at the left-hand side.
36266
36267 The queue display has a vertical scroll bar, and can also be scrolled by means
36268 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36269 The text searching facilities, as described above for the log window, are also
36270 available, but the caret is always moved to the end of the text when the queue
36271 display is updated.
36272
36273
36274
36275 .section "The queue menu" "SECID269"
36276 .cindex "queue" "menu in monitor"
36277 If the &%shift%& key is held down and the left button is clicked when the mouse
36278 pointer is over the text for any message, an action menu pops up, and the first
36279 line of the queue display for the message is highlighted. This does not affect
36280 any selected text.
36281
36282 If you want to use some other event for popping up the menu, you can set the
36283 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36284 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36285 value set in this parameter is a standard X event description. For example, to
36286 run eximon using &%ctrl%& rather than &%shift%& you could use
36287 .code
36288 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36289 .endd
36290 The title of the menu is the message id, and it contains entries which act as
36291 follows:
36292
36293 .ilist
36294 &'message log'&: The contents of the message log for the message are displayed
36295 in a new text window.
36296 .next
36297 &'headers'&: Information from the spool file that contains the envelope
36298 information and headers is displayed in a new text window. See chapter
36299 &<<CHAPspool>>& for a description of the format of spool files.
36300 .next
36301 &'body'&: The contents of the spool file containing the body of the message are
36302 displayed in a new text window. There is a default limit of 20,000 bytes to the
36303 amount of data displayed. This can be changed by setting the BODY_MAX
36304 option at compile time, or the EXIMON_BODY_MAX option at run time.
36305 .next
36306 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36307 delivery of the message. This causes an automatic thaw if the message is
36308 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36309 a new text window. The delivery is run in a separate process, to avoid holding
36310 up the monitor while the delivery proceeds.
36311 .next
36312 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36313 that the message be frozen.
36314 .next
36315 .cindex "thawing messages"
36316 .cindex "unfreezing messages"
36317 .cindex "frozen messages" "thawing"
36318 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36319 that the message be thawed.
36320 .next
36321 .cindex "delivery" "forcing failure"
36322 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36323 that Exim gives up trying to deliver the message. A bounce message is generated
36324 for any remaining undelivered addresses.
36325 .next
36326 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36327 that the message be deleted from the system without generating a bounce
36328 message.
36329 .next
36330 &'add recipient'&: A dialog box is displayed into which a recipient address can
36331 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36332 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36333 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36334 causes a call to Exim to be made using the &%-Mar%& option to request that an
36335 additional recipient be added to the message, unless the entry box is empty, in
36336 which case no action is taken.
36337 .next
36338 &'mark delivered'&: A dialog box is displayed into which a recipient address
36339 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36340 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36341 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36342 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36343 recipient address as already delivered, unless the entry box is empty, in which
36344 case no action is taken.
36345 .next
36346 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36347 mark all recipient addresses as already delivered.
36348 .next
36349 &'edit sender'&: A dialog box is displayed initialized with the current
36350 sender's address. Pressing RETURN causes a call to Exim to be made using the
36351 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36352 in which case no action is taken. If you want to set an empty sender (as in
36353 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36354 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36355 the address is qualified with that domain.
36356 .endlist
36357
36358 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36359 other cases when a call to Exim is made, if there is any output from Exim (in
36360 particular, if the command fails) a window containing the command and the
36361 output is displayed. Otherwise, the results of the action are normally apparent
36362 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36363 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36364 if no output is generated.
36365
36366 The queue display is automatically updated for actions such as freezing and
36367 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36368 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36369 force an update of the display after one of these actions.
36370
36371 In any text window that is displayed as result of a menu action, the normal
36372 cut-and-paste facility is available, and searching can be carried out using ^R
36373 and ^S, as described above for the log tail window.
36374 .ecindex IIDeximon
36375
36376
36377
36378
36379
36380 . ////////////////////////////////////////////////////////////////////////////
36381 . ////////////////////////////////////////////////////////////////////////////
36382
36383 .chapter "Security considerations" "CHAPsecurity"
36384 .scindex IIDsecurcon "security" "discussion of"
36385 This chapter discusses a number of issues concerned with security, some of
36386 which are also covered in other parts of this manual.
36387
36388 For reasons that this author does not understand, some people have promoted
36389 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36390 existence of this chapter in the documentation. However, the intent of the
36391 chapter is simply to describe the way Exim works in relation to certain
36392 security concerns, not to make any specific claims about the effectiveness of
36393 its security as compared with other MTAs.
36394
36395 What follows is a description of the way Exim is supposed to be. Best efforts
36396 have been made to try to ensure that the code agrees with the theory, but an
36397 absence of bugs can never be guaranteed. Any that are reported will get fixed
36398 as soon as possible.
36399
36400
36401 .section "Building a more &""hardened""& Exim" "SECID286"
36402 .cindex "security" "build-time features"
36403 There are a number of build-time options that can be set in &_Local/Makefile_&
36404 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36405 Exim administrator who does not have the root password, or by someone who has
36406 penetrated the Exim (but not the root) account. These options are as follows:
36407
36408 .ilist
36409 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36410 start of any file names used with the &%-C%& option. When it is set, these file
36411 names are also not allowed to contain the sequence &"/../"&. (However, if the
36412 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36413 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36414 default setting for &%ALT_CONFIG_PREFIX%&.
36415
36416 If the permitted configuration files are confined to a directory to
36417 which only root has access, this guards against someone who has broken
36418 into the Exim account from running a privileged Exim with an arbitrary
36419 configuration file, and using it to break into other accounts.
36420 .next
36421
36422 If a non-trusted configuration file (i.e. not the default configuration file
36423 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36424 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36425 the next item), then root privilege is retained only if the caller of Exim is
36426 root. This locks out the possibility of testing a configuration using &%-C%&
36427 right through message reception and delivery, even if the caller is root. The
36428 reception works, but by that time, Exim is running as the Exim user, so when
36429 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36430 privilege to be lost. However, root can test reception and delivery using two
36431 separate commands.
36432
36433 .next
36434 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36435 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36436 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36437 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36438 the restrictive side.  Requiring build-time selection of safe macros is onerous
36439 but this option is intended solely as a transition mechanism to permit
36440 previously-working configurations to continue to work after release 4.73.
36441 .next
36442 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36443 is disabled.
36444 .next
36445 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36446 never to be used for any deliveries. This is like the &%never_users%& runtime
36447 option, but it cannot be overridden; the runtime option adds additional users
36448 to the list. The default setting is &"root"&; this prevents a non-root user who
36449 is permitted to modify the runtime file from using Exim as a way to get root.
36450 .endlist
36451
36452
36453
36454 .section "Root privilege" "SECID270"
36455 .cindex "setuid"
36456 .cindex "root privilege"
36457 The Exim binary is normally setuid to root, which means that it gains root
36458 privilege (runs as root) when it starts execution. In some special cases (for
36459 example, when the daemon is not in use and there are no local deliveries), it
36460 may be possible to run Exim setuid to some user other than root. This is
36461 discussed in the next section. However, in most installations, root privilege
36462 is required for two things:
36463
36464 .ilist
36465 To set up a socket connected to the standard SMTP port (25) when initialising
36466 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36467 not required.
36468 .next
36469 To be able to change uid and gid in order to read users' &_.forward_& files and
36470 perform local deliveries as the receiving user or as specified in the
36471 configuration.
36472 .endlist
36473
36474 It is not necessary to be root to do any of the other things Exim does, such as
36475 receiving messages and delivering them externally over SMTP, and it is
36476 obviously more secure if Exim does not run as root except when necessary.
36477 For this reason, a user and group for Exim to use must be defined in
36478 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36479 group"&. Their values can be changed by the run time configuration, though this
36480 is not recommended. Often a user called &'exim'& is used, but some sites use
36481 &'mail'& or another user name altogether.
36482
36483 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36484 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36485 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36486
36487 After a new Exim process has interpreted its command line options, it changes
36488 uid and gid in the following cases:
36489
36490 .ilist
36491 .oindex "&%-C%&"
36492 .oindex "&%-D%&"
36493 If the &%-C%& option is used to specify an alternate configuration file, or if
36494 the &%-D%& option is used to define macro values for the configuration, and the
36495 calling process is not running as root, the uid and gid are changed to those of
36496 the calling process.
36497 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36498 option may not be used at all.
36499 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36500 can be supplied if the calling process is running as root, the Exim run-time
36501 user or CONFIGURE_OWNER, if defined.
36502 .next
36503 .oindex "&%-be%&"
36504 .oindex "&%-bf%&"
36505 .oindex "&%-bF%&"
36506 If the expansion test option (&%-be%&) or one of the filter testing options
36507 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36508 calling process.
36509 .next
36510 If the process is not a daemon process or a queue runner process or a delivery
36511 process or a process for testing address routing (started with &%-bt%&), the
36512 uid and gid are changed to the Exim user and group. This means that Exim always
36513 runs under its own uid and gid when receiving messages. This also applies when
36514 testing address verification
36515 .oindex "&%-bv%&"
36516 .oindex "&%-bh%&"
36517 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36518 option).
36519 .next
36520 For a daemon, queue runner, delivery, or address testing process, the uid
36521 remains as root at this stage, but the gid is changed to the Exim group.
36522 .endlist
36523
36524 The processes that initially retain root privilege behave as follows:
36525
36526 .ilist
36527 A daemon process changes the gid to the Exim group and the uid to the Exim
36528 user after setting up one or more listening sockets. The &[initgroups()]&
36529 function is called, so that if the Exim user is in any additional groups, they
36530 will be used during message reception.
36531 .next
36532 A queue runner process retains root privilege throughout its execution. Its
36533 job is to fork a controlled sequence of delivery processes.
36534 .next
36535 A delivery process retains root privilege throughout most of its execution,
36536 but any actual deliveries (that is, the transports themselves) are run in
36537 subprocesses which always change to a non-root uid and gid. For local
36538 deliveries this is typically the uid and gid of the owner of the mailbox; for
36539 remote deliveries, the Exim uid and gid are used. Once all the delivery
36540 subprocesses have been run, a delivery process changes to the Exim uid and gid
36541 while doing post-delivery tidying up such as updating the retry database and
36542 generating bounce and warning messages.
36543
36544 While the recipient addresses in a message are being routed, the delivery
36545 process runs as root. However, if a user's filter file has to be processed,
36546 this is done in a subprocess that runs under the individual user's uid and
36547 gid. A system filter is run as root unless &%system_filter_user%& is set.
36548 .next
36549 A process that is testing addresses (the &%-bt%& option) runs as root so that
36550 the routing is done in the same environment as a message delivery.
36551 .endlist
36552
36553
36554
36555
36556 .section "Running Exim without privilege" "SECTrunexiwitpri"
36557 .cindex "privilege, running without"
36558 .cindex "unprivileged running"
36559 .cindex "root privilege" "running without"
36560 Some installations like to run Exim in an unprivileged state for more of its
36561 operation, for added security. Support for this mode of operation is provided
36562 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36563 gid are changed to the Exim user and group at the start of a delivery process
36564 (and also queue runner and address testing processes). This means that address
36565 routing is no longer run as root, and the deliveries themselves cannot change
36566 to any other uid.
36567
36568 .cindex SIGHUP
36569 .cindex "daemon" "restarting"
36570 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36571 that the daemon can still be started in the usual way, and it can respond
36572 correctly to SIGHUP because the re-invocation regains root privilege.
36573
36574 An alternative approach is to make Exim setuid to the Exim user and also setgid
36575 to the Exim group. If you do this, the daemon must be started from a root
36576 process. (Calling Exim from a root process makes it behave in the way it does
36577 when it is setuid root.) However, the daemon cannot restart itself after a
36578 SIGHUP signal because it cannot regain privilege.
36579
36580 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36581 stops Exim from trying to re-invoke itself to do a delivery after a message has
36582 been received. Such a re-invocation is a waste of resources because it has no
36583 effect.
36584
36585 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36586 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36587 to the Exim user seems a clean approach, but there is one complication:
36588
36589 In this style of operation, Exim is running with the real uid and gid set to
36590 those of the calling process, and the effective uid/gid set to Exim's values.
36591 Ideally, any association with the calling process' uid/gid should be dropped,
36592 that is, the real uid/gid should be reset to the effective values so as to
36593 discard any privileges that the caller may have. While some operating systems
36594 have a function that permits this action for a non-root effective uid, quite a
36595 number of them do not. Because of this lack of standardization, Exim does not
36596 address this problem at this time.
36597
36598 For this reason, the recommended approach for &"mostly unprivileged"& running
36599 is to keep the Exim binary setuid to root, and to set
36600 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36601 be used in the most straightforward way.
36602
36603 If you configure Exim not to run delivery processes as root, there are a
36604 number of restrictions on what you can do:
36605
36606 .ilist
36607 You can deliver only as the Exim user/group. You should  explicitly use the
36608 &%user%& and &%group%& options to override routers or local transports that
36609 normally deliver as the recipient. This makes sure that configurations that
36610 work in this mode function the same way in normal mode. Any implicit or
36611 explicit specification of another user causes an error.
36612 .next
36613 Use of &_.forward_& files is severely restricted, such that it is usually
36614 not worthwhile to include them in the configuration.
36615 .next
36616 Users who wish to use &_.forward_& would have to make their home directory and
36617 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36618 and their equivalents in Exim filters, cannot be used. While they could be
36619 enabled in the Exim user's name, that would be insecure and not very useful.
36620 .next
36621 Unless the local user mailboxes are all owned by the Exim user (possible in
36622 some POP3 or IMAP-only environments):
36623
36624 .olist
36625 They must be owned by the Exim group and be writeable by that group. This
36626 implies you must set &%mode%& in the appendfile configuration, as well as the
36627 mode of the mailbox files themselves.
36628 .next
36629 You must set &%no_check_owner%&, since most or all of the files will not be
36630 owned by the Exim user.
36631 .next
36632 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36633 on a newly created mailbox when unprivileged. This also implies that new
36634 mailboxes need to be created manually.
36635 .endlist olist
36636 .endlist ilist
36637
36638
36639 These restrictions severely restrict what can be done in local deliveries.
36640 However, there are no restrictions on remote deliveries. If you are running a
36641 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36642 gives more security at essentially no cost.
36643
36644 If you are using the &%mua_wrapper%& facility (see chapter
36645 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36646
36647
36648
36649
36650 .section "Delivering to local files" "SECID271"
36651 Full details of the checks applied by &(appendfile)& before it writes to a file
36652 are given in chapter &<<CHAPappendfile>>&.
36653
36654
36655
36656 .section "Running local commands" "SECTsecconslocalcmds"
36657 .cindex "security" "local commands"
36658 .cindex "security" "command injection attacks"
36659 There are a number of ways in which an administrator can configure Exim to run
36660 commands based upon received, untrustworthy, data. Further, in some
36661 configurations a user who can control a &_.forward_& file can also arrange to
36662 run commands. Configuration to check includes, but is not limited to:
36663
36664 .ilist
36665 Use of &%use_shell%& in the pipe transport: various forms of shell command
36666 injection may be possible with this option present. It is dangerous and should
36667 be used only with considerable caution. Consider constraints which whitelist
36668 allowed characters in a variable which is to be used in a pipe transport that
36669 has &%use_shell%& enabled.
36670 .next
36671 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36672 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36673 &_.forward_& files in a redirect router. If Exim is running on a central mail
36674 hub to which ordinary users do not have shell access, but home directories are
36675 NFS mounted (for instance) then administrators should review the list of these
36676 forbid options available, and should bear in mind that the options that may
36677 need forbidding can change as new features are added between releases.
36678 .next
36679 The &%${run...}%& expansion item does not use a shell by default, but
36680 administrators can configure use of &_/bin/sh_& as part of the command.
36681 Such invocations should be viewed with prejudicial suspicion.
36682 .next
36683 Administrators who use embedded Perl are advised to explore how Perl's
36684 taint checking might apply to their usage.
36685 .next
36686 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36687 administrators are well advised to view its use with suspicion, in case (for
36688 instance) it allows a local-part to contain embedded Exim directives.
36689 .next
36690 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36691 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36692 each can reference arbitrary lists and files, rather than just being a list
36693 of opaque strings.
36694 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36695 real-world security vulnerabilities caused by its use with untrustworthy data
36696 injected in, for SQL injection attacks.
36697 Consider the use of the &%inlisti%& expansion condition instead.
36698 .endlist
36699
36700
36701
36702
36703 .section "Trust in configuration data" "SECTsecconfdata"
36704 .cindex "security" "data sources"
36705 .cindex "security" "regular expressions"
36706 .cindex "regular expressions" "security"
36707 .cindex "PCRE" "security"
36708 If configuration data for Exim can come from untrustworthy sources, there
36709 are some issues to be aware of:
36710
36711 .ilist
36712 Use of &%${expand...}%& may provide a path for shell injection attacks.
36713 .next
36714 Letting untrusted data provide a regular expression is unwise.
36715 .next
36716 Using &%${match...}%& to apply a fixed regular expression against untrusted
36717 data may result in pathological behaviour within PCRE.  Be aware of what
36718 "backtracking" means and consider options for being more strict with a regular
36719 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36720 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36721 possessive quantifiers or just not using regular expressions against untrusted
36722 data.
36723 .next
36724 It can be important to correctly use &%${quote:...}%&,
36725 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36726 items to ensure that data is correctly constructed.
36727 .next
36728 Some lookups might return multiple results, even though normal usage is only
36729 expected to yield one result.
36730 .endlist
36731
36732
36733
36734
36735 .section "IPv4 source routing" "SECID272"
36736 .cindex "source routing" "in IP packets"
36737 .cindex "IP source routing"
36738 Many operating systems suppress IP source-routed packets in the kernel, but
36739 some cannot be made to do this, so Exim does its own check. It logs incoming
36740 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36741 IPv6. No special checking is currently done.
36742
36743
36744
36745 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36746 Support for these SMTP commands is disabled by default. If required, they can
36747 be enabled by defining suitable ACLs.
36748
36749
36750
36751
36752 .section "Privileged users" "SECID274"
36753 .cindex "trusted users"
36754 .cindex "admin user"
36755 .cindex "privileged user"
36756 .cindex "user" "trusted"
36757 .cindex "user" "admin"
36758 Exim recognizes two sets of users with special privileges. Trusted users are
36759 able to submit new messages to Exim locally, but supply their own sender
36760 addresses and information about a sending host. For other users submitting
36761 local messages, Exim sets up the sender address from the uid, and doesn't
36762 permit a remote host to be specified.
36763
36764 .oindex "&%-f%&"
36765 However, an untrusted user is permitted to use the &%-f%& command line option
36766 in the special form &%-f <>%& to indicate that a delivery failure for the
36767 message should not cause an error report. This affects the message's envelope,
36768 but it does not affect the &'Sender:'& header. Untrusted users may also be
36769 permitted to use specific forms of address with the &%-f%& option by setting
36770 the &%untrusted_set_sender%& option.
36771
36772 Trusted users are used to run processes that receive mail messages from some
36773 other mail domain and pass them on to Exim for delivery either locally, or over
36774 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36775 as any user listed in the &%trusted_users%& configuration option, or under any
36776 group listed in the &%trusted_groups%& option.
36777
36778 Admin users are permitted to do things to the messages on Exim's queue. They
36779 can freeze or thaw messages, cause them to be returned to their senders, remove
36780 them entirely, or modify them in various ways. In addition, admin users can run
36781 the Exim monitor and see all the information it is capable of providing, which
36782 includes the contents of files on the spool.
36783
36784 .oindex "&%-M%&"
36785 .oindex "&%-q%&"
36786 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36787 delivery of messages on its queue is restricted to admin users. This
36788 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36789 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36790 queue is also restricted to admin users. This restriction can be relaxed by
36791 setting &%no_queue_list_requires_admin%&.
36792
36793 Exim recognizes an admin user if the calling process is running as root or as
36794 the Exim user or if any of the groups associated with the calling process is
36795 the Exim group. It is not necessary actually to be running under the Exim
36796 group. However, if admin users who are not root or the Exim user are to access
36797 the contents of files on the spool via the Exim monitor (which runs
36798 unprivileged), Exim must be built to allow group read access to its spool
36799 files.
36800
36801
36802
36803 .section "Spool files" "SECID275"
36804 .cindex "spool directory" "files"
36805 Exim's spool directory and everything it contains is owned by the Exim user and
36806 set to the Exim group. The mode for spool files is defined in the
36807 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36808 any user who is a member of the Exim group can access these files.
36809
36810
36811
36812 .section "Use of argv[0]" "SECID276"
36813 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36814 of specific strings, Exim assumes certain options. For example, calling Exim
36815 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36816 to calling it with the option &%-bS%&. There are no security implications in
36817 this.
36818
36819
36820
36821 .section "Use of %f formatting" "SECID277"
36822 The only use made of &"%f"& by Exim is in formatting load average values. These
36823 are actually stored in integer variables as 1000 times the load average.
36824 Consequently, their range is limited and so therefore is the length of the
36825 converted output.
36826
36827
36828
36829 .section "Embedded Exim path" "SECID278"
36830 Exim uses its own path name, which is embedded in the code, only when it needs
36831 to re-exec in order to regain root privilege. Therefore, it is not root when it
36832 does so. If some bug allowed the path to get overwritten, it would lead to an
36833 arbitrary program's being run as exim, not as root.
36834
36835
36836
36837 .section "Dynamic module directory" "SECTdynmoddir"
36838 Any dynamically loadable modules must be installed into the directory
36839 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36840 loading it.
36841
36842
36843 .section "Use of sprintf()" "SECID279"
36844 .cindex "&[sprintf()]&"
36845 A large number of occurrences of &"sprintf"& in the code are actually calls to
36846 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36847 The intermediate formatting is done into a large fixed buffer by a function
36848 that runs through the format string itself, and checks the length of each
36849 conversion before performing it, thus preventing buffer overruns.
36850
36851 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36852 the output buffer is known to be sufficiently long to contain the converted
36853 string.
36854
36855
36856
36857 .section "Use of debug_printf() and log_write()" "SECID280"
36858 Arbitrary strings are passed to both these functions, but they do their
36859 formatting by calling the function &'string_vformat()'&, which runs through
36860 the format string itself, and checks the length of each conversion.
36861
36862
36863
36864 .section "Use of strcat() and strcpy()" "SECID281"
36865 These are used only in cases where the output buffer is known to be large
36866 enough to hold the result.
36867 .ecindex IIDsecurcon
36868
36869
36870
36871
36872 . ////////////////////////////////////////////////////////////////////////////
36873 . ////////////////////////////////////////////////////////////////////////////
36874
36875 .chapter "Format of spool files" "CHAPspool"
36876 .scindex IIDforspo1 "format" "spool files"
36877 .scindex IIDforspo2 "spool directory" "format of files"
36878 .scindex IIDforspo3 "spool files" "format of"
36879 .cindex "spool files" "editing"
36880 A message on Exim's queue consists of two files, whose names are the message id
36881 followed by -D and -H, respectively. The data portion of the message is kept in
36882 the -D file on its own. The message's envelope, status, and headers are all
36883 kept in the -H file, whose format is described in this chapter. Each of these
36884 two files contains the final component of its own name as its first line. This
36885 is insurance against disk crashes where the directory is lost but the files
36886 themselves are recoverable.
36887
36888 Some people are tempted into editing -D files in order to modify messages. You
36889 need to be extremely careful if you do this; it is not recommended and you are
36890 on your own if you do it. Here are some of the pitfalls:
36891
36892 .ilist
36893 You must ensure that Exim does not try to deliver the message while you are
36894 fiddling with it. The safest way is to take out a write lock on the -D file,
36895 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36896 place, the lock will be retained. If you write a new file and rename it, the
36897 lock will be lost at the instant of rename.
36898 .next
36899 .vindex "&$body_linecount$&"
36900 If you change the number of lines in the file, the value of
36901 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36902 present, this value is not used by Exim, but there is no guarantee that this
36903 will always be the case.
36904 .next
36905 If the message is in MIME format, you must take care not to break it.
36906 .next
36907 If the message is cryptographically signed, any change will invalidate the
36908 signature.
36909 .endlist
36910 All in all, modifying -D files is fraught with danger.
36911
36912 Files whose names end with -J may also be seen in the &_input_& directory (or
36913 its subdirectories when &%split_spool_directory%& is set). These are journal
36914 files, used to record addresses to which the message has been delivered during
36915 the course of a delivery attempt. If there are still undelivered recipients at
36916 the end, the -H file is updated, and the -J file is deleted. If, however, there
36917 is some kind of crash (for example, a power outage) before this happens, the -J
36918 file remains in existence. When Exim next processes the message, it notices the
36919 -J file and uses it to update the -H file before starting the next delivery
36920 attempt.
36921
36922 .section "Format of the -H file" "SECID282"
36923 .cindex "uid (user id)" "in spool file"
36924 .cindex "gid (group id)" "in spool file"
36925 The second line of the -H file contains the login name for the uid of the
36926 process that called Exim to read the message, followed by the numerical uid and
36927 gid. For a locally generated message, this is normally the user who sent the
36928 message. For a message received over TCP/IP via the daemon, it is
36929 normally the Exim user.
36930
36931 The third line of the file contains the address of the message's sender as
36932 transmitted in the envelope, contained in angle brackets. The sender address is
36933 empty for bounce messages. For incoming SMTP mail, the sender address is given
36934 in the MAIL command. For locally generated mail, the sender address is
36935 created by Exim from the login name of the current user and the configured
36936 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36937 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36938 &"<>"& or an address that matches &%untrusted_set_senders%&.
36939
36940 The fourth line contains two numbers. The first is the time that the message
36941 was received, in the conventional Unix form &-- the number of seconds since the
36942 start of the epoch. The second number is a count of the number of messages
36943 warning of delayed delivery that have been sent to the sender.
36944
36945 There follow a number of lines starting with a hyphen. These can appear in any
36946 order, and are omitted when not relevant:
36947
36948 .vlist
36949 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36950 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36951 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36952 recognized, to provide backward compatibility. In the old format, a line of
36953 this form is present for every ACL variable that is not empty. The number
36954 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36955 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36956 the data string for the variable. The string itself starts at the beginning of
36957 the next line, and is followed by a newline character. It may contain internal
36958 newlines.
36959
36960 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36961 A line of this form is present for every ACL connection variable that is
36962 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36963 The length is the length of the data string for the variable. The string itself
36964 starts at the beginning of the next line, and is followed by a newline
36965 character. It may contain internal newlines.
36966
36967 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36968 A line of this form is present for every ACL message variable that is defined.
36969 Note that there is a space between &%-aclm%& and the rest of the name. The
36970 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 "&%-active_hostname%&&~<&'hostname'&>"
36975 This is present if, when the message was received over SMTP, the value of
36976 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36977
36978 .vitem &%-allow_unqualified_recipient%&
36979 This is present if unqualified recipient addresses are permitted in header
36980 lines (to stop such addresses from being qualified if rewriting occurs at
36981 transport time). Local messages that were input using &%-bnq%& and remote
36982 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36983
36984 .vitem &%-allow_unqualified_sender%&
36985 This is present if unqualified sender addresses are permitted in header lines
36986 (to stop such addresses from being qualified if rewriting occurs at transport
36987 time). Local messages that were input using &%-bnq%& and remote messages from
36988 hosts that match &%sender_unqualified_hosts%& set this flag.
36989
36990 .vitem "&%-auth_id%&&~<&'text'&>"
36991 The id information for a message received on an authenticated SMTP connection
36992 &-- the value of the &$authenticated_id$& variable.
36993
36994 .vitem "&%-auth_sender%&&~<&'address'&>"
36995 The address of an authenticated sender &-- the value of the
36996 &$authenticated_sender$& variable.
36997
36998 .vitem "&%-body_linecount%&&~<&'number'&>"
36999 This records the number of lines in the body of the message, and is always
37000 present.
37001
37002 .vitem "&%-body_zerocount%&&~<&'number'&>"
37003 This records the number of binary zero bytes in the body of the message, and is
37004 present if the number is greater than zero.
37005
37006 .vitem &%-deliver_firsttime%&
37007 This is written when a new message is first added to the spool. When the spool
37008 file is updated after a deferral, it is omitted.
37009
37010 .vitem "&%-frozen%&&~<&'time'&>"
37011 .cindex "frozen messages" "spool data"
37012 The message is frozen, and the freezing happened at <&'time'&>.
37013
37014 .vitem "&%-helo_name%&&~<&'text'&>"
37015 This records the host name as specified by a remote host in a HELO or EHLO
37016 command.
37017
37018 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37019 This records the IP address of the host from which the message was received and
37020 the remote port number that was used. It is omitted for locally generated
37021 messages.
37022
37023 .vitem "&%-host_auth%&&~<&'text'&>"
37024 If the message was received on an authenticated SMTP connection, this records
37025 the name of the authenticator &-- the value of the
37026 &$sender_host_authenticated$& variable.
37027
37028 .vitem &%-host_lookup_failed%&
37029 This is present if an attempt to look up the sending host's name from its IP
37030 address failed. It corresponds to the &$host_lookup_failed$& variable.
37031
37032 .vitem "&%-host_name%&&~<&'text'&>"
37033 .cindex "reverse DNS lookup"
37034 .cindex "DNS" "reverse lookup"
37035 This records the name of the remote host from which the message was received,
37036 if the host name was looked up from the IP address when the message was being
37037 received. It is not present if no reverse lookup was done.
37038
37039 .vitem "&%-ident%&&~<&'text'&>"
37040 For locally submitted messages, this records the login of the originating user,
37041 unless it was a trusted user and the &%-oMt%& option was used to specify an
37042 ident value. For messages received over TCP/IP, this records the ident string
37043 supplied by the remote host, if any.
37044
37045 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37046 This records the IP address of the local interface and the port number through
37047 which a message was received from a remote host. It is omitted for locally
37048 generated messages.
37049
37050 .vitem &%-local%&
37051 The message is from a local sender.
37052
37053 .vitem &%-localerror%&
37054 The message is a locally-generated bounce message.
37055
37056 .vitem "&%-local_scan%&&~<&'string'&>"
37057 This records the data string that was returned by the &[local_scan()]& function
37058 when the message was received &-- the value of the &$local_scan_data$&
37059 variable. It is omitted if no data was returned.
37060
37061 .vitem &%-manual_thaw%&
37062 The message was frozen but has been thawed manually, that is, by an explicit
37063 Exim command rather than via the auto-thaw process.
37064
37065 .vitem &%-N%&
37066 A testing delivery process was started using the &%-N%& option to suppress any
37067 actual deliveries, but delivery was deferred. At any further delivery attempts,
37068 &%-N%& is assumed.
37069
37070 .vitem &%-received_protocol%&
37071 This records the value of the &$received_protocol$& variable, which contains
37072 the name of the protocol by which the message was received.
37073
37074 .vitem &%-sender_set_untrusted%&
37075 The envelope sender of this message was set by an untrusted local caller (used
37076 to ensure that the caller is displayed in queue listings).
37077
37078 .vitem "&%-spam_score_int%&&~<&'number'&>"
37079 If a message was scanned by SpamAssassin, this is present. It records the value
37080 of &$spam_score_int$&.
37081
37082 .vitem &%-tls_certificate_verified%&
37083 A TLS certificate was received from the client that sent this message, and the
37084 certificate was verified by the server.
37085
37086 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37087 When the message was received over an encrypted connection, this records the
37088 name of the cipher suite that was used.
37089
37090 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37091 When the message was received over an encrypted connection, and a certificate
37092 was received from the client, this records the Distinguished Name from that
37093 certificate.
37094 .endlist
37095
37096 Following the options there is a list of those addresses to which the message
37097 is not to be delivered. This set of addresses is initialized from the command
37098 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37099 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37100 the address is added to this set. The addresses are kept internally as a
37101 balanced binary tree, and it is a representation of that tree which is written
37102 to the spool file. If an address is expanded via an alias or forward file, the
37103 original address is added to the tree when deliveries to all its child
37104 addresses are complete.
37105
37106 If the tree is empty, there is a single line in the spool file containing just
37107 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37108 Y or N, followed by an address. The address is the value for the node of the
37109 tree, and the letters indicate whether the node has a left branch and/or a
37110 right branch attached to it, respectively. If branches exist, they immediately
37111 follow. Here is an example of a three-node tree:
37112 .code
37113 YY darcy@austen.fict.example
37114 NN alice@wonderland.fict.example
37115 NN editor@thesaurus.ref.example
37116 .endd
37117 After the non-recipients tree, there is a list of the message's recipients.
37118 This is a simple list, preceded by a count. It includes all the original
37119 recipients of the message, including those to whom the message has already been
37120 delivered. In the simplest case, the list contains one address per line. For
37121 example:
37122 .code
37123 4
37124 editor@thesaurus.ref.example
37125 darcy@austen.fict.example
37126 rdo@foundation
37127 alice@wonderland.fict.example
37128 .endd
37129 However, when a child address has been added to the top-level addresses as a
37130 result of the use of the &%one_time%& option on a &(redirect)& router, each
37131 line is of the following form:
37132 .display
37133 <&'top-level address'&> <&'errors_to address'&> &&&
37134   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37135 .endd
37136 The 01 flag bit indicates the presence of the three other fields that follow
37137 the top-level address. Other bits may be used in future to support additional
37138 fields. The <&'parent number'&> is the offset in the recipients list of the
37139 original parent of the &"one time"& address. The first two fields are the
37140 envelope sender that is associated with this address and its length. If the
37141 length is zero, there is no special envelope sender (there are then two space
37142 characters in the line). A non-empty field can arise from a &(redirect)& router
37143 that has an &%errors_to%& setting.
37144
37145
37146 A blank line separates the envelope and status information from the headers
37147 which follow. A header may occupy several lines of the file, and to save effort
37148 when reading it in, each header is preceded by a number and an identifying
37149 character. The number is the number of characters in the header, including any
37150 embedded newlines and the terminating newline. The character is one of the
37151 following:
37152
37153 .table2 50pt
37154 .row <&'blank'&>         "header in which Exim has no special interest"
37155 .row &`B`&               "&'Bcc:'& header"
37156 .row &`C`&               "&'Cc:'& header"
37157 .row &`F`&               "&'From:'& header"
37158 .row &`I`&               "&'Message-id:'& header"
37159 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37160 .row &`R`&               "&'Reply-To:'& header"
37161 .row &`S`&               "&'Sender:'& header"
37162 .row &`T`&               "&'To:'& header"
37163 .row &`*`&               "replaced or deleted header"
37164 .endtable
37165
37166 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37167 purposes. They are not transmitted when the message is delivered. Here is a
37168 typical set of headers:
37169 .code
37170 111P Received: by hobbit.fict.example with local (Exim 4.00)
37171 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37172 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37173 038* X-rewrote-sender: bb@hobbit.fict.example
37174 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37175 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37176 099* To: alice@wonderland.fict.example, rdo@foundation,
37177 darcy@austen.fict.example, editor@thesaurus.ref.example
37178 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37179 darcy@austen.fict.example, editor@thesaurus.ref.example
37180 038  Date: Fri, 11 May 2001 10:28:59 +0100
37181 .endd
37182 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37183 &'To:'& header have been rewritten, the last one because routing expanded the
37184 unqualified domain &'foundation'&.
37185 .ecindex IIDforspo1
37186 .ecindex IIDforspo2
37187 .ecindex IIDforspo3
37188
37189 . ////////////////////////////////////////////////////////////////////////////
37190 . ////////////////////////////////////////////////////////////////////////////
37191
37192 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37193          "DKIM Support"
37194 .cindex "DKIM"
37195
37196 DKIM is a mechanism by which messages sent by some entity can be provably
37197 linked to a domain which that entity controls.  It permits reputation to
37198 be tracked on a per-domain basis, rather than merely upon source IP address.
37199 DKIM is documented in RFC 4871.
37200
37201 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37202 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37203
37204 Exim's DKIM implementation allows to
37205 .olist
37206 Sign outgoing messages: This function is implemented in the SMTP transport.
37207 It can co-exist with all other Exim features
37208 (including transport filters)
37209 except cutthrough delivery.
37210 .next
37211 Verify signatures in incoming messages: This is implemented by an additional
37212 ACL (acl_smtp_dkim), which can be called several times per message, with
37213 different signature contexts.
37214 .endlist
37215
37216 In typical Exim style, the verification implementation does not include any
37217 default "policy". Instead it enables you to build your own policy using
37218 Exim's standard controls.
37219
37220 Please note that verification of DKIM signatures in incoming mail is turned
37221 on by default for logging purposes. For each signature in incoming email,
37222 exim will log a line displaying the most important signature details, and the
37223 signature status. Here is an example (with line-breaks added for clarity):
37224 .code
37225 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37226     d=facebookmail.com s=q1-2009b
37227     c=relaxed/relaxed a=rsa-sha1
37228     i=@facebookmail.com t=1252484542 [verification succeeded]
37229 .endd
37230 You might want to turn off DKIM verification processing entirely for internal
37231 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37232 control modifier. This should typically be done in the RCPT ACL, at points
37233 where you accept mail from relay sources (internal hosts or authenticated
37234 senders).
37235
37236
37237 .section "Signing outgoing messages" "SECID513"
37238 .cindex "DKIM" "signing"
37239
37240 Signing is implemented by setting private options on the SMTP transport.
37241 These options take (expandable) strings as arguments.
37242
37243 .option dkim_domain smtp string&!! unset
37244 MANDATORY:
37245 The domain you want to sign with. The result of this expanded
37246 option is put into the &%$dkim_domain%& expansion variable.
37247
37248 .option dkim_selector smtp string&!! unset
37249 MANDATORY:
37250 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37251 variable to look up a matching selector. The result is put in the expansion
37252 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37253 option along with &%$dkim_domain%&.
37254
37255 .option dkim_private_key smtp string&!! unset
37256 MANDATORY:
37257 This sets the private key to use. You can use the &%$dkim_domain%& and
37258 &%$dkim_selector%& expansion variables to determine the private key to use.
37259 The result can either
37260 .ilist
37261 be a valid RSA private key in ASCII armor, including line breaks.
37262 .next
37263 start with a slash, in which case it is treated as a file that contains
37264 the private key.
37265 .next
37266 be "0", "false" or the empty string, in which case the message will not
37267 be signed. This case will not result in an error, even if &%dkim_strict%&
37268 is set.
37269 .endlist
37270
37271 .option dkim_canon smtp string&!! unset
37272 OPTIONAL:
37273 This option sets the canonicalization method used when signing a message.
37274 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37275 The option defaults to "relaxed" when unset. Note: the current implementation
37276 only supports using the same canonicalization method for both headers and body.
37277
37278 .option dkim_strict smtp string&!! unset
37279 OPTIONAL:
37280 This  option  defines  how  Exim  behaves  when  signing a message that
37281 should be signed fails for some reason.  When the expansion evaluates to
37282 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37283 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37284 variables here.
37285
37286 .option dkim_sign_headers smtp string&!! unset
37287 OPTIONAL:
37288 When set, this option must expand to (or be specified as) a colon-separated
37289 list of header names. Headers with these names will be included in the message
37290 signature. When unspecified, the header names recommended in RFC4871 will be
37291 used.
37292
37293
37294 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37295 .cindex "DKIM" "verification"
37296
37297 Verification of DKIM signatures in incoming email is implemented via the
37298 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37299 syntactically(!) correct signature in the incoming message.
37300 A missing ACL definition defaults to accept.
37301 If any ACL call does not acccept, the message is not accepted.
37302 If a cutthrough delivery was in progress for the message it is
37303 summarily dropped (having wasted the transmission effort).
37304
37305 To evaluate the signature in the ACL a large number of expansion variables
37306 containing the signature status and its details are set up during the
37307 runtime of the ACL.
37308
37309 Calling the ACL only for existing signatures is not sufficient to build
37310 more advanced policies. For that reason, the global option
37311 &%dkim_verify_signers%&, and a global expansion variable
37312 &%$dkim_signers%& exist.
37313
37314 The global option &%dkim_verify_signers%& can be set to a colon-separated
37315 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37316 called. It is expanded when the message has been received. At this point,
37317 the expansion variable &%$dkim_signers%& already contains a colon-separated
37318 list of signer domains and identities for the message. When
37319 &%dkim_verify_signers%& is not specified in the main configuration,
37320 it defaults as:
37321 .code
37322 dkim_verify_signers = $dkim_signers
37323 .endd
37324 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37325 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37326 call the ACL for known domains or identities. This would be achieved as follows:
37327 .code
37328 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37329 .endd
37330 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37331 and "ebay.com", plus all domains and identities that have signatures in the message.
37332 You can also be more creative in constructing your policy. For example:
37333 .code
37334 dkim_verify_signers = $sender_address_domain:$dkim_signers
37335 .endd
37336
37337 If a domain or identity is listed several times in the (expanded) value of
37338 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37339
37340
37341 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37342 available (from most to least important):
37343
37344
37345 .vlist
37346 .vitem &%$dkim_cur_signer%&
37347 The signer that is being evaluated in this ACL run. This can be a domain or
37348 an identity. This is one of the list items from the expanded main option
37349 &%dkim_verify_signers%& (see above).
37350 .vitem &%$dkim_verify_status%&
37351 A string describing the general status of the signature. One of
37352 .ilist
37353 &%none%&: There is no signature in the message for the current domain or
37354 identity (as reflected by &%$dkim_cur_signer%&).
37355 .next
37356 &%invalid%&: The signature could not be verified due to a processing error.
37357 More detail is available in &%$dkim_verify_reason%&.
37358 .next
37359 &%fail%&: Verification of the signature failed.  More detail is
37360 available in &%$dkim_verify_reason%&.
37361 .next
37362 &%pass%&: The signature passed verification. It is valid.
37363 .endlist
37364 .vitem &%$dkim_verify_reason%&
37365 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37366 "fail" or "invalid". One of
37367 .ilist
37368 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37369 key for the domain could not be retrieved. This may be a temporary problem.
37370 .next
37371 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37372 record for the domain is syntactically invalid.
37373 .next
37374 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37375 body hash does not match the one specified in the signature header. This
37376 means that the message body was modified in transit.
37377 .next
37378 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37379 could not be verified. This may mean that headers were modified,
37380 re-written or otherwise changed in a way which is incompatible with
37381 DKIM verification. It may of course also mean that the signature is forged.
37382 .endlist
37383 .vitem &%$dkim_domain%&
37384 The signing domain. IMPORTANT: This variable is only populated if there is
37385 an actual signature in the message for the current domain or identity (as
37386 reflected by &%$dkim_cur_signer%&).
37387 .vitem &%$dkim_identity%&
37388 The signing identity, if present. IMPORTANT: This variable is only populated
37389 if there is an actual signature in the message for the current domain or
37390 identity (as reflected by &%$dkim_cur_signer%&).
37391 .vitem &%$dkim_selector%&
37392 The key record selector string.
37393 .vitem &%$dkim_algo%&
37394 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37395 .vitem &%$dkim_canon_body%&
37396 The body canonicalization method. One of 'relaxed' or 'simple'.
37397 .vitem &%dkim_canon_headers%&
37398 The header canonicalization method. One of 'relaxed' or 'simple'.
37399 .vitem &%$dkim_copiedheaders%&
37400 A transcript of headers and their values which are included in the signature
37401 (copied from the 'z=' tag of the signature).
37402 .vitem &%$dkim_bodylength%&
37403 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37404 limit was set by the signer, "9999999999999" is returned. This makes sure
37405 that this variable always expands to an integer value.
37406 .vitem &%$dkim_created%&
37407 UNIX timestamp reflecting the date and time when the signature was created.
37408 When this was not specified by the signer, "0" is returned.
37409 .vitem &%$dkim_expires%&
37410 UNIX timestamp reflecting the date and time when the signer wants the
37411 signature to be treated as "expired". When this was not specified by the
37412 signer, "9999999999999" is returned. This makes it possible to do useful
37413 integer size comparisons against this value.
37414 .vitem &%$dkim_headernames%&
37415 A colon-separated list of names of headers included in the signature.
37416 .vitem &%$dkim_key_testing%&
37417 "1" if the key record has the "testing" flag set, "0" if not.
37418 .vitem &%$dkim_key_nosubdomains%&
37419 "1" if the key record forbids subdomaining, "0" otherwise.
37420 .vitem &%$dkim_key_srvtype%&
37421 Service type (tag s=) from the key record. Defaults to "*" if not specified
37422 in the key record.
37423 .vitem &%$dkim_key_granularity%&
37424 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37425 in the key record.
37426 .vitem &%$dkim_key_notes%&
37427 Notes from the key record (tag n=).
37428 .endlist
37429
37430 In addition, two ACL conditions are provided:
37431
37432 .vlist
37433 .vitem &%dkim_signers%&
37434 ACL condition that checks a colon-separated list of domains or identities
37435 for a match against the domain or identity that the ACL is currently verifying
37436 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37437 verb to a group of domains or identities. For example:
37438
37439 .code
37440 # Warn when Mail purportedly from GMail has no signature at all
37441 warn log_message = GMail sender without DKIM signature
37442      sender_domains = gmail.com
37443      dkim_signers = gmail.com
37444      dkim_status = none
37445 .endd
37446
37447 .vitem &%dkim_status%&
37448 ACL condition that checks a colon-separated list of possible DKIM verification
37449 results against the actual result of verification. This is typically used
37450 to restrict an ACL verb to a list of verification outcomes, for example:
37451
37452 .code
37453 deny message = Mail from Paypal with invalid/missing signature
37454      sender_domains = paypal.com:paypal.de
37455      dkim_signers = paypal.com:paypal.de
37456      dkim_status = none:invalid:fail
37457 .endd
37458
37459 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37460 see the documentation of the &%$dkim_verify_status%& expansion variable above
37461 for more information of what they mean.
37462 .endlist
37463
37464 . ////////////////////////////////////////////////////////////////////////////
37465 . ////////////////////////////////////////////////////////////////////////////
37466
37467 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37468          "Adding drivers or lookups"
37469 .cindex "adding drivers"
37470 .cindex "new drivers, adding"
37471 .cindex "drivers" "adding new"
37472 The following actions have to be taken in order to add a new router, transport,
37473 authenticator, or lookup type to Exim:
37474
37475 .olist
37476 Choose a name for the driver or lookup type that does not conflict with any
37477 existing name; I will use &"newdriver"& in what follows.
37478 .next
37479 Add to &_src/EDITME_& the line:
37480 .display
37481 <&'type'&>&`_NEWDRIVER=yes`&
37482 .endd
37483 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37484 code is not to be included in the binary by default, comment this line out. You
37485 should also add any relevant comments about the driver or lookup type.
37486 .next
37487 Add to &_src/config.h.defaults_& the line:
37488 .code
37489 #define <type>_NEWDRIVER
37490 .endd
37491 .next
37492 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37493 and create a table entry as is done for all the other drivers and lookup types.
37494 .next
37495 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37496 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37497 Add your &`NEWDRIVER`& to that list.
37498 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37499 simple form that most lookups have.
37500 .next
37501 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37502 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37503 driver or lookup type and add it to the definition of OBJ.
37504 .next
37505 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37506 &_src_&.
37507 .next
37508 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37509 as for other drivers and lookups.
37510 .endlist
37511
37512 Then all you need to do is write the code! A good way to start is to make a
37513 proforma by copying an existing module of the same type, globally changing all
37514 occurrences of the name, and cutting out most of the code. Note that any
37515 options you create must be listed in alphabetical order, because the tables are
37516 searched using a binary chop procedure.
37517
37518 There is a &_README_& file in each of the sub-directories of &_src_& describing
37519 the interface that is expected.
37520
37521
37522
37523
37524 . ////////////////////////////////////////////////////////////////////////////
37525 . ////////////////////////////////////////////////////////////////////////////
37526
37527 . /////////////////////////////////////////////////////////////////////////////
37528 . These lines are processing instructions for the Simple DocBook Processor that
37529 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37530 . PDFs than using xmlto and fop. They will be ignored by all other XML
37531 . processors.
37532 . /////////////////////////////////////////////////////////////////////////////
37533
37534 .literal xml
37535 <?sdop
37536   format="newpage"
37537   foot_right_recto="&chaptertitle;"
37538   foot_right_verso="&chaptertitle;"
37539 ?>
37540 .literal off
37541
37542 .makeindex "Options index"   "option"
37543 .makeindex "Variables index" "variable"
37544 .makeindex "Concept index"   "concept"
37545
37546
37547 . /////////////////////////////////////////////////////////////////////////////
37548 . /////////////////////////////////////////////////////////////////////////////