Apply timeout consistently to all malware scanner types
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.84"
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 .vitem &%-MCD%&
3815 .oindex "&%-MCD%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option. It signifies that the
3818 remote host supports the ESMTP &_DSN_& extension.
3819
3820 .vitem &%-MCP%&
3821 .oindex "&%-MCP%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3824 which Exim is connected supports pipelining.
3825
3826 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3827 .oindex "&%-MCQ%&"
3828 This option is not intended for use by external callers. It is used internally
3829 by Exim in conjunction with the &%-MC%& option when the original delivery was
3830 started by a queue runner. It passes on the process id of the queue runner,
3831 together with the file descriptor number of an open pipe. Closure of the pipe
3832 signals the final completion of the sequence of processes that are passing
3833 messages through the same SMTP connection.
3834
3835 .vitem &%-MCS%&
3836 .oindex "&%-MCS%&"
3837 This option is not intended for use by external callers. It is used internally
3838 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3839 SMTP SIZE option should be used on messages delivered down the existing
3840 connection.
3841
3842 .vitem &%-MCT%&
3843 .oindex "&%-MCT%&"
3844 This option is not intended for use by external callers. It is used internally
3845 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3846 host to which Exim is connected supports TLS encryption.
3847
3848 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3849 .oindex "&%-Mc%&"
3850 .cindex "hints database" "not overridden by &%-Mc%&"
3851 .cindex "delivery" "manually started &-- not forced"
3852 This option requests Exim to run a delivery attempt on each message in turn,
3853 but unlike the &%-M%& option, it does check for retry hints, and respects any
3854 that are found. This option is not very useful to external callers. It is
3855 provided mainly for internal use by Exim when it needs to re-invoke itself in
3856 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3857 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3858 respects retry times and other options such as &%hold_domains%& that are
3859 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3860 If you want to run a specific delivery as if in a queue run, you should use
3861 &%-q%& with a message id argument. A distinction between queue run deliveries
3862 and other deliveries is made in one or two places.
3863
3864 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3865 .oindex "&%-Mes%&"
3866 .cindex "message" "changing sender"
3867 .cindex "sender" "changing"
3868 This option requests Exim to change the sender address in the message to the
3869 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3870 &"edit sender"&). There must be exactly two arguments. The first argument must
3871 be a message id, and the second one an email address. However, if the message
3872 is active (in the middle of a delivery attempt), its status is not altered.
3873 This option can be used only by an admin user.
3874
3875 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3876 .oindex "&%-Mf%&"
3877 .cindex "freezing messages"
3878 .cindex "message" "manually freezing"
3879 This option requests Exim to mark each listed message as &"frozen"&. This
3880 prevents any delivery attempts taking place until the message is &"thawed"&,
3881 either manually or as a result of the &%auto_thaw%& configuration option.
3882 However, if any of the messages are active (in the middle of a delivery
3883 attempt), their status is not altered. This option can be used only by an admin
3884 user.
3885
3886 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3887 .oindex "&%-Mg%&"
3888 .cindex "giving up on messages"
3889 .cindex "message" "abandoning delivery attempts"
3890 .cindex "delivery" "abandoning further attempts"
3891 This option requests Exim to give up trying to deliver the listed messages,
3892 including any that are frozen. However, if any of the messages are active,
3893 their status is not altered. For non-bounce messages, a delivery error message
3894 is sent to the sender, containing the text &"cancelled by administrator"&.
3895 Bounce messages are just discarded. This option can be used only by an admin
3896 user.
3897
3898 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3899 .oindex "&%-Mmad%&"
3900 .cindex "delivery" "cancelling all"
3901 This option requests Exim to mark all the recipient addresses in the messages
3902 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3903 message is active (in the middle of a delivery attempt), its status is not
3904 altered. This option can be used only by an admin user.
3905
3906 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3907 .oindex "&%-Mmd%&"
3908 .cindex "delivery" "cancelling by address"
3909 .cindex "recipient" "removing"
3910 .cindex "removing recipients"
3911 This option requests Exim to mark the given addresses as already delivered
3912 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3913 the remaining ones must be email addresses. These are matched to recipient
3914 addresses in the message in a case-sensitive manner. If the message is active
3915 (in the middle of a delivery attempt), its status is not altered. This option
3916 can be used only by an admin user.
3917
3918 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3919 .oindex "&%-Mrm%&"
3920 .cindex "removing messages"
3921 .cindex "abandoning mail"
3922 .cindex "message" "manually discarding"
3923 This option requests Exim to remove the given messages from the queue. No
3924 bounce messages are sent; each message is simply forgotten. However, if any of
3925 the messages are active, their status is not altered. This option can be used
3926 only by an admin user or by the user who originally caused the message to be
3927 placed on the queue.
3928
3929 .vitem &%-Mset%&&~<&'message&~id'&>
3930 .oindex "&%-Mset%&
3931 .cindex "testing" "string expansion"
3932 .cindex "expansion" "testing"
3933 This option is useful only in conjunction with &%-be%& (that is, when testing
3934 string expansions). Exim loads the given message from its spool before doing
3935 the test expansions, thus setting message-specific variables such as
3936 &$message_size$& and the header variables. The &$recipients$& variable is made
3937 available. This feature is provided to make it easier to test expansions that
3938 make use of these variables. However, this option can be used only by an admin
3939 user. See also &%-bem%&.
3940
3941 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3942 .oindex "&%-Mt%&"
3943 .cindex "thawing messages"
3944 .cindex "unfreezing messages"
3945 .cindex "frozen messages" "thawing"
3946 .cindex "message" "thawing frozen"
3947 This option requests Exim to &"thaw"& any of the listed messages that are
3948 &"frozen"&, so that delivery attempts can resume. However, if any of the
3949 messages are active, their status is not altered. This option can be used only
3950 by an admin user.
3951
3952 .vitem &%-Mvb%&&~<&'message&~id'&>
3953 .oindex "&%-Mvb%&"
3954 .cindex "listing" "message body"
3955 .cindex "message" "listing body of"
3956 This option causes the contents of the message body (-D) spool file to be
3957 written to the standard output. This option can be used only by an admin user.
3958
3959 .vitem &%-Mvc%&&~<&'message&~id'&>
3960 .oindex "&%-Mvc%&"
3961 .cindex "message" "listing in RFC 2822 format"
3962 .cindex "listing" "message in RFC 2822 format"
3963 This option causes a copy of the complete message (header lines plus body) to
3964 be written to the standard output in RFC 2822 format. This option can be used
3965 only by an admin user.
3966
3967 .vitem &%-Mvh%&&~<&'message&~id'&>
3968 .oindex "&%-Mvh%&"
3969 .cindex "listing" "message headers"
3970 .cindex "header lines" "listing"
3971 .cindex "message" "listing header lines"
3972 This option causes the contents of the message headers (-H) spool file to be
3973 written to the standard output. This option can be used only by an admin user.
3974
3975 .vitem &%-Mvl%&&~<&'message&~id'&>
3976 .oindex "&%-Mvl%&"
3977 .cindex "listing" "message log"
3978 .cindex "message" "listing message log"
3979 This option causes the contents of the message log spool file to be written to
3980 the standard output. This option can be used only by an admin user.
3981
3982 .vitem &%-m%&
3983 .oindex "&%-m%&"
3984 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3985 treats it that way too.
3986
3987 .vitem &%-N%&
3988 .oindex "&%-N%&"
3989 .cindex "debugging" "&%-N%& option"
3990 .cindex "debugging" "suppressing delivery"
3991 This is a debugging option that inhibits delivery of a message at the transport
3992 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3993 it just doesn't actually transport the message, but instead behaves as if it
3994 had successfully done so. However, it does not make any updates to the retry
3995 database, and the log entries for deliveries are flagged with &"*>"& rather
3996 than &"=>"&.
3997
3998 Because &%-N%& discards any message to which it applies, only root or the Exim
3999 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4000 words, an ordinary user can use it only when supplying an incoming message to
4001 which it will apply. Although transportation never fails when &%-N%& is set, an
4002 address may be deferred because of a configuration problem on a transport, or a
4003 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4004 the message, and applies to any subsequent delivery attempts that may happen
4005 for that message.
4006
4007 .vitem &%-n%&
4008 .oindex "&%-n%&"
4009 This option is interpreted by Sendmail to mean &"no aliasing"&.
4010 For normal modes of operation, it is ignored by Exim.
4011 When combined with &%-bP%& it suppresses the name of an option from being output.
4012
4013 .vitem &%-O%&&~<&'data'&>
4014 .oindex "&%-O%&"
4015 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4016 Exim.
4017
4018 .vitem &%-oA%&&~<&'file&~name'&>
4019 .oindex "&%-oA%&"
4020 .cindex "Sendmail compatibility" "&%-oA%& option"
4021 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4022 alternative alias file name. Exim handles &%-bi%& differently; see the
4023 description above.
4024
4025 .vitem &%-oB%&&~<&'n'&>
4026 .oindex "&%-oB%&"
4027 .cindex "SMTP" "passed connection"
4028 .cindex "SMTP" "multiple deliveries"
4029 .cindex "multiple SMTP deliveries"
4030 This is a debugging option which limits the maximum number of messages that can
4031 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4032 transport. If <&'n'&> is omitted, the limit is set to 1.
4033
4034 .vitem &%-odb%&
4035 .oindex "&%-odb%&"
4036 .cindex "background delivery"
4037 .cindex "delivery" "in the background"
4038 This option applies to all modes in which Exim accepts incoming messages,
4039 including the listening daemon. It requests &"background"& delivery of such
4040 messages, which means that the accepting process automatically starts a
4041 delivery process for each message received, but does not wait for the delivery
4042 processes to finish.
4043
4044 When all the messages have been received, the reception process exits,
4045 leaving the delivery processes to finish in their own time. The standard output
4046 and error streams are closed at the start of each delivery process.
4047 This is the default action if none of the &%-od%& options are present.
4048
4049 If one of the queueing options in the configuration file
4050 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4051 overrides it if &%queue_only_override%& is set true, which is the default
4052 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4053
4054 .vitem &%-odf%&
4055 .oindex "&%-odf%&"
4056 .cindex "foreground delivery"
4057 .cindex "delivery" "in the foreground"
4058 This option requests &"foreground"& (synchronous) delivery when Exim has
4059 accepted a locally-generated message. (For the daemon it is exactly the same as
4060 &%-odb%&.) A delivery process is automatically started to deliver the message,
4061 and Exim waits for it to complete before proceeding.
4062
4063 The original Exim reception process does not finish until the delivery
4064 process for the final message has ended. The standard error stream is left open
4065 during deliveries.
4066
4067 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4068 false and one of the queueing options in the configuration file is in effect.
4069
4070 If there is a temporary delivery error during foreground delivery, the
4071 message is left on the queue for later delivery, and the original reception
4072 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4073 restricted configuration that never queues messages.
4074
4075
4076 .vitem &%-odi%&
4077 .oindex "&%-odi%&"
4078 This option is synonymous with &%-odf%&. It is provided for compatibility with
4079 Sendmail.
4080
4081 .vitem &%-odq%&
4082 .oindex "&%-odq%&"
4083 .cindex "non-immediate delivery"
4084 .cindex "delivery" "suppressing immediate"
4085 .cindex "queueing incoming messages"
4086 This option applies to all modes in which Exim accepts incoming messages,
4087 including the listening daemon. It specifies that the accepting process should
4088 not automatically start a delivery process for each message received. Messages
4089 are placed on the queue, and remain there until a subsequent queue runner
4090 process encounters them. There are several configuration options (such as
4091 &%queue_only%&) that can be used to queue incoming messages under certain
4092 conditions. This option overrides all of them and also &%-odqs%&. It always
4093 forces queueing.
4094
4095 .vitem &%-odqs%&
4096 .oindex "&%-odqs%&"
4097 .cindex "SMTP" "delaying delivery"
4098 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4099 However, like &%-odb%& and &%-odi%&, this option has no effect if
4100 &%queue_only_override%& is false and one of the queueing options in the
4101 configuration file is in effect.
4102
4103 When &%-odqs%& does operate, a delivery process is started for each incoming
4104 message, in the background by default, but in the foreground if &%-odi%& is
4105 also present. The recipient addresses are routed, and local deliveries are done
4106 in the normal way. However, if any SMTP deliveries are required, they are not
4107 done at this time, so the message remains on the queue until a subsequent queue
4108 runner process encounters it. Because routing was done, Exim knows which
4109 messages are waiting for which hosts, and so a number of messages for the same
4110 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4111 configuration option has the same effect for specific domains. See also the
4112 &%-qq%& option.
4113
4114 .vitem &%-oee%&
4115 .oindex "&%-oee%&"
4116 .cindex "error" "reporting"
4117 If an error is detected while a non-SMTP message is being received (for
4118 example, a malformed address), the error is reported to the sender in a mail
4119 message.
4120
4121 .cindex "return code" "for &%-oee%&"
4122 Provided
4123 this error message is successfully sent, the Exim receiving process
4124 exits with a return code of zero. If not, the return code is 2 if the problem
4125 is that the original message has no recipients, or 1 for any other error.
4126 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4127
4128 .vitem &%-oem%&
4129 .oindex "&%-oem%&"
4130 .cindex "error" "reporting"
4131 .cindex "return code" "for &%-oem%&"
4132 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4133 return code, whether or not the error message was successfully sent.
4134 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4135
4136 .vitem &%-oep%&
4137 .oindex "&%-oep%&"
4138 .cindex "error" "reporting"
4139 If an error is detected while a non-SMTP message is being received, the
4140 error is reported by writing a message to the standard error file (stderr).
4141 .cindex "return code" "for &%-oep%&"
4142 The return code is 1 for all errors.
4143
4144 .vitem &%-oeq%&
4145 .oindex "&%-oeq%&"
4146 .cindex "error" "reporting"
4147 This option is supported for compatibility with Sendmail, but has the same
4148 effect as &%-oep%&.
4149
4150 .vitem &%-oew%&
4151 .oindex "&%-oew%&"
4152 .cindex "error" "reporting"
4153 This option is supported for compatibility with Sendmail, but has the same
4154 effect as &%-oem%&.
4155
4156 .vitem &%-oi%&
4157 .oindex "&%-oi%&"
4158 .cindex "dot" "in incoming non-SMTP message"
4159 This option, which has the same effect as &%-i%&, specifies that a dot on a
4160 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4161 single dot does terminate, though Exim does no special processing for other
4162 lines that start with a dot. This option is set by default if Exim is called as
4163 &'rmail'&. See also &%-ti%&.
4164
4165 .vitem &%-oitrue%&
4166 .oindex "&%-oitrue%&"
4167 This option is treated as synonymous with &%-oi%&.
4168
4169 .vitem &%-oMa%&&~<&'host&~address'&>
4170 .oindex "&%-oMa%&"
4171 .cindex "sender" "host address, specifying for local message"
4172 A number of options starting with &%-oM%& can be used to set values associated
4173 with remote hosts on locally-submitted messages (that is, messages not received
4174 over TCP/IP). These options can be used by any caller in conjunction with the
4175 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4176 other circumstances, they are ignored unless the caller is trusted.
4177
4178 The &%-oMa%& option sets the sender host address. This may include a port
4179 number at the end, after a full stop (period). For example:
4180 .code
4181 exim -bs -oMa 10.9.8.7.1234
4182 .endd
4183 An alternative syntax is to enclose the IP address in square brackets,
4184 followed by a colon and the port number:
4185 .code
4186 exim -bs -oMa [10.9.8.7]:1234
4187 .endd
4188 The IP address is placed in the &$sender_host_address$& variable, and the
4189 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4190 are present on the command line, the sender host IP address is taken from
4191 whichever one is last.
4192
4193 .vitem &%-oMaa%&&~<&'name'&>
4194 .oindex "&%-oMaa%&"
4195 .cindex "authentication" "name, specifying for local message"
4196 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4197 option sets the value of &$sender_host_authenticated$& (the authenticator
4198 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4199 This option can be used with &%-bh%& and &%-bs%& to set up an
4200 authenticated SMTP session without actually using the SMTP AUTH command.
4201
4202 .vitem &%-oMai%&&~<&'string'&>
4203 .oindex "&%-oMai%&"
4204 .cindex "authentication" "id, specifying for local message"
4205 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4206 option sets the value of &$authenticated_id$& (the id that was authenticated).
4207 This overrides the default value (the caller's login id, except with &%-bh%&,
4208 where there is no default) for messages from local sources. See chapter
4209 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4210
4211 .vitem &%-oMas%&&~<&'address'&>
4212 .oindex "&%-oMas%&"
4213 .cindex "authentication" "sender, specifying for local message"
4214 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4215 option sets the authenticated sender value in &$authenticated_sender$&. It
4216 overrides the sender address that is created from the caller's login id for
4217 messages from local sources, except when &%-bh%& is used, when there is no
4218 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4219 specified on a MAIL command overrides this value. See chapter
4220 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4221
4222 .vitem &%-oMi%&&~<&'interface&~address'&>
4223 .oindex "&%-oMi%&"
4224 .cindex "interface" "address, specifying for local message"
4225 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4226 option sets the IP interface address value. A port number may be included,
4227 using the same syntax as for &%-oMa%&. The interface address is placed in
4228 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4229
4230 .vitem &%-oMm%&&~<&'message&~reference'&>
4231 .oindex "&%-oMm%&"
4232 .cindex "message reference" "message reference, specifying for local message"
4233 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4234 option sets the message reference, e.g. message-id, and is logged during
4235 delivery. This is useful when some kind of audit trail is required to tie
4236 messages together. The format of the message reference is checked and will
4237 abort if the format is invalid. The option will only be accepted if exim is
4238 running in trusted mode, not as any regular user.
4239
4240 The best example of a message reference is when Exim sends a bounce message.
4241 The message reference is the message-id of the original message for which Exim
4242 is sending the bounce.
4243
4244 .vitem &%-oMr%&&~<&'protocol&~name'&>
4245 .oindex "&%-oMr%&"
4246 .cindex "protocol, specifying for local message"
4247 .vindex "&$received_protocol$&"
4248 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4249 option sets the received protocol value that is stored in
4250 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4251 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4252 SMTP protocol names (see the description of &$received_protocol$& in section
4253 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4254 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4255 be set by &%-oMr%&.
4256
4257 .vitem &%-oMs%&&~<&'host&~name'&>
4258 .oindex "&%-oMs%&"
4259 .cindex "sender" "host name, specifying for local message"
4260 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4261 option sets the sender host name in &$sender_host_name$&. When this option is
4262 present, Exim does not attempt to look up a host name from an IP address; it
4263 uses the name it is given.
4264
4265 .vitem &%-oMt%&&~<&'ident&~string'&>
4266 .oindex "&%-oMt%&"
4267 .cindex "sender" "ident string, specifying for local message"
4268 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4269 option sets the sender ident value in &$sender_ident$&. The default setting for
4270 local callers is the login id of the calling process, except when &%-bh%& is
4271 used, when there is no default.
4272
4273 .vitem &%-om%&
4274 .oindex "&%-om%&"
4275 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4276 In Sendmail, this option means &"me too"&, indicating that the sender of a
4277 message should receive a copy of the message if the sender appears in an alias
4278 expansion. Exim always does this, so the option does nothing.
4279
4280 .vitem &%-oo%&
4281 .oindex "&%-oo%&"
4282 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4283 This option is ignored. In Sendmail it specifies &"old style headers"&,
4284 whatever that means.
4285
4286 .vitem &%-oP%&&~<&'path'&>
4287 .oindex "&%-oP%&"
4288 .cindex "pid (process id)" "of daemon"
4289 .cindex "daemon" "process id (pid)"
4290 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4291 value. The option specifies the file to which the process id of the daemon is
4292 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4293 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4294 because in those cases, the normal pid file is not used.
4295
4296 .vitem &%-or%&&~<&'time'&>
4297 .oindex "&%-or%&"
4298 .cindex "timeout" "for non-SMTP input"
4299 This option sets a timeout value for incoming non-SMTP messages. If it is not
4300 set, Exim will wait forever for the standard input. The value can also be set
4301 by the &%receive_timeout%& option. The format used for specifying times is
4302 described in section &<<SECTtimeformat>>&.
4303
4304 .vitem &%-os%&&~<&'time'&>
4305 .oindex "&%-os%&"
4306 .cindex "timeout" "for SMTP input"
4307 .cindex "SMTP" "input timeout"
4308 This option sets a timeout value for incoming SMTP messages. The timeout
4309 applies to each SMTP command and block of data. The value can also be set by
4310 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4311 for specifying times is described in section &<<SECTtimeformat>>&.
4312
4313 .vitem &%-ov%&
4314 .oindex "&%-ov%&"
4315 This option has exactly the same effect as &%-v%&.
4316
4317 .vitem &%-oX%&&~<&'number&~or&~string'&>
4318 .oindex "&%-oX%&"
4319 .cindex "TCP/IP" "setting listening ports"
4320 .cindex "TCP/IP" "setting listening interfaces"
4321 .cindex "port" "receiving TCP/IP"
4322 This option is relevant only when the &%-bd%& (start listening daemon) option
4323 is also given. It controls which ports and interfaces the daemon uses. Details
4324 of the syntax, and how it interacts with configuration file options, are given
4325 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4326 file is written unless &%-oP%& is also present to specify a pid file name.
4327
4328 .vitem &%-pd%&
4329 .oindex "&%-pd%&"
4330 .cindex "Perl" "starting the interpreter"
4331 This option applies when an embedded Perl interpreter is linked with Exim (see
4332 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4333 option, forcing the starting of the interpreter to be delayed until it is
4334 needed.
4335
4336 .vitem &%-ps%&
4337 .oindex "&%-ps%&"
4338 .cindex "Perl" "starting the interpreter"
4339 This option applies when an embedded Perl interpreter is linked with Exim (see
4340 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4341 option, forcing the starting of the interpreter to occur as soon as Exim is
4342 started.
4343
4344 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4345 .oindex "&%-p%&"
4346 For compatibility with Sendmail, this option is equivalent to
4347 .display
4348 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4349 .endd
4350 It sets the incoming protocol and host name (for trusted callers). The
4351 host name and its colon can be omitted when only the protocol is to be set.
4352 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4353 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4354 or &`s`& using this option (but that does not seem a real limitation).
4355
4356 .vitem &%-q%&
4357 .oindex "&%-q%&"
4358 .cindex "queue runner" "starting manually"
4359 This option is normally restricted to admin users. However, there is a
4360 configuration option called &%prod_requires_admin%& which can be set false to
4361 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4362 and &%-S%& options).
4363
4364 .cindex "queue runner" "description of operation"
4365 The &%-q%& option starts one queue runner process. This scans the queue of
4366 waiting messages, and runs a delivery process for each one in turn. It waits
4367 for each delivery process to finish before starting the next one. A delivery
4368 process may not actually do any deliveries if the retry times for the addresses
4369 have not been reached. Use &%-qf%& (see below) if you want to override this.
4370
4371 If
4372 .cindex "SMTP" "passed connection"
4373 .cindex "SMTP" "multiple deliveries"
4374 .cindex "multiple SMTP deliveries"
4375 the delivery process spawns other processes to deliver other messages down
4376 passed SMTP connections, the queue runner waits for these to finish before
4377 proceeding.
4378
4379 When all the queued messages have been considered, the original queue runner
4380 process terminates. In other words, a single pass is made over the waiting
4381 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4382 this to be repeated periodically.
4383
4384 Exim processes the waiting messages in an unpredictable order. It isn't very
4385 random, but it is likely to be different each time, which is all that matters.
4386 If one particular message screws up a remote MTA, other messages to the same
4387 MTA have a chance of getting through if they get tried first.
4388
4389 It is possible to cause the messages to be processed in lexical message id
4390 order, which is essentially the order in which they arrived, by setting the
4391 &%queue_run_in_order%& option, but this is not recommended for normal use.
4392
4393 .vitem &%-q%&<&'qflags'&>
4394 The &%-q%& option may be followed by one or more flag letters that change its
4395 behaviour. They are all optional, but if more than one is present, they must
4396 appear in the correct order. Each flag is described in a separate item below.
4397
4398 .vitem &%-qq...%&
4399 .oindex "&%-qq%&"
4400 .cindex "queue" "double scanning"
4401 .cindex "queue" "routing"
4402 .cindex "routing" "whole queue before delivery"
4403 An option starting with &%-qq%& requests a two-stage queue run. In the first
4404 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4405 every domain. Addresses are routed, local deliveries happen, but no remote
4406 transports are run.
4407
4408 .cindex "hints database" "remembering routing"
4409 The hints database that remembers which messages are waiting for specific hosts
4410 is updated, as if delivery to those hosts had been deferred. After this is
4411 complete, a second, normal queue scan happens, with routing and delivery taking
4412 place as normal. Messages that are routed to the same host should mostly be
4413 delivered down a single SMTP
4414 .cindex "SMTP" "passed connection"
4415 .cindex "SMTP" "multiple deliveries"
4416 .cindex "multiple SMTP deliveries"
4417 connection because of the hints that were set up during the first queue scan.
4418 This option may be useful for hosts that are connected to the Internet
4419 intermittently.
4420
4421 .vitem &%-q[q]i...%&
4422 .oindex "&%-qi%&"
4423 .cindex "queue" "initial delivery"
4424 If the &'i'& flag is present, the queue runner runs delivery processes only for
4425 those messages that haven't previously been tried. (&'i'& stands for &"initial
4426 delivery"&.) This can be helpful if you are putting messages on the queue using
4427 &%-odq%& and want a queue runner just to process the new messages.
4428
4429 .vitem &%-q[q][i]f...%&
4430 .oindex "&%-qf%&"
4431 .cindex "queue" "forcing delivery"
4432 .cindex "delivery" "forcing in queue run"
4433 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4434 message, whereas without &'f'& only those non-frozen addresses that have passed
4435 their retry times are tried.
4436
4437 .vitem &%-q[q][i]ff...%&
4438 .oindex "&%-qff%&"
4439 .cindex "frozen messages" "forcing delivery"
4440 If &'ff'& is present, a delivery attempt is forced for every message, whether
4441 frozen or not.
4442
4443 .vitem &%-q[q][i][f[f]]l%&
4444 .oindex "&%-ql%&"
4445 .cindex "queue" "local deliveries only"
4446 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4447 be done. If a message requires any remote deliveries, it remains on the queue
4448 for later delivery.
4449
4450 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4451 .cindex "queue" "delivering specific messages"
4452 When scanning the queue, Exim can be made to skip over messages whose ids are
4453 lexically less than a given value by following the &%-q%& option with a
4454 starting message id. For example:
4455 .code
4456 exim -q 0t5C6f-0000c8-00
4457 .endd
4458 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4459 second message id is given, messages whose ids are lexically greater than it
4460 are also skipped. If the same id is given twice, for example,
4461 .code
4462 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4463 .endd
4464 just one delivery process is started, for that message. This differs from
4465 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4466 that it counts as a delivery from a queue run. Note that the selection
4467 mechanism does not affect the order in which the messages are scanned. There
4468 are also other ways of selecting specific sets of messages for delivery in a
4469 queue run &-- see &%-R%& and &%-S%&.
4470
4471 .vitem &%-q%&<&'qflags'&><&'time'&>
4472 .cindex "queue runner" "starting periodically"
4473 .cindex "periodic queue running"
4474 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4475 starting a queue runner process at intervals specified by the given time value
4476 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4477 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4478 single daemon process handles both functions. A common way of starting up a
4479 combined daemon at system boot time is to use a command such as
4480 .code
4481 /usr/exim/bin/exim -bd -q30m
4482 .endd
4483 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4484 process every 30 minutes.
4485
4486 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4487 pid file is written unless one is explicitly requested by the &%-oP%& option.
4488
4489 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4490 .oindex "&%-qR%&"
4491 This option is synonymous with &%-R%&. It is provided for Sendmail
4492 compatibility.
4493
4494 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4495 .oindex "&%-qS%&"
4496 This option is synonymous with &%-S%&.
4497
4498 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4499 .oindex "&%-R%&"
4500 .cindex "queue runner" "for specific recipients"
4501 .cindex "delivery" "to given domain"
4502 .cindex "domain" "delivery to"
4503 The <&'rsflags'&> may be empty, in which case the white space before the string
4504 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4505 which are the possible values for <&'rsflags'&>. White space is required if
4506 <&'rsflags'&> is not empty.
4507
4508 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4509 perform a single queue run, except that, when scanning the messages on the
4510 queue, Exim processes only those that have at least one undelivered recipient
4511 address containing the given string, which is checked in a case-independent
4512 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4513 regular expression; otherwise it is a literal string.
4514
4515 If you want to do periodic queue runs for messages with specific recipients,
4516 you can combine &%-R%& with &%-q%& and a time value. For example:
4517 .code
4518 exim -q25m -R @special.domain.example
4519 .endd
4520 This example does a queue run for messages with recipients in the given domain
4521 every 25 minutes. Any additional flags that are specified with &%-q%& are
4522 applied to each queue run.
4523
4524 Once a message is selected for delivery by this mechanism, all its addresses
4525 are processed. For the first selected message, Exim overrides any retry
4526 information and forces a delivery attempt for each undelivered address. This
4527 means that if delivery of any address in the first message is successful, any
4528 existing retry information is deleted, and so delivery attempts for that
4529 address in subsequently selected messages (which are processed without forcing)
4530 will run. However, if delivery of any address does not succeed, the retry
4531 information is updated, and in subsequently selected messages, the failing
4532 address will be skipped.
4533
4534 .cindex "frozen messages" "forcing delivery"
4535 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4536 all selected messages, not just the first; frozen messages are included when
4537 &'ff'& is present.
4538
4539 The &%-R%& option makes it straightforward to initiate delivery of all messages
4540 to a given domain after a host has been down for some time. When the SMTP
4541 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4542 effect is to run Exim with the &%-R%& option, but it can be configured to run
4543 an arbitrary command instead.
4544
4545 .vitem &%-r%&
4546 .oindex "&%-r%&"
4547 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4548
4549 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4550 .oindex "&%-S%&"
4551 .cindex "delivery" "from given sender"
4552 .cindex "queue runner" "for specific senders"
4553 This option acts like &%-R%& except that it checks the string against each
4554 message's sender instead of against the recipients. If &%-R%& is also set, both
4555 conditions must be met for a message to be selected. If either of the options
4556 has &'f'& or &'ff'& in its flags, the associated action is taken.
4557
4558 .vitem &%-Tqt%&&~<&'times'&>
4559 .oindex "&%-Tqt%&"
4560 This is an option that is exclusively for use by the Exim testing suite. It is not
4561 recognized when Exim is run normally. It allows for the setting up of explicit
4562 &"queue times"& so that various warning/retry features can be tested.
4563
4564 .vitem &%-t%&
4565 .oindex "&%-t%&"
4566 .cindex "recipient" "extracting from header lines"
4567 .cindex "&'Bcc:'& header line"
4568 .cindex "&'Cc:'& header line"
4569 .cindex "&'To:'& header line"
4570 When Exim is receiving a locally-generated, non-SMTP message on its standard
4571 input, the &%-t%& option causes the recipients of the message to be obtained
4572 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4573 from the command arguments. The addresses are extracted before any rewriting
4574 takes place and the &'Bcc:'& header line, if present, is then removed.
4575
4576 .cindex "Sendmail compatibility" "&%-t%& option"
4577 If the command has any arguments, they specify addresses to which the message
4578 is &'not'& to be delivered. That is, the argument addresses are removed from
4579 the recipients list obtained from the headers. This is compatible with Smail 3
4580 and in accordance with the documented behaviour of several versions of
4581 Sendmail, as described in man pages on a number of operating systems (e.g.
4582 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4583 argument addresses to those obtained from the headers, and the O'Reilly
4584 Sendmail book documents it that way. Exim can be made to add argument addresses
4585 instead of subtracting them by setting the option
4586 &%extract_addresses_remove_arguments%& false.
4587
4588 .cindex "&%Resent-%& header lines" "with &%-t%&"
4589 If there are any &%Resent-%& header lines in the message, Exim extracts
4590 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4591 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4592 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4593 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4594
4595 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4596 message is resent several times). The RFC also specifies that they should be
4597 added at the front of the message, and separated by &'Received:'& lines. It is
4598 not at all clear how &%-t%& should operate in the present of multiple sets,
4599 nor indeed exactly what constitutes a &"set"&.
4600 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4601 are often added at the end of the header, and if a message is resent more than
4602 once, it is common for the original set of &%Resent-%& headers to be renamed as
4603 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4604
4605 .vitem &%-ti%&
4606 .oindex "&%-ti%&"
4607 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4608 compatibility with Sendmail.
4609
4610 .vitem &%-tls-on-connect%&
4611 .oindex "&%-tls-on-connect%&"
4612 .cindex "TLS" "use without STARTTLS"
4613 .cindex "TLS" "automatic start"
4614 This option is available when Exim is compiled with TLS support. It forces all
4615 incoming SMTP connections to behave as if the incoming port is listed in the
4616 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4617 &<<CHAPTLS>>& for further details.
4618
4619
4620 .vitem &%-U%&
4621 .oindex "&%-U%&"
4622 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4623 Sendmail uses this option for &"initial message submission"&, and its
4624 documentation states that in future releases, it may complain about
4625 syntactically invalid messages rather than fixing them when this flag is not
4626 set. Exim ignores this option.
4627
4628 .vitem &%-v%&
4629 .oindex "&%-v%&"
4630 This option causes Exim to write information to the standard error stream,
4631 describing what it is doing. In particular, it shows the log lines for
4632 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4633 dialogue is shown. Some of the log lines shown may not actually be written to
4634 the log if the setting of &%log_selector%& discards them. Any relevant
4635 selectors are shown with each log line. If none are shown, the logging is
4636 unconditional.
4637
4638 .vitem &%-x%&
4639 .oindex "&%-x%&"
4640 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4641 National Language Support extended characters in the body of the mail item"&).
4642 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4643 this option.
4644
4645 .vitem &%-X%&&~<&'logfile'&>
4646 .oindex "&%-X%&"
4647 This option is interpreted by Sendmail to cause debug information to be sent
4648 to the named file.  It is ignored by Exim.
4649 .endlist
4650
4651 .ecindex IIDclo1
4652 .ecindex IIDclo2
4653
4654
4655 . ////////////////////////////////////////////////////////////////////////////
4656 . Insert a stylized DocBook comment here, to identify the end of the command
4657 . line options. This is for the benefit of the Perl script that automatically
4658 . creates a man page for the options.
4659 . ////////////////////////////////////////////////////////////////////////////
4660
4661 .literal xml
4662 <!-- === End of command line options === -->
4663 .literal off
4664
4665
4666
4667
4668
4669 . ////////////////////////////////////////////////////////////////////////////
4670 . ////////////////////////////////////////////////////////////////////////////
4671
4672
4673 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4674          "The runtime configuration file"
4675
4676 .cindex "run time configuration"
4677 .cindex "configuration file" "general description"
4678 .cindex "CONFIGURE_FILE"
4679 .cindex "configuration file" "errors in"
4680 .cindex "error" "in configuration file"
4681 .cindex "return code" "for bad configuration"
4682 Exim uses a single run time configuration file that is read whenever an Exim
4683 binary is executed. Note that in normal operation, this happens frequently,
4684 because Exim is designed to operate in a distributed manner, without central
4685 control.
4686
4687 If a syntax error is detected while reading the configuration file, Exim
4688 writes a message on the standard error, and exits with a non-zero return code.
4689 The message is also written to the panic log. &*Note*&: Only simple syntax
4690 errors can be detected at this time. The values of any expanded options are
4691 not checked until the expansion happens, even when the expansion does not
4692 actually alter the string.
4693
4694 The name of the configuration file is compiled into the binary for security
4695 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4696 most configurations, this specifies a single file. However, it is permitted to
4697 give a colon-separated list of file names, in which case Exim uses the first
4698 existing file in the list.
4699
4700 .cindex "EXIM_USER"
4701 .cindex "EXIM_GROUP"
4702 .cindex "CONFIGURE_OWNER"
4703 .cindex "CONFIGURE_GROUP"
4704 .cindex "configuration file" "ownership"
4705 .cindex "ownership" "configuration file"
4706 The run time configuration file must be owned by root or by the user that is
4707 specified at compile time by the CONFIGURE_OWNER option (if set). The
4708 configuration file must not be world-writeable, or group-writeable unless its
4709 group is the root group or the one specified at compile time by the
4710 CONFIGURE_GROUP option.
4711
4712 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4713 to root, anybody who is able to edit the run time configuration file has an
4714 easy way to run commands as root. If you specify a user or group in the
4715 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4716 who are members of that group will trivially be able to obtain root privileges.
4717
4718 Up to Exim version 4.72, the run time configuration file was also permitted to
4719 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4720 since it offered a simple privilege escalation for any attacker who managed to
4721 compromise the Exim user account.
4722
4723 A default configuration file, which will work correctly in simple situations,
4724 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4725 defines just one file name, the installation process copies the default
4726 configuration to a new file of that name if it did not previously exist. If
4727 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4728 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4729 configuration.
4730
4731
4732
4733 .section "Using a different configuration file" "SECID40"
4734 .cindex "configuration file" "alternate"
4735 A one-off alternate configuration can be specified by the &%-C%& command line
4736 option, which may specify a single file or a list of files. However, when
4737 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4738 unless the argument for &%-C%& is identical to the built-in value from
4739 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4740 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4741 is useful mainly for checking the syntax of configuration files before
4742 installing them. No owner or group checks are done on a configuration file
4743 specified by &%-C%&, if root privilege has been dropped.
4744
4745 Even the Exim user is not trusted to specify an arbitrary configuration file
4746 with the &%-C%& option to be used with root privileges, unless that file is
4747 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4748 testing a configuration using &%-C%& right through message reception and
4749 delivery, even if the caller is root. The reception works, but by that time,
4750 Exim is running as the Exim user, so when it re-execs to regain privilege for
4751 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4752 can test reception and delivery using two separate commands (one to put a
4753 message on the queue, using &%-odq%&, and another to do the delivery, using
4754 &%-M%&).
4755
4756 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4757 prefix string with which any file named in a &%-C%& command line option must
4758 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4759 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4760 name can be used with &%-C%&.
4761
4762 One-off changes to a configuration can be specified by the &%-D%& command line
4763 option, which defines and overrides values for macros used inside the
4764 configuration file. However, like &%-C%&, the use of this option by a
4765 non-privileged user causes Exim to discard its root privilege.
4766 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4767 completely disabled, and its use causes an immediate error exit.
4768
4769 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4770 to declare certain macro names trusted, such that root privilege will not
4771 necessarily be discarded.
4772 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4773 considered safe and, if &%-D%& only supplies macros from this list, and the
4774 values are acceptable, then Exim will not give up root privilege if the caller
4775 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4776 transition mechanism and is expected to be removed in the future.  Acceptable
4777 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4778
4779 Some sites may wish to use the same Exim binary on different machines that
4780 share a file system, but to use different configuration files on each machine.
4781 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4782 looks for a file whose name is the configuration file name followed by a dot
4783 and the machine's node name, as obtained from the &[uname()]& function. If this
4784 file does not exist, the standard name is tried. This processing occurs for
4785 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4786
4787 In some esoteric situations different versions of Exim may be run under
4788 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4789 help with this. See the comments in &_src/EDITME_& for details.
4790
4791
4792
4793 .section "Configuration file format" "SECTconffilfor"
4794 .cindex "configuration file" "format of"
4795 .cindex "format" "configuration file"
4796 Exim's configuration file is divided into a number of different parts. General
4797 option settings must always appear at the start of the file. The other parts
4798 are all optional, and may appear in any order. Each part other than the first
4799 is introduced by the word &"begin"& followed by the name of the part. The
4800 optional parts are:
4801
4802 .ilist
4803 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4804 &<<CHAPACL>>&).
4805 .next
4806 .cindex "AUTH" "configuration"
4807 &'authenticators'&: Configuration settings for the authenticator drivers. These
4808 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4809 .next
4810 &'routers'&: Configuration settings for the router drivers. Routers process
4811 addresses and determine how the message is to be delivered (see chapters
4812 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4813 .next
4814 &'transports'&: Configuration settings for the transport drivers. Transports
4815 define mechanisms for copying messages to destinations (see chapters
4816 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4817 .next
4818 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4819 If there is no retry section, or if it is empty (that is, no retry rules are
4820 defined), Exim will not retry deliveries. In this situation, temporary errors
4821 are treated the same as permanent errors. Retry rules are discussed in chapter
4822 &<<CHAPretry>>&.
4823 .next
4824 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4825 when new addresses are generated during delivery. Rewriting is discussed in
4826 chapter &<<CHAPrewrite>>&.
4827 .next
4828 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4829 want to use this feature, you must set
4830 .code
4831 LOCAL_SCAN_HAS_OPTIONS=yes
4832 .endd
4833 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4834 facility are given in chapter &<<CHAPlocalscan>>&.
4835 .endlist
4836
4837 .cindex "configuration file" "leading white space in"
4838 .cindex "configuration file" "trailing white space in"
4839 .cindex "white space" "in configuration file"
4840 Leading and trailing white space in configuration lines is always ignored.
4841
4842 Blank lines in the file, and lines starting with a # character (ignoring
4843 leading white space) are treated as comments and are ignored. &*Note*&: A
4844 # character other than at the beginning of a line is not treated specially,
4845 and does not introduce a comment.
4846
4847 Any non-comment line can be continued by ending it with a backslash. Note that
4848 the general rule for white space means that trailing white space after the
4849 backslash and leading white space at the start of continuation
4850 lines is ignored. Comment lines beginning with # (but not empty lines) may
4851 appear in the middle of a sequence of continuation lines.
4852
4853 A convenient way to create a configuration file is to start from the
4854 default, which is supplied in &_src/configure.default_&, and add, delete, or
4855 change settings as required.
4856
4857 The ACLs, retry rules, and rewriting rules have their own syntax which is
4858 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4859 respectively. The other parts of the configuration file have some syntactic
4860 items in common, and these are described below, from section &<<SECTcos>>&
4861 onwards. Before that, the inclusion, macro, and conditional facilities are
4862 described.
4863
4864
4865
4866 .section "File inclusions in the configuration file" "SECID41"
4867 .cindex "inclusions in configuration file"
4868 .cindex "configuration file" "including other files"
4869 .cindex "&`.include`& in configuration file"
4870 .cindex "&`.include_if_exists`& in configuration file"
4871 You can include other files inside Exim's run time configuration file by
4872 using this syntax:
4873 .display
4874 &`.include`& <&'file name'&>
4875 &`.include_if_exists`& <&'file name'&>
4876 .endd
4877 on a line by itself. Double quotes round the file name are optional. If you use
4878 the first form, a configuration error occurs if the file does not exist; the
4879 second form does nothing for non-existent files. In all cases, an absolute file
4880 name is required.
4881
4882 Includes may be nested to any depth, but remember that Exim reads its
4883 configuration file often, so it is a good idea to keep them to a minimum.
4884 If you change the contents of an included file, you must HUP the daemon,
4885 because an included file is read only when the configuration itself is read.
4886
4887 The processing of inclusions happens early, at a physical line level, so, like
4888 comment lines, an inclusion can be used in the middle of an option setting,
4889 for example:
4890 .code
4891 hosts_lookup = a.b.c \
4892                .include /some/file
4893 .endd
4894 Include processing happens after macro processing (see below). Its effect is to
4895 process the lines of the included file as if they occurred inline where the
4896 inclusion appears.
4897
4898
4899
4900 .section "Macros in the configuration file" "SECTmacrodefs"
4901 .cindex "macro" "description of"
4902 .cindex "configuration file" "macros"
4903 If a line in the main part of the configuration (that is, before the first
4904 &"begin"& line) begins with an upper case letter, it is taken as a macro
4905 definition, and must be of the form
4906 .display
4907 <&'name'&> = <&'rest of line'&>
4908 .endd
4909 The name must consist of letters, digits, and underscores, and need not all be
4910 in upper case, though that is recommended. The rest of the line, including any
4911 continuations, is the replacement text, and has leading and trailing white
4912 space removed. Quotes are not removed. The replacement text can never end with
4913 a backslash character, but this doesn't seem to be a serious limitation.
4914
4915 Macros may also be defined between router, transport, authenticator, or ACL
4916 definitions. They may not, however, be defined within an individual driver or
4917 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4918
4919 .section "Macro substitution" "SECID42"
4920 Once a macro is defined, all subsequent lines in the file (and any included
4921 files) are scanned for the macro name; if there are several macros, the line is
4922 scanned for each in turn, in the order in which the macros are defined. The
4923 replacement text is not re-scanned for the current macro, though it is scanned
4924 for subsequently defined macros. For this reason, a macro name may not contain
4925 the name of a previously defined macro as a substring. You could, for example,
4926 define
4927 .display
4928 &`ABCD_XYZ = `&<&'something'&>
4929 &`ABCD = `&<&'something else'&>
4930 .endd
4931 but putting the definitions in the opposite order would provoke a configuration
4932 error. Macro expansion is applied to individual physical lines from the file,
4933 before checking for line continuation or file inclusion (see above). If a line
4934 consists solely of a macro name, and the expansion of the macro is empty, the
4935 line is ignored. A macro at the start of a line may turn the line into a
4936 comment line or a &`.include`& line.
4937
4938
4939 .section "Redefining macros" "SECID43"
4940 Once defined, the value of a macro can be redefined later in the configuration
4941 (or in an included file). Redefinition is specified by using &'=='& instead of
4942 &'='&. For example:
4943 .code
4944 MAC =  initial value
4945 ...
4946 MAC == updated value
4947 .endd
4948 Redefinition does not alter the order in which the macros are applied to the
4949 subsequent lines of the configuration file. It is still the same order in which
4950 the macros were originally defined. All that changes is the macro's value.
4951 Redefinition makes it possible to accumulate values. For example:
4952 .code
4953 MAC =  initial value
4954 ...
4955 MAC == MAC and something added
4956 .endd
4957 This can be helpful in situations where the configuration file is built
4958 from a number of other files.
4959
4960 .section "Overriding macro values" "SECID44"
4961 The values set for macros in the configuration file can be overridden by the
4962 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4963 used, unless called by root or the Exim user. A definition on the command line
4964 using the &%-D%& option causes all definitions and redefinitions within the
4965 file to be ignored.
4966
4967
4968
4969 .section "Example of macro usage" "SECID45"
4970 As an example of macro usage, consider a configuration where aliases are looked
4971 up in a MySQL database. It helps to keep the file less cluttered if long
4972 strings such as SQL statements are defined separately as macros, for example:
4973 .code
4974 ALIAS_QUERY = select mailbox from user where \
4975               login='${quote_mysql:$local_part}';
4976 .endd
4977 This can then be used in a &(redirect)& router setting like this:
4978 .code
4979 data = ${lookup mysql{ALIAS_QUERY}}
4980 .endd
4981 In earlier versions of Exim macros were sometimes used for domain, host, or
4982 address lists. In Exim 4 these are handled better by named lists &-- see
4983 section &<<SECTnamedlists>>&.
4984
4985
4986 .section "Conditional skips in the configuration file" "SECID46"
4987 .cindex "configuration file" "conditional skips"
4988 .cindex "&`.ifdef`&"
4989 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4990 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4991 portions of the configuration file. The processing happens whenever the file is
4992 read (that is, when an Exim binary starts to run).
4993
4994 The implementation is very simple. Instances of the first four directives must
4995 be followed by text that includes the names of one or macros. The condition
4996 that is tested is whether or not any macro substitution has taken place in the
4997 line. Thus:
4998 .code
4999 .ifdef AAA
5000 message_size_limit = 50M
5001 .else
5002 message_size_limit = 100M
5003 .endif
5004 .endd
5005 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5006 otherwise. If there is more than one macro named on the line, the condition
5007 is true if any of them are defined. That is, it is an &"or"& condition. To
5008 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5009
5010 Although you can use a macro expansion to generate one of these directives,
5011 it is not very useful, because the condition &"there was a macro substitution
5012 in this line"& will always be true.
5013
5014 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5015 to clarify complicated nestings.
5016
5017
5018
5019 .section "Common option syntax" "SECTcos"
5020 .cindex "common option syntax"
5021 .cindex "syntax of common options"
5022 .cindex "configuration file" "common option syntax"
5023 For the main set of options, driver options, and &[local_scan()]& options,
5024 each setting is on a line by itself, and starts with a name consisting of
5025 lower-case letters and underscores. Many options require a data value, and in
5026 these cases the name must be followed by an equals sign (with optional white
5027 space) and then the value. For example:
5028 .code
5029 qualify_domain = mydomain.example.com
5030 .endd
5031 .cindex "hiding configuration option values"
5032 .cindex "configuration options" "hiding value of"
5033 .cindex "options" "hiding value of"
5034 Some option settings may contain sensitive data, for example, passwords for
5035 accessing databases. To stop non-admin users from using the &%-bP%& command
5036 line option to read these values, you can precede the option settings with the
5037 word &"hide"&. For example:
5038 .code
5039 hide mysql_servers = localhost/users/admin/secret-password
5040 .endd
5041 For non-admin users, such options are displayed like this:
5042 .code
5043 mysql_servers = <value not displayable>
5044 .endd
5045 If &"hide"& is used on a driver option, it hides the value of that option on
5046 all instances of the same driver.
5047
5048 The following sections describe the syntax used for the different data types
5049 that are found in option settings.
5050
5051
5052 .section "Boolean options" "SECID47"
5053 .cindex "format" "boolean"
5054 .cindex "boolean configuration values"
5055 .oindex "&%no_%&&'xxx'&"
5056 .oindex "&%not_%&&'xxx'&"
5057 Options whose type is given as boolean are on/off switches. There are two
5058 different ways of specifying such options: with and without a data value. If
5059 the option name is specified on its own without data, the switch is turned on;
5060 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5061 boolean options may be followed by an equals sign and one of the words
5062 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5063 the following two settings have exactly the same effect:
5064 .code
5065 queue_only
5066 queue_only = true
5067 .endd
5068 The following two lines also have the same (opposite) effect:
5069 .code
5070 no_queue_only
5071 queue_only = false
5072 .endd
5073 You can use whichever syntax you prefer.
5074
5075
5076
5077
5078 .section "Integer values" "SECID48"
5079 .cindex "integer configuration values"
5080 .cindex "format" "integer"
5081 If an option's type is given as &"integer"&, the value can be given in decimal,
5082 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5083 number is assumed. Otherwise, it is treated as an octal number unless it starts
5084 with the characters &"0x"&, in which case the remainder is interpreted as a
5085 hexadecimal number.
5086
5087 If an integer value is followed by the letter K, it is multiplied by 1024; if
5088 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5089 of integer option settings are output, values which are an exact multiple of
5090 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5091 and M. The printing style is independent of the actual input format that was
5092 used.
5093
5094
5095 .section "Octal integer values" "SECID49"
5096 .cindex "integer format"
5097 .cindex "format" "octal integer"
5098 If an option's type is given as &"octal integer"&, its value is always
5099 interpreted as an octal number, whether or not it starts with the digit zero.
5100 Such options are always output in octal.
5101
5102
5103 .section "Fixed point numbers" "SECID50"
5104 .cindex "fixed point configuration values"
5105 .cindex "format" "fixed point"
5106 If an option's type is given as &"fixed-point"&, its value must be a decimal
5107 integer, optionally followed by a decimal point and up to three further digits.
5108
5109
5110
5111 .section "Time intervals" "SECTtimeformat"
5112 .cindex "time interval" "specifying in configuration"
5113 .cindex "format" "time interval"
5114 A time interval is specified as a sequence of numbers, each followed by one of
5115 the following letters, with no intervening white space:
5116
5117 .table2 30pt
5118 .irow &%s%& seconds
5119 .irow &%m%& minutes
5120 .irow &%h%& hours
5121 .irow &%d%& days
5122 .irow &%w%& weeks
5123 .endtable
5124
5125 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5126 intervals are output in the same format. Exim does not restrict the values; it
5127 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5128
5129
5130
5131 .section "String values" "SECTstrings"
5132 .cindex "string" "format of configuration values"
5133 .cindex "format" "string"
5134 If an option's type is specified as &"string"&, the value can be specified with
5135 or without double-quotes. If it does not start with a double-quote, the value
5136 consists of the remainder of the line plus any continuation lines, starting at
5137 the first character after any leading white space, with trailing white space
5138 removed, and with no interpretation of the characters in the string. Because
5139 Exim removes comment lines (those beginning with #) at an early stage, they can
5140 appear in the middle of a multi-line string. The following two settings are
5141 therefore equivalent:
5142 .code
5143 trusted_users = uucp:mail
5144 trusted_users = uucp:\
5145                 # This comment line is ignored
5146                 mail
5147 .endd
5148 .cindex "string" "quoted"
5149 .cindex "escape characters in quoted strings"
5150 If a string does start with a double-quote, it must end with a closing
5151 double-quote, and any backslash characters other than those used for line
5152 continuation are interpreted as escape characters, as follows:
5153
5154 .table2 100pt
5155 .irow &`\\`&                     "single backslash"
5156 .irow &`\n`&                     "newline"
5157 .irow &`\r`&                     "carriage return"
5158 .irow &`\t`&                     "tab"
5159 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5160 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5161                                    character"
5162 .endtable
5163
5164 If a backslash is followed by some other character, including a double-quote
5165 character, that character replaces the pair.
5166
5167 Quoting is necessary only if you want to make use of the backslash escapes to
5168 insert special characters, or if you need to specify a value with leading or
5169 trailing spaces. These cases are rare, so quoting is almost never needed in
5170 current versions of Exim. In versions of Exim before 3.14, quoting was required
5171 in order to continue lines, so you may come across older configuration files
5172 and examples that apparently quote unnecessarily.
5173
5174
5175 .section "Expanded strings" "SECID51"
5176 .cindex "expansion" "definition of"
5177 Some strings in the configuration file are subjected to &'string expansion'&,
5178 by which means various parts of the string may be changed according to the
5179 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5180 is as just described; in particular, the handling of backslashes in quoted
5181 strings is done as part of the input process, before expansion takes place.
5182 However, backslash is also an escape character for the expander, so any
5183 backslashes that are required for that reason must be doubled if they are
5184 within a quoted configuration string.
5185
5186
5187 .section "User and group names" "SECID52"
5188 .cindex "user name" "format of"
5189 .cindex "format" "user name"
5190 .cindex "groups" "name format"
5191 .cindex "format" "group name"
5192 User and group names are specified as strings, using the syntax described
5193 above, but the strings are interpreted specially. A user or group name must
5194 either consist entirely of digits, or be a name that can be looked up using the
5195 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5196
5197
5198 .section "List construction" "SECTlistconstruct"
5199 .cindex "list" "syntax of in configuration"
5200 .cindex "format" "list item in configuration"
5201 .cindex "string" "list, definition of"
5202 The data for some configuration options is a list of items, with colon as the
5203 default separator. Many of these options are shown with type &"string list"& in
5204 the descriptions later in this document. Others are listed as &"domain list"&,
5205 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5206 are all the same; however, those other than &"string list"& are subject to
5207 particular kinds of interpretation, as described in chapter
5208 &<<CHAPdomhosaddlists>>&.
5209
5210 In all these cases, the entire list is treated as a single string as far as the
5211 input syntax is concerned. The &%trusted_users%& setting in section
5212 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5213 in a list, it must be entered as two colons. Leading and trailing white space
5214 on each item in a list is ignored. This makes it possible to include items that
5215 start with a colon, and in particular, certain forms of IPv6 address. For
5216 example, the list
5217 .code
5218 local_interfaces = 127.0.0.1 : ::::1
5219 .endd
5220 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5221
5222 &*Note*&: Although leading and trailing white space is ignored in individual
5223 list items, it is not ignored when parsing the list. The space after the first
5224 colon in the example above is necessary. If it were not there, the list would
5225 be interpreted as the two items 127.0.0.1:: and 1.
5226
5227 .section "Changing list separators" "SECID53"
5228 .cindex "list separator" "changing"
5229 .cindex "IPv6" "addresses in lists"
5230 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5231 introduced to allow the separator character to be changed. If a list begins
5232 with a left angle bracket, followed by any punctuation character, that
5233 character is used instead of colon as the list separator. For example, the list
5234 above can be rewritten to use a semicolon separator like this:
5235 .code
5236 local_interfaces = <; 127.0.0.1 ; ::1
5237 .endd
5238 This facility applies to all lists, with the exception of the list in
5239 &%log_file_path%&. It is recommended that the use of non-colon separators be
5240 confined to circumstances where they really are needed.
5241
5242 .cindex "list separator" "newline as"
5243 .cindex "newline" "as list separator"
5244 It is also possible to use newline and other control characters (those with
5245 code values less than 32, plus DEL) as separators in lists. Such separators
5246 must be provided literally at the time the list is processed. For options that
5247 are string-expanded, you can write the separator using a normal escape
5248 sequence. This will be processed by the expander before the string is
5249 interpreted as a list. For example, if a newline-separated list of domains is
5250 generated by a lookup, you can process it directly by a line such as this:
5251 .code
5252 domains = <\n ${lookup mysql{.....}}
5253 .endd
5254 This avoids having to change the list separator in such data. You are unlikely
5255 to want to use a control character as a separator in an option that is not
5256 expanded, because the value is literal text. However, it can be done by giving
5257 the value in quotes. For example:
5258 .code
5259 local_interfaces = "<\n 127.0.0.1 \n ::1"
5260 .endd
5261 Unlike printing character separators, which can be included in list items by
5262 doubling, it is not possible to include a control character as data when it is
5263 set as the separator. Two such characters in succession are interpreted as
5264 enclosing an empty list item.
5265
5266
5267
5268 .section "Empty items in lists" "SECTempitelis"
5269 .cindex "list" "empty item in"
5270 An empty item at the end of a list is always ignored. In other words, trailing
5271 separator characters are ignored. Thus, the list in
5272 .code
5273 senders = user@domain :
5274 .endd
5275 contains only a single item. If you want to include an empty string as one item
5276 in a list, it must not be the last item. For example, this list contains three
5277 items, the second of which is empty:
5278 .code
5279 senders = user1@domain : : user2@domain
5280 .endd
5281 &*Note*&: There must be white space between the two colons, as otherwise they
5282 are interpreted as representing a single colon data character (and the list
5283 would then contain just one item). If you want to specify a list that contains
5284 just one, empty item, you can do it as in this example:
5285 .code
5286 senders = :
5287 .endd
5288 In this case, the first item is empty, and the second is discarded because it
5289 is at the end of the list.
5290
5291
5292
5293
5294 .section "Format of driver configurations" "SECTfordricon"
5295 .cindex "drivers" "configuration format"
5296 There are separate parts in the configuration for defining routers, transports,
5297 and authenticators. In each part, you are defining a number of driver
5298 instances, each with its own set of options. Each driver instance is defined by
5299 a sequence of lines like this:
5300 .display
5301 <&'instance name'&>:
5302   <&'option'&>
5303   ...
5304   <&'option'&>
5305 .endd
5306 In the following example, the instance name is &(localuser)&, and it is
5307 followed by three options settings:
5308 .code
5309 localuser:
5310   driver = accept
5311   check_local_user
5312   transport = local_delivery
5313 .endd
5314 For each driver instance, you specify which Exim code module it uses &-- by the
5315 setting of the &%driver%& option &-- and (optionally) some configuration
5316 settings. For example, in the case of transports, if you want a transport to
5317 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5318 a local file you would use the &(appendfile)& driver. Each of the drivers is
5319 described in detail in its own separate chapter later in this manual.
5320
5321 You can have several routers, transports, or authenticators that are based on
5322 the same underlying driver (each must have a different instance name).
5323
5324 The order in which routers are defined is important, because addresses are
5325 passed to individual routers one by one, in order. The order in which
5326 transports are defined does not matter at all. The order in which
5327 authenticators are defined is used only when Exim, as a client, is searching
5328 them to find one that matches an authentication mechanism offered by the
5329 server.
5330
5331 .cindex "generic options"
5332 .cindex "options" "generic &-- definition of"
5333 Within a driver instance definition, there are two kinds of option: &'generic'&
5334 and &'private'&. The generic options are those that apply to all drivers of the
5335 same type (that is, all routers, all transports or all authenticators). The
5336 &%driver%& option is a generic option that must appear in every definition.
5337 .cindex "private options"
5338 The private options are special for each driver, and none need appear, because
5339 they all have default values.
5340
5341 The options may appear in any order, except that the &%driver%& option must
5342 precede any private options, since these depend on the particular driver. For
5343 this reason, it is recommended that &%driver%& always be the first option.
5344
5345 Driver instance names, which are used for reference in log entries and
5346 elsewhere, can be any sequence of letters, digits, and underscores (starting
5347 with a letter) and must be unique among drivers of the same type. A router and
5348 a transport (for example) can each have the same name, but no two router
5349 instances can have the same name. The name of a driver instance should not be
5350 confused with the name of the underlying driver module. For example, the
5351 configuration lines:
5352 .code
5353 remote_smtp:
5354   driver = smtp
5355 .endd
5356 create an instance of the &(smtp)& transport driver whose name is
5357 &(remote_smtp)&. The same driver code can be used more than once, with
5358 different instance names and different option settings each time. A second
5359 instance of the &(smtp)& transport, with different options, might be defined
5360 thus:
5361 .code
5362 special_smtp:
5363   driver = smtp
5364   port = 1234
5365   command_timeout = 10s
5366 .endd
5367 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5368 these transport instances from routers, and these names would appear in log
5369 lines.
5370
5371 Comment lines may be present in the middle of driver specifications. The full
5372 list of option settings for any particular driver instance, including all the
5373 defaulted values, can be extracted by making use of the &%-bP%& command line
5374 option.
5375
5376
5377
5378
5379
5380
5381 . ////////////////////////////////////////////////////////////////////////////
5382 . ////////////////////////////////////////////////////////////////////////////
5383
5384 .chapter "The default configuration file" "CHAPdefconfil"
5385 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5386 .cindex "default" "configuration file &""walk through""&"
5387 The default configuration file supplied with Exim as &_src/configure.default_&
5388 is sufficient for a host with simple mail requirements. As an introduction to
5389 the way Exim is configured, this chapter &"walks through"& the default
5390 configuration, giving brief explanations of the settings. Detailed descriptions
5391 of the options are given in subsequent chapters. The default configuration file
5392 itself contains extensive comments about ways you might want to modify the
5393 initial settings. However, note that there are many options that are not
5394 mentioned at all in the default configuration.
5395
5396
5397
5398 .section "Main configuration settings" "SECTdefconfmain"
5399 The main (global) configuration option settings must always come first in the
5400 file. The first thing you'll see in the file, after some initial comments, is
5401 the line
5402 .code
5403 # primary_hostname =
5404 .endd
5405 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5406 to know the official, fully qualified name of your host, and this is where you
5407 can specify it. However, in most cases you do not need to set this option. When
5408 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5409
5410 The first three non-comment configuration lines are as follows:
5411 .code
5412 domainlist local_domains    = @
5413 domainlist relay_to_domains =
5414 hostlist   relay_from_hosts = 127.0.0.1
5415 .endd
5416 These are not, in fact, option settings. They are definitions of two named
5417 domain lists and one named host list. Exim allows you to give names to lists of
5418 domains, hosts, and email addresses, in order to make it easier to manage the
5419 configuration file (see section &<<SECTnamedlists>>&).
5420
5421 The first line defines a domain list called &'local_domains'&; this is used
5422 later in the configuration to identify domains that are to be delivered
5423 on the local host.
5424
5425 .cindex "@ in a domain list"
5426 There is just one item in this list, the string &"@"&. This is a special form
5427 of entry which means &"the name of the local host"&. Thus, if the local host is
5428 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5429 be delivered locally. Because the local host's name is referenced indirectly,
5430 the same configuration file can be used on different hosts.
5431
5432 The second line defines a domain list called &'relay_to_domains'&, but the
5433 list itself is empty. Later in the configuration we will come to the part that
5434 controls mail relaying through the local host; it allows relaying to any
5435 domains in this list. By default, therefore, no relaying on the basis of a mail
5436 domain is permitted.
5437
5438 The third line defines a host list called &'relay_from_hosts'&. This list is
5439 used later in the configuration to permit relaying from any host or IP address
5440 that matches the list. The default contains just the IP address of the IPv4
5441 loopback interface, which means that processes on the local host are able to
5442 submit mail for relaying by sending it over TCP/IP to that interface. No other
5443 hosts are permitted to submit messages for relaying.
5444
5445 Just to be sure there's no misunderstanding: at this point in the configuration
5446 we aren't actually setting up any controls. We are just defining some domains
5447 and hosts that will be used in the controls that are specified later.
5448
5449 The next two configuration lines are genuine option settings:
5450 .code
5451 acl_smtp_rcpt = acl_check_rcpt
5452 acl_smtp_data = acl_check_data
5453 .endd
5454 These options specify &'Access Control Lists'& (ACLs) that are to be used
5455 during an incoming SMTP session for every recipient of a message (every RCPT
5456 command), and after the contents of the message have been received,
5457 respectively. The names of the lists are &'acl_check_rcpt'& and
5458 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5459 section of the configuration. The RCPT ACL controls which recipients are
5460 accepted for an incoming message &-- if a configuration does not provide an ACL
5461 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5462 contents of a message to be checked.
5463
5464 Two commented-out option settings are next:
5465 .code
5466 # av_scanner = clamd:/tmp/clamd
5467 # spamd_address = 127.0.0.1 783
5468 .endd
5469 These are example settings that can be used when Exim is compiled with the
5470 content-scanning extension. The first specifies the interface to the virus
5471 scanner, and the second specifies the interface to SpamAssassin. Further
5472 details are given in chapter &<<CHAPexiscan>>&.
5473
5474 Three more commented-out option settings follow:
5475 .code
5476 # tls_advertise_hosts = *
5477 # tls_certificate = /etc/ssl/exim.crt
5478 # tls_privatekey = /etc/ssl/exim.pem
5479 .endd
5480 These are example settings that can be used when Exim is compiled with
5481 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5482 first one specifies the list of clients that are allowed to use TLS when
5483 connecting to this server; in this case the wildcard means all clients. The
5484 other options specify where Exim should find its TLS certificate and private
5485 key, which together prove the server's identity to any clients that connect.
5486 More details are given in chapter &<<CHAPTLS>>&.
5487
5488 Another two commented-out option settings follow:
5489 .code
5490 # daemon_smtp_ports = 25 : 465 : 587
5491 # tls_on_connect_ports = 465
5492 .endd
5493 .cindex "port" "465 and 587"
5494 .cindex "port" "for message submission"
5495 .cindex "message" "submission, ports for"
5496 .cindex "ssmtp protocol"
5497 .cindex "smtps protocol"
5498 .cindex "SMTP" "ssmtp protocol"
5499 .cindex "SMTP" "smtps protocol"
5500 These options provide better support for roaming users who wish to use this
5501 server for message submission. They are not much use unless you have turned on
5502 TLS (as described in the previous paragraph) and authentication (about which
5503 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5504 on end-user networks, so RFC 4409 specifies that message submission should use
5505 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5506 configured to use port 587 correctly, so these settings also enable the
5507 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5508 &<<SECTsupobssmt>>&).
5509
5510 Two more commented-out options settings follow:
5511 .code
5512 # qualify_domain =
5513 # qualify_recipient =
5514 .endd
5515 The first of these specifies a domain that Exim uses when it constructs a
5516 complete email address from a local login name. This is often needed when Exim
5517 receives a message from a local process. If you do not set &%qualify_domain%&,
5518 the value of &%primary_hostname%& is used. If you set both of these options,
5519 you can have different qualification domains for sender and recipient
5520 addresses. If you set only the first one, its value is used in both cases.
5521
5522 .cindex "domain literal" "recognizing format"
5523 The following line must be uncommented if you want Exim to recognize
5524 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5525 (an IP address within square brackets) instead of a named domain.
5526 .code
5527 # allow_domain_literals
5528 .endd
5529 The RFCs still require this form, but many people think that in the modern
5530 Internet it makes little sense to permit mail to be sent to specific hosts by
5531 quoting their IP addresses. This ancient format has been used by people who
5532 try to abuse hosts by using them for unwanted relaying. However, some
5533 people believe there are circumstances (for example, messages addressed to
5534 &'postmaster'&) where domain literals are still useful.
5535
5536 The next configuration line is a kind of trigger guard:
5537 .code
5538 never_users = root
5539 .endd
5540 It specifies that no delivery must ever be run as the root user. The normal
5541 convention is to set up &'root'& as an alias for the system administrator. This
5542 setting is a guard against slips in the configuration.
5543 The list of users specified by &%never_users%& is not, however, the complete
5544 list; the build-time configuration in &_Local/Makefile_& has an option called
5545 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5546 contents of &%never_users%& are added to this list. By default
5547 FIXED_NEVER_USERS also specifies root.
5548
5549 When a remote host connects to Exim in order to send mail, the only information
5550 Exim has about the host's identity is its IP address. The next configuration
5551 line,
5552 .code
5553 host_lookup = *
5554 .endd
5555 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5556 in order to get a host name. This improves the quality of the logging
5557 information, but if you feel it is too expensive, you can remove it entirely,
5558 or restrict the lookup to hosts on &"nearby"& networks.
5559 Note that it is not always possible to find a host name from an IP address,
5560 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5561 unreachable.
5562
5563 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5564 1413 (hence their names):
5565 .code
5566 rfc1413_hosts = *
5567 rfc1413_query_timeout = 0s
5568 .endd
5569 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5570 Few hosts offer RFC1413 service these days; calls have to be
5571 terminated by a timeout and this needlessly delays the startup
5572 of an incoming SMTP connection.
5573 If you have hosts for which you trust RFC1413 and need this
5574 information, you can change this.
5575
5576 This line enables an efficiency SMTP option.  It is negotiated by clients
5577 and not expected to cause problems but can be disabled if needed.
5578 .code
5579 prdr_enable = true
5580 .endd
5581
5582 When Exim receives messages over SMTP connections, it expects all addresses to
5583 be fully qualified with a domain, as required by the SMTP definition. However,
5584 if you are running a server to which simple clients submit messages, you may
5585 find that they send unqualified addresses. The two commented-out options:
5586 .code
5587 # sender_unqualified_hosts =
5588 # recipient_unqualified_hosts =
5589 .endd
5590 show how you can specify hosts that are permitted to send unqualified sender
5591 and recipient addresses, respectively.
5592
5593 The &%percent_hack_domains%& option is also commented out:
5594 .code
5595 # percent_hack_domains =
5596 .endd
5597 It provides a list of domains for which the &"percent hack"& is to operate.
5598 This is an almost obsolete form of explicit email routing. If you do not know
5599 anything about it, you can safely ignore this topic.
5600
5601 The last two settings in the main part of the default configuration are
5602 concerned with messages that have been &"frozen"& on Exim's queue. When a
5603 message is frozen, Exim no longer continues to try to deliver it. Freezing
5604 occurs when a bounce message encounters a permanent failure because the sender
5605 address of the original message that caused the bounce is invalid, so the
5606 bounce cannot be delivered. This is probably the most common case, but there
5607 are also other conditions that cause freezing, and frozen messages are not
5608 always bounce messages.
5609 .code
5610 ignore_bounce_errors_after = 2d
5611 timeout_frozen_after = 7d
5612 .endd
5613 The first of these options specifies that failing bounce messages are to be
5614 discarded after 2 days on the queue. The second specifies that any frozen
5615 message (whether a bounce message or not) is to be timed out (and discarded)
5616 after a week. In this configuration, the first setting ensures that no failing
5617 bounce message ever lasts a week.
5618
5619
5620
5621 .section "ACL configuration" "SECID54"
5622 .cindex "default" "ACLs"
5623 .cindex "&ACL;" "default configuration"
5624 In the default configuration, the ACL section follows the main configuration.
5625 It starts with the line
5626 .code
5627 begin acl
5628 .endd
5629 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5630 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5631 and &%acl_smtp_data%& above.
5632
5633 .cindex "RCPT" "ACL for"
5634 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5635 RCPT command specifies one of the message's recipients. The ACL statements
5636 are considered in order, until the recipient address is either accepted or
5637 rejected. The RCPT command is then accepted or rejected, according to the
5638 result of the ACL processing.
5639 .code
5640 acl_check_rcpt:
5641 .endd
5642 This line, consisting of a name terminated by a colon, marks the start of the
5643 ACL, and names it.
5644 .code
5645 accept  hosts = :
5646 .endd
5647 This ACL statement accepts the recipient if the sending host matches the list.
5648 But what does that strange list mean? It doesn't actually contain any host
5649 names or IP addresses. The presence of the colon puts an empty item in the
5650 list; Exim matches this only if the incoming message did not come from a remote
5651 host, because in that case, the remote hostname is empty. The colon is
5652 important. Without it, the list itself is empty, and can never match anything.
5653
5654 What this statement is doing is to accept unconditionally all recipients in
5655 messages that are submitted by SMTP from local processes using the standard
5656 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5657 manner.
5658 .code
5659 deny    message       = Restricted characters in address
5660         domains       = +local_domains
5661         local_parts   = ^[.] : ^.*[@%!/|]
5662
5663 deny    message       = Restricted characters in address
5664         domains       = !+local_domains
5665         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5666 .endd
5667 These statements are concerned with local parts that contain any of the
5668 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5669 Although these characters are entirely legal in local parts (in the case of
5670 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5671 in Internet mail addresses.
5672
5673 The first three have in the past been associated with explicitly routed
5674 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5675 option). Addresses containing these characters are regularly tried by spammers
5676 in an attempt to bypass relaying restrictions, and also by open relay testing
5677 programs. Unless you really need them it is safest to reject these characters
5678 at this early stage. This configuration is heavy-handed in rejecting these
5679 characters for all messages it accepts from remote hosts. This is a deliberate
5680 policy of being as safe as possible.
5681
5682 The first rule above is stricter, and is applied to messages that are addressed
5683 to one of the local domains handled by this host. This is implemented by the
5684 first condition, which restricts it to domains that are listed in the
5685 &'local_domains'& domain list. The &"+"& character is used to indicate a
5686 reference to a named list. In this configuration, there is just one domain in
5687 &'local_domains'&, but in general there may be many.
5688
5689 The second condition on the first statement uses two regular expressions to
5690 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5691 or &"|"&. If you have local accounts that include these characters, you will
5692 have to modify this rule.
5693
5694 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5695 allows them because they have been encountered in practice. (Consider the
5696 common convention of local parts constructed as
5697 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5698 the author of Exim, who has no second initial.) However, a local part starting
5699 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5700 file name (for example, for a mailing list). This is also true for local parts
5701 that contain slashes. A pipe symbol can also be troublesome if the local part
5702 is incorporated unthinkingly into a shell command line.
5703
5704 The second rule above applies to all other domains, and is less strict. This
5705 allows your own users to send outgoing messages to sites that use slashes
5706 and vertical bars in their local parts. It blocks local parts that begin
5707 with a dot, slash, or vertical bar, but allows these characters within the
5708 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5709 and &"!"& is blocked, as before. The motivation here is to prevent your users
5710 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5711 .code
5712 accept  local_parts   = postmaster
5713         domains       = +local_domains
5714 .endd
5715 This statement, which has two conditions, accepts an incoming address if the
5716 local part is &'postmaster'& and the domain is one of those listed in the
5717 &'local_domains'& domain list. The &"+"& character is used to indicate a
5718 reference to a named list. In this configuration, there is just one domain in
5719 &'local_domains'&, but in general there may be many.
5720
5721 The presence of this statement means that mail to postmaster is never blocked
5722 by any of the subsequent tests. This can be helpful while sorting out problems
5723 in cases where the subsequent tests are incorrectly denying access.
5724 .code
5725 require verify        = sender
5726 .endd
5727 This statement requires the sender address to be verified before any subsequent
5728 ACL statement can be used. If verification fails, the incoming recipient
5729 address is refused. Verification consists of trying to route the address, to
5730 see if a bounce message could be delivered to it. In the case of remote
5731 addresses, basic verification checks only the domain, but &'callouts'& can be
5732 used for more verification if required. Section &<<SECTaddressverification>>&
5733 discusses the details of address verification.
5734 .code
5735 accept  hosts         = +relay_from_hosts
5736         control       = submission
5737 .endd
5738 This statement accepts the address if the message is coming from one of the
5739 hosts that are defined as being allowed to relay through this host. Recipient
5740 verification is omitted here, because in many cases the clients are dumb MUAs
5741 that do not cope well with SMTP error responses. For the same reason, the
5742 second line specifies &"submission mode"& for messages that are accepted. This
5743 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5744 messages that are deficient in some way, for example, because they lack a
5745 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5746 probably add recipient verification here, and disable submission mode.
5747 .code
5748 accept  authenticated = *
5749         control       = submission
5750 .endd
5751 This statement accepts the address if the client host has authenticated itself.
5752 Submission mode is again specified, on the grounds that such messages are most
5753 likely to come from MUAs. The default configuration does not define any
5754 authenticators, though it does include some nearly complete commented-out
5755 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5756 fact authenticate until you complete the authenticator definitions.
5757 .code
5758 require message = relay not permitted
5759         domains = +local_domains : +relay_to_domains
5760 .endd
5761 This statement rejects the address if its domain is neither a local domain nor
5762 one of the domains for which this host is a relay.
5763 .code
5764 require verify = recipient
5765 .endd
5766 This statement requires the recipient address to be verified; if verification
5767 fails, the address is rejected.
5768 .code
5769 # deny    message     = rejected because $sender_host_address \
5770 #                       is in a black list at $dnslist_domain\n\
5771 #                       $dnslist_text
5772 #         dnslists    = black.list.example
5773 #
5774 # warn    dnslists    = black.list.example
5775 #         add_header  = X-Warning: $sender_host_address is in \
5776 #                       a black list at $dnslist_domain
5777 #         log_message = found in $dnslist_domain
5778 .endd
5779 These commented-out lines are examples of how you could configure Exim to check
5780 sending hosts against a DNS black list. The first statement rejects messages
5781 from blacklisted hosts, whereas the second just inserts a warning header
5782 line.
5783 .code
5784 # require verify = csa
5785 .endd
5786 This commented-out line is an example of how you could turn on client SMTP
5787 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5788 records.
5789 .code
5790 accept
5791 .endd
5792 The final statement in the first ACL unconditionally accepts any recipient
5793 address that has successfully passed all the previous tests.
5794 .code
5795 acl_check_data:
5796 .endd
5797 This line marks the start of the second ACL, and names it. Most of the contents
5798 of this ACL are commented out:
5799 .code
5800 # deny    malware   = *
5801 #         message   = This message contains a virus \
5802 #                     ($malware_name).
5803 .endd
5804 These lines are examples of how to arrange for messages to be scanned for
5805 viruses when Exim has been compiled with the content-scanning extension, and a
5806 suitable virus scanner is installed. If the message is found to contain a
5807 virus, it is rejected with the given custom error message.
5808 .code
5809 # warn    spam      = nobody
5810 #         message   = X-Spam_score: $spam_score\n\
5811 #                     X-Spam_score_int: $spam_score_int\n\
5812 #                     X-Spam_bar: $spam_bar\n\
5813 #                     X-Spam_report: $spam_report
5814 .endd
5815 These lines are an example of how to arrange for messages to be scanned by
5816 SpamAssassin when Exim has been compiled with the content-scanning extension,
5817 and SpamAssassin has been installed. The SpamAssassin check is run with
5818 &`nobody`& as its user parameter, and the results are added to the message as a
5819 series of extra header line. In this case, the message is not rejected,
5820 whatever the spam score.
5821 .code
5822 accept
5823 .endd
5824 This final line in the DATA ACL accepts the message unconditionally.
5825
5826
5827 .section "Router configuration" "SECID55"
5828 .cindex "default" "routers"
5829 .cindex "routers" "default"
5830 The router configuration comes next in the default configuration, introduced
5831 by the line
5832 .code
5833 begin routers
5834 .endd
5835 Routers are the modules in Exim that make decisions about where to send
5836 messages. An address is passed to each router in turn, until it is either
5837 accepted, or failed. This means that the order in which you define the routers
5838 matters. Each router is fully described in its own chapter later in this
5839 manual. Here we give only brief overviews.
5840 .code
5841 # domain_literal:
5842 #   driver = ipliteral
5843 #   domains = !+local_domains
5844 #   transport = remote_smtp
5845 .endd
5846 .cindex "domain literal" "default router"
5847 This router is commented out because the majority of sites do not want to
5848 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5849 you uncomment this router, you also need to uncomment the setting of
5850 &%allow_domain_literals%& in the main part of the configuration.
5851 .code
5852 dnslookup:
5853   driver = dnslookup
5854   domains = ! +local_domains
5855   transport = remote_smtp
5856   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5857   no_more
5858 .endd
5859 The first uncommented router handles addresses that do not involve any local
5860 domains. This is specified by the line
5861 .code
5862 domains = ! +local_domains
5863 .endd
5864 The &%domains%& option lists the domains to which this router applies, but the
5865 exclamation mark is a negation sign, so the router is used only for domains
5866 that are not in the domain list called &'local_domains'& (which was defined at
5867 the start of the configuration). The plus sign before &'local_domains'&
5868 indicates that it is referring to a named list. Addresses in other domains are
5869 passed on to the following routers.
5870
5871 The name of the router driver is &(dnslookup)&,
5872 and is specified by the &%driver%& option. Do not be confused by the fact that
5873 the name of this router instance is the same as the name of the driver. The
5874 instance name is arbitrary, but the name set in the &%driver%& option must be
5875 one of the driver modules that is in the Exim binary.
5876
5877 The &(dnslookup)& router routes addresses by looking up their domains in the
5878 DNS in order to obtain a list of hosts to which the address is routed. If the
5879 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5880 specified by the &%transport%& option. If the router does not find the domain
5881 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5882 the address fails and is bounced.
5883
5884 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5885 be entirely ignored. This option is present because a number of cases have been
5886 encountered where MX records in the DNS point to host names
5887 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5888 Completely ignoring these IP addresses causes Exim to fail to route the
5889 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5890 continue to try to deliver the message periodically until the address timed
5891 out.
5892 .code
5893 system_aliases:
5894   driver = redirect
5895   allow_fail
5896   allow_defer
5897   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5898 # user = exim
5899   file_transport = address_file
5900   pipe_transport = address_pipe
5901 .endd
5902 Control reaches this and subsequent routers only for addresses in the local
5903 domains. This router checks to see whether the local part is defined as an
5904 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5905 data that it looks up from that file. If no data is found for the local part,
5906 the value of the &%data%& option is empty, causing the address to be passed to
5907 the next router.
5908
5909 &_/etc/aliases_& is a conventional name for the system aliases file that is
5910 often used. That is why it is referenced by from the default configuration
5911 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5912 &_Local/Makefile_& before building Exim.
5913 .code
5914 userforward:
5915   driver = redirect
5916   check_local_user
5917 # local_part_suffix = +* : -*
5918 # local_part_suffix_optional
5919   file = $home/.forward
5920 # allow_filter
5921   no_verify
5922   no_expn
5923   check_ancestor
5924   file_transport = address_file
5925   pipe_transport = address_pipe
5926   reply_transport = address_reply
5927 .endd
5928 This is the most complicated router in the default configuration. It is another
5929 redirection router, but this time it is looking for forwarding data set up by
5930 individual users. The &%check_local_user%& setting specifies a check that the
5931 local part of the address is the login name of a local user. If it is not, the
5932 router is skipped. The two commented options that follow &%check_local_user%&,
5933 namely:
5934 .code
5935 # local_part_suffix = +* : -*
5936 # local_part_suffix_optional
5937 .endd
5938 .vindex "&$local_part_suffix$&"
5939 show how you can specify the recognition of local part suffixes. If the first
5940 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5941 by any sequence of characters, is removed from the local part and placed in the
5942 variable &$local_part_suffix$&. The second suffix option specifies that the
5943 presence of a suffix in the local part is optional. When a suffix is present,
5944 the check for a local login uses the local part with the suffix removed.
5945
5946 When a local user account is found, the file called &_.forward_& in the user's
5947 home directory is consulted. If it does not exist, or is empty, the router
5948 declines. Otherwise, the contents of &_.forward_& are interpreted as
5949 redirection data (see chapter &<<CHAPredirect>>& for more details).
5950
5951 .cindex "Sieve filter" "enabling in default router"
5952 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5953 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5954 is commented out by default), the contents of the file are interpreted as a set
5955 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5956 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5957 separate document entitled &'Exim's interfaces to mail filtering'&.
5958
5959 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5960 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5961 There are two reasons for doing this:
5962
5963 .olist
5964 Whether or not a local user has a &_.forward_& file is not really relevant when
5965 checking an address for validity; it makes sense not to waste resources doing
5966 unnecessary work.
5967 .next
5968 More importantly, when Exim is verifying addresses or handling an EXPN
5969 command during an SMTP session, it is running as the Exim user, not as root.
5970 The group is the Exim group, and no additional groups are set up.
5971 It may therefore not be possible for Exim to read users' &_.forward_& files at
5972 this time.
5973 .endlist
5974
5975 The setting of &%check_ancestor%& prevents the router from generating a new
5976 address that is the same as any previous address that was redirected. (This
5977 works round a problem concerning a bad interaction between aliasing and
5978 forwarding &-- see section &<<SECTredlocmai>>&).
5979
5980 The final three option settings specify the transports that are to be used when
5981 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5982 auto-reply, respectively. For example, if a &_.forward_& file contains
5983 .code
5984 a.nother@elsewhere.example, /home/spqr/archive
5985 .endd
5986 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5987 transport.
5988 .code
5989 localuser:
5990   driver = accept
5991   check_local_user
5992 # local_part_suffix = +* : -*
5993 # local_part_suffix_optional
5994   transport = local_delivery
5995 .endd
5996 The final router sets up delivery into local mailboxes, provided that the local
5997 part is the name of a local login, by accepting the address and assigning it to
5998 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5999 routers, so the address is bounced. The commented suffix settings fulfil the
6000 same purpose as they do for the &(userforward)& router.
6001
6002
6003 .section "Transport configuration" "SECID56"
6004 .cindex "default" "transports"
6005 .cindex "transports" "default"
6006 Transports define mechanisms for actually delivering messages. They operate
6007 only when referenced from routers, so the order in which they are defined does
6008 not matter. The transports section of the configuration starts with
6009 .code
6010 begin transports
6011 .endd
6012 One remote transport and four local transports are defined.
6013 .code
6014 remote_smtp:
6015   driver = smtp
6016   hosts_try_prdr = *
6017 .endd
6018 This transport is used for delivering messages over SMTP connections.
6019 The list of remote hosts comes from the router.
6020 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6021 It is negotiated between client and server
6022 and not expected to cause problems but can be disabled if needed.
6023 All other options are defaulted.
6024 .code
6025 local_delivery:
6026   driver = appendfile
6027   file = /var/mail/$local_part
6028   delivery_date_add
6029   envelope_to_add
6030   return_path_add
6031 # group = mail
6032 # mode = 0660
6033 .endd
6034 This &(appendfile)& transport is used for local delivery to user mailboxes in
6035 traditional BSD mailbox format. By default it runs under the uid and gid of the
6036 local user, which requires the sticky bit to be set on the &_/var/mail_&
6037 directory. Some systems use the alternative approach of running mail deliveries
6038 under a particular group instead of using the sticky bit. The commented options
6039 show how this can be done.
6040
6041 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6042 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6043 similarly-named options above.
6044 .code
6045 address_pipe:
6046   driver = pipe
6047   return_output
6048 .endd
6049 This transport is used for handling deliveries to pipes that are generated by
6050 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6051 option specifies that any output generated by the pipe is to be returned to the
6052 sender.
6053 .code
6054 address_file:
6055   driver = appendfile
6056   delivery_date_add
6057   envelope_to_add
6058   return_path_add
6059 .endd
6060 This transport is used for handling deliveries to files that are generated by
6061 redirection. The name of the file is not specified in this instance of
6062 &(appendfile)&, because it comes from the &(redirect)& router.
6063 .code
6064 address_reply:
6065   driver = autoreply
6066 .endd
6067 This transport is used for handling automatic replies generated by users'
6068 filter files.
6069
6070
6071
6072 .section "Default retry rule" "SECID57"
6073 .cindex "retry" "default rule"
6074 .cindex "default" "retry rule"
6075 The retry section of the configuration file contains rules which affect the way
6076 Exim retries deliveries that cannot be completed at the first attempt. It is
6077 introduced by the line
6078 .code
6079 begin retry
6080 .endd
6081 In the default configuration, there is just one rule, which applies to all
6082 errors:
6083 .code
6084 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6085 .endd
6086 This causes any temporarily failing address to be retried every 15 minutes for
6087 2 hours, then at intervals starting at one hour and increasing by a factor of
6088 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6089 is not delivered after 4 days of temporary failure, it is bounced.
6090
6091 If the retry section is removed from the configuration, or is empty (that is,
6092 if no retry rules are defined), Exim will not retry deliveries. This turns
6093 temporary errors into permanent errors.
6094
6095
6096 .section "Rewriting configuration" "SECID58"
6097 The rewriting section of the configuration, introduced by
6098 .code
6099 begin rewrite
6100 .endd
6101 contains rules for rewriting addresses in messages as they arrive. There are no
6102 rewriting rules in the default configuration file.
6103
6104
6105
6106 .section "Authenticators configuration" "SECTdefconfauth"
6107 .cindex "AUTH" "configuration"
6108 The authenticators section of the configuration, introduced by
6109 .code
6110 begin authenticators
6111 .endd
6112 defines mechanisms for the use of the SMTP AUTH command. The default
6113 configuration file contains two commented-out example authenticators
6114 which support plaintext username/password authentication using the
6115 standard PLAIN mechanism and the traditional but non-standard LOGIN
6116 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6117 to support most MUA software.
6118
6119 The example PLAIN authenticator looks like this:
6120 .code
6121 #PLAIN:
6122 #  driver                  = plaintext
6123 #  server_set_id           = $auth2
6124 #  server_prompts          = :
6125 #  server_condition        = Authentication is not yet configured
6126 #  server_advertise_condition = ${if def:tls_in_cipher }
6127 .endd
6128 And the example LOGIN authenticator looks like this:
6129 .code
6130 #LOGIN:
6131 #  driver                  = plaintext
6132 #  server_set_id           = $auth1
6133 #  server_prompts          = <| Username: | Password:
6134 #  server_condition        = Authentication is not yet configured
6135 #  server_advertise_condition = ${if def:tls_in_cipher }
6136 .endd
6137
6138 The &%server_set_id%& option makes Exim remember the authenticated username
6139 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6140 &%server_prompts%& option configures the &(plaintext)& authenticator so
6141 that it implements the details of the specific authentication mechanism,
6142 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6143 when Exim offers authentication to clients; in the examples, this is only
6144 when TLS or SSL has been started, so to enable the authenticators you also
6145 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6146
6147 The &%server_condition%& setting defines how to verify that the username and
6148 password are correct. In the examples it just produces an error message.
6149 To make the authenticators work, you can use a string expansion
6150 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6151
6152 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6153 usercode and password are in different positions.
6154 Chapter &<<CHAPplaintext>>& covers both.
6155
6156 .ecindex IIDconfiwal
6157
6158
6159
6160 . ////////////////////////////////////////////////////////////////////////////
6161 . ////////////////////////////////////////////////////////////////////////////
6162
6163 .chapter "Regular expressions" "CHAPregexp"
6164
6165 .cindex "regular expressions" "library"
6166 .cindex "PCRE"
6167 Exim supports the use of regular expressions in many of its options. It
6168 uses the PCRE regular expression library; this provides regular expression
6169 matching that is compatible with Perl 5. The syntax and semantics of
6170 regular expressions is discussed in many Perl reference books, and also in
6171 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6172 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6173
6174 The documentation for the syntax and semantics of the regular expressions that
6175 are supported by PCRE is included in the PCRE distribution, and no further
6176 description is included here. The PCRE functions are called from Exim using
6177 the default option settings (that is, with no PCRE options set), except that
6178 the PCRE_CASELESS option is set when the matching is required to be
6179 case-insensitive.
6180
6181 In most cases, when a regular expression is required in an Exim configuration,
6182 it has to start with a circumflex, in order to distinguish it from plain text
6183 or an &"ends with"& wildcard. In this example of a configuration setting, the
6184 second item in the colon-separated list is a regular expression.
6185 .code
6186 domains = a.b.c : ^\\d{3} : *.y.z : ...
6187 .endd
6188 The doubling of the backslash is required because of string expansion that
6189 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6190 of this issue, and a way of avoiding the need for doubling backslashes. The
6191 regular expression that is eventually used in this example contains just one
6192 backslash. The circumflex is included in the regular expression, and has the
6193 normal effect of &"anchoring"& it to the start of the string that is being
6194 matched.
6195
6196 There are, however, two cases where a circumflex is not required for the
6197 recognition of a regular expression: these are the &%match%& condition in a
6198 string expansion, and the &%matches%& condition in an Exim filter file. In
6199 these cases, the relevant string is always treated as a regular expression; if
6200 it does not start with a circumflex, the expression is not anchored, and can
6201 match anywhere in the subject string.
6202
6203 In all cases, if you want a regular expression to match at the end of a string,
6204 you must code the $ metacharacter to indicate this. For example:
6205 .code
6206 domains = ^\\d{3}\\.example
6207 .endd
6208 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6209 You need to use:
6210 .code
6211 domains = ^\\d{3}\\.example\$
6212 .endd
6213 if you want &'example'& to be the top-level domain. The backslash before the
6214 $ is needed because string expansion also interprets dollar characters.
6215
6216
6217
6218 . ////////////////////////////////////////////////////////////////////////////
6219 . ////////////////////////////////////////////////////////////////////////////
6220
6221 .chapter "File and database lookups" "CHAPfdlookup"
6222 .scindex IIDfidalo1 "file" "lookups"
6223 .scindex IIDfidalo2 "database" "lookups"
6224 .cindex "lookup" "description of"
6225 Exim can be configured to look up data in files or databases as it processes
6226 messages. Two different kinds of syntax are used:
6227
6228 .olist
6229 A string that is to be expanded may contain explicit lookup requests. These
6230 cause parts of the string to be replaced by data that is obtained from the
6231 lookup. Lookups of this type are conditional expansion items. Different results
6232 can be defined for the cases of lookup success and failure. See chapter
6233 &<<CHAPexpand>>&, where string expansions are described in detail.
6234 .next
6235 Lists of domains, hosts, and email addresses can contain lookup requests as a
6236 way of avoiding excessively long linear lists. In this case, the data that is
6237 returned by the lookup is often (but not always) discarded; whether the lookup
6238 succeeds or fails is what really counts. These kinds of list are described in
6239 chapter &<<CHAPdomhosaddlists>>&.
6240 .endlist
6241
6242 String expansions, lists, and lookups interact with each other in such a way
6243 that there is no order in which to describe any one of them that does not
6244 involve references to the others. Each of these three chapters makes more sense
6245 if you have read the other two first. If you are reading this for the first
6246 time, be aware that some of it will make a lot more sense after you have read
6247 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6248
6249 .section "Examples of different lookup syntax" "SECID60"
6250 It is easy to confuse the two different kinds of lookup, especially as the
6251 lists that may contain the second kind are always expanded before being
6252 processed as lists. Therefore, they may also contain lookups of the first kind.
6253 Be careful to distinguish between the following two examples:
6254 .code
6255 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6256 domains = lsearch;/some/file
6257 .endd
6258 The first uses a string expansion, the result of which must be a domain list.
6259 No strings have been specified for a successful or a failing lookup; the
6260 defaults in this case are the looked-up data and an empty string, respectively.
6261 The expansion takes place before the string is processed as a list, and the
6262 file that is searched could contain lines like this:
6263 .code
6264 192.168.3.4: domain1:domain2:...
6265 192.168.1.9: domain3:domain4:...
6266 .endd
6267 When the lookup succeeds, the result of the expansion is a list of domains (and
6268 possibly other types of item that are allowed in domain lists).
6269
6270 In the second example, the lookup is a single item in a domain list. It causes
6271 Exim to use a lookup to see if the domain that is being processed can be found
6272 in the file. The file could contains lines like this:
6273 .code
6274 domain1:
6275 domain2:
6276 .endd
6277 Any data that follows the keys is not relevant when checking that the domain
6278 matches the list item.
6279
6280 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6281 Consider a file containing lines like this:
6282 .code
6283 192.168.5.6: lsearch;/another/file
6284 .endd
6285 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6286 first &%domains%& setting above generates the second setting, which therefore
6287 causes a second lookup to occur.
6288
6289 The rest of this chapter describes the different lookup types that are
6290 available. Any of them can be used in any part of the configuration where a
6291 lookup is permitted.
6292
6293
6294 .section "Lookup types" "SECID61"
6295 .cindex "lookup" "types of"
6296 .cindex "single-key lookup" "definition of"
6297 Two different types of data lookup are implemented:
6298
6299 .ilist
6300 The &'single-key'& type requires the specification of a file in which to look,
6301 and a single key to search for. The key must be a non-empty string for the
6302 lookup to succeed. The lookup type determines how the file is searched.
6303 .next
6304 .cindex "query-style lookup" "definition of"
6305 The &'query-style'& type accepts a generalized database query. No particular
6306 key value is assumed by Exim for query-style lookups. You can use whichever
6307 Exim variables you need to construct the database query.
6308 .endlist
6309
6310 The code for each lookup type is in a separate source file that is included in
6311 the binary of Exim only if the corresponding compile-time option is set. The
6312 default settings in &_src/EDITME_& are:
6313 .code
6314 LOOKUP_DBM=yes
6315 LOOKUP_LSEARCH=yes
6316 .endd
6317 which means that only linear searching and DBM lookups are included by default.
6318 For some types of lookup (e.g. SQL databases), you need to install appropriate
6319 libraries and header files before building Exim.
6320
6321
6322
6323
6324 .section "Single-key lookup types" "SECTsinglekeylookups"
6325 .cindex "lookup" "single-key types"
6326 .cindex "single-key lookup" "list of types"
6327 The following single-key lookup types are implemented:
6328
6329 .ilist
6330 .cindex "cdb" "description of"
6331 .cindex "lookup" "cdb"
6332 .cindex "binary zero" "in lookup key"
6333 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6334 string without a terminating binary zero. The cdb format is designed for
6335 indexed files that are read frequently and never updated, except by total
6336 re-creation. As such, it is particularly suitable for large files containing
6337 aliases or other indexed data referenced by an MTA. Information about cdb can
6338 be found in several places:
6339 .display
6340 &url(http://www.pobox.com/~djb/cdb.html)
6341 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6342 &url(http://packages.debian.org/stable/utils/freecdb.html)
6343 .endd
6344 A cdb distribution is not needed in order to build Exim with cdb support,
6345 because the code for reading cdb files is included directly in Exim itself.
6346 However, no means of building or testing cdb files is provided with Exim, so
6347 you need to obtain a cdb distribution in order to do this.
6348 .next
6349 .cindex "DBM" "lookup type"
6350 .cindex "lookup" "dbm"
6351 .cindex "binary zero" "in lookup key"
6352 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6353 DBM file by looking up the record with the given key. A terminating binary
6354 zero is included in the key that is passed to the DBM library. See section
6355 &<<SECTdb>>& for a discussion of DBM libraries.
6356
6357 .cindex "Berkeley DB library" "file format"
6358 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6359 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6360 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6361 the DB_UNKNOWN option. This enables it to handle any of the types of database
6362 that the library supports, and can be useful for accessing DBM files created by
6363 other applications. (For earlier DB versions, DB_HASH is always used.)
6364 .next
6365 .cindex "lookup" "dbmjz"
6366 .cindex "lookup" "dbm &-- embedded NULs"
6367 .cindex "sasldb2"
6368 .cindex "dbmjz lookup type"
6369 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6370 interpreted as an Exim list; the elements of the list are joined together with
6371 ASCII NUL characters to form the lookup key.  An example usage would be to
6372 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6373 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6374 &(cram_md5)& authenticator.
6375 .next
6376 .cindex "lookup" "dbmnz"
6377 .cindex "lookup" "dbm &-- terminating zero"
6378 .cindex "binary zero" "in lookup key"
6379 .cindex "Courier"
6380 .cindex "&_/etc/userdbshadow.dat_&"
6381 .cindex "dbmnz lookup type"
6382 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6383 is not included in the key that is passed to the DBM library. You may need this
6384 if you want to look up data in files that are created by or shared with some
6385 other application that does not use terminating zeros. For example, you need to
6386 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6387 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6388 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6389 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6390 .next
6391 .cindex "lookup" "dsearch"
6392 .cindex "dsearch lookup type"
6393 &(dsearch)&: The given file must be a directory; this is searched for an entry
6394 whose name is the key by calling the &[lstat()]& function. The key may not
6395 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6396 the lookup is the name of the entry, which may be a file, directory,
6397 symbolic link, or any other kind of directory entry. An example of how this
6398 lookup can be used to support virtual domains is given in section
6399 &<<SECTvirtualdomains>>&.
6400 .next
6401 .cindex "lookup" "iplsearch"
6402 .cindex "iplsearch lookup type"
6403 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6404 terminated by a colon or white space or the end of the line. The keys in the
6405 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6406 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6407 being interpreted as a key terminator. For example:
6408 .code
6409 1.2.3.4:           data for 1.2.3.4
6410 192.168.0.0/16:    data for 192.168.0.0/16
6411 "abcd::cdab":      data for abcd::cdab
6412 "abcd:abcd::/32"   data for abcd:abcd::/32
6413 .endd
6414 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6415 file is searched linearly, using the CIDR masks where present, until a matching
6416 key is found. The first key that matches is used; there is no attempt to find a
6417 &"best"& match. Apart from the way the keys are matched, the processing for
6418 &(iplsearch)& is the same as for &(lsearch)&.
6419
6420 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6421 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6422 lookup types support only literal keys.
6423
6424 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6425 the implicit key is the host's IP address rather than its name (see section
6426 &<<SECThoslispatsikey>>&).
6427 .next
6428 .cindex "linear search"
6429 .cindex "lookup" "lsearch"
6430 .cindex "lsearch lookup type"
6431 .cindex "case sensitivity" "in lsearch lookup"
6432 &(lsearch)&: The given file is a text file that is searched linearly for a
6433 line beginning with the search key, terminated by a colon or white space or the
6434 end of the line. The search is case-insensitive; that is, upper and lower case
6435 letters are treated as the same. The first occurrence of the key that is found
6436 in the file is used.
6437
6438 White space between the key and the colon is permitted. The remainder of the
6439 line, with leading and trailing white space removed, is the data. This can be
6440 continued onto subsequent lines by starting them with any amount of white
6441 space, but only a single space character is included in the data at such a
6442 junction. If the data begins with a colon, the key must be terminated by a
6443 colon, for example:
6444 .code
6445 baduser:  :fail:
6446 .endd
6447 Empty lines and lines beginning with # are ignored, even if they occur in the
6448 middle of an item. This is the traditional textual format of alias files. Note
6449 that the keys in an &(lsearch)& file are literal strings. There is no
6450 wildcarding of any kind.
6451
6452 .cindex "lookup" "lsearch &-- colons in keys"
6453 .cindex "white space" "in lsearch key"
6454 In most &(lsearch)& files, keys are not required to contain colons or #
6455 characters, or white space. However, if you need this feature, it is available.
6456 If a key begins with a doublequote character, it is terminated only by a
6457 matching quote (or end of line), and the normal escaping rules apply to its
6458 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6459 quoted keys (exactly as for unquoted keys). There is no special handling of
6460 quotes for the data part of an &(lsearch)& line.
6461
6462 .next
6463 .cindex "NIS lookup type"
6464 .cindex "lookup" "NIS"
6465 .cindex "binary zero" "in lookup key"
6466 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6467 the given key, without a terminating binary zero. There is a variant called
6468 &(nis0)& which does include the terminating binary zero in the key. This is
6469 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6470 aliases; the full map names must be used.
6471
6472 .next
6473 .cindex "wildlsearch lookup type"
6474 .cindex "lookup" "wildlsearch"
6475 .cindex "nwildlsearch lookup type"
6476 .cindex "lookup" "nwildlsearch"
6477 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6478 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6479 the file may be wildcarded. The difference between these two lookup types is
6480 that for &(wildlsearch)&, each key in the file is string-expanded before being
6481 used, whereas for &(nwildlsearch)&, no expansion takes place.
6482
6483 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6484 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6485 file that are regular expressions can be made case-sensitive by the use of
6486 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6487
6488 . ==== As this is a nested list, any displays it contains must be indented
6489 . ==== as otherwise they are too far to the left.
6490
6491 .olist
6492 The string may begin with an asterisk to mean &"ends with"&. For example:
6493 .code
6494     *.a.b.c       data for anything.a.b.c
6495     *fish         data for anythingfish
6496 .endd
6497 .next
6498 The string may begin with a circumflex to indicate a regular expression. For
6499 example, for &(wildlsearch)&:
6500 .code
6501     ^\N\d+\.a\.b\N    data for <digits>.a.b
6502 .endd
6503 Note the use of &`\N`& to disable expansion of the contents of the regular
6504 expression. If you are using &(nwildlsearch)&, where the keys are not
6505 string-expanded, the equivalent entry is:
6506 .code
6507     ^\d+\.a\.b        data for <digits>.a.b
6508 .endd
6509 The case-insensitive flag is set at the start of compiling the regular
6510 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6511 For example, to make the entire pattern case-sensitive:
6512 .code
6513     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6514 .endd
6515
6516 If the regular expression contains white space or colon characters, you must
6517 either quote it (see &(lsearch)& above), or represent these characters in other
6518 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6519 colon. This may be easier than quoting, because if you quote, you have to
6520 escape all the backslashes inside the quotes.
6521
6522 &*Note*&: It is not possible to capture substrings in a regular expression
6523 match for later use, because the results of all lookups are cached. If a lookup
6524 is repeated, the result is taken from the cache, and no actual pattern matching
6525 takes place. The values of all the numeric variables are unset after a
6526 &((n)wildlsearch)& match.
6527
6528 .next
6529 Although I cannot see it being of much use, the general matching function that
6530 is used to implement &((n)wildlsearch)& means that the string may begin with a
6531 lookup name terminated by a semicolon, and followed by lookup data. For
6532 example:
6533 .code
6534     cdb;/some/file  data for keys that match the file
6535 .endd
6536 The data that is obtained from the nested lookup is discarded.
6537 .endlist olist
6538
6539 Keys that do not match any of these patterns are interpreted literally. The
6540 continuation rules for the data are the same as for &(lsearch)&, and keys may
6541 be followed by optional colons.
6542
6543 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6544 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6545 lookup types support only literal keys.
6546 .endlist ilist
6547
6548
6549 .section "Query-style lookup types" "SECID62"
6550 .cindex "lookup" "query-style types"
6551 .cindex "query-style lookup" "list of types"
6552 The supported query-style lookup types are listed below. Further details about
6553 many of them are given in later sections.
6554
6555 .ilist
6556 .cindex "DNS" "as a lookup type"
6557 .cindex "lookup" "DNS"
6558 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6559 are given in the supplied query. The resulting data is the contents of the
6560 records. See section &<<SECTdnsdb>>&.
6561 .next
6562 .cindex "InterBase lookup type"
6563 .cindex "lookup" "InterBase"
6564 &(ibase)&: This does a lookup in an InterBase database.
6565 .next
6566 .cindex "LDAP" "lookup type"
6567 .cindex "lookup" "LDAP"
6568 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6569 returns attributes from a single entry. There is a variant called &(ldapm)&
6570 that permits values from multiple entries to be returned. A third variant
6571 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6572 any attribute values. See section &<<SECTldap>>&.
6573 .next
6574 .cindex "MySQL" "lookup type"
6575 .cindex "lookup" "MySQL"
6576 &(mysql)&: The format of the query is an SQL statement that is passed to a
6577 MySQL database. See section &<<SECTsql>>&.
6578 .next
6579 .cindex "NIS+ lookup type"
6580 .cindex "lookup" "NIS+"
6581 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6582 the field to be returned. See section &<<SECTnisplus>>&.
6583 .next
6584 .cindex "Oracle" "lookup type"
6585 .cindex "lookup" "Oracle"
6586 &(oracle)&: The format of the query is an SQL statement that is passed to an
6587 Oracle database. See section &<<SECTsql>>&.
6588 .next
6589 .cindex "lookup" "passwd"
6590 .cindex "passwd lookup type"
6591 .cindex "&_/etc/passwd_&"
6592 &(passwd)& is a query-style lookup with queries that are just user names. The
6593 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6594 success, the result string is the same as you would get from an &(lsearch)&
6595 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6596 password value. For example:
6597 .code
6598 *:42:42:King Rat:/home/kr:/bin/bash
6599 .endd
6600 .next
6601 .cindex "PostgreSQL lookup type"
6602 .cindex "lookup" "PostgreSQL"
6603 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6604 PostgreSQL database. See section &<<SECTsql>>&.
6605
6606 .next
6607 .cindex "sqlite lookup type"
6608 .cindex "lookup" "sqlite"
6609 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6610 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6611
6612 .next
6613 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6614 not likely to be useful in normal operation.
6615 .next
6616 .cindex "whoson lookup type"
6617 .cindex "lookup" "whoson"
6618 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6619 allows a server to check whether a particular (dynamically allocated) IP
6620 address is currently allocated to a known (trusted) user and, optionally, to
6621 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6622 at one time for &"POP before SMTP"& authentication, but that approach has been
6623 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6624 &"POP before SMTP"& checking using ACL statements such as
6625 .code
6626 require condition = \
6627   ${lookup whoson {$sender_host_address}{yes}{no}}
6628 .endd
6629 The query consists of a single IP address. The value returned is the name of
6630 the authenticated user, which is stored in the variable &$value$&. However, in
6631 this example, the data in &$value$& is not used; the result of the lookup is
6632 one of the fixed strings &"yes"& or &"no"&.
6633 .endlist
6634
6635
6636
6637 .section "Temporary errors in lookups" "SECID63"
6638 .cindex "lookup" "temporary error in"
6639 Lookup functions can return temporary error codes if the lookup cannot be
6640 completed. For example, an SQL or LDAP database might be unavailable. For this
6641 reason, it is not advisable to use a lookup that might do this for critical
6642 options such as a list of local domains.
6643
6644 When a lookup cannot be completed in a router or transport, delivery
6645 of the message (to the relevant address) is deferred, as for any other
6646 temporary error. In other circumstances Exim may assume the lookup has failed,
6647 or may give up altogether.
6648
6649
6650
6651 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6652 .cindex "wildcard lookups"
6653 .cindex "lookup" "default values"
6654 .cindex "lookup" "wildcard"
6655 .cindex "lookup" "* added to type"
6656 .cindex "default" "in single-key lookups"
6657 In this context, a &"default value"& is a value specified by the administrator
6658 that is to be used if a lookup fails.
6659
6660 &*Note:*& This section applies only to single-key lookups. For query-style
6661 lookups, the facilities of the query language must be used. An attempt to
6662 specify a default for a query-style lookup provokes an error.
6663
6664 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6665 and the initial lookup fails, the key &"*"& is looked up in the file to
6666 provide a default value. See also the section on partial matching below.
6667
6668 .cindex "*@ with single-key lookup"
6669 .cindex "lookup" "*@ added to type"
6670 .cindex "alias file" "per-domain default"
6671 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6672 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6673 character, a second lookup is done with everything before the last @ replaced
6674 by *. This makes it possible to provide per-domain defaults in alias files
6675 that include the domains in the keys. If the second lookup fails (or doesn't
6676 take place because there is no @ in the key), &"*"& is looked up.
6677 For example, a &(redirect)& router might contain:
6678 .code
6679 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6680 .endd
6681 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6682 looks up these keys, in this order:
6683 .code
6684 jane@eyre.example
6685 *@eyre.example
6686 *
6687 .endd
6688 The data is taken from whichever key it finds first. &*Note*&: In an
6689 &(lsearch)& file, this does not mean the first of these keys in the file. A
6690 complete scan is done for each key, and only if it is not found at all does
6691 Exim move on to try the next key.
6692
6693
6694
6695 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6696 .cindex "partial matching"
6697 .cindex "wildcard lookups"
6698 .cindex "lookup" "partial matching"
6699 .cindex "lookup" "wildcard"
6700 .cindex "asterisk" "in search type"
6701 The normal operation of a single-key lookup is to search the file for an exact
6702 match with the given key. However, in a number of situations where domains are
6703 being looked up, it is useful to be able to do partial matching. In this case,
6704 information in the file that has a key starting with &"*."& is matched by any
6705 domain that ends with the components that follow the full stop. For example, if
6706 a key in a DBM file is
6707 .code
6708 *.dates.fict.example
6709 .endd
6710 then when partial matching is enabled this is matched by (amongst others)
6711 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6712 by &'dates.fict.example'&, if that does not appear as a separate key in the
6713 file.
6714
6715 &*Note*&: Partial matching is not available for query-style lookups. It is
6716 also not available for any lookup items in address lists (see section
6717 &<<SECTaddresslist>>&).
6718
6719 Partial matching is implemented by doing a series of separate lookups using
6720 keys constructed by modifying the original subject key. This means that it can
6721 be used with any of the single-key lookup types, provided that
6722 partial matching keys
6723 beginning with a special prefix (default &"*."&) are included in the data file.
6724 Keys in the file that do not begin with the prefix are matched only by
6725 unmodified subject keys when partial matching is in use.
6726
6727 Partial matching is requested by adding the string &"partial-"& to the front of
6728 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6729 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6730 is added at the start of the subject key, and it is looked up again. If that
6731 fails, further lookups are tried with dot-separated components removed from the
6732 start of the subject key, one-by-one, and &"*."& added on the front of what
6733 remains.
6734
6735 A minimum number of two non-* components are required. This can be adjusted
6736 by including a number before the hyphen in the search type. For example,
6737 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6738 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6739 subject key is &'2250.dates.fict.example'& then the following keys are looked
6740 up when the minimum number of non-* components is two:
6741 .code
6742 2250.dates.fict.example
6743 *.2250.dates.fict.example
6744 *.dates.fict.example
6745 *.fict.example
6746 .endd
6747 As soon as one key in the sequence is successfully looked up, the lookup
6748 finishes.
6749
6750 .cindex "lookup" "partial matching &-- changing prefix"
6751 .cindex "prefix" "for partial matching"
6752 The use of &"*."& as the partial matching prefix is a default that can be
6753 changed. The motivation for this feature is to allow Exim to operate with file
6754 formats that are used by other MTAs. A different prefix can be supplied in
6755 parentheses instead of the hyphen after &"partial"&. For example:
6756 .code
6757 domains = partial(.)lsearch;/some/file
6758 .endd
6759 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6760 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6761 components is unchanged). The prefix may consist of any punctuation characters
6762 other than a closing parenthesis. It may be empty, for example:
6763 .code
6764 domains = partial1()cdb;/some/file
6765 .endd
6766 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6767 &`a.b.c`&, &`b.c`&, and &`c`&.
6768
6769 If &"partial0"& is specified, what happens at the end (when the lookup with
6770 just one non-wild component has failed, and the original key is shortened right
6771 down to the null string) depends on the prefix:
6772
6773 .ilist
6774 If the prefix has zero length, the whole lookup fails.
6775 .next
6776 If the prefix has length 1, a lookup for just the prefix is done. For
6777 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6778 .next
6779 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6780 remainder is looked up. With the default prefix, therefore, the final lookup is
6781 for &"*"& on its own.
6782 .next
6783 Otherwise, the whole prefix is looked up.
6784 .endlist
6785
6786
6787 If the search type ends in &"*"& or &"*@"& (see section
6788 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6789 this implies happens after all partial lookups have failed. If &"partial0"& is
6790 specified, adding &"*"& to the search type has no effect with the default
6791 prefix, because the &"*"& key is already included in the sequence of partial
6792 lookups. However, there might be a use for lookup types such as
6793 &"partial0(.)lsearch*"&.
6794
6795 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6796 in domain lists and the like. Partial matching works only in terms of
6797 dot-separated components; a key such as &`*fict.example`&
6798 in a database file is useless, because the asterisk in a partial matching
6799 subject key is always followed by a dot.
6800
6801
6802
6803
6804 .section "Lookup caching" "SECID64"
6805 .cindex "lookup" "caching"
6806 .cindex "caching" "lookup data"
6807 Exim caches all lookup results in order to avoid needless repetition of
6808 lookups. However, because (apart from the daemon) Exim operates as a collection
6809 of independent, short-lived processes, this caching applies only within a
6810 single Exim process. There is no inter-process lookup caching facility.
6811
6812 For single-key lookups, Exim keeps the relevant files open in case there is
6813 another lookup that needs them. In some types of configuration this can lead to
6814 many files being kept open for messages with many recipients. To avoid hitting
6815 the operating system limit on the number of simultaneously open files, Exim
6816 closes the least recently used file when it needs to open more files than its
6817 own internal limit, which can be changed via the &%lookup_open_max%& option.
6818
6819 The single-key lookup files are closed and the lookup caches are flushed at
6820 strategic points during delivery &-- for example, after all routing is
6821 complete.
6822
6823
6824
6825
6826 .section "Quoting lookup data" "SECID65"
6827 .cindex "lookup" "quoting"
6828 .cindex "quoting" "in lookups"
6829 When data from an incoming message is included in a query-style lookup, there
6830 is the possibility of special characters in the data messing up the syntax of
6831 the query. For example, a NIS+ query that contains
6832 .code
6833 [name=$local_part]
6834 .endd
6835 will be broken if the local part happens to contain a closing square bracket.
6836 For NIS+, data can be enclosed in double quotes like this:
6837 .code
6838 [name="$local_part"]
6839 .endd
6840 but this still leaves the problem of a double quote in the data. The rule for
6841 NIS+ is that double quotes must be doubled. Other lookup types have different
6842 rules, and to cope with the differing requirements, an expansion operator
6843 of the following form is provided:
6844 .code
6845 ${quote_<lookup-type>:<string>}
6846 .endd
6847 For example, the safest way to write the NIS+ query is
6848 .code
6849 [name="${quote_nisplus:$local_part}"]
6850 .endd
6851 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6852 operator can be used for all lookup types, but has no effect for single-key
6853 lookups, since no quoting is ever needed in their key strings.
6854
6855
6856
6857
6858 .section "More about dnsdb" "SECTdnsdb"
6859 .cindex "dnsdb lookup"
6860 .cindex "lookup" "dnsdb"
6861 .cindex "DNS" "as a lookup type"
6862 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6863 of a record type and a domain name, separated by an equals sign. For example,
6864 an expansion string could contain:
6865 .code
6866 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6867 .endd
6868 If the lookup succeeds, the result is placed in &$value$&, which in this case
6869 is used on its own as the result. If the lookup does not succeed, the
6870 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6871 &<<SECTforexpfai>>& for an explanation of what this means.
6872
6873 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6874 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6875 configured). If no type is given, TXT is assumed. When the type is PTR,
6876 the data can be an IP address, written as normal; inversion and the addition of
6877 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6878 .code
6879 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6880 .endd
6881 If the data for a PTR record is not a syntactically valid IP address, it is not
6882 altered and nothing is added.
6883
6884 For any record type, if multiple records are found (or, for A6 lookups, if a
6885 single record leads to multiple addresses), the data is returned as a
6886 concatenation, with newline as the default separator. The order, of course,
6887 depends on the DNS resolver. You can specify a different separator character
6888 between multiple records by putting a right angle-bracket followed immediately
6889 by the new separator at the start of the query. For example:
6890 .code
6891 ${lookup dnsdb{>: a=host1.example}}
6892 .endd
6893 It is permitted to specify a space as the separator character. Further
6894 white space is ignored.
6895
6896 .cindex "MX record" "in &(dnsdb)& lookup"
6897 .cindex "SRV record" "in &(dnsdb)& lookup"
6898 For an MX lookup, both the preference value and the host name are returned for
6899 each record, separated by a space. For an SRV lookup, the priority, weight,
6900 port, and host name are returned for each record, separated by spaces.
6901 An alternate field separator can be specified using a comma after the main
6902 separator character, followed immediately by the field separator.
6903
6904 .cindex "TXT record" "in &(dnsdb)& lookup"
6905 .cindex "SPF record" "in &(dnsdb)& lookup"
6906 For TXT records with multiple items of data, only the first item is returned,
6907 unless a separator for them is specified using a comma after the separator
6908 character followed immediately by the TXT record item separator. To concatenate
6909 items without a separator, use a semicolon instead. For SPF records the
6910 default behaviour is to concatenate multiple items without using a separator.
6911 .code
6912 ${lookup dnsdb{>\n,: txt=a.b.example}}
6913 ${lookup dnsdb{>\n; txt=a.b.example}}
6914 ${lookup dnsdb{spf=example.org}}
6915 .endd
6916 It is permitted to specify a space as the separator character. Further
6917 white space is ignored.
6918
6919 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6920 .cindex "dnsdb modifiers"
6921 .cindex "modifiers" "dnsdb"
6922 .cindex "options" "dnsdb"
6923 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6924 each followed by a comma,
6925 that may appear before the record type.
6926
6927 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6928 temporary DNS error for any of them, the behaviour is controlled by
6929 a defer-option modifier.
6930 The possible keywords are
6931 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6932 With &"strict"& behaviour, any temporary DNS error causes the
6933 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6934 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6935 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6936 error causes the whole lookup to defer only if none of the other lookups
6937 succeed. The default is &"lax"&, so the following lookups are equivalent:
6938 .code
6939 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6940 ${lookup dnsdb{a=one.host.com:two.host.com}}
6941 .endd
6942 Thus, in the default case, as long as at least one of the DNS lookups
6943 yields some data, the lookup succeeds.
6944
6945 .cindex "DNSSEC" "dns lookup"
6946 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6947 The possible keywords are
6948 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6949 With &"strict"& or &"lax"& DNSSEC information is requested
6950 with the lookup.
6951 With &"strict"& a response from the DNS resolver that
6952 is not labelled as authenticated data
6953 is treated as equivalent to a temporary DNS error.
6954 The default is &"never"&.
6955
6956 See also the &$lookup_dnssec_authenticated$& variable.
6957
6958
6959 .section "Pseudo dnsdb record types" "SECID66"
6960 .cindex "MX record" "in &(dnsdb)& lookup"
6961 By default, both the preference value and the host name are returned for
6962 each MX record, separated by a space. If you want only host names, you can use
6963 the pseudo-type MXH:
6964 .code
6965 ${lookup dnsdb{mxh=a.b.example}}
6966 .endd
6967 In this case, the preference values are omitted, and just the host names are
6968 returned.
6969
6970 .cindex "name server for enclosing domain"
6971 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6972 records on the given domain, but if none are found, it removes the first
6973 component of the domain name, and tries again. This process continues until NS
6974 records are found or there are no more components left (or there is a DNS
6975 error). In other words, it may return the name servers for a top-level domain,
6976 but it never returns the root name servers. If there are no NS records for the
6977 top-level domain, the lookup fails. Consider these examples:
6978 .code
6979 ${lookup dnsdb{zns=xxx.quercite.com}}
6980 ${lookup dnsdb{zns=xxx.edu}}
6981 .endd
6982 Assuming that in each case there are no NS records for the full domain name,
6983 the first returns the name servers for &%quercite.com%&, and the second returns
6984 the name servers for &%edu%&.
6985
6986 You should be careful about how you use this lookup because, unless the
6987 top-level domain does not exist, the lookup always returns some host names. The
6988 sort of use to which this might be put is for seeing if the name servers for a
6989 given domain are on a blacklist. You can probably assume that the name servers
6990 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6991 such a list.
6992
6993 .cindex "CSA" "in &(dnsdb)& lookup"
6994 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6995 records according to the CSA rules, which are described in section
6996 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6997 not sufficient because of the extra parent domain search behaviour of CSA. The
6998 result of a successful lookup such as:
6999 .code
7000 ${lookup dnsdb {csa=$sender_helo_name}}
7001 .endd
7002 has two space-separated fields: an authorization code and a target host name.
7003 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7004 authorization required but absent, or &"?"& for unknown.
7005
7006 .cindex "A+" "in &(dnsdb)& lookup"
7007 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
7008 and then an A lookup.  All results are returned; defer processing
7009 (see below) is handled separately for each lookup.  Example:
7010 .code
7011 ${lookup dnsdb {>; a+=$sender_helo_name}}
7012 .endd
7013
7014
7015 .section "Multiple dnsdb lookups" "SECID67"
7016 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7017 However, you can specify a list of domains or IP addresses in a single
7018 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7019 the default separator, but with the ability to change this. For example:
7020 .code
7021 ${lookup dnsdb{one.domain.com:two.domain.com}}
7022 ${lookup dnsdb{a=one.host.com:two.host.com}}
7023 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7024 .endd
7025 In order to retain backwards compatibility, there is one special case: if
7026 the lookup type is PTR and no change of separator is specified, Exim looks
7027 to see if the rest of the string is precisely one IPv6 address. In this
7028 case, it does not treat it as a list.
7029
7030 The data from each lookup is concatenated, with newline separators by default,
7031 in the same way that multiple DNS records for a single item are handled. A
7032 different separator can be specified, as described above.
7033
7034
7035
7036
7037 .section "More about LDAP" "SECTldap"
7038 .cindex "LDAP" "lookup, more about"
7039 .cindex "lookup" "LDAP"
7040 .cindex "Solaris" "LDAP"
7041 The original LDAP implementation came from the University of Michigan; this has
7042 become &"Open LDAP"&, and there are now two different releases. Another
7043 implementation comes from Netscape, and Solaris 7 and subsequent releases
7044 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7045 the lookup function level, their error handling is different. For this reason
7046 it is necessary to set a compile-time variable when building Exim with LDAP, to
7047 indicate which LDAP library is in use. One of the following should appear in
7048 your &_Local/Makefile_&:
7049 .code
7050 LDAP_LIB_TYPE=UMICHIGAN
7051 LDAP_LIB_TYPE=OPENLDAP1
7052 LDAP_LIB_TYPE=OPENLDAP2
7053 LDAP_LIB_TYPE=NETSCAPE
7054 LDAP_LIB_TYPE=SOLARIS
7055 .endd
7056 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7057 same interface as the University of Michigan version.
7058
7059 There are three LDAP lookup types in Exim. These behave slightly differently in
7060 the way they handle the results of a query:
7061
7062 .ilist
7063 &(ldap)& requires the result to contain just one entry; if there are more, it
7064 gives an error.
7065 .next
7066 &(ldapdn)& also requires the result to contain just one entry, but it is the
7067 Distinguished Name that is returned rather than any attribute values.
7068 .next
7069 &(ldapm)& permits the result to contain more than one entry; the attributes
7070 from all of them are returned.
7071 .endlist
7072
7073
7074 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7075 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7076 the data returned by a successful lookup is described in the next section.
7077 First we explain how LDAP queries are coded.
7078
7079
7080 .section "Format of LDAP queries" "SECTforldaque"
7081 .cindex "LDAP" "query format"
7082 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7083 the configuration of a &(redirect)& router one might have this setting:
7084 .code
7085 data = ${lookup ldap \
7086   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7087   c=UK?mailbox?base?}}
7088 .endd
7089 .cindex "LDAP" "with TLS"
7090 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7091 secure (encrypted) LDAP connections. The second of these ensures that an
7092 encrypted TLS connection is used.
7093
7094 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7095 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7096 See the &%ldap_start_tls%& option.
7097
7098 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7099 controlled. Every part of the TLS configuration can be configured by settings in
7100 &_exim.conf_&. Depending on the version of the client libraries installed on
7101 your system, some of the initialization may have required setting options in
7102 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7103 certificates. This revealed a nuance where the current UID that exim was
7104 running as could affect which config files it read. With Exim 4.83, these
7105 methods become optional, only taking effect if not specifically set in
7106 &_exim.conf_&.
7107
7108
7109 .section "LDAP quoting" "SECID68"
7110 .cindex "LDAP" "quoting"
7111 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7112 and the second because the LDAP query is represented as a URL. Furthermore,
7113 within an LDAP query, two different kinds of quoting are required. For this
7114 reason, there are two different LDAP-specific quoting operators.
7115
7116 The &%quote_ldap%& operator is designed for use on strings that are part of
7117 filter specifications. Conceptually, it first does the following conversions on
7118 the string:
7119 .code
7120 *   =>   \2A
7121 (   =>   \28
7122 )   =>   \29
7123 \   =>   \5C
7124 .endd
7125 in accordance with RFC 2254. The resulting string is then quoted according
7126 to the rules for URLs, that is, all non-alphanumeric characters except
7127 .code
7128 ! $ ' - . _ ( ) * +
7129 .endd
7130 are converted to their hex values, preceded by a percent sign. For example:
7131 .code
7132 ${quote_ldap: a(bc)*, a<yz>; }
7133 .endd
7134 yields
7135 .code
7136 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7137 .endd
7138 Removing the URL quoting, this is (with a leading and a trailing space):
7139 .code
7140 a\28bc\29\2A, a<yz>;
7141 .endd
7142 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7143 base DN specifications in queries. Conceptually, it first converts the string
7144 by inserting a backslash in front of any of the following characters:
7145 .code
7146 , + " \ < > ;
7147 .endd
7148 It also inserts a backslash before any leading spaces or # characters, and
7149 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7150 is then quoted according to the rules for URLs. For example:
7151 .code
7152 ${quote_ldap_dn: a(bc)*, a<yz>; }
7153 .endd
7154 yields
7155 .code
7156 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7157 .endd
7158 Removing the URL quoting, this is (with a trailing space):
7159 .code
7160 \ a(bc)*\, a\<yz\>\;\
7161 .endd
7162 There are some further comments about quoting in the section on LDAP
7163 authentication below.
7164
7165
7166 .section "LDAP connections" "SECID69"
7167 .cindex "LDAP" "connections"
7168 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7169 is in use, via a Unix domain socket. The example given above does not specify
7170 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7171 by starting it with
7172 .code
7173 ldap://<hostname>:<port>/...
7174 .endd
7175 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7176 used. When no server is specified in a query, a list of default servers is
7177 taken from the &%ldap_default_servers%& configuration option. This supplies a
7178 colon-separated list of servers which are tried in turn until one successfully
7179 handles a query, or there is a serious error. Successful handling either
7180 returns the requested data, or indicates that it does not exist. Serious errors
7181 are syntactical, or multiple values when only a single value is expected.
7182 Errors which cause the next server to be tried are connection failures, bind
7183 failures, and timeouts.
7184
7185 For each server name in the list, a port number can be given. The standard way
7186 of specifying a host and port is to use a colon separator (RFC 1738). Because
7187 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7188 doubled. For example
7189 .code
7190 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7191 .endd
7192 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7193 to the LDAP library with no server name, and the library's default (normally
7194 the local host) is used.
7195
7196 If you are using the OpenLDAP library, you can connect to an LDAP server using
7197 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7198 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7199 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7200 not available.
7201
7202 For this type of connection, instead of a host name for the server, a pathname
7203 for the socket is required, and the port number is not relevant. The pathname
7204 can be specified either as an item in &%ldap_default_servers%&, or inline in
7205 the query. In the former case, you can have settings such as
7206 .code
7207 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7208 .endd
7209 When the pathname is given in the query, you have to escape the slashes as
7210 &`%2F`& to fit in with the LDAP URL syntax. For example:
7211 .code
7212 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7213 .endd
7214 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7215 a pathname, it uses the Unix domain socket code, even if the query actually
7216 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7217 socket connection. This behaviour means that you can use a setting of
7218 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7219 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7220 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7221 backup host.
7222
7223 If an explicit &`ldapi`& type is given in a query when a host name is
7224 specified, an error is diagnosed. However, if there are more items in
7225 &%ldap_default_servers%&, they are tried. In other words:
7226
7227 .ilist
7228 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7229 interface.
7230 .next
7231 Using &`ldapi`& with a host name causes an error.
7232 .endlist
7233
7234
7235 Using &`ldapi`& with no host or path in the query, and no setting of
7236 &%ldap_default_servers%&, does whatever the library does by default.
7237
7238
7239
7240 .section "LDAP authentication and control information" "SECID70"
7241 .cindex "LDAP" "authentication"
7242 The LDAP URL syntax provides no way of passing authentication and other control
7243 information to the server. To make this possible, the URL in an LDAP query may
7244 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7245 spaces. If a value contains spaces it must be enclosed in double quotes, and
7246 when double quotes are used, backslash is interpreted in the usual way inside
7247 them. The following names are recognized:
7248 .display
7249 &`DEREFERENCE`&  set the dereferencing parameter
7250 &`NETTIME    `&  set a timeout for a network operation
7251 &`USER       `&  set the DN, for authenticating the LDAP bind
7252 &`PASS       `&  set the password, likewise
7253 &`REFERRALS  `&  set the referrals parameter
7254 &`SERVERS    `&  set alternate server list for this query only
7255 &`SIZE       `&  set the limit for the number of entries returned
7256 &`TIME       `&  set the maximum waiting time for a query
7257 .endd
7258 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7259 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7260 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7261 library from trying to follow referrals issued by the LDAP server.
7262
7263 The name CONNECT is an obsolete name for NETTIME, retained for
7264 backwards compatibility. This timeout (specified as a number of seconds) is
7265 enforced from the client end for operations that can be carried out over a
7266 network. Specifically, it applies to network connections and calls to the
7267 &'ldap_result()'& function. If the value is greater than zero, it is used if
7268 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7269 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7270 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7271 Netscape SDK; for OpenLDAP no action is taken.
7272
7273 The TIME parameter (also a number of seconds) is passed to the server to
7274 set a server-side limit on the time taken to complete a search.
7275
7276 The SERVERS parameter allows you to specify an alternate list of ldap servers
7277 to use for an individual lookup.  The global ldap_servers option provides a
7278 default list of ldap servers, and a single lookup can specify a single ldap
7279 server to use.  But when you need to do a lookup with a list of servers that is
7280 different than the default list (maybe different order, maybe a completely
7281 different set of servers), the SERVERS parameter allows you to specify this
7282 alternate list (colon-separated).
7283
7284 Here is an example of an LDAP query in an Exim lookup that uses some of these
7285 values. This is a single line, folded to fit on the page:
7286 .code
7287 ${lookup ldap
7288   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7289   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7290   {$value}fail}
7291 .endd
7292 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7293 any of the auxiliary data. Exim configuration settings that include lookups
7294 which contain password information should be preceded by &"hide"& to prevent
7295 non-admin users from using the &%-bP%& option to see their values.
7296
7297 The auxiliary data items may be given in any order. The default is no
7298 connection timeout (the system timeout is used), no user or password, no limit
7299 on the number of entries returned, and no time limit on queries.
7300
7301 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7302 removes any URL quoting that it may contain before passing it LDAP. Apparently
7303 some libraries do this for themselves, but some do not. Removing the URL
7304 quoting has two advantages:
7305
7306 .ilist
7307 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7308 DNs as with DNs inside actual queries.
7309 .next
7310 It permits spaces inside USER= DNs.
7311 .endlist
7312
7313 For example, a setting such as
7314 .code
7315 USER=cn=${quote_ldap_dn:$1}
7316 .endd
7317 should work even if &$1$& contains spaces.
7318
7319 Expanded data for the PASS= value should be quoted using the &%quote%&
7320 expansion operator, rather than the LDAP quote operators. The only reason this
7321 field needs quoting is to ensure that it conforms to the Exim syntax, which
7322 does not allow unquoted spaces. For example:
7323 .code
7324 PASS=${quote:$3}
7325 .endd
7326 The LDAP authentication mechanism can be used to check passwords as part of
7327 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7328 &<<CHAPexpand>>&.
7329
7330
7331
7332 .section "Format of data returned by LDAP" "SECID71"
7333 .cindex "LDAP" "returned data formats"
7334 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7335 as a sequence of values, for example
7336 .code
7337 cn=manager, o=University of Cambridge, c=UK
7338 .endd
7339 The &(ldap)& lookup type generates an error if more than one entry matches the
7340 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7341 the result between the data from different entries. It is possible for multiple
7342 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7343 you know that whatever values are returned all came from a single entry in the
7344 directory.
7345
7346 In the common case where you specify a single attribute in your LDAP query, the
7347 result is not quoted, and does not contain the attribute name. If the attribute
7348 has multiple values, they are separated by commas.
7349
7350 If you specify multiple attributes, the result contains space-separated, quoted
7351 strings, each preceded by the attribute name and an equals sign. Within the
7352 quotes, the quote character, backslash, and newline are escaped with
7353 backslashes, and commas are used to separate multiple values for the attribute.
7354 Any commas in attribute values are doubled
7355 (permitting treatment of the values as a comma-separated list).
7356 Apart from the escaping, the string within quotes takes the same form as the
7357 output when a single attribute is requested. Specifying no attributes is the
7358 same as specifying all of an entry's attributes.
7359
7360 Here are some examples of the output format. The first line of each pair is an
7361 LDAP query, and the second is the data that is returned. The attribute called
7362 &%attr1%& has two values, one of them with an embedded comma, whereas
7363 &%attr2%& has only one value:
7364 .code
7365 ldap:///o=base?attr1?sub?(uid=fred)
7366 value1.1,value1,,2
7367
7368 ldap:///o=base?attr2?sub?(uid=fred)
7369 value two
7370
7371 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7372 attr1="value1.1,value1,,2" attr2="value two"
7373
7374 ldap:///o=base??sub?(uid=fred)
7375 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7376 .endd
7377 You can
7378 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7379 results of LDAP lookups.
7380 The &%extract%& operator in string expansions can be used to pick out
7381 individual fields from data that consists of &'key'&=&'value'& pairs.
7382 The &%listextract%& operator should be used to pick out individual values
7383 of attributes, even when only a single value is expected.
7384 The doubling of embedded commas allows you to use the returned data as a
7385 comma separated list (using the "<," syntax for changing the input list separator).
7386
7387
7388
7389
7390 .section "More about NIS+" "SECTnisplus"
7391 .cindex "NIS+ lookup type"
7392 .cindex "lookup" "NIS+"
7393 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7394 and field name. If this is given, the result of a successful query is the
7395 contents of the named field; otherwise the result consists of a concatenation
7396 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7397 values containing spaces are quoted. For example, the query
7398 .code
7399 [name=mg1456],passwd.org_dir
7400 .endd
7401 might return the string
7402 .code
7403 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7404 home=/home/mg1456 shell=/bin/bash shadow=""
7405 .endd
7406 (split over two lines here to fit on the page), whereas
7407 .code
7408 [name=mg1456],passwd.org_dir:gcos
7409 .endd
7410 would just return
7411 .code
7412 Martin Guerre
7413 .endd
7414 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7415 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7416 operator is to double any quote characters within the text.
7417
7418
7419
7420 .section "SQL lookups" "SECTsql"
7421 .cindex "SQL lookup types"
7422 .cindex "MySQL" "lookup type"
7423 .cindex "PostgreSQL lookup type"
7424 .cindex "lookup" "MySQL"
7425 .cindex "lookup" "PostgreSQL"
7426 .cindex "Oracle" "lookup type"
7427 .cindex "lookup" "Oracle"
7428 .cindex "InterBase lookup type"
7429 .cindex "lookup" "InterBase"
7430 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7431 databases. Queries for these databases contain SQL statements, so an example
7432 might be
7433 .code
7434 ${lookup mysql{select mailbox from users where id='userx'}\
7435   {$value}fail}
7436 .endd
7437 If the result of the query contains more than one field, the data for each
7438 field in the row is returned, preceded by its name, so the result of
7439 .code
7440 ${lookup pgsql{select home,name from users where id='userx'}\
7441   {$value}}
7442 .endd
7443 might be
7444 .code
7445 home=/home/userx name="Mister X"
7446 .endd
7447 Empty values and values containing spaces are double quoted, with embedded
7448 quotes escaped by a backslash. If the result of the query contains just one
7449 field, the value is passed back verbatim, without a field name, for example:
7450 .code
7451 Mister X
7452 .endd
7453 If the result of the query yields more than one row, it is all concatenated,
7454 with a newline between the data for each row.
7455
7456
7457 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7458 .cindex "MySQL" "lookup type"
7459 .cindex "PostgreSQL lookup type"
7460 .cindex "lookup" "MySQL"
7461 .cindex "lookup" "PostgreSQL"
7462 .cindex "Oracle" "lookup type"
7463 .cindex "lookup" "Oracle"
7464 .cindex "InterBase lookup type"
7465 .cindex "lookup" "InterBase"
7466 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7467 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7468 option (as appropriate) must be set to a colon-separated list of server
7469 information.
7470 (For MySQL and PostgreSQL only, the global option need not be set if all
7471 queries contain their own server information &-- see section
7472 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7473 items: host name, database name, user name, and password. In the case of
7474 Oracle, the host name field is used for the &"service name"&, and the database
7475 name field is not used and should be empty. For example:
7476 .code
7477 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7478 .endd
7479 Because password data is sensitive, you should always precede the setting with
7480 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7481 option. Here is an example where two MySQL servers are listed:
7482 .code
7483 hide mysql_servers = localhost/users/root/secret:\
7484                      otherhost/users/root/othersecret
7485 .endd
7486 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7487 because this is a colon-separated list, the colon has to be doubled. For each
7488 query, these parameter groups are tried in order until a connection is made and
7489 a query is successfully processed. The result of a query may be that no data is
7490 found, but that is still a successful query. In other words, the list of
7491 servers provides a backup facility, not a list of different places to look.
7492
7493 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7494 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7495 respectively, and the characters single-quote, double-quote, and backslash
7496 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7497 addition, escapes the percent and underscore characters. This cannot be done
7498 for MySQL because these escapes are not recognized in contexts where these
7499 characters are not special.
7500
7501 .section "Specifying the server in the query" "SECTspeserque"
7502 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7503 it is possible to specify a list of servers with an individual query. This is
7504 done by starting the query with
7505 .display
7506 &`servers=`&&'server1:server2:server3:...'&&`;`&
7507 .endd
7508 Each item in the list may take one of two forms:
7509 .olist
7510 If it contains no slashes it is assumed to be just a host name. The appropriate
7511 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7512 of the same name, and the remaining parameters (database, user, password) are
7513 taken from there.
7514 .next
7515 If it contains any slashes, it is taken as a complete parameter set.
7516 .endlist
7517 The list of servers is used in exactly the same way as the global list.
7518 Once a connection to a server has happened and a query has been
7519 successfully executed, processing of the lookup ceases.
7520
7521 This feature is intended for use in master/slave situations where updates
7522 are occurring and you want to update the master rather than a slave. If the
7523 master is in the list as a backup for reading, you might have a global setting
7524 like this:
7525 .code
7526 mysql_servers = slave1/db/name/pw:\
7527                 slave2/db/name/pw:\
7528                 master/db/name/pw
7529 .endd
7530 In an updating lookup, you could then write:
7531 .code
7532 ${lookup mysql{servers=master; UPDATE ...} }
7533 .endd
7534 That query would then be sent only to the master server. If, on the other hand,
7535 the master is not to be used for reading, and so is not present in the global
7536 option, you can still update it by a query of this form:
7537 .code
7538 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7539 .endd
7540
7541
7542 .section "Special MySQL features" "SECID73"
7543 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7544 causes a connection to the server on the local host by means of a Unix domain
7545 socket. An alternate socket can be specified in parentheses. The full syntax of
7546 each item in &%mysql_servers%& is:
7547 .display
7548 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7549   <&'user'&>/<&'password'&>
7550 .endd
7551 Any of the three sub-parts of the first field can be omitted. For normal use on
7552 the local host it can be left blank or set to just &"localhost"&.
7553
7554 No database need be supplied &-- but if it is absent here, it must be given in
7555 the queries.
7556
7557 If a MySQL query is issued that does not request any data (an insert, update,
7558 or delete command), the result of the lookup is the number of rows affected.
7559
7560 &*Warning*&: This can be misleading. If an update does not actually change
7561 anything (for example, setting a field to the value it already has), the result
7562 is zero because no rows are affected.
7563
7564
7565 .section "Special PostgreSQL features" "SECID74"
7566 PostgreSQL lookups can also use Unix domain socket connections to the database.
7567 This is usually faster and costs less CPU time than a TCP/IP connection.
7568 However it can be used only if the mail server runs on the same machine as the
7569 database server. A configuration line for PostgreSQL via Unix domain sockets
7570 looks like this:
7571 .code
7572 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7573 .endd
7574 In other words, instead of supplying a host name, a path to the socket is
7575 given. The path name is enclosed in parentheses so that its slashes aren't
7576 visually confused with the delimiters for the other server parameters.
7577
7578 If a PostgreSQL query is issued that does not request any data (an insert,
7579 update, or delete command), the result of the lookup is the number of rows
7580 affected.
7581
7582 .section "More about SQLite" "SECTsqlite"
7583 .cindex "lookup" "SQLite"
7584 .cindex "sqlite lookup type"
7585 SQLite is different to the other SQL lookups because a file name is required in
7586 addition to the SQL query. An SQLite database is a single file, and there is no
7587 daemon as in the other SQL databases. The interface to Exim requires the name
7588 of the file, as an absolute path, to be given at the start of the query. It is
7589 separated from the query by white space. This means that the path name cannot
7590 contain white space. Here is a lookup expansion example:
7591 .code
7592 ${lookup sqlite {/some/thing/sqlitedb \
7593   select name from aliases where id='userx';}}
7594 .endd
7595 In a list, the syntax is similar. For example:
7596 .code
7597 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7598    select * from relays where ip='$sender_host_address';
7599 .endd
7600 The only character affected by the &%quote_sqlite%& operator is a single
7601 quote, which it doubles.
7602
7603 The SQLite library handles multiple simultaneous accesses to the database
7604 internally. Multiple readers are permitted, but only one process can
7605 update at once. Attempts to access the database while it is being updated
7606 are rejected after a timeout period, during which the SQLite library
7607 waits for the lock to be released. In Exim, the default timeout is set
7608 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7609 option.
7610 .ecindex IIDfidalo1
7611 .ecindex IIDfidalo2
7612
7613
7614 . ////////////////////////////////////////////////////////////////////////////
7615 . ////////////////////////////////////////////////////////////////////////////
7616
7617 .chapter "Domain, host, address, and local part lists" &&&
7618          "CHAPdomhosaddlists" &&&
7619          "Domain, host, and address lists"
7620 .scindex IIDdohoadli "lists of domains; hosts; etc."
7621 A number of Exim configuration options contain lists of domains, hosts,
7622 email addresses, or local parts. For example, the &%hold_domains%& option
7623 contains a list of domains whose delivery is currently suspended. These lists
7624 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7625 arguments to expansion conditions such as &%match_domain%&.
7626
7627 Each item in one of these lists is a pattern to be matched against a domain,
7628 host, email address, or local part, respectively. In the sections below, the
7629 different types of pattern for each case are described, but first we cover some
7630 general facilities that apply to all four kinds of list.
7631
7632
7633
7634 .section "Expansion of lists" "SECID75"
7635 .cindex "expansion" "of lists"
7636 Each list is expanded as a single string before it is used. The result of
7637 expansion must be a list, possibly containing empty items, which is split up
7638 into separate items for matching. By default, colon is the separator character,
7639 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7640 &<<SECTempitelis>>& for details of the list syntax; the second of these
7641 discusses the way to specify empty list items.
7642
7643
7644 If the string expansion is forced to fail, Exim behaves as if the item it is
7645 testing (domain, host, address, or local part) is not in the list. Other
7646 expansion failures cause temporary errors.
7647
7648 If an item in a list is a regular expression, backslashes, dollars and possibly
7649 other special characters in the expression must be protected against
7650 misinterpretation by the string expander. The easiest way to do this is to use
7651 the &`\N`& expansion feature to indicate that the contents of the regular
7652 expression should not be expanded. For example, in an ACL you might have:
7653 .code
7654 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7655                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7656 .endd
7657 The first item is a regular expression that is protected from expansion by
7658 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7659 senders based on the receiving domain.
7660
7661
7662
7663
7664 .section "Negated items in lists" "SECID76"
7665 .cindex "list" "negation"
7666 .cindex "negation" "in lists"
7667 Items in a list may be positive or negative. Negative items are indicated by a
7668 leading exclamation mark, which may be followed by optional white space. A list
7669 defines a set of items (domains, etc). When Exim processes one of these lists,
7670 it is trying to find out whether a domain, host, address, or local part
7671 (respectively) is in the set that is defined by the list. It works like this:
7672
7673 The list is scanned from left to right. If a positive item is matched, the
7674 subject that is being checked is in the set; if a negative item is matched, the
7675 subject is not in the set. If the end of the list is reached without the
7676 subject having matched any of the patterns, it is in the set if the last item
7677 was a negative one, but not if it was a positive one. For example, the list in
7678 .code
7679 domainlist relay_to_domains = !a.b.c : *.b.c
7680 .endd
7681 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7682 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7683 list is positive. However, if the setting were
7684 .code
7685 domainlist relay_to_domains = !a.b.c
7686 .endd
7687 then all domains other than &'a.b.c'& would match because the last item in the
7688 list is negative. In other words, a list that ends with a negative item behaves
7689 as if it had an extra item &`:*`& on the end.
7690
7691 Another way of thinking about positive and negative items in lists is to read
7692 the connector as &"or"& after a positive item and as &"and"& after a negative
7693 item.
7694
7695
7696
7697 .section "File names in lists" "SECTfilnamlis"
7698 .cindex "list" "file name in"
7699 If an item in a domain, host, address, or local part list is an absolute file
7700 name (beginning with a slash character), each line of the file is read and
7701 processed as if it were an independent item in the list, except that further
7702 file names are not allowed,
7703 and no expansion of the data from the file takes place.
7704 Empty lines in the file are ignored, and the file may also contain comment
7705 lines:
7706
7707 .ilist
7708 For domain and host lists, if a # character appears anywhere in a line of the
7709 file, it and all following characters are ignored.
7710 .next
7711 Because local parts may legitimately contain # characters, a comment in an
7712 address list or local part list file is recognized only if # is preceded by
7713 white space or the start of the line. For example:
7714 .code
7715 not#comment@x.y.z   # but this is a comment
7716 .endd
7717 .endlist
7718
7719 Putting a file name in a list has the same effect as inserting each line of the
7720 file as an item in the list (blank lines and comments excepted). However, there
7721 is one important difference: the file is read each time the list is processed,
7722 so if its contents vary over time, Exim's behaviour changes.
7723
7724 If a file name is preceded by an exclamation mark, the sense of any match
7725 within the file is inverted. For example, if
7726 .code
7727 hold_domains = !/etc/nohold-domains
7728 .endd
7729 and the file contains the lines
7730 .code
7731 !a.b.c
7732 *.b.c
7733 .endd
7734 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7735 any domain matching &`*.b.c`& is not.
7736
7737
7738
7739 .section "An lsearch file is not an out-of-line list" "SECID77"
7740 As will be described in the sections that follow, lookups can be used in lists
7741 to provide indexed methods of checking list membership. There has been some
7742 confusion about the way &(lsearch)& lookups work in lists. Because
7743 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7744 sometimes thought that it is allowed to contain wild cards and other kinds of
7745 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7746 always fixed strings, just as for any other single-key lookup type.
7747
7748 If you want to use a file to contain wild-card patterns that form part of a
7749 list, just give the file name on its own, without a search type, as described
7750 in the previous section. You could also use the &(wildlsearch)& or
7751 &(nwildlsearch)&, but there is no advantage in doing this.
7752
7753
7754
7755
7756 .section "Named lists" "SECTnamedlists"
7757 .cindex "named lists"
7758 .cindex "list" "named"
7759 A list of domains, hosts, email addresses, or local parts can be given a name
7760 which is then used to refer to the list elsewhere in the configuration. This is
7761 particularly convenient if the same list is required in several different
7762 places. It also allows lists to be given meaningful names, which can improve
7763 the readability of the configuration. For example, it is conventional to define
7764 a domain list called &'local_domains'& for all the domains that are handled
7765 locally on a host, using a configuration line such as
7766 .code
7767 domainlist local_domains = localhost:my.dom.example
7768 .endd
7769 Named lists are referenced by giving their name preceded by a plus sign, so,
7770 for example, a router that is intended to handle local domains would be
7771 configured with the line
7772 .code
7773 domains = +local_domains
7774 .endd
7775 The first router in a configuration is often one that handles all domains
7776 except the local ones, using a configuration with a negated item like this:
7777 .code
7778 dnslookup:
7779   driver = dnslookup
7780   domains = ! +local_domains
7781   transport = remote_smtp
7782   no_more
7783 .endd
7784 The four kinds of named list are created by configuration lines starting with
7785 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7786 respectively. Then there follows the name that you are defining, followed by an
7787 equals sign and the list itself. For example:
7788 .code
7789 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7790 addresslist bad_senders = cdb;/etc/badsenders
7791 .endd
7792 A named list may refer to other named lists:
7793 .code
7794 domainlist  dom1 = first.example : second.example
7795 domainlist  dom2 = +dom1 : third.example
7796 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7797 .endd
7798 &*Warning*&: If the last item in a referenced list is a negative one, the
7799 effect may not be what you intended, because the negation does not propagate
7800 out to the higher level. For example, consider:
7801 .code
7802 domainlist  dom1 = !a.b
7803 domainlist  dom2 = +dom1 : *.b
7804 .endd
7805 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7806 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7807 means it matches the second list as well. The effect is not the same as
7808 .code
7809 domainlist  dom2 = !a.b : *.b
7810 .endd
7811 where &'x.y'& does not match. It's best to avoid negation altogether in
7812 referenced lists if you can.
7813
7814 Named lists may have a performance advantage. When Exim is routing an
7815 address or checking an incoming message, it caches the result of tests on named
7816 lists. So, if you have a setting such as
7817 .code
7818 domains = +local_domains
7819 .endd
7820 on several of your routers
7821 or in several ACL statements,
7822 the actual test is done only for the first one. However, the caching works only
7823 if there are no expansions within the list itself or any sublists that it
7824 references. In other words, caching happens only for lists that are known to be
7825 the same each time they are referenced.
7826
7827 By default, there may be up to 16 named lists of each type. This limit can be
7828 extended by changing a compile-time variable. The use of domain and host lists
7829 is recommended for concepts such as local domains, relay domains, and relay
7830 hosts. The default configuration is set up like this.
7831
7832
7833
7834 .section "Named lists compared with macros" "SECID78"
7835 .cindex "list" "named compared with macro"
7836 .cindex "macro" "compared with named list"
7837 At first sight, named lists might seem to be no different from macros in the
7838 configuration file. However, macros are just textual substitutions. If you
7839 write
7840 .code
7841 ALIST = host1 : host2
7842 auth_advertise_hosts = !ALIST
7843 .endd
7844 it probably won't do what you want, because that is exactly the same as
7845 .code
7846 auth_advertise_hosts = !host1 : host2
7847 .endd
7848 Notice that the second host name is not negated. However, if you use a host
7849 list, and write
7850 .code
7851 hostlist alist = host1 : host2
7852 auth_advertise_hosts = ! +alist
7853 .endd
7854 the negation applies to the whole list, and so that is equivalent to
7855 .code
7856 auth_advertise_hosts = !host1 : !host2
7857 .endd
7858
7859
7860 .section "Named list caching" "SECID79"
7861 .cindex "list" "caching of named"
7862 .cindex "caching" "named lists"
7863 While processing a message, Exim caches the result of checking a named list if
7864 it is sure that the list is the same each time. In practice, this means that
7865 the cache operates only if the list contains no $ characters, which guarantees
7866 that it will not change when it is expanded. Sometimes, however, you may have
7867 an expanded list that you know will be the same each time within a given
7868 message. For example:
7869 .code
7870 domainlist special_domains = \
7871            ${lookup{$sender_host_address}cdb{/some/file}}
7872 .endd
7873 This provides a list of domains that depends only on the sending host's IP
7874 address. If this domain list is referenced a number of times (for example,
7875 in several ACL lines, or in several routers) the result of the check is not
7876 cached by default, because Exim does not know that it is going to be the
7877 same list each time.
7878
7879 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7880 cache the result anyway. For example:
7881 .code
7882 domainlist_cache special_domains = ${lookup{...
7883 .endd
7884 If you do this, you should be absolutely sure that caching is going to do
7885 the right thing in all cases. When in doubt, leave it out.
7886
7887
7888
7889 .section "Domain lists" "SECTdomainlist"
7890 .cindex "domain list" "patterns for"
7891 .cindex "list" "domain list"
7892 Domain lists contain patterns that are to be matched against a mail domain.
7893 The following types of item may appear in domain lists:
7894
7895 .ilist
7896 .cindex "primary host name"
7897 .cindex "host name" "matched in domain list"
7898 .oindex "&%primary_hostname%&"
7899 .cindex "domain list" "matching primary host name"
7900 .cindex "@ in a domain list"
7901 If a pattern consists of a single @ character, it matches the local host name,
7902 as set by the &%primary_hostname%& option (or defaulted). This makes it
7903 possible to use the same configuration file on several different hosts that
7904 differ only in their names.
7905 .next
7906 .cindex "@[] in a domain list"
7907 .cindex "domain list" "matching local IP interfaces"
7908 .cindex "domain literal"
7909 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7910 in square brackets (as in an email address that contains a domain literal), but
7911 only if that IP address is recognized as local for email routing purposes. The
7912 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7913 control which of a host's several IP addresses are treated as local.
7914 In today's Internet, the use of domain literals is controversial.
7915 .next
7916 .cindex "@mx_any"
7917 .cindex "@mx_primary"
7918 .cindex "@mx_secondary"
7919 .cindex "domain list" "matching MX pointers to local host"
7920 If a pattern consists of the string &`@mx_any`& it matches any domain that
7921 has an MX record pointing to the local host or to any host that is listed in
7922 .oindex "&%hosts_treat_as_local%&"
7923 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7924 are similar, except that the first matches only when a primary MX target is the
7925 local host, and the second only when no primary MX target is the local host,
7926 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7927 preference value &-- there may of course be more than one of them.
7928
7929 The MX lookup that takes place when matching a pattern of this type is
7930 performed with the resolver options for widening names turned off. Thus, for
7931 example, a single-component domain will &'not'& be expanded by adding the
7932 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7933 options of the &(dnslookup)& router for a discussion of domain widening.
7934
7935 Sometimes you may want to ignore certain IP addresses when using one of these
7936 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7937 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7938 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7939 on a router). For example:
7940 .code
7941 domains = @mx_any/ignore=127.0.0.1
7942 .endd
7943 This example matches any domain that has an MX record pointing to one of
7944 the local host's IP addresses other than 127.0.0.1.
7945
7946 The list of IP addresses is in fact processed by the same code that processes
7947 host lists, so it may contain CIDR-coded network specifications and it may also
7948 contain negative items.
7949
7950 Because the list of IP addresses is a sublist within a domain list, you have to
7951 be careful about delimiters if there is more than one address. Like any other
7952 list, the default delimiter can be changed. Thus, you might have:
7953 .code
7954 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7955           an.other.domain : ...
7956 .endd
7957 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7958 involved, it is easiest to change the delimiter for the main list as well:
7959 .code
7960 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7961           an.other.domain ? ...
7962 .endd
7963 .next
7964 .cindex "asterisk" "in domain list"
7965 .cindex "domain list" "asterisk in"
7966 .cindex "domain list" "matching &""ends with""&"
7967 If a pattern starts with an asterisk, the remaining characters of the pattern
7968 are compared with the terminating characters of the domain. The use of &"*"& in
7969 domain lists differs from its use in partial matching lookups. In a domain
7970 list, the character following the asterisk need not be a dot, whereas partial
7971 matching works only in terms of dot-separated components. For example, a domain
7972 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7973 &'cipher.key.ex'&.
7974
7975 .next
7976 .cindex "regular expressions" "in domain list"
7977 .cindex "domain list" "matching regular expression"
7978 If a pattern starts with a circumflex character, it is treated as a regular
7979 expression, and matched against the domain using a regular expression matching
7980 function. The circumflex is treated as part of the regular expression.
7981 Email domains are case-independent, so this regular expression match is by
7982 default case-independent, but you can make it case-dependent by starting it
7983 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7984 are given in chapter &<<CHAPregexp>>&.
7985
7986 &*Warning*&: Because domain lists are expanded before being processed, you
7987 must escape any backslash and dollar characters in the regular expression, or
7988 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7989 it is not to be expanded (unless you really do want to build a regular
7990 expression by expansion, of course).
7991 .next
7992 .cindex "lookup" "in domain list"
7993 .cindex "domain list" "matching by lookup"
7994 If a pattern starts with the name of a single-key lookup type followed by a
7995 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7996 must be a file name in a suitable format for the lookup type. For example, for
7997 &"cdb;"& it must be an absolute path:
7998 .code
7999 domains = cdb;/etc/mail/local_domains.cdb
8000 .endd
8001 The appropriate type of lookup is done on the file using the domain name as the
8002 key. In most cases, the data that is looked up is not used; Exim is interested
8003 only in whether or not the key is present in the file. However, when a lookup
8004 is used for the &%domains%& option on a router
8005 or a &%domains%& condition in an ACL statement, the data is preserved in the
8006 &$domain_data$& variable and can be referred to in other router options or
8007 other statements in the same ACL.
8008
8009 .next
8010 Any of the single-key lookup type names may be preceded by
8011 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8012 .code
8013 domains = partial-dbm;/partial/domains
8014 .endd
8015 This causes partial matching logic to be invoked; a description of how this
8016 works is given in section &<<SECTpartiallookup>>&.
8017
8018 .next
8019 .cindex "asterisk" "in lookup type"
8020 Any of the single-key lookup types may be followed by an asterisk. This causes
8021 a default lookup for a key consisting of a single asterisk to be done if the
8022 original lookup fails. This is not a useful feature when using a domain list to
8023 select particular domains (because any domain would match), but it might have
8024 value if the result of the lookup is being used via the &$domain_data$&
8025 expansion variable.
8026 .next
8027 If the pattern starts with the name of a query-style lookup type followed by a
8028 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8029 pattern must be an appropriate query for the lookup type, as described in
8030 chapter &<<CHAPfdlookup>>&. For example:
8031 .code
8032 hold_domains = mysql;select domain from holdlist \
8033   where domain = '${quote_mysql:$domain}';
8034 .endd
8035 In most cases, the data that is looked up is not used (so for an SQL query, for
8036 example, it doesn't matter what field you select). Exim is interested only in
8037 whether or not the query succeeds. However, when a lookup is used for the
8038 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8039 variable and can be referred to in other options.
8040 .next
8041 .cindex "domain list" "matching literal domain name"
8042 If none of the above cases apply, a caseless textual comparison is made
8043 between the pattern and the domain.
8044 .endlist
8045
8046 Here is an example that uses several different kinds of pattern:
8047 .code
8048 domainlist funny_domains = \
8049   @ : \
8050   lib.unseen.edu : \
8051   *.foundation.fict.example : \
8052   \N^[1-2]\d{3}\.fict\.example$\N : \
8053   partial-dbm;/opt/data/penguin/book : \
8054   nis;domains.byname : \
8055   nisplus;[name=$domain,status=local],domains.org_dir
8056 .endd
8057 There are obvious processing trade-offs among the various matching modes. Using
8058 an asterisk is faster than a regular expression, and listing a few names
8059 explicitly probably is too. The use of a file or database lookup is expensive,
8060 but may be the only option if hundreds of names are required. Because the
8061 patterns are tested in order, it makes sense to put the most commonly matched
8062 patterns earlier.
8063
8064
8065
8066 .section "Host lists" "SECThostlist"
8067 .cindex "host list" "patterns in"
8068 .cindex "list" "host list"
8069 Host lists are used to control what remote hosts are allowed to do. For
8070 example, some hosts may be allowed to use the local host as a relay, and some
8071 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8072 two different ways, by name or by IP address. In a host list, some types of
8073 pattern are matched to a host name, and some are matched to an IP address.
8074 You need to be particularly careful with this when single-key lookups are
8075 involved, to ensure that the right value is being used as the key.
8076
8077
8078 .section "Special host list patterns" "SECID80"
8079 .cindex "empty item in hosts list"
8080 .cindex "host list" "empty string in"
8081 If a host list item is the empty string, it matches only when no remote host is
8082 involved. This is the case when a message is being received from a local
8083 process using SMTP on the standard input, that is, when a TCP/IP connection is
8084 not used.
8085
8086 .cindex "asterisk" "in host list"
8087 The special pattern &"*"& in a host list matches any host or no host. Neither
8088 the IP address nor the name is actually inspected.
8089
8090
8091
8092 .section "Host list patterns that match by IP address" "SECThoslispatip"
8093 .cindex "host list" "matching IP addresses"
8094 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8095 the incoming address actually appears in the IPv6 host as
8096 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8097 list, it is converted into a traditional IPv4 address first. (Not all operating
8098 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8099 concerns.)
8100
8101 The following types of pattern in a host list check the remote host by
8102 inspecting its IP address:
8103
8104 .ilist
8105 If the pattern is a plain domain name (not a regular expression, not starting
8106 with *, not a lookup of any kind), Exim calls the operating system function
8107 to find the associated IP address(es). Exim uses the newer
8108 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8109 This typically causes a forward DNS lookup of the name. The result is compared
8110 with the IP address of the subject host.
8111
8112 If there is a temporary problem (such as a DNS timeout) with the host name
8113 lookup, a temporary error occurs. For example, if the list is being used in an
8114 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8115 temporary SMTP error code. If no IP address can be found for the host name,
8116 what happens is described in section &<<SECTbehipnot>>& below.
8117
8118 .next
8119 .cindex "@ in a host list"
8120 If the pattern is &"@"&, the primary host name is substituted and used as a
8121 domain name, as just described.
8122
8123 .next
8124 If the pattern is an IP address, it is matched against the IP address of the
8125 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8126 IPv6 addresses can be given in colon-separated format, but the colons have to
8127 be doubled so as not to be taken as item separators when the default list
8128 separator is used. IPv6 addresses are recognized even when Exim is compiled
8129 without IPv6 support. This means that if they appear in a host list on an
8130 IPv4-only host, Exim will not treat them as host names. They are just addresses
8131 that can never match a client host.
8132
8133 .next
8134 .cindex "@[] in a host list"
8135 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8136 the local host. For example, if the local host is an IPv4 host with one
8137 interface address 10.45.23.56, these two ACL statements have the same effect:
8138 .code
8139 accept hosts = 127.0.0.1 : 10.45.23.56
8140 accept hosts = @[]
8141 .endd
8142 .next
8143 .cindex "CIDR notation"
8144 If the pattern is an IP address followed by a slash and a mask length (for
8145 example 10.11.42.0/24), it is matched against the IP address of the subject
8146 host under the given mask. This allows, an entire network of hosts to be
8147 included (or excluded) by a single item. The mask uses CIDR notation; it
8148 specifies the number of address bits that must match, starting from the most
8149 significant end of the address.
8150
8151 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8152 of a range of addresses. It is the number of bits in the network portion of the
8153 address. The above example specifies a 24-bit netmask, so it matches all 256
8154 addresses in the 10.11.42.0 network. An item such as
8155 .code
8156 192.168.23.236/31
8157 .endd
8158 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8159 32 for an IPv4 address is the same as no mask at all; just a single address
8160 matches.
8161
8162 Here is another example which shows an IPv4 and an IPv6 network:
8163 .code
8164 recipient_unqualified_hosts = 192.168.0.0/16: \
8165                               3ffe::ffff::836f::::/48
8166 .endd
8167 The doubling of list separator characters applies only when these items
8168 appear inline in a host list. It is not required when indirecting via a file.
8169 For example:
8170 .code
8171 recipient_unqualified_hosts = /opt/exim/unqualnets
8172 .endd
8173 could make use of a file containing
8174 .code
8175 172.16.0.0/12
8176 3ffe:ffff:836f::/48
8177 .endd
8178 to have exactly the same effect as the previous example. When listing IPv6
8179 addresses inline, it is usually more convenient to use the facility for
8180 changing separator characters. This list contains the same two networks:
8181 .code
8182 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8183                                  3ffe:ffff:836f::/48
8184 .endd
8185 The separator is changed to semicolon by the leading &"<;"& at the start of the
8186 list.
8187 .endlist
8188
8189
8190
8191 .section "Host list patterns for single-key lookups by host address" &&&
8192          "SECThoslispatsikey"
8193 .cindex "host list" "lookup of IP address"
8194 When a host is to be identified by a single-key lookup of its complete IP
8195 address, the pattern takes this form:
8196 .display
8197 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8198 .endd
8199 For example:
8200 .code
8201 hosts_lookup = net-cdb;/hosts-by-ip.db
8202 .endd
8203 The text form of the IP address of the subject host is used as the lookup key.
8204 IPv6 addresses are converted to an unabbreviated form, using lower case
8205 letters, with dots as separators because colon is the key terminator in
8206 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8207 quoting the keys, but this is a facility that was added later.] The data
8208 returned by the lookup is not used.
8209
8210 .cindex "IP address" "masking"
8211 .cindex "host list" "masked IP address"
8212 Single-key lookups can also be performed using masked IP addresses, using
8213 patterns of this form:
8214 .display
8215 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8216 .endd
8217 For example:
8218 .code
8219 net24-dbm;/networks.db
8220 .endd
8221 The IP address of the subject host is masked using <&'number'&> as the mask
8222 length. A textual string is constructed from the masked value, followed by the
8223 mask, and this is used as the lookup key. For example, if the host's IP address
8224 is 192.168.34.6, the key that is looked up for the above example is
8225 &"192.168.34.0/24"&.
8226
8227 When an IPv6 address is converted to a string, dots are normally used instead
8228 of colons, so that keys in &(lsearch)& files need not contain colons (which
8229 terminate &(lsearch)& keys). This was implemented some time before the ability
8230 to quote keys was made available in &(lsearch)& files. However, the more
8231 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8232 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8233 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8234 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8235 addresses are always used.
8236
8237 Ideally, it would be nice to tidy up this anomalous situation by changing to
8238 colons in all cases, given that quoting is now available for &(lsearch)&.
8239 However, this would be an incompatible change that might break some existing
8240 configurations.
8241
8242 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8243 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8244 the former case the key strings include the mask value, whereas in the latter
8245 case the IP address is used on its own.
8246
8247
8248
8249 .section "Host list patterns that match by host name" "SECThoslispatnam"
8250 .cindex "host" "lookup failures"
8251 .cindex "unknown host name"
8252 .cindex "host list" "matching host name"
8253 There are several types of pattern that require Exim to know the name of the
8254 remote host. These are either wildcard patterns or lookups by name. (If a
8255 complete hostname is given without any wildcarding, it is used to find an IP
8256 address to match against, as described in section &<<SECThoslispatip>>&
8257 above.)
8258
8259 If the remote host name is not already known when Exim encounters one of these
8260 patterns, it has to be found from the IP address.
8261 Although many sites on the Internet are conscientious about maintaining reverse
8262 DNS data for their hosts, there are also many that do not do this.
8263 Consequently, a name cannot always be found, and this may lead to unwanted
8264 effects. Take care when configuring host lists with wildcarded name patterns.
8265 Consider what will happen if a name cannot be found.
8266
8267 Because of the problems of determining host names from IP addresses, matching
8268 against host names is not as common as matching against IP addresses.
8269
8270 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8271 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8272 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8273 are done can be changed by setting the &%host_lookup_order%& option. For
8274 security, once Exim has found one or more names, it looks up the IP addresses
8275 for these names and compares them with the IP address that it started with.
8276 Only those names whose IP addresses match are accepted. Any other names are
8277 discarded. If no names are left, Exim behaves as if the host name cannot be
8278 found. In the most common case there is only one name and one IP address.
8279
8280 There are some options that control what happens if a host name cannot be
8281 found. These are described in section &<<SECTbehipnot>>& below.
8282
8283 .cindex "host" "alias for"
8284 .cindex "alias for host"
8285 As a result of aliasing, hosts may have more than one name. When processing any
8286 of the following types of pattern, all the host's names are checked:
8287
8288 .ilist
8289 .cindex "asterisk" "in host list"
8290 If a pattern starts with &"*"& the remainder of the item must match the end of
8291 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8292 &'.b.c'&. This special simple form is provided because this is a very common
8293 requirement. Other kinds of wildcarding require the use of a regular
8294 expression.
8295 .next
8296 .cindex "regular expressions" "in host list"
8297 .cindex "host list" "regular expression in"
8298 If the item starts with &"^"& it is taken to be a regular expression which is
8299 matched against the host name. Host names are case-independent, so this regular
8300 expression match is by default case-independent, but you can make it
8301 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8302 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8303 example,
8304 .code
8305 ^(a|b)\.c\.d$
8306 .endd
8307 is a regular expression that matches either of the two hosts &'a.c.d'& or
8308 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8309 that backslash and dollar characters are not misinterpreted as part of the
8310 string expansion. The simplest way to do this is to use &`\N`& to mark that
8311 part of the string as non-expandable. For example:
8312 .code
8313 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8314 .endd
8315 &*Warning*&: If you want to match a complete host name, you must include the
8316 &`$`& terminating metacharacter in the regular expression, as in the above
8317 example. Without it, a match at the start of the host name is all that is
8318 required.
8319 .endlist
8320
8321
8322
8323
8324 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8325 .cindex "host" "lookup failures, permanent"
8326 While processing a host list, Exim may need to look up an IP address from a
8327 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8328 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8329 behaviour when it fails to find the information it is seeking is the same.
8330
8331 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8332 apply to temporary DNS errors, whose handling is described in the next section.
8333
8334 .cindex "&`+include_unknown`&"
8335 .cindex "&`+ignore_unknown`&"
8336 Exim parses a host list from left to right. If it encounters a permanent
8337 lookup failure in any item in the host list before it has found a match,
8338 Exim treats it as a failure and the default behavior is as if the host
8339 does not match the list. This may not always be what you want to happen.
8340 To change Exim's behaviour, the special items &`+include_unknown`& or
8341 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8342 not recognized in an indirected file).
8343
8344 .ilist
8345 If any item that follows &`+include_unknown`& requires information that
8346 cannot found, Exim behaves as if the host does match the list. For example,
8347 .code
8348 host_reject_connection = +include_unknown:*.enemy.ex
8349 .endd
8350 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8351 any hosts whose name it cannot find.
8352
8353 .next
8354 If any item that follows &`+ignore_unknown`& requires information that cannot
8355 be found, Exim ignores that item and proceeds to the rest of the list. For
8356 example:
8357 .code
8358 accept hosts = +ignore_unknown : friend.example : \
8359                192.168.4.5
8360 .endd
8361 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8362 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8363 name can be found for 192.168.4.5, it is rejected.
8364 .endlist
8365
8366 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8367 list. The effect of each one lasts until the next, or until the end of the
8368 list.
8369
8370 .section "Mixing wildcarded host names and addresses in host lists" &&&
8371          "SECTmixwilhos"
8372 .cindex "host list" "mixing names and addresses in"
8373
8374 This section explains the host/ip processing logic with the same concepts
8375 as the previous section, but specifically addresses what happens when a
8376 wildcarded hostname is one of the items in the hostlist.
8377
8378 .ilist
8379 If you have name lookups or wildcarded host names and
8380 IP addresses in the same host list, you should normally put the IP
8381 addresses first. For example, in an ACL you could have:
8382 .code
8383 accept hosts = 10.9.8.7 : *.friend.example
8384 .endd
8385 The reason you normally would order it this way lies in the
8386 left-to-right way that Exim processes lists.  It can test IP addresses
8387 without doing any DNS lookups, but when it reaches an item that requires
8388 a host name, it fails if it cannot find a host name to compare with the
8389 pattern. If the above list is given in the opposite order, the
8390 &%accept%& statement fails for a host whose name cannot be found, even
8391 if its IP address is 10.9.8.7.
8392
8393 .next
8394 If you really do want to do the name check first, and still recognize the IP
8395 address, you can rewrite the ACL like this:
8396 .code
8397 accept hosts = *.friend.example
8398 accept hosts = 10.9.8.7
8399 .endd
8400 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8401 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8402 &`+ignore_unknown`&, which was discussed in depth in the first example in
8403 this section.
8404 .endlist
8405
8406
8407 .section "Temporary DNS errors when looking up host information" &&&
8408          "SECTtemdnserr"
8409 .cindex "host" "lookup failures, temporary"
8410 .cindex "&`+include_defer`&"
8411 .cindex "&`+ignore_defer`&"
8412 A temporary DNS lookup failure normally causes a defer action (except when
8413 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8414 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8415 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8416 section. These options should be used with care, probably only in non-critical
8417 host lists such as whitelists.
8418
8419
8420
8421 .section "Host list patterns for single-key lookups by host name" &&&
8422          "SECThoslispatnamsk"
8423 .cindex "unknown host name"
8424 .cindex "host list" "matching host name"
8425 If a pattern is of the form
8426 .display
8427 <&'single-key-search-type'&>;<&'search-data'&>
8428 .endd
8429 for example
8430 .code
8431 dbm;/host/accept/list
8432 .endd
8433 a single-key lookup is performed, using the host name as its key. If the
8434 lookup succeeds, the host matches the item. The actual data that is looked up
8435 is not used.
8436
8437 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8438 keys in the file, not IP addresses. If you want to do lookups based on IP
8439 addresses, you must precede the search type with &"net-"& (see section
8440 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8441 two items in the same list, one doing an address lookup and one doing a name
8442 lookup, both using the same file.
8443
8444
8445
8446 .section "Host list patterns for query-style lookups" "SECID81"
8447 If a pattern is of the form
8448 .display
8449 <&'query-style-search-type'&>;<&'query'&>
8450 .endd
8451 the query is obeyed, and if it succeeds, the host matches the item. The actual
8452 data that is looked up is not used. The variables &$sender_host_address$& and
8453 &$sender_host_name$& can be used in the query. For example:
8454 .code
8455 hosts_lookup = pgsql;\
8456   select ip from hostlist where ip='$sender_host_address'
8457 .endd
8458 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8459 can use the &%sg%& expansion item to change this if you need to. If you want to
8460 use masked IP addresses in database queries, you can use the &%mask%& expansion
8461 operator.
8462
8463 If the query contains a reference to &$sender_host_name$&, Exim automatically
8464 looks up the host name if it has not already done so. (See section
8465 &<<SECThoslispatnam>>& for comments on finding host names.)
8466
8467 Historical note: prior to release 4.30, Exim would always attempt to find a
8468 host name before running the query, unless the search type was preceded by
8469 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8470 still recognized for query-style lookups, but its presence or absence has no
8471 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8472 See section &<<SECThoslispatsikey>>&.)
8473
8474
8475
8476
8477
8478 .section "Address lists" "SECTaddresslist"
8479 .cindex "list" "address list"
8480 .cindex "address list" "empty item"
8481 .cindex "address list" "patterns"
8482 Address lists contain patterns that are matched against mail addresses. There
8483 is one special case to be considered: the sender address of a bounce message is
8484 always empty. You can test for this by providing an empty item in an address
8485 list. For example, you can set up a router to process bounce messages by
8486 using this option setting:
8487 .code
8488 senders = :
8489 .endd
8490 The presence of the colon creates an empty item. If you do not provide any
8491 data, the list is empty and matches nothing. The empty sender can also be
8492 detected by a regular expression that matches an empty string,
8493 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8494
8495 Non-empty items in an address list can be straightforward email addresses. For
8496 example:
8497 .code
8498 senders = jbc@askone.example : hs@anacreon.example
8499 .endd
8500 A certain amount of wildcarding is permitted. If a pattern contains an @
8501 character, but is not a regular expression and does not begin with a
8502 semicolon-terminated lookup type (described below), the local part of the
8503 subject address is compared with the local part of the pattern, which may start
8504 with an asterisk. If the local parts match, the domain is checked in exactly
8505 the same way as for a pattern in a domain list. For example, the domain can be
8506 wildcarded, refer to a named list, or be a lookup:
8507 .code
8508 deny senders = *@*.spamming.site:\
8509                *@+hostile_domains:\
8510                bozo@partial-lsearch;/list/of/dodgy/sites:\
8511                *@dbm;/bad/domains.db
8512 .endd
8513 .cindex "local part" "starting with !"
8514 .cindex "address list" "local part starting with !"
8515 If a local part that begins with an exclamation mark is required, it has to be
8516 specified using a regular expression, because otherwise the exclamation mark is
8517 treated as a sign of negation, as is standard in lists.
8518
8519 If a non-empty pattern that is not a regular expression or a lookup does not
8520 contain an @ character, it is matched against the domain part of the subject
8521 address. The only two formats that are recognized this way are a literal
8522 domain, or a domain pattern that starts with *. In both these cases, the effect
8523 is the same as if &`*@`& preceded the pattern. For example:
8524 .code
8525 deny senders = enemy.domain : *.enemy.domain
8526 .endd
8527
8528 The following kinds of more complicated address list pattern can match any
8529 address, including the empty address that is characteristic of bounce message
8530 senders:
8531
8532 .ilist
8533 .cindex "regular expressions" "in address list"
8534 .cindex "address list" "regular expression in"
8535 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8536 done against the complete address, with the pattern as the regular expression.
8537 You must take care that backslash and dollar characters are not misinterpreted
8538 as part of the string expansion. The simplest way to do this is to use &`\N`&
8539 to mark that part of the string as non-expandable. For example:
8540 .code
8541 deny senders = \N^.*this.*@example\.com$\N : \
8542                \N^\d{8}.+@spamhaus.example$\N : ...
8543 .endd
8544 The &`\N`& sequences are removed by the expansion, so these items do indeed
8545 start with &"^"& by the time they are being interpreted as address patterns.
8546
8547 .next
8548 .cindex "address list" "lookup for complete address"
8549 Complete addresses can be looked up by using a pattern that starts with a
8550 lookup type terminated by a semicolon, followed by the data for the lookup. For
8551 example:
8552 .code
8553 deny senders = cdb;/etc/blocked.senders : \
8554   mysql;select address from blocked where \
8555   address='${quote_mysql:$sender_address}'
8556 .endd
8557 Both query-style and single-key lookup types can be used. For a single-key
8558 lookup type, Exim uses the complete address as the key. However, empty keys are
8559 not supported for single-key lookups, so a match against the empty address
8560 always fails. This restriction does not apply to query-style lookups.
8561
8562 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8563 cannot be used, and is ignored if specified, with an entry being written to the
8564 panic log.
8565 .cindex "*@ with single-key lookup"
8566 However, you can configure lookup defaults, as described in section
8567 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8568 default. For example, with this lookup:
8569 .code
8570 accept senders = lsearch*@;/some/file
8571 .endd
8572 the file could contains lines like this:
8573 .code
8574 user1@domain1.example
8575 *@domain2.example
8576 .endd
8577 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8578 that are tried is:
8579 .code
8580 nimrod@jaeger.example
8581 *@jaeger.example
8582 *
8583 .endd
8584 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8585 would mean that every address matches, thus rendering the test useless.
8586
8587 &*Warning 2*&: Do not confuse these two kinds of item:
8588 .code
8589 deny recipients = dbm*@;/some/file
8590 deny recipients = *@dbm;/some/file
8591 .endd
8592 The first does a whole address lookup, with defaulting, as just described,
8593 because it starts with a lookup type. The second matches the local part and
8594 domain independently, as described in a bullet point below.
8595 .endlist
8596
8597
8598 The following kinds of address list pattern can match only non-empty addresses.
8599 If the subject address is empty, a match against any of these pattern types
8600 always fails.
8601
8602
8603 .ilist
8604 .cindex "@@ with single-key lookup"
8605 .cindex "address list" "@@ lookup type"
8606 .cindex "address list" "split local part and domain"
8607 If a pattern starts with &"@@"& followed by a single-key lookup item
8608 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8609 split into a local part and a domain. The domain is looked up in the file. If
8610 it is not found, there is no match. If it is found, the data that is looked up
8611 from the file is treated as a colon-separated list of local part patterns, each
8612 of which is matched against the subject local part in turn.
8613
8614 .cindex "asterisk" "in address list"
8615 The lookup may be a partial one, and/or one involving a search for a default
8616 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8617 patterns that are looked up can be regular expressions or begin with &"*"&, or
8618 even be further lookups. They may also be independently negated. For example,
8619 with
8620 .code
8621 deny senders = @@dbm;/etc/reject-by-domain
8622 .endd
8623 the data from which the DBM file is built could contain lines like
8624 .code
8625 baddomain.com:  !postmaster : *
8626 .endd
8627 to reject all senders except &%postmaster%& from that domain.
8628
8629 .cindex "local part" "starting with !"
8630 If a local part that actually begins with an exclamation mark is required, it
8631 has to be specified using a regular expression. In &(lsearch)& files, an entry
8632 may be split over several lines by indenting the second and subsequent lines,
8633 but the separating colon must still be included at line breaks. White space
8634 surrounding the colons is ignored. For example:
8635 .code
8636 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8637   spammer3 : spammer4
8638 .endd
8639 As in all colon-separated lists in Exim, a colon can be included in an item by
8640 doubling.
8641
8642 If the last item in the list starts with a right angle-bracket, the remainder
8643 of the item is taken as a new key to look up in order to obtain a continuation
8644 list of local parts. The new key can be any sequence of characters. Thus one
8645 might have entries like
8646 .code
8647 aol.com: spammer1 : spammer 2 : >*
8648 xyz.com: spammer3 : >*
8649 *:       ^\d{8}$
8650 .endd
8651 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8652 local parts for all domains, in addition to the specific local parts listed for
8653 each domain. Of course, using this feature costs another lookup each time a
8654 chain is followed, but the effort needed to maintain the data is reduced.
8655
8656 .cindex "loop" "in lookups"
8657 It is possible to construct loops using this facility, and in order to catch
8658 them, the chains may be no more than fifty items long.
8659
8660 .next
8661 The @@<&'lookup'&> style of item can also be used with a query-style
8662 lookup, but in this case, the chaining facility is not available. The lookup
8663 can only return a single list of local parts.
8664 .endlist
8665
8666 &*Warning*&: There is an important difference between the address list items
8667 in these two examples:
8668 .code
8669 senders = +my_list
8670 senders = *@+my_list
8671 .endd
8672 In the first one, &`my_list`& is a named address list, whereas in the second
8673 example it is a named domain list.
8674
8675
8676
8677
8678 .section "Case of letters in address lists" "SECTcasletadd"
8679 .cindex "case of local parts"
8680 .cindex "address list" "case forcing"
8681 .cindex "case forcing in address lists"
8682 Domains in email addresses are always handled caselessly, but for local parts
8683 case may be significant on some systems (see &%caseful_local_part%& for how
8684 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8685 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8686 blocking lists should be done in a case-independent manner. Since most address
8687 lists in Exim are used for this kind of control, Exim attempts to do this by
8688 default.
8689
8690 The domain portion of an address is always lowercased before matching it to an
8691 address list. The local part is lowercased by default, and any string
8692 comparisons that take place are done caselessly. This means that the data in
8693 the address list itself, in files included as plain file names, and in any file
8694 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8695 keys in files that are looked up by a search type other than &(lsearch)& (which
8696 works caselessly) must be in lower case, because these lookups are not
8697 case-independent.
8698
8699 .cindex "&`+caseful`&"
8700 To allow for the possibility of caseful address list matching, if an item in
8701 an address list is the string &"+caseful"&, the original case of the local
8702 part is restored for any comparisons that follow, and string comparisons are no
8703 longer case-independent. This does not affect the domain, which remains in
8704 lower case. However, although independent matches on the domain alone are still
8705 performed caselessly, regular expressions that match against an entire address
8706 become case-sensitive after &"+caseful"& has been seen.
8707
8708
8709
8710 .section "Local part lists" "SECTlocparlis"
8711 .cindex "list" "local part list"
8712 .cindex "local part" "list"
8713 Case-sensitivity in local part lists is handled in the same way as for address
8714 lists, as just described. The &"+caseful"& item can be used if required. In a
8715 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8716 set false, the subject is lowercased and the matching is initially
8717 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8718 matching in the local part list, but not elsewhere in the router. If
8719 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8720 option is case-sensitive from the start.
8721
8722 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8723 comments are handled in the same way as address lists &-- they are recognized
8724 only if the # is preceded by white space or the start of the line.
8725 Otherwise, local part lists are matched in the same way as domain lists, except
8726 that the special items that refer to the local host (&`@`&, &`@[]`&,
8727 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8728 Refer to section &<<SECTdomainlist>>& for details of the other available item
8729 types.
8730 .ecindex IIDdohoadli
8731
8732
8733
8734
8735 . ////////////////////////////////////////////////////////////////////////////
8736 . ////////////////////////////////////////////////////////////////////////////
8737
8738 .chapter "String expansions" "CHAPexpand"
8739 .scindex IIDstrexp "expansion" "of strings"
8740 Many strings in Exim's run time configuration are expanded before use. Some of
8741 them are expanded every time they are used; others are expanded only once.
8742
8743 When a string is being expanded it is copied verbatim from left to right except
8744 when a dollar or backslash character is encountered. A dollar specifies the
8745 start of a portion of the string that is interpreted and replaced as described
8746 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8747 escape character, as described in the following section.
8748
8749 Whether a string is expanded depends upon the context.  Usually this is solely
8750 dependent upon the option for which a value is sought; in this documentation,
8751 options for which string expansion is performed are marked with &dagger; after
8752 the data type.  ACL rules always expand strings.  A couple of expansion
8753 conditions do not expand some of the brace-delimited branches, for security
8754 reasons.
8755
8756
8757
8758 .section "Literal text in expanded strings" "SECTlittext"
8759 .cindex "expansion" "including literal text"
8760 An uninterpreted dollar can be included in an expanded string by putting a
8761 backslash in front of it. A backslash can be used to prevent any special
8762 character being treated specially in an expansion, including backslash itself.
8763 If the string appears in quotes in the configuration file, two backslashes are
8764 required because the quotes themselves cause interpretation of backslashes when
8765 the string is read in (see section &<<SECTstrings>>&).
8766
8767 .cindex "expansion" "non-expandable substrings"
8768 A portion of the string can specified as non-expandable by placing it between
8769 two occurrences of &`\N`&. This is particularly useful for protecting regular
8770 expressions, which often contain backslashes and dollar signs. For example:
8771 .code
8772 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8773 .endd
8774 On encountering the first &`\N`&, the expander copies subsequent characters
8775 without interpretation until it reaches the next &`\N`& or the end of the
8776 string.
8777
8778
8779
8780 .section "Character escape sequences in expanded strings" "SECID82"
8781 .cindex "expansion" "escape sequences"
8782 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8783 expanded string is recognized as an escape sequence for the character newline,
8784 carriage return, or tab, respectively. A backslash followed by up to three
8785 octal digits is recognized as an octal encoding for a single character, and a
8786 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8787 encoding.
8788
8789 These escape sequences are also recognized in quoted strings when they are read
8790 in. Their interpretation in expansions as well is useful for unquoted strings,
8791 and for other cases such as looked-up strings that are then expanded.
8792
8793
8794 .section "Testing string expansions" "SECID83"
8795 .cindex "expansion" "testing"
8796 .cindex "testing" "string expansion"
8797 .oindex "&%-be%&"
8798 Many expansions can be tested by calling Exim with the &%-be%& option. This
8799 takes the command arguments, or lines from the standard input if there are no
8800 arguments, runs them through the string expansion code, and writes the results
8801 to the standard output. Variables based on configuration values are set up, but
8802 since no message is being processed, variables such as &$local_part$& have no
8803 value. Nevertheless the &%-be%& option can be useful for checking out file and
8804 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8805 and &%nhash%&.
8806
8807 Exim gives up its root privilege when it is called with the &%-be%& option, and
8808 instead runs under the uid and gid it was called with, to prevent users from
8809 using &%-be%& for reading files to which they do not have access.
8810
8811 .oindex "&%-bem%&"
8812 If you want to test expansions that include variables whose values are taken
8813 from a message, there are two other options that can be used. The &%-bem%&
8814 option is like &%-be%& except that it is followed by a file name. The file is
8815 read as a message before doing the test expansions. For example:
8816 .code
8817 exim -bem /tmp/test.message '$h_subject:'
8818 .endd
8819 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8820 Exim message identifier. For example:
8821 .code
8822 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8823 .endd
8824 This loads the message from Exim's spool before doing the test expansions, and
8825 is therefore restricted to admin users.
8826
8827
8828 .section "Forced expansion failure" "SECTforexpfai"
8829 .cindex "expansion" "forced failure"
8830 A number of expansions that are described in the following section have
8831 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8832 (which are sometimes called &"curly brackets"&). Which of the two strings is
8833 used depends on some condition that is evaluated as part of the expansion. If,
8834 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8835 the entire string expansion fails in a way that can be detected by the code
8836 that requested the expansion. This is called &"forced expansion failure"&, and
8837 its consequences depend on the circumstances. In some cases it is no different
8838 from any other expansion failure, but in others a different action may be
8839 taken. Such variations are mentioned in the documentation of the option that is
8840 being expanded.
8841
8842
8843
8844
8845 .section "Expansion items" "SECTexpansionitems"
8846 The following items are recognized in expanded strings. White space may be used
8847 between sub-items that are keywords or substrings enclosed in braces inside an
8848 outer set of braces, to improve readability. &*Warning*&: Within braces,
8849 white space is significant.
8850
8851 .vlist
8852 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8853 .cindex "expansion" "variables"
8854 Substitute the contents of the named variable, for example:
8855 .code
8856 $local_part
8857 ${domain}
8858 .endd
8859 The second form can be used to separate the name from subsequent alphanumeric
8860 characters. This form (using braces) is available only for variables; it does
8861 &'not'& apply to message headers. The names of the variables are given in
8862 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8863 given, the expansion fails.
8864
8865 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8866 .cindex "expansion" "operators"
8867 The string is first itself expanded, and then the operation specified by
8868 <&'op'&> is applied to it. For example:
8869 .code
8870 ${lc:$local_part}
8871 .endd
8872 The string starts with the first character after the colon, which may be
8873 leading white space. A list of operators is given in section &<<SECTexpop>>&
8874 below. The operator notation is used for simple expansion items that have just
8875 one argument, because it reduces the number of braces and therefore makes the
8876 string easier to understand.
8877
8878 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8879 This item inserts &"basic"& header lines. It is described with the &%header%&
8880 expansion item below.
8881
8882
8883 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8884 .cindex "expansion" "calling an acl"
8885 .cindex "&%acl%&" "call from expansion"
8886 The name and zero to nine argument strings are first expanded separately.  The expanded
8887 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8888 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8889 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8890 and may use the variables; if another acl expansion is used the values
8891 are restored after it returns.  If the ACL sets
8892 a value using a "message =" modifier and returns accept or deny, the value becomes
8893 the result of the expansion.
8894 If no message is set and the ACL returns accept or deny
8895 the expansion result is an empty string.
8896 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8897
8898
8899 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8900        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8901 .cindex "expansion" "extracting cerificate fields"
8902 .cindex "&%certextract%&" "certificate fields"
8903 .cindex "certificate" "extracting fields"
8904 The <&'certificate'&> must be a variable of type certificate.
8905 The field name is expanded and used to retrive the relevant field from
8906 the certificate.  Supported fields are:
8907 .display
8908 &`version        `&
8909 &`serial_number  `&
8910 &`subject        `& RFC4514 DN
8911 &`issuer         `& RFC4514 DN
8912 &`notbefore      `& time
8913 &`notafter       `& time
8914 &`sig_algorithm  `&
8915 &`signature      `&
8916 &`subj_altname   `& tagged list
8917 &`ocsp_uri       `& list
8918 &`crl_uri        `& list
8919 .endd
8920 If the field is found,
8921 <&'string2'&> is expanded, and replaces the whole item;
8922 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8923 variable &$value$& contains the value that has been extracted. Afterwards, it
8924 is restored to any previous value it might have had.
8925
8926 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8927 key is not found. If {<&'string2'&>} is also omitted, the value that was
8928 extracted is used.
8929
8930 Some field names take optional modifiers, appended and separated by commas.
8931
8932 The field selectors marked as "RFC4514" above
8933 output a Distinguished Name string which is
8934 not quite
8935 parseable by Exim as a comma-separated tagged list
8936 (the exceptions being elements containin commas).
8937 RDN elements of a single type may be selected by
8938 a modifier of the type label; if so the expansion
8939 result is a list (newline-separated by default).
8940 The separator may be changed by another modifer of
8941 a right angle-bracket followed immediately by the new separator.
8942 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8943
8944 The field selectors marked as "time" above
8945 take an optional modifier of "int"
8946 for which the result is the number of seconds since epoch.
8947 Otherwise the result is a human-readable string
8948 in the timezone selected by the main "timezone" option.
8949
8950 The field selectors marked as "list" above return a list,
8951 newline-separated by default,
8952 (embedded separator characters in elements are doubled).
8953 The separator may be changed by a modifier of
8954 a right angle-bracket followed immediately by the new separator.
8955
8956 The field selectors marked as "tagged" above
8957 prefix each list element with a type string and an equals sign.
8958 Elements of only one type may be selected by a modifier
8959 which is one of "dns", "uri" or "mail";
8960 if so the elenment tags are omitted.
8961
8962 If not otherwise noted field values are presented in human-readable form.
8963
8964 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8965        {*&<&'arg'&>&*}...}*&"
8966 .cindex &%dlfunc%&
8967 This expansion dynamically loads and then calls a locally-written C function.
8968 This functionality is available only if Exim is compiled with
8969 .code
8970 EXPAND_DLFUNC=yes
8971 .endd
8972 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8973 object so that it doesn't reload the same object file in the same Exim process
8974 (but of course Exim does start new processes frequently).
8975
8976 There may be from zero to eight arguments to the function. When compiling
8977 a local function that is to be called in this way, &_local_scan.h_& should be
8978 included. The Exim variables and functions that are defined by that API
8979 are also available for dynamically loaded functions. The function itself
8980 must have the following type:
8981 .code
8982 int dlfunction(uschar **yield, int argc, uschar *argv[])
8983 .endd
8984 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8985 function should return one of the following values:
8986
8987 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8988 into the expanded string that is being built.
8989
8990 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8991 from &'yield'&, if it is set.
8992
8993 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8994 taken from &'yield'& if it is set.
8995
8996 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8997
8998 When compiling a function that is to be used in this way with gcc,
8999 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9000 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9001
9002 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9003        {*&<&'string3'&>&*}}*&"
9004 .cindex "expansion" "extracting substrings by key"
9005 .cindex "&%extract%&" "substrings by key"
9006 The key and <&'string1'&> are first expanded separately. Leading and trailing
9007 white space is removed from the key (but not from any of the strings). The key
9008 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9009 form:
9010 .display
9011 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9012 .endd
9013 .vindex "&$value$&"
9014 where the equals signs and spaces (but not both) are optional. If any of the
9015 values contain white space, they must be enclosed in double quotes, and any
9016 values that are enclosed in double quotes are subject to escape processing as
9017 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9018 for the value that corresponds to the key. The search is case-insensitive. If
9019 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9020 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9021 variable &$value$& contains the value that has been extracted. Afterwards, it
9022 is restored to any previous value it might have had.
9023
9024 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9025 key is not found. If {<&'string2'&>} is also omitted, the value that was
9026 extracted is used. Thus, for example, these two expansions are identical, and
9027 yield &"2001"&:
9028 .code
9029 ${extract{gid}{uid=1984 gid=2001}}
9030 ${extract{gid}{uid=1984 gid=2001}{$value}}
9031 .endd
9032 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9033 appear, for example:
9034 .code
9035 ${extract{Z}{A=... B=...}{$value} fail }
9036 .endd
9037 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9038 {<&'string2'&>} must be present for &"fail"& to be recognized.
9039
9040
9041 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9042         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9043 .cindex "expansion" "extracting substrings by number"
9044 .cindex "&%extract%&" "substrings by number"
9045 The <&'number'&> argument must consist entirely of decimal digits,
9046 apart from leading and trailing white space, which is ignored.
9047 This is what distinguishes this form of &%extract%& from the previous kind. It
9048 behaves in the same way, except that, instead of extracting a named field, it
9049 extracts from <&'string1'&> the field whose number is given as the first
9050 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9051 <&'string3'&> as before.
9052
9053 The fields in the string are separated by any one of the characters in the
9054 separator string. These may include space or tab characters.
9055 The first field is numbered one. If the number is negative, the fields are
9056 counted from the end of the string, with the rightmost one numbered -1. If the
9057 number given is zero, the entire string is returned. If the modulus of the
9058 number is greater than the number of fields in the string, the result is the
9059 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9060 provided. For example:
9061 .code
9062 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9063 .endd
9064 yields &"42"&, and
9065 .code
9066 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9067 .endd
9068 yields &"99"&. Two successive separators mean that the field between them is
9069 empty (for example, the fifth field above).
9070
9071
9072 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9073 .cindex "list" "selecting by condition"
9074 .cindex "expansion" "selecting from list by condition"
9075 .vindex "&$item$&"
9076 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9077 default, but the separator can be changed in the usual way. For each item
9078 in this list, its value is place in &$item$&, and then the condition is
9079 evaluated. If the condition is true, &$item$& is added to the output as an
9080 item in a new list; if the condition is false, the item is discarded. The
9081 separator used for the output list is the same as the one used for the
9082 input, but a separator setting is not included in the output. For example:
9083 .code
9084 ${filter{a:b:c}{!eq{$item}{b}}
9085 .endd
9086 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9087 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9088
9089
9090 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9091 .cindex "hash function" "textual"
9092 .cindex "expansion" "textual hash"
9093 This is a textual hashing function, and was the first to be implemented in
9094 early versions of Exim. In current releases, there are other hashing functions
9095 (numeric, MD5, and SHA-1), which are described below.
9096
9097 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9098 <&'n'&>. If you are using fixed values for these numbers, that is, if
9099 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9100 use the simpler operator notation that avoids some of the braces:
9101 .code
9102 ${hash_<n>_<m>:<string>}
9103 .endd
9104 The second number is optional (in both notations). If <&'n'&> is greater than
9105 or equal to the length of the string, the expansion item returns the string.
9106 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9107 function to the string. The new string consists of characters taken from the
9108 first <&'m'&> characters of the string
9109 .code
9110 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9111 .endd
9112 If <&'m'&> is not present the value 26 is used, so that only lower case
9113 letters appear. For example:
9114 .display
9115 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9116 &`$hash{5}{monty}}           `&   yields  &`monty`&
9117 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9118 .endd
9119
9120 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9121         &*$h_*&<&'header&~name'&>&*:*&" &&&
9122        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9123         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9124        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9125         &*$rh_*&<&'header&~name'&>&*:*&"
9126 .cindex "expansion" "header insertion"
9127 .vindex "&$header_$&"
9128 .vindex "&$bheader_$&"
9129 .vindex "&$rheader_$&"
9130 .cindex "header lines" "in expansion strings"
9131 .cindex "header lines" "character sets"
9132 .cindex "header lines" "decoding"
9133 Substitute the contents of the named message header line, for example
9134 .code
9135 $header_reply-to:
9136 .endd
9137 The newline that terminates a header line is not included in the expansion, but
9138 internal newlines (caused by splitting the header line over several physical
9139 lines) may be present.
9140
9141 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9142 the data in the header line is interpreted.
9143
9144 .ilist
9145 .cindex "white space" "in header lines"
9146 &%rheader%& gives the original &"raw"& content of the header line, with no
9147 processing at all, and without the removal of leading and trailing white space.
9148
9149 .next
9150 .cindex "base64 encoding" "in header lines"
9151 &%bheader%& removes leading and trailing white space, and then decodes base64
9152 or quoted-printable MIME &"words"& within the header text, but does no
9153 character set translation. If decoding of what looks superficially like a MIME
9154 &"word"& fails, the raw string is returned. If decoding
9155 .cindex "binary zero" "in header line"
9156 produces a binary zero character, it is replaced by a question mark &-- this is
9157 what Exim does for binary zeros that are actually received in header lines.
9158
9159 .next
9160 &%header%& tries to translate the string as decoded by &%bheader%& to a
9161 standard character set. This is an attempt to produce the same string as would
9162 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9163 returned. Translation is attempted only on operating systems that support the
9164 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9165 a system Makefile or in &_Local/Makefile_&.
9166 .endlist ilist
9167
9168 In a filter file, the target character set for &%header%& can be specified by a
9169 command of the following form:
9170 .code
9171 headers charset "UTF-8"
9172 .endd
9173 This command affects all references to &$h_$& (or &$header_$&) expansions in
9174 subsequently obeyed filter commands. In the absence of this command, the target
9175 character set in a filter is taken from the setting of the &%headers_charset%&
9176 option in the runtime configuration. The value of this option defaults to the
9177 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9178 ISO-8859-1.
9179
9180 Header names follow the syntax of RFC 2822, which states that they may contain
9181 any printing characters except space and colon. Consequently, curly brackets
9182 &'do not'& terminate header names, and should not be used to enclose them as
9183 if they were variables. Attempting to do so causes a syntax error.
9184
9185 Only header lines that are common to all copies of a message are visible to
9186 this mechanism. These are the original header lines that are received with the
9187 message, and any that are added by an ACL statement or by a system
9188 filter. Header lines that are added to a particular copy of a message by a
9189 router or transport are not accessible.
9190
9191 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9192 before the DATA ACL, because the header structure is not set up until the
9193 message is received. Header lines that are added in a RCPT ACL (for example)
9194 are saved until the message's incoming header lines are available, at which
9195 point they are added. When a DATA ACL is running, however, header lines added
9196 by earlier ACLs are visible.
9197
9198 Upper case and lower case letters are synonymous in header names. If the
9199 following character is white space, the terminating colon may be omitted, but
9200 this is not recommended, because you may then forget it when it is needed. When
9201 white space terminates the header name, it is included in the expanded string.
9202 If the message does not contain the given header, the expansion item is
9203 replaced by an empty string. (See the &%def%& condition in section
9204 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9205
9206 If there is more than one header with the same name, they are all concatenated
9207 to form the substitution string, up to a maximum length of 64K. Unless
9208 &%rheader%& is being used, leading and trailing white space is removed from
9209 each header before concatenation, and a completely empty header is ignored. A
9210 newline character is then inserted between non-empty headers, but there is no
9211 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9212 those headers that contain lists of addresses, a comma is also inserted at the
9213 junctions between headers. This does not happen for the &%rheader%& expansion.
9214
9215
9216 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9217 .cindex "expansion" "hmac hashing"
9218 .cindex &%hmac%&
9219 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9220 shared secret and some text into a message authentication code, as specified in
9221 RFC 2104. This differs from &`${md5:secret_text...}`& or
9222 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9223 cryptographic hash, allowing for authentication that is not possible with MD5
9224 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9225 present. For example:
9226 .code
9227 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9228 .endd
9229 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9230 produces:
9231 .code
9232 dd97e3ba5d1a61b5006108f8c8252953
9233 .endd
9234 As an example of how this might be used, you might put in the main part of
9235 an Exim configuration:
9236 .code
9237 SPAMSCAN_SECRET=cohgheeLei2thahw
9238 .endd
9239 In a router or a transport you could then have:
9240 .code
9241 headers_add = \
9242   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9243   ${hmac{md5}{SPAMSCAN_SECRET}\
9244   {${primary_hostname},${message_exim_id},$h_message-id:}}
9245 .endd
9246 Then given a message, you can check where it was scanned by looking at the
9247 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9248 this header line is authentic by recomputing the authentication code from the
9249 host name, message ID and the &'Message-id:'& header line. This can be done
9250 using Exim's &%-be%& option, or by other means, for example by using the
9251 &'hmac_md5_hex()'& function in Perl.
9252
9253
9254 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9255 .cindex "expansion" "conditional"
9256 .cindex "&%if%&, expansion item"
9257 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9258 item; otherwise <&'string2'&> is used. The available conditions are described
9259 in section &<<SECTexpcond>>& below. For example:
9260 .code
9261 ${if eq {$local_part}{postmaster} {yes}{no} }
9262 .endd
9263 The second string need not be present; if it is not and the condition is not
9264 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9265 be present instead of the second string (without any curly brackets). In this
9266 case, the expansion is forced to fail if the condition is not true (see section
9267 &<<SECTforexpfai>>&).
9268
9269 If both strings are omitted, the result is the string &`true`& if the condition
9270 is true, and the empty string if the condition is false. This makes it less
9271 cumbersome to write custom ACL and router conditions. For example, instead of
9272 .code
9273 condition = ${if >{$acl_m4}{3}{true}{false}}
9274 .endd
9275 you can use
9276 .code
9277 condition = ${if >{$acl_m4}{3}}
9278 .endd
9279
9280 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9281 .cindex "expansion" "string truncation"
9282 .cindex "&%length%& expansion item"
9283 The &%length%& item is used to extract the initial portion of a string. Both
9284 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9285 you are using a fixed value for the number, that is, if <&'string1'&> does not
9286 change when expanded, you can use the simpler operator notation that avoids
9287 some of the braces:
9288 .code
9289 ${length_<n>:<string>}
9290 .endd
9291 The result of this item is either the first <&'n'&> characters or the whole
9292 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9293 &%strlen%&, which gives the length of a string.
9294
9295
9296 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9297         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9298 .cindex "expansion" "extracting list elements by number"
9299 .cindex "&%listextract%&" "extract list elements by number"
9300 .cindex "list" "extracting elements by number"
9301 The <&'number'&> argument must consist entirely of decimal digits,
9302 apart from an optional leading minus,
9303 and leading and trailing white space (which is ignored).
9304
9305 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9306 default, but the separator can be changed in the usual way.
9307
9308 The first field of the list is numbered one.
9309 If the number is negative, the fields are
9310 counted from the end of the list, with the rightmost one numbered -1.
9311 The numbered element of the list is extracted and placed in &$value$&,
9312 then <&'string2'&> is expanded as the result.
9313
9314 If the modulus of the
9315 number is zero or greater than the number of fields in the string,
9316 the result is the expansion of <&'string3'&>.
9317
9318 For example:
9319 .code
9320 ${listextract{2}{x:42:99}}
9321 .endd
9322 yields &"42"&, and
9323 .code
9324 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9325 .endd
9326 yields &"result: 99"&.
9327
9328 If {<&'string3'&>} is omitted, an empty string is used for string3.
9329 If {<&'string2'&>} is also omitted, the value that was
9330 extracted is used.
9331 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9332
9333
9334 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9335         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9336 This is the first of one of two different types of lookup item, which are both
9337 described in the next item.
9338
9339 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9340         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9341 .cindex "expansion" "lookup in"
9342 .cindex "file" "lookups"
9343 .cindex "lookup" "in expanded string"
9344 The two forms of lookup item specify data lookups in files and databases, as
9345 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9346 lookups, and the second is used for query-style lookups. The <&'key'&>,
9347 <&'file'&>, and <&'query'&> strings are expanded before use.
9348
9349 If there is any white space in a lookup item which is part of a filter command,
9350 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9351 other place where white space is significant, the lookup item must be enclosed
9352 in double quotes. The use of data lookups in users' filter files may be locked
9353 out by the system administrator.
9354
9355 .vindex "&$value$&"
9356 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9357 During its expansion, the variable &$value$& contains the data returned by the
9358 lookup. Afterwards it reverts to the value it had previously (at the outer
9359 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9360 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9361 string on failure. If <&'string2'&> is provided, it can itself be a nested
9362 lookup, thus providing a mechanism for looking up a default value when the
9363 original lookup fails.
9364
9365 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9366 data for the outer lookup while the parameters of the second lookup are
9367 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9368 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9369 appear, and in this case, if the lookup fails, the entire expansion is forced
9370 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9371 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9372 successful lookup, and nothing in the case of failure.
9373
9374 For single-key lookups, the string &"partial"& is permitted to precede the
9375 search type in order to do partial matching, and * or *@ may follow a search
9376 type to request default lookups if the key does not match (see sections
9377 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9378
9379 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9380 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9381 and non-wild parts of the key during the expansion of the replacement text.
9382 They return to their previous values at the end of the lookup item.
9383
9384 This example looks up the postmaster alias in the conventional alias file:
9385 .code
9386 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9387 .endd
9388 This example uses NIS+ to look up the full name of the user corresponding to
9389 the local part of an address, forcing the expansion to fail if it is not found:
9390 .code
9391 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9392   {$value}fail}
9393 .endd
9394
9395
9396 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9397 .cindex "expansion" "list creation"
9398 .vindex "&$item$&"
9399 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9400 default, but the separator can be changed in the usual way. For each item
9401 in this list, its value is place in &$item$&, and then <&'string2'&> is
9402 expanded and added to the output as an item in a new list. The separator used
9403 for the output list is the same as the one used for the input, but a separator
9404 setting is not included in the output. For example:
9405 .code
9406 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9407 .endd
9408 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9409 value of &$item$& is restored to what it was before. See also the &*filter*&
9410 and &*reduce*& expansion items.
9411
9412 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9413 .cindex "expansion" "numeric hash"
9414 .cindex "hash function" "numeric"
9415 The three strings are expanded; the first two must yield numbers. Call them
9416 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9417 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9418 can use the simpler operator notation that avoids some of the braces:
9419 .code
9420 ${nhash_<n>_<m>:<string>}
9421 .endd
9422 The second number is optional (in both notations). If there is only one number,
9423 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9424 processed by a div/mod hash function that returns two numbers, separated by a
9425 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9426 example,
9427 .code
9428 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9429 .endd
9430 returns the string &"6/33"&.
9431
9432
9433
9434 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9435 .cindex "Perl" "use in expanded string"
9436 .cindex "expansion" "calling Perl from"
9437 This item is available only if Exim has been built to include an embedded Perl
9438 interpreter. The subroutine name and the arguments are first separately
9439 expanded, and then the Perl subroutine is called with those arguments. No
9440 additional arguments need be given; the maximum number permitted, including the
9441 name of the subroutine, is nine.
9442
9443 The return value of the subroutine is inserted into the expanded string, unless
9444 the return value is &%undef%&. In that case, the expansion fails in the same
9445 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9446 Whatever you return is evaluated in a scalar context. For example, if you
9447 return the name of a Perl vector, the return value is the size of the vector,
9448 not its contents.
9449
9450 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9451 with the error message that was passed to &%die%&. More details of the embedded
9452 Perl facility are given in chapter &<<CHAPperl>>&.
9453
9454 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9455 out the use of this expansion item in filter files.
9456
9457
9458 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9459 .cindex "&%prvs%& expansion item"
9460 The first argument is a complete email address and the second is secret
9461 keystring. The third argument, specifying a key number, is optional. If absent,
9462 it defaults to 0. The result of the expansion is a prvs-signed email address,
9463 to be typically used with the &%return_path%& option on an &(smtp)& transport
9464 as part of a bounce address tag validation (BATV) scheme. For more discussion
9465 and an example, see section &<<SECTverifyPRVS>>&.
9466
9467 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9468         {*&<&'string'&>&*}}*&"
9469 .cindex "&%prvscheck%& expansion item"
9470 This expansion item is the complement of the &%prvs%& item. It is used for
9471 checking prvs-signed addresses. If the expansion of the first argument does not
9472 yield a syntactically valid prvs-signed address, the whole item expands to the
9473 empty string. When the first argument does expand to a syntactically valid
9474 prvs-signed address, the second argument is expanded, with the prvs-decoded
9475 version of the address and the key number extracted from the address in the
9476 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9477
9478 These two variables can be used in the expansion of the second argument to
9479 retrieve the secret. The validity of the prvs-signed address is then checked
9480 against the secret. The result is stored in the variable &$prvscheck_result$&,
9481 which is empty for failure or &"1"& for success.
9482
9483 The third argument is optional; if it is missing, it defaults to an empty
9484 string. This argument is now expanded. If the result is an empty string, the
9485 result of the expansion is the decoded version of the address. This is the case
9486 whether or not the signature was valid. Otherwise, the result of the expansion
9487 is the expansion of the third argument.
9488
9489 All three variables can be used in the expansion of the third argument.
9490 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9491 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9492
9493 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9494 .cindex "expansion" "inserting an entire file"
9495 .cindex "file" "inserting into expansion"
9496 .cindex "&%readfile%& expansion item"
9497 The file name and end-of-line string are first expanded separately. The file is
9498 then read, and its contents replace the entire item. All newline characters in
9499 the file are replaced by the end-of-line string if it is present. Otherwise,
9500 newlines are left in the string.
9501 String expansion is not applied to the contents of the file. If you want this,
9502 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9503 the string expansion fails.
9504
9505 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9506 locks out the use of this expansion item in filter files.
9507
9508
9509
9510 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9511         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9512 .cindex "expansion" "inserting from a socket"
9513 .cindex "socket, use of in expansion"
9514 .cindex "&%readsocket%& expansion item"
9515 This item inserts data from a Unix domain or TCP socket into the expanded
9516 string. The minimal way of using it uses just two arguments, as in these
9517 examples:
9518 .code
9519 ${readsocket{/socket/name}{request string}}
9520 ${readsocket{inet:some.host:1234}{request string}}
9521 .endd
9522 For a Unix domain socket, the first substring must be the path to the socket.
9523 For an Internet socket, the first substring must contain &`inet:`& followed by
9524 a host name or IP address, followed by a colon and a port, which can be a
9525 number or the name of a TCP port in &_/etc/services_&. An IP address may
9526 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9527 example:
9528 .code
9529 ${readsocket{inet:[::1]:1234}{request string}}
9530 .endd
9531 Only a single host name may be given, but if looking it up yields more than
9532 one IP address, they are each tried in turn until a connection is made. For
9533 both kinds of socket, Exim makes a connection, writes the request string
9534 (unless it is an empty string) and reads from the socket until an end-of-file
9535 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9536 extend what can be done. Firstly, you can vary the timeout. For example:
9537 .code
9538 ${readsocket{/socket/name}{request string}{3s}}
9539 .endd
9540 A fourth argument allows you to change any newlines that are in the data
9541 that is read, in the same way as for &%readfile%& (see above). This example
9542 turns them into spaces:
9543 .code
9544 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9545 .endd
9546 As with all expansions, the substrings are expanded before the processing
9547 happens. Errors in these sub-expansions cause the expansion to fail. In
9548 addition, the following errors can occur:
9549
9550 .ilist
9551 Failure to create a socket file descriptor;
9552 .next
9553 Failure to connect the socket;
9554 .next
9555 Failure to write the request string;
9556 .next
9557 Timeout on reading from the socket.
9558 .endlist
9559
9560 By default, any of these errors causes the expansion to fail. However, if
9561 you supply a fifth substring, it is expanded and used when any of the above
9562 errors occurs. For example:
9563 .code
9564 ${readsocket{/socket/name}{request string}{3s}{\n}\
9565   {socket failure}}
9566 .endd
9567 You can test for the existence of a Unix domain socket by wrapping this
9568 expansion in &`${if exists`&, but there is a race condition between that test
9569 and the actual opening of the socket, so it is safer to use the fifth argument
9570 if you want to be absolutely sure of avoiding an expansion error for a
9571 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9572
9573 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9574 locks out the use of this expansion item in filter files.
9575
9576
9577 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9578 .cindex "expansion" "reducing a list to a scalar"
9579 .cindex "list" "reducing to a scalar"
9580 .vindex "&$value$&"
9581 .vindex "&$item$&"
9582 This operation reduces a list to a single, scalar string. After expansion,
9583 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9584 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9585 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9586 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9587 them. The result of that expansion is assigned to &$value$& before the next
9588 iteration. When the end of the list is reached, the final value of &$value$& is
9589 added to the expansion output. The &*reduce*& expansion item can be used in a
9590 number of ways. For example, to add up a list of numbers:
9591 .code
9592 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9593 .endd
9594 The result of that expansion would be &`6`&. The maximum of a list of numbers
9595 can be found:
9596 .code
9597 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9598 .endd
9599 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9600 restored to what they were before. See also the &*filter*& and &*map*&
9601 expansion items.
9602
9603 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9604 This item inserts &"raw"& header lines. It is described with the &%header%&
9605 expansion item above.
9606
9607 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9608         {*&<&'string2'&>&*}}*&"
9609 .cindex "expansion" "running a command"
9610 .cindex "&%run%& expansion item"
9611 The command and its arguments are first expanded as one string. The string is
9612 split apart into individual arguments by spaces, and then the command is run
9613 in a separate process, but under the same uid and gid.  As in other command
9614 executions from Exim, a shell is not used by default. If the command requires
9615 a shell, you must explicitly code it.
9616
9617 Since the arguments are split by spaces, when there is a variable expansion
9618 which has an empty result, it will cause the situation that the argument will
9619 simply be omitted when the program is actually executed by Exim. If the
9620 script/program requires a specific number of arguments and the expanded
9621 variable could possibly result in this empty expansion, the variable must be
9622 quoted. This is more difficult if the expanded variable itself could result
9623 in a string containing quotes, because it would interfere with the quotes
9624 around the command arguments. A possible guard against this is to wrap the
9625 variable in the &%sg%& operator to change any quote marks to some other
9626 character.
9627
9628 The standard input for the command exists, but is empty. The standard output
9629 and standard error are set to the same file descriptor.
9630 .cindex "return code" "from &%run%& expansion"
9631 .vindex "&$value$&"
9632 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9633 and replaces the entire item; during this expansion, the standard output/error
9634 from the command is in the variable &$value$&. If the command fails,
9635 <&'string2'&>, if present, is expanded and used. Once again, during the
9636 expansion, the standard output/error from the command is in the variable
9637 &$value$&.
9638
9639 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9640 can be the word &"fail"& (not in braces) to force expansion failure if the
9641 command does not succeed. If both strings are omitted, the result is contents
9642 of the standard output/error on success, and nothing on failure.
9643
9644 .vindex "&$run_in_acl$&"
9645 The standard output/error of the command is put in the variable &$value$&.
9646 In this ACL example, the output of a command is logged for the admin to
9647 troubleshoot:
9648 .code
9649 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9650       log_message  = Output of id: $value
9651 .endd
9652 If the command requires shell idioms, such as the > redirect operator, the
9653 shell must be invoked directly, such as with:
9654 .code
9655 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9656 .endd
9657
9658 .vindex "&$runrc$&"
9659 The return code from the command is put in the variable &$runrc$&, and this
9660 remains set afterwards, so in a filter file you can do things like this:
9661 .code
9662 if "${run{x y z}{}}$runrc" is 1 then ...
9663   elif $runrc is 2 then ...
9664   ...
9665 endif
9666 .endd
9667 If execution of the command fails (for example, the command does not exist),
9668 the return code is 127 &-- the same code that shells use for non-existent
9669 commands.
9670
9671 &*Warning*&: In a router or transport, you cannot assume the order in which
9672 option values are expanded, except for those preconditions whose order of
9673 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9674 by the expansion of one option, and use it in another.
9675
9676 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9677 out the use of this expansion item in filter files.
9678
9679
9680 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9681 .cindex "expansion" "string substitution"
9682 .cindex "&%sg%& expansion item"
9683 This item works like Perl's substitution operator (s) with the global (/g)
9684 option; hence its name. However, unlike the Perl equivalent, Exim does not
9685 modify the subject string; instead it returns the modified string for insertion
9686 into the overall expansion. The item takes three arguments: the subject string,
9687 a regular expression, and a substitution string. For example:
9688 .code
9689 ${sg{abcdefabcdef}{abc}{xyz}}
9690 .endd
9691 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9692 if any $ or \ characters are required in the regular expression or in the
9693 substitution string, they have to be escaped. For example:
9694 .code
9695 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9696 .endd
9697 yields &"defabc"&, and
9698 .code
9699 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9700 .endd
9701 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9702 the regular expression from string expansion.
9703
9704
9705
9706 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9707 .cindex sorting a list
9708 .cindex list sorting
9709 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9710 default, but the separator can be changed in the usual way.
9711 The <&'comparator'&> argument is interpreted as the operator
9712 of a two-argument expansion condition.
9713 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9714 The comparison should return true when applied to two values
9715 if the first value should sort before the second value.
9716 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9717 the element being placed in &$item$&,
9718 to give values for comparison.
9719
9720 The item result is a sorted list,
9721 with the original list separator,
9722 of the list elements (in full) of the original.
9723
9724 Examples:
9725 .code
9726 ${sort{3:2:1:4}{<}{$item}}
9727 .endd
9728 sorts a list of numbers, and
9729 .code
9730 ${sort {$lookup dnsdb{>:,,mx=example.com}} {<} {${listextract{1}{<,$item}}}}
9731 .endd
9732 will sort an MX lookup into priority order.
9733
9734
9735 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9736 .cindex "&%substr%& expansion item"
9737 .cindex "substring extraction"
9738 .cindex "expansion" "substring extraction"
9739 The three strings are expanded; the first two must yield numbers. Call them
9740 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9741 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9742 can use the simpler operator notation that avoids some of the braces:
9743 .code
9744 ${substr_<n>_<m>:<string>}
9745 .endd
9746 The second number is optional (in both notations).
9747 If it is absent in the simpler format, the preceding underscore must also be
9748 omitted.
9749
9750 The &%substr%& item can be used to extract more general substrings than
9751 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9752 length required. For example
9753 .code
9754 ${substr{3}{2}{$local_part}}
9755 .endd
9756 If the starting offset is greater than the string length the result is the
9757 null string; if the length plus starting offset is greater than the string
9758 length, the result is the right-hand part of the string, starting from the
9759 given offset. The first character in the string has offset zero.
9760
9761 The &%substr%& expansion item can take negative offset values to count
9762 from the right-hand end of its operand. The last character is offset -1, the
9763 second-last is offset -2, and so on. Thus, for example,
9764 .code
9765 ${substr{-5}{2}{1234567}}
9766 .endd
9767 yields &"34"&. If the absolute value of a negative offset is greater than the
9768 length of the string, the substring starts at the beginning of the string, and
9769 the length is reduced by the amount of overshoot. Thus, for example,
9770 .code
9771 ${substr{-5}{2}{12}}
9772 .endd
9773 yields an empty string, but
9774 .code
9775 ${substr{-3}{2}{12}}
9776 .endd
9777 yields &"1"&.
9778
9779 When the second number is omitted from &%substr%&, the remainder of the string
9780 is taken if the offset is positive. If it is negative, all characters in the
9781 string preceding the offset point are taken. For example, an offset of -1 and
9782 no length, as in these semantically identical examples:
9783 .code
9784 ${substr_-1:abcde}
9785 ${substr{-1}{abcde}}
9786 .endd
9787 yields all but the last character of the string, that is, &"abcd"&.
9788
9789
9790
9791 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9792         {*&<&'replacements'&>&*}}*&"
9793 .cindex "expansion" "character translation"
9794 .cindex "&%tr%& expansion item"
9795 This item does single-character translation on its subject string. The second
9796 argument is a list of characters to be translated in the subject string. Each
9797 matching character is replaced by the corresponding character from the
9798 replacement list. For example
9799 .code
9800 ${tr{abcdea}{ac}{13}}
9801 .endd
9802 yields &`1b3de1`&. If there are duplicates in the second character string, the
9803 last occurrence is used. If the third string is shorter than the second, its
9804 last character is replicated. However, if it is empty, no translation takes
9805 place.
9806 .endlist
9807
9808
9809
9810 .section "Expansion operators" "SECTexpop"
9811 .cindex "expansion" "operators"
9812 For expansion items that perform transformations on a single argument string,
9813 the &"operator"& notation is used because it is simpler and uses fewer braces.
9814 The substring is first expanded before the operation is applied to it. The
9815 following operations can be performed:
9816
9817 .vlist
9818 .vitem &*${address:*&<&'string'&>&*}*&
9819 .cindex "expansion" "RFC 2822 address handling"
9820 .cindex "&%address%& expansion item"
9821 The string is interpreted as an RFC 2822 address, as it might appear in a
9822 header line, and the effective address is extracted from it. If the string does
9823 not parse successfully, the result is empty.
9824
9825
9826 .vitem &*${addresses:*&<&'string'&>&*}*&
9827 .cindex "expansion" "RFC 2822 address handling"
9828 .cindex "&%addresses%& expansion item"
9829 The string (after expansion) is interpreted as a list of addresses in RFC
9830 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9831 operative address (&'local-part@domain'&) is extracted from each item, and the
9832 result of the expansion is a colon-separated list, with appropriate
9833 doubling of colons should any happen to be present in the email addresses.
9834 Syntactically invalid RFC2822 address items are omitted from the output.
9835
9836 It is possible to specify a character other than colon for the output
9837 separator by starting the string with > followed by the new separator
9838 character. For example:
9839 .code
9840 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9841 .endd
9842 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9843 expansion item, which extracts the working address from a single RFC2822
9844 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9845 processing lists.
9846
9847 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9848 a strict interpretation of header line formatting.  Exim parses the bare,
9849 unquoted portion of an email address and if it finds a comma, treats it as an
9850 email address seperator. For the example header line:
9851 .code
9852 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9853 .endd
9854 The first example below demonstrates that Q-encoded email addresses are parsed
9855 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9856 It does not see the comma because it's still encoded as "=2C".  The second
9857 example below is passed the contents of &`$header_from:`&, meaning it gets
9858 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9859 The third example shows that the presence of a comma is skipped when it is
9860 quoted.
9861 .code
9862 # exim -be '${addresses:From: \
9863 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9864 user@example.com
9865 # exim -be '${addresses:From: Last, First <user@example.com>}'
9866 Last:user@example.com
9867 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9868 user@example.com
9869 .endd
9870
9871 .vitem &*${base62:*&<&'digits'&>&*}*&
9872 .cindex "&%base62%& expansion item"
9873 .cindex "expansion" "conversion to base 62"
9874 The string must consist entirely of decimal digits. The number is converted to
9875 base 62 and output as a string of six characters, including leading zeros. In
9876 the few operating environments where Exim uses base 36 instead of base 62 for
9877 its message identifiers (because those systems do not have case-sensitive file
9878 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9879 be absolutely clear: this is &'not'& base64 encoding.
9880
9881 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9882 .cindex "&%base62d%& expansion item"
9883 .cindex "expansion" "conversion to base 62"
9884 The string must consist entirely of base-62 digits, or, in operating
9885 environments where Exim uses base 36 instead of base 62 for its message
9886 identifiers, base-36 digits. The number is converted to decimal and output as a
9887 string.
9888
9889
9890 .vitem &*${domain:*&<&'string'&>&*}*&
9891 .cindex "domain" "extraction"
9892 .cindex "expansion" "domain extraction"
9893 The string is interpreted as an RFC 2822 address and the domain is extracted
9894 from it. If the string does not parse successfully, the result is empty.
9895
9896
9897 .vitem &*${escape:*&<&'string'&>&*}*&
9898 .cindex "expansion" "escaping non-printing characters"
9899 .cindex "&%escape%& expansion item"
9900 If the string contains any non-printing characters, they are converted to
9901 escape sequences starting with a backslash. Whether characters with the most
9902 significant bit set (so-called &"8-bit characters"&) count as printing or not
9903 is controlled by the &%print_topbitchars%& option.
9904
9905
9906 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9907 .cindex "expansion" "expression evaluation"
9908 .cindex "expansion" "arithmetic expression"
9909 .cindex "&%eval%& expansion item"
9910 These items supports simple arithmetic and bitwise logical operations in
9911 expansion strings. The string (after expansion) must be a conventional
9912 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9913 logical operators, and parentheses. All operations are carried out using
9914 integer arithmetic. The operator priorities are as follows (the same as in the
9915 C programming language):
9916 .table2 70pt 300pt
9917 .irow &'highest:'& "not (~), negate (-)"
9918 .irow ""   "multiply (*), divide (/), remainder (%)"
9919 .irow ""   "plus (+), minus (-)"
9920 .irow ""   "shift-left (<<), shift-right (>>)"
9921 .irow ""   "and (&&)"
9922 .irow ""   "xor (^)"
9923 .irow &'lowest:'&  "or (|)"
9924 .endtable
9925 Binary operators with the same priority are evaluated from left to right. White
9926 space is permitted before or after operators.
9927
9928 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9929 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9930 decimal, even if they start with a leading zero; hexadecimal numbers are not
9931 permitted. This can be useful when processing numbers extracted from dates or
9932 times, which often do have leading zeros.
9933
9934 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9935 or 1024*1024*1024,
9936 respectively. Negative numbers are supported. The result of the computation is
9937 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9938
9939 .display
9940 &`${eval:1+1}            `&  yields 2
9941 &`${eval:1+2*3}          `&  yields 7
9942 &`${eval:(1+2)*3}        `&  yields 9
9943 &`${eval:2+42%5}         `&  yields 4
9944 &`${eval:0xc&amp;5}          `&  yields 4
9945 &`${eval:0xc|5}          `&  yields 13
9946 &`${eval:0xc^5}          `&  yields 9
9947 &`${eval:0xc>>1}         `&  yields 6
9948 &`${eval:0xc<<1}         `&  yields 24
9949 &`${eval:~255&amp;0x1234}    `&  yields 4608
9950 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9951 .endd
9952
9953 As a more realistic example, in an ACL you might have
9954 .code
9955 deny   message = Too many bad recipients
9956        condition =                    \
9957          ${if and {                   \
9958            {>{$rcpt_count}{10}}       \
9959            {                          \
9960            <                          \
9961              {$recipients_count}      \
9962              {${eval:$rcpt_count/2}}  \
9963            }                          \
9964          }{yes}{no}}
9965 .endd
9966 The condition is true if there have been more than 10 RCPT commands and
9967 fewer than half of them have resulted in a valid recipient.
9968
9969
9970 .vitem &*${expand:*&<&'string'&>&*}*&
9971 .cindex "expansion" "re-expansion of substring"
9972 The &%expand%& operator causes a string to be expanded for a second time. For
9973 example,
9974 .code
9975 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9976 .endd
9977 first looks up a string in a file while expanding the operand for &%expand%&,
9978 and then re-expands what it has found.
9979
9980
9981 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9982 .cindex "Unicode"
9983 .cindex "UTF-8" "conversion from"
9984 .cindex "expansion" "UTF-8 conversion"
9985 .cindex "&%from_utf8%& expansion item"
9986 The world is slowly moving towards Unicode, although there are no standards for
9987 email yet. However, other applications (including some databases) are starting
9988 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9989 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9990 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9991 the result is an undefined sequence of bytes.
9992
9993 Unicode code points with values less than 256 are compatible with ASCII and
9994 ISO-8859-1 (also known as Latin-1).
9995 For example, character 169 is the copyright symbol in both cases, though the
9996 way it is encoded is different. In UTF-8, more than one byte is needed for
9997 characters with code values greater than 127, whereas ISO-8859-1 is a
9998 single-byte encoding (but thereby limited to 256 characters). This makes
9999 translation from UTF-8 to ISO-8859-1 straightforward.
10000
10001
10002 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10003 .cindex "hash function" "textual"
10004 .cindex "expansion" "textual hash"
10005 The &%hash%& operator is a simpler interface to the hashing function that can
10006 be used when the two parameters are fixed numbers (as opposed to strings that
10007 change when expanded). The effect is the same as
10008 .code
10009 ${hash{<n>}{<m>}{<string>}}
10010 .endd
10011 See the description of the general &%hash%& item above for details. The
10012 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10013
10014
10015
10016 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10017 .cindex "base64 encoding" "conversion from hex"
10018 .cindex "expansion" "hex to base64"
10019 .cindex "&%hex2b64%& expansion item"
10020 This operator converts a hex string into one that is base64 encoded. This can
10021 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10022
10023
10024
10025 .vitem &*${hexquote:*&<&'string'&>&*}*&
10026 .cindex "quoting" "hex-encoded unprintable characters"
10027 .cindex "&%hexquote%& expansion item"
10028 This operator converts non-printable characters in a string into a hex
10029 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10030 as is, and other byte values are converted to &`\xNN`&, for example a
10031 byte value 127 is converted to &`\x7f`&.
10032
10033
10034 .vitem &*${lc:*&<&'string'&>&*}*&
10035 .cindex "case forcing in strings"
10036 .cindex "string" "case forcing"
10037 .cindex "lower casing"
10038 .cindex "expansion" "case forcing"
10039 .cindex "&%lc%& expansion item"
10040 This forces the letters in the string into lower-case, for example:
10041 .code
10042 ${lc:$local_part}
10043 .endd
10044
10045 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10046 .cindex "expansion" "string truncation"
10047 .cindex "&%length%& expansion item"
10048 The &%length%& operator is a simpler interface to the &%length%& function that
10049 can be used when the parameter is a fixed number (as opposed to a string that
10050 changes when expanded). The effect is the same as
10051 .code
10052 ${length{<number>}{<string>}}
10053 .endd
10054 See the description of the general &%length%& item above for details. Note that
10055 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10056 when &%length%& is used as an operator.
10057
10058
10059 .vitem &*${listcount:*&<&'string'&>&*}*&
10060 .cindex "expansion" "list item count"
10061 .cindex "list" "item count"
10062 .cindex "list" "count of items"
10063 .cindex "&%listcount%& expansion item"
10064 The string is interpreted as a list and the number of items is returned.
10065
10066
10067 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10068 .cindex "expansion" "named list"
10069 .cindex "&%listnamed%& expansion item"
10070 The name is interpreted as a named list and the content of the list is returned,
10071 expanding any referenced lists, re-quoting as needed for colon-separation.
10072 If the optional type is given it must be one of "a", "d", "h" or "l"
10073 and selects address-, domain-, host- or localpart- lists to search among respectively.
10074 Otherwise all types are searched in an undefined order and the first
10075 matching list is returned.
10076
10077
10078 .vitem &*${local_part:*&<&'string'&>&*}*&
10079 .cindex "expansion" "local part extraction"
10080 .cindex "&%local_part%& expansion item"
10081 The string is interpreted as an RFC 2822 address and the local part is
10082 extracted from it. If the string does not parse successfully, the result is
10083 empty.
10084
10085
10086 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10087 .cindex "masked IP address"
10088 .cindex "IP address" "masking"
10089 .cindex "CIDR notation"
10090 .cindex "expansion" "IP address masking"
10091 .cindex "&%mask%& expansion item"
10092 If the form of the string to be operated on is not an IP address followed by a
10093 slash and an integer (that is, a network address in CIDR notation), the
10094 expansion fails. Otherwise, this operator converts the IP address to binary,
10095 masks off the least significant bits according to the bit count, and converts
10096 the result back to text, with mask appended. For example,
10097 .code
10098 ${mask:10.111.131.206/28}
10099 .endd
10100 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10101 be mostly used for looking up masked addresses in files, the result for an IPv6
10102 address uses dots to separate components instead of colons, because colon
10103 terminates a key string in lsearch files. So, for example,
10104 .code
10105 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10106 .endd
10107 returns the string
10108 .code
10109 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10110 .endd
10111 Letters in IPv6 addresses are always output in lower case.
10112
10113
10114 .vitem &*${md5:*&<&'string'&>&*}*&
10115 .cindex "MD5 hash"
10116 .cindex "expansion" "MD5 hash"
10117 .cindex "certificate fingerprint"
10118 .cindex "&%md5%& expansion item"
10119 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10120 as a 32-digit hexadecimal number, in which any letters are in lower case.
10121
10122
10123 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10124 .cindex "expansion" "numeric hash"
10125 .cindex "hash function" "numeric"
10126 The &%nhash%& operator is a simpler interface to the numeric hashing function
10127 that can be used when the two parameters are fixed numbers (as opposed to
10128 strings that change when expanded). The effect is the same as
10129 .code
10130 ${nhash{<n>}{<m>}{<string>}}
10131 .endd
10132 See the description of the general &%nhash%& item above for details.
10133
10134
10135 .vitem &*${quote:*&<&'string'&>&*}*&
10136 .cindex "quoting" "in string expansions"
10137 .cindex "expansion" "quoting"
10138 .cindex "&%quote%& expansion item"
10139 The &%quote%& operator puts its argument into double quotes if it
10140 is an empty string or
10141 contains anything other than letters, digits, underscores, dots, and hyphens.
10142 Any occurrences of double quotes and backslashes are escaped with a backslash.
10143 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10144 respectively For example,
10145 .code
10146 ${quote:ab"*"cd}
10147 .endd
10148 becomes
10149 .code
10150 "ab\"*\"cd"
10151 .endd
10152 The place where this is useful is when the argument is a substitution from a
10153 variable or a message header.
10154
10155 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10156 .cindex "&%quote_local_part%& expansion item"
10157 This operator is like &%quote%&, except that it quotes the string only if
10158 required to do so by the rules of RFC 2822 for quoting local parts. For
10159 example, a plus sign would not cause quoting (but it would for &%quote%&).
10160 If you are creating a new email address from the contents of &$local_part$&
10161 (or any other unknown data), you should always use this operator.
10162
10163
10164 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10165 .cindex "quoting" "lookup-specific"
10166 This operator applies lookup-specific quoting rules to the string. Each
10167 query-style lookup type has its own quoting rules which are described with
10168 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10169 .code
10170 ${quote_ldap:two * two}
10171 .endd
10172 returns
10173 .code
10174 two%20%5C2A%20two
10175 .endd
10176 For single-key lookup types, no quoting is ever necessary and this operator
10177 yields an unchanged string.
10178
10179
10180 .vitem &*${randint:*&<&'n'&>&*}*&
10181 .cindex "random number"
10182 This operator returns a somewhat random number which is less than the
10183 supplied number and is at least 0.  The quality of this randomness depends
10184 on how Exim was built; the values are not suitable for keying material.
10185 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10186 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10187 for versions of GnuTLS with that function.
10188 Otherwise, the implementation may be arc4random(), random() seeded by
10189 srandomdev() or srandom(), or a custom implementation even weaker than
10190 random().
10191
10192
10193 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10194 .cindex "expansion" "IP address"
10195 This operator reverses an IP address; for IPv4 addresses, the result is in
10196 dotted-quad decimal form, while for IPv6 addreses the result is in
10197 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10198 for DNS.  For example,
10199 .code
10200 ${reverse_ip:192.0.2.4}
10201 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10202 .endd
10203 returns
10204 .code
10205 4.2.0.192
10206 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
10207 .endd
10208
10209
10210 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10211 .cindex "expansion" "RFC 2047"
10212 .cindex "RFC 2047" "expansion operator"
10213 .cindex "&%rfc2047%& expansion item"
10214 This operator encodes text according to the rules of RFC 2047. This is an
10215 encoding that is used in header lines to encode non-ASCII characters. It is
10216 assumed that the input string is in the encoding specified by the
10217 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10218 contains only characters in the range 33&--126, and no instances of the
10219 characters
10220 .code
10221 ? = ( ) < > @ , ; : \ " . [ ] _
10222 .endd
10223 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10224 string, using as many &"encoded words"& as necessary to encode all the
10225 characters.
10226
10227
10228 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10229 .cindex "expansion" "RFC 2047"
10230 .cindex "RFC 2047" "decoding"
10231 .cindex "&%rfc2047d%& expansion item"
10232 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10233 bytes are replaced by question marks. Characters are converted into the
10234 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10235 not recognized unless &%check_rfc2047_length%& is set false.
10236
10237 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10238 access a header line, RFC 2047 decoding is done automatically. You do not need
10239 to use this operator as well.
10240
10241
10242
10243 .vitem &*${rxquote:*&<&'string'&>&*}*&
10244 .cindex "quoting" "in regular expressions"
10245 .cindex "regular expressions" "quoting"
10246 .cindex "&%rxquote%& expansion item"
10247 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10248 characters in its argument. This is useful when substituting the values of
10249 variables or headers inside regular expressions.
10250
10251
10252 .vitem &*${sha1:*&<&'string'&>&*}*&
10253 .cindex "SHA-1 hash"
10254 .cindex "expansion" "SHA-1 hashing"
10255 .cindex "certificate fingerprint"
10256 .cindex "&%sha2%& expansion item"
10257 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10258 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10259
10260
10261 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10262 .cindex "SHA-256 hash"
10263 .cindex "certificate fingerprint"
10264 .cindex "expansion" "SHA-256 hashing"
10265 .cindex "&%sha256%& expansion item"
10266 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10267 certificate,
10268 and returns
10269 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10270 Only arguments which are a single variable of certificate type are supported.
10271
10272
10273 .vitem &*${stat:*&<&'string'&>&*}*&
10274 .cindex "expansion" "statting a file"
10275 .cindex "file" "extracting characteristics"
10276 .cindex "&%stat%& expansion item"
10277 The string, after expansion, must be a file path. A call to the &[stat()]&
10278 function is made for this path. If &[stat()]& fails, an error occurs and the
10279 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10280 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10281 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10282 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10283 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10284 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10285 can extract individual fields using the &%extract%& expansion item.
10286
10287 The use of the &%stat%& expansion in users' filter files can be locked out by
10288 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10289 systems for files larger than 2GB.
10290
10291 .vitem &*${str2b64:*&<&'string'&>&*}*&
10292 .cindex "expansion" "base64 encoding"
10293 .cindex "base64 encoding" "in string expansion"
10294 .cindex "&%str2b64%& expansion item"
10295 This operator converts a string into one that is base64 encoded.
10296
10297
10298
10299 .vitem &*${strlen:*&<&'string'&>&*}*&
10300 .cindex "expansion" "string length"
10301 .cindex "string" "length in expansion"
10302 .cindex "&%strlen%& expansion item"
10303 The item is replace by the length of the expanded string, expressed as a
10304 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10305
10306
10307 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10308 .cindex "&%substr%& expansion item"
10309 .cindex "substring extraction"
10310 .cindex "expansion" "substring expansion"
10311 The &%substr%& operator is a simpler interface to the &%substr%& function that
10312 can be used when the two parameters are fixed numbers (as opposed to strings
10313 that change when expanded). The effect is the same as
10314 .code
10315 ${substr{<start>}{<length>}{<string>}}
10316 .endd
10317 See the description of the general &%substr%& item above for details. The
10318 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10319
10320 .vitem &*${time_eval:*&<&'string'&>&*}*&
10321 .cindex "&%time_eval%& expansion item"
10322 .cindex "time interval" "decoding"
10323 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10324 seconds.
10325
10326 .vitem &*${time_interval:*&<&'string'&>&*}*&
10327 .cindex "&%time_interval%& expansion item"
10328 .cindex "time interval" "formatting"
10329 The argument (after sub-expansion) must be a sequence of decimal digits that
10330 represents an interval of time as a number of seconds. It is converted into a
10331 number of larger units and output in Exim's normal time format, for example,
10332 &`1w3d4h2m6s`&.
10333
10334 .vitem &*${uc:*&<&'string'&>&*}*&
10335 .cindex "case forcing in strings"
10336 .cindex "string" "case forcing"
10337 .cindex "upper casing"
10338 .cindex "expansion" "case forcing"
10339 .cindex "&%uc%& expansion item"
10340 This forces the letters in the string into upper-case.
10341
10342 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10343 .cindex "correction of invalid utf-8 sequences in strings"
10344 .cindex "utf-8" "utf-8 sequences"
10345 .cindex "incorrect utf-8"
10346 .cindex "expansion" "utf-8 forcing"
10347 .cindex "&%utf8clean%& expansion item"
10348 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10349 .endlist
10350
10351
10352
10353
10354
10355
10356 .section "Expansion conditions" "SECTexpcond"
10357 .scindex IIDexpcond "expansion" "conditions"
10358 The following conditions are available for testing by the &%${if%& construct
10359 while expanding strings:
10360
10361 .vlist
10362 .vitem &*!*&<&'condition'&>
10363 .cindex "expansion" "negating a condition"
10364 .cindex "negation" "in expansion condition"
10365 Preceding any condition with an exclamation mark negates the result of the
10366 condition.
10367
10368 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10369 .cindex "numeric comparison"
10370 .cindex "expansion" "numeric comparison"
10371 There are a number of symbolic operators for doing numeric comparisons. They
10372 are:
10373 .display
10374 &`=   `&   equal
10375 &`==  `&   equal
10376 &`>   `&   greater
10377 &`>=  `&   greater or equal
10378 &`<   `&   less
10379 &`<=  `&   less or equal
10380 .endd
10381 For example:
10382 .code
10383 ${if >{$message_size}{10M} ...
10384 .endd
10385 Note that the general negation operator provides for inequality testing. The
10386 two strings must take the form of optionally signed decimal integers,
10387 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10388 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10389 As a special case, the numerical value of an empty string is taken as
10390 zero.
10391
10392 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10393 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10394 10M, not if 10M is larger than &$message_size$&.
10395
10396
10397 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10398         {*&<&'arg2'&>&*}...}*&
10399 .cindex "expansion" "calling an acl"
10400 .cindex "&%acl%&" "expansion condition"
10401 The name and zero to nine argument strings are first expanded separately.  The expanded
10402 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10403 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10404 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10405 and may use the variables; if another acl expansion is used the values
10406 are restored after it returns.  If the ACL sets
10407 a value using a "message =" modifier the variable $value becomes
10408 the result of the expansion, otherwise it is empty.
10409 If the ACL returns accept the condition is true; if deny, false.
10410 If the ACL returns defer the result is a forced-fail.
10411
10412 .vitem &*bool&~{*&<&'string'&>&*}*&
10413 .cindex "expansion" "boolean parsing"
10414 .cindex "&%bool%& expansion condition"
10415 This condition turns a string holding a true or false representation into
10416 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10417 (case-insensitively); also integer numbers map to true if non-zero,
10418 false if zero.
10419 An empty string is treated as false.
10420 Leading and trailing whitespace is ignored;
10421 thus a string consisting only of whitespace is false.
10422 All other string values will result in expansion failure.
10423
10424 When combined with ACL variables, this expansion condition will let you
10425 make decisions in one place and act on those decisions in another place.
10426 For example:
10427 .code
10428 ${if bool{$acl_m_privileged_sender} ...
10429 .endd
10430
10431
10432 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10433 .cindex "expansion" "boolean parsing"
10434 .cindex "&%bool_lax%& expansion condition"
10435 Like &%bool%&, this condition turns a string into a boolean state.  But
10436 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10437 loose definition that the Router &%condition%& option uses.  The empty string
10438 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10439 true.  Leading and trailing whitespace is ignored.
10440
10441 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10442
10443 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10444 .cindex "expansion" "encrypted comparison"
10445 .cindex "encrypted strings, comparing"
10446 .cindex "&%crypteq%& expansion condition"
10447 This condition is included in the Exim binary if it is built to support any
10448 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10449 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10450 included in the binary.
10451
10452 The &%crypteq%& condition has two arguments. The first is encrypted and
10453 compared against the second, which is already encrypted. The second string may
10454 be in the LDAP form for storing encrypted strings, which starts with the
10455 encryption type in curly brackets, followed by the data. If the second string
10456 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10457 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10458 Typically this will be a field from a password file. An example of an encrypted
10459 string in LDAP form is:
10460 .code
10461 {md5}CY9rzUYh03PK3k6DJie09g==
10462 .endd
10463 If such a string appears directly in an expansion, the curly brackets have to
10464 be quoted, because they are part of the expansion syntax. For example:
10465 .code
10466 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10467 .endd
10468 The following encryption types (whose names are matched case-independently) are
10469 supported:
10470
10471 .ilist
10472 .cindex "MD5 hash"
10473 .cindex "base64 encoding" "in encrypted password"
10474 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10475 printable characters to compare with the remainder of the second string. If the
10476 length of the comparison string is 24, Exim assumes that it is base64 encoded
10477 (as in the above example). If the length is 32, Exim assumes that it is a
10478 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10479 comparison fails.
10480
10481 .next
10482 .cindex "SHA-1 hash"
10483 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10484 printable characters to compare with the remainder of the second string. If the
10485 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10486 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10487 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10488
10489 .next
10490 .cindex "&[crypt()]&"
10491 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10492 only the first eight characters of the password. However, in modern operating
10493 systems this is no longer true, and in many cases the entire password is used,
10494 whatever its length.
10495
10496 .next
10497 .cindex "&[crypt16()]&"
10498 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10499 use up to 16 characters of the password in some operating systems. Again, in
10500 modern operating systems, more characters may be used.
10501 .endlist
10502 Exim has its own version of &[crypt16()]&, which is just a double call to
10503 &[crypt()]&. For operating systems that have their own version, setting
10504 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10505 operating system version instead of its own. This option is set by default in
10506 the OS-dependent &_Makefile_& for those operating systems that are known to
10507 support &[crypt16()]&.
10508
10509 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10510 it was not using the same algorithm as some operating systems' versions. It
10511 turns out that as well as &[crypt16()]& there is a function called
10512 &[bigcrypt()]& in some operating systems. This may or may not use the same
10513 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10514
10515 However, since there is now a move away from the traditional &[crypt()]&
10516 functions towards using SHA1 and other algorithms, tidying up this area of
10517 Exim is seen as very low priority.
10518
10519 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10520 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10521 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10522 default is &`{crypt}`&. Whatever the default, you can always use either
10523 function by specifying it explicitly in curly brackets.
10524
10525 .vitem &*def:*&<&'variable&~name'&>
10526 .cindex "expansion" "checking for empty variable"
10527 .cindex "&%def%& expansion condition"
10528 The &%def%& condition must be followed by the name of one of the expansion
10529 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10530 variable does not contain the empty string. For example:
10531 .code
10532 ${if def:sender_ident {from $sender_ident}}
10533 .endd
10534 Note that the variable name is given without a leading &%$%& character. If the
10535 variable does not exist, the expansion fails.
10536
10537 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10538         &~&*def:h_*&<&'header&~name'&>&*:*&"
10539 .cindex "expansion" "checking header line existence"
10540 This condition is true if a message is being processed and the named header
10541 exists in the message. For example,
10542 .code
10543 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10544 .endd
10545 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10546 the header name must be terminated by a colon if white space does not follow.
10547
10548 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10549        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10550 .cindex "string" "comparison"
10551 .cindex "expansion" "string comparison"
10552 .cindex "&%eq%& expansion condition"
10553 .cindex "&%eqi%& expansion condition"
10554 The two substrings are first expanded. The condition is true if the two
10555 resulting strings are identical. For &%eq%& the comparison includes the case of
10556 letters, whereas for &%eqi%& the comparison is case-independent.
10557
10558 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10559 .cindex "expansion" "file existence test"
10560 .cindex "file" "existence test"
10561 .cindex "&%exists%&, expansion condition"
10562 The substring is first expanded and then interpreted as an absolute path. The
10563 condition is true if the named file (or directory) exists. The existence test
10564 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10565 users' filter files may be locked out by the system administrator.
10566
10567 .vitem &*first_delivery*&
10568 .cindex "delivery" "first"
10569 .cindex "first delivery"
10570 .cindex "expansion" "first delivery test"
10571 .cindex "&%first_delivery%& expansion condition"
10572 This condition, which has no data, is true during a message's first delivery
10573 attempt. It is false during any subsequent delivery attempts.
10574
10575
10576 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10577        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10578 .cindex "list" "iterative conditions"
10579 .cindex "expansion" "&*forall*& condition"
10580 .cindex "expansion" "&*forany*& condition"
10581 .vindex "&$item$&"
10582 These conditions iterate over a list. The first argument is expanded to form
10583 the list. By default, the list separator is a colon, but it can be changed by
10584 the normal method. The second argument is interpreted as a condition that is to
10585 be applied to each item in the list in turn. During the interpretation of the
10586 condition, the current list item is placed in a variable called &$item$&.
10587 .ilist
10588 For &*forany*&, interpretation stops if the condition is true for any item, and
10589 the result of the whole condition is true. If the condition is false for all
10590 items in the list, the overall condition is false.
10591 .next
10592 For &*forall*&, interpretation stops if the condition is false for any item,
10593 and the result of the whole condition is false. If the condition is true for
10594 all items in the list, the overall condition is true.
10595 .endlist
10596 Note that negation of &*forany*& means that the condition must be false for all
10597 items for the overall condition to succeed, and negation of &*forall*& means
10598 that the condition must be false for at least one item. In this example, the
10599 list separator is changed to a comma:
10600 .code
10601 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10602 .endd
10603 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10604 being processed, to enable these expansion items to be nested.
10605
10606 To scan a named list, expand it with the &*listnamed*& operator.
10607
10608
10609 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10610        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10611 .cindex "string" "comparison"
10612 .cindex "expansion" "string comparison"
10613 .cindex "&%ge%& expansion condition"
10614 .cindex "&%gei%& expansion condition"
10615 The two substrings are first expanded. The condition is true if the first
10616 string is lexically greater than or equal to the second string. For &%ge%& the
10617 comparison includes the case of letters, whereas for &%gei%& the comparison is
10618 case-independent.
10619
10620 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10621        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10622 .cindex "string" "comparison"
10623 .cindex "expansion" "string comparison"
10624 .cindex "&%gt%& expansion condition"
10625 .cindex "&%gti%& expansion condition"
10626 The two substrings are first expanded. The condition is true if the first
10627 string is lexically greater than the second string. For &%gt%& the comparison
10628 includes the case of letters, whereas for &%gti%& the comparison is
10629 case-independent.
10630
10631 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10632        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10633 .cindex "string" "comparison"
10634 .cindex "list" "iterative conditions"
10635 Both strings are expanded; the second string is treated as a list of simple
10636 strings; if the first string is a member of the second, then the condition
10637 is true.
10638
10639 These are simpler to use versions of the more powerful &*forany*& condition.
10640 Examples, and the &*forany*& equivalents:
10641 .code
10642 ${if inlist{needle}{foo:needle:bar}}
10643   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10644 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10645   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10646 .endd
10647
10648 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10649        &*isip4&~{*&<&'string'&>&*}*& &&&
10650        &*isip6&~{*&<&'string'&>&*}*&
10651 .cindex "IP address" "testing string format"
10652 .cindex "string" "testing for IP address"
10653 .cindex "&%isip%& expansion condition"
10654 .cindex "&%isip4%& expansion condition"
10655 .cindex "&%isip6%& expansion condition"
10656 The substring is first expanded, and then tested to see if it has the form of
10657 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10658 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10659
10660 For an IPv4 address, the test is for four dot-separated components, each of
10661 which consists of from one to three digits. For an IPv6 address, up to eight
10662 colon-separated components are permitted, each containing from one to four
10663 hexadecimal digits. There may be fewer than eight components if an empty
10664 component (adjacent colons) is present. Only one empty component is permitted.
10665
10666 &*Note*&: The checks are just on the form of the address; actual numerical
10667 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10668 check. The main use of these tests is to distinguish between IP addresses and
10669 host names, or between IPv4 and IPv6 addresses. For example, you could use
10670 .code
10671 ${if isip4{$sender_host_address}...
10672 .endd
10673 to test which IP version an incoming SMTP connection is using.
10674
10675 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10676 .cindex "LDAP" "use for authentication"
10677 .cindex "expansion" "LDAP authentication test"
10678 .cindex "&%ldapauth%& expansion condition"
10679 This condition supports user authentication using LDAP. See section
10680 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10681 queries. For this use, the query must contain a user name and password. The
10682 query itself is not used, and can be empty. The condition is true if the
10683 password is not empty, and the user name and password are accepted by the LDAP
10684 server. An empty password is rejected without calling LDAP because LDAP binds
10685 with an empty password are considered anonymous regardless of the username, and
10686 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10687 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10688 this can be used.
10689
10690
10691 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10692        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10693 .cindex "string" "comparison"
10694 .cindex "expansion" "string comparison"
10695 .cindex "&%le%& expansion condition"
10696 .cindex "&%lei%& expansion condition"
10697 The two substrings are first expanded. The condition is true if the first
10698 string is lexically less than or equal to the second string. For &%le%& the
10699 comparison includes the case of letters, whereas for &%lei%& the comparison is
10700 case-independent.
10701
10702 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10703        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10704 .cindex "string" "comparison"
10705 .cindex "expansion" "string comparison"
10706 .cindex "&%lt%& expansion condition"
10707 .cindex "&%lti%& expansion condition"
10708 The two substrings are first expanded. The condition is true if the first
10709 string is lexically less than the second string. For &%lt%& the comparison
10710 includes the case of letters, whereas for &%lti%& the comparison is
10711 case-independent.
10712
10713
10714 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10715 .cindex "expansion" "regular expression comparison"
10716 .cindex "regular expressions" "match in expanded string"
10717 .cindex "&%match%& expansion condition"
10718 The two substrings are first expanded. The second is then treated as a regular
10719 expression and applied to the first. Because of the pre-expansion, if the
10720 regular expression contains dollar, or backslash characters, they must be
10721 escaped. Care must also be taken if the regular expression contains braces
10722 (curly brackets). A closing brace must be escaped so that it is not taken as a
10723 premature termination of <&'string2'&>. The easiest approach is to use the
10724 &`\N`& feature to disable expansion of the regular expression.
10725 For example,
10726 .code
10727 ${if match {$local_part}{\N^\d{3}\N} ...
10728 .endd
10729 If the whole expansion string is in double quotes, further escaping of
10730 backslashes is also required.
10731
10732 The condition is true if the regular expression match succeeds.
10733 The regular expression is not required to begin with a circumflex
10734 metacharacter, but if there is no circumflex, the expression is not anchored,
10735 and it may match anywhere in the subject, not just at the start. If you want
10736 the pattern to match at the end of the subject, you must include the &`$`&
10737 metacharacter at an appropriate point.
10738
10739 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10740 At the start of an &%if%& expansion the values of the numeric variable
10741 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10742 succeeds causes them to be reset to the substrings of that condition and they
10743 will have these values during the expansion of the success string. At the end
10744 of the &%if%& expansion, the previous values are restored. After testing a
10745 combination of conditions using &%or%&, the subsequent values of the numeric
10746 variables are those of the condition that succeeded.
10747
10748 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10749 .cindex "&%match_address%& expansion condition"
10750 See &*match_local_part*&.
10751
10752 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10753 .cindex "&%match_domain%& expansion condition"
10754 See &*match_local_part*&.
10755
10756 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10757 .cindex "&%match_ip%& expansion condition"
10758 This condition matches an IP address to a list of IP address patterns. It must
10759 be followed by two argument strings. The first (after expansion) must be an IP
10760 address or an empty string. The second (not expanded) is a restricted host
10761 list that can match only an IP address, not a host name. For example:
10762 .code
10763 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10764 .endd
10765 The specific types of host list item that are permitted in the list are:
10766
10767 .ilist
10768 An IP address, optionally with a CIDR mask.
10769 .next
10770 A single asterisk, which matches any IP address.
10771 .next
10772 An empty item, which matches only if the IP address is empty. This could be
10773 useful for testing for a locally submitted message or one from specific hosts
10774 in a single test such as
10775 . ==== As this is a nested list, any displays it contains must be indented
10776 . ==== as otherwise they are too far to the left. This comment applies to
10777 . ==== the use of xmlto plus fop. There's no problem when formatting with
10778 . ==== sdop, with or without the extra indent.
10779 .code
10780   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10781 .endd
10782 where the first item in the list is the empty string.
10783 .next
10784 The item @[] matches any of the local host's interface addresses.
10785 .next
10786 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10787 even if &`net-`& is not specified. There is never any attempt to turn the IP
10788 address into a host name. The most common type of linear search for
10789 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10790 masks. For example:
10791 .code
10792   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10793 .endd
10794 It is of course possible to use other kinds of lookup, and in such a case, you
10795 do need to specify the &`net-`& prefix if you want to specify a specific
10796 address mask, for example:
10797 .code
10798   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10799 .endd
10800 However, unless you are combining a &%match_ip%& condition with others, it is
10801 just as easy to use the fact that a lookup is itself a condition, and write:
10802 .code
10803   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10804 .endd
10805 .endlist ilist
10806
10807 Note that <&'string2'&> is not itself subject to string expansion, unless
10808 Exim was built with the EXPAND_LISTMATCH_RHS option.
10809
10810 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10811
10812 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10813 .cindex "domain list" "in expansion condition"
10814 .cindex "address list" "in expansion condition"
10815 .cindex "local part" "list, in expansion condition"
10816 .cindex "&%match_local_part%& expansion condition"
10817 This condition, together with &%match_address%& and &%match_domain%&, make it
10818 possible to test domain, address, and local part lists within expansions. Each
10819 condition requires two arguments: an item and a list to match. A trivial
10820 example is:
10821 .code
10822 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10823 .endd
10824 In each case, the second argument may contain any of the allowable items for a
10825 list of the appropriate type. Also, because the second argument (after
10826 expansion) is a standard form of list, it is possible to refer to a named list.
10827 Thus, you can use conditions like this:
10828 .code
10829 ${if match_domain{$domain}{+local_domains}{...
10830 .endd
10831 .cindex "&`+caseful`&"
10832 For address lists, the matching starts off caselessly, but the &`+caseful`&
10833 item can be used, as in all address lists, to cause subsequent items to
10834 have their local parts matched casefully. Domains are always matched
10835 caselessly.
10836
10837 Note that <&'string2'&> is not itself subject to string expansion, unless
10838 Exim was built with the EXPAND_LISTMATCH_RHS option.
10839
10840 &*Note*&: Host lists are &'not'& supported in this way. This is because
10841 hosts have two identities: a name and an IP address, and it is not clear
10842 how to specify cleanly how such a test would work. However, IP addresses can be
10843 matched using &%match_ip%&.
10844
10845 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10846 .cindex "PAM authentication"
10847 .cindex "AUTH" "with PAM"
10848 .cindex "Solaris" "PAM support"
10849 .cindex "expansion" "PAM authentication test"
10850 .cindex "&%pam%& expansion condition"
10851 &'Pluggable Authentication Modules'&
10852 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10853 available in the latest releases of Solaris and in some GNU/Linux
10854 distributions. The Exim support, which is intended for use in conjunction with
10855 the SMTP AUTH command, is available only if Exim is compiled with
10856 .code
10857 SUPPORT_PAM=yes
10858 .endd
10859 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10860 in some releases of GNU/Linux &%-ldl%& is also needed.
10861
10862 The argument string is first expanded, and the result must be a
10863 colon-separated list of strings. Leading and trailing white space is ignored.
10864 The PAM module is initialized with the service name &"exim"& and the user name
10865 taken from the first item in the colon-separated data string (<&'string1'&>).
10866 The remaining items in the data string are passed over in response to requests
10867 from the authentication function. In the simple case there will only be one
10868 request, for a password, so the data consists of just two strings.
10869
10870 There can be problems if any of the strings are permitted to contain colon
10871 characters. In the usual way, these have to be doubled to avoid being taken as
10872 separators. If the data is being inserted from a variable, the &%sg%& expansion
10873 item can be used to double any existing colons. For example, the configuration
10874 of a LOGIN authenticator might contain this setting:
10875 .code
10876 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10877 .endd
10878 For a PLAIN authenticator you could use:
10879 .code
10880 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10881 .endd
10882 In some operating systems, PAM authentication can be done only from a process
10883 running as root. Since Exim is running as the Exim user when receiving
10884 messages, this means that PAM cannot be used directly in those systems.
10885 A patched version of the &'pam_unix'& module that comes with the
10886 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10887 The patched module allows one special uid/gid combination, in addition to root,
10888 to authenticate. If you build the patched module to allow the Exim user and
10889 group, PAM can then be used from an Exim authenticator.
10890
10891
10892 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10893 .cindex "&'pwcheck'& daemon"
10894 .cindex "Cyrus"
10895 .cindex "expansion" "&'pwcheck'& authentication test"
10896 .cindex "&%pwcheck%& expansion condition"
10897 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10898 This is one way of making it possible for passwords to be checked by a process
10899 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10900 deprecated. Its replacement is &'saslauthd'& (see below).
10901
10902 The pwcheck support is not included in Exim by default. You need to specify
10903 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10904 building Exim. For example:
10905 .code
10906 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10907 .endd
10908 You do not need to install the full Cyrus software suite in order to use
10909 the pwcheck daemon. You can compile and install just the daemon alone
10910 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10911 access to the &_/var/pwcheck_& directory.
10912
10913 The &%pwcheck%& condition takes one argument, which must be the user name and
10914 password, separated by a colon. For example, in a LOGIN authenticator
10915 configuration, you might have this:
10916 .code
10917 server_condition = ${if pwcheck{$auth1:$auth2}}
10918 .endd
10919 Again, for a PLAIN authenticator configuration, this would be:
10920 .code
10921 server_condition = ${if pwcheck{$auth2:$auth3}}
10922 .endd
10923 .vitem &*queue_running*&
10924 .cindex "queue runner" "detecting when delivering from"
10925 .cindex "expansion" "queue runner test"
10926 .cindex "&%queue_running%& expansion condition"
10927 This condition, which has no data, is true during delivery attempts that are
10928 initiated by queue runner processes, and false otherwise.
10929
10930
10931 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10932 .cindex "Radius"
10933 .cindex "expansion" "Radius authentication"
10934 .cindex "&%radius%& expansion condition"
10935 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10936 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10937 the Radius client configuration file in order to build Exim with Radius
10938 support.
10939
10940 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10941 library, using the original API. If you are using release 0.4.0 or later of
10942 this library, you need to set
10943 .code
10944 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10945 .endd
10946 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10947 &%libradius%& library that comes with FreeBSD. To do this, set
10948 .code
10949 RADIUS_LIB_TYPE=RADLIB
10950 .endd
10951 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10952 You may also have to supply a suitable setting in EXTRALIBS so that the
10953 Radius library can be found when Exim is linked.
10954
10955 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10956 Radius client library, which calls the Radius server. The condition is true if
10957 the authentication is successful. For example:
10958 .code
10959 server_condition = ${if radius{<arguments>}}
10960 .endd
10961
10962
10963 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10964         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10965 .cindex "&'saslauthd'& daemon"
10966 .cindex "Cyrus"
10967 .cindex "expansion" "&'saslauthd'& authentication test"
10968 .cindex "&%saslauthd%& expansion condition"
10969 This condition supports user authentication using the Cyrus &'saslauthd'&
10970 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10971 Using this daemon is one way of making it possible for passwords to be checked
10972 by a process that is not running as root.
10973
10974 The saslauthd support is not included in Exim by default. You need to specify
10975 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10976 building Exim. For example:
10977 .code
10978 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10979 .endd
10980 You do not need to install the full Cyrus software suite in order to use
10981 the saslauthd daemon. You can compile and install just the daemon alone
10982 from the Cyrus SASL library.
10983
10984 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10985 two are mandatory. For example:
10986 .code
10987 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10988 .endd
10989 The service and the realm are optional (which is why the arguments are enclosed
10990 in their own set of braces). For details of the meaning of the service and
10991 realm, and how to run the daemon, consult the Cyrus documentation.
10992 .endlist vlist
10993
10994
10995
10996 .section "Combining expansion conditions" "SECID84"
10997 .cindex "expansion" "combining conditions"
10998 Several conditions can be tested at once by combining them using the &%and%&
10999 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11000 conditions on their own, and precede their lists of sub-conditions. Each
11001 sub-condition must be enclosed in braces within the overall braces that contain
11002 the list. No repetition of &%if%& is used.
11003
11004
11005 .vlist
11006 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11007 .cindex "&""or""& expansion condition"
11008 .cindex "expansion" "&""or""& of conditions"
11009 The sub-conditions are evaluated from left to right. The condition is true if
11010 any one of the sub-conditions is true.
11011 For example,
11012 .code
11013 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11014 .endd
11015 When a true sub-condition is found, the following ones are parsed but not
11016 evaluated. If there are several &"match"& sub-conditions the values of the
11017 numeric variables afterwards are taken from the first one that succeeds.
11018
11019 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11020 .cindex "&""and""& expansion condition"
11021 .cindex "expansion" "&""and""& of conditions"
11022 The sub-conditions are evaluated from left to right. The condition is true if
11023 all of the sub-conditions are true. If there are several &"match"&
11024 sub-conditions, the values of the numeric variables afterwards are taken from
11025 the last one. When a false sub-condition is found, the following ones are
11026 parsed but not evaluated.
11027 .endlist
11028 .ecindex IIDexpcond
11029
11030
11031
11032
11033 .section "Expansion variables" "SECTexpvar"
11034 .cindex "expansion" "variables, list of"
11035 This section contains an alphabetical list of all the expansion variables. Some
11036 of them are available only when Exim is compiled with specific options such as
11037 support for TLS or the content scanning extension.
11038
11039 .vlist
11040 .vitem "&$0$&, &$1$&, etc"
11041 .cindex "numerical variables (&$1$& &$2$& etc)"
11042 When a &%match%& expansion condition succeeds, these variables contain the
11043 captured substrings identified by the regular expression during subsequent
11044 processing of the success string of the containing &%if%& expansion item.
11045 However, they do not retain their values afterwards; in fact, their previous
11046 values are restored at the end of processing an &%if%& item. The numerical
11047 variables may also be set externally by some other matching process which
11048 precedes the expansion of the string. For example, the commands available in
11049 Exim filter files include an &%if%& command with its own regular expression
11050 matching condition.
11051
11052 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11053 Within an acl condition, expansion condition or expansion item
11054 any arguments are copied to these variables,
11055 any unused variables being made empty.
11056
11057 .vitem "&$acl_c...$&"
11058 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11059 can be given any name that starts with &$acl_c$& and is at least six characters
11060 long, but the sixth character must be either a digit or an underscore. For
11061 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11062 variables persist throughout the lifetime of an SMTP connection. They can be
11063 used to pass information between ACLs and between different invocations of the
11064 same ACL. When a message is received, the values of these variables are saved
11065 with the message, and can be accessed by filters, routers, and transports
11066 during subsequent delivery.
11067
11068 .vitem "&$acl_m...$&"
11069 These variables are like the &$acl_c...$& variables, except that their values
11070 are reset after a message has been received. Thus, if several messages are
11071 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11072 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11073 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11074 message is received, the values of these variables are saved with the message,
11075 and can be accessed by filters, routers, and transports during subsequent
11076 delivery.
11077
11078 .vitem &$acl_narg$&
11079 Within an acl condition, expansion condition or expansion item
11080 this variable has the number of arguments.
11081
11082 .vitem &$acl_verify_message$&
11083 .vindex "&$acl_verify_message$&"
11084 After an address verification has failed, this variable contains the failure
11085 message. It retains its value for use in subsequent modifiers. The message can
11086 be preserved by coding like this:
11087 .code
11088 warn !verify = sender
11089      set acl_m0 = $acl_verify_message
11090 .endd
11091 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11092 &%log_message%& modifiers, to include information about the verification
11093 failure.
11094
11095 .vitem &$address_data$&
11096 .vindex "&$address_data$&"
11097 This variable is set by means of the &%address_data%& option in routers. The
11098 value then remains with the address while it is processed by subsequent routers
11099 and eventually a transport. If the transport is handling multiple addresses,
11100 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11101 for more details. &*Note*&: The contents of &$address_data$& are visible in
11102 user filter files.
11103
11104 If &$address_data$& is set when the routers are called from an ACL to verify
11105 a recipient address, the final value is still in the variable for subsequent
11106 conditions and modifiers of the ACL statement. If routing the address caused it
11107 to be redirected to just one address, the child address is also routed as part
11108 of the verification, and in this case the final value of &$address_data$& is
11109 from the child's routing.
11110
11111 If &$address_data$& is set when the routers are called from an ACL to verify a
11112 sender address, the final value is also preserved, but this time in
11113 &$sender_address_data$&, to distinguish it from data from a recipient
11114 address.
11115
11116 In both cases (recipient and sender verification), the value does not persist
11117 after the end of the current ACL statement. If you want to preserve
11118 these values for longer, you can save them in ACL variables.
11119
11120 .vitem &$address_file$&
11121 .vindex "&$address_file$&"
11122 When, as a result of aliasing, forwarding, or filtering, a message is directed
11123 to a specific file, this variable holds the name of the file when the transport
11124 is running. At other times, the variable is empty. For example, using the
11125 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11126 .code
11127 /home/r2d2/savemail
11128 .endd
11129 then when the &(address_file)& transport is running, &$address_file$&
11130 contains the text string &`/home/r2d2/savemail`&.
11131 .cindex "Sieve filter" "value of &$address_file$&"
11132 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11133 then up to the transport configuration to generate an appropriate absolute path
11134 to the relevant file.
11135
11136 .vitem &$address_pipe$&
11137 .vindex "&$address_pipe$&"
11138 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11139 this variable holds the pipe command when the transport is running.
11140
11141 .vitem "&$auth1$& &-- &$auth3$&"
11142 .vindex "&$auth1$&, &$auth2$&, etc"
11143 These variables are used in SMTP authenticators (see chapters
11144 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11145
11146 .vitem &$authenticated_id$&
11147 .cindex "authentication" "id"
11148 .vindex "&$authenticated_id$&"
11149 When a server successfully authenticates a client it may be configured to
11150 preserve some of the authentication information in the variable
11151 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11152 user/password authenticator configuration might preserve the user name for use
11153 in the routers. Note that this is not the same information that is saved in
11154 &$sender_host_authenticated$&.
11155 When a message is submitted locally (that is, not over a TCP connection)
11156 the value of &$authenticated_id$& is normally the login name of the calling
11157 process. However, a trusted user can override this by means of the &%-oMai%&
11158 command line option.
11159
11160 .vitem &$authenticated_fail_id$&
11161 .cindex "authentication" "fail" "id"
11162 .vindex "&$authenticated_fail_id$&"
11163 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11164 will contain the failed authentication id. If more than one authentication
11165 id is attempted, it will contain only the last one. The variable is
11166 available for processing in the ACL's, generally the quit or notquit ACL.
11167 A message to a local recipient could still be accepted without requiring
11168 authentication, which means this variable could also be visible in all of
11169 the ACL's as well.
11170
11171
11172 .vitem &$authenticated_sender$&
11173 .cindex "sender" "authenticated"
11174 .cindex "authentication" "sender"
11175 .cindex "AUTH" "on MAIL command"
11176 .vindex "&$authenticated_sender$&"
11177 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11178 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11179 described in section &<<SECTauthparamail>>&. Unless the data is the string
11180 &"<>"&, it is set as the authenticated sender of the message, and the value is
11181 available during delivery in the &$authenticated_sender$& variable. If the
11182 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11183
11184 .vindex "&$qualify_domain$&"
11185 When a message is submitted locally (that is, not over a TCP connection), the
11186 value of &$authenticated_sender$& is an address constructed from the login
11187 name of the calling process and &$qualify_domain$&, except that a trusted user
11188 can override this by means of the &%-oMas%& command line option.
11189
11190
11191 .vitem &$authentication_failed$&
11192 .cindex "authentication" "failure"
11193 .vindex "&$authentication_failed$&"
11194 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11195 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11196 possible to distinguish between &"did not try to authenticate"&
11197 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11198 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11199 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11200 negative response to an AUTH command, including (for example) an attempt to use
11201 an undefined mechanism.
11202
11203 .vitem &$av_failed$&
11204 .cindex "content scanning" "AV scanner failure"
11205 This variable is available when Exim is compiled with the content-scanning
11206 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11207 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11208 the ACL malware condition.
11209
11210 .vitem &$body_linecount$&
11211 .cindex "message body" "line count"
11212 .cindex "body of message" "line count"
11213 .vindex "&$body_linecount$&"
11214 When a message is being received or delivered, this variable contains the
11215 number of lines in the message's body. See also &$message_linecount$&.
11216
11217 .vitem &$body_zerocount$&
11218 .cindex "message body" "binary zero count"
11219 .cindex "body of message" "binary zero count"
11220 .cindex "binary zero" "in message body"
11221 .vindex "&$body_zerocount$&"
11222 When a message is being received or delivered, this variable contains the
11223 number of binary zero bytes (ASCII NULs) in the message's body.
11224
11225 .vitem &$bounce_recipient$&
11226 .vindex "&$bounce_recipient$&"
11227 This is set to the recipient address of a bounce message while Exim is creating
11228 it. It is useful if a customized bounce message text file is in use (see
11229 chapter &<<CHAPemsgcust>>&).
11230
11231 .vitem &$bounce_return_size_limit$&
11232 .vindex "&$bounce_return_size_limit$&"
11233 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11234 up to a multiple of 1000. It is useful when a customized error message text
11235 file is in use (see chapter &<<CHAPemsgcust>>&).
11236
11237 .vitem &$caller_gid$&
11238 .cindex "gid (group id)" "caller"
11239 .vindex "&$caller_gid$&"
11240 The real group id under which the process that called Exim was running. This is
11241 not the same as the group id of the originator of a message (see
11242 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11243 incarnation normally contains the Exim gid.
11244
11245 .vitem &$caller_uid$&
11246 .cindex "uid (user id)" "caller"
11247 .vindex "&$caller_uid$&"
11248 The real user id under which the process that called Exim was running. This is
11249 not the same as the user id of the originator of a message (see
11250 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11251 incarnation normally contains the Exim uid.
11252
11253 .vitem &$compile_date$&
11254 .vindex "&$compile_date$&"
11255 The date on which the Exim binary was compiled.
11256
11257 .vitem &$compile_number$&
11258 .vindex "&$compile_number$&"
11259 The building process for Exim keeps a count of the number
11260 of times it has been compiled. This serves to distinguish different
11261 compilations of the same version of the program.
11262
11263 .vitem &$config_dir$&
11264 .vindex "&$config_dir$&"
11265 The directory name of the main configuration file. That is, the content of
11266 &$config_file$& with the last component stripped. The value does not
11267 contain the trailing slash. If &$config_file$& does not contain a slash,
11268 &$config_dir$& is ".".
11269
11270 .vitem &$config_file$&
11271 .vindex "&$config_file$&"
11272 The name of the main configuration file Exim is using.
11273
11274 .vitem &$demime_errorlevel$&
11275 .vindex "&$demime_errorlevel$&"
11276 This variable is available when Exim is compiled with
11277 the content-scanning extension and the obsolete &%demime%& condition. For
11278 details, see section &<<SECTdemimecond>>&.
11279
11280 .vitem &$demime_reason$&
11281 .vindex "&$demime_reason$&"
11282 This variable is available when Exim is compiled with the
11283 content-scanning extension and the obsolete &%demime%& condition. For details,
11284 see section &<<SECTdemimecond>>&.
11285
11286 .vitem &$dnslist_domain$& &&&
11287        &$dnslist_matched$& &&&
11288        &$dnslist_text$& &&&
11289        &$dnslist_value$&
11290 .vindex "&$dnslist_domain$&"
11291 .vindex "&$dnslist_matched$&"
11292 .vindex "&$dnslist_text$&"
11293 .vindex "&$dnslist_value$&"
11294 .cindex "black list (DNS)"
11295 When a DNS (black) list lookup succeeds, these variables are set to contain
11296 the following data from the lookup: the list's domain name, the key that was
11297 looked up, the contents of any associated TXT record, and the value from the
11298 main A record. See section &<<SECID204>>& for more details.
11299
11300 .vitem &$domain$&
11301 .vindex "&$domain$&"
11302 When an address is being routed, or delivered on its own, this variable
11303 contains the domain. Uppercase letters in the domain are converted into lower
11304 case for &$domain$&.
11305
11306 Global address rewriting happens when a message is received, so the value of
11307 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11308 is set during user filtering, but not during system filtering, because a
11309 message may have many recipients and the system filter is called just once.
11310
11311 When more than one address is being delivered at once (for example, several
11312 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11313 have the same domain. Transports can be restricted to handling only one domain
11314 at a time if the value of &$domain$& is required at transport time &-- this is
11315 the default for local transports. For further details of the environment in
11316 which local transports are run, see chapter &<<CHAPenvironment>>&.
11317
11318 .oindex "&%delay_warning_condition%&"
11319 At the end of a delivery, if all deferred addresses have the same domain, it is
11320 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11321
11322 The &$domain$& variable is also used in some other circumstances:
11323
11324 .ilist
11325 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11326 the recipient address. The domain of the &'sender'& address is in
11327 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11328 normally set during the running of the MAIL ACL. However, if the sender address
11329 is verified with a callout during the MAIL ACL, the sender domain is placed in
11330 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11331 the &(smtp)& transport.
11332
11333 .next
11334 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11335 &$domain$& contains the domain portion of the address that is being rewritten;
11336 it can be used in the expansion of the replacement address, for example, to
11337 rewrite domains by file lookup.
11338
11339 .next
11340 With one important exception, whenever a domain list is being scanned,
11341 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11342 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11343 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11344 that, in a RCPT ACL, the sender domain list can be dependent on the
11345 recipient domain (which is what is in &$domain$& at this time).
11346
11347 .next
11348 .cindex "ETRN" "value of &$domain$&"
11349 .oindex "&%smtp_etrn_command%&"
11350 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11351 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11352 .endlist
11353
11354
11355 .vitem &$domain_data$&
11356 .vindex "&$domain_data$&"
11357 When the &%domains%& option on a router matches a domain by
11358 means of a lookup, the data read by the lookup is available during the running
11359 of the router as &$domain_data$&. In addition, if the driver routes the
11360 address to a transport, the value is available in that transport. If the
11361 transport is handling multiple addresses, the value from the first address is
11362 used.
11363
11364 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11365 domain by means of a lookup. The data read by the lookup is available during
11366 the rest of the ACL statement. In all other situations, this variable expands
11367 to nothing.
11368
11369 .vitem &$exim_gid$&
11370 .vindex "&$exim_gid$&"
11371 This variable contains the numerical value of the Exim group id.
11372
11373 .vitem &$exim_path$&
11374 .vindex "&$exim_path$&"
11375 This variable contains the path to the Exim binary.
11376
11377 .vitem &$exim_uid$&
11378 .vindex "&$exim_uid$&"
11379 This variable contains the numerical value of the Exim user id.
11380
11381 .vitem &$exim_version$&
11382 .vindex "&$exim_uid$&"
11383 This variable contains the version string of the Exim build.
11384 The first character is a major version number, currently 4.
11385 Then after a dot, the next group of digits is a minor version number.
11386 There may be other characters following the minor version.
11387
11388 .vitem &$found_extension$&
11389 .vindex "&$found_extension$&"
11390 This variable is available when Exim is compiled with the
11391 content-scanning extension and the obsolete &%demime%& condition. For details,
11392 see section &<<SECTdemimecond>>&.
11393
11394 .vitem &$header_$&<&'name'&>
11395 This is not strictly an expansion variable. It is expansion syntax for
11396 inserting the message header line with the given name. Note that the name must
11397 be terminated by colon or white space, because it may contain a wide variety of
11398 characters. Note also that braces must &'not'& be used.
11399
11400 .vitem &$headers_added$&
11401 .vindex "&$headers_added$&"
11402 Within an ACL this variable contains the headers added so far by
11403 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11404 The headers are a newline-separated list.
11405
11406 .vitem &$home$&
11407 .vindex "&$home$&"
11408 When the &%check_local_user%& option is set for a router, the user's home
11409 directory is placed in &$home$& when the check succeeds. In particular, this
11410 means it is set during the running of users' filter files. A router may also
11411 explicitly set a home directory for use by a transport; this can be overridden
11412 by a setting on the transport itself.
11413
11414 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11415 of the environment variable HOME.
11416
11417 .vitem &$host$&
11418 .vindex "&$host$&"
11419 If a router assigns an address to a transport (any transport), and passes a
11420 list of hosts with the address, the value of &$host$& when the transport starts
11421 to run is the name of the first host on the list. Note that this applies both
11422 to local and remote transports.
11423
11424 .cindex "transport" "filter"
11425 .cindex "filter" "transport filter"
11426 For the &(smtp)& transport, if there is more than one host, the value of
11427 &$host$& changes as the transport works its way through the list. In
11428 particular, when the &(smtp)& transport is expanding its options for encryption
11429 using TLS, or for specifying a transport filter (see chapter
11430 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11431 is connected.
11432
11433 When used in the client part of an authenticator configuration (see chapter
11434 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11435 client is connected.
11436
11437
11438 .vitem &$host_address$&
11439 .vindex "&$host_address$&"
11440 This variable is set to the remote host's IP address whenever &$host$& is set
11441 for a remote connection. It is also set to the IP address that is being checked
11442 when the &%ignore_target_hosts%& option is being processed.
11443
11444 .vitem &$host_data$&
11445 .vindex "&$host_data$&"
11446 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11447 result of the lookup is made available in the &$host_data$& variable. This
11448 allows you, for example, to do things like this:
11449 .code
11450 deny  hosts = net-lsearch;/some/file
11451 message = $host_data
11452 .endd
11453 .vitem &$host_lookup_deferred$&
11454 .cindex "host name" "lookup, failure of"
11455 .vindex "&$host_lookup_deferred$&"
11456 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11457 message comes from a remote host and there is an attempt to look up the host's
11458 name from its IP address, and the attempt is not successful, one of these
11459 variables is set to &"1"&.
11460
11461 .ilist
11462 If the lookup receives a definite negative response (for example, a DNS lookup
11463 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11464
11465 .next
11466 If there is any kind of problem during the lookup, such that Exim cannot
11467 tell whether or not the host name is defined (for example, a timeout for a DNS
11468 lookup), &$host_lookup_deferred$& is set to &"1"&.
11469 .endlist ilist
11470
11471 Looking up a host's name from its IP address consists of more than just a
11472 single reverse lookup. Exim checks that a forward lookup of at least one of the
11473 names it receives from a reverse lookup yields the original IP address. If this
11474 is not the case, Exim does not accept the looked up name(s), and
11475 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11476 IP address (for example, the existence of a PTR record in the DNS) is not
11477 sufficient on its own for the success of a host name lookup. If the reverse
11478 lookup succeeds, but there is a lookup problem such as a timeout when checking
11479 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11480 &"1"&. See also &$sender_host_name$&.
11481
11482 .vitem &$host_lookup_failed$&
11483 .vindex "&$host_lookup_failed$&"
11484 See &$host_lookup_deferred$&.
11485
11486 .vitem &$host_port$&
11487 .vindex "&$host_port$&"
11488 This variable is set to the remote host's TCP port whenever &$host$& is set
11489 for an outbound connection.
11490
11491
11492 .vitem &$inode$&
11493 .vindex "&$inode$&"
11494 The only time this variable is set is while expanding the &%directory_file%&
11495 option in the &(appendfile)& transport. The variable contains the inode number
11496 of the temporary file which is about to be renamed. It can be used to construct
11497 a unique name for the file.
11498
11499 .vitem &$interface_address$&
11500 .vindex "&$interface_address$&"
11501 This is an obsolete name for &$received_ip_address$&.
11502
11503 .vitem &$interface_port$&
11504 .vindex "&$interface_port$&"
11505 This is an obsolete name for &$received_port$&.
11506
11507 .vitem &$item$&
11508 .vindex "&$item$&"
11509 This variable is used during the expansion of &*forall*& and &*forany*&
11510 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11511 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11512 empty.
11513
11514 .vitem &$ldap_dn$&
11515 .vindex "&$ldap_dn$&"
11516 This variable, which is available only when Exim is compiled with LDAP support,
11517 contains the DN from the last entry in the most recently successful LDAP
11518 lookup.
11519
11520 .vitem &$load_average$&
11521 .vindex "&$load_average$&"
11522 This variable contains the system load average, multiplied by 1000 so that it
11523 is an integer. For example, if the load average is 0.21, the value of the
11524 variable is 210. The value is recomputed every time the variable is referenced.
11525
11526 .vitem &$local_part$&
11527 .vindex "&$local_part$&"
11528 When an address is being routed, or delivered on its own, this
11529 variable contains the local part. When a number of addresses are being
11530 delivered together (for example, multiple RCPT commands in an SMTP
11531 session), &$local_part$& is not set.
11532
11533 Global address rewriting happens when a message is received, so the value of
11534 &$local_part$& during routing and delivery is the value after rewriting.
11535 &$local_part$& is set during user filtering, but not during system filtering,
11536 because a message may have many recipients and the system filter is called just
11537 once.
11538
11539 .vindex "&$local_part_prefix$&"
11540 .vindex "&$local_part_suffix$&"
11541 If a local part prefix or suffix has been recognized, it is not included in the
11542 value of &$local_part$& during routing and subsequent delivery. The values of
11543 any prefix or suffix are in &$local_part_prefix$& and
11544 &$local_part_suffix$&, respectively.
11545
11546 When a message is being delivered to a file, pipe, or autoreply transport as a
11547 result of aliasing or forwarding, &$local_part$& is set to the local part of
11548 the parent address, not to the file name or command (see &$address_file$& and
11549 &$address_pipe$&).
11550
11551 When an ACL is running for a RCPT command, &$local_part$& contains the
11552 local part of the recipient address.
11553
11554 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11555 &$local_part$& contains the local part of the address that is being rewritten;
11556 it can be used in the expansion of the replacement address, for example.
11557
11558 In all cases, all quoting is removed from the local part. For example, for both
11559 the addresses
11560 .code
11561 "abc:xyz"@test.example
11562 abc\:xyz@test.example
11563 .endd
11564 the value of &$local_part$& is
11565 .code
11566 abc:xyz
11567 .endd
11568 If you use &$local_part$& to create another address, you should always wrap it
11569 inside a quoting operator. For example, in a &(redirect)& router you could
11570 have:
11571 .code
11572 data = ${quote_local_part:$local_part}@new.domain.example
11573 .endd
11574 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11575 to process local parts in a case-dependent manner in a router, you can set the
11576 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11577
11578 .vitem &$local_part_data$&
11579 .vindex "&$local_part_data$&"
11580 When the &%local_parts%& option on a router matches a local part by means of a
11581 lookup, the data read by the lookup is available during the running of the
11582 router as &$local_part_data$&. In addition, if the driver routes the address
11583 to a transport, the value is available in that transport. If the transport is
11584 handling multiple addresses, the value from the first address is used.
11585
11586 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11587 matches a local part by means of a lookup. The data read by the lookup is
11588 available during the rest of the ACL statement. In all other situations, this
11589 variable expands to nothing.
11590
11591 .vitem &$local_part_prefix$&
11592 .vindex "&$local_part_prefix$&"
11593 When an address is being routed or delivered, and a
11594 specific prefix for the local part was recognized, it is available in this
11595 variable, having been removed from &$local_part$&.
11596
11597 .vitem &$local_part_suffix$&
11598 .vindex "&$local_part_suffix$&"
11599 When an address is being routed or delivered, and a
11600 specific suffix for the local part was recognized, it is available in this
11601 variable, having been removed from &$local_part$&.
11602
11603 .vitem &$local_scan_data$&
11604 .vindex "&$local_scan_data$&"
11605 This variable contains the text returned by the &[local_scan()]& function when
11606 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11607
11608 .vitem &$local_user_gid$&
11609 .vindex "&$local_user_gid$&"
11610 See &$local_user_uid$&.
11611
11612 .vitem &$local_user_uid$&
11613 .vindex "&$local_user_uid$&"
11614 This variable and &$local_user_gid$& are set to the uid and gid after the
11615 &%check_local_user%& router precondition succeeds. This means that their values
11616 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11617 and &%condition%&), for the &%address_data%& expansion, and for any
11618 router-specific expansions. At all other times, the values in these variables
11619 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11620
11621 .vitem &$localhost_number$&
11622 .vindex "&$localhost_number$&"
11623 This contains the expanded value of the
11624 &%localhost_number%& option. The expansion happens after the main options have
11625 been read.
11626
11627 .vitem &$log_inodes$&
11628 .vindex "&$log_inodes$&"
11629 The number of free inodes in the disk partition where Exim's
11630 log files are being written. The value is recalculated whenever the variable is
11631 referenced. If the relevant file system does not have the concept of inodes,
11632 the value of is -1. See also the &%check_log_inodes%& option.
11633
11634 .vitem &$log_space$&
11635 .vindex "&$log_space$&"
11636 The amount of free space (as a number of kilobytes) in the disk
11637 partition where Exim's log files are being written. The value is recalculated
11638 whenever the variable is referenced. If the operating system does not have the
11639 ability to find the amount of free space (only true for experimental systems),
11640 the space value is -1. See also the &%check_log_space%& option.
11641
11642
11643 .vitem &$lookup_dnssec_authenticated$&
11644 .vindex "&$lookup_dnssec_authenticated$&"
11645 This variable is set after a DNS lookup done by
11646 a dnsdb lookup expansion, dnslookup router or smtp transport.
11647 It will be empty if &(DNSSEC)& was not requested,
11648 &"no"& if the result was not labelled as authenticated data
11649 and &"yes"& if it was.
11650
11651 .vitem &$mailstore_basename$&
11652 .vindex "&$mailstore_basename$&"
11653 This variable is set only when doing deliveries in &"mailstore"& format in the
11654 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11655 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11656 contains the basename of the files that are being written, that is, the name
11657 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11658 variable is empty.
11659
11660 .vitem &$malware_name$&
11661 .vindex "&$malware_name$&"
11662 This variable is available when Exim is compiled with the
11663 content-scanning extension. It is set to the name of the virus that was found
11664 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11665
11666 .vitem &$max_received_linelength$&
11667 .vindex "&$max_received_linelength$&"
11668 .cindex "maximum" "line length"
11669 .cindex "line length" "maximum"
11670 This variable contains the number of bytes in the longest line that was
11671 received as part of the message, not counting the line termination
11672 character(s).
11673
11674 .vitem &$message_age$&
11675 .cindex "message" "age of"
11676 .vindex "&$message_age$&"
11677 This variable is set at the start of a delivery attempt to contain the number
11678 of seconds since the message was received. It does not change during a single
11679 delivery attempt.
11680
11681 .vitem &$message_body$&
11682 .cindex "body of message" "expansion variable"
11683 .cindex "message body" "in expansion"
11684 .cindex "binary zero" "in message body"
11685 .vindex "&$message_body$&"
11686 .oindex "&%message_body_visible%&"
11687 This variable contains the initial portion of a message's body while it is
11688 being delivered, and is intended mainly for use in filter files. The maximum
11689 number of characters of the body that are put into the variable is set by the
11690 &%message_body_visible%& configuration option; the default is 500.
11691
11692 .oindex "&%message_body_newlines%&"
11693 By default, newlines are converted into spaces in &$message_body$&, to make it
11694 easier to search for phrases that might be split over a line break. However,
11695 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11696 zeros are always converted into spaces.
11697
11698 .vitem &$message_body_end$&
11699 .cindex "body of message" "expansion variable"
11700 .cindex "message body" "in expansion"
11701 .vindex "&$message_body_end$&"
11702 This variable contains the final portion of a message's
11703 body while it is being delivered. The format and maximum size are as for
11704 &$message_body$&.
11705
11706 .vitem &$message_body_size$&
11707 .cindex "body of message" "size"
11708 .cindex "message body" "size"
11709 .vindex "&$message_body_size$&"
11710 When a message is being delivered, this variable contains the size of the body
11711 in bytes. The count starts from the character after the blank line that
11712 separates the body from the header. Newlines are included in the count. See
11713 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11714
11715 .vitem &$message_exim_id$&
11716 .vindex "&$message_exim_id$&"
11717 When a message is being received or delivered, this variable contains the
11718 unique message id that is generated and used by Exim to identify the message.
11719 An id is not created for a message until after its header has been successfully
11720 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11721 line; it is the local id that Exim assigns to the message, for example:
11722 &`1BXTIK-0001yO-VA`&.
11723
11724 .vitem &$message_headers$&
11725 .vindex &$message_headers$&
11726 This variable contains a concatenation of all the header lines when a message
11727 is being processed, except for lines added by routers or transports. The header
11728 lines are separated by newline characters. Their contents are decoded in the
11729 same way as a header line that is inserted by &%bheader%&.
11730
11731 .vitem &$message_headers_raw$&
11732 .vindex &$message_headers_raw$&
11733 This variable is like &$message_headers$& except that no processing of the
11734 contents of header lines is done.
11735
11736 .vitem &$message_id$&
11737 This is an old name for &$message_exim_id$&. It is now deprecated.
11738
11739 .vitem &$message_linecount$&
11740 .vindex "&$message_linecount$&"
11741 This variable contains the total number of lines in the header and body of the
11742 message. Compare &$body_linecount$&, which is the count for the body only.
11743 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11744 number of lines received. Before delivery happens (that is, before filters,
11745 routers, and transports run) the count is increased to include the
11746 &'Received:'& header line that Exim standardly adds, and also any other header
11747 lines that are added by ACLs. The blank line that separates the message header
11748 from the body is not counted.
11749
11750 As with the special case of &$message_size$&, during the expansion of the
11751 appendfile transport's maildir_tag option in maildir format, the value of
11752 &$message_linecount$& is the precise size of the number of newlines in the
11753 file that has been written (minus one for the blank line between the
11754 header and the body).
11755
11756 Here is an example of the use of this variable in a DATA ACL:
11757 .code
11758 deny message   = Too many lines in message header
11759      condition = \
11760       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11761 .endd
11762 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11763 message has not yet been received.
11764
11765 .vitem &$message_size$&
11766 .cindex "size" "of message"
11767 .cindex "message" "size"
11768 .vindex "&$message_size$&"
11769 When a message is being processed, this variable contains its size in bytes. In
11770 most cases, the size includes those headers that were received with the
11771 message, but not those (such as &'Envelope-to:'&) that are added to individual
11772 deliveries as they are written. However, there is one special case: during the
11773 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11774 doing a delivery in maildir format, the value of &$message_size$& is the
11775 precise size of the file that has been written. See also
11776 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11777
11778 .cindex "RCPT" "value of &$message_size$&"
11779 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11780 contains the size supplied on the MAIL command, or -1 if no size was given. The
11781 value may not, of course, be truthful.
11782
11783 .vitem &$mime_$&&'xxx'&
11784 A number of variables whose names start with &$mime$& are
11785 available when Exim is compiled with the content-scanning extension. For
11786 details, see section &<<SECTscanmimepart>>&.
11787
11788 .vitem "&$n0$& &-- &$n9$&"
11789 These variables are counters that can be incremented by means
11790 of the &%add%& command in filter files.
11791
11792 .vitem &$original_domain$&
11793 .vindex "&$domain$&"
11794 .vindex "&$original_domain$&"
11795 When a top-level address is being processed for delivery, this contains the
11796 same value as &$domain$&. However, if a &"child"& address (for example,
11797 generated by an alias, forward, or filter file) is being processed, this
11798 variable contains the domain of the original address (lower cased). This
11799 differs from &$parent_domain$& only when there is more than one level of
11800 aliasing or forwarding. When more than one address is being delivered in a
11801 single transport run, &$original_domain$& is not set.
11802
11803 If a new address is created by means of a &%deliver%& command in a system
11804 filter, it is set up with an artificial &"parent"& address. This has the local
11805 part &'system-filter'& and the default qualify domain.
11806
11807 .vitem &$original_local_part$&
11808 .vindex "&$local_part$&"
11809 .vindex "&$original_local_part$&"
11810 When a top-level address is being processed for delivery, this contains the
11811 same value as &$local_part$&, unless a prefix or suffix was removed from the
11812 local part, because &$original_local_part$& always contains the full local
11813 part. When a &"child"& address (for example, generated by an alias, forward, or
11814 filter file) is being processed, this variable contains the full local part of
11815 the original address.
11816
11817 If the router that did the redirection processed the local part
11818 case-insensitively, the value in &$original_local_part$& is in lower case.
11819 This variable differs from &$parent_local_part$& only when there is more than
11820 one level of aliasing or forwarding. When more than one address is being
11821 delivered in a single transport run, &$original_local_part$& is not set.
11822
11823 If a new address is created by means of a &%deliver%& command in a system
11824 filter, it is set up with an artificial &"parent"& address. This has the local
11825 part &'system-filter'& and the default qualify domain.
11826
11827 .vitem &$originator_gid$&
11828 .cindex "gid (group id)" "of originating user"
11829 .cindex "sender" "gid"
11830 .vindex "&$caller_gid$&"
11831 .vindex "&$originator_gid$&"
11832 This variable contains the value of &$caller_gid$& that was set when the
11833 message was received. For messages received via the command line, this is the
11834 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11835 normally the gid of the Exim user.
11836
11837 .vitem &$originator_uid$&
11838 .cindex "uid (user id)" "of originating user"
11839 .cindex "sender" "uid"
11840 .vindex "&$caller_uid$&"
11841 .vindex "&$originaltor_uid$&"
11842 The value of &$caller_uid$& that was set when the message was received. For
11843 messages received via the command line, this is the uid of the sending user.
11844 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11845 user.
11846
11847 .vitem &$parent_domain$&
11848 .vindex "&$parent_domain$&"
11849 This variable is similar to &$original_domain$& (see
11850 above), except that it refers to the immediately preceding parent address.
11851
11852 .vitem &$parent_local_part$&
11853 .vindex "&$parent_local_part$&"
11854 This variable is similar to &$original_local_part$&
11855 (see above), except that it refers to the immediately preceding parent address.
11856
11857 .vitem &$pid$&
11858 .cindex "pid (process id)" "of current process"
11859 .vindex "&$pid$&"
11860 This variable contains the current process id.
11861
11862 .vitem &$pipe_addresses$&
11863 .cindex "filter" "transport filter"
11864 .cindex "transport" "filter"
11865 .vindex "&$pipe_addresses$&"
11866 This is not an expansion variable, but is mentioned here because the string
11867 &`$pipe_addresses`& is handled specially in the command specification for the
11868 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11869 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11870 It cannot be used in general expansion strings, and provokes an &"unknown
11871 variable"& error if encountered.
11872
11873 .vitem &$primary_hostname$&
11874 .vindex "&$primary_hostname$&"
11875 This variable contains the value set by &%primary_hostname%& in the
11876 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11877 a single-component name, Exim calls &[gethostbyname()]& (or
11878 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11879 qualified host name. See also &$smtp_active_hostname$&.
11880
11881
11882 .vitem &$prvscheck_address$&
11883 This variable is used in conjunction with the &%prvscheck%& expansion item,
11884 which is described in sections &<<SECTexpansionitems>>& and
11885 &<<SECTverifyPRVS>>&.
11886
11887 .vitem &$prvscheck_keynum$&
11888 This variable is used in conjunction with the &%prvscheck%& expansion item,
11889 which is described in sections &<<SECTexpansionitems>>& and
11890 &<<SECTverifyPRVS>>&.
11891
11892 .vitem &$prvscheck_result$&
11893 This variable is used in conjunction with the &%prvscheck%& expansion item,
11894 which is described in sections &<<SECTexpansionitems>>& and
11895 &<<SECTverifyPRVS>>&.
11896
11897 .vitem &$qualify_domain$&
11898 .vindex "&$qualify_domain$&"
11899 The value set for the &%qualify_domain%& option in the configuration file.
11900
11901 .vitem &$qualify_recipient$&
11902 .vindex "&$qualify_recipient$&"
11903 The value set for the &%qualify_recipient%& option in the configuration file,
11904 or if not set, the value of &$qualify_domain$&.
11905
11906 .vitem &$rcpt_count$&
11907 .vindex "&$rcpt_count$&"
11908 When a message is being received by SMTP, this variable contains the number of
11909 RCPT commands received for the current message. If this variable is used in a
11910 RCPT ACL, its value includes the current command.
11911
11912 .vitem &$rcpt_defer_count$&
11913 .vindex "&$rcpt_defer_count$&"
11914 .cindex "4&'xx'& responses" "count of"
11915 When a message is being received by SMTP, this variable contains the number of
11916 RCPT commands in the current message that have previously been rejected with a
11917 temporary (4&'xx'&) response.
11918
11919 .vitem &$rcpt_fail_count$&
11920 .vindex "&$rcpt_fail_count$&"
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 permanent (5&'xx'&) response.
11924
11925 .vitem &$received_count$&
11926 .vindex "&$received_count$&"
11927 This variable contains the number of &'Received:'& header lines in the message,
11928 including the one added by Exim (so its value is always greater than zero). It
11929 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11930 delivering.
11931
11932 .vitem &$received_for$&
11933 .vindex "&$received_for$&"
11934 If there is only a single recipient address in an incoming message, this
11935 variable contains that address when the &'Received:'& header line is being
11936 built. The value is copied after recipient rewriting has happened, but before
11937 the &[local_scan()]& function is run.
11938
11939 .vitem &$received_ip_address$&
11940 .vindex "&$received_ip_address$&"
11941 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11942 variable is set to the address of the local IP interface, and &$received_port$&
11943 is set to the local port number. (The remote IP address and port are in
11944 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11945 the port value is -1 unless it has been set using the &%-oMi%& command line
11946 option.
11947
11948 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11949 could be used, for example, to make the file name for a TLS certificate depend
11950 on which interface and/or port is being used for the incoming connection. The
11951 values of &$received_ip_address$& and &$received_port$& are saved with any
11952 messages that are received, thus making these variables available at delivery
11953 time.
11954 For outbound connections see &$sending_ip_address$&.
11955
11956 .vitem &$received_port$&
11957 .vindex "&$received_port$&"
11958 See &$received_ip_address$&.
11959
11960 .vitem &$received_protocol$&
11961 .vindex "&$received_protocol$&"
11962 When a message is being processed, this variable contains the name of the
11963 protocol by which it was received. Most of the names used by Exim are defined
11964 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11965 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11966 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11967 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11968 connection and the client was successfully authenticated.
11969
11970 Exim uses the protocol name &"smtps"& for the case when encryption is
11971 automatically set up on connection without the use of STARTTLS (see
11972 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11973 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11974 where the client initially uses EHLO, sets up an encrypted connection using
11975 STARTTLS, and then uses HELO afterwards.
11976
11977 The &%-oMr%& option provides a way of specifying a custom protocol name for
11978 messages that are injected locally by trusted callers. This is commonly used to
11979 identify messages that are being re-injected after some kind of scanning.
11980
11981 .vitem &$received_time$&
11982 .vindex "&$received_time$&"
11983 This variable contains the date and time when the current message was received,
11984 as a number of seconds since the start of the Unix epoch.
11985
11986 .vitem &$recipient_data$&
11987 .vindex "&$recipient_data$&"
11988 This variable is set after an indexing lookup success in an ACL &%recipients%&
11989 condition. It contains the data from the lookup, and the value remains set
11990 until the next &%recipients%& test. Thus, you can do things like this:
11991 .display
11992 &`require recipients  = cdb*@;/some/file`&
11993 &`deny    `&&'some further test involving'& &`$recipient_data`&
11994 .endd
11995 &*Warning*&: This variable is set only when a lookup is used as an indexing
11996 method in the address list, using the semicolon syntax as in the example above.
11997 The variable is not set for a lookup that is used as part of the string
11998 expansion that all such lists undergo before being interpreted.
11999
12000 .vitem &$recipient_verify_failure$&
12001 .vindex "&$recipient_verify_failure$&"
12002 In an ACL, when a recipient verification fails, this variable contains
12003 information about the failure. It is set to one of the following words:
12004
12005 .ilist
12006 &"qualify"&: The address was unqualified (no domain), and the message
12007 was neither local nor came from an exempted host.
12008
12009 .next
12010 &"route"&: Routing failed.
12011
12012 .next
12013 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12014 or before the MAIL command (that is, on initial connection, HELO, or
12015 MAIL).
12016
12017 .next
12018 &"recipient"&: The RCPT command in a callout was rejected.
12019 .next
12020
12021 &"postmaster"&: The postmaster check in a callout was rejected.
12022 .endlist
12023
12024 The main use of this variable is expected to be to distinguish between
12025 rejections of MAIL and rejections of RCPT.
12026
12027 .vitem &$recipients$&
12028 .vindex "&$recipients$&"
12029 This variable contains a list of envelope recipients for a message. A comma and
12030 a space separate the addresses in the replacement text. However, the variable
12031 is not generally available, to prevent exposure of Bcc recipients in
12032 unprivileged users' filter files. You can use &$recipients$& only in these
12033 cases:
12034
12035 .olist
12036 In a system filter file.
12037 .next
12038 In the ACLs associated with the DATA command and with non-SMTP messages, that
12039 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12040 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12041 &%acl_not_smtp_mime%&.
12042 .next
12043 From within a &[local_scan()]& function.
12044 .endlist
12045
12046
12047 .vitem &$recipients_count$&
12048 .vindex "&$recipients_count$&"
12049 When a message is being processed, this variable contains the number of
12050 envelope recipients that came with the message. Duplicates are not excluded
12051 from the count. While a message is being received over SMTP, the number
12052 increases for each accepted recipient. It can be referenced in an ACL.
12053
12054
12055 .vitem &$regex_match_string$&
12056 .vindex "&$regex_match_string$&"
12057 This variable is set to contain the matching regular expression after a
12058 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12059
12060
12061 .vitem &$reply_address$&
12062 .vindex "&$reply_address$&"
12063 When a message is being processed, this variable contains the contents of the
12064 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12065 contents of the &'From:'& header line. Apart from the removal of leading
12066 white space, the value is not processed in any way. In particular, no RFC 2047
12067 decoding or character code translation takes place.
12068
12069 .vitem &$return_path$&
12070 .vindex "&$return_path$&"
12071 When a message is being delivered, this variable contains the return path &--
12072 the sender field that will be sent as part of the envelope. It is not enclosed
12073 in <> characters. At the start of routing an address, &$return_path$& has the
12074 same value as &$sender_address$&, but if, for example, an incoming message to a
12075 mailing list has been expanded by a router which specifies a different address
12076 for bounce messages, &$return_path$& subsequently contains the new bounce
12077 address, whereas &$sender_address$& always contains the original sender address
12078 that was received with the message. In other words, &$sender_address$& contains
12079 the incoming envelope sender, and &$return_path$& contains the outgoing
12080 envelope sender.
12081
12082 .vitem &$return_size_limit$&
12083 .vindex "&$return_size_limit$&"
12084 This is an obsolete name for &$bounce_return_size_limit$&.
12085
12086 .vitem &$router_name$&
12087 .cindex "router" "name"
12088 .cindex "name" "of router"
12089 .vindex "&$router_name$&"
12090 During the running of a router this variable contains its name.
12091
12092 .vitem &$runrc$&
12093 .cindex "return code" "from &%run%& expansion"
12094 .vindex "&$runrc$&"
12095 This variable contains the return code from a command that is run by the
12096 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12097 assume the order in which option values are expanded, except for those
12098 preconditions whose order of testing is documented. Therefore, you cannot
12099 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12100 another.
12101
12102 .vitem &$self_hostname$&
12103 .oindex "&%self%&" "value of host name"
12104 .vindex "&$self_hostname$&"
12105 When an address is routed to a supposedly remote host that turns out to be the
12106 local host, what happens is controlled by the &%self%& generic router option.
12107 One of its values causes the address to be passed to another router. When this
12108 happens, &$self_hostname$& is set to the name of the local host that the
12109 original router encountered. In other circumstances its contents are null.
12110
12111 .vitem &$sender_address$&
12112 .vindex "&$sender_address$&"
12113 When a message is being processed, this variable contains the sender's address
12114 that was received in the message's envelope. The case of letters in the address
12115 is retained, in both the local part and the domain. For bounce messages, the
12116 value of this variable is the empty string. See also &$return_path$&.
12117
12118 .vitem &$sender_address_data$&
12119 .vindex "&$address_data$&"
12120 .vindex "&$sender_address_data$&"
12121 If &$address_data$& is set when the routers are called from an ACL to verify a
12122 sender address, the final value is preserved in &$sender_address_data$&, to
12123 distinguish it from data from a recipient address. The value does not persist
12124 after the end of the current ACL statement. If you want to preserve it for
12125 longer, you can save it in an ACL variable.
12126
12127 .vitem &$sender_address_domain$&
12128 .vindex "&$sender_address_domain$&"
12129 The domain portion of &$sender_address$&.
12130
12131 .vitem &$sender_address_local_part$&
12132 .vindex "&$sender_address_local_part$&"
12133 The local part portion of &$sender_address$&.
12134
12135 .vitem &$sender_data$&
12136 .vindex "&$sender_data$&"
12137 This variable is set after a lookup success in an ACL &%senders%& condition or
12138 in a router &%senders%& option. It contains the data from the lookup, and the
12139 value remains set until the next &%senders%& test. Thus, you can do things like
12140 this:
12141 .display
12142 &`require senders      = cdb*@;/some/file`&
12143 &`deny    `&&'some further test involving'& &`$sender_data`&
12144 .endd
12145 &*Warning*&: This variable is set only when a lookup is used as an indexing
12146 method in the address list, using the semicolon syntax as in the example above.
12147 The variable is not set for a lookup that is used as part of the string
12148 expansion that all such lists undergo before being interpreted.
12149
12150 .vitem &$sender_fullhost$&
12151 .vindex "&$sender_fullhost$&"
12152 When a message is received from a remote host, this variable contains the host
12153 name and IP address in a single string. It ends with the IP address in square
12154 brackets, followed by a colon and a port number if the logging of ports is
12155 enabled. The format of the rest of the string depends on whether the host
12156 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12157 looking up its IP address. (Looking up the IP address can be forced by the
12158 &%host_lookup%& option, independent of verification.) A plain host name at the
12159 start of the string is a verified host name; if this is not present,
12160 verification either failed or was not requested. A host name in parentheses is
12161 the argument of a HELO or EHLO command. This is omitted if it is identical to
12162 the verified host name or to the host's IP address in square brackets.
12163
12164 .vitem &$sender_helo_name$&
12165 .vindex "&$sender_helo_name$&"
12166 When a message is received from a remote host that has issued a HELO or EHLO
12167 command, the argument of that command is placed in this variable. It is also
12168 set if HELO or EHLO is used when a message is received using SMTP locally via
12169 the &%-bs%& or &%-bS%& options.
12170
12171 .vitem &$sender_host_address$&
12172 .vindex "&$sender_host_address$&"
12173 When a message is received from a remote host using SMTP,
12174 this variable contains that
12175 host's IP address. For locally non-SMTP submitted messages, it is empty.
12176
12177 .vitem &$sender_host_authenticated$&
12178 .vindex "&$sender_host_authenticated$&"
12179 This variable contains the name (not the public name) of the authenticator
12180 driver that successfully authenticated the client from which the message was
12181 received. It is empty if there was no successful authentication. See also
12182 &$authenticated_id$&.
12183
12184 .vitem &$sender_host_dnssec$&
12185 .vindex "&$sender_host_dnssec$&"
12186 If an attempt to populate &$sender_host_name$& has been made
12187 (by reference, &%hosts_lookup%& or
12188 otherwise) then this boolean will have been set true if, and only if, the
12189 resolver library states that the reverse DNS was authenticated data.  At all
12190 other times, this variable is false.
12191
12192 It is likely that you will need to coerce DNSSEC support on in the resolver
12193 library, by setting:
12194 .code
12195 dns_dnssec_ok = 1
12196 .endd
12197
12198 Exim does not perform DNSSEC validation itself, instead leaving that to a
12199 validating resolver (eg, unbound, or bind with suitable configuration).
12200
12201 Exim does not (currently) check to see if the forward DNS was also secured
12202 with DNSSEC, only the reverse DNS.
12203
12204 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12205 mechanism in the list, then this variable will be false.
12206
12207
12208 .vitem &$sender_host_name$&
12209 .vindex "&$sender_host_name$&"
12210 When a message is received from a remote host, this variable contains the
12211 host's name as obtained by looking up its IP address. For messages received by
12212 other means, this variable is empty.
12213
12214 .vindex "&$host_lookup_failed$&"
12215 If the host name has not previously been looked up, a reference to
12216 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12217 A looked up name is accepted only if it leads back to the original IP address
12218 via a forward lookup. If either the reverse or the forward lookup fails to find
12219 any data, or if the forward lookup does not yield the original IP address,
12220 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12221
12222 .vindex "&$host_lookup_deferred$&"
12223 However, if either of the lookups cannot be completed (for example, there is a
12224 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12225 &$host_lookup_failed$& remains set to &"0"&.
12226
12227 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12228 host name again if there is a subsequent reference to &$sender_host_name$&
12229 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12230 is set to &"1"&.
12231
12232 Exim does not automatically look up every calling host's name. If you want
12233 maximum efficiency, you should arrange your configuration so that it avoids
12234 these lookups altogether. The lookup happens only if one or more of the
12235 following are true:
12236
12237 .ilist
12238 A string containing &$sender_host_name$& is expanded.
12239 .next
12240 The calling host matches the list in &%host_lookup%&. In the default
12241 configuration, this option is set to *, so it must be changed if lookups are
12242 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12243 .next
12244 Exim needs the host name in order to test an item in a host list. The items
12245 that require this are described in sections &<<SECThoslispatnam>>& and
12246 &<<SECThoslispatnamsk>>&.
12247 .next
12248 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12249 In this case, the host name is required to compare with the name quoted in any
12250 EHLO or HELO commands that the client issues.
12251 .next
12252 The remote host issues a EHLO or HELO command that quotes one of the
12253 domains in &%helo_lookup_domains%&. The default value of this option is
12254 . ==== As this is a nested list, any displays it contains must be indented
12255 . ==== as otherwise they are too far to the left.
12256 .code
12257   helo_lookup_domains = @ : @[]
12258 .endd
12259 which causes a lookup if a remote host (incorrectly) gives the server's name or
12260 IP address in an EHLO or HELO command.
12261 .endlist
12262
12263
12264 .vitem &$sender_host_port$&
12265 .vindex "&$sender_host_port$&"
12266 When a message is received from a remote host, this variable contains the port
12267 number that was used on the remote host.
12268
12269 .vitem &$sender_ident$&
12270 .vindex "&$sender_ident$&"
12271 When a message is received from a remote host, this variable contains the
12272 identification received in response to an RFC 1413 request. When a message has
12273 been received locally, this variable contains the login name of the user that
12274 called Exim.
12275
12276 .vitem &$sender_rate_$&&'xxx'&
12277 A number of variables whose names begin &$sender_rate_$& are set as part of the
12278 &%ratelimit%& ACL condition. Details are given in section
12279 &<<SECTratelimiting>>&.
12280
12281 .vitem &$sender_rcvhost$&
12282 .cindex "DNS" "reverse lookup"
12283 .cindex "reverse DNS lookup"
12284 .vindex "&$sender_rcvhost$&"
12285 This is provided specifically for use in &'Received:'& headers. It starts with
12286 either the verified host name (as obtained from a reverse DNS lookup) or, if
12287 there is no verified host name, the IP address in square brackets. After that
12288 there may be text in parentheses. When the first item is a verified host name,
12289 the first thing in the parentheses is the IP address in square brackets,
12290 followed by a colon and a port number if port logging is enabled. When the
12291 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12292 the parentheses.
12293
12294 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12295 was used and its argument was not identical to the real host name or IP
12296 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12297 all three items are present in the parentheses, a newline and tab are inserted
12298 into the string, to improve the formatting of the &'Received:'& header.
12299
12300 .vitem &$sender_verify_failure$&
12301 .vindex "&$sender_verify_failure$&"
12302 In an ACL, when a sender verification fails, this variable contains information
12303 about the failure. The details are the same as for
12304 &$recipient_verify_failure$&.
12305
12306 .vitem &$sending_ip_address$&
12307 .vindex "&$sending_ip_address$&"
12308 This variable is set whenever an outgoing SMTP connection to another host has
12309 been set up. It contains the IP address of the local interface that is being
12310 used. This is useful if a host that has more than one IP address wants to take
12311 on different personalities depending on which one is being used. For incoming
12312 connections, see &$received_ip_address$&.
12313
12314 .vitem &$sending_port$&
12315 .vindex "&$sending_port$&"
12316 This variable is set whenever an outgoing SMTP connection to another host has
12317 been set up. It contains the local port that is being used. For incoming
12318 connections, see &$received_port$&.
12319
12320 .vitem &$smtp_active_hostname$&
12321 .vindex "&$smtp_active_hostname$&"
12322 During an incoming SMTP session, this variable contains the value of the active
12323 host name, as specified by the &%smtp_active_hostname%& option. The value of
12324 &$smtp_active_hostname$& is saved with any message that is received, so its
12325 value can be consulted during routing and delivery.
12326
12327 .vitem &$smtp_command$&
12328 .vindex "&$smtp_command$&"
12329 During the processing of an incoming SMTP command, this variable contains the
12330 entire command. This makes it possible to distinguish between HELO and EHLO in
12331 the HELO ACL, and also to distinguish between commands such as these:
12332 .code
12333 MAIL FROM:<>
12334 MAIL FROM: <>
12335 .endd
12336 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12337 command, the address in &$smtp_command$& is the original address before any
12338 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12339 the address after SMTP-time rewriting.
12340
12341 .vitem &$smtp_command_argument$&
12342 .cindex "SMTP" "command, argument for"
12343 .vindex "&$smtp_command_argument$&"
12344 While an ACL is running to check an SMTP command, this variable contains the
12345 argument, that is, the text that follows the command name, with leading white
12346 space removed. Following the introduction of &$smtp_command$&, this variable is
12347 somewhat redundant, but is retained for backwards compatibility.
12348
12349 .vitem &$smtp_count_at_connection_start$&
12350 .vindex "&$smtp_count_at_connection_start$&"
12351 This variable is set greater than zero only in processes spawned by the Exim
12352 daemon for handling incoming SMTP connections. The name is deliberately long,
12353 in order to emphasize what the contents are. When the daemon accepts a new
12354 connection, it increments this variable. A copy of the variable is passed to
12355 the child process that handles the connection, but its value is fixed, and
12356 never changes. It is only an approximation of how many incoming connections
12357 there actually are, because many other connections may come and go while a
12358 single connection is being processed. When a child process terminates, the
12359 daemon decrements its copy of the variable.
12360
12361 .vitem "&$sn0$& &-- &$sn9$&"
12362 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12363 that were current at the end of the system filter file. This allows a system
12364 filter file to set values that can be tested in users' filter files. For
12365 example, a system filter could set a value indicating how likely it is that a
12366 message is junk mail.
12367
12368 .vitem &$spam_$&&'xxx'&
12369 A number of variables whose names start with &$spam$& are available when Exim
12370 is compiled with the content-scanning extension. For details, see section
12371 &<<SECTscanspamass>>&.
12372
12373
12374 .vitem &$spool_directory$&
12375 .vindex "&$spool_directory$&"
12376 The name of Exim's spool directory.
12377
12378 .vitem &$spool_inodes$&
12379 .vindex "&$spool_inodes$&"
12380 The number of free inodes in the disk partition where Exim's spool files are
12381 being written. The value is recalculated whenever the variable is referenced.
12382 If the relevant file system does not have the concept of inodes, the value of
12383 is -1. See also the &%check_spool_inodes%& option.
12384
12385 .vitem &$spool_space$&
12386 .vindex "&$spool_space$&"
12387 The amount of free space (as a number of kilobytes) in the disk partition where
12388 Exim's spool files are being written. The value is recalculated whenever the
12389 variable is referenced. If the operating system does not have the ability to
12390 find the amount of free space (only true for experimental systems), the space
12391 value is -1. For example, to check in an ACL that there is at least 50
12392 megabytes free on the spool, you could write:
12393 .code
12394 condition = ${if > {$spool_space}{50000}}
12395 .endd
12396 See also the &%check_spool_space%& option.
12397
12398
12399 .vitem &$thisaddress$&
12400 .vindex "&$thisaddress$&"
12401 This variable is set only during the processing of the &%foranyaddress%&
12402 command in a filter file. Its use is explained in the description of that
12403 command, which can be found in the separate document entitled &'Exim's
12404 interfaces to mail filtering'&.
12405
12406 .vitem &$tls_in_bits$&
12407 .vindex "&$tls_in_bits$&"
12408 Contains an approximation of the TLS cipher's bit-strength
12409 on the inbound connection; the meaning of
12410 this depends upon the TLS implementation used.
12411 If TLS has not been negotiated, the value will be 0.
12412 The value of this is automatically fed into the Cyrus SASL authenticator
12413 when acting as a server, to specify the "external SSF" (a SASL term).
12414
12415 The deprecated &$tls_bits$& variable refers to the inbound side
12416 except when used in the context of an outbound SMTP delivery, when it refers to
12417 the outbound.
12418
12419 .vitem &$tls_out_bits$&
12420 .vindex "&$tls_out_bits$&"
12421 Contains an approximation of the TLS cipher's bit-strength
12422 on an outbound SMTP connection; the meaning of
12423 this depends upon the TLS implementation used.
12424 If TLS has not been negotiated, the value will be 0.
12425
12426 .vitem &$tls_in_ourcert$&
12427 .vindex "&$tls_in_ourcert$&"
12428 This variable refers to the certificate presented to the peer of an
12429 inbound connection when the message was received.
12430 It is only useful as the argument of a
12431 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12432 or a &%def%& condition.
12433
12434 .vitem &$tls_in_peercert$&
12435 .vindex "&$tls_in_peercert$&"
12436 This variable refers to the certificate presented by the peer of an
12437 inbound connection when the message was received.
12438 It is only useful as the argument of a
12439 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12440 or a &%def%& condition.
12441
12442 .vitem &$tls_out_ourcert$&
12443 .vindex "&$tls_out_ourcert$&"
12444 This variable refers to the certificate presented to the peer of an
12445 outbound connection.  It is only useful as the argument of a
12446 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12447 or a &%def%& condition.
12448
12449 .vitem &$tls_out_peercert$&
12450 .vindex "&$tls_out_peercert$&"
12451 This variable refers to the certificate presented by the peer of an
12452 outbound connection.  It is only useful as the argument of a
12453 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12454 or a &%def%& condition.
12455
12456 .vitem &$tls_in_certificate_verified$&
12457 .vindex "&$tls_in_certificate_verified$&"
12458 This variable is set to &"1"& if a TLS certificate was verified when the
12459 message was received, and &"0"& otherwise.
12460
12461 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12462 except when used in the context of an outbound SMTP delivery, when it refers to
12463 the outbound.
12464
12465 .vitem &$tls_out_certificate_verified$&
12466 .vindex "&$tls_out_certificate_verified$&"
12467 This variable is set to &"1"& if a TLS certificate was verified when an
12468 outbound SMTP connection was made,
12469 and &"0"& otherwise.
12470
12471 .vitem &$tls_in_cipher$&
12472 .vindex "&$tls_in_cipher$&"
12473 .vindex "&$tls_cipher$&"
12474 When a message is received from a remote host over an encrypted SMTP
12475 connection, this variable is set to the cipher suite that was negotiated, for
12476 example DES-CBC3-SHA. In other circumstances, in particular, for message
12477 received over unencrypted connections, the variable is empty. Testing
12478 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12479 non-encrypted connections during ACL processing.
12480
12481 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12482 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12483 becomes the same as &$tls_out_cipher$&.
12484
12485 .vitem &$tls_out_cipher$&
12486 .vindex "&$tls_out_cipher$&"
12487 This variable is
12488 cleared before any outgoing SMTP connection is made,
12489 and then set to the outgoing cipher suite if one is negotiated. See chapter
12490 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12491 details of the &(smtp)& transport.
12492
12493 .vitem &$tls_in_ocsp$&
12494 .vindex "&$tls_in_ocsp$&"
12495 When a message is received from a remote client connection
12496 the result of any OCSP request from the client is encoded in this variable:
12497 .code
12498 0 OCSP proof was not requested (default value)
12499 1 No response to request
12500 2 Response not verified
12501 3 Verification failed
12502 4 Verification succeeded
12503 .endd
12504
12505 .vitem &$tls_out_ocsp$&
12506 .vindex "&$tls_out_ocsp$&"
12507 When a message is sent to a remote host connection
12508 the result of any OCSP request made is encoded in this variable.
12509 See &$tls_in_ocsp$& for values.
12510
12511 .vitem &$tls_in_peerdn$&
12512 .vindex "&$tls_in_peerdn$&"
12513 .vindex "&$tls_peerdn$&"
12514 When a message is received from a remote host over an encrypted SMTP
12515 connection, and Exim is configured to request a certificate from the client,
12516 the value of the Distinguished Name of the certificate is made available in the
12517 &$tls_in_peerdn$& during subsequent processing.
12518
12519 The deprecated &$tls_peerdn$& variable refers to the inbound side
12520 except when used in the context of an outbound SMTP delivery, when it refers to
12521 the outbound.
12522
12523 .vitem &$tls_out_peerdn$&
12524 .vindex "&$tls_out_peerdn$&"
12525 When a message is being delivered to a remote host over an encrypted SMTP
12526 connection, and Exim is configured to request a certificate from the server,
12527 the value of the Distinguished Name of the certificate is made available in the
12528 &$tls_out_peerdn$& during subsequent processing.
12529
12530 .vitem &$tls_in_sni$&
12531 .vindex "&$tls_in_sni$&"
12532 .vindex "&$tls_sni$&"
12533 .cindex "TLS" "Server Name Indication"
12534 When a TLS session is being established, if the client sends the Server
12535 Name Indication extension, the value will be placed in this variable.
12536 If the variable appears in &%tls_certificate%& then this option and
12537 some others, described in &<<SECTtlssni>>&,
12538 will be re-expanded early in the TLS session, to permit
12539 a different certificate to be presented (and optionally a different key to be
12540 used) to the client, based upon the value of the SNI extension.
12541
12542 The deprecated &$tls_sni$& variable refers to the inbound side
12543 except when used in the context of an outbound SMTP delivery, when it refers to
12544 the outbound.
12545
12546 .vitem &$tls_out_sni$&
12547 .vindex "&$tls_out_sni$&"
12548 .cindex "TLS" "Server Name Indication"
12549 During outbound
12550 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12551 the transport.
12552
12553 .vitem &$tod_bsdinbox$&
12554 .vindex "&$tod_bsdinbox$&"
12555 The time of day and the date, in the format required for BSD-style mailbox
12556 files, for example: Thu Oct 17 17:14:09 1995.
12557
12558 .vitem &$tod_epoch$&
12559 .vindex "&$tod_epoch$&"
12560 The time and date as a number of seconds since the start of the Unix epoch.
12561
12562 .vitem &$tod_epoch_l$&
12563 .vindex "&$tod_epoch_l$&"
12564 The time and date as a number of microseconds since the start of the Unix epoch.
12565
12566 .vitem &$tod_full$&
12567 .vindex "&$tod_full$&"
12568 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12569 +0100. The timezone is always given as a numerical offset from UTC, with
12570 positive values used for timezones that are ahead (east) of UTC, and negative
12571 values for those that are behind (west).
12572
12573 .vitem &$tod_log$&
12574 .vindex "&$tod_log$&"
12575 The time and date in the format used for writing Exim's log files, for example:
12576 1995-10-12 15:32:29, but without a timezone.
12577
12578 .vitem &$tod_logfile$&
12579 .vindex "&$tod_logfile$&"
12580 This variable contains the date in the format yyyymmdd. This is the format that
12581 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12582 flag.
12583
12584 .vitem &$tod_zone$&
12585 .vindex "&$tod_zone$&"
12586 This variable contains the numerical value of the local timezone, for example:
12587 -0500.
12588
12589 .vitem &$tod_zulu$&
12590 .vindex "&$tod_zulu$&"
12591 This variable contains the UTC date and time in &"Zulu"& format, as specified
12592 by ISO 8601, for example: 20030221154023Z.
12593
12594 .vitem &$transport_name$&
12595 .cindex "transport" "name"
12596 .cindex "name" "of transport"
12597 .vindex "&$transport_name$&"
12598 During the running of a transport, this variable contains its name.
12599
12600 .vitem &$value$&
12601 .vindex "&$value$&"
12602 This variable contains the result of an expansion lookup, extraction operation,
12603 or external command, as described above. It is also used during a
12604 &*reduce*& expansion.
12605
12606 .vitem &$verify_mode$&
12607 .vindex "&$verify_mode$&"
12608 While a router or transport is being run in verify mode
12609 or for cutthrough delivery,
12610 contains "S" for sender-verification or "R" for recipient-verification.
12611 Otherwise, empty.
12612
12613 .vitem &$version_number$&
12614 .vindex "&$version_number$&"
12615 The version number of Exim.
12616
12617 .vitem &$warn_message_delay$&
12618 .vindex "&$warn_message_delay$&"
12619 This variable is set only during the creation of a message warning about a
12620 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12621
12622 .vitem &$warn_message_recipients$&
12623 .vindex "&$warn_message_recipients$&"
12624 This variable is set only during the creation of a message warning about a
12625 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12626 .endlist
12627 .ecindex IIDstrexp
12628
12629
12630
12631 . ////////////////////////////////////////////////////////////////////////////
12632 . ////////////////////////////////////////////////////////////////////////////
12633
12634 .chapter "Embedded Perl" "CHAPperl"
12635 .scindex IIDperl "Perl" "calling from Exim"
12636 Exim can be built to include an embedded Perl interpreter. When this is done,
12637 Perl subroutines can be called as part of the string expansion process. To make
12638 use of the Perl support, you need version 5.004 or later of Perl installed on
12639 your system. To include the embedded interpreter in the Exim binary, include
12640 the line
12641 .code
12642 EXIM_PERL = perl.o
12643 .endd
12644 in your &_Local/Makefile_& and then build Exim in the normal way.
12645
12646
12647 .section "Setting up so Perl can be used" "SECID85"
12648 .oindex "&%perl_startup%&"
12649 Access to Perl subroutines is via a global configuration option called
12650 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12651 no &%perl_startup%& option in the Exim configuration file then no Perl
12652 interpreter is started and there is almost no overhead for Exim (since none of
12653 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12654 option then the associated value is taken to be Perl code which is executed in
12655 a newly created Perl interpreter.
12656
12657 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12658 need backslashes before any characters to escape special meanings. The option
12659 should usually be something like
12660 .code
12661 perl_startup = do '/etc/exim.pl'
12662 .endd
12663 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12664 use from Exim. Exim can be configured either to start up a Perl interpreter as
12665 soon as it is entered, or to wait until the first time it is needed. Starting
12666 the interpreter at the beginning ensures that it is done while Exim still has
12667 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12668 fact used in a particular run. Also, note that this does not mean that Exim is
12669 necessarily running as root when Perl is called at a later time. By default,
12670 the interpreter is started only when it is needed, but this can be changed in
12671 two ways:
12672
12673 .ilist
12674 .oindex "&%perl_at_start%&"
12675 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12676 a startup when Exim is entered.
12677 .next
12678 The command line option &%-ps%& also requests a startup when Exim is entered,
12679 overriding the setting of &%perl_at_start%&.
12680 .endlist
12681
12682 There is also a command line option &%-pd%& (for delay) which suppresses the
12683 initial startup, even if &%perl_at_start%& is set.
12684
12685
12686 .section "Calling Perl subroutines" "SECID86"
12687 When the configuration file includes a &%perl_startup%& option you can make use
12688 of the string expansion item to call the Perl subroutines that are defined
12689 by the &%perl_startup%& code. The operator is used in any of the following
12690 forms:
12691 .code
12692 ${perl{foo}}
12693 ${perl{foo}{argument}}
12694 ${perl{foo}{argument1}{argument2} ... }
12695 .endd
12696 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12697 arguments may be passed. Passing more than this results in an expansion failure
12698 with an error message of the form
12699 .code
12700 Too many arguments passed to Perl subroutine "foo" (max is 8)
12701 .endd
12702 The return value of the Perl subroutine is evaluated in a scalar context before
12703 it is passed back to Exim to be inserted into the expanded string. If the
12704 return value is &'undef'&, the expansion is forced to fail in the same way as
12705 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12706 by obeying Perl's &%die%& function, the expansion fails with the error message
12707 that was passed to &%die%&.
12708
12709
12710 .section "Calling Exim functions from Perl" "SECID87"
12711 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12712 is available to call back into Exim's string expansion function. For example,
12713 the Perl code
12714 .code
12715 my $lp = Exim::expand_string('$local_part');
12716 .endd
12717 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12718 Note those are single quotes and not double quotes to protect against
12719 &$local_part$& being interpolated as a Perl variable.
12720
12721 If the string expansion is forced to fail by a &"fail"& item, the result of
12722 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12723 expansion string, the Perl call from the original expansion string fails with
12724 an appropriate error message, in the same way as if &%die%& were used.
12725
12726 .cindex "debugging" "from embedded Perl"
12727 .cindex "log" "writing from embedded Perl"
12728 Two other Exim functions are available for use from within Perl code.
12729 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12730 debugging is enabled. If you want a newline at the end, you must supply it.
12731 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12732 timestamp. In this case, you should not supply a terminating newline.
12733
12734
12735 .section "Use of standard output and error by Perl" "SECID88"
12736 .cindex "Perl" "standard output and error"
12737 You should not write to the standard error or output streams from within your
12738 Perl code, as it is not defined how these are set up. In versions of Exim
12739 before 4.50, it is possible for the standard output or error to refer to the
12740 SMTP connection during message reception via the daemon. Writing to this stream
12741 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12742 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12743 avoided, but the output is lost.
12744
12745 .cindex "Perl" "use of &%warn%&"
12746 The Perl &%warn%& statement writes to the standard error stream by default.
12747 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12748 you have no control. When Exim starts up the Perl interpreter, it arranges for
12749 output from the &%warn%& statement to be written to the Exim main log. You can
12750 change this by including appropriate Perl magic somewhere in your Perl code.
12751 For example, to discard &%warn%& output completely, you need this:
12752 .code
12753 $SIG{__WARN__} = sub { };
12754 .endd
12755 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12756 example, the code for the subroutine is empty, so it does nothing, but you can
12757 include any Perl code that you like. The text of the &%warn%& message is passed
12758 as the first subroutine argument.
12759 .ecindex IIDperl
12760
12761
12762 . ////////////////////////////////////////////////////////////////////////////
12763 . ////////////////////////////////////////////////////////////////////////////
12764
12765 .chapter "Starting the daemon and the use of network interfaces" &&&
12766          "CHAPinterfaces" &&&
12767          "Starting the daemon"
12768 .cindex "daemon" "starting"
12769 .cindex "interface" "listening"
12770 .cindex "network interface"
12771 .cindex "interface" "network"
12772 .cindex "IP address" "for listening"
12773 .cindex "daemon" "listening IP addresses"
12774 .cindex "TCP/IP" "setting listening interfaces"
12775 .cindex "TCP/IP" "setting listening ports"
12776 A host that is connected to a TCP/IP network may have one or more physical
12777 hardware network interfaces. Each of these interfaces may be configured as one
12778 or more &"logical"& interfaces, which are the entities that a program actually
12779 works with. Each of these logical interfaces is associated with an IP address.
12780 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12781 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12782 knowledge about the host's interfaces for use in three different circumstances:
12783
12784 .olist
12785 When a listening daemon is started, Exim needs to know which interfaces
12786 and ports to listen on.
12787 .next
12788 When Exim is routing an address, it needs to know which IP addresses
12789 are associated with local interfaces. This is required for the correct
12790 processing of MX lists by removing the local host and others with the
12791 same or higher priority values. Also, Exim needs to detect cases
12792 when an address is routed to an IP address that in fact belongs to the
12793 local host. Unless the &%self%& router option or the &%allow_localhost%&
12794 option of the smtp transport is set (as appropriate), this is treated
12795 as an error situation.
12796 .next
12797 When Exim connects to a remote host, it may need to know which interface to use
12798 for the outgoing connection.
12799 .endlist
12800
12801
12802 Exim's default behaviour is likely to be appropriate in the vast majority
12803 of cases. If your host has only one interface, and you want all its IP
12804 addresses to be treated in the same way, and you are using only the
12805 standard SMTP port, you should not need to take any special action. The
12806 rest of this chapter does not apply to you.
12807
12808 In a more complicated situation you may want to listen only on certain
12809 interfaces, or on different ports, and for this reason there are a number of
12810 options that can be used to influence Exim's behaviour. The rest of this
12811 chapter describes how they operate.
12812
12813 When a message is received over TCP/IP, the interface and port that were
12814 actually used are set in &$received_ip_address$& and &$received_port$&.
12815
12816
12817
12818 .section "Starting a listening daemon" "SECID89"
12819 When a listening daemon is started (by means of the &%-bd%& command line
12820 option), the interfaces and ports on which it listens are controlled by the
12821 following options:
12822
12823 .ilist
12824 &%daemon_smtp_ports%& contains a list of default ports
12825 or service names.
12826 (For backward compatibility, this option can also be specified in the singular.)
12827 .next
12828 &%local_interfaces%& contains list of interface IP addresses on which to
12829 listen. Each item may optionally also specify a port.
12830 .endlist
12831
12832 The default list separator in both cases is a colon, but this can be changed as
12833 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12834 it is usually best to change the separator to avoid having to double all the
12835 colons. For example:
12836 .code
12837 local_interfaces = <; 127.0.0.1 ; \
12838                       192.168.23.65 ; \
12839                       ::1 ; \
12840                       3ffe:ffff:836f::fe86:a061
12841 .endd
12842 There are two different formats for specifying a port along with an IP address
12843 in &%local_interfaces%&:
12844
12845 .olist
12846 The port is added onto the address with a dot separator. For example, to listen
12847 on port 1234 on two different IP addresses:
12848 .code
12849 local_interfaces = <; 192.168.23.65.1234 ; \
12850                       3ffe:ffff:836f::fe86:a061.1234
12851 .endd
12852 .next
12853 The IP address is enclosed in square brackets, and the port is added
12854 with a colon separator, for example:
12855 .code
12856 local_interfaces = <; [192.168.23.65]:1234 ; \
12857                       [3ffe:ffff:836f::fe86:a061]:1234
12858 .endd
12859 .endlist
12860
12861 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12862 default setting contains just one port:
12863 .code
12864 daemon_smtp_ports = smtp
12865 .endd
12866 If more than one port is listed, each interface that does not have its own port
12867 specified listens on all of them. Ports that are listed in
12868 &%daemon_smtp_ports%& can be identified either by name (defined in
12869 &_/etc/services_&) or by number. However, when ports are given with individual
12870 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12871
12872
12873
12874 .section "Special IP listening addresses" "SECID90"
12875 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12876 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12877 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12878 instead of setting up separate listening sockets for each interface. The
12879 default value of &%local_interfaces%& is
12880 .code
12881 local_interfaces = 0.0.0.0
12882 .endd
12883 when Exim is built without IPv6 support; otherwise it is:
12884 .code
12885 local_interfaces = <; ::0 ; 0.0.0.0
12886 .endd
12887 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12888
12889
12890
12891 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12892 The &%-oX%& command line option can be used to override the values of
12893 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12894 instance. Another way of doing this would be to use macros and the &%-D%&
12895 option. However, &%-oX%& can be used by any admin user, whereas modification of
12896 the runtime configuration by &%-D%& is allowed only when the caller is root or
12897 exim.
12898
12899 The value of &%-oX%& is a list of items. The default colon separator can be
12900 changed in the usual way if required. If there are any items that do not
12901 contain dots or colons (that is, are not IP addresses), the value of
12902 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12903 items that do contain dots or colons, the value of &%local_interfaces%& is
12904 replaced by those items. Thus, for example,
12905 .code
12906 -oX 1225
12907 .endd
12908 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12909 whereas
12910 .code
12911 -oX 192.168.34.5.1125
12912 .endd
12913 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12914 (However, since &%local_interfaces%& now contains no items without ports, the
12915 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12916
12917
12918
12919 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12920 .cindex "ssmtp protocol"
12921 .cindex "smtps protocol"
12922 .cindex "SMTP" "ssmtp protocol"
12923 .cindex "SMTP" "smtps protocol"
12924 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12925 before the STARTTLS command was standardized for SMTP. Some legacy clients
12926 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12927 list of port numbers or service names,
12928 connections to those ports must use SSMTP. The most
12929 common use of this option is expected to be
12930 .code
12931 tls_on_connect_ports = 465
12932 .endd
12933 because 465 is the usual port number used by the legacy clients. There is also
12934 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12935 this way when a daemon is started.
12936
12937 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12938 daemon to listen on those ports. You must still specify them in
12939 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12940 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12941 connections via the daemon.)
12942
12943
12944
12945
12946 .section "IPv6 address scopes" "SECID92"
12947 .cindex "IPv6" "address scopes"
12948 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12949 can, in principle, have the same link-local IPv6 address on different
12950 interfaces. Thus, additional information is needed, over and above the IP
12951 address, to distinguish individual interfaces. A convention of using a
12952 percent sign followed by something (often the interface name) has been
12953 adopted in some cases, leading to addresses like this:
12954 .code
12955 fe80::202:b3ff:fe03:45c1%eth0
12956 .endd
12957 To accommodate this usage, a percent sign followed by an arbitrary string is
12958 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12959 to convert a textual IPv6 address for actual use. This function recognizes the
12960 percent convention in operating systems that support it, and it processes the
12961 address appropriately. Unfortunately, some older libraries have problems with
12962 &[getaddrinfo()]&. If
12963 .code
12964 IPV6_USE_INET_PTON=yes
12965 .endd
12966 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12967 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12968 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12969 function.) Of course, this means that the additional functionality of
12970 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12971
12972 .section "Disabling IPv6" "SECID93"
12973 .cindex "IPv6" "disabling"
12974 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12975 run on a host whose kernel does not support IPv6. The binary will fall back to
12976 using IPv4, but it may waste resources looking up AAAA records, and trying to
12977 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12978 .oindex "&%disable_ipv6%&"
12979 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12980 activities take place. AAAA records are never looked up, and any IPv6 addresses
12981 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12982 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12983 to handle IPv6 literal addresses.
12984
12985 On the other hand, when IPv6 is in use, there may be times when you want to
12986 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12987 option to globally suppress the lookup of AAAA records for specified domains,
12988 and you can use the &%ignore_target_hosts%& generic router option to ignore
12989 IPv6 addresses in an individual router.
12990
12991
12992
12993 .section "Examples of starting a listening daemon" "SECID94"
12994 The default case in an IPv6 environment is
12995 .code
12996 daemon_smtp_ports = smtp
12997 local_interfaces = <; ::0 ; 0.0.0.0
12998 .endd
12999 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13000 Either one or two sockets may be used, depending on the characteristics of
13001 the TCP/IP stack. (This is complicated and messy; for more information,
13002 read the comments in the &_daemon.c_& source file.)
13003
13004 To specify listening on ports 25 and 26 on all interfaces:
13005 .code
13006 daemon_smtp_ports = 25 : 26
13007 .endd
13008 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13009 .code
13010 local_interfaces = <; ::0.25     ; ::0.26 \
13011                       0.0.0.0.25 ; 0.0.0.0.26
13012 .endd
13013 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13014 IPv4 loopback address only:
13015 .code
13016 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13017 .endd
13018 To specify listening on the default port on specific interfaces only:
13019 .code
13020 local_interfaces = 10.0.0.67 : 192.168.34.67
13021 .endd
13022 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13023
13024
13025
13026 .section "Recognizing the local host" "SECTreclocipadd"
13027 The &%local_interfaces%& option is also used when Exim needs to determine
13028 whether or not an IP address refers to the local host. That is, the IP
13029 addresses of all the interfaces on which a daemon is listening are always
13030 treated as local.
13031
13032 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13033 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13034 available interfaces from the operating system, and extracts the relevant
13035 (that is, IPv4 or IPv6) addresses to use for checking.
13036
13037 Some systems set up large numbers of virtual interfaces in order to provide
13038 many virtual web servers. In this situation, you may want to listen for
13039 email on only a few of the available interfaces, but nevertheless treat all
13040 interfaces as local when routing. You can do this by setting
13041 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13042 &"all"& wildcard values. These addresses are recognized as local, but are not
13043 used for listening. Consider this example:
13044 .code
13045 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13046                       192.168.53.235 ; \
13047                       3ffe:2101:12:1:a00:20ff:fe86:a061
13048
13049 extra_local_interfaces = <; ::0 ; 0.0.0.0
13050 .endd
13051 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13052 address, but all available interface addresses are treated as local when
13053 Exim is routing.
13054
13055 In some environments the local host name may be in an MX list, but with an IP
13056 address that is not assigned to any local interface. In other cases it may be
13057 desirable to treat other host names as if they referred to the local host. Both
13058 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13059 This contains host names rather than IP addresses. When a host is referenced
13060 during routing, either via an MX record or directly, it is treated as the local
13061 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13062 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13063
13064
13065
13066 .section "Delivering to a remote host" "SECID95"
13067 Delivery to a remote host is handled by the smtp transport. By default, it
13068 allows the system's TCP/IP functions to choose which interface to use (if
13069 there is more than one) when connecting to a remote host. However, the
13070 &%interface%& option can be set to specify which interface is used. See the
13071 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13072 details.
13073
13074
13075
13076
13077 . ////////////////////////////////////////////////////////////////////////////
13078 . ////////////////////////////////////////////////////////////////////////////
13079
13080 .chapter "Main configuration" "CHAPmainconfig"
13081 .scindex IIDconfima "configuration file" "main section"
13082 .scindex IIDmaiconf "main configuration"
13083 The first part of the run time configuration file contains three types of item:
13084
13085 .ilist
13086 Macro definitions: These lines start with an upper case letter. See section
13087 &<<SECTmacrodefs>>& for details of macro processing.
13088 .next
13089 Named list definitions: These lines start with one of the words &"domainlist"&,
13090 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13091 section &<<SECTnamedlists>>&.
13092 .next
13093 Main configuration settings: Each setting occupies one line of the file
13094 (with possible continuations). If any setting is preceded by the word
13095 &"hide"&, the &%-bP%& command line option displays its value to admin users
13096 only. See section &<<SECTcos>>& for a description of the syntax of these option
13097 settings.
13098 .endlist
13099
13100 This chapter specifies all the main configuration options, along with their
13101 types and default values. For ease of finding a particular option, they appear
13102 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13103 are now so many options, they are first listed briefly in functional groups, as
13104 an aid to finding the name of the option you are looking for. Some options are
13105 listed in more than one group.
13106
13107 .section "Miscellaneous" "SECID96"
13108 .table2
13109 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13110 .row &%disable_ipv6%&                "do no IPv6 processing"
13111 .row &%keep_malformed%&              "for broken files &-- should not happen"
13112 .row &%localhost_number%&            "for unique message ids in clusters"
13113 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13114 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13115 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13116 .row &%print_topbitchars%&           "top-bit characters are printing"
13117 .row &%timezone%&                    "force time zone"
13118 .endtable
13119
13120
13121 .section "Exim parameters" "SECID97"
13122 .table2
13123 .row &%exim_group%&                  "override compiled-in value"
13124 .row &%exim_path%&                   "override compiled-in value"
13125 .row &%exim_user%&                   "override compiled-in value"
13126 .row &%primary_hostname%&            "default from &[uname()]&"
13127 .row &%split_spool_directory%&       "use multiple directories"
13128 .row &%spool_directory%&             "override compiled-in value"
13129 .endtable
13130
13131
13132
13133 .section "Privilege controls" "SECID98"
13134 .table2
13135 .row &%admin_groups%&                "groups that are Exim admin users"
13136 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13137 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13138 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13139 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13140 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13141 .row &%never_users%&                 "do not run deliveries as these"
13142 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13143 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13144 .row &%trusted_groups%&              "groups that are trusted"
13145 .row &%trusted_users%&               "users that are trusted"
13146 .endtable
13147
13148
13149
13150 .section "Logging" "SECID99"
13151 .table2
13152 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13153 .row &%log_file_path%&               "override compiled-in value"
13154 .row &%log_selector%&                "set/unset optional logging"
13155 .row &%log_timezone%&                "add timezone to log lines"
13156 .row &%message_logs%&                "create per-message logs"
13157 .row &%preserve_message_logs%&       "after message completion"
13158 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13159 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13160 .row &%syslog_facility%&             "set syslog &""facility""& field"
13161 .row &%syslog_processname%&          "set syslog &""ident""& field"
13162 .row &%syslog_timestamp%&            "timestamp syslog lines"
13163 .row &%write_rejectlog%&             "control use of message log"
13164 .endtable
13165
13166
13167
13168 .section "Frozen messages" "SECID100"
13169 .table2
13170 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13171 .row &%freeze_tell%&                 "send message when freezing"
13172 .row &%move_frozen_messages%&        "to another directory"
13173 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13174 .endtable
13175
13176
13177
13178 .section "Data lookups" "SECID101"
13179 .table2
13180 .row &%ibase_servers%&               "InterBase servers"
13181 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13182 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13183 .row &%ldap_cert_file%&              "client cert file for LDAP"
13184 .row &%ldap_cert_key%&               "client key file for LDAP"
13185 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13186 .row &%ldap_default_servers%&        "used if no server in query"
13187 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13188 .row &%ldap_start_tls%&              "require TLS within LDAP"
13189 .row &%ldap_version%&                "set protocol version"
13190 .row &%lookup_open_max%&             "lookup files held open"
13191 .row &%mysql_servers%&               "default MySQL servers"
13192 .row &%oracle_servers%&              "Oracle servers"
13193 .row &%pgsql_servers%&               "default PostgreSQL servers"
13194 .row &%sqlite_lock_timeout%&         "as it says"
13195 .endtable
13196
13197
13198
13199 .section "Message ids" "SECID102"
13200 .table2
13201 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13202 .row &%message_id_header_text%&      "ditto"
13203 .endtable
13204
13205
13206
13207 .section "Embedded Perl Startup" "SECID103"
13208 .table2
13209 .row &%perl_at_start%&               "always start the interpreter"
13210 .row &%perl_startup%&                "code to obey when starting Perl"
13211 .endtable
13212
13213
13214
13215 .section "Daemon" "SECID104"
13216 .table2
13217 .row &%daemon_smtp_ports%&           "default ports"
13218 .row &%daemon_startup_retries%&      "number of times to retry"
13219 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13220 .row &%extra_local_interfaces%&      "not necessarily listened on"
13221 .row &%local_interfaces%&            "on which to listen, with optional ports"
13222 .row &%pid_file_path%&               "override compiled-in value"
13223 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13224 .endtable
13225
13226
13227
13228 .section "Resource control" "SECID105"
13229 .table2
13230 .row &%check_log_inodes%&            "before accepting a message"
13231 .row &%check_log_space%&             "before accepting a message"
13232 .row &%check_spool_inodes%&          "before accepting a message"
13233 .row &%check_spool_space%&           "before accepting a message"
13234 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13235 .row &%queue_only_load%&             "queue incoming if load high"
13236 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13237 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13238 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13239 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13240 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13241 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13242 .row &%smtp_accept_max_per_connection%& "messages per connection"
13243 .row &%smtp_accept_max_per_host%&    "connections from one host"
13244 .row &%smtp_accept_queue%&           "queue mail if more connections"
13245 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13246                                            connection"
13247 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13248 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13249 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13250 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13251 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13252 .endtable
13253
13254
13255
13256 .section "Policy controls" "SECID106"
13257 .table2
13258 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13259 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13260 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13261 .row &%acl_smtp_auth%&               "ACL for AUTH"
13262 .row &%acl_smtp_connect%&            "ACL for connection"
13263 .row &%acl_smtp_data%&               "ACL for DATA"
13264 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13265 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13266 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13267 .row &%acl_smtp_expn%&               "ACL for EXPN"
13268 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13269 .row &%acl_smtp_mail%&               "ACL for MAIL"
13270 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13271 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13272 .row &%acl_smtp_predata%&            "ACL for start of data"
13273 .row &%acl_smtp_quit%&               "ACL for QUIT"
13274 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13275 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13276 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13277 .row &%av_scanner%&                  "specify virus scanner"
13278 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13279                                       words""&"
13280 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13281 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13282 .row &%header_maxsize%&              "total size of message header"
13283 .row &%header_line_maxsize%&         "individual header line limit"
13284 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13285 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13286 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13287 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13288 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13289 .row &%host_lookup%&                 "host name looked up for these hosts"
13290 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13291 .row &%host_reject_connection%&      "reject connection from these hosts"
13292 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13293 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13294 .row &%message_size_limit%&          "for all messages"
13295 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13296 .row &%spamd_address%&               "set interface to SpamAssassin"
13297 .row &%strict_acl_vars%&             "object to unset ACL variables"
13298 .endtable
13299
13300
13301
13302 .section "Callout cache" "SECID107"
13303 .table2
13304 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13305                                          item"
13306 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13307                                          item"
13308 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13309 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13310 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13311 .endtable
13312
13313
13314
13315 .section "TLS" "SECID108"
13316 .table2
13317 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13318 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13319 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13320 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13321 .row &%tls_certificate%&             "location of server certificate"
13322 .row &%tls_crl%&                     "certificate revocation list"
13323 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13324 .row &%tls_dhparam%&                 "DH parameters for server"
13325 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13326 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13327 .row &%tls_privatekey%&              "location of server private key"
13328 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13329 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13330 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13331 .row &%tls_verify_certificates%&     "expected client certificates"
13332 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13333 .endtable
13334
13335
13336
13337 .section "Local user handling" "SECID109"
13338 .table2
13339 .row &%finduser_retries%&            "useful in NIS environments"
13340 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13341 .row &%gecos_pattern%&               "ditto"
13342 .row &%max_username_length%&         "for systems that truncate"
13343 .row &%unknown_login%&               "used when no login name found"
13344 .row &%unknown_username%&            "ditto"
13345 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13346 .row &%uucp_from_sender%&            "ditto"
13347 .endtable
13348
13349
13350
13351 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13352 .table2
13353 .row &%header_maxsize%&              "total size of message header"
13354 .row &%header_line_maxsize%&         "individual header line limit"
13355 .row &%message_size_limit%&          "applies to all messages"
13356 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13357 .row &%received_header_text%&        "expanded to make &'Received:'&"
13358 .row &%received_headers_max%&        "for mail loop detection"
13359 .row &%recipients_max%&              "limit per message"
13360 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13361 .endtable
13362
13363
13364
13365
13366 .section "Non-SMTP incoming messages" "SECID111"
13367 .table2
13368 .row &%receive_timeout%&             "for non-SMTP messages"
13369 .endtable
13370
13371
13372
13373
13374
13375 .section "Incoming SMTP messages" "SECID112"
13376 See also the &'Policy controls'& section above.
13377
13378 .table2
13379 .row &%host_lookup%&                 "host name looked up for these hosts"
13380 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13381 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13382 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13383 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13384 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13385 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13386 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13387 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13388 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13389 .row &%smtp_accept_max_per_connection%& "messages per connection"
13390 .row &%smtp_accept_max_per_host%&    "connections from one host"
13391 .row &%smtp_accept_queue%&           "queue mail if more connections"
13392 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13393                                            connection"
13394 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13395 .row &%smtp_active_hostname%&        "host name to use in messages"
13396 .row &%smtp_banner%&                 "text for welcome banner"
13397 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13398 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13399 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13400 .row &%smtp_etrn_command%&           "what to run for ETRN"
13401 .row &%smtp_etrn_serialize%&         "only one at once"
13402 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13403 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13404 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13405 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13406 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13407 .row &%smtp_receive_timeout%&        "per command or data line"
13408 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13409 .row &%smtp_return_error_details%&   "give detail on rejections"
13410 .endtable
13411
13412
13413
13414 .section "SMTP extensions" "SECID113"
13415 .table2
13416 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13417 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13418 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13419 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13420 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13421 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13422 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13423 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13424 .endtable
13425
13426
13427
13428 .section "Processing messages" "SECID114"
13429 .table2
13430 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13431 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13432 .row &%allow_utf8_domains%&          "in addresses"
13433 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13434                                       words""&"
13435 .row &%delivery_date_remove%&        "from incoming messages"
13436 .row &%envelope_to_remove%&          "from incoming messages"
13437 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13438 .row &%headers_charset%&             "default for translations"
13439 .row &%qualify_domain%&              "default for senders"
13440 .row &%qualify_recipient%&           "default for recipients"
13441 .row &%return_path_remove%&          "from incoming messages"
13442 .row &%strip_excess_angle_brackets%& "in addresses"
13443 .row &%strip_trailing_dot%&          "at end of addresses"
13444 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13445 .endtable
13446
13447
13448
13449 .section "System filter" "SECID115"
13450 .table2
13451 .row &%system_filter%&               "locate system filter"
13452 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13453                                             directory"
13454 .row &%system_filter_file_transport%& "transport for delivery to a file"
13455 .row &%system_filter_group%&         "group for filter running"
13456 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13457 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13458 .row &%system_filter_user%&          "user for filter running"
13459 .endtable
13460
13461
13462
13463 .section "Routing and delivery" "SECID116"
13464 .table2
13465 .row &%disable_ipv6%&                "do no IPv6 processing"
13466 .row &%dns_again_means_nonexist%&    "for broken domains"
13467 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13468 .row &%dns_dnssec_ok%&               "parameter for resolver"
13469 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13470 .row &%dns_retrans%&                 "parameter for resolver"
13471 .row &%dns_retry%&                   "parameter for resolver"
13472 .row &%dns_use_edns0%&               "parameter for resolver"
13473 .row &%hold_domains%&                "hold delivery for these domains"
13474 .row &%local_interfaces%&            "for routing checks"
13475 .row &%queue_domains%&               "no immediate delivery for these"
13476 .row &%queue_only%&                  "no immediate delivery at all"
13477 .row &%queue_only_file%&             "no immediate delivery if file exists"
13478 .row &%queue_only_load%&             "no immediate delivery if load is high"
13479 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13480 .row &%queue_only_override%&         "allow command line to override"
13481 .row &%queue_run_in_order%&          "order of arrival"
13482 .row &%queue_run_max%&               "of simultaneous queue runners"
13483 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13484 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13485 .row &%remote_sort_domains%&         "order of remote deliveries"
13486 .row &%retry_data_expire%&           "timeout for retry data"
13487 .row &%retry_interval_max%&          "safety net for retry rules"
13488 .endtable
13489
13490
13491
13492 .section "Bounce and warning messages" "SECID117"
13493 .table2
13494 .row &%bounce_message_file%&         "content of bounce"
13495 .row &%bounce_message_text%&         "content of bounce"
13496 .row &%bounce_return_body%&          "include body if returning message"
13497 .row &%bounce_return_message%&       "include original message in bounce"
13498 .row &%bounce_return_size_limit%&    "limit on returned message"
13499 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13500 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13501 .row &%errors_copy%&                 "copy bounce messages"
13502 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13503 .row &%delay_warning%&               "time schedule"
13504 .row &%delay_warning_condition%&     "condition for warning messages"
13505 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13506 .row &%smtp_return_error_details%&   "give detail on rejections"
13507 .row &%warn_message_file%&           "content of warning message"
13508 .endtable
13509
13510
13511
13512 .section "Alphabetical list of main options" "SECTalomo"
13513 Those options that undergo string expansion before use are marked with
13514 &dagger;.
13515
13516 .option accept_8bitmime main boolean true
13517 .cindex "8BITMIME"
13518 .cindex "8-bit characters"
13519 .cindex "log" "selectors"
13520 .cindex "log" "8BITMIME"
13521 This option causes Exim to send 8BITMIME in its response to an SMTP
13522 EHLO command, and to accept the BODY= parameter on MAIL commands.
13523 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13524 takes no steps to do anything special with messages received by this route.
13525
13526 Historically Exim kept this option off by default, but the maintainers
13527 feel that in today's Internet, this causes more problems than it solves.
13528 It now defaults to true.
13529 A more detailed analysis of the issues is provided by Dan Bernstein:
13530 .display
13531 &url(http://cr.yp.to/smtp/8bitmime.html)
13532 .endd
13533
13534 To log received 8BITMIME status use
13535 .code
13536 log_selector = +8bitmime
13537 .endd
13538
13539 .option acl_not_smtp main string&!! unset
13540 .cindex "&ACL;" "for non-SMTP messages"
13541 .cindex "non-SMTP messages" "ACLs for"
13542 This option defines the ACL that is run when a non-SMTP message has been
13543 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13544 further details.
13545
13546 .option acl_not_smtp_mime main string&!! unset
13547 This option defines the ACL that is run for individual MIME parts of non-SMTP
13548 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13549 SMTP messages.
13550
13551 .option acl_not_smtp_start main string&!! unset
13552 .cindex "&ACL;" "at start of non-SMTP message"
13553 .cindex "non-SMTP messages" "ACLs for"
13554 This option defines the ACL that is run before Exim starts reading a
13555 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13556
13557 .option acl_smtp_auth main string&!! unset
13558 .cindex "&ACL;" "setting up for SMTP commands"
13559 .cindex "AUTH" "ACL for"
13560 This option defines the ACL that is run when an SMTP AUTH command is
13561 received. See chapter &<<CHAPACL>>& for further details.
13562
13563 .option acl_smtp_connect main string&!! unset
13564 .cindex "&ACL;" "on SMTP connection"
13565 This option defines the ACL that is run when an SMTP connection is received.
13566 See chapter &<<CHAPACL>>& for further details.
13567
13568 .option acl_smtp_data main string&!! unset
13569 .cindex "DATA" "ACL for"
13570 This option defines the ACL that is run after an SMTP DATA command has been
13571 processed and the message itself has been received, but before the final
13572 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13573
13574 .option acl_smtp_data_prdr main string&!! accept
13575 .cindex "PRDR" "ACL for"
13576 .cindex "DATA" "PRDR ACL for"
13577 .cindex "&ACL;" "PRDR-related"
13578 .cindex "&ACL;" "per-user data processing"
13579 This option defines the ACL that,
13580 if the PRDR feature has been negotiated,
13581 is run for each recipient after an SMTP DATA command has been
13582 processed and the message itself has been received, but before the
13583 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13584
13585 .option acl_smtp_etrn main string&!! unset
13586 .cindex "ETRN" "ACL for"
13587 This option defines the ACL that is run when an SMTP ETRN command is
13588 received. See chapter &<<CHAPACL>>& for further details.
13589
13590 .option acl_smtp_expn main string&!! unset
13591 .cindex "EXPN" "ACL for"
13592 This option defines the ACL that is run when an SMTP EXPN command is
13593 received. See chapter &<<CHAPACL>>& for further details.
13594
13595 .option acl_smtp_helo main string&!! unset
13596 .cindex "EHLO" "ACL for"
13597 .cindex "HELO" "ACL for"
13598 This option defines the ACL that is run when an SMTP EHLO or HELO
13599 command is received. See chapter &<<CHAPACL>>& for further details.
13600
13601
13602 .option acl_smtp_mail main string&!! unset
13603 .cindex "MAIL" "ACL for"
13604 This option defines the ACL that is run when an SMTP MAIL command is
13605 received. See chapter &<<CHAPACL>>& for further details.
13606
13607 .option acl_smtp_mailauth main string&!! unset
13608 .cindex "AUTH" "on MAIL command"
13609 This option defines the ACL that is run when there is an AUTH parameter on
13610 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13611 &<<CHAPSMTPAUTH>>& for details of authentication.
13612
13613 .option acl_smtp_mime main string&!! unset
13614 .cindex "MIME content scanning" "ACL for"
13615 This option is available when Exim is built with the content-scanning
13616 extension. It defines the ACL that is run for each MIME part in a message. See
13617 section &<<SECTscanmimepart>>& for details.
13618
13619 .option acl_smtp_predata main string&!! unset
13620 This option defines the ACL that is run when an SMTP DATA command is
13621 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13622 further details.
13623
13624 .option acl_smtp_quit main string&!! unset
13625 .cindex "QUIT, ACL for"
13626 This option defines the ACL that is run when an SMTP QUIT command is
13627 received. See chapter &<<CHAPACL>>& for further details.
13628
13629 .option acl_smtp_rcpt main string&!! unset
13630 .cindex "RCPT" "ACL for"
13631 This option defines the ACL that is run when an SMTP RCPT command is
13632 received. See chapter &<<CHAPACL>>& for further details.
13633
13634 .option acl_smtp_starttls main string&!! unset
13635 .cindex "STARTTLS, ACL for"
13636 This option defines the ACL that is run when an SMTP STARTTLS command is
13637 received. See chapter &<<CHAPACL>>& for further details.
13638
13639 .option acl_smtp_vrfy main string&!! unset
13640 .cindex "VRFY" "ACL for"
13641 This option defines the ACL that is run when an SMTP VRFY command is
13642 received. See chapter &<<CHAPACL>>& for further details.
13643
13644 .option admin_groups main "string list&!!" unset
13645 .cindex "admin user"
13646 This option is expanded just once, at the start of Exim's processing. If the
13647 current group or any of the supplementary groups of an Exim caller is in this
13648 colon-separated list, the caller has admin privileges. If all your system
13649 programmers are in a specific group, for example, you can give them all Exim
13650 admin privileges by putting that group in &%admin_groups%&. However, this does
13651 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13652 To permit this, you have to add individuals to the Exim group.
13653
13654 .option allow_domain_literals main boolean false
13655 .cindex "domain literal"
13656 If this option is set, the RFC 2822 domain literal format is permitted in
13657 email addresses. The option is not set by default, because the domain literal
13658 format is not normally required these days, and few people know about it. It
13659 has, however, been exploited by mail abusers.
13660
13661 Unfortunately, it seems that some DNS black list maintainers are using this
13662 format to report black listing to postmasters. If you want to accept messages
13663 addressed to your hosts by IP address, you need to set
13664 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13665 domains (defined in the named domain list &%local_domains%& in the default
13666 configuration). This &"magic string"& matches the domain literal form of all
13667 the local host's IP addresses.
13668
13669
13670 .option allow_mx_to_ip main boolean false
13671 .cindex "MX record" "pointing to IP address"
13672 It appears that more and more DNS zone administrators are breaking the rules
13673 and putting domain names that look like IP addresses on the right hand side of
13674 MX records. Exim follows the rules and rejects this, giving an error message
13675 that explains the mis-configuration. However, some other MTAs support this
13676 practice, so to avoid &"Why can't Exim do this?"& complaints,
13677 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13678 recommended, except when you have no other choice.
13679
13680 .option allow_utf8_domains main boolean false
13681 .cindex "domain" "UTF-8 characters in"
13682 .cindex "UTF-8" "in domain name"
13683 Lots of discussion is going on about internationalized domain names. One
13684 camp is strongly in favour of just using UTF-8 characters, and it seems
13685 that at least two other MTAs permit this. This option allows Exim users to
13686 experiment if they wish.
13687
13688 If it is set true, Exim's domain parsing function allows valid
13689 UTF-8 multicharacters to appear in domain name components, in addition to
13690 letters, digits, and hyphens. However, just setting this option is not
13691 enough; if you want to look up these domain names in the DNS, you must also
13692 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13693 suitable setting is:
13694 .code
13695 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13696   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13697 .endd
13698 Alternatively, you can just disable this feature by setting
13699 .code
13700 dns_check_names_pattern =
13701 .endd
13702 That is, set the option to an empty string so that no check is done.
13703
13704
13705 .option auth_advertise_hosts main "host list&!!" *
13706 .cindex "authentication" "advertising"
13707 .cindex "AUTH" "advertising"
13708 If any server authentication mechanisms are configured, Exim advertises them in
13709 response to an EHLO command only if the calling host matches this list.
13710 Otherwise, Exim does not advertise AUTH.
13711 Exim does not accept AUTH commands from clients to which it has not
13712 advertised the availability of AUTH. The advertising of individual
13713 authentication mechanisms can be controlled by the use of the
13714 &%server_advertise_condition%& generic authenticator option on the individual
13715 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13716
13717 Certain mail clients (for example, Netscape) require the user to provide a name
13718 and password for authentication if AUTH is advertised, even though it may
13719 not be needed (the host may accept messages from hosts on its local LAN without
13720 authentication, for example). The &%auth_advertise_hosts%& option can be used
13721 to make these clients more friendly by excluding them from the set of hosts to
13722 which Exim advertises AUTH.
13723
13724 .cindex "AUTH" "advertising when encrypted"
13725 If you want to advertise the availability of AUTH only when the connection
13726 is encrypted using TLS, you can make use of the fact that the value of this
13727 option is expanded, with a setting like this:
13728 .code
13729 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13730 .endd
13731 .vindex "&$tls_in_cipher$&"
13732 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13733 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13734 expansion is *, which matches all hosts.
13735
13736
13737 .option auto_thaw main time 0s
13738 .cindex "thawing messages"
13739 .cindex "unfreezing messages"
13740 If this option is set to a time greater than zero, a queue runner will try a
13741 new delivery attempt on any frozen message, other than a bounce message, if
13742 this much time has passed since it was frozen. This may result in the message
13743 being re-frozen if nothing has changed since the last attempt. It is a way of
13744 saying &"keep on trying, even though there are big problems"&.
13745
13746 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13747 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13748 thought to be very useful any more, and its use should probably be avoided.
13749
13750
13751 .option av_scanner main string "see below"
13752 This option is available if Exim is built with the content-scanning extension.
13753 It specifies which anti-virus scanner to use. The default value is:
13754 .code
13755 sophie:/var/run/sophie
13756 .endd
13757 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13758 before use. See section &<<SECTscanvirus>>& for further details.
13759
13760
13761 .option bi_command main string unset
13762 .oindex "&%-bi%&"
13763 This option supplies the name of a command that is run when Exim is called with
13764 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13765 just the command name, it is not a complete command line. If an argument is
13766 required, it must come from the &%-oA%& command line option.
13767
13768
13769 .option bounce_message_file main string unset
13770 .cindex "bounce message" "customizing"
13771 .cindex "customizing" "bounce message"
13772 This option defines a template file containing paragraphs of text to be used
13773 for constructing bounce messages.  Details of the file's contents are given in
13774 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13775
13776
13777 .option bounce_message_text main string unset
13778 When this option is set, its contents are included in the default bounce
13779 message immediately after &"This message was created automatically by mail
13780 delivery software."& It is not used if &%bounce_message_file%& is set.
13781
13782 .option bounce_return_body main boolean true
13783 .cindex "bounce message" "including body"
13784 This option controls whether the body of an incoming message is included in a
13785 bounce message when &%bounce_return_message%& is true. The default setting
13786 causes the entire message, both header and body, to be returned (subject to the
13787 value of &%bounce_return_size_limit%&). If this option is false, only the
13788 message header is included. In the case of a non-SMTP message containing an
13789 error that is detected during reception, only those header lines preceding the
13790 point at which the error was detected are returned.
13791 .cindex "bounce message" "including original"
13792
13793 .option bounce_return_message main boolean true
13794 If this option is set false, none of the original message is included in
13795 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13796 &%bounce_return_body%&.
13797
13798
13799 .option bounce_return_size_limit main integer 100K
13800 .cindex "size" "of bounce, limit"
13801 .cindex "bounce message" "size limit"
13802 .cindex "limit" "bounce message size"
13803 This option sets a limit in bytes on the size of messages that are returned to
13804 senders as part of bounce messages when &%bounce_return_message%& is true. The
13805 limit should be less than the value of the global &%message_size_limit%& and of
13806 any &%message_size_limit%& settings on transports, to allow for the bounce text
13807 that Exim generates. If this option is set to zero there is no limit.
13808
13809 When the body of any message that is to be included in a bounce message is
13810 greater than the limit, it is truncated, and a comment pointing this out is
13811 added at the top. The actual cutoff may be greater than the value given, owing
13812 to the use of buffering for transferring the message in chunks (typically 8K in
13813 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13814 messages.
13815
13816 .option bounce_sender_authentication main string unset
13817 .cindex "bounce message" "sender authentication"
13818 .cindex "authentication" "bounce message"
13819 .cindex "AUTH" "on bounce message"
13820 This option provides an authenticated sender address that is sent with any
13821 bounce messages generated by Exim that are sent over an authenticated SMTP
13822 connection. A typical setting might be:
13823 .code
13824 bounce_sender_authentication = mailer-daemon@my.domain.example
13825 .endd
13826 which would cause bounce messages to be sent using the SMTP command:
13827 .code
13828 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13829 .endd
13830 The value of &%bounce_sender_authentication%& must always be a complete email
13831 address.
13832
13833 .option callout_domain_negative_expire main time 3h
13834 .cindex "caching" "callout timeouts"
13835 .cindex "callout" "caching timeouts"
13836 This option specifies the expiry time for negative callout cache data for a
13837 domain. See section &<<SECTcallver>>& for details of callout verification, and
13838 section &<<SECTcallvercache>>& for details of the caching.
13839
13840
13841 .option callout_domain_positive_expire main time 7d
13842 This option specifies the expiry time for positive callout cache data for a
13843 domain. See section &<<SECTcallver>>& for details of callout verification, and
13844 section &<<SECTcallvercache>>& for details of the caching.
13845
13846
13847 .option callout_negative_expire main time 2h
13848 This option specifies the expiry time for negative callout cache data for an
13849 address. See section &<<SECTcallver>>& for details of callout verification, and
13850 section &<<SECTcallvercache>>& for details of the caching.
13851
13852
13853 .option callout_positive_expire main time 24h
13854 This option specifies the expiry time for positive callout cache data for an
13855 address. See section &<<SECTcallver>>& for details of callout verification, and
13856 section &<<SECTcallvercache>>& for details of the caching.
13857
13858
13859 .option callout_random_local_part main string&!! "see below"
13860 This option defines the &"random"& local part that can be used as part of
13861 callout verification. The default value is
13862 .code
13863 $primary_hostname-$tod_epoch-testing
13864 .endd
13865 See section &<<CALLaddparcall>>& for details of how this value is used.
13866
13867
13868 .option check_log_inodes main integer 0
13869 See &%check_spool_space%& below.
13870
13871
13872 .option check_log_space main integer 0
13873 See &%check_spool_space%& below.
13874
13875 .oindex "&%check_rfc2047_length%&"
13876 .cindex "RFC 2047" "disabling length check"
13877 .option check_rfc2047_length main boolean true
13878 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13879 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13880 word; strings to be encoded that exceed this length are supposed to use
13881 multiple encoded words. By default, Exim does not recognize encoded words that
13882 exceed the maximum length. However, it seems that some software, in violation
13883 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13884 set false, Exim recognizes encoded words of any length.
13885
13886
13887 .option check_spool_inodes main integer 0
13888 See &%check_spool_space%& below.
13889
13890
13891 .option check_spool_space main integer 0
13892 .cindex "checking disk space"
13893 .cindex "disk space, checking"
13894 .cindex "spool directory" "checking space"
13895 The four &%check_...%& options allow for checking of disk resources before a
13896 message is accepted.
13897
13898 .vindex "&$log_inodes$&"
13899 .vindex "&$log_space$&"
13900 .vindex "&$spool_inodes$&"
13901 .vindex "&$spool_space$&"
13902 When any of these options are set, they apply to all incoming messages. If you
13903 want to apply different checks to different kinds of message, you can do so by
13904 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13905 &$spool_space$& in an ACL with appropriate additional conditions.
13906
13907
13908 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13909 either value is greater than zero, for example:
13910 .code
13911 check_spool_space = 10M
13912 check_spool_inodes = 100
13913 .endd
13914 The spool partition is the one that contains the directory defined by
13915 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13916 transit.
13917
13918 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13919 files are written if either is greater than zero. These should be set only if
13920 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13921
13922 If there is less space or fewer inodes than requested, Exim refuses to accept
13923 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13924 error response to the MAIL command. If ESMTP is in use and there was a
13925 SIZE parameter on the MAIL command, its value is added to the
13926 &%check_spool_space%& value, and the check is performed even if
13927 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13928
13929 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13930 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13931
13932 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13933 failure a message is written to stderr and Exim exits with a non-zero code, as
13934 it obviously cannot send an error message of any kind.
13935
13936 .option daemon_smtp_ports main string &`smtp`&
13937 .cindex "port" "for daemon"
13938 .cindex "TCP/IP" "setting listening ports"
13939 This option specifies one or more default SMTP ports on which the Exim daemon
13940 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13941 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13942
13943 .option daemon_startup_retries main integer 9
13944 .cindex "daemon startup, retrying"
13945 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13946 the daemon at startup when it cannot immediately bind a listening socket
13947 (typically because the socket is already in use): &%daemon_startup_retries%&
13948 defines the number of retries after the first failure, and
13949 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13950
13951 .option daemon_startup_sleep main time 30s
13952 See &%daemon_startup_retries%&.
13953
13954 .option delay_warning main "time list" 24h
13955 .cindex "warning of delay"
13956 .cindex "delay warning, specifying"
13957 When a message is delayed, Exim sends a warning message to the sender at
13958 intervals specified by this option. The data is a colon-separated list of times
13959 after which to send warning messages. If the value of the option is an empty
13960 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13961 message has been on the queue for longer than the last time, the last interval
13962 between the times is used to compute subsequent warning times. For example,
13963 with
13964 .code
13965 delay_warning = 4h:8h:24h
13966 .endd
13967 the first message is sent after 4 hours, the second after 8 hours, and
13968 the third one after 24 hours. After that, messages are sent every 16 hours,
13969 because that is the interval between the last two times on the list. If you set
13970 just one time, it specifies the repeat interval. For example, with:
13971 .code
13972 delay_warning = 6h
13973 .endd
13974 messages are repeated every six hours. To stop warnings after a given time, set
13975 a very large time at the end of the list. For example:
13976 .code
13977 delay_warning = 2h:12h:99d
13978 .endd
13979 Note that the option is only evaluated at the time a delivery attempt fails,
13980 which depends on retry and queue-runner configuration.
13981 Typically retries will be configured more frequently than warning messages.
13982
13983 .option delay_warning_condition main string&!! "see below"
13984 .vindex "&$domain$&"
13985 The string is expanded at the time a warning message might be sent. If all the
13986 deferred addresses have the same domain, it is set in &$domain$& during the
13987 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13988 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13989 &"false"& (the comparison being done caselessly) then the warning message is
13990 not sent. The default is:
13991 .code
13992 delay_warning_condition = ${if or {\
13993   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13994   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13995   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13996   } {no}{yes}}
13997 .endd
13998 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13999 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14000 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14001 &"auto-replied"& in an &'Auto-Submitted:'& header.
14002
14003 .option deliver_drop_privilege main boolean false
14004 .cindex "unprivileged delivery"
14005 .cindex "delivery" "unprivileged"
14006 If this option is set true, Exim drops its root privilege at the start of a
14007 delivery process, and runs as the Exim user throughout. This severely restricts
14008 the kinds of local delivery that are possible, but is viable in certain types
14009 of configuration. There is a discussion about the use of root privilege in
14010 chapter &<<CHAPsecurity>>&.
14011
14012 .option deliver_queue_load_max main fixed-point unset
14013 .cindex "load average"
14014 .cindex "queue runner" "abandoning"
14015 When this option is set, a queue run is abandoned if the system load average
14016 becomes greater than the value of the option. The option has no effect on
14017 ancient operating systems on which Exim cannot determine the load average.
14018 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14019
14020
14021 .option delivery_date_remove main boolean true
14022 .cindex "&'Delivery-date:'& header line"
14023 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14024 message when it is delivered, in exactly the same way as &'Return-path:'& is
14025 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14026 should not be present in incoming messages, and this option causes them to be
14027 removed at the time the message is received, to avoid any problems that might
14028 occur when a delivered message is subsequently sent on to some other recipient.
14029
14030 .option disable_fsync main boolean false
14031 .cindex "&[fsync()]&, disabling"
14032 This option is available only if Exim was built with the compile-time option
14033 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14034 a runtime configuration generates an &"unknown option"& error. You should not
14035 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14036 really, really, really understand what you are doing. &'No pre-compiled
14037 distributions of Exim should ever make this option available.'&
14038
14039 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14040 updated files' data to be written to disc before continuing. Unexpected events
14041 such as crashes and power outages may cause data to be lost or scrambled.
14042 Here be Dragons. &*Beware.*&
14043
14044
14045 .option disable_ipv6 main boolean false
14046 .cindex "IPv6" "disabling"
14047 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14048 activities take place. AAAA records are never looked up, and any IPv6 addresses
14049 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14050 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14051 to handle IPv6 literal addresses.
14052
14053
14054 .option dns_again_means_nonexist main "domain list&!!" unset
14055 .cindex "DNS" "&""try again""& response; overriding"
14056 DNS lookups give a &"try again"& response for the DNS errors
14057 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14058 keep trying to deliver a message, or to give repeated temporary errors to
14059 incoming mail. Sometimes the effect is caused by a badly set up name server and
14060 may persist for a long time. If a domain which exhibits this problem matches
14061 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14062 This option should be used with care. You can make it apply to reverse lookups
14063 by a setting such as this:
14064 .code
14065 dns_again_means_nonexist = *.in-addr.arpa
14066 .endd
14067 This option applies to all DNS lookups that Exim does. It also applies when the
14068 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14069 since these are most likely to be caused by DNS lookup problems. The
14070 &(dnslookup)& router has some options of its own for controlling what happens
14071 when lookups for MX or SRV records give temporary errors. These more specific
14072 options are applied after this global option.
14073
14074 .option dns_check_names_pattern main string "see below"
14075 .cindex "DNS" "pre-check of name syntax"
14076 When this option is set to a non-empty string, it causes Exim to check domain
14077 names for characters that are not allowed in host names before handing them to
14078 the DNS resolver, because some resolvers give temporary errors for names that
14079 contain unusual characters. If a domain name contains any unwanted characters,
14080 a &"not found"& result is forced, and the resolver is not called. The check is
14081 done by matching the domain name against a regular expression, which is the
14082 value of this option. The default pattern is
14083 .code
14084 dns_check_names_pattern = \
14085   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14086 .endd
14087 which permits only letters, digits, slashes, and hyphens in components, but
14088 they must start and end with a letter or digit. Slashes are not, in fact,
14089 permitted in host names, but they are found in certain NS records (which can be
14090 accessed in Exim by using a &%dnsdb%& lookup). If you set
14091 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14092 empty string.
14093
14094 .option dns_csa_search_limit main integer 5
14095 This option controls the depth of parental searching for CSA SRV records in the
14096 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14097
14098 .option dns_csa_use_reverse main boolean true
14099 This option controls whether or not an IP address, given as a CSA domain, is
14100 reversed and looked up in the reverse DNS, as described in more detail in
14101 section &<<SECTverifyCSA>>&.
14102
14103
14104 .option dns_dnssec_ok main integer -1
14105 .cindex "DNS" "resolver options"
14106 .cindex "DNS" "DNSSEC"
14107 If this option is set to a non-negative number then Exim will initialise the
14108 DNS resolver library to either use or not use DNSSEC, overriding the system
14109 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14110
14111 If the resolver library does not support DNSSEC then this option has no effect.
14112
14113
14114 .option dns_ipv4_lookup main "domain list&!!" unset
14115 .cindex "IPv6" "DNS lookup for AAAA records"
14116 .cindex "DNS" "IPv6 lookup for AAAA records"
14117 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14118 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14119 (A records) when trying to find IP addresses for hosts, unless the host's
14120 domain matches this list.
14121
14122 This is a fudge to help with name servers that give big delays or otherwise do
14123 not work for the AAAA record type. In due course, when the world's name
14124 servers have all been upgraded, there should be no need for this option.
14125
14126
14127 .option dns_retrans main time 0s
14128 .cindex "DNS" "resolver options"
14129 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14130 retransmission and retry parameters for DNS lookups. Values of zero (the
14131 defaults) leave the system default settings unchanged. The first value is the
14132 time between retries, and the second is the number of retries. It isn't
14133 totally clear exactly how these settings affect the total time a DNS lookup may
14134 take. I haven't found any documentation about timeouts on DNS lookups; these
14135 parameter values are available in the external resolver interface structure,
14136 but nowhere does it seem to describe how they are used or what you might want
14137 to set in them.
14138
14139
14140 .option dns_retry main integer 0
14141 See &%dns_retrans%& above.
14142
14143
14144 .option dns_use_edns0 main integer -1
14145 .cindex "DNS" "resolver options"
14146 .cindex "DNS" "EDNS0"
14147 If this option is set to a non-negative number then Exim will initialise the
14148 DNS resolver library to either use or not use EDNS0 extensions, overriding
14149 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14150 on.
14151
14152 If the resolver library does not support EDNS0 then this option has no effect.
14153
14154
14155 .option drop_cr main boolean false
14156 This is an obsolete option that is now a no-op. It used to affect the way Exim
14157 handled CR and LF characters in incoming messages. What happens now is
14158 described in section &<<SECTlineendings>>&.
14159
14160 .option dsn_advertise_hosts main "host list&!!" unset
14161 .cindex "bounce messages" "success"
14162 .cindex "DSN" "success"
14163 .cindex "Delivery Status Notification" "success"
14164 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14165 and accepted from, these hosts.
14166 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14167 and RET and ORCPT options on MAIL FROM commands.
14168 A NOTIFY=SUCCESS option requests success-DSN messages.
14169 A NOTIFY= option with no argument requests that no delay or failure DSNs
14170 are sent.
14171
14172 .option dsn_from main "string&!!" "see below"
14173 .cindex "&'From:'& header line" "in bounces"
14174 .cindex "bounce messages" "&'From:'& line, specifying"
14175 This option can be used to vary the contents of &'From:'& header lines in
14176 bounces and other automatically generated messages (&"Delivery Status
14177 Notifications"& &-- hence the name of the option). The default setting is:
14178 .code
14179 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14180 .endd
14181 The value is expanded every time it is needed. If the expansion fails, a
14182 panic is logged, and the default value is used.
14183
14184 .option envelope_to_remove main boolean true
14185 .cindex "&'Envelope-to:'& header line"
14186 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14187 message when it is delivered, in exactly the same way as &'Return-path:'& is
14188 handled. &'Envelope-to:'& records the original recipient address from the
14189 messages's envelope that caused the delivery to happen. Such headers should not
14190 be present in incoming messages, and this option causes them to be removed at
14191 the time the message is received, to avoid any problems that might occur when a
14192 delivered message is subsequently sent on to some other recipient.
14193
14194
14195 .option errors_copy main "string list&!!" unset
14196 .cindex "bounce message" "copy to other address"
14197 .cindex "copy of bounce message"
14198 Setting this option causes Exim to send bcc copies of bounce messages that it
14199 generates to other addresses. &*Note*&: This does not apply to bounce messages
14200 coming from elsewhere. The value of the option is a colon-separated list of
14201 items. Each item consists of a pattern, terminated by white space, followed by
14202 a comma-separated list of email addresses. If a pattern contains spaces, it
14203 must be enclosed in double quotes.
14204
14205 Each pattern is processed in the same way as a single item in an address list
14206 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14207 the bounce message, the message is copied to the addresses on the list. The
14208 items are scanned in order, and once a matching one is found, no further items
14209 are examined. For example:
14210 .code
14211 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14212               rqps@mydomain   hostmaster@mydomain.example,\
14213                               postmaster@mydomain.example
14214 .endd
14215 .vindex "&$domain$&"
14216 .vindex "&$local_part$&"
14217 The address list is expanded before use. The expansion variables &$local_part$&
14218 and &$domain$& are set from the original recipient of the error message, and if
14219 there was any wildcard matching in the pattern, the expansion
14220 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14221 variables &$0$&, &$1$&, etc. are set in the normal way.
14222
14223
14224 .option errors_reply_to main string unset
14225 .cindex "bounce message" "&'Reply-to:'& in"
14226 By default, Exim's bounce and delivery warning messages contain the header line
14227 .display
14228 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14229 .endd
14230 .oindex &%quota_warn_message%&
14231 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14232 A warning message that is generated by the &%quota_warn_message%& option in an
14233 &(appendfile)& transport may contain its own &'From:'& header line that
14234 overrides the default.
14235
14236 Experience shows that people reply to bounce messages. If the
14237 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14238 and warning messages. For example:
14239 .code
14240 errors_reply_to = postmaster@my.domain.example
14241 .endd
14242 The value of the option is not expanded. It must specify a valid RFC 2822
14243 address. However, if a warning message that is generated by the
14244 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14245 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14246 not used.
14247
14248
14249 .option exim_group main string "compile-time configured"
14250 .cindex "gid (group id)" "Exim's own"
14251 .cindex "Exim group"
14252 This option changes the gid under which Exim runs when it gives up root
14253 privilege. The default value is compiled into the binary. The value of this
14254 option is used only when &%exim_user%& is also set. Unless it consists entirely
14255 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14256 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14257 security issues.
14258
14259
14260 .option exim_path main string "see below"
14261 .cindex "Exim binary, path name"
14262 This option specifies the path name of the Exim binary, which is used when Exim
14263 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14264 the directory configured at compile time by the BIN_DIRECTORY setting. It
14265 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14266 other place.
14267 &*Warning*&: Do not use a macro to define the value of this option, because
14268 you will break those Exim utilities that scan the configuration file to find
14269 where the binary is. (They then use the &%-bP%& option to extract option
14270 settings such as the value of &%spool_directory%&.)
14271
14272
14273 .option exim_user main string "compile-time configured"
14274 .cindex "uid (user id)" "Exim's own"
14275 .cindex "Exim user"
14276 This option changes the uid under which Exim runs when it gives up root
14277 privilege. The default value is compiled into the binary. Ownership of the run
14278 time configuration file and the use of the &%-C%& and &%-D%& command line
14279 options is checked against the values in the binary, not what is set here.
14280
14281 Unless it consists entirely of digits, the string is looked up using
14282 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14283 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14284 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14285
14286
14287 .option extra_local_interfaces main "string list" unset
14288 This option defines network interfaces that are to be considered local when
14289 routing, but which are not used for listening by the daemon. See section
14290 &<<SECTreclocipadd>>& for details.
14291
14292
14293 . Allow this long option name to split; give it unsplit as a fifth argument
14294 . for the automatic .oindex that is generated by .option.
14295
14296 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14297          extract_addresses_remove_arguments
14298 .oindex "&%-t%&"
14299 .cindex "command line" "addresses with &%-t%&"
14300 .cindex "Sendmail compatibility" "&%-t%& option"
14301 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14302 are present on the command line when the &%-t%& option is used to build an
14303 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14304 line addresses are removed from the recipients list. This is also how Smail
14305 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14306 command line addresses are added to those obtained from the header lines. When
14307 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14308 argument headers. If it is set false, Exim adds rather than removes argument
14309 addresses.
14310
14311
14312 .option finduser_retries main integer 0
14313 .cindex "NIS, retrying user lookups"
14314 On systems running NIS or other schemes in which user and group information is
14315 distributed from a remote system, there can be times when &[getpwnam()]& and
14316 related functions fail, even when given valid data, because things time out.
14317 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14318 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14319 many extra times to find a user or a group, waiting for one second between
14320 retries.
14321
14322 .cindex "&_/etc/passwd_&" "multiple reading of"
14323 You should not set this option greater than zero if your user information is in
14324 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14325 search the file multiple times for non-existent users, and also cause delay.
14326
14327
14328
14329 .option freeze_tell main "string list, comma separated" unset
14330 .cindex "freezing messages" "sending a message when freezing"
14331 On encountering certain errors, or when configured to do so in a system filter,
14332 ACL, or special router, Exim freezes a message. This means that no further
14333 delivery attempts take place until an administrator thaws the message, or the
14334 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14335 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14336 warning message whenever it freezes something, unless the message it is
14337 freezing is a locally-generated bounce message. (Without this exception there
14338 is the possibility of looping.) The warning message is sent to the addresses
14339 supplied as the comma-separated value of this option. If several of the
14340 message's addresses cause freezing, only a single message is sent. If the
14341 freezing was automatic, the reason(s) for freezing can be found in the message
14342 log. If you configure freezing in a filter or ACL, you must arrange for any
14343 logging that you require.
14344
14345
14346 .option gecos_name main string&!! unset
14347 .cindex "HP-UX"
14348 .cindex "&""gecos""& field, parsing"
14349 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14350 password file to hold other information in addition to users' real names. Exim
14351 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14352 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14353 of the field are used unchanged, except that, if an ampersand is encountered,
14354 it is replaced by the user's login name with the first character forced to
14355 upper case, since this is a convention that is observed on many systems.
14356
14357 When these options are set, &%gecos_pattern%& is treated as a regular
14358 expression that is to be applied to the field (again with && replaced by the
14359 login name), and if it matches, &%gecos_name%& is expanded and used as the
14360 user's name.
14361
14362 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14363 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14364 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14365 name terminates at the first comma, the following can be used:
14366 .code
14367 gecos_pattern = ([^,]*)
14368 gecos_name = $1
14369 .endd
14370
14371 .option gecos_pattern main string unset
14372 See &%gecos_name%& above.
14373
14374
14375 .option gnutls_compat_mode main boolean unset
14376 This option controls whether GnuTLS is used in compatibility mode in an Exim
14377 server. This reduces security slightly, but improves interworking with older
14378 implementations of TLS.
14379
14380
14381 option gnutls_allow_auto_pkcs11 main boolean unset
14382 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14383 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14384
14385 See
14386 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14387 for documentation.
14388
14389
14390
14391 .option headers_charset main string "see below"
14392 This option sets a default character set for translating from encoded MIME
14393 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14394 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14395 ultimate default is ISO-8859-1. For more details see the description of header
14396 insertions in section &<<SECTexpansionitems>>&.
14397
14398
14399
14400 .option header_maxsize main integer "see below"
14401 .cindex "header section" "maximum size of"
14402 .cindex "limit" "size of message header section"
14403 This option controls the overall maximum size of a message's header
14404 section. The default is the value of HEADER_MAXSIZE in
14405 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14406 sections are rejected.
14407
14408
14409 .option header_line_maxsize main integer 0
14410 .cindex "header lines" "maximum size of"
14411 .cindex "limit" "size of one header line"
14412 This option limits the length of any individual header line in a message, after
14413 all the continuations have been joined together. Messages with individual
14414 header lines that are longer than the limit are rejected. The default value of
14415 zero means &"no limit"&.
14416
14417
14418
14419
14420 .option helo_accept_junk_hosts main "host list&!!" unset
14421 .cindex "HELO" "accepting junk data"
14422 .cindex "EHLO" "accepting junk data"
14423 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14424 mail, and gives an error response for invalid data. Unfortunately, there are
14425 some SMTP clients that send syntactic junk. They can be accommodated by setting
14426 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14427 if you want to do semantic checking.
14428 See also &%helo_allow_chars%& for a way of extending the permitted character
14429 set.
14430
14431
14432 .option helo_allow_chars main string unset
14433 .cindex "HELO" "underscores in"
14434 .cindex "EHLO" "underscores in"
14435 .cindex "underscore in EHLO/HELO"
14436 This option can be set to a string of rogue characters that are permitted in
14437 all EHLO and HELO names in addition to the standard letters, digits,
14438 hyphens, and dots. If you really must allow underscores, you can set
14439 .code
14440 helo_allow_chars = _
14441 .endd
14442 Note that the value is one string, not a list.
14443
14444
14445 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14446 .cindex "HELO" "forcing reverse lookup"
14447 .cindex "EHLO" "forcing reverse lookup"
14448 If the domain given by a client in a HELO or EHLO command matches this
14449 list, a reverse lookup is done in order to establish the host's true name. The
14450 default forces a lookup if the client host gives the server's name or any of
14451 its IP addresses (in brackets), something that broken clients have been seen to
14452 do.
14453
14454
14455 .option helo_try_verify_hosts main "host list&!!" unset
14456 .cindex "HELO verifying" "optional"
14457 .cindex "EHLO" "verifying, optional"
14458 By default, Exim just checks the syntax of HELO and EHLO commands (see
14459 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14460 to do more extensive checking of the data supplied by these commands. The ACL
14461 condition &`verify = helo`& is provided to make this possible.
14462 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14463 to force the check to occur. From release 4.53 onwards, this is no longer
14464 necessary. If the check has not been done before &`verify = helo`& is
14465 encountered, it is done at that time. Consequently, this option is obsolete.
14466 Its specification is retained here for backwards compatibility.
14467
14468 When an EHLO or HELO command is received, if the calling host matches
14469 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14470 EHLO command either:
14471
14472 .ilist
14473 is an IP literal matching the calling address of the host, or
14474 .next
14475 .cindex "DNS" "reverse lookup"
14476 .cindex "reverse DNS lookup"
14477 matches the host name that Exim obtains by doing a reverse lookup of the
14478 calling host address, or
14479 .next
14480 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14481 available) yields the calling host address.
14482 .endlist
14483
14484 However, the EHLO or HELO command is not rejected if any of the checks
14485 fail. Processing continues, but the result of the check is remembered, and can
14486 be detected later in an ACL by the &`verify = helo`& condition.
14487
14488 .option helo_verify_hosts main "host list&!!" unset
14489 .cindex "HELO verifying" "mandatory"
14490 .cindex "EHLO" "verifying, mandatory"
14491 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14492 backwards compatibility. For hosts that match this option, Exim checks the host
14493 name given in the HELO or EHLO in the same way as for
14494 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14495 rejected with a 550 error, and entries are written to the main and reject logs.
14496 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14497 error.
14498
14499 .option hold_domains main "domain list&!!" unset
14500 .cindex "domain" "delaying delivery"
14501 .cindex "delivery" "delaying certain domains"
14502 This option allows mail for particular domains to be held on the queue
14503 manually. The option is overridden if a message delivery is forced with the
14504 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14505 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14506 item in &%hold_domains%&, no routing or delivery for that address is done, and
14507 it is deferred every time the message is looked at.
14508
14509 This option is intended as a temporary operational measure for delaying the
14510 delivery of mail while some problem is being sorted out, or some new
14511 configuration tested. If you just want to delay the processing of some
14512 domains until a queue run occurs, you should use &%queue_domains%& or
14513 &%queue_smtp_domains%&, not &%hold_domains%&.
14514
14515 A setting of &%hold_domains%& does not override Exim's code for removing
14516 messages from the queue if they have been there longer than the longest retry
14517 time in any retry rule. If you want to hold messages for longer than the normal
14518 retry times, insert a dummy retry rule with a long retry time.
14519
14520
14521 .option host_lookup main "host list&!!" unset
14522 .cindex "host name" "lookup, forcing"
14523 Exim does not look up the name of a calling host from its IP address unless it
14524 is required to compare against some host list, or the host matches
14525 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14526 option (which normally contains IP addresses rather than host names). The
14527 default configuration file contains
14528 .code
14529 host_lookup = *
14530 .endd
14531 which causes a lookup to happen for all hosts. If the expense of these lookups
14532 is felt to be too great, the setting can be changed or removed.
14533
14534 After a successful reverse lookup, Exim does a forward lookup on the name it
14535 has obtained, to verify that it yields the IP address that it started with. If
14536 this check fails, Exim behaves as if the name lookup failed.
14537
14538 .vindex "&$host_lookup_failed$&"
14539 .vindex "&$sender_host_name$&"
14540 After any kind of failure, the host name (in &$sender_host_name$&) remains
14541 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14542 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14543 &`verify = reverse_host_lookup`& in ACLs.
14544
14545
14546 .option host_lookup_order main "string list" &`bydns:byaddr`&
14547 This option specifies the order of different lookup methods when Exim is trying
14548 to find a host name from an IP address. The default is to do a DNS lookup
14549 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14550 if that fails. You can change the order of these lookups, or omit one entirely,
14551 if you want.
14552
14553 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14554 multiple PTR records in the DNS and the IP address is not listed in
14555 &_/etc/hosts_&. Different operating systems give different results in this
14556 case. That is why the default tries a DNS lookup first.
14557
14558
14559
14560 .option host_reject_connection main "host list&!!" unset
14561 .cindex "host" "rejecting connections from"
14562 If this option is set, incoming SMTP calls from the hosts listed are rejected
14563 as soon as the connection is made.
14564 This option is obsolete, and retained only for backward compatibility, because
14565 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14566 connections immediately.
14567
14568 The ability to give an immediate rejection (either by this option or using an
14569 ACL) is provided for use in unusual cases. Many hosts will just try again,
14570 sometimes without much delay. Normally, it is better to use an ACL to reject
14571 incoming messages at a later stage, such as after RCPT commands. See
14572 chapter &<<CHAPACL>>&.
14573
14574
14575 .option hosts_connection_nolog main "host list&!!" unset
14576 .cindex "host" "not logging connections from"
14577 This option defines a list of hosts for which connection logging does not
14578 happen, even though the &%smtp_connection%& log selector is set. For example,
14579 you might want not to log SMTP connections from local processes, or from
14580 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14581 the daemon; you should therefore strive to restrict its value to a short inline
14582 list of IP addresses and networks. To disable logging SMTP connections from
14583 local processes, you must create a host list with an empty item. For example:
14584 .code
14585 hosts_connection_nolog = :
14586 .endd
14587 If the &%smtp_connection%& log selector is not set, this option has no effect.
14588
14589
14590
14591 .option hosts_treat_as_local main "domain list&!!" unset
14592 .cindex "local host" "domains treated as"
14593 .cindex "host" "treated as local"
14594 If this option is set, any host names that match the domain list are treated as
14595 if they were the local host when Exim is scanning host lists obtained from MX
14596 records
14597 or other sources. Note that the value of this option is a domain list, not a
14598 host list, because it is always used to check host names, not IP addresses.
14599
14600 This option also applies when Exim is matching the special items
14601 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14602 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14603 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14604 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14605 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14606 interfaces and recognizing the local host.
14607
14608
14609 .option ibase_servers main "string list" unset
14610 .cindex "InterBase" "server list"
14611 This option provides a list of InterBase servers and associated connection data,
14612 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14613 The option is available only if Exim has been built with InterBase support.
14614
14615
14616
14617 .option ignore_bounce_errors_after main time 10w
14618 .cindex "bounce message" "discarding"
14619 .cindex "discarding bounce message"
14620 This option affects the processing of bounce messages that cannot be delivered,
14621 that is, those that suffer a permanent delivery failure. (Bounce messages that
14622 suffer temporary delivery failures are of course retried in the usual way.)
14623
14624 After a permanent delivery failure, bounce messages are frozen,
14625 because there is no sender to whom they can be returned. When a frozen bounce
14626 message has been on the queue for more than the given time, it is unfrozen at
14627 the next queue run, and a further delivery is attempted. If delivery fails
14628 again, the bounce message is discarded. This makes it possible to keep failed
14629 bounce messages around for a shorter time than the normal maximum retry time
14630 for frozen messages. For example,
14631 .code
14632 ignore_bounce_errors_after = 12h
14633 .endd
14634 retries failed bounce message deliveries after 12 hours, discarding any further
14635 failures. If the value of this option is set to a zero time period, bounce
14636 failures are discarded immediately. Setting a very long time (as in the default
14637 value) has the effect of disabling this option. For ways of automatically
14638 dealing with other kinds of frozen message, see &%auto_thaw%& and
14639 &%timeout_frozen_after%&.
14640
14641
14642 .option ignore_fromline_hosts main "host list&!!" unset
14643 .cindex "&""From""& line"
14644 .cindex "UUCP" "&""From""& line"
14645 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14646 the headers of a message. By default this is treated as the start of the
14647 message's body, which means that any following headers are not recognized as
14648 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14649 match those hosts that insist on sending it. If the sender is actually a local
14650 process rather than a remote host, and is using &%-bs%& to inject the messages,
14651 &%ignore_fromline_local%& must be set to achieve this effect.
14652
14653
14654 .option ignore_fromline_local main boolean false
14655 See &%ignore_fromline_hosts%& above.
14656
14657
14658 .option keep_malformed main time 4d
14659 This option specifies the length of time to keep messages whose spool files
14660 have been corrupted in some way. This should, of course, never happen. At the
14661 next attempt to deliver such a message, it gets removed. The incident is
14662 logged.
14663
14664
14665 .option ldap_ca_cert_dir main string unset
14666 .cindex "LDAP", "TLS CA certificate directory"
14667 This option indicates which directory contains CA certificates for verifying
14668 a TLS certificate presented by an LDAP server.
14669 While Exim does not provide a default value, your SSL library may.
14670 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14671 and constrained to be a directory.
14672
14673
14674 .option ldap_ca_cert_file main string unset
14675 .cindex "LDAP", "TLS CA certificate file"
14676 This option indicates which file contains CA certificates for verifying
14677 a TLS certificate presented by an LDAP server.
14678 While Exim does not provide a default value, your SSL library may.
14679 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14680 and constrained to be a file.
14681
14682
14683 .option ldap_cert_file main string unset
14684 .cindex "LDAP" "TLS client certificate file"
14685 This option indicates which file contains an TLS client certificate which
14686 Exim should present to the LDAP server during TLS negotiation.
14687 Should be used together with &%ldap_cert_key%&.
14688
14689
14690 .option ldap_cert_key main string unset
14691 .cindex "LDAP" "TLS client key file"
14692 This option indicates which file contains the secret/private key to use
14693 to prove identity to the LDAP server during TLS negotiation.
14694 Should be used together with &%ldap_cert_file%&, which contains the
14695 identity to be proven.
14696
14697
14698 .option ldap_cipher_suite main string unset
14699 .cindex "LDAP" "TLS cipher suite"
14700 This controls the TLS cipher-suite negotiation during TLS negotiation with
14701 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14702 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14703
14704
14705 .option ldap_default_servers main "string list" unset
14706 .cindex "LDAP" "default servers"
14707 This option provides a list of LDAP servers which are tried in turn when an
14708 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14709 details of LDAP queries. This option is available only when Exim has been built
14710 with LDAP support.
14711
14712
14713 .option ldap_require_cert main string unset.
14714 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14715 This should be one of the values "hard", "demand", "allow", "try" or "never".
14716 A value other than one of these is interpreted as "never".
14717 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14718 Although Exim does not set a default, the LDAP library probably defaults
14719 to hard/demand.
14720
14721
14722 .option ldap_start_tls main boolean false
14723 .cindex "LDAP" "whether or not to negotiate TLS"
14724 If set, Exim will attempt to negotiate TLS with the LDAP server when
14725 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14726 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14727 of SSL-on-connect.
14728 In the event of failure to negotiate TLS, the action taken is controlled
14729 by &%ldap_require_cert%&.
14730
14731
14732 .option ldap_version main integer unset
14733 .cindex "LDAP" "protocol version, forcing"
14734 This option can be used to force Exim to set a specific protocol version for
14735 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14736 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14737 the LDAP headers; otherwise it is 2. This option is available only when Exim
14738 has been built with LDAP support.
14739
14740
14741
14742 .option local_from_check main boolean true
14743 .cindex "&'Sender:'& header line" "disabling addition of"
14744 .cindex "&'From:'& header line" "disabling checking of"
14745 When a message is submitted locally (that is, not over a TCP/IP connection) by
14746 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14747 checks that the &'From:'& header line matches the login of the calling user and
14748 the domain specified by &%qualify_domain%&.
14749
14750 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14751 locally submitted message is automatically qualified by Exim, unless the
14752 &%-bnq%& command line option is used.
14753
14754 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14755 on the local part. If the &'From:'& header line does not match, Exim adds a
14756 &'Sender:'& header with an address constructed from the calling user's login
14757 and the default qualify domain.
14758
14759 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14760 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14761 &'Sender:'& header lines supplied by untrusted users, you must also set
14762 &%local_sender_retain%& to be true.
14763
14764 .cindex "envelope sender"
14765 These options affect only the header lines in the message. The envelope sender
14766 is still forced to be the login id at the qualify domain unless
14767 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14768
14769 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14770 request similar header line checking. See section &<<SECTthesenhea>>&, which
14771 has more details about &'Sender:'& processing.
14772
14773
14774
14775
14776 .option local_from_prefix main string unset
14777 When Exim checks the &'From:'& header line of locally submitted messages for
14778 matching the login id (see &%local_from_check%& above), it can be configured to
14779 ignore certain prefixes and suffixes in the local part of the address. This is
14780 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14781 appropriate lists, in the same form as the &%local_part_prefix%& and
14782 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14783 example, if
14784 .code
14785 local_from_prefix = *-
14786 .endd
14787 is set, a &'From:'& line containing
14788 .code
14789 From: anything-user@your.domain.example
14790 .endd
14791 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14792 matches the actual sender address that is constructed from the login name and
14793 qualify domain.
14794
14795
14796 .option local_from_suffix main string unset
14797 See &%local_from_prefix%& above.
14798
14799
14800 .option local_interfaces main "string list" "see below"
14801 This option controls which network interfaces are used by the daemon for
14802 listening; they are also used to identify the local host when routing. Chapter
14803 &<<CHAPinterfaces>>& contains a full description of this option and the related
14804 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14805 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14806 &%local_interfaces%& is
14807 .code
14808 local_interfaces = 0.0.0.0
14809 .endd
14810 when Exim is built without IPv6 support; otherwise it is
14811 .code
14812 local_interfaces = <; ::0 ; 0.0.0.0
14813 .endd
14814
14815 .option local_scan_timeout main time 5m
14816 .cindex "timeout" "for &[local_scan()]& function"
14817 .cindex "&[local_scan()]& function" "timeout"
14818 This timeout applies to the &[local_scan()]& function (see chapter
14819 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14820 the incoming message is rejected with a temporary error if it is an SMTP
14821 message. For a non-SMTP message, the message is dropped and Exim ends with a
14822 non-zero code. The incident is logged on the main and reject logs.
14823
14824
14825
14826 .option local_sender_retain main boolean false
14827 .cindex "&'Sender:'& header line" "retaining from local submission"
14828 When a message is submitted locally (that is, not over a TCP/IP connection) by
14829 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14830 do not want this to happen, you must set &%local_sender_retain%&, and you must
14831 also set &%local_from_check%& to be false (Exim will complain if you do not).
14832 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14833 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14834
14835
14836
14837
14838 .option localhost_number main string&!! unset
14839 .cindex "host" "locally unique number for"
14840 .cindex "message ids" "with multiple hosts"
14841 .vindex "&$localhost_number$&"
14842 Exim's message ids are normally unique only within the local host. If
14843 uniqueness among a set of hosts is required, each host must set a different
14844 value for the &%localhost_number%& option. The string is expanded immediately
14845 after reading the configuration file (so that a number can be computed from the
14846 host name, for example) and the result of the expansion must be a number in the
14847 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14848 systems). This is available in subsequent string expansions via the variable
14849 &$localhost_number$&. When &%localhost_number is set%&, the final two
14850 characters of the message id, instead of just being a fractional part of the
14851 time, are computed from the time and the local host number as described in
14852 section &<<SECTmessiden>>&.
14853
14854
14855
14856 .option log_file_path main "string list&!!" "set at compile time"
14857 .cindex "log" "file path for"
14858 This option sets the path which is used to determine the names of Exim's log
14859 files, or indicates that logging is to be to syslog, or both. It is expanded
14860 when Exim is entered, so it can, for example, contain a reference to the host
14861 name. If no specific path is set for the log files at compile or run time, they
14862 are written in a sub-directory called &_log_& in Exim's spool directory.
14863 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14864 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14865 used. If this string is fixed at your installation (contains no expansion
14866 variables) it is recommended that you do not set this option in the
14867 configuration file, but instead supply the path using LOG_FILE_PATH in
14868 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14869 early on &-- in particular, failure to read the configuration file.
14870
14871
14872 .option log_selector main string unset
14873 .cindex "log" "selectors"
14874 This option can be used to reduce or increase the number of things that Exim
14875 writes to its log files. Its argument is made up of names preceded by plus or
14876 minus characters. For example:
14877 .code
14878 log_selector = +arguments -retry_defer
14879 .endd
14880 A list of possible names and what they control is given in the chapter on
14881 logging, in section &<<SECTlogselector>>&.
14882
14883
14884 .option log_timezone main boolean false
14885 .cindex "log" "timezone for entries"
14886 .vindex "&$tod_log$&"
14887 .vindex "&$tod_zone$&"
14888 By default, the timestamps on log lines are in local time without the
14889 timezone. This means that if your timezone changes twice a year, the timestamps
14890 in log lines are ambiguous for an hour when the clocks go back. One way of
14891 avoiding this problem is to set the timezone to UTC. An alternative is to set
14892 &%log_timezone%& true. This turns on the addition of the timezone offset to
14893 timestamps in log lines. Turning on this option can add quite a lot to the size
14894 of log files because each line is extended by 6 characters. Note that the
14895 &$tod_log$& variable contains the log timestamp without the zone, but there is
14896 another variable called &$tod_zone$& that contains just the timezone offset.
14897
14898
14899 .option lookup_open_max main integer 25
14900 .cindex "too many open files"
14901 .cindex "open files, too many"
14902 .cindex "file" "too many open"
14903 .cindex "lookup" "maximum open files"
14904 .cindex "limit" "open files for lookups"
14905 This option limits the number of simultaneously open files for single-key
14906 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14907 Exim normally keeps these files open during routing, because often the same
14908 file is required several times. If the limit is reached, Exim closes the least
14909 recently used file. Note that if you are using the &'ndbm'& library, it
14910 actually opens two files for each logical DBM database, though it still counts
14911 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14912 open files"& errors with NDBM, you need to reduce the value of
14913 &%lookup_open_max%&.
14914
14915
14916 .option max_username_length main integer 0
14917 .cindex "length of login name"
14918 .cindex "user name" "maximum length"
14919 .cindex "limit" "user name length"
14920 Some operating systems are broken in that they truncate long arguments to
14921 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14922 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14923 an argument that is longer behaves as if &[getpwnam()]& failed.
14924
14925
14926 .option message_body_newlines main bool false
14927 .cindex "message body" "newlines in variables"
14928 .cindex "newline" "in message body variables"
14929 .vindex "&$message_body$&"
14930 .vindex "&$message_body_end$&"
14931 By default, newlines in the message body are replaced by spaces when setting
14932 the &$message_body$& and &$message_body_end$& expansion variables. If this
14933 option is set true, this no longer happens.
14934
14935
14936 .option message_body_visible main integer 500
14937 .cindex "body of message" "visible size"
14938 .cindex "message body" "visible size"
14939 .vindex "&$message_body$&"
14940 .vindex "&$message_body_end$&"
14941 This option specifies how much of a message's body is to be included in the
14942 &$message_body$& and &$message_body_end$& expansion variables.
14943
14944
14945 .option message_id_header_domain main string&!! unset
14946 .cindex "&'Message-ID:'& header line"
14947 If this option is set, the string is expanded and used as the right hand side
14948 (domain) of the &'Message-ID:'& header that Exim creates if a
14949 locally-originated incoming message does not have one. &"Locally-originated"&
14950 means &"not received over TCP/IP."&
14951 Otherwise, the primary host name is used.
14952 Only letters, digits, dot and hyphen are accepted; any other characters are
14953 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14954 empty string, the option is ignored.
14955
14956
14957 .option message_id_header_text main string&!! unset
14958 If this variable is set, the string is expanded and used to augment the text of
14959 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14960 message does not have one. The text of this header is required by RFC 2822 to
14961 take the form of an address. By default, Exim uses its internal message id as
14962 the local part, and the primary host name as the domain. If this option is set,
14963 it is expanded, and provided the expansion is not forced to fail, and does not
14964 yield an empty string, the result is inserted into the header immediately
14965 before the @, separated from the internal message id by a dot. Any characters
14966 that are illegal in an address are automatically converted into hyphens. This
14967 means that variables such as &$tod_log$& can be used, because the spaces and
14968 colons will become hyphens.
14969
14970
14971 .option message_logs main boolean true
14972 .cindex "message logs" "disabling"
14973 .cindex "log" "message log; disabling"
14974 If this option is turned off, per-message log files are not created in the
14975 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14976 Exim, by reducing the number of files involved in handling a message from a
14977 minimum of four (header spool file, body spool file, delivery journal, and
14978 per-message log) to three. The other major I/O activity is Exim's main log,
14979 which is not affected by this option.
14980
14981
14982 .option message_size_limit main string&!! 50M
14983 .cindex "message" "size limit"
14984 .cindex "limit" "message size"
14985 .cindex "size" "of message, limit"
14986 This option limits the maximum size of message that Exim will process. The
14987 value is expanded for each incoming connection so, for example, it can be made
14988 to depend on the IP address of the remote host for messages arriving via
14989 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14990 optionally followed by K or M.
14991
14992 &*Note*&: This limit cannot be made to depend on a message's sender or any
14993 other properties of an individual message, because it has to be advertised in
14994 the server's response to EHLO. String expansion failure causes a temporary
14995 error. A value of zero means no limit, but its use is not recommended. See also
14996 &%bounce_return_size_limit%&.
14997
14998 Incoming SMTP messages are failed with a 552 error if the limit is
14999 exceeded; locally-generated messages either get a stderr message or a delivery
15000 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15001 an oversized message is logged in both the main and the reject logs. See also
15002 the generic transport option &%message_size_limit%&, which limits the size of
15003 message that an individual transport can process.
15004
15005 If you use a virus-scanner and set this option to to a value larger than the
15006 maximum size that your virus-scanner is configured to support, you may get
15007 failures triggered by large mails.  The right size to configure for the
15008 virus-scanner depends upon what data is passed and the options in use but it's
15009 probably safest to just set it to a little larger than this value.  Eg, with a
15010 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15011 some problems may result.
15012
15013 A value of 0 will disable size limit checking; Exim will still advertise the
15014 SIZE extension in an EHLO response, but without a limit, so as to permit
15015 SMTP clients to still indicate the message size along with the MAIL verb.
15016
15017
15018 .option move_frozen_messages main boolean false
15019 .cindex "frozen messages" "moving"
15020 This option, which is available only if Exim has been built with the setting
15021 .code
15022 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15023 .endd
15024 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15025 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15026 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15027 standard utilities for handling such moved messages, and they do not show up in
15028 lists generated by &%-bp%& or by the Exim monitor.
15029
15030
15031 .option mua_wrapper main boolean false
15032 Setting this option true causes Exim to run in a very restrictive mode in which
15033 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15034 contains a full description of this facility.
15035
15036
15037
15038 .option mysql_servers main "string list" unset
15039 .cindex "MySQL" "server list"
15040 This option provides a list of MySQL servers and associated connection data, to
15041 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15042 option is available only if Exim has been built with MySQL support.
15043
15044
15045 .option never_users main "string list&!!" unset
15046 This option is expanded just once, at the start of Exim's processing. Local
15047 message deliveries are normally run in processes that are setuid to the
15048 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15049 It is usually desirable to prevent any deliveries from running as root, as a
15050 safety precaution.
15051
15052 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15053 list of users that must not be used for local deliveries. This list is fixed in
15054 the binary and cannot be overridden by the configuration file. By default, it
15055 contains just the single user name &"root"&. The &%never_users%& runtime option
15056 can be used to add more users to the fixed list.
15057
15058 If a message is to be delivered as one of the users on the fixed list or the
15059 &%never_users%& list, an error occurs, and delivery is deferred. A common
15060 example is
15061 .code
15062 never_users = root:daemon:bin
15063 .endd
15064 Including root is redundant if it is also on the fixed list, but it does no
15065 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15066 transport driver.
15067
15068
15069 .option openssl_options main "string list" "+no_sslv2"
15070 .cindex "OpenSSL "compatibility options"
15071 This option allows an administrator to adjust the SSL options applied
15072 by OpenSSL to connections.  It is given as a space-separated list of items,
15073 each one to be +added or -subtracted from the current value.
15074
15075 This option is only available if Exim is built against OpenSSL.  The values
15076 available for this option vary according to the age of your OpenSSL install.
15077 The &"all"& value controls a subset of flags which are available, typically
15078 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15079 list the values known on your system and Exim should support all the
15080 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15081 names lose the leading &"SSL_OP_"& and are lower-cased.
15082
15083 Note that adjusting the options can have severe impact upon the security of
15084 SSL as used by Exim.  It is possible to disable safety checks and shoot
15085 yourself in the foot in various unpleasant ways.  This option should not be
15086 adjusted lightly.  An unrecognised item will be detected at startup, by
15087 invoking Exim with the &%-bV%& flag.
15088
15089 The option affects Exim operating both as a server and as a client.
15090
15091 Historical note: prior to release 4.80, Exim defaulted this value to
15092 "+dont_insert_empty_fragments", which may still be needed for compatibility
15093 with some clients, but which lowers security by increasing exposure to
15094 some now infamous attacks.
15095
15096 Examples:
15097 .code
15098 # Make both old MS and old Eudora happy:
15099 openssl_options = -all +microsoft_big_sslv3_buffer \
15100                        +dont_insert_empty_fragments
15101
15102 # Disable older protocol versions:
15103 openssl_options = +no_sslv2 +no_sslv3
15104 .endd
15105
15106 Possible options may include:
15107 .ilist
15108 &`all`&
15109 .next
15110 &`allow_unsafe_legacy_renegotiation`&
15111 .next
15112 &`cipher_server_preference`&
15113 .next
15114 &`dont_insert_empty_fragments`&
15115 .next
15116 &`ephemeral_rsa`&
15117 .next
15118 &`legacy_server_connect`&
15119 .next
15120 &`microsoft_big_sslv3_buffer`&
15121 .next
15122 &`microsoft_sess_id_bug`&
15123 .next
15124 &`msie_sslv2_rsa_padding`&
15125 .next
15126 &`netscape_challenge_bug`&
15127 .next
15128 &`netscape_reuse_cipher_change_bug`&
15129 .next
15130 &`no_compression`&
15131 .next
15132 &`no_session_resumption_on_renegotiation`&
15133 .next
15134 &`no_sslv2`&
15135 .next
15136 &`no_sslv3`&
15137 .next
15138 &`no_ticket`&
15139 .next
15140 &`no_tlsv1`&
15141 .next
15142 &`no_tlsv1_1`&
15143 .next
15144 &`no_tlsv1_2`&
15145 .next
15146 &`safari_ecdhe_ecdsa_bug`&
15147 .next
15148 &`single_dh_use`&
15149 .next
15150 &`single_ecdh_use`&
15151 .next
15152 &`ssleay_080_client_dh_bug`&
15153 .next
15154 &`sslref2_reuse_cert_type_bug`&
15155 .next
15156 &`tls_block_padding_bug`&
15157 .next
15158 &`tls_d5_bug`&
15159 .next
15160 &`tls_rollback_bug`&
15161 .endlist
15162
15163 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15164 all clients connecting using the MacOS SecureTransport TLS facility prior
15165 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15166 to negotiate TLS then this option value might help, provided that your OpenSSL
15167 release is new enough to contain this work-around.  This may be a situation
15168 where you have to upgrade OpenSSL to get buggy clients working.
15169
15170
15171 .option oracle_servers main "string list" unset
15172 .cindex "Oracle" "server list"
15173 This option provides a list of Oracle servers and associated connection data,
15174 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15175 The option is available only if Exim has been built with Oracle support.
15176
15177
15178 .option percent_hack_domains main "domain list&!!" unset
15179 .cindex "&""percent hack""&"
15180 .cindex "source routing" "in email address"
15181 .cindex "address" "source-routed"
15182 The &"percent hack"& is the convention whereby a local part containing a
15183 percent sign is re-interpreted as a new email address, with the percent
15184 replaced by @. This is sometimes called &"source routing"&, though that term is
15185 also applied to RFC 2822 addresses that begin with an @ character. If this
15186 option is set, Exim implements the percent facility for those domains listed,
15187 but no others. This happens before an incoming SMTP address is tested against
15188 an ACL.
15189
15190 &*Warning*&: The &"percent hack"& has often been abused by people who are
15191 trying to get round relaying restrictions. For this reason, it is best avoided
15192 if at all possible. Unfortunately, a number of less security-conscious MTAs
15193 implement it unconditionally. If you are running Exim on a gateway host, and
15194 routing mail through to internal MTAs without processing the local parts, it is
15195 a good idea to reject recipient addresses with percent characters in their
15196 local parts. Exim's default configuration does this.
15197
15198
15199 .option perl_at_start main boolean false
15200 This option is available only when Exim is built with an embedded Perl
15201 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15202
15203
15204 .option perl_startup main string unset
15205 This option is available only when Exim is built with an embedded Perl
15206 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15207
15208
15209 .option pgsql_servers main "string list" unset
15210 .cindex "PostgreSQL lookup type" "server list"
15211 This option provides a list of PostgreSQL servers and associated connection
15212 data, to be used in conjunction with &(pgsql)& lookups (see section
15213 &<<SECID72>>&). The option is available only if Exim has been built with
15214 PostgreSQL support.
15215
15216
15217 .option pid_file_path main string&!! "set at compile time"
15218 .cindex "daemon" "pid file path"
15219 .cindex "pid file, path for"
15220 This option sets the name of the file to which the Exim daemon writes its
15221 process id. The string is expanded, so it can contain, for example, references
15222 to the host name:
15223 .code
15224 pid_file_path = /var/log/$primary_hostname/exim.pid
15225 .endd
15226 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15227 spool directory.
15228 The value set by the option can be overridden by the &%-oP%& command line
15229 option. A pid file is not written if a &"non-standard"& daemon is run by means
15230 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15231
15232
15233 .option pipelining_advertise_hosts main "host list&!!" *
15234 .cindex "PIPELINING" "suppressing advertising"
15235 This option can be used to suppress the advertisement of the SMTP
15236 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15237 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15238 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15239 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15240 that clients will use it; &"out of order"& commands that are &"expected"& do
15241 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15242
15243
15244 .option prdr_enable main boolean false
15245 .cindex "PRDR" "enabling on server"
15246 This option can be used to enable the Per-Recipient Data Response extension
15247 to SMTP, defined by Eric Hall.
15248 If the option is set, PRDR is advertised by Exim when operating as a server.
15249 If the client requests PRDR, and more than one recipient, for a message 
15250 an additional ACL is called for each recipient after the message content
15251 is recieved.  See section &<<SECTPRDRACL>>&.
15252
15253 .option preserve_message_logs main boolean false
15254 .cindex "message logs" "preserving"
15255 If this option is set, message log files are not deleted when messages are
15256 completed. Instead, they are moved to a sub-directory of the spool directory
15257 called &_msglog.OLD_&, where they remain available for statistical or debugging
15258 purposes. This is a dangerous option to set on systems with any appreciable
15259 volume of mail. Use with care!
15260
15261
15262 .option primary_hostname main string "see below"
15263 .cindex "name" "of local host"
15264 .cindex "host" "name of local"
15265 .cindex "local host" "name of"
15266 .vindex "&$primary_hostname$&"
15267 This specifies the name of the current host. It is used in the default EHLO or
15268 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15269 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15270 The value is also used by default in some SMTP response messages from an Exim
15271 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15272
15273 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15274 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15275 contains only one component, Exim passes it to &[gethostbyname()]& (or
15276 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15277 version. The variable &$primary_hostname$& contains the host name, whether set
15278 explicitly by this option, or defaulted.
15279
15280
15281 .option print_topbitchars main boolean false
15282 .cindex "printing characters"
15283 .cindex "8-bit characters"
15284 By default, Exim considers only those characters whose codes lie in the range
15285 32&--126 to be printing characters. In a number of circumstances (for example,
15286 when writing log entries) non-printing characters are converted into escape
15287 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15288 is set, code values of 128 and above are also considered to be printing
15289 characters.
15290
15291 This option also affects the header syntax checks performed by the
15292 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15293 the user's full name when constructing From: and Sender: addresses (as
15294 described in section &<<SECTconstr>>&). Setting this option can cause
15295 Exim to generate eight bit message headers that do not conform to the
15296 standards.
15297
15298
15299 .option process_log_path main string unset
15300 .cindex "process log path"
15301 .cindex "log" "process log"
15302 .cindex "&'exiwhat'&"
15303 This option sets the name of the file to which an Exim process writes its
15304 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15305 utility script. If this option is unset, the file called &_exim-process.info_&
15306 in Exim's spool directory is used. The ability to specify the name explicitly
15307 can be useful in environments where two different Exims are running, using
15308 different spool directories.
15309
15310
15311 .option prod_requires_admin main boolean true
15312 .oindex "&%-M%&"
15313 .oindex "&%-R%&"
15314 .oindex "&%-q%&"
15315 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15316 admin user unless &%prod_requires_admin%& is set false. See also
15317 &%queue_list_requires_admin%&.
15318
15319
15320 .option qualify_domain main string "see below"
15321 .cindex "domain" "for qualifying addresses"
15322 .cindex "address" "qualification"
15323 This option specifies the domain name that is added to any envelope sender
15324 addresses that do not have a domain qualification. It also applies to
15325 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15326 are accepted by default only for locally-generated messages. Qualification is
15327 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15328 locally-generated messages, unless the &%-bnq%& command line option is used.
15329
15330 Messages from external sources must always contain fully qualified addresses,
15331 unless the sending host matches &%sender_unqualified_hosts%& or
15332 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15333 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15334 necessary. Internally, Exim always works with fully qualified envelope
15335 addresses. If &%qualify_domain%& is not set, it defaults to the
15336 &%primary_hostname%& value.
15337
15338
15339 .option qualify_recipient main string "see below"
15340 This option allows you to specify a different domain for qualifying recipient
15341 addresses to the one that is used for senders. See &%qualify_domain%& above.
15342
15343
15344
15345 .option queue_domains main "domain list&!!" unset
15346 .cindex "domain" "specifying non-immediate delivery"
15347 .cindex "queueing incoming messages"
15348 .cindex "message" "queueing certain domains"
15349 This option lists domains for which immediate delivery is not required.
15350 A delivery process is started whenever a message is received, but only those
15351 domains that do not match are processed. All other deliveries wait until the
15352 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15353
15354
15355 .option queue_list_requires_admin main boolean true
15356 .oindex "&%-bp%&"
15357 The &%-bp%& command-line option, which lists the messages that are on the
15358 queue, requires the caller to be an admin user unless
15359 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15360
15361
15362 .option queue_only main boolean false
15363 .cindex "queueing incoming messages"
15364 .cindex "message" "queueing unconditionally"
15365 If &%queue_only%& is set, a delivery process is not automatically started
15366 whenever a message is received. Instead, the message waits on the queue for the
15367 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15368 delivered immediately when certain conditions (such as heavy load) occur.
15369
15370 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15371 and &%-odi%& command line options override &%queue_only%& unless
15372 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15373 &%queue_only_load%&, and &%smtp_accept_queue%&.
15374
15375
15376 .option queue_only_file main string unset
15377 .cindex "queueing incoming messages"
15378 .cindex "message" "queueing by file existence"
15379 This option can be set to a colon-separated list of absolute path names, each
15380 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15381 it tests for the existence of each listed path using a call to &[stat()]&. For
15382 each path that exists, the corresponding queueing option is set.
15383 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15384 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15385 .code
15386 queue_only_file = smtp/some/file
15387 .endd
15388 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15389 &_/some/file_& exists.
15390
15391
15392 .option queue_only_load main fixed-point unset
15393 .cindex "load average"
15394 .cindex "queueing incoming messages"
15395 .cindex "message" "queueing by load"
15396 If the system load average is higher than this value, incoming messages from
15397 all sources are queued, and no automatic deliveries are started. If this
15398 happens during local or remote SMTP input, all subsequent messages received on
15399 the same SMTP connection are queued by default, whatever happens to the load in
15400 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15401 false.
15402
15403 Deliveries will subsequently be performed by queue runner processes. This
15404 option has no effect on ancient operating systems on which Exim cannot
15405 determine the load average. See also &%deliver_queue_load_max%& and
15406 &%smtp_load_reserve%&.
15407
15408
15409 .option queue_only_load_latch main boolean true
15410 .cindex "load average" "re-evaluating per message"
15411 When this option is true (the default), once one message has been queued
15412 because the load average is higher than the value set by &%queue_only_load%&,
15413 all subsequent messages received on the same SMTP connection are also queued.
15414 This is a deliberate choice; even though the load average may fall below the
15415 threshold, it doesn't seem right to deliver later messages on the same
15416 connection when not delivering earlier ones. However, there are special
15417 circumstances such as very long-lived connections from scanning appliances
15418 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15419 should be set false. This causes the value of the load average to be
15420 re-evaluated for each message.
15421
15422
15423 .option queue_only_override main boolean true
15424 .cindex "queueing incoming messages"
15425 When this option is true, the &%-od%&&'x'& command line options override the
15426 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15427 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15428 to override; they are accepted, but ignored.
15429
15430
15431 .option queue_run_in_order main boolean false
15432 .cindex "queue runner" "processing messages in order"
15433 If this option is set, queue runs happen in order of message arrival instead of
15434 in an arbitrary order. For this to happen, a complete list of the entire queue
15435 must be set up before the deliveries start. When the queue is all held in a
15436 single directory (the default), a single list is created for both the ordered
15437 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15438 single list is not created when &%queue_run_in_order%& is false. In this case,
15439 the sub-directories are processed one at a time (in a random order), and this
15440 avoids setting up one huge list for the whole queue. Thus, setting
15441 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15442 when the queue is large, because of the extra work in setting up the single,
15443 large list. In most situations, &%queue_run_in_order%& should not be set.
15444
15445
15446
15447 .option queue_run_max main integer 5
15448 .cindex "queue runner" "maximum number of"
15449 This controls the maximum number of queue runner processes that an Exim daemon
15450 can run simultaneously. This does not mean that it starts them all at once,
15451 but rather that if the maximum number are still running when the time comes to
15452 start another one, it refrains from starting another one. This can happen with
15453 very large queues and/or very sluggish deliveries. This option does not,
15454 however, interlock with other processes, so additional queue runners can be
15455 started by other means, or by killing and restarting the daemon.
15456
15457 Setting this option to zero does not suppress queue runs; rather, it disables
15458 the limit, allowing any number of simultaneous queue runner processes to be
15459 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15460 the daemon's command line.
15461
15462 .option queue_smtp_domains main "domain list&!!" unset
15463 .cindex "queueing incoming messages"
15464 .cindex "message" "queueing remote deliveries"
15465 When this option is set, a delivery process is started whenever a message is
15466 received, routing is performed, and local deliveries take place.
15467 However, if any SMTP deliveries are required for domains that match
15468 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15469 message waits on the queue for the next queue run. Since routing of the message
15470 has taken place, Exim knows to which remote hosts it must be delivered, and so
15471 when the queue run happens, multiple messages for the same host are delivered
15472 over a single SMTP connection. The &%-odqs%& command line option causes all
15473 SMTP deliveries to be queued in this way, and is equivalent to setting
15474 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15475 &%queue_domains%&.
15476
15477
15478 .option receive_timeout main time 0s
15479 .cindex "timeout" "for non-SMTP input"
15480 This option sets the timeout for accepting a non-SMTP message, that is, the
15481 maximum time that Exim waits when reading a message on the standard input. If
15482 the value is zero, it will wait for ever. This setting is overridden by the
15483 &%-or%& command line option. The timeout for incoming SMTP messages is
15484 controlled by &%smtp_receive_timeout%&.
15485
15486 .option received_header_text main string&!! "see below"
15487 .cindex "customizing" "&'Received:'& header"
15488 .cindex "&'Received:'& header line" "customizing"
15489 This string defines the contents of the &'Received:'& message header that is
15490 added to each message, except for the timestamp, which is automatically added
15491 on at the end (preceded by a semicolon). The string is expanded each time it is
15492 used. If the expansion yields an empty string, no &'Received:'& header line is
15493 added to the message. Otherwise, the string should start with the text
15494 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15495 header lines. The default setting is:
15496
15497 .code
15498 received_header_text = Received: \
15499   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15500   {${if def:sender_ident \
15501   {from ${quote_local_part:$sender_ident} }}\
15502   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15503   by $primary_hostname \
15504   ${if def:received_protocol {with $received_protocol}} \
15505   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15506   (Exim $version_number)\n\t\
15507   ${if def:sender_address \
15508   {(envelope-from <$sender_address>)\n\t}}\
15509   id $message_exim_id\
15510   ${if def:received_for {\n\tfor $received_for}}
15511 .endd
15512
15513 The reference to the TLS cipher is omitted when Exim is built without TLS
15514 support. The use of conditional expansions ensures that this works for both
15515 locally generated messages and messages received from remote hosts, giving
15516 header lines such as the following:
15517 .code
15518 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15519 by marley.carol.example with esmtp (Exim 4.00)
15520 (envelope-from <bob@carol.example>)
15521 id 16IOWa-00019l-00
15522 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15523 Received: by scrooge.carol.example with local (Exim 4.00)
15524 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15525 .endd
15526 Until the body of the message has been received, the timestamp is the time when
15527 the message started to be received. Once the body has arrived, and all policy
15528 checks have taken place, the timestamp is updated to the time at which the
15529 message was accepted.
15530
15531
15532 .option received_headers_max main integer 30
15533 .cindex "loop" "prevention"
15534 .cindex "mail loop prevention"
15535 .cindex "&'Received:'& header line" "counting"
15536 When a message is to be delivered, the number of &'Received:'& headers is
15537 counted, and if it is greater than this parameter, a mail loop is assumed to
15538 have occurred, the delivery is abandoned, and an error message is generated.
15539 This applies to both local and remote deliveries.
15540
15541
15542 .option recipient_unqualified_hosts main "host list&!!" unset
15543 .cindex "unqualified addresses"
15544 .cindex "host" "unqualified addresses from"
15545 This option lists those hosts from which Exim is prepared to accept unqualified
15546 recipient addresses in message envelopes. The addresses are made fully
15547 qualified by the addition of the &%qualify_recipient%& value. This option also
15548 affects message header lines. Exim does not reject unqualified recipient
15549 addresses in headers, but it qualifies them only if the message came from a
15550 host that matches &%recipient_unqualified_hosts%&,
15551 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15552 option was not set.
15553
15554
15555 .option recipients_max main integer 0
15556 .cindex "limit" "number of recipients"
15557 .cindex "recipient" "maximum number"
15558 If this option is set greater than zero, it specifies the maximum number of
15559 original recipients for any message. Additional recipients that are generated
15560 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15561 all recipients over the limit; earlier recipients are delivered as normal.
15562 Non-SMTP messages with too many recipients are failed, and no deliveries are
15563 done.
15564
15565 .cindex "RCPT" "maximum number of incoming"
15566 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15567 RCPT commands in a single message.
15568
15569
15570 .option recipients_max_reject main boolean false
15571 If this option is set true, Exim rejects SMTP messages containing too many
15572 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15573 error to the eventual DATA command. Otherwise (the default) it gives a 452
15574 error to the surplus RCPT commands and accepts the message on behalf of the
15575 initial set of recipients. The remote server should then re-send the message
15576 for the remaining recipients at a later time.
15577
15578
15579 .option remote_max_parallel main integer 2
15580 .cindex "delivery" "parallelism for remote"
15581 This option controls parallel delivery of one message to a number of remote
15582 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15583 does all the remote deliveries for a message one by one. Otherwise, if a single
15584 message has to be delivered to more than one remote host, or if several copies
15585 have to be sent to the same remote host, up to &%remote_max_parallel%&
15586 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15587 deliveries are required, the maximum number of processes are started, and as
15588 each one finishes, another is begun. The order of starting processes is the
15589 same as if sequential delivery were being done, and can be controlled by the
15590 &%remote_sort_domains%& option. If parallel delivery takes place while running
15591 with debugging turned on, the debugging output from each delivery process is
15592 tagged with its process id.
15593
15594 This option controls only the maximum number of parallel deliveries for one
15595 message in one Exim delivery process. Because Exim has no central queue
15596 manager, there is no way of controlling the total number of simultaneous
15597 deliveries if the configuration allows a delivery attempt as soon as a message
15598 is received.
15599
15600 .cindex "number of deliveries"
15601 .cindex "delivery" "maximum number of"
15602 If you want to control the total number of deliveries on the system, you
15603 need to set the &%queue_only%& option. This ensures that all incoming messages
15604 are added to the queue without starting a delivery process. Then set up an Exim
15605 daemon to start queue runner processes at appropriate intervals (probably
15606 fairly often, for example, every minute), and limit the total number of queue
15607 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15608 delivers only one message at a time, the maximum number of deliveries that can
15609 then take place at once is &%queue_run_max%& multiplied by
15610 &%remote_max_parallel%&.
15611
15612 If it is purely remote deliveries you want to control, use
15613 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15614 doing the SMTP routing before queueing, so that several messages for the same
15615 host will eventually get delivered down the same connection.
15616
15617
15618 .option remote_sort_domains main "domain list&!!" unset
15619 .cindex "sorting remote deliveries"
15620 .cindex "delivery" "sorting remote"
15621 When there are a number of remote deliveries for a message, they are sorted by
15622 domain into the order given by this list. For example,
15623 .code
15624 remote_sort_domains = *.cam.ac.uk:*.uk
15625 .endd
15626 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15627 then to those in the &%uk%& domain, then to any others.
15628
15629
15630 .option retry_data_expire main time 7d
15631 .cindex "hints database" "data expiry"
15632 This option sets a &"use before"& time on retry information in Exim's hints
15633 database. Any older retry data is ignored. This means that, for example, once a
15634 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15635 past failures.
15636
15637
15638 .option retry_interval_max main time 24h
15639 .cindex "retry" "limit on interval"
15640 .cindex "limit" "on retry interval"
15641 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15642 intervals between delivery attempts for messages that cannot be delivered
15643 straight away. This option sets an overall limit to the length of time between
15644 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15645 the default value.
15646
15647
15648 .option return_path_remove main boolean true
15649 .cindex "&'Return-path:'& header line" "removing"
15650 RFC 2821, section 4.4, states that an SMTP server must insert a
15651 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15652 The &'Return-path:'& header preserves the sender address as received in the
15653 MAIL command. This description implies that this header should not be present
15654 in an incoming message. If &%return_path_remove%& is true, any existing
15655 &'Return-path:'& headers are removed from messages at the time they are
15656 received. Exim's transports have options for adding &'Return-path:'& headers at
15657 the time of delivery. They are normally used only for final local deliveries.
15658
15659
15660 .option return_size_limit main integer 100K
15661 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15662
15663
15664 .option rfc1413_hosts main "host list&!!" @[]
15665 .cindex "RFC 1413"
15666 .cindex "host" "for RFC 1413 calls"
15667 RFC 1413 identification calls are made to any client host which matches
15668 an item in the list.
15669 The default value specifies just this host, being any local interface
15670 for the system.
15671
15672 .option rfc1413_query_timeout main time 0s
15673 .cindex "RFC 1413" "query timeout"
15674 .cindex "timeout" "for RFC 1413 call"
15675 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15676 no RFC 1413 calls are ever made.
15677
15678
15679 .option sender_unqualified_hosts main "host list&!!" unset
15680 .cindex "unqualified addresses"
15681 .cindex "host" "unqualified addresses from"
15682 This option lists those hosts from which Exim is prepared to accept unqualified
15683 sender addresses. The addresses are made fully qualified by the addition of
15684 &%qualify_domain%&. This option also affects message header lines. Exim does
15685 not reject unqualified addresses in headers that contain sender addresses, but
15686 it qualifies them only if the message came from a host that matches
15687 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15688 using TCP/IP), and the &%-bnq%& option was not set.
15689
15690
15691 .option smtp_accept_keepalive main boolean true
15692 .cindex "keepalive" "on incoming connection"
15693 This option controls the setting of the SO_KEEPALIVE option on incoming
15694 TCP/IP socket connections. When set, it causes the kernel to probe idle
15695 connections periodically, by sending packets with &"old"& sequence numbers. The
15696 other end of the connection should send an acknowledgment if the connection is
15697 still okay or a reset if the connection has been aborted. The reason for doing
15698 this is that it has the beneficial effect of freeing up certain types of
15699 connection that can get stuck when the remote host is disconnected without
15700 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15701 hours to detect unreachable hosts.
15702
15703
15704
15705 .option smtp_accept_max main integer 20
15706 .cindex "limit" "incoming SMTP connections"
15707 .cindex "SMTP" "incoming connection count"
15708 .cindex "inetd"
15709 This option specifies the maximum number of simultaneous incoming SMTP calls
15710 that Exim will accept. It applies only to the listening daemon; there is no
15711 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15712 value is set to zero, no limit is applied. However, it is required to be
15713 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15714 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15715
15716 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15717 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15718 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15719 and &%smtp_load_reserve%& are then checked before accepting the connection.
15720
15721
15722 .option smtp_accept_max_nonmail main integer 10
15723 .cindex "limit" "non-mail SMTP commands"
15724 .cindex "SMTP" "limiting non-mail commands"
15725 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15726 the connection if there are too many. This option defines &"too many"&. The
15727 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15728 client looping sending EHLO, for example. The check is applied only if the
15729 client host matches &%smtp_accept_max_nonmail_hosts%&.
15730
15731 When a new message is expected, one occurrence of RSET is not counted. This
15732 allows a client to send one RSET between messages (this is not necessary,
15733 but some clients do it). Exim also allows one uncounted occurrence of HELO
15734 or EHLO, and one occurrence of STARTTLS between messages. After
15735 starting up a TLS session, another EHLO is expected, and so it too is not
15736 counted. The first occurrence of AUTH in a connection, or immediately
15737 following STARTTLS is not counted. Otherwise, all commands other than
15738 MAIL, RCPT, DATA, and QUIT are counted.
15739
15740
15741 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15742 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15743 check by setting this option. The default value makes it apply to all hosts. By
15744 changing the value, you can exclude any badly-behaved hosts that you have to
15745 live with.
15746
15747
15748 . Allow this long option name to split; give it unsplit as a fifth argument
15749 . for the automatic .oindex that is generated by .option.
15750 . We insert " &~&~" which is both pretty nasty visually and results in
15751 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15752 . zero-width-space, which would be nicer visually and results in (at least)
15753 . html that Firefox will split on when it's forced to reflow (rather than
15754 . inserting a horizontal scrollbar).  However, the text is still not
15755 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15756 . the option name to split.
15757
15758 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15759          smtp_accept_max_per_connection
15760 .cindex "SMTP" "limiting incoming message count"
15761 .cindex "limit" "messages per SMTP connection"
15762 The value of this option limits the number of MAIL commands that Exim is
15763 prepared to accept over a single SMTP connection, whether or not each command
15764 results in the transfer of a message. After the limit is reached, a 421
15765 response is given to subsequent MAIL commands. This limit is a safety
15766 precaution against a client that goes mad (incidents of this type have been
15767 seen).
15768
15769
15770 .option smtp_accept_max_per_host main string&!! unset
15771 .cindex "limit" "SMTP connections from one host"
15772 .cindex "host" "limiting SMTP connections from"
15773 This option restricts the number of simultaneous IP connections from a single
15774 host (strictly, from a single IP address) to the Exim daemon. The option is
15775 expanded, to enable different limits to be applied to different hosts by
15776 reference to &$sender_host_address$&. Once the limit is reached, additional
15777 connection attempts from the same host are rejected with error code 421. This
15778 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15779 of zero imposes no limit. If this option is set greater than zero, it is
15780 required that &%smtp_accept_max%& be non-zero.
15781
15782 &*Warning*&: When setting this option you should not use any expansion
15783 constructions that take an appreciable amount of time. The expansion and test
15784 happen in the main daemon loop, in order to reject additional connections
15785 without forking additional processes (otherwise a denial-of-service attack
15786 could cause a vast number or processes to be created). While the daemon is
15787 doing this processing, it cannot accept any other incoming connections.
15788
15789
15790
15791 .option smtp_accept_queue main integer 0
15792 .cindex "SMTP" "incoming connection count"
15793 .cindex "queueing incoming messages"
15794 .cindex "message" "queueing by SMTP connection count"
15795 If the number of simultaneous incoming SMTP connections being handled via the
15796 listening daemon exceeds this value, messages received by SMTP are just placed
15797 on the queue; no delivery processes are started automatically. The count is
15798 fixed at the start of an SMTP connection. It cannot be updated in the
15799 subprocess that receives messages, and so the queueing or not queueing applies
15800 to all messages received in the same connection.
15801
15802 A value of zero implies no limit, and clearly any non-zero value is useful only
15803 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15804 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15805 various &%-od%&&'x'& command line options.
15806
15807
15808 . See the comment on smtp_accept_max_per_connection
15809
15810 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15811          smtp_accept_queue_per_connection
15812 .cindex "queueing incoming messages"
15813 .cindex "message" "queueing by message count"
15814 This option limits the number of delivery processes that Exim starts
15815 automatically when receiving messages via SMTP, whether via the daemon or by
15816 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15817 and the number of messages received in a single SMTP session exceeds this
15818 number, subsequent messages are placed on the queue, but no delivery processes
15819 are started. This helps to limit the number of Exim processes when a server
15820 restarts after downtime and there is a lot of mail waiting for it on other
15821 systems. On large systems, the default should probably be increased, and on
15822 dial-in client systems it should probably be set to zero (that is, disabled).
15823
15824
15825 .option smtp_accept_reserve main integer 0
15826 .cindex "SMTP" "incoming call count"
15827 .cindex "host" "reserved"
15828 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15829 number of SMTP connections that are reserved for connections from the hosts
15830 that are specified in &%smtp_reserve_hosts%&. The value set in
15831 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15832 restricted to this number of connections; the option specifies a minimum number
15833 of connection slots for them, not a maximum. It is a guarantee that this group
15834 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15835 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15836 individual host.
15837
15838 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15839 set to 5, once there are 45 active connections (from any hosts), new
15840 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15841 provided the other criteria for acceptance are met.
15842
15843
15844 .option smtp_active_hostname main string&!! unset
15845 .cindex "host" "name in SMTP responses"
15846 .cindex "SMTP" "host name in responses"
15847 .vindex "&$primary_hostname$&"
15848 This option is provided for multi-homed servers that want to masquerade as
15849 several different hosts. At the start of an incoming SMTP connection, its value
15850 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15851 responses. For example, it is used as domain name in the response to an
15852 incoming HELO or EHLO command.
15853
15854 .vindex "&$smtp_active_hostname$&"
15855 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15856 is saved with any messages that are received. It is therefore available for use
15857 in routers and transports when the message is later delivered.
15858
15859 If this option is unset, or if its expansion is forced to fail, or if the
15860 expansion results in an empty string, the value of &$primary_hostname$& is
15861 used. Other expansion failures cause a message to be written to the main and
15862 panic logs, and the SMTP command receives a temporary error. Typically, the
15863 value of &%smtp_active_hostname%& depends on the incoming interface address.
15864 For example:
15865 .code
15866 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15867   {cox.mydomain}{box.mydomain}}
15868 .endd
15869
15870 Although &$smtp_active_hostname$& is primarily concerned with incoming
15871 messages, it is also used as the default for HELO commands in callout
15872 verification if there is no remote transport from which to obtain a
15873 &%helo_data%& value.
15874
15875 .option smtp_banner main string&!! "see below"
15876 .cindex "SMTP" "welcome banner"
15877 .cindex "banner for SMTP"
15878 .cindex "welcome banner for SMTP"
15879 .cindex "customizing" "SMTP banner"
15880 This string, which is expanded every time it is used, is output as the initial
15881 positive response to an SMTP connection. The default setting is:
15882 .code
15883 smtp_banner = $smtp_active_hostname ESMTP Exim \
15884   $version_number $tod_full
15885 .endd
15886 Failure to expand the string causes a panic error. If you want to create a
15887 multiline response to the initial SMTP connection, use &"\n"& in the string at
15888 appropriate points, but not at the end. Note that the 220 code is not included
15889 in this string. Exim adds it automatically (several times in the case of a
15890 multiline response).
15891
15892
15893 .option smtp_check_spool_space main boolean true
15894 .cindex "checking disk space"
15895 .cindex "disk space, checking"
15896 .cindex "spool directory" "checking space"
15897 When this option is set, if an incoming SMTP session encounters the SIZE
15898 option on a MAIL command, it checks that there is enough space in the
15899 spool directory's partition to accept a message of that size, while still
15900 leaving free the amount specified by &%check_spool_space%& (even if that value
15901 is zero). If there isn't enough space, a temporary error code is returned.
15902
15903
15904 .option smtp_connect_backlog main integer 20
15905 .cindex "connection backlog"
15906 .cindex "SMTP" "connection backlog"
15907 .cindex "backlog of connections"
15908 This option specifies a maximum number of waiting SMTP connections. Exim passes
15909 this value to the TCP/IP system when it sets up its listener. Once this number
15910 of connections are waiting for the daemon's attention, subsequent connection
15911 attempts are refused at the TCP/IP level. At least, that is what the manuals
15912 say; in some circumstances such connection attempts have been observed to time
15913 out instead. For large systems it is probably a good idea to increase the
15914 value (to 50, say). It also gives some protection against denial-of-service
15915 attacks by SYN flooding.
15916
15917
15918 .option smtp_enforce_sync main boolean true
15919 .cindex "SMTP" "synchronization checking"
15920 .cindex "synchronization checking in SMTP"
15921 The SMTP protocol specification requires the client to wait for a response from
15922 the server at certain points in the dialogue. Without PIPELINING these
15923 synchronization points are after every command; with PIPELINING they are
15924 fewer, but they still exist.
15925
15926 Some spamming sites send out a complete set of SMTP commands without waiting
15927 for any response. Exim protects against this by rejecting a message if the
15928 client has sent further input when it should not have. The error response &"554
15929 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15930 for this error cannot be perfect because of transmission delays (unexpected
15931 input may be on its way but not yet received when Exim checks). However, it
15932 does detect many instances.
15933
15934 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15935 If you want to disable the check selectively (for example, only for certain
15936 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15937 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15938
15939
15940
15941 .option smtp_etrn_command main string&!! unset
15942 .cindex "ETRN" "command to be run"
15943 .vindex "&$domain$&"
15944 If this option is set, the given command is run whenever an SMTP ETRN
15945 command is received from a host that is permitted to issue such commands (see
15946 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15947 are independently expanded. The expansion variable &$domain$& is set to the
15948 argument of the ETRN command, and no syntax checking is done on it. For
15949 example:
15950 .code
15951 smtp_etrn_command = /etc/etrn_command $domain \
15952                     $sender_host_address
15953 .endd
15954 A new process is created to run the command, but Exim does not wait for it to
15955 complete. Consequently, its status cannot be checked. If the command cannot be
15956 run, a line is written to the panic log, but the ETRN caller still receives
15957 a 250 success response. Exim is normally running under its own uid when
15958 receiving SMTP, so it is not possible for it to change the uid before running
15959 the command.
15960
15961
15962 .option smtp_etrn_serialize main boolean true
15963 .cindex "ETRN" "serializing"
15964 When this option is set, it prevents the simultaneous execution of more than
15965 one identical command as a result of ETRN in an SMTP connection. See
15966 section &<<SECTETRN>>& for details.
15967
15968
15969 .option smtp_load_reserve main fixed-point unset
15970 .cindex "load average"
15971 If the system load average ever gets higher than this, incoming SMTP calls are
15972 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15973 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15974 the load is over the limit. The option has no effect on ancient operating
15975 systems on which Exim cannot determine the load average. See also
15976 &%deliver_queue_load_max%& and &%queue_only_load%&.
15977
15978
15979
15980 .option smtp_max_synprot_errors main integer 3
15981 .cindex "SMTP" "limiting syntax and protocol errors"
15982 .cindex "limit" "SMTP syntax and protocol errors"
15983 Exim rejects SMTP commands that contain syntax or protocol errors. In
15984 particular, a syntactically invalid email address, as in this command:
15985 .code
15986 RCPT TO:<abc xyz@a.b.c>
15987 .endd
15988 causes immediate rejection of the command, before any other tests are done.
15989 (The ACL cannot be run if there is no valid address to set up for it.) An
15990 example of a protocol error is receiving RCPT before MAIL. If there are
15991 too many syntax or protocol errors in one SMTP session, the connection is
15992 dropped. The limit is set by this option.
15993
15994 .cindex "PIPELINING" "expected errors"
15995 When the PIPELINING extension to SMTP is in use, some protocol errors are
15996 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15997 Exim assumes that PIPELINING will be used if it advertises it (see
15998 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15999 not count towards the limit.
16000
16001
16002
16003 .option smtp_max_unknown_commands main integer 3
16004 .cindex "SMTP" "limiting unknown commands"
16005 .cindex "limit" "unknown SMTP commands"
16006 If there are too many unrecognized commands in an incoming SMTP session, an
16007 Exim server drops the connection. This is a defence against some kinds of abuse
16008 that subvert web
16009 clients
16010 into making connections to SMTP ports; in these circumstances, a number of
16011 non-SMTP command lines are sent first.
16012
16013
16014
16015 .option smtp_ratelimit_hosts main "host list&!!" unset
16016 .cindex "SMTP" "rate limiting"
16017 .cindex "limit" "rate of message arrival"
16018 .cindex "RCPT" "rate limiting"
16019 Some sites find it helpful to be able to limit the rate at which certain hosts
16020 can send them messages, and the rate at which an individual message can specify
16021 recipients.
16022
16023 Exim has two rate-limiting facilities. This section describes the older
16024 facility, which can limit rates within a single connection. The newer
16025 &%ratelimit%& ACL condition can limit rates across all connections. See section
16026 &<<SECTratelimiting>>& for details of the newer facility.
16027
16028 When a host matches &%smtp_ratelimit_hosts%&, the values of
16029 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16030 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16031 respectively. Each option, if set, must contain a set of four comma-separated
16032 values:
16033
16034 .ilist
16035 A threshold, before which there is no rate limiting.
16036 .next
16037 An initial time delay. Unlike other times in Exim, numbers with decimal
16038 fractional parts are allowed here.
16039 .next
16040 A factor by which to increase the delay each time.
16041 .next
16042 A maximum value for the delay. This should normally be less than 5 minutes,
16043 because after that time, the client is liable to timeout the SMTP command.
16044 .endlist
16045
16046 For example, these settings have been used successfully at the site which
16047 first suggested this feature, for controlling mail from their customers:
16048 .code
16049 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16050 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16051 .endd
16052 The first setting specifies delays that are applied to MAIL commands after
16053 two have been received over a single connection. The initial delay is 0.5
16054 seconds, increasing by a factor of 1.05 each time. The second setting applies
16055 delays to RCPT commands when more than four occur in a single message.
16056
16057
16058 .option smtp_ratelimit_mail main string unset
16059 See &%smtp_ratelimit_hosts%& above.
16060
16061
16062 .option smtp_ratelimit_rcpt main string unset
16063 See &%smtp_ratelimit_hosts%& above.
16064
16065
16066 .option smtp_receive_timeout main time 5m
16067 .cindex "timeout" "for SMTP input"
16068 .cindex "SMTP" "input timeout"
16069 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16070 input, including batch SMTP. If a line of input (either an SMTP command or a
16071 data line) is not received within this time, the SMTP connection is dropped and
16072 the message is abandoned.
16073 A line is written to the log containing one of the following messages:
16074 .code
16075 SMTP command timeout on connection from...
16076 SMTP data timeout on connection from...
16077 .endd
16078 The former means that Exim was expecting to read an SMTP command; the latter
16079 means that it was in the DATA phase, reading the contents of a message.
16080
16081
16082 .oindex "&%-os%&"
16083 The value set by this option can be overridden by the
16084 &%-os%& command-line option. A setting of zero time disables the timeout, but
16085 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16086 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16087 timeout is controlled by &%receive_timeout%& and &%-or%&.
16088
16089
16090 .option smtp_reserve_hosts main "host list&!!" unset
16091 This option defines hosts for which SMTP connections are reserved; see
16092 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16093
16094
16095 .option smtp_return_error_details main boolean false
16096 .cindex "SMTP" "details policy failures"
16097 .cindex "policy control" "rejection, returning details"
16098 In the default state, Exim uses bland messages such as
16099 &"Administrative prohibition"& when it rejects SMTP commands for policy
16100 reasons. Many sysadmins like this because it gives away little information
16101 to spammers. However, some other sysadmins who are applying strict checking
16102 policies want to give out much fuller information about failures. Setting
16103 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16104 example, instead of &"Administrative prohibition"&, it might give:
16105 .code
16106 550-Rejected after DATA: '>' missing at end of address:
16107 550 failing address in "From" header is: <user@dom.ain
16108 .endd
16109
16110 .option spamd_address main string "see below"
16111 This option is available when Exim is compiled with the content-scanning
16112 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16113 The default value is
16114 .code
16115 127.0.0.1 783
16116 .endd
16117 See section &<<SECTscanspamass>>& for more details.
16118
16119
16120
16121 .option split_spool_directory main boolean false
16122 .cindex "multiple spool directories"
16123 .cindex "spool directory" "split"
16124 .cindex "directories, multiple"
16125 If this option is set, it causes Exim to split its input directory into 62
16126 subdirectories, each with a single alphanumeric character as its name. The
16127 sixth character of the message id is used to allocate messages to
16128 subdirectories; this is the least significant base-62 digit of the time of
16129 arrival of the message.
16130
16131 Splitting up the spool in this way may provide better performance on systems
16132 where there are long mail queues, by reducing the number of files in any one
16133 directory. The msglog directory is also split up in a similar way to the input
16134 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16135 are still placed in the single directory &_msglog.OLD_&.
16136
16137 It is not necessary to take any special action for existing messages when
16138 changing &%split_spool_directory%&. Exim notices messages that are in the
16139 &"wrong"& place, and continues to process them. If the option is turned off
16140 after a period of being on, the subdirectories will eventually empty and be
16141 automatically deleted.
16142
16143 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16144 changes. Instead of creating a list of all messages in the queue, and then
16145 trying to deliver each one in turn, it constructs a list of those in one
16146 sub-directory and tries to deliver them, before moving on to the next
16147 sub-directory. The sub-directories are processed in a random order. This
16148 spreads out the scanning of the input directories, and uses less memory. It is
16149 particularly beneficial when there are lots of messages on the queue. However,
16150 if &%queue_run_in_order%& is set, none of this new processing happens. The
16151 entire queue has to be scanned and sorted before any deliveries can start.
16152
16153
16154 .option spool_directory main string&!! "set at compile time"
16155 .cindex "spool directory" "path to"
16156 This defines the directory in which Exim keeps its spool, that is, the messages
16157 it is waiting to deliver. The default value is taken from the compile-time
16158 configuration setting, if there is one. If not, this option must be set. The
16159 string is expanded, so it can contain, for example, a reference to
16160 &$primary_hostname$&.
16161
16162 If the spool directory name is fixed on your installation, it is recommended
16163 that you set it at build time rather than from this option, particularly if the
16164 log files are being written to the spool directory (see &%log_file_path%&).
16165 Otherwise log files cannot be used for errors that are detected early on, such
16166 as failures in the configuration file.
16167
16168 By using this option to override the compiled-in path, it is possible to run
16169 tests of Exim without using the standard spool.
16170
16171 .option sqlite_lock_timeout main time 5s
16172 .cindex "sqlite lookup type" "lock timeout"
16173 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16174 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16175
16176 .option strict_acl_vars main boolean false
16177 .cindex "&ACL;" "variables, handling unset"
16178 This option controls what happens if a syntactically valid but undefined ACL
16179 variable is referenced. If it is false (the default), an empty string
16180 is substituted; if it is true, an error is generated. See section
16181 &<<SECTaclvariables>>& for details of ACL variables.
16182
16183 .option strip_excess_angle_brackets main boolean false
16184 .cindex "angle brackets, excess"
16185 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16186 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16187 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16188 passed on to another MTA, the excess angle brackets are not passed on. If this
16189 option is not set, multiple pairs of angle brackets cause a syntax error.
16190
16191
16192 .option strip_trailing_dot main boolean false
16193 .cindex "trailing dot on domain"
16194 .cindex "dot" "trailing on domain"
16195 If this option is set, a trailing dot at the end of a domain in an address is
16196 ignored. If this is in the envelope and the message is passed on to another
16197 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16198 domain causes a syntax error.
16199 However, addresses in header lines are checked only when an ACL requests header
16200 syntax checking.
16201
16202
16203 .option syslog_duplication main boolean true
16204 .cindex "syslog" "duplicate log lines; suppressing"
16205 When Exim is logging to syslog, it writes the log lines for its three
16206 separate logs at different syslog priorities so that they can in principle
16207 be separated on the logging hosts. Some installations do not require this
16208 separation, and in those cases, the duplication of certain log lines is a
16209 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16210 particular log line is written to syslog. For lines that normally go to
16211 both the main log and the reject log, the reject log version (possibly
16212 containing message header lines) is written, at LOG_NOTICE priority.
16213 Lines that normally go to both the main and the panic log are written at
16214 the LOG_ALERT priority.
16215
16216
16217 .option syslog_facility main string unset
16218 .cindex "syslog" "facility; setting"
16219 This option sets the syslog &"facility"& name, used when Exim is logging to
16220 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16221 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16222 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16223 details of Exim's logging.
16224
16225
16226
16227 .option syslog_processname main string &`exim`&
16228 .cindex "syslog" "process name; setting"
16229 This option sets the syslog &"ident"& name, used when Exim is logging to
16230 syslog. The value must be no longer than 32 characters. See chapter
16231 &<<CHAPlog>>& for details of Exim's logging.
16232
16233
16234
16235 .option syslog_timestamp main boolean true
16236 .cindex "syslog" "timestamps"
16237 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16238 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16239 details of Exim's logging.
16240
16241
16242 .option system_filter main string&!! unset
16243 .cindex "filter" "system filter"
16244 .cindex "system filter" "specifying"
16245 .cindex "Sieve filter" "not available for system filter"
16246 This option specifies an Exim filter file that is applied to all messages at
16247 the start of each delivery attempt, before any routing is done. System filters
16248 must be Exim filters; they cannot be Sieve filters. If the system filter
16249 generates any deliveries to files or pipes, or any new mail messages, the
16250 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16251 which transports are to be used. Details of this facility are given in chapter
16252 &<<CHAPsystemfilter>>&.
16253
16254
16255 .option system_filter_directory_transport main string&!! unset
16256 .vindex "&$address_file$&"
16257 This sets the name of the transport driver that is to be used when the
16258 &%save%& command in a system message filter specifies a path ending in &"/"&,
16259 implying delivery of each message into a separate file in some directory.
16260 During the delivery, the variable &$address_file$& contains the path name.
16261
16262
16263 .option system_filter_file_transport main string&!! unset
16264 .cindex "file" "transport for system filter"
16265 This sets the name of the transport driver that is to be used when the &%save%&
16266 command in a system message filter specifies a path not ending in &"/"&. During
16267 the delivery, the variable &$address_file$& contains the path name.
16268
16269 .option system_filter_group main string unset
16270 .cindex "gid (group id)" "system filter"
16271 This option is used only when &%system_filter_user%& is also set. It sets the
16272 gid under which the system filter is run, overriding any gid that is associated
16273 with the user. The value may be numerical or symbolic.
16274
16275 .option system_filter_pipe_transport main string&!! unset
16276 .cindex "&(pipe)& transport" "for system filter"
16277 .vindex "&$address_pipe$&"
16278 This specifies the transport driver that is to be used when a &%pipe%& command
16279 is used in a system filter. During the delivery, the variable &$address_pipe$&
16280 contains the pipe command.
16281
16282
16283 .option system_filter_reply_transport main string&!! unset
16284 .cindex "&(autoreply)& transport" "for system filter"
16285 This specifies the transport driver that is to be used when a &%mail%& command
16286 is used in a system filter.
16287
16288
16289 .option system_filter_user main string unset
16290 .cindex "uid (user id)" "system filter"
16291 If this option is set to root, the system filter is run in the main Exim
16292 delivery process, as root.  Otherwise, the system filter runs in a separate
16293 process, as the given user, defaulting to the Exim run-time user.
16294 Unless the string consists entirely of digits, it
16295 is looked up in the password data. Failure to find the named user causes a
16296 configuration error. The gid is either taken from the password data, or
16297 specified by &%system_filter_group%&. When the uid is specified numerically,
16298 &%system_filter_group%& is required to be set.
16299
16300 If the system filter generates any pipe, file, or reply deliveries, the uid
16301 under which the filter is run is used when transporting them, unless a
16302 transport option overrides.
16303
16304
16305 .option tcp_nodelay main boolean true
16306 .cindex "daemon" "TCP_NODELAY on sockets"
16307 .cindex "Nagle algorithm"
16308 .cindex "TCP_NODELAY on listening sockets"
16309 If this option is set false, it stops the Exim daemon setting the
16310 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16311 turns off the &"Nagle algorithm"&, which is a way of improving network
16312 performance in interactive (character-by-character) situations. Turning it off
16313 should improve Exim's performance a bit, so that is what happens by default.
16314 However, it appears that some broken clients cannot cope, and time out. Hence
16315 this option. It affects only those sockets that are set up for listening by the
16316 daemon. Sockets created by the smtp transport for delivering mail always set
16317 TCP_NODELAY.
16318
16319
16320 .option timeout_frozen_after main time 0s
16321 .cindex "frozen messages" "timing out"
16322 .cindex "timeout" "frozen messages"
16323 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16324 message of any kind that has been on the queue for longer than the given time
16325 is automatically cancelled at the next queue run. If the frozen message is a
16326 bounce message, it is just discarded; otherwise, a bounce is sent to the
16327 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16328 If you want to timeout frozen bounce messages earlier than other kinds of
16329 frozen message, see &%ignore_bounce_errors_after%&.
16330
16331 &*Note:*& the default value of zero means no timeouts; with this setting,
16332 frozen messages remain on the queue forever (except for any frozen bounce
16333 messages that are released by &%ignore_bounce_errors_after%&).
16334
16335
16336 .option timezone main string unset
16337 .cindex "timezone, setting"
16338 The value of &%timezone%& is used to set the environment variable TZ while
16339 running Exim (if it is different on entry). This ensures that all timestamps
16340 created by Exim are in the required timezone. If you want all your timestamps
16341 to be in UTC (aka GMT) you should set
16342 .code
16343 timezone = UTC
16344 .endd
16345 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16346 or, if that is not set, from the value of the TZ environment variable when Exim
16347 is built. If &%timezone%& is set to the empty string, either at build or run
16348 time, any existing TZ variable is removed from the environment when Exim
16349 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16350 unfortunately not all, operating systems.
16351
16352
16353 .option tls_advertise_hosts main "host list&!!" unset
16354 .cindex "TLS" "advertising"
16355 .cindex "encryption" "on SMTP connection"
16356 .cindex "SMTP" "encrypted connection"
16357 When Exim is built with support for TLS encrypted connections, the availability
16358 of the STARTTLS command to set up an encrypted session is advertised in
16359 response to EHLO only to those client hosts that match this option. See
16360 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16361
16362
16363 .option tls_certificate main string&!! unset
16364 .cindex "TLS" "server certificate; location of"
16365 .cindex "certificate" "server, location of"
16366 The value of this option is expanded, and must then be the absolute path to a
16367 file which contains the server's certificates. The server's private key is also
16368 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16369 &<<CHAPTLS>>& for further details.
16370
16371 &*Note*&: The certificates defined by this option are used only when Exim is
16372 receiving incoming messages as a server. If you want to supply certificates for
16373 use when sending messages as a client, you must set the &%tls_certificate%&
16374 option in the relevant &(smtp)& transport.
16375
16376 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16377 if the OpenSSL build supports TLS extensions and the TLS client sends the
16378 Server Name Indication extension, then this option and others documented in
16379 &<<SECTtlssni>>& will be re-expanded.
16380
16381 .option tls_crl main string&!! unset
16382 .cindex "TLS" "server certificate revocation list"
16383 .cindex "certificate" "revocation list for server"
16384 This option specifies a certificate revocation list. The expanded value must
16385 be the name of a file that contains a CRL in PEM format.
16386
16387 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16388
16389
16390 .option tls_dh_max_bits main integer 2236
16391 .cindex "TLS" "D-H bit count"
16392 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16393 the chosen TLS library.  That value might prove to be too high for
16394 interoperability.  This option provides a maximum clamp on the value
16395 suggested, trading off security for interoperability.
16396
16397 The value must be at least 1024.
16398
16399 The value 2236 was chosen because, at time of adding the option, it was the
16400 hard-coded maximum value supported by the NSS cryptographic library, as used
16401 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16402
16403 If you prefer more security and are willing to break some clients, raise this
16404 number.
16405
16406 Note that the value passed to GnuTLS for *generating* a new prime may be a
16407 little less than this figure, because GnuTLS is inexact and may produce a
16408 larger prime than requested.
16409
16410
16411 .option tls_dhparam main string&!! unset
16412 .cindex "TLS" "D-H parameters for server"
16413 The value of this option is expanded and indicates the source of DH parameters
16414 to be used by Exim.
16415
16416 If it is a filename starting with a &`/`&, then it names a file from which DH
16417 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16418 PKCS#3 representation of the DH prime.  If the file does not exist, for
16419 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16420 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16421 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16422 and treated as though the &%tls_dhparam%& were set to "none".
16423
16424 If this option expands to the string "none", then no DH parameters will be
16425 loaded by Exim.
16426
16427 If this option expands to the string "historic" and Exim is using GnuTLS, then
16428 Exim will attempt to load a file from inside the spool directory.  If the file
16429 does not exist, Exim will attempt to create it.
16430 See section &<<SECTgnutlsparam>>& for further details.
16431
16432 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16433 a default DH prime; the default is the 2048 bit prime described in section
16434 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16435 in IKE is assigned number 23.
16436
16437 Otherwise, the option must expand to the name used by Exim for any of a number
16438 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16439 "ike" followed by the number used by IKE, of "default" which corresponds to
16440 "ike23".
16441
16442 The available primes are:
16443 &`ike1`&, &`ike2`&, &`ike5`&,
16444 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16445 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16446
16447 Some of these will be too small to be accepted by clients.
16448 Some may be too large to be accepted by clients.
16449
16450 The TLS protocol does not negotiate an acceptable size for this; clients tend
16451 to hard-drop connections if what is offered by the server is unacceptable,
16452 whether too large or too small, and there's no provision for the client to
16453 tell the server what these constraints are.  Thus, as a server operator, you
16454 need to make an educated guess as to what is most likely to work for your
16455 userbase.
16456
16457 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16458 is most likely to maximise interoperability.  The upper bound comes from
16459 applications using the Mozilla Network Security Services (NSS) library, which
16460 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16461 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16462 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16463 acceptable bound from 1024 to 2048.
16464
16465
16466 .option tls_ocsp_file main string&!! unset
16467 This option
16468 must if set expand to the absolute path to a file which contains a current
16469 status proof for the server's certificate, as obtained from the
16470 Certificate Authority.
16471
16472
16473 .option tls_on_connect_ports main "string list" unset
16474 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16475 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16476 set up without waiting for the client to issue a STARTTLS command. For
16477 further details, see section &<<SECTsupobssmt>>&.
16478
16479
16480
16481 .option tls_privatekey main string&!! unset
16482 .cindex "TLS" "server private key; location of"
16483 The value of this option is expanded, and must then be the absolute path to a
16484 file which contains the server's private key. If this option is unset, or if
16485 the expansion is forced to fail, or the result is an empty string, the private
16486 key is assumed to be in the same file as the server's certificates. See chapter
16487 &<<CHAPTLS>>& for further details.
16488
16489 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16490
16491
16492 .option tls_remember_esmtp main boolean false
16493 .cindex "TLS" "esmtp state; remembering"
16494 .cindex "TLS" "broken clients"
16495 If this option is set true, Exim violates the RFCs by remembering that it is in
16496 &"esmtp"& state after successfully negotiating a TLS session. This provides
16497 support for broken clients that fail to send a new EHLO after starting a
16498 TLS session.
16499
16500
16501 .option tls_require_ciphers main string&!! unset
16502 .cindex "TLS" "requiring specific ciphers"
16503 .cindex "cipher" "requiring specific"
16504 This option controls which ciphers can be used for incoming TLS connections.
16505 The &(smtp)& transport has an option of the same name for controlling outgoing
16506 connections. This option is expanded for each connection, so can be varied for
16507 different clients if required. The value of this option must be a list of
16508 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16509 in somewhat different ways. If GnuTLS is being used, the client controls the
16510 preference order of the available ciphers. Details are given in sections
16511 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16512
16513
16514 .option tls_try_verify_hosts main "host list&!!" unset
16515 .cindex "TLS" "client certificate verification"
16516 .cindex "certificate" "verification of client"
16517 See &%tls_verify_hosts%& below.
16518
16519
16520 .option tls_verify_certificates main string&!! system
16521 .cindex "TLS" "client certificate verification"
16522 .cindex "certificate" "verification of client"
16523 The value of this option is expanded, and must then be either the
16524 word "system"
16525 or the absolute path to
16526 a file or directory containing permitted certificates for clients that
16527 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16528
16529 The "system" value for the option will use a
16530 system default location compiled into the SSL library.
16531 This is not available for GnuTLS versions preceding 3.0.20,
16532 and will be taken as empty; an explicit location
16533 must be specified.
16534
16535 The use of a directory for the option value is not avilable for GnuTLS versions
16536 preceding 3.3.6 and a single file must be used.
16537
16538 With OpenSSL the certificates specified
16539 explicitly
16540 either by file or directory
16541 are added to those given by the system default location.
16542
16543 With OpenSSL the certificates specified
16544 explicitly
16545 either by file or directory
16546 are added to those given by the system default location.
16547
16548 These certificates should be for the certificate authorities trusted, rather
16549 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16550 the value is a file then the certificates are sent by Exim as a server to
16551 connecting clients, defining the list of accepted certificate authorities.
16552 Thus the values defined should be considered public data.  To avoid this,
16553 use the explicit directory version.
16554
16555 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16556
16557 A forced expansion failure or setting to an empty string is equivalent to
16558 being unset.
16559
16560
16561 .option tls_verify_hosts main "host list&!!" unset
16562 .cindex "TLS" "client certificate verification"
16563 .cindex "certificate" "verification of client"
16564 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16565 certificates from clients. The expected certificates are defined by
16566 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16567 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16568 &%tls_verify_certificates%& is not set.
16569
16570 Any client that matches &%tls_verify_hosts%& is constrained by
16571 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16572 present one of the listed certificates. If it does not, the connection is
16573 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16574 the host to use TLS. It can still send SMTP commands through unencrypted
16575 connections. Forcing a client to use TLS has to be done separately using an
16576 ACL to reject inappropriate commands when the connection is not encrypted.
16577
16578 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16579 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16580 certificate and checks it against &%tls_verify_certificates%&, but does not
16581 abort the connection if there is no certificate or if it does not match. This
16582 state can be detected in an ACL, which makes it possible to implement policies
16583 such as &"accept for relay only if a verified certificate has been received,
16584 but accept for local delivery if encrypted, even without a verified
16585 certificate"&.
16586
16587 Client hosts that match neither of these lists are not asked to present
16588 certificates.
16589
16590
16591 .option trusted_groups main "string list&!!" unset
16592 .cindex "trusted groups"
16593 .cindex "groups" "trusted"
16594 This option is expanded just once, at the start of Exim's processing. If this
16595 option is set, any process that is running in one of the listed groups, or
16596 which has one of them as a supplementary group, is trusted. The groups can be
16597 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16598 details of what trusted callers are permitted to do. If neither
16599 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16600 are trusted.
16601
16602 .option trusted_users main "string list&!!" unset
16603 .cindex "trusted users"
16604 .cindex "user" "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 as one of the listed users is
16607 trusted. The users can be specified numerically or by name. See section
16608 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16609 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16610 Exim user are trusted.
16611
16612 .option unknown_login main string&!! unset
16613 .cindex "uid (user id)" "unknown caller"
16614 .vindex "&$caller_uid$&"
16615 This is a specialized feature for use in unusual configurations. By default, if
16616 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16617 gives up. The &%unknown_login%& option can be used to set a login name to be
16618 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16619 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16620 is used for the user's real name (gecos field), unless this has been set by the
16621 &%-F%& option.
16622
16623 .option unknown_username main string unset
16624 See &%unknown_login%&.
16625
16626 .option untrusted_set_sender main "address list&!!" unset
16627 .cindex "trusted users"
16628 .cindex "sender" "setting by untrusted user"
16629 .cindex "untrusted user setting sender"
16630 .cindex "user" "untrusted setting sender"
16631 .cindex "envelope sender"
16632 When an untrusted user submits a message to Exim using the standard input, Exim
16633 normally creates an envelope sender address from the user's login and the
16634 default qualification domain. Data from the &%-f%& option (for setting envelope
16635 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16636 is used) is ignored.
16637
16638 However, untrusted users are permitted to set an empty envelope sender address,
16639 to declare that a message should never generate any bounces. For example:
16640 .code
16641 exim -f '<>' user@domain.example
16642 .endd
16643 .vindex "&$sender_ident$&"
16644 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16645 other envelope sender addresses in a controlled way. When it is set, untrusted
16646 users are allowed to set envelope sender addresses that match any of the
16647 patterns in the list. Like all address lists, the string is expanded. The
16648 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16649 users to setting senders that start with their login ids
16650 followed by a hyphen
16651 by a setting like this:
16652 .code
16653 untrusted_set_sender = ^$sender_ident-
16654 .endd
16655 If you want to allow untrusted users to set envelope sender addresses without
16656 restriction, you can use
16657 .code
16658 untrusted_set_sender = *
16659 .endd
16660 The &%untrusted_set_sender%& option applies to all forms of local input, but
16661 only to the setting of the envelope sender. It does not permit untrusted users
16662 to use the other options which trusted user can use to override message
16663 parameters. Furthermore, it does not stop Exim from removing an existing
16664 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16665 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16666 overriding these actions. The handling of the &'Sender:'& header is also
16667 described in section &<<SECTthesenhea>>&.
16668
16669 The log line for a message's arrival shows the envelope sender following
16670 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16671 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16672 envelope sender address, the user's login is shown in parentheses after the
16673 sender address.
16674
16675
16676 .option uucp_from_pattern main string "see below"
16677 .cindex "&""From""& line"
16678 .cindex "UUCP" "&""From""& line"
16679 Some applications that pass messages to an MTA via a command line interface use
16680 an initial line starting with &"From&~"& to pass the envelope sender. In
16681 particular, this is used by UUCP software. Exim recognizes such a line by means
16682 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16683 matches, the sender address is constructed by expanding the contents of
16684 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16685 default pattern recognizes lines in the following two forms:
16686 .code
16687 From ph10 Fri Jan  5 12:35 GMT 1996
16688 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16689 .endd
16690 The pattern can be seen by running
16691 .code
16692 exim -bP uucp_from_pattern
16693 .endd
16694 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16695 year in the second case. The first word after &"From&~"& is matched in the
16696 regular expression by a parenthesized subpattern. The default value for
16697 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16698 (&"ph10"& in the example above) as the message's sender. See also
16699 &%ignore_fromline_hosts%&.
16700
16701
16702 .option uucp_from_sender main string&!! &`$1`&
16703 See &%uucp_from_pattern%& above.
16704
16705
16706 .option warn_message_file main string unset
16707 .cindex "warning of delay" "customizing the message"
16708 .cindex "customizing" "warning message"
16709 This option defines a template file containing paragraphs of text to be used
16710 for constructing the warning message which is sent by Exim when a message has
16711 been on the queue for a specified amount of time, as specified by
16712 &%delay_warning%&. Details of the file's contents are given in chapter
16713 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16714
16715
16716 .option write_rejectlog main boolean true
16717 .cindex "reject log" "disabling"
16718 If this option is set false, Exim no longer writes anything to the reject log.
16719 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16720 .ecindex IIDconfima
16721 .ecindex IIDmaiconf
16722
16723
16724
16725
16726 . ////////////////////////////////////////////////////////////////////////////
16727 . ////////////////////////////////////////////////////////////////////////////
16728
16729 .chapter "Generic options for routers" "CHAProutergeneric"
16730 .scindex IIDgenoprou1 "options" "generic; for routers"
16731 .scindex IIDgenoprou2 "generic options" "router"
16732 This chapter describes the generic options that apply to all routers.
16733 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16734
16735 For a general description of how a router operates, see sections
16736 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16737 which the preconditions are tested. The order of expansion of the options that
16738 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16739 &%headers_remove%&, &%transport%&.
16740
16741
16742
16743 .option address_data routers string&!! unset
16744 .cindex "router" "data attached to address"
16745 The string is expanded just before the router is run, that is, after all the
16746 precondition tests have succeeded. If the expansion is forced to fail, the
16747 router declines, the value of &%address_data%& remains unchanged, and the
16748 &%more%& option controls what happens next. Other expansion failures cause
16749 delivery of the address to be deferred.
16750
16751 .vindex "&$address_data$&"
16752 When the expansion succeeds, the value is retained with the address, and can be
16753 accessed using the variable &$address_data$& in the current router, subsequent
16754 routers, and the eventual transport.
16755
16756 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16757 that runs a user's filter file, the contents of &$address_data$& are accessible
16758 in the filter. This is not normally a problem, because such data is usually
16759 either not confidential or it &"belongs"& to the current user, but if you do
16760 put confidential data into &$address_data$& you need to remember this point.
16761
16762 Even if the router declines or passes, the value of &$address_data$& remains
16763 with the address, though it can be changed by another &%address_data%& setting
16764 on a subsequent router. If a router generates child addresses, the value of
16765 &$address_data$& propagates to them. This also applies to the special kind of
16766 &"child"& that is generated by a router with the &%unseen%& option.
16767
16768 The idea of &%address_data%& is that you can use it to look up a lot of data
16769 for the address once, and then pick out parts of the data later. For example,
16770 you could use a single LDAP lookup to return a string of the form
16771 .code
16772 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16773 .endd
16774 In the transport you could pick out the mailbox by a setting such as
16775 .code
16776 file = ${extract{mailbox}{$address_data}}
16777 .endd
16778 This makes the configuration file less messy, and also reduces the number of
16779 lookups (though Exim does cache lookups).
16780
16781 .vindex "&$sender_address_data$&"
16782 .vindex "&$address_data$&"
16783 The &%address_data%& facility is also useful as a means of passing information
16784 from one router to another, and from a router to a transport. In addition, if
16785 &$address_data$& is set by a router when verifying a recipient address from an
16786 ACL, it remains available for use in the rest of the ACL statement. After
16787 verifying a sender, the value is transferred to &$sender_address_data$&.
16788
16789
16790
16791 .option address_test routers&!? boolean true
16792 .oindex "&%-bt%&"
16793 .cindex "router" "skipping when address testing"
16794 If this option is set false, the router is skipped when routing is being tested
16795 by means of the &%-bt%& command line option. This can be a convenience when
16796 your first router sends messages to an external scanner, because it saves you
16797 having to set the &"already scanned"& indicator when testing real address
16798 routing.
16799
16800
16801
16802 .option cannot_route_message routers string&!! unset
16803 .cindex "router" "customizing &""cannot route""& message"
16804 .cindex "customizing" "&""cannot route""& message"
16805 This option specifies a text message that is used when an address cannot be
16806 routed because Exim has run out of routers. The default message is
16807 &"Unrouteable address"&. This option is useful only on routers that have
16808 &%more%& set false, or on the very last router in a configuration, because the
16809 value that is used is taken from the last router that is considered. This
16810 includes a router that is skipped because its preconditions are not met, as
16811 well as a router that declines. For example, using the default configuration,
16812 you could put:
16813 .code
16814 cannot_route_message = Remote domain not found in DNS
16815 .endd
16816 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16817 and
16818 .code
16819 cannot_route_message = Unknown local user
16820 .endd
16821 on the final router that checks for local users. If string expansion fails for
16822 this option, the default message is used. Unless the expansion failure was
16823 explicitly forced, a message about the failure is written to the main and panic
16824 logs, in addition to the normal message about the routing failure.
16825
16826
16827 .option caseful_local_part routers boolean false
16828 .cindex "case of local parts"
16829 .cindex "router" "case of local parts"
16830 By default, routers handle the local parts of addresses in a case-insensitive
16831 manner, though the actual case is preserved for transmission with the message.
16832 If you want the case of letters to be significant in a router, you must set
16833 this option true. For individual router options that contain address or local
16834 part lists (for example, &%local_parts%&), case-sensitive matching can be
16835 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16836 more details.
16837
16838 .vindex "&$local_part$&"
16839 .vindex "&$original_local_part$&"
16840 .vindex "&$parent_local_part$&"
16841 The value of the &$local_part$& variable is forced to lower case while a
16842 router is running unless &%caseful_local_part%& is set. When a router assigns
16843 an address to a transport, the value of &$local_part$& when the transport runs
16844 is the same as it was in the router. Similarly, when a router generates child
16845 addresses by aliasing or forwarding, the values of &$original_local_part$&
16846 and &$parent_local_part$& are those that were used by the redirecting router.
16847
16848 This option applies to the processing of an address by a router. When a
16849 recipient address is being processed in an ACL, there is a separate &%control%&
16850 modifier that can be used to specify case-sensitive processing within the ACL
16851 (see section &<<SECTcontrols>>&).
16852
16853
16854
16855 .option check_local_user routers&!? boolean false
16856 .cindex "local user, checking in router"
16857 .cindex "router" "checking for local user"
16858 .cindex "&_/etc/passwd_&"
16859 .vindex "&$home$&"
16860 When this option is true, Exim checks that the local part of the recipient
16861 address (with affixes removed if relevant) is the name of an account on the
16862 local system. The check is done by calling the &[getpwnam()]& function rather
16863 than trying to read &_/etc/passwd_& directly. This means that other methods of
16864 holding password data (such as NIS) are supported. If the local part is a local
16865 user, &$home$& is set from the password data, and can be tested in other
16866 preconditions that are evaluated after this one (the order of evaluation is
16867 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16868 overridden by &%router_home_directory%&. If the local part is not a local user,
16869 the router is skipped.
16870
16871 If you want to check that the local part is either the name of a local user
16872 or matches something else, you cannot combine &%check_local_user%& with a
16873 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16874 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16875 setting to achieve this. For example:
16876 .code
16877 local_parts = passwd;$local_part : lsearch;/etc/other/users
16878 .endd
16879 Note, however, that the side effects of &%check_local_user%& (such as setting
16880 up a home directory) do not occur when a &(passwd)& lookup is used in a
16881 &%local_parts%& (or any other) precondition.
16882
16883
16884
16885 .option condition routers&!? string&!! unset
16886 .cindex "router" "customized precondition"
16887 This option specifies a general precondition test that has to succeed for the
16888 router to be called. The &%condition%& option is the last precondition to be
16889 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16890 result is a forced failure, or an empty string, or one of the strings &"0"& or
16891 &"no"& or &"false"& (checked without regard to the case of the letters), the
16892 router is skipped, and the address is offered to the next one.
16893
16894 If the result is any other value, the router is run (as this is the last
16895 precondition to be evaluated, all the other preconditions must be true).
16896
16897 This option is unusual in that multiple &%condition%& options may be present.
16898 All &%condition%& options must succeed.
16899
16900 The &%condition%& option provides a means of applying custom conditions to the
16901 running of routers. Note that in the case of a simple conditional expansion,
16902 the default expansion values are exactly what is wanted. For example:
16903 .code
16904 condition = ${if >{$message_age}{600}}
16905 .endd
16906 Because of the default behaviour of the string expansion, this is equivalent to
16907 .code
16908 condition = ${if >{$message_age}{600}{true}{}}
16909 .endd
16910
16911 A multiple condition example, which succeeds:
16912 .code
16913 condition = ${if >{$message_age}{600}}
16914 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16915 condition = foobar
16916 .endd
16917
16918 If the expansion fails (other than forced failure) delivery is deferred. Some
16919 of the other precondition options are common special cases that could in fact
16920 be specified using &%condition%&.
16921
16922 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16923 are far older, and use one set of semantics.  ACLs are newer and when
16924 they were created, the ACL &%condition%& process was given far stricter
16925 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
16926 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
16927 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
16928 Router rules processing behavior.
16929
16930 This is best illustrated in an example:
16931 .code
16932 # If used in an ACL condition will fail with a syntax error, but
16933 # in a router condition any extra characters are treated as a string
16934
16935 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16936 true {yes} {no}}
16937
16938 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16939  {yes} {no}}
16940 .endd
16941 In each example above, the &%if%& statement actually ends after
16942 &"{google.com}}"&.  Since no true or false braces were defined, the
16943 default &%if%& behavior is to return a boolean true or a null answer
16944 (which evaluates to false). The rest of the line is then treated as a
16945 string. So the first example resulted in the boolean answer &"true"&
16946 with the string &" {yes} {no}}"& appended to it. The second example
16947 resulted in the null output (indicating false) with the string
16948 &" {yes} {no}}"& appended to it.
16949
16950 In fact you can put excess forward braces in too.  In the router
16951 &%condition%&, Exim's parser only looks for &"{"& symbols when they
16952 mean something, like after a &"$"& or when required as part of a
16953 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16954 string characters.
16955
16956 Thus, in a Router, the above expansion strings will both always evaluate
16957 true, as the result of expansion is a non-empty string which doesn't
16958 match an explicit false value.  This can be tricky to debug.  By
16959 contrast, in an ACL either of those strings will always result in an
16960 expansion error because the result doesn't look sufficiently boolean.
16961
16962
16963 .option debug_print routers string&!! unset
16964 .cindex "testing" "variables in drivers"
16965 If this option is set and debugging is enabled (see the &%-d%& command line
16966 option) or in address-testing mode (see the &%-bt%& command line option),
16967 the string is expanded and included in the debugging output.
16968 If expansion of the string fails, the error message is written to the debugging
16969 output, and Exim carries on processing.
16970 This option is provided to help with checking out the values of variables and
16971 so on when debugging router configurations. For example, if a &%condition%&
16972 option appears not to be working, &%debug_print%& can be used to output the
16973 variables it references. The output happens after checks for &%domains%&,
16974 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16975 are tested. A newline is added to the text if it does not end with one.
16976 The variable &$router_name$& contains the name of the router.
16977
16978
16979
16980 .option disable_logging routers boolean false
16981 If this option is set true, nothing is logged for any routing errors
16982 or for any deliveries caused by this router. You should not set this option
16983 unless you really, really know what you are doing. See also the generic
16984 transport option of the same name.
16985
16986
16987 .option domains routers&!? "domain list&!!" unset
16988 .cindex "router" "restricting to specific domains"
16989 .vindex "&$domain_data$&"
16990 If this option is set, the router is skipped unless the current domain matches
16991 the list. If the match is achieved by means of a file lookup, the data that the
16992 lookup returned for the domain is placed in &$domain_data$& for use in string
16993 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16994 a list of the order in which preconditions are evaluated.
16995
16996
16997
16998 .option driver routers string unset
16999 This option must always be set. It specifies which of the available routers is
17000 to be used.
17001
17002
17003 .option dsn_lasthop routers boolean false
17004 .cindex "DSN" "success"
17005 .cindex "Delivery Status Notification" "success"
17006 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17007 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17008 instead send a success DSN as if the next hop does not support DSN.
17009 Not effective on redirect routers.
17010
17011
17012
17013 .option errors_to routers string&!! unset
17014 .cindex "envelope sender"
17015 .cindex "router" "changing address for errors"
17016 If a router successfully handles an address, it may assign the address to a
17017 transport for delivery or it may generate child addresses. In both cases, if
17018 there is a delivery problem during later processing, the resulting bounce
17019 message is sent to the address that results from expanding this string,
17020 provided that the address verifies successfully. The &%errors_to%& option is
17021 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17022
17023 The &%errors_to%& setting associated with an address can be overridden if it
17024 subsequently passes through other routers that have their own &%errors_to%&
17025 settings, or if the message is delivered by a transport with a &%return_path%&
17026 setting.
17027
17028 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17029 the expansion fails to verify, the errors address associated with the incoming
17030 address is used. At top level, this is the envelope sender. A non-forced
17031 expansion failure causes delivery to be deferred.
17032
17033 If an address for which &%errors_to%& has been set ends up being delivered over
17034 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17035 any bounces that are generated by other MTAs on the delivery route are also
17036 sent there. You can set &%errors_to%& to the empty string by either of these
17037 settings:
17038 .code
17039 errors_to =
17040 errors_to = ""
17041 .endd
17042 An expansion item that yields an empty string has the same effect. If you do
17043 this, a locally detected delivery error for addresses processed by this router
17044 no longer gives rise to a bounce message; the error is discarded. If the
17045 address is delivered to a remote host, the return path is set to &`<>`&, unless
17046 overridden by the &%return_path%& option on the transport.
17047
17048 .vindex "&$address_data$&"
17049 If for some reason you want to discard local errors, but use a non-empty
17050 MAIL command for remote delivery, you can preserve the original return
17051 path in &$address_data$& in the router, and reinstate it in the transport by
17052 setting &%return_path%&.
17053
17054 The most common use of &%errors_to%& is to direct mailing list bounces to the
17055 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17056 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17057
17058
17059
17060 .option expn routers&!? boolean true
17061 .cindex "address" "testing"
17062 .cindex "testing" "addresses"
17063 .cindex "EXPN" "router skipping"
17064 .cindex "router" "skipping for EXPN"
17065 If this option is turned off, the router is skipped when testing an address
17066 as a result of processing an SMTP EXPN command. You might, for example,
17067 want to turn it off on a router for users' &_.forward_& files, while leaving it
17068 on for the system alias file.
17069 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17070 are evaluated.
17071
17072 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17073 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17074 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17075
17076
17077
17078 .option fail_verify routers boolean false
17079 .cindex "router" "forcing verification failure"
17080 Setting this option has the effect of setting both &%fail_verify_sender%& and
17081 &%fail_verify_recipient%& to the same value.
17082
17083
17084
17085 .option fail_verify_recipient routers boolean false
17086 If this option is true and an address is accepted by this router when
17087 verifying a recipient, verification fails.
17088
17089
17090
17091 .option fail_verify_sender routers boolean false
17092 If this option is true and an address is accepted by this router when
17093 verifying a sender, verification fails.
17094
17095
17096
17097 .option fallback_hosts routers "string list" unset
17098 .cindex "router" "fallback hosts"
17099 .cindex "fallback" "hosts specified on router"
17100 String expansion is not applied to this option. The argument must be a
17101 colon-separated list of host names or IP addresses. The list separator can be
17102 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17103 each name or address. In fact, the format of each item is exactly the same as
17104 defined for the list of hosts in a &(manualroute)& router (see section
17105 &<<SECTformatonehostitem>>&).
17106
17107 If a router queues an address for a remote transport, this host list is
17108 associated with the address, and used instead of the transport's fallback host
17109 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17110 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17111 transport for further details.
17112
17113
17114 .option group routers string&!! "see below"
17115 .cindex "gid (group id)" "local delivery"
17116 .cindex "local transports" "uid and gid"
17117 .cindex "transport" "local"
17118 .cindex "router" "setting group"
17119 When a router queues an address for a transport, and the transport does not
17120 specify a group, the group given here is used when running the delivery
17121 process.
17122 The group may be specified numerically or by name. If expansion fails, the
17123 error is logged and delivery is deferred.
17124 The default is unset, unless &%check_local_user%& is set, when the default
17125 is taken from the password information. See also &%initgroups%& and &%user%&
17126 and the discussion in chapter &<<CHAPenvironment>>&.
17127
17128
17129
17130 .option headers_add routers list&!! unset
17131 .cindex "header lines" "adding"
17132 .cindex "router" "adding header lines"
17133 This option specifies a list of text headers, newline-separated,
17134 that is associated with any addresses that are accepted by the router.
17135 Each item is separately expanded, at routing time.  However, this
17136 option has no effect when an address is just being verified. The way in which
17137 the text is used to add header lines at transport time is described in section
17138 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17139 message is in the process of being transported. This means that references to
17140 header lines in string expansions in the transport's configuration do not
17141 &"see"& the added header lines.
17142
17143 The &%headers_add%& option is expanded after &%errors_to%&, but before
17144 &%headers_remove%& and &%transport%&. If an item is empty, or if
17145 an item expansion is forced to fail, the item has no effect. Other expansion
17146 failures are treated as configuration errors.
17147
17148 Unlike most options, &%headers_add%& can be specified multiple times
17149 for a router; all listed headers are added.
17150
17151 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17152 router that has the &%one_time%& option set.
17153
17154 .cindex "duplicate addresses"
17155 .oindex "&%unseen%&"
17156 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17157 additions are deleted when the address is passed on to subsequent routers.
17158 For a &%redirect%& router, if a generated address is the same as the incoming
17159 address, this can lead to duplicate addresses with different header
17160 modifications. Exim does not do duplicate deliveries (except, in certain
17161 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17162 which of the duplicates is discarded, so this ambiguous situation should be
17163 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17164
17165
17166
17167 .option headers_remove routers list&!! unset
17168 .cindex "header lines" "removing"
17169 .cindex "router" "removing header lines"
17170 This option specifies a list of text headers, colon-separated,
17171 that is associated with any addresses that are accepted by the router.
17172 Each item is separately expanded, at routing time.  However, this
17173 option has no effect when an address is just being verified. The way in which
17174 the text is used to remove header lines at transport time is described in
17175 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17176 the message is in the process of being transported. This means that references
17177 to header lines in string expansions in the transport's configuration still
17178 &"see"& the original header lines.
17179
17180 The &%headers_remove%& option is expanded after &%errors_to%& and
17181 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17182 the item has no effect. Other expansion failures are treated as configuration
17183 errors.
17184
17185 Unlike most options, &%headers_remove%& can be specified multiple times
17186 for a router; all listed headers are removed.
17187
17188 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17189 router that has the &%one_time%& option set.
17190
17191 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17192 removal requests are deleted when the address is passed on to subsequent
17193 routers, and this can lead to problems with duplicates -- see the similar
17194 warning for &%headers_add%& above.
17195
17196
17197 .option ignore_target_hosts routers "host list&!!" unset
17198 .cindex "IP address" "discarding"
17199 .cindex "router" "discarding IP addresses"
17200 Although this option is a host list, it should normally contain IP address
17201 entries rather than names. If any host that is looked up by the router has an
17202 IP address that matches an item in this list, Exim behaves as if that IP
17203 address did not exist. This option allows you to cope with rogue DNS entries
17204 like
17205 .code
17206 remote.domain.example.  A  127.0.0.1
17207 .endd
17208 by setting
17209 .code
17210 ignore_target_hosts = 127.0.0.1
17211 .endd
17212 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17213 discarded in this way, the router declines. In a conventional configuration, an
17214 attempt to mail to such a domain would normally provoke the &"unrouteable
17215 domain"& error, and an attempt to verify an address in the domain would fail.
17216 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17217 router declines if presented with one of the listed addresses.
17218
17219 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17220 means of the first or the second of the following settings, respectively:
17221 .code
17222 ignore_target_hosts = 0.0.0.0/0
17223 ignore_target_hosts = <; 0::0/0
17224 .endd
17225 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17226 in the second line matches all IPv6 addresses.
17227
17228 This option may also be useful for ignoring link-local and site-local IPv6
17229 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17230 is expanded before use as a list, it is possible to make it dependent on the
17231 domain that is being routed.
17232
17233 .vindex "&$host_address$&"
17234 During its expansion, &$host_address$& is set to the IP address that is being
17235 checked.
17236
17237 .option initgroups routers boolean false
17238 .cindex "additional groups"
17239 .cindex "groups" "additional"
17240 .cindex "local transports" "uid and gid"
17241 .cindex "transport" "local"
17242 If the router queues an address for a transport, and this option is true, and
17243 the uid supplied by the router is not overridden by the transport, the
17244 &[initgroups()]& function is called when running the transport to ensure that
17245 any additional groups associated with the uid are set up. See also &%group%&
17246 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17247
17248
17249
17250 .option local_part_prefix routers&!? "string list" unset
17251 .cindex "router" "prefix for local part"
17252 .cindex "prefix" "for local part, used in router"
17253 If this option is set, the router is skipped unless the local part starts with
17254 one of the given strings, or &%local_part_prefix_optional%& is true. See
17255 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17256 evaluated.
17257
17258 The list is scanned from left to right, and the first prefix that matches is
17259 used. A limited form of wildcard is available; if the prefix begins with an
17260 asterisk, it matches the longest possible sequence of arbitrary characters at
17261 the start of the local part. An asterisk should therefore always be followed by
17262 some character that does not occur in normal local parts.
17263 .cindex "multiple mailboxes"
17264 .cindex "mailbox" "multiple"
17265 Wildcarding can be used to set up multiple user mailboxes, as described in
17266 section &<<SECTmulbox>>&.
17267
17268 .vindex "&$local_part$&"
17269 .vindex "&$local_part_prefix$&"
17270 During the testing of the &%local_parts%& option, and while the router is
17271 running, the prefix is removed from the local part, and is available in the
17272 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17273 the router accepts the address, this remains true during subsequent delivery by
17274 a transport. In particular, the local part that is transmitted in the RCPT
17275 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17276 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17277 the relevant transport.
17278
17279 When an address is being verified, &%local_part_prefix%& affects only the
17280 behaviour of the router. If the callout feature of verification is in use, this
17281 means that the full address, including the prefix, will be used during the
17282 callout.
17283
17284 The prefix facility is commonly used to handle local parts of the form
17285 &%owner-something%&. Another common use is to support local parts of the form
17286 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17287 to tell a user their forwarding is broken &-- by placing a router like this one
17288 immediately before the router that handles &_.forward_& files:
17289 .code
17290 real_localuser:
17291   driver = accept
17292   local_part_prefix = real-
17293   check_local_user
17294   transport = local_delivery
17295 .endd
17296 For security, it would probably be a good idea to restrict the use of this
17297 router to locally-generated messages, using a condition such as this:
17298 .code
17299   condition = ${if match {$sender_host_address}\
17300                          {\N^(|127\.0\.0\.1)$\N}}
17301 .endd
17302
17303 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17304 both conditions must be met if not optional. Care must be taken if wildcards
17305 are used in both a prefix and a suffix on the same router. Different
17306 separator characters must be used to avoid ambiguity.
17307
17308
17309 .option local_part_prefix_optional routers boolean false
17310 See &%local_part_prefix%& above.
17311
17312
17313
17314 .option local_part_suffix routers&!? "string list" unset
17315 .cindex "router" "suffix for local part"
17316 .cindex "suffix for local part" "used in router"
17317 This option operates in the same way as &%local_part_prefix%&, except that the
17318 local part must end (rather than start) with the given string, the
17319 &%local_part_suffix_optional%& option determines whether the suffix is
17320 mandatory, and the wildcard * character, if present, must be the last
17321 character of the suffix. This option facility is commonly used to handle local
17322 parts of the form &%something-request%& and multiple user mailboxes of the form
17323 &%username-foo%&.
17324
17325
17326 .option local_part_suffix_optional routers boolean false
17327 See &%local_part_suffix%& above.
17328
17329
17330
17331 .option local_parts routers&!? "local part list&!!" unset
17332 .cindex "router" "restricting to specific local parts"
17333 .cindex "local part" "checking in router"
17334 The router is run only if the local part of the address matches the list.
17335 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17336 are evaluated, and
17337 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17338 string is expanded, it is possible to make it depend on the domain, for
17339 example:
17340 .code
17341 local_parts = dbm;/usr/local/specials/$domain
17342 .endd
17343 .vindex "&$local_part_data$&"
17344 If the match is achieved by a lookup, the data that the lookup returned
17345 for the local part is placed in the variable &$local_part_data$& for use in
17346 expansions of the router's private options. You might use this option, for
17347 example, if you have a large number of local virtual domains, and you want to
17348 send all postmaster mail to the same place without having to set up an alias in
17349 each virtual domain:
17350 .code
17351 postmaster:
17352   driver = redirect
17353   local_parts = postmaster
17354   data = postmaster@real.domain.example
17355 .endd
17356
17357
17358 .option log_as_local routers boolean "see below"
17359 .cindex "log" "delivery line"
17360 .cindex "delivery" "log line format"
17361 Exim has two logging styles for delivery, the idea being to make local
17362 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17363 recipient address is given just as the local part, without a domain. The use of
17364 this style is controlled by this option. It defaults to true for the &(accept)&
17365 router, and false for all the others. This option applies only when a
17366 router assigns an address to a transport. It has no effect on routers that
17367 redirect addresses.
17368
17369
17370
17371 .option more routers boolean&!! true
17372 The result of string expansion for this option must be a valid boolean value,
17373 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17374 result causes an error, and delivery is deferred. If the expansion is forced to
17375 fail, the default value for the option (true) is used. Other failures cause
17376 delivery to be deferred.
17377
17378 If this option is set false, and the router declines to handle the address, no
17379 further routers are tried, routing fails, and the address is bounced.
17380 .oindex "&%self%&"
17381 However, if the router explicitly passes an address to the following router by
17382 means of the setting
17383 .code
17384 self = pass
17385 .endd
17386 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17387 does not affect the behaviour if one of the precondition tests fails. In that
17388 case, the address is always passed to the next router.
17389
17390 Note that &%address_data%& is not considered to be a precondition. If its
17391 expansion is forced to fail, the router declines, and the value of &%more%&
17392 controls what happens next.
17393
17394
17395 .option pass_on_timeout routers boolean false
17396 .cindex "timeout" "of router"
17397 .cindex "router" "timeout"
17398 If a router times out during a host lookup, it normally causes deferral of the
17399 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17400 router, overriding &%no_more%&. This may be helpful for systems that are
17401 intermittently connected to the Internet, or those that want to pass to a smart
17402 host any messages that cannot immediately be delivered.
17403
17404 There are occasional other temporary errors that can occur while doing DNS
17405 lookups. They are treated in the same way as a timeout, and this option
17406 applies to all of them.
17407
17408
17409
17410 .option pass_router routers string unset
17411 .cindex "router" "go to after &""pass""&"
17412 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17413 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17414 routing to continue, and overriding a false setting of &%more%&. When one of
17415 these routers returns &"pass"&, the address is normally handed on to the next
17416 router in sequence. This can be changed by setting &%pass_router%& to the name
17417 of another router. However (unlike &%redirect_router%&) the named router must
17418 be below the current router, to avoid loops. Note that this option applies only
17419 to the special case of &"pass"&. It does not apply when a router returns
17420 &"decline"& because it cannot handle an address.
17421
17422
17423
17424 .option redirect_router routers string unset
17425 .cindex "router" "start at after redirection"
17426 Sometimes an administrator knows that it is pointless to reprocess addresses
17427 generated from alias or forward files with the same router again. For
17428 example, if an alias file translates real names into login ids there is no
17429 point searching the alias file a second time, especially if it is a large file.
17430
17431 The &%redirect_router%& option can be set to the name of any router instance.
17432 It causes the routing of any generated addresses to start at the named router
17433 instead of at the first router. This option has no effect if the router in
17434 which it is set does not generate new addresses.
17435
17436
17437
17438 .option require_files routers&!? "string list&!!" unset
17439 .cindex "file" "requiring for router"
17440 .cindex "router" "requiring file existence"
17441 This option provides a general mechanism for predicating the running of a
17442 router on the existence or non-existence of certain files or directories.
17443 Before running a router, as one of its precondition tests, Exim works its way
17444 through the &%require_files%& list, expanding each item separately.
17445
17446 Because the list is split before expansion, any colons in expansion items must
17447 be doubled, or the facility for using a different list separator must be used.
17448 If any expansion is forced to fail, the item is ignored. Other expansion
17449 failures cause routing of the address to be deferred.
17450
17451 If any expanded string is empty, it is ignored. Otherwise, except as described
17452 below, each string must be a fully qualified file path, optionally preceded by
17453 &"!"&. The paths are passed to the &[stat()]& function to test for the
17454 existence of the files or directories. The router is skipped if any paths not
17455 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17456
17457 .cindex "NFS"
17458 If &[stat()]& cannot determine whether a file exists or not, delivery of
17459 the message is deferred. This can happen when NFS-mounted filesystems are
17460 unavailable.
17461
17462 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17463 options, so you cannot use it to check for the existence of a file in which to
17464 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17465 full list of the order in which preconditions are evaluated.) However, as
17466 these options are all expanded, you can use the &%exists%& expansion condition
17467 to make such tests. The &%require_files%& option is intended for checking files
17468 that the router may be going to use internally, or which are needed by a
17469 transport (for example &_.procmailrc_&).
17470
17471 During delivery, the &[stat()]& function is run as root, but there is a
17472 facility for some checking of the accessibility of a file by another user.
17473 This is not a proper permissions check, but just a &"rough"& check that
17474 operates as follows:
17475
17476 If an item in a &%require_files%& list does not contain any forward slash
17477 characters, it is taken to be the user (and optional group, separated by a
17478 comma) to be checked for subsequent files in the list. If no group is specified
17479 but the user is specified symbolically, the gid associated with the uid is
17480 used. For example:
17481 .code
17482 require_files = mail:/some/file
17483 require_files = $local_part:$home/.procmailrc
17484 .endd
17485 If a user or group name in a &%require_files%& list does not exist, the
17486 &%require_files%& condition fails.
17487
17488 Exim performs the check by scanning along the components of the file path, and
17489 checking the access for the given uid and gid. It checks for &"x"& access on
17490 directories, and &"r"& access on the final file. Note that this means that file
17491 access control lists, if the operating system has them, are ignored.
17492
17493 &*Warning 1*&: When the router is being run to verify addresses for an
17494 incoming SMTP message, Exim is not running as root, but under its own uid. This
17495 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17496 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17497 user is not permitted to read one of the directories on the file's path.
17498
17499 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17500 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17501 without root access. In this case, if a check for access by a particular user
17502 is requested, Exim creates a subprocess that runs as that user, and tries the
17503 check again in that process.
17504
17505 The default action for handling an unresolved EACCES is to consider it to
17506 be caused by a configuration error, and routing is deferred because the
17507 existence or non-existence of the file cannot be determined. However, in some
17508 circumstances it may be desirable to treat this condition as if the file did
17509 not exist. If the file name (or the exclamation mark that precedes the file
17510 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17511 as if the file did not exist. For example:
17512 .code
17513 require_files = +/some/file
17514 .endd
17515 If the router is not an essential part of verification (for example, it
17516 handles users' &_.forward_& files), another solution is to set the &%verify%&
17517 option false so that the router is skipped when verifying.
17518
17519
17520
17521 .option retry_use_local_part routers boolean "see below"
17522 .cindex "hints database" "retry keys"
17523 .cindex "local part" "in retry keys"
17524 When a delivery suffers a temporary routing failure, a retry record is created
17525 in Exim's hints database. For addresses whose routing depends only on the
17526 domain, the key for the retry record should not involve the local part, but for
17527 other addresses, both the domain and the local part should be included.
17528 Usually, remote routing is of the former kind, and local routing is of the
17529 latter kind.
17530
17531 This option controls whether the local part is used to form the key for retry
17532 hints for addresses that suffer temporary errors while being handled by this
17533 router. The default value is true for any router that has &%check_local_user%&
17534 set, and false otherwise. Note that this option does not apply to hints keys
17535 for transport delays; they are controlled by a generic transport option of the
17536 same name.
17537
17538 The setting of &%retry_use_local_part%& applies only to the router on which it
17539 appears. If the router generates child addresses, they are routed
17540 independently; this setting does not become attached to them.
17541
17542
17543
17544 .option router_home_directory routers string&!! unset
17545 .cindex "router" "home directory for"
17546 .cindex "home directory" "for router"
17547 .vindex "&$home$&"
17548 This option sets a home directory for use while the router is running. (Compare
17549 &%transport_home_directory%&, which sets a home directory for later
17550 transporting.) In particular, if used on a &(redirect)& router, this option
17551 sets a value for &$home$& while a filter is running. The value is expanded;
17552 forced expansion failure causes the option to be ignored &-- other failures
17553 cause the router to defer.
17554
17555 Expansion of &%router_home_directory%& happens immediately after the
17556 &%check_local_user%& test (if configured), before any further expansions take
17557 place.
17558 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17559 are evaluated.)
17560 While the router is running, &%router_home_directory%& overrides the value of
17561 &$home$& that came from &%check_local_user%&.
17562
17563 When a router accepts an address and assigns it to a local transport (including
17564 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17565 delivery), the home directory setting for the transport is taken from the first
17566 of these values that is set:
17567
17568 .ilist
17569 The &%home_directory%& option on the transport;
17570 .next
17571 The &%transport_home_directory%& option on the router;
17572 .next
17573 The password data if &%check_local_user%& is set on the router;
17574 .next
17575 The &%router_home_directory%& option on the router.
17576 .endlist
17577
17578 In other words, &%router_home_directory%& overrides the password data for the
17579 router, but not for the transport.
17580
17581
17582
17583 .option self routers string freeze
17584 .cindex "MX record" "pointing to local host"
17585 .cindex "local host" "MX pointing to"
17586 This option applies to those routers that use a recipient address to find a
17587 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17588 and &(manualroute)& routers.
17589 Certain configurations of the &(queryprogram)& router can also specify a list
17590 of remote hosts.
17591 Usually such routers are configured to send the message to a remote host via an
17592 &(smtp)& transport. The &%self%& option specifies what happens when the first
17593 host on the list turns out to be the local host.
17594 The way in which Exim checks for the local host is described in section
17595 &<<SECTreclocipadd>>&.
17596
17597 Normally this situation indicates either an error in Exim's configuration (for
17598 example, the router should be configured not to process this domain), or an
17599 error in the DNS (for example, the MX should not point to this host). For this
17600 reason, the default action is to log the incident, defer the address, and
17601 freeze the message. The following alternatives are provided for use in special
17602 cases:
17603
17604 .vlist
17605 .vitem &%defer%&
17606 Delivery of the message is tried again later, but the message is not frozen.
17607
17608 .vitem "&%reroute%&: <&'domain'&>"
17609 The domain is changed to the given domain, and the address is passed back to
17610 be reprocessed by the routers. No rewriting of headers takes place. This
17611 behaviour is essentially a redirection.
17612
17613 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17614 The domain is changed to the given domain, and the address is passed back to be
17615 reprocessed by the routers. Any headers that contain the original domain are
17616 rewritten.
17617
17618 .vitem &%pass%&
17619 .oindex "&%more%&"
17620 .vindex "&$self_hostname$&"
17621 The router passes the address to the next router, or to the router named in the
17622 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17623 subsequent routing and delivery, the variable &$self_hostname$& contains the
17624 name of the local host that the router encountered. This can be used to
17625 distinguish between different cases for hosts with multiple names. The
17626 combination
17627 .code
17628 self = pass
17629 no_more
17630 .endd
17631 ensures that only those addresses that routed to the local host are passed on.
17632 Without &%no_more%&, addresses that were declined for other reasons would also
17633 be passed to the next router.
17634
17635 .vitem &%fail%&
17636 Delivery fails and an error report is generated.
17637
17638 .vitem &%send%&
17639 .cindex "local host" "sending to"
17640 The anomaly is ignored and the address is queued for the transport. This
17641 setting should be used with extreme caution. For an &(smtp)& transport, it
17642 makes sense only in cases where the program that is listening on the SMTP port
17643 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17644 different configuration file that handles the domain in another way.
17645 .endlist
17646
17647
17648
17649 .option senders routers&!? "address list&!!" unset
17650 .cindex "router" "checking senders"
17651 If this option is set, the router is skipped unless the message's sender
17652 address matches something on the list.
17653 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17654 are evaluated.
17655
17656 There are issues concerning verification when the running of routers is
17657 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17658 setting, it sets the sender to the null string. When using the &%-bt%& option
17659 to check a configuration file, it is necessary also to use the &%-f%& option to
17660 set an appropriate sender. For incoming mail, the sender is unset when
17661 verifying the sender, but is available when verifying any recipients. If the
17662 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17663 matters.
17664
17665
17666 .option translate_ip_address routers string&!! unset
17667 .cindex "IP address" "translating"
17668 .cindex "packet radio"
17669 .cindex "router" "IP address translation"
17670 There exist some rare networking situations (for example, packet radio) where
17671 it is helpful to be able to translate IP addresses generated by normal routing
17672 mechanisms into other IP addresses, thus performing a kind of manual IP
17673 routing. This should be done only if the normal IP routing of the TCP/IP stack
17674 is inadequate or broken. Because this is an extremely uncommon requirement, the
17675 code to support this option is not included in the Exim binary unless
17676 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17677
17678 .vindex "&$host_address$&"
17679 The &%translate_ip_address%& string is expanded for every IP address generated
17680 by the router, with the generated address set in &$host_address$&. If the
17681 expansion is forced to fail, no action is taken.
17682 For any other expansion error, delivery of the message is deferred.
17683 If the result of the expansion is an IP address, that replaces the original
17684 address; otherwise the result is assumed to be a host name &-- this is looked
17685 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17686 produce one or more replacement IP addresses. For example, to subvert all IP
17687 addresses in some specific networks, this could be added to a router:
17688 .code
17689 translate_ip_address = \
17690   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17691     {$value}fail}}
17692 .endd
17693 The file would contain lines like
17694 .code
17695 10.2.3.128/26    some.host
17696 10.8.4.34/26     10.44.8.15
17697 .endd
17698 You should not make use of this facility unless you really understand what you
17699 are doing.
17700
17701
17702
17703 .option transport routers string&!! unset
17704 This option specifies the transport to be used when a router accepts an address
17705 and sets it up for delivery. A transport is never needed if a router is used
17706 only for verification. The value of the option is expanded at routing time,
17707 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17708 and result must be the name of one of the configured transports. If it is not,
17709 delivery is deferred.
17710
17711 The &%transport%& option is not used by the &(redirect)& router, but it does
17712 have some private options that set up transports for pipe and file deliveries
17713 (see chapter &<<CHAPredirect>>&).
17714
17715
17716
17717 .option transport_current_directory routers string&!! unset
17718 .cindex "current directory for local transport"
17719 This option associates a current directory with any address that is routed
17720 to a local transport. This can happen either because a transport is
17721 explicitly configured for the router, or because it generates a delivery to a
17722 file or a pipe. During the delivery process (that is, at transport time), this
17723 option string is expanded and is set as the current directory, unless
17724 overridden by a setting on the transport.
17725 If the expansion fails for any reason, including forced failure, an error is
17726 logged, and delivery is deferred.
17727 See chapter &<<CHAPenvironment>>& for details of the local delivery
17728 environment.
17729
17730
17731
17732
17733 .option transport_home_directory routers string&!! "see below"
17734 .cindex "home directory" "for local transport"
17735 This option associates a home directory with any address that is routed to a
17736 local transport. This can happen either because a transport is explicitly
17737 configured for the router, or because it generates a delivery to a file or a
17738 pipe. During the delivery process (that is, at transport time), the option
17739 string is expanded and is set as the home directory, unless overridden by a
17740 setting of &%home_directory%& on the transport.
17741 If the expansion fails for any reason, including forced failure, an error is
17742 logged, and delivery is deferred.
17743
17744 If the transport does not specify a home directory, and
17745 &%transport_home_directory%& is not set for the router, the home directory for
17746 the transport is taken from the password data if &%check_local_user%& is set for
17747 the router. Otherwise it is taken from &%router_home_directory%& if that option
17748 is set; if not, no home directory is set for the transport.
17749
17750 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17751 environment.
17752
17753
17754
17755
17756 .option unseen routers boolean&!! false
17757 .cindex "router" "carrying on after success"
17758 The result of string expansion for this option must be a valid boolean value,
17759 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17760 result causes an error, and delivery is deferred. If the expansion is forced to
17761 fail, the default value for the option (false) is used. Other failures cause
17762 delivery to be deferred.
17763
17764 When this option is set true, routing does not cease if the router accepts the
17765 address. Instead, a copy of the incoming address is passed to the next router,
17766 overriding a false setting of &%more%&. There is little point in setting
17767 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17768 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17769 sometimes true and sometimes false).
17770
17771 .cindex "copy of message (&%unseen%& option)"
17772 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17773 qualifier in filter files. It can be used to cause copies of messages to be
17774 delivered to some other destination, while also carrying out a normal delivery.
17775 In effect, the current address is made into a &"parent"& that has two children
17776 &-- one that is delivered as specified by this router, and a clone that goes on
17777 to be routed further. For this reason, &%unseen%& may not be combined with the
17778 &%one_time%& option in a &(redirect)& router.
17779
17780 &*Warning*&: Header lines added to the address (or specified for removal) by
17781 this router or by previous routers affect the &"unseen"& copy of the message
17782 only. The clone that continues to be processed by further routers starts with
17783 no added headers and none specified for removal. For a &%redirect%& router, if
17784 a generated address is the same as the incoming address, this can lead to
17785 duplicate addresses with different header modifications. Exim does not do
17786 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17787 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17788 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17789 &%redirect%& router may be of help.
17790
17791 Unlike the handling of header modifications, any data that was set by the
17792 &%address_data%& option in the current or previous routers &'is'& passed on to
17793 subsequent routers.
17794
17795
17796 .option user routers string&!! "see below"
17797 .cindex "uid (user id)" "local delivery"
17798 .cindex "local transports" "uid and gid"
17799 .cindex "transport" "local"
17800 .cindex "router" "user for filter processing"
17801 .cindex "filter" "user for processing"
17802 When a router queues an address for a transport, and the transport does not
17803 specify a user, the user given here is used when running the delivery process.
17804 The user may be specified numerically or by name. If expansion fails, the
17805 error is logged and delivery is deferred.
17806 This user is also used by the &(redirect)& router when running a filter file.
17807 The default is unset, except when &%check_local_user%& is set. In this case,
17808 the default is taken from the password information. If the user is specified as
17809 a name, and &%group%& is not set, the group associated with the user is used.
17810 See also &%initgroups%& and &%group%& and the discussion in chapter
17811 &<<CHAPenvironment>>&.
17812
17813
17814
17815 .option verify routers&!? boolean true
17816 Setting this option has the effect of setting &%verify_sender%& and
17817 &%verify_recipient%& to the same value.
17818
17819
17820 .option verify_only routers&!? boolean false
17821 .cindex "EXPN" "with &%verify_only%&"
17822 .oindex "&%-bv%&"
17823 .cindex "router" "used only when verifying"
17824 If this option is set, the router is used only when verifying an address,
17825 delivering in cutthrough mode or
17826 testing with the &%-bv%& option, not when actually doing a delivery, testing
17827 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17828 restricted to verifying only senders or recipients by means of
17829 &%verify_sender%& and &%verify_recipient%&.
17830
17831 &*Warning*&: When the router is being run to verify addresses for an incoming
17832 SMTP message, Exim is not running as root, but under its own uid. If the router
17833 accesses any files, you need to make sure that they are accessible to the Exim
17834 user or group.
17835
17836
17837 .option verify_recipient routers&!? boolean true
17838 If this option is false, the router is skipped when verifying recipient
17839 addresses,
17840 delivering in cutthrough mode
17841 or testing recipient verification using &%-bv%&.
17842 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17843 are evaluated.
17844 See also the &$verify_mode$& variable.
17845
17846
17847 .option verify_sender routers&!? boolean true
17848 If this option is false, the router is skipped when verifying sender addresses
17849 or testing sender verification using &%-bvs%&.
17850 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17851 are evaluated.
17852 See also the &$verify_mode$& variable.
17853 .ecindex IIDgenoprou1
17854 .ecindex IIDgenoprou2
17855
17856
17857
17858
17859
17860
17861 . ////////////////////////////////////////////////////////////////////////////
17862 . ////////////////////////////////////////////////////////////////////////////
17863
17864 .chapter "The accept router" "CHID4"
17865 .cindex "&(accept)& router"
17866 .cindex "routers" "&(accept)&"
17867 The &(accept)& router has no private options of its own. Unless it is being
17868 used purely for verification (see &%verify_only%&) a transport is required to
17869 be defined by the generic &%transport%& option. If the preconditions that are
17870 specified by generic options are met, the router accepts the address and queues
17871 it for the given transport. The most common use of this router is for setting
17872 up deliveries to local mailboxes. For example:
17873 .code
17874 localusers:
17875   driver = accept
17876   domains = mydomain.example
17877   check_local_user
17878   transport = local_delivery
17879 .endd
17880 The &%domains%& condition in this example checks the domain of the address, and
17881 &%check_local_user%& checks that the local part is the login of a local user.
17882 When both preconditions are met, the &(accept)& router runs, and queues the
17883 address for the &(local_delivery)& transport.
17884
17885
17886
17887
17888
17889
17890 . ////////////////////////////////////////////////////////////////////////////
17891 . ////////////////////////////////////////////////////////////////////////////
17892
17893 .chapter "The dnslookup router" "CHAPdnslookup"
17894 .scindex IIDdnsrou1 "&(dnslookup)& router"
17895 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17896 The &(dnslookup)& router looks up the hosts that handle mail for the
17897 recipient's domain in the DNS. A transport must always be set for this router,
17898 unless &%verify_only%& is set.
17899
17900 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17901 SRV records. If none are found, or if SRV support is not configured,
17902 MX records are looked up. If no MX records exist, address records are sought.
17903 However, &%mx_domains%& can be set to disable the direct use of address
17904 records.
17905
17906 MX records of equal priority are sorted by Exim into a random order. Exim then
17907 looks for address records for the host names obtained from MX or SRV records.
17908 When a host has more than one IP address, they are sorted into a random order,
17909 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17910 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17911 generic option, the router declines.
17912
17913 Unless they have the highest priority (lowest MX value), MX records that point
17914 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17915 are discarded, together with any other MX records of equal or lower priority.
17916
17917 .cindex "MX record" "pointing to local host"
17918 .cindex "local host" "MX pointing to"
17919 .oindex "&%self%&" "in &(dnslookup)& router"
17920 If the host pointed to by the highest priority MX record, or looked up as an
17921 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17922 happens is controlled by the generic &%self%& option.
17923
17924
17925 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17926 There have been problems with DNS servers when SRV records are looked up.
17927 Some mis-behaving servers return a DNS error or timeout when a non-existent
17928 SRV record is sought. Similar problems have in the past been reported for
17929 MX records. The global &%dns_again_means_nonexist%& option can help with this
17930 problem, but it is heavy-handed because it is a global option.
17931
17932 For this reason, there are two options, &%srv_fail_domains%& and
17933 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17934 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17935 an attempt to look up an SRV or MX record causes one of these results, and the
17936 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17937 such record"&. In the case of an SRV lookup, this means that the router
17938 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17939 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17940 case routing fails.
17941
17942
17943 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17944 .cindex "&(dnslookup)& router" "declines"
17945 There are a few cases where a &(dnslookup)& router will decline to accept
17946 an address; if such a router is expected to handle "all remaining non-local
17947 domains", then it is important to set &%no_more%&.
17948
17949 Reasons for a &(dnslookup)& router to decline currently include:
17950 .ilist
17951 The domain does not exist in DNS
17952 .next
17953 The domain exists but the MX record's host part is just "."; this is a common
17954 convention (borrowed from SRV) used to indicate that there is no such service
17955 for this domain and to not fall back to trying A/AAAA records.
17956 .next
17957 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17958 .next
17959 MX record points to a non-existent host.
17960 .next
17961 MX record points to an IP address and the main section option
17962 &%allow_mx_to_ip%& is not set.
17963 .next
17964 MX records exist and point to valid hosts, but all hosts resolve only to
17965 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17966 .next
17967 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17968 &%dns_check_names_pattern%& for handling one variant of this)
17969 .next
17970 &%check_secondary_mx%& is set on this router but the local host can
17971 not be found in the MX records (see below)
17972 .endlist
17973
17974
17975
17976
17977 .section "Private options for dnslookup" "SECID118"
17978 .cindex "options" "&(dnslookup)& router"
17979 The private options for the &(dnslookup)& router are as follows:
17980
17981 .option check_secondary_mx dnslookup boolean false
17982 .cindex "MX record" "checking for secondary"
17983 If this option is set, the router declines unless the local host is found in
17984 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17985 process domains for which the local host is a secondary mail exchanger
17986 differently to other domains. The way in which Exim decides whether a host is
17987 the local host is described in section &<<SECTreclocipadd>>&.
17988
17989
17990 .option check_srv dnslookup string&!! unset
17991 .cindex "SRV record" "enabling use of"
17992 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17993 addition to MX and address records. The support is disabled by default. To
17994 enable SRV support, set the &%check_srv%& option to the name of the service
17995 required. For example,
17996 .code
17997 check_srv = smtp
17998 .endd
17999 looks for SRV records that refer to the normal smtp service. The option is
18000 expanded, so the service name can vary from message to message or address
18001 to address. This might be helpful if SRV records are being used for a
18002 submission service. If the expansion is forced to fail, the &%check_srv%&
18003 option is ignored, and the router proceeds to look for MX records in the
18004 normal way.
18005
18006 When the expansion succeeds, the router searches first for SRV records for
18007 the given service (it assumes TCP protocol). A single SRV record with a
18008 host name that consists of just a single dot indicates &"no such service for
18009 this domain"&; if this is encountered, the router declines. If other kinds of
18010 SRV record are found, they are used to construct a host list for delivery
18011 according to the rules of RFC 2782. MX records are not sought in this case.
18012
18013 When no SRV records are found, MX records (and address records) are sought in
18014 the traditional way. In other words, SRV records take precedence over MX
18015 records, just as MX records take precedence over address records. Note that
18016 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18017 defined it. It is apparently believed that MX records are sufficient for email
18018 and that SRV records should not be used for this purpose. However, SRV records
18019 have an additional &"weight"& feature which some people might find useful when
18020 trying to split an SMTP load between hosts of different power.
18021
18022 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18023 when there is a DNS lookup error.
18024
18025
18026
18027 .option dnssec_request_domains dnslookup "domain list&!!" unset
18028 .cindex "MX record" "security"
18029 .cindex "DNSSEC" "MX lookup"
18030 .cindex "security" "MX lookup"
18031 .cindex "DNS" "DNSSEC"
18032 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18033 the dnssec request bit set.
18034 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18035
18036
18037
18038 .option dnssec_require_domains dnslookup "domain list&!!" unset
18039 .cindex "MX record" "security"
18040 .cindex "DNSSEC" "MX lookup"
18041 .cindex "security" "MX lookup"
18042 .cindex "DNS" "DNSSEC"
18043 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18044 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18045 (AD bit) set wil be ignored and logged as a host-lookup failure.
18046 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18047
18048
18049
18050 .option mx_domains dnslookup "domain list&!!" unset
18051 .cindex "MX record" "required to exist"
18052 .cindex "SRV record" "required to exist"
18053 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18054 record in order to be recognized. (The name of this option could be improved.)
18055 For example, if all the mail hosts in &'fict.example'& are known to have MX
18056 records, except for those in &'discworld.fict.example'&, you could use this
18057 setting:
18058 .code
18059 mx_domains = ! *.discworld.fict.example : *.fict.example
18060 .endd
18061 This specifies that messages addressed to a domain that matches the list but
18062 has no MX record should be bounced immediately instead of being routed using
18063 the address record.
18064
18065
18066 .option mx_fail_domains dnslookup "domain list&!!" unset
18067 If the DNS lookup for MX records for one of the domains in this list causes a
18068 DNS lookup error, Exim behaves as if no MX records were found. See section
18069 &<<SECTprowitdnsloo>>& for more discussion.
18070
18071
18072
18073
18074 .option qualify_single dnslookup boolean true
18075 .cindex "DNS" "resolver options"
18076 .cindex "DNS" "qualifying single-component names"
18077 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18078 lookups. Typically, but not standardly, this causes the resolver to qualify
18079 single-component names with the default domain. For example, on a machine
18080 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18081 &'thesaurus.ref.example'& inside the resolver. For details of what your
18082 resolver actually does, consult your man pages for &'resolver'& and
18083 &'resolv.conf'&.
18084
18085
18086
18087 .option rewrite_headers dnslookup boolean true
18088 .cindex "rewriting" "header lines"
18089 .cindex "header lines" "rewriting"
18090 If the domain name in the address that is being processed is not fully
18091 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18092 an address is specified as &'dormouse@teaparty'&, the domain might be
18093 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18094 occur as a result of setting the &%widen_domains%& option. If
18095 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18096 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18097 header lines of the message are rewritten with the full domain name.
18098
18099 This option should be turned off only when it is known that no message is
18100 ever going to be sent outside an environment where the abbreviation makes
18101 sense.
18102
18103 When an MX record is looked up in the DNS and matches a wildcard record, name
18104 servers normally return a record containing the name that has been looked up,
18105 making it impossible to detect whether a wildcard was present or not. However,
18106 some name servers have recently been seen to return the wildcard entry. If the
18107 name returned by a DNS lookup begins with an asterisk, it is not used for
18108 header rewriting.
18109
18110
18111 .option same_domain_copy_routing dnslookup boolean false
18112 .cindex "address" "copying routing"
18113 Addresses with the same domain are normally routed by the &(dnslookup)& router
18114 to the same list of hosts. However, this cannot be presumed, because the router
18115 options and preconditions may refer to the local part of the address. By
18116 default, therefore, Exim routes each address in a message independently. DNS
18117 servers run caches, so repeated DNS lookups are not normally expensive, and in
18118 any case, personal messages rarely have more than a few recipients.
18119
18120 If you are running mailing lists with large numbers of subscribers at the same
18121 domain, and you are using a &(dnslookup)& router which is independent of the
18122 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18123 lookups for identical domains in one message. In this case, when &(dnslookup)&
18124 routes an address to a remote transport, any other unrouted addresses in the
18125 message that have the same domain are automatically given the same routing
18126 without processing them independently,
18127 provided the following conditions are met:
18128
18129 .ilist
18130 No router that processed the address specified &%headers_add%& or
18131 &%headers_remove%&.
18132 .next
18133 The router did not change the address in any way, for example, by &"widening"&
18134 the domain.
18135 .endlist
18136
18137
18138
18139
18140 .option search_parents dnslookup boolean false
18141 .cindex "DNS" "resolver options"
18142 When this option is true, the resolver option RES_DNSRCH is set for DNS
18143 lookups. This is different from the &%qualify_single%& option in that it
18144 applies to domains containing dots. Typically, but not standardly, it causes
18145 the resolver to search for the name in the current domain and in parent
18146 domains. For example, on a machine in the &'fict.example'& domain, if looking
18147 up &'teaparty.wonderland'& failed, the resolver would try
18148 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18149 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18150
18151 Setting this option true can cause problems in domains that have a wildcard MX
18152 record, because any domain that does not have its own MX record matches the
18153 local wildcard.
18154
18155
18156
18157 .option srv_fail_domains dnslookup "domain list&!!" unset
18158 If the DNS lookup for SRV records for one of the domains in this list causes a
18159 DNS lookup error, Exim behaves as if no SRV records were found. See section
18160 &<<SECTprowitdnsloo>>& for more discussion.
18161
18162
18163
18164
18165 .option widen_domains dnslookup "string list" unset
18166 .cindex "domain" "partial; widening"
18167 If a DNS lookup fails and this option is set, each of its strings in turn is
18168 added onto the end of the domain, and the lookup is tried again. For example,
18169 if
18170 .code
18171 widen_domains = fict.example:ref.example
18172 .endd
18173 is set and a lookup of &'klingon.dictionary'& fails,
18174 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18175 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18176 and &%search_parents%& options can cause some widening to be undertaken inside
18177 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18178 when verifying, unless &%rewrite_headers%& is false (not the default).
18179
18180
18181 .section "Effect of qualify_single and search_parents" "SECID119"
18182 When a domain from an envelope recipient is changed by the resolver as a result
18183 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18184 corresponding address in the message's header lines unless &%rewrite_headers%&
18185 is set false. Exim then re-routes the address, using the full domain.
18186
18187 These two options affect only the DNS lookup that takes place inside the router
18188 for the domain of the address that is being routed. They do not affect lookups
18189 such as that implied by
18190 .code
18191 domains = @mx_any
18192 .endd
18193 that may happen while processing a router precondition before the router is
18194 entered. No widening ever takes place for these lookups.
18195 .ecindex IIDdnsrou1
18196 .ecindex IIDdnsrou2
18197
18198
18199
18200
18201
18202
18203
18204
18205
18206 . ////////////////////////////////////////////////////////////////////////////
18207 . ////////////////////////////////////////////////////////////////////////////
18208
18209 .chapter "The ipliteral router" "CHID5"
18210 .cindex "&(ipliteral)& router"
18211 .cindex "domain literal" "routing"
18212 .cindex "routers" "&(ipliteral)&"
18213 This router has no private options. Unless it is being used purely for
18214 verification (see &%verify_only%&) a transport is required to be defined by the
18215 generic &%transport%& option. The router accepts the address if its domain part
18216 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18217 router handles the address
18218 .code
18219 root@[192.168.1.1]
18220 .endd
18221 by setting up delivery to the host with that IP address. IPv4 domain literals
18222 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18223 are similar, but the address is preceded by &`ipv6:`&. For example:
18224 .code
18225 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18226 .endd
18227 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18228 grounds that sooner or later somebody will try it.
18229
18230 .oindex "&%self%&" "in &(ipliteral)& router"
18231 If the IP address matches something in &%ignore_target_hosts%&, the router
18232 declines. If an IP literal turns out to refer to the local host, the generic
18233 &%self%& option determines what happens.
18234
18235 The RFCs require support for domain literals; however, their use is
18236 controversial in today's Internet. If you want to use this router, you must
18237 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18238 Exim will not recognize the domain literal syntax in addresses.
18239
18240
18241
18242 . ////////////////////////////////////////////////////////////////////////////
18243 . ////////////////////////////////////////////////////////////////////////////
18244
18245 .chapter "The iplookup router" "CHID6"
18246 .cindex "&(iplookup)& router"
18247 .cindex "routers" "&(iplookup)&"
18248 The &(iplookup)& router was written to fulfil a specific requirement in
18249 Cambridge University (which in fact no longer exists). For this reason, it is
18250 not included in the binary of Exim by default. If you want to include it, you
18251 must set
18252 .code
18253 ROUTER_IPLOOKUP=yes
18254 .endd
18255 in your &_Local/Makefile_& configuration file.
18256
18257 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18258 connection to one or more specific hosts. The host can then return the same or
18259 a different address &-- in effect rewriting the recipient address in the
18260 message's envelope. The new address is then passed on to subsequent routers. If
18261 this process fails, the address can be passed on to other routers, or delivery
18262 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18263 must not be specified for it.
18264
18265 .cindex "options" "&(iplookup)& router"
18266 .option hosts iplookup string unset
18267 This option must be supplied. Its value is a colon-separated list of host
18268 names. The hosts are looked up using &[gethostbyname()]&
18269 (or &[getipnodebyname()]& when available)
18270 and are tried in order until one responds to the query. If none respond, what
18271 happens is controlled by &%optional%&.
18272
18273
18274 .option optional iplookup boolean false
18275 If &%optional%& is true, if no response is obtained from any host, the address
18276 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18277 delivery to the address is deferred.
18278
18279
18280 .option port iplookup integer 0
18281 .cindex "port" "&(iplookup)& router"
18282 This option must be supplied. It specifies the port number for the TCP or UDP
18283 call.
18284
18285
18286 .option protocol iplookup string udp
18287 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18288 protocols is to be used.
18289
18290
18291 .option query iplookup string&!! "see below"
18292 This defines the content of the query that is sent to the remote hosts. The
18293 default value is:
18294 .code
18295 $local_part@$domain $local_part@$domain
18296 .endd
18297 The repetition serves as a way of checking that a response is to the correct
18298 query in the default case (see &%response_pattern%& below).
18299
18300
18301 .option reroute iplookup string&!! unset
18302 If this option is not set, the rerouted address is precisely the byte string
18303 returned by the remote host, up to the first white space, if any. If set, the
18304 string is expanded to form the rerouted address. It can include parts matched
18305 in the response by &%response_pattern%& by means of numeric variables such as
18306 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18307 whether or not a pattern is in use. In all cases, the rerouted address must end
18308 up in the form &'local_part@domain'&.
18309
18310
18311 .option response_pattern iplookup string unset
18312 This option can be set to a regular expression that is applied to the string
18313 returned from the remote host. If the pattern does not match the response, the
18314 router declines. If &%response_pattern%& is not set, no checking of the
18315 response is done, unless the query was defaulted, in which case there is a
18316 check that the text returned after the first white space is the original
18317 address. This checks that the answer that has been received is in response to
18318 the correct question. For example, if the response is just a new domain, the
18319 following could be used:
18320 .code
18321 response_pattern = ^([^@]+)$
18322 reroute = $local_part@$1
18323 .endd
18324
18325 .option timeout iplookup time 5s
18326 This specifies the amount of time to wait for a response from the remote
18327 machine. The same timeout is used for the &[connect()]& function for a TCP
18328 call. It does not apply to UDP.
18329
18330
18331
18332
18333 . ////////////////////////////////////////////////////////////////////////////
18334 . ////////////////////////////////////////////////////////////////////////////
18335
18336 .chapter "The manualroute router" "CHID7"
18337 .scindex IIDmanrou1 "&(manualroute)& router"
18338 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18339 .cindex "domain" "manually routing"
18340 The &(manualroute)& router is so-called because it provides a way of manually
18341 routing an address according to its domain. It is mainly used when you want to
18342 route addresses to remote hosts according to your own rules, bypassing the
18343 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18344 route to local transports, a facility that may be useful if you want to save
18345 messages for dial-in hosts in local files.
18346
18347 The &(manualroute)& router compares a list of domain patterns with the domain
18348 it is trying to route. If there is no match, the router declines. Each pattern
18349 has associated with it a list of hosts and some other optional data, which may
18350 include a transport. The combination of a pattern and its data is called a
18351 &"routing rule"&. For patterns that do not have an associated transport, the
18352 generic &%transport%& option must specify a transport, unless the router is
18353 being used purely for verification (see &%verify_only%&).
18354
18355 .vindex "&$host$&"
18356 In the case of verification, matching the domain pattern is sufficient for the
18357 router to accept the address. When actually routing an address for delivery,
18358 an address that matches a domain pattern is queued for the associated
18359 transport. If the transport is not a local one, a host list must be associated
18360 with the pattern; IP addresses are looked up for the hosts, and these are
18361 passed to the transport along with the mail address. For local transports, a
18362 host list is optional. If it is present, it is passed in &$host$& as a single
18363 text string.
18364
18365 The list of routing rules can be provided as an inline string in
18366 &%route_list%&, or the data can be obtained by looking up the domain in a file
18367 or database by setting &%route_data%&. Only one of these settings may appear in
18368 any one instance of &(manualroute)&. The format of routing rules is described
18369 below, following the list of private options.
18370
18371
18372 .section "Private options for manualroute" "SECTprioptman"
18373
18374 .cindex "options" "&(manualroute)& router"
18375 The private options for the &(manualroute)& router are as follows:
18376
18377 .option host_all_ignored manualroute string defer
18378 See &%host_find_failed%&.
18379
18380 .option host_find_failed manualroute string freeze
18381 This option controls what happens when &(manualroute)& tries to find an IP
18382 address for a host, and the host does not exist. The option can be set to one
18383 of the following values:
18384 .code
18385 decline
18386 defer
18387 fail
18388 freeze
18389 ignore
18390 pass
18391 .endd
18392 The default (&"freeze"&) assumes that this state is a serious configuration
18393 error. The difference between &"pass"& and &"decline"& is that the former
18394 forces the address to be passed to the next router (or the router defined by
18395 &%pass_router%&),
18396 .oindex "&%more%&"
18397 overriding &%no_more%&, whereas the latter passes the address to the next
18398 router only if &%more%& is true.
18399
18400 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18401 cannot be found. If all the hosts in the list are ignored, the behaviour is
18402 controlled by the &%host_all_ignored%& option. This takes the same values
18403 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18404
18405 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18406 state; if a host lookup gets a temporary error, delivery is deferred unless the
18407 generic &%pass_on_timeout%& option is set.
18408
18409
18410 .option hosts_randomize manualroute boolean false
18411 .cindex "randomized host list"
18412 .cindex "host" "list of; randomized"
18413 If this option is set, the order of the items in a host list in a routing rule
18414 is randomized each time the list is used, unless an option in the routing rule
18415 overrides (see below). Randomizing the order of a host list can be used to do
18416 crude load sharing. However, if more than one mail address is routed by the
18417 same router to the same host list, the host lists are considered to be the same
18418 (even though they may be randomized into different orders) for the purpose of
18419 deciding whether to batch the deliveries into a single SMTP transaction.
18420
18421 When &%hosts_randomize%& is true, a host list may be split
18422 into groups whose order is separately randomized. This makes it possible to
18423 set up MX-like behaviour. The boundaries between groups are indicated by an
18424 item that is just &`+`& in the host list. For example:
18425 .code
18426 route_list = * host1:host2:host3:+:host4:host5
18427 .endd
18428 The order of the first three hosts and the order of the last two hosts is
18429 randomized for each use, but the first three always end up before the last two.
18430 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18431 randomized host list is passed to an &(smtp)& transport that also has
18432 &%hosts_randomize set%&, the list is not re-randomized.
18433
18434
18435 .option route_data manualroute string&!! unset
18436 If this option is set, it must expand to yield the data part of a routing rule.
18437 Typically, the expansion string includes a lookup based on the domain. For
18438 example:
18439 .code
18440 route_data = ${lookup{$domain}dbm{/etc/routes}}
18441 .endd
18442 If the expansion is forced to fail, or the result is an empty string, the
18443 router declines. Other kinds of expansion failure cause delivery to be
18444 deferred.
18445
18446
18447 .option route_list manualroute "string list" unset
18448 This string is a list of routing rules, in the form defined below. Note that,
18449 unlike most string lists, the items are separated by semicolons. This is so
18450 that they may contain colon-separated host lists.
18451
18452
18453 .option same_domain_copy_routing manualroute boolean false
18454 .cindex "address" "copying routing"
18455 Addresses with the same domain are normally routed by the &(manualroute)&
18456 router to the same list of hosts. However, this cannot be presumed, because the
18457 router options and preconditions may refer to the local part of the address. By
18458 default, therefore, Exim routes each address in a message independently. DNS
18459 servers run caches, so repeated DNS lookups are not normally expensive, and in
18460 any case, personal messages rarely have more than a few recipients.
18461
18462 If you are running mailing lists with large numbers of subscribers at the same
18463 domain, and you are using a &(manualroute)& router which is independent of the
18464 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18465 lookups for identical domains in one message. In this case, when
18466 &(manualroute)& routes an address to a remote transport, any other unrouted
18467 addresses in the message that have the same domain are automatically given the
18468 same routing without processing them independently. However, this is only done
18469 if &%headers_add%& and &%headers_remove%& are unset.
18470
18471
18472
18473
18474 .section "Routing rules in route_list" "SECID120"
18475 The value of &%route_list%& is a string consisting of a sequence of routing
18476 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18477 entered as two semicolons. Alternatively, the list separator can be changed as
18478 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18479 Empty rules are ignored. The format of each rule is
18480 .display
18481 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18482 .endd
18483 The following example contains two rules, each with a simple domain pattern and
18484 no options:
18485 .code
18486 route_list = \
18487   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18488   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18489 .endd
18490 The three parts of a rule are separated by white space. The pattern and the
18491 list of hosts can be enclosed in quotes if necessary, and if they are, the
18492 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18493 single domain pattern, which is the only mandatory item in the rule. The
18494 pattern is in the same format as one item in a domain list (see section
18495 &<<SECTdomainlist>>&),
18496 except that it may not be the name of an interpolated file.
18497 That is, it may be wildcarded, or a regular expression, or a file or database
18498 lookup (with semicolons doubled, because of the use of semicolon as a separator
18499 in a &%route_list%&).
18500
18501 The rules in &%route_list%& are searched in order until one of the patterns
18502 matches the domain that is being routed. The list of hosts and then options are
18503 then used as described below. If there is no match, the router declines. When
18504 &%route_list%& is set, &%route_data%& must not be set.
18505
18506
18507
18508 .section "Routing rules in route_data" "SECID121"
18509 The use of &%route_list%& is convenient when there are only a small number of
18510 routing rules. For larger numbers, it is easier to use a file or database to
18511 hold the routing information, and use the &%route_data%& option instead.
18512 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18513 Most commonly, &%route_data%& is set as a string that contains an
18514 expansion lookup. For example, suppose we place two routing rules in a file
18515 like this:
18516 .code
18517 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18518 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18519 .endd
18520 This data can be accessed by setting
18521 .code
18522 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18523 .endd
18524 Failure of the lookup results in an empty string, causing the router to
18525 decline. However, you do not have to use a lookup in &%route_data%&. The only
18526 requirement is that the result of expanding the string is a list of hosts,
18527 possibly followed by options, separated by white space. The list of hosts must
18528 be enclosed in quotes if it contains white space.
18529
18530
18531
18532
18533 .section "Format of the list of hosts" "SECID122"
18534 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18535 always separately expanded before use. If the expansion fails, the router
18536 declines. The result of the expansion must be a colon-separated list of names
18537 and/or IP addresses, optionally also including ports. The format of each item
18538 in the list is described in the next section. The list separator can be changed
18539 as described in section &<<SECTlistconstruct>>&.
18540
18541 If the list of hosts was obtained from a &%route_list%& item, the following
18542 variables are set during its expansion:
18543
18544 .ilist
18545 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18546 If the domain was matched against a regular expression, the numeric variables
18547 &$1$&, &$2$&, etc. may be set. For example:
18548 .code
18549 route_list = ^domain(\d+)   host-$1.text.example
18550 .endd
18551 .next
18552 &$0$& is always set to the entire domain.
18553 .next
18554 &$1$& is also set when partial matching is done in a file lookup.
18555
18556 .next
18557 .vindex "&$value$&"
18558 If the pattern that matched the domain was a lookup item, the data that was
18559 looked up is available in the expansion variable &$value$&. For example:
18560 .code
18561 route_list = lsearch;;/some/file.routes  $value
18562 .endd
18563 .endlist
18564
18565 Note the doubling of the semicolon in the pattern that is necessary because
18566 semicolon is the default route list separator.
18567
18568
18569
18570 .section "Format of one host item" "SECTformatonehostitem"
18571 Each item in the list of hosts is either a host name or an IP address,
18572 optionally with an attached port number. When no port is given, an IP address
18573 is not enclosed in brackets. When a port is specified, it overrides the port
18574 specification on the transport. The port is separated from the name or address
18575 by a colon. This leads to some complications:
18576
18577 .ilist
18578 Because colon is the default separator for the list of hosts, either
18579 the colon that specifies a port must be doubled, or the list separator must
18580 be changed. The following two examples have the same effect:
18581 .code
18582 route_list = * "host1.tld::1225 : host2.tld::1226"
18583 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18584 .endd
18585 .next
18586 When IPv6 addresses are involved, it gets worse, because they contain
18587 colons of their own. To make this case easier, it is permitted to
18588 enclose an IP address (either v4 or v6) in square brackets if a port
18589 number follows. For example:
18590 .code
18591 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18592 .endd
18593 .endlist
18594
18595 .section "How the list of hosts is used" "SECThostshowused"
18596 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18597 the hosts is tried, in the order specified, when carrying out the SMTP
18598 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18599 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18600 transport.
18601
18602 Hosts may be listed by name or by IP address. An unadorned name in the list of
18603 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18604 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18605 records in the DNS. For example:
18606 .code
18607 route_list = *  x.y.z:p.q.r/MX:e.f.g
18608 .endd
18609 If this feature is used with a port specifier, the port must come last. For
18610 example:
18611 .code
18612 route_list = *  dom1.tld/mx::1225
18613 .endd
18614 If the &%hosts_randomize%& option is set, the order of the items in the list is
18615 randomized before any lookups are done. Exim then scans the list; for any name
18616 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18617 be an interface on the local host and the item is not the first in the list,
18618 Exim discards it and any subsequent items. If it is the first item, what
18619 happens is controlled by the
18620 .oindex "&%self%&" "in &(manualroute)& router"
18621 &%self%& option of the router.
18622
18623 A name on the list that is followed by &`/MX`& is replaced with the list of
18624 hosts obtained by looking up MX records for the name. This is always a DNS
18625 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18626 below) are not relevant here. The order of these hosts is determined by the
18627 preference values in the MX records, according to the usual rules. Because
18628 randomizing happens before the MX lookup, it does not affect the order that is
18629 defined by MX preferences.
18630
18631 If the local host is present in the sublist obtained from MX records, but is
18632 not the most preferred host in that list, it and any equally or less
18633 preferred hosts are removed before the sublist is inserted into the main list.
18634
18635 If the local host is the most preferred host in the MX list, what happens
18636 depends on where in the original list of hosts the &`/MX`& item appears. If it
18637 is not the first item (that is, there are previous hosts in the main list),
18638 Exim discards this name and any subsequent items in the main list.
18639
18640 If the MX item is first in the list of hosts, and the local host is the
18641 most preferred host, what happens is controlled by the &%self%& option of the
18642 router.
18643
18644 DNS failures when lookup up the MX records are treated in the same way as DNS
18645 failures when looking up IP addresses: &%pass_on_timeout%& and
18646 &%host_find_failed%& are used when relevant.
18647
18648 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18649 whether obtained from an MX lookup or not.
18650
18651
18652
18653 .section "How the options are used" "SECThowoptused"
18654 The options are a sequence of words; in practice no more than three are ever
18655 present. One of the words can be the name of a transport; this overrides the
18656 &%transport%& option on the router for this particular routing rule only. The
18657 other words (if present) control randomization of the list of hosts on a
18658 per-rule basis, and how the IP addresses of the hosts are to be found when
18659 routing to a remote transport. These options are as follows:
18660
18661 .ilist
18662 &%randomize%&: randomize the order of the hosts in this list, overriding the
18663 setting of &%hosts_randomize%& for this routing rule only.
18664 .next
18665 &%no_randomize%&: do not randomize the order of the hosts in this list,
18666 overriding the setting of &%hosts_randomize%& for this routing rule only.
18667 .next
18668 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18669 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18670 also look in &_/etc/hosts_& or other sources of information.
18671 .next
18672 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18673 no address records are found. If there is a temporary DNS error (such as a
18674 timeout), delivery is deferred.
18675 .endlist
18676
18677 For example:
18678 .code
18679 route_list = domain1  host1:host2:host3  randomize bydns;\
18680              domain2  host4:host5
18681 .endd
18682 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18683 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18684 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18685 or &[gethostbyname()]&, and the result of the lookup is the result of that
18686 call.
18687
18688 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18689 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18690 instead of TRY_AGAIN. That is why the default action is to try a DNS
18691 lookup first. Only if that gives a definite &"no such host"& is the local
18692 function called.
18693
18694
18695
18696 If no IP address for a host can be found, what happens is controlled by the
18697 &%host_find_failed%& option.
18698
18699 .vindex "&$host$&"
18700 When an address is routed to a local transport, IP addresses are not looked up.
18701 The host list is passed to the transport in the &$host$& variable.
18702
18703
18704
18705 .section "Manualroute examples" "SECID123"
18706 In some of the examples that follow, the presence of the &%remote_smtp%&
18707 transport, as defined in the default configuration file, is assumed:
18708
18709 .ilist
18710 .cindex "smart host" "example router"
18711 The &(manualroute)& router can be used to forward all external mail to a
18712 &'smart host'&. If you have set up, in the main part of the configuration, a
18713 named domain list that contains your local domains, for example:
18714 .code
18715 domainlist local_domains = my.domain.example
18716 .endd
18717 You can arrange for all other domains to be routed to a smart host by making
18718 your first router something like this:
18719 .code
18720 smart_route:
18721   driver = manualroute
18722   domains = !+local_domains
18723   transport = remote_smtp
18724   route_list = * smarthost.ref.example
18725 .endd
18726 This causes all non-local addresses to be sent to the single host
18727 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18728 they are tried in order
18729 (but you can use &%hosts_randomize%& to vary the order each time).
18730 Another way of configuring the same thing is this:
18731 .code
18732 smart_route:
18733   driver = manualroute
18734   transport = remote_smtp
18735   route_list = !+local_domains  smarthost.ref.example
18736 .endd
18737 There is no difference in behaviour between these two routers as they stand.
18738 However, they behave differently if &%no_more%& is added to them. In the first
18739 example, the router is skipped if the domain does not match the &%domains%&
18740 precondition; the following router is always tried. If the router runs, it
18741 always matches the domain and so can never decline. Therefore, &%no_more%&
18742 would have no effect. In the second case, the router is never skipped; it
18743 always runs. However, if it doesn't match the domain, it declines. In this case
18744 &%no_more%& would prevent subsequent routers from running.
18745
18746 .next
18747 .cindex "mail hub example"
18748 A &'mail hub'& is a host which receives mail for a number of domains via MX
18749 records in the DNS and delivers it via its own private routing mechanism. Often
18750 the final destinations are behind a firewall, with the mail hub being the one
18751 machine that can connect to machines both inside and outside the firewall. The
18752 &(manualroute)& router is usually used on a mail hub to route incoming messages
18753 to the correct hosts. For a small number of domains, the routing can be inline,
18754 using the &%route_list%& option, but for a larger number a file or database
18755 lookup is easier to manage.
18756
18757 If the domain names are in fact the names of the machines to which the mail is
18758 to be sent by the mail hub, the configuration can be quite simple. For
18759 example:
18760 .code
18761 hub_route:
18762   driver = manualroute
18763   transport = remote_smtp
18764   route_list = *.rhodes.tvs.example  $domain
18765 .endd
18766 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18767 whose names are the same as the mail domains. A similar approach can be taken
18768 if the host name can be obtained from the domain name by a string manipulation
18769 that the expansion facilities can handle. Otherwise, a lookup based on the
18770 domain can be used to find the host:
18771 .code
18772 through_firewall:
18773   driver = manualroute
18774   transport = remote_smtp
18775   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18776 .endd
18777 The result of the lookup must be the name or IP address of the host (or
18778 hosts) to which the address is to be routed. If the lookup fails, the route
18779 data is empty, causing the router to decline. The address then passes to the
18780 next router.
18781
18782 .next
18783 .cindex "batched SMTP output example"
18784 .cindex "SMTP" "batched outgoing; example"
18785 You can use &(manualroute)& to deliver messages to pipes or files in batched
18786 SMTP format for onward transportation by some other means. This is one way of
18787 storing mail for a dial-up host when it is not connected. The route list entry
18788 can be as simple as a single domain name in a configuration like this:
18789 .code
18790 save_in_file:
18791   driver = manualroute
18792   transport = batchsmtp_appendfile
18793   route_list = saved.domain.example
18794 .endd
18795 though often a pattern is used to pick up more than one domain. If there are
18796 several domains or groups of domains with different transport requirements,
18797 different transports can be listed in the routing information:
18798 .code
18799 save_in_file:
18800   driver = manualroute
18801   route_list = \
18802     *.saved.domain1.example  $domain  batch_appendfile; \
18803     *.saved.domain2.example  \
18804       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18805       batch_pipe
18806 .endd
18807 .vindex "&$domain$&"
18808 .vindex "&$host$&"
18809 The first of these just passes the domain in the &$host$& variable, which
18810 doesn't achieve much (since it is also in &$domain$&), but the second does a
18811 file lookup to find a value to pass, causing the router to decline to handle
18812 the address if the lookup fails.
18813
18814 .next
18815 .cindex "UUCP" "example of router for"
18816 Routing mail directly to UUCP software is a specific case of the use of
18817 &(manualroute)& in a gateway to another mail environment. This is an example of
18818 one way it can be done:
18819 .code
18820 # Transport
18821 uucp:
18822   driver = pipe
18823   user = nobody
18824   command = /usr/local/bin/uux -r - \
18825     ${substr_-5:$host}!rmail ${local_part}
18826   return_fail_output = true
18827
18828 # Router
18829 uucphost:
18830   transport = uucp
18831   driver = manualroute
18832   route_data = \
18833     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18834 .endd
18835 The file &_/usr/local/exim/uucphosts_& contains entries like
18836 .code
18837 darksite.ethereal.example:           darksite.UUCP
18838 .endd
18839 It can be set up more simply without adding and removing &".UUCP"& but this way
18840 makes clear the distinction between the domain name
18841 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18842 .endlist
18843 .ecindex IIDmanrou1
18844 .ecindex IIDmanrou2
18845
18846
18847
18848
18849
18850
18851
18852
18853 . ////////////////////////////////////////////////////////////////////////////
18854 . ////////////////////////////////////////////////////////////////////////////
18855
18856 .chapter "The queryprogram router" "CHAPdriverlast"
18857 .scindex IIDquerou1 "&(queryprogram)& router"
18858 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18859 .cindex "routing" "by external program"
18860 The &(queryprogram)& router routes an address by running an external command
18861 and acting on its output. This is an expensive way to route, and is intended
18862 mainly for use in lightly-loaded systems, or for performing experiments.
18863 However, if it is possible to use the precondition options (&%domains%&,
18864 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18865 be used in special cases, even on a busy host. There are the following private
18866 options:
18867 .cindex "options" "&(queryprogram)& router"
18868
18869 .option command queryprogram string&!! unset
18870 This option must be set. It specifies the command that is to be run. The
18871 command is split up into a command name and arguments, and then each is
18872 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18873 &<<CHAPpipetransport>>&).
18874
18875
18876 .option command_group queryprogram string unset
18877 .cindex "gid (group id)" "in &(queryprogram)& router"
18878 This option specifies a gid to be set when running the command while routing an
18879 address for deliver. It must be set if &%command_user%& specifies a numerical
18880 uid. If it begins with a digit, it is interpreted as the numerical value of the
18881 gid. Otherwise it is looked up using &[getgrnam()]&.
18882
18883
18884 .option command_user queryprogram string unset
18885 .cindex "uid (user id)" "for &(queryprogram)&"
18886 This option must be set. It specifies the uid which is set when running the
18887 command while routing an address for delivery. If the value begins with a digit,
18888 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18889 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18890 not set, a value for the gid also.
18891
18892 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18893 root, which it does during a normal delivery in a conventional configuration.
18894 However, when an address is being verified during message reception, Exim is
18895 usually running as the Exim user, not as root. If the &(queryprogram)& router
18896 is called from a non-root process, Exim cannot change uid or gid before running
18897 the command. In this circumstance the command runs under the current uid and
18898 gid.
18899
18900
18901 .option current_directory queryprogram string /
18902 This option specifies an absolute path which is made the current directory
18903 before running the command.
18904
18905
18906 .option timeout queryprogram time 1h
18907 If the command does not complete within the timeout period, its process group
18908 is killed and the message is frozen. A value of zero time specifies no
18909 timeout.
18910
18911
18912 The standard output of the command is connected to a pipe, which is read when
18913 the command terminates. It should consist of a single line of output,
18914 containing up to five fields, separated by white space. The maximum length of
18915 the line is 1023 characters. Longer lines are silently truncated. The first
18916 field is one of the following words (case-insensitive):
18917
18918 .ilist
18919 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18920 below).
18921 .next
18922 &'Decline'&: the router declines; pass the address to the next router, unless
18923 &%no_more%& is set.
18924 .next
18925 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18926 subsequent text on the line is an error message. If the router is run as part
18927 of address verification during an incoming SMTP message, the message is
18928 included in the SMTP response.
18929 .next
18930 &'Defer'&: routing could not be completed at this time; try again later. Any
18931 subsequent text on the line is an error message which is logged. It is not
18932 included in any SMTP response.
18933 .next
18934 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18935 .next
18936 &'Pass'&: pass the address to the next router (or the router specified by
18937 &%pass_router%&), overriding &%no_more%&.
18938 .next
18939 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18940 new addresses, which are routed independently, starting with the first router,
18941 or the router specified by &%redirect_router%&, if set.
18942 .endlist
18943
18944 When the first word is &'accept'&, the remainder of the line consists of a
18945 number of keyed data values, as follows (split into two lines here, to fit on
18946 the page):
18947 .code
18948 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18949 LOOKUP=byname|bydns DATA=<text>
18950 .endd
18951 The data items can be given in any order, and all are optional. If no transport
18952 is included, the transport specified by the generic &%transport%& option is
18953 used. The list of hosts and the lookup type are needed only if the transport is
18954 an &(smtp)& transport that does not itself supply a list of hosts.
18955
18956 The format of the list of hosts is the same as for the &(manualroute)& router.
18957 As well as host names and IP addresses with optional port numbers, as described
18958 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18959 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18960 (see section &<<SECThostshowused>>&).
18961
18962 If the lookup type is not specified, Exim behaves as follows when trying to
18963 find an IP address for each host: First, a DNS lookup is done. If this yields
18964 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18965 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18966 result of the lookup is the result of that call.
18967
18968 .vindex "&$address_data$&"
18969 If the DATA field is set, its value is placed in the &$address_data$&
18970 variable. For example, this return line
18971 .code
18972 accept hosts=x1.y.example:x2.y.example data="rule1"
18973 .endd
18974 routes the address to the default transport, passing a list of two hosts. When
18975 the transport runs, the string &"rule1"& is in &$address_data$&.
18976 .ecindex IIDquerou1
18977 .ecindex IIDquerou2
18978
18979
18980
18981
18982 . ////////////////////////////////////////////////////////////////////////////
18983 . ////////////////////////////////////////////////////////////////////////////
18984
18985 .chapter "The redirect router" "CHAPredirect"
18986 .scindex IIDredrou1 "&(redirect)& router"
18987 .scindex IIDredrou2 "routers" "&(redirect)&"
18988 .cindex "alias file" "in a &(redirect)& router"
18989 .cindex "address redirection" "&(redirect)& router"
18990 The &(redirect)& router handles several kinds of address redirection. Its most
18991 common uses are for resolving local part aliases from a central alias file
18992 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18993 files, but it has many other potential uses. The incoming address can be
18994 redirected in several different ways:
18995
18996 .ilist
18997 It can be replaced by one or more new addresses which are themselves routed
18998 independently.
18999 .next
19000 It can be routed to be delivered to a given file or directory.
19001 .next
19002 It can be routed to be delivered to a specified pipe command.
19003 .next
19004 It can cause an automatic reply to be generated.
19005 .next
19006 It can be forced to fail, optionally with a custom error message.
19007 .next
19008 It can be temporarily deferred, optionally with a custom message.
19009 .next
19010 It can be discarded.
19011 .endlist
19012
19013 The generic &%transport%& option must not be set for &(redirect)& routers.
19014 However, there are some private options which define transports for delivery to
19015 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19016 &%pipe_transport%& and &%reply_transport%& descriptions below.
19017
19018 If success DSNs have been requested
19019 .cindex "DSN" "success"
19020 .cindex "Delivery Status Notification" "success"
19021 redirection triggers one and the DSN options are not passed any further.
19022
19023
19024
19025 .section "Redirection data" "SECID124"
19026 The router operates by interpreting a text string which it obtains either by
19027 expanding the contents of the &%data%& option, or by reading the entire
19028 contents of a file whose name is given in the &%file%& option. These two
19029 options are mutually exclusive. The first is commonly used for handling system
19030 aliases, in a configuration like this:
19031 .code
19032 system_aliases:
19033   driver = redirect
19034   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19035 .endd
19036 If the lookup fails, the expanded string in this example is empty. When the
19037 expansion of &%data%& results in an empty string, the router declines. A forced
19038 expansion failure also causes the router to decline; other expansion failures
19039 cause delivery to be deferred.
19040
19041 A configuration using &%file%& is commonly used for handling users'
19042 &_.forward_& files, like this:
19043 .code
19044 userforward:
19045   driver = redirect
19046   check_local_user
19047   file = $home/.forward
19048   no_verify
19049 .endd
19050 If the file does not exist, or causes no action to be taken (for example, it is
19051 empty or consists only of comments), the router declines. &*Warning*&: This
19052 is not the case when the file contains syntactically valid items that happen to
19053 yield empty addresses, for example, items containing only RFC 2822 address
19054 comments.
19055
19056
19057
19058 .section "Forward files and address verification" "SECID125"
19059 .cindex "address redirection" "while verifying"
19060 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19061 &_.forward_& files, as in the example above. There are two reasons for this:
19062
19063 .ilist
19064 When Exim is receiving an incoming SMTP message from a remote host, it is
19065 running under the Exim uid, not as root. Exim is unable to change uid to read
19066 the file as the user, and it may not be able to read it as the Exim user. So in
19067 practice the router may not be able to operate.
19068 .next
19069 However, even when the router can operate, the existence of a &_.forward_& file
19070 is unimportant when verifying an address. What should be checked is whether the
19071 local part is a valid user name or not. Cutting out the redirection processing
19072 saves some resources.
19073 .endlist
19074
19075
19076
19077
19078
19079
19080 .section "Interpreting redirection data" "SECID126"
19081 .cindex "Sieve filter" "specifying in redirection data"
19082 .cindex "filter" "specifying in redirection data"
19083 The contents of the data string, whether obtained from &%data%& or &%file%&,
19084 can be interpreted in two different ways:
19085
19086 .ilist
19087 If the &%allow_filter%& option is set true, and the data begins with the text
19088 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19089 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19090 respectively. Details of the syntax and semantics of filter files are described
19091 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19092 document is intended for use by end users.
19093 .next
19094 Otherwise, the data must be a comma-separated list of redirection items, as
19095 described in the next section.
19096 .endlist
19097
19098 When a message is redirected to a file (a &"mail folder"&), the file name given
19099 in a non-filter redirection list must always be an absolute path. A filter may
19100 generate a relative path &-- how this is handled depends on the transport's
19101 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19102 for the &(appendfile)& transport.
19103
19104
19105
19106 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19107 .cindex "address redirection" "non-filter list items"
19108 When the redirection data is not an Exim or Sieve filter, for example, if it
19109 comes from a conventional alias or forward file, it consists of a list of
19110 addresses, file names, pipe commands, or certain special items (see section
19111 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19112 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19113 depending on their default values. The items in the list are separated by
19114 commas or newlines.
19115 If a comma is required in an item, the entire item must be enclosed in double
19116 quotes.
19117
19118 Lines starting with a # character are comments, and are ignored, and # may
19119 also appear following a comma, in which case everything between the # and the
19120 next newline character is ignored.
19121
19122 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19123 double quotes are retained because some forms of mail address require their use
19124 (but never to enclose the entire address). In the following description,
19125 &"item"& refers to what remains after any surrounding double quotes have been
19126 removed.
19127
19128 .vindex "&$local_part$&"
19129 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19130 and the expansion contains a reference to &$local_part$&, you should make use
19131 of the &%quote_local_part%& expansion operator, in case the local part contains
19132 special characters. For example, to redirect all mail for the domain
19133 &'obsolete.example'&, retaining the existing local part, you could use this
19134 setting:
19135 .code
19136 data = ${quote_local_part:$local_part}@newdomain.example
19137 .endd
19138
19139
19140 .section "Redirecting to a local mailbox" "SECTredlocmai"
19141 .cindex "routing" "loops in"
19142 .cindex "loop" "while routing, avoidance of"
19143 .cindex "address redirection" "to local mailbox"
19144 A redirection item may safely be the same as the address currently under
19145 consideration. This does not cause a routing loop, because a router is
19146 automatically skipped if any ancestor of the address that is being processed
19147 is the same as the current address and was processed by the current router.
19148 Such an address is therefore passed to the following routers, so it is handled
19149 as if there were no redirection. When making this loop-avoidance test, the
19150 complete local part, including any prefix or suffix, is used.
19151
19152 .cindex "address redirection" "local part without domain"
19153 Specifying the same local part without a domain is a common usage in personal
19154 filter files when the user wants to have messages delivered to the local
19155 mailbox and also forwarded elsewhere. For example, the user whose login is
19156 &'cleo'& might have a &_.forward_& file containing this:
19157 .code
19158 cleo, cleopatra@egypt.example
19159 .endd
19160 .cindex "backslash in alias file"
19161 .cindex "alias file" "backslash in"
19162 For compatibility with other MTAs, such unqualified local parts may be
19163 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19164 it does make a difference if more than one domain is being handled
19165 synonymously.
19166
19167 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19168 2822 address that does not include a domain, the item is qualified using the
19169 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19170 addresses are qualified using the value in &%qualify_recipient%&, but you can
19171 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19172
19173 Care must be taken if there are alias names for local users.
19174 Consider an MTA handling a single local domain where the system alias file
19175 contains:
19176 .code
19177 Sam.Reman: spqr
19178 .endd
19179 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19180 messages in the local mailbox, and also forward copies elsewhere. He creates
19181 this forward file:
19182 .code
19183 Sam.Reman, spqr@reme.elsewhere.example
19184 .endd
19185 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19186 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19187 second time round, because it has previously routed it,
19188 and the following routers presumably cannot handle the alias. The forward file
19189 should really contain
19190 .code
19191 spqr, spqr@reme.elsewhere.example
19192 .endd
19193 but because this is such a common error, the &%check_ancestor%& option (see
19194 below) exists to provide a way to get round it. This is normally set on a
19195 &(redirect)& router that is handling users' &_.forward_& files.
19196
19197
19198
19199 .section "Special items in redirection lists" "SECTspecitredli"
19200 In addition to addresses, the following types of item may appear in redirection
19201 lists (that is, in non-filter redirection data):
19202
19203 .ilist
19204 .cindex "pipe" "in redirection list"
19205 .cindex "address redirection" "to pipe"
19206 An item is treated as a pipe command if it begins with &"|"& and does not parse
19207 as a valid RFC 2822 address that includes a domain. A transport for running the
19208 command must be specified by the &%pipe_transport%& option.
19209 Normally, either the router or the transport specifies a user and a group under
19210 which to run the delivery. The default is to use the Exim user and group.
19211
19212 Single or double quotes can be used for enclosing the individual arguments of
19213 the pipe command; no interpretation of escapes is done for single quotes. If
19214 the command contains a comma character, it is necessary to put the whole item
19215 in double quotes, for example:
19216 .code
19217 "|/some/command ready,steady,go"
19218 .endd
19219 since items in redirection lists are terminated by commas. Do not, however,
19220 quote just the command. An item such as
19221 .code
19222 |"/some/command ready,steady,go"
19223 .endd
19224 is interpreted as a pipe with a rather strange command name, and no arguments.
19225
19226 Note that the above example assumes that the text comes from a lookup source
19227 of some sort, so that the quotes are part of the data.  If composing a
19228 redirect router with a &%data%& option directly specifying this command, the
19229 quotes will be used by the configuration parser to define the extent of one
19230 string, but will not be passed down into the redirect router itself.  There
19231 are two main approaches to get around this: escape quotes to be part of the
19232 data itself, or avoid using this mechanism and instead create a custom
19233 transport with the &%command%& option set and reference that transport from
19234 an &%accept%& router.
19235
19236 .next
19237 .cindex "file" "in redirection list"
19238 .cindex "address redirection" "to file"
19239 An item is interpreted as a path name if it begins with &"/"& and does not
19240 parse as a valid RFC 2822 address that includes a domain. For example,
19241 .code
19242 /home/world/minbari
19243 .endd
19244 is treated as a file name, but
19245 .code
19246 /s=molari/o=babylon/@x400gate.way
19247 .endd
19248 is treated as an address. For a file name, a transport must be specified using
19249 the &%file_transport%& option. However, if the generated path name ends with a
19250 forward slash character, it is interpreted as a directory name rather than a
19251 file name, and &%directory_transport%& is used instead.
19252
19253 Normally, either the router or the transport specifies a user and a group under
19254 which to run the delivery. The default is to use the Exim user and group.
19255
19256 .cindex "&_/dev/null_&"
19257 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19258 bypassed at a high level, and the log entry shows &"**bypassed**"&
19259 instead of a transport name. In this case the user and group are not used.
19260
19261 .next
19262 .cindex "included address list"
19263 .cindex "address redirection" "included external list"
19264 If an item is of the form
19265 .code
19266 :include:<path name>
19267 .endd
19268 a list of further items is taken from the given file and included at that
19269 point. &*Note*&: Such a file can not be a filter file; it is just an
19270 out-of-line addition to the list. The items in the included list are separated
19271 by commas or newlines and are not subject to expansion. If this is the first
19272 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19273 the alias name. This example is incorrect:
19274 .code
19275 list1    :include:/opt/lists/list1
19276 .endd
19277 It must be given as
19278 .code
19279 list1:   :include:/opt/lists/list1
19280 .endd
19281 .next
19282 .cindex "address redirection" "to black hole"
19283 Sometimes you want to throw away mail to a particular local part. Making the
19284 &%data%& option expand to an empty string does not work, because that causes
19285 the router to decline. Instead, the alias item
19286 .cindex "black hole"
19287 .cindex "abandoning mail"
19288 &':blackhole:'& can be used. It does what its name implies. No delivery is
19289 done, and no error message is generated. This has the same effect as specifing
19290 &_/dev/null_& as a destination, but it can be independently disabled.
19291
19292 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19293 delivery is done for the original local part, even if other redirection items
19294 are present. If you are generating a multi-item list (for example, by reading a
19295 database) and need the ability to provide a no-op item, you must use
19296 &_/dev/null_&.
19297
19298 .next
19299 .cindex "delivery" "forcing failure"
19300 .cindex "delivery" "forcing deferral"
19301 .cindex "failing delivery" "forcing"
19302 .cindex "deferred delivery, forcing"
19303 .cindex "customizing" "failure message"
19304 An attempt to deliver a particular address can be deferred or forced to fail by
19305 redirection items of the form
19306 .code
19307 :defer:
19308 :fail:
19309 .endd
19310 respectively. When a redirection list contains such an item, it applies
19311 to the entire redirection; any other items in the list are ignored. Any
19312 text following &':fail:'& or &':defer:'& is placed in the error text
19313 associated with the failure. For example, an alias file might contain:
19314 .code
19315 X.Employee:  :fail: Gone away, no forwarding address
19316 .endd
19317 In the case of an address that is being verified from an ACL or as the subject
19318 of a
19319 .cindex "VRFY" "error text, display of"
19320 VRFY command, the text is included in the SMTP error response by
19321 default.
19322 .cindex "EXPN" "error text, display of"
19323 The text is not included in the response to an EXPN command. In non-SMTP cases
19324 the text is included in the error message that Exim generates.
19325
19326 .cindex "SMTP" "error codes"
19327 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19328 &':fail:'&. However, if the message starts with three digits followed by a
19329 space, optionally followed by an extended code of the form &'n.n.n'&, also
19330 followed by a space, and the very first digit is the same as the default error
19331 code, the code from the message is used instead. If the very first digit is
19332 incorrect, a panic error is logged, and the default code is used. You can
19333 suppress the use of the supplied code in a redirect router by setting the
19334 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19335 ignored.
19336
19337 .vindex "&$acl_verify_message$&"
19338 In an ACL, an explicitly provided message overrides the default, but the
19339 default message is available in the variable &$acl_verify_message$& and can
19340 therefore be included in a custom message if this is desired.
19341
19342 Normally the error text is the rest of the redirection list &-- a comma does
19343 not terminate it &-- but a newline does act as a terminator. Newlines are not
19344 normally present in alias expansions. In &(lsearch)& lookups they are removed
19345 as part of the continuation process, but they may exist in other kinds of
19346 lookup and in &':include:'& files.
19347
19348 During routing for message delivery (as opposed to verification), a redirection
19349 containing &':fail:'& causes an immediate failure of the incoming address,
19350 whereas &':defer:'& causes the message to remain on the queue so that a
19351 subsequent delivery attempt can happen at a later time. If an address is
19352 deferred for too long, it will ultimately fail, because the normal retry
19353 rules still apply.
19354
19355 .next
19356 .cindex "alias file" "exception to default"
19357 Sometimes it is useful to use a single-key search type with a default (see
19358 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19359 for exceptions to the default. These can be handled by aliasing them to
19360 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19361 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19362 results in an empty redirection list has the same effect.
19363 .endlist
19364
19365
19366 .section "Duplicate addresses" "SECTdupaddr"
19367 .cindex "duplicate addresses"
19368 .cindex "address duplicate, discarding"
19369 .cindex "pipe" "duplicated"
19370 Exim removes duplicate addresses from the list to which it is delivering, so as
19371 to deliver just one copy to each address. This does not apply to deliveries
19372 routed to pipes by different immediate parent addresses, but an indirect
19373 aliasing scheme of the type
19374 .code
19375 pipe:       |/some/command $local_part
19376 localpart1: pipe
19377 localpart2: pipe
19378 .endd
19379 does not work with a message that is addressed to both local parts, because
19380 when the second is aliased to the intermediate local part &"pipe"& it gets
19381 discarded as being the same as a previously handled address. However, a scheme
19382 such as
19383 .code
19384 localpart1: |/some/command $local_part
19385 localpart2: |/some/command $local_part
19386 .endd
19387 does result in two different pipe deliveries, because the immediate parents of
19388 the pipes are distinct.
19389
19390
19391
19392 .section "Repeated redirection expansion" "SECID128"
19393 .cindex "repeated redirection expansion"
19394 .cindex "address redirection" "repeated for each delivery attempt"
19395 When a message cannot be delivered to all of its recipients immediately,
19396 leading to two or more delivery attempts, redirection expansion is carried out
19397 afresh each time for those addresses whose children were not all previously
19398 delivered. If redirection is being used as a mailing list, this can lead to new
19399 members of the list receiving copies of old messages. The &%one_time%& option
19400 can be used to avoid this.
19401
19402
19403 .section "Errors in redirection lists" "SECID129"
19404 .cindex "address redirection" "errors"
19405 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19406 error is skipped, and an entry is written to the main log. This may be useful
19407 for mailing lists that are automatically managed. Otherwise, if an error is
19408 detected while generating the list of new addresses, the original address is
19409 deferred. See also &%syntax_errors_to%&.
19410
19411
19412
19413 .section "Private options for the redirect router" "SECID130"
19414
19415 .cindex "options" "&(redirect)& router"
19416 The private options for the &(redirect)& router are as follows:
19417
19418
19419 .option allow_defer redirect boolean false
19420 Setting this option allows the use of &':defer:'& in non-filter redirection
19421 data, or the &%defer%& command in an Exim filter file.
19422
19423
19424 .option allow_fail redirect boolean false
19425 .cindex "failing delivery" "from filter"
19426 If this option is true, the &':fail:'& item can be used in a redirection list,
19427 and the &%fail%& command may be used in an Exim filter file.
19428
19429
19430 .option allow_filter redirect boolean false
19431 .cindex "filter" "enabling use of"
19432 .cindex "Sieve filter" "enabling use of"
19433 Setting this option allows Exim to interpret redirection data that starts with
19434 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19435 are some features of Exim filter files that some administrators may wish to
19436 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19437
19438 It is also possible to lock out Exim filters or Sieve filters while allowing
19439 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19440
19441
19442 The filter is run using the uid and gid set by the generic &%user%& and
19443 &%group%& options. These take their defaults from the password data if
19444 &%check_local_user%& is set, so in the normal case of users' personal filter
19445 files, the filter is run as the relevant user. When &%allow_filter%& is set
19446 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19447
19448
19449
19450 .option allow_freeze redirect boolean false
19451 .cindex "freezing messages" "allowing in filter"
19452 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19453 This command is more normally encountered in system filters, and is disabled by
19454 default for redirection filters because it isn't something you usually want to
19455 let ordinary users do.
19456
19457
19458
19459 .option check_ancestor redirect boolean false
19460 This option is concerned with handling generated addresses that are the same
19461 as some address in the list of redirection ancestors of the current address.
19462 Although it is turned off by default in the code, it is set in the default
19463 configuration file for handling users' &_.forward_& files. It is recommended
19464 for this use of the &(redirect)& router.
19465
19466 When &%check_ancestor%& is set, if a generated address (including the domain)
19467 is the same as any ancestor of the current address, it is replaced by a copy of
19468 the current address. This helps in the case where local part A is aliased to B,
19469 and B has a &_.forward_& file pointing back to A. For example, within a single
19470 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19471 &_&~jb/.forward_& contains:
19472 .code
19473 \Joe.Bloggs, <other item(s)>
19474 .endd
19475 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19476 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19477 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19478 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19479 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19480 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19481 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19482 original address. See also the &%repeat_use%& option below.
19483
19484
19485 .option check_group redirect boolean "see below"
19486 When the &%file%& option is used, the group owner of the file is checked only
19487 when this option is set. The permitted groups are those listed in the
19488 &%owngroups%& option, together with the user's default group if
19489 &%check_local_user%& is set. If the file has the wrong group, routing is
19490 deferred. The default setting for this option is true if &%check_local_user%&
19491 is set and the &%modemask%& option permits the group write bit, or if the
19492 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19493
19494
19495
19496 .option check_owner redirect boolean "see below"
19497 When the &%file%& option is used, the owner of the file is checked only when
19498 this option is set. If &%check_local_user%& is set, the local user is
19499 permitted; otherwise the owner must be one of those listed in the &%owners%&
19500 option. The default value for this option is true if &%check_local_user%& or
19501 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19502
19503
19504 .option data redirect string&!! unset
19505 This option is mutually exclusive with &%file%&. One or other of them must be
19506 set, but not both. The contents of &%data%& are expanded, and then used as the
19507 list of forwarding items, or as a set of filtering instructions. If the
19508 expansion is forced to fail, or the result is an empty string or a string that
19509 has no effect (consists entirely of comments), the router declines.
19510
19511 When filtering instructions are used, the string must begin with &"#Exim
19512 filter"&, and all comments in the string, including this initial one, must be
19513 terminated with newline characters. For example:
19514 .code
19515 data = #Exim filter\n\
19516        if $h_to: contains Exim then save $home/mail/exim endif
19517 .endd
19518 If you are reading the data from a database where newlines cannot be included,
19519 you can use the &${sg}$& expansion item to turn the escape string of your
19520 choice into a newline.
19521
19522
19523 .option directory_transport redirect string&!! unset
19524 A &(redirect)& router sets up a direct delivery to a directory when a path name
19525 ending with a slash is specified as a new &"address"&. The transport used is
19526 specified by this option, which, after expansion, must be the name of a
19527 configured transport. This should normally be an &(appendfile)& transport.
19528
19529
19530 .option file redirect string&!! unset
19531 This option specifies the name of a file that contains the redirection data. It
19532 is mutually exclusive with the &%data%& option. The string is expanded before
19533 use; if the expansion is forced to fail, the router declines. Other expansion
19534 failures cause delivery to be deferred. The result of a successful expansion
19535 must be an absolute path. The entire file is read and used as the redirection
19536 data. If the data is an empty string or a string that has no effect (consists
19537 entirely of comments), the router declines.
19538
19539 .cindex "NFS" "checking for file existence"
19540 If the attempt to open the file fails with a &"does not exist"& error, Exim
19541 runs a check on the containing directory,
19542 unless &%ignore_enotdir%& is true (see below).
19543 If the directory does not appear to exist, delivery is deferred. This can
19544 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19545 is a mount problem. If the containing directory does exist, but the file does
19546 not, the router declines.
19547
19548
19549 .option file_transport redirect string&!! unset
19550 .vindex "&$address_file$&"
19551 A &(redirect)& router sets up a direct delivery to a file when a path name not
19552 ending in a slash is specified as a new &"address"&. The transport used is
19553 specified by this option, which, after expansion, must be the name of a
19554 configured transport. This should normally be an &(appendfile)& transport. When
19555 it is running, the file name is in &$address_file$&.
19556
19557
19558 .option filter_prepend_home redirect boolean true
19559 When this option is true, if a &(save)& command in an Exim filter specifies a
19560 relative path, and &$home$& is defined, it is automatically prepended to the
19561 relative path. If this option is set false, this action does not happen. The
19562 relative path is then passed to the transport unmodified.
19563
19564
19565 .option forbid_blackhole redirect boolean false
19566 If this option is true, the &':blackhole:'& item may not appear in a
19567 redirection list.
19568
19569
19570 .option forbid_exim_filter redirect boolean false
19571 If this option is set true, only Sieve filters are permitted when
19572 &%allow_filter%& is true.
19573
19574
19575
19576
19577 .option forbid_file redirect boolean false
19578 .cindex "delivery" "to file; forbidding"
19579 .cindex "Sieve filter" "forbidding delivery to a file"
19580 .cindex "Sieve filter" "&""keep""& facility; disabling"
19581 If this option is true, this router may not generate a new address that
19582 specifies delivery to a local file or directory, either from a filter or from a
19583 conventional forward file. This option is forced to be true if &%one_time%& is
19584 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19585 locks out the Sieve's &"keep"& facility.
19586
19587
19588 .option forbid_filter_dlfunc redirect boolean false
19589 .cindex "filter" "locking out certain features"
19590 If this option is true, string expansions in Exim filters are not allowed to
19591 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19592 functions.
19593
19594 .option forbid_filter_existstest redirect boolean false
19595 .cindex "expansion" "statting a file"
19596 If this option is true, string expansions in Exim filters are not allowed to
19597 make use of the &%exists%& condition or the &%stat%& expansion item.
19598
19599 .option forbid_filter_logwrite redirect boolean false
19600 If this option is true, use of the logging facility in Exim filters is not
19601 permitted. Logging is in any case available only if the filter is being run
19602 under some unprivileged uid (which is normally the case for ordinary users'
19603 &_.forward_& files).
19604
19605
19606 .option forbid_filter_lookup redirect boolean false
19607 If this option is true, string expansions in Exim filter files are not allowed
19608 to make use of &%lookup%& items.
19609
19610
19611 .option forbid_filter_perl redirect boolean false
19612 This option has an effect only if Exim is built with embedded Perl support. If
19613 it is true, string expansions in Exim filter files are not allowed to make use
19614 of the embedded Perl support.
19615
19616
19617 .option forbid_filter_readfile redirect boolean false
19618 If this option is true, string expansions in Exim filter files are not allowed
19619 to make use of &%readfile%& items.
19620
19621
19622 .option forbid_filter_readsocket redirect boolean false
19623 If this option is true, string expansions in Exim filter files are not allowed
19624 to make use of &%readsocket%& items.
19625
19626
19627 .option forbid_filter_reply redirect boolean false
19628 If this option is true, this router may not generate an automatic reply
19629 message. Automatic replies can be generated only from Exim or Sieve filter
19630 files, not from traditional forward files. This option is forced to be true if
19631 &%one_time%& is set.
19632
19633
19634 .option forbid_filter_run redirect boolean false
19635 If this option is true, string expansions in Exim filter files are not allowed
19636 to make use of &%run%& items.
19637
19638
19639 .option forbid_include redirect boolean false
19640 If this option is true, items of the form
19641 .code
19642 :include:<path name>
19643 .endd
19644 are not permitted in non-filter redirection lists.
19645
19646
19647 .option forbid_pipe redirect boolean false
19648 .cindex "delivery" "to pipe; forbidding"
19649 If this option is true, this router may not generate a new address which
19650 specifies delivery to a pipe, either from an Exim filter or from a conventional
19651 forward file. This option is forced to be true if &%one_time%& is set.
19652
19653
19654 .option forbid_sieve_filter redirect boolean false
19655 If this option is set true, only Exim filters are permitted when
19656 &%allow_filter%& is true.
19657
19658
19659 .cindex "SMTP" "error codes"
19660 .option forbid_smtp_code redirect boolean false
19661 If this option is set true, any SMTP error codes that are present at the start
19662 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19663 the default codes (451 and 550, respectively) are always used.
19664
19665
19666
19667
19668 .option hide_child_in_errmsg redirect boolean false
19669 .cindex "bounce message" "redirection details; suppressing"
19670 If this option is true, it prevents Exim from quoting a child address if it
19671 generates a bounce or delay message for it. Instead it says &"an address
19672 generated from <&'the top level address'&>"&. Of course, this applies only to
19673 bounces generated locally. If a message is forwarded to another host, &'its'&
19674 bounce may well quote the generated address.
19675
19676
19677 .option ignore_eacces redirect boolean false
19678 .cindex "EACCES"
19679 If this option is set and an attempt to open a redirection file yields the
19680 EACCES error (permission denied), the &(redirect)& router behaves as if the
19681 file did not exist.
19682
19683
19684 .option ignore_enotdir redirect boolean false
19685 .cindex "ENOTDIR"
19686 If this option is set and an attempt to open a redirection file yields the
19687 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19688 router behaves as if the file did not exist.
19689
19690 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19691 router that has the &%file%& option set discovers that the file does not exist
19692 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19693 against unmounted NFS directories. If the parent can not be statted, delivery
19694 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19695 is set, because that option tells Exim to ignore &"something on the path is not
19696 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19697 that some operating systems give ENOENT where others give ENOTDIR.
19698
19699
19700
19701 .option include_directory redirect string unset
19702 If this option is set, the path names of any &':include:'& items in a
19703 redirection list must start with this directory.
19704
19705
19706 .option modemask redirect "octal integer" 022
19707 This specifies mode bits which must not be set for a file specified by the
19708 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19709
19710
19711 .option one_time redirect boolean false
19712 .cindex "one-time aliasing/forwarding expansion"
19713 .cindex "alias file" "one-time expansion"
19714 .cindex "forward file" "one-time expansion"
19715 .cindex "mailing lists" "one-time expansion"
19716 .cindex "address redirection" "one-time expansion"
19717 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19718 files each time it tries to deliver a message causes a problem when one or more
19719 of the generated addresses fails be delivered at the first attempt. The problem
19720 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19721 but of what happens when the redirection list changes during the time that the
19722 message is on Exim's queue. This is particularly true in the case of mailing
19723 lists, where new subscribers might receive copies of messages that were posted
19724 before they subscribed.
19725
19726 If &%one_time%& is set and any addresses generated by the router fail to
19727 deliver at the first attempt, the failing addresses are added to the message as
19728 &"top level"& addresses, and the parent address that generated them is marked
19729 &"delivered"&. Thus, redirection does not happen again at the next delivery
19730 attempt.
19731
19732 &*Warning 1*&: Any header line addition or removal that is specified by this
19733 router would be lost if delivery did not succeed at the first attempt. For this
19734 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19735 permitted when &%one_time%& is set.
19736
19737 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19738 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19739 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19740
19741 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19742 &%one_time%&.
19743
19744 The original top-level address is remembered with each of the generated
19745 addresses, and is output in any log messages. However, any intermediate parent
19746 addresses are not recorded. This makes a difference to the log only if
19747 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19748 typically be used for mailing lists, where there is normally just one level of
19749 expansion.
19750
19751
19752 .option owners redirect "string list" unset
19753 .cindex "ownership" "alias file"
19754 .cindex "ownership" "forward file"
19755 .cindex "alias file" "ownership"
19756 .cindex "forward file" "ownership"
19757 This specifies a list of permitted owners for the file specified by &%file%&.
19758 This list is in addition to the local user when &%check_local_user%& is set.
19759 See &%check_owner%& above.
19760
19761
19762 .option owngroups redirect "string list" unset
19763 This specifies a list of permitted groups for the file specified by &%file%&.
19764 The list is in addition to the local user's primary group when
19765 &%check_local_user%& is set. See &%check_group%& above.
19766
19767
19768 .option pipe_transport redirect string&!! unset
19769 .vindex "&$address_pipe$&"
19770 A &(redirect)& router sets up a direct delivery to a pipe when a string
19771 starting with a vertical bar character is specified as a new &"address"&. The
19772 transport used is specified by this option, which, after expansion, must be the
19773 name of a configured transport. This should normally be a &(pipe)& transport.
19774 When the transport is run, the pipe command is in &$address_pipe$&.
19775
19776
19777 .option qualify_domain redirect string&!! unset
19778 .vindex "&$qualify_recipient$&"
19779 If this option is set, and an unqualified address (one without a domain) is
19780 generated, and that address would normally be qualified by the global setting
19781 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19782 expanding this string. If the expansion fails, the router declines. If you want
19783 to revert to the default, you can have the expansion generate
19784 &$qualify_recipient$&.
19785
19786 This option applies to all unqualified addresses generated by Exim filters,
19787 but for traditional &_.forward_& files, it applies only to addresses that are
19788 not preceded by a backslash. Sieve filters cannot generate unqualified
19789 addresses.
19790
19791 .option qualify_preserve_domain redirect boolean false
19792 .cindex "domain" "in redirection; preserving"
19793 .cindex "preserving domain in redirection"
19794 .cindex "address redirection" "domain; preserving"
19795 If this option is set, the router's local &%qualify_domain%& option must not be
19796 set (a configuration error occurs if it is). If an unqualified address (one
19797 without a domain) is generated, it is qualified with the domain of the parent
19798 address (the immediately preceding ancestor) instead of the global
19799 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19800 this applies whether or not the address is preceded by a backslash.
19801
19802
19803 .option repeat_use redirect boolean true
19804 If this option is set false, the router is skipped for a child address that has
19805 any ancestor that was routed by this router. This test happens before any of
19806 the other preconditions are tested. Exim's default anti-looping rules skip
19807 only when the ancestor is the same as the current address. See also
19808 &%check_ancestor%& above and the generic &%redirect_router%& option.
19809
19810
19811 .option reply_transport redirect string&!! unset
19812 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19813 &%vacation%& command is used in a filter file. The transport used is specified
19814 by this option, which, after expansion, must be the name of a configured
19815 transport. This should normally be an &(autoreply)& transport. Other transports
19816 are unlikely to do anything sensible or useful.
19817
19818
19819 .option rewrite redirect boolean true
19820 .cindex "address redirection" "disabling rewriting"
19821 If this option is set false, addresses generated by the router are not
19822 subject to address rewriting. Otherwise, they are treated like new addresses
19823 and are rewritten according to the global rewriting rules.
19824
19825
19826 .option sieve_subaddress redirect string&!! unset
19827 The value of this option is passed to a Sieve filter to specify the
19828 :subaddress part of an address.
19829
19830 .option sieve_useraddress redirect string&!! unset
19831 The value of this option is passed to a Sieve filter to specify the :user part
19832 of an address. However, if it is unset, the entire original local part
19833 (including any prefix or suffix) is used for :user.
19834
19835
19836 .option sieve_vacation_directory redirect string&!! unset
19837 .cindex "Sieve filter" "vacation directory"
19838 To enable the &"vacation"& extension for Sieve filters, you must set
19839 &%sieve_vacation_directory%& to the directory where vacation databases are held
19840 (do not put anything else in that directory), and ensure that the
19841 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19842 needs their own directory; Exim will create it if necessary.
19843
19844
19845
19846 .option skip_syntax_errors redirect boolean false
19847 .cindex "forward file" "broken"
19848 .cindex "address redirection" "broken files"
19849 .cindex "alias file" "broken"
19850 .cindex "broken alias or forward files"
19851 .cindex "ignoring faulty addresses"
19852 .cindex "skipping faulty addresses"
19853 .cindex "error" "skipping bad syntax"
19854 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19855 non-filter redirection data are skipped, and each failing address is logged. If
19856 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19857 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19858 are expanded and placed at the head of the error message generated by
19859 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19860 be the same address as the generic &%errors_to%& option. The
19861 &%skip_syntax_errors%& option is often used when handling mailing lists.
19862
19863 If all the addresses in a redirection list are skipped because of syntax
19864 errors, the router declines to handle the original address, and it is passed to
19865 the following routers.
19866
19867 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19868 error in the filter causes filtering to be abandoned without any action being
19869 taken. The incident is logged, and the router declines to handle the address,
19870 so it is passed to the following routers.
19871
19872 .cindex "Sieve filter" "syntax errors in"
19873 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19874 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19875 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19876
19877 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19878 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19879 option, used with an address that does not get redirected, can be used to
19880 notify users of these errors, by means of a router like this:
19881 .code
19882 userforward:
19883   driver = redirect
19884   allow_filter
19885   check_local_user
19886   file = $home/.forward
19887   file_transport = address_file
19888   pipe_transport = address_pipe
19889   reply_transport = address_reply
19890   no_verify
19891   skip_syntax_errors
19892   syntax_errors_to = real-$local_part@$domain
19893   syntax_errors_text = \
19894    This is an automatically generated message. An error has\n\
19895    been found in your .forward file. Details of the error are\n\
19896    reported below. While this error persists, you will receive\n\
19897    a copy of this message for every message that is addressed\n\
19898    to you. If your .forward file is a filter file, or if it is\n\
19899    a non-filter file containing no valid forwarding addresses,\n\
19900    a copy of each incoming message will be put in your normal\n\
19901    mailbox. If a non-filter file contains at least one valid\n\
19902    forwarding address, forwarding to the valid addresses will\n\
19903    happen, and those will be the only deliveries that occur.
19904 .endd
19905 You also need a router to ensure that local addresses that are prefixed by
19906 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19907 put this immediately before the &(userforward)& router:
19908 .code
19909 real_localuser:
19910   driver = accept
19911   check_local_user
19912   local_part_prefix = real-
19913   transport = local_delivery
19914 .endd
19915 For security, it would probably be a good idea to restrict the use of this
19916 router to locally-generated messages, using a condition such as this:
19917 .code
19918   condition = ${if match {$sender_host_address}\
19919                          {\N^(|127\.0\.0\.1)$\N}}
19920 .endd
19921
19922
19923 .option syntax_errors_text redirect string&!! unset
19924 See &%skip_syntax_errors%& above.
19925
19926
19927 .option syntax_errors_to redirect string unset
19928 See &%skip_syntax_errors%& above.
19929 .ecindex IIDredrou1
19930 .ecindex IIDredrou2
19931
19932
19933
19934
19935
19936
19937 . ////////////////////////////////////////////////////////////////////////////
19938 . ////////////////////////////////////////////////////////////////////////////
19939
19940 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19941          "Environment for local transports"
19942 .scindex IIDenvlotra1 "local transports" "environment for"
19943 .scindex IIDenvlotra2 "environment for local transports"
19944 .scindex IIDenvlotra3 "transport" "local; environment for"
19945 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19946 transport can be thought of as similar to a pipe.) Exim always runs transports
19947 in subprocesses, under specified uids and gids. Typical deliveries to local
19948 mailboxes run under the uid and gid of the local user.
19949
19950 Exim also sets a specific current directory while running the transport; for
19951 some transports a home directory setting is also relevant. The &(pipe)&
19952 transport is the only one that sets up environment variables; see section
19953 &<<SECTpipeenv>>& for details.
19954
19955 The values used for the uid, gid, and the directories may come from several
19956 different places. In many cases, the router that handles the address associates
19957 settings with that address as a result of its &%check_local_user%&, &%group%&,
19958 or &%user%& options. However, values may also be given in the transport's own
19959 configuration, and these override anything that comes from the router.
19960
19961
19962
19963 .section "Concurrent deliveries" "SECID131"
19964 .cindex "concurrent deliveries"
19965 .cindex "simultaneous deliveries"
19966 If two different messages for the same local recipient arrive more or less
19967 simultaneously, the two delivery processes are likely to run concurrently. When
19968 the &(appendfile)& transport is used to write to a file, Exim applies locking
19969 rules to stop concurrent processes from writing to the same file at the same
19970 time.
19971
19972 However, when you use a &(pipe)& transport, it is up to you to arrange any
19973 locking that is needed. Here is a silly example:
19974 .code
19975 my_transport:
19976   driver = pipe
19977   command = /bin/sh -c 'cat >>/some/file'
19978 .endd
19979 This is supposed to write the message at the end of the file. However, if two
19980 messages arrive at the same time, the file will be scrambled. You can use the
19981 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19982 file using the same algorithm that Exim itself uses.
19983
19984
19985
19986
19987 .section "Uids and gids" "SECTenvuidgid"
19988 .cindex "local transports" "uid and gid"
19989 .cindex "transport" "local; uid and gid"
19990 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19991 overrides any group that the router set in the address, even if &%user%& is not
19992 set for the transport. This makes it possible, for example, to run local mail
19993 delivery under the uid of the recipient (set by the router), but in a special
19994 group (set by the transport). For example:
19995 .code
19996 # Routers ...
19997 # User/group are set by check_local_user in this router
19998 local_users:
19999   driver = accept
20000   check_local_user
20001   transport = group_delivery
20002
20003 # Transports ...
20004 # This transport overrides the group
20005 group_delivery:
20006   driver = appendfile
20007   file = /var/spool/mail/$local_part
20008   group = mail
20009 .endd
20010 If &%user%& is set for a transport, its value overrides what is set in the
20011 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20012 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20013 set.
20014
20015 .oindex "&%initgroups%&"
20016 When the uid is taken from the transport's configuration, the &[initgroups()]&
20017 function is called for the groups associated with that uid if the
20018 &%initgroups%& option is set for the transport. When the uid is not specified
20019 by the transport, but is associated with the address by a router, the option
20020 for calling &[initgroups()]& is taken from the router configuration.
20021
20022 .cindex "&(pipe)& transport" "uid for"
20023 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20024 is set and &%user%& is not set, the uid of the process that called Exim to
20025 receive the message is used, and if &%group%& is not set, the corresponding
20026 original gid is also used.
20027
20028 This is the detailed preference order for obtaining a gid; the first of the
20029 following that is set is used:
20030
20031 .ilist
20032 A &%group%& setting of the transport;
20033 .next
20034 A &%group%& setting of the router;
20035 .next
20036 A gid associated with a user setting of the router, either as a result of
20037 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20038 .next
20039 The group associated with a non-numeric &%user%& setting of the transport;
20040 .next
20041 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20042 the uid is the creator's uid;
20043 .next
20044 The Exim gid if the Exim uid is being used as a default.
20045 .endlist
20046
20047 If, for example, the user is specified numerically on the router and there are
20048 no group settings, no gid is available. In this situation, an error occurs.
20049 This is different for the uid, for which there always is an ultimate default.
20050 The first of the following that is set is used:
20051
20052 .ilist
20053 A &%user%& setting of the transport;
20054 .next
20055 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20056 .next
20057 A &%user%& setting of the router;
20058 .next
20059 A &%check_local_user%& setting of the router;
20060 .next
20061 The Exim uid.
20062 .endlist
20063
20064 Of course, an error will still occur if the uid that is chosen is on the
20065 &%never_users%& list.
20066
20067
20068
20069
20070
20071 .section "Current and home directories" "SECID132"
20072 .cindex "current directory for local transport"
20073 .cindex "home directory" "for local transport"
20074 .cindex "transport" "local; home directory for"
20075 .cindex "transport" "local; current directory for"
20076 Routers may set current and home directories for local transports by means of
20077 the &%transport_current_directory%& and &%transport_home_directory%& options.
20078 However, if the transport's &%current_directory%& or &%home_directory%& options
20079 are set, they override the router's values. In detail, the home directory
20080 for a local transport is taken from the first of these values that is set:
20081
20082 .ilist
20083 The &%home_directory%& option on the transport;
20084 .next
20085 The &%transport_home_directory%& option on the router;
20086 .next
20087 The password data if &%check_local_user%& is set on the router;
20088 .next
20089 The &%router_home_directory%& option on the router.
20090 .endlist
20091
20092 The current directory is taken from the first of these values that is set:
20093
20094 .ilist
20095 The &%current_directory%& option on the transport;
20096 .next
20097 The &%transport_current_directory%& option on the router.
20098 .endlist
20099
20100
20101 If neither the router nor the transport sets a current directory, Exim uses the
20102 value of the home directory, if it is set. Otherwise it sets the current
20103 directory to &_/_& before running a local transport.
20104
20105
20106
20107 .section "Expansion variables derived from the address" "SECID133"
20108 .vindex "&$domain$&"
20109 .vindex "&$local_part$&"
20110 .vindex "&$original_domain$&"
20111 Normally a local delivery is handling a single address, and in that case the
20112 variables such as &$domain$& and &$local_part$& are set during local
20113 deliveries. However, in some circumstances more than one address may be handled
20114 at once (for example, while writing batch SMTP for onward transmission by some
20115 other means). In this case, the variables associated with the local part are
20116 never set, &$domain$& is set only if all the addresses have the same domain,
20117 and &$original_domain$& is never set.
20118 .ecindex IIDenvlotra1
20119 .ecindex IIDenvlotra2
20120 .ecindex IIDenvlotra3
20121
20122
20123
20124
20125
20126
20127
20128 . ////////////////////////////////////////////////////////////////////////////
20129 . ////////////////////////////////////////////////////////////////////////////
20130
20131 .chapter "Generic options for transports" "CHAPtransportgeneric"
20132 .scindex IIDgenoptra1 "generic options" "transport"
20133 .scindex IIDgenoptra2 "options" "generic; for transports"
20134 .scindex IIDgenoptra3 "transport" "generic options for"
20135 The following generic options apply to all transports:
20136
20137
20138 .option body_only transports boolean false
20139 .cindex "transport" "body only"
20140 .cindex "message" "transporting body only"
20141 .cindex "body of message" "transporting"
20142 If this option is set, the message's headers are not transported. It is
20143 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20144 or &(pipe)& transports, the settings of &%message_prefix%& and
20145 &%message_suffix%& should be checked, because this option does not
20146 automatically suppress them.
20147
20148
20149 .option current_directory transports string&!! unset
20150 .cindex "transport" "current directory for"
20151 This specifies the current directory that is to be set while running the
20152 transport, overriding any value that may have been set by the router.
20153 If the expansion fails for any reason, including forced failure, an error is
20154 logged, and delivery is deferred.
20155
20156
20157 .option disable_logging transports boolean false
20158 If this option is set true, nothing is logged for any
20159 deliveries by the transport or for any
20160 transport errors. You should not set this option unless you really, really know
20161 what you are doing.
20162
20163
20164 .option debug_print transports string&!! unset
20165 .cindex "testing" "variables in drivers"
20166 If this option is set and debugging is enabled (see the &%-d%& command line
20167 option), the string is expanded and included in the debugging output when the
20168 transport is run.
20169 If expansion of the string fails, the error message is written to the debugging
20170 output, and Exim carries on processing.
20171 This facility is provided to help with checking out the values of variables and
20172 so on when debugging driver configurations. For example, if a &%headers_add%&
20173 option is not working properly, &%debug_print%& could be used to output the
20174 variables it references. A newline is added to the text if it does not end with
20175 one.
20176 The variables &$transport_name$& and &$router_name$& contain the name of the
20177 transport and the router that called it.
20178
20179 .option delivery_date_add transports boolean false
20180 .cindex "&'Delivery-date:'& header line"
20181 If this option is true, a &'Delivery-date:'& header is added to the message.
20182 This gives the actual time the delivery was made. As this is not a standard
20183 header, Exim has a configuration option (&%delivery_date_remove%&) which
20184 requests its removal from incoming messages, so that delivered messages can
20185 safely be resent to other recipients.
20186
20187
20188 .option driver transports string unset
20189 This specifies which of the available transport drivers is to be used.
20190 There is no default, and this option must be set for every transport.
20191
20192
20193 .option envelope_to_add transports boolean false
20194 .cindex "&'Envelope-to:'& header line"
20195 If this option is true, an &'Envelope-to:'& header is added to the message.
20196 This gives the original address(es) in the incoming envelope that caused this
20197 delivery to happen. More than one address may be present if the transport is
20198 configured to handle several addresses at once, or if more than one original
20199 address was redirected to the same final address. As this is not a standard
20200 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20201 its removal from incoming messages, so that delivered messages can safely be
20202 resent to other recipients.
20203
20204
20205 .option group transports string&!! "Exim group"
20206 .cindex "transport" "group; specifying"
20207 This option specifies a gid for running the transport process, overriding any
20208 value that the router supplies, and also overriding any value associated with
20209 &%user%& (see below).
20210
20211
20212 .option headers_add transports list&!! unset
20213 .cindex "header lines" "adding in transport"
20214 .cindex "transport" "header lines; adding"
20215 This option specifies a list of text headers, newline-separated,
20216 which are (separately) expanded and added to the header
20217 portion of a message as it is transported, as described in section
20218 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20219 routers. If the result of the expansion is an empty string, or if the expansion
20220 is forced to fail, no action is taken. Other expansion failures are treated as
20221 errors and cause the delivery to be deferred.
20222
20223 Unlike most options, &%headers_add%& can be specified multiple times
20224 for a transport; all listed headers are added.
20225
20226
20227 .option headers_only transports boolean false
20228 .cindex "transport" "header lines only"
20229 .cindex "message" "transporting headers only"
20230 .cindex "header lines" "transporting"
20231 If this option is set, the message's body is not transported. It is mutually
20232 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20233 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20234 checked, since this option does not automatically suppress them.
20235
20236
20237 .option headers_remove transports list&!! unset
20238 .cindex "header lines" "removing"
20239 .cindex "transport" "header lines; removing"
20240 This option specifies a list of header names, colon-separated;
20241 these headers are omitted from the message as it is transported, as described
20242 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20243 routers.
20244 Each list item is separately expanded.
20245 If the result of the expansion is an empty string, or if the expansion
20246 is forced to fail, no action is taken. Other expansion failures are treated as
20247 errors and cause the delivery to be deferred.
20248
20249 Unlike most options, &%headers_remove%& can be specified multiple times
20250 for a router; all listed headers are removed.
20251
20252
20253
20254 .option headers_rewrite transports string unset
20255 .cindex "transport" "header lines; rewriting"
20256 .cindex "rewriting" "at transport time"
20257 This option allows addresses in header lines to be rewritten at transport time,
20258 that is, as the message is being copied to its destination. The contents of the
20259 option are a colon-separated list of rewriting rules. Each rule is in exactly
20260 the same form as one of the general rewriting rules that are applied when a
20261 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20262 example,
20263 .code
20264 headers_rewrite = a@b c@d f : \
20265                   x@y w@z
20266 .endd
20267 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20268 &'w@z'& in all address-bearing header lines. The rules are applied to the
20269 header lines just before they are written out at transport time, so they affect
20270 only those copies of the message that pass through the transport. However, only
20271 the message's original header lines, and any that were added by a system
20272 filter, are rewritten. If a router or transport adds header lines, they are not
20273 affected by this option. These rewriting rules are &'not'& applied to the
20274 envelope. You can change the return path using &%return_path%&, but you cannot
20275 change envelope recipients at this time.
20276
20277
20278 .option home_directory transports string&!! unset
20279 .cindex "transport" "home directory for"
20280 .vindex "&$home$&"
20281 This option specifies a home directory setting for a local transport,
20282 overriding any value that may be set by the router. The home directory is
20283 placed in &$home$& while expanding the transport's private options. It is also
20284 used as the current directory if no current directory is set by the
20285 &%current_directory%& option on the transport or the
20286 &%transport_current_directory%& option on the router. If the expansion fails
20287 for any reason, including forced failure, an error is logged, and delivery is
20288 deferred.
20289
20290
20291 .option initgroups transports boolean false
20292 .cindex "additional groups"
20293 .cindex "groups" "additional"
20294 .cindex "transport" "group; additional"
20295 If this option is true and the uid for the delivery process is provided by the
20296 transport, the &[initgroups()]& function is called when running the transport
20297 to ensure that any additional groups associated with the uid are set up.
20298
20299
20300 .option message_size_limit transports string&!! 0
20301 .cindex "limit" "message size per transport"
20302 .cindex "size" "of message, limit"
20303 .cindex "transport" "message size; limiting"
20304 This option controls the size of messages passed through the transport. It is
20305 expanded before use; the result of the expansion must be a sequence of decimal
20306 digits, optionally followed by K or M. If the expansion fails for any reason,
20307 including forced failure, or if the result is not of the required form,
20308 delivery is deferred. If the value is greater than zero and the size of a
20309 message exceeds this limit, the address is failed. If there is any chance that
20310 the resulting bounce message could be routed to the same transport, you should
20311 ensure that &%return_size_limit%& is less than the transport's
20312 &%message_size_limit%&, as otherwise the bounce message will fail to get
20313 delivered.
20314
20315
20316
20317 .option rcpt_include_affixes transports boolean false
20318 .cindex "prefix" "for local part, including in envelope"
20319 .cindex "suffix for local part" "including in envelope"
20320 .cindex "local part" "prefix"
20321 .cindex "local part" "suffix"
20322 When this option is false (the default), and an address that has had any
20323 affixes (prefixes or suffixes) removed from the local part is delivered by any
20324 form of SMTP or LMTP, the affixes are not included. For example, if a router
20325 that contains
20326 .code
20327 local_part_prefix = *-
20328 .endd
20329 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20330 is delivered with
20331 .code
20332 RCPT TO:<xyz@some.domain>
20333 .endd
20334 This is also the case when an ACL-time callout is being used to verify a
20335 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20336 whole local part is included in the RCPT command. This option applies to BSMTP
20337 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20338 &(lmtp)& and &(smtp)& transports.
20339
20340
20341 .option retry_use_local_part transports boolean "see below"
20342 .cindex "hints database" "retry keys"
20343 When a delivery suffers a temporary failure, a retry record is created
20344 in Exim's hints database. For remote deliveries, the key for the retry record
20345 is based on the name and/or IP address of the failing remote host. For local
20346 deliveries, the key is normally the entire address, including both the local
20347 part and the domain. This is suitable for most common cases of local delivery
20348 temporary failure &-- for example, exceeding a mailbox quota should delay only
20349 deliveries to that mailbox, not to the whole domain.
20350
20351 However, in some special cases you may want to treat a temporary local delivery
20352 as a failure associated with the domain, and not with a particular local part.
20353 (For example, if you are storing all mail for some domain in files.) You can do
20354 this by setting &%retry_use_local_part%& false.
20355
20356 For all the local transports, its default value is true. For remote transports,
20357 the default value is false for tidiness, but changing the value has no effect
20358 on a remote transport in the current implementation.
20359
20360
20361 .option return_path transports string&!! unset
20362 .cindex "envelope sender"
20363 .cindex "transport" "return path; changing"
20364 .cindex "return path" "changing in transport"
20365 If this option is set, the string is expanded at transport time and replaces
20366 the existing return path (envelope sender) value in the copy of the message
20367 that is being delivered. An empty return path is permitted. This feature is
20368 designed for remote deliveries, where the value of this option is used in the
20369 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20370 only effect is to change the address that is placed in the &'Return-path:'&
20371 header line, if one is added to the message (see the next option).
20372
20373 &*Note:*& A changed return path is not logged unless you add
20374 &%return_path_on_delivery%& to the log selector.
20375
20376 .vindex "&$return_path$&"
20377 The expansion can refer to the existing value via &$return_path$&. This is
20378 either the message's envelope sender, or an address set by the
20379 &%errors_to%& option on a router. If the expansion is forced to fail, no
20380 replacement occurs; if it fails for another reason, delivery is deferred. This
20381 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20382 section &<<SECTverp>>&.
20383
20384 &*Note*&: If a delivery error is detected locally, including the case when a
20385 remote server rejects a message at SMTP time, the bounce message is not sent to
20386 the value of this option. It is sent to the previously set errors address.
20387 This defaults to the incoming sender address, but can be changed by setting
20388 &%errors_to%& in a router.
20389
20390
20391
20392 .option return_path_add transports boolean false
20393 .cindex "&'Return-path:'& header line"
20394 If this option is true, a &'Return-path:'& header is added to the message.
20395 Although the return path is normally available in the prefix line of BSD
20396 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20397 have easy access to it.
20398
20399 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20400 the delivery SMTP server makes the final delivery"&. This implies that this
20401 header should not be present in incoming messages. Exim has a configuration
20402 option, &%return_path_remove%&, which requests removal of this header from
20403 incoming messages, so that delivered messages can safely be resent to other
20404 recipients.
20405
20406
20407 .option shadow_condition transports string&!! unset
20408 See &%shadow_transport%& below.
20409
20410
20411 .option shadow_transport transports string unset
20412 .cindex "shadow transport"
20413 .cindex "transport" "shadow"
20414 A local transport may set the &%shadow_transport%& option to the name of
20415 another local transport. Shadow remote transports are not supported.
20416
20417 Whenever a delivery to the main transport succeeds, and either
20418 &%shadow_condition%& is unset, or its expansion does not result in the empty
20419 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20420 passed to the shadow transport, with the same delivery address or addresses. If
20421 expansion fails, no action is taken except that non-forced expansion failures
20422 cause a log line to be written.
20423
20424 The result of the shadow transport is discarded and does not affect the
20425 subsequent processing of the message. Only a single level of shadowing is
20426 provided; the &%shadow_transport%& option is ignored on any transport when it
20427 is running as a shadow. Options concerned with output from pipes are also
20428 ignored. The log line for the successful delivery has an item added on the end,
20429 of the form
20430 .code
20431 ST=<shadow transport name>
20432 .endd
20433 If the shadow transport did not succeed, the error message is put in
20434 parentheses afterwards. Shadow transports can be used for a number of different
20435 purposes, including keeping more detailed log information than Exim normally
20436 provides, and implementing automatic acknowledgment policies based on message
20437 headers that some sites insist on.
20438
20439
20440 .option transport_filter transports string&!! unset
20441 .cindex "transport" "filter"
20442 .cindex "filter" "transport filter"
20443 This option sets up a filtering (in the Unix shell sense) process for messages
20444 at transport time. It should not be confused with mail filtering as set up by
20445 individual users or via a system filter.
20446
20447 When the message is about to be written out, the command specified by
20448 &%transport_filter%& is started up in a separate, parallel process, and
20449 the entire message, including the header lines, is passed to it on its standard
20450 input (this in fact is done from a third process, to avoid deadlock). The
20451 command must be specified as an absolute path.
20452
20453 The lines of the message that are written to the transport filter are
20454 terminated by newline (&"\n"&). The message is passed to the filter before any
20455 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20456 lines beginning with a dot, and also before any processing implied by the
20457 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20458 &(pipe)& transports.
20459
20460 The standard error for the filter process is set to the same destination as its
20461 standard output; this is read and written to the message's ultimate
20462 destination. The process that writes the message to the filter, the
20463 filter itself, and the original process that reads the result and delivers it
20464 are all run in parallel, like a shell pipeline.
20465
20466 The filter can perform any transformations it likes, but of course should take
20467 care not to break RFC 2822 syntax. Exim does not check the result, except to
20468 test for a final newline when SMTP is in use. All messages transmitted over
20469 SMTP must end with a newline, so Exim supplies one if it is missing.
20470
20471 .cindex "content scanning" "per user"
20472 A transport filter can be used to provide content-scanning on a per-user basis
20473 at delivery time if the only required effect of the scan is to modify the
20474 message. For example, a content scan could insert a new header line containing
20475 a spam score. This could be interpreted by a filter in the user's MUA. It is
20476 not possible to discard a message at this stage.
20477
20478 .cindex "SMTP" "SIZE"
20479 A problem might arise if the filter increases the size of a message that is
20480 being sent down an SMTP connection. If the receiving SMTP server has indicated
20481 support for the SIZE parameter, Exim will have sent the size of the message
20482 at the start of the SMTP session. If what is actually sent is substantially
20483 more, the server might reject the message. This can be worked round by setting
20484 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20485 additions to the message, or to disable the use of SIZE altogether.
20486
20487 .vindex "&$pipe_addresses$&"
20488 The value of the &%transport_filter%& option is the command string for starting
20489 the filter, which is run directly from Exim, not under a shell. The string is
20490 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20491 Exim breaks it up into arguments and then expands each argument separately (see
20492 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20493 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20494 of arguments, one for each address that applies to this delivery. (This isn't
20495 an ideal name for this feature here, but as it was already implemented for the
20496 &(pipe)& transport, it seemed sensible not to change it.)
20497
20498 .vindex "&$host$&"
20499 .vindex "&$host_address$&"
20500 The expansion variables &$host$& and &$host_address$& are available when the
20501 transport is a remote one. They contain the name and IP address of the host to
20502 which the message is being sent. For example:
20503 .code
20504 transport_filter = /some/directory/transport-filter.pl \
20505   $host $host_address $sender_address $pipe_addresses
20506 .endd
20507
20508 Two problems arise if you want to use more complicated expansion items to
20509 generate transport filter commands, both of which due to the fact that the
20510 command is split up &'before'& expansion.
20511 .ilist
20512 If an expansion item contains white space, you must quote it, so that it is all
20513 part of the same command item. If the entire option setting is one such
20514 expansion item, you have to take care what kind of quoting you use. For
20515 example:
20516 .code
20517 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20518 .endd
20519 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20520 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20521 stripped by Exim when it read the option's value. When the value is used, if
20522 the single quotes were missing, the line would be split into two items,
20523 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20524 Exim tried to expand the first one.
20525 .next
20526 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20527 expansion cannot generate multiple arguments, or a command name followed by
20528 arguments. Consider this example:
20529 .code
20530 transport_filter = ${lookup{$host}lsearch{/a/file}\
20531                     {$value}{/bin/cat}}
20532 .endd
20533 The result of the lookup is interpreted as the name of the command, even
20534 if it contains white space. The simplest way round this is to use a shell:
20535 .code
20536 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20537                                {$value}{/bin/cat}}
20538 .endd
20539 .endlist
20540
20541 The filter process is run under the same uid and gid as the normal delivery.
20542 For remote deliveries this is the Exim uid/gid by default. The command should
20543 normally yield a zero return code. Transport filters are not supposed to fail.
20544 A non-zero code is taken to mean that the transport filter encountered some
20545 serious problem. Delivery of the message is deferred; the message remains on
20546 the queue and is tried again later. It is not possible to cause a message to be
20547 bounced from a transport filter.
20548
20549 If a transport filter is set on an autoreply transport, the original message is
20550 passed through the filter as it is being copied into the newly generated
20551 message, which happens if the &%return_message%& option is set.
20552
20553
20554 .option transport_filter_timeout transports time 5m
20555 .cindex "transport" "filter, timeout"
20556 When Exim is reading the output of a transport filter, it applies a timeout
20557 that can be set by this option. Exceeding the timeout is normally treated as a
20558 temporary delivery failure. However, if a transport filter is used with a
20559 &(pipe)& transport, a timeout in the transport filter is treated in the same
20560 way as a timeout in the pipe command itself. By default, a timeout is a hard
20561 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20562 becomes a temporary error.
20563
20564
20565 .option user transports string&!! "Exim user"
20566 .cindex "uid (user id)" "local delivery"
20567 .cindex "transport" "user, specifying"
20568 This option specifies the user under whose uid the delivery process is to be
20569 run, overriding any uid that may have been set by the router. If the user is
20570 given as a name, the uid is looked up from the password data, and the
20571 associated group is taken as the value of the gid to be used if the &%group%&
20572 option is not set.
20573
20574 For deliveries that use local transports, a user and group are normally
20575 specified explicitly or implicitly (for example, as a result of
20576 &%check_local_user%&) by the router or transport.
20577
20578 .cindex "hints database" "access by remote transport"
20579 For remote transports, you should leave this option unset unless you really are
20580 sure you know what you are doing. When a remote transport is running, it needs
20581 to be able to access Exim's hints databases, because each host may have its own
20582 retry data.
20583 .ecindex IIDgenoptra1
20584 .ecindex IIDgenoptra2
20585 .ecindex IIDgenoptra3
20586
20587
20588
20589
20590
20591
20592 . ////////////////////////////////////////////////////////////////////////////
20593 . ////////////////////////////////////////////////////////////////////////////
20594
20595 .chapter "Address batching in local transports" "CHAPbatching" &&&
20596          "Address batching"
20597 .cindex "transport" "local; address batching in"
20598 The only remote transport (&(smtp)&) is normally configured to handle more than
20599 one address at a time, so that when several addresses are routed to the same
20600 remote host, just one copy of the message is sent. Local transports, however,
20601 normally handle one address at a time. That is, a separate instance of the
20602 transport is run for each address that is routed to the transport. A separate
20603 copy of the message is delivered each time.
20604
20605 .cindex "batched local delivery"
20606 .oindex "&%batch_max%&"
20607 .oindex "&%batch_id%&"
20608 In special cases, it may be desirable to handle several addresses at once in a
20609 local transport, for example:
20610
20611 .ilist
20612 In an &(appendfile)& transport, when storing messages in files for later
20613 delivery by some other means, a single copy of the message with multiple
20614 recipients saves space.
20615 .next
20616 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20617 a single copy saves time, and is the normal way LMTP is expected to work.
20618 .next
20619 In a &(pipe)& transport, when passing the message
20620 to a scanner program or
20621 to some other delivery mechanism such as UUCP, multiple recipients may be
20622 acceptable.
20623 .endlist
20624
20625 These three local transports all have the same options for controlling multiple
20626 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20627 repeating the information for each transport, these options are described here.
20628
20629 The &%batch_max%& option specifies the maximum number of addresses that can be
20630 delivered together in a single run of the transport. Its default value is one
20631 (no batching). When more than one address is routed to a transport that has a
20632 &%batch_max%& value greater than one, the addresses are delivered in a batch
20633 (that is, in a single run of the transport with multiple recipients), subject
20634 to certain conditions:
20635
20636 .ilist
20637 .vindex "&$local_part$&"
20638 If any of the transport's options contain a reference to &$local_part$&, no
20639 batching is possible.
20640 .next
20641 .vindex "&$domain$&"
20642 If any of the transport's options contain a reference to &$domain$&, only
20643 addresses with the same domain are batched.
20644 .next
20645 .cindex "customizing" "batching condition"
20646 If &%batch_id%& is set, it is expanded for each address, and only those
20647 addresses with the same expanded value are batched. This allows you to specify
20648 customized batching conditions. Failure of the expansion for any reason,
20649 including forced failure, disables batching, but it does not stop the delivery
20650 from taking place.
20651 .next
20652 Batched addresses must also have the same errors address (where to send
20653 delivery errors), the same header additions and removals, the same user and
20654 group for the transport, and if a host list is present, the first host must
20655 be the same.
20656 .endlist
20657
20658 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20659 both when the file or pipe command is specified in the transport, and when it
20660 is specified by a &(redirect)& router, but all the batched addresses must of
20661 course be routed to the same file or pipe command. These two transports have an
20662 option called &%use_bsmtp%&, which causes them to deliver the message in
20663 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20664 &%check_string%& and &%escape_string%& options are forced to the values
20665 .code
20666 check_string = "."
20667 escape_string = ".."
20668 .endd
20669 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20670 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20671 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20672
20673 .cindex "&'Envelope-to:'& header line"
20674 If the generic &%envelope_to_add%& option is set for a batching transport, the
20675 &'Envelope-to:'& header that is added to the message contains all the addresses
20676 that are being processed together. If you are using a batching &(appendfile)&
20677 transport without &%use_bsmtp%&, the only way to preserve the recipient
20678 addresses is to set the &%envelope_to_add%& option.
20679
20680 .cindex "&(pipe)& transport" "with multiple addresses"
20681 .vindex "&$pipe_addresses$&"
20682 If you are using a &(pipe)& transport without BSMTP, and setting the
20683 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20684 the command. This is not a true variable; it is a bit of magic that causes each
20685 of the recipient addresses to be inserted into the command as a separate
20686 argument. This provides a way of accessing all the addresses that are being
20687 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20688 are specified by a &(redirect)& router.
20689
20690
20691
20692
20693 . ////////////////////////////////////////////////////////////////////////////
20694 . ////////////////////////////////////////////////////////////////////////////
20695
20696 .chapter "The appendfile transport" "CHAPappendfile"
20697 .scindex IIDapptra1 "&(appendfile)& transport"
20698 .scindex IIDapptra2 "transports" "&(appendfile)&"
20699 .cindex "directory creation"
20700 .cindex "creating directories"
20701 The &(appendfile)& transport delivers a message by appending it to an existing
20702 file, or by creating an entirely new file in a specified directory. Single
20703 files to which messages are appended can be in the traditional Unix mailbox
20704 format, or optionally in the MBX format supported by the Pine MUA and
20705 University of Washington IMAP daemon, &'inter alia'&. When each message is
20706 being delivered as a separate file, &"maildir"& format can optionally be used
20707 to give added protection against failures that happen part-way through the
20708 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20709 supported. For all file formats, Exim attempts to create as many levels of
20710 directory as necessary, provided that &%create_directory%& is set.
20711
20712 The code for the optional formats is not included in the Exim binary by
20713 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20714 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20715 included.
20716
20717 .cindex "quota" "system"
20718 Exim recognizes system quota errors, and generates an appropriate message. Exim
20719 also supports its own quota control within the transport, for use when the
20720 system facility is unavailable or cannot be used for some reason.
20721
20722 If there is an error while appending to a file (for example, quota exceeded or
20723 partition filled), Exim attempts to reset the file's length and last
20724 modification time back to what they were before. If there is an error while
20725 creating an entirely new file, the new file is removed.
20726
20727 Before appending to a file, a number of security checks are made, and the
20728 file is locked. A detailed description is given below, after the list of
20729 private options.
20730
20731 The &(appendfile)& transport is most commonly used for local deliveries to
20732 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20733 putting messages into files for remote delivery by some means other than Exim.
20734 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20735 option).
20736
20737
20738
20739 .section "The file and directory options" "SECTfildiropt"
20740 The &%file%& option specifies a single file, to which the message is appended;
20741 the &%directory%& option specifies a directory, in which a new file containing
20742 the message is created. Only one of these two options can be set, and for
20743 normal deliveries to mailboxes, one of them &'must'& be set.
20744
20745 .vindex "&$address_file$&"
20746 .vindex "&$local_part$&"
20747 However, &(appendfile)& is also used for delivering messages to files or
20748 directories whose names (or parts of names) are obtained from alias,
20749 forwarding, or filtering operations (for example, a &%save%& command in a
20750 user's Exim filter). When such a transport is running, &$local_part$& contains
20751 the local part that was aliased or forwarded, and &$address_file$& contains the
20752 name (or partial name) of the file or directory generated by the redirection
20753 operation. There are two cases:
20754
20755 .ilist
20756 If neither &%file%& nor &%directory%& is set, the redirection operation
20757 must specify an absolute path (one that begins with &`/`&). This is the most
20758 common case when users with local accounts use filtering to sort mail into
20759 different folders. See for example, the &(address_file)& transport in the
20760 default configuration. If the path ends with a slash, it is assumed to be the
20761 name of a directory. A delivery to a directory can also be forced by setting
20762 &%maildir_format%& or &%mailstore_format%&.
20763 .next
20764 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20765 used to determine the file or directory name for the delivery. Normally, the
20766 contents of &$address_file$& are used in some way in the string expansion.
20767 .endlist
20768
20769
20770 .cindex "Sieve filter" "configuring &(appendfile)&"
20771 .cindex "Sieve filter" "relative mailbox path handling"
20772 As an example of the second case, consider an environment where users do not
20773 have home directories. They may be permitted to use Exim filter commands of the
20774 form:
20775 .code
20776 save folder23
20777 .endd
20778 or Sieve filter commands of the form:
20779 .code
20780 require "fileinto";
20781 fileinto "folder23";
20782 .endd
20783 In this situation, the expansion of &%file%& or &%directory%& in the transport
20784 must transform the relative path into an appropriate absolute file name. In the
20785 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20786 is used as a result of a &"keep"& action in the filter. This example shows one
20787 way of handling this requirement:
20788 .code
20789 file = ${if eq{$address_file}{inbox} \
20790             {/var/mail/$local_part} \
20791             {${if eq{${substr_0_1:$address_file}}{/} \
20792                   {$address_file} \
20793                   {$home/mail/$address_file} \
20794             }} \
20795        }
20796 .endd
20797 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20798 location, absolute paths are used without change, and other folders are in the
20799 &_mail_& directory within the home directory.
20800
20801 &*Note 1*&: While processing an Exim filter, a relative path such as
20802 &_folder23_& is turned into an absolute path if a home directory is known to
20803 the router. In particular, this is the case if &%check_local_user%& is set. If
20804 you want to prevent this happening at routing time, you can set
20805 &%router_home_directory%& empty. This forces the router to pass the relative
20806 path to the transport.
20807
20808 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20809 the &%file%& or &%directory%& option is still used if it is set.
20810
20811
20812
20813
20814 .section "Private options for appendfile" "SECID134"
20815 .cindex "options" "&(appendfile)& transport"
20816
20817
20818
20819 .option allow_fifo appendfile boolean false
20820 .cindex "fifo (named pipe)"
20821 .cindex "named pipe (fifo)"
20822 .cindex "pipe" "named (fifo)"
20823 Setting this option permits delivery to named pipes (FIFOs) as well as to
20824 regular files. If no process is reading the named pipe at delivery time, the
20825 delivery is deferred.
20826
20827
20828 .option allow_symlink appendfile boolean false
20829 .cindex "symbolic link" "to mailbox"
20830 .cindex "mailbox" "symbolic link"
20831 By default, &(appendfile)& will not deliver if the path name for the file is
20832 that of a symbolic link. Setting this option relaxes that constraint, but there
20833 are security issues involved in the use of symbolic links. Be sure you know
20834 what you are doing if you set this. Details of exactly what this option affects
20835 are included in the discussion which follows this list of options.
20836
20837
20838 .option batch_id appendfile string&!! unset
20839 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20840 However, batching is automatically disabled for &(appendfile)& deliveries that
20841 happen as a result of forwarding or aliasing or other redirection directly to a
20842 file.
20843
20844
20845 .option batch_max appendfile integer 1
20846 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20847
20848
20849 .option check_group appendfile boolean false
20850 When this option is set, the group owner of the file defined by the &%file%&
20851 option is checked to see that it is the same as the group under which the
20852 delivery process is running. The default setting is false because the default
20853 file mode is 0600, which means that the group is irrelevant.
20854
20855
20856 .option check_owner appendfile boolean true
20857 When this option is set, the owner of the file defined by the &%file%& option
20858 is checked to ensure that it is the same as the user under which the delivery
20859 process is running.
20860
20861
20862 .option check_string appendfile string "see below"
20863 .cindex "&""From""& line"
20864 As &(appendfile)& writes the message, the start of each line is tested for
20865 matching &%check_string%&, and if it does, the initial matching characters are
20866 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20867 a literal string, not a regular expression, and the case of any letters it
20868 contains is significant.
20869
20870 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20871 are forced to &"."& and &".."& respectively, and any settings in the
20872 configuration are ignored. Otherwise, they default to &"From&~"& and
20873 &">From&~"& when the &%file%& option is set, and unset when any of the
20874 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20875
20876 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20877 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20878 &"From&~"& indicates the start of a new message. All four options need changing
20879 if another format is used. For example, to deliver to mailboxes in MMDF format:
20880 .cindex "MMDF format mailbox"
20881 .cindex "mailbox" "MMDF format"
20882 .code
20883 check_string = "\1\1\1\1\n"
20884 escape_string = "\1\1\1\1 \n"
20885 message_prefix = "\1\1\1\1\n"
20886 message_suffix = "\1\1\1\1\n"
20887 .endd
20888 .option create_directory appendfile boolean true
20889 .cindex "directory creation"
20890 When this option is true, Exim attempts to create any missing superior
20891 directories for the file that it is about to write. A created directory's mode
20892 is given by the &%directory_mode%& option.
20893
20894 The group ownership of a newly created directory is highly dependent on the
20895 operating system (and possibly the file system) that is being used. For
20896 example, in Solaris, if the parent directory has the setgid bit set, its group
20897 is propagated to the child; if not, the currently set group is used. However,
20898 in FreeBSD, the parent's group is always used.
20899
20900
20901
20902 .option create_file appendfile string anywhere
20903 This option constrains the location of files and directories that are created
20904 by this transport. It applies to files defined by the &%file%& option and
20905 directories defined by the &%directory%& option. In the case of maildir
20906 delivery, it applies to the top level directory, not the maildir directories
20907 beneath.
20908
20909 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20910 &"belowhome"&. In the second and third cases, a home directory must have been
20911 set for the transport. This option is not useful when an explicit file name is
20912 given for normal mailbox deliveries. It is intended for the case when file
20913 names are generated from users' &_.forward_& files. These are usually handled
20914 by an &(appendfile)& transport called &%address_file%&. See also
20915 &%file_must_exist%&.
20916
20917
20918 .option directory appendfile string&!! unset
20919 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20920 or &%directory%& must be set, unless the delivery is the direct result of a
20921 redirection (see section &<<SECTfildiropt>>&).
20922
20923 When &%directory%& is set, the string is expanded, and the message is delivered
20924 into a new file or files in or below the given directory, instead of being
20925 appended to a single mailbox file. A number of different formats are provided
20926 (see &%maildir_format%& and &%mailstore_format%&), and see section
20927 &<<SECTopdir>>& for further details of this form of delivery.
20928
20929
20930 .option directory_file appendfile string&!! "see below"
20931 .cindex "base62"
20932 .vindex "&$inode$&"
20933 When &%directory%& is set, but neither &%maildir_format%& nor
20934 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20935 whose name is obtained by expanding this string. The default value is:
20936 .code
20937 q${base62:$tod_epoch}-$inode
20938 .endd
20939 This generates a unique name from the current time, in base 62 form, and the
20940 inode of the file. The variable &$inode$& is available only when expanding this
20941 option.
20942
20943
20944 .option directory_mode appendfile "octal integer" 0700
20945 If &(appendfile)& creates any directories as a result of the
20946 &%create_directory%& option, their mode is specified by this option.
20947
20948
20949 .option escape_string appendfile string "see description"
20950 See &%check_string%& above.
20951
20952
20953 .option file appendfile string&!! unset
20954 This option is mutually exclusive with the &%directory%& option, but one of
20955 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20956 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20957 specifies a single file, to which the message is appended. One or more of
20958 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20959 &%file%&.
20960
20961 .cindex "NFS" "lock file"
20962 .cindex "locking files"
20963 .cindex "lock files"
20964 If you are using more than one host to deliver over NFS into the same
20965 mailboxes, you should always use lock files.
20966
20967 The string value is expanded for each delivery, and must yield an absolute
20968 path. The most common settings of this option are variations on one of these
20969 examples:
20970 .code
20971 file = /var/spool/mail/$local_part
20972 file = /home/$local_part/inbox
20973 file = $home/inbox
20974 .endd
20975 .cindex "&""sticky""& bit"
20976 In the first example, all deliveries are done into the same directory. If Exim
20977 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20978 create a file in the directory, so the &"sticky"& bit must be turned on for
20979 deliveries to be possible, or alternatively the &%group%& option can be used to
20980 run the delivery under a group id which has write access to the directory.
20981
20982
20983
20984 .option file_format appendfile string unset
20985 .cindex "file" "mailbox; checking existing format"
20986 This option requests the transport to check the format of an existing file
20987 before adding to it. The check consists of matching a specific string at the
20988 start of the file. The value of the option consists of an even number of
20989 colon-separated strings. The first of each pair is the test string, and the
20990 second is the name of a transport. If the transport associated with a matched
20991 string is not the current transport, control is passed over to the other
20992 transport. For example, suppose the standard &(local_delivery)& transport has
20993 this added to it:
20994 .code
20995 file_format = "From       : local_delivery :\
20996                \1\1\1\1\n : local_mmdf_delivery"
20997 .endd
20998 Mailboxes that begin with &"From"& are still handled by this transport, but if
20999 a mailbox begins with four binary ones followed by a newline, control is passed
21000 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21001 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21002 is assumed to match the current transport. If the start of a mailbox doesn't
21003 match any string, or if the transport named for a given string is not defined,
21004 delivery is deferred.
21005
21006
21007 .option file_must_exist appendfile boolean false
21008 If this option is true, the file specified by the &%file%& option must exist.
21009 A temporary error occurs if it does not, causing delivery to be deferred.
21010 If this option is false, the file is created if it does not exist.
21011
21012
21013 .option lock_fcntl_timeout appendfile time 0s
21014 .cindex "timeout" "mailbox locking"
21015 .cindex "mailbox" "locking, blocking and non-blocking"
21016 .cindex "locking files"
21017 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21018 when locking an open mailbox file. If the call fails, the delivery process
21019 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21020 Non-blocking calls are used so that the file is not kept open during the wait
21021 for the lock; the reason for this is to make it as safe as possible for
21022 deliveries over NFS in the case when processes might be accessing an NFS
21023 mailbox without using a lock file. This should not be done, but
21024 misunderstandings and hence misconfigurations are not unknown.
21025
21026 On a busy system, however, the performance of a non-blocking lock approach is
21027 not as good as using a blocking lock with a timeout. In this case, the waiting
21028 is done inside the system call, and Exim's delivery process acquires the lock
21029 and can proceed as soon as the previous lock holder releases it.
21030
21031 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21032 timeout, are used. There may still be some retrying: the maximum number of
21033 retries is
21034 .code
21035 (lock_retries * lock_interval) / lock_fcntl_timeout
21036 .endd
21037 rounded up to the next whole number. In other words, the total time during
21038 which &(appendfile)& is trying to get a lock is roughly the same, unless
21039 &%lock_fcntl_timeout%& is set very large.
21040
21041 You should consider setting this option if you are getting a lot of delayed
21042 local deliveries because of errors of the form
21043 .code
21044 failed to lock mailbox /some/file (fcntl)
21045 .endd
21046
21047 .option lock_flock_timeout appendfile time 0s
21048 This timeout applies to file locking when using &[flock()]& (see
21049 &%use_flock%&); the timeout operates in a similar manner to
21050 &%lock_fcntl_timeout%&.
21051
21052
21053 .option lock_interval appendfile time 3s
21054 This specifies the time to wait between attempts to lock the file. See below
21055 for details of locking.
21056
21057
21058 .option lock_retries appendfile integer 10
21059 This specifies the maximum number of attempts to lock the file. A value of zero
21060 is treated as 1. See below for details of locking.
21061
21062
21063 .option lockfile_mode appendfile "octal integer" 0600
21064 This specifies the mode of the created lock file, when a lock file is being
21065 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21066
21067
21068 .option lockfile_timeout appendfile time 30m
21069 .cindex "timeout" "mailbox locking"
21070 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21071 exists and is older than this value, it is assumed to have been left behind by
21072 accident, and Exim attempts to remove it.
21073
21074
21075 .option mailbox_filecount appendfile string&!! unset
21076 .cindex "mailbox" "specifying size of"
21077 .cindex "size" "of mailbox"
21078 If this option is set, it is expanded, and the result is taken as the current
21079 number of files in the mailbox. It must be a decimal number, optionally
21080 followed by K or M. This provides a way of obtaining this information from an
21081 external source that maintains the data.
21082
21083
21084 .option mailbox_size appendfile string&!! unset
21085 .cindex "mailbox" "specifying size of"
21086 .cindex "size" "of mailbox"
21087 If this option is set, it is expanded, and the result is taken as the current
21088 size the mailbox. It must be a decimal number, optionally followed by K or M.
21089 This provides a way of obtaining this information from an external source that
21090 maintains the data. This is likely to be helpful for maildir deliveries where
21091 it is computationally expensive to compute the size of a mailbox.
21092
21093
21094
21095 .option maildir_format appendfile boolean false
21096 .cindex "maildir format" "specifying"
21097 If this option is set with the &%directory%& option, the delivery is into a new
21098 file, in the &"maildir"& format that is used by other mail software. When the
21099 transport is activated directly from a &(redirect)& router (for example, the
21100 &(address_file)& transport in the default configuration), setting
21101 &%maildir_format%& causes the path received from the router to be treated as a
21102 directory, whether or not it ends with &`/`&. This option is available only if
21103 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21104 &<<SECTmaildirdelivery>>& below for further details.
21105
21106
21107 .option maildir_quota_directory_regex appendfile string "See below"
21108 .cindex "maildir format" "quota; directories included in"
21109 .cindex "quota" "maildir; directories included in"
21110 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21111 a regular expression for specifying directories, relative to the quota
21112 directory (see &%quota_directory%&), that should be included in the quota
21113 calculation. The default value is:
21114 .code
21115 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21116 .endd
21117 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21118 (directories whose names begin with a dot). If you want to exclude the
21119 &_Trash_&
21120 folder from the count (as some sites do), you need to change this setting to
21121 .code
21122 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21123 .endd
21124 This uses a negative lookahead in the regular expression to exclude the
21125 directory whose name is &_.Trash_&. When a directory is excluded from quota
21126 calculations, quota processing is bypassed for any messages that are delivered
21127 directly into that directory.
21128
21129
21130 .option maildir_retries appendfile integer 10
21131 This option specifies the number of times to retry when writing a file in
21132 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21133
21134
21135 .option maildir_tag appendfile string&!! unset
21136 This option applies only to deliveries in maildir format, and is described in
21137 section &<<SECTmaildirdelivery>>& below.
21138
21139
21140 .option maildir_use_size_file appendfile&!! boolean false
21141 .cindex "maildir format" "&_maildirsize_& file"
21142 The result of string expansion for this option must be a valid boolean value.
21143 If it is true, it enables support for &_maildirsize_& files. Exim
21144 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21145 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21146 value is zero. See &%maildir_quota_directory_regex%& above and section
21147 &<<SECTmaildirdelivery>>& below for further details.
21148
21149 .option maildirfolder_create_regex appendfile string unset
21150 .cindex "maildir format" "&_maildirfolder_& file"
21151 .cindex "&_maildirfolder_&, creating"
21152 The value of this option is a regular expression. If it is unset, it has no
21153 effect. Otherwise, before a maildir delivery takes place, the pattern is
21154 matched against the name of the maildir directory, that is, the directory
21155 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21156 delivery. If there is a match, Exim checks for the existence of a file called
21157 &_maildirfolder_& in the directory, and creates it if it does not exist.
21158 See section &<<SECTmaildirdelivery>>& for more details.
21159
21160
21161 .option mailstore_format appendfile boolean false
21162 .cindex "mailstore format" "specifying"
21163 If this option is set with the &%directory%& option, the delivery is into two
21164 new files in  &"mailstore"& format. The option is available only if
21165 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21166 below for further details.
21167
21168
21169 .option mailstore_prefix appendfile string&!! unset
21170 This option applies only to deliveries in mailstore format, and is described in
21171 section &<<SECTopdir>>& below.
21172
21173
21174 .option mailstore_suffix appendfile string&!! unset
21175 This option applies only to deliveries in mailstore format, and is described in
21176 section &<<SECTopdir>>& below.
21177
21178
21179 .option mbx_format appendfile boolean false
21180 .cindex "locking files"
21181 .cindex "file" "locking"
21182 .cindex "file" "MBX format"
21183 .cindex "MBX format, specifying"
21184 This option is available only if Exim has been compiled with SUPPORT_MBX
21185 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21186 the message is appended to the mailbox file in MBX format instead of
21187 traditional Unix format. This format is supported by Pine4 and its associated
21188 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21189
21190 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21191 automatically changed by the use of &%mbx_format%&. They should normally be set
21192 empty when using MBX format, so this option almost always appears in this
21193 combination:
21194 .code
21195 mbx_format = true
21196 message_prefix =
21197 message_suffix =
21198 .endd
21199 If none of the locking options are mentioned in the configuration,
21200 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21201 is possible to specify the other kinds of locking with &%mbx_format%&, but
21202 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21203 interworks with &'c-client'&, providing for shared access to the mailbox. It
21204 should not be used if any program that does not use this form of locking is
21205 going to access the mailbox, nor should it be used if the mailbox file is NFS
21206 mounted, because it works only when the mailbox is accessed from a single host.
21207
21208 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21209 the standard version of &'c-client'&, because as long as it has a mailbox open
21210 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21211 append messages to it.
21212
21213
21214 .option message_prefix appendfile string&!! "see below"
21215 .cindex "&""From""& line"
21216 The string specified here is expanded and output at the start of every message.
21217 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21218 in which case it is:
21219 .code
21220 message_prefix = "From ${if def:return_path{$return_path}\
21221   {MAILER-DAEMON}} $tod_bsdinbox\n"
21222 .endd
21223 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21224 &`\n`& to &`\r\n`& in &%message_prefix%&.
21225
21226 .option message_suffix appendfile string&!! "see below"
21227 The string specified here is expanded and output at the end of every message.
21228 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21229 in which case it is a single newline character. The suffix can be suppressed by
21230 setting
21231 .code
21232 message_suffix =
21233 .endd
21234 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21235 &`\n`& to &`\r\n`& in &%message_suffix%&.
21236
21237 .option mode appendfile "octal integer" 0600
21238 If the output file is created, it is given this mode. If it already exists and
21239 has wider permissions, they are reduced to this mode. If it has narrower
21240 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21241 if the delivery is the result of a &%save%& command in a filter file specifying
21242 a particular mode, the mode of the output file is always forced to take that
21243 value, and this option is ignored.
21244
21245
21246 .option mode_fail_narrower appendfile boolean true
21247 This option applies in the case when an existing mailbox file has a narrower
21248 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21249 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21250 continues with the delivery attempt, using the existing mode of the file.
21251
21252
21253 .option notify_comsat appendfile boolean false
21254 If this option is true, the &'comsat'& daemon is notified after every
21255 successful delivery to a user mailbox. This is the daemon that notifies logged
21256 on users about incoming mail.
21257
21258
21259 .option quota appendfile string&!! unset
21260 .cindex "quota" "imposed by Exim"
21261 This option imposes a limit on the size of the file to which Exim is appending,
21262 or to the total space used in the directory tree when the &%directory%& option
21263 is set. In the latter case, computation of the space used is expensive, because
21264 all the files in the directory (and any sub-directories) have to be
21265 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21266 &%maildir_use_size_file%& for ways to avoid this in environments where users
21267 have no shell access to their mailboxes).
21268
21269 As there is no interlock against two simultaneous deliveries into a
21270 multi-file mailbox, it is possible for the quota to be overrun in this case.
21271 For single-file mailboxes, of course, an interlock is a necessity.
21272
21273 A file's size is taken as its &'used'& value. Because of blocking effects, this
21274 may be a lot less than the actual amount of disk space allocated to the file.
21275 If the sizes of a number of files are being added up, the rounding effect can
21276 become quite noticeable, especially on systems that have large block sizes.
21277 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21278 the obvious value which users understand most easily.
21279
21280 The value of the option is expanded, and must then be a numerical value
21281 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21282 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21283 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21284 be handled.
21285
21286 &*Note*&: A value of zero is interpreted as &"no quota"&.
21287
21288 The expansion happens while Exim is running as root, before it changes uid for
21289 the delivery. This means that files that are inaccessible to the end user can
21290 be used to hold quota values that are looked up in the expansion. When delivery
21291 fails because this quota is exceeded, the handling of the error is as for
21292 system quota failures.
21293
21294 By default, Exim's quota checking mimics system quotas, and restricts the
21295 mailbox to the specified maximum size, though the value is not accurate to the
21296 last byte, owing to separator lines and additional headers that may get added
21297 during message delivery. When a mailbox is nearly full, large messages may get
21298 refused even though small ones are accepted, because the size of the current
21299 message is added to the quota when the check is made. This behaviour can be
21300 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21301 for exceeding the quota does not include the current message. Thus, deliveries
21302 continue until the quota has been exceeded; thereafter, no further messages are
21303 delivered. See also &%quota_warn_threshold%&.
21304
21305
21306 .option quota_directory appendfile string&!! unset
21307 This option defines the directory to check for quota purposes when delivering
21308 into individual files. The default is the delivery directory, or, if a file
21309 called &_maildirfolder_& exists in a maildir directory, the parent of the
21310 delivery directory.
21311
21312
21313 .option quota_filecount appendfile string&!! 0
21314 This option applies when the &%directory%& option is set. It limits the total
21315 number of files in the directory (compare the inode limit in system quotas). It
21316 can only be used if &%quota%& is also set. The value is expanded; an expansion
21317 failure causes delivery to be deferred. A value of zero is interpreted as
21318 &"no quota"&.
21319
21320
21321 .option quota_is_inclusive appendfile boolean true
21322 See &%quota%& above.
21323
21324
21325 .option quota_size_regex appendfile string unset
21326 This option applies when one of the delivery modes that writes a separate file
21327 for each message is being used. When Exim wants to find the size of one of
21328 these files in order to test the quota, it first checks &%quota_size_regex%&.
21329 If this is set to a regular expression that matches the file name, and it
21330 captures one string, that string is interpreted as a representation of the
21331 file's size. The value of &%quota_size_regex%& is not expanded.
21332
21333 This feature is useful only when users have no shell access to their mailboxes
21334 &-- otherwise they could defeat the quota simply by renaming the files. This
21335 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21336 the file length to the file name. For example:
21337 .code
21338 maildir_tag = ,S=$message_size
21339 quota_size_regex = ,S=(\d+)
21340 .endd
21341 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21342 number of lines in the message.
21343
21344 The regular expression should not assume that the length is at the end of the
21345 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21346 sometimes add other information onto the ends of message file names.
21347
21348 Section &<<SECID136>>& contains further information.
21349
21350
21351 .option quota_warn_message appendfile string&!! "see below"
21352 See below for the use of this option. If it is not set when
21353 &%quota_warn_threshold%& is set, it defaults to
21354 .code
21355 quota_warn_message = "\
21356   To: $local_part@$domain\n\
21357   Subject: Your mailbox\n\n\
21358   This message is automatically created \
21359   by mail delivery software.\n\n\
21360   The size of your mailbox has exceeded \
21361   a warning threshold that is\n\
21362   set by the system administrator.\n"
21363 .endd
21364
21365
21366 .option quota_warn_threshold appendfile string&!! 0
21367 .cindex "quota" "warning threshold"
21368 .cindex "mailbox" "size warning"
21369 .cindex "size" "of mailbox"
21370 This option is expanded in the same way as &%quota%& (see above). If the
21371 resulting value is greater than zero, and delivery of the message causes the
21372 size of the file or total space in the directory tree to cross the given
21373 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21374 may be specified as a percentage of it by following the value with a percent
21375 sign. For example:
21376 .code
21377 quota = 10M
21378 quota_warn_threshold = 75%
21379 .endd
21380 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21381 percent sign is ignored.
21382
21383 The warning message itself is specified by the &%quota_warn_message%& option,
21384 and it must start with a &'To:'& header line containing the recipient(s) of the
21385 warning message. These do not necessarily have to include the recipient(s) of
21386 the original message. A &'Subject:'& line should also normally be supplied. You
21387 can include any other header lines that you want. If you do not include a
21388 &'From:'& line, the default is:
21389 .code
21390 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21391 .endd
21392 .oindex &%errors_reply_to%&
21393 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21394 option.
21395
21396 The &%quota%& option does not have to be set in order to use this option; they
21397 are independent of one another except when the threshold is specified as a
21398 percentage.
21399
21400
21401 .option use_bsmtp appendfile boolean false
21402 .cindex "envelope sender"
21403 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21404 format, with the envelope sender and recipient(s) included as SMTP commands. If
21405 you want to include a leading HELO command with such messages, you can do
21406 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21407 for details of batch SMTP.
21408
21409
21410 .option use_crlf appendfile boolean false
21411 .cindex "carriage return"
21412 .cindex "linefeed"
21413 This option causes lines to be terminated with the two-character CRLF sequence
21414 (carriage return, linefeed) instead of just a linefeed character. In the case
21415 of batched SMTP, the byte sequence written to the file is then an exact image
21416 of what would be sent down a real SMTP connection.
21417
21418 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21419 (which are used to supply the traditional &"From&~"& and blank line separators
21420 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21421 carriage return characters if these are needed. In cases where these options
21422 have non-empty defaults, the values end with a single linefeed, so they must be
21423 changed to end with &`\r\n`& if &%use_crlf%& is set.
21424
21425
21426 .option use_fcntl_lock appendfile boolean "see below"
21427 This option controls the use of the &[fcntl()]& function to lock a file for
21428 exclusive use when a message is being appended. It is set by default unless
21429 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21430 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21431 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21432
21433
21434 .option use_flock_lock appendfile boolean false
21435 This option is provided to support the use of &[flock()]& for file locking, for
21436 the few situations where it is needed. Most modern operating systems support
21437 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21438 each other. Exim uses &[fcntl()]& locking by default.
21439
21440 This option is required only if you are using an operating system where
21441 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21442 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21443 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21444
21445 .cindex "Solaris" "&[flock()]& support"
21446 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21447 have it (and some, I think, provide a not quite right version built on top of
21448 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21449 the ability to use it, and any attempt to do so will cause a configuration
21450 error.
21451
21452 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21453 is just being mapped onto &[fcntl()]& by the OS).
21454
21455
21456 .option use_lockfile appendfile boolean "see below"
21457 If this option is turned off, Exim does not attempt to create a lock file when
21458 appending to a mailbox file. In this situation, the only locking is by
21459 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21460 sure that every MUA that is ever going to look at your users' mailboxes uses
21461 &[fcntl()]& rather than a lock file, and even then only when you are not
21462 delivering over NFS from more than one host.
21463
21464 .cindex "NFS" "lock file"
21465 In order to append to an NFS file safely from more than one host, it is
21466 necessary to take out a lock &'before'& opening the file, and the lock file
21467 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21468 file corruption.
21469
21470 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21471 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21472 except when &%mbx_format%& is set.
21473
21474
21475 .option use_mbx_lock appendfile boolean "see below"
21476 This option is available only if Exim has been compiled with SUPPORT_MBX
21477 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21478 locking rules be used. It is set by default if &%mbx_format%& is set and none
21479 of the locking options are mentioned in the configuration. The locking rules
21480 are the same as are used by the &'c-client'& library that underlies Pine and
21481 the IMAP4 and POP daemons that come with it (see the discussion below). The
21482 rules allow for shared access to the mailbox. However, this kind of locking
21483 does not work when the mailbox is NFS mounted.
21484
21485 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21486 &%use_flock_lock%& to control what kind of locking is used in implementing the
21487 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21488 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21489
21490
21491
21492
21493 .section "Operational details for appending" "SECTopappend"
21494 .cindex "appending to a file"
21495 .cindex "file" "appending"
21496 Before appending to a file, the following preparations are made:
21497
21498 .ilist
21499 If the name of the file is &_/dev/null_&, no action is taken, and a success
21500 return is given.
21501
21502 .next
21503 .cindex "directory creation"
21504 If any directories on the file's path are missing, Exim creates them if the
21505 &%create_directory%& option is set. A created directory's mode is given by the
21506 &%directory_mode%& option.
21507
21508 .next
21509 If &%file_format%& is set, the format of an existing file is checked. If this
21510 indicates that a different transport should be used, control is passed to that
21511 transport.
21512
21513 .next
21514 .cindex "file" "locking"
21515 .cindex "locking files"
21516 .cindex "NFS" "lock file"
21517 If &%use_lockfile%& is set, a lock file is built in a way that will work
21518 reliably over NFS, as follows:
21519
21520 .olist
21521 Create a &"hitching post"& file whose name is that of the lock file with the
21522 current time, primary host name, and process id added, by opening for writing
21523 as a new file. If this fails with an access error, delivery is deferred.
21524 .next
21525 Close the hitching post file, and hard link it to the lock file name.
21526 .next
21527 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21528 Unlink the hitching post name.
21529 .next
21530 Otherwise, use &[stat()]& to get information about the hitching post file, and
21531 then unlink hitching post name. If the number of links is exactly two, creation
21532 of the lock file succeeded but something (for example, an NFS server crash and
21533 restart) caused this fact not to be communicated to the &[link()]& call.
21534 .next
21535 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21536 up to &%lock_retries%& times. However, since any program that writes to a
21537 mailbox should complete its task very quickly, it is reasonable to time out old
21538 lock files that are normally the result of user agent and system crashes. If an
21539 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21540 it before trying again.
21541 .endlist olist
21542
21543 .next
21544 A call is made to &[lstat()]& to discover whether the main file exists, and if
21545 so, what its characteristics are. If &[lstat()]& fails for any reason other
21546 than non-existence, delivery is deferred.
21547
21548 .next
21549 .cindex "symbolic link" "to mailbox"
21550 .cindex "mailbox" "symbolic link"
21551 If the file does exist and is a symbolic link, delivery is deferred, unless the
21552 &%allow_symlink%& option is set, in which case the ownership of the link is
21553 checked, and then &[stat()]& is called to find out about the real file, which
21554 is then subjected to the checks below. The check on the top-level link
21555 ownership prevents one user creating a link for another's mailbox in a sticky
21556 directory, though allowing symbolic links in this case is definitely not a good
21557 idea. If there is a chain of symbolic links, the intermediate ones are not
21558 checked.
21559
21560 .next
21561 If the file already exists but is not a regular file, or if the file's owner
21562 and group (if the group is being checked &-- see &%check_group%& above) are
21563 different from the user and group under which the delivery is running,
21564 delivery is deferred.
21565
21566 .next
21567 If the file's permissions are more generous than specified, they are reduced.
21568 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21569 is set false, in which case the delivery is tried using the existing
21570 permissions.
21571
21572 .next
21573 The file's inode number is saved, and the file is then opened for appending.
21574 If this fails because the file has vanished, &(appendfile)& behaves as if it
21575 hadn't existed (see below). For any other failures, delivery is deferred.
21576
21577 .next
21578 If the file is opened successfully, check that the inode number hasn't
21579 changed, that it is still a regular file, and that the owner and permissions
21580 have not changed. If anything is wrong, defer delivery and freeze the message.
21581
21582 .next
21583 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21584 option is set. Otherwise, check that the file is being created in a permitted
21585 directory if the &%create_file%& option is set (deferring on failure), and then
21586 open for writing as a new file, with the O_EXCL and O_CREAT options,
21587 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21588 set). In this case, which can happen if the link points to a non-existent file,
21589 the file is opened for writing using O_CREAT but not O_EXCL, because
21590 that prevents link following.
21591
21592 .next
21593 .cindex "loop" "while file testing"
21594 If opening fails because the file exists, obey the tests given above for
21595 existing files. However, to avoid looping in a situation where the file is
21596 being continuously created and destroyed, the exists/not-exists loop is broken
21597 after 10 repetitions, and the message is then frozen.
21598
21599 .next
21600 If opening fails with any other error, defer delivery.
21601
21602 .next
21603 .cindex "file" "locking"
21604 .cindex "locking files"
21605 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21606 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21607 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21608 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21609 file, and an exclusive lock on the file whose name is
21610 .code
21611 /tmp/.<device-number>.<inode-number>
21612 .endd
21613 using the device and inode numbers of the open mailbox file, in accordance with
21614 the MBX locking rules. This file is created with a mode that is specified by
21615 the &%lockfile_mode%& option.
21616
21617 If Exim fails to lock the file, there are two possible courses of action,
21618 depending on the value of the locking timeout. This is obtained from
21619 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21620
21621 If the timeout value is zero, the file is closed, Exim waits for
21622 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21623 to lock it again. This happens up to &%lock_retries%& times, after which the
21624 delivery is deferred.
21625
21626 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21627 &[flock()]& are used (with the given timeout), so there has already been some
21628 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21629 immediately. It retries up to
21630 .code
21631 (lock_retries * lock_interval) / <timeout>
21632 .endd
21633 times (rounded up).
21634 .endlist
21635
21636 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21637 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21638
21639
21640 .section "Operational details for delivery to a new file" "SECTopdir"
21641 .cindex "delivery" "to single file"
21642 .cindex "&""From""& line"
21643 When the &%directory%& option is set instead of &%file%&, each message is
21644 delivered into a newly-created file or set of files. When &(appendfile)& is
21645 activated directly from a &(redirect)& router, neither &%file%& nor
21646 &%directory%& is normally set, because the path for delivery is supplied by the
21647 router. (See for example, the &(address_file)& transport in the default
21648 configuration.) In this case, delivery is to a new file if either the path name
21649 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21650
21651 No locking is required while writing the message to a new file, so the various
21652 locking options of the transport are ignored. The &"From"& line that by default
21653 separates messages in a single file is not normally needed, nor is the escaping
21654 of message lines that start with &"From"&, and there is no need to ensure a
21655 newline at the end of each message. Consequently, the default values for
21656 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21657 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21658
21659 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21660 the files in the delivery directory by default. However, you can specify a
21661 different directory by setting &%quota_directory%&. Also, for maildir
21662 deliveries (see below) the &_maildirfolder_& convention is honoured.
21663
21664
21665 .cindex "maildir format"
21666 .cindex "mailstore format"
21667 There are three different ways in which delivery to individual files can be
21668 done, controlled by the settings of the &%maildir_format%& and
21669 &%mailstore_format%& options. Note that code to support maildir or mailstore
21670 formats is not included in the binary unless SUPPORT_MAILDIR or
21671 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21672
21673 .cindex "directory creation"
21674 In all three cases an attempt is made to create the directory and any necessary
21675 sub-directories if they do not exist, provided that the &%create_directory%&
21676 option is set (the default). The location of a created directory can be
21677 constrained by setting &%create_file%&. A created directory's mode is given by
21678 the &%directory_mode%& option. If creation fails, or if the
21679 &%create_directory%& option is not set when creation is required, delivery is
21680 deferred.
21681
21682
21683
21684 .section "Maildir delivery" "SECTmaildirdelivery"
21685 .cindex "maildir format" "description of"
21686 If the &%maildir_format%& option is true, Exim delivers each message by writing
21687 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21688 directory that is defined by the &%directory%& option (the &"delivery
21689 directory"&). If the delivery is successful, the file is renamed into the
21690 &_new_& subdirectory.
21691
21692 In the file name, <&'stime'&> is the current time of day in seconds, and
21693 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21694 Exim checks that the time-of-day clock has moved on by at least one microsecond
21695 before terminating the delivery process. This guarantees uniqueness for the
21696 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21697 opening it. If any response other than ENOENT (does not exist) is given,
21698 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21699
21700 Before Exim carries out a maildir delivery, it ensures that subdirectories
21701 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21702 do not exist, Exim tries to create them and any superior directories in their
21703 path, subject to the &%create_directory%& and &%create_file%& options. If the
21704 &%maildirfolder_create_regex%& option is set, and the regular expression it
21705 contains matches the delivery directory, Exim also ensures that a file called
21706 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21707 &_maildirfolder_& file cannot be created, delivery is deferred.
21708
21709 These features make it possible to use Exim to create all the necessary files
21710 and directories in a maildir mailbox, including subdirectories for maildir++
21711 folders. Consider this example:
21712 .code
21713 maildir_format = true
21714 directory = /var/mail/$local_part\
21715            ${if eq{$local_part_suffix}{}{}\
21716            {/.${substr_1:$local_part_suffix}}}
21717 maildirfolder_create_regex = /\.[^/]+$
21718 .endd
21719 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21720 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21721 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21722 not match this name, so Exim will not look for or create the file
21723 &_/var/mail/pimbo/maildirfolder_&, though it will create
21724 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21725
21726 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21727 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21728 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21729 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21730 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21731
21732 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21733 not inadvertently match the toplevel maildir directory, because a
21734 &_maildirfolder_& file at top level would completely break quota calculations.
21735
21736 .cindex "quota" "in maildir delivery"
21737 .cindex "maildir++"
21738 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21739 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21740 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21741 Exim assumes the directory is a maildir++ folder directory, which is one level
21742 down from the user's top level mailbox directory. This causes it to start at
21743 the parent directory instead of the current directory when calculating the
21744 amount of space used.
21745
21746 One problem with delivering into a multi-file mailbox is that it is
21747 computationally expensive to compute the size of the mailbox for quota
21748 checking. Various approaches have been taken to reduce the amount of work
21749 needed. The next two sections describe two of them. A third alternative is to
21750 use some external process for maintaining the size data, and use the expansion
21751 of the &%mailbox_size%& option as a way of importing it into Exim.
21752
21753
21754
21755
21756 .section "Using tags to record message sizes" "SECID135"
21757 If &%maildir_tag%& is set, the string is expanded for each delivery.
21758 When the maildir file is renamed into the &_new_& sub-directory, the
21759 tag is added to its name. However, if adding the tag takes the length of the
21760 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21761 the tag is dropped and the maildir file is created with no tag.
21762
21763
21764 .vindex "&$message_size$&"
21765 Tags can be used to encode the size of files in their names; see
21766 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21767 happens after the message has been written. The value of the &$message_size$&
21768 variable is set to the number of bytes actually written. If the expansion is
21769 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21770 be deferred. The expanded tag may contain any printing characters except &"/"&.
21771 Non-printing characters in the string are ignored; if the resulting string is
21772 empty, it is ignored. If it starts with an alphanumeric character, a leading
21773 colon is inserted; this default has not proven to be the path that popular
21774 maildir implementations have chosen (but changing it in Exim would break
21775 backwards compatibility).
21776
21777 For one common implementation, you might set:
21778 .code
21779 maildir_tag = ,S=${message_size}
21780 .endd
21781 but you should check the documentation of the other software to be sure.
21782
21783 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21784 as this allows Exim to extract the size from your tag, instead of having to
21785 &[stat()]& each message file.
21786
21787
21788 .section "Using a maildirsize file" "SECID136"
21789 .cindex "quota" "in maildir delivery"
21790 .cindex "maildir format" "&_maildirsize_& file"
21791 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21792 storing quota and message size information in a file called &_maildirsize_&
21793 within the toplevel maildir directory. If this file does not exist, Exim
21794 creates it, setting the quota from the &%quota%& option of the transport. If
21795 the maildir directory itself does not exist, it is created before any attempt
21796 to write a &_maildirsize_& file.
21797
21798 The &_maildirsize_& file is used to hold information about the sizes of
21799 messages in the maildir, thus speeding up quota calculations. The quota value
21800 in the file is just a cache; if the quota is changed in the transport, the new
21801 value overrides the cached value when the next message is delivered. The cache
21802 is maintained for the benefit of other programs that access the maildir and
21803 need to know the quota.
21804
21805 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21806 file is maintained (with a zero quota setting), but no quota is imposed.
21807
21808 A regular expression is available for controlling which directories in the
21809 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21810 See the description of the &%maildir_quota_directory_regex%& option above for
21811 details.
21812
21813
21814 .section "Mailstore delivery" "SECID137"
21815 .cindex "mailstore format" "description of"
21816 If the &%mailstore_format%& option is true, each message is written as two
21817 files in the given directory. A unique base name is constructed from the
21818 message id and the current delivery process, and the files that are written use
21819 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21820 contains the message's envelope, and the &_.msg_& file contains the message
21821 itself. The base name is placed in the variable &$mailstore_basename$&.
21822
21823 During delivery, the envelope is first written to a file with the suffix
21824 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21825 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21826 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21827 file before accessing either of them. An alternative approach is to wait for
21828 the absence of a &_.tmp_& file.
21829
21830 The envelope file starts with any text defined by the &%mailstore_prefix%&
21831 option, expanded and terminated by a newline if there isn't one. Then follows
21832 the sender address on one line, then all the recipient addresses, one per line.
21833 There can be more than one recipient only if the &%batch_max%& option is set
21834 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21835 appended to the file, followed by a newline if it does not end with one.
21836
21837 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21838 failure, it is ignored. Other expansion errors are treated as serious
21839 configuration errors, and delivery is deferred. The variable
21840 &$mailstore_basename$& is available for use during these expansions.
21841
21842
21843 .section "Non-special new file delivery" "SECID138"
21844 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21845 file is created directly in the named directory. For example, when delivering
21846 messages into files in batched SMTP format for later delivery to some host (see
21847 section &<<SECTbatchSMTP>>&), a setting such as
21848 .code
21849 directory = /var/bsmtp/$host
21850 .endd
21851 might be used. A message is written to a file with a temporary name, which is
21852 then renamed when the delivery is complete. The final name is obtained by
21853 expanding the contents of the &%directory_file%& option.
21854 .ecindex IIDapptra1
21855 .ecindex IIDapptra2
21856
21857
21858
21859
21860
21861
21862 . ////////////////////////////////////////////////////////////////////////////
21863 . ////////////////////////////////////////////////////////////////////////////
21864
21865 .chapter "The autoreply transport" "CHID8"
21866 .scindex IIDauttra1 "transports" "&(autoreply)&"
21867 .scindex IIDauttra2 "&(autoreply)& transport"
21868 The &(autoreply)& transport is not a true transport in that it does not cause
21869 the message to be transmitted. Instead, it generates a new mail message as an
21870 automatic reply to the incoming message. &'References:'& and
21871 &'Auto-Submitted:'& header lines are included. These are constructed according
21872 to the rules in RFCs 2822 and 3834, respectively.
21873
21874 If the router that passes the message to this transport does not have the
21875 &%unseen%& option set, the original message (for the current recipient) is not
21876 delivered anywhere. However, when the &%unseen%& option is set on the router
21877 that passes the message to this transport, routing of the address continues, so
21878 another router can set up a normal message delivery.
21879
21880
21881 The &(autoreply)& transport is usually run as the result of mail filtering, a
21882 &"vacation"& message being the standard example. However, it can also be run
21883 directly from a router like any other transport. To reduce the possibility of
21884 message cascades, messages created by the &(autoreply)& transport always have
21885 empty envelope sender addresses, like bounce messages.
21886
21887 The parameters of the message to be sent can be specified in the configuration
21888 by options described below. However, these are used only when the address
21889 passed to the transport does not contain its own reply information. When the
21890 transport is run as a consequence of a
21891 &%mail%&
21892 or &%vacation%& command in a filter file, the parameters of the message are
21893 supplied by the filter, and passed with the address. The transport's options
21894 that define the message are then ignored (so they are not usually set in this
21895 case). The message is specified entirely by the filter or by the transport; it
21896 is never built from a mixture of options. However, the &%file_optional%&,
21897 &%mode%&, and &%return_message%& options apply in all cases.
21898
21899 &(Autoreply)& is implemented as a local transport. When used as a result of a
21900 command in a user's filter file, &(autoreply)& normally runs under the uid and
21901 gid of the user, and with appropriate current and home directories (see chapter
21902 &<<CHAPenvironment>>&).
21903
21904 There is a subtle difference between routing a message to a &(pipe)& transport
21905 that generates some text to be returned to the sender, and routing it to an
21906 &(autoreply)& transport. This difference is noticeable only if more than one
21907 address from the same message is so handled. In the case of a pipe, the
21908 separate outputs from the different addresses are gathered up and returned to
21909 the sender in a single message, whereas if &(autoreply)& is used, a separate
21910 message is generated for each address that is passed to it.
21911
21912 Non-printing characters are not permitted in the header lines generated for the
21913 message that &(autoreply)& creates, with the exception of newlines that are
21914 immediately followed by white space. If any non-printing characters are found,
21915 the transport defers.
21916 Whether characters with the top bit set count as printing characters or not is
21917 controlled by the &%print_topbitchars%& global option.
21918
21919 If any of the generic options for manipulating headers (for example,
21920 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21921 of the original message that is included in the generated message when
21922 &%return_message%& is set. They do not apply to the generated message itself.
21923
21924 .vindex "&$sender_address$&"
21925 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21926 the message, indicating that there were no recipients, it does not treat this
21927 as an error. This means that autoreplies sent to &$sender_address$& when this
21928 is empty (because the incoming message is a bounce message) do not cause
21929 problems. They are just discarded.
21930
21931
21932
21933 .section "Private options for autoreply" "SECID139"
21934 .cindex "options" "&(autoreply)& transport"
21935
21936 .option bcc autoreply string&!! unset
21937 This specifies the addresses that are to receive &"blind carbon copies"& of the
21938 message when the message is specified by the transport.
21939
21940
21941 .option cc autoreply string&!! unset
21942 This specifies recipients of the message and the contents of the &'Cc:'& header
21943 when the message is specified by the transport.
21944
21945
21946 .option file autoreply string&!! unset
21947 The contents of the file are sent as the body of the message when the message
21948 is specified by the transport. If both &%file%& and &%text%& are set, the text
21949 string comes first.
21950
21951
21952 .option file_expand autoreply boolean false
21953 If this is set, the contents of the file named by the &%file%& option are
21954 subjected to string expansion as they are added to the message.
21955
21956
21957 .option file_optional autoreply boolean false
21958 If this option is true, no error is generated if the file named by the &%file%&
21959 option or passed with the address does not exist or cannot be read.
21960
21961
21962 .option from autoreply string&!! unset
21963 This specifies the contents of the &'From:'& header when the message is
21964 specified by the transport.
21965
21966
21967 .option headers autoreply string&!! unset
21968 This specifies additional RFC 2822 headers that are to be added to the message
21969 when the message is specified by the transport. Several can be given by using
21970 &"\n"& to separate them. There is no check on the format.
21971
21972
21973 .option log autoreply string&!! unset
21974 This option names a file in which a record of every message sent is logged when
21975 the message is specified by the transport.
21976
21977
21978 .option mode autoreply "octal integer" 0600
21979 If either the log file or the &"once"& file has to be created, this mode is
21980 used.
21981
21982
21983 .option never_mail autoreply "address list&!!" unset
21984 If any run of the transport creates a message with a recipient that matches any
21985 item in the list, that recipient is quietly discarded. If all recipients are
21986 discarded, no message is created. This applies both when the recipients are
21987 generated by a filter and when they are specified in the transport.
21988
21989
21990
21991 .option once autoreply string&!! unset
21992 This option names a file or DBM database in which a record of each &'To:'&
21993 recipient is kept when the message is specified by the transport. &*Note*&:
21994 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21995
21996 If &%once%& is unset, or is set to an empty string, the message is always sent.
21997 By default, if &%once%& is set to a non-empty file name, the message
21998 is not sent if a potential recipient is already listed in the database.
21999 However, if the &%once_repeat%& option specifies a time greater than zero, the
22000 message is sent if that much time has elapsed since a message was last sent to
22001 this recipient. A setting of zero time for &%once_repeat%& (the default)
22002 prevents a message from being sent a second time &-- in this case, zero means
22003 infinity.
22004
22005 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22006 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22007 greater than zero, it changes the way Exim implements the &%once%& option.
22008 Instead of using a DBM file to record every recipient it sends to, it uses a
22009 regular file, whose size will never get larger than the given value.
22010
22011 In the file, Exim keeps a linear list of recipient addresses and the times at
22012 which they were sent messages. If the file is full when a new address needs to
22013 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22014 means that a given recipient may receive multiple messages, but at
22015 unpredictable intervals that depend on the rate of turnover of addresses in the
22016 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22017
22018
22019 .option once_file_size autoreply integer 0
22020 See &%once%& above.
22021
22022
22023 .option once_repeat autoreply time&!! 0s
22024 See &%once%& above.
22025 After expansion, the value of this option must be a valid time value.
22026
22027
22028 .option reply_to autoreply string&!! unset
22029 This specifies the contents of the &'Reply-To:'& header when the message is
22030 specified by the transport.
22031
22032
22033 .option return_message autoreply boolean false
22034 If this is set, a copy of the original message is returned with the new
22035 message, subject to the maximum size set in the &%return_size_limit%& global
22036 configuration option.
22037
22038
22039 .option subject autoreply string&!! unset
22040 This specifies the contents of the &'Subject:'& header when the message is
22041 specified by the transport. It is tempting to quote the original subject in
22042 automatic responses. For example:
22043 .code
22044 subject = Re: $h_subject:
22045 .endd
22046 There is a danger in doing this, however. It may allow a third party to
22047 subscribe your users to an opt-in mailing list, provided that the list accepts
22048 bounce messages as subscription confirmations. Well-managed lists require a
22049 non-bounce message to confirm a subscription, so the danger is relatively
22050 small.
22051
22052
22053
22054 .option text autoreply string&!! unset
22055 This specifies a single string to be used as the body of the message when the
22056 message is specified by the transport. If both &%text%& and &%file%& are set,
22057 the text comes first.
22058
22059
22060 .option to autoreply string&!! unset
22061 This specifies recipients of the message and the contents of the &'To:'& header
22062 when the message is specified by the transport.
22063 .ecindex IIDauttra1
22064 .ecindex IIDauttra2
22065
22066
22067
22068
22069 . ////////////////////////////////////////////////////////////////////////////
22070 . ////////////////////////////////////////////////////////////////////////////
22071
22072 .chapter "The lmtp transport" "CHAPLMTP"
22073 .cindex "transports" "&(lmtp)&"
22074 .cindex "&(lmtp)& transport"
22075 .cindex "LMTP" "over a pipe"
22076 .cindex "LMTP" "over a socket"
22077 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22078 specified command
22079 or by interacting with a Unix domain socket.
22080 This transport is something of a cross between the &(pipe)& and &(smtp)&
22081 transports. Exim also has support for using LMTP over TCP/IP; this is
22082 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22083 to be of minority interest, the default build-time configure in &_src/EDITME_&
22084 has it commented out. You need to ensure that
22085 .code
22086 TRANSPORT_LMTP=yes
22087 .endd
22088 .cindex "options" "&(lmtp)& transport"
22089 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22090 included in the Exim binary. The private options of the &(lmtp)& transport are
22091 as follows:
22092
22093 .option batch_id lmtp string&!! unset
22094 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22095
22096
22097 .option batch_max lmtp integer 1
22098 This limits the number of addresses that can be handled in a single delivery.
22099 Most LMTP servers can handle several addresses at once, so it is normally a
22100 good idea to increase this value. See the description of local delivery
22101 batching in chapter &<<CHAPbatching>>&.
22102
22103
22104 .option command lmtp string&!! unset
22105 This option must be set if &%socket%& is not set. The string is a command which
22106 is run in a separate process. It is split up into a command name and list of
22107 arguments, each of which is separately expanded (so expansion cannot change the
22108 number of arguments). The command is run directly, not via a shell. The message
22109 is passed to the new process using the standard input and output to operate the
22110 LMTP protocol.
22111
22112 .option ignore_quota lmtp boolean false
22113 .cindex "LMTP" "ignoring quota errors"
22114 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22115 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22116 in its response to the LHLO command.
22117
22118 .option socket lmtp string&!! unset
22119 This option must be set if &%command%& is not set. The result of expansion must
22120 be the name of a Unix domain socket. The transport connects to the socket and
22121 delivers the message to it using the LMTP protocol.
22122
22123
22124 .option timeout lmtp time 5m
22125 The transport is aborted if the created process or Unix domain socket does not
22126 respond to LMTP commands or message input within this timeout. Delivery
22127 is deferred, and will be tried again later. Here is an example of a typical
22128 LMTP transport:
22129 .code
22130 lmtp:
22131   driver = lmtp
22132   command = /some/local/lmtp/delivery/program
22133   batch_max = 20
22134   user = exim
22135 .endd
22136 This delivers up to 20 addresses at a time, in a mixture of domains if
22137 necessary, running as the user &'exim'&.
22138
22139
22140
22141 . ////////////////////////////////////////////////////////////////////////////
22142 . ////////////////////////////////////////////////////////////////////////////
22143
22144 .chapter "The pipe transport" "CHAPpipetransport"
22145 .scindex IIDpiptra1 "transports" "&(pipe)&"
22146 .scindex IIDpiptra2 "&(pipe)& transport"
22147 The &(pipe)& transport is used to deliver messages via a pipe to a command
22148 running in another process. One example is the use of &(pipe)& as a
22149 pseudo-remote transport for passing messages to some other delivery mechanism
22150 (such as UUCP). Another is the use by individual users to automatically process
22151 their incoming messages. The &(pipe)& transport can be used in one of the
22152 following ways:
22153
22154 .ilist
22155 .vindex "&$local_part$&"
22156 A router routes one address to a transport in the normal way, and the
22157 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22158 contains the local part of the address (as usual), and the command that is run
22159 is specified by the &%command%& option on the transport.
22160 .next
22161 .vindex "&$pipe_addresses$&"
22162 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22163 transport can handle more than one address in a single run. In this case, when
22164 more than one address is routed to the transport, &$local_part$& is not set
22165 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22166 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22167 that are routed to the transport.
22168 .next
22169 .vindex "&$address_pipe$&"
22170 A router redirects an address directly to a pipe command (for example, from an
22171 alias or forward file). In this case, &$address_pipe$& contains the text of the
22172 pipe command, and the &%command%& option on the transport is ignored unless
22173 &%force_command%& is set. If only one address is being transported
22174 (&%batch_max%& is not greater than one, or only one address was redirected to
22175 this pipe command), &$local_part$& contains the local part that was redirected.
22176 .endlist
22177
22178
22179 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22180 deliver messages over pipes using the LMTP interactive protocol. This is
22181 implemented by the &(lmtp)& transport.
22182
22183 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22184 &_.forward_& file, the command runs under the uid and gid of that user. In
22185 other cases, the uid and gid have to be specified explicitly, either on the
22186 transport or on the router that handles the address. Current and &"home"&
22187 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22188 details of the local delivery environment and chapter &<<CHAPbatching>>&
22189 for a discussion of local delivery batching.
22190
22191
22192 .section "Concurrent delivery" "SECID140"
22193 If two messages arrive at almost the same time, and both are routed to a pipe
22194 delivery, the two pipe transports may be run concurrently. You must ensure that
22195 any pipe commands you set up are robust against this happening. If the commands
22196 write to a file, the &%exim_lock%& utility might be of use.
22197
22198
22199
22200
22201 .section "Returned status and data" "SECID141"
22202 .cindex "&(pipe)& transport" "returned data"
22203 If the command exits with a non-zero return code, the delivery is deemed to
22204 have failed, unless either the &%ignore_status%& option is set (in which case
22205 the return code is treated as zero), or the return code is one of those listed
22206 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22207 later"&. In this case, delivery is deferred. Details of a permanent failure are
22208 logged, but are not included in the bounce message, which merely contains
22209 &"local delivery failed"&.
22210
22211 If the command exits on a signal and the &%freeze_signal%& option is set then
22212 the message will be frozen in the queue. If that option is not set, a bounce
22213 will be sent as normal.
22214
22215 If the return code is greater than 128 and the command being run is a shell
22216 script, it normally means that the script was terminated by a signal whose
22217 value is the return code minus 128. The &%freeze_signal%& option does not
22218 apply in this case.
22219
22220 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22221 return code is set to 127. This is the value that a shell returns if it is
22222 asked to run a non-existent command. The wording for the log line suggests that
22223 a non-existent command may be the problem.
22224
22225 The &%return_output%& option can affect the result of a pipe delivery. If it is
22226 set and the command produces any output on its standard output or standard
22227 error streams, the command is considered to have failed, even if it gave a zero
22228 return code or if &%ignore_status%& is set. The output from the command is
22229 included as part of the bounce message. The &%return_fail_output%& option is
22230 similar, except that output is returned only when the command exits with a
22231 failure return code, that is, a value other than zero or a code that matches
22232 &%temp_errors%&.
22233
22234
22235
22236 .section "How the command is run" "SECThowcommandrun"
22237 .cindex "&(pipe)& transport" "path for command"
22238 The command line is (by default) broken down into a command name and arguments
22239 by the &(pipe)& transport itself. The &%allow_commands%& and
22240 &%restrict_to_path%& options can be used to restrict the commands that may be
22241 run.
22242
22243 .cindex "quoting" "in pipe command"
22244 Unquoted arguments are delimited by white space. If an argument appears in
22245 double quotes, backslash is interpreted as an escape character in the usual
22246 way. If an argument appears in single quotes, no escaping is done.
22247
22248 String expansion is applied to the command line except when it comes from a
22249 traditional &_.forward_& file (commands from a filter file are expanded). The
22250 expansion is applied to each argument in turn rather than to the whole line.
22251 For this reason, any string expansion item that contains white space must be
22252 quoted so as to be contained within a single argument. A setting such as
22253 .code
22254 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22255 .endd
22256 will not work, because the expansion item gets split between several
22257 arguments. You have to write
22258 .code
22259 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22260 .endd
22261 to ensure that it is all in one argument. The expansion is done in this way,
22262 argument by argument, so that the number of arguments cannot be changed as a
22263 result of expansion, and quotes or backslashes in inserted variables do not
22264 interact with external quoting. However, this leads to problems if you want to
22265 generate multiple arguments (or the command name plus arguments) from a single
22266 expansion. In this situation, the simplest solution is to use a shell. For
22267 example:
22268 .code
22269 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22270 .endd
22271
22272 .cindex "transport" "filter"
22273 .cindex "filter" "transport filter"
22274 .vindex "&$pipe_addresses$&"
22275 Special handling takes place when an argument consists of precisely the text
22276 &`$pipe_addresses`&. This is not a general expansion variable; the only
22277 place this string is recognized is when it appears as an argument for a pipe or
22278 transport filter command. It causes each address that is being handled to be
22279 inserted in the argument list at that point &'as a separate argument'&. This
22280 avoids any problems with spaces or shell metacharacters, and is of use when a
22281 &(pipe)& transport is handling groups of addresses in a batch.
22282
22283 If &%force_command%& is enabled on the transport, Special handling takes place
22284 for an argument that consists of precisely the text &`$address_pipe`&.  It
22285 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22286 argument is inserted in the argument list at that point
22287 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22288 the only item in the argument; in fact, if it were then &%force_command%&
22289 should behave as a no-op.  Rather, it should be used to adjust the command
22290 run while preserving the argument vector separation.
22291
22292 After splitting up into arguments and expansion, the resulting command is run
22293 in a subprocess directly from the transport, &'not'& under a shell. The
22294 message that is being delivered is supplied on the standard input, and the
22295 standard output and standard error are both connected to a single pipe that is
22296 read by Exim. The &%max_output%& option controls how much output the command
22297 may produce, and the &%return_output%& and &%return_fail_output%& options
22298 control what is done with it.
22299
22300 Not running the command under a shell (by default) lessens the security risks
22301 in cases when a command from a user's filter file is built out of data that was
22302 taken from an incoming message. If a shell is required, it can of course be
22303 explicitly specified as the command to be run. However, there are circumstances
22304 where existing commands (for example, in &_.forward_& files) expect to be run
22305 under a shell and cannot easily be modified. To allow for these cases, there is
22306 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22307 works. Instead of breaking up the command line as just described, it expands it
22308 as a single string and passes the result to &_/bin/sh_&. The
22309 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22310 with &%use_shell%&, and the whole mechanism is inherently less secure.
22311
22312
22313
22314 .section "Environment variables" "SECTpipeenv"
22315 .cindex "&(pipe)& transport" "environment for command"
22316 .cindex "environment for pipe transport"
22317 The environment variables listed below are set up when the command is invoked.
22318 This list is a compromise for maximum compatibility with other MTAs. Note that
22319 the &%environment%& option can be used to add additional variables to this
22320 environment.
22321 .display
22322 &`DOMAIN            `&   the domain of the address
22323 &`HOME              `&   the home directory, if set
22324 &`HOST              `&   the host name when called from a router (see below)
22325 &`LOCAL_PART        `&   see below
22326 &`LOCAL_PART_PREFIX `&   see below
22327 &`LOCAL_PART_SUFFIX `&   see below
22328 &`LOGNAME           `&   see below
22329 &`MESSAGE_ID        `&   Exim's local ID for the message
22330 &`PATH              `&   as specified by the &%path%& option below
22331 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22332 &`RECIPIENT         `&   the complete recipient address
22333 &`SENDER            `&   the sender of the message (empty if a bounce)
22334 &`SHELL             `&   &`/bin/sh`&
22335 &`TZ                `&   the value of the &%timezone%& option, if set
22336 &`USER              `&   see below
22337 .endd
22338 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22339 router, LOCAL_PART is set to the local part of the address. When it is
22340 called as a result of a forward or alias expansion, LOCAL_PART is set to
22341 the local part of the address that was expanded. In both cases, any affixes are
22342 removed from the local part, and made available in LOCAL_PART_PREFIX and
22343 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22344 same value as LOCAL_PART for compatibility with other MTAs.
22345
22346 .cindex "HOST"
22347 HOST is set only when a &(pipe)& transport is called from a router that
22348 associates hosts with an address, typically when using &(pipe)& as a
22349 pseudo-remote transport. HOST is set to the first host name specified by
22350 the router.
22351
22352 .cindex "HOME"
22353 If the transport's generic &%home_directory%& option is set, its value is used
22354 for the HOME environment variable. Otherwise, a home directory may be set
22355 by the router's &%transport_home_directory%& option, which defaults to the
22356 user's home directory if &%check_local_user%& is set.
22357
22358
22359 .section "Private options for pipe" "SECID142"
22360 .cindex "options" "&(pipe)& transport"
22361
22362
22363
22364 .option allow_commands pipe "string list&!!" unset
22365 .cindex "&(pipe)& transport" "permitted commands"
22366 The string is expanded, and is then interpreted as a colon-separated list of
22367 permitted commands. If &%restrict_to_path%& is not set, the only commands
22368 permitted are those in the &%allow_commands%& list. They need not be absolute
22369 paths; the &%path%& option is still used for relative paths. If
22370 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22371 in the &%allow_commands%& list, or a name without any slashes that is found on
22372 the path. In other words, if neither &%allow_commands%& nor
22373 &%restrict_to_path%& is set, there is no restriction on the command, but
22374 otherwise only commands that are permitted by one or the other are allowed. For
22375 example, if
22376 .code
22377 allow_commands = /usr/bin/vacation
22378 .endd
22379 and &%restrict_to_path%& is not set, the only permitted command is
22380 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22381 &%use_shell%& is set.
22382
22383
22384 .option batch_id pipe string&!! unset
22385 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22386
22387
22388 .option batch_max pipe integer 1
22389 This limits the number of addresses that can be handled in a single delivery.
22390 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22391
22392
22393 .option check_string pipe string unset
22394 As &(pipe)& writes the message, the start of each line is tested for matching
22395 &%check_string%&, and if it does, the initial matching characters are replaced
22396 by the contents of &%escape_string%&, provided both are set. The value of
22397 &%check_string%& is a literal string, not a regular expression, and the case of
22398 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22399 of &%check_string%& and &%escape_string%& are forced to values that implement
22400 the SMTP escaping protocol. Any settings made in the configuration file are
22401 ignored.
22402
22403
22404 .option command pipe string&!! unset
22405 This option need not be set when &(pipe)& is being used to deliver to pipes
22406 obtained directly from address redirections. In other cases, the option must be
22407 set, to provide a command to be run. It need not yield an absolute path (see
22408 the &%path%& option below). The command is split up into separate arguments by
22409 Exim, and each argument is separately expanded, as described in section
22410 &<<SECThowcommandrun>>& above.
22411
22412
22413 .option environment pipe string&!! unset
22414 .cindex "&(pipe)& transport" "environment for command"
22415 .cindex "environment for &(pipe)& transport"
22416 This option is used to add additional variables to the environment in which the
22417 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22418 a string which is expanded, and then interpreted as a colon-separated list of
22419 environment settings of the form <&'name'&>=<&'value'&>.
22420
22421
22422 .option escape_string pipe string unset
22423 See &%check_string%& above.
22424
22425
22426 .option freeze_exec_fail pipe boolean false
22427 .cindex "exec failure"
22428 .cindex "failure of exec"
22429 .cindex "&(pipe)& transport" "failure of exec"
22430 Failure to exec the command in a pipe transport is by default treated like
22431 any other failure while running the command. However, if &%freeze_exec_fail%&
22432 is set, failure to exec is treated specially, and causes the message to be
22433 frozen, whatever the setting of &%ignore_status%&.
22434
22435
22436 .option freeze_signal pipe boolean false
22437 .cindex "signal exit"
22438 .cindex "&(pipe)& transport", "signal exit"
22439 Normally if the process run by a command in a pipe transport exits on a signal,
22440 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22441 frozen in Exim's queue instead.
22442
22443
22444 .option force_command pipe boolean false
22445 .cindex "force command"
22446 .cindex "&(pipe)& transport", "force command"
22447 Normally when a router redirects an address directly to a pipe command
22448 the &%command%& option on the transport is ignored.  If &%force_command%&
22449 is set, the &%command%& option will used. This is especially
22450 useful for forcing a wrapper or additional argument to be added to the
22451 command. For example:
22452 .code
22453 command = /usr/bin/remote_exec myhost -- $address_pipe
22454 force_command
22455 .endd
22456
22457 Note that &$address_pipe$& is handled specially in &%command%& when
22458 &%force_command%& is set, expanding out to the original argument vector as
22459 separate items, similarly to a Unix shell &`"$@"`& construct.
22460
22461 .option ignore_status pipe boolean false
22462 If this option is true, the status returned by the subprocess that is set up to
22463 run the command is ignored, and Exim behaves as if zero had been returned.
22464 Otherwise, a non-zero status or termination by signal causes an error return
22465 from the transport unless the status value is one of those listed in
22466 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22467
22468 &*Note*&: This option does not apply to timeouts, which do not return a status.
22469 See the &%timeout_defer%& option for how timeouts are handled.
22470
22471 .option log_defer_output pipe boolean false
22472 .cindex "&(pipe)& transport" "logging output"
22473 If this option is set, and the status returned by the command is
22474 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22475 and any output was produced, the first line of it is written to the main log.
22476
22477
22478 .option log_fail_output pipe boolean false
22479 If this option is set, and the command returns any output, and also ends with a
22480 return code that is neither zero nor one of the return codes listed in
22481 &%temp_errors%& (that is, the delivery failed), the first line of output is
22482 written to the main log. This option and &%log_output%& are mutually exclusive.
22483 Only one of them may be set.
22484
22485
22486
22487 .option log_output pipe boolean false
22488 If this option is set and the command returns any output, the first line of
22489 output is written to the main log, whatever the return code. This option and
22490 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22491
22492
22493
22494 .option max_output pipe integer 20K
22495 This specifies the maximum amount of output that the command may produce on its
22496 standard output and standard error file combined. If the limit is exceeded, the
22497 process running the command is killed. This is intended as a safety measure to
22498 catch runaway processes. The limit is applied independently of the settings of
22499 the options that control what is done with such output (for example,
22500 &%return_output%&). Because of buffering effects, the amount of output may
22501 exceed the limit by a small amount before Exim notices.
22502
22503
22504 .option message_prefix pipe string&!! "see below"
22505 The string specified here is expanded and output at the start of every message.
22506 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22507 .code
22508 message_prefix = \
22509   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22510   ${tod_bsdinbox}\n
22511 .endd
22512 .cindex "Cyrus"
22513 .cindex "&%tmail%&"
22514 .cindex "&""From""& line"
22515 This is required by the commonly used &_/usr/bin/vacation_& program.
22516 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22517 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22518 setting
22519 .code
22520 message_prefix =
22521 .endd
22522 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22523 &`\n`& to &`\r\n`& in &%message_prefix%&.
22524
22525
22526 .option message_suffix pipe string&!! "see below"
22527 The string specified here is expanded and output at the end of every message.
22528 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22529 The suffix can be suppressed by setting
22530 .code
22531 message_suffix =
22532 .endd
22533 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22534 &`\n`& to &`\r\n`& in &%message_suffix%&.
22535
22536
22537 .option path pipe string "see below"
22538 This option specifies the string that is set up in the PATH environment
22539 variable of the subprocess. The default is:
22540 .code
22541 /bin:/usr/bin
22542 .endd
22543 If the &%command%& option does not yield an absolute path name, the command is
22544 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22545 apply to a command specified as a transport filter.
22546
22547
22548 .option permit_coredump pipe boolean false
22549 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22550 a core-dump of a pipe command, enable this command.  This enables core-dumps
22551 during delivery and affects both the Exim binary and the pipe command run.
22552 It is recommended that this option remain off unless and until you have a need
22553 for it and that this only be enabled when needed, as the risk of excessive
22554 resource consumption can be quite high.  Note also that Exim is typically
22555 installed as a setuid binary and most operating systems will inhibit coredumps
22556 of these by default, so further OS-specific action may be required.
22557
22558
22559 .option pipe_as_creator pipe boolean false
22560 .cindex "uid (user id)" "local delivery"
22561 If the generic &%user%& option is not set and this option is true, the delivery
22562 process is run under the uid that was in force when Exim was originally called
22563 to accept the message. If the group id is not otherwise set (via the generic
22564 &%group%& option), the gid that was in force when Exim was originally called to
22565 accept the message is used.
22566
22567
22568 .option restrict_to_path pipe boolean false
22569 When this option is set, any command name not listed in &%allow_commands%& must
22570 contain no slashes. The command is searched for only in the directories listed
22571 in the &%path%& option. This option is intended for use in the case when a pipe
22572 command has been generated from a user's &_.forward_& file. This is usually
22573 handled by a &(pipe)& transport called &%address_pipe%&.
22574
22575
22576 .option return_fail_output pipe boolean false
22577 If this option is true, and the command produced any output and ended with a
22578 return code other than zero or one of the codes listed in &%temp_errors%& (that
22579 is, the delivery failed), the output is returned in the bounce message.
22580 However, if the message has a null sender (that is, it is itself a bounce
22581 message), output from the command is discarded. This option and
22582 &%return_output%& are mutually exclusive. Only one of them may be set.
22583
22584
22585
22586 .option return_output pipe boolean false
22587 If this option is true, and the command produced any output, the delivery is
22588 deemed to have failed whatever the return code from the command, and the output
22589 is returned in the bounce message. Otherwise, the output is just discarded.
22590 However, if the message has a null sender (that is, it is a bounce message),
22591 output from the command is always discarded, whatever the setting of this
22592 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22593 of them may be set.
22594
22595
22596
22597 .option temp_errors pipe "string list" "see below"
22598 .cindex "&(pipe)& transport" "temporary failure"
22599 This option contains either a colon-separated list of numbers, or a single
22600 asterisk. If &%ignore_status%& is false
22601 and &%return_output%& is not set,
22602 and the command exits with a non-zero return code, the failure is treated as
22603 temporary and the delivery is deferred if the return code matches one of the
22604 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22605 codes are treated as permanent errors. The default setting contains the codes
22606 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22607 compiled on a system that does not define these macros, it assumes values of 75
22608 and 73, respectively.
22609
22610
22611 .option timeout pipe time 1h
22612 If the command fails to complete within this time, it is killed. This normally
22613 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22614 specifies no timeout. In order to ensure that any subprocesses created by the
22615 command are also killed, Exim makes the initial process a process group leader,
22616 and kills the whole process group on a timeout. However, this can be defeated
22617 if one of the processes starts a new process group.
22618
22619 .option timeout_defer pipe boolean false
22620 A timeout in a &(pipe)& transport, either in the command that the transport
22621 runs, or in a transport filter that is associated with it, is by default
22622 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22623 is set true, both kinds of timeout become temporary errors, causing the
22624 delivery to be deferred.
22625
22626 .option umask pipe "octal integer" 022
22627 This specifies the umask setting for the subprocess that runs the command.
22628
22629
22630 .option use_bsmtp pipe boolean false
22631 .cindex "envelope sender"
22632 If this option is set true, the &(pipe)& transport writes messages in &"batch
22633 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22634 commands. If you want to include a leading HELO command with such messages,
22635 you can do so by setting the &%message_prefix%& option. See section
22636 &<<SECTbatchSMTP>>& for details of batch SMTP.
22637
22638 .option use_classresources pipe boolean false
22639 .cindex "class resources (BSD)"
22640 This option is available only when Exim is running on FreeBSD, NetBSD, or
22641 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22642 resource limits when a &(pipe)& transport is run to perform a delivery. The
22643 limits for the uid under which the pipe is to run are obtained from the login
22644 class database.
22645
22646
22647 .option use_crlf pipe boolean false
22648 .cindex "carriage return"
22649 .cindex "linefeed"
22650 This option causes lines to be terminated with the two-character CRLF sequence
22651 (carriage return, linefeed) instead of just a linefeed character. In the case
22652 of batched SMTP, the byte sequence written to the pipe is then an exact image
22653 of what would be sent down a real SMTP connection.
22654
22655 The contents of the &%message_prefix%& and &%message_suffix%& options are
22656 written verbatim, so must contain their own carriage return characters if these
22657 are needed. When &%use_bsmtp%& is not set, the default values for both
22658 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22659 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22660
22661
22662 .option use_shell pipe boolean false
22663 .vindex "&$pipe_addresses$&"
22664 If this option is set, it causes the command to be passed to &_/bin/sh_&
22665 instead of being run directly from the transport, as described in section
22666 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22667 where the command is expected to be run under a shell and cannot easily be
22668 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22669 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22670 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22671 its &%-c%& option.
22672
22673
22674
22675 .section "Using an external local delivery agent" "SECID143"
22676 .cindex "local delivery" "using an external agent"
22677 .cindex "&'procmail'&"
22678 .cindex "external local delivery"
22679 .cindex "delivery" "&'procmail'&"
22680 .cindex "delivery" "by external agent"
22681 The &(pipe)& transport can be used to pass all messages that require local
22682 delivery to a separate local delivery agent such as &%procmail%&. When doing
22683 this, care must be taken to ensure that the pipe is run under an appropriate
22684 uid and gid. In some configurations one wants this to be a uid that is trusted
22685 by the delivery agent to supply the correct sender of the message. It may be
22686 necessary to recompile or reconfigure the delivery agent so that it trusts an
22687 appropriate user. The following is an example transport and router
22688 configuration for &%procmail%&:
22689 .code
22690 # transport
22691 procmail_pipe:
22692   driver = pipe
22693   command = /usr/local/bin/procmail -d $local_part
22694   return_path_add
22695   delivery_date_add
22696   envelope_to_add
22697   check_string = "From "
22698   escape_string = ">From "
22699   umask = 077
22700   user = $local_part
22701   group = mail
22702
22703 # router
22704 procmail:
22705   driver = accept
22706   check_local_user
22707   transport = procmail_pipe
22708 .endd
22709 In this example, the pipe is run as the local user, but with the group set to
22710 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22711 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22712 user to supply a correct sender address. If you do not specify either a
22713 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22714 home directory is the user's home directory by default.
22715
22716 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22717 .code
22718 IFS=" "
22719 .endd
22720 as shown in some &%procmail%& documentation, because Exim does not by default
22721 use a shell to run pipe commands.
22722
22723 .cindex "Cyrus"
22724 The next example shows a transport and a router for a system where local
22725 deliveries are handled by the Cyrus IMAP server.
22726 .code
22727 # transport
22728 local_delivery_cyrus:
22729   driver = pipe
22730   command = /usr/cyrus/bin/deliver \
22731             -m ${substr_1:$local_part_suffix} -- $local_part
22732   user = cyrus
22733   group = mail
22734   return_output
22735   log_output
22736   message_prefix =
22737   message_suffix =
22738
22739 # router
22740 local_user_cyrus:
22741   driver = accept
22742   check_local_user
22743   local_part_suffix = .*
22744   transport = local_delivery_cyrus
22745 .endd
22746 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22747 &%return_output%& to cause any text written by Cyrus to be returned to the
22748 sender.
22749 .ecindex IIDpiptra1
22750 .ecindex IIDpiptra2
22751
22752
22753 . ////////////////////////////////////////////////////////////////////////////
22754 . ////////////////////////////////////////////////////////////////////////////
22755
22756 .chapter "The smtp transport" "CHAPsmtptrans"
22757 .scindex IIDsmttra1 "transports" "&(smtp)&"
22758 .scindex IIDsmttra2 "&(smtp)& transport"
22759 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22760 or LMTP protocol. The list of hosts to try can either be taken from the address
22761 that is being processed (having been set up by the router), or specified
22762 explicitly for the transport. Timeout and retry processing (see chapter
22763 &<<CHAPretry>>&) is applied to each IP address independently.
22764
22765
22766 .section "Multiple messages on a single connection" "SECID144"
22767 The sending of multiple messages over a single TCP/IP connection can arise in
22768 two ways:
22769
22770 .ilist
22771 If a message contains more than &%max_rcpt%& (see below) addresses that are
22772 routed to the same host, more than one copy of the message has to be sent to
22773 that host. In this situation, multiple copies may be sent in a single run of
22774 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22775 does when it has too many addresses to send in one message also depends on the
22776 value of the global &%remote_max_parallel%& option. Details are given in
22777 section &<<SECToutSMTPTCP>>&.)
22778 .next
22779 .cindex "hints database" "remembering routing"
22780 When a message has been successfully delivered over a TCP/IP connection, Exim
22781 looks in its hints database to see if there are any other messages awaiting a
22782 connection to the same host. If there are, a new delivery process is started
22783 for one of them, and the current TCP/IP connection is passed on to it. The new
22784 process may in turn send multiple copies and possibly create yet another
22785 process.
22786 .endlist
22787
22788
22789 For each copy sent over the same TCP/IP connection, a sequence counter is
22790 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22791 no further messages are sent over that connection.
22792
22793
22794
22795 .section "Use of the $host and $host_address variables" "SECID145"
22796 .vindex "&$host$&"
22797 .vindex "&$host_address$&"
22798 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22799 &$host_address$& are the name and IP address of the first host on the host list
22800 passed by the router. However, when the transport is about to connect to a
22801 specific host, and while it is connected to that host, &$host$& and
22802 &$host_address$& are set to the values for that host. These are the values
22803 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22804 &%serialize_hosts%&, and the various TLS options are expanded.
22805
22806
22807 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22808 .vindex &$tls_bits$&
22809 .vindex &$tls_cipher$&
22810 .vindex &$tls_peerdn$&
22811 .vindex &$tls_sni$&
22812 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22813 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22814 are the values that were set when the message was received.
22815 These are the values that are used for options that are expanded before any
22816 SMTP connections are made. Just before each connection is made, these four
22817 variables are emptied. If TLS is subsequently started, they are set to the
22818 appropriate values for the outgoing connection, and these are the values that
22819 are in force when any authenticators are run and when the
22820 &%authenticated_sender%& option is expanded.
22821
22822 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22823 and will be removed in a future release.
22824
22825
22826 .section "Private options for smtp" "SECID146"
22827 .cindex "options" "&(smtp)& transport"
22828 The private options of the &(smtp)& transport are as follows:
22829
22830
22831 .option address_retry_include_sender smtp boolean true
22832 .cindex "4&'xx'& responses" "retrying after"
22833 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22834 is the combination of sender and recipient that is delayed in subsequent queue
22835 runs until the retry time is reached. You can delay the recipient without
22836 reference to the sender (which is what earlier versions of Exim did), by
22837 setting &%address_retry_include_sender%& false. However, this can lead to
22838 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22839
22840 .option allow_localhost smtp boolean false
22841 .cindex "local host" "sending to"
22842 .cindex "fallback" "hosts specified on transport"
22843 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22844 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22845 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22846 the delivery anyway. This should be used only in special cases when the
22847 configuration ensures that no looping will result (for example, a differently
22848 configured Exim is listening on the port to which the message is sent).
22849
22850
22851 .option authenticated_sender smtp string&!! unset
22852 .cindex "Cyrus"
22853 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22854 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22855 overriding any existing authenticated sender value. If the string expansion is
22856 forced to fail, the option is ignored. Other expansion failures cause delivery
22857 to be deferred. If the result of expansion is an empty string, that is also
22858 ignored.
22859
22860 The expansion happens after the outgoing connection has been made and TLS
22861 started, if required. This means that the &$host$&, &$host_address$&,
22862 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22863 particular connection.
22864
22865 If the SMTP session is not authenticated, the expansion of
22866 &%authenticated_sender%& still happens (and can cause the delivery to be
22867 deferred if it fails), but no AUTH= item is added to MAIL commands
22868 unless &%authenticated_sender_force%& is true.
22869
22870 This option allows you to use the &(smtp)& transport in LMTP mode to
22871 deliver mail to Cyrus IMAP and provide the proper local part as the
22872 &"authenticated sender"&, via a setting such as:
22873 .code
22874 authenticated_sender = $local_part
22875 .endd
22876 This removes the need for IMAP subfolders to be assigned special ACLs to
22877 allow direct delivery to those subfolders.
22878
22879 Because of expected uses such as that just described for Cyrus (when no
22880 domain is involved), there is no checking on the syntax of the provided
22881 value.
22882
22883
22884 .option authenticated_sender_force smtp boolean false
22885 If this option is set true, the &%authenticated_sender%& option's value
22886 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22887 authenticated as a client.
22888
22889
22890 .option command_timeout smtp time 5m
22891 This sets a timeout for receiving a response to an SMTP command that has been
22892 sent out. It is also used when waiting for the initial banner line from the
22893 remote host. Its value must not be zero.
22894
22895
22896 .option connect_timeout smtp time 5m
22897 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22898 to a remote host. A setting of zero allows the system timeout (typically
22899 several minutes) to act. To have any effect, the value of this option must be
22900 less than the system timeout. However, it has been observed that on some
22901 systems there is no system timeout, which is why the default value for this
22902 option is 5 minutes, a value recommended by RFC 1123.
22903
22904
22905 .option connection_max_messages smtp integer 500
22906 .cindex "SMTP" "passed connection"
22907 .cindex "SMTP" "multiple deliveries"
22908 .cindex "multiple SMTP deliveries"
22909 This controls the maximum number of separate message deliveries that are sent
22910 over a single TCP/IP connection. If the value is zero, there is no limit.
22911 For testing purposes, this value can be overridden by the &%-oB%& command line
22912 option.
22913
22914
22915 .option data_timeout smtp time 5m
22916 This sets a timeout for the transmission of each block in the data portion of
22917 the message. As a result, the overall timeout for a message depends on the size
22918 of the message. Its value must not be zero. See also &%final_timeout%&.
22919
22920
22921 .option delay_after_cutoff smtp boolean true
22922 This option controls what happens when all remote IP addresses for a given
22923 domain have been inaccessible for so long that they have passed their retry
22924 cutoff times.
22925
22926 In the default state, if the next retry time has not been reached for any of
22927 them, the address is bounced without trying any deliveries. In other words,
22928 Exim delays retrying an IP address after the final cutoff time until a new
22929 retry time is reached, and can therefore bounce an address without ever trying
22930 a delivery, when machines have been down for a long time. Some people are
22931 unhappy at this prospect, so...
22932
22933 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22934 addresses are past their final cutoff time, Exim tries to deliver to those
22935 IP addresses that have not been tried since the message arrived. If there are
22936 none, of if they all fail, the address is bounced. In other words, it does not
22937 delay when a new message arrives, but immediately tries those expired IP
22938 addresses that haven't been tried since the message arrived. If there is a
22939 continuous stream of messages for the dead hosts, unsetting
22940 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22941 to them.
22942
22943
22944 .option dns_qualify_single smtp boolean true
22945 If the &%hosts%& or &%fallback_hosts%& option is being used,
22946 and the &%gethostbyname%& option is false,
22947 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22948 in chapter &<<CHAPdnslookup>>& for more details.
22949
22950
22951 .option dns_search_parents smtp boolean false
22952 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22953 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22954 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22955 details.
22956
22957
22958 .option dnssec_request_domains smtp "domain list&!!" unset
22959 .cindex "MX record" "security"
22960 .cindex "DNSSEC" "MX lookup"
22961 .cindex "security" "MX lookup"
22962 .cindex "DNS" "DNSSEC"
22963 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22964 the dnssec request bit set.
22965 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22966
22967
22968
22969 .option dnssec_require_domains smtp "domain list&!!" unset
22970 .cindex "MX record" "security"
22971 .cindex "DNSSEC" "MX lookup"
22972 .cindex "security" "MX lookup"
22973 .cindex "DNS" "DNSSEC"
22974 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22975 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22976 (AD bit) set wil be ignored and logged as a host-lookup failure.
22977 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22978
22979
22980
22981 .option dscp smtp string&!! unset
22982 .cindex "DCSP" "outbound"
22983 This option causes the DSCP value associated with a socket to be set to one
22984 of a number of fixed strings or to numeric value.
22985 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22986 Common values include &`throughput`&, &`mincost`&, and on newer systems
22987 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22988
22989 The outbound packets from Exim will be marked with this value in the header
22990 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22991 that these values will have any effect, not be stripped by networking
22992 equipment, or do much of anything without cooperation with your Network
22993 Engineer and those of all network operators between the source and destination.
22994
22995
22996 .option fallback_hosts smtp "string list" unset
22997 .cindex "fallback" "hosts specified on transport"
22998 String expansion is not applied to this option. The argument must be a
22999 colon-separated list of host names or IP addresses, optionally also including
23000 port numbers, though the separator can be changed, as described in section
23001 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23002 item in a &%route_list%& setting for the &(manualroute)& router, as described
23003 in section &<<SECTformatonehostitem>>&.
23004
23005 Fallback hosts can also be specified on routers, which associate them with the
23006 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23007 &%fallback_hosts%& specified on the transport is used only if the address does
23008 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23009 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23010 However, &%hosts_randomize%& does apply to fallback host lists.
23011
23012 If Exim is unable to deliver to any of the hosts for a particular address, and
23013 the errors are not permanent rejections, the address is put on a separate
23014 transport queue with its host list replaced by the fallback hosts, unless the
23015 address was routed via MX records and the current host was in the original MX
23016 list. In that situation, the fallback host list is not used.
23017
23018 Once normal deliveries are complete, the fallback queue is delivered by
23019 re-running the same transports with the new host lists. If several failing
23020 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23021 copy of the message is sent.
23022
23023 The resolution of the host names on the fallback list is controlled by the
23024 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23025 both to cases when the host list comes with the address and when it is taken
23026 from &%hosts%&. This option provides a &"use a smart host only if delivery
23027 fails"& facility.
23028
23029
23030 .option final_timeout smtp time 10m
23031 This is the timeout that applies while waiting for the response to the final
23032 line containing just &"."& that terminates a message. Its value must not be
23033 zero.
23034
23035 .option gethostbyname smtp boolean false
23036 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23037 being used, names are looked up using &[gethostbyname()]&
23038 (or &[getipnodebyname()]& when available)
23039 instead of using the DNS. Of course, that function may in fact use the DNS, but
23040 it may also consult other sources of information such as &_/etc/hosts_&.
23041
23042 .option gnutls_compat_mode smtp boolean unset
23043 This option controls whether GnuTLS is used in compatibility mode in an Exim
23044 server. This reduces security slightly, but improves interworking with older
23045 implementations of TLS.
23046
23047 .option helo_data smtp string&!! "see below"
23048 .cindex "HELO" "argument, setting"
23049 .cindex "EHLO" "argument, setting"
23050 .cindex "LHLO argument setting"
23051 The value of this option is expanded after a connection to a another host has
23052 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23053 command that starts the outgoing SMTP or LMTP session. The default value of the
23054 option is:
23055 .code
23056 $primary_hostname
23057 .endd
23058 During the expansion, the variables &$host$& and &$host_address$& are set to
23059 the identity of the remote host, and the variables &$sending_ip_address$& and
23060 &$sending_port$& are set to the local IP address and port number that are being
23061 used. These variables can be used to generate different values for different
23062 servers or different local IP addresses. For example, if you want the string
23063 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23064 interface address, you could use this:
23065 .code
23066 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23067   {$primary_hostname}}
23068 .endd
23069 The use of &%helo_data%& applies both to sending messages and when doing
23070 callouts.
23071
23072 .option hosts smtp "string list&!!" unset
23073 Hosts are associated with an address by a router such as &(dnslookup)&, which
23074 finds the hosts by looking up the address domain in the DNS, or by
23075 &(manualroute)&, which has lists of hosts in its configuration. However,
23076 email addresses can be passed to the &(smtp)& transport by any router, and not
23077 all of them can provide an associated list of hosts.
23078
23079 The &%hosts%& option specifies a list of hosts to be used if the address being
23080 processed does not have any hosts associated with it. The hosts specified by
23081 &%hosts%& are also used, whether or not the address has its own hosts, if
23082 &%hosts_override%& is set.
23083
23084 The string is first expanded, before being interpreted as a colon-separated
23085 list of host names or IP addresses, possibly including port numbers. The
23086 separator may be changed to something other than colon, as described in section
23087 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23088 item in a &%route_list%& setting for the &(manualroute)& router, as described
23089 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23090 of the &(manualroute)& router is not available here.
23091
23092 If the expansion fails, delivery is deferred. Unless the failure was caused by
23093 the inability to complete a lookup, the error is logged to the panic log as
23094 well as the main log. Host names are looked up either by searching directly for
23095 address records in the DNS or by calling &[gethostbyname()]& (or
23096 &[getipnodebyname()]& when available), depending on the setting of the
23097 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23098 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23099 address are used.
23100
23101 During delivery, the hosts are tried in order, subject to their retry status,
23102 unless &%hosts_randomize%& is set.
23103
23104
23105 .option hosts_avoid_esmtp smtp "host list&!!" unset
23106 .cindex "ESMTP, avoiding use of"
23107 .cindex "HELO" "forcing use of"
23108 .cindex "EHLO" "avoiding use of"
23109 .cindex "PIPELINING" "avoiding the use of"
23110 This option is for use with broken hosts that announce ESMTP facilities (for
23111 example, PIPELINING) and then fail to implement them properly. When a host
23112 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23113 start of the SMTP session. This means that it cannot use any of the ESMTP
23114 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23115
23116
23117 .option hosts_avoid_pipelining smtp "host list&!!" unset
23118 .cindex "PIPELINING" "avoiding the use of"
23119 Exim will not use the SMTP PIPELINING extension when delivering to any host
23120 that matches this list, even if the server host advertises PIPELINING support.
23121
23122
23123 .option hosts_avoid_tls smtp "host list&!!" unset
23124 .cindex "TLS" "avoiding for certain hosts"
23125 Exim will not try to start a TLS session when delivering to any host that
23126 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23127
23128 .option hosts_verify_avoid_tls smtp "host list&!!" *
23129 .cindex "TLS" "avoiding for certain hosts"
23130 Exim will not try to start a TLS session for a verify callout,
23131 or when delivering in cutthrough mode,
23132 to any host that matches this list.
23133 Note that the default is to not use TLS.
23134
23135
23136 .option hosts_max_try smtp integer 5
23137 .cindex "host" "maximum number to try"
23138 .cindex "limit" "number of hosts tried"
23139 .cindex "limit" "number of MX tried"
23140 .cindex "MX record" "maximum tried"
23141 This option limits the number of IP addresses that are tried for any one
23142 delivery in cases where there are temporary delivery errors. Section
23143 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23144
23145
23146 .option hosts_max_try_hardlimit smtp integer 50
23147 This is an additional check on the maximum number of IP addresses that Exim
23148 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23149 why it exists.
23150
23151
23152
23153 .option hosts_nopass_tls smtp "host list&!!" unset
23154 .cindex "TLS" "passing connection"
23155 .cindex "multiple SMTP deliveries"
23156 .cindex "TLS" "multiple message deliveries"
23157 For any host that matches this list, a connection on which a TLS session has
23158 been started will not be passed to a new delivery process for sending another
23159 message on the same connection. See section &<<SECTmulmessam>>& for an
23160 explanation of when this might be needed.
23161
23162
23163 .option hosts_override smtp boolean false
23164 If this option is set and the &%hosts%& option is also set, any hosts that are
23165 attached to the address are ignored, and instead the hosts specified by the
23166 &%hosts%& option are always used. This option does not apply to
23167 &%fallback_hosts%&.
23168
23169
23170 .option hosts_randomize smtp boolean false
23171 .cindex "randomized host list"
23172 .cindex "host" "list of; randomized"
23173 .cindex "fallback" "randomized hosts"
23174 If this option is set, and either the list of hosts is taken from the
23175 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23176 were not obtained from MX records (this includes fallback hosts from the
23177 router), and were not randomized by the router, the order of trying the hosts
23178 is randomized each time the transport runs. Randomizing the order of a host
23179 list can be used to do crude load sharing.
23180
23181 When &%hosts_randomize%& is true, a host list may be split into groups whose
23182 order is separately randomized. This makes it possible to set up MX-like
23183 behaviour. The boundaries between groups are indicated by an item that is just
23184 &`+`& in the host list. For example:
23185 .code
23186 hosts = host1:host2:host3:+:host4:host5
23187 .endd
23188 The order of the first three hosts and the order of the last two hosts is
23189 randomized for each use, but the first three always end up before the last two.
23190 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23191
23192 .option hosts_require_auth smtp "host list&!!" unset
23193 .cindex "authentication" "required by client"
23194 This option provides a list of servers for which authentication must succeed
23195 before Exim will try to transfer a message. If authentication fails for
23196 servers which are not in this list, Exim tries to send unauthenticated. If
23197 authentication fails for one of these servers, delivery is deferred. This
23198 temporary error is detectable in the retry rules, so it can be turned into a
23199 hard failure if required. See also &%hosts_try_auth%&, and chapter
23200 &<<CHAPSMTPAUTH>>& for details of authentication.
23201
23202
23203 .option hosts_request_ocsp smtp "host list&!!" *
23204 .cindex "TLS" "requiring for certain servers"
23205 Exim will request a Certificate Status on a
23206 TLS session for any host that matches this list.
23207 &%tls_verify_certificates%& should also be set for the transport.
23208
23209 .option hosts_require_ocsp smtp "host list&!!" unset
23210 .cindex "TLS" "requiring for certain servers"
23211 Exim will request, and check for a valid Certificate Status being given, on a
23212 TLS session for any host that matches this list.
23213 &%tls_verify_certificates%& should also be set for the transport.
23214
23215 .option hosts_require_tls smtp "host list&!!" unset
23216 .cindex "TLS" "requiring for certain servers"
23217 Exim will insist on using a TLS session when delivering to any host that
23218 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23219 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23220 incoming messages, use an appropriate ACL.
23221
23222 .option hosts_try_auth smtp "host list&!!" unset
23223 .cindex "authentication" "optional in client"
23224 This option provides a list of servers to which, provided they announce
23225 authentication support, Exim will attempt to authenticate as a client when it
23226 connects. If authentication fails, Exim will try to transfer the message
23227 unauthenticated. See also &%hosts_require_auth%&, and chapter
23228 &<<CHAPSMTPAUTH>>& for details of authentication.
23229
23230 .option hosts_try_prdr smtp "host list&!!" *
23231 .cindex "PRDR" "enabling, optional in client"
23232 This option provides a list of servers to which, provided they announce
23233 PRDR support, Exim will attempt to negotiate PRDR
23234 for multi-recipient messages.
23235 The option can usually be left as default.
23236
23237 .option interface smtp "string list&!!" unset
23238 .cindex "bind IP address"
23239 .cindex "IP address" "binding"
23240 .vindex "&$host$&"
23241 .vindex "&$host_address$&"
23242 This option specifies which interface to bind to when making an outgoing SMTP
23243 call. The value is an IP address, not an interface name such as
23244 &`eth0`&. Do not confuse this with the interface address that was used when a
23245 message was received, which is in &$received_ip_address$&, formerly known as
23246 &$interface_address$&. The name was changed to minimize confusion with the
23247 outgoing interface address. There is no variable that contains an outgoing
23248 interface address because, unless it is set by this option, its value is
23249 unknown.
23250
23251 During the expansion of the &%interface%& option the variables &$host$& and
23252 &$host_address$& refer to the host to which a connection is about to be made
23253 during the expansion of the string. Forced expansion failure, or an empty
23254 string result causes the option to be ignored. Otherwise, after expansion, the
23255 string must be a list of IP addresses, colon-separated by default, but the
23256 separator can be changed in the usual way. For example:
23257 .code
23258 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23259 .endd
23260 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23261 connection. If none of them are the correct type, the option is ignored. If
23262 &%interface%& is not set, or is ignored, the system's IP functions choose which
23263 interface to use if the host has more than one.
23264
23265
23266 .option keepalive smtp boolean true
23267 .cindex "keepalive" "on outgoing connection"
23268 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23269 connections. When set, it causes the kernel to probe idle connections
23270 periodically, by sending packets with &"old"& sequence numbers. The other end
23271 of the connection should send a acknowledgment if the connection is still okay
23272 or a reset if the connection has been aborted. The reason for doing this is
23273 that it has the beneficial effect of freeing up certain types of connection
23274 that can get stuck when the remote host is disconnected without tidying up the
23275 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23276 unreachable hosts.
23277
23278
23279 .option lmtp_ignore_quota smtp boolean false
23280 .cindex "LMTP" "ignoring quota errors"
23281 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23282 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23283 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23284
23285 .option max_rcpt smtp integer 100
23286 .cindex "RCPT" "maximum number of outgoing"
23287 This option limits the number of RCPT commands that are sent in a single
23288 SMTP message transaction. Each set of addresses is treated independently, and
23289 so can cause parallel connections to the same host if &%remote_max_parallel%&
23290 permits this.
23291
23292
23293 .option multi_domain smtp boolean&!! true
23294 .vindex "&$domain$&"
23295 When this option is set, the &(smtp)& transport can handle a number of
23296 addresses containing a mixture of different domains provided they all resolve
23297 to the same list of hosts. Turning the option off restricts the transport to
23298 handling only one domain at a time. This is useful if you want to use
23299 &$domain$& in an expansion for the transport, because it is set only when there
23300 is a single domain involved in a remote delivery.
23301
23302 It is expanded per-address and can depend on any of
23303 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23304 &$host$&, &$host_address$& and &$host_port$&.
23305
23306 .option port smtp string&!! "see below"
23307 .cindex "port" "sending TCP/IP"
23308 .cindex "TCP/IP" "setting outgoing port"
23309 This option specifies the TCP/IP port on the server to which Exim connects.
23310 &*Note:*& Do not confuse this with the port that was used when a message was
23311 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23312 The name was changed to minimize confusion with the outgoing port. There is no
23313 variable that contains an outgoing port.
23314
23315 If the value of this option begins with a digit it is taken as a port number;
23316 otherwise it is looked up using &[getservbyname()]&. The default value is
23317 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23318 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23319 is deferred.
23320
23321
23322
23323 .option protocol smtp string smtp
23324 .cindex "LMTP" "over TCP/IP"
23325 .cindex "ssmtp protocol" "outbound"
23326 .cindex "TLS" "SSL-on-connect outbound"
23327 .vindex "&$port$&"
23328 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23329 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23330 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23331 deliveries into closed message stores. Exim also has support for running LMTP
23332 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23333
23334 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23335 changes to &"smtps"&, and the transport initiates TLS immediately after
23336 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23337 The Internet standards bodies strongly discourage use of this mode.
23338
23339
23340 .option retry_include_ip_address smtp boolean&!! true
23341 Exim normally includes both the host name and the IP address in the key it
23342 constructs for indexing retry data after a temporary delivery failure. This
23343 means that when one of several IP addresses for a host is failing, it gets
23344 tried periodically (controlled by the retry rules), but use of the other IP
23345 addresses is not affected.
23346
23347 However, in some dialup environments hosts are assigned a different IP address
23348 each time they connect. In this situation the use of the IP address as part of
23349 the retry key leads to undesirable behaviour. Setting this option false causes
23350 Exim to use only the host name.
23351 Since it is expanded it can be made to depend on the host or domain.
23352
23353
23354 .option serialize_hosts smtp "host list&!!" unset
23355 .cindex "serializing connections"
23356 .cindex "host" "serializing connections"
23357 Because Exim operates in a distributed manner, if several messages for the same
23358 host arrive at around the same time, more than one simultaneous connection to
23359 the remote host can occur. This is not usually a problem except when there is a
23360 slow link between the hosts. In that situation it may be helpful to restrict
23361 Exim to one connection at a time. This can be done by setting
23362 &%serialize_hosts%& to match the relevant hosts.
23363
23364 .cindex "hints database" "serializing deliveries to a host"
23365 Exim implements serialization by means of a hints database in which a record is
23366 written whenever a process connects to one of the restricted hosts. The record
23367 is deleted when the connection is completed. Obviously there is scope for
23368 records to get left lying around if there is a system or program crash. To
23369 guard against this, Exim ignores any records that are more than six hours old.
23370
23371 If you set up this kind of serialization, you should also arrange to delete the
23372 relevant hints database whenever your system reboots. The names of the files
23373 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23374 may be one or two files, depending on the type of DBM in use. The same files
23375 are used for ETRN serialization.
23376
23377
23378 .option size_addition smtp integer 1024
23379 .cindex "SMTP" "SIZE"
23380 .cindex "message" "size issue for transport filter"
23381 .cindex "size" "of message"
23382 .cindex "transport" "filter"
23383 .cindex "filter" "transport filter"
23384 If a remote SMTP server indicates that it supports the SIZE option of the
23385 MAIL command, Exim uses this to pass over the message size at the start of
23386 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23387 sends, to allow for headers and other text that may be added during delivery by
23388 configuration options or in a transport filter. It may be necessary to increase
23389 this if a lot of text is added to messages.
23390
23391 Alternatively, if the value of &%size_addition%& is set negative, it disables
23392 the use of the SIZE option altogether.
23393
23394
23395 .option tls_certificate smtp string&!! unset
23396 .cindex "TLS" "client certificate, location of"
23397 .cindex "certificate" "client, location of"
23398 .vindex "&$host$&"
23399 .vindex "&$host_address$&"
23400 The value of this option must be the absolute path to a file which contains the
23401 client's certificate, for possible use when sending a message over an encrypted
23402 connection. The values of &$host$& and &$host_address$& are set to the name and
23403 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23404 details of TLS.
23405
23406 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23407 certificate when sending messages as a client. The global option of the same
23408 name specifies the certificate for Exim as a server; it is not automatically
23409 assumed that the same certificate should be used when Exim is operating as a
23410 client.
23411
23412
23413 .option tls_crl smtp string&!! unset
23414 .cindex "TLS" "client certificate revocation list"
23415 .cindex "certificate" "revocation list for client"
23416 This option specifies a certificate revocation list. The expanded value must
23417 be the name of a file that contains a CRL in PEM format.
23418
23419
23420 .option tls_dh_min_bits smtp integer 1024
23421 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23422 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23423 key agreement is negotiated, the server will provide a large prime number
23424 for use.  This option establishes the minimum acceptable size of that number.
23425 If the parameter offered by the server is too small, then the TLS handshake
23426 will fail.
23427
23428 Only supported when using GnuTLS.
23429
23430
23431 .option tls_privatekey smtp string&!! unset
23432 .cindex "TLS" "client private key, location of"
23433 .vindex "&$host$&"
23434 .vindex "&$host_address$&"
23435 The value of this option must be the absolute path to a file which contains the
23436 client's private key. This is used when sending a message over an encrypted
23437 connection using a client certificate. The values of &$host$& and
23438 &$host_address$& are set to the name and address of the server during the
23439 expansion. If this option is unset, or the expansion is forced to fail, or the
23440 result is an empty string, the private key is assumed to be in the same file as
23441 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23442
23443
23444 .option tls_require_ciphers smtp string&!! unset
23445 .cindex "TLS" "requiring specific ciphers"
23446 .cindex "cipher" "requiring specific"
23447 .vindex "&$host$&"
23448 .vindex "&$host_address$&"
23449 The value of this option must be a list of permitted cipher suites, for use
23450 when setting up an outgoing encrypted connection. (There is a global option of
23451 the same name for controlling incoming connections.) The values of &$host$& and
23452 &$host_address$& are set to the name and address of the server during the
23453 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23454 is used in different ways by OpenSSL and GnuTLS (see sections
23455 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23456 ciphers is a preference order.
23457
23458
23459
23460 .option tls_sni smtp string&!! unset
23461 .cindex "TLS" "Server Name Indication"
23462 .vindex "&$tls_sni$&"
23463 If this option is set then it sets the $tls_out_sni variable and causes any
23464 TLS session to pass this value as the Server Name Indication extension to
23465 the remote side, which can be used by the remote side to select an appropriate
23466 certificate and private key for the session.
23467
23468 See &<<SECTtlssni>>& for more information.
23469
23470 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23471 TLS extensions.
23472
23473
23474
23475
23476 .option tls_tempfail_tryclear smtp boolean true
23477 .cindex "4&'xx'& responses" "to STARTTLS"
23478 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23479 setting up a TLS session, this option determines whether or not Exim should try
23480 to deliver the message unencrypted. If it is set false, delivery to the
23481 current host is deferred; if there are other hosts, they are tried. If this
23482 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23483 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23484 TLS negotiation fails, Exim closes the current connection (because it is in an
23485 unknown state), opens a new one to the same host, and then tries the delivery
23486 in clear.
23487
23488
23489 .option tls_try_verify_hosts smtp "host list&!!" *
23490 .cindex "TLS" "server certificate verification"
23491 .cindex "certificate" "verification of server"
23492 This option gives a list of hosts for which, on encrypted connections,
23493 certificate verification will be tried but need not succeed.
23494 The &%tls_verify_certificates%& option must also be set.
23495 Note that unless the host is in this list
23496 TLS connections will be denied to hosts using self-signed certificates
23497 when &%tls_verify_certificates%& is matched.
23498 The &$tls_out_certificate_verified$& variable is set when
23499 certificate verification succeeds.
23500
23501
23502 .option tls_verify_cert_hostnames smtp "host list&!!" *
23503 .cindex "TLS" "server certificate hostname verification"
23504 .cindex "certificate" "verification of server"
23505 This option give a list of hosts for which,
23506 while verifying the server certificate,
23507 checks will be included on the host name
23508 (note that this will generally be the result of a DNS MX lookup)
23509 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23510 limited to being the initial component of a 3-or-more component FQDN.
23511
23512 There is no equivalent checking on client certificates.
23513
23514
23515 .option tls_verify_certificates smtp string&!! system
23516 .cindex "TLS" "server certificate verification"
23517 .cindex "certificate" "verification of server"
23518 .vindex "&$host$&"
23519 .vindex "&$host_address$&"
23520 The value of this option must be either the
23521 word "system"
23522 or the absolute path to
23523 a file or directory containing permitted certificates for servers,
23524 for use when setting up an encrypted connection.
23525
23526 The "system" value for the option will use a location compiled into the SSL library.
23527 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23528 is taken as empty and an explicit location
23529 must be specified.
23530
23531 The use of a directory for the option value is not avilable for GnuTLS versions
23532 preceding 3.3.6 and a single file must be used.
23533
23534 With OpenSSL the certificates specified
23535 explicitly
23536 either by file or directory
23537 are added to those given by the system default location.
23538
23539 The values of &$host$& and
23540 &$host_address$& are set to the name and address of the server during the
23541 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23542
23543 For back-compatability,
23544 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23545 (a single-colon empty list counts as being set)
23546 and certificate verification fails the TLS connection is closed.
23547
23548
23549 .option tls_verify_hosts smtp "host list&!!" unset
23550 .cindex "TLS" "server certificate verification"
23551 .cindex "certificate" "verification of server"
23552 This option gives a list of hosts for which. on encrypted connections,
23553 certificate verification must succeed.
23554 The &%tls_verify_certificates%& option must also be set.
23555 If both this option and &%tls_try_verify_hosts%& are unset
23556 operation is as if this option selected all hosts.
23557
23558
23559
23560
23561 .section "How the limits for the number of hosts to try are used" &&&
23562          "SECTvalhosmax"
23563 .cindex "host" "maximum number to try"
23564 .cindex "limit" "hosts; maximum number tried"
23565 There are two options that are concerned with the number of hosts that are
23566 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23567 &%hosts_max_try_hardlimit%&.
23568
23569
23570 The &%hosts_max_try%& option limits the number of hosts that are tried
23571 for a single delivery. However, despite the term &"host"& in its name, the
23572 option actually applies to each IP address independently. In other words, a
23573 multihomed host is treated as several independent hosts, just as it is for
23574 retrying.
23575
23576 Many of the larger ISPs have multiple MX records which often point to
23577 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23578 created as a result of routing one of these domains.
23579
23580 Trying every single IP address on such a long list does not seem sensible; if
23581 several at the top of the list fail, it is reasonable to assume there is some
23582 problem that is likely to affect all of them. Roughly speaking, the value of
23583 &%hosts_max_try%& is the maximum number that are tried before deferring the
23584 delivery. However, the logic cannot be quite that simple.
23585
23586 Firstly, IP addresses that are skipped because their retry times have not
23587 arrived do not count, and in addition, addresses that are past their retry
23588 limits are also not counted, even when they are tried. This means that when
23589 some IP addresses are past their retry limits, more than the value of
23590 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23591 that all IP addresses are considered before timing out an email address (but
23592 see below for an exception).
23593
23594 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23595 list to see if there is a subsequent host with a different (higher valued) MX.
23596 If there is, that host is considered next, and the current IP address is used
23597 but not counted. This behaviour helps in the case of a domain with a retry rule
23598 that hardly ever delays any hosts, as is now explained:
23599
23600 Consider the case of a long list of hosts with one MX value, and a few with a
23601 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23602 hosts at the top of the list are tried at first. With the default retry rule,
23603 which specifies increasing retry times, the higher MX hosts are eventually
23604 tried when those at the top of the list are skipped because they have not
23605 reached their retry times.
23606
23607 However, it is common practice to put a fixed short retry time on domains for
23608 large ISPs, on the grounds that their servers are rarely down for very long.
23609 Unfortunately, these are exactly the domains that tend to resolve to long lists
23610 of hosts. The short retry time means that the lowest MX hosts are tried every
23611 time. The attempts may be in a different order because of random sorting, but
23612 without the special MX check, the higher MX hosts would never be tried until
23613 all the lower MX hosts had timed out (which might be several days), because
23614 there are always some lower MX hosts that have reached their retry times. With
23615 the special check, Exim considers at least one IP address from each MX value at
23616 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23617 reached.
23618
23619 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23620 particular, Exim normally eventually tries all the IP addresses before timing
23621 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23622 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23623 been set up with hundreds of IP addresses for some domains. It can
23624 take a very long time indeed for an address to time out in these cases.
23625
23626 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23627 Exim never tries more than this number of IP addresses; if it hits this limit
23628 and they are all timed out, the email address is bounced, even though not all
23629 possible IP addresses have been tried.
23630 .ecindex IIDsmttra1
23631 .ecindex IIDsmttra2
23632
23633
23634
23635
23636
23637 . ////////////////////////////////////////////////////////////////////////////
23638 . ////////////////////////////////////////////////////////////////////////////
23639
23640 .chapter "Address rewriting" "CHAPrewrite"
23641 .scindex IIDaddrew "rewriting" "addresses"
23642 There are some circumstances in which Exim automatically rewrites domains in
23643 addresses. The two most common are when an address is given without a domain
23644 (referred to as an &"unqualified address"&) or when an address contains an
23645 abbreviated domain that is expanded by DNS lookup.
23646
23647 Unqualified envelope addresses are accepted only for locally submitted
23648 messages, or for messages that are received from hosts matching
23649 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23650 appropriate. Unqualified addresses in header lines are qualified if they are in
23651 locally submitted messages, or messages from hosts that are permitted to send
23652 unqualified envelope addresses. Otherwise, unqualified addresses in header
23653 lines are neither qualified nor rewritten.
23654
23655 One situation in which Exim does &'not'& automatically rewrite a domain is
23656 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23657 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23658 do this. The new RFCs do not contain this suggestion.
23659
23660
23661 .section "Explicitly configured address rewriting" "SECID147"
23662 This chapter describes the rewriting rules that can be used in the
23663 main rewrite section of the configuration file, and also in the generic
23664 &%headers_rewrite%& option that can be set on any transport.
23665
23666 Some people believe that configured address rewriting is a Mortal Sin.
23667 Others believe that life is not possible without it. Exim provides the
23668 facility; you do not have to use it.
23669
23670 The main rewriting rules that appear in the &"rewrite"& section of the
23671 configuration file are applied to addresses in incoming messages, both envelope
23672 addresses and addresses in header lines. Each rule specifies the types of
23673 address to which it applies.
23674
23675 Whether or not addresses in header lines are rewritten depends on the origin of
23676 the headers and the type of rewriting. Global rewriting, that is, rewriting
23677 rules from the rewrite section of the configuration file, is applied only to
23678 those headers that were received with the message. Header lines that are added
23679 by ACLs or by a system filter or by individual routers or transports (which
23680 are specific to individual recipient addresses) are not rewritten by the global
23681 rules.
23682
23683 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23684 applies all headers except those added by routers and transports. That is, as
23685 well as the headers that were received with the message, it also applies to
23686 headers that were added by an ACL or a system filter.
23687
23688
23689 In general, rewriting addresses from your own system or domain has some
23690 legitimacy. Rewriting other addresses should be done only with great care and
23691 in special circumstances. The author of Exim believes that rewriting should be
23692 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23693 Although it can sometimes be used as a routing tool, this is very strongly
23694 discouraged.
23695
23696 There are two commonly encountered circumstances where rewriting is used, as
23697 illustrated by these examples:
23698
23699 .ilist
23700 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23701 exchange mail with each other behind a firewall, but there is only a single
23702 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23703 &'hitch.fict.example'& when sending mail off-site.
23704 .next
23705 A host rewrites the local parts of its own users so that, for example,
23706 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23707 .endlist
23708
23709
23710
23711 .section "When does rewriting happen?" "SECID148"
23712 .cindex "rewriting" "timing of"
23713 .cindex "&ACL;" "rewriting addresses in"
23714 Configured address rewriting can take place at several different stages of a
23715 message's processing.
23716
23717 .vindex "&$sender_address$&"
23718 At the start of an ACL for MAIL, the sender address may have been rewritten
23719 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23720 ordinary rewrite rules have yet been applied. If, however, the sender address
23721 is verified in the ACL, it is rewritten before verification, and remains
23722 rewritten thereafter. The subsequent value of &$sender_address$& is the
23723 rewritten address. This also applies if sender verification happens in a
23724 RCPT ACL. Otherwise, when the sender address is not verified, it is
23725 rewritten as soon as a message's header lines have been received.
23726
23727 .vindex "&$domain$&"
23728 .vindex "&$local_part$&"
23729 Similarly, at the start of an ACL for RCPT, the current recipient's address
23730 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23731 rewrite rules have yet been applied to it. However, the behaviour is different
23732 from the sender address when a recipient is verified. The address is rewritten
23733 for the verification, but the rewriting is not remembered at this stage. The
23734 value of &$local_part$& and &$domain$& after verification are always the same
23735 as they were before (that is, they contain the unrewritten &-- except for
23736 SMTP-time rewriting &-- address).
23737
23738 As soon as a message's header lines have been received, all the envelope
23739 recipient addresses are permanently rewritten, and rewriting is also applied to
23740 the addresses in the header lines (if configured). This happens before adding
23741 any header lines that were specified in MAIL or RCPT ACLs, and
23742 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23743 before the DATA ACL and &[local_scan()]& functions are run.
23744
23745 When an address is being routed, either for delivery or for verification,
23746 rewriting is applied immediately to child addresses that are generated by
23747 redirection, unless &%no_rewrite%& is set on the router.
23748
23749 .cindex "envelope sender" "rewriting at transport time"
23750 .cindex "rewriting" "at transport time"
23751 .cindex "header lines" "rewriting at transport time"
23752 At transport time, additional rewriting of addresses in header lines can be
23753 specified by setting the generic &%headers_rewrite%& option on a transport.
23754 This option contains rules that are identical in form to those in the rewrite
23755 section of the configuration file. They are applied to the original message
23756 header lines and any that were added by ACLs or a system filter. They are not
23757 applied to header lines that are added by routers or the transport.
23758
23759 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23760 transport option. However, it is not possible to rewrite envelope recipients at
23761 transport time.
23762
23763
23764
23765
23766 .section "Testing the rewriting rules that apply on input" "SECID149"
23767 .cindex "rewriting" "testing"
23768 .cindex "testing" "rewriting"
23769 Exim's input rewriting configuration appears in a part of the run time
23770 configuration file headed by &"begin rewrite"&. It can be tested by the
23771 &%-brw%& command line option. This takes an address (which can be a full RFC
23772 2822 address) as its argument. The output is a list of how the address would be
23773 transformed by the rewriting rules for each of the different places it might
23774 appear in an incoming message, that is, for each different header and for the
23775 envelope sender and recipient fields. For example,
23776 .code
23777 exim -brw ph10@exim.workshop.example
23778 .endd
23779 might produce the output
23780 .code
23781 sender: Philip.Hazel@exim.workshop.example
23782 from: Philip.Hazel@exim.workshop.example
23783 to: ph10@exim.workshop.example
23784 cc: ph10@exim.workshop.example
23785 bcc: ph10@exim.workshop.example
23786 reply-to: Philip.Hazel@exim.workshop.example
23787 env-from: Philip.Hazel@exim.workshop.example
23788 env-to: ph10@exim.workshop.example
23789 .endd
23790 which shows that rewriting has been set up for that address when used in any of
23791 the source fields, but not when it appears as a recipient address. At the
23792 present time, there is no equivalent way of testing rewriting rules that are
23793 set for a particular transport.
23794
23795
23796 .section "Rewriting rules" "SECID150"
23797 .cindex "rewriting" "rules"
23798 The rewrite section of the configuration file consists of lines of rewriting
23799 rules in the form
23800 .display
23801 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23802 .endd
23803 Rewriting rules that are specified for the &%headers_rewrite%& generic
23804 transport option are given as a colon-separated list. Each item in the list
23805 takes the same form as a line in the main rewriting configuration (except that
23806 any colons must be doubled, of course).
23807
23808 The formats of source patterns and replacement strings are described below.
23809 Each is terminated by white space, unless enclosed in double quotes, in which
23810 case normal quoting conventions apply inside the quotes. The flags are single
23811 characters which may appear in any order. Spaces and tabs between them are
23812 ignored.
23813
23814 For each address that could potentially be rewritten, the rules are scanned in
23815 order, and replacements for the address from earlier rules can themselves be
23816 replaced by later rules (but see the &"q"& and &"R"& flags).
23817
23818 The order in which addresses are rewritten is undefined, may change between
23819 releases, and must not be relied on, with one exception: when a message is
23820 received, the envelope sender is always rewritten first, before any header
23821 lines are rewritten. For example, the replacement string for a rewrite of an
23822 address in &'To:'& must not assume that the message's address in &'From:'& has
23823 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23824 that the envelope sender has already been rewritten.
23825
23826 .vindex "&$domain$&"
23827 .vindex "&$local_part$&"
23828 The variables &$local_part$& and &$domain$& can be used in the replacement
23829 string to refer to the address that is being rewritten. Note that lookup-driven
23830 rewriting can be done by a rule of the form
23831 .code
23832 *@*   ${lookup ...
23833 .endd
23834 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23835 refer to the address that is being rewritten.
23836
23837
23838 .section "Rewriting patterns" "SECID151"
23839 .cindex "rewriting" "patterns"
23840 .cindex "address list" "in a rewriting pattern"
23841 The source pattern in a rewriting rule is any item which may appear in an
23842 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23843 single-item address list, which means that it is expanded before being tested
23844 against the address. As always, if you use a regular expression as a pattern,
23845 you must take care to escape dollar and backslash characters, or use the &`\N`&
23846 facility to suppress string expansion within the regular expression.
23847
23848 Domains in patterns should be given in lower case. Local parts in patterns are
23849 case-sensitive. If you want to do case-insensitive matching of local parts, you
23850 can use a regular expression that starts with &`^(?i)`&.
23851
23852 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23853 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23854 depending on the type of match which occurred. These can be used in the
23855 replacement string to insert portions of the incoming address. &$0$& always
23856 refers to the complete incoming address. When a regular expression is used, the
23857 numerical variables are set from its capturing subexpressions. For other types
23858 of pattern they are set as follows:
23859
23860 .ilist
23861 If a local part or domain starts with an asterisk, the numerical variables
23862 refer to the character strings matched by asterisks, with &$1$& associated with
23863 the first asterisk, and &$2$& with the second, if present. For example, if the
23864 pattern
23865 .code
23866 *queen@*.fict.example
23867 .endd
23868 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23869 .code
23870 $0 = hearts-queen@wonderland.fict.example
23871 $1 = hearts-
23872 $2 = wonderland
23873 .endd
23874 Note that if the local part does not start with an asterisk, but the domain
23875 does, it is &$1$& that contains the wild part of the domain.
23876
23877 .next
23878 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23879 of the domain are placed in the next available numerical variables. Suppose,
23880 for example, that the address &'foo@bar.baz.example'& is processed by a
23881 rewriting rule of the form
23882 .display
23883 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23884 .endd
23885 and the key in the file that matches the domain is &`*.baz.example`&. Then
23886 .code
23887 $1 = foo
23888 $2 = bar
23889 $3 = baz.example
23890 .endd
23891 If the address &'foo@baz.example'& is looked up, this matches the same
23892 wildcard file entry, and in this case &$2$& is set to the empty string, but
23893 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23894 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23895 whole domain. For non-partial domain lookups, no numerical variables are set.
23896 .endlist
23897
23898
23899 .section "Rewriting replacements" "SECID152"
23900 .cindex "rewriting" "replacements"
23901 If the replacement string for a rule is a single asterisk, addresses that
23902 match the pattern and the flags are &'not'& rewritten, and no subsequent
23903 rewriting rules are scanned. For example,
23904 .code
23905 hatta@lookingglass.fict.example  *  f
23906 .endd
23907 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23908 &'From:'& headers.
23909
23910 .vindex "&$domain$&"
23911 .vindex "&$local_part$&"
23912 If the replacement string is not a single asterisk, it is expanded, and must
23913 yield a fully qualified address. Within the expansion, the variables
23914 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23915 Any letters they contain retain their original case &-- they are not lower
23916 cased. The numerical variables are set up according to the type of pattern that
23917 matched the address, as described above. If the expansion is forced to fail by
23918 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23919 current rule is abandoned, but subsequent rules may take effect. Any other
23920 expansion failure causes the entire rewriting operation to be abandoned, and an
23921 entry written to the panic log.
23922
23923
23924
23925 .section "Rewriting flags" "SECID153"
23926 There are three different kinds of flag that may appear on rewriting rules:
23927
23928 .ilist
23929 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23930 c, f, h, r, s, t.
23931 .next
23932 A flag that specifies rewriting at SMTP time: S.
23933 .next
23934 Flags that control the rewriting process: Q, q, R, w.
23935 .endlist
23936
23937 For rules that are part of the &%headers_rewrite%& generic transport option,
23938 E, F, T, and S are not permitted.
23939
23940
23941
23942 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23943          "SECID154"
23944 .cindex "rewriting" "flags"
23945 If none of the following flag letters, nor the &"S"& flag (see section
23946 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23947 and to both the sender and recipient fields of the envelope, whereas a
23948 transport-time rewriting rule just applies to all headers. Otherwise, the
23949 rewriting rule is skipped unless the relevant addresses are being processed.
23950 .display
23951 &`E`&       rewrite all envelope fields
23952 &`F`&       rewrite the envelope From field
23953 &`T`&       rewrite the envelope To field
23954 &`b`&       rewrite the &'Bcc:'& header
23955 &`c`&       rewrite the &'Cc:'& header
23956 &`f`&       rewrite the &'From:'& header
23957 &`h`&       rewrite all headers
23958 &`r`&       rewrite the &'Reply-To:'& header
23959 &`s`&       rewrite the &'Sender:'& header
23960 &`t`&       rewrite the &'To:'& header
23961 .endd
23962 "All headers" means all of the headers listed above that can be selected
23963 individually, plus their &'Resent-'& versions. It does not include
23964 other headers such as &'Subject:'& etc.
23965
23966 You should be particularly careful about rewriting &'Sender:'& headers, and
23967 restrict this to special known cases in your own domains.
23968
23969
23970 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23971 .cindex "SMTP" "rewriting malformed addresses"
23972 .cindex "RCPT" "rewriting argument of"
23973 .cindex "MAIL" "rewriting argument of"
23974 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23975 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23976 before any other processing; even before syntax checking. The pattern is
23977 required to be a regular expression, and it is matched against the whole of the
23978 data for the command, including any surrounding angle brackets.
23979
23980 .vindex "&$domain$&"
23981 .vindex "&$local_part$&"
23982 This form of rewrite rule allows for the handling of addresses that are not
23983 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23984 input). Because the input is not required to be a syntactically valid address,
23985 the variables &$local_part$& and &$domain$& are not available during the
23986 expansion of the replacement string. The result of rewriting replaces the
23987 original address in the MAIL or RCPT command.
23988
23989
23990 .section "Flags controlling the rewriting process" "SECID155"
23991 There are four flags which control the way the rewriting process works. These
23992 take effect only when a rule is invoked, that is, when the address is of the
23993 correct type (matches the flags) and matches the pattern:
23994
23995 .ilist
23996 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23997 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23998 absence of &"Q"& the rewritten address must always include a domain.
23999 .next
24000 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24001 even if no rewriting actually takes place because of a &"fail"& in the
24002 expansion. The &"q"& flag is not effective if the address is of the wrong type
24003 (does not match the flags) or does not match the pattern.
24004 .next
24005 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24006 address, up to ten times. It can be combined with the &"q"& flag, to stop
24007 rewriting once it fails to match (after at least one successful rewrite).
24008 .next
24009 .cindex "rewriting" "whole addresses"
24010 When an address in a header is rewritten, the rewriting normally applies only
24011 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24012 left unchanged. For example, rewriting might change
24013 .code
24014 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24015 .endd
24016 into
24017 .code
24018 From: Ford Prefect <prefectf@hitch.fict.example>
24019 .endd
24020 .cindex "RFC 2047"
24021 Sometimes there is a need to replace the whole address item, and this can be
24022 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24023 causes an address in a header line to be rewritten, the entire address is
24024 replaced, not just the working part. The replacement must be a complete RFC
24025 2822 address, including the angle brackets if necessary. If text outside angle
24026 brackets contains a character whose value is greater than 126 or less than 32
24027 (except for tab), the text is encoded according to RFC 2047. The character set
24028 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24029
24030 When the &"w"& flag is set on a rule that causes an envelope address to be
24031 rewritten, all but the working part of the replacement address is discarded.
24032 .endlist
24033
24034
24035 .section "Rewriting examples" "SECID156"
24036 Here is an example of the two common rewriting paradigms:
24037 .code
24038 *@*.hitch.fict.example  $1@hitch.fict.example
24039 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24040                      {$value}fail}@hitch.fict.example bctfrF
24041 .endd
24042 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24043 the string expansion to fail if the lookup does not succeed. In this context it
24044 has the effect of leaving the original address unchanged, but Exim goes on to
24045 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24046 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24047 explicitly, which would cause the rewritten address to be the same as before,
24048 at the cost of a small bit of processing. Not supplying either of these is an
24049 error, since the rewritten address would then contain no local part.
24050
24051 The first example above replaces the domain with a superior, more general
24052 domain. This may not be desirable for certain local parts. If the rule
24053 .code
24054 root@*.hitch.fict.example  *
24055 .endd
24056 were inserted before the first rule, rewriting would be suppressed for the
24057 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24058
24059 Rewriting can be made conditional on a number of tests, by making use of
24060 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24061 messages that originate outside the local host:
24062 .code
24063 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24064                          {$1@hitch.fict.example}fail}"
24065 .endd
24066 The replacement string is quoted in this example because it contains white
24067 space.
24068
24069 .cindex "rewriting" "bang paths"
24070 .cindex "bang paths" "rewriting"
24071 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24072 an address it treats it as an unqualified local part which it qualifies with
24073 the local qualification domain (if the source of the message is local or if the
24074 remote host is permitted to send unqualified addresses). Rewriting can
24075 sometimes be used to handle simple bang paths with a fixed number of
24076 components. For example, the rule
24077 .code
24078 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24079 .endd
24080 rewrites a two-component bang path &'host.name!user'& as the domain address
24081 &'user@host.name'&. However, there is a security implication in using this as
24082 a global rewriting rule for envelope addresses. It can provide a backdoor
24083 method for using your system as a relay, because the incoming addresses appear
24084 to be local. If the bang path addresses are received via SMTP, it is safer to
24085 use the &"S"& flag to rewrite them as they are received, so that relay checking
24086 can be done on the rewritten addresses.
24087 .ecindex IIDaddrew
24088
24089
24090
24091
24092
24093 . ////////////////////////////////////////////////////////////////////////////
24094 . ////////////////////////////////////////////////////////////////////////////
24095
24096 .chapter "Retry configuration" "CHAPretry"
24097 .scindex IIDretconf1 "retry" "configuration, description of"
24098 .scindex IIDregconf2 "configuration file" "retry section"
24099 The &"retry"& section of the runtime configuration file contains a list of
24100 retry rules that control how often Exim tries to deliver messages that cannot
24101 be delivered at the first attempt. If there are no retry rules (the section is
24102 empty or not present), there are no retries. In this situation, temporary
24103 errors are treated as permanent. The default configuration contains a single,
24104 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24105 line option can be used to test which retry rule will be used for a given
24106 address, domain and error.
24107
24108 The most common cause of retries is temporary failure to deliver to a remote
24109 host because the host is down, or inaccessible because of a network problem.
24110 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24111 address) basis, not on a per-message basis. Thus, if one message has recently
24112 been delayed, delivery of a new message to the same host is not immediately
24113 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24114 log selector is set, the message
24115 .cindex "retry" "time not reached"
24116 &"retry time not reached"& is written to the main log whenever a delivery is
24117 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24118 the handling of errors during remote deliveries.
24119
24120 Retry processing applies to routing as well as to delivering, except as covered
24121 in the next paragraph. The retry rules do not distinguish between these
24122 actions. It is not possible, for example, to specify different behaviour for
24123 failures to route the domain &'snark.fict.example'& and failures to deliver to
24124 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24125 added complication, so did not implement it. However, although they share the
24126 same retry rule, the actual retry times for routing and transporting a given
24127 domain are maintained independently.
24128
24129 When a delivery is not part of a queue run (typically an immediate delivery on
24130 receipt of a message), the routers are always run, and local deliveries are
24131 always attempted, even if retry times are set for them. This makes for better
24132 behaviour if one particular message is causing problems (for example, causing
24133 quota overflow, or provoking an error in a filter file). If such a delivery
24134 suffers a temporary failure, the retry data is updated as normal, and
24135 subsequent delivery attempts from queue runs occur only when the retry time for
24136 the local address is reached.
24137
24138 .section "Changing retry rules" "SECID157"
24139 If you change the retry rules in your configuration, you should consider
24140 whether or not to delete the retry data that is stored in Exim's spool area in
24141 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24142 always safe; that is why they are called &"hints"&.
24143
24144 The hints retry data contains suggested retry times based on the previous
24145 rules. In the case of a long-running problem with a remote host, it might
24146 record the fact that the host has timed out. If your new rules increase the
24147 timeout time for such a host, you should definitely remove the old retry data
24148 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24149 messages that it should now be retaining.
24150
24151
24152
24153 .section "Format of retry rules" "SECID158"
24154 .cindex "retry" "rules"
24155 Each retry rule occupies one line and consists of three or four parts,
24156 separated by white space: a pattern, an error name, an optional list of sender
24157 addresses, and a list of retry parameters. The pattern and sender lists must be
24158 enclosed in double quotes if they contain white space. The rules are searched
24159 in order until one is found where the pattern, error name, and sender list (if
24160 present) match the failing host or address, the error that occurred, and the
24161 message's sender, respectively.
24162
24163
24164 The pattern is any single item that may appear in an address list (see section
24165 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24166 which means that it is expanded before being tested against the address that
24167 has been delayed. A negated address list item is permitted. Address
24168 list processing treats a plain domain name as if it were preceded by &"*@"&,
24169 which makes it possible for many retry rules to start with just a domain. For
24170 example,
24171 .code
24172 lookingglass.fict.example        *  F,24h,30m;
24173 .endd
24174 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24175 whereas
24176 .code
24177 alice@lookingglass.fict.example  *  F,24h,30m;
24178 .endd
24179 applies only to temporary failures involving the local part &%alice%&.
24180 In practice, almost all rules start with a domain name pattern without a local
24181 part.
24182
24183 .cindex "regular expressions" "in retry rules"
24184 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24185 must match a complete address, not just a domain, because that is how regular
24186 expressions work in address lists.
24187 .display
24188 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24189 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24190 .endd
24191
24192
24193 .section "Choosing which retry rule to use for address errors" "SECID159"
24194 When Exim is looking for a retry rule after a routing attempt has failed (for
24195 example, after a DNS timeout), each line in the retry configuration is tested
24196 against the complete address only if &%retry_use_local_part%& is set for the
24197 router. Otherwise, only the domain is used, except when matching against a
24198 regular expression, when the local part of the address is replaced with &"*"&.
24199 A domain on its own can match a domain pattern, or a pattern that starts with
24200 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24201 &%check_local_user%& is true, and false for other routers.
24202
24203 Similarly, when Exim is looking for a retry rule after a local delivery has
24204 failed (for example, after a mailbox full error), each line in the retry
24205 configuration is tested against the complete address only if
24206 &%retry_use_local_part%& is set for the transport (it defaults true for all
24207 local transports).
24208
24209 .cindex "4&'xx'& responses" "retry rules for"
24210 However, when Exim is looking for a retry rule after a remote delivery attempt
24211 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24212 whole address is always used as the key when searching the retry rules. The
24213 rule that is found is used to create a retry time for the combination of the
24214 failing address and the message's sender. It is the combination of sender and
24215 recipient that is delayed in subsequent queue runs until its retry time is
24216 reached. You can delay the recipient without regard to the sender by setting
24217 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24218 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24219 commands.
24220
24221
24222
24223 .section "Choosing which retry rule to use for host and message errors" &&&
24224          "SECID160"
24225 For a temporary error that is not related to an individual address (for
24226 example, a connection timeout), each line in the retry configuration is checked
24227 twice. First, the name of the remote host is used as a domain name (preceded by
24228 &"*@"& when matching a regular expression). If this does not match the line,
24229 the domain from the email address is tried in a similar fashion. For example,
24230 suppose the MX records for &'a.b.c.example'& are
24231 .code
24232 a.b.c.example  MX  5  x.y.z.example
24233                MX  6  p.q.r.example
24234                MX  7  m.n.o.example
24235 .endd
24236 and the retry rules are
24237 .code
24238 p.q.r.example    *      F,24h,30m;
24239 a.b.c.example    *      F,4d,45m;
24240 .endd
24241 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24242 first rule matches neither the host nor the domain, so Exim looks at the second
24243 rule. This does not match the host, but it does match the domain, so it is used
24244 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24245 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24246 first retry rule is used, because it matches the host.
24247
24248 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24249 first rule to determine retry times, but for all the other hosts for the domain
24250 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24251 routing to &'a.b.c.example'& suffers a temporary failure.
24252
24253 &*Note*&: The host name is used when matching the patterns, not its IP address.
24254 However, if a message is routed directly to an IP address without the use of a
24255 host name, for example, if a &(manualroute)& router contains a setting such as:
24256 .code
24257 route_list = *.a.example  192.168.34.23
24258 .endd
24259 then the &"host name"& that is used when searching for a retry rule is the
24260 textual form of the IP address.
24261
24262 .section "Retry rules for specific errors" "SECID161"
24263 .cindex "retry" "specific errors; specifying"
24264 The second field in a retry rule is the name of a particular error, or an
24265 asterisk, which matches any error. The errors that can be tested for are:
24266
24267 .vlist
24268 .vitem &%auth_failed%&
24269 Authentication failed when trying to send to a host in the
24270 &%hosts_require_auth%& list in an &(smtp)& transport.
24271
24272 .vitem &%data_4xx%&
24273 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24274 after the command, or after sending the message's data.
24275
24276 .vitem &%mail_4xx%&
24277 A 4&'xx'& error was received for an outgoing MAIL command.
24278
24279 .vitem &%rcpt_4xx%&
24280 A 4&'xx'& error was received for an outgoing RCPT command.
24281 .endlist
24282
24283 For the three 4&'xx'& errors, either the first or both of the x's can be given
24284 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24285 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24286 and have retries every ten minutes with a one-hour timeout, you could set up a
24287 retry rule of this form:
24288 .code
24289 the.domain.name  rcpt_452   F,1h,10m
24290 .endd
24291 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24292 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24293
24294 .vlist
24295 .vitem &%lost_connection%&
24296 A server unexpectedly closed the SMTP connection. There may, of course,
24297 legitimate reasons for this (host died, network died), but if it repeats a lot
24298 for the same host, it indicates something odd.
24299
24300 .vitem &%refused_MX%&
24301 A connection to a host obtained from an MX record was refused.
24302
24303 .vitem &%refused_A%&
24304 A connection to a host not obtained from an MX record was refused.
24305
24306 .vitem &%refused%&
24307 A connection was refused.
24308
24309 .vitem &%timeout_connect_MX%&
24310 A connection attempt to a host obtained from an MX record timed out.
24311
24312 .vitem &%timeout_connect_A%&
24313 A connection attempt to a host not obtained from an MX record timed out.
24314
24315 .vitem &%timeout_connect%&
24316 A connection attempt timed out.
24317
24318 .vitem &%timeout_MX%&
24319 There was a timeout while connecting or during an SMTP session with a host
24320 obtained from an MX record.
24321
24322 .vitem &%timeout_A%&
24323 There was a timeout while connecting or during an SMTP session with a host not
24324 obtained from an MX record.
24325
24326 .vitem &%timeout%&
24327 There was a timeout while connecting or during an SMTP session.
24328
24329 .vitem &%tls_required%&
24330 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24331 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24332 to STARTTLS, or there was a problem setting up the TLS connection.
24333
24334 .vitem &%quota%&
24335 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24336 transport.
24337
24338 .vitem &%quota_%&<&'time'&>
24339 .cindex "quota" "error testing in retry rule"
24340 .cindex "retry" "quota error testing"
24341 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24342 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24343 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24344 for four days.
24345 .endlist
24346
24347 .cindex "mailbox" "time of last read"
24348 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24349 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24350 it should be based on the last time that the user accessed the mailbox.
24351 However, it is not always possible to determine this. Exim uses the following
24352 heuristic rules:
24353
24354 .ilist
24355 If the mailbox is a single file, the time of last access (the &"atime"&) is
24356 used. As no new messages are being delivered (because the mailbox is over
24357 quota), Exim does not access the file, so this is the time of last user access.
24358 .next
24359 .cindex "maildir format" "time of last read"
24360 For a maildir delivery, the time of last modification of the &_new_&
24361 subdirectory is used. As the mailbox is over quota, no new files are created in
24362 the &_new_& subdirectory, because no new messages are being delivered. Any
24363 change to the &_new_& subdirectory is therefore assumed to be the result of an
24364 MUA moving a new message to the &_cur_& directory when it is first read. The
24365 time that is used is therefore the last time that the user read a new message.
24366 .next
24367 For other kinds of multi-file mailbox, the time of last access cannot be
24368 obtained, so a retry rule that uses this type of error field is never matched.
24369 .endlist
24370
24371 The quota errors apply both to system-enforced quotas and to Exim's own quota
24372 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24373 when a local delivery is deferred because a partition is full (the ENOSPC
24374 error).
24375
24376
24377
24378 .section "Retry rules for specified senders" "SECID162"
24379 .cindex "retry" "rules; sender-specific"
24380 You can specify retry rules that apply only when the failing message has a
24381 specific sender. In particular, this can be used to define retry rules that
24382 apply only to bounce messages. The third item in a retry rule can be of this
24383 form:
24384 .display
24385 &`senders=`&<&'address list'&>
24386 .endd
24387 The retry timings themselves are then the fourth item. For example:
24388 .code
24389 *   rcpt_4xx   senders=:   F,1h,30m
24390 .endd
24391 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24392 host. If the address list contains white space, it must be enclosed in quotes.
24393 For example:
24394 .code
24395 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24396 .endd
24397 &*Warning*&: This facility can be unhelpful if it is used for host errors
24398 (which do not depend on the recipient). The reason is that the sender is used
24399 only to match the retry rule. Once the rule has been found for a host error,
24400 its contents are used to set a retry time for the host, and this will apply to
24401 all messages, not just those with specific senders.
24402
24403 When testing retry rules using &%-brt%&, you can supply a sender using the
24404 &%-f%& command line option, like this:
24405 .code
24406 exim -f "" -brt user@dom.ain
24407 .endd
24408 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24409 list is never matched.
24410
24411
24412
24413
24414
24415 .section "Retry parameters" "SECID163"
24416 .cindex "retry" "parameters in rules"
24417 The third (or fourth, if a senders list is present) field in a retry rule is a
24418 sequence of retry parameter sets, separated by semicolons. Each set consists of
24419 .display
24420 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24421 .endd
24422 The letter identifies the algorithm for computing a new retry time; the cutoff
24423 time is the time beyond which this algorithm no longer applies, and the
24424 arguments vary the algorithm's action. The cutoff time is measured from the
24425 time that the first failure for the domain (combined with the local part if
24426 relevant) was detected, not from the time the message was received.
24427
24428 .cindex "retry" "algorithms"
24429 .cindex "retry" "fixed intervals"
24430 .cindex "retry" "increasing intervals"
24431 .cindex "retry" "random intervals"
24432 The available algorithms are:
24433
24434 .ilist
24435 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24436 the interval.
24437 .next
24438 &'G'&: retry at geometrically increasing intervals. The first argument
24439 specifies a starting value for the interval, and the second a multiplier, which
24440 is used to increase the size of the interval at each retry.
24441 .next
24442 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24443 retry, the previous interval is multiplied by the factor in order to get a
24444 maximum for the next interval. The minimum interval is the first argument of
24445 the parameter, and an actual interval is chosen randomly between them. Such a
24446 rule has been found to be helpful in cluster configurations when all the
24447 members of the cluster restart at once, and may therefore synchronize their
24448 queue processing times.
24449 .endlist
24450
24451 When computing the next retry time, the algorithm definitions are scanned in
24452 order until one whose cutoff time has not yet passed is reached. This is then
24453 used to compute a new retry time that is later than the current time. In the
24454 case of fixed interval retries, this simply means adding the interval to the
24455 current time. For geometrically increasing intervals, retry intervals are
24456 computed from the rule's parameters until one that is greater than the previous
24457 interval is found. The main configuration variable
24458 .cindex "limit" "retry interval"
24459 .cindex "retry" "interval, maximum"
24460 .oindex "&%retry_interval_max%&"
24461 &%retry_interval_max%& limits the maximum interval between retries. It
24462 cannot be set greater than &`24h`&, which is its default value.
24463
24464 A single remote domain may have a number of hosts associated with it, and each
24465 host may have more than one IP address. Retry algorithms are selected on the
24466 basis of the domain name, but are applied to each IP address independently. If,
24467 for example, a host has two IP addresses and one is unusable, Exim will
24468 generate retry times for it and will not try to use it until its next retry
24469 time comes. Thus the good IP address is likely to be tried first most of the
24470 time.
24471
24472 .cindex "hints database" "use for retrying"
24473 Retry times are hints rather than promises. Exim does not make any attempt to
24474 run deliveries exactly at the computed times. Instead, a queue runner process
24475 starts delivery processes for delayed messages periodically, and these attempt
24476 new deliveries only for those addresses that have passed their next retry time.
24477 If a new message arrives for a deferred address, an immediate delivery attempt
24478 occurs only if the address has passed its retry time. In the absence of new
24479 messages, the minimum time between retries is the interval between queue runner
24480 processes. There is not much point in setting retry times of five minutes if
24481 your queue runners happen only once an hour, unless there are a significant
24482 number of incoming messages (which might be the case on a system that is
24483 sending everything to a smart host, for example).
24484
24485 The data in the retry hints database can be inspected by using the
24486 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24487 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24488 &'exinext'& utility script can be used to find out what the next retry times
24489 are for the hosts associated with a particular mail domain, and also for local
24490 deliveries that have been deferred.
24491
24492
24493 .section "Retry rule examples" "SECID164"
24494 Here are some example retry rules:
24495 .code
24496 alice@wonderland.fict.example quota_5d  F,7d,3h
24497 wonderland.fict.example       quota_5d
24498 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24499 lookingglass.fict.example     *         F,24h,30m;
24500 *                 refused_A   F,2h,20m;
24501 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24502 .endd
24503 The first rule sets up special handling for mail to
24504 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24505 mailbox has not been read for at least 5 days. Retries continue every three
24506 hours for 7 days. The second rule handles over-quota errors for all other local
24507 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24508 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24509 fail are bounced immediately if the mailbox has not been read for at least 5
24510 days.
24511
24512 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24513 happen every 15 minutes for an hour, then with geometrically increasing
24514 intervals until two days have passed since a delivery first failed. After the
24515 first hour there is a delay of one hour, then two hours, then four hours, and
24516 so on (this is a rather extreme example).
24517
24518 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24519 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24520 all other domains, with special action for connection refusal from hosts that
24521 were not obtained from an MX record.
24522
24523 The final rule in a retry configuration should always have asterisks in the
24524 first two fields so as to provide a general catch-all for any addresses that do
24525 not have their own special handling. This example tries every 15 minutes for 2
24526 hours, then with intervals starting at one hour and increasing by a factor of
24527 1.5 up to 16 hours, then every 8 hours up to 5 days.
24528
24529
24530
24531 .section "Timeout of retry data" "SECID165"
24532 .cindex "timeout" "of retry data"
24533 .oindex "&%retry_data_expire%&"
24534 .cindex "hints database" "data expiry"
24535 .cindex "retry" "timeout of data"
24536 Exim timestamps the data that it writes to its retry hints database. When it
24537 consults the data during a delivery it ignores any that is older than the value
24538 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24539 been tried for 7 days, Exim will try to deliver to it immediately a message
24540 arrives, and if that fails, it will calculate a retry time as if it were
24541 failing for the first time.
24542
24543 This improves the behaviour for messages routed to rarely-used hosts such as MX
24544 backups. If such a host was down at one time, and happens to be down again when
24545 Exim tries a month later, using the old retry data would imply that it had been
24546 down all the time, which is not a justified assumption.
24547
24548 If a host really is permanently dead, this behaviour causes a burst of retries
24549 every now and again, but only if messages routed to it are rare. If there is a
24550 message at least once every 7 days the retry data never expires.
24551
24552
24553
24554
24555 .section "Long-term failures" "SECID166"
24556 .cindex "delivery failure, long-term"
24557 .cindex "retry" "after long-term failure"
24558 Special processing happens when an email address has been failing for so long
24559 that the cutoff time for the last algorithm is reached. For example, using the
24560 default retry rule:
24561 .code
24562 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24563 .endd
24564 the cutoff time is four days. Reaching the retry cutoff is independent of how
24565 long any specific message has been failing; it is the length of continuous
24566 failure for the recipient address that counts.
24567
24568 When the cutoff time is reached for a local delivery, or for all the IP
24569 addresses associated with a remote delivery, a subsequent delivery failure
24570 causes Exim to give up on the address, and a bounce message is generated.
24571 In order to cater for new messages that use the failing address, a next retry
24572 time is still computed from the final algorithm, and is used as follows:
24573
24574 For local deliveries, one delivery attempt is always made for any subsequent
24575 messages. If this delivery fails, the address fails immediately. The
24576 post-cutoff retry time is not used.
24577
24578 If the delivery is remote, there are two possibilities, controlled by the
24579 .oindex "&%delay_after_cutoff%&"
24580 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24581 default. Until the post-cutoff retry time for one of the IP addresses is
24582 reached, the failing email address is bounced immediately, without a delivery
24583 attempt taking place. After that time, one new delivery attempt is made to
24584 those IP addresses that are past their retry times, and if that still fails,
24585 the address is bounced and new retry times are computed.
24586
24587 In other words, when all the hosts for a given email address have been failing
24588 for a long time, Exim bounces rather then defers until one of the hosts' retry
24589 times is reached. Then it tries once, and bounces if that attempt fails. This
24590 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24591 to a broken destination, but if the host does recover, Exim will eventually
24592 notice.
24593
24594 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24595 addresses are past their final cutoff time, Exim tries to deliver to those IP
24596 addresses that have not been tried since the message arrived. If there are
24597 no suitable IP addresses, or if they all fail, the address is bounced. In other
24598 words, it does not delay when a new message arrives, but tries the expired
24599 addresses immediately, unless they have been tried since the message arrived.
24600 If there is a continuous stream of messages for the failing domains, setting
24601 &%delay_after_cutoff%& false means that there will be many more attempts to
24602 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24603 true.
24604
24605 .section "Deliveries that work intermittently" "SECID167"
24606 .cindex "retry" "intermittently working deliveries"
24607 Some additional logic is needed to cope with cases where a host is
24608 intermittently available, or when a message has some attribute that prevents
24609 its delivery when others to the same address get through. In this situation,
24610 because some messages are successfully delivered, the &"retry clock"& for the
24611 host or address keeps getting reset by the successful deliveries, and so
24612 failing messages remain on the queue for ever because the cutoff time is never
24613 reached.
24614
24615 Two exceptional actions are applied to prevent this happening. The first
24616 applies to errors that are related to a message rather than a remote host.
24617 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24618 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24619 commands, and quota failures. For this type of error, if a message's arrival
24620 time is earlier than the &"first failed"& time for the error, the earlier time
24621 is used when scanning the retry rules to decide when to try next and when to
24622 time out the address.
24623
24624 The exceptional second action applies in all cases. If a message has been on
24625 the queue for longer than the cutoff time of any applicable retry rule for a
24626 given address, a delivery is attempted for that address, even if it is not yet
24627 time, and if this delivery fails, the address is timed out. A new retry time is
24628 not computed in this case, so that other messages for the same address are
24629 considered immediately.
24630 .ecindex IIDretconf1
24631 .ecindex IIDregconf2
24632
24633
24634
24635
24636
24637
24638 . ////////////////////////////////////////////////////////////////////////////
24639 . ////////////////////////////////////////////////////////////////////////////
24640
24641 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24642 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24643 .scindex IIDauthconf2 "authentication"
24644 The &"authenticators"& section of Exim's run time configuration is concerned
24645 with SMTP authentication. This facility is an extension to the SMTP protocol,
24646 described in RFC 2554, which allows a client SMTP host to authenticate itself
24647 to a server. This is a common way for a server to recognize clients that are
24648 permitted to use it as a relay. SMTP authentication is not of relevance to the
24649 transfer of mail between servers that have no managerial connection with each
24650 other.
24651
24652 .cindex "AUTH" "description of"
24653 Very briefly, the way SMTP authentication works is as follows:
24654
24655 .ilist
24656 The server advertises a number of authentication &'mechanisms'& in response to
24657 the client's EHLO command.
24658 .next
24659 The client issues an AUTH command, naming a specific mechanism. The command
24660 may, optionally, contain some authentication data.
24661 .next
24662 The server may issue one or more &'challenges'&, to which the client must send
24663 appropriate responses. In simple authentication mechanisms, the challenges are
24664 just prompts for user names and passwords. The server does not have to issue
24665 any challenges &-- in some mechanisms the relevant data may all be transmitted
24666 with the AUTH command.
24667 .next
24668 The server either accepts or denies authentication.
24669 .next
24670 If authentication succeeds, the client may optionally make use of the AUTH
24671 option on the MAIL command to pass an authenticated sender in subsequent
24672 mail transactions. Authentication lasts for the remainder of the SMTP
24673 connection.
24674 .next
24675 If authentication fails, the client may give up, or it may try a different
24676 authentication mechanism, or it may try transferring mail over the
24677 unauthenticated connection.
24678 .endlist
24679
24680 If you are setting up a client, and want to know which authentication
24681 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24682 SMTP port) on the server, and issue an EHLO command. The response to this
24683 includes the list of supported mechanisms. For example:
24684 .display
24685 &`$ `&&*&`telnet server.example 25`&*&
24686 &`Trying 192.168.34.25...`&
24687 &`Connected to server.example.`&
24688 &`Escape character is &#x0027;^]&#x0027;.`&
24689 &`220 server.example ESMTP Exim 4.20 ...`&
24690 &*&`ehlo client.example`&*&
24691 &`250-server.example Hello client.example [10.8.4.5]`&
24692 &`250-SIZE 52428800`&
24693 &`250-PIPELINING`&
24694 &`250-AUTH PLAIN`&
24695 &`250 HELP`&
24696 .endd
24697 The second-last line of this example output shows that the server supports
24698 authentication using the PLAIN mechanism. In Exim, the different authentication
24699 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24700 routers and transports, which authenticators are included in the binary is
24701 controlled by build-time definitions. The following are currently available,
24702 included by setting
24703 .code
24704 AUTH_CRAM_MD5=yes
24705 AUTH_CYRUS_SASL=yes
24706 AUTH_DOVECOT=yes
24707 AUTH_GSASL=yes
24708 AUTH_HEIMDAL_GSSAPI=yes
24709 AUTH_PLAINTEXT=yes
24710 AUTH_SPA=yes
24711 .endd
24712 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24713 authentication mechanism (RFC 2195), and the second provides an interface to
24714 the Cyrus SASL authentication library.
24715 The third is an interface to Dovecot's authentication system, delegating the
24716 work via a socket interface.
24717 The fourth provides an interface to the GNU SASL authentication library, which
24718 provides mechanisms but typically not data sources.
24719 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24720 supporting setting a server keytab.
24721 The sixth can be configured to support
24722 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24723 not formally documented, but used by several MUAs. The seventh authenticator
24724 supports Microsoft's &'Secure Password Authentication'& mechanism.
24725
24726 The authenticators are configured using the same syntax as other drivers (see
24727 section &<<SECTfordricon>>&). If no authenticators are required, no
24728 authentication section need be present in the configuration file. Each
24729 authenticator can in principle have both server and client functions. When Exim
24730 is receiving SMTP mail, it is acting as a server; when it is sending out
24731 messages over SMTP, it is acting as a client. Authenticator configuration
24732 options are provided for use in both these circumstances.
24733
24734 To make it clear which options apply to which situation, the prefixes
24735 &%server_%& and &%client_%& are used on option names that are specific to
24736 either the server or the client function, respectively. Server and client
24737 functions are disabled if none of their options are set. If an authenticator is
24738 to be used for both server and client functions, a single definition, using
24739 both sets of options, is required. For example:
24740 .code
24741 cram:
24742   driver = cram_md5
24743   public_name = CRAM-MD5
24744   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24745   client_name = ph10
24746   client_secret = secret2
24747 .endd
24748 The &%server_%& option is used when Exim is acting as a server, and the
24749 &%client_%& options when it is acting as a client.
24750
24751 Descriptions of the individual authenticators are given in subsequent chapters.
24752 The remainder of this chapter covers the generic options for the
24753 authenticators, followed by general discussion of the way authentication works
24754 in Exim.
24755
24756 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24757 per-mechanism basis.  Please read carefully to determine which variables hold
24758 account labels such as usercodes and which hold passwords or other
24759 authenticating data.
24760
24761 Note that some mechanisms support two different identifiers for accounts: the
24762 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24763 and &'authz'& are commonly encountered.  The American spelling is standard here.
24764 Conceptually, authentication data such as passwords are tied to the identifier
24765 used to authenticate; servers may have rules to permit one user to act as a
24766 second user, so that after login the session is treated as though that second
24767 user had logged in.  That second user is the &'authorization id'&.  A robust
24768 configuration might confirm that the &'authz'& field is empty or matches the
24769 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24770 as verified data, the &'authz'& as an unverified request which the server might
24771 choose to honour.
24772
24773 A &'realm'& is a text string, typically a domain name, presented by a server
24774 to a client to help it select an account and credentials to use.  In some
24775 mechanisms, the client and server provably agree on the realm, but clients
24776 typically can not treat the realm as secure data to be blindly trusted.
24777
24778
24779
24780 .section "Generic options for authenticators" "SECID168"
24781 .cindex "authentication" "generic options"
24782 .cindex "options" "generic; for authenticators"
24783
24784 .option client_condition authenticators string&!! unset
24785 When Exim is authenticating as a client, it skips any authenticator whose
24786 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24787 used, for example, to skip plain text authenticators when the connection is not
24788 encrypted by a setting such as:
24789 .code
24790 client_condition = ${if !eq{$tls_out_cipher}{}}
24791 .endd
24792
24793
24794 .option client_set_id authenticators string&!! unset
24795 When client authentication succeeds, this condition is expanded; the
24796 result is used in the log lines for outbound messasges.
24797 Typically it will be the user name used for authentication.
24798
24799
24800 .option driver authenticators string unset
24801 This option must always be set. It specifies which of the available
24802 authenticators is to be used.
24803
24804
24805 .option public_name authenticators string unset
24806 This option specifies the name of the authentication mechanism that the driver
24807 implements, and by which it is known to the outside world. These names should
24808 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24809 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24810 defaults to the driver's instance name.
24811
24812
24813 .option server_advertise_condition authenticators string&!! unset
24814 When a server is about to advertise an authentication mechanism, the condition
24815 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24816 mechanism is not advertised.
24817 If the expansion fails, the mechanism is not advertised. If the failure was not
24818 forced, and was not caused by a lookup defer, the incident is logged.
24819 See section &<<SECTauthexiser>>& below for further discussion.
24820
24821
24822 .option server_condition authenticators string&!! unset
24823 This option must be set for a &%plaintext%& server authenticator, where it
24824 is used directly to control authentication. See section &<<SECTplainserver>>&
24825 for details.
24826
24827 For the &(gsasl)& authenticator, this option is required for various
24828 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24829
24830 For the other authenticators, &%server_condition%& can be used as an additional
24831 authentication or authorization mechanism that is applied after the other
24832 authenticator conditions succeed. If it is set, it is expanded when the
24833 authenticator would otherwise return a success code. If the expansion is forced
24834 to fail, authentication fails. Any other expansion failure causes a temporary
24835 error code to be returned. If the result of a successful expansion is an empty
24836 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24837 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24838 other result, a temporary error code is returned, with the expanded string as
24839 the error text.
24840
24841
24842 .option server_debug_print authenticators string&!! unset
24843 If this option is set and authentication debugging is enabled (see the &%-d%&
24844 command line option), the string is expanded and included in the debugging
24845 output when the authenticator is run as a server. This can help with checking
24846 out the values of variables.
24847 If expansion of the string fails, the error message is written to the debugging
24848 output, and Exim carries on processing.
24849
24850
24851 .option server_set_id authenticators string&!! unset
24852 .vindex "&$authenticated_id$&"
24853 When an Exim server successfully authenticates a client, this string is
24854 expanded using data from the authentication, and preserved for any incoming
24855 messages in the variable &$authenticated_id$&. It is also included in the log
24856 lines for incoming messages. For example, a user/password authenticator
24857 configuration might preserve the user name that was used to authenticate, and
24858 refer to it subsequently during delivery of the message.
24859 If expansion fails, the option is ignored.
24860
24861
24862 .option server_mail_auth_condition authenticators string&!! unset
24863 This option allows a server to discard authenticated sender addresses supplied
24864 as part of MAIL commands in SMTP connections that are authenticated by the
24865 driver on which &%server_mail_auth_condition%& is set. The option is not used
24866 as part of the authentication process; instead its (unexpanded) value is
24867 remembered for later use.
24868 How it is used is described in the following section.
24869
24870
24871
24872
24873
24874 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24875 .cindex "authentication" "sender; authenticated"
24876 .cindex "AUTH" "on MAIL command"
24877 When a client supplied an AUTH= item on a MAIL command, Exim applies
24878 the following checks before accepting it as the authenticated sender of the
24879 message:
24880
24881 .ilist
24882 If the connection is not using extended SMTP (that is, HELO was used rather
24883 than EHLO), the use of AUTH= is a syntax error.
24884 .next
24885 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24886 .next
24887 .vindex "&$authenticated_sender$&"
24888 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24889 running, the value of &$authenticated_sender$& is set to the value obtained
24890 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24891 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24892 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24893 given for the MAIL command.
24894 .next
24895 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24896 is accepted and placed in &$authenticated_sender$& only if the client has
24897 authenticated.
24898 .next
24899 If the AUTH= value was accepted by either of the two previous rules, and
24900 the client has authenticated, and the authenticator has a setting for the
24901 &%server_mail_auth_condition%&, the condition is checked at this point. The
24902 valued that was saved from the authenticator is expanded. If the expansion
24903 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24904 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24905 the value of &$authenticated_sender$& is retained and passed on with the
24906 message.
24907 .endlist
24908
24909
24910 When &$authenticated_sender$& is set for a message, it is passed on to other
24911 hosts to which Exim authenticates as a client. Do not confuse this value with
24912 &$authenticated_id$&, which is a string obtained from the authentication
24913 process, and which is not usually a complete email address.
24914
24915 .vindex "&$sender_address$&"
24916 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24917 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24918 therefore make use of &$authenticated_sender$&. The converse is not true: the
24919 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24920 ACL is run.
24921
24922
24923
24924 .section "Authentication on an Exim server" "SECTauthexiser"
24925 .cindex "authentication" "on an Exim server"
24926 When Exim receives an EHLO command, it advertises the public names of those
24927 authenticators that are configured as servers, subject to the following
24928 conditions:
24929
24930 .ilist
24931 The client host must match &%auth_advertise_hosts%& (default *).
24932 .next
24933 It the &%server_advertise_condition%& option is set, its expansion must not
24934 yield the empty string, &"0"&, &"no"&, or &"false"&.
24935 .endlist
24936
24937 The order in which the authenticators are defined controls the order in which
24938 the mechanisms are advertised.
24939
24940 Some mail clients (for example, some versions of Netscape) require the user to
24941 provide a name and password for authentication whenever AUTH is advertised,
24942 even though authentication may not in fact be needed (for example, Exim may be
24943 set up to allow unconditional relaying from the client by an IP address check).
24944 You can make such clients more friendly by not advertising AUTH to them.
24945 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24946 that runs for RCPT) to relay without authentication, you should set
24947 .code
24948 auth_advertise_hosts = ! 10.9.8.0/24
24949 .endd
24950 so that no authentication mechanisms are advertised to them.
24951
24952 The &%server_advertise_condition%& controls the advertisement of individual
24953 authentication mechanisms. For example, it can be used to restrict the
24954 advertisement of a particular mechanism to encrypted connections, by a setting
24955 such as:
24956 .code
24957 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24958 .endd
24959 .vindex "&$tls_in_cipher$&"
24960 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24961 yields &"yes"&, which allows the advertisement to happen.
24962
24963 When an Exim server receives an AUTH command from a client, it rejects it
24964 immediately if AUTH was not advertised in response to an earlier EHLO
24965 command. This is the case if
24966
24967 .ilist
24968 The client host does not match &%auth_advertise_hosts%&; or
24969 .next
24970 No authenticators are configured with server options; or
24971 .next
24972 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24973 server authenticators.
24974 .endlist
24975
24976
24977 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24978 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24979 AUTH is accepted from any client host.
24980
24981 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24982 server authentication mechanism that was advertised in response to EHLO and
24983 that matches the one named in the AUTH command. If it finds one, it runs
24984 the appropriate authentication protocol, and authentication either succeeds or
24985 fails. If there is no matching advertised mechanism, the AUTH command is
24986 rejected with a 504 error.
24987
24988 .vindex "&$received_protocol$&"
24989 .vindex "&$sender_host_authenticated$&"
24990 When a message is received from an authenticated host, the value of
24991 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24992 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24993 public name) of the authenticator driver that successfully authenticated the
24994 client from which the message was received. This variable is empty if there was
24995 no successful authentication.
24996
24997
24998
24999
25000 .section "Testing server authentication" "SECID169"
25001 .cindex "authentication" "testing a server"
25002 .cindex "AUTH" "testing a server"
25003 .cindex "base64 encoding" "creating authentication test data"
25004 Exim's &%-bh%& option can be useful for testing server authentication
25005 configurations. The data for the AUTH command has to be sent using base64
25006 encoding. A quick way to produce such data for testing is the following Perl
25007 script:
25008 .code
25009 use MIME::Base64;
25010 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25011 .endd
25012 .cindex "binary zero" "in authentication data"
25013 This interprets its argument as a Perl string, and then encodes it. The
25014 interpretation as a Perl string allows binary zeros, which are required for
25015 some kinds of authentication, to be included in the data. For example, a
25016 command line to run this script on such data might be
25017 .code
25018 encode '\0user\0password'
25019 .endd
25020 Note the use of single quotes to prevent the shell interpreting the
25021 backslashes, so that they can be interpreted by Perl to specify characters
25022 whose code value is zero.
25023
25024 &*Warning 1*&: If either of the user or password strings starts with an octal
25025 digit, you must use three zeros instead of one after the leading backslash. If
25026 you do not, the octal digit that starts your string will be incorrectly
25027 interpreted as part of the code for the first character.
25028
25029 &*Warning 2*&: If there are characters in the strings that Perl interprets
25030 specially, you must use a Perl escape to prevent them being misinterpreted. For
25031 example, a command such as
25032 .code
25033 encode '\0user@domain.com\0pas$$word'
25034 .endd
25035 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25036
25037 If you have the &%mimencode%& command installed, another way to do produce
25038 base64-encoded strings is to run the command
25039 .code
25040 echo -e -n `\0user\0password' | mimencode
25041 .endd
25042 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25043 in the argument, and the &%-n%& option specifies no newline at the end of its
25044 output. However, not all versions of &%echo%& recognize these options, so you
25045 should check your version before relying on this suggestion.
25046
25047
25048
25049 .section "Authentication by an Exim client" "SECID170"
25050 .cindex "authentication" "on an Exim client"
25051 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25052 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25053 announces support for authentication, and the host matches an entry in either
25054 of these options, Exim (as a client) tries to authenticate as follows:
25055
25056 .ilist
25057 For each authenticator that is configured as a client, in the order in which
25058 they are defined in the configuration, it searches the authentication
25059 mechanisms announced by the server for one whose name matches the public name
25060 of the authenticator.
25061 .next
25062 .vindex "&$host$&"
25063 .vindex "&$host_address$&"
25064 When it finds one that matches, it runs the authenticator's client code. The
25065 variables &$host$& and &$host_address$& are available for any string expansions
25066 that the client might do. They are set to the server's name and IP address. If
25067 any expansion is forced to fail, the authentication attempt is abandoned, and
25068 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25069 delivery to be deferred.
25070 .next
25071 If the result of the authentication attempt is a temporary error or a timeout,
25072 Exim abandons trying to send the message to the host for the moment. It will
25073 try again later. If there are any backup hosts available, they are tried in the
25074 usual way.
25075 .next
25076 If the response to authentication is a permanent error (5&'xx'& code), Exim
25077 carries on searching the list of authenticators and tries another one if
25078 possible. If all authentication attempts give permanent errors, or if there are
25079 no attempts because no mechanisms match (or option expansions force failure),
25080 what happens depends on whether the host matches &%hosts_require_auth%& or
25081 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25082 delivery is deferred. The error can be detected in the retry rules, and thereby
25083 turned into a permanent error if you wish. In the second case, Exim tries to
25084 deliver the message unauthenticated.
25085 .endlist
25086
25087 .cindex "AUTH" "on MAIL command"
25088 When Exim has authenticated itself to a remote server, it adds the AUTH
25089 parameter to the MAIL commands it sends, if it has an authenticated sender for
25090 the message. If the message came from a remote host, the authenticated sender
25091 is the one that was receiving on an incoming MAIL command, provided that the
25092 incoming connection was authenticated and the &%server_mail_auth%& condition
25093 allowed the authenticated sender to be retained. If a local process calls Exim
25094 to send a message, the sender address that is built from the login name and
25095 &%qualify_domain%& is treated as authenticated. However, if the
25096 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25097 the authenticated sender that was received with the message.
25098 .ecindex IIDauthconf1
25099 .ecindex IIDauthconf2
25100
25101
25102
25103
25104
25105
25106 . ////////////////////////////////////////////////////////////////////////////
25107 . ////////////////////////////////////////////////////////////////////////////
25108
25109 .chapter "The plaintext authenticator" "CHAPplaintext"
25110 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25111 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25112 The &(plaintext)& authenticator can be configured to support the PLAIN and
25113 LOGIN authentication mechanisms, both of which transfer authentication data as
25114 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25115 security risk; you are strongly advised to insist on the use of SMTP encryption
25116 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25117 use unencrypted plain text, you should not use the same passwords for SMTP
25118 connections as you do for login accounts.
25119
25120 .section "Plaintext options" "SECID171"
25121 .cindex "options" "&(plaintext)& authenticator (server)"
25122 When configured as a server, &(plaintext)& uses the following options:
25123
25124 .option server_condition authenticators string&!! unset
25125 This is actually a global authentication option, but it must be set in order to
25126 configure the &(plaintext)& driver as a server. Its use is described below.
25127
25128 .option server_prompts plaintext string&!! unset
25129 The contents of this option, after expansion, must be a colon-separated list of
25130 prompt strings. If expansion fails, a temporary authentication rejection is
25131 given.
25132
25133 .section "Using plaintext in a server" "SECTplainserver"
25134 .cindex "AUTH" "in &(plaintext)& authenticator"
25135 .cindex "binary zero" "in &(plaintext)& authenticator"
25136 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25137         "in &(plaintext)& authenticator"
25138 .vindex "&$auth1$&, &$auth2$&, etc"
25139 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25140
25141 When running as a server, &(plaintext)& performs the authentication test by
25142 expanding a string. The data sent by the client with the AUTH command, or in
25143 response to subsequent prompts, is base64 encoded, and so may contain any byte
25144 values when decoded. If any data is supplied with the command, it is treated as
25145 a list of strings, separated by NULs (binary zeros), the first three of which
25146 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25147 (neither LOGIN nor PLAIN uses more than three strings).
25148
25149 For compatibility with previous releases of Exim, the values are also placed in
25150 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25151 variables for this purpose is now deprecated, as it can lead to confusion in
25152 string expansions that also use them for other things.
25153
25154 If there are more strings in &%server_prompts%& than the number of strings
25155 supplied with the AUTH command, the remaining prompts are used to obtain more
25156 data. Each response from the client may be a list of NUL-separated strings.
25157
25158 .vindex "&$authenticated_id$&"
25159 Once a sufficient number of data strings have been received,
25160 &%server_condition%& is expanded. If the expansion is forced to fail,
25161 authentication fails. Any other expansion failure causes a temporary error code
25162 to be returned. If the result of a successful expansion is an empty string,
25163 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25164 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25165 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25166 For any other result, a temporary error code is returned, with the expanded
25167 string as the error text
25168
25169 &*Warning*&: If you use a lookup in the expansion to find the user's
25170 password, be sure to make the authentication fail if the user is unknown.
25171 There are good and bad examples at the end of the next section.
25172
25173
25174
25175 .section "The PLAIN authentication mechanism" "SECID172"
25176 .cindex "PLAIN authentication mechanism"
25177 .cindex "authentication" "PLAIN mechanism"
25178 .cindex "binary zero" "in &(plaintext)& authenticator"
25179 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25180 sent as one item of data (that is, one combined string containing two NUL
25181 separators). The data is sent either as part of the AUTH command, or
25182 subsequently in response to an empty prompt from the server.
25183
25184 The second and third strings are a user name and a corresponding password.
25185 Using a single fixed user name and password as an example, this could be
25186 configured as follows:
25187 .code
25188 fixed_plain:
25189   driver = plaintext
25190   public_name = PLAIN
25191   server_prompts = :
25192   server_condition = \
25193     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25194   server_set_id = $auth2
25195 .endd
25196 Note that the default result strings from &%if%& (&"true"& or an empty string)
25197 are exactly what we want here, so they need not be specified. Obviously, if the
25198 password contains expansion-significant characters such as dollar, backslash,
25199 or closing brace, they have to be escaped.
25200
25201 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25202 the end of a string list are ignored). If all the data comes as part of the
25203 AUTH command, as is commonly the case, the prompt is not used. This
25204 authenticator is advertised in the response to EHLO as
25205 .code
25206 250-AUTH PLAIN
25207 .endd
25208 and a client host can authenticate itself by sending the command
25209 .code
25210 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25211 .endd
25212 As this contains three strings (more than the number of prompts), no further
25213 data is required from the client. Alternatively, the client may just send
25214 .code
25215 AUTH PLAIN
25216 .endd
25217 to initiate authentication, in which case the server replies with an empty
25218 prompt. The client must respond with the combined data string.
25219
25220 The data string is base64 encoded, as required by the RFC. This example,
25221 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25222 represents a zero byte. This is split up into three strings, the first of which
25223 is empty. The &%server_condition%& option in the authenticator checks that the
25224 second two are &`username`& and &`mysecret`& respectively.
25225
25226 Having just one fixed user name and password, as in this example, is not very
25227 realistic, though for a small organization with only a handful of
25228 authenticating clients it could make sense.
25229
25230 A more sophisticated instance of this authenticator could use the user name in
25231 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25232 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25233 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25234 This is an incorrect example:
25235 .code
25236 server_condition = \
25237   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25238 .endd
25239 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25240 which it then compares to the supplied password (&$auth3$&). Why is this example
25241 incorrect? It works fine for existing users, but consider what happens if a
25242 non-existent user name is given. The lookup fails, but as no success/failure
25243 strings are given for the lookup, it yields an empty string. Thus, to defeat
25244 the authentication, all a client has to do is to supply a non-existent user
25245 name and an empty password. The correct way of writing this test is:
25246 .code
25247 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25248   {${if eq{$value}{$auth3}}} {false}}
25249 .endd
25250 In this case, if the lookup succeeds, the result is checked; if the lookup
25251 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25252 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25253 always fails if its second argument is empty. However, the second way of
25254 writing the test makes the logic clearer.
25255
25256
25257 .section "The LOGIN authentication mechanism" "SECID173"
25258 .cindex "LOGIN authentication mechanism"
25259 .cindex "authentication" "LOGIN mechanism"
25260 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25261 in a number of programs. No data is sent with the AUTH command. Instead, a
25262 user name and password are supplied separately, in response to prompts. The
25263 plaintext authenticator can be configured to support this as in this example:
25264 .code
25265 fixed_login:
25266   driver = plaintext
25267   public_name = LOGIN
25268   server_prompts = User Name : Password
25269   server_condition = \
25270     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25271   server_set_id = $auth1
25272 .endd
25273 Because of the way plaintext operates, this authenticator accepts data supplied
25274 with the AUTH command (in contravention of the specification of LOGIN), but
25275 if the client does not supply it (as is the case for LOGIN clients), the prompt
25276 strings are used to obtain two data items.
25277
25278 Some clients are very particular about the precise text of the prompts. For
25279 example, Outlook Express is reported to recognize only &"Username:"& and
25280 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25281 strings. It uses the &%ldapauth%& expansion condition to check the user
25282 name and password by binding to an LDAP server:
25283 .code
25284 login:
25285   driver = plaintext
25286   public_name = LOGIN
25287   server_prompts = Username:: : Password::
25288   server_condition = ${if and{{ \
25289     !eq{}{$auth1} }{ \
25290     ldapauth{\
25291       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25292       pass=${quote:$auth2} \
25293       ldap://ldap.example.org/} }} }
25294   server_set_id = uid=$auth1,ou=people,o=example.org
25295 .endd
25296 We have to check that the username is not empty before using it, because LDAP
25297 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25298 operator to correctly quote the DN for authentication. However, the basic
25299 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25300 correct one to use for the password, because quoting is needed only to make
25301 the password conform to the Exim syntax. At the LDAP level, the password is an
25302 uninterpreted string.
25303
25304
25305 .section "Support for different kinds of authentication" "SECID174"
25306 A number of string expansion features are provided for the purpose of
25307 interfacing to different ways of user authentication. These include checking
25308 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25309 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25310 &<<SECTexpcond>>&.
25311
25312
25313
25314
25315 .section "Using plaintext in a client" "SECID175"
25316 .cindex "options" "&(plaintext)& authenticator (client)"
25317 The &(plaintext)& authenticator has two client options:
25318
25319 .option client_ignore_invalid_base64 plaintext boolean false
25320 If the client receives a server prompt that is not a valid base64 string,
25321 authentication is abandoned by default. However, if this option is set true,
25322 the error in the challenge is ignored and the client sends the response as
25323 usual.
25324
25325 .option client_send plaintext string&!! unset
25326 The string is a colon-separated list of authentication data strings. Each
25327 string is independently expanded before being sent to the server. The first
25328 string is sent with the AUTH command; any more strings are sent in response
25329 to prompts from the server. Before each string is expanded, the value of the
25330 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25331 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25332 way. Thus, the prompt that is received in response to sending the first string
25333 (with the AUTH command) can be used in the expansion of the second string, and
25334 so on. If an invalid base64 string is received when
25335 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25336 &$auth$&<&'n'&> variable.
25337
25338 &*Note*&: You cannot use expansion to create multiple strings, because
25339 splitting takes priority and happens first.
25340
25341 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25342 the data, further processing is applied to each string before it is sent. If
25343 there are any single circumflex characters in the string, they are converted to
25344 NULs. Should an actual circumflex be required as data, it must be doubled in
25345 the string.
25346
25347 This is an example of a client configuration that implements the PLAIN
25348 authentication mechanism with a fixed user name and password:
25349 .code
25350 fixed_plain:
25351   driver = plaintext
25352   public_name = PLAIN
25353   client_send = ^username^mysecret
25354 .endd
25355 The lack of colons means that the entire text is sent with the AUTH
25356 command, with the circumflex characters converted to NULs. A similar example
25357 that uses the LOGIN mechanism is:
25358 .code
25359 fixed_login:
25360   driver = plaintext
25361   public_name = LOGIN
25362   client_send = : username : mysecret
25363 .endd
25364 The initial colon means that the first string is empty, so no data is sent with
25365 the AUTH command itself. The remaining strings are sent in response to
25366 prompts.
25367 .ecindex IIDplaiauth1
25368 .ecindex IIDplaiauth2
25369
25370
25371
25372
25373 . ////////////////////////////////////////////////////////////////////////////
25374 . ////////////////////////////////////////////////////////////////////////////
25375
25376 .chapter "The cram_md5 authenticator" "CHID9"
25377 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25378 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25379 .cindex "CRAM-MD5 authentication mechanism"
25380 .cindex "authentication" "CRAM-MD5 mechanism"
25381 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25382 sends a challenge string to the client, and the response consists of a user
25383 name and the CRAM-MD5 digest of the challenge string combined with a secret
25384 string (password) which is known to both server and client. Thus, the secret
25385 is not sent over the network as plain text, which makes this authenticator more
25386 secure than &(plaintext)&. However, the downside is that the secret has to be
25387 available in plain text at either end.
25388
25389
25390 .section "Using cram_md5 as a server" "SECID176"
25391 .cindex "options" "&(cram_md5)& authenticator (server)"
25392 This authenticator has one server option, which must be set to configure the
25393 authenticator as a server:
25394
25395 .option server_secret cram_md5 string&!! unset
25396 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25397 When the server receives the client's response, the user name is placed in
25398 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25399 obtain the password for that user. The server then computes the CRAM-MD5 digest
25400 that the client should have sent, and checks that it received the correct
25401 string. If the expansion of &%server_secret%& is forced to fail, authentication
25402 fails. If the expansion fails for some other reason, a temporary error code is
25403 returned to the client.
25404
25405 For compatibility with previous releases of Exim, the user name is also placed
25406 in &$1$&. However, the use of this variables for this purpose is now
25407 deprecated, as it can lead to confusion in string expansions that also use
25408 numeric variables for other things.
25409
25410 For example, the following authenticator checks that the user name given by the
25411 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25412 user name, authentication fails.
25413 .code
25414 fixed_cram:
25415   driver = cram_md5
25416   public_name = CRAM-MD5
25417   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25418   server_set_id = $auth1
25419 .endd
25420 .vindex "&$authenticated_id$&"
25421 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25422 name in &$authenticated_id$&. A more typical configuration might look up the
25423 secret string in a file, using the user name as the key. For example:
25424 .code
25425 lookup_cram:
25426   driver = cram_md5
25427   public_name = CRAM-MD5
25428   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25429                   {$value}fail}
25430   server_set_id = $auth1
25431 .endd
25432 Note that this expansion explicitly forces failure if the lookup fails
25433 because &$auth1$& contains an unknown user name.
25434
25435 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25436 using the relevant libraries, you need to know the realm to specify in the
25437 lookup and then ask for the &"userPassword"& attribute for that user in that
25438 realm, with:
25439 .code
25440 cyrusless_crammd5:
25441   driver = cram_md5
25442   public_name = CRAM-MD5
25443   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25444                   dbmjz{/etc/sasldb2}}
25445   server_set_id = $auth1
25446 .endd
25447
25448 .section "Using cram_md5 as a client" "SECID177"
25449 .cindex "options" "&(cram_md5)& authenticator (client)"
25450 When used as a client, the &(cram_md5)& authenticator has two options:
25451
25452
25453
25454 .option client_name cram_md5 string&!! "the primary host name"
25455 This string is expanded, and the result used as the user name data when
25456 computing the response to the server's challenge.
25457
25458
25459 .option client_secret cram_md5 string&!! unset
25460 This option must be set for the authenticator to work as a client. Its value is
25461 expanded and the result used as the secret string when computing the response.
25462
25463
25464 .vindex "&$host$&"
25465 .vindex "&$host_address$&"
25466 Different user names and secrets can be used for different servers by referring
25467 to &$host$& or &$host_address$& in the options. Forced failure of either
25468 expansion string is treated as an indication that this authenticator is not
25469 prepared to handle this case. Exim moves on to the next configured client
25470 authenticator. Any other expansion failure causes Exim to give up trying to
25471 send the message to the current server.
25472
25473 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25474 strings, is:
25475 .code
25476 fixed_cram:
25477   driver = cram_md5
25478   public_name = CRAM-MD5
25479   client_name = ph10
25480   client_secret = secret
25481 .endd
25482 .ecindex IIDcramauth1
25483 .ecindex IIDcramauth2
25484
25485
25486
25487 . ////////////////////////////////////////////////////////////////////////////
25488 . ////////////////////////////////////////////////////////////////////////////
25489
25490 .chapter "The cyrus_sasl authenticator" "CHID10"
25491 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25492 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25493 .cindex "Cyrus" "SASL library"
25494 .cindex "Kerberos"
25495 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25496 Digital Ltd (&url(http://www.aldigital.co.uk)).
25497
25498 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25499 library implementation of the RFC 2222 (&"Simple Authentication and Security
25500 Layer"&). This library supports a number of authentication mechanisms,
25501 including PLAIN and LOGIN, but also several others that Exim does not support
25502 directly. In particular, there is support for Kerberos authentication.
25503
25504 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25505 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25506 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25507 name of the driver to determine which mechanism to support.
25508
25509 Where access to some kind of secret file is required, for example in GSSAPI
25510 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25511 user, and that the Cyrus SASL library has no way of escalating privileges
25512 by default. You may also find you need to set environment variables,
25513 depending on the driver you are using.
25514
25515 The application name provided by Exim is &"exim"&, so various SASL options may
25516 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25517 Kerberos, note that because of limitations in the GSSAPI interface,
25518 changing the server keytab might need to be communicated down to the Kerberos
25519 layer independently. The mechanism for doing so is dependent upon the Kerberos
25520 implementation.
25521
25522 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25523 may be set to point to an alternative keytab file. Exim will pass this
25524 variable through from its own inherited environment when started as root or the
25525 Exim user. The keytab file needs to be readable by the Exim user.
25526 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25527 environment variable.  In practice, for those releases, the Cyrus authenticator
25528 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25529 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25530
25531
25532 .section "Using cyrus_sasl as a server" "SECID178"
25533 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25534 (on a successful authentication) into &$auth1$&. For compatibility with
25535 previous releases of Exim, the username is also placed in &$1$&. However, the
25536 use of this variable for this purpose is now deprecated, as it can lead to
25537 confusion in string expansions that also use numeric variables for other
25538 things.
25539
25540
25541 .option server_hostname cyrus_sasl string&!! "see below"
25542 This option selects the hostname that is used when communicating with the
25543 library. The default value is &`$primary_hostname`&. It is up to the underlying
25544 SASL plug-in what it does with this data.
25545
25546
25547 .option server_mech cyrus_sasl string "see below"
25548 This option selects the authentication mechanism this driver should use. The
25549 default is the value of the generic &%public_name%& option. This option allows
25550 you to use a different underlying mechanism from the advertised name. For
25551 example:
25552 .code
25553 sasl:
25554   driver = cyrus_sasl
25555   public_name = X-ANYTHING
25556   server_mech = CRAM-MD5
25557   server_set_id = $auth1
25558 .endd
25559
25560 .option server_realm cyrus_sasl string&!! unset
25561 This specifies the SASL realm that the server claims to be in.
25562
25563
25564 .option server_service cyrus_sasl string &`smtp`&
25565 This is the SASL service that the server claims to implement.
25566
25567
25568 For straightforward cases, you do not need to set any of the authenticator's
25569 private options. All you need to do is to specify an appropriate mechanism as
25570 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25571 PLAIN, you could have two authenticators as follows:
25572 .code
25573 sasl_cram_md5:
25574   driver = cyrus_sasl
25575   public_name = CRAM-MD5
25576   server_set_id = $auth1
25577
25578 sasl_plain:
25579   driver = cyrus_sasl
25580   public_name = PLAIN
25581   server_set_id = $auth2
25582 .endd
25583 Cyrus SASL does implement the LOGIN authentication method, even though it is
25584 not a standard method. It is disabled by default in the source distribution,
25585 but it is present in many binary distributions.
25586 .ecindex IIDcyrauth1
25587 .ecindex IIDcyrauth2
25588
25589
25590
25591
25592 . ////////////////////////////////////////////////////////////////////////////
25593 . ////////////////////////////////////////////////////////////////////////////
25594 .chapter "The dovecot authenticator" "CHAPdovecot"
25595 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25596 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25597 This authenticator is an interface to the authentication facility of the
25598 Dovecot POP/IMAP server, which can support a number of authentication methods.
25599 Note that Dovecot must be configured to use auth-client not auth-userdb.
25600 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25601 to use the same mechanisms for SMTP authentication. This is a server
25602 authenticator only. There is only one option:
25603
25604 .option server_socket dovecot string unset
25605
25606 This option must specify the socket that is the interface to Dovecot
25607 authentication. The &%public_name%& option must specify an authentication
25608 mechanism that Dovecot is configured to support. You can have several
25609 authenticators for different mechanisms. For example:
25610 .code
25611 dovecot_plain:
25612   driver = dovecot
25613   public_name = PLAIN
25614   server_socket = /var/run/dovecot/auth-client
25615   server_set_id = $auth1
25616
25617 dovecot_ntlm:
25618   driver = dovecot
25619   public_name = NTLM
25620   server_socket = /var/run/dovecot/auth-client
25621   server_set_id = $auth1
25622 .endd
25623 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25624 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25625 option is passed in the Dovecot authentication command. If, for a TLS
25626 connection, a client certificate has been verified, the &"valid-client-cert"&
25627 option is passed. When authentication succeeds, the identity of the user
25628 who authenticated is placed in &$auth1$&.
25629 .ecindex IIDdcotauth1
25630 .ecindex IIDdcotauth2
25631
25632
25633 . ////////////////////////////////////////////////////////////////////////////
25634 . ////////////////////////////////////////////////////////////////////////////
25635 .chapter "The gsasl authenticator" "CHAPgsasl"
25636 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25637 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25638 .cindex "authentication" "GNU SASL"
25639 .cindex "authentication" "SASL"
25640 .cindex "authentication" "EXTERNAL"
25641 .cindex "authentication" "ANONYMOUS"
25642 .cindex "authentication" "PLAIN"
25643 .cindex "authentication" "LOGIN"
25644 .cindex "authentication" "DIGEST-MD5"
25645 .cindex "authentication" "CRAM-MD5"
25646 .cindex "authentication" "SCRAM-SHA-1"
25647 The &(gsasl)& authenticator provides server integration for the GNU SASL
25648 library and the mechanisms it provides.  This is new as of the 4.80 release
25649 and there are a few areas where the library does not let Exim smoothly
25650 scale to handle future authentication mechanisms, so no guarantee can be
25651 made that any particular new authentication mechanism will be supported
25652 without code changes in Exim.
25653
25654
25655 .option server_channelbinding gsasl boolean false
25656 Some authentication mechanisms are able to use external context at both ends
25657 of the session to bind the authentication to that context, and fail the
25658 authentication process if that context differs.  Specifically, some TLS
25659 ciphersuites can provide identifying information about the cryptographic
25660 context.
25661
25662 This means that certificate identity and verification becomes a non-issue,
25663 as a man-in-the-middle attack will cause the correct client and server to
25664 see different identifiers and authentication will fail.
25665
25666 This is currently only supported when using the GnuTLS library.  This is
25667 only usable by mechanisms which support "channel binding"; at time of
25668 writing, that's the SCRAM family.
25669
25670 This defaults off to ensure smooth upgrade across Exim releases, in case
25671 this option causes some clients to start failing.  Some future release
25672 of Exim may switch the default to be true.
25673
25674
25675 .option server_hostname gsasl string&!! "see below"
25676 This option selects the hostname that is used when communicating with the
25677 library. The default value is &`$primary_hostname`&.
25678 Some mechanisms will use this data.
25679
25680
25681 .option server_mech gsasl string "see below"
25682 This option selects the authentication mechanism this driver should use. The
25683 default is the value of the generic &%public_name%& option. This option allows
25684 you to use a different underlying mechanism from the advertised name. For
25685 example:
25686 .code
25687 sasl:
25688   driver = gsasl
25689   public_name = X-ANYTHING
25690   server_mech = CRAM-MD5
25691   server_set_id = $auth1
25692 .endd
25693
25694
25695 .option server_password gsasl string&!! unset
25696 Various mechanisms need access to the cleartext password on the server, so
25697 that proof-of-possession can be demonstrated on the wire, without sending
25698 the password itself.
25699
25700 The data available for lookup varies per mechanism.
25701 In all cases, &$auth1$& is set to the &'authentication id'&.
25702 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25703 if available, else the empty string.
25704 The &$auth3$& variable will always be the &'realm'& if available,
25705 else the empty string.
25706
25707 A forced failure will cause authentication to defer.
25708
25709 If using this option, it may make sense to set the &%server_condition%&
25710 option to be simply "true".
25711
25712
25713 .option server_realm gsasl string&!! unset
25714 This specifies the SASL realm that the server claims to be in.
25715 Some mechanisms will use this data.
25716
25717
25718 .option server_scram_iter gsasl string&!! unset
25719 This option provides data for the SCRAM family of mechanisms.
25720 &$auth1$& is not available at evaluation time.
25721 (This may change, as we receive feedback on use)
25722
25723
25724 .option server_scram_salt gsasl string&!! unset
25725 This option provides data for the SCRAM family of mechanisms.
25726 &$auth1$& is not available at evaluation time.
25727 (This may change, as we receive feedback on use)
25728
25729
25730 .option server_service gsasl string &`smtp`&
25731 This is the SASL service that the server claims to implement.
25732 Some mechanisms will use this data.
25733
25734
25735 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25736 .vindex "&$auth1$&, &$auth2$&, etc"
25737 These may be set when evaluating specific options, as detailed above.
25738 They will also be set when evaluating &%server_condition%&.
25739
25740 Unless otherwise stated below, the &(gsasl)& integration will use the following
25741 meanings for these variables:
25742
25743 .ilist
25744 .vindex "&$auth1$&"
25745 &$auth1$&: the &'authentication id'&
25746 .next
25747 .vindex "&$auth2$&"
25748 &$auth2$&: the &'authorization id'&
25749 .next
25750 .vindex "&$auth3$&"
25751 &$auth3$&: the &'realm'&
25752 .endlist
25753
25754 On a per-mechanism basis:
25755
25756 .ilist
25757 .cindex "authentication" "EXTERNAL"
25758 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25759 the &%server_condition%& option must be present.
25760 .next
25761 .cindex "authentication" "ANONYMOUS"
25762 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25763 the &%server_condition%& option must be present.
25764 .next
25765 .cindex "authentication" "GSSAPI"
25766 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25767 &$auth2$& will be set to the &'authorization id'&,
25768 the &%server_condition%& option must be present.
25769 .endlist
25770
25771 An &'anonymous token'& is something passed along as an unauthenticated
25772 identifier; this is analogous to FTP anonymous authentication passing an
25773 email address, or software-identifier@, as the "password".
25774
25775
25776 An example showing the password having the realm specified in the callback
25777 and demonstrating a Cyrus SASL to GSASL migration approach is:
25778 .code
25779 gsasl_cyrusless_crammd5:
25780   driver = gsasl
25781   public_name = CRAM-MD5
25782   server_realm = imap.example.org
25783   server_password = ${lookup{$auth1:$auth3:userPassword}\
25784                     dbmjz{/etc/sasldb2}{$value}fail}
25785   server_set_id = ${quote:$auth1}
25786   server_condition = yes
25787 .endd
25788
25789
25790 . ////////////////////////////////////////////////////////////////////////////
25791 . ////////////////////////////////////////////////////////////////////////////
25792
25793 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25794 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25795 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25796 .cindex "authentication" "GSSAPI"
25797 .cindex "authentication" "Kerberos"
25798 The &(heimdal_gssapi)& authenticator provides server integration for the
25799 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25800 reliably.
25801
25802 .option server_hostname heimdal_gssapi string&!! "see below"
25803 This option selects the hostname that is used, with &%server_service%&,
25804 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25805 identifier.  The default value is &`$primary_hostname`&.
25806
25807 .option server_keytab heimdal_gssapi string&!! unset
25808 If set, then Heimdal will not use the system default keytab (typically
25809 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25810 The value should be a pathname, with no &"file:"& prefix.
25811
25812 .option server_service heimdal_gssapi string&!! "smtp"
25813 This option specifies the service identifier used, in conjunction with
25814 &%server_hostname%&, for building the identifer for finding credentials
25815 from the keytab.
25816
25817
25818 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25819 Beware that these variables will typically include a realm, thus will appear
25820 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25821 not verified, so a malicious client can set it to anything.
25822
25823 The &$auth1$& field should be safely trustable as a value from the Key
25824 Distribution Center.  Note that these are not quite email addresses.
25825 Each identifier is for a role, and so the left-hand-side may include a
25826 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25827
25828 .vindex "&$auth1$&, &$auth2$&, etc"
25829 .ilist
25830 .vindex "&$auth1$&"
25831 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25832 .next
25833 .vindex "&$auth2$&"
25834 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25835 authentication.  If that was empty, this will also be set to the
25836 GSS Display Name.
25837 .endlist
25838
25839
25840 . ////////////////////////////////////////////////////////////////////////////
25841 . ////////////////////////////////////////////////////////////////////////////
25842
25843 .chapter "The spa authenticator" "CHAPspa"
25844 .scindex IIDspaauth1 "&(spa)& authenticator"
25845 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25846 .cindex "authentication" "Microsoft Secure Password"
25847 .cindex "authentication" "NTLM"
25848 .cindex "Microsoft Secure Password Authentication"
25849 .cindex "NTLM authentication"
25850 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25851 Password Authentication'& mechanism,
25852 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25853 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25854 taken from the Samba project (&url(http://www.samba.org)). The code for the
25855 server side was subsequently contributed by Tom Kistner. The mechanism works as
25856 follows:
25857
25858 .ilist
25859 After the AUTH command has been accepted, the client sends an SPA
25860 authentication request based on the user name and optional domain.
25861 .next
25862 The server sends back a challenge.
25863 .next
25864 The client builds a challenge response which makes use of the user's password
25865 and sends it to the server, which then accepts or rejects it.
25866 .endlist
25867
25868 Encryption is used to protect the password in transit.
25869
25870
25871
25872 .section "Using spa as a server" "SECID179"
25873 .cindex "options" "&(spa)& authenticator (server)"
25874 The &(spa)& authenticator has just one server option:
25875
25876 .option server_password spa string&!! unset
25877 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25878 This option is expanded, and the result must be the cleartext password for the
25879 authenticating user, whose name is at this point in &$auth1$&. For
25880 compatibility with previous releases of Exim, the user name is also placed in
25881 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25882 it can lead to confusion in string expansions that also use numeric variables
25883 for other things. For example:
25884 .code
25885 spa:
25886   driver = spa
25887   public_name = NTLM
25888   server_password = \
25889     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25890 .endd
25891 If the expansion is forced to fail, authentication fails. Any other expansion
25892 failure causes a temporary error code to be returned.
25893
25894
25895
25896
25897
25898 .section "Using spa as a client" "SECID180"
25899 .cindex "options" "&(spa)& authenticator (client)"
25900 The &(spa)& authenticator has the following client options:
25901
25902
25903
25904 .option client_domain spa string&!! unset
25905 This option specifies an optional domain for the authentication.
25906
25907
25908 .option client_password spa string&!! unset
25909 This option specifies the user's password, and must be set.
25910
25911
25912 .option client_username spa string&!! unset
25913 This option specifies the user name, and must be set. Here is an example of a
25914 configuration of this authenticator for use with the mail servers at
25915 &'msn.com'&:
25916 .code
25917 msn:
25918   driver = spa
25919   public_name = MSN
25920   client_username = msn/msn_username
25921   client_password = msn_plaintext_password
25922   client_domain = DOMAIN_OR_UNSET
25923 .endd
25924 .ecindex IIDspaauth1
25925 .ecindex IIDspaauth2
25926
25927
25928
25929
25930
25931 . ////////////////////////////////////////////////////////////////////////////
25932 . ////////////////////////////////////////////////////////////////////////////
25933
25934 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25935          "Encrypted SMTP connections"
25936 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25937 .scindex IIDencsmtp2 "SMTP" "encryption"
25938 .cindex "TLS" "on SMTP connection"
25939 .cindex "OpenSSL"
25940 .cindex "GnuTLS"
25941 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25942 Sockets Layer), is implemented by making use of the OpenSSL library or the
25943 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25944 cryptographic code in the Exim distribution itself for implementing TLS. In
25945 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25946 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25947 You also need to understand the basic concepts of encryption at a managerial
25948 level, and in particular, the way that public keys, private keys, and
25949 certificates are used.
25950
25951 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25952 connection is established, the client issues a STARTTLS command. If the
25953 server accepts this, the client and the server negotiate an encryption
25954 mechanism. If the negotiation succeeds, the data that subsequently passes
25955 between them is encrypted.
25956
25957 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25958 and if so, what cipher suite is in use, whether the client supplied a
25959 certificate, and whether or not that certificate was verified. This makes it
25960 possible for an Exim server to deny or accept certain commands based on the
25961 encryption state.
25962
25963 &*Warning*&: Certain types of firewall and certain anti-virus products can
25964 disrupt TLS connections. You need to turn off SMTP scanning for these products
25965 in order to get TLS to work.
25966
25967
25968
25969 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25970          "SECID284"
25971 .cindex "ssmtp protocol"
25972 .cindex "smtps protocol"
25973 .cindex "SMTP" "ssmtp protocol"
25974 .cindex "SMTP" "smtps protocol"
25975 Early implementations of encrypted SMTP used a different TCP port from normal
25976 SMTP, and expected an encryption negotiation to start immediately, instead of
25977 waiting for a STARTTLS command from the client using the standard SMTP
25978 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25979 allocated for this purpose.
25980
25981 This approach was abandoned when encrypted SMTP was standardized, but there are
25982 still some legacy clients that use it. Exim supports these clients by means of
25983 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25984 numbers; the most common use is expected to be:
25985 .code
25986 tls_on_connect_ports = 465
25987 .endd
25988 The port numbers specified by this option apply to all SMTP connections, both
25989 via the daemon and via &'inetd'&. You still need to specify all the ports that
25990 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25991 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25992 an extra port &-- rather, it specifies different behaviour on a port that is
25993 defined elsewhere.
25994
25995 There is also a &%-tls-on-connect%& command line option. This overrides
25996 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25997
25998
25999
26000
26001
26002
26003 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26004 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26005 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26006 followed later, when the first versions of GnuTLS were released. To build Exim
26007 to use GnuTLS, you need to set
26008 .code
26009 USE_GNUTLS=yes
26010 .endd
26011 in Local/Makefile, in addition to
26012 .code
26013 SUPPORT_TLS=yes
26014 .endd
26015 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26016 include files and libraries for GnuTLS can be found.
26017
26018 There are some differences in usage when using GnuTLS instead of OpenSSL:
26019
26020 .ilist
26021 The &%tls_verify_certificates%& option
26022 cannot be the path of a directory
26023 for GnuTLS versions before 3.3.6
26024 (for later versions, or OpenSSL, it can be either).
26025 .next
26026 The default value for &%tls_dhparam%& differs for historical reasons.
26027 .next
26028 .vindex "&$tls_in_peerdn$&"
26029 .vindex "&$tls_out_peerdn$&"
26030 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26031 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26032 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26033 .next
26034 OpenSSL identifies cipher suites using hyphens as separators, for example:
26035 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26036 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26037 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26038 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26039 to handle its own older variants) when processing lists of cipher suites in the
26040 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26041 option).
26042 .next
26043 The &%tls_require_ciphers%& options operate differently, as described in the
26044 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26045 .next
26046 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26047 When using OpenSSL, this option is ignored.
26048 (If an API is found to let OpenSSL be configured in this way,
26049 let the Exim Maintainers know and we'll likely use it).
26050 .next
26051 Some other recently added features may only be available in one or the other.
26052 This should be documented with the feature.  If the documentation does not
26053 explicitly state that the feature is infeasible in the other TLS
26054 implementation, then patches are welcome.
26055 .endlist
26056
26057
26058 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26059 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26060 an explicit path; if the latter, then the text about generation still applies,
26061 but not the chosen filename.
26062 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26063 See the documentation of &%tls_dhparam%& for more information.
26064
26065 GnuTLS uses D-H parameters that may take a substantial amount of time
26066 to compute. It is unreasonable to re-compute them for every TLS session.
26067 Therefore, Exim keeps this data in a file in its spool directory, called
26068 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26069 of bits requested.
26070 The file is owned by the Exim user and is readable only by
26071 its owner. Every Exim process that start up GnuTLS reads the D-H
26072 parameters from this file. If the file does not exist, the first Exim process
26073 that needs it computes the data and writes it to a temporary file which is
26074 renamed once it is complete. It does not matter if several Exim processes do
26075 this simultaneously (apart from wasting a few resources). Once a file is in
26076 place, new Exim processes immediately start using it.
26077
26078 For maximum security, the parameters that are stored in this file should be
26079 recalculated periodically, the frequency depending on your paranoia level.
26080 If you are avoiding using the fixed D-H primes published in RFCs, then you
26081 are concerned about some advanced attacks and will wish to do this; if you do
26082 not regenerate then you might as well stick to the standard primes.
26083
26084 Arranging this is easy in principle; just delete the file when you want new
26085 values to be computed. However, there may be a problem. The calculation of new
26086 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26087 If the system is not very active, &_/dev/random_& may delay returning data
26088 until enough randomness (entropy) is available. This may cause Exim to hang for
26089 a substantial amount of time, causing timeouts on incoming connections.
26090
26091 The solution is to generate the parameters externally to Exim. They are stored
26092 in &_gnutls-params-N_& in PEM format, which means that they can be
26093 generated externally using the &(certtool)& command that is part of GnuTLS.
26094
26095 To replace the parameters with new ones, instead of deleting the file
26096 and letting Exim re-create it, you can generate new parameters using
26097 &(certtool)& and, when this has been done, replace Exim's cache file by
26098 renaming. The relevant commands are something like this:
26099 .code
26100 # ls
26101 [ look for file; assume gnutls-params-2236 is the most recent ]
26102 # rm -f new-params
26103 # touch new-params
26104 # chown exim:exim new-params
26105 # chmod 0600 new-params
26106 # certtool --generate-dh-params --bits 2236 >>new-params
26107 # openssl dhparam -noout -text -in new-params | head
26108 [ check the first line, make sure it's not more than 2236;
26109   if it is, then go back to the start ("rm") and repeat
26110   until the size generated is at most the size requested ]
26111 # chmod 0400 new-params
26112 # mv new-params gnutls-params-2236
26113 .endd
26114 If Exim never has to generate the parameters itself, the possibility of
26115 stalling is removed.
26116
26117 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26118 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26119 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26120 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26121 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26122 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26123 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26124 which applies to all D-H usage, client or server.  If the value returned by
26125 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26126 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26127 limit, which is still much higher than Exim historically used.
26128
26129 The filename and bits used will change as the GnuTLS maintainers change the
26130 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26131 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26132 2432 bits, while NSS is limited to 2236 bits.
26133
26134 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26135 increase the chance of the generated prime actually being within acceptable
26136 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26137 procedure above.  There is no sane procedure available to Exim to double-check
26138 the size of the generated prime, so it might still be too large.
26139
26140
26141 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26142 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26143 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26144 There is a function in the OpenSSL library that can be passed a list of cipher
26145 suites before the cipher negotiation takes place. This specifies which ciphers
26146 are acceptable. The list is colon separated and may contain names like
26147 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26148 directly to this function call.
26149 Many systems will install the OpenSSL manual-pages, so you may have
26150 &'ciphers(1)'& available to you.
26151 The following quotation from the OpenSSL
26152 documentation specifies what forms of item are allowed in the cipher string:
26153
26154 .ilist
26155 It can consist of a single cipher suite such as RC4-SHA.
26156 .next
26157 It can represent a list of cipher suites containing a certain algorithm,
26158 or cipher suites of a certain type. For example SHA1 represents all
26159 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26160 SSL v3 algorithms.
26161 .next
26162 Lists of cipher suites can be combined in a single cipher string using
26163 the + character. This is used as a logical and operation. For example
26164 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26165 algorithms.
26166 .endlist
26167
26168 Each cipher string can be optionally preceded by one of the characters &`!`&,
26169 &`-`& or &`+`&.
26170 .ilist
26171 If &`!`& is used, the ciphers are permanently deleted from the list. The
26172 ciphers deleted can never reappear in the list even if they are explicitly
26173 stated.
26174 .next
26175 If &`-`& is used, the ciphers are deleted from the list, but some or all
26176 of the ciphers can be added again by later options.
26177 .next
26178 If &`+`& is used, the ciphers are moved to the end of the list. This
26179 option does not add any new ciphers; it just moves matching existing ones.
26180 .endlist
26181
26182 If none of these characters is present, the string is interpreted as
26183 a list of ciphers to be appended to the current preference list. If the list
26184 includes any ciphers already present they will be ignored: that is, they will
26185 not be moved to the end of the list.
26186 .endlist
26187
26188 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26189 string:
26190 .code
26191 # note single-quotes to get ! past any shell history expansion
26192 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26193 .endd
26194
26195 This example will let the library defaults be permitted on the MX port, where
26196 there's probably no identity verification anyway, but ups the ante on the
26197 submission ports where the administrator might have some influence on the
26198 choice of clients used:
26199 .code
26200 # OpenSSL variant; see man ciphers(1)
26201 tls_require_ciphers = ${if =={$received_port}{25}\
26202                            {DEFAULT}\
26203                            {HIGH:!MD5:!SHA1}}
26204 .endd
26205
26206
26207
26208 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26209          "SECTreqciphgnu"
26210 .cindex "GnuTLS" "specifying parameters for"
26211 .cindex "TLS" "specifying ciphers (GnuTLS)"
26212 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26213 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26214 .cindex "TLS" "specifying protocols (GnuTLS)"
26215 .cindex "TLS" "specifying priority string (GnuTLS)"
26216 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26217 The GnuTLS library allows the caller to provide a "priority string", documented
26218 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26219 ciphersuite specification in OpenSSL.
26220
26221 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26222 and controls both protocols and ciphers.
26223
26224 The &%tls_require_ciphers%& option is available both as an global option,
26225 controlling how Exim behaves as a server, and also as an option of the
26226 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26227 the value is string expanded.  The resulting string is not an Exim list and
26228 the string is given to the GnuTLS library, so that Exim does not need to be
26229 aware of future feature enhancements of GnuTLS.
26230
26231 Documentation of the strings accepted may be found in the GnuTLS manual, under
26232 "Priority strings".  This is online as
26233 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26234 but beware that this relates to GnuTLS 3, which may be newer than the version
26235 installed on your system.  If you are using GnuTLS 3,
26236 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26237 on that site can be used to test a given string.
26238
26239 For example:
26240 .code
26241 # Disable older versions of protocols
26242 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26243 .endd
26244
26245 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26246 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26247 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26248
26249 This example will let the library defaults be permitted on the MX port, where
26250 there's probably no identity verification anyway, and lowers security further
26251 by increasing compatibility; but this ups the ante on the submission ports
26252 where the administrator might have some influence on the choice of clients
26253 used:
26254 .code
26255 # GnuTLS variant
26256 tls_require_ciphers = ${if =={$received_port}{25}\
26257                            {NORMAL:%COMPAT}\
26258                            {SECURE128}}
26259 .endd
26260
26261
26262 .section "Configuring an Exim server to use TLS" "SECID182"
26263 .cindex "TLS" "configuring an Exim server"
26264 When Exim has been built with TLS support, it advertises the availability of
26265 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26266 but not to any others. The default value of this option is unset, which means
26267 that STARTTLS is not advertised at all. This default is chosen because you
26268 need to set some other options in order to make TLS available, and also it is
26269 sensible for systems that want to use TLS only as a client.
26270
26271 If a client issues a STARTTLS command and there is some configuration
26272 problem in the server, the command is rejected with a 454 error. If the client
26273 persists in trying to issue SMTP commands, all except QUIT are rejected
26274 with the error
26275 .code
26276 554 Security failure
26277 .endd
26278 If a STARTTLS command is issued within an existing TLS session, it is
26279 rejected with a 554 error code.
26280
26281 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26282 match some hosts. You can, of course, set it to * to match all hosts.
26283 However, this is not all you need to do. TLS sessions to a server won't work
26284 without some further configuration at the server end.
26285
26286 It is rumoured that all existing clients that support TLS/SSL use RSA
26287 encryption. To make this work you need to set, in the server,
26288 .code
26289 tls_certificate = /some/file/name
26290 tls_privatekey = /some/file/name
26291 .endd
26292 These options are, in fact, expanded strings, so you can make them depend on
26293 the identity of the client that is connected if you wish. The first file
26294 contains the server's X509 certificate, and the second contains the private key
26295 that goes with it. These files need to be
26296 PEM format and readable by the Exim user, and must
26297 always be given as full path names.
26298 The key must not be password-protected.
26299 They can be the same file if both the
26300 certificate and the key are contained within it. If &%tls_privatekey%& is not
26301 set, or if its expansion is forced to fail or results in an empty string, this
26302 is assumed to be the case. The certificate file may also contain intermediate
26303 certificates that need to be sent to the client to enable it to authenticate
26304 the server's certificate.
26305
26306 If you do not understand about certificates and keys, please try to find a
26307 source of this background information, which is not Exim-specific. (There are a
26308 few comments below in section &<<SECTcerandall>>&.)
26309
26310 &*Note*&: These options do not apply when Exim is operating as a client &--
26311 they apply only in the case of a server. If you need to use a certificate in an
26312 Exim client, you must set the options of the same names in an &(smtp)&
26313 transport.
26314
26315 With just these options, an Exim server will be able to use TLS. It does not
26316 require the client to have a certificate (but see below for how to insist on
26317 this). There is one other option that may be needed in other situations. If
26318 .code
26319 tls_dhparam = /some/file/name
26320 .endd
26321 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26322 with the parameters contained in the file.
26323 Set this to &`none`& to disable use of DH entirely, by making no prime
26324 available:
26325 .code
26326 tls_dhparam = none
26327 .endd
26328 This may also be set to a string identifying a standard prime to be used for
26329 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26330 used is &`ike23`&.  There are a few standard primes available, see the
26331 documentation for &%tls_dhparam%& for the complete list.
26332
26333 See the command
26334 .code
26335 openssl dhparam
26336 .endd
26337 for a way of generating file data.
26338
26339 The strings supplied for these three options are expanded every time a client
26340 host connects. It is therefore possible to use different certificates and keys
26341 for different hosts, if you so wish, by making use of the client's IP address
26342 in &$sender_host_address$& to control the expansion. If a string expansion is
26343 forced to fail, Exim behaves as if the option is not set.
26344
26345 .cindex "cipher" "logging"
26346 .cindex "log" "TLS cipher"
26347 .vindex "&$tls_in_cipher$&"
26348 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26349 an incoming TLS connection. It is included in the &'Received:'& header of an
26350 incoming message (by default &-- you can, of course, change this), and it is
26351 also included in the log line that records a message's arrival, keyed by
26352 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26353 condition can be used to test for specific cipher suites in ACLs.
26354
26355 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26356 can check the name of the cipher suite and vary their actions accordingly. The
26357 cipher suite names vary, depending on which TLS library is being used. For
26358 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26359 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26360 documentation for more details.
26361
26362 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26363 (again depending on the &%tls_cipher%& log selector).
26364
26365
26366 .section "Requesting and verifying client certificates" "SECID183"
26367 .cindex "certificate" "verification of client"
26368 .cindex "TLS" "client certificate verification"
26369 If you want an Exim server to request a certificate when negotiating a TLS
26370 session with a client, you must set either &%tls_verify_hosts%& or
26371 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26372 apply to all TLS connections. For any host that matches one of these options,
26373 Exim requests a certificate as part of the setup of the TLS session. The
26374 contents of the certificate are verified by comparing it with a list of
26375 expected certificates.
26376 These may be the system default set (depending on library version),
26377 an explicit file or,
26378 depending on library version, a directory, identified by
26379 &%tls_verify_certificates%&.
26380
26381 A file can contain multiple certificates, concatenated end to end. If a
26382 directory is used
26383 (OpenSSL only),
26384 each certificate must be in a separate file, with a name (or a symbolic link)
26385 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26386 certificate. You can compute the relevant hash by running the command
26387 .code
26388 openssl x509 -hash -noout -in /cert/file
26389 .endd
26390 where &_/cert/file_& contains a single certificate.
26391
26392 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26393 what happens if the client does not supply a certificate, or if the certificate
26394 does not match any of the certificates in the collection named by
26395 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26396 attempt to set up a TLS session is aborted, and the incoming connection is
26397 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26398 session continues. ACLs that run for subsequent SMTP commands can detect the
26399 fact that no certificate was verified, and vary their actions accordingly. For
26400 example, you can insist on a certificate before accepting a message for
26401 relaying, but not when the message is destined for local delivery.
26402
26403 .vindex "&$tls_in_peerdn$&"
26404 When a client supplies a certificate (whether it verifies or not), the value of
26405 the Distinguished Name of the certificate is made available in the variable
26406 &$tls_in_peerdn$& during subsequent processing of the message.
26407
26408 .cindex "log" "distinguished name"
26409 Because it is often a long text string, it is not included in the log line or
26410 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26411 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26412 &%received_header_text%& to change the &'Received:'& header. When no
26413 certificate is supplied, &$tls_in_peerdn$& is empty.
26414
26415
26416 .section "Revoked certificates" "SECID184"
26417 .cindex "TLS" "revoked certificates"
26418 .cindex "revocation list"
26419 .cindex "certificate" "revocation list"
26420 .cindex "OCSP" "stapling"
26421 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26422 certificates are revoked. If you have such a list, you can pass it to an Exim
26423 server using the global option called &%tls_crl%& and to an Exim client using
26424 an identically named option for the &(smtp)& transport. In each case, the value
26425 of the option is expanded and must then be the name of a file that contains a
26426 CRL in PEM format.
26427 The downside is that clients have to periodically re-download a potentially huge
26428 file from every certificate authority they know of.
26429
26430 The way with most moving parts at query time is Online Certificate
26431 Status Protocol (OCSP), where the client verifies the certificate
26432 against an OCSP server run by the CA.  This lets the CA track all
26433 usage of the certs.  It requires running software with access to the
26434 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26435 is based on HTTP and can be proxied accordingly.
26436
26437 The only widespread OCSP server implementation (known to this writer)
26438 comes as part of OpenSSL and aborts on an invalid request, such as
26439 connecting to the port and then disconnecting.  This requires
26440 re-entering the passphrase each time some random client does this.
26441
26442 The third way is OCSP Stapling; in this, the server using a certificate
26443 issued by the CA periodically requests an OCSP proof of validity from
26444 the OCSP server, then serves it up inline as part of the TLS
26445 negotiation.   This approach adds no extra round trips, does not let the
26446 CA track users, scales well with number of certs issued by the CA and is
26447 resilient to temporary OCSP server failures, as long as the server
26448 starts retrying to fetch an OCSP proof some time before its current
26449 proof expires.  The downside is that it requires server support.
26450
26451 Unless Exim is built with the support disabled,
26452 or with GnuTLS earlier than version 3.1.3,
26453 support for OCSP stapling is included.
26454
26455 There is a global option called &%tls_ocsp_file%&.
26456 The file specified therein is expected to be in DER format, and contain
26457 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26458 option will be re-expanded for SNI, if the &%tls_certificate%& option
26459 contains &`tls_in_sni`&, as per other TLS options.
26460
26461 Exim does not at this time implement any support for fetching a new OCSP
26462 proof.  The burden is on the administrator to handle this, outside of
26463 Exim.  The file specified should be replaced atomically, so that the
26464 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26465 on each connection, so a new file will be handled transparently on the
26466 next connection.
26467
26468 When built with OpenSSL Exim will check for a valid next update timestamp
26469 in the OCSP proof; if not present, or if the proof has expired, it will be
26470 ignored.
26471
26472 For the client to be able to verify the stapled OCSP the server must
26473 also supply, in its stapled information, any intermediate
26474 certificates for the chain leading to the OCSP proof from the signer
26475 of the server certificate.  There may be zero or one such. These
26476 intermediate certificates should be added to the server OCSP stapling
26477 file named by &%tls_ocsp_file%&.
26478
26479 Note that the proof only covers the terminal server certificate,
26480 not any of the chain from CA to it.
26481
26482 There is no current way to staple a proof for a client certificate.
26483
26484 .code
26485   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26486   OCSP server is supplied.  The server URL may be included in the
26487   server certificate, if the CA is helpful.
26488
26489   One failure mode seen was the OCSP Signer cert expiring before the end
26490   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26491   noted this as invalid overall, but the re-fetch script did not.
26492 .endd
26493
26494
26495
26496
26497 .section "Configuring an Exim client to use TLS" "SECID185"
26498 .cindex "cipher" "logging"
26499 .cindex "log" "TLS cipher"
26500 .cindex "log" "distinguished name"
26501 .cindex "TLS" "configuring an Exim client"
26502 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26503 deliveries as well as to incoming, the latter one causing logging of the
26504 server certificate's DN. The remaining client configuration for TLS is all
26505 within the &(smtp)& transport.
26506
26507 It is not necessary to set any options to have TLS work in the &(smtp)&
26508 transport. If Exim is built with TLS support, and TLS is advertised by a
26509 server, the &(smtp)& transport always tries to start a TLS session. However,
26510 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26511 transport) to a list of server hosts for which TLS should not be used.
26512
26513 If you do not want Exim to attempt to send messages unencrypted when an attempt
26514 to set up an encrypted connection fails in any way, you can set
26515 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26516 those hosts, delivery is always deferred if an encrypted connection cannot be
26517 set up. If there are any other hosts for the address, they are tried in the
26518 usual way.
26519
26520 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26521 the message unencrypted. It always does this if the response to STARTTLS is
26522 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26523 session after a success response code, what happens is controlled by the
26524 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26525 delivery to this host is deferred, and other hosts (if available) are tried. If
26526 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26527 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26528 negotiation fails, Exim closes the current connection (because it is in an
26529 unknown state), opens a new one to the same host, and then tries the delivery
26530 unencrypted.
26531
26532 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26533 transport provide the client with a certificate, which is passed to the server
26534 if it requests it. If the server is Exim, it will request a certificate only if
26535 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26536
26537 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26538 specifies a collection of expected server certificates.
26539 These may be the system default set (depeding on library version),
26540 a file or,
26541 depnding on liibrary version, a directory,
26542 must name a file or,
26543 for OpenSSL only (not GnuTLS), a directory.
26544 The client verifies the server's certificate
26545 against this collection, taking into account any revoked certificates that are
26546 in the list defined by &%tls_crl%&.
26547 Failure to verify fails the TLS connection unless either of the
26548 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26549
26550 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26551 certificate verification to the listed servers.  Verification either must
26552 or need not succeed respectively.
26553
26554 The &(smtp)& transport has two OCSP-related options:
26555 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26556 is requested and required for the connection to proceed.  The default
26557 value is empty.
26558 &%hosts_request_ocsp%&; a host-list for which (additionally)
26559 a Certificate Status is requested (but not necessarily verified).  The default
26560 value is "*" meaning that requests are made unless configured
26561 otherwise.
26562
26563 The host(s) should also be in &%hosts_require_tls%&, and
26564 &%tls_verify_certificates%& configured for the transport,
26565 for OCSP to be relevant.
26566
26567 If
26568 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26569 list of permitted cipher suites. If either of these checks fails, delivery to
26570 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26571 alternative hosts, if any.
26572
26573  &*Note*&:
26574 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26575 is operating as a client. Exim does not assume that a server certificate (set
26576 by the global options of the same name) should also be used when operating as a
26577 client.
26578
26579 .vindex "&$host$&"
26580 .vindex "&$host_address$&"
26581 All the TLS options in the &(smtp)& transport are expanded before use, with
26582 &$host$& and &$host_address$& containing the name and address of the server to
26583 which the client is connected. Forced failure of an expansion causes Exim to
26584 behave as if the relevant option were unset.
26585
26586 .vindex &$tls_out_bits$&
26587 .vindex &$tls_out_cipher$&
26588 .vindex &$tls_out_peerdn$&
26589 .vindex &$tls_out_sni$&
26590 Before an SMTP connection is established, the
26591 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26592 variables are emptied. (Until the first connection, they contain the values
26593 that were set when the message was received.) If STARTTLS is subsequently
26594 successfully obeyed, these variables are set to the relevant values for the
26595 outgoing connection.
26596
26597
26598
26599 .section "Use of TLS Server Name Indication" "SECTtlssni"
26600 .cindex "TLS" "Server Name Indication"
26601 .vindex "&$tls_in_sni$&"
26602 .oindex "&%tls_in_sni%&"
26603 With TLS1.0 or above, there is an extension mechanism by which extra
26604 information can be included at various points in the protocol.  One of these
26605 extensions, documented in RFC 6066 (and before that RFC 4366) is
26606 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26607 client in the initial handshake, so that the server can examine the servername
26608 within and possibly choose to use different certificates and keys (and more)
26609 for this session.
26610
26611 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26612 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26613 address.
26614
26615 With SMTP to MX, there are the same problems here as in choosing the identity
26616 against which to validate a certificate: you can't rely on insecure DNS to
26617 provide the identity which you then cryptographically verify.  So this will
26618 be of limited use in that environment.
26619
26620 With SMTP to Submission, there is a well-defined hostname which clients are
26621 connecting to and can validate certificates against.  Thus clients &*can*&
26622 choose to include this information in the TLS negotiation.  If this becomes
26623 wide-spread, then hosters can choose to present different certificates to
26624 different clients.  Or even negotiate different cipher suites.
26625
26626 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26627 if not empty, will be sent on a TLS session as part of the handshake.  There's
26628 nothing more to it.  Choosing a sensible value not derived insecurely is the
26629 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26630 for the lifetime of the client connection (including during authentication).
26631
26632 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26633 received from a client.
26634 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26635
26636 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26637 option (prior to expansion) then the following options will be re-expanded
26638 during TLS session handshake, to permit alternative values to be chosen:
26639
26640 .ilist
26641 .vindex "&%tls_certificate%&"
26642 &%tls_certificate%&
26643 .next
26644 .vindex "&%tls_crl%&"
26645 &%tls_crl%&
26646 .next
26647 .vindex "&%tls_privatekey%&"
26648 &%tls_privatekey%&
26649 .next
26650 .vindex "&%tls_verify_certificates%&"
26651 &%tls_verify_certificates%&
26652 .next
26653 .vindex "&%tls_ocsp_file%&"
26654 &%tls_ocsp_file%&
26655 .endlist
26656
26657 Great care should be taken to deal with matters of case, various injection
26658 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26659 can always be referenced; it is important to remember that &$tls_sni$& is
26660 arbitrary unverified data provided prior to authentication.
26661
26662 The Exim developers are proceeding cautiously and so far no other TLS options
26663 are re-expanded.
26664
26665 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26666 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26667 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26668 see &`-servername`& in the output, then OpenSSL has support.
26669
26670 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26671 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26672 built, then you have SNI support).
26673
26674
26675
26676 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26677          "SECTmulmessam"
26678 .cindex "multiple SMTP deliveries with TLS"
26679 .cindex "TLS" "multiple message deliveries"
26680 Exim sends multiple messages down the same TCP/IP connection by starting up
26681 an entirely new delivery process for each message, passing the socket from
26682 one process to the next. This implementation does not fit well with the use
26683 of TLS, because there is quite a lot of state information associated with a TLS
26684 connection, not just a socket identification. Passing all the state information
26685 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26686 session before passing the socket to a new process. The new process may then
26687 try to start a new TLS session, and if successful, may try to re-authenticate
26688 if AUTH is in use, before sending the next message.
26689
26690 The RFC is not clear as to whether or not an SMTP session continues in clear
26691 after TLS has been shut down, or whether TLS may be restarted again later, as
26692 just described. However, if the server is Exim, this shutdown and
26693 reinitialization works. It is not known which (if any) other servers operate
26694 successfully if the client closes a TLS session and continues with unencrypted
26695 SMTP, but there are certainly some that do not work. For such servers, Exim
26696 should not pass the socket to another process, because the failure of the
26697 subsequent attempt to use it would cause Exim to record a temporary host error,
26698 and delay other deliveries to that host.
26699
26700 To test for this case, Exim sends an EHLO command to the server after
26701 closing down the TLS session. If this fails in any way, the connection is
26702 closed instead of being passed to a new delivery process, but no retry
26703 information is recorded.
26704
26705 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26706 &(smtp)& transport to match those hosts for which Exim should not pass
26707 connections to new processes if TLS has been used.
26708
26709
26710
26711
26712 .section "Certificates and all that" "SECTcerandall"
26713 .cindex "certificate" "references to discussion"
26714 In order to understand fully how TLS works, you need to know about
26715 certificates, certificate signing, and certificate authorities. This is not the
26716 place to give a tutorial, especially as I do not know very much about it
26717 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26718 to Apache, currently at
26719 .display
26720 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26721 .endd
26722 Other parts of the &'modssl'& documentation are also helpful, and have
26723 links to further files.
26724 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26725 0-201-61598-3), contains both introductory and more in-depth descriptions.
26726 Some sample programs taken from the book are available from
26727 .display
26728 &url(http://www.rtfm.com/openssl-examples/)
26729 .endd
26730
26731
26732 .section "Certificate chains" "SECID186"
26733 The file named by &%tls_certificate%& may contain more than one
26734 certificate. This is useful in the case where the certificate that is being
26735 sent is validated by an intermediate certificate which the other end does
26736 not have. Multiple certificates must be in the correct order in the file.
26737 First the host's certificate itself, then the first intermediate
26738 certificate to validate the issuer of the host certificate, then the next
26739 intermediate certificate to validate the issuer of the first intermediate
26740 certificate, and so on, until finally (optionally) the root certificate.
26741 The root certificate must already be trusted by the recipient for
26742 validation to succeed, of course, but if it's not preinstalled, sending the
26743 root certificate along with the rest makes it available for the user to
26744 install if the receiving end is a client MUA that can interact with a user.
26745
26746 Note that certificates using MD5 are unlikely to work on today's Internet;
26747 even if your libraries allow loading them for use in Exim when acting as a
26748 server, increasingly clients will not accept such certificates.  The error
26749 diagnostics in such a case can be frustratingly vague.
26750
26751
26752
26753 .section "Self-signed certificates" "SECID187"
26754 .cindex "certificate" "self-signed"
26755 You can create a self-signed certificate using the &'req'& command provided
26756 with OpenSSL, like this:
26757 . ==== Do not shorten the duration here without reading and considering
26758 . ==== the text below.  Please leave it at 9999 days.
26759 .code
26760 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26761             -days 9999 -nodes
26762 .endd
26763 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26764 delimited and so can be identified independently. The &%-days%& option
26765 specifies a period for which the certificate is valid. The &%-nodes%& option is
26766 important: if you do not set it, the key is encrypted with a passphrase
26767 that you are prompted for, and any use that is made of the key causes more
26768 prompting for the passphrase. This is not helpful if you are going to use
26769 this certificate and key in an MTA, where prompting is not possible.
26770
26771 . ==== I expect to still be working 26 years from now.  The less technical
26772 . ==== debt I create, in terms of storing up trouble for my later years, the
26773 . ==== happier I will be then.  We really have reached the point where we
26774 . ==== should start, at the very least, provoking thought and making folks
26775 . ==== pause before proceeding, instead of leaving all the fixes until two
26776 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26777 . ==== -pdp, 2012
26778 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26779 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26780 the above command might produce a date in the past.  Think carefully about
26781 the lifetime of the systems you're deploying, and either reduce the duration
26782 of the certificate or reconsider your platform deployment.  (At time of
26783 writing, reducing the duration is the most likely choice, but the inexorable
26784 progression of time takes us steadily towards an era where this will not
26785 be a sensible resolution).
26786
26787 A self-signed certificate made in this way is sufficient for testing, and
26788 may be adequate for all your requirements if you are mainly interested in
26789 encrypting transfers, and not in secure identification.
26790
26791 However, many clients require that the certificate presented by the server be a
26792 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26793 certificate. In this situation, the self-signed certificate described above
26794 must be installed on the client host as a trusted root &'certification
26795 authority'& (CA), and the certificate used by Exim must be a user certificate
26796 signed with that self-signed certificate.
26797
26798 For information on creating self-signed CA certificates and using them to sign
26799 user certificates, see the &'General implementation overview'& chapter of the
26800 Open-source PKI book, available online at
26801 &url(http://ospkibook.sourceforge.net/).
26802 .ecindex IIDencsmtp1
26803 .ecindex IIDencsmtp2
26804
26805
26806
26807 . ////////////////////////////////////////////////////////////////////////////
26808 . ////////////////////////////////////////////////////////////////////////////
26809
26810 .chapter "Access control lists" "CHAPACL"
26811 .scindex IIDacl "&ACL;" "description"
26812 .cindex "control of incoming mail"
26813 .cindex "message" "controlling incoming"
26814 .cindex "policy control" "access control lists"
26815 Access Control Lists (ACLs) are defined in a separate section of the run time
26816 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26817 name, terminated by a colon. Here is a complete ACL section that contains just
26818 one very small ACL:
26819 .code
26820 begin acl
26821 small_acl:
26822   accept   hosts = one.host.only
26823 .endd
26824 You can have as many lists as you like in the ACL section, and the order in
26825 which they appear does not matter. The lists are self-terminating.
26826
26827 The majority of ACLs are used to control Exim's behaviour when it receives
26828 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26829 when a local process submits a message using SMTP by specifying the &%-bs%&
26830 option. The most common use is for controlling which recipients are accepted
26831 in incoming messages. In addition, you can define an ACL that is used to check
26832 local non-SMTP messages. The default configuration file contains an example of
26833 a realistic ACL for checking RCPT commands. This is discussed in chapter
26834 &<<CHAPdefconfil>>&.
26835
26836
26837 .section "Testing ACLs" "SECID188"
26838 The &%-bh%& command line option provides a way of testing your ACL
26839 configuration locally by running a fake SMTP session with which you interact.
26840 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26841 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26842
26843
26844
26845 .section "Specifying when ACLs are used" "SECID189"
26846 .cindex "&ACL;" "options for specifying"
26847 In order to cause an ACL to be used, you have to name it in one of the relevant
26848 options in the main part of the configuration. These options are:
26849 .cindex "AUTH" "ACL for"
26850 .cindex "DATA" "ACLs for"
26851 .cindex "ETRN" "ACL for"
26852 .cindex "EXPN" "ACL for"
26853 .cindex "HELO" "ACL for"
26854 .cindex "EHLO" "ACL for"
26855 .cindex "MAIL" "ACL for"
26856 .cindex "QUIT, ACL for"
26857 .cindex "RCPT" "ACL for"
26858 .cindex "STARTTLS, ACL for"
26859 .cindex "VRFY" "ACL for"
26860 .cindex "SMTP" "connection, ACL for"
26861 .cindex "non-SMTP messages" "ACLs for"
26862 .cindex "MIME content scanning" "ACL for"
26863 .cindex "PRDR" "ACL for"
26864
26865 .table2 140pt
26866 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26867 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26868 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26869 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26870 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26871 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26872 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26873 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26874 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26875 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26876 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26877 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26878 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26879 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26880 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26881 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26882 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26883 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26884 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26885 .endtable
26886
26887 For example, if you set
26888 .code
26889 acl_smtp_rcpt = small_acl
26890 .endd
26891 the little ACL defined above is used whenever Exim receives a RCPT command
26892 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26893 done when RCPT commands arrive. A rejection of RCPT should cause the
26894 sending MTA to give up on the recipient address contained in the RCPT
26895 command, whereas rejection at other times may cause the client MTA to keep on
26896 trying to deliver the message. It is therefore recommended that you do as much
26897 testing as possible at RCPT time.
26898
26899
26900 .section "The non-SMTP ACLs" "SECID190"
26901 .cindex "non-SMTP messages" "ACLs for"
26902 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26903 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26904 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26905 the state of the SMTP connection such as encryption and authentication) are not
26906 relevant and are forbidden in these ACLs. However, the sender and recipients
26907 are known, so the &%senders%& and &%sender_domains%& conditions and the
26908 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26909 &$authenticated_sender$& are also available. You can specify added header lines
26910 in any of these ACLs.
26911
26912 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26913 non-SMTP message, before any of the message has been read. (This is the
26914 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26915 batched SMTP input, it runs after the DATA command has been reached. The
26916 result of this ACL is ignored; it cannot be used to reject a message. If you
26917 really need to, you could set a value in an ACL variable here and reject based
26918 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26919 controls, and in particular, it can be used to set
26920 .code
26921 control = suppress_local_fixups
26922 .endd
26923 This cannot be used in the other non-SMTP ACLs because by the time they are
26924 run, it is too late.
26925
26926 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26927 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26928
26929 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26930 kind of rejection is treated as permanent, because there is no way of sending a
26931 temporary error for these kinds of message.
26932
26933
26934 .section "The SMTP connect ACL" "SECID191"
26935 .cindex "SMTP" "connection, ACL for"
26936 .oindex &%smtp_banner%&
26937 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26938 session, after the test specified by &%host_reject_connection%& (which is now
26939 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26940 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26941 the message override the banner message that is otherwise specified by the
26942 &%smtp_banner%& option.
26943
26944
26945 .section "The EHLO/HELO ACL" "SECID192"
26946 .cindex "EHLO" "ACL for"
26947 .cindex "HELO" "ACL for"
26948 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26949 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26950 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26951 Note that a client may issue more than one EHLO or HELO command in an SMTP
26952 session, and indeed is required to issue a new EHLO or HELO after successfully
26953 setting up encryption following a STARTTLS command.
26954
26955 If the command is accepted by an &%accept%& verb that has a &%message%&
26956 modifier, the message may not contain more than one line (it will be truncated
26957 at the first newline and a panic logged if it does). Such a message cannot
26958 affect the EHLO options that are listed on the second and subsequent lines of
26959 an EHLO response.
26960
26961
26962 .section "The DATA ACLs" "SECID193"
26963 .cindex "DATA" "ACLs for"
26964 Two ACLs are associated with the DATA command, because it is two-stage
26965 command, with two responses being sent to the client.
26966 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26967 is obeyed. This gives you control after all the RCPT commands, but before
26968 the message itself is received. It offers the opportunity to give a negative
26969 response to the DATA command before the data is transmitted. Header lines
26970 added by MAIL or RCPT ACLs are not visible at this time, but any that
26971 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26972
26973 You cannot test the contents of the message, for example, to verify addresses
26974 in the headers, at RCPT time or when the DATA command is received. Such
26975 tests have to appear in the ACL that is run after the message itself has been
26976 received, before the final response to the DATA command is sent. This is
26977 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26978 associated with the DATA command.
26979
26980 For both of these ACLs, it is not possible to reject individual recipients. An
26981 error response rejects the entire message. Unfortunately, it is known that some
26982 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26983 before or after the data) correctly &-- they keep the message on their queues
26984 and try again later, but that is their problem, though it does waste some of
26985 your resources.
26986
26987 The &%acl_smtp_data%& ACL is run after
26988 the &%acl_smtp_data_prdr%&,
26989 the &%acl_smtp_dkim%&
26990 and the &%acl_smtp_mime%& ACLs.
26991
26992 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26993 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26994 enabled (which is the default).
26995
26996 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26997 received, and is executed for each DKIM signature found in a message.  If not
26998 otherwise specified, the default action is to accept.
26999
27000 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27001
27002 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27003
27004
27005 .section "The SMTP MIME ACL" "SECID194"
27006 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27007 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27008
27009 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27010
27011
27012 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27013 .cindex "PRDR" "ACL for"
27014 .oindex "&%prdr_enable%&"
27015 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27016 with PRDR support enabled (which is the default).
27017 It becomes active only when the PRDR feature is negotiated between
27018 client and server for a message, and more than one recipient
27019 has been accepted.
27020
27021 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27022 has been recieved, and is executed once for each recipient of the message
27023 with &$local_part$& and &$domain$& valid.
27024 The test may accept, defer or deny for inividual recipients.
27025 The &%acl_smtp_data%& will still be called after this ACL and
27026 can reject the message overall, even if this ACL has accepted it
27027 for some or all recipients.
27028
27029 PRDR may be used to support per-user content filtering.  Without it
27030 one must defer any recipient after the first that has a different
27031 content-filter configuration.  With PRDR, the RCPT-time check
27032 for this can be disabled when the MAIL-time $smtp_command included
27033 "PRDR".  Any required difference in behaviour of the main DATA-time
27034 ACL should however depend on the PRDR-time ACL having run, as Exim
27035 will avoid doing so in some situations (eg.  single-recipient mails).
27036
27037 See also the &%prdr_enable%& global option
27038 and the &%hosts_try_prdr%& smtp transport option.
27039
27040 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27041 If the ACL is not defined, processing completes as if
27042 the feature was not requested by the client.
27043
27044 .section "The QUIT ACL" "SECTQUITACL"
27045 .cindex "QUIT, ACL for"
27046 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27047 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27048 does not in fact control any access. For this reason, the only verbs that are
27049 permitted are &%accept%& and &%warn%&.
27050
27051 This ACL can be used for tasks such as custom logging at the end of an SMTP
27052 session. For example, you can use ACL variables in other ACLs to count
27053 messages, recipients, etc., and log the totals at QUIT time using one or
27054 more &%logwrite%& modifiers on a &%warn%& verb.
27055
27056 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27057 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27058
27059 You do not need to have a final &%accept%&, but if you do, you can use a
27060 &%message%& modifier to specify custom text that is sent as part of the 221
27061 response to QUIT.
27062
27063 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27064 failure (for example, failure to open a log file, or when Exim is bombing out
27065 because it has detected an unrecoverable error), all SMTP commands from the
27066 client are given temporary error responses until QUIT is received or the
27067 connection is closed. In these special cases, the QUIT ACL does not run.
27068
27069
27070 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27071 .vindex &$acl_smtp_notquit$&
27072 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27073 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27074 trouble, such as being unable to write to its log files, this ACL is not run,
27075 because it might try to do things (such as write to log files) that make the
27076 situation even worse.
27077
27078 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27079 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27080 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27081 and &%warn%&.
27082
27083 .vindex &$smtp_notquit_reason$&
27084 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27085 to a string that indicates the reason for the termination of the SMTP
27086 connection. The possible values are:
27087 .table2
27088 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27089 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27090 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27091 .irow &`connection-lost`&          "The SMTP connection has been lost"
27092 .irow &`data-timeout`&             "Timeout while reading message data"
27093 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27094 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27095 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27096 .irow &`synchronization-error`&    "SMTP synchronization error"
27097 .irow &`tls-failed`&               "TLS failed to start"
27098 .endtable
27099 In most cases when an SMTP connection is closed without having received QUIT,
27100 Exim sends an SMTP response message before actually closing the connection.
27101 With the exception of the &`acl-drop`& case, the default message can be
27102 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27103 &%drop%& verb in another ACL, it is the message from the other ACL that is
27104 used.
27105
27106
27107 .section "Finding an ACL to use" "SECID195"
27108 .cindex "&ACL;" "finding which to use"
27109 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27110 you can use different ACLs in different circumstances. For example,
27111 .code
27112 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27113                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27114 .endd
27115 In the default configuration file there are some example settings for
27116 providing an RFC 4409 message submission service on port 587 and a
27117 non-standard &"smtps"& service on port 465. You can use a string
27118 expansion like this to choose an ACL for MUAs on these ports which is
27119 more appropriate for this purpose than the default ACL on port 25.
27120
27121 The expanded string does not have to be the name of an ACL in the
27122 configuration file; there are other possibilities. Having expanded the
27123 string, Exim searches for an ACL as follows:
27124
27125 .ilist
27126 If the string begins with a slash, Exim uses it as a file name, and reads its
27127 contents as an ACL. The lines are processed in the same way as lines in the
27128 Exim configuration file. In particular, continuation lines are supported, blank
27129 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27130 If the file does not exist or cannot be read, an error occurs (typically
27131 causing a temporary failure of whatever caused the ACL to be run). For example:
27132 .code
27133 acl_smtp_data = /etc/acls/\
27134   ${lookup{$sender_host_address}lsearch\
27135   {/etc/acllist}{$value}{default}}
27136 .endd
27137 This looks up an ACL file to use on the basis of the host's IP address, falling
27138 back to a default if the lookup fails. If an ACL is successfully read from a
27139 file, it is retained in memory for the duration of the Exim process, so that it
27140 can be re-used without having to re-read the file.
27141 .next
27142 If the string does not start with a slash, and does not contain any spaces,
27143 Exim searches the ACL section of the configuration for an ACL whose name
27144 matches the string.
27145 .next
27146 If no named ACL is found, or if the string contains spaces, Exim parses
27147 the string as an inline ACL. This can save typing in cases where you just
27148 want to have something like
27149 .code
27150 acl_smtp_vrfy = accept
27151 .endd
27152 in order to allow free use of the VRFY command. Such a string may contain
27153 newlines; it is processed in the same way as an ACL that is read from a file.
27154 .endlist
27155
27156
27157
27158
27159 .section "ACL return codes" "SECID196"
27160 .cindex "&ACL;" "return codes"
27161 Except for the QUIT ACL, which does not affect the SMTP return code (see
27162 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27163 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27164 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27165 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27166 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27167 This also causes a 4&'xx'& return code.
27168
27169 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27170 &"deny"&, because there is no mechanism for passing temporary errors to the
27171 submitters of non-SMTP messages.
27172
27173
27174 ACLs that are relevant to message reception may also return &"discard"&. This
27175 has the effect of &"accept"&, but causes either the entire message or an
27176 individual recipient address to be discarded. In other words, it is a
27177 blackholing facility. Use it with care.
27178
27179 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27180 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27181 RCPT ACL is to discard just the one recipient address. If there are no
27182 recipients left when the message's data is received, the DATA ACL is not
27183 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27184 remaining recipients. The &"discard"& return is not permitted for the
27185 &%acl_smtp_predata%& ACL.
27186
27187
27188 .cindex "&[local_scan()]& function" "when all recipients discarded"
27189 The &[local_scan()]& function is always run, even if there are no remaining
27190 recipients; it may create new recipients.
27191
27192
27193
27194 .section "Unset ACL options" "SECID197"
27195 .cindex "&ACL;" "unset options"
27196 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27197 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27198 not defined at all. For any defined ACL, the default action when control
27199 reaches the end of the ACL statements is &"deny"&.
27200
27201 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27202 these two are ACLs that are used only for their side effects. They cannot be
27203 used to accept or reject anything.
27204
27205 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27206 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27207 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27208 when the ACL is not defined is &"accept"&.
27209
27210 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27211 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27212 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27213 messages over an SMTP connection. For an example, see the ACL in the default
27214 configuration file.
27215
27216
27217
27218
27219 .section "Data for message ACLs" "SECID198"
27220 .cindex "&ACL;" "data for message ACL"
27221 .vindex &$domain$&
27222 .vindex &$local_part$&
27223 .vindex &$sender_address$&
27224 .vindex &$sender_host_address$&
27225 .vindex &$smtp_command$&
27226 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27227 that contain information about the host and the message's sender (for example,
27228 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27229 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27230 &$local_part$& are set from the argument address. The entire SMTP command
27231 is available in &$smtp_command$&.
27232
27233 When an ACL for the AUTH parameter of MAIL is running, the variables that
27234 contain information about the host are set, but &$sender_address$& is not yet
27235 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27236 how it is used.
27237
27238 .vindex "&$message_size$&"
27239 The &$message_size$& variable is set to the value of the SIZE parameter on
27240 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27241 that parameter is not given. The value is updated to the true message size by
27242 the time the final DATA ACL is run (after the message data has been
27243 received).
27244
27245 .vindex "&$rcpt_count$&"
27246 .vindex "&$recipients_count$&"
27247 The &$rcpt_count$& variable increases by one for each RCPT command received.
27248 The &$recipients_count$& variable increases by one each time a RCPT command is
27249 accepted, so while an ACL for RCPT is being processed, it contains the number
27250 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27251 &$rcpt_count$& contains the total number of RCPT commands, and
27252 &$recipients_count$& contains the total number of accepted recipients.
27253
27254
27255
27256
27257
27258 .section "Data for non-message ACLs" "SECTdatfornon"
27259 .cindex "&ACL;" "data for non-message ACL"
27260 .vindex &$smtp_command_argument$&
27261 .vindex &$smtp_command$&
27262 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27263 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27264 and the entire SMTP command is available in &$smtp_command$&.
27265 These variables can be tested using a &%condition%& condition. For example,
27266 here is an ACL for use with AUTH, which insists that either the session is
27267 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27268 does not permit authentication methods that use cleartext passwords on
27269 unencrypted connections.
27270 .code
27271 acl_check_auth:
27272   accept encrypted = *
27273   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27274                      {CRAM-MD5}}
27275   deny   message   = TLS encryption or CRAM-MD5 required
27276 .endd
27277 (Another way of applying this restriction is to arrange for the authenticators
27278 that use cleartext passwords not to be advertised when the connection is not
27279 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27280 option to do this.)
27281
27282
27283
27284 .section "Format of an ACL" "SECID199"
27285 .cindex "&ACL;" "format of"
27286 .cindex "&ACL;" "verbs, definition of"
27287 An individual ACL consists of a number of statements. Each statement starts
27288 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27289 Modifiers can change the way the verb operates, define error and log messages,
27290 set variables, insert delays, and vary the processing of accepted messages.
27291
27292 If all the conditions are met, the verb is obeyed. The same condition may be
27293 used (with different arguments) more than once in the same statement. This
27294 provides a means of specifying an &"and"& conjunction between conditions. For
27295 example:
27296 .code
27297 deny  dnslists = list1.example
27298 dnslists = list2.example
27299 .endd
27300 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27301 the conditions and modifiers when it reaches a condition that fails. What
27302 happens then depends on the verb (and in one case, on a special modifier). Not
27303 all the conditions make sense at every testing point. For example, you cannot
27304 test a sender address in the ACL that is run for a VRFY command.
27305
27306
27307 .section "ACL verbs" "SECID200"
27308 The ACL verbs are as follows:
27309
27310 .ilist
27311 .cindex "&%accept%& ACL verb"
27312 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27313 of the conditions are not met, what happens depends on whether &%endpass%&
27314 appears among the conditions (for syntax see below). If the failing condition
27315 is before &%endpass%&, control is passed to the next ACL statement; if it is
27316 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27317 check a RCPT command:
27318 .code
27319 accept domains = +local_domains
27320 endpass
27321 verify = recipient
27322 .endd
27323 If the recipient domain does not match the &%domains%& condition, control
27324 passes to the next statement. If it does match, the recipient is verified, and
27325 the command is accepted if verification succeeds. However, if verification
27326 fails, the ACL yields &"deny"&, because the failing condition is after
27327 &%endpass%&.
27328
27329 The &%endpass%& feature has turned out to be confusing to many people, so its
27330 use is not recommended nowadays. It is always possible to rewrite an ACL so
27331 that &%endpass%& is not needed, and it is no longer used in the default
27332 configuration.
27333
27334 .cindex "&%message%& ACL modifier" "with &%accept%&"
27335 If a &%message%& modifier appears on an &%accept%& statement, its action
27336 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27337 (when an &%accept%& verb either accepts or passes control to the next
27338 statement), &%message%& can be used to vary the message that is sent when an
27339 SMTP command is accepted. For example, in a RCPT ACL you could have:
27340 .display
27341 &`accept  `&<&'some conditions'&>
27342 &`        message = OK, I will allow you through today`&
27343 .endd
27344 You can specify an SMTP response code, optionally followed by an &"extended
27345 response code"& at the start of the message, but the first digit must be the
27346 same as would be sent by default, which is 2 for an &%accept%& verb.
27347
27348 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27349 an error message that is used when access is denied. This behaviour is retained
27350 for backward compatibility, but current &"best practice"& is to avoid the use
27351 of &%endpass%&.
27352
27353
27354 .next
27355 .cindex "&%defer%& ACL verb"
27356 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27357 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27358 &%defer%& is the same as &%deny%&, because there is no way of sending a
27359 temporary error. For a RCPT command, &%defer%& is much the same as using a
27360 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27361 be used in any ACL, and even for a recipient it might be a simpler approach.
27362
27363
27364 .next
27365 .cindex "&%deny%& ACL verb"
27366 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27367 the conditions are not met, control is passed to the next ACL statement. For
27368 example,
27369 .code
27370 deny dnslists = blackholes.mail-abuse.org
27371 .endd
27372 rejects commands from hosts that are on a DNS black list.
27373
27374
27375 .next
27376 .cindex "&%discard%& ACL verb"
27377 &%discard%&: This verb behaves like &%accept%&, except that it returns
27378 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27379 that are concerned with receiving messages. When all the conditions are true,
27380 the sending entity receives a &"success"& response. However, &%discard%& causes
27381 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27382 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27383 message's recipients are discarded. Recipients that are discarded before DATA
27384 do not appear in the log line when the &%received_recipients%& log selector is set.
27385
27386 If the &%log_message%& modifier is set when &%discard%& operates,
27387 its contents are added to the line that is automatically written to the log.
27388 The &%message%& modifier operates exactly as it does for &%accept%&.
27389
27390
27391 .next
27392 .cindex "&%drop%& ACL verb"
27393 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27394 forcibly closed after the 5&'xx'& error message has been sent. For example:
27395 .code
27396 drop   message   = I don't take more than 20 RCPTs
27397        condition = ${if > {$rcpt_count}{20}}
27398 .endd
27399 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27400 The connection is always dropped after sending a 550 response.
27401
27402 .next
27403 .cindex "&%require%& ACL verb"
27404 &%require%&: If all the conditions are met, control is passed to the next ACL
27405 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27406 example, when checking a RCPT command,
27407 .code
27408 require message = Sender did not verify
27409         verify  = sender
27410 .endd
27411 passes control to subsequent statements only if the message's sender can be
27412 verified. Otherwise, it rejects the command. Note the positioning of the
27413 &%message%& modifier, before the &%verify%& condition. The reason for this is
27414 discussed in section &<<SECTcondmodproc>>&.
27415
27416 .next
27417 .cindex "&%warn%& ACL verb"
27418 &%warn%&: If all the conditions are true, a line specified by the
27419 &%log_message%& modifier is written to Exim's main log. Control always passes
27420 to the next ACL statement. If any condition is false, the log line is not
27421 written. If an identical log line is requested several times in the same
27422 message, only one copy is actually written to the log. If you want to force
27423 duplicates to be written, use the &%logwrite%& modifier instead.
27424
27425 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27426 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27427 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27428 first failing condition. There is more about adding header lines in section
27429 &<<SECTaddheadacl>>&.
27430
27431 If any condition on a &%warn%& statement cannot be completed (that is, there is
27432 some sort of defer), the log line specified by &%log_message%& is not written.
27433 This does not include the case of a forced failure from a lookup, which
27434 is considered to be a successful completion. After a defer, no further
27435 conditions or modifiers in the &%warn%& statement are processed. The incident
27436 is logged, and the ACL continues to be processed, from the next statement
27437 onwards.
27438
27439
27440 .vindex "&$acl_verify_message$&"
27441 When one of the &%warn%& conditions is an address verification that fails, the
27442 text of the verification failure message is in &$acl_verify_message$&. If you
27443 want this logged, you must set it up explicitly. For example:
27444 .code
27445 warn   !verify = sender
27446        log_message = sender verify failed: $acl_verify_message
27447 .endd
27448 .endlist
27449
27450 At the end of each ACL there is an implicit unconditional &%deny%&.
27451
27452 As you can see from the examples above, the conditions and modifiers are
27453 written one to a line, with the first one on the same line as the verb, and
27454 subsequent ones on following lines. If you have a very long condition, you can
27455 continue it onto several physical lines by the usual backslash continuation
27456 mechanism. It is conventional to align the conditions vertically.
27457
27458
27459
27460 .section "ACL variables" "SECTaclvariables"
27461 .cindex "&ACL;" "variables"
27462 There are some special variables that can be set during ACL processing. They
27463 can be used to pass information between different ACLs, different invocations
27464 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27465 transports, and filters that are used to deliver a message. The names of these
27466 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27467 an underscore, but the remainder of the name can be any sequence of
27468 alphanumeric characters and underscores that you choose. There is no limit on
27469 the number of ACL variables. The two sets act as follows:
27470 .ilist
27471 The values of those variables whose names begin with &$acl_c$& persist
27472 throughout an SMTP connection. They are never reset. Thus, a value that is set
27473 while receiving one message is still available when receiving the next message
27474 on the same SMTP connection.
27475 .next
27476 The values of those variables whose names begin with &$acl_m$& persist only
27477 while a message is being received. They are reset afterwards. They are also
27478 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27479 .endlist
27480
27481 When a message is accepted, the current values of all the ACL variables are
27482 preserved with the message and are subsequently made available at delivery
27483 time. The ACL variables are set by a modifier called &%set%&. For example:
27484 .code
27485 accept hosts = whatever
27486        set acl_m4 = some value
27487 accept authenticated = *
27488        set acl_c_auth = yes
27489 .endd
27490 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27491 be set. If you want to set a variable without taking any action, you can use a
27492 &%warn%& verb without any other modifiers or conditions.
27493
27494 .oindex &%strict_acl_vars%&
27495 What happens if a syntactically valid but undefined ACL variable is
27496 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27497 false (the default), an empty string is substituted; if it is true, an
27498 error is generated.
27499
27500 Versions of Exim before 4.64 have a limited set of numbered variables, but
27501 their names are compatible, so there is no problem with upgrading.
27502
27503
27504 .section "Condition and modifier processing" "SECTcondmodproc"
27505 .cindex "&ACL;" "conditions; processing"
27506 .cindex "&ACL;" "modifiers; processing"
27507 An exclamation mark preceding a condition negates its result. For example:
27508 .code
27509 deny   domains = *.dom.example
27510       !verify  = recipient
27511 .endd
27512 causes the ACL to return &"deny"& if the recipient domain ends in
27513 &'dom.example'& and the recipient address cannot be verified. Sometimes
27514 negation can be used on the right-hand side of a condition. For example, these
27515 two statements are equivalent:
27516 .code
27517 deny  hosts = !192.168.3.4
27518 deny !hosts =  192.168.3.4
27519 .endd
27520 However, for many conditions (&%verify%& being a good example), only left-hand
27521 side negation of the whole condition is possible.
27522
27523 The arguments of conditions and modifiers are expanded. A forced failure
27524 of an expansion causes a condition to be ignored, that is, it behaves as if the
27525 condition is true. Consider these two statements:
27526 .code
27527 accept  senders = ${lookup{$host_name}lsearch\
27528                   {/some/file}{$value}fail}
27529 accept  senders = ${lookup{$host_name}lsearch\
27530                   {/some/file}{$value}{}}
27531 .endd
27532 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27533 the returned list is searched, but if the lookup fails the behaviour is
27534 different in the two cases. The &%fail%& in the first statement causes the
27535 condition to be ignored, leaving no further conditions. The &%accept%& verb
27536 therefore succeeds. The second statement, however, generates an empty list when
27537 the lookup fails. No sender can match an empty list, so the condition fails,
27538 and therefore the &%accept%& also fails.
27539
27540 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27541 specify actions that are taken as the conditions for a statement are checked;
27542 others specify text for messages that are used when access is denied or a
27543 warning is generated. The &%control%& modifier affects the way an incoming
27544 message is handled.
27545
27546 The positioning of the modifiers in an ACL statement is important, because the
27547 processing of a verb ceases as soon as its outcome is known. Only those
27548 modifiers that have already been encountered will take effect. For example,
27549 consider this use of the &%message%& modifier:
27550 .code
27551 require message = Can't verify sender
27552         verify  = sender
27553         message = Can't verify recipient
27554         verify  = recipient
27555         message = This message cannot be used
27556 .endd
27557 If sender verification fails, Exim knows that the result of the statement is
27558 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27559 so its text is used as the error message. If sender verification succeeds, but
27560 recipient verification fails, the second message is used. If recipient
27561 verification succeeds, the third message becomes &"current"&, but is never used
27562 because there are no more conditions to cause failure.
27563
27564 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27565 modifier that is used, because all the conditions must be true for rejection to
27566 happen. Specifying more than one &%message%& modifier does not make sense, and
27567 the message can even be specified after all the conditions. For example:
27568 .code
27569 deny   hosts = ...
27570       !senders = *@my.domain.example
27571        message = Invalid sender from client host
27572 .endd
27573 The &"deny"& result does not happen until the end of the statement is reached,
27574 by which time Exim has set up the message.
27575
27576
27577
27578 .section "ACL modifiers" "SECTACLmodi"
27579 .cindex "&ACL;" "modifiers; list of"
27580 The ACL modifiers are as follows:
27581
27582 .vlist
27583 .vitem &*add_header*&&~=&~<&'text'&>
27584 This modifier specifies one or more header lines that are to be added to an
27585 incoming message, assuming, of course, that the message is ultimately
27586 accepted. For details, see section &<<SECTaddheadacl>>&.
27587
27588 .vitem &*continue*&&~=&~<&'text'&>
27589 .cindex "&%continue%& ACL modifier"
27590 .cindex "database" "updating in ACL"
27591 This modifier does nothing of itself, and processing of the ACL always
27592 continues with the next condition or modifier. The value of &%continue%& is in
27593 the side effects of expanding its argument. Typically this could be used to
27594 update a database. It is really just a syntactic tidiness, to avoid having to
27595 write rather ugly lines like this:
27596 .display
27597 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27598 .endd
27599 Instead, all you need is
27600 .display
27601 &`continue = `&<&'some expansion'&>
27602 .endd
27603
27604 .vitem &*control*&&~=&~<&'text'&>
27605 .cindex "&%control%& ACL modifier"
27606 This modifier affects the subsequent processing of the SMTP connection or of an
27607 incoming message that is accepted. The effect of the first type of control
27608 lasts for the duration of the connection, whereas the effect of the second type
27609 lasts only until the current message has been received. The message-specific
27610 controls always apply to the whole message, not to individual recipients,
27611 even if the &%control%& modifier appears in a RCPT ACL.
27612
27613 As there are now quite a few controls that can be applied, they are described
27614 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27615 in several different ways. For example:
27616
27617 . ==== As this is a nested list, any displays it contains must be indented
27618 . ==== as otherwise they are too far to the left. That comment applies only
27619 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27620 . ==== way.
27621
27622 .ilist
27623 It can be at the end of an &%accept%& statement:
27624 .code
27625     accept  ...some conditions
27626             control = queue_only
27627 .endd
27628 In this case, the control is applied when this statement yields &"accept"&, in
27629 other words, when the conditions are all true.
27630
27631 .next
27632 It can be in the middle of an &%accept%& statement:
27633 .code
27634     accept  ...some conditions...
27635             control = queue_only
27636             ...some more conditions...
27637 .endd
27638 If the first set of conditions are true, the control is applied, even if the
27639 statement does not accept because one of the second set of conditions is false.
27640 In this case, some subsequent statement must yield &"accept"& for the control
27641 to be relevant.
27642
27643 .next
27644 It can be used with &%warn%& to apply the control, leaving the
27645 decision about accepting or denying to a subsequent verb. For
27646 example:
27647 .code
27648     warn    ...some conditions...
27649             control = freeze
27650     accept  ...
27651 .endd
27652 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27653 &%logwrite%&, so it does not add anything to the message and does not write a
27654 log entry.
27655
27656 .next
27657 If you want to apply a control unconditionally, you can use it with a
27658 &%require%& verb. For example:
27659 .code
27660     require  control = no_multiline_responses
27661 .endd
27662 .endlist
27663
27664 .vitem &*delay*&&~=&~<&'time'&>
27665 .cindex "&%delay%& ACL modifier"
27666 .oindex "&%-bh%&"
27667 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27668 the time interval before proceeding. However, when testing Exim using the
27669 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27670 output instead). The time is given in the usual Exim notation, and the delay
27671 happens as soon as the modifier is processed. In an SMTP session, pending
27672 output is flushed before the delay is imposed.
27673
27674 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27675 example:
27676 .code
27677 deny    ...some conditions...
27678         delay = 30s
27679 .endd
27680 The delay happens if all the conditions are true, before the statement returns
27681 &"deny"&. Compare this with:
27682 .code
27683 deny    delay = 30s
27684         ...some conditions...
27685 .endd
27686 which waits for 30s before processing the conditions. The &%delay%& modifier
27687 can also be used with &%warn%& and together with &%control%&:
27688 .code
27689 warn    ...some conditions...
27690         delay = 2m
27691         control = freeze
27692 accept  ...
27693 .endd
27694
27695 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27696 responses to several commands are no longer buffered and sent in one packet (as
27697 they would normally be) because all output is flushed before imposing the
27698 delay. This optimization is disabled so that a number of small delays do not
27699 appear to the client as one large aggregated delay that might provoke an
27700 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27701 using a &%control%& modifier to set &%no_delay_flush%&.
27702
27703
27704 .vitem &*endpass*&
27705 .cindex "&%endpass%& ACL modifier"
27706 This modifier, which has no argument, is recognized only in &%accept%& and
27707 &%discard%& statements. It marks the boundary between the conditions whose
27708 failure causes control to pass to the next statement, and the conditions whose
27709 failure causes the ACL to return &"deny"&. This concept has proved to be
27710 confusing to some people, so the use of &%endpass%& is no longer recommended as
27711 &"best practice"&. See the description of &%accept%& above for more details.
27712
27713
27714 .vitem &*log_message*&&~=&~<&'text'&>
27715 .cindex "&%log_message%& ACL modifier"
27716 This modifier sets up a message that is used as part of the log message if the
27717 ACL denies access or a &%warn%& statement's conditions are true. For example:
27718 .code
27719 require log_message = wrong cipher suite $tls_in_cipher
27720         encrypted   = DES-CBC3-SHA
27721 .endd
27722 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27723 example:
27724 .display
27725 &`discard `&<&'some conditions'&>
27726 &`        log_message = Discarded $local_part@$domain because...`&
27727 .endd
27728 When access is denied, &%log_message%& adds to any underlying error message
27729 that may exist because of a condition failure. For example, while verifying a
27730 recipient address, a &':fail:'& redirection might have already set up a
27731 message.
27732
27733 The message may be defined before the conditions to which it applies, because
27734 the string expansion does not happen until Exim decides that access is to be
27735 denied. This means that any variables that are set by the condition are
27736 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27737 variables are set after a DNS black list lookup succeeds. If the expansion of
27738 &%log_message%& fails, or if the result is an empty string, the modifier is
27739 ignored.
27740
27741 .vindex "&$acl_verify_message$&"
27742 If you want to use a &%warn%& statement to log the result of an address
27743 verification, you can use &$acl_verify_message$& to include the verification
27744 error message.
27745
27746 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27747 the start of the logged message. If the same warning log message is requested
27748 more than once while receiving  a single email message, only one copy is
27749 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27750 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27751 is logged for a successful &%warn%& statement.
27752
27753 If &%log_message%& is not present and there is no underlying error message (for
27754 example, from the failure of address verification), but &%message%& is present,
27755 the &%message%& text is used for logging rejections. However, if any text for
27756 logging contains newlines, only the first line is logged. In the absence of
27757 both &%log_message%& and &%message%&, a default built-in message is used for
27758 logging rejections.
27759
27760
27761 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27762 .cindex "&%log_reject_target%& ACL modifier"
27763 .cindex "logging in ACL" "specifying which log"
27764 This modifier makes it possible to specify which logs are used for messages
27765 about ACL rejections. Its argument is a colon-separated list of words that can
27766 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27767 may be empty, in which case a rejection is not logged at all. For example, this
27768 ACL fragment writes no logging information when access is denied:
27769 .display
27770 &`deny `&<&'some conditions'&>
27771 &`     log_reject_target =`&
27772 .endd
27773 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27774 permanent and temporary rejections. Its effect lasts for the rest of the
27775 current ACL.
27776
27777
27778 .vitem &*logwrite*&&~=&~<&'text'&>
27779 .cindex "&%logwrite%& ACL modifier"
27780 .cindex "logging in ACL" "immediate"
27781 This modifier writes a message to a log file as soon as it is encountered when
27782 processing an ACL. (Compare &%log_message%&, which, except in the case of
27783 &%warn%& and &%discard%&, is used only if the ACL statement denies
27784 access.) The &%logwrite%& modifier can be used to log special incidents in
27785 ACLs. For example:
27786 .display
27787 &`accept `&<&'some special conditions'&>
27788 &`       control  = freeze`&
27789 &`       logwrite = froze message because ...`&
27790 .endd
27791 By default, the message is written to the main log. However, it may begin
27792 with a colon, followed by a comma-separated list of log names, and then
27793 another colon, to specify exactly which logs are to be written. For
27794 example:
27795 .code
27796 logwrite = :main,reject: text for main and reject logs
27797 logwrite = :panic: text for panic log only
27798 .endd
27799
27800
27801 .vitem &*message*&&~=&~<&'text'&>
27802 .cindex "&%message%& ACL modifier"
27803 This modifier sets up a text string that is expanded and used as a response
27804 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27805 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27806 there is some complication if &%endpass%& is involved; see the description of
27807 &%accept%& for details.)
27808
27809 The expansion of the message happens at the time Exim decides that the ACL is
27810 to end, not at the time it processes &%message%&. If the expansion fails, or
27811 generates an empty string, the modifier is ignored. Here is an example where
27812 &%message%& must be specified first, because the ACL ends with a rejection if
27813 the &%hosts%& condition fails:
27814 .code
27815 require  message = Host not recognized
27816          hosts = 10.0.0.0/8
27817 .endd
27818 (Once a condition has failed, no further conditions or modifiers are
27819 processed.)
27820
27821 .cindex "SMTP" "error codes"
27822 .oindex "&%smtp_banner%&
27823 For ACLs that are triggered by SMTP commands, the message is returned as part
27824 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27825 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27826 is accepted. In the case of the connect ACL, accepting with a message modifier
27827 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27828 accept message may not contain more than one line (otherwise it will be
27829 truncated at the first newline and a panic logged), and it cannot affect the
27830 EHLO options.
27831
27832 When SMTP is involved, the message may begin with an overriding response code,
27833 consisting of three digits optionally followed by an &"extended response code"&
27834 of the form &'n.n.n'&, each code being followed by a space. For example:
27835 .code
27836 deny  message = 599 1.2.3 Host not welcome
27837       hosts = 192.168.34.0/24
27838 .endd
27839 The first digit of the supplied response code must be the same as would be sent
27840 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27841 access, but for the predata ACL, note that the default success code is 354, not
27842 2&'xx'&.
27843
27844 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27845 the message modifier cannot override the 221 response code.
27846
27847 The text in a &%message%& modifier is literal; any quotes are taken as
27848 literals, but because the string is expanded, backslash escapes are processed
27849 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27850 response.
27851
27852 .vindex "&$acl_verify_message$&"
27853 For ACLs that are called by an &%acl =%& ACL condition, the message is
27854 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27855
27856 If &%message%& is used on a statement that verifies an address, the message
27857 specified overrides any message that is generated by the verification process.
27858 However, the original message is available in the variable
27859 &$acl_verify_message$&, so you can incorporate it into your message if you
27860 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27861 routers to be passed back as part of the SMTP response, you should either not
27862 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27863
27864 For compatibility with previous releases of Exim, a &%message%& modifier that
27865 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27866 modifier, but this usage is now deprecated. However, &%message%& acts only when
27867 all the conditions are true, wherever it appears in an ACL command, whereas
27868 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27869 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27870 effect.
27871
27872
27873 .vitem &*remove_header*&&~=&~<&'text'&>
27874 This modifier specifies one or more header names in a colon-separated list
27875  that are to be removed from an incoming message, assuming, of course, that
27876 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27877
27878
27879 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27880 .cindex "&%set%& ACL modifier"
27881 This modifier puts a value into one of the ACL variables (see section
27882 &<<SECTaclvariables>>&).
27883
27884
27885 .vitem &*udpsend*&&~=&~<&'parameters'&>
27886 This modifier sends a UDP packet, for purposes such as statistics
27887 collection or behaviour monitoring. The parameters are expanded, and
27888 the result of the expansion must be a colon-separated list consisting
27889 of a destination server, port number, and the packet contents. The
27890 server can be specified as a host name or IPv4 or IPv6 address. The
27891 separator can be changed with the usual angle bracket syntax. For
27892 example, you might want to collect information on which hosts connect
27893 when:
27894 .code
27895 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27896              $tod_zulu $sender_host_address
27897 .endd
27898 .endlist
27899
27900
27901
27902
27903 .section "Use of the control modifier" "SECTcontrols"
27904 .cindex "&%control%& ACL modifier"
27905 The &%control%& modifier supports the following settings:
27906
27907 .vlist
27908 .vitem &*control&~=&~allow_auth_unadvertised*&
27909 This modifier allows a client host to use the SMTP AUTH command even when it
27910 has not been advertised in response to EHLO. Furthermore, because there are
27911 apparently some really broken clients that do this, Exim will accept AUTH after
27912 HELO (rather than EHLO) when this control is set. It should be used only if you
27913 really need it, and you should limit its use to those broken clients that do
27914 not work without it. For example:
27915 .code
27916 warn hosts   = 192.168.34.25
27917      control = allow_auth_unadvertised
27918 .endd
27919 Normally, when an Exim server receives an AUTH command, it checks the name of
27920 the authentication mechanism that is given in the command to ensure that it
27921 matches an advertised mechanism. When this control is set, the check that a
27922 mechanism has been advertised is bypassed. Any configured mechanism can be used
27923 by the client. This control is permitted only in the connection and HELO ACLs.
27924
27925
27926 .vitem &*control&~=&~caseful_local_part*& &&&
27927        &*control&~=&~caselower_local_part*&
27928 .cindex "&ACL;" "case of local part in"
27929 .cindex "case of local parts"
27930 .vindex "&$local_part$&"
27931 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27932 (that is, during RCPT processing). By default, the contents of &$local_part$&
27933 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27934 any uppercase letters in the original local part are restored in &$local_part$&
27935 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27936 is encountered.
27937
27938 These controls affect only the current recipient. Moreover, they apply only to
27939 local part handling that takes place directly in the ACL (for example, as a key
27940 in lookups). If a test to verify the recipient is obeyed, the case-related
27941 handling of the local part during the verification is controlled by the router
27942 configuration (see the &%caseful_local_part%& generic router option).
27943
27944 This facility could be used, for example, to add a spam score to local parts
27945 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27946 spam score:
27947 .code
27948 warn  control = caseful_local_part
27949       set acl_m4 = ${eval:\
27950                      $acl_m4 + \
27951                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27952                     }
27953       control = caselower_local_part
27954 .endd
27955 Notice that we put back the lower cased version afterwards, assuming that
27956 is what is wanted for subsequent tests.
27957
27958
27959 .vitem &*control&~=&~cutthrough_delivery*&
27960 .cindex "&ACL;" "cutthrough routing"
27961 .cindex "cutthrough" "requesting"
27962 This option requests delivery be attempted while the item is being received.
27963
27964 The option usable in the RCPT ACL.
27965 If enabled for a message recieved via smtp and routed to an smtp transport,
27966 and the message has only one recipient,
27967 then the delivery connection is made while the receiving connection is open
27968 and data is copied from one to the other.
27969
27970 If a recipient-verify callout connection is subsequently
27971 requested in the same ACL it is held open and used for the data,
27972 otherwise one is made after the initial RCPT ACL completes.
27973
27974 Note that routers are used in verify mode,
27975 and cannot depend on content of received headers.
27976 Note also that headers cannot be
27977 modified by any of the post-data ACLs (DATA, MIME and DKIM).
27978 Headers may be modified by routers (subject to the above) and transports.
27979
27980 Cutthrough delivery is not supported via transport-filters or when DKIM signing
27981 of outgoing messages is done, because it sends data to the ultimate destination
27982 before the entire message has been received from the source.
27983
27984 Should the ultimate destination system positively accept or reject the mail,
27985 a corresponding indication is given to the source system and nothing is queued.
27986 If there is a temporary error the item is queued for later delivery in the
27987 usual fashion. If the item is successfully delivered in cutthrough mode
27988 the log line is tagged with ">>" rather than "=>" and appears
27989 before the acceptance "<=" line.
27990
27991 Delivery in this mode avoids the generation of a bounce mail to a
27992 (possibly faked)
27993 sender when the destination system is doing content-scan based rejection.
27994
27995
27996 .vitem &*control&~=&~debug/*&<&'options'&>
27997 .cindex "&ACL;" "enabling debug logging"
27998 .cindex "debugging" "enabling from an ACL"
27999 This control turns on debug logging, almost as though Exim had been invoked
28000 with &`-d`&, with the output going to a new logfile, by default called
28001 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28002 may access any variables already defined.  The logging may be adjusted with
28003 the &'opts'& option, which takes the same values as the &`-d`& command-line
28004 option.  Some examples (which depend on variables that don't exist in all
28005 contexts):
28006 .code
28007       control = debug
28008       control = debug/tag=.$sender_host_address
28009       control = debug/opts=+expand+acl
28010       control = debug/tag=.$message_exim_id/opts=+expand
28011 .endd
28012
28013
28014 .vitem &*control&~=&~dkim_disable_verify*&
28015 .cindex "disable DKIM verify"
28016 .cindex "DKIM" "disable verify"
28017 This control turns off DKIM verification processing entirely.  For details on
28018 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28019
28020
28021 .vitem &*control&~=&~dscp/*&<&'value'&>
28022 .cindex "&ACL;" "setting DSCP value"
28023 .cindex "DSCP" "inbound"
28024 This option causes the DSCP value associated with the socket for the inbound
28025 connection to be adjusted to a given value, given as one of a number of fixed
28026 strings or to numeric value.
28027 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28028 Common values include &`throughput`&, &`mincost`&, and on newer systems
28029 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28030
28031 The outbound packets from Exim will be marked with this value in the header
28032 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28033 that these values will have any effect, not be stripped by networking
28034 equipment, or do much of anything without cooperation with your Network
28035 Engineer and those of all network operators between the source and destination.
28036
28037
28038 .vitem &*control&~=&~enforce_sync*& &&&
28039        &*control&~=&~no_enforce_sync*&
28040 .cindex "SMTP" "synchronization checking"
28041 .cindex "synchronization checking in SMTP"
28042 These controls make it possible to be selective about when SMTP synchronization
28043 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28044 state of the switch (it is true by default). See the description of this option
28045 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28046
28047 The effect of these two controls lasts for the remainder of the SMTP
28048 connection. They can appear in any ACL except the one for the non-SMTP
28049 messages. The most straightforward place to put them is in the ACL defined by
28050 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28051 before the first synchronization check. The expected use is to turn off the
28052 synchronization checks for badly-behaved hosts that you nevertheless need to
28053 work with.
28054
28055
28056 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28057 .cindex "fake defer"
28058 .cindex "defer, fake"
28059 This control works in exactly the same way as &%fakereject%& (described below)
28060 except that it causes an SMTP 450 response after the message data instead of a
28061 550 response. You must take care when using &%fakedefer%& because it causes the
28062 messages to be duplicated when the sender retries. Therefore, you should not
28063 use &%fakedefer%& if the message is to be delivered normally.
28064
28065 .vitem &*control&~=&~fakereject/*&<&'message'&>
28066 .cindex "fake rejection"
28067 .cindex "rejection, fake"
28068 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28069 words, only when an SMTP message is being received. If Exim accepts the
28070 message, instead the final 250 response, a 550 rejection message is sent.
28071 However, Exim proceeds to deliver the message as normal. The control applies
28072 only to the current message, not to any subsequent ones that may be received in
28073 the same SMTP connection.
28074
28075 The text for the 550 response is taken from the &%control%& modifier. If no
28076 message is supplied, the following is used:
28077 .code
28078 550-Your message has been rejected but is being
28079 550-kept for evaluation.
28080 550-If it was a legitimate message, it may still be
28081 550 delivered to the target recipient(s).
28082 .endd
28083 This facility should be used with extreme caution.
28084
28085 .vitem &*control&~=&~freeze*&
28086 .cindex "frozen messages" "forcing in ACL"
28087 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28088 other words, only when a message is being received. If the message is accepted,
28089 it is placed on Exim's queue and frozen. The control applies only to the
28090 current message, not to any subsequent ones that may be received in the same
28091 SMTP connection.
28092
28093 This modifier can optionally be followed by &`/no_tell`&. If the global option
28094 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28095 is told about the freezing), provided all the &*control=freeze*& modifiers that
28096 are obeyed for the current message have the &`/no_tell`& option.
28097
28098 .vitem &*control&~=&~no_delay_flush*&
28099 .cindex "SMTP" "output flushing, disabling for delay"
28100 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28101 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28102 use. This control, as long as it is encountered before the &%delay%& modifier,
28103 disables such output flushing.
28104
28105 .vitem &*control&~=&~no_callout_flush*&
28106 .cindex "SMTP" "output flushing, disabling for callout"
28107 Exim normally flushes SMTP output before performing a callout in an ACL, to
28108 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28109 use. This control, as long as it is encountered before the &%verify%& condition
28110 that causes the callout, disables such output flushing.
28111
28112 .vitem &*control&~=&~no_mbox_unspool*&
28113 This control is available when Exim is compiled with the content scanning
28114 extension. Content scanning may require a copy of the current message, or parts
28115 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28116 or spam scanner. Normally, such copies are deleted when they are no longer
28117 needed. If this control is set, the copies are not deleted. The control applies
28118 only to the current message, not to any subsequent ones that may be received in
28119 the same SMTP connection. It is provided for debugging purposes and is unlikely
28120 to be useful in production.
28121
28122 .vitem &*control&~=&~no_multiline_responses*&
28123 .cindex "multiline responses, suppressing"
28124 This control is permitted for any ACL except the one for non-SMTP messages.
28125 It seems that there are broken clients in use that cannot handle multiline
28126 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28127
28128 If this control is set, multiline SMTP responses from ACL rejections are
28129 suppressed. One way of doing this would have been to put out these responses as
28130 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28131 (&"use multiline responses for more"& it says &-- ha!), and some of the
28132 responses might get close to that. So this facility, which is after all only a
28133 sop to broken clients, is implemented by doing two very easy things:
28134
28135 .ilist
28136 Extra information that is normally output as part of a rejection caused by
28137 sender verification failure is omitted. Only the final line (typically &"sender
28138 verification failed"&) is sent.
28139 .next
28140 If a &%message%& modifier supplies a multiline response, only the first
28141 line is output.
28142 .endlist
28143
28144 The setting of the switch can, of course, be made conditional on the
28145 calling host. Its effect lasts until the end of the SMTP connection.
28146
28147 .vitem &*control&~=&~no_pipelining*&
28148 .cindex "PIPELINING" "suppressing advertising"
28149 This control turns off the advertising of the PIPELINING extension to SMTP in
28150 the current session. To be useful, it must be obeyed before Exim sends its
28151 response to an EHLO command. Therefore, it should normally appear in an ACL
28152 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28153 &%pipelining_advertise_hosts%&.
28154
28155 .vitem &*control&~=&~queue_only*&
28156 .oindex "&%queue_only%&"
28157 .cindex "queueing incoming messages"
28158 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28159 other words, only when a message is being received. If the message is accepted,
28160 it is placed on Exim's queue and left there for delivery by a subsequent queue
28161 runner. No immediate delivery process is started. In other words, it has the
28162 effect as the &%queue_only%& global option. However, the control applies only
28163 to the current message, not to any subsequent ones that may be received in the
28164 same SMTP connection.
28165
28166 .vitem &*control&~=&~submission/*&<&'options'&>
28167 .cindex "message" "submission"
28168 .cindex "submission mode"
28169 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28170 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28171 the current message is a submission from a local MUA. In this case, Exim
28172 operates in &"submission mode"&, and applies certain fixups to the message if
28173 necessary. For example, it adds a &'Date:'& header line if one is not present.
28174 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28175 late (the message has already been created).
28176
28177 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28178 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28179 submission mode; the available options for this control are described there.
28180 The control applies only to the current message, not to any subsequent ones
28181 that may be received in the same SMTP connection.
28182
28183 .vitem &*control&~=&~suppress_local_fixups*&
28184 .cindex "submission fixups, suppressing"
28185 This control applies to locally submitted (non TCP/IP) messages, and is the
28186 complement of &`control = submission`&. It disables the fixups that are
28187 normally applied to locally-submitted messages. Specifically:
28188
28189 .ilist
28190 Any &'Sender:'& header line is left alone (in this respect, it is a
28191 dynamic version of &%local_sender_retain%&).
28192 .next
28193 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28194 .next
28195 There is no check that &'From:'& corresponds to the actual sender.
28196 .endlist ilist
28197
28198 This control may be useful when a remotely-originated message is accepted,
28199 passed to some scanning program, and then re-submitted for delivery. It can be
28200 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28201 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28202 data is read.
28203
28204 &*Note:*& This control applies only to the current message, not to any others
28205 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28206 .endlist vlist
28207
28208
28209 .section "Summary of message fixup control" "SECTsummesfix"
28210 All four possibilities for message fixups can be specified:
28211
28212 .ilist
28213 Locally submitted, fixups applied: the default.
28214 .next
28215 Locally submitted, no fixups applied: use
28216 &`control = suppress_local_fixups`&.
28217 .next
28218 Remotely submitted, no fixups applied: the default.
28219 .next
28220 Remotely submitted, fixups applied: use &`control = submission`&.
28221 .endlist
28222
28223
28224
28225 .section "Adding header lines in ACLs" "SECTaddheadacl"
28226 .cindex "header lines" "adding in an ACL"
28227 .cindex "header lines" "position of added lines"
28228 .cindex "&%add_header%& ACL modifier"
28229 The &%add_header%& modifier can be used to add one or more extra header lines
28230 to an incoming message, as in this example:
28231 .code
28232 warn dnslists = sbl.spamhaus.org : \
28233                 dialup.mail-abuse.org
28234      add_header = X-blacklisted-at: $dnslist_domain
28235 .endd
28236 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28237 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28238 receiving a message). The message must ultimately be accepted for
28239 &%add_header%& to have any significant effect. You can use &%add_header%& with
28240 any ACL verb, including &%deny%& (though this is potentially useful only in a
28241 RCPT ACL).
28242
28243 Headers will not be added to the message if the modifier is used in
28244 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28245
28246 Leading and trailing newlines are removed from
28247 the data for the &%add_header%& modifier; if it then
28248 contains one or more newlines that
28249 are not followed by a space or a tab, it is assumed to contain multiple header
28250 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28251 front of any line that is not a valid header line.
28252
28253 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28254 They are added to the message before processing the DATA and MIME ACLs.
28255 However, if an identical header line is requested more than once, only one copy
28256 is actually added to the message. Further header lines may be accumulated
28257 during the DATA and MIME ACLs, after which they are added to the message, again
28258 with duplicates suppressed. Thus, it is possible to add two identical header
28259 lines to an SMTP message, but only if one is added before DATA and one after.
28260 In the case of non-SMTP messages, new headers are accumulated during the
28261 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28262 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28263 are included in the entry that is written to the reject log.
28264
28265 .cindex "header lines" "added; visibility of"
28266 Header lines are not visible in string expansions
28267 of message headers
28268 until they are added to the
28269 message. It follows that header lines defined in the MAIL, RCPT, and predata
28270 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28271 header lines that are added by the DATA or MIME ACLs are not visible in those
28272 ACLs. Because of this restriction, you cannot use header lines as a way of
28273 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28274 this, you can use ACL variables, as described in section
28275 &<<SECTaclvariables>>&.
28276
28277 The list of headers yet to be added is given by the &%$headers_added%& variable.
28278
28279 The &%add_header%& modifier acts immediately as it is encountered during the
28280 processing of an ACL. Notice the difference between these two cases:
28281 .display
28282 &`accept add_header = ADDED: some text`&
28283 &`       `&<&'some condition'&>
28284
28285 &`accept `&<&'some condition'&>
28286 &`       add_header = ADDED: some text`&
28287 .endd
28288 In the first case, the header line is always added, whether or not the
28289 condition is true. In the second case, the header line is added only if the
28290 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28291 ACL statement. All those that are encountered before a condition fails are
28292 honoured.
28293
28294 .cindex "&%warn%& ACL verb"
28295 For compatibility with previous versions of Exim, a &%message%& modifier for a
28296 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28297 effect only if all the conditions are true, even if it appears before some of
28298 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28299 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28300 are present on a &%warn%& verb, both are processed according to their
28301 specifications.
28302
28303 By default, new header lines are added to a message at the end of the existing
28304 header lines. However, you can specify that any particular header line should
28305 be added right at the start (before all the &'Received:'& lines), immediately
28306 after the first block of &'Received:'& lines, or immediately before any line
28307 that is not a &'Received:'& or &'Resent-something:'& header.
28308
28309 This is done by specifying &":at_start:"&, &":after_received:"&, or
28310 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28311 header line, respectively. (Header text cannot start with a colon, as there has
28312 to be a header name first.) For example:
28313 .code
28314 warn add_header = \
28315        :after_received:X-My-Header: something or other...
28316 .endd
28317 If more than one header line is supplied in a single &%add_header%& modifier,
28318 each one is treated independently and can therefore be placed differently. If
28319 you add more than one line at the start, or after the Received: block, they end
28320 up in reverse order.
28321
28322 &*Warning*&: This facility currently applies only to header lines that are
28323 added in an ACL. It does NOT work for header lines that are added in a
28324 system filter or in a router or transport.
28325
28326
28327
28328 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28329 .cindex "header lines" "removing in an ACL"
28330 .cindex "header lines" "position of removed lines"
28331 .cindex "&%remove_header%& ACL modifier"
28332 The &%remove_header%& modifier can be used to remove one or more header lines
28333 from an incoming message, as in this example:
28334 .code
28335 warn   message        = Remove internal headers
28336        remove_header  = x-route-mail1 : x-route-mail2
28337 .endd
28338 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28339 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28340 receiving a message). The message must ultimately be accepted for
28341 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28342 with any ACL verb, including &%deny%&, though this is really not useful for
28343 any verb that doesn't result in a delivered message.
28344
28345 Headers will not be removed to the message if the modifier is used in
28346 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28347
28348 More than one header can be removed at the same time by using a colon separated
28349 list of header names. The header matching is case insensitive. Wildcards are
28350 not permitted, nor is list expansion performed, so you cannot use hostlists to
28351 create a list of headers, however both connection and message variable expansion
28352 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28353 .code
28354 warn   hosts           = +internal_hosts
28355        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28356 warn   message         = Remove internal headers
28357        remove_header   = $acl_c_ihdrs
28358 .endd
28359 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28360 They are removed from the message before processing the DATA and MIME ACLs.
28361 There is no harm in attempting to remove the same header twice nor is removing
28362 a non-existent header. Further header lines to be removed may be accumulated
28363 during the DATA and MIME ACLs, after which they are removed from the message,
28364 if present. In the case of non-SMTP messages, headers to be removed are
28365 accumulated during the non-SMTP ACLs, and are removed from the message after
28366 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28367 ACL, there really is no effect because there is no logging of what headers
28368 would have been removed.
28369
28370 .cindex "header lines" "removed; visibility of"
28371 Header lines are not visible in string expansions until the DATA phase when it
28372 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28373 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28374 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28375 this restriction, you cannot use header lines as a way of controlling data
28376 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28377 you should instead use ACL variables, as described in section
28378 &<<SECTaclvariables>>&.
28379
28380 The &%remove_header%& modifier acts immediately as it is encountered during the
28381 processing of an ACL. Notice the difference between these two cases:
28382 .display
28383 &`accept remove_header = X-Internal`&
28384 &`       `&<&'some condition'&>
28385
28386 &`accept `&<&'some condition'&>
28387 &`       remove_header = X-Internal`&
28388 .endd
28389 In the first case, the header line is always removed, whether or not the
28390 condition is true. In the second case, the header line is removed only if the
28391 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28392 same ACL statement. All those that are encountered before a condition fails
28393 are honoured.
28394
28395 &*Warning*&: This facility currently applies only to header lines that are
28396 present during ACL processing. It does NOT remove header lines that are added
28397 in a system filter or in a router or transport.
28398
28399
28400
28401
28402 .section "ACL conditions" "SECTaclconditions"
28403 .cindex "&ACL;" "conditions; list of"
28404 Some of the conditions listed in this section are available only when Exim is
28405 compiled with the content-scanning extension. They are included here briefly
28406 for completeness. More detailed descriptions can be found in the discussion on
28407 content scanning in chapter &<<CHAPexiscan>>&.
28408
28409 Not all conditions are relevant in all circumstances. For example, testing
28410 senders and recipients does not make sense in an ACL that is being run as the
28411 result of the arrival of an ETRN command, and checks on message headers can be
28412 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28413 can use the same condition (with different parameters) more than once in the
28414 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28415 The conditions are as follows:
28416
28417
28418 .vlist
28419 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28420 .cindex "&ACL;" "nested"
28421 .cindex "&ACL;" "indirect"
28422 .cindex "&ACL;" "arguments"
28423 .cindex "&%acl%& ACL condition"
28424 The possible values of the argument are the same as for the
28425 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28426 &"accept"& the condition is true; if it returns &"deny"& the condition is
28427 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28428 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28429 condition false. This means that further processing of the &%warn%& verb
28430 ceases, but processing of the ACL continues.
28431
28432 If the argument is a named ACL, up to nine space-separated optional values
28433 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28434 and $acl_narg is set to the count of values.
28435 Previous values of these variables are restored after the call returns.
28436 The name and values are expanded separately.
28437 Note that spaces in complex expansions which are used as arguments
28438 will act as argument separators.
28439
28440 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28441 the connection is dropped. If it returns &"discard"&, the verb must be
28442 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28443 conditions are tested.
28444
28445 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28446 loops. This condition allows you to use different ACLs in different
28447 circumstances. For example, different ACLs can be used to handle RCPT commands
28448 for different local users or different local domains.
28449
28450 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28451 .cindex "&%authenticated%& ACL condition"
28452 .cindex "authentication" "ACL checking"
28453 .cindex "&ACL;" "testing for authentication"
28454 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28455 the name of the authenticator is tested against the list. To test for
28456 authentication by any authenticator, you can set
28457 .code
28458 authenticated = *
28459 .endd
28460
28461 .vitem &*condition&~=&~*&<&'string'&>
28462 .cindex "&%condition%& ACL condition"
28463 .cindex "customizing" "ACL condition"
28464 .cindex "&ACL;" "customized test"
28465 .cindex "&ACL;" "testing, customized"
28466 This feature allows you to make up custom conditions. If the result of
28467 expanding the string is an empty string, the number zero, or one of the strings
28468 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28469 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28470 any other value, some error is assumed to have occurred, and the ACL returns
28471 &"defer"&. However, if the expansion is forced to fail, the condition is
28472 ignored. The effect is to treat it as true, whether it is positive or
28473 negative.
28474
28475 .vitem &*decode&~=&~*&<&'location'&>
28476 .cindex "&%decode%& ACL condition"
28477 This condition is available only when Exim is compiled with the
28478 content-scanning extension, and it is allowed only in the ACL defined by
28479 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28480 If all goes well, the condition is true. It is false only if there are
28481 problems such as a syntax error or a memory shortage. For more details, see
28482 chapter &<<CHAPexiscan>>&.
28483
28484 .vitem &*demime&~=&~*&<&'extension&~list'&>
28485 .cindex "&%demime%& ACL condition"
28486 This condition is available only when Exim is compiled with the
28487 content-scanning extension. Its use is described in section
28488 &<<SECTdemimecond>>&.
28489
28490 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28491 .cindex "&%dnslists%& ACL condition"
28492 .cindex "DNS list" "in ACL"
28493 .cindex "black list (DNS)"
28494 .cindex "&ACL;" "testing a DNS list"
28495 This condition checks for entries in DNS black lists. These are also known as
28496 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28497 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28498 different variants of this condition to describe briefly here. See sections
28499 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28500
28501 .vitem &*domains&~=&~*&<&'domain&~list'&>
28502 .cindex "&%domains%& ACL condition"
28503 .cindex "domain" "ACL checking"
28504 .cindex "&ACL;" "testing a recipient domain"
28505 .vindex "&$domain_data$&"
28506 This condition is relevant only after a RCPT command. It checks that the domain
28507 of the recipient address is in the domain list. If percent-hack processing is
28508 enabled, it is done before this test is done. If the check succeeds with a
28509 lookup, the result of the lookup is placed in &$domain_data$& until the next
28510 &%domains%& test.
28511
28512 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28513 use &%domains%& in a DATA ACL.
28514
28515
28516 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28517 .cindex "&%encrypted%& ACL condition"
28518 .cindex "encryption" "checking in an ACL"
28519 .cindex "&ACL;" "testing for encryption"
28520 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28521 name of the cipher suite in use is tested against the list. To test for
28522 encryption without testing for any specific cipher suite(s), set
28523 .code
28524 encrypted = *
28525 .endd
28526
28527
28528 .vitem &*hosts&~=&~*&<&'host&~list'&>
28529 .cindex "&%hosts%& ACL condition"
28530 .cindex "host" "ACL checking"
28531 .cindex "&ACL;" "testing the client host"
28532 This condition tests that the calling host matches the host list. If you have
28533 name lookups or wildcarded host names and IP addresses in the same host list,
28534 you should normally put the IP addresses first. For example, you could have:
28535 .code
28536 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28537 .endd
28538 The lookup in this example uses the host name for its key. This is implied by
28539 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28540 and it wouldn't matter which way round you had these two items.)
28541
28542 The reason for the problem with host names lies in the left-to-right way that
28543 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28544 but when it reaches an item that requires a host name, it fails if it cannot
28545 find a host name to compare with the pattern. If the above list is given in the
28546 opposite order, the &%accept%& statement fails for a host whose name cannot be
28547 found, even if its IP address is 10.9.8.7.
28548
28549 If you really do want to do the name check first, and still recognize the IP
28550 address even if the name lookup fails, you can rewrite the ACL like this:
28551 .code
28552 accept hosts = dbm;/etc/friendly/hosts
28553 accept hosts = 10.9.8.7
28554 .endd
28555 The default action on failing to find the host name is to assume that the host
28556 is not in the list, so the first &%accept%& statement fails. The second
28557 statement can then check the IP address.
28558
28559 .vindex "&$host_data$&"
28560 If a &%hosts%& condition is satisfied by means of a lookup, the result
28561 of the lookup is made available in the &$host_data$& variable. This
28562 allows you, for example, to set up a statement like this:
28563 .code
28564 deny  hosts = net-lsearch;/some/file
28565 message = $host_data
28566 .endd
28567 which gives a custom error message for each denied host.
28568
28569 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28570 .cindex "&%local_parts%& ACL condition"
28571 .cindex "local part" "ACL checking"
28572 .cindex "&ACL;" "testing a local part"
28573 .vindex "&$local_part_data$&"
28574 This condition is relevant only after a RCPT command. It checks that the local
28575 part of the recipient address is in the list. If percent-hack processing is
28576 enabled, it is done before this test. If the check succeeds with a lookup, the
28577 result of the lookup is placed in &$local_part_data$&, which remains set until
28578 the next &%local_parts%& test.
28579
28580 .vitem &*malware&~=&~*&<&'option'&>
28581 .cindex "&%malware%& ACL condition"
28582 .cindex "&ACL;" "virus scanning"
28583 .cindex "&ACL;" "scanning for viruses"
28584 This condition is available only when Exim is compiled with the
28585 content-scanning extension. It causes the incoming message to be scanned for
28586 viruses. For details, see chapter &<<CHAPexiscan>>&.
28587
28588 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28589 .cindex "&%mime_regex%& ACL condition"
28590 .cindex "&ACL;" "testing by regex matching"
28591 This condition is available only when Exim is compiled with the
28592 content-scanning extension, and it is allowed only in the ACL defined by
28593 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28594 with any of the regular expressions. For details, see chapter
28595 &<<CHAPexiscan>>&.
28596
28597 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28598 .cindex "rate limiting"
28599 This condition can be used to limit the rate at which a user or host submits
28600 messages. Details are given in section &<<SECTratelimiting>>&.
28601
28602 .vitem &*recipients&~=&~*&<&'address&~list'&>
28603 .cindex "&%recipients%& ACL condition"
28604 .cindex "recipient" "ACL checking"
28605 .cindex "&ACL;" "testing a recipient"
28606 This condition is relevant only after a RCPT command. It checks the entire
28607 recipient address against a list of recipients.
28608
28609 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28610 .cindex "&%regex%& ACL condition"
28611 .cindex "&ACL;" "testing by regex matching"
28612 This condition is available only when Exim is compiled with the
28613 content-scanning extension, and is available only in the DATA, MIME, and
28614 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28615 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28616
28617 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28618 .cindex "&%sender_domains%& ACL condition"
28619 .cindex "sender" "ACL checking"
28620 .cindex "&ACL;" "testing a sender domain"
28621 .vindex "&$domain$&"
28622 .vindex "&$sender_address_domain$&"
28623 This condition tests the domain of the sender of the message against the given
28624 domain list. &*Note*&: The domain of the sender address is in
28625 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28626 of this condition. This is an exception to the general rule for testing domain
28627 lists. It is done this way so that, if this condition is used in an ACL for a
28628 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28629 influence the sender checking.
28630
28631 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28632 relaying, because sender addresses are easily, and commonly, forged.
28633
28634 .vitem &*senders&~=&~*&<&'address&~list'&>
28635 .cindex "&%senders%& ACL condition"
28636 .cindex "sender" "ACL checking"
28637 .cindex "&ACL;" "testing a sender"
28638 This condition tests the sender of the message against the given list. To test
28639 for a bounce message, which has an empty sender, set
28640 .code
28641 senders = :
28642 .endd
28643 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28644 relaying, because sender addresses are easily, and commonly, forged.
28645
28646 .vitem &*spam&~=&~*&<&'username'&>
28647 .cindex "&%spam%& ACL condition"
28648 .cindex "&ACL;" "scanning for spam"
28649 This condition is available only when Exim is compiled with the
28650 content-scanning extension. It causes the incoming message to be scanned by
28651 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28652
28653 .vitem &*verify&~=&~certificate*&
28654 .cindex "&%verify%& ACL condition"
28655 .cindex "TLS" "client certificate verification"
28656 .cindex "certificate" "verification of client"
28657 .cindex "&ACL;" "certificate verification"
28658 .cindex "&ACL;" "testing a TLS certificate"
28659 This condition is true in an SMTP session if the session is encrypted, and a
28660 certificate was received from the client, and the certificate was verified. The
28661 server requests a certificate only if the client matches &%tls_verify_hosts%&
28662 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28663
28664 .vitem &*verify&~=&~csa*&
28665 .cindex "CSA verification"
28666 This condition checks whether the sending host (the client) is authorized to
28667 send email. Details of how this works are given in section
28668 &<<SECTverifyCSA>>&.
28669
28670 .vitem &*verify&~=&~header_names_ascii*&
28671 .cindex "&%verify%& ACL condition"
28672 .cindex "&ACL;" "verifying header names only ASCII"
28673 .cindex "header lines" "verifying header names only ASCII"
28674 .cindex "verifying" "header names only ASCII"
28675 This condition is relevant only in an ACL that is run after a message has been
28676 received, that is, in an ACL specified by &%acl_smtp_data%& or
28677 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28678 there are no non-ASCII characters, also excluding control characters.  The
28679 allowable characters are decimal ASCII values 33 through 126.
28680
28681 Exim itself will handle headers with non-ASCII characters, but it can cause
28682 problems for downstream applications, so this option will allow their
28683 detection and rejection in the DATA ACL's.
28684
28685 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28686 .cindex "&%verify%& ACL condition"
28687 .cindex "&ACL;" "verifying sender in the header"
28688 .cindex "header lines" "verifying the sender in"
28689 .cindex "sender" "verifying in header"
28690 .cindex "verifying" "sender in header"
28691 This condition is relevant only in an ACL that is run after a message has been
28692 received, that is, in an ACL specified by &%acl_smtp_data%& or
28693 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28694 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28695 is loosely thought of as a &"sender"& address (hence the name of the test).
28696 However, an address that appears in one of these headers need not be an address
28697 that accepts bounce messages; only sender addresses in envelopes are required
28698 to accept bounces. Therefore, if you use the callout option on this check, you
28699 might want to arrange for a non-empty address in the MAIL command.
28700
28701 Details of address verification and the options are given later, starting at
28702 section &<<SECTaddressverification>>& (callouts are described in section
28703 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28704 condition to restrict it to bounce messages only:
28705 .code
28706 deny    senders = :
28707         message = A valid sender header is required for bounces
28708        !verify  = header_sender
28709 .endd
28710
28711 .vitem &*verify&~=&~header_syntax*&
28712 .cindex "&%verify%& ACL condition"
28713 .cindex "&ACL;" "verifying header syntax"
28714 .cindex "header lines" "verifying syntax"
28715 .cindex "verifying" "header syntax"
28716 This condition is relevant only in an ACL that is run after a message has been
28717 received, that is, in an ACL specified by &%acl_smtp_data%& or
28718 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28719 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28720 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28721 permitted only in locally generated messages and from hosts that match
28722 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28723 appropriate.
28724
28725 Note that this condition is a syntax check only. However, a common spamming
28726 ploy used to be to send syntactically invalid headers such as
28727 .code
28728 To: @
28729 .endd
28730 and this condition can be used to reject such messages, though they are not as
28731 common as they used to be.
28732
28733 .vitem &*verify&~=&~helo*&
28734 .cindex "&%verify%& ACL condition"
28735 .cindex "&ACL;" "verifying HELO/EHLO"
28736 .cindex "HELO" "verifying"
28737 .cindex "EHLO" "verifying"
28738 .cindex "verifying" "EHLO"
28739 .cindex "verifying" "HELO"
28740 This condition is true if a HELO or EHLO command has been received from the
28741 client host, and its contents have been verified. If there has been no previous
28742 attempt to verify the HELO/EHLO contents, it is carried out when this
28743 condition is encountered. See the description of the &%helo_verify_hosts%& and
28744 &%helo_try_verify_hosts%& options for details of how to request verification
28745 independently of this condition.
28746
28747 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28748 option), this condition is always true.
28749
28750
28751 .vitem &*verify&~=&~not_blind*&
28752 .cindex "verifying" "not blind"
28753 .cindex "bcc recipients, verifying none"
28754 This condition checks that there are no blind (bcc) recipients in the message.
28755 Every envelope recipient must appear either in a &'To:'& header line or in a
28756 &'Cc:'& header line for this condition to be true. Local parts are checked
28757 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28758 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28759 used only in a DATA or non-SMTP ACL.
28760
28761 There are, of course, many legitimate messages that make use of blind (bcc)
28762 recipients. This check should not be used on its own for blocking messages.
28763
28764
28765 .vitem &*verify&~=&~recipient/*&<&'options'&>
28766 .cindex "&%verify%& ACL condition"
28767 .cindex "&ACL;" "verifying recipient"
28768 .cindex "recipient" "verifying"
28769 .cindex "verifying" "recipient"
28770 .vindex "&$address_data$&"
28771 This condition is relevant only after a RCPT command. It verifies the current
28772 recipient. Details of address verification are given later, starting at section
28773 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28774 of &$address_data$& is the last value that was set while routing the address.
28775 This applies even if the verification fails. When an address that is being
28776 verified is redirected to a single address, verification continues with the new
28777 address, and in that case, the subsequent value of &$address_data$& is the
28778 value for the child address.
28779
28780 .vitem &*verify&~=&~reverse_host_lookup*&
28781 .cindex "&%verify%& ACL condition"
28782 .cindex "&ACL;" "verifying host reverse lookup"
28783 .cindex "host" "verifying reverse lookup"
28784 This condition ensures that a verified host name has been looked up from the IP
28785 address of the client host. (This may have happened already if the host name
28786 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28787 Verification ensures that the host name obtained from a reverse DNS lookup, or
28788 one of its aliases, does, when it is itself looked up in the DNS, yield the
28789 original IP address.
28790
28791 If this condition is used for a locally generated message (that is, when there
28792 is no client host involved), it always succeeds.
28793
28794 .vitem &*verify&~=&~sender/*&<&'options'&>
28795 .cindex "&%verify%& ACL condition"
28796 .cindex "&ACL;" "verifying sender"
28797 .cindex "sender" "verifying"
28798 .cindex "verifying" "sender"
28799 This condition is relevant only after a MAIL or RCPT command, or after a
28800 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28801 the message's sender is empty (that is, this is a bounce message), the
28802 condition is true. Otherwise, the sender address is verified.
28803
28804 .vindex "&$address_data$&"
28805 .vindex "&$sender_address_data$&"
28806 If there is data in the &$address_data$& variable at the end of routing, its
28807 value is placed in &$sender_address_data$& at the end of verification. This
28808 value can be used in subsequent conditions and modifiers in the same ACL
28809 statement. It does not persist after the end of the current statement. If you
28810 want to preserve the value for longer, you can save it in an ACL variable.
28811
28812 Details of verification are given later, starting at section
28813 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28814 to avoid doing it more than once per message.
28815
28816 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28817 .cindex "&%verify%& ACL condition"
28818 This is a variation of the previous option, in which a modified address is
28819 verified as a sender.
28820 .endlist
28821
28822
28823
28824 .section "Using DNS lists" "SECTmorednslists"
28825 .cindex "DNS list" "in ACL"
28826 .cindex "black list (DNS)"
28827 .cindex "&ACL;" "testing a DNS list"
28828 In its simplest form, the &%dnslists%& condition tests whether the calling host
28829 is on at least one of a number of DNS lists by looking up the inverted IP
28830 address in one or more DNS domains. (Note that DNS list domains are not mail
28831 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28832 special options instead.) For example, if the calling host's IP
28833 address is 192.168.62.43, and the ACL statement is
28834 .code
28835 deny dnslists = blackholes.mail-abuse.org : \
28836                 dialups.mail-abuse.org
28837 .endd
28838 the following records are looked up:
28839 .code
28840 43.62.168.192.blackholes.mail-abuse.org
28841 43.62.168.192.dialups.mail-abuse.org
28842 .endd
28843 As soon as Exim finds an existing DNS record, processing of the list stops.
28844 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28845 to test that a host is on more than one list (an &"and"& conjunction), you can
28846 use two separate conditions:
28847 .code
28848 deny dnslists = blackholes.mail-abuse.org
28849      dnslists = dialups.mail-abuse.org
28850 .endd
28851 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28852 behaves as if the host does not match the list item, that is, as if the DNS
28853 record does not exist. If there are further items in the DNS list, they are
28854 processed.
28855
28856 This is usually the required action when &%dnslists%& is used with &%deny%&
28857 (which is the most common usage), because it prevents a DNS failure from
28858 blocking mail. However, you can change this behaviour by putting one of the
28859 following special items in the list:
28860 .display
28861 &`+include_unknown `&   behave as if the item is on the list
28862 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28863 &`+defer_unknown   `&   give a temporary error
28864 .endd
28865 .cindex "&`+include_unknown`&"
28866 .cindex "&`+exclude_unknown`&"
28867 .cindex "&`+defer_unknown`&"
28868 Each of these applies to any subsequent items on the list. For example:
28869 .code
28870 deny dnslists = +defer_unknown : foo.bar.example
28871 .endd
28872 Testing the list of domains stops as soon as a match is found. If you want to
28873 warn for one list and block for another, you can use two different statements:
28874 .code
28875 deny  dnslists = blackholes.mail-abuse.org
28876 warn  message  = X-Warn: sending host is on dialups list
28877       dnslists = dialups.mail-abuse.org
28878 .endd
28879 DNS list lookups are cached by Exim for the duration of the SMTP session,
28880 so a lookup based on the IP address is done at most once for any incoming
28881 connection. Exim does not share information between multiple incoming
28882 connections (but your local name server cache should be active).
28883
28884
28885
28886 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28887 .cindex "DNS list" "keyed by explicit IP address"
28888 By default, the IP address that is used in a DNS list lookup is the IP address
28889 of the calling host. However, you can specify another IP address by listing it
28890 after the domain name, introduced by a slash. For example:
28891 .code
28892 deny dnslists = black.list.tld/192.168.1.2
28893 .endd
28894 This feature is not very helpful with explicit IP addresses; it is intended for
28895 use with IP addresses that are looked up, for example, the IP addresses of the
28896 MX hosts or nameservers of an email sender address. For an example, see section
28897 &<<SECTmulkeyfor>>& below.
28898
28899
28900
28901
28902 .section "DNS lists keyed on domain names" "SECID202"
28903 .cindex "DNS list" "keyed by domain name"
28904 There are some lists that are keyed on domain names rather than inverted IP
28905 addresses (see for example the &'domain based zones'& link at
28906 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28907 with these lists. You can change the name that is looked up in a DNS list by
28908 listing it after the domain name, introduced by a slash. For example,
28909 .code
28910 deny  message  = Sender's domain is listed at $dnslist_domain
28911       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28912 .endd
28913 This particular example is useful only in ACLs that are obeyed after the
28914 RCPT or DATA commands, when a sender address is available. If (for
28915 example) the message's sender is &'user@tld.example'& the name that is looked
28916 up by this example is
28917 .code
28918 tld.example.dsn.rfc-ignorant.org
28919 .endd
28920 A single &%dnslists%& condition can contain entries for both names and IP
28921 addresses. For example:
28922 .code
28923 deny dnslists = sbl.spamhaus.org : \
28924                 dsn.rfc-ignorant.org/$sender_address_domain
28925 .endd
28926 The first item checks the sending host's IP address; the second checks a domain
28927 name. The whole condition is true if either of the DNS lookups succeeds.
28928
28929
28930
28931
28932 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28933 .cindex "DNS list" "multiple keys for"
28934 The syntax described above for looking up explicitly-defined values (either
28935 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28936 name for the DNS list, what follows the slash can in fact be a list of items.
28937 As with all lists in Exim, the default separator is a colon. However, because
28938 this is a sublist within the list of DNS blacklist domains, it is necessary
28939 either to double the separators like this:
28940 .code
28941 dnslists = black.list.tld/name.1::name.2
28942 .endd
28943 or to change the separator character, like this:
28944 .code
28945 dnslists = black.list.tld/<;name.1;name.2
28946 .endd
28947 If an item in the list is an IP address, it is inverted before the DNS
28948 blacklist domain is appended. If it is not an IP address, no inversion
28949 occurs. Consider this condition:
28950 .code
28951 dnslists = black.list.tld/<;192.168.1.2;a.domain
28952 .endd
28953 The DNS lookups that occur are:
28954 .code
28955 2.1.168.192.black.list.tld
28956 a.domain.black.list.tld
28957 .endd
28958 Once a DNS record has been found (that matches a specific IP return
28959 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28960 are done. If there is a temporary DNS error, the rest of the sublist of domains
28961 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28962 only if no other DNS lookup in this sublist succeeds. In other words, a
28963 successful lookup for any of the items in the sublist overrides a temporary
28964 error for a previous item.
28965
28966 The ability to supply a list of items after the slash is in some sense just a
28967 syntactic convenience. These two examples have the same effect:
28968 .code
28969 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28970 dnslists = black.list.tld/a.domain::b.domain
28971 .endd
28972 However, when the data for the list is obtained from a lookup, the second form
28973 is usually much more convenient. Consider this example:
28974 .code
28975 deny message  = The mail servers for the domain \
28976                 $sender_address_domain \
28977                 are listed at $dnslist_domain ($dnslist_value); \
28978                 see $dnslist_text.
28979      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28980                                    ${lookup dnsdb {>|mxh=\
28981                                    $sender_address_domain} }} }
28982 .endd
28983 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28984 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28985 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28986 of expanding the condition might be something like this:
28987 .code
28988 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28989 .endd
28990 Thus, this example checks whether or not the IP addresses of the sender
28991 domain's mail servers are on the Spamhaus black list.
28992
28993 The key that was used for a successful DNS list lookup is put into the variable
28994 &$dnslist_matched$& (see section &<<SECID204>>&).
28995
28996
28997
28998
28999 .section "Data returned by DNS lists" "SECID203"
29000 .cindex "DNS list" "data returned from"
29001 DNS lists are constructed using address records in the DNS. The original RBL
29002 just used the address 127.0.0.1 on the right hand side of each record, but the
29003 RBL+ list and some other lists use a number of values with different meanings.
29004 The values used on the RBL+ list are:
29005 .display
29006 127.1.0.1  RBL
29007 127.1.0.2  DUL
29008 127.1.0.3  DUL and RBL
29009 127.1.0.4  RSS
29010 127.1.0.5  RSS and RBL
29011 127.1.0.6  RSS and DUL
29012 127.1.0.7  RSS and DUL and RBL
29013 .endd
29014 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29015 different values. Some DNS lists may return more than one address record;
29016 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29017
29018
29019 .section "Variables set from DNS lists" "SECID204"
29020 .cindex "expansion" "variables, set from DNS list"
29021 .cindex "DNS list" "variables set from"
29022 .vindex "&$dnslist_domain$&"
29023 .vindex "&$dnslist_matched$&"
29024 .vindex "&$dnslist_text$&"
29025 .vindex "&$dnslist_value$&"
29026 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29027 the name of the overall domain that matched (for example,
29028 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29029 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29030 the DNS record. When the key is an IP address, it is not reversed in
29031 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29032 cases, for example:
29033 .code
29034 deny dnslists = spamhaus.example
29035 .endd
29036 the key is also available in another variable (in this case,
29037 &$sender_host_address$&). In more complicated cases, however, this is not true.
29038 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29039 might generate a dnslists lookup like this:
29040 .code
29041 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29042 .endd
29043 If this condition succeeds, the value in &$dnslist_matched$& might be
29044 &`192.168.6.7`& (for example).
29045
29046 If more than one address record is returned by the DNS lookup, all the IP
29047 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29048 The variable &$dnslist_text$& contains the contents of any associated TXT
29049 record. For lists such as RBL+ the TXT record for a merged entry is often not
29050 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29051 information.
29052
29053 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29054 &-- although these appear before the condition in the ACL, they are not
29055 expanded until after it has failed. For example:
29056 .code
29057 deny    hosts = !+local_networks
29058         message = $sender_host_address is listed \
29059                   at $dnslist_domain
29060         dnslists = rbl-plus.mail-abuse.example
29061 .endd
29062
29063
29064
29065 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29066 .cindex "DNS list" "matching specific returned data"
29067 You can add an equals sign and an IP address after a &%dnslists%& domain name
29068 in order to restrict its action to DNS records with a matching right hand side.
29069 For example,
29070 .code
29071 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29072 .endd
29073 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29074 any address record is considered to be a match. For the moment, we assume
29075 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29076 describes how multiple records are handled.
29077
29078 More than one IP address may be given for checking, using a comma as a
29079 separator. These are alternatives &-- if any one of them matches, the
29080 &%dnslists%& condition is true. For example:
29081 .code
29082 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29083 .endd
29084 If you want to specify a constraining address list and also specify names or IP
29085 addresses to be looked up, the constraining address list must be specified
29086 first. For example:
29087 .code
29088 deny dnslists = dsn.rfc-ignorant.org\
29089                 =127.0.0.2/$sender_address_domain
29090 .endd
29091
29092 If the character &`&&`& is used instead of &`=`&, the comparison for each
29093 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29094 In other words, the listed addresses are used as bit masks. The comparison is
29095 true if all the bits in the mask are present in the address that is being
29096 tested. For example:
29097 .code
29098 dnslists = a.b.c&0.0.0.3
29099 .endd
29100 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29101 want to test whether one bit or another bit is present (as opposed to both
29102 being present), you must use multiple values. For example:
29103 .code
29104 dnslists = a.b.c&0.0.0.1,0.0.0.2
29105 .endd
29106 matches if the final component of the address is an odd number or two times
29107 an odd number.
29108
29109
29110
29111 .section "Negated DNS matching conditions" "SECID205"
29112 You can supply a negative list of IP addresses as part of a &%dnslists%&
29113 condition. Whereas
29114 .code
29115 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29116 .endd
29117 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29118 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29119 .code
29120 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29121 .endd
29122 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29123 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29124 words, the result of the test is inverted if an exclamation mark appears before
29125 the &`=`& (or the &`&&`&) sign.
29126
29127 &*Note*&: This kind of negation is not the same as negation in a domain,
29128 host, or address list (which is why the syntax is different).
29129
29130 If you are using just one list, the negation syntax does not gain you much. The
29131 previous example is precisely equivalent to
29132 .code
29133 deny  dnslists = a.b.c
29134      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29135 .endd
29136 However, if you are using multiple lists, the negation syntax is clearer.
29137 Consider this example:
29138 .code
29139 deny  dnslists = sbl.spamhaus.org : \
29140                  list.dsbl.org : \
29141                  dnsbl.njabl.org!=127.0.0.3 : \
29142                  relays.ordb.org
29143 .endd
29144 Using only positive lists, this would have to be:
29145 .code
29146 deny  dnslists = sbl.spamhaus.org : \
29147                  list.dsbl.org
29148 deny  dnslists = dnsbl.njabl.org
29149      !dnslists = dnsbl.njabl.org=127.0.0.3
29150 deny  dnslists = relays.ordb.org
29151 .endd
29152 which is less clear, and harder to maintain.
29153
29154
29155
29156
29157 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29158 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29159 thereby providing more than one IP address. When an item in a &%dnslists%& list
29160 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29161 the match to specific results from the DNS lookup, there are two ways in which
29162 the checking can be handled. For example, consider the condition:
29163 .code
29164 dnslists = a.b.c=127.0.0.1
29165 .endd
29166 What happens if the DNS lookup for the incoming IP address yields both
29167 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29168 condition true because at least one given value was found, or is it false
29169 because at least one of the found values was not listed? And how does this
29170 affect negated conditions? Both possibilities are provided for with the help of
29171 additional separators &`==`& and &`=&&`&.
29172
29173 .ilist
29174 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29175 IP addresses matches one of the listed addresses. For the example above, the
29176 condition is true because 127.0.0.1 matches.
29177 .next
29178 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29179 looked up IP addresses matches one of the listed addresses. If the condition is
29180 changed to:
29181 .code
29182 dnslists = a.b.c==127.0.0.1
29183 .endd
29184 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29185 false because 127.0.0.2 is not listed. You would need to have:
29186 .code
29187 dnslists = a.b.c==127.0.0.1,127.0.0.2
29188 .endd
29189 for the condition to be true.
29190 .endlist
29191
29192 When &`!`& is used to negate IP address matching, it inverts the result, giving
29193 the precise opposite of the behaviour above. Thus:
29194 .ilist
29195 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29196 addresses matches one of the listed addresses. Consider:
29197 .code
29198 dnslists = a.b.c!&0.0.0.1
29199 .endd
29200 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29201 false because 127.0.0.1 matches.
29202 .next
29203 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29204 looked up IP address that does not match. Consider:
29205 .code
29206 dnslists = a.b.c!=&0.0.0.1
29207 .endd
29208 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29209 true, because 127.0.0.2 does not match. You would need to have:
29210 .code
29211 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29212 .endd
29213 for the condition to be false.
29214 .endlist
29215 When the DNS lookup yields only a single IP address, there is no difference
29216 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29217
29218
29219
29220
29221 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29222 .cindex "DNS list" "information from merged"
29223 When the facility for restricting the matching IP values in a DNS list is used,
29224 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29225 the true reason for rejection. This happens when lists are merged and the IP
29226 address in the A record is used to distinguish them; unfortunately there is
29227 only one TXT record. One way round this is not to use merged lists, but that
29228 can be inefficient because it requires multiple DNS lookups where one would do
29229 in the vast majority of cases when the host of interest is not on any of the
29230 lists.
29231
29232 A less inefficient way of solving this problem is available. If
29233 two domain names, comma-separated, are given, the second is used first to
29234 do an initial check, making use of any IP value restrictions that are set.
29235 If there is a match, the first domain is used, without any IP value
29236 restrictions, to get the TXT record. As a byproduct of this, there is also
29237 a check that the IP being tested is indeed on the first list. The first
29238 domain is the one that is put in &$dnslist_domain$&. For example:
29239 .code
29240 reject message  = \
29241          rejected because $sender_host_address is blacklisted \
29242          at $dnslist_domain\n$dnslist_text
29243        dnslists = \
29244          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29245          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29246 .endd
29247 For the first blacklist item, this starts by doing a lookup in
29248 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29249 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29250 value, and as long as something is found, it looks for the corresponding TXT
29251 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29252 The second blacklist item is processed similarly.
29253
29254 If you are interested in more than one merged list, the same list must be
29255 given several times, but because the results of the DNS lookups are cached,
29256 the DNS calls themselves are not repeated. For example:
29257 .code
29258 reject dnslists = \
29259          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29260          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29261          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29262          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29263 .endd
29264 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29265 values matches (or if no record is found), this is the only lookup that is
29266 done. Only if there is a match is one of the more specific lists consulted.
29267
29268
29269
29270 .section "DNS lists and IPv6" "SECTmorednslistslast"
29271 .cindex "IPv6" "DNS black lists"
29272 .cindex "DNS list" "IPv6 usage"
29273 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29274 nibble by nibble. For example, if the calling host's IP address is
29275 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29276 .code
29277 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29278   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29279 .endd
29280 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29281 lists contain wildcard records, intended for IPv4, that interact badly with
29282 IPv6. For example, the DNS entry
29283 .code
29284 *.3.some.list.example.    A    127.0.0.1
29285 .endd
29286 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29287 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29288
29289 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29290 &%condition%& condition, as in this example:
29291 .code
29292 deny   condition = ${if isip4{$sender_host_address}}
29293        dnslists  = some.list.example
29294 .endd
29295
29296 If an explicit key is being used for a DNS lookup and it may be an IPv6
29297 address you should specify alternate list separators for both the outer
29298 (DNS list name) list and inner (lookup keys) list:
29299 .code
29300        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29301 .endd
29302
29303 .section "Rate limiting incoming messages" "SECTratelimiting"
29304 .cindex "rate limiting" "client sending"
29305 .cindex "limiting client sending rates"
29306 .oindex "&%smtp_ratelimit_*%&"
29307 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29308 which clients can send email. This is more powerful than the
29309 &%smtp_ratelimit_*%& options, because those options control the rate of
29310 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29311 works across all connections (concurrent and sequential) from the same client
29312 host. The syntax of the &%ratelimit%& condition is:
29313 .display
29314 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29315 .endd
29316 If the average client sending rate is less than &'m'& messages per time
29317 period &'p'& then the condition is false; otherwise it is true.
29318
29319 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29320 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29321 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29322 of &'p'&.
29323
29324 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29325 time interval, for example, &`8h`& for eight hours. A larger time constant
29326 means that it takes Exim longer to forget a client's past behaviour. The
29327 parameter &'m'& is the maximum number of messages that a client is permitted to
29328 send in each time interval. It also specifies the number of messages permitted
29329 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29330 constant, you can allow a client to send more messages in a burst without
29331 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29332 both small, messages must be sent at an even rate.
29333
29334 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29335 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29336 when deploying the &%ratelimit%& ACL condition. The script prints usage
29337 instructions when it is run with no arguments.
29338
29339 The key is used to look up the data for calculating the client's average
29340 sending rate. This data is stored in Exim's spool directory, alongside the
29341 retry and other hints databases. The default key is &$sender_host_address$&,
29342 which means Exim computes the sending rate of each client host IP address.
29343 By changing the key you can change how Exim identifies clients for the purpose
29344 of ratelimiting. For example, to limit the sending rate of each authenticated
29345 user, independent of the computer they are sending from, set the key to
29346 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29347 example, &$authenticated_id$& is only meaningful if the client has
29348 authenticated (which you can check with the &%authenticated%& ACL condition).
29349
29350 The lookup key does not have to identify clients: If you want to limit the
29351 rate at which a recipient receives messages, you can use the key
29352 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29353 ACL.
29354
29355 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29356 specifies what Exim measures the rate of, for example messages or recipients
29357 or bytes. You can adjust the measurement using the &%unique=%& and/or
29358 &%count=%& options. You can also control when Exim updates the recorded rate
29359 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29360 separated by a slash, like the other parameters. They may appear in any order.
29361
29362 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29363 any options that alter the meaning of the stored data. The limit &'m'& is not
29364 stored, so you can alter the configured maximum rate and Exim will still
29365 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29366 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29367 behaviour. The lookup key is not affected by changes to the update mode and
29368 the &%count=%& option.
29369
29370
29371 .section "Ratelimit options for what is being measured" "ratoptmea"
29372 .cindex "rate limiting" "per_* options"
29373 The &%per_conn%& option limits the client's connection rate. It is not
29374 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29375 &%acl_not_smtp_start%& ACLs.
29376
29377 The &%per_mail%& option limits the client's rate of sending messages. This is
29378 the default if none of the &%per_*%& options is specified. It can be used in
29379 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29380 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29381
29382 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29383 the same ACLs as the &%per_mail%& option, though it is best to use this option
29384 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29385 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29386 in its MAIL command, which may be inaccurate or completely missing. You can
29387 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29388 in kilobytes, megabytes, or gigabytes, respectively.
29389
29390 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29391 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29392 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29393 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29394 ACLs the rate is updated with the total recipient count in one go. Note that
29395 in either case the rate limiting engine will see a message with many
29396 recipients as a large high-speed burst.
29397
29398 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29399 number of different recipients that the client has sent messages to in the
29400 last time period. That is, if the client repeatedly sends messages to the same
29401 recipient, its measured rate is not increased. This option can only be used in
29402 &%acl_smtp_rcpt%&.
29403
29404 The &%per_cmd%& option causes Exim to recompute the rate every time the
29405 condition is processed. This can be used to limit the rate of any SMTP
29406 command. If it is used in multiple ACLs it can limit the aggregate rate of
29407 multiple different commands.
29408
29409 The &%count=%& option can be used to alter how much Exim adds to the client's
29410 measured rate. For example, the &%per_byte%& option is equivalent to
29411 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29412 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29413 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29414
29415 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29416
29417
29418 .section "Ratelimit update modes" "ratoptupd"
29419 .cindex "rate limiting" "reading data without updating"
29420 You can specify one of three options with the &%ratelimit%& condition to
29421 control when its database is updated. This section describes the &%readonly%&
29422 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29423
29424 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29425 previously-computed rate to check against the limit.
29426
29427 For example, you can test the client's sending rate and deny it access (when
29428 it is too fast) in the connect ACL. If the client passes this check then it
29429 can go on to send a message, in which case its recorded rate will be updated
29430 in the MAIL ACL. Subsequent connections from the same client will check this
29431 new rate.
29432 .code
29433 acl_check_connect:
29434  deny ratelimit = 100 / 5m / readonly
29435     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29436                   (max $sender_rate_limit)
29437 # ...
29438 acl_check_mail:
29439  warn ratelimit = 100 / 5m / strict
29440     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29441                   (max $sender_rate_limit)
29442 .endd
29443
29444 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29445 processing a message then it may increase the client's measured rate more than
29446 it should. For example, this will happen if you check the &%per_rcpt%& option
29447 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29448 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29449 multiple update problems by using the &%readonly%& option on later ratelimit
29450 checks.
29451
29452 The &%per_*%& options described above do not make sense in some ACLs. If you
29453 use a &%per_*%& option in an ACL where it is not normally permitted then the
29454 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29455 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29456 next section) so you must specify the &%readonly%& option explicitly.
29457
29458
29459 .section "Ratelimit options for handling fast clients" "ratoptfast"
29460 .cindex "rate limiting" "strict and leaky modes"
29461 If a client's average rate is greater than the maximum, the rate limiting
29462 engine can react in two possible ways, depending on the presence of the
29463 &%strict%& or &%leaky%& update modes. This is independent of the other
29464 counter-measures (such as rejecting the message) that may be specified by the
29465 rest of the ACL.
29466
29467 The &%leaky%& (default) option means that the client's recorded rate is not
29468 updated if it is above the limit. The effect of this is that Exim measures the
29469 client's average rate of successfully sent email, which cannot be greater than
29470 the maximum allowed. If the client is over the limit it may suffer some
29471 counter-measures (as specified in the ACL), but it will still be able to send
29472 email at the configured maximum rate, whatever the rate of its attempts. This
29473 is generally the better choice if you have clients that retry automatically.
29474 For example, it does not prevent a sender with an over-aggressive retry rate
29475 from getting any email through.
29476
29477 The &%strict%& option means that the client's recorded rate is always
29478 updated. The effect of this is that Exim measures the client's average rate
29479 of attempts to send email, which can be much higher than the maximum it is
29480 actually allowed. If the client is over the limit it may be subjected to
29481 counter-measures by the ACL. It must slow down and allow sufficient time to
29482 pass that its computed rate falls below the maximum before it can send email
29483 again. The time (the number of smoothing periods) it must wait and not
29484 attempt to send mail can be calculated with this formula:
29485 .code
29486         ln(peakrate/maxrate)
29487 .endd
29488
29489
29490 .section "Limiting the rate of different events" "ratoptuniq"
29491 .cindex "rate limiting" "counting unique events"
29492 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29493 rate of different events. For example, the &%per_addr%& option uses this
29494 mechanism to count the number of different recipients that the client has
29495 sent messages to in the last time period; it is equivalent to
29496 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29497 measure the rate that a client uses different sender addresses with the
29498 options &`per_mail/unique=$sender_address`&.
29499
29500 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29501 has seen for that key. The whole set is thrown away when it is older than the
29502 rate smoothing period &'p'&, so each different event is counted at most once
29503 per period. In the &%leaky%& update mode, an event that causes the client to
29504 go over the limit is not added to the set, in the same way that the client's
29505 recorded rate is not updated in the same situation.
29506
29507 When you combine the &%unique=%& and &%readonly%& options, the specific
29508 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29509 rate.
29510
29511 The &%unique=%& mechanism needs more space in the ratelimit database than the
29512 other &%ratelimit%& options in order to store the event set. The number of
29513 unique values is potentially as large as the rate limit, so the extra space
29514 required increases with larger limits.
29515
29516 The uniqueification is not perfect: there is a small probability that Exim
29517 will think a new event has happened before. If the sender's rate is less than
29518 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29519 the measured rate can go above the limit, in which case Exim may under-count
29520 events by a significant margin. Fortunately, if the rate is high enough (2.7
29521 times the limit) that the false positive rate goes above 9%, then Exim will
29522 throw away the over-full event set before the measured rate falls below the
29523 limit. Therefore the only harm should be that exceptionally high sending rates
29524 are logged incorrectly; any countermeasures you configure will be as effective
29525 as intended.
29526
29527
29528 .section "Using rate limiting" "useratlim"
29529 Exim's other ACL facilities are used to define what counter-measures are taken
29530 when the rate limit is exceeded. This might be anything from logging a warning
29531 (for example, while measuring existing sending rates in order to define
29532 policy), through time delays to slow down fast senders, up to rejecting the
29533 message. For example:
29534 .code
29535 # Log all senders' rates
29536 warn ratelimit = 0 / 1h / strict
29537      log_message = Sender rate $sender_rate / $sender_rate_period
29538
29539 # Slow down fast senders; note the need to truncate $sender_rate
29540 # at the decimal point.
29541 warn ratelimit = 100 / 1h / per_rcpt / strict
29542      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29543                    $sender_rate_limit }s
29544
29545 # Keep authenticated users under control
29546 deny authenticated = *
29547      ratelimit = 100 / 1d / strict / $authenticated_id
29548
29549 # System-wide rate limit
29550 defer message = Sorry, too busy. Try again later.
29551      ratelimit = 10 / 1s / $primary_hostname
29552
29553 # Restrict incoming rate from each host, with a default
29554 # set using a macro and special cases looked up in a table.
29555 defer message = Sender rate exceeds $sender_rate_limit \
29556                messages per $sender_rate_period
29557      ratelimit = ${lookup {$sender_host_address} \
29558                    cdb {DB/ratelimits.cdb} \
29559                    {$value} {RATELIMIT} }
29560 .endd
29561 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29562 especially with the &%per_rcpt%& option, you may suffer from a performance
29563 bottleneck caused by locking on the ratelimit hints database. Apart from
29564 making your ACLs less complicated, you can reduce the problem by using a
29565 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29566 this means that Exim will lose its hints data after a reboot (including retry
29567 hints, the callout cache, and ratelimit data).
29568
29569
29570
29571 .section "Address verification" "SECTaddressverification"
29572 .cindex "verifying address" "options for"
29573 .cindex "policy control" "address verification"
29574 Several of the &%verify%& conditions described in section
29575 &<<SECTaclconditions>>& cause addresses to be verified. Section
29576 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29577 The verification conditions can be followed by options that modify the
29578 verification process. The options are separated from the keyword and from each
29579 other by slashes, and some of them contain parameters. For example:
29580 .code
29581 verify = sender/callout
29582 verify = recipient/defer_ok/callout=10s,defer_ok
29583 .endd
29584 The first stage of address verification, which always happens, is to run the
29585 address through the routers, in &"verify mode"&. Routers can detect the
29586 difference between verification and routing for delivery, and their actions can
29587 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29588 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29589 The available options are as follows:
29590
29591 .ilist
29592 If the &%callout%& option is specified, successful routing to one or more
29593 remote hosts is followed by a &"callout"& to those hosts as an additional
29594 check. Callouts and their sub-options are discussed in the next section.
29595 .next
29596 If there is a defer error while doing verification routing, the ACL
29597 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29598 options, the condition is forced to be true instead. Note that this is a main
29599 verification option as well as a suboption for callouts.
29600 .next
29601 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29602 discusses the reporting of sender address verification failures.
29603 .next
29604 The &%success_on_redirect%& option causes verification always to succeed
29605 immediately after a successful redirection. By default, if a redirection
29606 generates just one address, that address is also verified. See further
29607 discussion in section &<<SECTredirwhilveri>>&.
29608 .endlist
29609
29610 .cindex "verifying address" "differentiating failures"
29611 .vindex "&$recipient_verify_failure$&"
29612 .vindex "&$sender_verify_failure$&"
29613 .vindex "&$acl_verify_message$&"
29614 After an address verification failure, &$acl_verify_message$& contains the
29615 error message that is associated with the failure. It can be preserved by
29616 coding like this:
29617 .code
29618 warn  !verify = sender
29619        set acl_m0 = $acl_verify_message
29620 .endd
29621 If you are writing your own custom rejection message or log message when
29622 denying access, you can use this variable to include information about the
29623 verification failure.
29624
29625 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29626 appropriate) contains one of the following words:
29627
29628 .ilist
29629 &%qualify%&: The address was unqualified (no domain), and the message
29630 was neither local nor came from an exempted host.
29631 .next
29632 &%route%&: Routing failed.
29633 .next
29634 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29635 occurred at or before the MAIL command (that is, on initial
29636 connection, HELO, or MAIL).
29637 .next
29638 &%recipient%&: The RCPT command in a callout was rejected.
29639 .next
29640 &%postmaster%&: The postmaster check in a callout was rejected.
29641 .endlist
29642
29643 The main use of these variables is expected to be to distinguish between
29644 rejections of MAIL and rejections of RCPT in callouts.
29645
29646
29647
29648
29649 .section "Callout verification" "SECTcallver"
29650 .cindex "verifying address" "by callout"
29651 .cindex "callout" "verification"
29652 .cindex "SMTP" "callout verification"
29653 For non-local addresses, routing verifies the domain, but is unable to do any
29654 checking of the local part. There are situations where some means of verifying
29655 the local part is desirable. One way this can be done is to make an SMTP
29656 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29657 a subsequent host for a recipient address, to see if the host accepts the
29658 address. We use the term &'callout'& to cover both cases. Note that for a
29659 sender address, the callback is not to the client host that is trying to
29660 deliver the message, but to one of the hosts that accepts incoming mail for the
29661 sender's domain.
29662
29663 Exim does not do callouts by default. If you want them to happen, you must
29664 request them by setting appropriate options on the &%verify%& condition, as
29665 described below. This facility should be used with care, because it can add a
29666 lot of resource usage to the cost of verifying an address. However, Exim does
29667 cache the results of callouts, which helps to reduce the cost. Details of
29668 caching are in section &<<SECTcallvercache>>&.
29669
29670 Recipient callouts are usually used only between hosts that are controlled by
29671 the same administration. For example, a corporate gateway host could use
29672 callouts to check for valid recipients on an internal mailserver. A successful
29673 callout does not guarantee that a real delivery to the address would succeed;
29674 on the other hand, a failing callout does guarantee that a delivery would fail.
29675
29676 If the &%callout%& option is present on a condition that verifies an address, a
29677 second stage of verification occurs if the address is successfully routed to
29678 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29679 &(manualroute)& router, where the router specifies the hosts. However, if a
29680 router that does not set up hosts routes to an &(smtp)& transport with a
29681 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29682 &%hosts_override%& set, its hosts are always used, whether or not the router
29683 supplies a host list.
29684 Callouts are only supported on &(smtp)& transports.
29685
29686 The port that is used is taken from the transport, if it is specified and is a
29687 remote transport. (For routers that do verification only, no transport need be
29688 specified.) Otherwise, the default SMTP port is used. If a remote transport
29689 specifies an outgoing interface, this is used; otherwise the interface is not
29690 specified. Likewise, the text that is used for the HELO command is taken from
29691 the transport's &%helo_data%& option; if there is no transport, the value of
29692 &$smtp_active_hostname$& is used.
29693
29694 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29695 test whether a bounce message could be delivered to the sender address. The
29696 following SMTP commands are sent:
29697 .display
29698 &`HELO `&<&'local host name'&>
29699 &`MAIL FROM:<>`&
29700 &`RCPT TO:`&<&'the address to be tested'&>
29701 &`QUIT`&
29702 .endd
29703 LHLO is used instead of HELO if the transport's &%protocol%& option is
29704 set to &"lmtp"&.
29705
29706 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29707 settings.
29708
29709 A recipient callout check is similar. By default, it also uses an empty address
29710 for the sender. This default is chosen because most hosts do not make use of
29711 the sender address when verifying a recipient. Using the same address means
29712 that a single cache entry can be used for each recipient. Some sites, however,
29713 do make use of the sender address when verifying. These are catered for by the
29714 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29715
29716 If the response to the RCPT command is a 2&'xx'& code, the verification
29717 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29718 Exim tries the next host, if any. If there is a problem with all the remote
29719 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29720 &%callout%& option is given, in which case the condition is forced to succeed.
29721
29722 .cindex "SMTP" "output flushing, disabling for callout"
29723 A callout may take a little time. For this reason, Exim normally flushes SMTP
29724 output before performing a callout in an ACL, to avoid unexpected timeouts in
29725 clients when the SMTP PIPELINING extension is in use. The flushing can be
29726 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29727
29728
29729
29730
29731 .section "Additional parameters for callouts" "CALLaddparcall"
29732 .cindex "callout" "additional parameters for"
29733 The &%callout%& option can be followed by an equals sign and a number of
29734 optional parameters, separated by commas. For example:
29735 .code
29736 verify = recipient/callout=10s,defer_ok
29737 .endd
29738 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29739 separate verify options, is retained for backwards compatibility, but is now
29740 deprecated. The additional parameters for &%callout%& are as follows:
29741
29742
29743 .vlist
29744 .vitem <&'a&~time&~interval'&>
29745 .cindex "callout" "timeout, specifying"
29746 This specifies the timeout that applies for the callout attempt to each host.
29747 For example:
29748 .code
29749 verify = sender/callout=5s
29750 .endd
29751 The default is 30 seconds. The timeout is used for each response from the
29752 remote host. It is also used for the initial connection, unless overridden by
29753 the &%connect%& parameter.
29754
29755
29756 .vitem &*connect&~=&~*&<&'time&~interval'&>
29757 .cindex "callout" "connection timeout, specifying"
29758 This parameter makes it possible to set a different (usually smaller) timeout
29759 for making the SMTP connection. For example:
29760 .code
29761 verify = sender/callout=5s,connect=1s
29762 .endd
29763 If not specified, this timeout defaults to the general timeout value.
29764
29765 .vitem &*defer_ok*&
29766 .cindex "callout" "defer, action on"
29767 When this parameter is present, failure to contact any host, or any other kind
29768 of temporary error, is treated as success by the ACL. However, the cache is not
29769 updated in this circumstance.
29770
29771 .vitem &*fullpostmaster*&
29772 .cindex "callout" "full postmaster check"
29773 This operates like the &%postmaster%& option (see below), but if the check for
29774 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29775 accordance with the specification in RFC 2821. The RFC states that the
29776 unqualified address &'postmaster'& should be accepted.
29777
29778
29779 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29780 .cindex "callout" "sender when verifying header"
29781 When verifying addresses in header lines using the &%header_sender%&
29782 verification option, Exim behaves by default as if the addresses are envelope
29783 sender addresses from a message. Callout verification therefore tests to see
29784 whether a bounce message could be delivered, by using an empty address in the
29785 MAIL command. However, it is arguable that these addresses might never be used
29786 as envelope senders, and could therefore justifiably reject bounce messages
29787 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29788 address to use in the MAIL command. For example:
29789 .code
29790 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29791 .endd
29792 This parameter is available only for the &%header_sender%& verification option.
29793
29794
29795 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29796 .cindex "callout" "overall timeout, specifying"
29797 This parameter sets an overall timeout for performing a callout verification.
29798 For example:
29799 .code
29800 verify = sender/callout=5s,maxwait=30s
29801 .endd
29802 This timeout defaults to four times the callout timeout for individual SMTP
29803 commands. The overall timeout applies when there is more than one host that can
29804 be tried. The timeout is checked before trying the next host. This prevents
29805 very long delays if there are a large number of hosts and all are timing out
29806 (for example, when network connections are timing out).
29807
29808
29809 .vitem &*no_cache*&
29810 .cindex "callout" "cache, suppressing"
29811 .cindex "caching callout, suppressing"
29812 When this parameter is given, the callout cache is neither read nor updated.
29813
29814 .vitem &*postmaster*&
29815 .cindex "callout" "postmaster; checking"
29816 When this parameter is set, a successful callout check is followed by a similar
29817 check for the local part &'postmaster'& at the same domain. If this address is
29818 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29819 the postmaster check is recorded in a cache record; if it is a failure, this is
29820 used to fail subsequent callouts for the domain without a connection being
29821 made, until the cache record expires.
29822
29823 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29824 The postmaster check uses an empty sender in the MAIL command by default.
29825 You can use this parameter to do a postmaster check using a different address.
29826 For example:
29827 .code
29828 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29829 .endd
29830 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29831 one overrides. The &%postmaster%& parameter is equivalent to this example:
29832 .code
29833 require  verify = sender/callout=postmaster_mailfrom=
29834 .endd
29835 &*Warning*&: The caching arrangements for postmaster checking do not take
29836 account of the sender address. It is assumed that either the empty address or
29837 a fixed non-empty address will be used. All that Exim remembers is that the
29838 postmaster check for the domain succeeded or failed.
29839
29840
29841 .vitem &*random*&
29842 .cindex "callout" "&""random""& check"
29843 When this parameter is set, before doing the normal callout check, Exim does a
29844 check for a &"random"& local part at the same domain. The local part is not
29845 really random &-- it is defined by the expansion of the option
29846 &%callout_random_local_part%&, which defaults to
29847 .code
29848 $primary_hostname-$tod_epoch-testing
29849 .endd
29850 The idea here is to try to determine whether the remote host accepts all local
29851 parts without checking. If it does, there is no point in doing callouts for
29852 specific local parts. If the &"random"& check succeeds, the result is saved in
29853 a cache record, and used to force the current and subsequent callout checks to
29854 succeed without a connection being made, until the cache record expires.
29855
29856 .vitem &*use_postmaster*&
29857 .cindex "callout" "sender for recipient check"
29858 This parameter applies to recipient callouts only. For example:
29859 .code
29860 deny  !verify = recipient/callout=use_postmaster
29861 .endd
29862 .vindex "&$qualify_domain$&"
29863 It causes a non-empty postmaster address to be used in the MAIL command when
29864 performing the callout for the recipient, and also for a &"random"& check if
29865 that is configured. The local part of the address is &`postmaster`& and the
29866 domain is the contents of &$qualify_domain$&.
29867
29868 .vitem &*use_sender*&
29869 This option applies to recipient callouts only. For example:
29870 .code
29871 require  verify = recipient/callout=use_sender
29872 .endd
29873 It causes the message's actual sender address to be used in the MAIL
29874 command when performing the callout, instead of an empty address. There is no
29875 need to use this option unless you know that the called hosts make use of the
29876 sender when checking recipients. If used indiscriminately, it reduces the
29877 usefulness of callout caching.
29878 .endlist
29879
29880 If you use any of the parameters that set a non-empty sender for the MAIL
29881 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29882 &%use_sender%&), you should think about possible loops. Recipient checking is
29883 usually done between two hosts that are under the same management, and the host
29884 that receives the callouts is not normally configured to do callouts itself.
29885 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29886 these circumstances.
29887
29888 However, if you use a non-empty sender address for a callout to an arbitrary
29889 host, there is the likelihood that the remote host will itself initiate a
29890 callout check back to your host. As it is checking what appears to be a message
29891 sender, it is likely to use an empty address in MAIL, thus avoiding a
29892 callout loop. However, to be on the safe side it would be best to set up your
29893 own ACLs so that they do not do sender verification checks when the recipient
29894 is the address you use for header sender or postmaster callout checking.
29895
29896 Another issue to think about when using non-empty senders for callouts is
29897 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29898 by the sender/recipient combination; thus, for any given recipient, many more
29899 actual callouts are performed than when an empty sender or postmaster is used.
29900
29901
29902
29903
29904 .section "Callout caching" "SECTcallvercache"
29905 .cindex "hints database" "callout cache"
29906 .cindex "callout" "cache, description of"
29907 .cindex "caching" "callout"
29908 Exim caches the results of callouts in order to reduce the amount of resources
29909 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29910 option. A hints database called &"callout"& is used for the cache. Two
29911 different record types are used: one records the result of a callout check for
29912 a specific address, and the other records information that applies to the
29913 entire domain (for example, that it accepts the local part &'postmaster'&).
29914
29915 When an original callout fails, a detailed SMTP error message is given about
29916 the failure. However, for subsequent failures use the cache data, this message
29917 is not available.
29918
29919 The expiry times for negative and positive address cache records are
29920 independent, and can be set by the global options &%callout_negative_expire%&
29921 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29922
29923 If a host gives a negative response to an SMTP connection, or rejects any
29924 commands up to and including
29925 .code
29926 MAIL FROM:<>
29927 .endd
29928 (but not including the MAIL command with a non-empty address),
29929 any callout attempt is bound to fail. Exim remembers such failures in a
29930 domain cache record, which it uses to fail callouts for the domain without
29931 making new connections, until the domain record times out. There are two
29932 separate expiry times for domain cache records:
29933 &%callout_domain_negative_expire%& (default 3h) and
29934 &%callout_domain_positive_expire%& (default 7d).
29935
29936 Domain records expire when the negative expiry time is reached if callouts
29937 cannot be made for the domain, or if the postmaster check failed.
29938 Otherwise, they expire when the positive expiry time is reached. This
29939 ensures that, for example, a host that stops accepting &"random"& local parts
29940 will eventually be noticed.
29941
29942 The callout caching mechanism is based on the domain of the address that is
29943 being tested. If the domain routes to several hosts, it is assumed that their
29944 behaviour will be the same.
29945
29946
29947
29948 .section "Sender address verification reporting" "SECTsenaddver"
29949 .cindex "verifying" "suppressing error details"
29950 See section &<<SECTaddressverification>>& for a general discussion of
29951 verification. When sender verification fails in an ACL, the details of the
29952 failure are given as additional output lines before the 550 response to the
29953 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29954 you might see:
29955 .code
29956 MAIL FROM:<xyz@abc.example>
29957 250 OK
29958 RCPT TO:<pqr@def.example>
29959 550-Verification failed for <xyz@abc.example>
29960 550-Called:   192.168.34.43
29961 550-Sent:     RCPT TO:<xyz@abc.example>
29962 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29963 550 Sender verification failed
29964 .endd
29965 If more than one RCPT command fails in the same way, the details are given
29966 only for the first of them. However, some administrators do not want to send
29967 out this much information. You can suppress the details by adding
29968 &`/no_details`& to the ACL statement that requests sender verification. For
29969 example:
29970 .code
29971 verify = sender/no_details
29972 .endd
29973
29974 .section "Redirection while verifying" "SECTredirwhilveri"
29975 .cindex "verifying" "redirection while"
29976 .cindex "address redirection" "while verifying"
29977 A dilemma arises when a local address is redirected by aliasing or forwarding
29978 during verification: should the generated addresses themselves be verified,
29979 or should the successful expansion of the original address be enough to verify
29980 it? By default, Exim takes the following pragmatic approach:
29981
29982 .ilist
29983 When an incoming address is redirected to just one child address, verification
29984 continues with the child address, and if that fails to verify, the original
29985 verification also fails.
29986 .next
29987 When an incoming address is redirected to more than one child address,
29988 verification does not continue. A success result is returned.
29989 .endlist
29990
29991 This seems the most reasonable behaviour for the common use of aliasing as a
29992 way of redirecting different local parts to the same mailbox. It means, for
29993 example, that a pair of alias entries of the form
29994 .code
29995 A.Wol:   aw123
29996 aw123:   :fail: Gone away, no forwarding address
29997 .endd
29998 work as expected, with both local parts causing verification failure. When a
29999 redirection generates more than one address, the behaviour is more like a
30000 mailing list, where the existence of the alias itself is sufficient for
30001 verification to succeed.
30002
30003 It is possible, however, to change the default behaviour so that all successful
30004 redirections count as successful verifications, however many new addresses are
30005 generated. This is specified by the &%success_on_redirect%& verification
30006 option. For example:
30007 .code
30008 require verify = recipient/success_on_redirect/callout=10s
30009 .endd
30010 In this example, verification succeeds if a router generates a new address, and
30011 the callout does not occur, because no address was routed to a remote host.
30012
30013 When verification is being tested via the &%-bv%& option, the treatment of
30014 redirections is as just described, unless the &%-v%& or any debugging option is
30015 also specified. In that case, full verification is done for every generated
30016 address and a report is output for each of them.
30017
30018
30019
30020 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30021 .cindex "CSA" "verifying"
30022 Client SMTP Authorization is a system that allows a site to advertise
30023 which machines are and are not permitted to send email. This is done by placing
30024 special SRV records in the DNS; these are looked up using the client's HELO
30025 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30026 Authorization checks in Exim are performed by the ACL condition:
30027 .code
30028 verify = csa
30029 .endd
30030 This fails if the client is not authorized. If there is a DNS problem, or if no
30031 valid CSA SRV record is found, or if the client is authorized, the condition
30032 succeeds. These three cases can be distinguished using the expansion variable
30033 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30034 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30035 be likely to cause problems for legitimate email.
30036
30037 The error messages produced by the CSA code include slightly more
30038 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30039 looking up the CSA SRV record, or problems looking up the CSA target
30040 address record. There are four reasons for &$csa_status$& being &"fail"&:
30041
30042 .ilist
30043 The client's host name is explicitly not authorized.
30044 .next
30045 The client's IP address does not match any of the CSA target IP addresses.
30046 .next
30047 The client's host name is authorized but it has no valid target IP addresses
30048 (for example, the target's addresses are IPv6 and the client is using IPv4).
30049 .next
30050 The client's host name has no CSA SRV record but a parent domain has asserted
30051 that all subdomains must be explicitly authorized.
30052 .endlist
30053
30054 The &%csa%& verification condition can take an argument which is the domain to
30055 use for the DNS query. The default is:
30056 .code
30057 verify = csa/$sender_helo_name
30058 .endd
30059 This implementation includes an extension to CSA. If the query domain
30060 is an address literal such as [192.0.2.95], or if it is a bare IP
30061 address, Exim searches for CSA SRV records in the reverse DNS as if
30062 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30063 meaningful to say:
30064 .code
30065 verify = csa/$sender_host_address
30066 .endd
30067 In fact, this is the check that Exim performs if the client does not say HELO.
30068 This extension can be turned off by setting the main configuration option
30069 &%dns_csa_use_reverse%& to be false.
30070
30071 If a CSA SRV record is not found for the domain itself, a search
30072 is performed through its parent domains for a record which might be
30073 making assertions about subdomains. The maximum depth of this search is limited
30074 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30075 default. Exim does not look for CSA SRV records in a top level domain, so the
30076 default settings handle HELO domains as long as seven
30077 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30078 of legitimate HELO domains.
30079
30080 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30081 direct SRV lookups, this is not sufficient because of the extra parent domain
30082 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30083 addresses into lookups in the reverse DNS space. The result of a successful
30084 lookup such as:
30085 .code
30086 ${lookup dnsdb {csa=$sender_helo_name}}
30087 .endd
30088 has two space-separated fields: an authorization code and a target host name.
30089 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30090 authorization required but absent, or &"?"& for unknown.
30091
30092
30093
30094
30095 .section "Bounce address tag validation" "SECTverifyPRVS"
30096 .cindex "BATV, verifying"
30097 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30098 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30099 Genuine incoming bounce messages should therefore always be addressed to
30100 recipients that have a valid tag. This scheme is a way of detecting unwanted
30101 bounce messages caused by sender address forgeries (often called &"collateral
30102 spam"&), because the recipients of such messages do not include valid tags.
30103
30104 There are two expansion items to help with the implementation of the BATV
30105 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30106 the original envelope sender address by using a simple key to add a hash of the
30107 address and some time-based randomizing information. The &%prvs%& expansion
30108 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30109 The syntax of these expansion items is described in section
30110 &<<SECTexpansionitems>>&.
30111
30112 As an example, suppose the secret per-address keys are stored in an MySQL
30113 database. A query to look up the key for an address could be defined as a macro
30114 like this:
30115 .code
30116 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30117                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30118                 }{$value}}
30119 .endd
30120 Suppose also that the senders who make use of BATV are defined by an address
30121 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30122 use this:
30123 .code
30124 # Bounces: drop unsigned addresses for BATV senders
30125 deny message = This address does not send an unsigned reverse path
30126      senders = :
30127      recipients = +batv_senders
30128
30129 # Bounces: In case of prvs-signed address, check signature.
30130 deny message = Invalid reverse path signature.
30131      senders = :
30132      condition  = ${prvscheck {$local_part@$domain}\
30133                   {PRVSCHECK_SQL}{1}}
30134      !condition = $prvscheck_result
30135 .endd
30136 The first statement rejects recipients for bounce messages that are addressed
30137 to plain BATV sender addresses, because it is known that BATV senders do not
30138 send out messages with plain sender addresses. The second statement rejects
30139 recipients that are prvs-signed, but with invalid signatures (either because
30140 the key is wrong, or the signature has timed out).
30141
30142 A non-prvs-signed address is not rejected by the second statement, because the
30143 &%prvscheck%& expansion yields an empty string if its first argument is not a
30144 prvs-signed address, thus causing the &%condition%& condition to be false. If
30145 the first argument is a syntactically valid prvs-signed address, the yield is
30146 the third string (in this case &"1"&), whether or not the cryptographic and
30147 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30148 of the checks (empty for failure, &"1"& for success).
30149
30150 There is one more issue you must consider when implementing prvs-signing:
30151 you have to ensure that the routers accept prvs-signed addresses and
30152 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30153 router to remove the signature with a configuration along these lines:
30154 .code
30155 batv_redirect:
30156   driver = redirect
30157   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30158 .endd
30159 This works because, if the third argument of &%prvscheck%& is empty, the result
30160 of the expansion of a prvs-signed address is the decoded value of the original
30161 address. This router should probably be the first of your routers that handles
30162 local addresses.
30163
30164 To create BATV-signed addresses in the first place, a transport of this form
30165 can be used:
30166 .code
30167 external_smtp_batv:
30168   driver = smtp
30169   return_path = ${prvs {$return_path} \
30170                        {${lookup mysql{SELECT \
30171                        secret FROM batv_prvs WHERE \
30172                        sender='${quote_mysql:$sender_address}'} \
30173                        {$value}fail}}}
30174 .endd
30175 If no key can be found for the existing return path, no signing takes place.
30176
30177
30178
30179 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30180 .cindex "&ACL;" "relay control"
30181 .cindex "relaying" "control by ACL"
30182 .cindex "policy control" "relay control"
30183 An MTA is said to &'relay'& a message if it receives it from some host and
30184 delivers it directly to another host as a result of a remote address contained
30185 within it. Redirecting a local address via an alias or forward file and then
30186 passing the message on to another host is not relaying,
30187 .cindex "&""percent hack""&"
30188 but a redirection as a result of the &"percent hack"& is.
30189
30190 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30191 A host which is acting as a gateway or an MX backup is concerned with incoming
30192 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30193 a host which is acting as a smart host for a number of clients is concerned
30194 with outgoing relaying from those clients to the Internet at large. Often the
30195 same host is fulfilling both functions,
30196 . ///
30197 . as illustrated in the diagram below,
30198 . ///
30199 but in principle these two kinds of relaying are entirely independent. What is
30200 not wanted is the transmission of mail from arbitrary remote hosts through your
30201 system to arbitrary domains.
30202
30203
30204 You can implement relay control by means of suitable statements in the ACL that
30205 runs for each RCPT command. For convenience, it is often easiest to use
30206 Exim's named list facility to define the domains and hosts involved. For
30207 example, suppose you want to do the following:
30208
30209 .ilist
30210 Deliver a number of domains to mailboxes on the local host (or process them
30211 locally in some other way). Let's say these are &'my.dom1.example'& and
30212 &'my.dom2.example'&.
30213 .next
30214 Relay mail for a number of other domains for which you are the secondary MX.
30215 These might be &'friend1.example'& and &'friend2.example'&.
30216 .next
30217 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30218 Suppose your LAN is 192.168.45.0/24.
30219 .endlist
30220
30221
30222 In the main part of the configuration, you put the following definitions:
30223 .code
30224 domainlist local_domains    = my.dom1.example : my.dom2.example
30225 domainlist relay_to_domains = friend1.example : friend2.example
30226 hostlist   relay_from_hosts = 192.168.45.0/24
30227 .endd
30228 Now you can use these definitions in the ACL that is run for every RCPT
30229 command:
30230 .code
30231 acl_check_rcpt:
30232   accept domains = +local_domains : +relay_to_domains
30233   accept hosts   = +relay_from_hosts
30234 .endd
30235 The first statement accepts any RCPT command that contains an address in
30236 the local or relay domains. For any other domain, control passes to the second
30237 statement, which accepts the command only if it comes from one of the relay
30238 hosts. In practice, you will probably want to make your ACL more sophisticated
30239 than this, for example, by including sender and recipient verification. The
30240 default configuration includes a more comprehensive example, which is described
30241 in chapter &<<CHAPdefconfil>>&.
30242
30243
30244
30245 .section "Checking a relay configuration" "SECTcheralcon"
30246 .cindex "relaying" "checking control of"
30247 You can check the relay characteristics of your configuration in the same way
30248 that you can test any ACL behaviour for an incoming SMTP connection, by using
30249 the &%-bh%& option to run a fake SMTP session with which you interact.
30250
30251 For specifically testing for unwanted relaying, the host
30252 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30253 host from the host on which Exim is running, using the normal telnet port, you
30254 will see a normal telnet connection message and then quite a long delay. Be
30255 patient. The remote host is making an SMTP connection back to your host, and
30256 trying a number of common probes to test for open relay vulnerability. The
30257 results of the tests will eventually appear on your terminal.
30258 .ecindex IIDacl
30259
30260
30261
30262 . ////////////////////////////////////////////////////////////////////////////
30263 . ////////////////////////////////////////////////////////////////////////////
30264
30265 .chapter "Content scanning at ACL time" "CHAPexiscan"
30266 .scindex IIDcosca "content scanning" "at ACL time"
30267 The extension of Exim to include content scanning at ACL time, formerly known
30268 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30269 was integrated into the main source for Exim release 4.50, and Tom continues to
30270 maintain it. Most of the wording of this chapter is taken from Tom's
30271 specification.
30272
30273 It is also possible to scan the content of messages at other times. The
30274 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30275 scanning after all the ACLs have run. A transport filter can be used to scan
30276 messages at delivery time (see the &%transport_filter%& option, described in
30277 chapter &<<CHAPtransportgeneric>>&).
30278
30279 If you want to include the ACL-time content-scanning features when you compile
30280 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30281 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30282
30283 .ilist
30284 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30285 for all MIME parts for SMTP and non-SMTP messages, respectively.
30286 .next
30287 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30288 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30289 run at the end of message reception (the &%acl_smtp_data%& ACL).
30290 .next
30291 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30292 of messages, or parts of messages, for debugging purposes.
30293 .next
30294 Additional expansion variables that are set in the new ACL and by the new
30295 conditions.
30296 .next
30297 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30298 .endlist
30299
30300 There is another content-scanning configuration option for &_Local/Makefile_&,
30301 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30302 condition is compiled, in addition to all the other content-scanning features.
30303
30304 Content-scanning is continually evolving, and new features are still being
30305 added. While such features are still unstable and liable to incompatible
30306 changes, they are made available in Exim by setting options whose names begin
30307 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30308 this manual. You can find out about them by reading the file called
30309 &_doc/experimental.txt_&.
30310
30311 All the content-scanning facilities work on a MBOX copy of the message that is
30312 temporarily created in a file called:
30313 .display
30314 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30315 .endd
30316 The &_.eml_& extension is a friendly hint to virus scanners that they can
30317 expect an MBOX-like structure inside that file. The file is created when the
30318 first content scanning facility is called. Subsequent calls to content
30319 scanning conditions open the same file again. The directory is recursively
30320 removed when the &%acl_smtp_data%& ACL has finished running, unless
30321 .code
30322 control = no_mbox_unspool
30323 .endd
30324 has been encountered. When the MIME ACL decodes files, they are put into the
30325 same directory by default.
30326
30327
30328
30329 .section "Scanning for viruses" "SECTscanvirus"
30330 .cindex "virus scanning"
30331 .cindex "content scanning" "for viruses"
30332 .cindex "content scanning" "the &%malware%& condition"
30333 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30334 It supports a &"generic"& interface to scanners called via the shell, and
30335 specialized interfaces for &"daemon"& type virus scanners, which are resident
30336 in memory and thus are much faster.
30337
30338 A timeout of 2 minutes is applied to a scanner call;
30339 if it expires then a defer action is taken.
30340
30341 .oindex "&%av_scanner%&"
30342 You can set the &%av_scanner%& option in the main part of the configuration
30343 to specify which scanner to use, together with any additional options that
30344 are needed. The basic syntax is as follows:
30345 .display
30346 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30347 .endd
30348 If you do not set &%av_scanner%&, it defaults to
30349 .code
30350 av_scanner = sophie:/var/run/sophie
30351 .endd
30352 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30353 before use.
30354 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30355 The following scanner types are supported in this release:
30356
30357 .vlist
30358 .vitem &%avast%&
30359 .cindex "virus scanners" "avast"
30360 This is the scanner daemon of Avast. It has been tested with Avast Core
30361 Security (currenty at version 1.1.7).
30362 You can get a trial version at &url(http://www.avast.com) or for Linux
30363 at &url(http://www.avast.com/linux-server-antivirus).
30364 This scanner type takes one option,
30365 which can be either a full path to a UNIX socket,
30366 or host and port specifiers separated by white space.
30367 The host may be a name or an IP address; the port is either a
30368 single number or a pair of numbers with a dash between.
30369 Any further options are given, on separate lines,
30370 to the daemon as options before the main scan command.
30371 For example:
30372 .code
30373 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30374 av_scanner = avast:192.168.2.22 5036
30375 .endd
30376 If you omit the argument, the default path
30377 &_/var/run/avast/scan.sock_&
30378 is used.
30379 If you use a remote host,
30380 you need to make Exim's spool directory available to it,
30381 as the scanner is passed a file path, not file contents.
30382 For information about available commands and their options you may use 
30383 .code
30384 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30385     FLAGS
30386     SENSITIVITY
30387     PACK
30388 .endd
30389
30390
30391 .vitem &%aveserver%&
30392 .cindex "virus scanners" "Kaspersky"
30393 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30394 at &url(http://www.kaspersky.com). This scanner type takes one option,
30395 which is the path to the daemon's UNIX socket. The default is shown in this
30396 example:
30397 .code
30398 av_scanner = aveserver:/var/run/aveserver
30399 .endd
30400
30401
30402 .vitem &%clamd%&
30403 .cindex "virus scanners" "clamd"
30404 This daemon-type scanner is GPL and free. You can get it at
30405 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30406 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30407 in the MIME ACL. This no longer believed to be necessary. One option is
30408 required: either the path and name of a UNIX socket file, or a hostname or IP
30409 number, and a port, separated by space, as in the second of these examples:
30410 .code
30411 av_scanner = clamd:/opt/clamd/socket
30412 av_scanner = clamd:192.0.2.3 1234
30413 av_scanner = clamd:192.0.2.3 1234:local
30414 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30415 .endd
30416 If the value of av_scanner points to a UNIX socket file or contains the local
30417 keyword, then the ClamAV interface will pass a filename containing the data
30418 to be scanned, which will should normally result in less I/O happening and be
30419 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30420 Exim does not assume that there is a common filesystem with the remote host.
30421 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30422 you be running a version of ClamAV prior to 0.95.
30423
30424 The final example shows that multiple TCP targets can be specified.  Exim will
30425 randomly use one for each incoming email (i.e. it load balances them).  Note
30426 that only TCP targets may be used if specifying a list of scanners; a UNIX
30427 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30428 unavailable, Exim will try the remaining one(s) until it finds one that works.
30429 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30430 not keep track of scanner state between multiple messages, and the scanner
30431 selection is random, so the message will get logged in the mainlog for each
30432 email that the down scanner gets chosen first (message wrapped to be readable):
30433 .code
30434 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30435    clamd: connection to localhost, port 3310 failed
30436    (Connection refused)
30437 .endd
30438
30439 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30440 contributing the code for this scanner.
30441
30442 .vitem &%cmdline%&
30443 .cindex "virus scanners" "command line interface"
30444 This is the keyword for the generic command line scanner interface. It can be
30445 used to attach virus scanners that are invoked from the shell. This scanner
30446 type takes 3 mandatory options:
30447
30448 .olist
30449 The full path and name of the scanner binary, with all command line options,
30450 and a placeholder (&`%s`&) for the directory to scan.
30451
30452 .next
30453 A regular expression to match against the STDOUT and STDERR output of the
30454 virus scanner. If the expression matches, a virus was found. You must make
30455 absolutely sure that this expression matches on &"virus found"&. This is called
30456 the &"trigger"& expression.
30457
30458 .next
30459 Another regular expression, containing exactly one pair of parentheses, to
30460 match the name of the virus found in the scanners output. This is called the
30461 &"name"& expression.
30462 .endlist olist
30463
30464 For example, Sophos Sweep reports a virus on a line like this:
30465 .code
30466 Virus 'W32/Magistr-B' found in file ./those.bat
30467 .endd
30468 For the trigger expression, we can match the phrase &"found in file"&. For the
30469 name expression, we want to extract the W32/Magistr-B string, so we can match
30470 for the single quotes left and right of it. Altogether, this makes the
30471 configuration setting:
30472 .code
30473 av_scanner = cmdline:\
30474              /path/to/sweep -ss -all -rec -archive %s:\
30475              found in file:'(.+)'
30476 .endd
30477 .vitem &%drweb%&
30478 .cindex "virus scanners" "DrWeb"
30479 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30480 takes one option,
30481 either a full path to a UNIX socket,
30482 or host and port specifiers separated by white space.
30483 The host may be a name or an IP address; the port is either a
30484 single number or a pair of numbers with a dash between.
30485 For example:
30486 .code
30487 av_scanner = drweb:/var/run/drwebd.sock
30488 av_scanner = drweb:192.168.2.20 31337
30489 .endd
30490 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30491 is used. Thanks to Alex Miller for contributing the code for this scanner.
30492
30493 .vitem &%f-protd%&
30494 .cindex "virus scanners" "f-protd"
30495 The f-protd scanner is accessed via HTTP over TCP.
30496 One argument is taken, being a space-separated hostname and port number
30497 (or port-range).
30498 For example:
30499 .code
30500 av_scanner = f-protd:localhost 10200-10204
30501 .endd
30502 If you omit the argument, the default values show above are used.
30503
30504 .vitem &%fsecure%&
30505 .cindex "virus scanners" "F-Secure"
30506 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30507 argument which is the path to a UNIX socket. For example:
30508 .code
30509 av_scanner = fsecure:/path/to/.fsav
30510 .endd
30511 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30512 Thelmen for contributing the code for this scanner.
30513
30514 .vitem &%kavdaemon%&
30515 .cindex "virus scanners" "Kaspersky"
30516 This is the scanner daemon of Kaspersky Version 4. This version of the
30517 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30518 scanner type takes one option, which is the path to the daemon's UNIX socket.
30519 For example:
30520 .code
30521 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30522 .endd
30523 The default path is &_/var/run/AvpCtl_&.
30524
30525 .vitem &%mksd%&
30526 .cindex "virus scanners" "mksd"
30527 This is a daemon type scanner that is aimed mainly at Polish users, though some
30528 parts of documentation are now available in English. You can get it at
30529 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30530 the maximum number of processes used simultaneously to scan the attachments,
30531 provided that the demime facility is employed and also provided that mksd has
30532 been run with at least the same number of child processes. For example:
30533 .code
30534 av_scanner = mksd:2
30535 .endd
30536 You can safely omit this option (the default value is 1).
30537
30538 .vitem &%sock%&
30539 .cindex "virus scanners" "simple socket-connected"
30540 This is a general-purpose way of talking to simple scanner daemons
30541 running on the local machine.
30542 There are four options:
30543 an address (which may be an IP addres and port, or the path of a Unix socket),
30544 a commandline to send (may include a single %s which will be replaced with
30545 the path to the mail file to be scanned),
30546 an RE to trigger on from the returned data,
30547 an RE to extract malware_name from the returned data.
30548 For example:
30549 .code
30550 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30551 .endd
30552 Default for the socket specifier is &_/tmp/malware.sock_&.
30553 Default for the commandline is &_%s\n_&.
30554 Both regular-expressions are required.
30555
30556 .vitem &%sophie%&
30557 .cindex "virus scanners" "Sophos and Sophie"
30558 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30559 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30560 for this scanner type is the path to the UNIX socket that Sophie uses for
30561 client communication. For example:
30562 .code
30563 av_scanner = sophie:/tmp/sophie
30564 .endd
30565 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30566 the option.
30567 .endlist
30568
30569 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30570 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30571 ACL.
30572
30573 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30574 makes it possible to use different scanners. See further below for an example.
30575 The &%malware%& condition caches its results, so when you use it multiple times
30576 for the same message, the actual scanning process is only carried out once.
30577 However, using expandable items in &%av_scanner%& disables this caching, in
30578 which case each use of the &%malware%& condition causes a new scan of the
30579 message.
30580
30581 The &%malware%& condition takes a right-hand argument that is expanded before
30582 use. It can then be one of
30583
30584 .ilist
30585 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30586 The condition succeeds if a virus was found, and fail otherwise. This is the
30587 recommended usage.
30588 .next
30589 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30590 the condition fails immediately.
30591 .next
30592 A regular expression, in which case the message is scanned for viruses. The
30593 condition succeeds if a virus is found and its name matches the regular
30594 expression. This allows you to take special actions on certain types of virus.
30595 .endlist
30596
30597 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
30598 even if there is a problem with the virus scanner. Otherwise, such a problem
30599 causes the ACL to defer.
30600
30601 .vindex "&$malware_name$&"
30602 When a virus is found, the condition sets up an expansion variable called
30603 &$malware_name$& that contains the name of the virus. You can use it in a
30604 &%message%& modifier that specifies the error returned to the sender, and/or in
30605 logging data.
30606
30607 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30608 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30609 &%malware%& condition.
30610
30611 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30612 imposed by your anti-virus scanner.
30613
30614 Here is a very simple scanning example:
30615 .code
30616 deny message = This message contains malware ($malware_name)
30617      demime = *
30618      malware = *
30619 .endd
30620 The next example accepts messages when there is a problem with the scanner:
30621 .code
30622 deny message = This message contains malware ($malware_name)
30623      demime = *
30624      malware = */defer_ok
30625 .endd
30626 The next example shows how to use an ACL variable to scan with both sophie and
30627 aveserver. It assumes you have set:
30628 .code
30629 av_scanner = $acl_m0
30630 .endd
30631 in the main Exim configuration.
30632 .code
30633 deny message = This message contains malware ($malware_name)
30634      set acl_m0 = sophie
30635      malware = *
30636
30637 deny message = This message contains malware ($malware_name)
30638      set acl_m0 = aveserver
30639      malware = *
30640 .endd
30641
30642
30643 .section "Scanning with SpamAssassin" "SECTscanspamass"
30644 .cindex "content scanning" "for spam"
30645 .cindex "spam scanning"
30646 .cindex "SpamAssassin"
30647 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30648 score and a report for the message. You can get SpamAssassin at
30649 &url(http://www.spamassassin.org), or, if you have a working Perl
30650 installation, you can use CPAN by running:
30651 .code
30652 perl -MCPAN -e 'install Mail::SpamAssassin'
30653 .endd
30654 SpamAssassin has its own set of configuration files. Please review its
30655 documentation to see how you can tweak it. The default installation should work
30656 nicely, however.
30657
30658 .oindex "&%spamd_address%&"
30659 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30660 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30661 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30662 part of the Exim configuration as follows (example):
30663 .code
30664 spamd_address = 192.168.99.45 387
30665 .endd
30666 You do not need to set this option if you use the default. As of version 2.60,
30667 &%spamd%& also supports communication over UNIX sockets. If you want to use
30668 these, supply &%spamd_address%& with an absolute file name instead of a
30669 address/port pair:
30670 .code
30671 spamd_address = /var/run/spamd_socket
30672 .endd
30673 You can have multiple &%spamd%& servers to improve scalability. These can
30674 reside on other hardware reachable over the network. To specify multiple
30675 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30676 option, separated with colons:
30677 .code
30678 spamd_address = 192.168.2.10 783 : \
30679                 192.168.2.11 783 : \
30680                 192.168.2.12 783
30681 .endd
30682 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30683 fashion. When a server fails to respond to the connection attempt, all other
30684 servers are tried until one succeeds. If no server responds, the &%spam%&
30685 condition defers.
30686
30687 &*Warning*&: It is not possible to use the UNIX socket connection method with
30688 multiple &%spamd%& servers.
30689
30690 The &%spamd_address%& variable is expanded before use if it starts with
30691 a dollar sign. In this case, the expansion may return a string that is
30692 used as the list so that multiple spamd servers can be the result of an
30693 expansion.
30694
30695 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30696 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30697 .code
30698 deny message = This message was classified as SPAM
30699      spam = joe
30700 .endd
30701 The right-hand side of the &%spam%& condition specifies a name. This is
30702 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30703 to scan using a specific profile, but rather use the SpamAssassin system-wide
30704 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30705 However, you must put something on the right-hand side.
30706
30707 The name allows you to use per-domain or per-user antispam profiles in
30708 principle, but this is not straightforward in practice, because a message may
30709 have multiple recipients, not necessarily all in the same domain. Because the
30710 &%spam%& condition has to be called from a DATA ACL in order to be able to
30711 read the contents of the message, the variables &$local_part$& and &$domain$&
30712 are not set.
30713
30714 The right-hand side of the &%spam%& condition is expanded before being used, so
30715 you can put lookups or conditions there. When the right-hand side evaluates to
30716 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30717
30718
30719 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30720 large ones may cause significant performance degradation. As most spam messages
30721 are quite small, it is recommended that you do not scan the big ones. For
30722 example:
30723 .code
30724 deny message = This message was classified as SPAM
30725      condition = ${if < {$message_size}{10K}}
30726      spam = nobody
30727 .endd
30728
30729 The &%spam%& condition returns true if the threshold specified in the user's
30730 SpamAssassin profile has been matched or exceeded. If you want to use the
30731 &%spam%& condition for its side effects (see the variables below), you can make
30732 it always return &"true"& by appending &`:true`& to the username.
30733
30734 .cindex "spam scanning" "returned variables"
30735 When the &%spam%& condition is run, it sets up a number of expansion
30736 variables. These variables are saved with the received message, thus they are
30737 available for use at delivery time.
30738
30739 .vlist
30740 .vitem &$spam_score$&
30741 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30742 for inclusion in log or reject messages.
30743
30744 .vitem &$spam_score_int$&
30745 The spam score of the message, multiplied by ten, as an integer value. For
30746 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30747 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30748 The integer value is useful for numeric comparisons in conditions.
30749
30750 .vitem &$spam_bar$&
30751 A string consisting of a number of &"+"& or &"-"& characters, representing the
30752 integer part of the spam score value. A spam score of 4.4 would have a
30753 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30754 headers, since MUAs can match on such strings.
30755
30756 .vitem &$spam_report$&
30757 A multiline text table, containing the full SpamAssassin report for the
30758 message. Useful for inclusion in headers or reject messages.
30759 .endlist
30760
30761 The &%spam%& condition caches its results unless expansion in
30762 spamd_address was used. If you call it again with the same user name, it
30763 does not scan again, but rather returns the same values as before.
30764
30765 The &%spam%& condition returns DEFER if there is any error while running
30766 the message through SpamAssassin or if the expansion of spamd_address
30767 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30768 statement block), append &`/defer_ok`& to the right-hand side of the
30769 spam condition, like this:
30770 .code
30771 deny message = This message was classified as SPAM
30772      spam    = joe/defer_ok
30773 .endd
30774 This causes messages to be accepted even if there is a problem with &%spamd%&.
30775
30776 Here is a longer, commented example of the use of the &%spam%&
30777 condition:
30778 .code
30779 # put headers in all messages (no matter if spam or not)
30780 warn  spam = nobody:true
30781       add_header = X-Spam-Score: $spam_score ($spam_bar)
30782       add_header = X-Spam-Report: $spam_report
30783
30784 # add second subject line with *SPAM* marker when message
30785 # is over threshold
30786 warn  spam = nobody
30787       add_header = Subject: *SPAM* $h_Subject:
30788
30789 # reject spam at high scores (> 12)
30790 deny  message = This message scored $spam_score spam points.
30791       spam = nobody:true
30792       condition = ${if >{$spam_score_int}{120}{1}{0}}
30793 .endd
30794
30795
30796
30797 .section "Scanning MIME parts" "SECTscanmimepart"
30798 .cindex "content scanning" "MIME parts"
30799 .cindex "MIME content scanning"
30800 .oindex "&%acl_smtp_mime%&"
30801 .oindex "&%acl_not_smtp_mime%&"
30802 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30803 each MIME part of an SMTP message, including multipart types, in the sequence
30804 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30805 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30806 options may both refer to the same ACL if you want the same processing in both
30807 cases.
30808
30809 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30810 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30811 the case of a non-SMTP message. However, a MIME ACL is called only if the
30812 message contains a &'Content-Type:'& header line. When a call to a MIME
30813 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30814 result code is sent to the client. In the case of an SMTP message, the
30815 &%acl_smtp_data%& ACL is not called when this happens.
30816
30817 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30818 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30819 condition to match against the raw MIME part. You can also use the
30820 &%mime_regex%& condition to match against the decoded MIME part (see section
30821 &<<SECTscanregex>>&).
30822
30823 At the start of a MIME ACL, a number of variables are set from the header
30824 information for the relevant MIME part. These are described below. The contents
30825 of the MIME part are not by default decoded into a disk file except for MIME
30826 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30827 part into a disk file, you can use the &%decode%& condition. The general
30828 syntax is:
30829 .display
30830 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30831 .endd
30832 The right hand side is expanded before use. After expansion,
30833 the value can be:
30834
30835 .olist
30836 &"0"& or &"false"&, in which case no decoding is done.
30837 .next
30838 The string &"default"&. In that case, the file is put in the temporary
30839 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30840 a sequential file name consisting of the message id and a sequence number. The
30841 full path and name is available in &$mime_decoded_filename$& after decoding.
30842 .next
30843 A full path name starting with a slash. If the full name is an existing
30844 directory, it is used as a replacement for the default directory. The filename
30845 is then sequentially assigned. If the path does not exist, it is used as
30846 the full path and file name.
30847 .next
30848 If the string does not start with a slash, it is used as the
30849 filename, and the default path is then used.
30850 .endlist
30851 The &%decode%& condition normally succeeds. It is only false for syntax
30852 errors or unusual circumstances such as memory shortages. You can easily decode
30853 a file with its original, proposed filename using
30854 .code
30855 decode = $mime_filename
30856 .endd
30857 However, you should keep in mind that &$mime_filename$& might contain
30858 anything. If you place files outside of the default path, they are not
30859 automatically unlinked.
30860
30861 For RFC822 attachments (these are messages attached to messages, with a
30862 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30863 as for the primary message, only that the &$mime_is_rfc822$& expansion
30864 variable is set (see below). Attached messages are always decoded to disk
30865 before being checked, and the files are unlinked once the check is done.
30866
30867 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30868 used to match regular expressions against raw and decoded MIME parts,
30869 respectively. They are described in section &<<SECTscanregex>>&.
30870
30871 .cindex "MIME content scanning" "returned variables"
30872 The following list describes all expansion variables that are
30873 available in the MIME ACL:
30874
30875 .vlist
30876 .vitem &$mime_boundary$&
30877 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30878 have a boundary string, which is stored in this variable. If the current part
30879 has no boundary parameter in the &'Content-Type:'& header, this variable
30880 contains the empty string.
30881
30882 .vitem &$mime_charset$&
30883 This variable contains the character set identifier, if one was found in the
30884 &'Content-Type:'& header. Examples for charset identifiers are:
30885 .code
30886 us-ascii
30887 gb2312 (Chinese)
30888 iso-8859-1
30889 .endd
30890 Please note that this value is not normalized, so you should do matches
30891 case-insensitively.
30892
30893 .vitem &$mime_content_description$&
30894 This variable contains the normalized content of the &'Content-Description:'&
30895 header. It can contain a human-readable description of the parts content. Some
30896 implementations repeat the filename for attachments here, but they are usually
30897 only used for display purposes.
30898
30899 .vitem &$mime_content_disposition$&
30900 This variable contains the normalized content of the &'Content-Disposition:'&
30901 header. You can expect strings like &"attachment"& or &"inline"& here.
30902
30903 .vitem &$mime_content_id$&
30904 This variable contains the normalized content of the &'Content-ID:'& header.
30905 This is a unique ID that can be used to reference a part from another part.
30906
30907 .vitem &$mime_content_size$&
30908 This variable is set only after the &%decode%& modifier (see above) has been
30909 successfully run. It contains the size of the decoded part in kilobytes. The
30910 size is always rounded up to full kilobytes, so only a completely empty part
30911 has a &$mime_content_size$& of zero.
30912
30913 .vitem &$mime_content_transfer_encoding$&
30914 This variable contains the normalized content of the
30915 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30916 type. Typical values are &"base64"& and &"quoted-printable"&.
30917
30918 .vitem &$mime_content_type$&
30919 If the MIME part has a &'Content-Type:'& header, this variable contains its
30920 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30921 are some examples of popular MIME types, as they may appear in this variable:
30922 .code
30923 text/plain
30924 text/html
30925 application/octet-stream
30926 image/jpeg
30927 audio/midi
30928 .endd
30929 If the MIME part has no &'Content-Type:'& header, this variable contains the
30930 empty string.
30931
30932 .vitem &$mime_decoded_filename$&
30933 This variable is set only after the &%decode%& modifier (see above) has been
30934 successfully run. It contains the full path and file name of the file
30935 containing the decoded data.
30936 .endlist
30937
30938 .cindex "RFC 2047"
30939 .vlist
30940 .vitem &$mime_filename$&
30941 This is perhaps the most important of the MIME variables. It contains a
30942 proposed filename for an attachment, if one was found in either the
30943 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30944 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30945 found, this variable contains the empty string.
30946
30947 .vitem &$mime_is_coverletter$&
30948 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30949 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30950 content in the cover letter, while not restricting attachments at all.
30951
30952 The variable contains 1 (true) for a MIME part believed to be part of the
30953 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30954 follows:
30955
30956 .olist
30957 The outermost MIME part of a message is always a cover letter.
30958
30959 .next
30960 If a multipart/alternative or multipart/related MIME part is a cover letter,
30961 so are all MIME subparts within that multipart.
30962
30963 .next
30964 If any other multipart is a cover letter, the first subpart is a cover letter,
30965 and the rest are attachments.
30966
30967 .next
30968 All parts contained within an attachment multipart are attachments.
30969 .endlist olist
30970
30971 As an example, the following will ban &"HTML mail"& (including that sent with
30972 alternative plain text), while allowing HTML files to be attached. HTML
30973 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30974 .code
30975 deny message = HTML mail is not accepted here
30976 !condition = $mime_is_rfc822
30977 condition = $mime_is_coverletter
30978 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30979 .endd
30980 .vitem &$mime_is_multipart$&
30981 This variable has the value 1 (true) when the current part has the main type
30982 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30983 Since multipart entities only serve as containers for other parts, you may not
30984 want to carry out specific actions on them.
30985
30986 .vitem &$mime_is_rfc822$&
30987 This variable has the value 1 (true) if the current part is not a part of the
30988 checked message itself, but part of an attached message. Attached message
30989 decoding is fully recursive.
30990
30991 .vitem &$mime_part_count$&
30992 This variable is a counter that is raised for each processed MIME part. It
30993 starts at zero for the very first part (which is usually a multipart). The
30994 counter is per-message, so it is reset when processing RFC822 attachments (see
30995 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30996 complete, so you can use it in the DATA ACL to determine the number of MIME
30997 parts of a message. For non-MIME messages, this variable contains the value -1.
30998 .endlist
30999
31000
31001
31002 .section "Scanning with regular expressions" "SECTscanregex"
31003 .cindex "content scanning" "with regular expressions"
31004 .cindex "regular expressions" "content scanning with"
31005 You can specify your own custom regular expression matches on the full body of
31006 the message, or on individual MIME parts.
31007
31008 The &%regex%& condition takes one or more regular expressions as arguments and
31009 matches them against the full message (when called in the DATA ACL) or a raw
31010 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31011 linewise, with a maximum line length of 32K characters. That means you cannot
31012 have multiline matches with the &%regex%& condition.
31013
31014 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31015 to 32K of decoded content (the whole content at once, not linewise). If the
31016 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31017 is decoded automatically when &%mime_regex%& is executed (using default path
31018 and filename values). If the decoded data is larger than  32K, only the first
31019 32K characters are checked.
31020
31021 The regular expressions are passed as a colon-separated list. To include a
31022 literal colon, you must double it. Since the whole right-hand side string is
31023 expanded before being used, you must also escape dollar signs and backslashes
31024 with more backslashes, or use the &`\N`& facility to disable expansion.
31025 Here is a simple example that contains two regular expressions:
31026 .code
31027 deny message = contains blacklisted regex ($regex_match_string)
31028      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31029 .endd
31030 The conditions returns true if any one of the regular expressions matches. The
31031 &$regex_match_string$& expansion variable is then set up and contains the
31032 matching regular expression.
31033
31034 &*Warning*&: With large messages, these conditions can be fairly
31035 CPU-intensive.
31036
31037
31038
31039
31040 .section "The demime condition" "SECTdemimecond"
31041 .cindex "content scanning" "MIME checking"
31042 .cindex "MIME content scanning"
31043 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31044 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31045 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31046 ACL functionality, but provides no additional facilities. Please note that this
31047 condition is deprecated and kept only for backward compatibility. You must set
31048 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31049 use the &%demime%& condition.
31050
31051 The &%demime%& condition unpacks MIME containers in the message. It detects
31052 errors in MIME containers and can match file extensions found in the message
31053 against a list. Using this facility produces files containing the unpacked MIME
31054 parts of the message in the temporary scan directory. If you do antivirus
31055 scanning, it is recommended that you use the &%demime%& condition before the
31056 antivirus (&%malware%&) condition.
31057
31058 On the right-hand side of the &%demime%& condition you can pass a
31059 colon-separated list of file extensions that it should match against. For
31060 example:
31061 .code
31062 deny message = Found blacklisted file attachment
31063      demime  = vbs:com:bat:pif:prf:lnk
31064 .endd
31065 If one of the file extensions is found, the condition is true, otherwise it is
31066 false. If there is a temporary error while demimeing (for example, &"disk
31067 full"&), the condition defers, and the message is temporarily rejected (unless
31068 the condition is on a &%warn%& verb).
31069
31070 The right-hand side is expanded before being treated as a list, so you can have
31071 conditions and lookups there. If it expands to an empty string, &"false"&, or
31072 zero (&"0"&), no demimeing is done and the condition is false.
31073
31074 The &%demime%& condition set the following variables:
31075
31076 .vlist
31077 .vitem &$demime_errorlevel$&
31078 .vindex "&$demime_errorlevel$&"
31079 When an error is detected in a MIME container, this variable contains the
31080 severity of the error, as an integer number. The higher the value, the more
31081 severe the error (the current maximum value is 3). If this variable is unset or
31082 zero, no error occurred.
31083
31084 .vitem &$demime_reason$&
31085 .vindex "&$demime_reason$&"
31086 When &$demime_errorlevel$& is greater than zero, this variable contains a
31087 human-readable text string describing the MIME error that occurred.
31088 .endlist
31089
31090 .vlist
31091 .vitem &$found_extension$&
31092 .vindex "&$found_extension$&"
31093 When the &%demime%& condition is true, this variable contains the file
31094 extension it found.
31095 .endlist
31096
31097 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31098 the &%demime%& condition, and are not changed on subsequent calls.
31099
31100 If you do not want to check for file extensions, but rather use the &%demime%&
31101 condition for unpacking or error checking purposes, pass &"*"& as the
31102 right-hand side value. Here is a more elaborate example of how to use this
31103 facility:
31104 .code
31105 # Reject messages with serious MIME container errors
31106 deny  message = Found MIME error ($demime_reason).
31107       demime = *
31108       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31109
31110 # Reject known virus spreading file extensions.
31111 # Accepting these is pretty much braindead.
31112 deny  message = contains $found_extension file (blacklisted).
31113       demime  = com:vbs:bat:pif:scr
31114
31115 # Freeze .exe and .doc files. Postmaster can
31116 # examine them and eventually thaw them.
31117 deny  log_message = Another $found_extension file.
31118       demime = exe:doc
31119       control = freeze
31120 .endd
31121 .ecindex IIDcosca
31122
31123
31124
31125
31126 . ////////////////////////////////////////////////////////////////////////////
31127 . ////////////////////////////////////////////////////////////////////////////
31128
31129 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31130          "Local scan function"
31131 .scindex IIDlosca "&[local_scan()]& function" "description of"
31132 .cindex "customizing" "input scan using C function"
31133 .cindex "policy control" "by local scan function"
31134 In these days of email worms, viruses, and ever-increasing spam, some sites
31135 want to apply a lot of checking to messages before accepting them.
31136
31137 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31138 passing messages to external virus and spam scanning software. You can also do
31139 a certain amount in Exim itself through string expansions and the &%condition%&
31140 condition in the ACL that runs after the SMTP DATA command or the ACL for
31141 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31142
31143 To allow for further customization to a site's own requirements, there is the
31144 possibility of linking Exim with a private message scanning function, written
31145 in C. If you want to run code that is written in something other than C, you
31146 can of course use a little C stub to call it.
31147
31148 The local scan function is run once for every incoming message, at the point
31149 when Exim is just about to accept the message.
31150 It can therefore be used to control non-SMTP messages from local processes as
31151 well as messages arriving via SMTP.
31152
31153 Exim applies a timeout to calls of the local scan function, and there is an
31154 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31155 Zero means &"no timeout"&.
31156 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31157 before calling the local scan function, so that the most common types of crash
31158 are caught. If the timeout is exceeded or one of those signals is caught, the
31159 incoming message is rejected with a temporary error if it is an SMTP message.
31160 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31161 code. The incident is logged on the main and reject logs.
31162
31163
31164
31165 .section "Building Exim to use a local scan function" "SECID207"
31166 .cindex "&[local_scan()]& function" "building Exim to use"
31167 To make use of the local scan function feature, you must tell Exim where your
31168 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31169 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31170 directory, so you might set
31171 .code
31172 LOCAL_SCAN_SOURCE=Local/local_scan.c
31173 .endd
31174 for example. The function must be called &[local_scan()]&. It is called by
31175 Exim after it has received a message, when the success return code is about to
31176 be sent. This is after all the ACLs have been run. The return code from your
31177 function controls whether the message is actually accepted or not. There is a
31178 commented template function (that just accepts the message) in the file
31179 _src/local_scan.c_.
31180
31181 If you want to make use of Exim's run time configuration file to set options
31182 for your &[local_scan()]& function, you must also set
31183 .code
31184 LOCAL_SCAN_HAS_OPTIONS=yes
31185 .endd
31186 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31187
31188
31189
31190
31191 .section "API for local_scan()" "SECTapiforloc"
31192 .cindex "&[local_scan()]& function" "API description"
31193 You must include this line near the start of your code:
31194 .code
31195 #include "local_scan.h"
31196 .endd
31197 This header file defines a number of variables and other values, and the
31198 prototype for the function itself. Exim is coded to use unsigned char values
31199 almost exclusively, and one of the things this header defines is a shorthand
31200 for &`unsigned char`& called &`uschar`&.
31201 It also contains the following macro definitions, to simplify casting character
31202 strings and pointers to character strings:
31203 .code
31204 #define CS   (char *)
31205 #define CCS  (const char *)
31206 #define CSS  (char **)
31207 #define US   (unsigned char *)
31208 #define CUS  (const unsigned char *)
31209 #define USS  (unsigned char **)
31210 .endd
31211 The function prototype for &[local_scan()]& is:
31212 .code
31213 extern int local_scan(int fd, uschar **return_text);
31214 .endd
31215 The arguments are as follows:
31216
31217 .ilist
31218 &%fd%& is a file descriptor for the file that contains the body of the message
31219 (the -D file). The file is open for reading and writing, but updating it is not
31220 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31221
31222 The descriptor is positioned at character 19 of the file, which is the first
31223 character of the body itself, because the first 19 characters are the message
31224 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31225 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31226 case this changes in some future version.
31227 .next
31228 &%return_text%& is an address which you can use to return a pointer to a text
31229 string at the end of the function. The value it points to on entry is NULL.
31230 .endlist
31231
31232 The function must return an &%int%& value which is one of the following macros:
31233
31234 .vlist
31235 .vitem &`LOCAL_SCAN_ACCEPT`&
31236 .vindex "&$local_scan_data$&"
31237 The message is accepted. If you pass back a string of text, it is saved with
31238 the message, and made available in the variable &$local_scan_data$&. No
31239 newlines are permitted (if there are any, they are turned into spaces) and the
31240 maximum length of text is 1000 characters.
31241
31242 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31243 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31244 queued without immediate delivery, and is frozen.
31245
31246 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31247 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31248 queued without immediate delivery.
31249
31250 .vitem &`LOCAL_SCAN_REJECT`&
31251 The message is rejected; the returned text is used as an error message which is
31252 passed back to the sender and which is also logged. Newlines are permitted &--
31253 they cause a multiline response for SMTP rejections, but are converted to
31254 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31255 used.
31256
31257 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31258 The message is temporarily rejected; the returned text is used as an error
31259 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31260 problem"& is used.
31261
31262 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31263 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31264 message is not written to the reject log. It has the effect of unsetting the
31265 &%rejected_header%& log selector for just this rejection. If
31266 &%rejected_header%& is already unset (see the discussion of the
31267 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31268 same as LOCAL_SCAN_REJECT.
31269
31270 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31271 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31272 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31273 .endlist
31274
31275 If the message is not being received by interactive SMTP, rejections are
31276 reported by writing to &%stderr%& or by sending an email, as configured by the
31277 &%-oe%& command line options.
31278
31279
31280
31281 .section "Configuration options for local_scan()" "SECTconoptloc"
31282 .cindex "&[local_scan()]& function" "configuration options"
31283 It is possible to have option settings in the main configuration file
31284 that set values in static variables in the &[local_scan()]& module. If you
31285 want to do this, you must have the line
31286 .code
31287 LOCAL_SCAN_HAS_OPTIONS=yes
31288 .endd
31289 in your &_Local/Makefile_& when you build Exim. (This line is in
31290 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31291 file, you must define static variables to hold the option values, and a table
31292 to define them.
31293
31294 The table must be a vector called &%local_scan_options%&, of type
31295 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31296 and a pointer to the variable that holds the value. The entries must appear in
31297 alphabetical order. Following &%local_scan_options%& you must also define a
31298 variable called &%local_scan_options_count%& that contains the number of
31299 entries in the table. Here is a short example, showing two kinds of option:
31300 .code
31301 static int my_integer_option = 42;
31302 static uschar *my_string_option = US"a default string";
31303
31304 optionlist local_scan_options[] = {
31305   { "my_integer", opt_int,       &my_integer_option },
31306   { "my_string",  opt_stringptr, &my_string_option }
31307 };
31308
31309 int local_scan_options_count =
31310   sizeof(local_scan_options)/sizeof(optionlist);
31311 .endd
31312 The values of the variables can now be changed from Exim's runtime
31313 configuration file by including a local scan section as in this example:
31314 .code
31315 begin local_scan
31316 my_integer = 99
31317 my_string = some string of text...
31318 .endd
31319 The available types of option data are as follows:
31320
31321 .vlist
31322 .vitem &*opt_bool*&
31323 This specifies a boolean (true/false) option. The address should point to a
31324 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31325 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31326 whether such a variable has been set at all, you can initialize it to
31327 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31328 values.)
31329
31330 .vitem &*opt_fixed*&
31331 This specifies a fixed point number, such as is used for load averages.
31332 The address should point to a variable of type &`int`&. The value is stored
31333 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31334
31335 .vitem &*opt_int*&
31336 This specifies an integer; the address should point to a variable of type
31337 &`int`&. The value may be specified in any of the integer formats accepted by
31338 Exim.
31339
31340 .vitem &*opt_mkint*&
31341 This is the same as &%opt_int%&, except that when such a value is output in a
31342 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31343 printed with the suffix K or M.
31344
31345 .vitem &*opt_octint*&
31346 This also specifies an integer, but the value is always interpreted as an
31347 octal integer, whether or not it starts with the digit zero, and it is
31348 always output in octal.
31349
31350 .vitem &*opt_stringptr*&
31351 This specifies a string value; the address must be a pointer to a
31352 variable that points to a string (for example, of type &`uschar *`&).
31353
31354 .vitem &*opt_time*&
31355 This specifies a time interval value. The address must point to a variable of
31356 type &`int`&. The value that is placed there is a number of seconds.
31357 .endlist
31358
31359 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31360 out the values of all the &[local_scan()]& options.
31361
31362
31363
31364 .section "Available Exim variables" "SECID208"
31365 .cindex "&[local_scan()]& function" "available Exim variables"
31366 The header &_local_scan.h_& gives you access to a number of C variables. These
31367 are the only ones that are guaranteed to be maintained from release to release.
31368 Note, however, that you can obtain the value of any Exim expansion variable,
31369 including &$recipients$&, by calling &'expand_string()'&. The exported
31370 C variables are as follows:
31371
31372 .vlist
31373 .vitem &*int&~body_linecount*&
31374 This variable contains the number of lines in the message's body.
31375
31376 .vitem &*int&~body_zerocount*&
31377 This variable contains the number of binary zero bytes in the message's body.
31378
31379 .vitem &*unsigned&~int&~debug_selector*&
31380 This variable is set to zero when no debugging is taking place. Otherwise, it
31381 is a bitmap of debugging selectors. Two bits are identified for use in
31382 &[local_scan()]&; they are defined as macros:
31383
31384 .ilist
31385 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31386 testing option that is not privileged &-- any caller may set it. All the
31387 other selector bits can be set only by admin users.
31388
31389 .next
31390 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31391 by the &`+local_scan`& debug selector. It is not included in the default set
31392 of debugging bits.
31393 .endlist ilist
31394
31395 Thus, to write to the debugging output only when &`+local_scan`& has been
31396 selected, you should use code like this:
31397 .code
31398 if ((debug_selector & D_local_scan) != 0)
31399   debug_printf("xxx", ...);
31400 .endd
31401 .vitem &*uschar&~*expand_string_message*&
31402 After a failing call to &'expand_string()'& (returned value NULL), the
31403 variable &%expand_string_message%& contains the error message, zero-terminated.
31404
31405 .vitem &*header_line&~*header_list*&
31406 A pointer to a chain of header lines. The &%header_line%& structure is
31407 discussed below.
31408
31409 .vitem &*header_line&~*header_last*&
31410 A pointer to the last of the header lines.
31411
31412 .vitem &*uschar&~*headers_charset*&
31413 The value of the &%headers_charset%& configuration option.
31414
31415 .vitem &*BOOL&~host_checking*&
31416 This variable is TRUE during a host checking session that is initiated by the
31417 &%-bh%& command line option.
31418
31419 .vitem &*uschar&~*interface_address*&
31420 The IP address of the interface that received the message, as a string. This
31421 is NULL for locally submitted messages.
31422
31423 .vitem &*int&~interface_port*&
31424 The port on which this message was received. When testing with the &%-bh%&
31425 command line option, the value of this variable is -1 unless a port has been
31426 specified via the &%-oMi%& option.
31427
31428 .vitem &*uschar&~*message_id*&
31429 This variable contains Exim's message id for the incoming message (the value of
31430 &$message_exim_id$&) as a zero-terminated string.
31431
31432 .vitem &*uschar&~*received_protocol*&
31433 The name of the protocol by which the message was received.
31434
31435 .vitem &*int&~recipients_count*&
31436 The number of accepted recipients.
31437
31438 .vitem &*recipient_item&~*recipients_list*&
31439 .cindex "recipient" "adding in local scan"
31440 .cindex "recipient" "removing in local scan"
31441 The list of accepted recipients, held in a vector of length
31442 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31443 can add additional recipients by calling &'receive_add_recipient()'& (see
31444 below). You can delete recipients by removing them from the vector and
31445 adjusting the value in &%recipients_count%&. In particular, by setting
31446 &%recipients_count%& to zero you remove all recipients. If you then return the
31447 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31448 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31449 and then call &'receive_add_recipient()'& as often as needed.
31450
31451 .vitem &*uschar&~*sender_address*&
31452 The envelope sender address. For bounce messages this is the empty string.
31453
31454 .vitem &*uschar&~*sender_host_address*&
31455 The IP address of the sending host, as a string. This is NULL for
31456 locally-submitted messages.
31457
31458 .vitem &*uschar&~*sender_host_authenticated*&
31459 The name of the authentication mechanism that was used, or NULL if the message
31460 was not received over an authenticated SMTP connection.
31461
31462 .vitem &*uschar&~*sender_host_name*&
31463 The name of the sending host, if known.
31464
31465 .vitem &*int&~sender_host_port*&
31466 The port on the sending host.
31467
31468 .vitem &*BOOL&~smtp_input*&
31469 This variable is TRUE for all SMTP input, including BSMTP.
31470
31471 .vitem &*BOOL&~smtp_batched_input*&
31472 This variable is TRUE for BSMTP input.
31473
31474 .vitem &*int&~store_pool*&
31475 The contents of this variable control which pool of memory is used for new
31476 requests. See section &<<SECTmemhanloc>>& for details.
31477 .endlist
31478
31479
31480 .section "Structure of header lines" "SECID209"
31481 The &%header_line%& structure contains the members listed below.
31482 You can add additional header lines by calling the &'header_add()'& function
31483 (see below). You can cause header lines to be ignored (deleted) by setting
31484 their type to *.
31485
31486
31487 .vlist
31488 .vitem &*struct&~header_line&~*next*&
31489 A pointer to the next header line, or NULL for the last line.
31490
31491 .vitem &*int&~type*&
31492 A code identifying certain headers that Exim recognizes. The codes are printing
31493 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31494 Notice in particular that any header line whose type is * is not transmitted
31495 with the message. This flagging is used for header lines that have been
31496 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31497 lines.) Effectively, * means &"deleted"&.
31498
31499 .vitem &*int&~slen*&
31500 The number of characters in the header line, including the terminating and any
31501 internal newlines.
31502
31503 .vitem &*uschar&~*text*&
31504 A pointer to the text of the header. It always ends with a newline, followed by
31505 a zero byte. Internal newlines are preserved.
31506 .endlist
31507
31508
31509
31510 .section "Structure of recipient items" "SECID210"
31511 The &%recipient_item%& structure contains these members:
31512
31513 .vlist
31514 .vitem &*uschar&~*address*&
31515 This is a pointer to the recipient address as it was received.
31516
31517 .vitem &*int&~pno*&
31518 This is used in later Exim processing when top level addresses are created by
31519 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31520 and must always contain -1 at this stage.
31521
31522 .vitem &*uschar&~*errors_to*&
31523 If this value is not NULL, bounce messages caused by failing to deliver to the
31524 recipient are sent to the address it contains. In other words, it overrides the
31525 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31526 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31527 an unqualified address, Exim qualifies it using the domain from
31528 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31529 is NULL for all recipients.
31530 .endlist
31531
31532
31533
31534 .section "Available Exim functions" "SECID211"
31535 .cindex "&[local_scan()]& function" "available Exim functions"
31536 The header &_local_scan.h_& gives you access to a number of Exim functions.
31537 These are the only ones that are guaranteed to be maintained from release to
31538 release:
31539
31540 .vlist
31541 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31542        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31543
31544 This function creates a child process that runs the command specified by
31545 &%argv%&. The environment for the process is specified by &%envp%&, which can
31546 be NULL if no environment variables are to be passed. A new umask is supplied
31547 for the process in &%newumask%&.
31548
31549 Pipes to the standard input and output of the new process are set up
31550 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31551 standard error is cloned to the standard output. If there are any file
31552 descriptors &"in the way"& in the new process, they are closed. If the final
31553 argument is TRUE, the new process is made into a process group leader.
31554
31555 The function returns the pid of the new process, or -1 if things go wrong.
31556
31557 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31558 This function waits for a child process to terminate, or for a timeout (in
31559 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31560 return value is as follows:
31561
31562 .ilist
31563 >= 0
31564
31565 The process terminated by a normal exit and the value is the process
31566 ending status.
31567
31568 .next
31569 < 0 and > &--256
31570
31571 The process was terminated by a signal and the value is the negation of the
31572 signal number.
31573
31574 .next
31575 &--256
31576
31577 The process timed out.
31578 .next
31579 &--257
31580
31581 The was some other error in wait(); &%errno%& is still set.
31582 .endlist
31583
31584 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31585 This function provide you with a means of submitting a new message to
31586 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31587 want, but this packages it all up for you.) The function creates a pipe,
31588 forks a subprocess that is running
31589 .code
31590 exim -t -oem -oi -f <>
31591 .endd
31592 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31593 that is connected to the standard input. The yield of the function is the PID
31594 of the subprocess. You can then write a message to the file descriptor, with
31595 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31596
31597 When you have finished, call &'child_close()'& to wait for the process to
31598 finish and to collect its ending status. A timeout value of zero is usually
31599 fine in this circumstance. Unless you have made a mistake with the recipient
31600 addresses, you should get a return code of zero.
31601
31602
31603 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31604        *sender_authentication)*&
31605 This function is a more sophisticated version of &'child_open()'&. The command
31606 that it runs is:
31607 .display
31608 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31609 .endd
31610 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31611
31612
31613 .vitem &*void&~debug_printf(char&~*,&~...)*&
31614 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31615 output is written to the standard error stream. If no debugging is selected,
31616 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31617 conditional on the &`local_scan`& debug selector by coding like this:
31618 .code
31619 if ((debug_selector & D_local_scan) != 0)
31620   debug_printf("xxx", ...);
31621 .endd
31622
31623 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31624 This is an interface to Exim's string expansion code. The return value is the
31625 expanded string, or NULL if there was an expansion failure.
31626 The C variable &%expand_string_message%& contains an error message after an
31627 expansion failure. If expansion does not change the string, the return value is
31628 the pointer to the input string. Otherwise, the return value points to a new
31629 block of memory that was obtained by a call to &'store_get()'&. See section
31630 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31631
31632 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31633 This function allows you to an add additional header line at the end of the
31634 existing ones. The first argument is the type, and should normally be a space
31635 character. The second argument is a format string and any number of
31636 substitution arguments as for &[sprintf()]&. You may include internal newlines
31637 if you want, and you must ensure that the string ends with a newline.
31638
31639 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31640         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31641 This function adds a new header line at a specified point in the header
31642 chain. The header itself is specified as for &'header_add()'&.
31643
31644 If &%name%& is NULL, the new header is added at the end of the chain if
31645 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31646 NULL, the header lines are searched for the first non-deleted header that
31647 matches the name. If one is found, the new header is added before it if
31648 &%after%& is false. If &%after%& is true, the new header is added after the
31649 found header and any adjacent subsequent ones with the same name (even if
31650 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31651 option controls where the header is added. If it is true, addition is at the
31652 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31653 headers, or at the top if there are no &'Received:'& headers, you could use
31654 .code
31655 header_add_at_position(TRUE, US"Received", TRUE,
31656   ' ', "X-xxx: ...");
31657 .endd
31658 Normally, there is always at least one non-deleted &'Received:'& header, but
31659 there may not be if &%received_header_text%& expands to an empty string.
31660
31661
31662 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31663 This function removes header lines. If &%occurrence%& is zero or negative, all
31664 occurrences of the header are removed. If occurrence is greater than zero, that
31665 particular instance of the header is removed. If no header(s) can be found that
31666 match the specification, the function does nothing.
31667
31668
31669 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31670         int&~length,&~BOOL&~notdel)*&"
31671 This function tests whether the given header has the given name. It is not just
31672 a string comparison, because white space is permitted between the name and the
31673 colon. If the &%notdel%& argument is true, a false return is forced for all
31674 &"deleted"& headers; otherwise they are not treated specially. For example:
31675 .code
31676 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31677 .endd
31678 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31679 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31680 This function base64-encodes a string, which is passed by address and length.
31681 The text may contain bytes of any value, including zero. The result is passed
31682 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31683 zero-terminated.
31684
31685 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31686 This function decodes a base64-encoded string. Its arguments are a
31687 zero-terminated base64-encoded string and the address of a variable that is set
31688 to point to the result, which is in dynamic memory. The length of the decoded
31689 string is the yield of the function. If the input is invalid base64 data, the
31690 yield is -1. A zero byte is added to the end of the output string to make it
31691 easy to interpret as a C string (assuming it contains no zeros of its own). The
31692 added zero byte is not included in the returned count.
31693
31694 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31695 This function checks for a match in a domain list. Domains are always
31696 matched caselessly. The return value is one of the following:
31697 .display
31698 &`OK     `& match succeeded
31699 &`FAIL   `& match failed
31700 &`DEFER  `& match deferred
31701 .endd
31702 DEFER is usually caused by some kind of lookup defer, such as the
31703 inability to contact a database.
31704
31705 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31706         BOOL&~caseless)*&"
31707 This function checks for a match in a local part list. The third argument
31708 controls case-sensitivity. The return values are as for
31709 &'lss_match_domain()'&.
31710
31711 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31712         BOOL&~caseless)*&"
31713 This function checks for a match in an address list. The third argument
31714 controls the case-sensitivity of the local part match. The domain is always
31715 matched caselessly. The return values are as for &'lss_match_domain()'&.
31716
31717 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31718         uschar&~*list)*&"
31719 This function checks for a match in a host list. The most common usage is
31720 expected to be
31721 .code
31722 lss_match_host(sender_host_name, sender_host_address, ...)
31723 .endd
31724 .vindex "&$sender_host_address$&"
31725 An empty address field matches an empty item in the host list. If the host name
31726 is NULL, the name corresponding to &$sender_host_address$& is automatically
31727 looked up if a host name is required to match an item in the list. The return
31728 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31729 returns ERROR in the case when it had to look up a host name, but the lookup
31730 failed.
31731
31732 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31733         *format,&~...)*&"
31734 This function writes to Exim's log files. The first argument should be zero (it
31735 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31736 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31737 them. It specifies to which log or logs the message is written. The remaining
31738 arguments are a format and relevant insertion arguments. The string should not
31739 contain any newlines, not even at the end.
31740
31741
31742 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31743 This function adds an additional recipient to the message. The first argument
31744 is the recipient address. If it is unqualified (has no domain), it is qualified
31745 with the &%qualify_recipient%& domain. The second argument must always be -1.
31746
31747 This function does not allow you to specify a private &%errors_to%& address (as
31748 described with the structure of &%recipient_item%& above), because it pre-dates
31749 the addition of that field to the structure. However, it is easy to add such a
31750 value afterwards. For example:
31751 .code
31752  receive_add_recipient(US"monitor@mydom.example", -1);
31753  recipients_list[recipients_count-1].errors_to =
31754    US"postmaster@mydom.example";
31755 .endd
31756
31757 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31758 This is a convenience function to remove a named recipient from the list of
31759 recipients. It returns true if a recipient was removed, and false if no
31760 matching recipient could be found. The argument must be a complete email
31761 address.
31762 .endlist
31763
31764
31765 .cindex "RFC 2047"
31766 .vlist
31767 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31768   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31769 This function decodes strings that are encoded according to RFC 2047. Typically
31770 these are the contents of header lines. First, each &"encoded word"& is decoded
31771 from the Q or B encoding into a byte-string. Then, if provided with the name of
31772 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31773 made  to translate the result to the named character set. If this fails, the
31774 binary string is returned with an error message.
31775
31776 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31777 maximum MIME word length is enforced. The third argument is the target
31778 encoding, or NULL if no translation is wanted.
31779
31780 .cindex "binary zero" "in RFC 2047 decoding"
31781 .cindex "RFC 2047" "binary zero in"
31782 If a binary zero is encountered in the decoded string, it is replaced by the
31783 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31784 not be 0 because header lines are handled as zero-terminated strings.
31785
31786 The function returns the result of processing the string, zero-terminated; if
31787 &%lenptr%& is not NULL, the length of the result is set in the variable to
31788 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31789
31790 If an error is encountered, the function returns NULL and uses the &%error%&
31791 argument to return an error message. The variable pointed to by &%error%& is
31792 set to NULL if there is no error; it may be set non-NULL even when the function
31793 returns a non-NULL value if decoding was successful, but there was a problem
31794 with translation.
31795
31796
31797 .vitem &*int&~smtp_fflush(void)*&
31798 This function is used in conjunction with &'smtp_printf()'&, as described
31799 below.
31800
31801 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31802 The arguments of this function are like &[printf()]&; it writes to the SMTP
31803 output stream. You should use this function only when there is an SMTP output
31804 stream, that is, when the incoming message is being received via interactive
31805 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31806 is FALSE. If you want to test for an incoming message from another host (as
31807 opposed to a local process that used the &%-bs%& command line option), you can
31808 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31809 is involved.
31810
31811 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31812 output function, so it can be used for all forms of SMTP connection.
31813
31814 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31815 must start with an appropriate response code: 550 if you are going to return
31816 LOCAL_SCAN_REJECT, 451 if you are going to return
31817 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31818 initial lines of a multi-line response, the code must be followed by a hyphen
31819 to indicate that the line is not the final response line. You must also ensure
31820 that the lines you write terminate with CRLF. For example:
31821 .code
31822 smtp_printf("550-this is some extra info\r\n");
31823 return LOCAL_SCAN_REJECT;
31824 .endd
31825 Note that you can also create multi-line responses by including newlines in
31826 the data returned via the &%return_text%& argument. The added value of using
31827 &'smtp_printf()'& is that, for instance, you could introduce delays between
31828 multiple output lines.
31829
31830 The &'smtp_printf()'& function does not return any error indication, because it
31831 does not automatically flush pending output, and therefore does not test
31832 the state of the stream. (In the main code of Exim, flushing and error
31833 detection is done when Exim is ready for the next SMTP input command.) If
31834 you want to flush the output and check for an error (for example, the
31835 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31836 arguments. It flushes the output stream, and returns a non-zero value if there
31837 is an error.
31838
31839 .vitem &*void&~*store_get(int)*&
31840 This function accesses Exim's internal store (memory) manager. It gets a new
31841 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31842 runs out of memory. See the next section for a discussion of memory handling.
31843
31844 .vitem &*void&~*store_get_perm(int)*&
31845 This function is like &'store_get()'&, but it always gets memory from the
31846 permanent pool. See the next section for a discussion of memory handling.
31847
31848 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31849 See below.
31850
31851 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31852 See below.
31853
31854 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31855 These three functions create strings using Exim's dynamic memory facilities.
31856 The first makes a copy of an entire string. The second copies up to a maximum
31857 number of characters, indicated by the second argument. The third uses a format
31858 and insertion arguments to create a new string. In each case, the result is a
31859 pointer to a new string in the current memory pool. See the next section for
31860 more discussion.
31861 .endlist
31862
31863
31864
31865 .section "More about Exim's memory handling" "SECTmemhanloc"
31866 .cindex "&[local_scan()]& function" "memory handling"
31867 No function is provided for freeing memory, because that is never needed.
31868 The dynamic memory that Exim uses when receiving a message is automatically
31869 recycled if another message is received by the same process (this applies only
31870 to incoming SMTP connections &-- other input methods can supply only one
31871 message at a time). After receiving the last message, a reception process
31872 terminates.
31873
31874 Because it is recycled, the normal dynamic memory cannot be used for holding
31875 data that must be preserved over a number of incoming messages on the same SMTP
31876 connection. However, Exim in fact uses two pools of dynamic memory; the second
31877 one is not recycled, and can be used for this purpose.
31878
31879 If you want to allocate memory that remains available for subsequent messages
31880 in the same SMTP connection, you should set
31881 .code
31882 store_pool = POOL_PERM
31883 .endd
31884 before calling the function that does the allocation. There is no need to
31885 restore the value if you do not need to; however, if you do want to revert to
31886 the normal pool, you can either restore the previous value of &%store_pool%& or
31887 set it explicitly to POOL_MAIN.
31888
31889 The pool setting applies to all functions that get dynamic memory, including
31890 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31891 There is also a convenience function called &'store_get_perm()'& that gets a
31892 block of memory from the permanent pool while preserving the value of
31893 &%store_pool%&.
31894 .ecindex IIDlosca
31895
31896
31897
31898
31899 . ////////////////////////////////////////////////////////////////////////////
31900 . ////////////////////////////////////////////////////////////////////////////
31901
31902 .chapter "System-wide message filtering" "CHAPsystemfilter"
31903 .scindex IIDsysfil1 "filter" "system filter"
31904 .scindex IIDsysfil2 "filtering all mail"
31905 .scindex IIDsysfil3 "system filter"
31906 The previous chapters (on ACLs and the local scan function) describe checks
31907 that can be applied to messages before they are accepted by a host. There is
31908 also a mechanism for checking messages once they have been received, but before
31909 they are delivered. This is called the &'system filter'&.
31910
31911 The system filter operates in a similar manner to users' filter files, but it
31912 is run just once per message (however many recipients the message has).
31913 It should not normally be used as a substitute for routing, because &%deliver%&
31914 commands in a system router provide new envelope recipient addresses.
31915 The system filter must be an Exim filter. It cannot be a Sieve filter.
31916
31917 The system filter is run at the start of a delivery attempt, before any routing
31918 is done. If a message fails to be completely delivered at the first attempt,
31919 the system filter is run again at the start of every retry.
31920 If you want your filter to do something only once per message, you can make use
31921 of the &%first_delivery%& condition in an &%if%& command in the filter to
31922 prevent it happening on retries.
31923
31924 .vindex "&$domain$&"
31925 .vindex "&$local_part$&"
31926 &*Warning*&: Because the system filter runs just once, variables that are
31927 specific to individual recipient addresses, such as &$local_part$& and
31928 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31929 you want to run a centrally-specified filter for each recipient address
31930 independently, you can do so by setting up a suitable &(redirect)& router, as
31931 described in section &<<SECTperaddfil>>& below.
31932
31933
31934 .section "Specifying a system filter" "SECID212"
31935 .cindex "uid (user id)" "system filter"
31936 .cindex "gid (group id)" "system filter"
31937 The name of the file that contains the system filter must be specified by
31938 setting &%system_filter%&. If you want the filter to run under a uid and gid
31939 other than root, you must also set &%system_filter_user%& and
31940 &%system_filter_group%& as appropriate. For example:
31941 .code
31942 system_filter = /etc/mail/exim.filter
31943 system_filter_user = exim
31944 .endd
31945 If a system filter generates any deliveries directly to files or pipes (via the
31946 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31947 specified by setting &%system_filter_file_transport%& and
31948 &%system_filter_pipe_transport%&, respectively. Similarly,
31949 &%system_filter_reply_transport%& must be set to handle any messages generated
31950 by the &%reply%& command.
31951
31952
31953 .section "Testing a system filter" "SECID213"
31954 You can run simple tests of a system filter in the same way as for a user
31955 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31956 are permitted only in system filters are recognized.
31957
31958 If you want to test the combined effect of a system filter and a user filter,
31959 you can use both &%-bF%& and &%-bf%& on the same command line.
31960
31961
31962
31963 .section "Contents of a system filter" "SECID214"
31964 The language used to specify system filters is the same as for users' filter
31965 files. It is described in the separate end-user document &'Exim's interface to
31966 mail filtering'&. However, there are some additional features that are
31967 available only in system filters; these are described in subsequent sections.
31968 If they are encountered in a user's filter file or when testing with &%-bf%&,
31969 they cause errors.
31970
31971 .cindex "frozen messages" "manual thaw; testing in filter"
31972 There are two special conditions which, though available in users' filter
31973 files, are designed for use in system filters. The condition &%first_delivery%&
31974 is true only for the first attempt at delivering a message, and
31975 &%manually_thawed%& is true only if the message has been frozen, and
31976 subsequently thawed by an admin user. An explicit forced delivery counts as a
31977 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31978
31979 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31980 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31981 succeed, it will not be tried again.
31982 If you want Exim to retry an unseen delivery until it succeeds, you should
31983 arrange to set it up every time the filter runs.
31984
31985 When a system filter finishes running, the values of the variables &$n0$& &--
31986 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31987 users' filter files. Thus a system filter can, for example, set up &"scores"&
31988 to which users' filter files can refer.
31989
31990
31991
31992 .section "Additional variable for system filters" "SECID215"
31993 .vindex "&$recipients$&"
31994 The expansion variable &$recipients$&, containing a list of all the recipients
31995 of the message (separated by commas and white space), is available in system
31996 filters. It is not available in users' filters for privacy reasons.
31997
31998
31999
32000 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32001 .cindex "freezing messages"
32002 .cindex "message" "freezing"
32003 .cindex "message" "forced failure"
32004 .cindex "&%fail%&" "in system filter"
32005 .cindex "&%freeze%& in system filter"
32006 .cindex "&%defer%& in system filter"
32007 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32008 always available in system filters, but are not normally enabled in users'
32009 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32010 for the &(redirect)& router.) These commands can optionally be followed by the
32011 word &%text%& and a string containing an error message, for example:
32012 .code
32013 fail text "this message looks like spam to me"
32014 .endd
32015 The keyword &%text%& is optional if the next character is a double quote.
32016
32017 The &%defer%& command defers delivery of the original recipients of the
32018 message. The &%fail%& command causes all the original recipients to be failed,
32019 and a bounce message to be created. The &%freeze%& command suspends all
32020 delivery attempts for the original recipients. In all cases, any new deliveries
32021 that are specified by the filter are attempted as normal after the filter has
32022 run.
32023
32024 The &%freeze%& command is ignored if the message has been manually unfrozen and
32025 not manually frozen since. This means that automatic freezing by a system
32026 filter can be used as a way of checking out suspicious messages. If a message
32027 is found to be all right, manually unfreezing it allows it to be delivered.
32028
32029 .cindex "log" "&%fail%& command log line"
32030 .cindex "&%fail%&" "log line; reducing"
32031 The text given with a fail command is used as part of the bounce message as
32032 well as being written to the log. If the message is quite long, this can fill
32033 up a lot of log space when such failures are common. To reduce the size of the
32034 log message, Exim interprets the text in a special way if it starts with the
32035 two characters &`<<`& and contains &`>>`& later. The text between these two
32036 strings is written to the log, and the rest of the text is used in the bounce
32037 message. For example:
32038 .code
32039 fail "<<filter test 1>>Your message is rejected \
32040      because it contains attachments that we are \
32041      not prepared to receive."
32042 .endd
32043
32044 .cindex "loop" "caused by &%fail%&"
32045 Take great care with the &%fail%& command when basing the decision to fail on
32046 the contents of the message, because the bounce message will of course include
32047 the contents of the original message and will therefore trigger the &%fail%&
32048 command again (causing a mail loop) unless steps are taken to prevent this.
32049 Testing the &%error_message%& condition is one way to prevent this. You could
32050 use, for example
32051 .code
32052 if $message_body contains "this is spam" and not error_message
32053 then fail text "spam is not wanted here" endif
32054 .endd
32055 though of course that might let through unwanted bounce messages. The
32056 alternative is clever checking of the body and/or headers to detect bounces
32057 generated by the filter.
32058
32059 The interpretation of a system filter file ceases after a
32060 &%defer%&,
32061 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32062 set up earlier in the filter file are honoured, so you can use a sequence such
32063 as
32064 .code
32065 mail ...
32066 freeze
32067 .endd
32068 to send a specified message when the system filter is freezing (or deferring or
32069 failing) a message. The normal deliveries for the message do not, of course,
32070 take place.
32071
32072
32073
32074 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32075 .cindex "header lines" "adding; in system filter"
32076 .cindex "header lines" "removing; in system filter"
32077 .cindex "filter" "header lines; adding/removing"
32078 Two filter commands that are available only in system filters are:
32079 .code
32080 headers add <string>
32081 headers remove <string>
32082 .endd
32083 The argument for the &%headers add%& is a string that is expanded and then
32084 added to the end of the message's headers. It is the responsibility of the
32085 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32086 space is ignored, and if the string is otherwise empty, or if the expansion is
32087 forced to fail, the command has no effect.
32088
32089 You can use &"\n"& within the string, followed by white space, to specify
32090 continued header lines. More than one header may be added in one command by
32091 including &"\n"& within the string without any following white space. For
32092 example:
32093 .code
32094 headers add "X-header-1: ....\n  \
32095              continuation of X-header-1 ...\n\
32096              X-header-2: ...."
32097 .endd
32098 Note that the header line continuation white space after the first newline must
32099 be placed before the backslash that continues the input string, because white
32100 space after input continuations is ignored.
32101
32102 The argument for &%headers remove%& is a colon-separated list of header names.
32103 This command applies only to those headers that are stored with the message;
32104 those that are added at delivery time (such as &'Envelope-To:'& and
32105 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32106 header with the same name, they are all removed.
32107
32108 The &%headers%& command in a system filter makes an immediate change to the set
32109 of header lines that was received with the message (with possible additions
32110 from ACL processing). Subsequent commands in the system filter operate on the
32111 modified set, which also forms the basis for subsequent message delivery.
32112 Unless further modified during routing or transporting, this set of headers is
32113 used for all recipients of the message.
32114
32115 During routing and transporting, the variables that refer to the contents of
32116 header lines refer only to those lines that are in this set. Thus, header lines
32117 that are added by a system filter are visible to users' filter files and to all
32118 routers and transports. This contrasts with the manipulation of header lines by
32119 routers and transports, which is not immediate, but which instead is saved up
32120 until the message is actually being written (see section
32121 &<<SECTheadersaddrem>>&).
32122
32123 If the message is not delivered at the first attempt, header lines that were
32124 added by the system filter are stored with the message, and so are still
32125 present at the next delivery attempt. Header lines that were removed are still
32126 present, but marked &"deleted"& so that they are not transported with the
32127 message. For this reason, it is usual to make the &%headers%& command
32128 conditional on &%first_delivery%& so that the set of header lines is not
32129 modified more than once.
32130
32131 Because header modification in a system filter acts immediately, you have to
32132 use an indirect approach if you want to modify the contents of a header line.
32133 For example:
32134 .code
32135 headers add "Old-Subject: $h_subject:"
32136 headers remove "Subject"
32137 headers add "Subject: new subject (was: $h_old-subject:)"
32138 headers remove "Old-Subject"
32139 .endd
32140
32141
32142
32143 .section "Setting an errors address in a system filter" "SECID217"
32144 .cindex "envelope sender"
32145 In a system filter, if a &%deliver%& command is followed by
32146 .code
32147 errors_to <some address>
32148 .endd
32149 in order to change the envelope sender (and hence the error reporting) for that
32150 delivery, any address may be specified. (In a user filter, only the current
32151 user's address can be set.) For example, if some mail is being monitored, you
32152 might use
32153 .code
32154 unseen deliver monitor@spying.example errors_to root@local.example
32155 .endd
32156 to take a copy which would not be sent back to the normal error reporting
32157 address if its delivery failed.
32158
32159
32160
32161 .section "Per-address filtering" "SECTperaddfil"
32162 .vindex "&$domain$&"
32163 .vindex "&$local_part$&"
32164 In contrast to the system filter, which is run just once per message for each
32165 delivery attempt, it is also possible to set up a system-wide filtering
32166 operation that runs once for each recipient address. In this case, variables
32167 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32168 filter file could be made dependent on them. This is an example of a router
32169 which implements such a filter:
32170 .code
32171 central_filter:
32172   check_local_user
32173   driver = redirect
32174   domains = +local_domains
32175   file = /central/filters/$local_part
32176   no_verify
32177   allow_filter
32178   allow_freeze
32179 .endd
32180 The filter is run in a separate process under its own uid. Therefore, either
32181 &%check_local_user%& must be set (as above), in which case the filter is run as
32182 the local user, or the &%user%& option must be used to specify which user to
32183 use. If both are set, &%user%& overrides.
32184
32185 Care should be taken to ensure that none of the commands in the filter file
32186 specify a significant delivery if the message is to go on to be delivered to
32187 its intended recipient. The router will not then claim to have dealt with the
32188 address, so it will be passed on to subsequent routers to be delivered in the
32189 normal way.
32190 .ecindex IIDsysfil1
32191 .ecindex IIDsysfil2
32192 .ecindex IIDsysfil3
32193
32194
32195
32196
32197
32198
32199 . ////////////////////////////////////////////////////////////////////////////
32200 . ////////////////////////////////////////////////////////////////////////////
32201
32202 .chapter "Message processing" "CHAPmsgproc"
32203 .scindex IIDmesproc "message" "general processing"
32204 Exim performs various transformations on the sender and recipient addresses of
32205 all messages that it handles, and also on the messages' header lines. Some of
32206 these are optional and configurable, while others always take place. All of
32207 this processing, except rewriting as a result of routing, and the addition or
32208 removal of header lines while delivering, happens when a message is received,
32209 before it is placed on Exim's queue.
32210
32211 Some of the automatic processing takes place by default only for
32212 &"locally-originated"& messages. This adjective is used to describe messages
32213 that are not received over TCP/IP, but instead are passed to an Exim process on
32214 its standard input. This includes the interactive &"local SMTP"& case that is
32215 set up by the &%-bs%& command line option.
32216
32217 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32218 or ::1) are not considered to be locally-originated. Exim does not treat the
32219 loopback interface specially in any way.
32220
32221 If you want the loopback interface to be treated specially, you must ensure
32222 that there are appropriate entries in your ACLs.
32223
32224
32225
32226
32227 .section "Submission mode for non-local messages" "SECTsubmodnon"
32228 .cindex "message" "submission"
32229 .cindex "submission mode"
32230 Processing that happens automatically for locally-originated messages (unless
32231 &%suppress_local_fixups%& is set) can also be requested for messages that are
32232 received over TCP/IP. The term &"submission mode"& is used to describe this
32233 state. Submission mode is set by the modifier
32234 .code
32235 control = submission
32236 .endd
32237 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32238 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32239 a local submission, and is normally used when the source of the message is
32240 known to be an MUA running on a client host (as opposed to an MTA). For
32241 example, to set submission mode for messages originating on the IPv4 loopback
32242 interface, you could include the following in the MAIL ACL:
32243 .code
32244 warn  hosts = 127.0.0.1
32245       control = submission
32246 .endd
32247 .cindex "&%sender_retain%& submission option"
32248 There are some options that can be used when setting submission mode. A slash
32249 is used to separate options. For example:
32250 .code
32251 control = submission/sender_retain
32252 .endd
32253 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32254 true and &%local_from_check%& false for the current incoming message. The first
32255 of these allows an existing &'Sender:'& header in the message to remain, and
32256 the second suppresses the check to ensure that &'From:'& matches the
32257 authenticated sender. With this setting, Exim still fixes up messages by adding
32258 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32259 attempt to check sender authenticity in header lines.
32260
32261 When &%sender_retain%& is not set, a submission mode setting may specify a
32262 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32263 example:
32264 .code
32265 control = submission/domain=some.domain
32266 .endd
32267 The domain may be empty. How this value is used is described in sections
32268 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32269 that allows you to specify the user's full name for inclusion in a created
32270 &'Sender:'& or &'From:'& header line. For example:
32271 .code
32272 accept authenticated = *
32273        control = submission/domain=wonderland.example/\
32274                             name=${lookup {$authenticated_id} \
32275                                    lsearch {/etc/exim/namelist}}
32276 .endd
32277 Because the name may contain any characters, including slashes, the &%name%&
32278 option must be given last. The remainder of the string is used as the name. For
32279 the example above, if &_/etc/exim/namelist_& contains:
32280 .code
32281 bigegg:  Humpty Dumpty
32282 .endd
32283 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32284 line would be:
32285 .code
32286 Sender: Humpty Dumpty <bigegg@wonderland.example>
32287 .endd
32288 .cindex "return path" "in submission mode"
32289 By default, submission mode forces the return path to the same address as is
32290 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32291 specified, the return path is also left unchanged.
32292
32293 &*Note*&: The changes caused by submission mode take effect after the predata
32294 ACL. This means that any sender checks performed before the fix-ups use the
32295 untrusted sender address specified by the user, not the trusted sender address
32296 specified by submission mode. Although this might be slightly unexpected, it
32297 does mean that you can configure ACL checks to spot that a user is trying to
32298 spoof another's address.
32299
32300 .section "Line endings" "SECTlineendings"
32301 .cindex "line endings"
32302 .cindex "carriage return"
32303 .cindex "linefeed"
32304 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32305 linefeed) is the line ending for messages transmitted over the Internet using
32306 SMTP over TCP/IP. However, within individual operating systems, different
32307 conventions are used. For example, Unix-like systems use just LF, but others
32308 use CRLF or just CR.
32309
32310 Exim was designed for Unix-like systems, and internally, it stores messages
32311 using the system's convention of a single LF as a line terminator. When
32312 receiving a message, all line endings are translated to this standard format.
32313 Originally, it was thought that programs that passed messages directly to an
32314 MTA within an operating system would use that system's convention. Experience
32315 has shown that this is not the case; for example, there are Unix applications
32316 that use CRLF in this circumstance. For this reason, and for compatibility with
32317 other MTAs, the way Exim handles line endings for all messages is now as
32318 follows:
32319
32320 .ilist
32321 LF not preceded by CR is treated as a line ending.
32322 .next
32323 CR is treated as a line ending; if it is immediately followed by LF, the LF
32324 is ignored.
32325 .next
32326 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32327 nor a local message in the state where a line containing only a dot is a
32328 terminator.
32329 .next
32330 If a bare CR is encountered within a header line, an extra space is added after
32331 the line terminator so as not to end the header line. The reasoning behind this
32332 is that bare CRs in header lines are most likely either to be mistakes, or
32333 people trying to play silly games.
32334 .next
32335 If the first header line received in a message ends with CRLF, a subsequent
32336 bare LF in a header line is treated in the same way as a bare CR in a header
32337 line.
32338 .endlist
32339
32340
32341
32342
32343
32344 .section "Unqualified addresses" "SECID218"
32345 .cindex "unqualified addresses"
32346 .cindex "address" "qualification"
32347 By default, Exim expects every envelope address it receives from an external
32348 host to be fully qualified. Unqualified addresses cause negative responses to
32349 SMTP commands. However, because SMTP is used as a means of transporting
32350 messages from MUAs running on personal workstations, there is sometimes a
32351 requirement to accept unqualified addresses from specific hosts or IP networks.
32352
32353 Exim has two options that separately control which hosts may send unqualified
32354 sender or recipient addresses in SMTP commands, namely
32355 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32356 cases, if an unqualified address is accepted, it is qualified by adding the
32357 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32358
32359 .oindex "&%qualify_domain%&"
32360 .oindex "&%qualify_recipient%&"
32361 Unqualified addresses in header lines are automatically qualified for messages
32362 that are locally originated, unless the &%-bnq%& option is given on the command
32363 line. For messages received over SMTP, unqualified addresses in header lines
32364 are qualified only if unqualified addresses are permitted in SMTP commands. In
32365 other words, such qualification is also controlled by
32366 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32367
32368
32369
32370
32371 .section "The UUCP From line" "SECID219"
32372 .cindex "&""From""& line"
32373 .cindex "UUCP" "&""From""& line"
32374 .cindex "sender" "address"
32375 .oindex "&%uucp_from_pattern%&"
32376 .oindex "&%uucp_from_sender%&"
32377 .cindex "envelope sender"
32378 .cindex "Sendmail compatibility" "&""From""& line"
32379 Messages that have come from UUCP (and some other applications) often begin
32380 with a line containing the envelope sender and a timestamp, following the word
32381 &"From"&. Examples of two common formats are:
32382 .code
32383 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32384 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32385 .endd
32386 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32387 Exim recognizes such lines at the start of messages that are submitted to it
32388 via the command line (that is, on the standard input). It does not recognize
32389 such lines in incoming SMTP messages, unless the sending host matches
32390 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32391 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32392 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32393 default value matches the two common cases shown above and puts the address
32394 that follows &"From"& into &$1$&.
32395
32396 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32397 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32398 a trusted user, the message's sender address is constructed by expanding the
32399 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32400 then parsed as an RFC 2822 address. If there is no domain, the local part is
32401 qualified with &%qualify_domain%& unless it is the empty string. However, if
32402 the command line &%-f%& option is used, it overrides the &"From"& line.
32403
32404 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32405 sender address is not changed. This is also the case for incoming SMTP messages
32406 that are permitted to contain &"From"& lines.
32407
32408 Only one &"From"& line is recognized. If there is more than one, the second is
32409 treated as a data line that starts the body of the message, as it is not valid
32410 as a header line. This also happens if a &"From"& line is present in an
32411 incoming SMTP message from a source that is not permitted to send them.
32412
32413
32414
32415 .section "Resent- header lines" "SECID220"
32416 .cindex "&%Resent-%& header lines"
32417 RFC 2822 makes provision for sets of header lines starting with the string
32418 &`Resent-`& to be added to a message when it is resent by the original
32419 recipient to somebody else. These headers are &'Resent-Date:'&,
32420 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32421 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32422
32423 .blockquote
32424 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32425 processing of replies or other such automatic actions on messages.'&
32426 .endblockquote
32427
32428 This leaves things a bit vague as far as other processing actions such as
32429 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32430 follows:
32431
32432 .ilist
32433 A &'Resent-From:'& line that just contains the login id of the submitting user
32434 is automatically rewritten in the same way as &'From:'& (see below).
32435 .next
32436 If there's a rewriting rule for a particular header line, it is also applied to
32437 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32438 &'From:'& also rewrites &'Resent-From:'&.
32439 .next
32440 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32441 also removed.
32442 .next
32443 For a locally-submitted message,
32444 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32445 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32446 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32447 included in log lines in this case.
32448 .next
32449 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32450 &%Resent-%& header lines are present.
32451 .endlist
32452
32453
32454
32455
32456 .section "The Auto-Submitted: header line" "SECID221"
32457 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32458 includes the header line:
32459 .code
32460 Auto-Submitted: auto-replied
32461 .endd
32462
32463 .section "The Bcc: header line" "SECID222"
32464 .cindex "&'Bcc:'& header line"
32465 If Exim is called with the &%-t%& option, to take recipient addresses from a
32466 message's header, it removes any &'Bcc:'& header line that may exist (after
32467 extracting its addresses). If &%-t%& is not present on the command line, any
32468 existing &'Bcc:'& is not removed.
32469
32470
32471 .section "The Date: header line" "SECID223"
32472 .cindex "&'Date:'& header line"
32473 If a locally-generated or submission-mode message has no &'Date:'& header line,
32474 Exim adds one, using the current date and time, unless the
32475 &%suppress_local_fixups%& control has been specified.
32476
32477 .section "The Delivery-date: header line" "SECID224"
32478 .cindex "&'Delivery-date:'& header line"
32479 .oindex "&%delivery_date_remove%&"
32480 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32481 set. Exim can be configured to add them to the final delivery of messages. (See
32482 the generic &%delivery_date_add%& transport option.) They should not be present
32483 in messages in transit. If the &%delivery_date_remove%& configuration option is
32484 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32485 messages.
32486
32487
32488 .section "The Envelope-to: header line" "SECID225"
32489 .cindex "&'Envelope-to:'& header line"
32490 .oindex "&%envelope_to_remove%&"
32491 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32492 Exim can be configured to add them to the final delivery of messages. (See the
32493 generic &%envelope_to_add%& transport option.) They should not be present in
32494 messages in transit. If the &%envelope_to_remove%& configuration option is set
32495 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32496 messages.
32497
32498
32499 .section "The From: header line" "SECTthefrohea"
32500 .cindex "&'From:'& header line"
32501 .cindex "Sendmail compatibility" "&""From""& line"
32502 .cindex "message" "submission"
32503 .cindex "submission mode"
32504 If a submission-mode message does not contain a &'From:'& header line, Exim
32505 adds one if either of the following conditions is true:
32506
32507 .ilist
32508 The envelope sender address is not empty (that is, this is not a bounce
32509 message). The added header line copies the envelope sender address.
32510 .next
32511 .vindex "&$authenticated_id$&"
32512 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32513 .olist
32514 .vindex "&$qualify_domain$&"
32515 If no domain is specified by the submission control, the local part is
32516 &$authenticated_id$& and the domain is &$qualify_domain$&.
32517 .next
32518 If a non-empty domain is specified by the submission control, the local
32519 part is &$authenticated_id$&, and the domain is the specified domain.
32520 .next
32521 If an empty domain is specified by the submission control,
32522 &$authenticated_id$& is assumed to be the complete address.
32523 .endlist
32524 .endlist
32525
32526 A non-empty envelope sender takes precedence.
32527
32528 If a locally-generated incoming message does not contain a &'From:'& header
32529 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32530 containing the sender's address. The calling user's login name and full name
32531 are used to construct the address, as described in section &<<SECTconstr>>&.
32532 They are obtained from the password data by calling &[getpwuid()]& (but see the
32533 &%unknown_login%& configuration option). The address is qualified with
32534 &%qualify_domain%&.
32535
32536 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32537 &'From:'& header line containing just the unqualified login name of the calling
32538 user, this is replaced by an address containing the user's login name and full
32539 name as described in section &<<SECTconstr>>&.
32540
32541
32542 .section "The Message-ID: header line" "SECID226"
32543 .cindex "&'Message-ID:'& header line"
32544 .cindex "message" "submission"
32545 .oindex "&%message_id_header_text%&"
32546 If a locally-generated or submission-mode incoming message does not contain a
32547 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32548 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32549 to the message. If there are any &'Resent-:'& headers in the message, it
32550 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32551 message id, preceded by the letter E to ensure it starts with a letter, and
32552 followed by @ and the primary host name. Additional information can be included
32553 in this header line by setting the &%message_id_header_text%& and/or
32554 &%message_id_header_domain%& options.
32555
32556
32557 .section "The Received: header line" "SECID227"
32558 .cindex "&'Received:'& header line"
32559 A &'Received:'& header line is added at the start of every message. The
32560 contents are defined by the &%received_header_text%& configuration option, and
32561 Exim automatically adds a semicolon and a timestamp to the configured string.
32562
32563 The &'Received:'& header is generated as soon as the message's header lines
32564 have been received. At this stage, the timestamp in the &'Received:'& header
32565 line is the time that the message started to be received. This is the value
32566 that is seen by the DATA ACL and by the &[local_scan()]& function.
32567
32568 Once a message is accepted, the timestamp in the &'Received:'& header line is
32569 changed to the time of acceptance, which is (apart from a small delay while the
32570 -H spool file is written) the earliest time at which delivery could start.
32571
32572
32573 .section "The References: header line" "SECID228"
32574 .cindex "&'References:'& header line"
32575 Messages created by the &(autoreply)& transport include a &'References:'&
32576 header line. This is constructed according to the rules that are described in
32577 section 3.64 of RFC 2822 (which states that replies should contain such a
32578 header line), and section 3.14 of RFC 3834 (which states that automatic
32579 responses are not different in this respect). However, because some mail
32580 processing software does not cope well with very long header lines, no more
32581 than 12 message IDs are copied from the &'References:'& header line in the
32582 incoming message. If there are more than 12, the first one and then the final
32583 11 are copied, before adding the message ID of the incoming message.
32584
32585
32586
32587 .section "The Return-path: header line" "SECID229"
32588 .cindex "&'Return-path:'& header line"
32589 .oindex "&%return_path_remove%&"
32590 &'Return-path:'& header lines are defined as something an MTA may insert when
32591 it does the final delivery of messages. (See the generic &%return_path_add%&
32592 transport option.) Therefore, they should not be present in messages in
32593 transit. If the &%return_path_remove%& configuration option is set (the
32594 default), Exim removes &'Return-path:'& header lines from incoming messages.
32595
32596
32597
32598 .section "The Sender: header line" "SECTthesenhea"
32599 .cindex "&'Sender:'& header line"
32600 .cindex "message" "submission"
32601 For a locally-originated message from an untrusted user, Exim may remove an
32602 existing &'Sender:'& header line, and it may add a new one. You can modify
32603 these actions by setting the &%local_sender_retain%& option true, the
32604 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32605 control setting.
32606
32607 When a local message is received from an untrusted user and
32608 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32609 control has not been set, a check is made to see if the address given in the
32610 &'From:'& header line is the correct (local) sender of the message. The address
32611 that is expected has the login name as the local part and the value of
32612 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32613 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32614 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32615 line is added to the message.
32616
32617 If you set &%local_from_check%& false, this checking does not occur. However,
32618 the removal of an existing &'Sender:'& line still happens, unless you also set
32619 &%local_sender_retain%& to be true. It is not possible to set both of these
32620 options true at the same time.
32621
32622 .cindex "submission mode"
32623 By default, no processing of &'Sender:'& header lines is done for messages
32624 received over TCP/IP or for messages submitted by trusted users. However, when
32625 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32626 not specified on the submission control, the following processing takes place:
32627
32628 .vindex "&$authenticated_id$&"
32629 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32630 authenticated, and &$authenticated_id$& is not empty, a sender address is
32631 created as follows:
32632
32633 .ilist
32634 .vindex "&$qualify_domain$&"
32635 If no domain is specified by the submission control, the local part is
32636 &$authenticated_id$& and the domain is &$qualify_domain$&.
32637 .next
32638 If a non-empty domain is specified by the submission control, the local part
32639 is &$authenticated_id$&, and the domain is the specified domain.
32640 .next
32641 If an empty domain is specified by the submission control,
32642 &$authenticated_id$& is assumed to be the complete address.
32643 .endlist
32644
32645 This address is compared with the address in the &'From:'& header line. If they
32646 are different, a &'Sender:'& header line containing the created address is
32647 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32648 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32649
32650 .cindex "return path" "created from &'Sender:'&"
32651 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32652 the message (the envelope sender address) is changed to be the same address,
32653 except in the case of submission mode when &%sender_retain%& is specified.
32654
32655
32656
32657 .section "Adding and removing header lines in routers and transports" &&&
32658          "SECTheadersaddrem"
32659 .cindex "header lines" "adding; in router or transport"
32660 .cindex "header lines" "removing; in router or transport"
32661 When a message is delivered, the addition and removal of header lines can be
32662 specified in a system filter, or on any of the routers and transports that
32663 process the message. Section &<<SECTaddremheasys>>& contains details about
32664 modifying headers in a system filter. Header lines can also be added in an ACL
32665 as a message is received (see section &<<SECTaddheadacl>>&).
32666
32667 In contrast to what happens in a system filter, header modifications that are
32668 specified on routers and transports apply only to the particular recipient
32669 addresses that are being processed by those routers and transports. These
32670 changes do not actually take place until a copy of the message is being
32671 transported. Therefore, they do not affect the basic set of header lines, and
32672 they do not affect the values of the variables that refer to header lines.
32673
32674 &*Note*&: In particular, this means that any expansions in the configuration of
32675 the transport cannot refer to the modified header lines, because such
32676 expansions all occur before the message is actually transported.
32677
32678 For both routers and transports, the argument of a &%headers_add%&
32679 option must be in the form of one or more RFC 2822 header lines, separated by
32680 newlines (coded as &"\n"&). For example:
32681 .code
32682 headers_add = X-added-header: added by $primary_hostname\n\
32683               X-added-second: another added header line
32684 .endd
32685 Exim does not check the syntax of these added header lines.
32686
32687 Multiple &%headers_add%& options for a single router or transport can be
32688 specified; the values will append to a single list of header lines.
32689 Each header-line is separately expanded.
32690
32691 The argument of a &%headers_remove%& option must consist of a colon-separated
32692 list of header names. This is confusing, because header names themselves are
32693 often terminated by colons. In this case, the colons are the list separators,
32694 not part of the names. For example:
32695 .code
32696 headers_remove = return-receipt-to:acknowledge-to
32697 .endd
32698
32699 Multiple &%headers_remove%& options for a single router or transport can be
32700 specified; the arguments will append to a single header-names list.
32701 Each item is separately expanded.
32702 Note that colons in complex expansions which are used to
32703 form all or part of a &%headers_remove%& list
32704 will act as list separators.
32705
32706 When &%headers_add%& or &%headers_remove%& is specified on a router,
32707 items are expanded at routing time,
32708 and then associated with all addresses that are
32709 accepted by that router, and also with any new addresses that it generates. If
32710 an address passes through several routers as a result of aliasing or
32711 forwarding, the changes are cumulative.
32712
32713 .oindex "&%unseen%&"
32714 However, this does not apply to multiple routers that result from the use of
32715 the &%unseen%& option. Any header modifications that were specified by the
32716 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32717
32718 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32719 settings cannot be delivered together in a batch, so a transport is always
32720 dealing with a set of addresses that have the same header-processing
32721 requirements.
32722
32723 The transport starts by writing the original set of header lines that arrived
32724 with the message, possibly modified by the system filter. As it writes out
32725 these lines, it consults the list of header names that were attached to the
32726 recipient address(es) by &%headers_remove%& options in routers, and it also
32727 consults the transport's own &%headers_remove%& option. Header lines whose
32728 names are on either of these lists are not written out. If there are multiple
32729 instances of any listed header, they are all skipped.
32730
32731 After the remaining original header lines have been written, new header
32732 lines that were specified by routers' &%headers_add%& options are written, in
32733 the order in which they were attached to the address. These are followed by any
32734 header lines specified by the transport's &%headers_add%& option.
32735
32736 This way of handling header line modifications in routers and transports has
32737 the following consequences:
32738
32739 .ilist
32740 The original set of header lines, possibly modified by the system filter,
32741 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32742 to it, at all times.
32743 .next
32744 Header lines that are added by a router's
32745 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32746 expansion syntax in subsequent routers or the transport.
32747 .next
32748 Conversely, header lines that are specified for removal by &%headers_remove%&
32749 in a router remain visible to subsequent routers and the transport.
32750 .next
32751 Headers added to an address by &%headers_add%& in a router cannot be removed by
32752 a later router or by a transport.
32753 .next
32754 An added header can refer to the contents of an original header that is to be
32755 removed, even it has the same name as the added header. For example:
32756 .code
32757 headers_remove = subject
32758 headers_add = Subject: new subject (was: $h_subject:)
32759 .endd
32760 .endlist
32761
32762 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32763 for a &(redirect)& router that has the &%one_time%& option set.
32764
32765
32766
32767
32768
32769 .section "Constructed addresses" "SECTconstr"
32770 .cindex "address" "constructed"
32771 .cindex "constructed address"
32772 When Exim constructs a sender address for a locally-generated message, it uses
32773 the form
32774 .display
32775 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32776 .endd
32777 For example:
32778 .code
32779 Zaphod Beeblebrox <zaphod@end.univ.example>
32780 .endd
32781 The user name is obtained from the &%-F%& command line option if set, or
32782 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32783 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32784 ampersand character, this is replaced by the login name with the first letter
32785 upper cased, as is conventional in a number of operating systems. See the
32786 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32787 The &%unknown_username%& option can be used to specify user names in cases when
32788 there is no password file entry.
32789
32790 .cindex "RFC 2047"
32791 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32792 parts of it if necessary. In addition, if it contains any non-printing
32793 characters, it is encoded as described in RFC 2047, which defines a way of
32794 including non-ASCII characters in header lines. The value of the
32795 &%headers_charset%& option specifies the name of the encoding that is used (the
32796 characters are assumed to be in this encoding). The setting of
32797 &%print_topbitchars%& controls whether characters with the top bit set (that
32798 is, with codes greater than 127) count as printing characters or not.
32799
32800
32801
32802 .section "Case of local parts" "SECID230"
32803 .cindex "case of local parts"
32804 .cindex "local part" "case of"
32805 RFC 2822 states that the case of letters in the local parts of addresses cannot
32806 be assumed to be non-significant. Exim preserves the case of local parts of
32807 addresses, but by default it uses a lower-cased form when it is routing,
32808 because on most Unix systems, usernames are in lower case and case-insensitive
32809 routing is required. However, any particular router can be made to use the
32810 original case for local parts by setting the &%caseful_local_part%& generic
32811 router option.
32812
32813 .cindex "mixed-case login names"
32814 If you must have mixed-case user names on your system, the best way to proceed,
32815 assuming you want case-independent handling of incoming email, is to set up
32816 your first router to convert incoming local parts in your domains to the
32817 correct case by means of a file lookup. For example:
32818 .code
32819 correct_case:
32820   driver = redirect
32821   domains = +local_domains
32822   data = ${lookup{$local_part}cdb\
32823               {/etc/usercased.cdb}{$value}fail}\
32824               @$domain
32825 .endd
32826 For this router, the local part is forced to lower case by the default action
32827 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32828 up a new local part in the correct case. If you then set &%caseful_local_part%&
32829 on any subsequent routers which process your domains, they will operate on
32830 local parts with the correct case in a case-sensitive manner.
32831
32832
32833
32834 .section "Dots in local parts" "SECID231"
32835 .cindex "dot" "in local part"
32836 .cindex "local part" "dots in"
32837 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32838 part may not begin or end with a dot, nor have two consecutive dots in the
32839 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32840 empty components for compatibility.
32841
32842
32843
32844 .section "Rewriting addresses" "SECID232"
32845 .cindex "rewriting" "addresses"
32846 Rewriting of sender and recipient addresses, and addresses in headers, can
32847 happen automatically, or as the result of configuration options, as described
32848 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32849 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32850
32851 Automatic rewriting includes qualification, as mentioned above. The other case
32852 in which it can happen is when an incomplete non-local domain is given. The
32853 routing process may cause this to be expanded into the full domain name. For
32854 example, a header such as
32855 .code
32856 To: hare@teaparty
32857 .endd
32858 might get rewritten as
32859 .code
32860 To: hare@teaparty.wonderland.fict.example
32861 .endd
32862 Rewriting as a result of routing is the one kind of message processing that
32863 does not happen at input time, as it cannot be done until the address has
32864 been routed.
32865
32866 Strictly, one should not do &'any'& deliveries of a message until all its
32867 addresses have been routed, in case any of the headers get changed as a
32868 result of routing. However, doing this in practice would hold up many
32869 deliveries for unreasonable amounts of time, just because one address could not
32870 immediately be routed. Exim therefore does not delay other deliveries when
32871 routing of one or more addresses is deferred.
32872 .ecindex IIDmesproc
32873
32874
32875
32876 . ////////////////////////////////////////////////////////////////////////////
32877 . ////////////////////////////////////////////////////////////////////////////
32878
32879 .chapter "SMTP processing" "CHAPSMTP"
32880 .scindex IIDsmtpproc1 "SMTP" "processing details"
32881 .scindex IIDsmtpproc2 "LMTP" "processing details"
32882 Exim supports a number of different ways of using the SMTP protocol, and its
32883 LMTP variant, which is an interactive protocol for transferring messages into a
32884 closed mail store application. This chapter contains details of how SMTP is
32885 processed. For incoming mail, the following are available:
32886
32887 .ilist
32888 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32889 .next
32890 SMTP over the standard input and output (the &%-bs%& option);
32891 .next
32892 Batched SMTP on the standard input (the &%-bS%& option).
32893 .endlist
32894
32895 For mail delivery, the following are available:
32896
32897 .ilist
32898 SMTP over TCP/IP (the &(smtp)& transport);
32899 .next
32900 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32901 &"lmtp"&);
32902 .next
32903 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32904 transport);
32905 .next
32906 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32907 the &%use_bsmtp%& option set).
32908 .endlist
32909
32910 &'Batched SMTP'& is the name for a process in which batches of messages are
32911 stored in or read from files (or pipes), in a format in which SMTP commands are
32912 used to contain the envelope information.
32913
32914
32915
32916 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32917 .cindex "SMTP" "outgoing over TCP/IP"
32918 .cindex "outgoing SMTP over TCP/IP"
32919 .cindex "LMTP" "over TCP/IP"
32920 .cindex "outgoing LMTP over TCP/IP"
32921 .cindex "EHLO"
32922 .cindex "HELO"
32923 .cindex "SIZE option on MAIL command"
32924 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32925 The &%protocol%& option selects which protocol is to be used, but the actual
32926 processing is the same in both cases.
32927
32928 If, in response to its EHLO command, Exim is told that the SIZE
32929 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32930 command. The value of <&'n'&> is the message size plus the value of the
32931 &%size_addition%& option (default 1024) to allow for additions to the message
32932 such as per-transport header lines, or changes made in a
32933 .cindex "transport" "filter"
32934 .cindex "filter" "transport filter"
32935 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32936 suppressed.
32937
32938 If the remote server advertises support for PIPELINING, Exim uses the
32939 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32940 required for the transaction.
32941
32942 If the remote server advertises support for the STARTTLS command, and Exim
32943 was built to support TLS encryption, it tries to start a TLS session unless the
32944 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32945 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32946 is called for verification.
32947
32948 If the remote server advertises support for the AUTH command, Exim scans
32949 the authenticators configuration for any suitable client settings, as described
32950 in chapter &<<CHAPSMTPAUTH>>&.
32951
32952 .cindex "carriage return"
32953 .cindex "linefeed"
32954 Responses from the remote host are supposed to be terminated by CR followed by
32955 LF. However, there are known to be hosts that do not send CR characters, so in
32956 order to be able to interwork with such hosts, Exim treats LF on its own as a
32957 line terminator.
32958
32959 If a message contains a number of different addresses, all those with the same
32960 characteristics (for example, the same envelope sender) that resolve to the
32961 same set of hosts, in the same order, are sent in a single SMTP transaction,
32962 even if they are for different domains, unless there are more than the setting
32963 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32964 they are split into groups containing no more than &%max_rcpt%&s addresses
32965 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32966 in parallel sessions. The order of hosts with identical MX values is not
32967 significant when checking whether addresses can be batched in this way.
32968
32969 When the &(smtp)& transport suffers a temporary failure that is not
32970 message-related, Exim updates its transport-specific database, which contains
32971 records indexed by host name that remember which messages are waiting for each
32972 particular host. It also updates the retry database with new retry times.
32973
32974 .cindex "hints database" "retry keys"
32975 Exim's retry hints are based on host name plus IP address, so if one address of
32976 a multi-homed host is broken, it will soon be skipped most of the time.
32977 See the next section for more detail about error handling.
32978
32979 .cindex "SMTP" "passed connection"
32980 .cindex "SMTP" "batching over TCP/IP"
32981 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32982 looks in the hints database for the transport to see if there are any queued
32983 messages waiting for the host to which it is connected. If it finds one, it
32984 creates a new Exim process using the &%-MC%& option (which can only be used by
32985 a process running as root or the Exim user) and passes the TCP/IP socket to it
32986 so that it can deliver another message using the same socket. The new process
32987 does only those deliveries that are routed to the connected host, and may in
32988 turn pass the socket on to a third process, and so on.
32989
32990 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32991 limit the number of messages sent down a single TCP/IP connection.
32992
32993 .cindex "asterisk" "after IP address"
32994 The second and subsequent messages delivered down an existing connection are
32995 identified in the main log by the addition of an asterisk after the closing
32996 square bracket of the IP address.
32997
32998
32999
33000
33001 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33002 .cindex "error" "in outgoing SMTP"
33003 .cindex "SMTP" "errors in outgoing"
33004 .cindex "host" "error"
33005 Three different kinds of error are recognized for outgoing SMTP: host errors,
33006 message errors, and recipient errors.
33007
33008 .vlist
33009 .vitem "&*Host errors*&"
33010 A host error is not associated with a particular message or with a
33011 particular recipient of a message. The host errors are:
33012
33013 .ilist
33014 Connection refused or timed out,
33015 .next
33016 Any error response code on connection,
33017 .next
33018 Any error response code to EHLO or HELO,
33019 .next
33020 Loss of connection at any time, except after &"."&,
33021 .next
33022 I/O errors at any time,
33023 .next
33024 Timeouts during the session, other than in response to MAIL, RCPT or
33025 the &"."& at the end of the data.
33026 .endlist ilist
33027
33028 For a host error, a permanent error response on connection, or in response to
33029 EHLO, causes all addresses routed to the host to be failed. Any other host
33030 error causes all addresses to be deferred, and retry data to be created for the
33031 host. It is not tried again, for any message, until its retry time arrives. If
33032 the current set of addresses are not all delivered in this run (to some
33033 alternative host), the message is added to the list of those waiting for this
33034 host, so if it is still undelivered when a subsequent successful delivery is
33035 made to the host, it will be sent down the same SMTP connection.
33036
33037 .vitem "&*Message errors*&"
33038 .cindex "message" "error"
33039 A message error is associated with a particular message when sent to a
33040 particular host, but not with a particular recipient of the message. The
33041 message errors are:
33042
33043 .ilist
33044 Any error response code to MAIL, DATA, or the &"."& that terminates
33045 the data,
33046 .next
33047 Timeout after MAIL,
33048 .next
33049 Timeout or loss of connection after the &"."& that terminates the data. A
33050 timeout after the DATA command itself is treated as a host error, as is loss of
33051 connection at any other time.
33052 .endlist ilist
33053
33054 For a message error, a permanent error response (5&'xx'&) causes all addresses
33055 to be failed, and a delivery error report to be returned to the sender. A
33056 temporary error response (4&'xx'&), or one of the timeouts, causes all
33057 addresses to be deferred. Retry data is not created for the host, but instead,
33058 a retry record for the combination of host plus message id is created. The
33059 message is not added to the list of those waiting for this host. This ensures
33060 that the failing message will not be sent to this host again until the retry
33061 time arrives. However, other messages that are routed to the host are not
33062 affected, so if it is some property of the message that is causing the error,
33063 it will not stop the delivery of other mail.
33064
33065 If the remote host specified support for the SIZE parameter in its response
33066 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33067 over-large message will cause a message error because the error arrives as a
33068 response to MAIL.
33069
33070 .vitem "&*Recipient errors*&"
33071 .cindex "recipient" "error"
33072 A recipient error is associated with a particular recipient of a message. The
33073 recipient errors are:
33074
33075 .ilist
33076 Any error response to RCPT,
33077 .next
33078 Timeout after RCPT.
33079 .endlist
33080
33081 For a recipient error, a permanent error response (5&'xx'&) causes the
33082 recipient address to be failed, and a bounce message to be returned to the
33083 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33084 address to be deferred, and routing retry data to be created for it. This is
33085 used to delay processing of the address in subsequent queue runs, until its
33086 routing retry time arrives. This applies to all messages, but because it
33087 operates only in queue runs, one attempt will be made to deliver a new message
33088 to the failing address before the delay starts to operate. This ensures that,
33089 if the failure is really related to the message rather than the recipient
33090 (&"message too big for this recipient"& is a possible example), other messages
33091 have a chance of getting delivered. If a delivery to the address does succeed,
33092 the retry information gets cleared, so all stuck messages get tried again, and
33093 the retry clock is reset.
33094
33095 The message is not added to the list of those waiting for this host. Use of the
33096 host for other messages is unaffected, and except in the case of a timeout,
33097 other recipients are processed independently, and may be successfully delivered
33098 in the current SMTP session. After a timeout it is of course impossible to
33099 proceed with the session, so all addresses get deferred. However, those other
33100 than the one that failed do not suffer any subsequent retry delays. Therefore,
33101 if one recipient is causing trouble, the others have a chance of getting
33102 through when a subsequent delivery attempt occurs before the failing
33103 recipient's retry time.
33104 .endlist
33105
33106 In all cases, if there are other hosts (or IP addresses) available for the
33107 current set of addresses (for example, from multiple MX records), they are
33108 tried in this run for any undelivered addresses, subject of course to their
33109 own retry data. In other words, recipient error retry data does not take effect
33110 until the next delivery attempt.
33111
33112 Some hosts have been observed to give temporary error responses to every
33113 MAIL command at certain times (&"insufficient space"& has been seen). It
33114 would be nice if such circumstances could be recognized, and defer data for the
33115 host itself created, but this is not possible within the current Exim design.
33116 What actually happens is that retry data for every (host, message) combination
33117 is created.
33118
33119 The reason that timeouts after MAIL and RCPT are treated specially is that
33120 these can sometimes arise as a result of the remote host's verification
33121 procedures. Exim makes this assumption, and treats them as if a temporary error
33122 response had been received. A timeout after &"."& is treated specially because
33123 it is known that some broken implementations fail to recognize the end of the
33124 message if the last character of the last line is a binary zero. Thus, it is
33125 helpful to treat this case as a message error.
33126
33127 Timeouts at other times are treated as host errors, assuming a problem with the
33128 host, or the connection to it. If a timeout after MAIL, RCPT,
33129 or &"."& is really a connection problem, the assumption is that at the next try
33130 the timeout is likely to occur at some other point in the dialogue, causing it
33131 then to be treated as a host error.
33132
33133 There is experimental evidence that some MTAs drop the connection after the
33134 terminating &"."& if they do not like the contents of the message for some
33135 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33136 should be given. That is why Exim treats this case as a message rather than a
33137 host error, in order not to delay other messages to the same host.
33138
33139
33140
33141
33142 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33143 .cindex "SMTP" "incoming over TCP/IP"
33144 .cindex "incoming SMTP over TCP/IP"
33145 .cindex "inetd"
33146 .cindex "daemon"
33147 Incoming SMTP messages can be accepted in one of two ways: by running a
33148 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33149 &_/etc/inetd.conf_& should be like this:
33150 .code
33151 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33152 .endd
33153 Exim distinguishes between this case and the case of a locally running user
33154 agent using the &%-bs%& option by checking whether or not the standard input is
33155 a socket. When it is, either the port must be privileged (less than 1024), or
33156 the caller must be root or the Exim user. If any other user passes a socket
33157 with an unprivileged port number, Exim prints a message on the standard error
33158 stream and exits with an error code.
33159
33160 By default, Exim does not make a log entry when a remote host connects or
33161 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33162 unexpected. It can be made to write such log entries by setting the
33163 &%smtp_connection%& log selector.
33164
33165 .cindex "carriage return"
33166 .cindex "linefeed"
33167 Commands from the remote host are supposed to be terminated by CR followed by
33168 LF. However, there are known to be hosts that do not send CR characters. In
33169 order to be able to interwork with such hosts, Exim treats LF on its own as a
33170 line terminator.
33171 Furthermore, because common code is used for receiving messages from all
33172 sources, a CR on its own is also interpreted as a line terminator. However, the
33173 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33174
33175 .cindex "EHLO" "invalid data"
33176 .cindex "HELO" "invalid data"
33177 One area that sometimes gives rise to problems concerns the EHLO or
33178 HELO commands. Some clients send syntactically invalid versions of these
33179 commands, which Exim rejects by default. (This is nothing to do with verifying
33180 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33181 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33182 match the broken hosts that send invalid commands.
33183
33184 .cindex "SIZE option on MAIL command"
33185 .cindex "MAIL" "SIZE option"
33186 The amount of disk space available is checked whenever SIZE is received on
33187 a MAIL command, independently of whether &%message_size_limit%& or
33188 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33189 false. A temporary error is given if there is not enough space. If
33190 &%check_spool_space%& is set, the check is for that amount of space plus the
33191 value given with SIZE, that is, it checks that the addition of the incoming
33192 message will not reduce the space below the threshold.
33193
33194 When a message is successfully received, Exim includes the local message id in
33195 its response to the final &"."& that terminates the data. If the remote host
33196 logs this text it can help with tracing what has happened to a message.
33197
33198 The Exim daemon can limit the number of simultaneous incoming connections it is
33199 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33200 number of simultaneous incoming connections from a single remote host (see the
33201 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33202 rejected using the SMTP temporary error code 421.
33203
33204 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33205 subprocess has finished, as this can get lost at busy times. Instead, it looks
33206 for completed subprocesses every time it wakes up. Provided there are other
33207 things happening (new incoming calls, starts of queue runs), completed
33208 processes will be noticed and tidied away. On very quiet systems you may
33209 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33210 it will be noticed when the daemon next wakes up.
33211
33212 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33213 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33214 high system load &-- for details see the &%smtp_accept_reserve%&,
33215 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33216 applies in both the daemon and &'inetd'& cases.
33217
33218 Exim normally starts a delivery process for each message received, though this
33219 can be varied by means of the &%-odq%& command line option and the
33220 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33221 number of simultaneously running delivery processes started in this way from
33222 SMTP input can be limited by the &%smtp_accept_queue%& and
33223 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33224 subsequently received messages are just put on the input queue without starting
33225 a delivery process.
33226
33227 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33228 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33229 started up from the &'inetd'& daemon, because in that case each connection is
33230 handled by an entirely independent Exim process. Control by load average is,
33231 however, available with &'inetd'&.
33232
33233 Exim can be configured to verify addresses in incoming SMTP commands as they
33234 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33235 to rewrite addresses at this time &-- before any syntax checking is done. See
33236 section &<<SECTrewriteS>>&.
33237
33238 Exim can also be configured to limit the rate at which a client host submits
33239 MAIL and RCPT commands in a single SMTP session. See the
33240 &%smtp_ratelimit_hosts%& option.
33241
33242
33243
33244 .section "Unrecognized SMTP commands" "SECID234"
33245 .cindex "SMTP" "unrecognized commands"
33246 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33247 commands during a single SMTP connection, it drops the connection after sending
33248 the error response to the last command. The default value for
33249 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33250 abuse that subvert web servers into making connections to SMTP ports; in these
33251 circumstances, a number of non-SMTP lines are sent first.
33252
33253
33254 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33255 .cindex "SMTP" "syntax errors"
33256 .cindex "SMTP" "protocol errors"
33257 A syntax error is detected if an SMTP command is recognized, but there is
33258 something syntactically wrong with its data, for example, a malformed email
33259 address in a RCPT command. Protocol errors include invalid command
33260 sequencing such as RCPT before MAIL. If Exim receives more than
33261 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33262 drops the connection after sending the error response to the last command. The
33263 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33264 broken clients that loop sending bad commands (yes, it has been seen).
33265
33266
33267
33268 .section "Use of non-mail SMTP commands" "SECID236"
33269 .cindex "SMTP" "non-mail commands"
33270 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33271 DATA. Exim counts such commands, and drops the connection if there are too
33272 many of them in a single SMTP session. This action catches some
33273 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33274 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33275 defines what &"too many"& means. Its default value is 10.
33276
33277 When a new message is expected, one occurrence of RSET is not counted. This
33278 allows a client to send one RSET between messages (this is not necessary,
33279 but some clients do it). Exim also allows one uncounted occurrence of HELO
33280 or EHLO, and one occurrence of STARTTLS between messages. After
33281 starting up a TLS session, another EHLO is expected, and so it too is not
33282 counted.
33283
33284 The first occurrence of AUTH in a connection, or immediately following
33285 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33286 RCPT, DATA, and QUIT are counted.
33287
33288 You can control which hosts are subject to the limit set by
33289 &%smtp_accept_max_nonmail%& by setting
33290 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33291 the limit apply to all hosts. This option means that you can exclude any
33292 specific badly-behaved hosts that you have to live with.
33293
33294
33295
33296
33297 .section "The VRFY and EXPN commands" "SECID237"
33298 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33299 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33300 appropriate) in order to decide whether the command should be accepted or not.
33301 If no ACL is defined, the command is rejected.
33302
33303 .cindex "VRFY" "processing"
33304 When VRFY is accepted, it runs exactly the same code as when Exim is
33305 called with the &%-bv%& option.
33306
33307 .cindex "EXPN" "processing"
33308 When EXPN is accepted, a single-level expansion of the address is done.
33309 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33310 than a verification (the &%-bv%& option). If an unqualified local part is given
33311 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33312 of VRFY and EXPN commands are logged on the main and reject logs, and
33313 VRFY verification failures are logged on the main log for consistency with
33314 RCPT failures.
33315
33316
33317
33318 .section "The ETRN command" "SECTETRN"
33319 .cindex "ETRN" "processing"
33320 RFC 1985 describes an SMTP command called ETRN that is designed to
33321 overcome the security problems of the TURN command (which has fallen into
33322 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33323 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33324 should be accepted or not. If no ACL is defined, the command is rejected.
33325
33326 The ETRN command is concerned with &"releasing"& messages that are awaiting
33327 delivery to certain hosts. As Exim does not organize its message queue by host,
33328 the only form of ETRN that is supported by default is the one where the
33329 text starts with the &"#"& prefix, in which case the remainder of the text is
33330 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33331 the &%-R%& option to happen, with the remainder of the ETRN text as its
33332 argument. For example,
33333 .code
33334 ETRN #brigadoon
33335 .endd
33336 runs the command
33337 .code
33338 exim -R brigadoon
33339 .endd
33340 which causes a delivery attempt on all messages with undelivered addresses
33341 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33342 default), Exim prevents the simultaneous execution of more than one queue run
33343 for the same argument string as a result of an ETRN command. This stops
33344 a misbehaving client from starting more than one queue runner at once.
33345
33346 .cindex "hints database" "ETRN serialization"
33347 Exim implements the serialization by means of a hints database in which a
33348 record is written whenever a process is started by ETRN, and deleted when
33349 the process completes. However, Exim does not keep the SMTP session waiting for
33350 the ETRN process to complete. Once ETRN is accepted, the client is sent
33351 a &"success"& return code. Obviously there is scope for hints records to get
33352 left lying around if there is a system or program crash. To guard against this,
33353 Exim ignores any records that are more than six hours old.
33354
33355 .oindex "&%smtp_etrn_command%&"
33356 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33357 used. This specifies a command that is run whenever ETRN is received,
33358 whatever the form of its argument. For
33359 example:
33360 .code
33361 smtp_etrn_command = /etc/etrn_command $domain \
33362                     $sender_host_address
33363 .endd
33364 .vindex "&$domain$&"
33365 The string is split up into arguments which are independently expanded. The
33366 expansion variable &$domain$& is set to the argument of the ETRN command,
33367 and no syntax checking is done on the contents of this argument. Exim does not
33368 wait for the command to complete, so its status code is not checked. Exim runs
33369 under its own uid and gid when receiving incoming SMTP, so it is not possible
33370 for it to change them before running the command.
33371
33372
33373
33374 .section "Incoming local SMTP" "SECID238"
33375 .cindex "SMTP" "local incoming"
33376 Some user agents use SMTP to pass messages to their local MTA using the
33377 standard input and output, as opposed to passing the envelope on the command
33378 line and writing the message to the standard input. This is supported by the
33379 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33380 messages over TCP/IP (including the use of ACLs), except that the envelope
33381 sender given in a MAIL command is ignored unless the caller is trusted. In
33382 an ACL you can detect this form of SMTP input by testing for an empty host
33383 identification. It is common to have this as the first line in the ACL that
33384 runs for RCPT commands:
33385 .code
33386 accept hosts = :
33387 .endd
33388 This accepts SMTP messages from local processes without doing any other tests.
33389
33390
33391
33392 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33393 .cindex "SMTP" "batched outgoing"
33394 .cindex "batched SMTP output"
33395 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33396 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33397 be output in BSMTP format. No SMTP responses are possible for this form of
33398 delivery. All it is doing is using SMTP commands as a way of transmitting the
33399 envelope along with the message.
33400
33401 The message is written to the file or pipe preceded by the SMTP commands
33402 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33403 the message that start with a dot have an extra dot added. The SMTP command
33404 HELO is not normally used. If it is required, the &%message_prefix%& option
33405 can be used to specify it.
33406
33407 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33408 one recipient address at a time by default. However, you can arrange for them
33409 to handle several addresses at once by setting the &%batch_max%& option. When
33410 this is done for BSMTP, messages may contain multiple RCPT commands. See
33411 chapter &<<CHAPbatching>>& for more details.
33412
33413 .vindex "&$host$&"
33414 When one or more addresses are routed to a BSMTP transport by a router that
33415 sets up a host list, the name of the first host on the list is available to the
33416 transport in the variable &$host$&. Here is an example of such a transport and
33417 router:
33418 .code
33419 begin routers
33420 route_append:
33421   driver = manualroute
33422   transport = smtp_appendfile
33423   route_list = domain.example  batch.host.example
33424
33425 begin transports
33426 smtp_appendfile:
33427   driver = appendfile
33428   directory = /var/bsmtp/$host
33429   batch_max = 1000
33430   use_bsmtp
33431   user = exim
33432 .endd
33433 This causes messages addressed to &'domain.example'& to be written in BSMTP
33434 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33435 message (unless there are more than 1000 recipients).
33436
33437
33438
33439 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33440 .cindex "SMTP" "batched incoming"
33441 .cindex "batched SMTP input"
33442 The &%-bS%& command line option causes Exim to accept one or more messages by
33443 reading SMTP on the standard input, but to generate no responses. If the caller
33444 is trusted, the senders in the MAIL commands are believed; otherwise the
33445 sender is always the caller of Exim. Unqualified senders and receivers are not
33446 rejected (there seems little point) but instead just get qualified. HELO
33447 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33448 as NOOP; QUIT quits.
33449
33450 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33451 ACL is run in the same way as for non-SMTP local input.
33452
33453 If an error is detected while reading a message, including a missing &"."& at
33454 the end, Exim gives up immediately. It writes details of the error to the
33455 standard output in a stylized way that the calling program should be able to
33456 make some use of automatically, for example:
33457 .code
33458 554 Unexpected end of file
33459 Transaction started in line 10
33460 Error detected in line 14
33461 .endd
33462 It writes a more verbose version, for human consumption, to the standard error
33463 file, for example:
33464 .code
33465 An error was detected while processing a file of BSMTP input.
33466 The error message was:
33467
33468 501 '>' missing at end of address
33469
33470 The SMTP transaction started in line 10.
33471 The error was detected in line 12.
33472 The SMTP command at fault was:
33473
33474 rcpt to:<malformed@in.com.plete
33475
33476 1 previous message was successfully processed.
33477 The rest of the batch was abandoned.
33478 .endd
33479 The return code from Exim is zero only if there were no errors. It is 1 if some
33480 messages were accepted before an error was detected, and 2 if no messages were
33481 accepted.
33482 .ecindex IIDsmtpproc1
33483 .ecindex IIDsmtpproc2
33484
33485
33486
33487 . ////////////////////////////////////////////////////////////////////////////
33488 . ////////////////////////////////////////////////////////////////////////////
33489
33490 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33491          "Customizing messages"
33492 When a message fails to be delivered, or remains on the queue for more than a
33493 configured amount of time, Exim sends a message to the original sender, or
33494 to an alternative configured address. The text of these messages is built into
33495 the code of Exim, but it is possible to change it, either by adding a single
33496 string, or by replacing each of the paragraphs by text supplied in a file.
33497
33498 The &'From:'& and &'To:'& header lines are automatically generated; you can
33499 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33500 option. Exim also adds the line
33501 .code
33502 Auto-Submitted: auto-generated
33503 .endd
33504 to all warning and bounce messages,
33505
33506
33507 .section "Customizing bounce messages" "SECID239"
33508 .cindex "customizing" "bounce message"
33509 .cindex "bounce message" "customizing"
33510 If &%bounce_message_text%& is set, its contents are included in the default
33511 message immediately after &"This message was created automatically by mail
33512 delivery software."& The string is not expanded. It is not used if
33513 &%bounce_message_file%& is set.
33514
33515 When &%bounce_message_file%& is set, it must point to a template file for
33516 constructing error messages. The file consists of a series of text items,
33517 separated by lines consisting of exactly four asterisks. If the file cannot be
33518 opened, default text is used and a message is written to the main and panic
33519 logs. If any text item in the file is empty, default text is used for that
33520 item.
33521
33522 .vindex "&$bounce_recipient$&"
33523 .vindex "&$bounce_return_size_limit$&"
33524 Each item of text that is read from the file is expanded, and there are two
33525 expansion variables which can be of use here: &$bounce_recipient$& is set to
33526 the recipient of an error message while it is being created, and
33527 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33528 option, rounded to a whole number.
33529
33530 The items must appear in the file in the following order:
33531
33532 .ilist
33533 The first item is included in the headers, and should include at least a
33534 &'Subject:'& header. Exim does not check the syntax of these headers.
33535 .next
33536 The second item forms the start of the error message. After it, Exim lists the
33537 failing addresses with their error messages.
33538 .next
33539 The third item is used to introduce any text from pipe transports that is to be
33540 returned to the sender. It is omitted if there is no such text.
33541 .next
33542 The fourth, fifth and sixth items will be ignored and may be empty.
33543 The fields exist for back-compatibility
33544 .endlist
33545
33546 The default state (&%bounce_message_file%& unset) is equivalent to the
33547 following file, in which the sixth item is empty. The &'Subject:'& and some
33548 other lines have been split in order to fit them on the page:
33549 .code
33550 Subject: Mail delivery failed
33551   ${if eq{$sender_address}{$bounce_recipient}
33552   {: returning message to sender}}
33553 ****
33554 This message was created automatically by mail delivery software.
33555
33556 A message ${if eq{$sender_address}{$bounce_recipient}
33557   {that you sent }{sent by
33558
33559 <$sender_address>
33560
33561 }}could not be delivered to all of its recipients.
33562 This is a permanent error. The following address(es) failed:
33563 ****
33564 The following text was generated during the delivery attempt(s):
33565 ****
33566 ------ This is a copy of the message, including all the headers.
33567   ------
33568 ****
33569 ------ The body of the message is $message_size characters long;
33570   only the first
33571 ------ $bounce_return_size_limit or so are included here.
33572 ****
33573 .endd
33574 .section "Customizing warning messages" "SECTcustwarn"
33575 .cindex "customizing" "warning message"
33576 .cindex "warning of delay" "customizing the message"
33577 The option &%warn_message_file%& can be pointed at a template file for use when
33578 warnings about message delays are created. In this case there are only three
33579 text sections:
33580
33581 .ilist
33582 The first item is included in the headers, and should include at least a
33583 &'Subject:'& header. Exim does not check the syntax of these headers.
33584 .next
33585 The second item forms the start of the warning message. After it, Exim lists
33586 the delayed addresses.
33587 .next
33588 The third item then ends the message.
33589 .endlist
33590
33591 The default state is equivalent to the following file, except that some lines
33592 have been split here, in order to fit them on the page:
33593 .code
33594 Subject: Warning: message $message_exim_id delayed
33595   $warn_message_delay
33596 ****
33597 This message was created automatically by mail delivery software.
33598
33599 A message ${if eq{$sender_address}{$warn_message_recipients}
33600 {that you sent }{sent by
33601
33602 <$sender_address>
33603
33604 }}has not been delivered to all of its recipients after
33605 more than $warn_message_delay on the queue on $primary_hostname.
33606
33607 The message identifier is:     $message_exim_id
33608 The subject of the message is: $h_subject
33609 The date of the message is:    $h_date
33610
33611 The following address(es) have not yet been delivered:
33612 ****
33613 No action is required on your part. Delivery attempts will
33614 continue for some time, and this warning may be repeated at
33615 intervals if the message remains undelivered. Eventually the
33616 mail delivery software will give up, and when that happens,
33617 the message will be returned to you.
33618 .endd
33619 .vindex "&$warn_message_delay$&"
33620 .vindex "&$warn_message_recipients$&"
33621 However, in the default state the subject and date lines are omitted if no
33622 appropriate headers exist. During the expansion of this file,
33623 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33624 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33625 of recipients for the warning message. There may be more than one if there are
33626 multiple addresses with different &%errors_to%& settings on the routers that
33627 handled them.
33628
33629
33630
33631
33632 . ////////////////////////////////////////////////////////////////////////////
33633 . ////////////////////////////////////////////////////////////////////////////
33634
33635 .chapter "Some common configuration settings" "CHAPcomconreq"
33636 This chapter discusses some configuration settings that seem to be fairly
33637 common. More examples and discussion can be found in the Exim book.
33638
33639
33640
33641 .section "Sending mail to a smart host" "SECID240"
33642 .cindex "smart host" "example router"
33643 If you want to send all mail for non-local domains to a &"smart host"&, you
33644 should replace the default &(dnslookup)& router with a router which does the
33645 routing explicitly:
33646 .code
33647 send_to_smart_host:
33648   driver = manualroute
33649   route_list = !+local_domains smart.host.name
33650   transport = remote_smtp
33651 .endd
33652 You can use the smart host's IP address instead of the name if you wish.
33653 If you are using Exim only to submit messages to a smart host, and not for
33654 receiving incoming messages, you can arrange for it to do the submission
33655 synchronously by setting the &%mua_wrapper%& option (see chapter
33656 &<<CHAPnonqueueing>>&).
33657
33658
33659
33660
33661 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33662 .cindex "mailing lists"
33663 Exim can be used to run simple mailing lists, but for large and/or complicated
33664 requirements, the use of additional specialized mailing list software such as
33665 Majordomo or Mailman is recommended.
33666
33667 The &(redirect)& router can be used to handle mailing lists where each list
33668 is maintained in a separate file, which can therefore be managed by an
33669 independent manager. The &%domains%& router option can be used to run these
33670 lists in a separate domain from normal mail. For example:
33671 .code
33672 lists:
33673   driver = redirect
33674   domains = lists.example
33675   file = /usr/lists/$local_part
33676   forbid_pipe
33677   forbid_file
33678   errors_to = $local_part-request@lists.example
33679   no_more
33680 .endd
33681 This router is skipped for domains other than &'lists.example'&. For addresses
33682 in that domain, it looks for a file that matches the local part. If there is no
33683 such file, the router declines, but because &%no_more%& is set, no subsequent
33684 routers are tried, and so the whole delivery fails.
33685
33686 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33687 expanded into a file name or a pipe delivery, which is usually inappropriate in
33688 a mailing list.
33689
33690 .oindex "&%errors_to%&"
33691 The &%errors_to%& option specifies that any delivery errors caused by addresses
33692 taken from a mailing list are to be sent to the given address rather than the
33693 original sender of the message. However, before acting on this, Exim verifies
33694 the error address, and ignores it if verification fails.
33695
33696 For example, using the configuration above, mail sent to
33697 &'dicts@lists.example'& is passed on to those addresses contained in
33698 &_/usr/lists/dicts_&, with error reports directed to
33699 &'dicts-request@lists.example'&, provided that this address can be verified.
33700 There could be a file called &_/usr/lists/dicts-request_& containing
33701 the address(es) of this particular list's manager(s), but other approaches,
33702 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33703 or &%local_part_suffix%& options) to handle addresses of the form
33704 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33705
33706
33707
33708 .section "Syntax errors in mailing lists" "SECID241"
33709 .cindex "mailing lists" "syntax errors in"
33710 If an entry in redirection data contains a syntax error, Exim normally defers
33711 delivery of the original address. That means that a syntax error in a mailing
33712 list holds up all deliveries to the list. This may not be appropriate when a
33713 list is being maintained automatically from data supplied by users, and the
33714 addresses are not rigorously checked.
33715
33716 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33717 entries that fail to parse, noting the incident in the log. If in addition
33718 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33719 whenever a broken address is skipped. It is usually appropriate to set
33720 &%syntax_errors_to%& to the same address as &%errors_to%&.
33721
33722
33723
33724 .section "Re-expansion of mailing lists" "SECID242"
33725 .cindex "mailing lists" "re-expansion of"
33726 Exim remembers every individual address to which a message has been delivered,
33727 in order to avoid duplication, but it normally stores only the original
33728 recipient addresses with a message. If all the deliveries to a mailing list
33729 cannot be done at the first attempt, the mailing list is re-expanded when the
33730 delivery is next tried. This means that alterations to the list are taken into
33731 account at each delivery attempt, so addresses that have been added to
33732 the list since the message arrived will therefore receive a copy of the
33733 message, even though it pre-dates their subscription.
33734
33735 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33736 on the &(redirect)& router. If this is done, any addresses generated by the
33737 router that fail to deliver at the first attempt are added to the message as
33738 &"top level"& addresses, and the parent address that generated them is marked
33739 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33740 subsequent delivery attempts. The disadvantage of this is that if any of the
33741 failing addresses are incorrect, correcting them in the file has no effect on
33742 pre-existing messages.
33743
33744 The original top-level address is remembered with each of the generated
33745 addresses, and is output in any log messages. However, any intermediate parent
33746 addresses are not recorded. This makes a difference to the log only if the
33747 &%all_parents%& selector is set, but for mailing lists there is normally only
33748 one level of expansion anyway.
33749
33750
33751
33752 .section "Closed mailing lists" "SECID243"
33753 .cindex "mailing lists" "closed"
33754 The examples so far have assumed open mailing lists, to which anybody may
33755 send mail. It is also possible to set up closed lists, where mail is accepted
33756 from specified senders only. This is done by making use of the generic
33757 &%senders%& option to restrict the router that handles the list.
33758
33759 The following example uses the same file as a list of recipients and as a list
33760 of permitted senders. It requires three routers:
33761 .code
33762 lists_request:
33763   driver = redirect
33764   domains = lists.example
33765   local_part_suffix = -request
33766   file = /usr/lists/$local_part$local_part_suffix
33767   no_more
33768
33769 lists_post:
33770   driver = redirect
33771   domains = lists.example
33772   senders = ${if exists {/usr/lists/$local_part}\
33773              {lsearch;/usr/lists/$local_part}{*}}
33774   file = /usr/lists/$local_part
33775   forbid_pipe
33776   forbid_file
33777   errors_to = $local_part-request@lists.example
33778   no_more
33779
33780 lists_closed:
33781   driver = redirect
33782   domains = lists.example
33783   allow_fail
33784   data = :fail: $local_part@lists.example is a closed mailing list
33785 .endd
33786 All three routers have the same &%domains%& setting, so for any other domains,
33787 they are all skipped. The first router runs only if the local part ends in
33788 &%-request%&. It handles messages to the list manager(s) by means of an open
33789 mailing list.
33790
33791 The second router runs only if the &%senders%& precondition is satisfied. It
33792 checks for the existence of a list that corresponds to the local part, and then
33793 checks that the sender is on the list by means of a linear search. It is
33794 necessary to check for the existence of the file before trying to search it,
33795 because otherwise Exim thinks there is a configuration error. If the file does
33796 not exist, the expansion of &%senders%& is *, which matches all senders. This
33797 means that the router runs, but because there is no list, declines, and
33798 &%no_more%& ensures that no further routers are run. The address fails with an
33799 &"unrouteable address"& error.
33800
33801 The third router runs only if the second router is skipped, which happens when
33802 a mailing list exists, but the sender is not on it. This router forcibly fails
33803 the address, giving a suitable error message.
33804
33805
33806
33807
33808 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33809 .cindex "VERP"
33810 .cindex "Variable Envelope Return Paths"
33811 .cindex "envelope sender"
33812 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33813 are a way of helping mailing list administrators discover which subscription
33814 address is the cause of a particular delivery failure. The idea is to encode
33815 the original recipient address in the outgoing envelope sender address, so that
33816 if the message is forwarded by another host and then subsequently bounces, the
33817 original recipient can be extracted from the recipient address of the bounce.
33818
33819 .oindex &%errors_to%&
33820 .oindex &%return_path%&
33821 Envelope sender addresses can be modified by Exim using two different
33822 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33823 list examples), or the &%return_path%& option on a transport. The second of
33824 these is effective only if the message is successfully delivered to another
33825 host; it is not used for errors detected on the local host (see the description
33826 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33827 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33828 .code
33829 verp_smtp:
33830   driver = smtp
33831   max_rcpt = 1
33832   return_path = \
33833     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33834       {$1-request+$local_part=$domain@your.dom.example}fail}
33835 .endd
33836 This has the effect of rewriting the return path (envelope sender) on outgoing
33837 SMTP messages, if the local part of the original return path ends in
33838 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33839 local part and domain of the recipient into the return path. Suppose, for
33840 example, that a message whose return path has been set to
33841 &'somelist-request@your.dom.example'& is sent to
33842 &'subscriber@other.dom.example'&. In the transport, the return path is
33843 rewritten as
33844 .code
33845 somelist-request+subscriber=other.dom.example@your.dom.example
33846 .endd
33847 .vindex "&$local_part$&"
33848 For this to work, you must tell Exim to send multiple copies of messages that
33849 have more than one recipient, so that each copy has just one recipient. This is
33850 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33851 might be sent to several different recipients in the same domain, in which case
33852 &$local_part$& is not available in the transport, because it is not unique.
33853
33854 Unless your host is doing nothing but mailing list deliveries, you should
33855 probably use a separate transport for the VERP deliveries, so as not to use
33856 extra resources in making one-per-recipient copies for other deliveries. This
33857 can easily be done by expanding the &%transport%& option in the router:
33858 .code
33859 dnslookup:
33860   driver = dnslookup
33861   domains = ! +local_domains
33862   transport = \
33863     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33864       {verp_smtp}{remote_smtp}}
33865   no_more
33866 .endd
33867 If you want to change the return path using &%errors_to%& in a router instead
33868 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33869 routers that handle mailing list addresses. This will ensure that all delivery
33870 errors, including those detected on the local host, are sent to the VERP
33871 address.
33872
33873 On a host that does no local deliveries and has no manual routing, only the
33874 &(dnslookup)& router needs to be changed. A special transport is not needed for
33875 SMTP deliveries. Every mailing list recipient has its own return path value,
33876 and so Exim must hand them to the transport one at a time. Here is an example
33877 of a &(dnslookup)& router that implements VERP:
33878 .code
33879 verp_dnslookup:
33880   driver = dnslookup
33881   domains = ! +local_domains
33882   transport = remote_smtp
33883   errors_to = \
33884     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33885      {$1-request+$local_part=$domain@your.dom.example}fail}
33886   no_more
33887 .endd
33888 Before you start sending out messages with VERPed return paths, you must also
33889 configure Exim to accept the bounce messages that come back to those paths.
33890 Typically this is done by setting a &%local_part_suffix%& option for a
33891 router, and using this to route the messages to wherever you want to handle
33892 them.
33893
33894 The overhead incurred in using VERP depends very much on the size of the
33895 message, the number of recipient addresses that resolve to the same remote
33896 host, and the speed of the connection over which the message is being sent. If
33897 a lot of addresses resolve to the same host and the connection is slow, sending
33898 a separate copy of the message for each address may take substantially longer
33899 than sending a single copy with many recipients (for which VERP cannot be
33900 used).
33901
33902
33903
33904
33905
33906
33907 .section "Virtual domains" "SECTvirtualdomains"
33908 .cindex "virtual domains"
33909 .cindex "domain" "virtual"
33910 The phrase &'virtual domain'& is unfortunately used with two rather different
33911 meanings:
33912
33913 .ilist
33914 A domain for which there are no real mailboxes; all valid local parts are
33915 aliases for other email addresses. Common examples are organizational
33916 top-level domains and &"vanity"& domains.
33917 .next
33918 One of a number of independent domains that are all handled by the same host,
33919 with mailboxes on that host, but where the mailbox owners do not necessarily
33920 have login accounts on that host.
33921 .endlist
33922
33923 The first usage is probably more common, and does seem more &"virtual"& than
33924 the second. This kind of domain can be handled in Exim with a straightforward
33925 aliasing router. One approach is to create a separate alias file for each
33926 virtual domain. Exim can test for the existence of the alias file to determine
33927 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33928 to a router of this form:
33929 .code
33930 virtual:
33931   driver = redirect
33932   domains = dsearch;/etc/mail/virtual
33933   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33934   no_more
33935 .endd
33936 The &%domains%& option specifies that the router is to be skipped, unless there
33937 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33938 domain that is being processed. When the router runs, it looks up the local
33939 part in the file to find a new address (or list of addresses). The &%no_more%&
33940 setting ensures that if the lookup fails (leading to &%data%& being an empty
33941 string), Exim gives up on the address without trying any subsequent routers.
33942
33943 This one router can handle all the virtual domains because the alias file names
33944 follow a fixed pattern. Permissions can be arranged so that appropriate people
33945 can edit the different alias files. A successful aliasing operation results in
33946 a new envelope recipient address, which is then routed from scratch.
33947
33948 The other kind of &"virtual"& domain can also be handled in a straightforward
33949 way. One approach is to create a file for each domain containing a list of
33950 valid local parts, and use it in a router like this:
33951 .code
33952 my_domains:
33953   driver = accept
33954   domains = dsearch;/etc/mail/domains
33955   local_parts = lsearch;/etc/mail/domains/$domain
33956   transport = my_mailboxes
33957 .endd
33958 The address is accepted if there is a file for the domain, and the local part
33959 can be found in the file. The &%domains%& option is used to check for the
33960 file's existence because &%domains%& is tested before the &%local_parts%&
33961 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33962 because that option is tested after &%local_parts%&. The transport is as
33963 follows:
33964 .code
33965 my_mailboxes:
33966   driver = appendfile
33967   file = /var/mail/$domain/$local_part
33968   user = mail
33969 .endd
33970 This uses a directory of mailboxes for each domain. The &%user%& setting is
33971 required, to specify which uid is to be used for writing to the mailboxes.
33972
33973 The configuration shown here is just one example of how you might support this
33974 requirement. There are many other ways this kind of configuration can be set
33975 up, for example, by using a database instead of separate files to hold all the
33976 information about the domains.
33977
33978
33979
33980 .section "Multiple user mailboxes" "SECTmulbox"
33981 .cindex "multiple mailboxes"
33982 .cindex "mailbox" "multiple"
33983 .cindex "local part" "prefix"
33984 .cindex "local part" "suffix"
33985 Heavy email users often want to operate with multiple mailboxes, into which
33986 incoming mail is automatically sorted. A popular way of handling this is to
33987 allow users to use multiple sender addresses, so that replies can easily be
33988 identified. Users are permitted to add prefixes or suffixes to their local
33989 parts for this purpose. The wildcard facility of the generic router options
33990 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33991 example, consider this router:
33992 .code
33993 userforward:
33994   driver = redirect
33995   check_local_user
33996   file = $home/.forward
33997   local_part_suffix = -*
33998   local_part_suffix_optional
33999   allow_filter
34000 .endd
34001 .vindex "&$local_part_suffix$&"
34002 It runs a user's &_.forward_& file for all local parts of the form
34003 &'username-*'&. Within the filter file the user can distinguish different
34004 cases by testing the variable &$local_part_suffix$&. For example:
34005 .code
34006 if $local_part_suffix contains -special then
34007 save /home/$local_part/Mail/special
34008 endif
34009 .endd
34010 If the filter file does not exist, or does not deal with such addresses, they
34011 fall through to subsequent routers, and, assuming no subsequent use of the
34012 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34013 control over which suffixes are valid.
34014
34015 Alternatively, a suffix can be used to trigger the use of a different
34016 &_.forward_& file &-- which is the way a similar facility is implemented in
34017 another MTA:
34018 .code
34019 userforward:
34020   driver = redirect
34021   check_local_user
34022   file = $home/.forward$local_part_suffix
34023   local_part_suffix = -*
34024   local_part_suffix_optional
34025   allow_filter
34026 .endd
34027 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34028 example, &_.forward-special_& is used. Once again, if the appropriate file
34029 does not exist, or does not deal with the address, it is passed on to
34030 subsequent routers, which could, if required, look for an unqualified
34031 &_.forward_& file to use as a default.
34032
34033
34034
34035 .section "Simplified vacation processing" "SECID244"
34036 .cindex "vacation processing"
34037 The traditional way of running the &'vacation'& program is for a user to set up
34038 a pipe command in a &_.forward_& file
34039 (see section &<<SECTspecitredli>>& for syntax details).
34040 This is prone to error by inexperienced users. There are two features of Exim
34041 that can be used to make this process simpler for users:
34042
34043 .ilist
34044 A local part prefix such as &"vacation-"& can be specified on a router which
34045 can cause the message to be delivered directly to the &'vacation'& program, or
34046 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34047 &_.forward_& file are then much simpler. For example:
34048 .code
34049 spqr, vacation-spqr
34050 .endd
34051 .next
34052 The &%require_files%& generic router option can be used to trigger a
34053 vacation delivery by checking for the existence of a certain file in the
34054 user's home directory. The &%unseen%& generic option should also be used, to
34055 ensure that the original delivery also proceeds. In this case, all the user has
34056 to do is to create a file called, say, &_.vacation_&, containing a vacation
34057 message.
34058 .endlist
34059
34060 Another advantage of both these methods is that they both work even when the
34061 use of arbitrary pipes by users is locked out.
34062
34063
34064
34065 .section "Taking copies of mail" "SECID245"
34066 .cindex "message" "copying every"
34067 Some installations have policies that require archive copies of all messages to
34068 be made. A single copy of each message can easily be taken by an appropriate
34069 command in a system filter, which could, for example, use a different file for
34070 each day's messages.
34071
34072 There is also a shadow transport mechanism that can be used to take copies of
34073 messages that are successfully delivered by local transports, one copy per
34074 delivery. This could be used, &'inter alia'&, to implement automatic
34075 notification of delivery by sites that insist on doing such things.
34076
34077
34078
34079 .section "Intermittently connected hosts" "SECID246"
34080 .cindex "intermittently connected hosts"
34081 It has become quite common (because it is cheaper) for hosts to connect to the
34082 Internet periodically rather than remain connected all the time. The normal
34083 arrangement is that mail for such hosts accumulates on a system that is
34084 permanently connected.
34085
34086 Exim was designed for use on permanently connected hosts, and so it is not
34087 particularly well-suited to use in an intermittently connected environment.
34088 Nevertheless there are some features that can be used.
34089
34090
34091 .section "Exim on the upstream server host" "SECID247"
34092 It is tempting to arrange for incoming mail for the intermittently connected
34093 host to remain on Exim's queue until the client connects. However, this
34094 approach does not scale very well. Two different kinds of waiting message are
34095 being mixed up in the same queue &-- those that cannot be delivered because of
34096 some temporary problem, and those that are waiting for their destination host
34097 to connect. This makes it hard to manage the queue, as well as wasting
34098 resources, because each queue runner scans the entire queue.
34099
34100 A better approach is to separate off those messages that are waiting for an
34101 intermittently connected host. This can be done by delivering these messages
34102 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34103 format, from where they are transmitted by other software when their
34104 destination connects. This makes it easy to collect all the mail for one host
34105 in a single directory, and to apply local timeout rules on a per-message basis
34106 if required.
34107
34108 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34109 you are doing this, you should configure Exim with a long retry period for the
34110 intermittent host. For example:
34111 .code
34112 cheshire.wonderland.fict.example    *   F,5d,24h
34113 .endd
34114 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34115 which messages it has queued up for that host. Once the intermittent host comes
34116 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34117 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34118 causes all the queued up messages to be delivered, often down a single SMTP
34119 connection. While the host remains connected, any new messages get delivered
34120 immediately.
34121
34122 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34123 issued with a different IP address each time it connects, Exim's retry
34124 mechanisms on the holding host get confused, because the IP address is normally
34125 used as part of the key string for holding retry information. This can be
34126 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34127 Since this has disadvantages for permanently connected hosts, it is best to
34128 arrange a separate transport for the intermittently connected ones.
34129
34130
34131
34132 .section "Exim on the intermittently connected client host" "SECID248"
34133 The value of &%smtp_accept_queue_per_connection%& should probably be
34134 increased, or even set to zero (that is, disabled) on the intermittently
34135 connected host, so that all incoming messages down a single connection get
34136 delivered immediately.
34137
34138 .cindex "SMTP" "passed connection"
34139 .cindex "SMTP" "multiple deliveries"
34140 .cindex "multiple SMTP deliveries"
34141 Mail waiting to be sent from an intermittently connected host will probably
34142 not have been routed, because without a connection DNS lookups are not
34143 possible. This means that if a normal queue run is done at connection time,
34144 each message is likely to be sent in a separate SMTP session. This can be
34145 avoided by starting the queue run with a command line option beginning with
34146 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34147 first pass, routing is done but no deliveries take place. The second pass is a
34148 normal queue run; since all the messages have been previously routed, those
34149 destined for the same host are likely to get sent as multiple deliveries in a
34150 single SMTP connection.
34151
34152
34153
34154 . ////////////////////////////////////////////////////////////////////////////
34155 . ////////////////////////////////////////////////////////////////////////////
34156
34157 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34158          "Exim as a non-queueing client"
34159 .cindex "client, non-queueing"
34160 .cindex "smart host" "suppressing queueing"
34161 On a personal computer, it is a common requirement for all
34162 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34163 configured to operate that way, for all the popular operating systems.
34164 However, there are some MUAs for Unix-like systems that cannot be so
34165 configured: they submit messages using the command line interface of
34166 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34167 messages this way.
34168
34169 If the personal computer runs continuously, there is no problem, because it can
34170 run a conventional MTA that handles delivery to the smart host, and deal with
34171 any delays via its queueing mechanism. However, if the computer does not run
34172 continuously or runs different operating systems at different times, queueing
34173 email is not desirable.
34174
34175 There is therefore a requirement for something that can provide the
34176 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34177 any queueing or retrying facilities. Furthermore, the delivery to the smart
34178 host should be synchronous, so that if it fails, the sending MUA is immediately
34179 informed. In other words, we want something that extends an MUA that submits
34180 to a local MTA via the command line so that it behaves like one that submits
34181 to a remote smart host using TCP/SMTP.
34182
34183 There are a number of applications (for example, there is one called &'ssmtp'&)
34184 that do this job. However, people have found them to be lacking in various
34185 ways. For instance, you might want to allow aliasing and forwarding to be done
34186 before sending a message to the smart host.
34187
34188 Exim already had the necessary infrastructure for doing this job. Just a few
34189 tweaks were needed to make it behave as required, though it is somewhat of an
34190 overkill to use a fully-featured MTA for this purpose.
34191
34192 .oindex "&%mua_wrapper%&"
34193 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34194 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34195 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34196 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34197 compatible router and transport configuration. Typically there will be just one
34198 router and one transport, sending everything to a smart host.
34199
34200 When run in MUA wrapping mode, the behaviour of Exim changes in the
34201 following ways:
34202
34203 .ilist
34204 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34205 In other words, the only way to submit messages is via the command line.
34206 .next
34207 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34208 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34209 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34210 does not finish until the delivery attempt is complete. If the delivery is
34211 successful, a zero return code is given.
34212 .next
34213 Address redirection is permitted, but the final routing for all addresses must
34214 be to the same remote transport, and to the same list of hosts. Furthermore,
34215 the return address (envelope sender) must be the same for all recipients, as
34216 must any added or deleted header lines. In other words, it must be possible to
34217 deliver the message in a single SMTP transaction, however many recipients there
34218 are.
34219 .next
34220 If these conditions are not met, or if routing any address results in a
34221 failure or defer status, or if Exim is unable to deliver all the recipients
34222 successfully to one of the smart hosts, delivery of the entire message fails.
34223 .next
34224 Because no queueing is allowed, all failures are treated as permanent; there
34225 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34226 smart host. Furthermore, because only a single yes/no response can be given to
34227 the caller, it is not possible to deliver to some recipients and not others. If
34228 there is an error (temporary or permanent) for any recipient, all are failed.
34229 .next
34230 If more than one smart host is listed, Exim will try another host after a
34231 connection failure or a timeout, in the normal way. However, if this kind of
34232 failure happens for all the hosts, the delivery fails.
34233 .next
34234 When delivery fails, an error message is written to the standard error stream
34235 (as well as to Exim's log), and Exim exits to the caller with a return code
34236 value 1. The message is expunged from Exim's spool files. No bounce messages
34237 are ever generated.
34238 .next
34239 No retry data is maintained, and any retry rules are ignored.
34240 .next
34241 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34242 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34243 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34244 .endlist
34245
34246 The overall effect is that Exim makes a single synchronous attempt to deliver
34247 the message, failing if there is any kind of problem. Because no local
34248 deliveries are done and no daemon can be run, Exim does not need root
34249 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34250 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34251 the advantages and disadvantages of running without root privilege.
34252
34253
34254
34255
34256 . ////////////////////////////////////////////////////////////////////////////
34257 . ////////////////////////////////////////////////////////////////////////////
34258
34259 .chapter "Log files" "CHAPlog"
34260 .scindex IIDloggen "log" "general description"
34261 .cindex "log" "types of"
34262 Exim writes three different logs, referred to as the main log, the reject log,
34263 and the panic log:
34264
34265 .ilist
34266 .cindex "main log"
34267 The main log records the arrival of each message and each delivery in a single
34268 line in each case. The format is as compact as possible, in an attempt to keep
34269 down the size of log files. Two-character flag sequences make it easy to pick
34270 out these lines. A number of other events are recorded in the main log. Some of
34271 them are optional, in which case the &%log_selector%& option controls whether
34272 they are included or not. A Perl script called &'eximstats'&, which does simple
34273 analysis of main log files, is provided in the Exim distribution (see section
34274 &<<SECTmailstat>>&).
34275 .next
34276 .cindex "reject log"
34277 The reject log records information from messages that are rejected as a result
34278 of a configuration option (that is, for policy reasons).
34279 The first line of each rejection is a copy of the line that is also written to
34280 the main log. Then, if the message's header has been read at the time the log
34281 is written, its contents are written to this log. Only the original header
34282 lines are available; header lines added by ACLs are not logged. You can use the
34283 reject log to check that your policy controls are working correctly; on a busy
34284 host this may be easier than scanning the main log for rejection messages. You
34285 can suppress the writing of the reject log by setting &%write_rejectlog%&
34286 false.
34287 .next
34288 .cindex "panic log"
34289 .cindex "system log"
34290 When certain serious errors occur, Exim writes entries to its panic log. If the
34291 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34292 are usually written to the main log as well, but can get lost amid the mass of
34293 other entries. The panic log should be empty under normal circumstances. It is
34294 therefore a good idea to check it (or to have a &'cron'& script check it)
34295 regularly, in order to become aware of any problems. When Exim cannot open its
34296 panic log, it tries as a last resort to write to the system log (syslog). This
34297 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34298 message itself is written at priority LOG_CRIT.
34299 .endlist
34300
34301 Every log line starts with a timestamp, in the format shown in the following
34302 example. Note that many of the examples shown in this chapter are line-wrapped.
34303 In the log file, this would be all on one line:
34304 .code
34305 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34306   by QUIT
34307 .endd
34308 By default, the timestamps are in the local timezone. There are two
34309 ways of changing this:
34310
34311 .ilist
34312 You can set the &%timezone%& option to a different time zone; in particular, if
34313 you set
34314 .code
34315 timezone = UTC
34316 .endd
34317 the timestamps will be in UTC (aka GMT).
34318 .next
34319 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34320 example:
34321 .code
34322 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34323 .endd
34324 .endlist
34325
34326 .cindex "log" "process ids in"
34327 .cindex "pid (process id)" "in log lines"
34328 Exim does not include its process id in log lines by default, but you can
34329 request that it does so by specifying the &`pid`& log selector (see section
34330 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34331 brackets, immediately after the time and date.
34332
34333
34334
34335
34336 .section "Where the logs are written" "SECTwhelogwri"
34337 .cindex "log" "destination"
34338 .cindex "log" "to file"
34339 .cindex "log" "to syslog"
34340 .cindex "syslog"
34341 The logs may be written to local files, or to syslog, or both. However, it
34342 should be noted that many syslog implementations use UDP as a transport, and
34343 are therefore unreliable in the sense that messages are not guaranteed to
34344 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34345 It has also been reported that on large log files (tens of megabytes) you may
34346 need to tweak syslog to prevent it syncing the file with each write &-- on
34347 Linux this has been seen to make syslog take 90% plus of CPU time.
34348
34349 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34350 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34351 configuration. This latter string is expanded, so it can contain, for example,
34352 references to the host name:
34353 .code
34354 log_file_path = /var/log/$primary_hostname/exim_%slog
34355 .endd
34356 It is generally advisable, however, to set the string in &_Local/Makefile_&
34357 rather than at run time, because then the setting is available right from the
34358 start of Exim's execution. Otherwise, if there's something it wants to log
34359 before it has read the configuration file (for example, an error in the
34360 configuration file) it will not use the path you want, and may not be able to
34361 log at all.
34362
34363 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34364 list, currently limited to at most two items. This is one option where the
34365 facility for changing a list separator may not be used. The list must always be
34366 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34367 otherwise the item must either be an absolute path, containing &`%s`& at the
34368 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34369 implying the use of a default path.
34370
34371 When Exim encounters an empty item in the list, it searches the list defined by
34372 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34373 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34374 mean &"use the path specified at build time"&. It no such item exists, log
34375 files are written in the &_log_& subdirectory of the spool directory. This is
34376 equivalent to the setting:
34377 .code
34378 log_file_path = $spool_directory/log/%slog
34379 .endd
34380 If you do not specify anything at build time or run time, that is where the
34381 logs are written.
34382
34383 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34384 are in use &-- see section &<<SECTdatlogfil>>& below.
34385
34386 Here are some examples of possible settings:
34387 .display
34388 &`LOG_FILE_PATH=syslog                    `& syslog only
34389 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34390 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34391 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34392 .endd
34393 If there are more than two paths in the list, the first is used and a panic
34394 error is logged.
34395
34396
34397
34398 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34399 .cindex "log" "cycling local files"
34400 .cindex "cycling logs"
34401 .cindex "&'exicyclog'&"
34402 .cindex "log" "local files; writing to"
34403 Some operating systems provide centralized and standardized methods for cycling
34404 log files. For those that do not, a utility script called &'exicyclog'& is
34405 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34406 main and reject logs each time it is called. The maximum number of old logs to
34407 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34408
34409 An Exim delivery process opens the main log when it first needs to write to it,
34410 and it keeps the file open in case subsequent entries are required &-- for
34411 example, if a number of different deliveries are being done for the same
34412 message. However, remote SMTP deliveries can take a long time, and this means
34413 that the file may be kept open long after it is renamed if &'exicyclog'& or
34414 something similar is being used to rename log files on a regular basis. To
34415 ensure that a switch of log files is noticed as soon as possible, Exim calls
34416 &[stat()]& on the main log's name before reusing an open file, and if the file
34417 does not exist, or its inode has changed, the old file is closed and Exim
34418 tries to open the main log from scratch. Thus, an old log file may remain open
34419 for quite some time, but no Exim processes should write to it once it has been
34420 renamed.
34421
34422
34423
34424 .section "Datestamped log files" "SECTdatlogfil"
34425 .cindex "log" "datestamped files"
34426 Instead of cycling the main and reject log files by renaming them
34427 periodically, some sites like to use files whose names contain a datestamp,
34428 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34429 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34430 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34431 point where the datestamp is required. For example:
34432 .code
34433 log_file_path = /var/spool/exim/log/%slog-%D
34434 log_file_path = /var/log/exim-%s-%D.log
34435 log_file_path = /var/spool/exim/log/%D-%slog
34436 log_file_path = /var/log/exim/%s.%M
34437 .endd
34438 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34439 examples of names generated by the above examples:
34440 .code
34441 /var/spool/exim/log/mainlog-20021225
34442 /var/log/exim-reject-20021225.log
34443 /var/spool/exim/log/20021225-mainlog
34444 /var/log/exim/main.200212
34445 .endd
34446 When this form of log file is specified, Exim automatically switches to new
34447 files at midnight. It does not make any attempt to compress old logs; you
34448 will need to write your own script if you require this. You should not
34449 run &'exicyclog'& with this form of logging.
34450
34451 The location of the panic log is also determined by &%log_file_path%&, but it
34452 is not datestamped, because rotation of the panic log does not make sense.
34453 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34454 the string. In addition, if it immediately follows a slash, a following
34455 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34456 character is removed. Thus, the four examples above would give these panic
34457 log names:
34458 .code
34459 /var/spool/exim/log/paniclog
34460 /var/log/exim-panic.log
34461 /var/spool/exim/log/paniclog
34462 /var/log/exim/panic
34463 .endd
34464
34465
34466 .section "Logging to syslog" "SECID249"
34467 .cindex "log" "syslog; writing to"
34468 The use of syslog does not change what Exim logs or the format of its messages,
34469 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34470 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34471 that, the same strings are written to syslog as to log files. The syslog
34472 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34473 by default, but you can change these by setting the &%syslog_facility%& and
34474 &%syslog_processname%& options, respectively. If Exim was compiled with
34475 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34476 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34477 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34478 the time and host name to each line.
34479 The three log streams are mapped onto syslog priorities as follows:
34480
34481 .ilist
34482 &'mainlog'& is mapped to LOG_INFO
34483 .next
34484 &'rejectlog'& is mapped to LOG_NOTICE
34485 .next
34486 &'paniclog'& is mapped to LOG_ALERT
34487 .endlist
34488
34489 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34490 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34491 these are routed by syslog to the same place. You can suppress this duplication
34492 by setting &%syslog_duplication%& false.
34493
34494 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34495 entries contain multiple lines when headers are included. To cope with both
34496 these cases, entries written to syslog are split into separate &[syslog()]&
34497 calls at each internal newline, and also after a maximum of
34498 870 data characters. (This allows for a total syslog line length of 1024, when
34499 additions such as timestamps are added.) If you are running a syslog
34500 replacement that can handle lines longer than the 1024 characters allowed by
34501 RFC 3164, you should set
34502 .code
34503 SYSLOG_LONG_LINES=yes
34504 .endd
34505 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34506 lines, but it still splits at internal newlines in &'reject'& log entries.
34507
34508 To make it easy to re-assemble split lines later, each component of a split
34509 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34510 where <&'n'&> is the component number and <&'m'&> is the total number of
34511 components in the entry. The / delimiter is used when the line was split
34512 because it was too long; if it was split because of an internal newline, the \
34513 delimiter is used. For example, supposing the length limit to be 50 instead of
34514 870, the following would be the result of a typical rejection message to
34515 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34516 name, and pid as added by syslog:
34517 .code
34518 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34519 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34520 [3/5]  when scanning for sender: missing or malformed lo
34521 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34522 [5/5] mple>)
34523 .endd
34524 The same error might cause the following lines to be written to &"rejectlog"&
34525 (LOG_NOTICE):
34526 .code
34527 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34528 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34529 [3/18] er when scanning for sender: missing or malformed
34530 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34531 [5\18] .example>)
34532 [6\18] Recipients: ph10@some.domain.cam.example
34533 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34534 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34535 [9\18]        id 16RdAL-0006pc-00
34536 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34537 [11\18] 09:43 +0100
34538 [12\18] F From: <>
34539 [13\18]   Subject: this is a test header
34540 [18\18]   X-something: this is another header
34541 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34542 [16\18] le>
34543 [17\18] B Bcc:
34544 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34545 .endd
34546 Log lines that are neither too long nor contain newlines are written to syslog
34547 without modification.
34548
34549 If only syslog is being used, the Exim monitor is unable to provide a log tail
34550 display, unless syslog is routing &'mainlog'& to a file on the local host and
34551 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34552 where it is.
34553
34554
34555
34556 .section "Log line flags" "SECID250"
34557 One line is written to the main log for each message received, and for each
34558 successful, unsuccessful, and delayed delivery. These lines can readily be
34559 picked out by the distinctive two-character flags that immediately follow the
34560 timestamp. The flags are:
34561 .display
34562 &`<=`&     message arrival
34563 &`=>`&     normal message delivery
34564 &`->`&     additional address in same delivery
34565 &`>>`&     cutthrough message delivery
34566 &`*>`&     delivery suppressed by &%-N%&
34567 &`**`&     delivery failed; address bounced
34568 &`==`&     delivery deferred; temporary problem
34569 .endd
34570
34571
34572 .section "Logging message reception" "SECID251"
34573 .cindex "log" "reception line"
34574 The format of the single-line entry in the main log that is written for every
34575 message received is shown in the basic example below, which is split over
34576 several lines in order to fit it on the page:
34577 .code
34578 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34579   H=mailer.fict.example [192.168.123.123] U=exim
34580   P=smtp S=5678 id=<incoming message id>
34581 .endd
34582 The address immediately following &"<="& is the envelope sender address. A
34583 bounce message is shown with the sender address &"<>"&, and if it is locally
34584 generated, this is followed by an item of the form
34585 .code
34586 R=<message id>
34587 .endd
34588 which is a reference to the message that caused the bounce to be sent.
34589
34590 .cindex "HELO"
34591 .cindex "EHLO"
34592 For messages from other hosts, the H and U fields identify the remote host and
34593 record the RFC 1413 identity of the user that sent the message, if one was
34594 received. The number given in square brackets is the IP address of the sending
34595 host. If there is a single, unparenthesized  host name in the H field, as
34596 above, it has been verified to correspond to the IP address (see the
34597 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34598 by the remote host in the SMTP HELO or EHLO command, and has not been
34599 verified. If verification yields a different name to that given for HELO or
34600 EHLO, the verified name appears first, followed by the HELO or EHLO
34601 name in parentheses.
34602
34603 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34604 without brackets, in the HELO or EHLO command, leading to entries in
34605 the log containing text like these examples:
34606 .code
34607 H=(10.21.32.43) [192.168.8.34]
34608 H=([10.21.32.43]) [192.168.8.34]
34609 .endd
34610 This can be confusing. Only the final address in square brackets can be relied
34611 on.
34612
34613 For locally generated messages (that is, messages not received over TCP/IP),
34614 the H field is omitted, and the U field contains the login name of the caller
34615 of Exim.
34616
34617 .cindex "authentication" "logging"
34618 .cindex "AUTH" "logging"
34619 For all messages, the P field specifies the protocol used to receive the
34620 message. This is the value that is stored in &$received_protocol$&. In the case
34621 of incoming SMTP messages, the value indicates whether or not any SMTP
34622 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34623 session was encrypted, there is an additional X field that records the cipher
34624 suite that was used.
34625
34626 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34627 hosts that have authenticated themselves using the SMTP AUTH command. The first
34628 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34629 there is an additional item A= followed by the name of the authenticator that
34630 was used. If an authenticated identification was set up by the authenticator's
34631 &%server_set_id%& option, this is logged too, separated by a colon from the
34632 authenticator name.
34633
34634 .cindex "size" "of message"
34635 The id field records the existing message id, if present. The size of the
34636 received message is given by the S field. When the message is delivered,
34637 headers may be removed or added, so that the size of delivered copies of the
34638 message may not correspond with this value (and indeed may be different to each
34639 other).
34640
34641 The &%log_selector%& option can be used to request the logging of additional
34642 data when a message is received. See section &<<SECTlogselector>>& below.
34643
34644
34645
34646 .section "Logging deliveries" "SECID252"
34647 .cindex "log" "delivery line"
34648 The format of the single-line entry in the main log that is written for every
34649 delivery is shown in one of the examples below, for local and remote
34650 deliveries, respectively. Each example has been split into two lines in order
34651 to fit it on the page:
34652 .code
34653 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34654   <marv@hitch.fict.example> R=localuser T=local_delivery
34655 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34656   monk@holistic.fict.example R=dnslookup T=remote_smtp
34657   H=holistic.fict.example [192.168.234.234]
34658 .endd
34659 For ordinary local deliveries, the original address is given in angle brackets
34660 after the final delivery address, which might be a pipe or a file. If
34661 intermediate address(es) exist between the original and the final address, the
34662 last of these is given in parentheses after the final address. The R and T
34663 fields record the router and transport that were used to process the address.
34664
34665 If SMTP AUTH was used for the delivery there is an additional item A=
34666 followed by the name of the authenticator that was used.
34667 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34668 option, this is logged too, separated by a colon from the authenticator name.
34669
34670 If a shadow transport was run after a successful local delivery, the log line
34671 for the successful delivery has an item added on the end, of the form
34672 .display
34673 &`ST=<`&&'shadow transport name'&&`>`&
34674 .endd
34675 If the shadow transport did not succeed, the error message is put in
34676 parentheses afterwards.
34677
34678 .cindex "asterisk" "after IP address"
34679 When more than one address is included in a single delivery (for example, two
34680 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34681 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34682 down a single SMTP connection, an asterisk follows the IP address in the log
34683 lines for the second and subsequent messages.
34684
34685 .cindex "delivery" "cutthrough; logging"
34686 .cindex "cutthrough" "logging"
34687 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34688 line precedes the reception line, since cutthrough waits for a possible
34689 rejection from the destination in case it can reject the sourced item.
34690
34691 The generation of a reply message by a filter file gets logged as a
34692 &"delivery"& to the addressee, preceded by &">"&.
34693
34694 The &%log_selector%& option can be used to request the logging of additional
34695 data when a message is delivered. See section &<<SECTlogselector>>& below.
34696
34697
34698 .section "Discarded deliveries" "SECID253"
34699 .cindex "discarded messages"
34700 .cindex "message" "discarded"
34701 .cindex "delivery" "discarded; logging"
34702 When a message is discarded as a result of the command &"seen finish"& being
34703 obeyed in a filter file which generates no deliveries, a log entry of the form
34704 .code
34705 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34706   <low.club@bridge.example> R=userforward
34707 .endd
34708 is written, to record why no deliveries are logged. When a message is discarded
34709 because it is aliased to &":blackhole:"& the log line is like this:
34710 .code
34711 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34712   <hole@nowhere.example> R=blackhole_router
34713 .endd
34714
34715
34716 .section "Deferred deliveries" "SECID254"
34717 When a delivery is deferred, a line of the following form is logged:
34718 .code
34719 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34720   R=dnslookup T=smtp defer (146): Connection refused
34721 .endd
34722 In the case of remote deliveries, the error is the one that was given for the
34723 last IP address that was tried. Details of individual SMTP failures are also
34724 written to the log, so the above line would be preceded by something like
34725 .code
34726 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34727   mail1.endrest.example [192.168.239.239]: Connection refused
34728 .endd
34729 When a deferred address is skipped because its retry time has not been reached,
34730 a message is written to the log, but this can be suppressed by setting an
34731 appropriate value in &%log_selector%&.
34732
34733
34734
34735 .section "Delivery failures" "SECID255"
34736 .cindex "delivery" "failure; logging"
34737 If a delivery fails because an address cannot be routed, a line of the
34738 following form is logged:
34739 .code
34740 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34741   <jim@trek99.example>: unknown mail domain
34742 .endd
34743 If a delivery fails at transport time, the router and transport are shown, and
34744 the response from the remote host is included, as in this example:
34745 .code
34746 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34747   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34748   after pipelined RCPT TO:<ace400@pb.example>: host
34749   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34750   <ace400@pb.example>...Addressee unknown
34751 .endd
34752 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34753 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34754 disabling PIPELINING. The log lines for all forms of delivery failure are
34755 flagged with &`**`&.
34756
34757
34758
34759 .section "Fake deliveries" "SECID256"
34760 .cindex "delivery" "fake; logging"
34761 If a delivery does not actually take place because the &%-N%& option has been
34762 used to suppress it, a normal delivery line is written to the log, except that
34763 &"=>"& is replaced by &"*>"&.
34764
34765
34766
34767 .section "Completion" "SECID257"
34768 A line of the form
34769 .code
34770 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34771 .endd
34772 is written to the main log when a message is about to be removed from the spool
34773 at the end of its processing.
34774
34775
34776
34777
34778 .section "Summary of Fields in Log Lines" "SECID258"
34779 .cindex "log" "summary of fields"
34780 A summary of the field identifiers that are used in log lines is shown in
34781 the following table:
34782 .display
34783 &`A   `&        authenticator name (and optional id and sender)
34784 &`C   `&        SMTP confirmation on delivery
34785 &`    `&        command list for &"no mail in SMTP session"&
34786 &`CV  `&        certificate verification status
34787 &`D   `&        duration of &"no mail in SMTP session"&
34788 &`DN  `&        distinguished name from peer certificate
34789 &`DT  `&        on &`=>`& lines: time taken for a delivery
34790 &`F   `&        sender address (on delivery lines)
34791 &`H   `&        host name and IP address
34792 &`I   `&        local interface used
34793 &`id  `&        message id for incoming message
34794 &`P   `&        on &`<=`& lines: protocol used
34795 &`    `&        on &`=>`& and &`**`& lines: return path
34796 &`QT  `&        on &`=>`& lines: time spent on queue so far
34797 &`    `&        on &"Completed"& lines: time spent on queue
34798 &`R   `&        on &`<=`& lines: reference for local bounce
34799 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34800 &`S   `&        size of message
34801 &`SNI `&        server name indication from TLS client hello
34802 &`ST  `&        shadow transport name
34803 &`T   `&        on &`<=`& lines: message subject (topic)
34804 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34805 &`U   `&        local user or RFC 1413 identity
34806 &`X   `&        TLS cipher suite
34807 .endd
34808
34809
34810 .section "Other log entries" "SECID259"
34811 Various other types of log entry are written from time to time. Most should be
34812 self-explanatory. Among the more common are:
34813
34814 .ilist
34815 .cindex "retry" "time not reached"
34816 &'retry time not reached'&&~&~An address previously suffered a temporary error
34817 during routing or local delivery, and the time to retry has not yet arrived.
34818 This message is not written to an individual message log file unless it happens
34819 during the first delivery attempt.
34820 .next
34821 &'retry time not reached for any host'&&~&~An address previously suffered
34822 temporary errors during remote delivery, and the retry time has not yet arrived
34823 for any of the hosts to which it is routed.
34824 .next
34825 .cindex "spool directory" "file locked"
34826 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34827 some other Exim process is already working on the message. This can be quite
34828 common if queue running processes are started at frequent intervals. The
34829 &'exiwhat'& utility script can be used to find out what Exim processes are
34830 doing.
34831 .next
34832 .cindex "error" "ignored"
34833 &'error ignored'&&~&~There are several circumstances that give rise to this
34834 message:
34835 .olist
34836 Exim failed to deliver a bounce message whose age was greater than
34837 &%ignore_bounce_errors_after%&. The bounce was discarded.
34838 .next
34839 A filter file set up a delivery using the &"noerror"& option, and the delivery
34840 failed. The delivery was discarded.
34841 .next
34842 A delivery set up by a router configured with
34843 . ==== As this is a nested list, any displays it contains must be indented
34844 . ==== as otherwise they are too far to the left.
34845 .code
34846     errors_to = <>
34847 .endd
34848 failed. The delivery was discarded.
34849 .endlist olist
34850 .endlist ilist
34851
34852
34853
34854
34855
34856 .section "Reducing or increasing what is logged" "SECTlogselector"
34857 .cindex "log" "selectors"
34858 By setting the &%log_selector%& global option, you can disable some of Exim's
34859 default logging, or you can request additional logging. The value of
34860 &%log_selector%& is made up of names preceded by plus or minus characters. For
34861 example:
34862 .code
34863 log_selector = +arguments -retry_defer
34864 .endd
34865 The list of optional log items is in the following table, with the default
34866 selection marked by asterisks:
34867 .display
34868 &` 8bitmime                   `&  received 8BITMIME status
34869 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34870 &` address_rewrite            `&  address rewriting
34871 &` all_parents                `&  all parents in => lines
34872 &` arguments                  `&  command line arguments
34873 &`*connection_reject          `&  connection rejections
34874 &`*delay_delivery             `&  immediate delivery delayed
34875 &` deliver_time               `&  time taken to perform delivery
34876 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34877 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34878 &`*etrn                       `&  ETRN commands
34879 &`*host_lookup_failed         `&  as it says
34880 &` ident_timeout              `&  timeout for ident connection
34881 &` incoming_interface         `&  incoming interface on <= lines
34882 &` incoming_port              `&  incoming port on <= lines
34883 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34884 &` outgoing_port              `&  add remote port to => lines
34885 &`*queue_run                  `&  start and end queue runs
34886 &` queue_time                 `&  time on queue for one recipient
34887 &` queue_time_overall         `&  time on queue for whole message
34888 &` pid                        `&  Exim process id
34889 &` received_recipients        `&  recipients on <= lines
34890 &` received_sender            `&  sender on <= lines
34891 &`*rejected_header            `&  header contents on reject log
34892 &`*retry_defer                `&  &"retry time not reached"&
34893 &` return_path_on_delivery    `&  put return path on => and ** lines
34894 &` sender_on_delivery         `&  add sender to => lines
34895 &`*sender_verify_fail         `&  sender verification failures
34896 &`*size_reject                `&  rejection because too big
34897 &`*skip_delivery              `&  delivery skipped in a queue run
34898 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34899 &` smtp_connection            `&  SMTP connections
34900 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34901 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34902 &` smtp_no_mail               `&  session with no MAIL commands
34903 &` smtp_protocol_error        `&  SMTP protocol errors
34904 &` smtp_syntax_error          `&  SMTP syntax errors
34905 &` subject                    `&  contents of &'Subject:'& on <= lines
34906 &`*tls_certificate_verified   `&  certificate verification status
34907 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34908 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34909 &` tls_sni                    `&  TLS SNI on <= lines
34910 &` unknown_in_list            `&  DNS lookup failed in list match
34911
34912 &` all                        `&  all of the above
34913 .endd
34914 More details on each of these items follows:
34915
34916 .ilist
34917 .cindex "8BITMIME"
34918 .cindex "log" "8BITMIME"
34919 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34920 which may help in tracking down interoperability issues with ancient MTAs
34921 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34922 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34923 &`7BIT`& and &`8BITMIME`& respectively.
34924 .next
34925 .cindex "&%warn%& ACL verb" "log when skipping"
34926 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34927 its conditions cannot be evaluated, a log line to this effect is written if
34928 this log selector is set.
34929 .next
34930 .cindex "log" "rewriting"
34931 .cindex "rewriting" "logging"
34932 &%address_rewrite%&: This applies both to global rewrites and per-transport
34933 rewrites, but not to rewrites in filters run as an unprivileged user (because
34934 such users cannot access the log).
34935 .next
34936 .cindex "log" "full parentage"
34937 &%all_parents%&: Normally only the original and final addresses are logged on
34938 delivery lines; with this selector, intermediate parents are given in
34939 parentheses between them.
34940 .next
34941 .cindex "log" "Exim arguments"
34942 .cindex "Exim arguments, logging"
34943 &%arguments%&: This causes Exim to write the arguments with which it was called
34944 to the main log, preceded by the current working directory. This is a debugging
34945 feature, added to make it easier to find out how certain MUAs call
34946 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34947 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34948 that are empty or that contain white space are quoted. Non-printing characters
34949 are shown as escape sequences. This facility cannot log unrecognized arguments,
34950 because the arguments are checked before the configuration file is read. The
34951 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34952 between the caller and Exim.
34953 .next
34954 .cindex "log" "connection rejections"
34955 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34956 connection is rejected, for whatever reason.
34957 .next
34958 .cindex "log" "delayed delivery"
34959 .cindex "delayed delivery, logging"
34960 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34961 started for an incoming message because the load is too high or too many
34962 messages were received on one connection. Logging does not occur if no delivery
34963 process is started because &%queue_only%& is set or &%-odq%& was used.
34964 .next
34965 .cindex "log" "delivery duration"
34966 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34967 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34968 .next
34969 .cindex "log" "message size on delivery"
34970 .cindex "size" "of message"
34971 &%delivery_size%&: For each delivery, the size of message delivered is added to
34972 the &"=>"& line, tagged with S=.
34973 .next
34974 .cindex "log" "dnslist defer"
34975 .cindex "DNS list" "logging defer"
34976 .cindex "black list (DNS)"
34977 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34978 DNS black list suffers a temporary error.
34979 .next
34980 .cindex "log" "ETRN commands"
34981 .cindex "ETRN" "logging"
34982 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34983 is run to determine whether or not it is actually accepted. An invalid ETRN
34984 command, or one received within a message transaction is not logged by this
34985 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34986 .next
34987 .cindex "log" "host lookup failure"
34988 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34989 any addresses, or when a lookup of an IP address fails to find a host name, a
34990 log line is written. This logging does not apply to direct DNS lookups when
34991 routing email addresses, but it does apply to &"byname"& lookups.
34992 .next
34993 .cindex "log" "ident timeout"
34994 .cindex "RFC 1413" "logging timeout"
34995 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34996 client's ident port times out.
34997 .next
34998 .cindex "log" "incoming interface"
34999 .cindex "interface" "logging"
35000 &%incoming_interface%&: The interface on which a message was received is added
35001 to the &"<="& line as an IP address in square brackets, tagged by I= and
35002 followed by a colon and the port number. The local interface and port are also
35003 added to other SMTP log lines, for example &"SMTP connection from"&, and to
35004 rejection lines.
35005 .next
35006 .cindex "log" "incoming remote port"
35007 .cindex "port" "logging remote"
35008 .cindex "TCP/IP" "logging incoming remote port"
35009 .vindex "&$sender_fullhost$&"
35010 .vindex "&$sender_rcvhost$&"
35011 &%incoming_port%&: The remote port number from which a message was received is
35012 added to log entries and &'Received:'& header lines, following the IP address
35013 in square brackets, and separated from it by a colon. This is implemented by
35014 changing the value that is put in the &$sender_fullhost$& and
35015 &$sender_rcvhost$& variables. Recording the remote port number has become more
35016 important with the widening use of NAT (see RFC 2505).
35017 .next
35018 .cindex "log" "dropped connection"
35019 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35020 connection is unexpectedly dropped.
35021 .next
35022 .cindex "log" "outgoing remote port"
35023 .cindex "port" "logging outgoint remote"
35024 .cindex "TCP/IP" "logging ougtoing remote port"
35025 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35026 containing => tags) following the IP address. This option is not included in
35027 the default setting, because for most ordinary configurations, the remote port
35028 number is always 25 (the SMTP port).
35029 .next
35030 .cindex "log" "process ids in"
35031 .cindex "pid (process id)" "in log lines"
35032 &%pid%&: The current process id is added to every log line, in square brackets,
35033 immediately after the time and date.
35034 .next
35035 .cindex "log" "queue run"
35036 .cindex "queue runner" "logging"
35037 &%queue_run%&: The start and end of every queue run are logged.
35038 .next
35039 .cindex "log" "queue time"
35040 &%queue_time%&: The amount of time the message has been in the queue on the
35041 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35042 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35043 includes reception time as well as the delivery time for the current address.
35044 This means that it may be longer than the difference between the arrival and
35045 delivery log line times, because the arrival log line is not written until the
35046 message has been successfully received.
35047 .next
35048 &%queue_time_overall%&: The amount of time the message has been in the queue on
35049 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35050 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35051 message, so it includes reception time as well as the total delivery time.
35052 .next
35053 .cindex "log" "recipients"
35054 &%received_recipients%&: The recipients of a message are listed in the main log
35055 as soon as the message is received. The list appears at the end of the log line
35056 that is written when a message is received, preceded by the word &"for"&. The
35057 addresses are listed after they have been qualified, but before any rewriting
35058 has taken place.
35059 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35060 in the list.
35061 .next
35062 .cindex "log" "sender reception"
35063 &%received_sender%&: The unrewritten original sender of a message is added to
35064 the end of the log line that records the message's arrival, after the word
35065 &"from"& (before the recipients if &%received_recipients%& is also set).
35066 .next
35067 .cindex "log" "header lines for rejection"
35068 &%rejected_header%&: If a message's header has been received at the time a
35069 rejection is written to the reject log, the complete header is added to the
35070 log. Header logging can be turned off individually for messages that are
35071 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35072 .next
35073 .cindex "log" "retry defer"
35074 &%retry_defer%&: A log line is written if a delivery is deferred because a
35075 retry time has not yet been reached. However, this &"retry time not reached"&
35076 message is always omitted from individual message logs after the first delivery
35077 attempt.
35078 .next
35079 .cindex "log" "return path"
35080 &%return_path_on_delivery%&: The return path that is being transmitted with
35081 the message is included in delivery and bounce lines, using the tag P=.
35082 This is omitted if no delivery actually happens, for example, if routing fails,
35083 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35084 .next
35085 .cindex "log" "sender on delivery"
35086 &%sender_on_delivery%&: The message's sender address is added to every delivery
35087 and bounce line, tagged by F= (for &"from"&).
35088 This is the original sender that was received with the message; it is not
35089 necessarily the same as the outgoing return path.
35090 .next
35091 .cindex "log" "sender verify failure"
35092 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35093 gives details of a sender verification failure is not written. Log lines for
35094 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35095 detail is lost.
35096 .next
35097 .cindex "log" "size rejection"
35098 &%size_reject%&: A log line is written whenever a message is rejected because
35099 it is too big.
35100 .next
35101 .cindex "log" "frozen messages; skipped"
35102 .cindex "frozen messages" "logging skipping"
35103 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35104 queue run because it is frozen or because another process is already delivering
35105 it.
35106 .cindex "&""spool file is locked""&"
35107 The message that is written is &"spool file is locked"&.
35108 .next
35109 .cindex "log" "smtp confirmation"
35110 .cindex "SMTP" "logging confirmation"
35111 .cindex "LMTP" "logging confirmation"
35112 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35113 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35114 A number of MTAs (including Exim) return an identifying string in this
35115 response.
35116 .next
35117 .cindex "log" "SMTP connections"
35118 .cindex "SMTP" "logging connections"
35119 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35120 established or closed, unless the connection is from a host that matches
35121 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35122 only when the closure is unexpected.) This applies to connections from local
35123 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35124 dropped in the middle of a message, a log line is always written, whether or
35125 not this selector is set, but otherwise nothing is written at the start and end
35126 of connections unless this selector is enabled.
35127
35128 For TCP/IP connections to an Exim daemon, the current number of connections is
35129 included in the log message for each new connection, but note that the count is
35130 reset if the daemon is restarted.
35131 Also, because connections are closed (and the closure is logged) in
35132 subprocesses, the count may not include connections that have been closed but
35133 whose termination the daemon has not yet noticed. Thus, while it is possible to
35134 match up the opening and closing of connections in the log, the value of the
35135 logged counts may not be entirely accurate.
35136 .next
35137 .cindex "log" "SMTP transaction; incomplete"
35138 .cindex "SMTP" "logging incomplete transactions"
35139 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35140 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35141 and the message sender plus any accepted recipients are included in the log
35142 line. This can provide evidence of dictionary attacks.
35143 .next
35144 .cindex "log" "non-MAIL SMTP sessions"
35145 .cindex "MAIL" "logging session without"
35146 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35147 connection terminates without having issued a MAIL command. This includes both
35148 the case when the connection is dropped, and the case when QUIT is used. It
35149 does not include cases where the connection is rejected right at the start (by
35150 an ACL, or because there are too many connections, or whatever). These cases
35151 already have their own log lines.
35152
35153 The log line that is written contains the identity of the client in the usual
35154 way, followed by D= and a time, which records the duration of the connection.
35155 If the connection was authenticated, this fact is logged exactly as it is for
35156 an incoming message, with an A= item. If the connection was encrypted, CV=,
35157 DN=, and X= items may appear as they do for an incoming message, controlled by
35158 the same logging options.
35159
35160 Finally, if any SMTP commands were issued during the connection, a C= item
35161 is added to the line, listing the commands that were used. For example,
35162 .code
35163 C=EHLO,QUIT
35164 .endd
35165 shows that the client issued QUIT straight after EHLO. If there were fewer
35166 than 20 commands, they are all listed. If there were more than 20 commands,
35167 the last 20 are listed, preceded by &"..."&. However, with the default
35168 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35169 have been aborted before 20 non-mail commands are processed.
35170 .next
35171 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35172 colon-separated, is appended to the A= item for a message arrival or delivery
35173 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35174 was accepted or used.
35175 .next
35176 .cindex "log" "SMTP protocol error"
35177 .cindex "SMTP" "logging protocol error"
35178 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35179 encountered. Exim does not have perfect detection of all protocol errors
35180 because of transmission delays and the use of pipelining. If PIPELINING has
35181 been advertised to a client, an Exim server assumes that the client will use
35182 it, and therefore it does not count &"expected"& errors (for example, RCPT
35183 received after rejecting MAIL) as protocol errors.
35184 .next
35185 .cindex "SMTP" "logging syntax errors"
35186 .cindex "SMTP" "syntax errors; logging"
35187 .cindex "SMTP" "unknown command; logging"
35188 .cindex "log" "unknown SMTP command"
35189 .cindex "log" "SMTP syntax error"
35190 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35191 encountered. An unrecognized command is treated as a syntax error. For an
35192 external connection, the host identity is given; for an internal connection
35193 using &%-bs%& the sender identification (normally the calling user) is given.
35194 .next
35195 .cindex "log" "subject"
35196 .cindex "subject, logging"
35197 &%subject%&: The subject of the message is added to the arrival log line,
35198 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35199 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35200 specifies whether characters with values greater than 127 should be logged
35201 unchanged, or whether they should be rendered as escape sequences.
35202 .next
35203 .cindex "log" "certificate verification"
35204 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35205 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35206 verified, and &`CV=no`& if not.
35207 .next
35208 .cindex "log" "TLS cipher"
35209 .cindex "TLS" "logging cipher"
35210 &%tls_cipher%&: When a message is sent or received over an encrypted
35211 connection, the cipher suite used is added to the log line, preceded by X=.
35212 .next
35213 .cindex "log" "TLS peer DN"
35214 .cindex "TLS" "logging peer DN"
35215 &%tls_peerdn%&: When a message is sent or received over an encrypted
35216 connection, and a certificate is supplied by the remote host, the peer DN is
35217 added to the log line, preceded by DN=.
35218 .next
35219 .cindex "log" "TLS SNI"
35220 .cindex "TLS" "logging SNI"
35221 &%tls_sni%&: When a message is received over an encrypted connection, and
35222 the remote host provided the Server Name Indication extension, the SNI is
35223 added to the log line, preceded by SNI=.
35224 .next
35225 .cindex "log" "DNS failure in list"
35226 &%unknown_in_list%&: This setting causes a log entry to be written when the
35227 result of a list match is failure because a DNS lookup failed.
35228 .endlist
35229
35230
35231 .section "Message log" "SECID260"
35232 .cindex "message" "log file for"
35233 .cindex "log" "message log; description of"
35234 .cindex "&_msglog_& directory"
35235 .oindex "&%preserve_message_logs%&"
35236 In addition to the general log files, Exim writes a log file for each message
35237 that it handles. The names of these per-message logs are the message ids, and
35238 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35239 message log contains copies of the log lines that apply to the message. This
35240 makes it easier to inspect the status of an individual message without having
35241 to search the main log. A message log is deleted when processing of the message
35242 is complete, unless &%preserve_message_logs%& is set, but this should be used
35243 only with great care because they can fill up your disk very quickly.
35244
35245 On a heavily loaded system, it may be desirable to disable the use of
35246 per-message logs, in order to reduce disk I/O. This can be done by setting the
35247 &%message_logs%& option false.
35248 .ecindex IIDloggen
35249
35250
35251
35252
35253 . ////////////////////////////////////////////////////////////////////////////
35254 . ////////////////////////////////////////////////////////////////////////////
35255
35256 .chapter "Exim utilities" "CHAPutils"
35257 .scindex IIDutils "utilities"
35258 A number of utility scripts and programs are supplied with Exim and are
35259 described in this chapter. There is also the Exim Monitor, which is covered in
35260 the next chapter. The utilities described here are:
35261
35262 .itable none 0 0 3  7* left  15* left  40* left
35263 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35264   "list what Exim processes are doing"
35265 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35266 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35267 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35268 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35269                                                 various criteria"
35270 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35271 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35272   "extract statistics from the log"
35273 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35274   "check address acceptance from given IP"
35275 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35276 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35277 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35278 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35279 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35280 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35281 .endtable
35282
35283 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35284 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35285 &url(http://duncanthrax.net/exilog/) for details.
35286
35287
35288
35289
35290 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35291 .cindex "&'exiwhat'&"
35292 .cindex "process, querying"
35293 .cindex "SIGUSR1"
35294 On operating systems that can restart a system call after receiving a signal
35295 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35296 a line describing what it is doing to the file &_exim-process.info_& in the
35297 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35298 processes it can find, having first emptied the file. It then waits for one
35299 second to allow the Exim processes to react before displaying the results. In
35300 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35301 send the signal to the Exim processes, so it is normally run as root.
35302
35303 &*Warning*&: This is not an efficient process. It is intended for occasional
35304 use by system administrators. It is not sensible, for example, to set up a
35305 script that sends SIGUSR1 signals to Exim processes at short intervals.
35306
35307
35308 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35309 varies in different operating systems. Not only are different options used,
35310 but the format of the output is different. For this reason, there are some
35311 system configuration options that configure exactly how &'exiwhat'& works. If
35312 it doesn't seem to be working for you, check the following compile-time
35313 options:
35314 .display
35315 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35316 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35317 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35318 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35319 .endd
35320 An example of typical output from &'exiwhat'& is
35321 .code
35322 164 daemon: -q1h, listening on port 25
35323 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35324 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35325   [10.19.42.42] (editor@ref.example)
35326 10592 handling incoming call from [192.168.243.242]
35327 10628 accepting a local non-SMTP message
35328 .endd
35329 The first number in the output line is the process number. The third line has
35330 been split here, in order to fit it on the page.
35331
35332
35333
35334 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35335 .cindex "&'exiqgrep'&"
35336 .cindex "queue" "grepping"
35337 This utility is a Perl script contributed by Matt Hubbard. It runs
35338 .code
35339 exim -bpu
35340 .endd
35341 or (in case &*-a*& switch is specified)
35342 .code
35343 exim -bp
35344 .endd
35345 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35346 contain alternate exim configuration the queue management might be using.
35347
35348 to obtain a queue listing, and then greps the output to select messages 
35349 that match given criteria. The following selection options are available:
35350
35351 .vlist
35352 .vitem &*-f*&&~<&'regex'&>
35353 Match the sender address using a case-insensitive search. The field that is
35354 tested is enclosed in angle brackets, so you can test for bounce messages with
35355 .code
35356 exiqgrep -f '^<>$'
35357 .endd
35358 .vitem &*-r*&&~<&'regex'&>
35359 Match a recipient address using a case-insensitve search. The field that is
35360 tested is not enclosed in angle brackets.
35361
35362 .vitem &*-s*&&~<&'regex'&>
35363 Match against the size field.
35364
35365 .vitem &*-y*&&~<&'seconds'&>
35366 Match messages that are younger than the given time.
35367
35368 .vitem &*-o*&&~<&'seconds'&>
35369 Match messages that are older than the given time.
35370
35371 .vitem &*-z*&
35372 Match only frozen messages.
35373
35374 .vitem &*-x*&
35375 Match only non-frozen messages.
35376 .endlist
35377
35378 The following options control the format of the output:
35379
35380 .vlist
35381 .vitem &*-c*&
35382 Display only the count of matching messages.
35383
35384 .vitem &*-l*&
35385 Long format &-- display the full message information as output by Exim. This is
35386 the default.
35387
35388 .vitem &*-i*&
35389 Display message ids only.
35390
35391 .vitem &*-b*&
35392 Brief format &-- one line per message.
35393
35394 .vitem &*-R*&
35395 Display messages in reverse order.
35396
35397 .vitem &*-a*&
35398 Include delivered recipients in queue listing.
35399 .endlist
35400
35401 There is one more option, &%-h%&, which outputs a list of options.
35402
35403
35404
35405 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35406 .cindex "&'exiqsumm'&"
35407 .cindex "queue" "summary"
35408 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35409 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35410 running a command such as
35411 .code
35412 exim -bp | exiqsumm
35413 .endd
35414 The output consists of one line for each domain that has messages waiting for
35415 it, as in the following example:
35416 .code
35417 3   2322   74m   66m  msn.com.example
35418 .endd
35419 Each line lists the number of pending deliveries for a domain, their total
35420 volume, and the length of time that the oldest and the newest messages have
35421 been waiting. Note that the number of pending deliveries is greater than the
35422 number of messages when messages have more than one recipient.
35423
35424 A summary line is output at the end. By default the output is sorted on the
35425 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35426 the output to be sorted by oldest message and by count of messages,
35427 respectively. There are also three options that split the messages for each
35428 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35429 separates frozen messages, and &%-s%& separates messages according to their
35430 sender.
35431
35432 The output of &'exim -bp'& contains the original addresses in the message, so
35433 this also applies to the output from &'exiqsumm'&. No domains from addresses
35434 generated by aliasing or forwarding are included (unless the &%one_time%&
35435 option of the &(redirect)& router has been used to convert them into &"top
35436 level"& addresses).
35437
35438
35439
35440
35441 .section "Extracting specific information from the log (exigrep)" &&&
35442          "SECTextspeinf"
35443 .cindex "&'exigrep'&"
35444 .cindex "log" "extracts; grepping for"
35445 The &'exigrep'& utility is a Perl script that searches one or more main log
35446 files for entries that match a given pattern. When it finds a match, it
35447 extracts all the log entries for the relevant message, not just those that
35448 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35449 given message, or all mail for a given user, or for a given host, for example.
35450 The input files can be in Exim log format or syslog format.
35451 If a matching log line is not associated with a specific message, it is
35452 included in &'exigrep'&'s output without any additional lines. The usage is:
35453 .display
35454 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35455 .endd
35456 If no log file names are given on the command line, the standard input is read.
35457
35458 The &%-t%& argument specifies a number of seconds. It adds an additional
35459 condition for message selection. Messages that are complete are shown only if
35460 they spent more than <&'n'&> seconds on the queue.
35461
35462 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35463 makes it case-sensitive. This may give a performance improvement when searching
35464 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35465 option; with &%-I%& they do not. In both cases it is possible to change the
35466 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35467
35468 The &%-l%& option means &"literal"&, that is, treat all characters in the
35469 pattern as standing for themselves. Otherwise the pattern must be a Perl
35470 regular expression.
35471
35472 The &%-v%& option inverts the matching condition. That is, a line is selected
35473 if it does &'not'& match the pattern.
35474
35475 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35476 that are generated as a result/response to a message that &'exigrep'& matched
35477 normally.
35478
35479 Example of &%-M%&:
35480 user_a sends a message to user_b, which generates a bounce back to user_b. If
35481 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35482 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35483 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35484 when searching for &"user_a"& will show both messages since the bounce is
35485 &"related"& to or a &"result"& of the first message that was found by the
35486 search term.
35487
35488 If the location of a &'zcat'& command is known from the definition of
35489 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35490 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35491
35492
35493 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35494 .cindex "&'exipick'&"
35495 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35496 lists messages from the queue according to a variety of criteria. For details
35497 of &'exipick'&'s facilities, visit the web page at
35498 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35499 the &%--help%& option.
35500
35501
35502 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35503 .cindex "log" "cycling local files"
35504 .cindex "cycling logs"
35505 .cindex "&'exicyclog'&"
35506 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35507 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35508 you are using log files with datestamps in their names (see section
35509 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35510 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35511 There are two command line options for &'exicyclog'&:
35512 .ilist
35513 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35514 default that is set when Exim is built. The default default is 10.
35515 .next
35516 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35517 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35518 overriding the script's default, which is to find the setting from Exim's
35519 configuration.
35520 .endlist
35521
35522 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35523 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35524 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35525 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35526 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35527 logs are handled similarly.
35528
35529 If the limit is greater than 99, the script uses 3-digit numbers such as
35530 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35531 to one that is greater, or &'vice versa'&, you will have to fix the names of
35532 any existing log files.
35533
35534 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35535 the end are deleted. All files with numbers greater than 01 are compressed,
35536 using a compression command which is configured by the COMPRESS_COMMAND
35537 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35538 root &%crontab%& entry of the form
35539 .code
35540 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35541 .endd
35542 assuming you have used the name &"exim"& for the Exim user. You can run
35543 &'exicyclog'& as root if you wish, but there is no need.
35544
35545
35546
35547 .section "Mail statistics (eximstats)" "SECTmailstat"
35548 .cindex "statistics"
35549 .cindex "&'eximstats'&"
35550 A Perl script called &'eximstats'& is provided for extracting statistical
35551 information from log files. The output is either plain text, or HTML.
35552 Exim log files are also supported by the &'Lire'& system produced by the
35553 LogReport Foundation &url(http://www.logreport.org).
35554
35555 The &'eximstats'& script has been hacked about quite a bit over time. The
35556 latest version is the result of some extensive revision by Steve Campbell. A
35557 lot of information is given by default, but there are options for suppressing
35558 various parts of it. Following any options, the arguments to the script are a
35559 list of files, which should be main log files. For example:
35560 .code
35561 eximstats -nr /var/spool/exim/log/mainlog.01
35562 .endd
35563 By default, &'eximstats'& extracts information about the number and volume of
35564 messages received from or delivered to various hosts. The information is sorted
35565 both by message count and by volume, and the top fifty hosts in each category
35566 are listed on the standard output. Similar information, based on email
35567 addresses or domains instead of hosts can be requested by means of various
35568 options. For messages delivered and received locally, similar statistics are
35569 also produced per user.
35570
35571 The output also includes total counts and statistics about delivery errors, and
35572 histograms showing the number of messages received and deliveries made in each
35573 hour of the day. A delivery with more than one address in its envelope (for
35574 example, an SMTP transaction with more than one RCPT command) is counted
35575 as a single delivery by &'eximstats'&.
35576
35577 Though normally more deliveries than receipts are reported (as messages may
35578 have multiple recipients), it is possible for &'eximstats'& to report more
35579 messages received than delivered, even though the queue is empty at the start
35580 and end of the period in question. If an incoming message contains no valid
35581 recipients, no deliveries are recorded for it. A bounce message is handled as
35582 an entirely separate message.
35583
35584 &'eximstats'& always outputs a grand total summary giving the volume and number
35585 of messages received and deliveries made, and the number of hosts involved in
35586 each case. It also outputs the number of messages that were delayed (that is,
35587 not completely delivered at the first attempt), and the number that had at
35588 least one address that failed.
35589
35590 The remainder of the output is in sections that can be independently disabled
35591 or modified by various options. It consists of a summary of deliveries by
35592 transport, histograms of messages received and delivered per time interval
35593 (default per hour), information about the time messages spent on the queue,
35594 a list of relayed messages, lists of the top fifty sending hosts, local
35595 senders, destination hosts, and destination local users by count and by volume,
35596 and a list of delivery errors that occurred.
35597
35598 The relay information lists messages that were actually relayed, that is, they
35599 came from a remote host and were directly delivered to some other remote host,
35600 without being processed (for example, for aliasing or forwarding) locally.
35601
35602 There are quite a few options for &'eximstats'& to control exactly what it
35603 outputs. These are documented in the Perl script itself, and can be extracted
35604 by running the command &(perldoc)& on the script. For example:
35605 .code
35606 perldoc /usr/exim/bin/eximstats
35607 .endd
35608
35609 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35610 .cindex "&'exim_checkaccess'&"
35611 .cindex "policy control" "checking access"
35612 .cindex "checking access"
35613 The &%-bh%& command line argument allows you to run a fake SMTP session with
35614 debugging output, in order to check what Exim is doing when it is applying
35615 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35616 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35617 sometimes you just want to answer the question &"Does this address have
35618 access?"& without bothering with any further details.
35619
35620 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35621 two arguments, an IP address and an email address:
35622 .code
35623 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35624 .endd
35625 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35626 given email address would be accepted in a RCPT command in a TCP/IP
35627 connection from the host with the given IP address. The output of the utility
35628 is either the word &"accepted"&, or the SMTP error response, for example:
35629 .code
35630 Rejected:
35631 550 Relay not permitted
35632 .endd
35633 When running this test, the utility uses &`<>`& as the envelope sender address
35634 for the MAIL command, but you can change this by providing additional
35635 options. These are passed directly to the Exim command. For example, to specify
35636 that the test is to be run with the sender address &'himself@there.example'&
35637 you can use:
35638 .code
35639 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35640                  -f himself@there.example
35641 .endd
35642 Note that these additional Exim command line items must be given after the two
35643 mandatory arguments.
35644
35645 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35646 while running its checks. You can run checks that include callouts by using
35647 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35648
35649
35650
35651 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35652 .cindex "DBM" "building dbm files"
35653 .cindex "building DBM files"
35654 .cindex "&'exim_dbmbuild'&"
35655 .cindex "lower casing"
35656 .cindex "binary zero" "in lookup key"
35657 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35658 the format used by the &(lsearch)& lookup (see section
35659 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35660 names as keys and the remainder of the information as data. The lower-casing
35661 can be prevented by calling the program with the &%-nolc%& option.
35662
35663 A terminating zero is included as part of the key string. This is expected by
35664 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35665 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35666 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35667 files.
35668
35669 The program requires two arguments: the name of the input file (which can be a
35670 single hyphen to indicate the standard input), and the name of the output file.
35671 It creates the output under a temporary name, and then renames it if all went
35672 well.
35673
35674 .cindex "USE_DB"
35675 If the native DB interface is in use (USE_DB is set in a compile-time
35676 configuration file &-- this is common in free versions of Unix) the two file
35677 names must be different, because in this mode the Berkeley DB functions create
35678 a single output file using exactly the name given. For example,
35679 .code
35680 exim_dbmbuild /etc/aliases /etc/aliases.db
35681 .endd
35682 reads the system alias file and creates a DBM version of it in
35683 &_/etc/aliases.db_&.
35684
35685 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35686 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35687 environment, the suffixes are added to the second argument of
35688 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35689 when the Berkeley functions are used in compatibility mode (though this is not
35690 recommended), because in that case it adds a &_.db_& suffix to the file name.
35691
35692 If a duplicate key is encountered, the program outputs a warning, and when it
35693 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35694 option is used. By default, only the first of a set of duplicates is used &--
35695 this makes it compatible with &(lsearch)& lookups. There is an option
35696 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35697 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35698 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35699 return code is 2.
35700
35701
35702
35703
35704 .section "Finding individual retry times (exinext)" "SECTfinindret"
35705 .cindex "retry" "times"
35706 .cindex "&'exinext'&"
35707 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35708 fish specific information out of the retry database. Given a mail domain (or a
35709 complete address), it looks up the hosts for that domain, and outputs any retry
35710 information for the hosts or for the domain. At present, the retry information
35711 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35712 output. For example:
35713 .code
35714 $ exinext piglet@milne.fict.example
35715 kanga.milne.example:192.168.8.1 error 146: Connection refused
35716   first failed: 21-Feb-1996 14:57:34
35717   last tried:   21-Feb-1996 14:57:34
35718   next try at:  21-Feb-1996 15:02:34
35719 roo.milne.example:192.168.8.3 error 146: Connection refused
35720   first failed: 20-Jan-1996 13:12:08
35721   last tried:   21-Feb-1996 11:42:03
35722   next try at:  21-Feb-1996 19:42:03
35723   past final cutoff time
35724 .endd
35725 You can also give &'exinext'& a local part, without a domain, and it
35726 will give any retry information for that local part in your default domain.
35727 A message id can be used to obtain retry information pertaining to a specific
35728 message. This exists only when an attempt to deliver a message to a remote host
35729 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35730 &'exinext'& is not particularly efficient, but then it is not expected to be
35731 run very often.
35732
35733 The &'exinext'& utility calls Exim to find out information such as the location
35734 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35735 passed on to the &'exim'& commands. The first specifies an alternate Exim
35736 configuration file, and the second sets macros for use within the configuration
35737 file. These features are mainly to help in testing, but might also be useful in
35738 environments where more than one configuration file is in use.
35739
35740
35741
35742 .section "Hints database maintenance" "SECThindatmai"
35743 .cindex "hints database" "maintenance"
35744 .cindex "maintaining Exim's hints database"
35745 Three utility programs are provided for maintaining the DBM files that Exim
35746 uses to contain its delivery hint information. Each program requires two
35747 arguments. The first specifies the name of Exim's spool directory, and the
35748 second is the name of the database it is to operate on. These are as follows:
35749
35750 .ilist
35751 &'retry'&: the database of retry information
35752 .next
35753 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35754 for remote hosts
35755 .next
35756 &'callout'&: the callout cache
35757 .next
35758 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35759 .next
35760 &'misc'&: other hints data
35761 .endlist
35762
35763 The &'misc'& database is used for
35764
35765 .ilist
35766 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35767 .next
35768 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35769 &(smtp)& transport)
35770 .endlist
35771
35772
35773
35774 .section "exim_dumpdb" "SECID261"
35775 .cindex "&'exim_dumpdb'&"
35776 The entire contents of a database are written to the standard output by the
35777 &'exim_dumpdb'& program, which has no options or arguments other than the
35778 spool and database names. For example, to dump the retry database:
35779 .code
35780 exim_dumpdb /var/spool/exim retry
35781 .endd
35782 Two lines of output are produced for each entry:
35783 .code
35784 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35785 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35786 .endd
35787 The first item on the first line is the key of the record. It starts with one
35788 of the letters R, or T, depending on whether it refers to a routing or
35789 transport retry. For a local delivery, the next part is the local address; for
35790 a remote delivery it is the name of the remote host, followed by its failing IP
35791 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35792 transport). If the remote port is not the standard one (port 25), it is added
35793 to the IP address. Then there follows an error code, an additional error code,
35794 and a textual description of the error.
35795
35796 The three times on the second line are the time of first failure, the time of
35797 the last delivery attempt, and the computed time for the next attempt. The line
35798 ends with an asterisk if the cutoff time for the last retry rule has been
35799 exceeded.
35800
35801 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35802 consists of a host name followed by a list of ids for messages that are or were
35803 waiting to be delivered to that host. If there are a very large number for any
35804 one host, continuation records, with a sequence number added to the host name,
35805 may be seen. The data in these records is often out of date, because a message
35806 may be routed to several alternative hosts, and Exim makes no effort to keep
35807 cross-references.
35808
35809
35810
35811 .section "exim_tidydb" "SECID262"
35812 .cindex "&'exim_tidydb'&"
35813 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35814 database. If run with no options, it removes all records that are more than 30
35815 days old. The age is calculated from the date and time that the record was last
35816 updated. Note that, in the case of the retry database, it is &'not'& the time
35817 since the first delivery failure. Information about a host that has been down
35818 for more than 30 days will remain in the database, provided that the record is
35819 updated sufficiently often.
35820
35821 The cutoff date can be altered by means of the &%-t%& option, which must be
35822 followed by a time. For example, to remove all records older than a week from
35823 the retry database:
35824 .code
35825 exim_tidydb -t 7d /var/spool/exim retry
35826 .endd
35827 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35828 message ids. In the former these appear as data in records keyed by host &--
35829 they were messages that were waiting for that host &-- and in the latter they
35830 are the keys for retry information for messages that have suffered certain
35831 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35832 message ids in database records are those of messages that are still on the
35833 queue. Message ids for messages that no longer exist are removed from
35834 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35835 For the &'retry'& database, records whose keys are non-existent message ids are
35836 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35837 whenever it removes information from the database.
35838
35839 Certain records are automatically removed by Exim when they are no longer
35840 needed, but others are not. For example, if all the MX hosts for a domain are
35841 down, a retry record is created for each one. If the primary MX host comes back
35842 first, its record is removed when Exim successfully delivers to it, but the
35843 records for the others remain because Exim has not tried to use those hosts.
35844
35845 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35846 hints databases. You should do this at a quiet time of day, because it requires
35847 a database to be locked (and therefore inaccessible to Exim) while it does its
35848 work. Removing records from a DBM file does not normally make the file smaller,
35849 but all the common DBM libraries are able to re-use the space that is released.
35850 After an initial phase of increasing in size, the databases normally reach a
35851 point at which they no longer get any bigger, as long as they are regularly
35852 tidied.
35853
35854 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35855 databases is likely to keep on increasing.
35856
35857
35858
35859
35860 .section "exim_fixdb" "SECID263"
35861 .cindex "&'exim_fixdb'&"
35862 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35863 Its main use is for testing Exim, but it might also be occasionally useful for
35864 getting round problems in a live system. It has no options, and its interface
35865 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35866 key of a database record can then be entered, and the data for that record is
35867 displayed.
35868
35869 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35870 except the &'retry'& database, that is the only operation that can be carried
35871 out. For the &'retry'& database, each field is output preceded by a number, and
35872 data for individual fields can be changed by typing the field number followed
35873 by new data, for example:
35874 .code
35875 > 4 951102:1000
35876 .endd
35877 resets the time of the next delivery attempt. Time values are given as a
35878 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35879 used as optional separators.
35880
35881
35882
35883
35884 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35885 .cindex "mailbox" "maintenance"
35886 .cindex "&'exim_lock'&"
35887 .cindex "locking mailboxes"
35888 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35889 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35890 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35891 a user agent while investigating a problem. The utility requires the name of
35892 the file as its first argument. If the locking is successful, the second
35893 argument is run as a command (using C's &[system()]& function); if there is no
35894 second argument, the value of the SHELL environment variable is used; if this
35895 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35896 is unlocked and the utility ends. The following options are available:
35897
35898 .vlist
35899 .vitem &%-fcntl%&
35900 Use &[fcntl()]& locking on the open mailbox.
35901
35902 .vitem &%-flock%&
35903 Use &[flock()]& locking on the open mailbox, provided the operating system
35904 supports it.
35905
35906 .vitem &%-interval%&
35907 This must be followed by a number, which is a number of seconds; it sets the
35908 interval to sleep between retries (default 3).
35909
35910 .vitem &%-lockfile%&
35911 Create a lock file before opening the mailbox.
35912
35913 .vitem &%-mbx%&
35914 Lock the mailbox using MBX rules.
35915
35916 .vitem &%-q%&
35917 Suppress verification output.
35918
35919 .vitem &%-retries%&
35920 This must be followed by a number; it sets the number of times to try to get
35921 the lock (default 10).
35922
35923 .vitem &%-restore_time%&
35924 This option causes &%exim_lock%& to restore the modified and read times to the
35925 locked file before exiting. This allows you to access a locked mailbox (for
35926 example, to take a backup copy) without disturbing the times that the user
35927 subsequently sees.
35928
35929 .vitem &%-timeout%&
35930 This must be followed by a number, which is a number of seconds; it sets a
35931 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35932 default), a non-blocking call is used.
35933
35934 .vitem &%-v%&
35935 Generate verbose output.
35936 .endlist
35937
35938 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35939 default is to create a lock file and also to use &[fcntl()]& locking on the
35940 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35941 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35942 requires that the directory containing the file be writeable. Locking by lock
35943 file does not last for ever; Exim assumes that a lock file is expired if it is
35944 more than 30 minutes old.
35945
35946 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35947 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35948 to be taken out on the open mailbox, and an exclusive lock on the file
35949 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35950 number of the mailbox file. When the locking is released, if an exclusive lock
35951 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35952
35953 The default output contains verification of the locking that takes place. The
35954 &%-v%& option causes some additional information to be given. The &%-q%& option
35955 suppresses all output except error messages.
35956
35957 A command such as
35958 .code
35959 exim_lock /var/spool/mail/spqr
35960 .endd
35961 runs an interactive shell while the file is locked, whereas
35962 .display
35963 &`exim_lock -q /var/spool/mail/spqr <<End`&
35964 <&'some commands'&>
35965 &`End`&
35966 .endd
35967 runs a specific non-interactive sequence of commands while the file is locked,
35968 suppressing all verification output. A single command can be run by a command
35969 such as
35970 .code
35971 exim_lock -q /var/spool/mail/spqr \
35972   "cp /var/spool/mail/spqr /some/where"
35973 .endd
35974 Note that if a command is supplied, it must be entirely contained within the
35975 second argument &-- hence the quotes.
35976 .ecindex IIDutils
35977
35978
35979 . ////////////////////////////////////////////////////////////////////////////
35980 . ////////////////////////////////////////////////////////////////////////////
35981
35982 .chapter "The Exim monitor" "CHAPeximon"
35983 .scindex IIDeximon "Exim monitor" "description"
35984 .cindex "X-windows"
35985 .cindex "&'eximon'&"
35986 .cindex "Local/eximon.conf"
35987 .cindex "&_exim_monitor/EDITME_&"
35988 The Exim monitor is an application which displays in an X window information
35989 about the state of Exim's queue and what Exim is doing. An admin user can
35990 perform certain operations on messages from this GUI interface; however all
35991 such facilities are also available from the command line, and indeed, the
35992 monitor itself makes use of the command line to perform any actions requested.
35993
35994
35995
35996 .section "Running the monitor" "SECID264"
35997 The monitor is started by running the script called &'eximon'&. This is a shell
35998 script that sets up a number of environment variables, and then runs the
35999 binary called &_eximon.bin_&. The default appearance of the monitor window can
36000 be changed by editing the &_Local/eximon.conf_& file created by editing
36001 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36002 parameters are for.
36003
36004 The parameters that get built into the &'eximon'& script can be overridden for
36005 a particular invocation by setting up environment variables of the same names,
36006 preceded by &`EXIMON_`&. For example, a shell command such as
36007 .code
36008 EXIMON_LOG_DEPTH=400 eximon
36009 .endd
36010 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36011 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36012 overrides the Exim log file configuration. This makes it possible to have
36013 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36014 syslog messages are routed to a file on the local host.
36015
36016 X resources can be used to change the appearance of the window in the normal
36017 way. For example, a resource setting of the form
36018 .code
36019 Eximon*background: gray94
36020 .endd
36021 changes the colour of the background to light grey rather than white. The
36022 stripcharts are drawn with both the data lines and the reference lines in
36023 black. This means that the reference lines are not visible when on top of the
36024 data. However, their colour can be changed by setting a resource called
36025 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36026 For example, if your X server is running Unix, you could set up lighter
36027 reference lines in the stripcharts by obeying
36028 .code
36029 xrdb -merge <<End
36030 Eximon*highlight: gray
36031 End
36032 .endd
36033 .cindex "admin user"
36034 In order to see the contents of messages on the queue, and to operate on them,
36035 &'eximon'& must either be run as root or by an admin user.
36036
36037 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36038 contain X11 resource parameters interpreted by the X11 library.  In addition,
36039 if the first parameter starts with the string "gdb" then it is removed and the
36040 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36041 versioned variants of gdb can be invoked).
36042
36043 The monitor's window is divided into three parts. The first contains one or
36044 more stripcharts and two action buttons, the second contains a &"tail"& of the
36045 main log file, and the third is a display of the queue of messages awaiting
36046 delivery, with two more action buttons. The following sections describe these
36047 different parts of the display.
36048
36049
36050
36051
36052 .section "The stripcharts" "SECID265"
36053 .cindex "stripchart"
36054 The first stripchart is always a count of messages on the queue. Its name can
36055 be configured by setting QUEUE_STRIPCHART_NAME in the
36056 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36057 configuration script by regular expression matches on log file entries, making
36058 it possible to display, for example, counts of messages delivered to certain
36059 hosts or using certain transports. The supplied defaults display counts of
36060 received and delivered messages, and of local and SMTP deliveries. The default
36061 period between stripchart updates is one minute; this can be adjusted by a
36062 parameter in the &_Local/eximon.conf_& file.
36063
36064 The stripchart displays rescale themselves automatically as the value they are
36065 displaying changes. There are always 10 horizontal lines in each chart; the
36066 title string indicates the value of each division when it is greater than one.
36067 For example, &"x2"& means that each division represents a value of 2.
36068
36069 It is also possible to have a stripchart which shows the percentage fullness of
36070 a particular disk partition, which is useful when local deliveries are confined
36071 to a single partition.
36072
36073 .cindex "&%statvfs%& function"
36074 This relies on the availability of the &[statvfs()]& function or equivalent in
36075 the operating system. Most, but not all versions of Unix that support Exim have
36076 this. For this particular stripchart, the top of the chart always represents
36077 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36078 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36079 &_Local/eximon.conf_& file.
36080
36081
36082
36083
36084 .section "Main action buttons" "SECID266"
36085 .cindex "size" "of monitor window"
36086 .cindex "Exim monitor" "window size"
36087 .cindex "window size"
36088 Below the stripcharts there is an action button for quitting the monitor. Next
36089 to this is another button marked &"Size"&. They are placed here so that
36090 shrinking the window to its default minimum size leaves just the queue count
36091 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36092 the window to expand to its maximum size, unless it is already at the maximum,
36093 in which case it is reduced to its minimum.
36094
36095 When expanding to the maximum, if the window cannot be fully seen where it
36096 currently is, it is moved back to where it was the last time it was at full
36097 size. When it is expanding from its minimum size, the old position is
36098 remembered, and next time it is reduced to the minimum it is moved back there.
36099
36100 The idea is that you can keep a reduced window just showing one or two
36101 stripcharts at a convenient place on your screen, easily expand it to show
36102 the full window when required, and just as easily put it back to what it was.
36103 The idea is copied from what the &'twm'& window manager does for its
36104 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36105 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36106
36107 Normally, the monitor starts up with the window at its full size, but it can be
36108 built so that it starts up with the window at its smallest size, by setting
36109 START_SMALL=yes in &_Local/eximon.conf_&.
36110
36111
36112
36113 .section "The log display" "SECID267"
36114 .cindex "log" "tail of; in monitor"
36115 The second section of the window is an area in which a display of the tail of
36116 the main log is maintained.
36117 To save space on the screen, the timestamp on each log line is shortened by
36118 removing the date and, if &%log_timezone%& is set, the timezone.
36119 The log tail is not available when the only destination for logging data is
36120 syslog, unless the syslog lines are routed to a local file whose name is passed
36121 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36122
36123 The log sub-window has a scroll bar at its lefthand side which can be used to
36124 move back to look at earlier text, and the up and down arrow keys also have a
36125 scrolling effect. The amount of log that is kept depends on the setting of
36126 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36127 to use. When this is full, the earlier 50% of data is discarded &-- this is
36128 much more efficient than throwing it away line by line. The sub-window also has
36129 a horizontal scroll bar for accessing the ends of long log lines. This is the
36130 only means of horizontal scrolling; the right and left arrow keys are not
36131 available. Text can be cut from this part of the window using the mouse in the
36132 normal way. The size of this subwindow is controlled by parameters in the
36133 configuration file &_Local/eximon.conf_&.
36134
36135 Searches of the text in the log window can be carried out by means of the ^R
36136 and ^S keystrokes, which default to a reverse and a forward search,
36137 respectively. The search covers only the text that is displayed in the window.
36138 It cannot go further back up the log.
36139
36140 The point from which the search starts is indicated by a caret marker. This is
36141 normally at the end of the text in the window, but can be positioned explicitly
36142 by pointing and clicking with the left mouse button, and is moved automatically
36143 by a successful search. If new text arrives in the window when it is scrolled
36144 back, the caret remains where it is, but if the window is not scrolled back,
36145 the caret is moved to the end of the new text.
36146
36147 Pressing ^R or ^S pops up a window into which the search text can be typed.
36148 There are buttons for selecting forward or reverse searching, for carrying out
36149 the search, and for cancelling. If the &"Search"& button is pressed, the search
36150 happens and the window remains so that further searches can be done. If the
36151 &"Return"& key is pressed, a single search is done and the window is closed. If
36152 ^C is typed the search is cancelled.
36153
36154 The searching facility is implemented using the facilities of the Athena text
36155 widget. By default this pops up a window containing both &"search"& and
36156 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36157 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36158 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36159 provided version of &%TextPop%& when the remaining parts of the text widget
36160 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36161 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36162 on these systems, at the expense of having unwanted items in the search popup
36163 window.
36164
36165
36166
36167 .section "The queue display" "SECID268"
36168 .cindex "queue" "display in monitor"
36169 The bottom section of the monitor window contains a list of all messages that
36170 are on the queue, which includes those currently being received or delivered,
36171 as well as those awaiting delivery. The size of this subwindow is controlled by
36172 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36173 at which it is updated is controlled by another parameter in the same file &--
36174 the default is 5 minutes, since queue scans can be quite expensive. However,
36175 there is an &"Update"& action button just above the display which can be used
36176 to force an update of the queue display at any time.
36177
36178 When a host is down for some time, a lot of pending mail can build up for it,
36179 and this can make it hard to deal with other messages on the queue. To help
36180 with this situation there is a button next to &"Update"& called &"Hide"&. If
36181 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36182 type anything in here and press &"Return"&, the text is added to a chain of
36183 such texts, and if every undelivered address in a message matches at least one
36184 of the texts, the message is not displayed.
36185
36186 If there is an address that does not match any of the texts, all the addresses
36187 are displayed as normal. The matching happens on the ends of addresses so, for
36188 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36189 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36190 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36191 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36192 a hide request is automatically cancelled after one hour.
36193
36194 While the dialogue box is displayed, you can't press any buttons or do anything
36195 else to the monitor window. For this reason, if you want to cut text from the
36196 queue display to use in the dialogue box, you have to do the cutting before
36197 pressing the &"Hide"& button.
36198
36199 The queue display contains, for each unhidden queued message, the length of
36200 time it has been on the queue, the size of the message, the message id, the
36201 message sender, and the first undelivered recipient, all on one line. If it is
36202 a bounce message, the sender is shown as &"<>"&. If there is more than one
36203 recipient to which the message has not yet been delivered, subsequent ones are
36204 listed on additional lines, up to a maximum configured number, following which
36205 an ellipsis is displayed. Recipients that have already received the message are
36206 not shown.
36207
36208 .cindex "frozen messages" "display"
36209 If a message is frozen, an asterisk is displayed at the left-hand side.
36210
36211 The queue display has a vertical scroll bar, and can also be scrolled by means
36212 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36213 The text searching facilities, as described above for the log window, are also
36214 available, but the caret is always moved to the end of the text when the queue
36215 display is updated.
36216
36217
36218
36219 .section "The queue menu" "SECID269"
36220 .cindex "queue" "menu in monitor"
36221 If the &%shift%& key is held down and the left button is clicked when the mouse
36222 pointer is over the text for any message, an action menu pops up, and the first
36223 line of the queue display for the message is highlighted. This does not affect
36224 any selected text.
36225
36226 If you want to use some other event for popping up the menu, you can set the
36227 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36228 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36229 value set in this parameter is a standard X event description. For example, to
36230 run eximon using &%ctrl%& rather than &%shift%& you could use
36231 .code
36232 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36233 .endd
36234 The title of the menu is the message id, and it contains entries which act as
36235 follows:
36236
36237 .ilist
36238 &'message log'&: The contents of the message log for the message are displayed
36239 in a new text window.
36240 .next
36241 &'headers'&: Information from the spool file that contains the envelope
36242 information and headers is displayed in a new text window. See chapter
36243 &<<CHAPspool>>& for a description of the format of spool files.
36244 .next
36245 &'body'&: The contents of the spool file containing the body of the message are
36246 displayed in a new text window. There is a default limit of 20,000 bytes to the
36247 amount of data displayed. This can be changed by setting the BODY_MAX
36248 option at compile time, or the EXIMON_BODY_MAX option at run time.
36249 .next
36250 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36251 delivery of the message. This causes an automatic thaw if the message is
36252 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36253 a new text window. The delivery is run in a separate process, to avoid holding
36254 up the monitor while the delivery proceeds.
36255 .next
36256 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36257 that the message be frozen.
36258 .next
36259 .cindex "thawing messages"
36260 .cindex "unfreezing messages"
36261 .cindex "frozen messages" "thawing"
36262 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36263 that the message be thawed.
36264 .next
36265 .cindex "delivery" "forcing failure"
36266 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36267 that Exim gives up trying to deliver the message. A bounce message is generated
36268 for any remaining undelivered addresses.
36269 .next
36270 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36271 that the message be deleted from the system without generating a bounce
36272 message.
36273 .next
36274 &'add recipient'&: A dialog box is displayed into which a recipient address can
36275 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36276 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36277 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36278 causes a call to Exim to be made using the &%-Mar%& option to request that an
36279 additional recipient be added to the message, unless the entry box is empty, in
36280 which case no action is taken.
36281 .next
36282 &'mark delivered'&: A dialog box is displayed into which a recipient address
36283 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36284 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36285 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36286 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36287 recipient address as already delivered, unless the entry box is empty, in which
36288 case no action is taken.
36289 .next
36290 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36291 mark all recipient addresses as already delivered.
36292 .next
36293 &'edit sender'&: A dialog box is displayed initialized with the current
36294 sender's address. Pressing RETURN causes a call to Exim to be made using the
36295 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36296 in which case no action is taken. If you want to set an empty sender (as in
36297 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36298 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36299 the address is qualified with that domain.
36300 .endlist
36301
36302 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36303 other cases when a call to Exim is made, if there is any output from Exim (in
36304 particular, if the command fails) a window containing the command and the
36305 output is displayed. Otherwise, the results of the action are normally apparent
36306 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36307 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36308 if no output is generated.
36309
36310 The queue display is automatically updated for actions such as freezing and
36311 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36312 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36313 force an update of the display after one of these actions.
36314
36315 In any text window that is displayed as result of a menu action, the normal
36316 cut-and-paste facility is available, and searching can be carried out using ^R
36317 and ^S, as described above for the log tail window.
36318 .ecindex IIDeximon
36319
36320
36321
36322
36323
36324 . ////////////////////////////////////////////////////////////////////////////
36325 . ////////////////////////////////////////////////////////////////////////////
36326
36327 .chapter "Security considerations" "CHAPsecurity"
36328 .scindex IIDsecurcon "security" "discussion of"
36329 This chapter discusses a number of issues concerned with security, some of
36330 which are also covered in other parts of this manual.
36331
36332 For reasons that this author does not understand, some people have promoted
36333 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36334 existence of this chapter in the documentation. However, the intent of the
36335 chapter is simply to describe the way Exim works in relation to certain
36336 security concerns, not to make any specific claims about the effectiveness of
36337 its security as compared with other MTAs.
36338
36339 What follows is a description of the way Exim is supposed to be. Best efforts
36340 have been made to try to ensure that the code agrees with the theory, but an
36341 absence of bugs can never be guaranteed. Any that are reported will get fixed
36342 as soon as possible.
36343
36344
36345 .section "Building a more &""hardened""& Exim" "SECID286"
36346 .cindex "security" "build-time features"
36347 There are a number of build-time options that can be set in &_Local/Makefile_&
36348 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36349 Exim administrator who does not have the root password, or by someone who has
36350 penetrated the Exim (but not the root) account. These options are as follows:
36351
36352 .ilist
36353 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36354 start of any file names used with the &%-C%& option. When it is set, these file
36355 names are also not allowed to contain the sequence &"/../"&. (However, if the
36356 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36357 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36358 default setting for &%ALT_CONFIG_PREFIX%&.
36359
36360 If the permitted configuration files are confined to a directory to
36361 which only root has access, this guards against someone who has broken
36362 into the Exim account from running a privileged Exim with an arbitrary
36363 configuration file, and using it to break into other accounts.
36364 .next
36365
36366 If a non-trusted configuration file (i.e. not the default configuration file
36367 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36368 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36369 the next item), then root privilege is retained only if the caller of Exim is
36370 root. This locks out the possibility of testing a configuration using &%-C%&
36371 right through message reception and delivery, even if the caller is root. The
36372 reception works, but by that time, Exim is running as the Exim user, so when
36373 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36374 privilege to be lost. However, root can test reception and delivery using two
36375 separate commands.
36376
36377 .next
36378 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36379 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36380 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36381 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36382 the restrictive side.  Requiring build-time selection of safe macros is onerous
36383 but this option is intended solely as a transition mechanism to permit
36384 previously-working configurations to continue to work after release 4.73.
36385 .next
36386 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36387 is disabled.
36388 .next
36389 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36390 never to be used for any deliveries. This is like the &%never_users%& runtime
36391 option, but it cannot be overridden; the runtime option adds additional users
36392 to the list. The default setting is &"root"&; this prevents a non-root user who
36393 is permitted to modify the runtime file from using Exim as a way to get root.
36394 .endlist
36395
36396
36397
36398 .section "Root privilege" "SECID270"
36399 .cindex "setuid"
36400 .cindex "root privilege"
36401 The Exim binary is normally setuid to root, which means that it gains root
36402 privilege (runs as root) when it starts execution. In some special cases (for
36403 example, when the daemon is not in use and there are no local deliveries), it
36404 may be possible to run Exim setuid to some user other than root. This is
36405 discussed in the next section. However, in most installations, root privilege
36406 is required for two things:
36407
36408 .ilist
36409 To set up a socket connected to the standard SMTP port (25) when initialising
36410 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36411 not required.
36412 .next
36413 To be able to change uid and gid in order to read users' &_.forward_& files and
36414 perform local deliveries as the receiving user or as specified in the
36415 configuration.
36416 .endlist
36417
36418 It is not necessary to be root to do any of the other things Exim does, such as
36419 receiving messages and delivering them externally over SMTP, and it is
36420 obviously more secure if Exim does not run as root except when necessary.
36421 For this reason, a user and group for Exim to use must be defined in
36422 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36423 group"&. Their values can be changed by the run time configuration, though this
36424 is not recommended. Often a user called &'exim'& is used, but some sites use
36425 &'mail'& or another user name altogether.
36426
36427 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36428 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36429 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36430
36431 After a new Exim process has interpreted its command line options, it changes
36432 uid and gid in the following cases:
36433
36434 .ilist
36435 .oindex "&%-C%&"
36436 .oindex "&%-D%&"
36437 If the &%-C%& option is used to specify an alternate configuration file, or if
36438 the &%-D%& option is used to define macro values for the configuration, and the
36439 calling process is not running as root, the uid and gid are changed to those of
36440 the calling process.
36441 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36442 option may not be used at all.
36443 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36444 can be supplied if the calling process is running as root, the Exim run-time
36445 user or CONFIGURE_OWNER, if defined.
36446 .next
36447 .oindex "&%-be%&"
36448 .oindex "&%-bf%&"
36449 .oindex "&%-bF%&"
36450 If the expansion test option (&%-be%&) or one of the filter testing options
36451 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36452 calling process.
36453 .next
36454 If the process is not a daemon process or a queue runner process or a delivery
36455 process or a process for testing address routing (started with &%-bt%&), the
36456 uid and gid are changed to the Exim user and group. This means that Exim always
36457 runs under its own uid and gid when receiving messages. This also applies when
36458 testing address verification
36459 .oindex "&%-bv%&"
36460 .oindex "&%-bh%&"
36461 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36462 option).
36463 .next
36464 For a daemon, queue runner, delivery, or address testing process, the uid
36465 remains as root at this stage, but the gid is changed to the Exim group.
36466 .endlist
36467
36468 The processes that initially retain root privilege behave as follows:
36469
36470 .ilist
36471 A daemon process changes the gid to the Exim group and the uid to the Exim
36472 user after setting up one or more listening sockets. The &[initgroups()]&
36473 function is called, so that if the Exim user is in any additional groups, they
36474 will be used during message reception.
36475 .next
36476 A queue runner process retains root privilege throughout its execution. Its
36477 job is to fork a controlled sequence of delivery processes.
36478 .next
36479 A delivery process retains root privilege throughout most of its execution,
36480 but any actual deliveries (that is, the transports themselves) are run in
36481 subprocesses which always change to a non-root uid and gid. For local
36482 deliveries this is typically the uid and gid of the owner of the mailbox; for
36483 remote deliveries, the Exim uid and gid are used. Once all the delivery
36484 subprocesses have been run, a delivery process changes to the Exim uid and gid
36485 while doing post-delivery tidying up such as updating the retry database and
36486 generating bounce and warning messages.
36487
36488 While the recipient addresses in a message are being routed, the delivery
36489 process runs as root. However, if a user's filter file has to be processed,
36490 this is done in a subprocess that runs under the individual user's uid and
36491 gid. A system filter is run as root unless &%system_filter_user%& is set.
36492 .next
36493 A process that is testing addresses (the &%-bt%& option) runs as root so that
36494 the routing is done in the same environment as a message delivery.
36495 .endlist
36496
36497
36498
36499
36500 .section "Running Exim without privilege" "SECTrunexiwitpri"
36501 .cindex "privilege, running without"
36502 .cindex "unprivileged running"
36503 .cindex "root privilege" "running without"
36504 Some installations like to run Exim in an unprivileged state for more of its
36505 operation, for added security. Support for this mode of operation is provided
36506 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36507 gid are changed to the Exim user and group at the start of a delivery process
36508 (and also queue runner and address testing processes). This means that address
36509 routing is no longer run as root, and the deliveries themselves cannot change
36510 to any other uid.
36511
36512 .cindex SIGHUP
36513 .cindex "daemon" "restarting"
36514 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36515 that the daemon can still be started in the usual way, and it can respond
36516 correctly to SIGHUP because the re-invocation regains root privilege.
36517
36518 An alternative approach is to make Exim setuid to the Exim user and also setgid
36519 to the Exim group. If you do this, the daemon must be started from a root
36520 process. (Calling Exim from a root process makes it behave in the way it does
36521 when it is setuid root.) However, the daemon cannot restart itself after a
36522 SIGHUP signal because it cannot regain privilege.
36523
36524 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36525 stops Exim from trying to re-invoke itself to do a delivery after a message has
36526 been received. Such a re-invocation is a waste of resources because it has no
36527 effect.
36528
36529 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36530 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36531 to the Exim user seems a clean approach, but there is one complication:
36532
36533 In this style of operation, Exim is running with the real uid and gid set to
36534 those of the calling process, and the effective uid/gid set to Exim's values.
36535 Ideally, any association with the calling process' uid/gid should be dropped,
36536 that is, the real uid/gid should be reset to the effective values so as to
36537 discard any privileges that the caller may have. While some operating systems
36538 have a function that permits this action for a non-root effective uid, quite a
36539 number of them do not. Because of this lack of standardization, Exim does not
36540 address this problem at this time.
36541
36542 For this reason, the recommended approach for &"mostly unprivileged"& running
36543 is to keep the Exim binary setuid to root, and to set
36544 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36545 be used in the most straightforward way.
36546
36547 If you configure Exim not to run delivery processes as root, there are a
36548 number of restrictions on what you can do:
36549
36550 .ilist
36551 You can deliver only as the Exim user/group. You should  explicitly use the
36552 &%user%& and &%group%& options to override routers or local transports that
36553 normally deliver as the recipient. This makes sure that configurations that
36554 work in this mode function the same way in normal mode. Any implicit or
36555 explicit specification of another user causes an error.
36556 .next
36557 Use of &_.forward_& files is severely restricted, such that it is usually
36558 not worthwhile to include them in the configuration.
36559 .next
36560 Users who wish to use &_.forward_& would have to make their home directory and
36561 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36562 and their equivalents in Exim filters, cannot be used. While they could be
36563 enabled in the Exim user's name, that would be insecure and not very useful.
36564 .next
36565 Unless the local user mailboxes are all owned by the Exim user (possible in
36566 some POP3 or IMAP-only environments):
36567
36568 .olist
36569 They must be owned by the Exim group and be writeable by that group. This
36570 implies you must set &%mode%& in the appendfile configuration, as well as the
36571 mode of the mailbox files themselves.
36572 .next
36573 You must set &%no_check_owner%&, since most or all of the files will not be
36574 owned by the Exim user.
36575 .next
36576 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36577 on a newly created mailbox when unprivileged. This also implies that new
36578 mailboxes need to be created manually.
36579 .endlist olist
36580 .endlist ilist
36581
36582
36583 These restrictions severely restrict what can be done in local deliveries.
36584 However, there are no restrictions on remote deliveries. If you are running a
36585 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36586 gives more security at essentially no cost.
36587
36588 If you are using the &%mua_wrapper%& facility (see chapter
36589 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36590
36591
36592
36593
36594 .section "Delivering to local files" "SECID271"
36595 Full details of the checks applied by &(appendfile)& before it writes to a file
36596 are given in chapter &<<CHAPappendfile>>&.
36597
36598
36599
36600 .section "Running local commands" "SECTsecconslocalcmds"
36601 .cindex "security" "local commands"
36602 .cindex "security" "command injection attacks"
36603 There are a number of ways in which an administrator can configure Exim to run
36604 commands based upon received, untrustworthy, data. Further, in some
36605 configurations a user who can control a &_.forward_& file can also arrange to
36606 run commands. Configuration to check includes, but is not limited to:
36607
36608 .ilist
36609 Use of &%use_shell%& in the pipe transport: various forms of shell command
36610 injection may be possible with this option present. It is dangerous and should
36611 be used only with considerable caution. Consider constraints which whitelist
36612 allowed characters in a variable which is to be used in a pipe transport that
36613 has &%use_shell%& enabled.
36614 .next
36615 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36616 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36617 &_.forward_& files in a redirect router. If Exim is running on a central mail
36618 hub to which ordinary users do not have shell access, but home directories are
36619 NFS mounted (for instance) then administrators should review the list of these
36620 forbid options available, and should bear in mind that the options that may
36621 need forbidding can change as new features are added between releases.
36622 .next
36623 The &%${run...}%& expansion item does not use a shell by default, but
36624 administrators can configure use of &_/bin/sh_& as part of the command.
36625 Such invocations should be viewed with prejudicial suspicion.
36626 .next
36627 Administrators who use embedded Perl are advised to explore how Perl's
36628 taint checking might apply to their usage.
36629 .next
36630 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36631 administrators are well advised to view its use with suspicion, in case (for
36632 instance) it allows a local-part to contain embedded Exim directives.
36633 .next
36634 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36635 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36636 each can reference arbitrary lists and files, rather than just being a list
36637 of opaque strings.
36638 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36639 real-world security vulnerabilities caused by its use with untrustworthy data
36640 injected in, for SQL injection attacks.
36641 Consider the use of the &%inlisti%& expansion condition instead.
36642 .endlist
36643
36644
36645
36646
36647 .section "Trust in configuration data" "SECTsecconfdata"
36648 .cindex "security" "data sources"
36649 .cindex "security" "regular expressions"
36650 .cindex "regular expressions" "security"
36651 .cindex "PCRE" "security"
36652 If configuration data for Exim can come from untrustworthy sources, there
36653 are some issues to be aware of:
36654
36655 .ilist
36656 Use of &%${expand...}%& may provide a path for shell injection attacks.
36657 .next
36658 Letting untrusted data provide a regular expression is unwise.
36659 .next
36660 Using &%${match...}%& to apply a fixed regular expression against untrusted
36661 data may result in pathological behaviour within PCRE.  Be aware of what
36662 "backtracking" means and consider options for being more strict with a regular
36663 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36664 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36665 possessive quantifiers or just not using regular expressions against untrusted
36666 data.
36667 .next
36668 It can be important to correctly use &%${quote:...}%&,
36669 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36670 items to ensure that data is correctly constructed.
36671 .next
36672 Some lookups might return multiple results, even though normal usage is only
36673 expected to yield one result.
36674 .endlist
36675
36676
36677
36678
36679 .section "IPv4 source routing" "SECID272"
36680 .cindex "source routing" "in IP packets"
36681 .cindex "IP source routing"
36682 Many operating systems suppress IP source-routed packets in the kernel, but
36683 some cannot be made to do this, so Exim does its own check. It logs incoming
36684 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36685 IPv6. No special checking is currently done.
36686
36687
36688
36689 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36690 Support for these SMTP commands is disabled by default. If required, they can
36691 be enabled by defining suitable ACLs.
36692
36693
36694
36695
36696 .section "Privileged users" "SECID274"
36697 .cindex "trusted users"
36698 .cindex "admin user"
36699 .cindex "privileged user"
36700 .cindex "user" "trusted"
36701 .cindex "user" "admin"
36702 Exim recognizes two sets of users with special privileges. Trusted users are
36703 able to submit new messages to Exim locally, but supply their own sender
36704 addresses and information about a sending host. For other users submitting
36705 local messages, Exim sets up the sender address from the uid, and doesn't
36706 permit a remote host to be specified.
36707
36708 .oindex "&%-f%&"
36709 However, an untrusted user is permitted to use the &%-f%& command line option
36710 in the special form &%-f <>%& to indicate that a delivery failure for the
36711 message should not cause an error report. This affects the message's envelope,
36712 but it does not affect the &'Sender:'& header. Untrusted users may also be
36713 permitted to use specific forms of address with the &%-f%& option by setting
36714 the &%untrusted_set_sender%& option.
36715
36716 Trusted users are used to run processes that receive mail messages from some
36717 other mail domain and pass them on to Exim for delivery either locally, or over
36718 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36719 as any user listed in the &%trusted_users%& configuration option, or under any
36720 group listed in the &%trusted_groups%& option.
36721
36722 Admin users are permitted to do things to the messages on Exim's queue. They
36723 can freeze or thaw messages, cause them to be returned to their senders, remove
36724 them entirely, or modify them in various ways. In addition, admin users can run
36725 the Exim monitor and see all the information it is capable of providing, which
36726 includes the contents of files on the spool.
36727
36728 .oindex "&%-M%&"
36729 .oindex "&%-q%&"
36730 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36731 delivery of messages on its queue is restricted to admin users. This
36732 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36733 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36734 queue is also restricted to admin users. This restriction can be relaxed by
36735 setting &%no_queue_list_requires_admin%&.
36736
36737 Exim recognizes an admin user if the calling process is running as root or as
36738 the Exim user or if any of the groups associated with the calling process is
36739 the Exim group. It is not necessary actually to be running under the Exim
36740 group. However, if admin users who are not root or the Exim user are to access
36741 the contents of files on the spool via the Exim monitor (which runs
36742 unprivileged), Exim must be built to allow group read access to its spool
36743 files.
36744
36745
36746
36747 .section "Spool files" "SECID275"
36748 .cindex "spool directory" "files"
36749 Exim's spool directory and everything it contains is owned by the Exim user and
36750 set to the Exim group. The mode for spool files is defined in the
36751 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36752 any user who is a member of the Exim group can access these files.
36753
36754
36755
36756 .section "Use of argv[0]" "SECID276"
36757 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36758 of specific strings, Exim assumes certain options. For example, calling Exim
36759 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36760 to calling it with the option &%-bS%&. There are no security implications in
36761 this.
36762
36763
36764
36765 .section "Use of %f formatting" "SECID277"
36766 The only use made of &"%f"& by Exim is in formatting load average values. These
36767 are actually stored in integer variables as 1000 times the load average.
36768 Consequently, their range is limited and so therefore is the length of the
36769 converted output.
36770
36771
36772
36773 .section "Embedded Exim path" "SECID278"
36774 Exim uses its own path name, which is embedded in the code, only when it needs
36775 to re-exec in order to regain root privilege. Therefore, it is not root when it
36776 does so. If some bug allowed the path to get overwritten, it would lead to an
36777 arbitrary program's being run as exim, not as root.
36778
36779
36780
36781 .section "Dynamic module directory" "SECTdynmoddir"
36782 Any dynamically loadable modules must be installed into the directory
36783 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36784 loading it.
36785
36786
36787 .section "Use of sprintf()" "SECID279"
36788 .cindex "&[sprintf()]&"
36789 A large number of occurrences of &"sprintf"& in the code are actually calls to
36790 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36791 The intermediate formatting is done into a large fixed buffer by a function
36792 that runs through the format string itself, and checks the length of each
36793 conversion before performing it, thus preventing buffer overruns.
36794
36795 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36796 the output buffer is known to be sufficiently long to contain the converted
36797 string.
36798
36799
36800
36801 .section "Use of debug_printf() and log_write()" "SECID280"
36802 Arbitrary strings are passed to both these functions, but they do their
36803 formatting by calling the function &'string_vformat()'&, which runs through
36804 the format string itself, and checks the length of each conversion.
36805
36806
36807
36808 .section "Use of strcat() and strcpy()" "SECID281"
36809 These are used only in cases where the output buffer is known to be large
36810 enough to hold the result.
36811 .ecindex IIDsecurcon
36812
36813
36814
36815
36816 . ////////////////////////////////////////////////////////////////////////////
36817 . ////////////////////////////////////////////////////////////////////////////
36818
36819 .chapter "Format of spool files" "CHAPspool"
36820 .scindex IIDforspo1 "format" "spool files"
36821 .scindex IIDforspo2 "spool directory" "format of files"
36822 .scindex IIDforspo3 "spool files" "format of"
36823 .cindex "spool files" "editing"
36824 A message on Exim's queue consists of two files, whose names are the message id
36825 followed by -D and -H, respectively. The data portion of the message is kept in
36826 the -D file on its own. The message's envelope, status, and headers are all
36827 kept in the -H file, whose format is described in this chapter. Each of these
36828 two files contains the final component of its own name as its first line. This
36829 is insurance against disk crashes where the directory is lost but the files
36830 themselves are recoverable.
36831
36832 Some people are tempted into editing -D files in order to modify messages. You
36833 need to be extremely careful if you do this; it is not recommended and you are
36834 on your own if you do it. Here are some of the pitfalls:
36835
36836 .ilist
36837 You must ensure that Exim does not try to deliver the message while you are
36838 fiddling with it. The safest way is to take out a write lock on the -D file,
36839 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36840 place, the lock will be retained. If you write a new file and rename it, the
36841 lock will be lost at the instant of rename.
36842 .next
36843 .vindex "&$body_linecount$&"
36844 If you change the number of lines in the file, the value of
36845 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36846 present, this value is not used by Exim, but there is no guarantee that this
36847 will always be the case.
36848 .next
36849 If the message is in MIME format, you must take care not to break it.
36850 .next
36851 If the message is cryptographically signed, any change will invalidate the
36852 signature.
36853 .endlist
36854 All in all, modifying -D files is fraught with danger.
36855
36856 Files whose names end with -J may also be seen in the &_input_& directory (or
36857 its subdirectories when &%split_spool_directory%& is set). These are journal
36858 files, used to record addresses to which the message has been delivered during
36859 the course of a delivery attempt. If there are still undelivered recipients at
36860 the end, the -H file is updated, and the -J file is deleted. If, however, there
36861 is some kind of crash (for example, a power outage) before this happens, the -J
36862 file remains in existence. When Exim next processes the message, it notices the
36863 -J file and uses it to update the -H file before starting the next delivery
36864 attempt.
36865
36866 .section "Format of the -H file" "SECID282"
36867 .cindex "uid (user id)" "in spool file"
36868 .cindex "gid (group id)" "in spool file"
36869 The second line of the -H file contains the login name for the uid of the
36870 process that called Exim to read the message, followed by the numerical uid and
36871 gid. For a locally generated message, this is normally the user who sent the
36872 message. For a message received over TCP/IP via the daemon, it is
36873 normally the Exim user.
36874
36875 The third line of the file contains the address of the message's sender as
36876 transmitted in the envelope, contained in angle brackets. The sender address is
36877 empty for bounce messages. For incoming SMTP mail, the sender address is given
36878 in the MAIL command. For locally generated mail, the sender address is
36879 created by Exim from the login name of the current user and the configured
36880 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36881 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36882 &"<>"& or an address that matches &%untrusted_set_senders%&.
36883
36884 The fourth line contains two numbers. The first is the time that the message
36885 was received, in the conventional Unix form &-- the number of seconds since the
36886 start of the epoch. The second number is a count of the number of messages
36887 warning of delayed delivery that have been sent to the sender.
36888
36889 There follow a number of lines starting with a hyphen. These can appear in any
36890 order, and are omitted when not relevant:
36891
36892 .vlist
36893 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36894 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36895 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36896 recognized, to provide backward compatibility. In the old format, a line of
36897 this form is present for every ACL variable that is not empty. The number
36898 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36899 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36900 the data string for the variable. The string itself starts at the beginning of
36901 the next line, and is followed by a newline character. It may contain internal
36902 newlines.
36903
36904 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36905 A line of this form is present for every ACL connection variable that is
36906 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36907 The length is the length of the data string for the variable. The string itself
36908 starts at the beginning of the next line, and is followed by a newline
36909 character. It may contain internal newlines.
36910
36911 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36912 A line of this form is present for every ACL message variable that is defined.
36913 Note that there is a space between &%-aclm%& and the rest of the name. The
36914 length is the length of the data string for the variable. The string itself
36915 starts at the beginning of the next line, and is followed by a newline
36916 character. It may contain internal newlines.
36917
36918 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36919 This is present if, when the message was received over SMTP, the value of
36920 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36921
36922 .vitem &%-allow_unqualified_recipient%&
36923 This is present if unqualified recipient addresses are permitted in header
36924 lines (to stop such addresses from being qualified if rewriting occurs at
36925 transport time). Local messages that were input using &%-bnq%& and remote
36926 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36927
36928 .vitem &%-allow_unqualified_sender%&
36929 This is present if unqualified sender addresses are permitted in header lines
36930 (to stop such addresses from being qualified if rewriting occurs at transport
36931 time). Local messages that were input using &%-bnq%& and remote messages from
36932 hosts that match &%sender_unqualified_hosts%& set this flag.
36933
36934 .vitem "&%-auth_id%&&~<&'text'&>"
36935 The id information for a message received on an authenticated SMTP connection
36936 &-- the value of the &$authenticated_id$& variable.
36937
36938 .vitem "&%-auth_sender%&&~<&'address'&>"
36939 The address of an authenticated sender &-- the value of the
36940 &$authenticated_sender$& variable.
36941
36942 .vitem "&%-body_linecount%&&~<&'number'&>"
36943 This records the number of lines in the body of the message, and is always
36944 present.
36945
36946 .vitem "&%-body_zerocount%&&~<&'number'&>"
36947 This records the number of binary zero bytes in the body of the message, and is
36948 present if the number is greater than zero.
36949
36950 .vitem &%-deliver_firsttime%&
36951 This is written when a new message is first added to the spool. When the spool
36952 file is updated after a deferral, it is omitted.
36953
36954 .vitem "&%-frozen%&&~<&'time'&>"
36955 .cindex "frozen messages" "spool data"
36956 The message is frozen, and the freezing happened at <&'time'&>.
36957
36958 .vitem "&%-helo_name%&&~<&'text'&>"
36959 This records the host name as specified by a remote host in a HELO or EHLO
36960 command.
36961
36962 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36963 This records the IP address of the host from which the message was received and
36964 the remote port number that was used. It is omitted for locally generated
36965 messages.
36966
36967 .vitem "&%-host_auth%&&~<&'text'&>"
36968 If the message was received on an authenticated SMTP connection, this records
36969 the name of the authenticator &-- the value of the
36970 &$sender_host_authenticated$& variable.
36971
36972 .vitem &%-host_lookup_failed%&
36973 This is present if an attempt to look up the sending host's name from its IP
36974 address failed. It corresponds to the &$host_lookup_failed$& variable.
36975
36976 .vitem "&%-host_name%&&~<&'text'&>"
36977 .cindex "reverse DNS lookup"
36978 .cindex "DNS" "reverse lookup"
36979 This records the name of the remote host from which the message was received,
36980 if the host name was looked up from the IP address when the message was being
36981 received. It is not present if no reverse lookup was done.
36982
36983 .vitem "&%-ident%&&~<&'text'&>"
36984 For locally submitted messages, this records the login of the originating user,
36985 unless it was a trusted user and the &%-oMt%& option was used to specify an
36986 ident value. For messages received over TCP/IP, this records the ident string
36987 supplied by the remote host, if any.
36988
36989 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36990 This records the IP address of the local interface and the port number through
36991 which a message was received from a remote host. It is omitted for locally
36992 generated messages.
36993
36994 .vitem &%-local%&
36995 The message is from a local sender.
36996
36997 .vitem &%-localerror%&
36998 The message is a locally-generated bounce message.
36999
37000 .vitem "&%-local_scan%&&~<&'string'&>"
37001 This records the data string that was returned by the &[local_scan()]& function
37002 when the message was received &-- the value of the &$local_scan_data$&
37003 variable. It is omitted if no data was returned.
37004
37005 .vitem &%-manual_thaw%&
37006 The message was frozen but has been thawed manually, that is, by an explicit
37007 Exim command rather than via the auto-thaw process.
37008
37009 .vitem &%-N%&
37010 A testing delivery process was started using the &%-N%& option to suppress any
37011 actual deliveries, but delivery was deferred. At any further delivery attempts,
37012 &%-N%& is assumed.
37013
37014 .vitem &%-received_protocol%&
37015 This records the value of the &$received_protocol$& variable, which contains
37016 the name of the protocol by which the message was received.
37017
37018 .vitem &%-sender_set_untrusted%&
37019 The envelope sender of this message was set by an untrusted local caller (used
37020 to ensure that the caller is displayed in queue listings).
37021
37022 .vitem "&%-spam_score_int%&&~<&'number'&>"
37023 If a message was scanned by SpamAssassin, this is present. It records the value
37024 of &$spam_score_int$&.
37025
37026 .vitem &%-tls_certificate_verified%&
37027 A TLS certificate was received from the client that sent this message, and the
37028 certificate was verified by the server.
37029
37030 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37031 When the message was received over an encrypted connection, this records the
37032 name of the cipher suite that was used.
37033
37034 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37035 When the message was received over an encrypted connection, and a certificate
37036 was received from the client, this records the Distinguished Name from that
37037 certificate.
37038 .endlist
37039
37040 Following the options there is a list of those addresses to which the message
37041 is not to be delivered. This set of addresses is initialized from the command
37042 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37043 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37044 the address is added to this set. The addresses are kept internally as a
37045 balanced binary tree, and it is a representation of that tree which is written
37046 to the spool file. If an address is expanded via an alias or forward file, the
37047 original address is added to the tree when deliveries to all its child
37048 addresses are complete.
37049
37050 If the tree is empty, there is a single line in the spool file containing just
37051 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37052 Y or N, followed by an address. The address is the value for the node of the
37053 tree, and the letters indicate whether the node has a left branch and/or a
37054 right branch attached to it, respectively. If branches exist, they immediately
37055 follow. Here is an example of a three-node tree:
37056 .code
37057 YY darcy@austen.fict.example
37058 NN alice@wonderland.fict.example
37059 NN editor@thesaurus.ref.example
37060 .endd
37061 After the non-recipients tree, there is a list of the message's recipients.
37062 This is a simple list, preceded by a count. It includes all the original
37063 recipients of the message, including those to whom the message has already been
37064 delivered. In the simplest case, the list contains one address per line. For
37065 example:
37066 .code
37067 4
37068 editor@thesaurus.ref.example
37069 darcy@austen.fict.example
37070 rdo@foundation
37071 alice@wonderland.fict.example
37072 .endd
37073 However, when a child address has been added to the top-level addresses as a
37074 result of the use of the &%one_time%& option on a &(redirect)& router, each
37075 line is of the following form:
37076 .display
37077 <&'top-level address'&> <&'errors_to address'&> &&&
37078   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37079 .endd
37080 The 01 flag bit indicates the presence of the three other fields that follow
37081 the top-level address. Other bits may be used in future to support additional
37082 fields. The <&'parent number'&> is the offset in the recipients list of the
37083 original parent of the &"one time"& address. The first two fields are the
37084 envelope sender that is associated with this address and its length. If the
37085 length is zero, there is no special envelope sender (there are then two space
37086 characters in the line). A non-empty field can arise from a &(redirect)& router
37087 that has an &%errors_to%& setting.
37088
37089
37090 A blank line separates the envelope and status information from the headers
37091 which follow. A header may occupy several lines of the file, and to save effort
37092 when reading it in, each header is preceded by a number and an identifying
37093 character. The number is the number of characters in the header, including any
37094 embedded newlines and the terminating newline. The character is one of the
37095 following:
37096
37097 .table2 50pt
37098 .row <&'blank'&>         "header in which Exim has no special interest"
37099 .row &`B`&               "&'Bcc:'& header"
37100 .row &`C`&               "&'Cc:'& header"
37101 .row &`F`&               "&'From:'& header"
37102 .row &`I`&               "&'Message-id:'& header"
37103 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37104 .row &`R`&               "&'Reply-To:'& header"
37105 .row &`S`&               "&'Sender:'& header"
37106 .row &`T`&               "&'To:'& header"
37107 .row &`*`&               "replaced or deleted header"
37108 .endtable
37109
37110 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37111 purposes. They are not transmitted when the message is delivered. Here is a
37112 typical set of headers:
37113 .code
37114 111P Received: by hobbit.fict.example with local (Exim 4.00)
37115 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37116 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37117 038* X-rewrote-sender: bb@hobbit.fict.example
37118 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37119 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37120 099* To: alice@wonderland.fict.example, rdo@foundation,
37121 darcy@austen.fict.example, editor@thesaurus.ref.example
37122 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37123 darcy@austen.fict.example, editor@thesaurus.ref.example
37124 038  Date: Fri, 11 May 2001 10:28:59 +0100
37125 .endd
37126 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37127 &'To:'& header have been rewritten, the last one because routing expanded the
37128 unqualified domain &'foundation'&.
37129 .ecindex IIDforspo1
37130 .ecindex IIDforspo2
37131 .ecindex IIDforspo3
37132
37133 . ////////////////////////////////////////////////////////////////////////////
37134 . ////////////////////////////////////////////////////////////////////////////
37135
37136 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37137          "DKIM Support"
37138 .cindex "DKIM"
37139
37140 DKIM is a mechanism by which messages sent by some entity can be provably
37141 linked to a domain which that entity controls.  It permits reputation to
37142 be tracked on a per-domain basis, rather than merely upon source IP address.
37143 DKIM is documented in RFC 4871.
37144
37145 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37146 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37147
37148 Exim's DKIM implementation allows to
37149 .olist
37150 Sign outgoing messages: This function is implemented in the SMTP transport.
37151 It can co-exist with all other Exim features
37152 (including transport filters)
37153 except cutthrough delivery.
37154 .next
37155 Verify signatures in incoming messages: This is implemented by an additional
37156 ACL (acl_smtp_dkim), which can be called several times per message, with
37157 different signature contexts.
37158 .endlist
37159
37160 In typical Exim style, the verification implementation does not include any
37161 default "policy". Instead it enables you to build your own policy using
37162 Exim's standard controls.
37163
37164 Please note that verification of DKIM signatures in incoming mail is turned
37165 on by default for logging purposes. For each signature in incoming email,
37166 exim will log a line displaying the most important signature details, and the
37167 signature status. Here is an example (with line-breaks added for clarity):
37168 .code
37169 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37170     d=facebookmail.com s=q1-2009b
37171     c=relaxed/relaxed a=rsa-sha1
37172     i=@facebookmail.com t=1252484542 [verification succeeded]
37173 .endd
37174 You might want to turn off DKIM verification processing entirely for internal
37175 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37176 control modifier. This should typically be done in the RCPT ACL, at points
37177 where you accept mail from relay sources (internal hosts or authenticated
37178 senders).
37179
37180
37181 .section "Signing outgoing messages" "SECID513"
37182 .cindex "DKIM" "signing"
37183
37184 Signing is implemented by setting private options on the SMTP transport.
37185 These options take (expandable) strings as arguments.
37186
37187 .option dkim_domain smtp string&!! unset
37188 MANDATORY:
37189 The domain you want to sign with. The result of this expanded
37190 option is put into the &%$dkim_domain%& expansion variable.
37191
37192 .option dkim_selector smtp string&!! unset
37193 MANDATORY:
37194 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37195 variable to look up a matching selector. The result is put in the expansion
37196 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37197 option along with &%$dkim_domain%&.
37198
37199 .option dkim_private_key smtp string&!! unset
37200 MANDATORY:
37201 This sets the private key to use. You can use the &%$dkim_domain%& and
37202 &%$dkim_selector%& expansion variables to determine the private key to use.
37203 The result can either
37204 .ilist
37205 be a valid RSA private key in ASCII armor, including line breaks.
37206 .next
37207 start with a slash, in which case it is treated as a file that contains
37208 the private key.
37209 .next
37210 be "0", "false" or the empty string, in which case the message will not
37211 be signed. This case will not result in an error, even if &%dkim_strict%&
37212 is set.
37213 .endlist
37214
37215 .option dkim_canon smtp string&!! unset
37216 OPTIONAL:
37217 This option sets the canonicalization method used when signing a message.
37218 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37219 The option defaults to "relaxed" when unset. Note: the current implementation
37220 only supports using the same canonicalization method for both headers and body.
37221
37222 .option dkim_strict smtp string&!! unset
37223 OPTIONAL:
37224 This  option  defines  how  Exim  behaves  when  signing a message that
37225 should be signed fails for some reason.  When the expansion evaluates to
37226 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37227 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37228 variables here.
37229
37230 .option dkim_sign_headers smtp string&!! unset
37231 OPTIONAL:
37232 When set, this option must expand to (or be specified as) a colon-separated
37233 list of header names. Headers with these names will be included in the message
37234 signature. When unspecified, the header names recommended in RFC4871 will be
37235 used.
37236
37237
37238 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37239 .cindex "DKIM" "verification"
37240
37241 Verification of DKIM signatures in incoming email is implemented via the
37242 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37243 syntactically(!) correct signature in the incoming message.
37244 A missing ACL definition defaults to accept.
37245 If any ACL call does not acccept, the message is not accepted.
37246 If a cutthrough delivery was in progress for the message it is
37247 summarily dropped (having wasted the transmission effort).
37248
37249 To evaluate the signature in the ACL a large number of expansion variables
37250 containing the signature status and its details are set up during the
37251 runtime of the ACL.
37252
37253 Calling the ACL only for existing signatures is not sufficient to build
37254 more advanced policies. For that reason, the global option
37255 &%dkim_verify_signers%&, and a global expansion variable
37256 &%$dkim_signers%& exist.
37257
37258 The global option &%dkim_verify_signers%& can be set to a colon-separated
37259 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37260 called. It is expanded when the message has been received. At this point,
37261 the expansion variable &%$dkim_signers%& already contains a colon-separated
37262 list of signer domains and identities for the message. When
37263 &%dkim_verify_signers%& is not specified in the main configuration,
37264 it defaults as:
37265 .code
37266 dkim_verify_signers = $dkim_signers
37267 .endd
37268 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37269 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37270 call the ACL for known domains or identities. This would be achieved as follows:
37271 .code
37272 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37273 .endd
37274 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37275 and "ebay.com", plus all domains and identities that have signatures in the message.
37276 You can also be more creative in constructing your policy. For example:
37277 .code
37278 dkim_verify_signers = $sender_address_domain:$dkim_signers
37279 .endd
37280
37281 If a domain or identity is listed several times in the (expanded) value of
37282 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37283
37284
37285 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37286 available (from most to least important):
37287
37288
37289 .vlist
37290 .vitem &%$dkim_cur_signer%&
37291 The signer that is being evaluated in this ACL run. This can be a domain or
37292 an identity. This is one of the list items from the expanded main option
37293 &%dkim_verify_signers%& (see above).
37294 .vitem &%$dkim_verify_status%&
37295 A string describing the general status of the signature. One of
37296 .ilist
37297 &%none%&: There is no signature in the message for the current domain or
37298 identity (as reflected by &%$dkim_cur_signer%&).
37299 .next
37300 &%invalid%&: The signature could not be verified due to a processing error.
37301 More detail is available in &%$dkim_verify_reason%&.
37302 .next
37303 &%fail%&: Verification of the signature failed.  More detail is
37304 available in &%$dkim_verify_reason%&.
37305 .next
37306 &%pass%&: The signature passed verification. It is valid.
37307 .endlist
37308 .vitem &%$dkim_verify_reason%&
37309 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37310 "fail" or "invalid". One of
37311 .ilist
37312 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37313 key for the domain could not be retrieved. This may be a temporary problem.
37314 .next
37315 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37316 record for the domain is syntactically invalid.
37317 .next
37318 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37319 body hash does not match the one specified in the signature header. This
37320 means that the message body was modified in transit.
37321 .next
37322 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37323 could not be verified. This may mean that headers were modified,
37324 re-written or otherwise changed in a way which is incompatible with
37325 DKIM verification. It may of course also mean that the signature is forged.
37326 .endlist
37327 .vitem &%$dkim_domain%&
37328 The signing domain. IMPORTANT: This variable is only populated if there is
37329 an actual signature in the message for the current domain or identity (as
37330 reflected by &%$dkim_cur_signer%&).
37331 .vitem &%$dkim_identity%&
37332 The signing identity, if present. IMPORTANT: This variable is only populated
37333 if there is an actual signature in the message for the current domain or
37334 identity (as reflected by &%$dkim_cur_signer%&).
37335 .vitem &%$dkim_selector%&
37336 The key record selector string.
37337 .vitem &%$dkim_algo%&
37338 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37339 .vitem &%$dkim_canon_body%&
37340 The body canonicalization method. One of 'relaxed' or 'simple'.
37341 .vitem &%dkim_canon_headers%&
37342 The header canonicalization method. One of 'relaxed' or 'simple'.
37343 .vitem &%$dkim_copiedheaders%&
37344 A transcript of headers and their values which are included in the signature
37345 (copied from the 'z=' tag of the signature).
37346 .vitem &%$dkim_bodylength%&
37347 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37348 limit was set by the signer, "9999999999999" is returned. This makes sure
37349 that this variable always expands to an integer value.
37350 .vitem &%$dkim_created%&
37351 UNIX timestamp reflecting the date and time when the signature was created.
37352 When this was not specified by the signer, "0" is returned.
37353 .vitem &%$dkim_expires%&
37354 UNIX timestamp reflecting the date and time when the signer wants the
37355 signature to be treated as "expired". When this was not specified by the
37356 signer, "9999999999999" is returned. This makes it possible to do useful
37357 integer size comparisons against this value.
37358 .vitem &%$dkim_headernames%&
37359 A colon-separated list of names of headers included in the signature.
37360 .vitem &%$dkim_key_testing%&
37361 "1" if the key record has the "testing" flag set, "0" if not.
37362 .vitem &%$dkim_key_nosubdomains%&
37363 "1" if the key record forbids subdomaining, "0" otherwise.
37364 .vitem &%$dkim_key_srvtype%&
37365 Service type (tag s=) from the key record. Defaults to "*" if not specified
37366 in the key record.
37367 .vitem &%$dkim_key_granularity%&
37368 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37369 in the key record.
37370 .vitem &%$dkim_key_notes%&
37371 Notes from the key record (tag n=).
37372 .endlist
37373
37374 In addition, two ACL conditions are provided:
37375
37376 .vlist
37377 .vitem &%dkim_signers%&
37378 ACL condition that checks a colon-separated list of domains or identities
37379 for a match against the domain or identity that the ACL is currently verifying
37380 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37381 verb to a group of domains or identities. For example:
37382
37383 .code
37384 # Warn when Mail purportedly from GMail has no signature at all
37385 warn log_message = GMail sender without DKIM signature
37386      sender_domains = gmail.com
37387      dkim_signers = gmail.com
37388      dkim_status = none
37389 .endd
37390
37391 .vitem &%dkim_status%&
37392 ACL condition that checks a colon-separated list of possible DKIM verification
37393 results against the actual result of verification. This is typically used
37394 to restrict an ACL verb to a list of verification outcomes, for example:
37395
37396 .code
37397 deny message = Mail from Paypal with invalid/missing signature
37398      sender_domains = paypal.com:paypal.de
37399      dkim_signers = paypal.com:paypal.de
37400      dkim_status = none:invalid:fail
37401 .endd
37402
37403 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37404 see the documentation of the &%$dkim_verify_status%& expansion variable above
37405 for more information of what they mean.
37406 .endlist
37407
37408 . ////////////////////////////////////////////////////////////////////////////
37409 . ////////////////////////////////////////////////////////////////////////////
37410
37411 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37412          "Adding drivers or lookups"
37413 .cindex "adding drivers"
37414 .cindex "new drivers, adding"
37415 .cindex "drivers" "adding new"
37416 The following actions have to be taken in order to add a new router, transport,
37417 authenticator, or lookup type to Exim:
37418
37419 .olist
37420 Choose a name for the driver or lookup type that does not conflict with any
37421 existing name; I will use &"newdriver"& in what follows.
37422 .next
37423 Add to &_src/EDITME_& the line:
37424 .display
37425 <&'type'&>&`_NEWDRIVER=yes`&
37426 .endd
37427 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37428 code is not to be included in the binary by default, comment this line out. You
37429 should also add any relevant comments about the driver or lookup type.
37430 .next
37431 Add to &_src/config.h.defaults_& the line:
37432 .code
37433 #define <type>_NEWDRIVER
37434 .endd
37435 .next
37436 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37437 and create a table entry as is done for all the other drivers and lookup types.
37438 .next
37439 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37440 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37441 Add your &`NEWDRIVER`& to that list.
37442 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37443 simple form that most lookups have.
37444 .next
37445 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37446 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37447 driver or lookup type and add it to the definition of OBJ.
37448 .next
37449 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37450 &_src_&.
37451 .next
37452 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37453 as for other drivers and lookups.
37454 .endlist
37455
37456 Then all you need to do is write the code! A good way to start is to make a
37457 proforma by copying an existing module of the same type, globally changing all
37458 occurrences of the name, and cutting out most of the code. Note that any
37459 options you create must be listed in alphabetical order, because the tables are
37460 searched using a binary chop procedure.
37461
37462 There is a &_README_& file in each of the sub-directories of &_src_& describing
37463 the interface that is expected.
37464
37465
37466
37467
37468 . ////////////////////////////////////////////////////////////////////////////
37469 . ////////////////////////////////////////////////////////////////////////////
37470
37471 . /////////////////////////////////////////////////////////////////////////////
37472 . These lines are processing instructions for the Simple DocBook Processor that
37473 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37474 . PDFs than using xmlto and fop. They will be ignored by all other XML
37475 . processors.
37476 . /////////////////////////////////////////////////////////////////////////////
37477
37478 .literal xml
37479 <?sdop
37480   format="newpage"
37481   foot_right_recto="&chaptertitle;"
37482   foot_right_verso="&chaptertitle;"
37483 ?>
37484 .literal off
37485
37486 .makeindex "Options index"   "option"
37487 .makeindex "Variables index" "variable"
37488 .makeindex "Concept index"   "concept"
37489
37490
37491 . /////////////////////////////////////////////////////////////////////////////
37492 . /////////////////////////////////////////////////////////////////////////////