Docs: update drweb malware scanner interface description
[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.83"
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 &%-MCP%&
3815 .oindex "&%-MCP%&"
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 server to
3818 which Exim is connected supports pipelining.
3819
3820 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3821 .oindex "&%-MCQ%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option when the original delivery was
3824 started by a queue runner. It passes on the process id of the queue runner,
3825 together with the file descriptor number of an open pipe. Closure of the pipe
3826 signals the final completion of the sequence of processes that are passing
3827 messages through the same SMTP connection.
3828
3829 .vitem &%-MCS%&
3830 .oindex "&%-MCS%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3833 SMTP SIZE option should be used on messages delivered down the existing
3834 connection.
3835
3836 .vitem &%-MCT%&
3837 .oindex "&%-MCT%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3840 host to which Exim is connected supports TLS encryption.
3841
3842 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3843 .oindex "&%-Mc%&"
3844 .cindex "hints database" "not overridden by &%-Mc%&"
3845 .cindex "delivery" "manually started &-- not forced"
3846 This option requests Exim to run a delivery attempt on each message in turn,
3847 but unlike the &%-M%& option, it does check for retry hints, and respects any
3848 that are found. This option is not very useful to external callers. It is
3849 provided mainly for internal use by Exim when it needs to re-invoke itself in
3850 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3851 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3852 respects retry times and other options such as &%hold_domains%& that are
3853 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3854 If you want to run a specific delivery as if in a queue run, you should use
3855 &%-q%& with a message id argument. A distinction between queue run deliveries
3856 and other deliveries is made in one or two places.
3857
3858 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3859 .oindex "&%-Mes%&"
3860 .cindex "message" "changing sender"
3861 .cindex "sender" "changing"
3862 This option requests Exim to change the sender address in the message to the
3863 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3864 &"edit sender"&). There must be exactly two arguments. The first argument must
3865 be a message id, and the second one an email address. However, if the message
3866 is active (in the middle of a delivery attempt), its status is not altered.
3867 This option can be used only by an admin user.
3868
3869 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3870 .oindex "&%-Mf%&"
3871 .cindex "freezing messages"
3872 .cindex "message" "manually freezing"
3873 This option requests Exim to mark each listed message as &"frozen"&. This
3874 prevents any delivery attempts taking place until the message is &"thawed"&,
3875 either manually or as a result of the &%auto_thaw%& configuration option.
3876 However, if any of the messages are active (in the middle of a delivery
3877 attempt), their status is not altered. This option can be used only by an admin
3878 user.
3879
3880 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3881 .oindex "&%-Mg%&"
3882 .cindex "giving up on messages"
3883 .cindex "message" "abandoning delivery attempts"
3884 .cindex "delivery" "abandoning further attempts"
3885 This option requests Exim to give up trying to deliver the listed messages,
3886 including any that are frozen. However, if any of the messages are active,
3887 their status is not altered. For non-bounce messages, a delivery error message
3888 is sent to the sender, containing the text &"cancelled by administrator"&.
3889 Bounce messages are just discarded. This option can be used only by an admin
3890 user.
3891
3892 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3893 .oindex "&%-Mmad%&"
3894 .cindex "delivery" "cancelling all"
3895 This option requests Exim to mark all the recipient addresses in the messages
3896 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3897 message is active (in the middle of a delivery attempt), its status is not
3898 altered. This option can be used only by an admin user.
3899
3900 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3901 .oindex "&%-Mmd%&"
3902 .cindex "delivery" "cancelling by address"
3903 .cindex "recipient" "removing"
3904 .cindex "removing recipients"
3905 This option requests Exim to mark the given addresses as already delivered
3906 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3907 the remaining ones must be email addresses. These are matched to recipient
3908 addresses in the message in a case-sensitive manner. If the message is active
3909 (in the middle of a delivery attempt), its status is not altered. This option
3910 can be used only by an admin user.
3911
3912 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3913 .oindex "&%-Mrm%&"
3914 .cindex "removing messages"
3915 .cindex "abandoning mail"
3916 .cindex "message" "manually discarding"
3917 This option requests Exim to remove the given messages from the queue. No
3918 bounce messages are sent; each message is simply forgotten. However, if any of
3919 the messages are active, their status is not altered. This option can be used
3920 only by an admin user or by the user who originally caused the message to be
3921 placed on the queue.
3922
3923 .vitem &%-Mset%&&~<&'message&~id'&>
3924 .oindex "&%-Mset%&
3925 .cindex "testing" "string expansion"
3926 .cindex "expansion" "testing"
3927 This option is useful only in conjunction with &%-be%& (that is, when testing
3928 string expansions). Exim loads the given message from its spool before doing
3929 the test expansions, thus setting message-specific variables such as
3930 &$message_size$& and the header variables. The &$recipients$& variable is made
3931 available. This feature is provided to make it easier to test expansions that
3932 make use of these variables. However, this option can be used only by an admin
3933 user. See also &%-bem%&.
3934
3935 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3936 .oindex "&%-Mt%&"
3937 .cindex "thawing messages"
3938 .cindex "unfreezing messages"
3939 .cindex "frozen messages" "thawing"
3940 .cindex "message" "thawing frozen"
3941 This option requests Exim to &"thaw"& any of the listed messages that are
3942 &"frozen"&, so that delivery attempts can resume. However, if any of the
3943 messages are active, their status is not altered. This option can be used only
3944 by an admin user.
3945
3946 .vitem &%-Mvb%&&~<&'message&~id'&>
3947 .oindex "&%-Mvb%&"
3948 .cindex "listing" "message body"
3949 .cindex "message" "listing body of"
3950 This option causes the contents of the message body (-D) spool file to be
3951 written to the standard output. This option can be used only by an admin user.
3952
3953 .vitem &%-Mvc%&&~<&'message&~id'&>
3954 .oindex "&%-Mvc%&"
3955 .cindex "message" "listing in RFC 2822 format"
3956 .cindex "listing" "message in RFC 2822 format"
3957 This option causes a copy of the complete message (header lines plus body) to
3958 be written to the standard output in RFC 2822 format. This option can be used
3959 only by an admin user.
3960
3961 .vitem &%-Mvh%&&~<&'message&~id'&>
3962 .oindex "&%-Mvh%&"
3963 .cindex "listing" "message headers"
3964 .cindex "header lines" "listing"
3965 .cindex "message" "listing header lines"
3966 This option causes the contents of the message headers (-H) spool file to be
3967 written to the standard output. This option can be used only by an admin user.
3968
3969 .vitem &%-Mvl%&&~<&'message&~id'&>
3970 .oindex "&%-Mvl%&"
3971 .cindex "listing" "message log"
3972 .cindex "message" "listing message log"
3973 This option causes the contents of the message log spool file to be written to
3974 the standard output. This option can be used only by an admin user.
3975
3976 .vitem &%-m%&
3977 .oindex "&%-m%&"
3978 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3979 treats it that way too.
3980
3981 .vitem &%-N%&
3982 .oindex "&%-N%&"
3983 .cindex "debugging" "&%-N%& option"
3984 .cindex "debugging" "suppressing delivery"
3985 This is a debugging option that inhibits delivery of a message at the transport
3986 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3987 it just doesn't actually transport the message, but instead behaves as if it
3988 had successfully done so. However, it does not make any updates to the retry
3989 database, and the log entries for deliveries are flagged with &"*>"& rather
3990 than &"=>"&.
3991
3992 Because &%-N%& discards any message to which it applies, only root or the Exim
3993 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3994 words, an ordinary user can use it only when supplying an incoming message to
3995 which it will apply. Although transportation never fails when &%-N%& is set, an
3996 address may be deferred because of a configuration problem on a transport, or a
3997 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3998 the message, and applies to any subsequent delivery attempts that may happen
3999 for that message.
4000
4001 .vitem &%-n%&
4002 .oindex "&%-n%&"
4003 This option is interpreted by Sendmail to mean &"no aliasing"&.
4004 For normal modes of operation, it is ignored by Exim.
4005 When combined with &%-bP%& it suppresses the name of an option from being output.
4006
4007 .vitem &%-O%&&~<&'data'&>
4008 .oindex "&%-O%&"
4009 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4010 Exim.
4011
4012 .vitem &%-oA%&&~<&'file&~name'&>
4013 .oindex "&%-oA%&"
4014 .cindex "Sendmail compatibility" "&%-oA%& option"
4015 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4016 alternative alias file name. Exim handles &%-bi%& differently; see the
4017 description above.
4018
4019 .vitem &%-oB%&&~<&'n'&>
4020 .oindex "&%-oB%&"
4021 .cindex "SMTP" "passed connection"
4022 .cindex "SMTP" "multiple deliveries"
4023 .cindex "multiple SMTP deliveries"
4024 This is a debugging option which limits the maximum number of messages that can
4025 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4026 transport. If <&'n'&> is omitted, the limit is set to 1.
4027
4028 .vitem &%-odb%&
4029 .oindex "&%-odb%&"
4030 .cindex "background delivery"
4031 .cindex "delivery" "in the background"
4032 This option applies to all modes in which Exim accepts incoming messages,
4033 including the listening daemon. It requests &"background"& delivery of such
4034 messages, which means that the accepting process automatically starts a
4035 delivery process for each message received, but does not wait for the delivery
4036 processes to finish.
4037
4038 When all the messages have been received, the reception process exits,
4039 leaving the delivery processes to finish in their own time. The standard output
4040 and error streams are closed at the start of each delivery process.
4041 This is the default action if none of the &%-od%& options are present.
4042
4043 If one of the queueing options in the configuration file
4044 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4045 overrides it if &%queue_only_override%& is set true, which is the default
4046 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4047
4048 .vitem &%-odf%&
4049 .oindex "&%-odf%&"
4050 .cindex "foreground delivery"
4051 .cindex "delivery" "in the foreground"
4052 This option requests &"foreground"& (synchronous) delivery when Exim has
4053 accepted a locally-generated message. (For the daemon it is exactly the same as
4054 &%-odb%&.) A delivery process is automatically started to deliver the message,
4055 and Exim waits for it to complete before proceeding.
4056
4057 The original Exim reception process does not finish until the delivery
4058 process for the final message has ended. The standard error stream is left open
4059 during deliveries.
4060
4061 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4062 false and one of the queueing options in the configuration file is in effect.
4063
4064 If there is a temporary delivery error during foreground delivery, the
4065 message is left on the queue for later delivery, and the original reception
4066 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4067 restricted configuration that never queues messages.
4068
4069
4070 .vitem &%-odi%&
4071 .oindex "&%-odi%&"
4072 This option is synonymous with &%-odf%&. It is provided for compatibility with
4073 Sendmail.
4074
4075 .vitem &%-odq%&
4076 .oindex "&%-odq%&"
4077 .cindex "non-immediate delivery"
4078 .cindex "delivery" "suppressing immediate"
4079 .cindex "queueing incoming messages"
4080 This option applies to all modes in which Exim accepts incoming messages,
4081 including the listening daemon. It specifies that the accepting process should
4082 not automatically start a delivery process for each message received. Messages
4083 are placed on the queue, and remain there until a subsequent queue runner
4084 process encounters them. There are several configuration options (such as
4085 &%queue_only%&) that can be used to queue incoming messages under certain
4086 conditions. This option overrides all of them and also &%-odqs%&. It always
4087 forces queueing.
4088
4089 .vitem &%-odqs%&
4090 .oindex "&%-odqs%&"
4091 .cindex "SMTP" "delaying delivery"
4092 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4093 However, like &%-odb%& and &%-odi%&, this option has no effect if
4094 &%queue_only_override%& is false and one of the queueing options in the
4095 configuration file is in effect.
4096
4097 When &%-odqs%& does operate, a delivery process is started for each incoming
4098 message, in the background by default, but in the foreground if &%-odi%& is
4099 also present. The recipient addresses are routed, and local deliveries are done
4100 in the normal way. However, if any SMTP deliveries are required, they are not
4101 done at this time, so the message remains on the queue until a subsequent queue
4102 runner process encounters it. Because routing was done, Exim knows which
4103 messages are waiting for which hosts, and so a number of messages for the same
4104 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4105 configuration option has the same effect for specific domains. See also the
4106 &%-qq%& option.
4107
4108 .vitem &%-oee%&
4109 .oindex "&%-oee%&"
4110 .cindex "error" "reporting"
4111 If an error is detected while a non-SMTP message is being received (for
4112 example, a malformed address), the error is reported to the sender in a mail
4113 message.
4114
4115 .cindex "return code" "for &%-oee%&"
4116 Provided
4117 this error message is successfully sent, the Exim receiving process
4118 exits with a return code of zero. If not, the return code is 2 if the problem
4119 is that the original message has no recipients, or 1 for any other error.
4120 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4121
4122 .vitem &%-oem%&
4123 .oindex "&%-oem%&"
4124 .cindex "error" "reporting"
4125 .cindex "return code" "for &%-oem%&"
4126 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4127 return code, whether or not the error message was successfully sent.
4128 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4129
4130 .vitem &%-oep%&
4131 .oindex "&%-oep%&"
4132 .cindex "error" "reporting"
4133 If an error is detected while a non-SMTP message is being received, the
4134 error is reported by writing a message to the standard error file (stderr).
4135 .cindex "return code" "for &%-oep%&"
4136 The return code is 1 for all errors.
4137
4138 .vitem &%-oeq%&
4139 .oindex "&%-oeq%&"
4140 .cindex "error" "reporting"
4141 This option is supported for compatibility with Sendmail, but has the same
4142 effect as &%-oep%&.
4143
4144 .vitem &%-oew%&
4145 .oindex "&%-oew%&"
4146 .cindex "error" "reporting"
4147 This option is supported for compatibility with Sendmail, but has the same
4148 effect as &%-oem%&.
4149
4150 .vitem &%-oi%&
4151 .oindex "&%-oi%&"
4152 .cindex "dot" "in incoming non-SMTP message"
4153 This option, which has the same effect as &%-i%&, specifies that a dot on a
4154 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4155 single dot does terminate, though Exim does no special processing for other
4156 lines that start with a dot. This option is set by default if Exim is called as
4157 &'rmail'&. See also &%-ti%&.
4158
4159 .vitem &%-oitrue%&
4160 .oindex "&%-oitrue%&"
4161 This option is treated as synonymous with &%-oi%&.
4162
4163 .vitem &%-oMa%&&~<&'host&~address'&>
4164 .oindex "&%-oMa%&"
4165 .cindex "sender" "host address, specifying for local message"
4166 A number of options starting with &%-oM%& can be used to set values associated
4167 with remote hosts on locally-submitted messages (that is, messages not received
4168 over TCP/IP). These options can be used by any caller in conjunction with the
4169 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4170 other circumstances, they are ignored unless the caller is trusted.
4171
4172 The &%-oMa%& option sets the sender host address. This may include a port
4173 number at the end, after a full stop (period). For example:
4174 .code
4175 exim -bs -oMa 10.9.8.7.1234
4176 .endd
4177 An alternative syntax is to enclose the IP address in square brackets,
4178 followed by a colon and the port number:
4179 .code
4180 exim -bs -oMa [10.9.8.7]:1234
4181 .endd
4182 The IP address is placed in the &$sender_host_address$& variable, and the
4183 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4184 are present on the command line, the sender host IP address is taken from
4185 whichever one is last.
4186
4187 .vitem &%-oMaa%&&~<&'name'&>
4188 .oindex "&%-oMaa%&"
4189 .cindex "authentication" "name, specifying for local message"
4190 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4191 option sets the value of &$sender_host_authenticated$& (the authenticator
4192 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4193 This option can be used with &%-bh%& and &%-bs%& to set up an
4194 authenticated SMTP session without actually using the SMTP AUTH command.
4195
4196 .vitem &%-oMai%&&~<&'string'&>
4197 .oindex "&%-oMai%&"
4198 .cindex "authentication" "id, specifying for local message"
4199 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4200 option sets the value of &$authenticated_id$& (the id that was authenticated).
4201 This overrides the default value (the caller's login id, except with &%-bh%&,
4202 where there is no default) for messages from local sources. See chapter
4203 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4204
4205 .vitem &%-oMas%&&~<&'address'&>
4206 .oindex "&%-oMas%&"
4207 .cindex "authentication" "sender, specifying for local message"
4208 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4209 option sets the authenticated sender value in &$authenticated_sender$&. It
4210 overrides the sender address that is created from the caller's login id for
4211 messages from local sources, except when &%-bh%& is used, when there is no
4212 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4213 specified on a MAIL command overrides this value. See chapter
4214 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4215
4216 .vitem &%-oMi%&&~<&'interface&~address'&>
4217 .oindex "&%-oMi%&"
4218 .cindex "interface" "address, specifying for local message"
4219 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4220 option sets the IP interface address value. A port number may be included,
4221 using the same syntax as for &%-oMa%&. The interface address is placed in
4222 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4223
4224 .vitem &%-oMm%&&~<&'message&~reference'&>
4225 .oindex "&%-oMm%&"
4226 .cindex "message reference" "message reference, specifying for local message"
4227 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4228 option sets the message reference, e.g. message-id, and is logged during
4229 delivery. This is useful when some kind of audit trail is required to tie
4230 messages together. The format of the message reference is checked and will
4231 abort if the format is invalid. The option will only be accepted if exim is
4232 running in trusted mode, not as any regular user.
4233
4234 The best example of a message reference is when Exim sends a bounce message.
4235 The message reference is the message-id of the original message for which Exim
4236 is sending the bounce.
4237
4238 .vitem &%-oMr%&&~<&'protocol&~name'&>
4239 .oindex "&%-oMr%&"
4240 .cindex "protocol, specifying for local message"
4241 .vindex "&$received_protocol$&"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4243 option sets the received protocol value that is stored in
4244 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4245 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4246 SMTP protocol names (see the description of &$received_protocol$& in section
4247 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4248 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4249 be set by &%-oMr%&.
4250
4251 .vitem &%-oMs%&&~<&'host&~name'&>
4252 .oindex "&%-oMs%&"
4253 .cindex "sender" "host name, specifying for local message"
4254 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4255 option sets the sender host name in &$sender_host_name$&. When this option is
4256 present, Exim does not attempt to look up a host name from an IP address; it
4257 uses the name it is given.
4258
4259 .vitem &%-oMt%&&~<&'ident&~string'&>
4260 .oindex "&%-oMt%&"
4261 .cindex "sender" "ident string, specifying for local message"
4262 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4263 option sets the sender ident value in &$sender_ident$&. The default setting for
4264 local callers is the login id of the calling process, except when &%-bh%& is
4265 used, when there is no default.
4266
4267 .vitem &%-om%&
4268 .oindex "&%-om%&"
4269 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4270 In Sendmail, this option means &"me too"&, indicating that the sender of a
4271 message should receive a copy of the message if the sender appears in an alias
4272 expansion. Exim always does this, so the option does nothing.
4273
4274 .vitem &%-oo%&
4275 .oindex "&%-oo%&"
4276 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4277 This option is ignored. In Sendmail it specifies &"old style headers"&,
4278 whatever that means.
4279
4280 .vitem &%-oP%&&~<&'path'&>
4281 .oindex "&%-oP%&"
4282 .cindex "pid (process id)" "of daemon"
4283 .cindex "daemon" "process id (pid)"
4284 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4285 value. The option specifies the file to which the process id of the daemon is
4286 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4287 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4288 because in those cases, the normal pid file is not used.
4289
4290 .vitem &%-or%&&~<&'time'&>
4291 .oindex "&%-or%&"
4292 .cindex "timeout" "for non-SMTP input"
4293 This option sets a timeout value for incoming non-SMTP messages. If it is not
4294 set, Exim will wait forever for the standard input. The value can also be set
4295 by the &%receive_timeout%& option. The format used for specifying times is
4296 described in section &<<SECTtimeformat>>&.
4297
4298 .vitem &%-os%&&~<&'time'&>
4299 .oindex "&%-os%&"
4300 .cindex "timeout" "for SMTP input"
4301 .cindex "SMTP" "input timeout"
4302 This option sets a timeout value for incoming SMTP messages. The timeout
4303 applies to each SMTP command and block of data. The value can also be set by
4304 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4305 for specifying times is described in section &<<SECTtimeformat>>&.
4306
4307 .vitem &%-ov%&
4308 .oindex "&%-ov%&"
4309 This option has exactly the same effect as &%-v%&.
4310
4311 .vitem &%-oX%&&~<&'number&~or&~string'&>
4312 .oindex "&%-oX%&"
4313 .cindex "TCP/IP" "setting listening ports"
4314 .cindex "TCP/IP" "setting listening interfaces"
4315 .cindex "port" "receiving TCP/IP"
4316 This option is relevant only when the &%-bd%& (start listening daemon) option
4317 is also given. It controls which ports and interfaces the daemon uses. Details
4318 of the syntax, and how it interacts with configuration file options, are given
4319 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4320 file is written unless &%-oP%& is also present to specify a pid file name.
4321
4322 .vitem &%-pd%&
4323 .oindex "&%-pd%&"
4324 .cindex "Perl" "starting the interpreter"
4325 This option applies when an embedded Perl interpreter is linked with Exim (see
4326 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4327 option, forcing the starting of the interpreter to be delayed until it is
4328 needed.
4329
4330 .vitem &%-ps%&
4331 .oindex "&%-ps%&"
4332 .cindex "Perl" "starting the interpreter"
4333 This option applies when an embedded Perl interpreter is linked with Exim (see
4334 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4335 option, forcing the starting of the interpreter to occur as soon as Exim is
4336 started.
4337
4338 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4339 .oindex "&%-p%&"
4340 For compatibility with Sendmail, this option is equivalent to
4341 .display
4342 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4343 .endd
4344 It sets the incoming protocol and host name (for trusted callers). The
4345 host name and its colon can be omitted when only the protocol is to be set.
4346 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4347 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4348 or &`s`& using this option (but that does not seem a real limitation).
4349
4350 .vitem &%-q%&
4351 .oindex "&%-q%&"
4352 .cindex "queue runner" "starting manually"
4353 This option is normally restricted to admin users. However, there is a
4354 configuration option called &%prod_requires_admin%& which can be set false to
4355 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4356 and &%-S%& options).
4357
4358 .cindex "queue runner" "description of operation"
4359 The &%-q%& option starts one queue runner process. This scans the queue of
4360 waiting messages, and runs a delivery process for each one in turn. It waits
4361 for each delivery process to finish before starting the next one. A delivery
4362 process may not actually do any deliveries if the retry times for the addresses
4363 have not been reached. Use &%-qf%& (see below) if you want to override this.
4364
4365 If
4366 .cindex "SMTP" "passed connection"
4367 .cindex "SMTP" "multiple deliveries"
4368 .cindex "multiple SMTP deliveries"
4369 the delivery process spawns other processes to deliver other messages down
4370 passed SMTP connections, the queue runner waits for these to finish before
4371 proceeding.
4372
4373 When all the queued messages have been considered, the original queue runner
4374 process terminates. In other words, a single pass is made over the waiting
4375 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4376 this to be repeated periodically.
4377
4378 Exim processes the waiting messages in an unpredictable order. It isn't very
4379 random, but it is likely to be different each time, which is all that matters.
4380 If one particular message screws up a remote MTA, other messages to the same
4381 MTA have a chance of getting through if they get tried first.
4382
4383 It is possible to cause the messages to be processed in lexical message id
4384 order, which is essentially the order in which they arrived, by setting the
4385 &%queue_run_in_order%& option, but this is not recommended for normal use.
4386
4387 .vitem &%-q%&<&'qflags'&>
4388 The &%-q%& option may be followed by one or more flag letters that change its
4389 behaviour. They are all optional, but if more than one is present, they must
4390 appear in the correct order. Each flag is described in a separate item below.
4391
4392 .vitem &%-qq...%&
4393 .oindex "&%-qq%&"
4394 .cindex "queue" "double scanning"
4395 .cindex "queue" "routing"
4396 .cindex "routing" "whole queue before delivery"
4397 An option starting with &%-qq%& requests a two-stage queue run. In the first
4398 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4399 every domain. Addresses are routed, local deliveries happen, but no remote
4400 transports are run.
4401
4402 .cindex "hints database" "remembering routing"
4403 The hints database that remembers which messages are waiting for specific hosts
4404 is updated, as if delivery to those hosts had been deferred. After this is
4405 complete, a second, normal queue scan happens, with routing and delivery taking
4406 place as normal. Messages that are routed to the same host should mostly be
4407 delivered down a single SMTP
4408 .cindex "SMTP" "passed connection"
4409 .cindex "SMTP" "multiple deliveries"
4410 .cindex "multiple SMTP deliveries"
4411 connection because of the hints that were set up during the first queue scan.
4412 This option may be useful for hosts that are connected to the Internet
4413 intermittently.
4414
4415 .vitem &%-q[q]i...%&
4416 .oindex "&%-qi%&"
4417 .cindex "queue" "initial delivery"
4418 If the &'i'& flag is present, the queue runner runs delivery processes only for
4419 those messages that haven't previously been tried. (&'i'& stands for &"initial
4420 delivery"&.) This can be helpful if you are putting messages on the queue using
4421 &%-odq%& and want a queue runner just to process the new messages.
4422
4423 .vitem &%-q[q][i]f...%&
4424 .oindex "&%-qf%&"
4425 .cindex "queue" "forcing delivery"
4426 .cindex "delivery" "forcing in queue run"
4427 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4428 message, whereas without &'f'& only those non-frozen addresses that have passed
4429 their retry times are tried.
4430
4431 .vitem &%-q[q][i]ff...%&
4432 .oindex "&%-qff%&"
4433 .cindex "frozen messages" "forcing delivery"
4434 If &'ff'& is present, a delivery attempt is forced for every message, whether
4435 frozen or not.
4436
4437 .vitem &%-q[q][i][f[f]]l%&
4438 .oindex "&%-ql%&"
4439 .cindex "queue" "local deliveries only"
4440 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4441 be done. If a message requires any remote deliveries, it remains on the queue
4442 for later delivery.
4443
4444 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4445 .cindex "queue" "delivering specific messages"
4446 When scanning the queue, Exim can be made to skip over messages whose ids are
4447 lexically less than a given value by following the &%-q%& option with a
4448 starting message id. For example:
4449 .code
4450 exim -q 0t5C6f-0000c8-00
4451 .endd
4452 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4453 second message id is given, messages whose ids are lexically greater than it
4454 are also skipped. If the same id is given twice, for example,
4455 .code
4456 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4457 .endd
4458 just one delivery process is started, for that message. This differs from
4459 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4460 that it counts as a delivery from a queue run. Note that the selection
4461 mechanism does not affect the order in which the messages are scanned. There
4462 are also other ways of selecting specific sets of messages for delivery in a
4463 queue run &-- see &%-R%& and &%-S%&.
4464
4465 .vitem &%-q%&<&'qflags'&><&'time'&>
4466 .cindex "queue runner" "starting periodically"
4467 .cindex "periodic queue running"
4468 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4469 starting a queue runner process at intervals specified by the given time value
4470 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4471 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4472 single daemon process handles both functions. A common way of starting up a
4473 combined daemon at system boot time is to use a command such as
4474 .code
4475 /usr/exim/bin/exim -bd -q30m
4476 .endd
4477 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4478 process every 30 minutes.
4479
4480 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4481 pid file is written unless one is explicitly requested by the &%-oP%& option.
4482
4483 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4484 .oindex "&%-qR%&"
4485 This option is synonymous with &%-R%&. It is provided for Sendmail
4486 compatibility.
4487
4488 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4489 .oindex "&%-qS%&"
4490 This option is synonymous with &%-S%&.
4491
4492 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4493 .oindex "&%-R%&"
4494 .cindex "queue runner" "for specific recipients"
4495 .cindex "delivery" "to given domain"
4496 .cindex "domain" "delivery to"
4497 The <&'rsflags'&> may be empty, in which case the white space before the string
4498 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4499 which are the possible values for <&'rsflags'&>. White space is required if
4500 <&'rsflags'&> is not empty.
4501
4502 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4503 perform a single queue run, except that, when scanning the messages on the
4504 queue, Exim processes only those that have at least one undelivered recipient
4505 address containing the given string, which is checked in a case-independent
4506 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4507 regular expression; otherwise it is a literal string.
4508
4509 If you want to do periodic queue runs for messages with specific recipients,
4510 you can combine &%-R%& with &%-q%& and a time value. For example:
4511 .code
4512 exim -q25m -R @special.domain.example
4513 .endd
4514 This example does a queue run for messages with recipients in the given domain
4515 every 25 minutes. Any additional flags that are specified with &%-q%& are
4516 applied to each queue run.
4517
4518 Once a message is selected for delivery by this mechanism, all its addresses
4519 are processed. For the first selected message, Exim overrides any retry
4520 information and forces a delivery attempt for each undelivered address. This
4521 means that if delivery of any address in the first message is successful, any
4522 existing retry information is deleted, and so delivery attempts for that
4523 address in subsequently selected messages (which are processed without forcing)
4524 will run. However, if delivery of any address does not succeed, the retry
4525 information is updated, and in subsequently selected messages, the failing
4526 address will be skipped.
4527
4528 .cindex "frozen messages" "forcing delivery"
4529 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4530 all selected messages, not just the first; frozen messages are included when
4531 &'ff'& is present.
4532
4533 The &%-R%& option makes it straightforward to initiate delivery of all messages
4534 to a given domain after a host has been down for some time. When the SMTP
4535 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4536 effect is to run Exim with the &%-R%& option, but it can be configured to run
4537 an arbitrary command instead.
4538
4539 .vitem &%-r%&
4540 .oindex "&%-r%&"
4541 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4542
4543 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4544 .oindex "&%-S%&"
4545 .cindex "delivery" "from given sender"
4546 .cindex "queue runner" "for specific senders"
4547 This option acts like &%-R%& except that it checks the string against each
4548 message's sender instead of against the recipients. If &%-R%& is also set, both
4549 conditions must be met for a message to be selected. If either of the options
4550 has &'f'& or &'ff'& in its flags, the associated action is taken.
4551
4552 .vitem &%-Tqt%&&~<&'times'&>
4553 .oindex "&%-Tqt%&"
4554 This is an option that is exclusively for use by the Exim testing suite. It is not
4555 recognized when Exim is run normally. It allows for the setting up of explicit
4556 &"queue times"& so that various warning/retry features can be tested.
4557
4558 .vitem &%-t%&
4559 .oindex "&%-t%&"
4560 .cindex "recipient" "extracting from header lines"
4561 .cindex "&'Bcc:'& header line"
4562 .cindex "&'Cc:'& header line"
4563 .cindex "&'To:'& header line"
4564 When Exim is receiving a locally-generated, non-SMTP message on its standard
4565 input, the &%-t%& option causes the recipients of the message to be obtained
4566 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4567 from the command arguments. The addresses are extracted before any rewriting
4568 takes place and the &'Bcc:'& header line, if present, is then removed.
4569
4570 .cindex "Sendmail compatibility" "&%-t%& option"
4571 If the command has any arguments, they specify addresses to which the message
4572 is &'not'& to be delivered. That is, the argument addresses are removed from
4573 the recipients list obtained from the headers. This is compatible with Smail 3
4574 and in accordance with the documented behaviour of several versions of
4575 Sendmail, as described in man pages on a number of operating systems (e.g.
4576 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4577 argument addresses to those obtained from the headers, and the O'Reilly
4578 Sendmail book documents it that way. Exim can be made to add argument addresses
4579 instead of subtracting them by setting the option
4580 &%extract_addresses_remove_arguments%& false.
4581
4582 .cindex "&%Resent-%& header lines" "with &%-t%&"
4583 If there are any &%Resent-%& header lines in the message, Exim extracts
4584 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4585 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4586 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4587 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4588
4589 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4590 message is resent several times). The RFC also specifies that they should be
4591 added at the front of the message, and separated by &'Received:'& lines. It is
4592 not at all clear how &%-t%& should operate in the present of multiple sets,
4593 nor indeed exactly what constitutes a &"set"&.
4594 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4595 are often added at the end of the header, and if a message is resent more than
4596 once, it is common for the original set of &%Resent-%& headers to be renamed as
4597 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4598
4599 .vitem &%-ti%&
4600 .oindex "&%-ti%&"
4601 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4602 compatibility with Sendmail.
4603
4604 .vitem &%-tls-on-connect%&
4605 .oindex "&%-tls-on-connect%&"
4606 .cindex "TLS" "use without STARTTLS"
4607 .cindex "TLS" "automatic start"
4608 This option is available when Exim is compiled with TLS support. It forces all
4609 incoming SMTP connections to behave as if the incoming port is listed in the
4610 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4611 &<<CHAPTLS>>& for further details.
4612
4613
4614 .vitem &%-U%&
4615 .oindex "&%-U%&"
4616 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4617 Sendmail uses this option for &"initial message submission"&, and its
4618 documentation states that in future releases, it may complain about
4619 syntactically invalid messages rather than fixing them when this flag is not
4620 set. Exim ignores this option.
4621
4622 .vitem &%-v%&
4623 .oindex "&%-v%&"
4624 This option causes Exim to write information to the standard error stream,
4625 describing what it is doing. In particular, it shows the log lines for
4626 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4627 dialogue is shown. Some of the log lines shown may not actually be written to
4628 the log if the setting of &%log_selector%& discards them. Any relevant
4629 selectors are shown with each log line. If none are shown, the logging is
4630 unconditional.
4631
4632 .vitem &%-x%&
4633 .oindex "&%-x%&"
4634 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4635 National Language Support extended characters in the body of the mail item"&).
4636 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4637 this option.
4638
4639 .vitem &%-X%&&~<&'logfile'&>
4640 .oindex "&%-X%&"
4641 This option is interpreted by Sendmail to cause debug information to be sent
4642 to the named file.  It is ignored by Exim.
4643 .endlist
4644
4645 .ecindex IIDclo1
4646 .ecindex IIDclo2
4647
4648
4649 . ////////////////////////////////////////////////////////////////////////////
4650 . Insert a stylized DocBook comment here, to identify the end of the command
4651 . line options. This is for the benefit of the Perl script that automatically
4652 . creates a man page for the options.
4653 . ////////////////////////////////////////////////////////////////////////////
4654
4655 .literal xml
4656 <!-- === End of command line options === -->
4657 .literal off
4658
4659
4660
4661
4662
4663 . ////////////////////////////////////////////////////////////////////////////
4664 . ////////////////////////////////////////////////////////////////////////////
4665
4666
4667 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4668          "The runtime configuration file"
4669
4670 .cindex "run time configuration"
4671 .cindex "configuration file" "general description"
4672 .cindex "CONFIGURE_FILE"
4673 .cindex "configuration file" "errors in"
4674 .cindex "error" "in configuration file"
4675 .cindex "return code" "for bad configuration"
4676 Exim uses a single run time configuration file that is read whenever an Exim
4677 binary is executed. Note that in normal operation, this happens frequently,
4678 because Exim is designed to operate in a distributed manner, without central
4679 control.
4680
4681 If a syntax error is detected while reading the configuration file, Exim
4682 writes a message on the standard error, and exits with a non-zero return code.
4683 The message is also written to the panic log. &*Note*&: Only simple syntax
4684 errors can be detected at this time. The values of any expanded options are
4685 not checked until the expansion happens, even when the expansion does not
4686 actually alter the string.
4687
4688 The name of the configuration file is compiled into the binary for security
4689 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4690 most configurations, this specifies a single file. However, it is permitted to
4691 give a colon-separated list of file names, in which case Exim uses the first
4692 existing file in the list.
4693
4694 .cindex "EXIM_USER"
4695 .cindex "EXIM_GROUP"
4696 .cindex "CONFIGURE_OWNER"
4697 .cindex "CONFIGURE_GROUP"
4698 .cindex "configuration file" "ownership"
4699 .cindex "ownership" "configuration file"
4700 The run time configuration file must be owned by root or by the user that is
4701 specified at compile time by the CONFIGURE_OWNER option (if set). The
4702 configuration file must not be world-writeable, or group-writeable unless its
4703 group is the root group or the one specified at compile time by the
4704 CONFIGURE_GROUP option.
4705
4706 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4707 to root, anybody who is able to edit the run time configuration file has an
4708 easy way to run commands as root. If you specify a user or group in the
4709 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4710 who are members of that group will trivially be able to obtain root privileges.
4711
4712 Up to Exim version 4.72, the run time configuration file was also permitted to
4713 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4714 since it offered a simple privilege escalation for any attacker who managed to
4715 compromise the Exim user account.
4716
4717 A default configuration file, which will work correctly in simple situations,
4718 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4719 defines just one file name, the installation process copies the default
4720 configuration to a new file of that name if it did not previously exist. If
4721 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4722 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4723 configuration.
4724
4725
4726
4727 .section "Using a different configuration file" "SECID40"
4728 .cindex "configuration file" "alternate"
4729 A one-off alternate configuration can be specified by the &%-C%& command line
4730 option, which may specify a single file or a list of files. However, when
4731 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4732 unless the argument for &%-C%& is identical to the built-in value from
4733 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4734 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4735 is useful mainly for checking the syntax of configuration files before
4736 installing them. No owner or group checks are done on a configuration file
4737 specified by &%-C%&, if root privilege has been dropped.
4738
4739 Even the Exim user is not trusted to specify an arbitrary configuration file
4740 with the &%-C%& option to be used with root privileges, unless that file is
4741 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4742 testing a configuration using &%-C%& right through message reception and
4743 delivery, even if the caller is root. The reception works, but by that time,
4744 Exim is running as the Exim user, so when it re-execs to regain privilege for
4745 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4746 can test reception and delivery using two separate commands (one to put a
4747 message on the queue, using &%-odq%&, and another to do the delivery, using
4748 &%-M%&).
4749
4750 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4751 prefix string with which any file named in a &%-C%& command line option must
4752 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4753 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4754 name can be used with &%-C%&.
4755
4756 One-off changes to a configuration can be specified by the &%-D%& command line
4757 option, which defines and overrides values for macros used inside the
4758 configuration file. However, like &%-C%&, the use of this option by a
4759 non-privileged user causes Exim to discard its root privilege.
4760 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4761 completely disabled, and its use causes an immediate error exit.
4762
4763 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4764 to declare certain macro names trusted, such that root privilege will not
4765 necessarily be discarded.
4766 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4767 considered safe and, if &%-D%& only supplies macros from this list, and the
4768 values are acceptable, then Exim will not give up root privilege if the caller
4769 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4770 transition mechanism and is expected to be removed in the future.  Acceptable
4771 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4772
4773 Some sites may wish to use the same Exim binary on different machines that
4774 share a file system, but to use different configuration files on each machine.
4775 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4776 looks for a file whose name is the configuration file name followed by a dot
4777 and the machine's node name, as obtained from the &[uname()]& function. If this
4778 file does not exist, the standard name is tried. This processing occurs for
4779 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4780
4781 In some esoteric situations different versions of Exim may be run under
4782 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4783 help with this. See the comments in &_src/EDITME_& for details.
4784
4785
4786
4787 .section "Configuration file format" "SECTconffilfor"
4788 .cindex "configuration file" "format of"
4789 .cindex "format" "configuration file"
4790 Exim's configuration file is divided into a number of different parts. General
4791 option settings must always appear at the start of the file. The other parts
4792 are all optional, and may appear in any order. Each part other than the first
4793 is introduced by the word &"begin"& followed by the name of the part. The
4794 optional parts are:
4795
4796 .ilist
4797 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4798 &<<CHAPACL>>&).
4799 .next
4800 .cindex "AUTH" "configuration"
4801 &'authenticators'&: Configuration settings for the authenticator drivers. These
4802 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4803 .next
4804 &'routers'&: Configuration settings for the router drivers. Routers process
4805 addresses and determine how the message is to be delivered (see chapters
4806 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4807 .next
4808 &'transports'&: Configuration settings for the transport drivers. Transports
4809 define mechanisms for copying messages to destinations (see chapters
4810 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4811 .next
4812 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4813 If there is no retry section, or if it is empty (that is, no retry rules are
4814 defined), Exim will not retry deliveries. In this situation, temporary errors
4815 are treated the same as permanent errors. Retry rules are discussed in chapter
4816 &<<CHAPretry>>&.
4817 .next
4818 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4819 when new addresses are generated during delivery. Rewriting is discussed in
4820 chapter &<<CHAPrewrite>>&.
4821 .next
4822 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4823 want to use this feature, you must set
4824 .code
4825 LOCAL_SCAN_HAS_OPTIONS=yes
4826 .endd
4827 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4828 facility are given in chapter &<<CHAPlocalscan>>&.
4829 .endlist
4830
4831 .cindex "configuration file" "leading white space in"
4832 .cindex "configuration file" "trailing white space in"
4833 .cindex "white space" "in configuration file"
4834 Leading and trailing white space in configuration lines is always ignored.
4835
4836 Blank lines in the file, and lines starting with a # character (ignoring
4837 leading white space) are treated as comments and are ignored. &*Note*&: A
4838 # character other than at the beginning of a line is not treated specially,
4839 and does not introduce a comment.
4840
4841 Any non-comment line can be continued by ending it with a backslash. Note that
4842 the general rule for white space means that trailing white space after the
4843 backslash and leading white space at the start of continuation
4844 lines is ignored. Comment lines beginning with # (but not empty lines) may
4845 appear in the middle of a sequence of continuation lines.
4846
4847 A convenient way to create a configuration file is to start from the
4848 default, which is supplied in &_src/configure.default_&, and add, delete, or
4849 change settings as required.
4850
4851 The ACLs, retry rules, and rewriting rules have their own syntax which is
4852 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4853 respectively. The other parts of the configuration file have some syntactic
4854 items in common, and these are described below, from section &<<SECTcos>>&
4855 onwards. Before that, the inclusion, macro, and conditional facilities are
4856 described.
4857
4858
4859
4860 .section "File inclusions in the configuration file" "SECID41"
4861 .cindex "inclusions in configuration file"
4862 .cindex "configuration file" "including other files"
4863 .cindex "&`.include`& in configuration file"
4864 .cindex "&`.include_if_exists`& in configuration file"
4865 You can include other files inside Exim's run time configuration file by
4866 using this syntax:
4867 .display
4868 &`.include`& <&'file name'&>
4869 &`.include_if_exists`& <&'file name'&>
4870 .endd
4871 on a line by itself. Double quotes round the file name are optional. If you use
4872 the first form, a configuration error occurs if the file does not exist; the
4873 second form does nothing for non-existent files. In all cases, an absolute file
4874 name is required.
4875
4876 Includes may be nested to any depth, but remember that Exim reads its
4877 configuration file often, so it is a good idea to keep them to a minimum.
4878 If you change the contents of an included file, you must HUP the daemon,
4879 because an included file is read only when the configuration itself is read.
4880
4881 The processing of inclusions happens early, at a physical line level, so, like
4882 comment lines, an inclusion can be used in the middle of an option setting,
4883 for example:
4884 .code
4885 hosts_lookup = a.b.c \
4886                .include /some/file
4887 .endd
4888 Include processing happens after macro processing (see below). Its effect is to
4889 process the lines of the included file as if they occurred inline where the
4890 inclusion appears.
4891
4892
4893
4894 .section "Macros in the configuration file" "SECTmacrodefs"
4895 .cindex "macro" "description of"
4896 .cindex "configuration file" "macros"
4897 If a line in the main part of the configuration (that is, before the first
4898 &"begin"& line) begins with an upper case letter, it is taken as a macro
4899 definition, and must be of the form
4900 .display
4901 <&'name'&> = <&'rest of line'&>
4902 .endd
4903 The name must consist of letters, digits, and underscores, and need not all be
4904 in upper case, though that is recommended. The rest of the line, including any
4905 continuations, is the replacement text, and has leading and trailing white
4906 space removed. Quotes are not removed. The replacement text can never end with
4907 a backslash character, but this doesn't seem to be a serious limitation.
4908
4909 Macros may also be defined between router, transport, authenticator, or ACL
4910 definitions. They may not, however, be defined within an individual driver or
4911 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4912
4913 .section "Macro substitution" "SECID42"
4914 Once a macro is defined, all subsequent lines in the file (and any included
4915 files) are scanned for the macro name; if there are several macros, the line is
4916 scanned for each in turn, in the order in which the macros are defined. The
4917 replacement text is not re-scanned for the current macro, though it is scanned
4918 for subsequently defined macros. For this reason, a macro name may not contain
4919 the name of a previously defined macro as a substring. You could, for example,
4920 define
4921 .display
4922 &`ABCD_XYZ = `&<&'something'&>
4923 &`ABCD = `&<&'something else'&>
4924 .endd
4925 but putting the definitions in the opposite order would provoke a configuration
4926 error. Macro expansion is applied to individual physical lines from the file,
4927 before checking for line continuation or file inclusion (see above). If a line
4928 consists solely of a macro name, and the expansion of the macro is empty, the
4929 line is ignored. A macro at the start of a line may turn the line into a
4930 comment line or a &`.include`& line.
4931
4932
4933 .section "Redefining macros" "SECID43"
4934 Once defined, the value of a macro can be redefined later in the configuration
4935 (or in an included file). Redefinition is specified by using &'=='& instead of
4936 &'='&. For example:
4937 .code
4938 MAC =  initial value
4939 ...
4940 MAC == updated value
4941 .endd
4942 Redefinition does not alter the order in which the macros are applied to the
4943 subsequent lines of the configuration file. It is still the same order in which
4944 the macros were originally defined. All that changes is the macro's value.
4945 Redefinition makes it possible to accumulate values. For example:
4946 .code
4947 MAC =  initial value
4948 ...
4949 MAC == MAC and something added
4950 .endd
4951 This can be helpful in situations where the configuration file is built
4952 from a number of other files.
4953
4954 .section "Overriding macro values" "SECID44"
4955 The values set for macros in the configuration file can be overridden by the
4956 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4957 used, unless called by root or the Exim user. A definition on the command line
4958 using the &%-D%& option causes all definitions and redefinitions within the
4959 file to be ignored.
4960
4961
4962
4963 .section "Example of macro usage" "SECID45"
4964 As an example of macro usage, consider a configuration where aliases are looked
4965 up in a MySQL database. It helps to keep the file less cluttered if long
4966 strings such as SQL statements are defined separately as macros, for example:
4967 .code
4968 ALIAS_QUERY = select mailbox from user where \
4969               login='${quote_mysql:$local_part}';
4970 .endd
4971 This can then be used in a &(redirect)& router setting like this:
4972 .code
4973 data = ${lookup mysql{ALIAS_QUERY}}
4974 .endd
4975 In earlier versions of Exim macros were sometimes used for domain, host, or
4976 address lists. In Exim 4 these are handled better by named lists &-- see
4977 section &<<SECTnamedlists>>&.
4978
4979
4980 .section "Conditional skips in the configuration file" "SECID46"
4981 .cindex "configuration file" "conditional skips"
4982 .cindex "&`.ifdef`&"
4983 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4984 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4985 portions of the configuration file. The processing happens whenever the file is
4986 read (that is, when an Exim binary starts to run).
4987
4988 The implementation is very simple. Instances of the first four directives must
4989 be followed by text that includes the names of one or macros. The condition
4990 that is tested is whether or not any macro substitution has taken place in the
4991 line. Thus:
4992 .code
4993 .ifdef AAA
4994 message_size_limit = 50M
4995 .else
4996 message_size_limit = 100M
4997 .endif
4998 .endd
4999 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5000 otherwise. If there is more than one macro named on the line, the condition
5001 is true if any of them are defined. That is, it is an &"or"& condition. To
5002 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5003
5004 Although you can use a macro expansion to generate one of these directives,
5005 it is not very useful, because the condition &"there was a macro substitution
5006 in this line"& will always be true.
5007
5008 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5009 to clarify complicated nestings.
5010
5011
5012
5013 .section "Common option syntax" "SECTcos"
5014 .cindex "common option syntax"
5015 .cindex "syntax of common options"
5016 .cindex "configuration file" "common option syntax"
5017 For the main set of options, driver options, and &[local_scan()]& options,
5018 each setting is on a line by itself, and starts with a name consisting of
5019 lower-case letters and underscores. Many options require a data value, and in
5020 these cases the name must be followed by an equals sign (with optional white
5021 space) and then the value. For example:
5022 .code
5023 qualify_domain = mydomain.example.com
5024 .endd
5025 .cindex "hiding configuration option values"
5026 .cindex "configuration options" "hiding value of"
5027 .cindex "options" "hiding value of"
5028 Some option settings may contain sensitive data, for example, passwords for
5029 accessing databases. To stop non-admin users from using the &%-bP%& command
5030 line option to read these values, you can precede the option settings with the
5031 word &"hide"&. For example:
5032 .code
5033 hide mysql_servers = localhost/users/admin/secret-password
5034 .endd
5035 For non-admin users, such options are displayed like this:
5036 .code
5037 mysql_servers = <value not displayable>
5038 .endd
5039 If &"hide"& is used on a driver option, it hides the value of that option on
5040 all instances of the same driver.
5041
5042 The following sections describe the syntax used for the different data types
5043 that are found in option settings.
5044
5045
5046 .section "Boolean options" "SECID47"
5047 .cindex "format" "boolean"
5048 .cindex "boolean configuration values"
5049 .oindex "&%no_%&&'xxx'&"
5050 .oindex "&%not_%&&'xxx'&"
5051 Options whose type is given as boolean are on/off switches. There are two
5052 different ways of specifying such options: with and without a data value. If
5053 the option name is specified on its own without data, the switch is turned on;
5054 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5055 boolean options may be followed by an equals sign and one of the words
5056 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5057 the following two settings have exactly the same effect:
5058 .code
5059 queue_only
5060 queue_only = true
5061 .endd
5062 The following two lines also have the same (opposite) effect:
5063 .code
5064 no_queue_only
5065 queue_only = false
5066 .endd
5067 You can use whichever syntax you prefer.
5068
5069
5070
5071
5072 .section "Integer values" "SECID48"
5073 .cindex "integer configuration values"
5074 .cindex "format" "integer"
5075 If an option's type is given as &"integer"&, the value can be given in decimal,
5076 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5077 number is assumed. Otherwise, it is treated as an octal number unless it starts
5078 with the characters &"0x"&, in which case the remainder is interpreted as a
5079 hexadecimal number.
5080
5081 If an integer value is followed by the letter K, it is multiplied by 1024; if
5082 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5083 of integer option settings are output, values which are an exact multiple of
5084 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5085 and M. The printing style is independent of the actual input format that was
5086 used.
5087
5088
5089 .section "Octal integer values" "SECID49"
5090 .cindex "integer format"
5091 .cindex "format" "octal integer"
5092 If an option's type is given as &"octal integer"&, its value is always
5093 interpreted as an octal number, whether or not it starts with the digit zero.
5094 Such options are always output in octal.
5095
5096
5097 .section "Fixed point numbers" "SECID50"
5098 .cindex "fixed point configuration values"
5099 .cindex "format" "fixed point"
5100 If an option's type is given as &"fixed-point"&, its value must be a decimal
5101 integer, optionally followed by a decimal point and up to three further digits.
5102
5103
5104
5105 .section "Time intervals" "SECTtimeformat"
5106 .cindex "time interval" "specifying in configuration"
5107 .cindex "format" "time interval"
5108 A time interval is specified as a sequence of numbers, each followed by one of
5109 the following letters, with no intervening white space:
5110
5111 .table2 30pt
5112 .irow &%s%& seconds
5113 .irow &%m%& minutes
5114 .irow &%h%& hours
5115 .irow &%d%& days
5116 .irow &%w%& weeks
5117 .endtable
5118
5119 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5120 intervals are output in the same format. Exim does not restrict the values; it
5121 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5122
5123
5124
5125 .section "String values" "SECTstrings"
5126 .cindex "string" "format of configuration values"
5127 .cindex "format" "string"
5128 If an option's type is specified as &"string"&, the value can be specified with
5129 or without double-quotes. If it does not start with a double-quote, the value
5130 consists of the remainder of the line plus any continuation lines, starting at
5131 the first character after any leading white space, with trailing white space
5132 removed, and with no interpretation of the characters in the string. Because
5133 Exim removes comment lines (those beginning with #) at an early stage, they can
5134 appear in the middle of a multi-line string. The following two settings are
5135 therefore equivalent:
5136 .code
5137 trusted_users = uucp:mail
5138 trusted_users = uucp:\
5139                 # This comment line is ignored
5140                 mail
5141 .endd
5142 .cindex "string" "quoted"
5143 .cindex "escape characters in quoted strings"
5144 If a string does start with a double-quote, it must end with a closing
5145 double-quote, and any backslash characters other than those used for line
5146 continuation are interpreted as escape characters, as follows:
5147
5148 .table2 100pt
5149 .irow &`\\`&                     "single backslash"
5150 .irow &`\n`&                     "newline"
5151 .irow &`\r`&                     "carriage return"
5152 .irow &`\t`&                     "tab"
5153 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5154 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5155                                    character"
5156 .endtable
5157
5158 If a backslash is followed by some other character, including a double-quote
5159 character, that character replaces the pair.
5160
5161 Quoting is necessary only if you want to make use of the backslash escapes to
5162 insert special characters, or if you need to specify a value with leading or
5163 trailing spaces. These cases are rare, so quoting is almost never needed in
5164 current versions of Exim. In versions of Exim before 3.14, quoting was required
5165 in order to continue lines, so you may come across older configuration files
5166 and examples that apparently quote unnecessarily.
5167
5168
5169 .section "Expanded strings" "SECID51"
5170 .cindex "expansion" "definition of"
5171 Some strings in the configuration file are subjected to &'string expansion'&,
5172 by which means various parts of the string may be changed according to the
5173 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5174 is as just described; in particular, the handling of backslashes in quoted
5175 strings is done as part of the input process, before expansion takes place.
5176 However, backslash is also an escape character for the expander, so any
5177 backslashes that are required for that reason must be doubled if they are
5178 within a quoted configuration string.
5179
5180
5181 .section "User and group names" "SECID52"
5182 .cindex "user name" "format of"
5183 .cindex "format" "user name"
5184 .cindex "groups" "name format"
5185 .cindex "format" "group name"
5186 User and group names are specified as strings, using the syntax described
5187 above, but the strings are interpreted specially. A user or group name must
5188 either consist entirely of digits, or be a name that can be looked up using the
5189 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5190
5191
5192 .section "List construction" "SECTlistconstruct"
5193 .cindex "list" "syntax of in configuration"
5194 .cindex "format" "list item in configuration"
5195 .cindex "string" "list, definition of"
5196 The data for some configuration options is a list of items, with colon as the
5197 default separator. Many of these options are shown with type &"string list"& in
5198 the descriptions later in this document. Others are listed as &"domain list"&,
5199 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5200 are all the same; however, those other than &"string list"& are subject to
5201 particular kinds of interpretation, as described in chapter
5202 &<<CHAPdomhosaddlists>>&.
5203
5204 In all these cases, the entire list is treated as a single string as far as the
5205 input syntax is concerned. The &%trusted_users%& setting in section
5206 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5207 in a list, it must be entered as two colons. Leading and trailing white space
5208 on each item in a list is ignored. This makes it possible to include items that
5209 start with a colon, and in particular, certain forms of IPv6 address. For
5210 example, the list
5211 .code
5212 local_interfaces = 127.0.0.1 : ::::1
5213 .endd
5214 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5215
5216 &*Note*&: Although leading and trailing white space is ignored in individual
5217 list items, it is not ignored when parsing the list. The space after the first
5218 colon in the example above is necessary. If it were not there, the list would
5219 be interpreted as the two items 127.0.0.1:: and 1.
5220
5221 .section "Changing list separators" "SECID53"
5222 .cindex "list separator" "changing"
5223 .cindex "IPv6" "addresses in lists"
5224 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5225 introduced to allow the separator character to be changed. If a list begins
5226 with a left angle bracket, followed by any punctuation character, that
5227 character is used instead of colon as the list separator. For example, the list
5228 above can be rewritten to use a semicolon separator like this:
5229 .code
5230 local_interfaces = <; 127.0.0.1 ; ::1
5231 .endd
5232 This facility applies to all lists, with the exception of the list in
5233 &%log_file_path%&. It is recommended that the use of non-colon separators be
5234 confined to circumstances where they really are needed.
5235
5236 .cindex "list separator" "newline as"
5237 .cindex "newline" "as list separator"
5238 It is also possible to use newline and other control characters (those with
5239 code values less than 32, plus DEL) as separators in lists. Such separators
5240 must be provided literally at the time the list is processed. For options that
5241 are string-expanded, you can write the separator using a normal escape
5242 sequence. This will be processed by the expander before the string is
5243 interpreted as a list. For example, if a newline-separated list of domains is
5244 generated by a lookup, you can process it directly by a line such as this:
5245 .code
5246 domains = <\n ${lookup mysql{.....}}
5247 .endd
5248 This avoids having to change the list separator in such data. You are unlikely
5249 to want to use a control character as a separator in an option that is not
5250 expanded, because the value is literal text. However, it can be done by giving
5251 the value in quotes. For example:
5252 .code
5253 local_interfaces = "<\n 127.0.0.1 \n ::1"
5254 .endd
5255 Unlike printing character separators, which can be included in list items by
5256 doubling, it is not possible to include a control character as data when it is
5257 set as the separator. Two such characters in succession are interpreted as
5258 enclosing an empty list item.
5259
5260
5261
5262 .section "Empty items in lists" "SECTempitelis"
5263 .cindex "list" "empty item in"
5264 An empty item at the end of a list is always ignored. In other words, trailing
5265 separator characters are ignored. Thus, the list in
5266 .code
5267 senders = user@domain :
5268 .endd
5269 contains only a single item. If you want to include an empty string as one item
5270 in a list, it must not be the last item. For example, this list contains three
5271 items, the second of which is empty:
5272 .code
5273 senders = user1@domain : : user2@domain
5274 .endd
5275 &*Note*&: There must be white space between the two colons, as otherwise they
5276 are interpreted as representing a single colon data character (and the list
5277 would then contain just one item). If you want to specify a list that contains
5278 just one, empty item, you can do it as in this example:
5279 .code
5280 senders = :
5281 .endd
5282 In this case, the first item is empty, and the second is discarded because it
5283 is at the end of the list.
5284
5285
5286
5287
5288 .section "Format of driver configurations" "SECTfordricon"
5289 .cindex "drivers" "configuration format"
5290 There are separate parts in the configuration for defining routers, transports,
5291 and authenticators. In each part, you are defining a number of driver
5292 instances, each with its own set of options. Each driver instance is defined by
5293 a sequence of lines like this:
5294 .display
5295 <&'instance name'&>:
5296   <&'option'&>
5297   ...
5298   <&'option'&>
5299 .endd
5300 In the following example, the instance name is &(localuser)&, and it is
5301 followed by three options settings:
5302 .code
5303 localuser:
5304   driver = accept
5305   check_local_user
5306   transport = local_delivery
5307 .endd
5308 For each driver instance, you specify which Exim code module it uses &-- by the
5309 setting of the &%driver%& option &-- and (optionally) some configuration
5310 settings. For example, in the case of transports, if you want a transport to
5311 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5312 a local file you would use the &(appendfile)& driver. Each of the drivers is
5313 described in detail in its own separate chapter later in this manual.
5314
5315 You can have several routers, transports, or authenticators that are based on
5316 the same underlying driver (each must have a different instance name).
5317
5318 The order in which routers are defined is important, because addresses are
5319 passed to individual routers one by one, in order. The order in which
5320 transports are defined does not matter at all. The order in which
5321 authenticators are defined is used only when Exim, as a client, is searching
5322 them to find one that matches an authentication mechanism offered by the
5323 server.
5324
5325 .cindex "generic options"
5326 .cindex "options" "generic &-- definition of"
5327 Within a driver instance definition, there are two kinds of option: &'generic'&
5328 and &'private'&. The generic options are those that apply to all drivers of the
5329 same type (that is, all routers, all transports or all authenticators). The
5330 &%driver%& option is a generic option that must appear in every definition.
5331 .cindex "private options"
5332 The private options are special for each driver, and none need appear, because
5333 they all have default values.
5334
5335 The options may appear in any order, except that the &%driver%& option must
5336 precede any private options, since these depend on the particular driver. For
5337 this reason, it is recommended that &%driver%& always be the first option.
5338
5339 Driver instance names, which are used for reference in log entries and
5340 elsewhere, can be any sequence of letters, digits, and underscores (starting
5341 with a letter) and must be unique among drivers of the same type. A router and
5342 a transport (for example) can each have the same name, but no two router
5343 instances can have the same name. The name of a driver instance should not be
5344 confused with the name of the underlying driver module. For example, the
5345 configuration lines:
5346 .code
5347 remote_smtp:
5348   driver = smtp
5349 .endd
5350 create an instance of the &(smtp)& transport driver whose name is
5351 &(remote_smtp)&. The same driver code can be used more than once, with
5352 different instance names and different option settings each time. A second
5353 instance of the &(smtp)& transport, with different options, might be defined
5354 thus:
5355 .code
5356 special_smtp:
5357   driver = smtp
5358   port = 1234
5359   command_timeout = 10s
5360 .endd
5361 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5362 these transport instances from routers, and these names would appear in log
5363 lines.
5364
5365 Comment lines may be present in the middle of driver specifications. The full
5366 list of option settings for any particular driver instance, including all the
5367 defaulted values, can be extracted by making use of the &%-bP%& command line
5368 option.
5369
5370
5371
5372
5373
5374
5375 . ////////////////////////////////////////////////////////////////////////////
5376 . ////////////////////////////////////////////////////////////////////////////
5377
5378 .chapter "The default configuration file" "CHAPdefconfil"
5379 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5380 .cindex "default" "configuration file &""walk through""&"
5381 The default configuration file supplied with Exim as &_src/configure.default_&
5382 is sufficient for a host with simple mail requirements. As an introduction to
5383 the way Exim is configured, this chapter &"walks through"& the default
5384 configuration, giving brief explanations of the settings. Detailed descriptions
5385 of the options are given in subsequent chapters. The default configuration file
5386 itself contains extensive comments about ways you might want to modify the
5387 initial settings. However, note that there are many options that are not
5388 mentioned at all in the default configuration.
5389
5390
5391
5392 .section "Main configuration settings" "SECTdefconfmain"
5393 The main (global) configuration option settings must always come first in the
5394 file. The first thing you'll see in the file, after some initial comments, is
5395 the line
5396 .code
5397 # primary_hostname =
5398 .endd
5399 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5400 to know the official, fully qualified name of your host, and this is where you
5401 can specify it. However, in most cases you do not need to set this option. When
5402 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5403
5404 The first three non-comment configuration lines are as follows:
5405 .code
5406 domainlist local_domains    = @
5407 domainlist relay_to_domains =
5408 hostlist   relay_from_hosts = 127.0.0.1
5409 .endd
5410 These are not, in fact, option settings. They are definitions of two named
5411 domain lists and one named host list. Exim allows you to give names to lists of
5412 domains, hosts, and email addresses, in order to make it easier to manage the
5413 configuration file (see section &<<SECTnamedlists>>&).
5414
5415 The first line defines a domain list called &'local_domains'&; this is used
5416 later in the configuration to identify domains that are to be delivered
5417 on the local host.
5418
5419 .cindex "@ in a domain list"
5420 There is just one item in this list, the string &"@"&. This is a special form
5421 of entry which means &"the name of the local host"&. Thus, if the local host is
5422 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5423 be delivered locally. Because the local host's name is referenced indirectly,
5424 the same configuration file can be used on different hosts.
5425
5426 The second line defines a domain list called &'relay_to_domains'&, but the
5427 list itself is empty. Later in the configuration we will come to the part that
5428 controls mail relaying through the local host; it allows relaying to any
5429 domains in this list. By default, therefore, no relaying on the basis of a mail
5430 domain is permitted.
5431
5432 The third line defines a host list called &'relay_from_hosts'&. This list is
5433 used later in the configuration to permit relaying from any host or IP address
5434 that matches the list. The default contains just the IP address of the IPv4
5435 loopback interface, which means that processes on the local host are able to
5436 submit mail for relaying by sending it over TCP/IP to that interface. No other
5437 hosts are permitted to submit messages for relaying.
5438
5439 Just to be sure there's no misunderstanding: at this point in the configuration
5440 we aren't actually setting up any controls. We are just defining some domains
5441 and hosts that will be used in the controls that are specified later.
5442
5443 The next two configuration lines are genuine option settings:
5444 .code
5445 acl_smtp_rcpt = acl_check_rcpt
5446 acl_smtp_data = acl_check_data
5447 .endd
5448 These options specify &'Access Control Lists'& (ACLs) that are to be used
5449 during an incoming SMTP session for every recipient of a message (every RCPT
5450 command), and after the contents of the message have been received,
5451 respectively. The names of the lists are &'acl_check_rcpt'& and
5452 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5453 section of the configuration. The RCPT ACL controls which recipients are
5454 accepted for an incoming message &-- if a configuration does not provide an ACL
5455 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5456 contents of a message to be checked.
5457
5458 Two commented-out option settings are next:
5459 .code
5460 # av_scanner = clamd:/tmp/clamd
5461 # spamd_address = 127.0.0.1 783
5462 .endd
5463 These are example settings that can be used when Exim is compiled with the
5464 content-scanning extension. The first specifies the interface to the virus
5465 scanner, and the second specifies the interface to SpamAssassin. Further
5466 details are given in chapter &<<CHAPexiscan>>&.
5467
5468 Three more commented-out option settings follow:
5469 .code
5470 # tls_advertise_hosts = *
5471 # tls_certificate = /etc/ssl/exim.crt
5472 # tls_privatekey = /etc/ssl/exim.pem
5473 .endd
5474 These are example settings that can be used when Exim is compiled with
5475 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5476 first one specifies the list of clients that are allowed to use TLS when
5477 connecting to this server; in this case the wildcard means all clients. The
5478 other options specify where Exim should find its TLS certificate and private
5479 key, which together prove the server's identity to any clients that connect.
5480 More details are given in chapter &<<CHAPTLS>>&.
5481
5482 Another two commented-out option settings follow:
5483 .code
5484 # daemon_smtp_ports = 25 : 465 : 587
5485 # tls_on_connect_ports = 465
5486 .endd
5487 .cindex "port" "465 and 587"
5488 .cindex "port" "for message submission"
5489 .cindex "message" "submission, ports for"
5490 .cindex "ssmtp protocol"
5491 .cindex "smtps protocol"
5492 .cindex "SMTP" "ssmtp protocol"
5493 .cindex "SMTP" "smtps protocol"
5494 These options provide better support for roaming users who wish to use this
5495 server for message submission. They are not much use unless you have turned on
5496 TLS (as described in the previous paragraph) and authentication (about which
5497 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5498 on end-user networks, so RFC 4409 specifies that message submission should use
5499 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5500 configured to use port 587 correctly, so these settings also enable the
5501 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5502 &<<SECTsupobssmt>>&).
5503
5504 Two more commented-out options settings follow:
5505 .code
5506 # qualify_domain =
5507 # qualify_recipient =
5508 .endd
5509 The first of these specifies a domain that Exim uses when it constructs a
5510 complete email address from a local login name. This is often needed when Exim
5511 receives a message from a local process. If you do not set &%qualify_domain%&,
5512 the value of &%primary_hostname%& is used. If you set both of these options,
5513 you can have different qualification domains for sender and recipient
5514 addresses. If you set only the first one, its value is used in both cases.
5515
5516 .cindex "domain literal" "recognizing format"
5517 The following line must be uncommented if you want Exim to recognize
5518 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5519 (an IP address within square brackets) instead of a named domain.
5520 .code
5521 # allow_domain_literals
5522 .endd
5523 The RFCs still require this form, but many people think that in the modern
5524 Internet it makes little sense to permit mail to be sent to specific hosts by
5525 quoting their IP addresses. This ancient format has been used by people who
5526 try to abuse hosts by using them for unwanted relaying. However, some
5527 people believe there are circumstances (for example, messages addressed to
5528 &'postmaster'&) where domain literals are still useful.
5529
5530 The next configuration line is a kind of trigger guard:
5531 .code
5532 never_users = root
5533 .endd
5534 It specifies that no delivery must ever be run as the root user. The normal
5535 convention is to set up &'root'& as an alias for the system administrator. This
5536 setting is a guard against slips in the configuration.
5537 The list of users specified by &%never_users%& is not, however, the complete
5538 list; the build-time configuration in &_Local/Makefile_& has an option called
5539 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5540 contents of &%never_users%& are added to this list. By default
5541 FIXED_NEVER_USERS also specifies root.
5542
5543 When a remote host connects to Exim in order to send mail, the only information
5544 Exim has about the host's identity is its IP address. The next configuration
5545 line,
5546 .code
5547 host_lookup = *
5548 .endd
5549 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5550 in order to get a host name. This improves the quality of the logging
5551 information, but if you feel it is too expensive, you can remove it entirely,
5552 or restrict the lookup to hosts on &"nearby"& networks.
5553 Note that it is not always possible to find a host name from an IP address,
5554 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5555 unreachable.
5556
5557 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5558 1413 (hence their names):
5559 .code
5560 rfc1413_hosts = *
5561 rfc1413_query_timeout = 0s
5562 .endd
5563 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5564 Few hosts offer RFC1413 service these days; calls have to be
5565 terminated by a timeout and this needlessly delays the startup
5566 of an incoming SMTP connection.
5567 If you have hosts for which you trust RFC1413 and need this
5568 information, you can change this.
5569
5570 This line enables an efficiency SMTP option.  It is negociated by clients
5571 and not expected to cause problems but can be disabled if needed.
5572 .code
5573 prdr_enable = true
5574 .endd
5575
5576 When Exim receives messages over SMTP connections, it expects all addresses to
5577 be fully qualified with a domain, as required by the SMTP definition. However,
5578 if you are running a server to which simple clients submit messages, you may
5579 find that they send unqualified addresses. The two commented-out options:
5580 .code
5581 # sender_unqualified_hosts =
5582 # recipient_unqualified_hosts =
5583 .endd
5584 show how you can specify hosts that are permitted to send unqualified sender
5585 and recipient addresses, respectively.
5586
5587 The &%percent_hack_domains%& option is also commented out:
5588 .code
5589 # percent_hack_domains =
5590 .endd
5591 It provides a list of domains for which the &"percent hack"& is to operate.
5592 This is an almost obsolete form of explicit email routing. If you do not know
5593 anything about it, you can safely ignore this topic.
5594
5595 The last two settings in the main part of the default configuration are
5596 concerned with messages that have been &"frozen"& on Exim's queue. When a
5597 message is frozen, Exim no longer continues to try to deliver it. Freezing
5598 occurs when a bounce message encounters a permanent failure because the sender
5599 address of the original message that caused the bounce is invalid, so the
5600 bounce cannot be delivered. This is probably the most common case, but there
5601 are also other conditions that cause freezing, and frozen messages are not
5602 always bounce messages.
5603 .code
5604 ignore_bounce_errors_after = 2d
5605 timeout_frozen_after = 7d
5606 .endd
5607 The first of these options specifies that failing bounce messages are to be
5608 discarded after 2 days on the queue. The second specifies that any frozen
5609 message (whether a bounce message or not) is to be timed out (and discarded)
5610 after a week. In this configuration, the first setting ensures that no failing
5611 bounce message ever lasts a week.
5612
5613
5614
5615 .section "ACL configuration" "SECID54"
5616 .cindex "default" "ACLs"
5617 .cindex "&ACL;" "default configuration"
5618 In the default configuration, the ACL section follows the main configuration.
5619 It starts with the line
5620 .code
5621 begin acl
5622 .endd
5623 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5624 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5625 and &%acl_smtp_data%& above.
5626
5627 .cindex "RCPT" "ACL for"
5628 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5629 RCPT command specifies one of the message's recipients. The ACL statements
5630 are considered in order, until the recipient address is either accepted or
5631 rejected. The RCPT command is then accepted or rejected, according to the
5632 result of the ACL processing.
5633 .code
5634 acl_check_rcpt:
5635 .endd
5636 This line, consisting of a name terminated by a colon, marks the start of the
5637 ACL, and names it.
5638 .code
5639 accept  hosts = :
5640 .endd
5641 This ACL statement accepts the recipient if the sending host matches the list.
5642 But what does that strange list mean? It doesn't actually contain any host
5643 names or IP addresses. The presence of the colon puts an empty item in the
5644 list; Exim matches this only if the incoming message did not come from a remote
5645 host, because in that case, the remote hostname is empty. The colon is
5646 important. Without it, the list itself is empty, and can never match anything.
5647
5648 What this statement is doing is to accept unconditionally all recipients in
5649 messages that are submitted by SMTP from local processes using the standard
5650 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5651 manner.
5652 .code
5653 deny    message       = Restricted characters in address
5654         domains       = +local_domains
5655         local_parts   = ^[.] : ^.*[@%!/|]
5656
5657 deny    message       = Restricted characters in address
5658         domains       = !+local_domains
5659         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5660 .endd
5661 These statements are concerned with local parts that contain any of the
5662 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5663 Although these characters are entirely legal in local parts (in the case of
5664 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5665 in Internet mail addresses.
5666
5667 The first three have in the past been associated with explicitly routed
5668 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5669 option). Addresses containing these characters are regularly tried by spammers
5670 in an attempt to bypass relaying restrictions, and also by open relay testing
5671 programs. Unless you really need them it is safest to reject these characters
5672 at this early stage. This configuration is heavy-handed in rejecting these
5673 characters for all messages it accepts from remote hosts. This is a deliberate
5674 policy of being as safe as possible.
5675
5676 The first rule above is stricter, and is applied to messages that are addressed
5677 to one of the local domains handled by this host. This is implemented by the
5678 first condition, which restricts it to domains that are listed in the
5679 &'local_domains'& domain list. The &"+"& character is used to indicate a
5680 reference to a named list. In this configuration, there is just one domain in
5681 &'local_domains'&, but in general there may be many.
5682
5683 The second condition on the first statement uses two regular expressions to
5684 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5685 or &"|"&. If you have local accounts that include these characters, you will
5686 have to modify this rule.
5687
5688 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5689 allows them because they have been encountered in practice. (Consider the
5690 common convention of local parts constructed as
5691 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5692 the author of Exim, who has no second initial.) However, a local part starting
5693 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5694 file name (for example, for a mailing list). This is also true for local parts
5695 that contain slashes. A pipe symbol can also be troublesome if the local part
5696 is incorporated unthinkingly into a shell command line.
5697
5698 The second rule above applies to all other domains, and is less strict. This
5699 allows your own users to send outgoing messages to sites that use slashes
5700 and vertical bars in their local parts. It blocks local parts that begin
5701 with a dot, slash, or vertical bar, but allows these characters within the
5702 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5703 and &"!"& is blocked, as before. The motivation here is to prevent your users
5704 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5705 .code
5706 accept  local_parts   = postmaster
5707         domains       = +local_domains
5708 .endd
5709 This statement, which has two conditions, accepts an incoming address if the
5710 local part is &'postmaster'& and the domain is one of those listed in the
5711 &'local_domains'& domain list. The &"+"& character is used to indicate a
5712 reference to a named list. In this configuration, there is just one domain in
5713 &'local_domains'&, but in general there may be many.
5714
5715 The presence of this statement means that mail to postmaster is never blocked
5716 by any of the subsequent tests. This can be helpful while sorting out problems
5717 in cases where the subsequent tests are incorrectly denying access.
5718 .code
5719 require verify        = sender
5720 .endd
5721 This statement requires the sender address to be verified before any subsequent
5722 ACL statement can be used. If verification fails, the incoming recipient
5723 address is refused. Verification consists of trying to route the address, to
5724 see if a bounce message could be delivered to it. In the case of remote
5725 addresses, basic verification checks only the domain, but &'callouts'& can be
5726 used for more verification if required. Section &<<SECTaddressverification>>&
5727 discusses the details of address verification.
5728 .code
5729 accept  hosts         = +relay_from_hosts
5730         control       = submission
5731 .endd
5732 This statement accepts the address if the message is coming from one of the
5733 hosts that are defined as being allowed to relay through this host. Recipient
5734 verification is omitted here, because in many cases the clients are dumb MUAs
5735 that do not cope well with SMTP error responses. For the same reason, the
5736 second line specifies &"submission mode"& for messages that are accepted. This
5737 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5738 messages that are deficient in some way, for example, because they lack a
5739 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5740 probably add recipient verification here, and disable submission mode.
5741 .code
5742 accept  authenticated = *
5743         control       = submission
5744 .endd
5745 This statement accepts the address if the client host has authenticated itself.
5746 Submission mode is again specified, on the grounds that such messages are most
5747 likely to come from MUAs. The default configuration does not define any
5748 authenticators, though it does include some nearly complete commented-out
5749 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5750 fact authenticate until you complete the authenticator definitions.
5751 .code
5752 require message = relay not permitted
5753         domains = +local_domains : +relay_to_domains
5754 .endd
5755 This statement rejects the address if its domain is neither a local domain nor
5756 one of the domains for which this host is a relay.
5757 .code
5758 require verify = recipient
5759 .endd
5760 This statement requires the recipient address to be verified; if verification
5761 fails, the address is rejected.
5762 .code
5763 # deny    message     = rejected because $sender_host_address \
5764 #                       is in a black list at $dnslist_domain\n\
5765 #                       $dnslist_text
5766 #         dnslists    = black.list.example
5767 #
5768 # warn    dnslists    = black.list.example
5769 #         add_header  = X-Warning: $sender_host_address is in \
5770 #                       a black list at $dnslist_domain
5771 #         log_message = found in $dnslist_domain
5772 .endd
5773 These commented-out lines are examples of how you could configure Exim to check
5774 sending hosts against a DNS black list. The first statement rejects messages
5775 from blacklisted hosts, whereas the second just inserts a warning header
5776 line.
5777 .code
5778 # require verify = csa
5779 .endd
5780 This commented-out line is an example of how you could turn on client SMTP
5781 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5782 records.
5783 .code
5784 accept
5785 .endd
5786 The final statement in the first ACL unconditionally accepts any recipient
5787 address that has successfully passed all the previous tests.
5788 .code
5789 acl_check_data:
5790 .endd
5791 This line marks the start of the second ACL, and names it. Most of the contents
5792 of this ACL are commented out:
5793 .code
5794 # deny    malware   = *
5795 #         message   = This message contains a virus \
5796 #                     ($malware_name).
5797 .endd
5798 These lines are examples of how to arrange for messages to be scanned for
5799 viruses when Exim has been compiled with the content-scanning extension, and a
5800 suitable virus scanner is installed. If the message is found to contain a
5801 virus, it is rejected with the given custom error message.
5802 .code
5803 # warn    spam      = nobody
5804 #         message   = X-Spam_score: $spam_score\n\
5805 #                     X-Spam_score_int: $spam_score_int\n\
5806 #                     X-Spam_bar: $spam_bar\n\
5807 #                     X-Spam_report: $spam_report
5808 .endd
5809 These lines are an example of how to arrange for messages to be scanned by
5810 SpamAssassin when Exim has been compiled with the content-scanning extension,
5811 and SpamAssassin has been installed. The SpamAssassin check is run with
5812 &`nobody`& as its user parameter, and the results are added to the message as a
5813 series of extra header line. In this case, the message is not rejected,
5814 whatever the spam score.
5815 .code
5816 accept
5817 .endd
5818 This final line in the DATA ACL accepts the message unconditionally.
5819
5820
5821 .section "Router configuration" "SECID55"
5822 .cindex "default" "routers"
5823 .cindex "routers" "default"
5824 The router configuration comes next in the default configuration, introduced
5825 by the line
5826 .code
5827 begin routers
5828 .endd
5829 Routers are the modules in Exim that make decisions about where to send
5830 messages. An address is passed to each router in turn, until it is either
5831 accepted, or failed. This means that the order in which you define the routers
5832 matters. Each router is fully described in its own chapter later in this
5833 manual. Here we give only brief overviews.
5834 .code
5835 # domain_literal:
5836 #   driver = ipliteral
5837 #   domains = !+local_domains
5838 #   transport = remote_smtp
5839 .endd
5840 .cindex "domain literal" "default router"
5841 This router is commented out because the majority of sites do not want to
5842 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5843 you uncomment this router, you also need to uncomment the setting of
5844 &%allow_domain_literals%& in the main part of the configuration.
5845 .code
5846 dnslookup:
5847   driver = dnslookup
5848   domains = ! +local_domains
5849   transport = remote_smtp
5850   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5851   no_more
5852 .endd
5853 The first uncommented router handles addresses that do not involve any local
5854 domains. This is specified by the line
5855 .code
5856 domains = ! +local_domains
5857 .endd
5858 The &%domains%& option lists the domains to which this router applies, but the
5859 exclamation mark is a negation sign, so the router is used only for domains
5860 that are not in the domain list called &'local_domains'& (which was defined at
5861 the start of the configuration). The plus sign before &'local_domains'&
5862 indicates that it is referring to a named list. Addresses in other domains are
5863 passed on to the following routers.
5864
5865 The name of the router driver is &(dnslookup)&,
5866 and is specified by the &%driver%& option. Do not be confused by the fact that
5867 the name of this router instance is the same as the name of the driver. The
5868 instance name is arbitrary, but the name set in the &%driver%& option must be
5869 one of the driver modules that is in the Exim binary.
5870
5871 The &(dnslookup)& router routes addresses by looking up their domains in the
5872 DNS in order to obtain a list of hosts to which the address is routed. If the
5873 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5874 specified by the &%transport%& option. If the router does not find the domain
5875 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5876 the address fails and is bounced.
5877
5878 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5879 be entirely ignored. This option is present because a number of cases have been
5880 encountered where MX records in the DNS point to host names
5881 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5882 Completely ignoring these IP addresses causes Exim to fail to route the
5883 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5884 continue to try to deliver the message periodically until the address timed
5885 out.
5886 .code
5887 system_aliases:
5888   driver = redirect
5889   allow_fail
5890   allow_defer
5891   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5892 # user = exim
5893   file_transport = address_file
5894   pipe_transport = address_pipe
5895 .endd
5896 Control reaches this and subsequent routers only for addresses in the local
5897 domains. This router checks to see whether the local part is defined as an
5898 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5899 data that it looks up from that file. If no data is found for the local part,
5900 the value of the &%data%& option is empty, causing the address to be passed to
5901 the next router.
5902
5903 &_/etc/aliases_& is a conventional name for the system aliases file that is
5904 often used. That is why it is referenced by from the default configuration
5905 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5906 &_Local/Makefile_& before building Exim.
5907 .code
5908 userforward:
5909   driver = redirect
5910   check_local_user
5911 # local_part_suffix = +* : -*
5912 # local_part_suffix_optional
5913   file = $home/.forward
5914 # allow_filter
5915   no_verify
5916   no_expn
5917   check_ancestor
5918   file_transport = address_file
5919   pipe_transport = address_pipe
5920   reply_transport = address_reply
5921 .endd
5922 This is the most complicated router in the default configuration. It is another
5923 redirection router, but this time it is looking for forwarding data set up by
5924 individual users. The &%check_local_user%& setting specifies a check that the
5925 local part of the address is the login name of a local user. If it is not, the
5926 router is skipped. The two commented options that follow &%check_local_user%&,
5927 namely:
5928 .code
5929 # local_part_suffix = +* : -*
5930 # local_part_suffix_optional
5931 .endd
5932 .vindex "&$local_part_suffix$&"
5933 show how you can specify the recognition of local part suffixes. If the first
5934 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5935 by any sequence of characters, is removed from the local part and placed in the
5936 variable &$local_part_suffix$&. The second suffix option specifies that the
5937 presence of a suffix in the local part is optional. When a suffix is present,
5938 the check for a local login uses the local part with the suffix removed.
5939
5940 When a local user account is found, the file called &_.forward_& in the user's
5941 home directory is consulted. If it does not exist, or is empty, the router
5942 declines. Otherwise, the contents of &_.forward_& are interpreted as
5943 redirection data (see chapter &<<CHAPredirect>>& for more details).
5944
5945 .cindex "Sieve filter" "enabling in default router"
5946 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5947 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5948 is commented out by default), the contents of the file are interpreted as a set
5949 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5950 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5951 separate document entitled &'Exim's interfaces to mail filtering'&.
5952
5953 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5954 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5955 There are two reasons for doing this:
5956
5957 .olist
5958 Whether or not a local user has a &_.forward_& file is not really relevant when
5959 checking an address for validity; it makes sense not to waste resources doing
5960 unnecessary work.
5961 .next
5962 More importantly, when Exim is verifying addresses or handling an EXPN
5963 command during an SMTP session, it is running as the Exim user, not as root.
5964 The group is the Exim group, and no additional groups are set up.
5965 It may therefore not be possible for Exim to read users' &_.forward_& files at
5966 this time.
5967 .endlist
5968
5969 The setting of &%check_ancestor%& prevents the router from generating a new
5970 address that is the same as any previous address that was redirected. (This
5971 works round a problem concerning a bad interaction between aliasing and
5972 forwarding &-- see section &<<SECTredlocmai>>&).
5973
5974 The final three option settings specify the transports that are to be used when
5975 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5976 auto-reply, respectively. For example, if a &_.forward_& file contains
5977 .code
5978 a.nother@elsewhere.example, /home/spqr/archive
5979 .endd
5980 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5981 transport.
5982 .code
5983 localuser:
5984   driver = accept
5985   check_local_user
5986 # local_part_suffix = +* : -*
5987 # local_part_suffix_optional
5988   transport = local_delivery
5989 .endd
5990 The final router sets up delivery into local mailboxes, provided that the local
5991 part is the name of a local login, by accepting the address and assigning it to
5992 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5993 routers, so the address is bounced. The commented suffix settings fulfil the
5994 same purpose as they do for the &(userforward)& router.
5995
5996
5997 .section "Transport configuration" "SECID56"
5998 .cindex "default" "transports"
5999 .cindex "transports" "default"
6000 Transports define mechanisms for actually delivering messages. They operate
6001 only when referenced from routers, so the order in which they are defined does
6002 not matter. The transports section of the configuration starts with
6003 .code
6004 begin transports
6005 .endd
6006 One remote transport and four local transports are defined.
6007 .code
6008 remote_smtp:
6009   driver = smtp
6010   hosts_try_prdr = *
6011 .endd
6012 This transport is used for delivering messages over SMTP connections.
6013 The list of remote hosts comes from the router.
6014 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6015 It is negotiated between client and server
6016 and not expected to cause problems but can be disabled if needed.
6017 All other options are defaulted.
6018 .code
6019 local_delivery:
6020   driver = appendfile
6021   file = /var/mail/$local_part
6022   delivery_date_add
6023   envelope_to_add
6024   return_path_add
6025 # group = mail
6026 # mode = 0660
6027 .endd
6028 This &(appendfile)& transport is used for local delivery to user mailboxes in
6029 traditional BSD mailbox format. By default it runs under the uid and gid of the
6030 local user, which requires the sticky bit to be set on the &_/var/mail_&
6031 directory. Some systems use the alternative approach of running mail deliveries
6032 under a particular group instead of using the sticky bit. The commented options
6033 show how this can be done.
6034
6035 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6036 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6037 similarly-named options above.
6038 .code
6039 address_pipe:
6040   driver = pipe
6041   return_output
6042 .endd
6043 This transport is used for handling deliveries to pipes that are generated by
6044 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6045 option specifies that any output generated by the pipe is to be returned to the
6046 sender.
6047 .code
6048 address_file:
6049   driver = appendfile
6050   delivery_date_add
6051   envelope_to_add
6052   return_path_add
6053 .endd
6054 This transport is used for handling deliveries to files that are generated by
6055 redirection. The name of the file is not specified in this instance of
6056 &(appendfile)&, because it comes from the &(redirect)& router.
6057 .code
6058 address_reply:
6059   driver = autoreply
6060 .endd
6061 This transport is used for handling automatic replies generated by users'
6062 filter files.
6063
6064
6065
6066 .section "Default retry rule" "SECID57"
6067 .cindex "retry" "default rule"
6068 .cindex "default" "retry rule"
6069 The retry section of the configuration file contains rules which affect the way
6070 Exim retries deliveries that cannot be completed at the first attempt. It is
6071 introduced by the line
6072 .code
6073 begin retry
6074 .endd
6075 In the default configuration, there is just one rule, which applies to all
6076 errors:
6077 .code
6078 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6079 .endd
6080 This causes any temporarily failing address to be retried every 15 minutes for
6081 2 hours, then at intervals starting at one hour and increasing by a factor of
6082 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6083 is not delivered after 4 days of temporary failure, it is bounced.
6084
6085 If the retry section is removed from the configuration, or is empty (that is,
6086 if no retry rules are defined), Exim will not retry deliveries. This turns
6087 temporary errors into permanent errors.
6088
6089
6090 .section "Rewriting configuration" "SECID58"
6091 The rewriting section of the configuration, introduced by
6092 .code
6093 begin rewrite
6094 .endd
6095 contains rules for rewriting addresses in messages as they arrive. There are no
6096 rewriting rules in the default configuration file.
6097
6098
6099
6100 .section "Authenticators configuration" "SECTdefconfauth"
6101 .cindex "AUTH" "configuration"
6102 The authenticators section of the configuration, introduced by
6103 .code
6104 begin authenticators
6105 .endd
6106 defines mechanisms for the use of the SMTP AUTH command. The default
6107 configuration file contains two commented-out example authenticators
6108 which support plaintext username/password authentication using the
6109 standard PLAIN mechanism and the traditional but non-standard LOGIN
6110 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6111 to support most MUA software.
6112
6113 The example PLAIN authenticator looks like this:
6114 .code
6115 #PLAIN:
6116 #  driver                  = plaintext
6117 #  server_set_id           = $auth2
6118 #  server_prompts          = :
6119 #  server_condition        = Authentication is not yet configured
6120 #  server_advertise_condition = ${if def:tls_in_cipher }
6121 .endd
6122 And the example LOGIN authenticator looks like this:
6123 .code
6124 #LOGIN:
6125 #  driver                  = plaintext
6126 #  server_set_id           = $auth1
6127 #  server_prompts          = <| Username: | Password:
6128 #  server_condition        = Authentication is not yet configured
6129 #  server_advertise_condition = ${if def:tls_in_cipher }
6130 .endd
6131
6132 The &%server_set_id%& option makes Exim remember the authenticated username
6133 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6134 &%server_prompts%& option configures the &(plaintext)& authenticator so
6135 that it implements the details of the specific authentication mechanism,
6136 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6137 when Exim offers authentication to clients; in the examples, this is only
6138 when TLS or SSL has been started, so to enable the authenticators you also
6139 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6140
6141 The &%server_condition%& setting defines how to verify that the username and
6142 password are correct. In the examples it just produces an error message.
6143 To make the authenticators work, you can use a string expansion
6144 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6145
6146 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6147 usercode and password are in different positions.
6148 Chapter &<<CHAPplaintext>>& covers both.
6149
6150 .ecindex IIDconfiwal
6151
6152
6153
6154 . ////////////////////////////////////////////////////////////////////////////
6155 . ////////////////////////////////////////////////////////////////////////////
6156
6157 .chapter "Regular expressions" "CHAPregexp"
6158
6159 .cindex "regular expressions" "library"
6160 .cindex "PCRE"
6161 Exim supports the use of regular expressions in many of its options. It
6162 uses the PCRE regular expression library; this provides regular expression
6163 matching that is compatible with Perl 5. The syntax and semantics of
6164 regular expressions is discussed in many Perl reference books, and also in
6165 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6166 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6167
6168 The documentation for the syntax and semantics of the regular expressions that
6169 are supported by PCRE is included in the PCRE distribution, and no further
6170 description is included here. The PCRE functions are called from Exim using
6171 the default option settings (that is, with no PCRE options set), except that
6172 the PCRE_CASELESS option is set when the matching is required to be
6173 case-insensitive.
6174
6175 In most cases, when a regular expression is required in an Exim configuration,
6176 it has to start with a circumflex, in order to distinguish it from plain text
6177 or an &"ends with"& wildcard. In this example of a configuration setting, the
6178 second item in the colon-separated list is a regular expression.
6179 .code
6180 domains = a.b.c : ^\\d{3} : *.y.z : ...
6181 .endd
6182 The doubling of the backslash is required because of string expansion that
6183 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6184 of this issue, and a way of avoiding the need for doubling backslashes. The
6185 regular expression that is eventually used in this example contains just one
6186 backslash. The circumflex is included in the regular expression, and has the
6187 normal effect of &"anchoring"& it to the start of the string that is being
6188 matched.
6189
6190 There are, however, two cases where a circumflex is not required for the
6191 recognition of a regular expression: these are the &%match%& condition in a
6192 string expansion, and the &%matches%& condition in an Exim filter file. In
6193 these cases, the relevant string is always treated as a regular expression; if
6194 it does not start with a circumflex, the expression is not anchored, and can
6195 match anywhere in the subject string.
6196
6197 In all cases, if you want a regular expression to match at the end of a string,
6198 you must code the $ metacharacter to indicate this. For example:
6199 .code
6200 domains = ^\\d{3}\\.example
6201 .endd
6202 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6203 You need to use:
6204 .code
6205 domains = ^\\d{3}\\.example\$
6206 .endd
6207 if you want &'example'& to be the top-level domain. The backslash before the
6208 $ is needed because string expansion also interprets dollar characters.
6209
6210
6211
6212 . ////////////////////////////////////////////////////////////////////////////
6213 . ////////////////////////////////////////////////////////////////////////////
6214
6215 .chapter "File and database lookups" "CHAPfdlookup"
6216 .scindex IIDfidalo1 "file" "lookups"
6217 .scindex IIDfidalo2 "database" "lookups"
6218 .cindex "lookup" "description of"
6219 Exim can be configured to look up data in files or databases as it processes
6220 messages. Two different kinds of syntax are used:
6221
6222 .olist
6223 A string that is to be expanded may contain explicit lookup requests. These
6224 cause parts of the string to be replaced by data that is obtained from the
6225 lookup. Lookups of this type are conditional expansion items. Different results
6226 can be defined for the cases of lookup success and failure. See chapter
6227 &<<CHAPexpand>>&, where string expansions are described in detail.
6228 .next
6229 Lists of domains, hosts, and email addresses can contain lookup requests as a
6230 way of avoiding excessively long linear lists. In this case, the data that is
6231 returned by the lookup is often (but not always) discarded; whether the lookup
6232 succeeds or fails is what really counts. These kinds of list are described in
6233 chapter &<<CHAPdomhosaddlists>>&.
6234 .endlist
6235
6236 String expansions, lists, and lookups interact with each other in such a way
6237 that there is no order in which to describe any one of them that does not
6238 involve references to the others. Each of these three chapters makes more sense
6239 if you have read the other two first. If you are reading this for the first
6240 time, be aware that some of it will make a lot more sense after you have read
6241 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6242
6243 .section "Examples of different lookup syntax" "SECID60"
6244 It is easy to confuse the two different kinds of lookup, especially as the
6245 lists that may contain the second kind are always expanded before being
6246 processed as lists. Therefore, they may also contain lookups of the first kind.
6247 Be careful to distinguish between the following two examples:
6248 .code
6249 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6250 domains = lsearch;/some/file
6251 .endd
6252 The first uses a string expansion, the result of which must be a domain list.
6253 No strings have been specified for a successful or a failing lookup; the
6254 defaults in this case are the looked-up data and an empty string, respectively.
6255 The expansion takes place before the string is processed as a list, and the
6256 file that is searched could contain lines like this:
6257 .code
6258 192.168.3.4: domain1:domain2:...
6259 192.168.1.9: domain3:domain4:...
6260 .endd
6261 When the lookup succeeds, the result of the expansion is a list of domains (and
6262 possibly other types of item that are allowed in domain lists).
6263
6264 In the second example, the lookup is a single item in a domain list. It causes
6265 Exim to use a lookup to see if the domain that is being processed can be found
6266 in the file. The file could contains lines like this:
6267 .code
6268 domain1:
6269 domain2:
6270 .endd
6271 Any data that follows the keys is not relevant when checking that the domain
6272 matches the list item.
6273
6274 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6275 Consider a file containing lines like this:
6276 .code
6277 192.168.5.6: lsearch;/another/file
6278 .endd
6279 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6280 first &%domains%& setting above generates the second setting, which therefore
6281 causes a second lookup to occur.
6282
6283 The rest of this chapter describes the different lookup types that are
6284 available. Any of them can be used in any part of the configuration where a
6285 lookup is permitted.
6286
6287
6288 .section "Lookup types" "SECID61"
6289 .cindex "lookup" "types of"
6290 .cindex "single-key lookup" "definition of"
6291 Two different types of data lookup are implemented:
6292
6293 .ilist
6294 The &'single-key'& type requires the specification of a file in which to look,
6295 and a single key to search for. The key must be a non-empty string for the
6296 lookup to succeed. The lookup type determines how the file is searched.
6297 .next
6298 .cindex "query-style lookup" "definition of"
6299 The &'query-style'& type accepts a generalized database query. No particular
6300 key value is assumed by Exim for query-style lookups. You can use whichever
6301 Exim variables you need to construct the database query.
6302 .endlist
6303
6304 The code for each lookup type is in a separate source file that is included in
6305 the binary of Exim only if the corresponding compile-time option is set. The
6306 default settings in &_src/EDITME_& are:
6307 .code
6308 LOOKUP_DBM=yes
6309 LOOKUP_LSEARCH=yes
6310 .endd
6311 which means that only linear searching and DBM lookups are included by default.
6312 For some types of lookup (e.g. SQL databases), you need to install appropriate
6313 libraries and header files before building Exim.
6314
6315
6316
6317
6318 .section "Single-key lookup types" "SECTsinglekeylookups"
6319 .cindex "lookup" "single-key types"
6320 .cindex "single-key lookup" "list of types"
6321 The following single-key lookup types are implemented:
6322
6323 .ilist
6324 .cindex "cdb" "description of"
6325 .cindex "lookup" "cdb"
6326 .cindex "binary zero" "in lookup key"
6327 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6328 string without a terminating binary zero. The cdb format is designed for
6329 indexed files that are read frequently and never updated, except by total
6330 re-creation. As such, it is particularly suitable for large files containing
6331 aliases or other indexed data referenced by an MTA. Information about cdb can
6332 be found in several places:
6333 .display
6334 &url(http://www.pobox.com/~djb/cdb.html)
6335 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6336 &url(http://packages.debian.org/stable/utils/freecdb.html)
6337 .endd
6338 A cdb distribution is not needed in order to build Exim with cdb support,
6339 because the code for reading cdb files is included directly in Exim itself.
6340 However, no means of building or testing cdb files is provided with Exim, so
6341 you need to obtain a cdb distribution in order to do this.
6342 .next
6343 .cindex "DBM" "lookup type"
6344 .cindex "lookup" "dbm"
6345 .cindex "binary zero" "in lookup key"
6346 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6347 DBM file by looking up the record with the given key. A terminating binary
6348 zero is included in the key that is passed to the DBM library. See section
6349 &<<SECTdb>>& for a discussion of DBM libraries.
6350
6351 .cindex "Berkeley DB library" "file format"
6352 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6353 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6354 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6355 the DB_UNKNOWN option. This enables it to handle any of the types of database
6356 that the library supports, and can be useful for accessing DBM files created by
6357 other applications. (For earlier DB versions, DB_HASH is always used.)
6358 .next
6359 .cindex "lookup" "dbmjz"
6360 .cindex "lookup" "dbm &-- embedded NULs"
6361 .cindex "sasldb2"
6362 .cindex "dbmjz lookup type"
6363 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6364 interpreted as an Exim list; the elements of the list are joined together with
6365 ASCII NUL characters to form the lookup key.  An example usage would be to
6366 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6367 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6368 &(cram_md5)& authenticator.
6369 .next
6370 .cindex "lookup" "dbmnz"
6371 .cindex "lookup" "dbm &-- terminating zero"
6372 .cindex "binary zero" "in lookup key"
6373 .cindex "Courier"
6374 .cindex "&_/etc/userdbshadow.dat_&"
6375 .cindex "dbmnz lookup type"
6376 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6377 is not included in the key that is passed to the DBM library. You may need this
6378 if you want to look up data in files that are created by or shared with some
6379 other application that does not use terminating zeros. For example, you need to
6380 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6381 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6382 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6383 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6384 .next
6385 .cindex "lookup" "dsearch"
6386 .cindex "dsearch lookup type"
6387 &(dsearch)&: The given file must be a directory; this is searched for an entry
6388 whose name is the key by calling the &[lstat()]& function. The key may not
6389 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6390 the lookup is the name of the entry, which may be a file, directory,
6391 symbolic link, or any other kind of directory entry. An example of how this
6392 lookup can be used to support virtual domains is given in section
6393 &<<SECTvirtualdomains>>&.
6394 .next
6395 .cindex "lookup" "iplsearch"
6396 .cindex "iplsearch lookup type"
6397 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6398 terminated by a colon or white space or the end of the line. The keys in the
6399 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6400 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6401 being interpreted as a key terminator. For example:
6402 .code
6403 1.2.3.4:           data for 1.2.3.4
6404 192.168.0.0/16:    data for 192.168.0.0/16
6405 "abcd::cdab":      data for abcd::cdab
6406 "abcd:abcd::/32"   data for abcd:abcd::/32
6407 .endd
6408 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6409 file is searched linearly, using the CIDR masks where present, until a matching
6410 key is found. The first key that matches is used; there is no attempt to find a
6411 &"best"& match. Apart from the way the keys are matched, the processing for
6412 &(iplsearch)& is the same as for &(lsearch)&.
6413
6414 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6415 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6416 lookup types support only literal keys.
6417
6418 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6419 the implicit key is the host's IP address rather than its name (see section
6420 &<<SECThoslispatsikey>>&).
6421 .next
6422 .cindex "linear search"
6423 .cindex "lookup" "lsearch"
6424 .cindex "lsearch lookup type"
6425 .cindex "case sensitivity" "in lsearch lookup"
6426 &(lsearch)&: The given file is a text file that is searched linearly for a
6427 line beginning with the search key, terminated by a colon or white space or the
6428 end of the line. The search is case-insensitive; that is, upper and lower case
6429 letters are treated as the same. The first occurrence of the key that is found
6430 in the file is used.
6431
6432 White space between the key and the colon is permitted. The remainder of the
6433 line, with leading and trailing white space removed, is the data. This can be
6434 continued onto subsequent lines by starting them with any amount of white
6435 space, but only a single space character is included in the data at such a
6436 junction. If the data begins with a colon, the key must be terminated by a
6437 colon, for example:
6438 .code
6439 baduser:  :fail:
6440 .endd
6441 Empty lines and lines beginning with # are ignored, even if they occur in the
6442 middle of an item. This is the traditional textual format of alias files. Note
6443 that the keys in an &(lsearch)& file are literal strings. There is no
6444 wildcarding of any kind.
6445
6446 .cindex "lookup" "lsearch &-- colons in keys"
6447 .cindex "white space" "in lsearch key"
6448 In most &(lsearch)& files, keys are not required to contain colons or #
6449 characters, or white space. However, if you need this feature, it is available.
6450 If a key begins with a doublequote character, it is terminated only by a
6451 matching quote (or end of line), and the normal escaping rules apply to its
6452 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6453 quoted keys (exactly as for unquoted keys). There is no special handling of
6454 quotes for the data part of an &(lsearch)& line.
6455
6456 .next
6457 .cindex "NIS lookup type"
6458 .cindex "lookup" "NIS"
6459 .cindex "binary zero" "in lookup key"
6460 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6461 the given key, without a terminating binary zero. There is a variant called
6462 &(nis0)& which does include the terminating binary zero in the key. This is
6463 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6464 aliases; the full map names must be used.
6465
6466 .next
6467 .cindex "wildlsearch lookup type"
6468 .cindex "lookup" "wildlsearch"
6469 .cindex "nwildlsearch lookup type"
6470 .cindex "lookup" "nwildlsearch"
6471 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6472 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6473 the file may be wildcarded. The difference between these two lookup types is
6474 that for &(wildlsearch)&, each key in the file is string-expanded before being
6475 used, whereas for &(nwildlsearch)&, no expansion takes place.
6476
6477 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6478 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6479 file that are regular expressions can be made case-sensitive by the use of
6480 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6481
6482 . ==== As this is a nested list, any displays it contains must be indented
6483 . ==== as otherwise they are too far to the left.
6484
6485 .olist
6486 The string may begin with an asterisk to mean &"ends with"&. For example:
6487 .code
6488     *.a.b.c       data for anything.a.b.c
6489     *fish         data for anythingfish
6490 .endd
6491 .next
6492 The string may begin with a circumflex to indicate a regular expression. For
6493 example, for &(wildlsearch)&:
6494 .code
6495     ^\N\d+\.a\.b\N    data for <digits>.a.b
6496 .endd
6497 Note the use of &`\N`& to disable expansion of the contents of the regular
6498 expression. If you are using &(nwildlsearch)&, where the keys are not
6499 string-expanded, the equivalent entry is:
6500 .code
6501     ^\d+\.a\.b        data for <digits>.a.b
6502 .endd
6503 The case-insensitive flag is set at the start of compiling the regular
6504 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6505 For example, to make the entire pattern case-sensitive:
6506 .code
6507     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6508 .endd
6509
6510 If the regular expression contains white space or colon characters, you must
6511 either quote it (see &(lsearch)& above), or represent these characters in other
6512 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6513 colon. This may be easier than quoting, because if you quote, you have to
6514 escape all the backslashes inside the quotes.
6515
6516 &*Note*&: It is not possible to capture substrings in a regular expression
6517 match for later use, because the results of all lookups are cached. If a lookup
6518 is repeated, the result is taken from the cache, and no actual pattern matching
6519 takes place. The values of all the numeric variables are unset after a
6520 &((n)wildlsearch)& match.
6521
6522 .next
6523 Although I cannot see it being of much use, the general matching function that
6524 is used to implement &((n)wildlsearch)& means that the string may begin with a
6525 lookup name terminated by a semicolon, and followed by lookup data. For
6526 example:
6527 .code
6528     cdb;/some/file  data for keys that match the file
6529 .endd
6530 The data that is obtained from the nested lookup is discarded.
6531 .endlist olist
6532
6533 Keys that do not match any of these patterns are interpreted literally. The
6534 continuation rules for the data are the same as for &(lsearch)&, and keys may
6535 be followed by optional colons.
6536
6537 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6538 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6539 lookup types support only literal keys.
6540 .endlist ilist
6541
6542
6543 .section "Query-style lookup types" "SECID62"
6544 .cindex "lookup" "query-style types"
6545 .cindex "query-style lookup" "list of types"
6546 The supported query-style lookup types are listed below. Further details about
6547 many of them are given in later sections.
6548
6549 .ilist
6550 .cindex "DNS" "as a lookup type"
6551 .cindex "lookup" "DNS"
6552 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6553 are given in the supplied query. The resulting data is the contents of the
6554 records. See section &<<SECTdnsdb>>&.
6555 .next
6556 .cindex "InterBase lookup type"
6557 .cindex "lookup" "InterBase"
6558 &(ibase)&: This does a lookup in an InterBase database.
6559 .next
6560 .cindex "LDAP" "lookup type"
6561 .cindex "lookup" "LDAP"
6562 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6563 returns attributes from a single entry. There is a variant called &(ldapm)&
6564 that permits values from multiple entries to be returned. A third variant
6565 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6566 any attribute values. See section &<<SECTldap>>&.
6567 .next
6568 .cindex "MySQL" "lookup type"
6569 .cindex "lookup" "MySQL"
6570 &(mysql)&: The format of the query is an SQL statement that is passed to a
6571 MySQL database. See section &<<SECTsql>>&.
6572 .next
6573 .cindex "NIS+ lookup type"
6574 .cindex "lookup" "NIS+"
6575 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6576 the field to be returned. See section &<<SECTnisplus>>&.
6577 .next
6578 .cindex "Oracle" "lookup type"
6579 .cindex "lookup" "Oracle"
6580 &(oracle)&: The format of the query is an SQL statement that is passed to an
6581 Oracle database. See section &<<SECTsql>>&.
6582 .next
6583 .cindex "lookup" "passwd"
6584 .cindex "passwd lookup type"
6585 .cindex "&_/etc/passwd_&"
6586 &(passwd)& is a query-style lookup with queries that are just user names. The
6587 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6588 success, the result string is the same as you would get from an &(lsearch)&
6589 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6590 password value. For example:
6591 .code
6592 *:42:42:King Rat:/home/kr:/bin/bash
6593 .endd
6594 .next
6595 .cindex "PostgreSQL lookup type"
6596 .cindex "lookup" "PostgreSQL"
6597 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6598 PostgreSQL database. See section &<<SECTsql>>&.
6599
6600 .next
6601 .cindex "sqlite lookup type"
6602 .cindex "lookup" "sqlite"
6603 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6604 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6605
6606 .next
6607 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6608 not likely to be useful in normal operation.
6609 .next
6610 .cindex "whoson lookup type"
6611 .cindex "lookup" "whoson"
6612 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6613 allows a server to check whether a particular (dynamically allocated) IP
6614 address is currently allocated to a known (trusted) user and, optionally, to
6615 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6616 at one time for &"POP before SMTP"& authentication, but that approach has been
6617 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6618 &"POP before SMTP"& checking using ACL statements such as
6619 .code
6620 require condition = \
6621   ${lookup whoson {$sender_host_address}{yes}{no}}
6622 .endd
6623 The query consists of a single IP address. The value returned is the name of
6624 the authenticated user, which is stored in the variable &$value$&. However, in
6625 this example, the data in &$value$& is not used; the result of the lookup is
6626 one of the fixed strings &"yes"& or &"no"&.
6627 .endlist
6628
6629
6630
6631 .section "Temporary errors in lookups" "SECID63"
6632 .cindex "lookup" "temporary error in"
6633 Lookup functions can return temporary error codes if the lookup cannot be
6634 completed. For example, an SQL or LDAP database might be unavailable. For this
6635 reason, it is not advisable to use a lookup that might do this for critical
6636 options such as a list of local domains.
6637
6638 When a lookup cannot be completed in a router or transport, delivery
6639 of the message (to the relevant address) is deferred, as for any other
6640 temporary error. In other circumstances Exim may assume the lookup has failed,
6641 or may give up altogether.
6642
6643
6644
6645 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6646 .cindex "wildcard lookups"
6647 .cindex "lookup" "default values"
6648 .cindex "lookup" "wildcard"
6649 .cindex "lookup" "* added to type"
6650 .cindex "default" "in single-key lookups"
6651 In this context, a &"default value"& is a value specified by the administrator
6652 that is to be used if a lookup fails.
6653
6654 &*Note:*& This section applies only to single-key lookups. For query-style
6655 lookups, the facilities of the query language must be used. An attempt to
6656 specify a default for a query-style lookup provokes an error.
6657
6658 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6659 and the initial lookup fails, the key &"*"& is looked up in the file to
6660 provide a default value. See also the section on partial matching below.
6661
6662 .cindex "*@ with single-key lookup"
6663 .cindex "lookup" "*@ added to type"
6664 .cindex "alias file" "per-domain default"
6665 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6666 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6667 character, a second lookup is done with everything before the last @ replaced
6668 by *. This makes it possible to provide per-domain defaults in alias files
6669 that include the domains in the keys. If the second lookup fails (or doesn't
6670 take place because there is no @ in the key), &"*"& is looked up.
6671 For example, a &(redirect)& router might contain:
6672 .code
6673 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6674 .endd
6675 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6676 looks up these keys, in this order:
6677 .code
6678 jane@eyre.example
6679 *@eyre.example
6680 *
6681 .endd
6682 The data is taken from whichever key it finds first. &*Note*&: In an
6683 &(lsearch)& file, this does not mean the first of these keys in the file. A
6684 complete scan is done for each key, and only if it is not found at all does
6685 Exim move on to try the next key.
6686
6687
6688
6689 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6690 .cindex "partial matching"
6691 .cindex "wildcard lookups"
6692 .cindex "lookup" "partial matching"
6693 .cindex "lookup" "wildcard"
6694 .cindex "asterisk" "in search type"
6695 The normal operation of a single-key lookup is to search the file for an exact
6696 match with the given key. However, in a number of situations where domains are
6697 being looked up, it is useful to be able to do partial matching. In this case,
6698 information in the file that has a key starting with &"*."& is matched by any
6699 domain that ends with the components that follow the full stop. For example, if
6700 a key in a DBM file is
6701 .code
6702 *.dates.fict.example
6703 .endd
6704 then when partial matching is enabled this is matched by (amongst others)
6705 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6706 by &'dates.fict.example'&, if that does not appear as a separate key in the
6707 file.
6708
6709 &*Note*&: Partial matching is not available for query-style lookups. It is
6710 also not available for any lookup items in address lists (see section
6711 &<<SECTaddresslist>>&).
6712
6713 Partial matching is implemented by doing a series of separate lookups using
6714 keys constructed by modifying the original subject key. This means that it can
6715 be used with any of the single-key lookup types, provided that
6716 partial matching keys
6717 beginning with a special prefix (default &"*."&) are included in the data file.
6718 Keys in the file that do not begin with the prefix are matched only by
6719 unmodified subject keys when partial matching is in use.
6720
6721 Partial matching is requested by adding the string &"partial-"& to the front of
6722 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6723 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6724 is added at the start of the subject key, and it is looked up again. If that
6725 fails, further lookups are tried with dot-separated components removed from the
6726 start of the subject key, one-by-one, and &"*."& added on the front of what
6727 remains.
6728
6729 A minimum number of two non-* components are required. This can be adjusted
6730 by including a number before the hyphen in the search type. For example,
6731 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6732 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6733 subject key is &'2250.dates.fict.example'& then the following keys are looked
6734 up when the minimum number of non-* components is two:
6735 .code
6736 2250.dates.fict.example
6737 *.2250.dates.fict.example
6738 *.dates.fict.example
6739 *.fict.example
6740 .endd
6741 As soon as one key in the sequence is successfully looked up, the lookup
6742 finishes.
6743
6744 .cindex "lookup" "partial matching &-- changing prefix"
6745 .cindex "prefix" "for partial matching"
6746 The use of &"*."& as the partial matching prefix is a default that can be
6747 changed. The motivation for this feature is to allow Exim to operate with file
6748 formats that are used by other MTAs. A different prefix can be supplied in
6749 parentheses instead of the hyphen after &"partial"&. For example:
6750 .code
6751 domains = partial(.)lsearch;/some/file
6752 .endd
6753 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6754 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6755 components is unchanged). The prefix may consist of any punctuation characters
6756 other than a closing parenthesis. It may be empty, for example:
6757 .code
6758 domains = partial1()cdb;/some/file
6759 .endd
6760 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6761 &`a.b.c`&, &`b.c`&, and &`c`&.
6762
6763 If &"partial0"& is specified, what happens at the end (when the lookup with
6764 just one non-wild component has failed, and the original key is shortened right
6765 down to the null string) depends on the prefix:
6766
6767 .ilist
6768 If the prefix has zero length, the whole lookup fails.
6769 .next
6770 If the prefix has length 1, a lookup for just the prefix is done. For
6771 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6772 .next
6773 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6774 remainder is looked up. With the default prefix, therefore, the final lookup is
6775 for &"*"& on its own.
6776 .next
6777 Otherwise, the whole prefix is looked up.
6778 .endlist
6779
6780
6781 If the search type ends in &"*"& or &"*@"& (see section
6782 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6783 this implies happens after all partial lookups have failed. If &"partial0"& is
6784 specified, adding &"*"& to the search type has no effect with the default
6785 prefix, because the &"*"& key is already included in the sequence of partial
6786 lookups. However, there might be a use for lookup types such as
6787 &"partial0(.)lsearch*"&.
6788
6789 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6790 in domain lists and the like. Partial matching works only in terms of
6791 dot-separated components; a key such as &`*fict.example`&
6792 in a database file is useless, because the asterisk in a partial matching
6793 subject key is always followed by a dot.
6794
6795
6796
6797
6798 .section "Lookup caching" "SECID64"
6799 .cindex "lookup" "caching"
6800 .cindex "caching" "lookup data"
6801 Exim caches all lookup results in order to avoid needless repetition of
6802 lookups. However, because (apart from the daemon) Exim operates as a collection
6803 of independent, short-lived processes, this caching applies only within a
6804 single Exim process. There is no inter-process lookup caching facility.
6805
6806 For single-key lookups, Exim keeps the relevant files open in case there is
6807 another lookup that needs them. In some types of configuration this can lead to
6808 many files being kept open for messages with many recipients. To avoid hitting
6809 the operating system limit on the number of simultaneously open files, Exim
6810 closes the least recently used file when it needs to open more files than its
6811 own internal limit, which can be changed via the &%lookup_open_max%& option.
6812
6813 The single-key lookup files are closed and the lookup caches are flushed at
6814 strategic points during delivery &-- for example, after all routing is
6815 complete.
6816
6817
6818
6819
6820 .section "Quoting lookup data" "SECID65"
6821 .cindex "lookup" "quoting"
6822 .cindex "quoting" "in lookups"
6823 When data from an incoming message is included in a query-style lookup, there
6824 is the possibility of special characters in the data messing up the syntax of
6825 the query. For example, a NIS+ query that contains
6826 .code
6827 [name=$local_part]
6828 .endd
6829 will be broken if the local part happens to contain a closing square bracket.
6830 For NIS+, data can be enclosed in double quotes like this:
6831 .code
6832 [name="$local_part"]
6833 .endd
6834 but this still leaves the problem of a double quote in the data. The rule for
6835 NIS+ is that double quotes must be doubled. Other lookup types have different
6836 rules, and to cope with the differing requirements, an expansion operator
6837 of the following form is provided:
6838 .code
6839 ${quote_<lookup-type>:<string>}
6840 .endd
6841 For example, the safest way to write the NIS+ query is
6842 .code
6843 [name="${quote_nisplus:$local_part}"]
6844 .endd
6845 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6846 operator can be used for all lookup types, but has no effect for single-key
6847 lookups, since no quoting is ever needed in their key strings.
6848
6849
6850
6851
6852 .section "More about dnsdb" "SECTdnsdb"
6853 .cindex "dnsdb lookup"
6854 .cindex "lookup" "dnsdb"
6855 .cindex "DNS" "as a lookup type"
6856 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6857 of a record type and a domain name, separated by an equals sign. For example,
6858 an expansion string could contain:
6859 .code
6860 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6861 .endd
6862 If the lookup succeeds, the result is placed in &$value$&, which in this case
6863 is used on its own as the result. If the lookup does not succeed, the
6864 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6865 &<<SECTforexpfai>>& for an explanation of what this means.
6866
6867 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6868 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6869 configured). If no type is given, TXT is assumed. When the type is PTR,
6870 the data can be an IP address, written as normal; inversion and the addition of
6871 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6872 .code
6873 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6874 .endd
6875 If the data for a PTR record is not a syntactically valid IP address, it is not
6876 altered and nothing is added.
6877
6878 For any record type, if multiple records are found (or, for A6 lookups, if a
6879 single record leads to multiple addresses), the data is returned as a
6880 concatenation, with newline as the default separator. The order, of course,
6881 depends on the DNS resolver. You can specify a different separator character
6882 between multiple records by putting a right angle-bracket followed immediately
6883 by the new separator at the start of the query. For example:
6884 .code
6885 ${lookup dnsdb{>: a=host1.example}}
6886 .endd
6887 It is permitted to specify a space as the separator character. Further
6888 white space is ignored.
6889
6890 .cindex "MX record" "in &(dnsdb)& lookup"
6891 .cindex "SRV record" "in &(dnsdb)& lookup"
6892 For an MX lookup, both the preference value and the host name are returned for
6893 each record, separated by a space. For an SRV lookup, the priority, weight,
6894 port, and host name are returned for each record, separated by spaces.
6895 .new
6896 An alternate field separator can be specified using a comma after the main
6897 separator character, followed immediately by the field separator.
6898 .wen
6899
6900 .cindex "TXT record" "in &(dnsdb)& lookup"
6901 .cindex "SPF record" "in &(dnsdb)& lookup"
6902 For TXT records with multiple items of data, only the first item is returned,
6903 unless a separator for them is specified using a comma after the separator
6904 character followed immediately by the TXT record item separator. To concatenate
6905 items without a separator, use a semicolon instead. For SPF records the
6906 default behaviour is to concatenate multiple items without using a separator.
6907 .code
6908 ${lookup dnsdb{>\n,: txt=a.b.example}}
6909 ${lookup dnsdb{>\n; txt=a.b.example}}
6910 ${lookup dnsdb{spf=example.org}}
6911 .endd
6912 It is permitted to specify a space as the separator character. Further
6913 white space is ignored.
6914
6915 .section "Pseudo dnsdb record types" "SECID66"
6916 .cindex "MX record" "in &(dnsdb)& lookup"
6917 By default, both the preference value and the host name are returned for
6918 each MX record, separated by a space. If you want only host names, you can use
6919 the pseudo-type MXH:
6920 .code
6921 ${lookup dnsdb{mxh=a.b.example}}
6922 .endd
6923 In this case, the preference values are omitted, and just the host names are
6924 returned.
6925
6926 .cindex "name server for enclosing domain"
6927 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6928 records on the given domain, but if none are found, it removes the first
6929 component of the domain name, and tries again. This process continues until NS
6930 records are found or there are no more components left (or there is a DNS
6931 error). In other words, it may return the name servers for a top-level domain,
6932 but it never returns the root name servers. If there are no NS records for the
6933 top-level domain, the lookup fails. Consider these examples:
6934 .code
6935 ${lookup dnsdb{zns=xxx.quercite.com}}
6936 ${lookup dnsdb{zns=xxx.edu}}
6937 .endd
6938 Assuming that in each case there are no NS records for the full domain name,
6939 the first returns the name servers for &%quercite.com%&, and the second returns
6940 the name servers for &%edu%&.
6941
6942 You should be careful about how you use this lookup because, unless the
6943 top-level domain does not exist, the lookup always returns some host names. The
6944 sort of use to which this might be put is for seeing if the name servers for a
6945 given domain are on a blacklist. You can probably assume that the name servers
6946 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6947 such a list.
6948
6949 .cindex "CSA" "in &(dnsdb)& lookup"
6950 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6951 records according to the CSA rules, which are described in section
6952 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6953 not sufficient because of the extra parent domain search behaviour of CSA. The
6954 result of a successful lookup such as:
6955 .code
6956 ${lookup dnsdb {csa=$sender_helo_name}}
6957 .endd
6958 has two space-separated fields: an authorization code and a target host name.
6959 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6960 authorization required but absent, or &"?"& for unknown.
6961
6962 .cindex "A+" "in &(dnsdb)& lookup"
6963 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6964 and then an A lookup.  All results are returned; defer processing
6965 (see below) is handled separately for each lookup.  Example:
6966 .code
6967 ${lookup dnsdb {>; a+=$sender_helo_name}}
6968 .endd
6969
6970
6971 .section "Multiple dnsdb lookups" "SECID67"
6972 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6973 However, you can specify a list of domains or IP addresses in a single
6974 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6975 the default separator, but with the ability to change this. For example:
6976 .code
6977 ${lookup dnsdb{one.domain.com:two.domain.com}}
6978 ${lookup dnsdb{a=one.host.com:two.host.com}}
6979 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6980 .endd
6981 In order to retain backwards compatibility, there is one special case: if
6982 the lookup type is PTR and no change of separator is specified, Exim looks
6983 to see if the rest of the string is precisely one IPv6 address. In this
6984 case, it does not treat it as a list.
6985
6986 The data from each lookup is concatenated, with newline separators by default,
6987 in the same way that multiple DNS records for a single item are handled. A
6988 different separator can be specified, as described above.
6989
6990 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6991 each followed by a comma,
6992 that may appear before the record type.
6993
6994 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6995 temporary DNS error for any of them, the behaviour is controlled by
6996 a defer-option modifier.
6997 The possible keywords are
6998 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6999 With &"strict"& behaviour, any temporary DNS error causes the
7000 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7001 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7002 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7003 error causes the whole lookup to defer only if none of the other lookups
7004 succeed. The default is &"lax"&, so the following lookups are equivalent:
7005 .code
7006 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7007 ${lookup dnsdb{a=one.host.com:two.host.com}}
7008 .endd
7009 Thus, in the default case, as long as at least one of the DNS lookups
7010 yields some data, the lookup succeeds.
7011
7012 .cindex "DNSSEC" "dns lookup"
7013 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7014 The possible keywords are
7015 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7016 With &"strict"& or &"lax"& DNSSEC information is requested
7017 with the lookup.
7018 With &"strict"& a response from the DNS resolver that
7019 is not labelled as authenticated data
7020 is treated as equivalent to a temporary DNS error.
7021 The default is &"never"&.
7022
7023 See also the &$lookup_dnssec_authenticated$& variable.
7024
7025
7026
7027
7028 .section "More about LDAP" "SECTldap"
7029 .cindex "LDAP" "lookup, more about"
7030 .cindex "lookup" "LDAP"
7031 .cindex "Solaris" "LDAP"
7032 The original LDAP implementation came from the University of Michigan; this has
7033 become &"Open LDAP"&, and there are now two different releases. Another
7034 implementation comes from Netscape, and Solaris 7 and subsequent releases
7035 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7036 the lookup function level, their error handling is different. For this reason
7037 it is necessary to set a compile-time variable when building Exim with LDAP, to
7038 indicate which LDAP library is in use. One of the following should appear in
7039 your &_Local/Makefile_&:
7040 .code
7041 LDAP_LIB_TYPE=UMICHIGAN
7042 LDAP_LIB_TYPE=OPENLDAP1
7043 LDAP_LIB_TYPE=OPENLDAP2
7044 LDAP_LIB_TYPE=NETSCAPE
7045 LDAP_LIB_TYPE=SOLARIS
7046 .endd
7047 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7048 same interface as the University of Michigan version.
7049
7050 There are three LDAP lookup types in Exim. These behave slightly differently in
7051 the way they handle the results of a query:
7052
7053 .ilist
7054 &(ldap)& requires the result to contain just one entry; if there are more, it
7055 gives an error.
7056 .next
7057 &(ldapdn)& also requires the result to contain just one entry, but it is the
7058 Distinguished Name that is returned rather than any attribute values.
7059 .next
7060 &(ldapm)& permits the result to contain more than one entry; the attributes
7061 from all of them are returned.
7062 .endlist
7063
7064
7065 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7066 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7067 the data returned by a successful lookup is described in the next section.
7068 First we explain how LDAP queries are coded.
7069
7070
7071 .section "Format of LDAP queries" "SECTforldaque"
7072 .cindex "LDAP" "query format"
7073 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7074 the configuration of a &(redirect)& router one might have this setting:
7075 .code
7076 data = ${lookup ldap \
7077   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7078   c=UK?mailbox?base?}}
7079 .endd
7080 .cindex "LDAP" "with TLS"
7081 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7082 secure (encrypted) LDAP connections. The second of these ensures that an
7083 encrypted TLS connection is used.
7084
7085 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7086 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7087 See the &%ldap_start_tls%& option.
7088
7089 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7090 controlled. Every part of the TLS configuration can be configured by settings in
7091 &_exim.conf_&. Depending on the version of the client libraries installed on
7092 your system, some of the initialization may have required setting options in
7093 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7094 certificates. This revealed a nuance where the current UID that exim was
7095 running as could affect which config files it read. With Exim 4.83, these
7096 methods become optional, only taking effect if not specifically set in
7097 &_exim.conf_&.
7098
7099
7100 .section "LDAP quoting" "SECID68"
7101 .cindex "LDAP" "quoting"
7102 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7103 and the second because the LDAP query is represented as a URL. Furthermore,
7104 within an LDAP query, two different kinds of quoting are required. For this
7105 reason, there are two different LDAP-specific quoting operators.
7106
7107 The &%quote_ldap%& operator is designed for use on strings that are part of
7108 filter specifications. Conceptually, it first does the following conversions on
7109 the string:
7110 .code
7111 *   =>   \2A
7112 (   =>   \28
7113 )   =>   \29
7114 \   =>   \5C
7115 .endd
7116 in accordance with RFC 2254. The resulting string is then quoted according
7117 to the rules for URLs, that is, all non-alphanumeric characters except
7118 .code
7119 ! $ ' - . _ ( ) * +
7120 .endd
7121 are converted to their hex values, preceded by a percent sign. For example:
7122 .code
7123 ${quote_ldap: a(bc)*, a<yz>; }
7124 .endd
7125 yields
7126 .code
7127 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7128 .endd
7129 Removing the URL quoting, this is (with a leading and a trailing space):
7130 .code
7131 a\28bc\29\2A, a<yz>;
7132 .endd
7133 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7134 base DN specifications in queries. Conceptually, it first converts the string
7135 by inserting a backslash in front of any of the following characters:
7136 .code
7137 , + " \ < > ;
7138 .endd
7139 It also inserts a backslash before any leading spaces or # characters, and
7140 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7141 is then quoted according to the rules for URLs. For example:
7142 .code
7143 ${quote_ldap_dn: a(bc)*, a<yz>; }
7144 .endd
7145 yields
7146 .code
7147 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7148 .endd
7149 Removing the URL quoting, this is (with a trailing space):
7150 .code
7151 \ a(bc)*\, a\<yz\>\;\
7152 .endd
7153 There are some further comments about quoting in the section on LDAP
7154 authentication below.
7155
7156
7157 .section "LDAP connections" "SECID69"
7158 .cindex "LDAP" "connections"
7159 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7160 is in use, via a Unix domain socket. The example given above does not specify
7161 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7162 by starting it with
7163 .code
7164 ldap://<hostname>:<port>/...
7165 .endd
7166 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7167 used. When no server is specified in a query, a list of default servers is
7168 taken from the &%ldap_default_servers%& configuration option. This supplies a
7169 colon-separated list of servers which are tried in turn until one successfully
7170 handles a query, or there is a serious error. Successful handling either
7171 returns the requested data, or indicates that it does not exist. Serious errors
7172 are syntactical, or multiple values when only a single value is expected.
7173 Errors which cause the next server to be tried are connection failures, bind
7174 failures, and timeouts.
7175
7176 For each server name in the list, a port number can be given. The standard way
7177 of specifying a host and port is to use a colon separator (RFC 1738). Because
7178 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7179 doubled. For example
7180 .code
7181 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7182 .endd
7183 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7184 to the LDAP library with no server name, and the library's default (normally
7185 the local host) is used.
7186
7187 If you are using the OpenLDAP library, you can connect to an LDAP server using
7188 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7189 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7190 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7191 not available.
7192
7193 For this type of connection, instead of a host name for the server, a pathname
7194 for the socket is required, and the port number is not relevant. The pathname
7195 can be specified either as an item in &%ldap_default_servers%&, or inline in
7196 the query. In the former case, you can have settings such as
7197 .code
7198 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7199 .endd
7200 When the pathname is given in the query, you have to escape the slashes as
7201 &`%2F`& to fit in with the LDAP URL syntax. For example:
7202 .code
7203 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7204 .endd
7205 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7206 a pathname, it uses the Unix domain socket code, even if the query actually
7207 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7208 socket connection. This behaviour means that you can use a setting of
7209 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7210 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7211 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7212 backup host.
7213
7214 If an explicit &`ldapi`& type is given in a query when a host name is
7215 specified, an error is diagnosed. However, if there are more items in
7216 &%ldap_default_servers%&, they are tried. In other words:
7217
7218 .ilist
7219 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7220 interface.
7221 .next
7222 Using &`ldapi`& with a host name causes an error.
7223 .endlist
7224
7225
7226 Using &`ldapi`& with no host or path in the query, and no setting of
7227 &%ldap_default_servers%&, does whatever the library does by default.
7228
7229
7230
7231 .section "LDAP authentication and control information" "SECID70"
7232 .cindex "LDAP" "authentication"
7233 The LDAP URL syntax provides no way of passing authentication and other control
7234 information to the server. To make this possible, the URL in an LDAP query may
7235 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7236 spaces. If a value contains spaces it must be enclosed in double quotes, and
7237 when double quotes are used, backslash is interpreted in the usual way inside
7238 them. The following names are recognized:
7239 .display
7240 &`DEREFERENCE`&  set the dereferencing parameter
7241 &`NETTIME    `&  set a timeout for a network operation
7242 &`USER       `&  set the DN, for authenticating the LDAP bind
7243 &`PASS       `&  set the password, likewise
7244 &`REFERRALS  `&  set the referrals parameter
7245 &`SERVERS    `&  set alternate server list for this query only
7246 &`SIZE       `&  set the limit for the number of entries returned
7247 &`TIME       `&  set the maximum waiting time for a query
7248 .endd
7249 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7250 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7251 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7252 library from trying to follow referrals issued by the LDAP server.
7253
7254 The name CONNECT is an obsolete name for NETTIME, retained for
7255 backwards compatibility. This timeout (specified as a number of seconds) is
7256 enforced from the client end for operations that can be carried out over a
7257 network. Specifically, it applies to network connections and calls to the
7258 &'ldap_result()'& function. If the value is greater than zero, it is used if
7259 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7260 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7261 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7262 Netscape SDK; for OpenLDAP no action is taken.
7263
7264 The TIME parameter (also a number of seconds) is passed to the server to
7265 set a server-side limit on the time taken to complete a search.
7266
7267 The SERVERS parameter allows you to specify an alternate list of ldap servers
7268 to use for an individual lookup.  The global ldap_servers option provides a
7269 default list of ldap servers, and a single lookup can specify a single ldap
7270 server to use.  But when you need to do a lookup with a list of servers that is
7271 different than the default list (maybe different order, maybe a completely
7272 different set of servers), the SERVERS parameter allows you to specify this
7273 alternate list (colon-separated).
7274
7275 Here is an example of an LDAP query in an Exim lookup that uses some of these
7276 values. This is a single line, folded to fit on the page:
7277 .code
7278 ${lookup ldap
7279   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7280   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7281   {$value}fail}
7282 .endd
7283 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7284 any of the auxiliary data. Exim configuration settings that include lookups
7285 which contain password information should be preceded by &"hide"& to prevent
7286 non-admin users from using the &%-bP%& option to see their values.
7287
7288 The auxiliary data items may be given in any order. The default is no
7289 connection timeout (the system timeout is used), no user or password, no limit
7290 on the number of entries returned, and no time limit on queries.
7291
7292 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7293 removes any URL quoting that it may contain before passing it LDAP. Apparently
7294 some libraries do this for themselves, but some do not. Removing the URL
7295 quoting has two advantages:
7296
7297 .ilist
7298 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7299 DNs as with DNs inside actual queries.
7300 .next
7301 It permits spaces inside USER= DNs.
7302 .endlist
7303
7304 For example, a setting such as
7305 .code
7306 USER=cn=${quote_ldap_dn:$1}
7307 .endd
7308 should work even if &$1$& contains spaces.
7309
7310 Expanded data for the PASS= value should be quoted using the &%quote%&
7311 expansion operator, rather than the LDAP quote operators. The only reason this
7312 field needs quoting is to ensure that it conforms to the Exim syntax, which
7313 does not allow unquoted spaces. For example:
7314 .code
7315 PASS=${quote:$3}
7316 .endd
7317 The LDAP authentication mechanism can be used to check passwords as part of
7318 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7319 &<<CHAPexpand>>&.
7320
7321
7322
7323 .section "Format of data returned by LDAP" "SECID71"
7324 .cindex "LDAP" "returned data formats"
7325 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7326 as a sequence of values, for example
7327 .code
7328 cn=manager, o=University of Cambridge, c=UK
7329 .endd
7330 The &(ldap)& lookup type generates an error if more than one entry matches the
7331 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7332 the result between the data from different entries. It is possible for multiple
7333 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7334 you know that whatever values are returned all came from a single entry in the
7335 directory.
7336
7337 In the common case where you specify a single attribute in your LDAP query, the
7338 result is not quoted, and does not contain the attribute name. If the attribute
7339 has multiple values, they are separated by commas.
7340
7341 If you specify multiple attributes, the result contains space-separated, quoted
7342 strings, each preceded by the attribute name and an equals sign. Within the
7343 quotes, the quote character, backslash, and newline are escaped with
7344 backslashes, and commas are used to separate multiple values for the attribute.
7345 .new
7346 Any commas in attribute values are doubled
7347 (permitting treatment of the values as a comma-separated list).
7348 .wen
7349 Apart from the escaping, the string within quotes takes the same form as the
7350 output when a single attribute is requested. Specifying no attributes is the
7351 same as specifying all of an entry's attributes.
7352
7353 .new
7354 Here are some examples of the output format. The first line of each pair is an
7355 LDAP query, and the second is the data that is returned. The attribute called
7356 &%attr1%& has two values, one of them with an embedded comma, whereas
7357 &%attr2%& has only one value:
7358 .code
7359 ldap:///o=base?attr1?sub?(uid=fred)
7360 value1.1,value1,,2
7361
7362 ldap:///o=base?attr2?sub?(uid=fred)
7363 value two
7364
7365 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7366 attr1="value1.1,value1,,2" attr2="value two"
7367
7368 ldap:///o=base??sub?(uid=fred)
7369 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7370 .endd
7371 .wen
7372 You can
7373 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7374 results of LDAP lookups.
7375 The &%extract%& operator in string expansions can be used to pick out
7376 individual fields from data that consists of &'key'&=&'value'& pairs.
7377 .new
7378 The &%listextract%& operator should be used to pick out individual values
7379 of attributes, even when only a single value is expected.
7380 The doubling of embedded commas allows you to use the returned data as a
7381 comma separated list (using the "<," syntax for changing the input list separator).
7382 .wen
7383
7384
7385
7386
7387 .section "More about NIS+" "SECTnisplus"
7388 .cindex "NIS+ lookup type"
7389 .cindex "lookup" "NIS+"
7390 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7391 and field name. If this is given, the result of a successful query is the
7392 contents of the named field; otherwise the result consists of a concatenation
7393 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7394 values containing spaces are quoted. For example, the query
7395 .code
7396 [name=mg1456],passwd.org_dir
7397 .endd
7398 might return the string
7399 .code
7400 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7401 home=/home/mg1456 shell=/bin/bash shadow=""
7402 .endd
7403 (split over two lines here to fit on the page), whereas
7404 .code
7405 [name=mg1456],passwd.org_dir:gcos
7406 .endd
7407 would just return
7408 .code
7409 Martin Guerre
7410 .endd
7411 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7412 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7413 operator is to double any quote characters within the text.
7414
7415
7416
7417 .section "SQL lookups" "SECTsql"
7418 .cindex "SQL lookup types"
7419 .cindex "MySQL" "lookup type"
7420 .cindex "PostgreSQL lookup type"
7421 .cindex "lookup" "MySQL"
7422 .cindex "lookup" "PostgreSQL"
7423 .cindex "Oracle" "lookup type"
7424 .cindex "lookup" "Oracle"
7425 .cindex "InterBase lookup type"
7426 .cindex "lookup" "InterBase"
7427 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7428 databases. Queries for these databases contain SQL statements, so an example
7429 might be
7430 .code
7431 ${lookup mysql{select mailbox from users where id='userx'}\
7432   {$value}fail}
7433 .endd
7434 If the result of the query contains more than one field, the data for each
7435 field in the row is returned, preceded by its name, so the result of
7436 .code
7437 ${lookup pgsql{select home,name from users where id='userx'}\
7438   {$value}}
7439 .endd
7440 might be
7441 .code
7442 home=/home/userx name="Mister X"
7443 .endd
7444 Empty values and values containing spaces are double quoted, with embedded
7445 quotes escaped by a backslash. If the result of the query contains just one
7446 field, the value is passed back verbatim, without a field name, for example:
7447 .code
7448 Mister X
7449 .endd
7450 If the result of the query yields more than one row, it is all concatenated,
7451 with a newline between the data for each row.
7452
7453
7454 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7455 .cindex "MySQL" "lookup type"
7456 .cindex "PostgreSQL lookup type"
7457 .cindex "lookup" "MySQL"
7458 .cindex "lookup" "PostgreSQL"
7459 .cindex "Oracle" "lookup type"
7460 .cindex "lookup" "Oracle"
7461 .cindex "InterBase lookup type"
7462 .cindex "lookup" "InterBase"
7463 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7464 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7465 option (as appropriate) must be set to a colon-separated list of server
7466 information.
7467 (For MySQL and PostgreSQL only, the global option need not be set if all
7468 queries contain their own server information &-- see section
7469 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7470 items: host name, database name, user name, and password. In the case of
7471 Oracle, the host name field is used for the &"service name"&, and the database
7472 name field is not used and should be empty. For example:
7473 .code
7474 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7475 .endd
7476 Because password data is sensitive, you should always precede the setting with
7477 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7478 option. Here is an example where two MySQL servers are listed:
7479 .code
7480 hide mysql_servers = localhost/users/root/secret:\
7481                      otherhost/users/root/othersecret
7482 .endd
7483 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7484 because this is a colon-separated list, the colon has to be doubled. For each
7485 query, these parameter groups are tried in order until a connection is made and
7486 a query is successfully processed. The result of a query may be that no data is
7487 found, but that is still a successful query. In other words, the list of
7488 servers provides a backup facility, not a list of different places to look.
7489
7490 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7491 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7492 respectively, and the characters single-quote, double-quote, and backslash
7493 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7494 addition, escapes the percent and underscore characters. This cannot be done
7495 for MySQL because these escapes are not recognized in contexts where these
7496 characters are not special.
7497
7498 .section "Specifying the server in the query" "SECTspeserque"
7499 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7500 it is possible to specify a list of servers with an individual query. This is
7501 done by starting the query with
7502 .display
7503 &`servers=`&&'server1:server2:server3:...'&&`;`&
7504 .endd
7505 Each item in the list may take one of two forms:
7506 .olist
7507 If it contains no slashes it is assumed to be just a host name. The appropriate
7508 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7509 of the same name, and the remaining parameters (database, user, password) are
7510 taken from there.
7511 .next
7512 If it contains any slashes, it is taken as a complete parameter set.
7513 .endlist
7514 The list of servers is used in exactly the same way as the global list.
7515 Once a connection to a server has happened and a query has been
7516 successfully executed, processing of the lookup ceases.
7517
7518 This feature is intended for use in master/slave situations where updates
7519 are occurring and you want to update the master rather than a slave. If the
7520 master is in the list as a backup for reading, you might have a global setting
7521 like this:
7522 .code
7523 mysql_servers = slave1/db/name/pw:\
7524                 slave2/db/name/pw:\
7525                 master/db/name/pw
7526 .endd
7527 In an updating lookup, you could then write:
7528 .code
7529 ${lookup mysql{servers=master; UPDATE ...} }
7530 .endd
7531 That query would then be sent only to the master server. If, on the other hand,
7532 the master is not to be used for reading, and so is not present in the global
7533 option, you can still update it by a query of this form:
7534 .code
7535 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7536 .endd
7537
7538
7539 .section "Special MySQL features" "SECID73"
7540 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7541 causes a connection to the server on the local host by means of a Unix domain
7542 socket. An alternate socket can be specified in parentheses. The full syntax of
7543 each item in &%mysql_servers%& is:
7544 .display
7545 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7546   <&'user'&>/<&'password'&>
7547 .endd
7548 Any of the three sub-parts of the first field can be omitted. For normal use on
7549 the local host it can be left blank or set to just &"localhost"&.
7550
7551 No database need be supplied &-- but if it is absent here, it must be given in
7552 the queries.
7553
7554 If a MySQL query is issued that does not request any data (an insert, update,
7555 or delete command), the result of the lookup is the number of rows affected.
7556
7557 &*Warning*&: This can be misleading. If an update does not actually change
7558 anything (for example, setting a field to the value it already has), the result
7559 is zero because no rows are affected.
7560
7561
7562 .section "Special PostgreSQL features" "SECID74"
7563 PostgreSQL lookups can also use Unix domain socket connections to the database.
7564 This is usually faster and costs less CPU time than a TCP/IP connection.
7565 However it can be used only if the mail server runs on the same machine as the
7566 database server. A configuration line for PostgreSQL via Unix domain sockets
7567 looks like this:
7568 .code
7569 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7570 .endd
7571 In other words, instead of supplying a host name, a path to the socket is
7572 given. The path name is enclosed in parentheses so that its slashes aren't
7573 visually confused with the delimiters for the other server parameters.
7574
7575 If a PostgreSQL query is issued that does not request any data (an insert,
7576 update, or delete command), the result of the lookup is the number of rows
7577 affected.
7578
7579 .section "More about SQLite" "SECTsqlite"
7580 .cindex "lookup" "SQLite"
7581 .cindex "sqlite lookup type"
7582 SQLite is different to the other SQL lookups because a file name is required in
7583 addition to the SQL query. An SQLite database is a single file, and there is no
7584 daemon as in the other SQL databases. The interface to Exim requires the name
7585 of the file, as an absolute path, to be given at the start of the query. It is
7586 separated from the query by white space. This means that the path name cannot
7587 contain white space. Here is a lookup expansion example:
7588 .code
7589 ${lookup sqlite {/some/thing/sqlitedb \
7590   select name from aliases where id='userx';}}
7591 .endd
7592 In a list, the syntax is similar. For example:
7593 .code
7594 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7595    select * from relays where ip='$sender_host_address';
7596 .endd
7597 The only character affected by the &%quote_sqlite%& operator is a single
7598 quote, which it doubles.
7599
7600 The SQLite library handles multiple simultaneous accesses to the database
7601 internally. Multiple readers are permitted, but only one process can
7602 update at once. Attempts to access the database while it is being updated
7603 are rejected after a timeout period, during which the SQLite library
7604 waits for the lock to be released. In Exim, the default timeout is set
7605 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7606 option.
7607 .ecindex IIDfidalo1
7608 .ecindex IIDfidalo2
7609
7610
7611 . ////////////////////////////////////////////////////////////////////////////
7612 . ////////////////////////////////////////////////////////////////////////////
7613
7614 .chapter "Domain, host, address, and local part lists" &&&
7615          "CHAPdomhosaddlists" &&&
7616          "Domain, host, and address lists"
7617 .scindex IIDdohoadli "lists of domains; hosts; etc."
7618 A number of Exim configuration options contain lists of domains, hosts,
7619 email addresses, or local parts. For example, the &%hold_domains%& option
7620 contains a list of domains whose delivery is currently suspended. These lists
7621 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7622 arguments to expansion conditions such as &%match_domain%&.
7623
7624 Each item in one of these lists is a pattern to be matched against a domain,
7625 host, email address, or local part, respectively. In the sections below, the
7626 different types of pattern for each case are described, but first we cover some
7627 general facilities that apply to all four kinds of list.
7628
7629
7630
7631 .section "Expansion of lists" "SECID75"
7632 .cindex "expansion" "of lists"
7633 Each list is expanded as a single string before it is used. The result of
7634 expansion must be a list, possibly containing empty items, which is split up
7635 into separate items for matching. By default, colon is the separator character,
7636 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7637 &<<SECTempitelis>>& for details of the list syntax; the second of these
7638 discusses the way to specify empty list items.
7639
7640
7641 If the string expansion is forced to fail, Exim behaves as if the item it is
7642 testing (domain, host, address, or local part) is not in the list. Other
7643 expansion failures cause temporary errors.
7644
7645 If an item in a list is a regular expression, backslashes, dollars and possibly
7646 other special characters in the expression must be protected against
7647 misinterpretation by the string expander. The easiest way to do this is to use
7648 the &`\N`& expansion feature to indicate that the contents of the regular
7649 expression should not be expanded. For example, in an ACL you might have:
7650 .code
7651 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7652                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7653 .endd
7654 The first item is a regular expression that is protected from expansion by
7655 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7656 senders based on the receiving domain.
7657
7658
7659
7660
7661 .section "Negated items in lists" "SECID76"
7662 .cindex "list" "negation"
7663 .cindex "negation" "in lists"
7664 Items in a list may be positive or negative. Negative items are indicated by a
7665 leading exclamation mark, which may be followed by optional white space. A list
7666 defines a set of items (domains, etc). When Exim processes one of these lists,
7667 it is trying to find out whether a domain, host, address, or local part
7668 (respectively) is in the set that is defined by the list. It works like this:
7669
7670 The list is scanned from left to right. If a positive item is matched, the
7671 subject that is being checked is in the set; if a negative item is matched, the
7672 subject is not in the set. If the end of the list is reached without the
7673 subject having matched any of the patterns, it is in the set if the last item
7674 was a negative one, but not if it was a positive one. For example, the list in
7675 .code
7676 domainlist relay_to_domains = !a.b.c : *.b.c
7677 .endd
7678 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7679 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7680 list is positive. However, if the setting were
7681 .code
7682 domainlist relay_to_domains = !a.b.c
7683 .endd
7684 then all domains other than &'a.b.c'& would match because the last item in the
7685 list is negative. In other words, a list that ends with a negative item behaves
7686 as if it had an extra item &`:*`& on the end.
7687
7688 Another way of thinking about positive and negative items in lists is to read
7689 the connector as &"or"& after a positive item and as &"and"& after a negative
7690 item.
7691
7692
7693
7694 .section "File names in lists" "SECTfilnamlis"
7695 .cindex "list" "file name in"
7696 If an item in a domain, host, address, or local part list is an absolute file
7697 name (beginning with a slash character), each line of the file is read and
7698 processed as if it were an independent item in the list, except that further
7699 file names are not allowed,
7700 and no expansion of the data from the file takes place.
7701 Empty lines in the file are ignored, and the file may also contain comment
7702 lines:
7703
7704 .ilist
7705 For domain and host lists, if a # character appears anywhere in a line of the
7706 file, it and all following characters are ignored.
7707 .next
7708 Because local parts may legitimately contain # characters, a comment in an
7709 address list or local part list file is recognized only if # is preceded by
7710 white space or the start of the line. For example:
7711 .code
7712 not#comment@x.y.z   # but this is a comment
7713 .endd
7714 .endlist
7715
7716 Putting a file name in a list has the same effect as inserting each line of the
7717 file as an item in the list (blank lines and comments excepted). However, there
7718 is one important difference: the file is read each time the list is processed,
7719 so if its contents vary over time, Exim's behaviour changes.
7720
7721 If a file name is preceded by an exclamation mark, the sense of any match
7722 within the file is inverted. For example, if
7723 .code
7724 hold_domains = !/etc/nohold-domains
7725 .endd
7726 and the file contains the lines
7727 .code
7728 !a.b.c
7729 *.b.c
7730 .endd
7731 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7732 any domain matching &`*.b.c`& is not.
7733
7734
7735
7736 .section "An lsearch file is not an out-of-line list" "SECID77"
7737 As will be described in the sections that follow, lookups can be used in lists
7738 to provide indexed methods of checking list membership. There has been some
7739 confusion about the way &(lsearch)& lookups work in lists. Because
7740 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7741 sometimes thought that it is allowed to contain wild cards and other kinds of
7742 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7743 always fixed strings, just as for any other single-key lookup type.
7744
7745 If you want to use a file to contain wild-card patterns that form part of a
7746 list, just give the file name on its own, without a search type, as described
7747 in the previous section. You could also use the &(wildlsearch)& or
7748 &(nwildlsearch)&, but there is no advantage in doing this.
7749
7750
7751
7752
7753 .section "Named lists" "SECTnamedlists"
7754 .cindex "named lists"
7755 .cindex "list" "named"
7756 A list of domains, hosts, email addresses, or local parts can be given a name
7757 which is then used to refer to the list elsewhere in the configuration. This is
7758 particularly convenient if the same list is required in several different
7759 places. It also allows lists to be given meaningful names, which can improve
7760 the readability of the configuration. For example, it is conventional to define
7761 a domain list called &'local_domains'& for all the domains that are handled
7762 locally on a host, using a configuration line such as
7763 .code
7764 domainlist local_domains = localhost:my.dom.example
7765 .endd
7766 Named lists are referenced by giving their name preceded by a plus sign, so,
7767 for example, a router that is intended to handle local domains would be
7768 configured with the line
7769 .code
7770 domains = +local_domains
7771 .endd
7772 The first router in a configuration is often one that handles all domains
7773 except the local ones, using a configuration with a negated item like this:
7774 .code
7775 dnslookup:
7776   driver = dnslookup
7777   domains = ! +local_domains
7778   transport = remote_smtp
7779   no_more
7780 .endd
7781 The four kinds of named list are created by configuration lines starting with
7782 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7783 respectively. Then there follows the name that you are defining, followed by an
7784 equals sign and the list itself. For example:
7785 .code
7786 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7787 addresslist bad_senders = cdb;/etc/badsenders
7788 .endd
7789 A named list may refer to other named lists:
7790 .code
7791 domainlist  dom1 = first.example : second.example
7792 domainlist  dom2 = +dom1 : third.example
7793 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7794 .endd
7795 &*Warning*&: If the last item in a referenced list is a negative one, the
7796 effect may not be what you intended, because the negation does not propagate
7797 out to the higher level. For example, consider:
7798 .code
7799 domainlist  dom1 = !a.b
7800 domainlist  dom2 = +dom1 : *.b
7801 .endd
7802 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7803 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7804 means it matches the second list as well. The effect is not the same as
7805 .code
7806 domainlist  dom2 = !a.b : *.b
7807 .endd
7808 where &'x.y'& does not match. It's best to avoid negation altogether in
7809 referenced lists if you can.
7810
7811 Named lists may have a performance advantage. When Exim is routing an
7812 address or checking an incoming message, it caches the result of tests on named
7813 lists. So, if you have a setting such as
7814 .code
7815 domains = +local_domains
7816 .endd
7817 on several of your routers
7818 or in several ACL statements,
7819 the actual test is done only for the first one. However, the caching works only
7820 if there are no expansions within the list itself or any sublists that it
7821 references. In other words, caching happens only for lists that are known to be
7822 the same each time they are referenced.
7823
7824 By default, there may be up to 16 named lists of each type. This limit can be
7825 extended by changing a compile-time variable. The use of domain and host lists
7826 is recommended for concepts such as local domains, relay domains, and relay
7827 hosts. The default configuration is set up like this.
7828
7829
7830
7831 .section "Named lists compared with macros" "SECID78"
7832 .cindex "list" "named compared with macro"
7833 .cindex "macro" "compared with named list"
7834 At first sight, named lists might seem to be no different from macros in the
7835 configuration file. However, macros are just textual substitutions. If you
7836 write
7837 .code
7838 ALIST = host1 : host2
7839 auth_advertise_hosts = !ALIST
7840 .endd
7841 it probably won't do what you want, because that is exactly the same as
7842 .code
7843 auth_advertise_hosts = !host1 : host2
7844 .endd
7845 Notice that the second host name is not negated. However, if you use a host
7846 list, and write
7847 .code
7848 hostlist alist = host1 : host2
7849 auth_advertise_hosts = ! +alist
7850 .endd
7851 the negation applies to the whole list, and so that is equivalent to
7852 .code
7853 auth_advertise_hosts = !host1 : !host2
7854 .endd
7855
7856
7857 .section "Named list caching" "SECID79"
7858 .cindex "list" "caching of named"
7859 .cindex "caching" "named lists"
7860 While processing a message, Exim caches the result of checking a named list if
7861 it is sure that the list is the same each time. In practice, this means that
7862 the cache operates only if the list contains no $ characters, which guarantees
7863 that it will not change when it is expanded. Sometimes, however, you may have
7864 an expanded list that you know will be the same each time within a given
7865 message. For example:
7866 .code
7867 domainlist special_domains = \
7868            ${lookup{$sender_host_address}cdb{/some/file}}
7869 .endd
7870 This provides a list of domains that depends only on the sending host's IP
7871 address. If this domain list is referenced a number of times (for example,
7872 in several ACL lines, or in several routers) the result of the check is not
7873 cached by default, because Exim does not know that it is going to be the
7874 same list each time.
7875
7876 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7877 cache the result anyway. For example:
7878 .code
7879 domainlist_cache special_domains = ${lookup{...
7880 .endd
7881 If you do this, you should be absolutely sure that caching is going to do
7882 the right thing in all cases. When in doubt, leave it out.
7883
7884
7885
7886 .section "Domain lists" "SECTdomainlist"
7887 .cindex "domain list" "patterns for"
7888 .cindex "list" "domain list"
7889 Domain lists contain patterns that are to be matched against a mail domain.
7890 The following types of item may appear in domain lists:
7891
7892 .ilist
7893 .cindex "primary host name"
7894 .cindex "host name" "matched in domain list"
7895 .oindex "&%primary_hostname%&"
7896 .cindex "domain list" "matching primary host name"
7897 .cindex "@ in a domain list"
7898 If a pattern consists of a single @ character, it matches the local host name,
7899 as set by the &%primary_hostname%& option (or defaulted). This makes it
7900 possible to use the same configuration file on several different hosts that
7901 differ only in their names.
7902 .next
7903 .cindex "@[] in a domain list"
7904 .cindex "domain list" "matching local IP interfaces"
7905 .cindex "domain literal"
7906 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7907 in square brackets (as in an email address that contains a domain literal), but
7908 only if that IP address is recognized as local for email routing purposes. The
7909 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7910 control which of a host's several IP addresses are treated as local.
7911 In today's Internet, the use of domain literals is controversial.
7912 .next
7913 .cindex "@mx_any"
7914 .cindex "@mx_primary"
7915 .cindex "@mx_secondary"
7916 .cindex "domain list" "matching MX pointers to local host"
7917 If a pattern consists of the string &`@mx_any`& it matches any domain that
7918 has an MX record pointing to the local host or to any host that is listed in
7919 .oindex "&%hosts_treat_as_local%&"
7920 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7921 are similar, except that the first matches only when a primary MX target is the
7922 local host, and the second only when no primary MX target is the local host,
7923 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7924 preference value &-- there may of course be more than one of them.
7925
7926 The MX lookup that takes place when matching a pattern of this type is
7927 performed with the resolver options for widening names turned off. Thus, for
7928 example, a single-component domain will &'not'& be expanded by adding the
7929 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7930 options of the &(dnslookup)& router for a discussion of domain widening.
7931
7932 Sometimes you may want to ignore certain IP addresses when using one of these
7933 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7934 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7935 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7936 on a router). For example:
7937 .code
7938 domains = @mx_any/ignore=127.0.0.1
7939 .endd
7940 This example matches any domain that has an MX record pointing to one of
7941 the local host's IP addresses other than 127.0.0.1.
7942
7943 The list of IP addresses is in fact processed by the same code that processes
7944 host lists, so it may contain CIDR-coded network specifications and it may also
7945 contain negative items.
7946
7947 Because the list of IP addresses is a sublist within a domain list, you have to
7948 be careful about delimiters if there is more than one address. Like any other
7949 list, the default delimiter can be changed. Thus, you might have:
7950 .code
7951 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7952           an.other.domain : ...
7953 .endd
7954 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7955 involved, it is easiest to change the delimiter for the main list as well:
7956 .code
7957 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7958           an.other.domain ? ...
7959 .endd
7960 .next
7961 .cindex "asterisk" "in domain list"
7962 .cindex "domain list" "asterisk in"
7963 .cindex "domain list" "matching &""ends with""&"
7964 If a pattern starts with an asterisk, the remaining characters of the pattern
7965 are compared with the terminating characters of the domain. The use of &"*"& in
7966 domain lists differs from its use in partial matching lookups. In a domain
7967 list, the character following the asterisk need not be a dot, whereas partial
7968 matching works only in terms of dot-separated components. For example, a domain
7969 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7970 &'cipher.key.ex'&.
7971
7972 .next
7973 .cindex "regular expressions" "in domain list"
7974 .cindex "domain list" "matching regular expression"
7975 If a pattern starts with a circumflex character, it is treated as a regular
7976 expression, and matched against the domain using a regular expression matching
7977 function. The circumflex is treated as part of the regular expression.
7978 Email domains are case-independent, so this regular expression match is by
7979 default case-independent, but you can make it case-dependent by starting it
7980 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7981 are given in chapter &<<CHAPregexp>>&.
7982
7983 &*Warning*&: Because domain lists are expanded before being processed, you
7984 must escape any backslash and dollar characters in the regular expression, or
7985 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7986 it is not to be expanded (unless you really do want to build a regular
7987 expression by expansion, of course).
7988 .next
7989 .cindex "lookup" "in domain list"
7990 .cindex "domain list" "matching by lookup"
7991 If a pattern starts with the name of a single-key lookup type followed by a
7992 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7993 must be a file name in a suitable format for the lookup type. For example, for
7994 &"cdb;"& it must be an absolute path:
7995 .code
7996 domains = cdb;/etc/mail/local_domains.cdb
7997 .endd
7998 The appropriate type of lookup is done on the file using the domain name as the
7999 key. In most cases, the data that is looked up is not used; Exim is interested
8000 only in whether or not the key is present in the file. However, when a lookup
8001 is used for the &%domains%& option on a router
8002 or a &%domains%& condition in an ACL statement, the data is preserved in the
8003 &$domain_data$& variable and can be referred to in other router options or
8004 other statements in the same ACL.
8005
8006 .next
8007 Any of the single-key lookup type names may be preceded by
8008 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8009 .code
8010 domains = partial-dbm;/partial/domains
8011 .endd
8012 This causes partial matching logic to be invoked; a description of how this
8013 works is given in section &<<SECTpartiallookup>>&.
8014
8015 .next
8016 .cindex "asterisk" "in lookup type"
8017 Any of the single-key lookup types may be followed by an asterisk. This causes
8018 a default lookup for a key consisting of a single asterisk to be done if the
8019 original lookup fails. This is not a useful feature when using a domain list to
8020 select particular domains (because any domain would match), but it might have
8021 value if the result of the lookup is being used via the &$domain_data$&
8022 expansion variable.
8023 .next
8024 If the pattern starts with the name of a query-style lookup type followed by a
8025 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8026 pattern must be an appropriate query for the lookup type, as described in
8027 chapter &<<CHAPfdlookup>>&. For example:
8028 .code
8029 hold_domains = mysql;select domain from holdlist \
8030   where domain = '${quote_mysql:$domain}';
8031 .endd
8032 In most cases, the data that is looked up is not used (so for an SQL query, for
8033 example, it doesn't matter what field you select). Exim is interested only in
8034 whether or not the query succeeds. However, when a lookup is used for the
8035 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8036 variable and can be referred to in other options.
8037 .next
8038 .cindex "domain list" "matching literal domain name"
8039 If none of the above cases apply, a caseless textual comparison is made
8040 between the pattern and the domain.
8041 .endlist
8042
8043 Here is an example that uses several different kinds of pattern:
8044 .code
8045 domainlist funny_domains = \
8046   @ : \
8047   lib.unseen.edu : \
8048   *.foundation.fict.example : \
8049   \N^[1-2]\d{3}\.fict\.example$\N : \
8050   partial-dbm;/opt/data/penguin/book : \
8051   nis;domains.byname : \
8052   nisplus;[name=$domain,status=local],domains.org_dir
8053 .endd
8054 There are obvious processing trade-offs among the various matching modes. Using
8055 an asterisk is faster than a regular expression, and listing a few names
8056 explicitly probably is too. The use of a file or database lookup is expensive,
8057 but may be the only option if hundreds of names are required. Because the
8058 patterns are tested in order, it makes sense to put the most commonly matched
8059 patterns earlier.
8060
8061
8062
8063 .section "Host lists" "SECThostlist"
8064 .cindex "host list" "patterns in"
8065 .cindex "list" "host list"
8066 Host lists are used to control what remote hosts are allowed to do. For
8067 example, some hosts may be allowed to use the local host as a relay, and some
8068 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8069 two different ways, by name or by IP address. In a host list, some types of
8070 pattern are matched to a host name, and some are matched to an IP address.
8071 You need to be particularly careful with this when single-key lookups are
8072 involved, to ensure that the right value is being used as the key.
8073
8074
8075 .section "Special host list patterns" "SECID80"
8076 .cindex "empty item in hosts list"
8077 .cindex "host list" "empty string in"
8078 If a host list item is the empty string, it matches only when no remote host is
8079 involved. This is the case when a message is being received from a local
8080 process using SMTP on the standard input, that is, when a TCP/IP connection is
8081 not used.
8082
8083 .cindex "asterisk" "in host list"
8084 The special pattern &"*"& in a host list matches any host or no host. Neither
8085 the IP address nor the name is actually inspected.
8086
8087
8088
8089 .section "Host list patterns that match by IP address" "SECThoslispatip"
8090 .cindex "host list" "matching IP addresses"
8091 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8092 the incoming address actually appears in the IPv6 host as
8093 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8094 list, it is converted into a traditional IPv4 address first. (Not all operating
8095 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8096 concerns.)
8097
8098 The following types of pattern in a host list check the remote host by
8099 inspecting its IP address:
8100
8101 .ilist
8102 If the pattern is a plain domain name (not a regular expression, not starting
8103 with *, not a lookup of any kind), Exim calls the operating system function
8104 to find the associated IP address(es). Exim uses the newer
8105 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8106 This typically causes a forward DNS lookup of the name. The result is compared
8107 with the IP address of the subject host.
8108
8109 If there is a temporary problem (such as a DNS timeout) with the host name
8110 lookup, a temporary error occurs. For example, if the list is being used in an
8111 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8112 temporary SMTP error code. If no IP address can be found for the host name,
8113 what happens is described in section &<<SECTbehipnot>>& below.
8114
8115 .next
8116 .cindex "@ in a host list"
8117 If the pattern is &"@"&, the primary host name is substituted and used as a
8118 domain name, as just described.
8119
8120 .next
8121 If the pattern is an IP address, it is matched against the IP address of the
8122 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8123 IPv6 addresses can be given in colon-separated format, but the colons have to
8124 be doubled so as not to be taken as item separators when the default list
8125 separator is used. IPv6 addresses are recognized even when Exim is compiled
8126 without IPv6 support. This means that if they appear in a host list on an
8127 IPv4-only host, Exim will not treat them as host names. They are just addresses
8128 that can never match a client host.
8129
8130 .next
8131 .cindex "@[] in a host list"
8132 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8133 the local host. For example, if the local host is an IPv4 host with one
8134 interface address 10.45.23.56, these two ACL statements have the same effect:
8135 .code
8136 accept hosts = 127.0.0.1 : 10.45.23.56
8137 accept hosts = @[]
8138 .endd
8139 .next
8140 .cindex "CIDR notation"
8141 If the pattern is an IP address followed by a slash and a mask length (for
8142 example 10.11.42.0/24), it is matched against the IP address of the subject
8143 host under the given mask. This allows, an entire network of hosts to be
8144 included (or excluded) by a single item. The mask uses CIDR notation; it
8145 specifies the number of address bits that must match, starting from the most
8146 significant end of the address.
8147
8148 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8149 of a range of addresses. It is the number of bits in the network portion of the
8150 address. The above example specifies a 24-bit netmask, so it matches all 256
8151 addresses in the 10.11.42.0 network. An item such as
8152 .code
8153 192.168.23.236/31
8154 .endd
8155 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8156 32 for an IPv4 address is the same as no mask at all; just a single address
8157 matches.
8158
8159 Here is another example which shows an IPv4 and an IPv6 network:
8160 .code
8161 recipient_unqualified_hosts = 192.168.0.0/16: \
8162                               3ffe::ffff::836f::::/48
8163 .endd
8164 The doubling of list separator characters applies only when these items
8165 appear inline in a host list. It is not required when indirecting via a file.
8166 For example:
8167 .code
8168 recipient_unqualified_hosts = /opt/exim/unqualnets
8169 .endd
8170 could make use of a file containing
8171 .code
8172 172.16.0.0/12
8173 3ffe:ffff:836f::/48
8174 .endd
8175 to have exactly the same effect as the previous example. When listing IPv6
8176 addresses inline, it is usually more convenient to use the facility for
8177 changing separator characters. This list contains the same two networks:
8178 .code
8179 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8180                                  3ffe:ffff:836f::/48
8181 .endd
8182 The separator is changed to semicolon by the leading &"<;"& at the start of the
8183 list.
8184 .endlist
8185
8186
8187
8188 .section "Host list patterns for single-key lookups by host address" &&&
8189          "SECThoslispatsikey"
8190 .cindex "host list" "lookup of IP address"
8191 When a host is to be identified by a single-key lookup of its complete IP
8192 address, the pattern takes this form:
8193 .display
8194 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8195 .endd
8196 For example:
8197 .code
8198 hosts_lookup = net-cdb;/hosts-by-ip.db
8199 .endd
8200 The text form of the IP address of the subject host is used as the lookup key.
8201 IPv6 addresses are converted to an unabbreviated form, using lower case
8202 letters, with dots as separators because colon is the key terminator in
8203 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8204 quoting the keys, but this is a facility that was added later.] The data
8205 returned by the lookup is not used.
8206
8207 .cindex "IP address" "masking"
8208 .cindex "host list" "masked IP address"
8209 Single-key lookups can also be performed using masked IP addresses, using
8210 patterns of this form:
8211 .display
8212 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8213 .endd
8214 For example:
8215 .code
8216 net24-dbm;/networks.db
8217 .endd
8218 The IP address of the subject host is masked using <&'number'&> as the mask
8219 length. A textual string is constructed from the masked value, followed by the
8220 mask, and this is used as the lookup key. For example, if the host's IP address
8221 is 192.168.34.6, the key that is looked up for the above example is
8222 &"192.168.34.0/24"&.
8223
8224 When an IPv6 address is converted to a string, dots are normally used instead
8225 of colons, so that keys in &(lsearch)& files need not contain colons (which
8226 terminate &(lsearch)& keys). This was implemented some time before the ability
8227 to quote keys was made available in &(lsearch)& files. However, the more
8228 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8229 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8230 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8231 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8232 addresses are always used.
8233
8234 Ideally, it would be nice to tidy up this anomalous situation by changing to
8235 colons in all cases, given that quoting is now available for &(lsearch)&.
8236 However, this would be an incompatible change that might break some existing
8237 configurations.
8238
8239 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8240 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8241 the former case the key strings include the mask value, whereas in the latter
8242 case the IP address is used on its own.
8243
8244
8245
8246 .section "Host list patterns that match by host name" "SECThoslispatnam"
8247 .cindex "host" "lookup failures"
8248 .cindex "unknown host name"
8249 .cindex "host list" "matching host name"
8250 There are several types of pattern that require Exim to know the name of the
8251 remote host. These are either wildcard patterns or lookups by name. (If a
8252 complete hostname is given without any wildcarding, it is used to find an IP
8253 address to match against, as described in section &<<SECThoslispatip>>&
8254 above.)
8255
8256 If the remote host name is not already known when Exim encounters one of these
8257 patterns, it has to be found from the IP address.
8258 Although many sites on the Internet are conscientious about maintaining reverse
8259 DNS data for their hosts, there are also many that do not do this.
8260 Consequently, a name cannot always be found, and this may lead to unwanted
8261 effects. Take care when configuring host lists with wildcarded name patterns.
8262 Consider what will happen if a name cannot be found.
8263
8264 Because of the problems of determining host names from IP addresses, matching
8265 against host names is not as common as matching against IP addresses.
8266
8267 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8268 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8269 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8270 are done can be changed by setting the &%host_lookup_order%& option. For
8271 security, once Exim has found one or more names, it looks up the IP addresses
8272 for these names and compares them with the IP address that it started with.
8273 Only those names whose IP addresses match are accepted. Any other names are
8274 discarded. If no names are left, Exim behaves as if the host name cannot be
8275 found. In the most common case there is only one name and one IP address.
8276
8277 There are some options that control what happens if a host name cannot be
8278 found. These are described in section &<<SECTbehipnot>>& below.
8279
8280 .cindex "host" "alias for"
8281 .cindex "alias for host"
8282 As a result of aliasing, hosts may have more than one name. When processing any
8283 of the following types of pattern, all the host's names are checked:
8284
8285 .ilist
8286 .cindex "asterisk" "in host list"
8287 If a pattern starts with &"*"& the remainder of the item must match the end of
8288 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8289 &'.b.c'&. This special simple form is provided because this is a very common
8290 requirement. Other kinds of wildcarding require the use of a regular
8291 expression.
8292 .next
8293 .cindex "regular expressions" "in host list"
8294 .cindex "host list" "regular expression in"
8295 If the item starts with &"^"& it is taken to be a regular expression which is
8296 matched against the host name. Host names are case-independent, so this regular
8297 expression match is by default case-independent, but you can make it
8298 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8299 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8300 example,
8301 .code
8302 ^(a|b)\.c\.d$
8303 .endd
8304 is a regular expression that matches either of the two hosts &'a.c.d'& or
8305 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8306 that backslash and dollar characters are not misinterpreted as part of the
8307 string expansion. The simplest way to do this is to use &`\N`& to mark that
8308 part of the string as non-expandable. For example:
8309 .code
8310 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8311 .endd
8312 &*Warning*&: If you want to match a complete host name, you must include the
8313 &`$`& terminating metacharacter in the regular expression, as in the above
8314 example. Without it, a match at the start of the host name is all that is
8315 required.
8316 .endlist
8317
8318
8319
8320
8321 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8322 .cindex "host" "lookup failures, permanent"
8323 While processing a host list, Exim may need to look up an IP address from a
8324 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8325 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8326 behaviour when it fails to find the information it is seeking is the same.
8327
8328 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8329 apply to temporary DNS errors, whose handling is described in the next section.
8330
8331 .cindex "&`+include_unknown`&"
8332 .cindex "&`+ignore_unknown`&"
8333 Exim parses a host list from left to right. If it encounters a permanent
8334 lookup failure in any item in the host list before it has found a match,
8335 Exim treats it as a failure and the default behavior is as if the host
8336 does not match the list. This may not always be what you want to happen.
8337 To change Exim's behaviour, the special items &`+include_unknown`& or
8338 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8339 not recognized in an indirected file).
8340
8341 .ilist
8342 If any item that follows &`+include_unknown`& requires information that
8343 cannot found, Exim behaves as if the host does match the list. For example,
8344 .code
8345 host_reject_connection = +include_unknown:*.enemy.ex
8346 .endd
8347 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8348 any hosts whose name it cannot find.
8349
8350 .next
8351 If any item that follows &`+ignore_unknown`& requires information that cannot
8352 be found, Exim ignores that item and proceeds to the rest of the list. For
8353 example:
8354 .code
8355 accept hosts = +ignore_unknown : friend.example : \
8356                192.168.4.5
8357 .endd
8358 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8359 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8360 name can be found for 192.168.4.5, it is rejected.
8361 .endlist
8362
8363 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8364 list. The effect of each one lasts until the next, or until the end of the
8365 list.
8366
8367 .section "Mixing wildcarded host names and addresses in host lists" &&&
8368          "SECTmixwilhos"
8369 .cindex "host list" "mixing names and addresses in"
8370
8371 This section explains the host/ip processing logic with the same concepts
8372 as the previous section, but specifically addresses what happens when a
8373 wildcarded hostname is one of the items in the hostlist.
8374
8375 .ilist
8376 If you have name lookups or wildcarded host names and
8377 IP addresses in the same host list, you should normally put the IP
8378 addresses first. For example, in an ACL you could have:
8379 .code
8380 accept hosts = 10.9.8.7 : *.friend.example
8381 .endd
8382 The reason you normally would order it this way lies in the
8383 left-to-right way that Exim processes lists.  It can test IP addresses
8384 without doing any DNS lookups, but when it reaches an item that requires
8385 a host name, it fails if it cannot find a host name to compare with the
8386 pattern. If the above list is given in the opposite order, the
8387 &%accept%& statement fails for a host whose name cannot be found, even
8388 if its IP address is 10.9.8.7.
8389
8390 .next
8391 If you really do want to do the name check first, and still recognize the IP
8392 address, you can rewrite the ACL like this:
8393 .code
8394 accept hosts = *.friend.example
8395 accept hosts = 10.9.8.7
8396 .endd
8397 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8398 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8399 &`+ignore_unknown`&, which was discussed in depth in the first example in
8400 this section.
8401 .endlist
8402
8403
8404 .section "Temporary DNS errors when looking up host information" &&&
8405          "SECTtemdnserr"
8406 .cindex "host" "lookup failures, temporary"
8407 .cindex "&`+include_defer`&"
8408 .cindex "&`+ignore_defer`&"
8409 A temporary DNS lookup failure normally causes a defer action (except when
8410 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8411 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8412 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8413 section. These options should be used with care, probably only in non-critical
8414 host lists such as whitelists.
8415
8416
8417
8418 .section "Host list patterns for single-key lookups by host name" &&&
8419          "SECThoslispatnamsk"
8420 .cindex "unknown host name"
8421 .cindex "host list" "matching host name"
8422 If a pattern is of the form
8423 .display
8424 <&'single-key-search-type'&>;<&'search-data'&>
8425 .endd
8426 for example
8427 .code
8428 dbm;/host/accept/list
8429 .endd
8430 a single-key lookup is performed, using the host name as its key. If the
8431 lookup succeeds, the host matches the item. The actual data that is looked up
8432 is not used.
8433
8434 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8435 keys in the file, not IP addresses. If you want to do lookups based on IP
8436 addresses, you must precede the search type with &"net-"& (see section
8437 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8438 two items in the same list, one doing an address lookup and one doing a name
8439 lookup, both using the same file.
8440
8441
8442
8443 .section "Host list patterns for query-style lookups" "SECID81"
8444 If a pattern is of the form
8445 .display
8446 <&'query-style-search-type'&>;<&'query'&>
8447 .endd
8448 the query is obeyed, and if it succeeds, the host matches the item. The actual
8449 data that is looked up is not used. The variables &$sender_host_address$& and
8450 &$sender_host_name$& can be used in the query. For example:
8451 .code
8452 hosts_lookup = pgsql;\
8453   select ip from hostlist where ip='$sender_host_address'
8454 .endd
8455 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8456 can use the &%sg%& expansion item to change this if you need to. If you want to
8457 use masked IP addresses in database queries, you can use the &%mask%& expansion
8458 operator.
8459
8460 If the query contains a reference to &$sender_host_name$&, Exim automatically
8461 looks up the host name if it has not already done so. (See section
8462 &<<SECThoslispatnam>>& for comments on finding host names.)
8463
8464 Historical note: prior to release 4.30, Exim would always attempt to find a
8465 host name before running the query, unless the search type was preceded by
8466 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8467 still recognized for query-style lookups, but its presence or absence has no
8468 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8469 See section &<<SECThoslispatsikey>>&.)
8470
8471
8472
8473
8474
8475 .section "Address lists" "SECTaddresslist"
8476 .cindex "list" "address list"
8477 .cindex "address list" "empty item"
8478 .cindex "address list" "patterns"
8479 Address lists contain patterns that are matched against mail addresses. There
8480 is one special case to be considered: the sender address of a bounce message is
8481 always empty. You can test for this by providing an empty item in an address
8482 list. For example, you can set up a router to process bounce messages by
8483 using this option setting:
8484 .code
8485 senders = :
8486 .endd
8487 The presence of the colon creates an empty item. If you do not provide any
8488 data, the list is empty and matches nothing. The empty sender can also be
8489 detected by a regular expression that matches an empty string,
8490 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8491
8492 Non-empty items in an address list can be straightforward email addresses. For
8493 example:
8494 .code
8495 senders = jbc@askone.example : hs@anacreon.example
8496 .endd
8497 A certain amount of wildcarding is permitted. If a pattern contains an @
8498 character, but is not a regular expression and does not begin with a
8499 semicolon-terminated lookup type (described below), the local part of the
8500 subject address is compared with the local part of the pattern, which may start
8501 with an asterisk. If the local parts match, the domain is checked in exactly
8502 the same way as for a pattern in a domain list. For example, the domain can be
8503 wildcarded, refer to a named list, or be a lookup:
8504 .code
8505 deny senders = *@*.spamming.site:\
8506                *@+hostile_domains:\
8507                bozo@partial-lsearch;/list/of/dodgy/sites:\
8508                *@dbm;/bad/domains.db
8509 .endd
8510 .cindex "local part" "starting with !"
8511 .cindex "address list" "local part starting with !"
8512 If a local part that begins with an exclamation mark is required, it has to be
8513 specified using a regular expression, because otherwise the exclamation mark is
8514 treated as a sign of negation, as is standard in lists.
8515
8516 If a non-empty pattern that is not a regular expression or a lookup does not
8517 contain an @ character, it is matched against the domain part of the subject
8518 address. The only two formats that are recognized this way are a literal
8519 domain, or a domain pattern that starts with *. In both these cases, the effect
8520 is the same as if &`*@`& preceded the pattern. For example:
8521 .code
8522 deny senders = enemy.domain : *.enemy.domain
8523 .endd
8524
8525 The following kinds of more complicated address list pattern can match any
8526 address, including the empty address that is characteristic of bounce message
8527 senders:
8528
8529 .ilist
8530 .cindex "regular expressions" "in address list"
8531 .cindex "address list" "regular expression in"
8532 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8533 done against the complete address, with the pattern as the regular expression.
8534 You must take care that backslash and dollar characters are not misinterpreted
8535 as part of the string expansion. The simplest way to do this is to use &`\N`&
8536 to mark that part of the string as non-expandable. For example:
8537 .code
8538 deny senders = \N^.*this.*@example\.com$\N : \
8539                \N^\d{8}.+@spamhaus.example$\N : ...
8540 .endd
8541 The &`\N`& sequences are removed by the expansion, so these items do indeed
8542 start with &"^"& by the time they are being interpreted as address patterns.
8543
8544 .next
8545 .cindex "address list" "lookup for complete address"
8546 Complete addresses can be looked up by using a pattern that starts with a
8547 lookup type terminated by a semicolon, followed by the data for the lookup. For
8548 example:
8549 .code
8550 deny senders = cdb;/etc/blocked.senders : \
8551   mysql;select address from blocked where \
8552   address='${quote_mysql:$sender_address}'
8553 .endd
8554 Both query-style and single-key lookup types can be used. For a single-key
8555 lookup type, Exim uses the complete address as the key. However, empty keys are
8556 not supported for single-key lookups, so a match against the empty address
8557 always fails. This restriction does not apply to query-style lookups.
8558
8559 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8560 cannot be used, and is ignored if specified, with an entry being written to the
8561 panic log.
8562 .cindex "*@ with single-key lookup"
8563 However, you can configure lookup defaults, as described in section
8564 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8565 default. For example, with this lookup:
8566 .code
8567 accept senders = lsearch*@;/some/file
8568 .endd
8569 the file could contains lines like this:
8570 .code
8571 user1@domain1.example
8572 *@domain2.example
8573 .endd
8574 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8575 that are tried is:
8576 .code
8577 nimrod@jaeger.example
8578 *@jaeger.example
8579 *
8580 .endd
8581 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8582 would mean that every address matches, thus rendering the test useless.
8583
8584 &*Warning 2*&: Do not confuse these two kinds of item:
8585 .code
8586 deny recipients = dbm*@;/some/file
8587 deny recipients = *@dbm;/some/file
8588 .endd
8589 The first does a whole address lookup, with defaulting, as just described,
8590 because it starts with a lookup type. The second matches the local part and
8591 domain independently, as described in a bullet point below.
8592 .endlist
8593
8594
8595 The following kinds of address list pattern can match only non-empty addresses.
8596 If the subject address is empty, a match against any of these pattern types
8597 always fails.
8598
8599
8600 .ilist
8601 .cindex "@@ with single-key lookup"
8602 .cindex "address list" "@@ lookup type"
8603 .cindex "address list" "split local part and domain"
8604 If a pattern starts with &"@@"& followed by a single-key lookup item
8605 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8606 split into a local part and a domain. The domain is looked up in the file. If
8607 it is not found, there is no match. If it is found, the data that is looked up
8608 from the file is treated as a colon-separated list of local part patterns, each
8609 of which is matched against the subject local part in turn.
8610
8611 .cindex "asterisk" "in address list"
8612 The lookup may be a partial one, and/or one involving a search for a default
8613 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8614 patterns that are looked up can be regular expressions or begin with &"*"&, or
8615 even be further lookups. They may also be independently negated. For example,
8616 with
8617 .code
8618 deny senders = @@dbm;/etc/reject-by-domain
8619 .endd
8620 the data from which the DBM file is built could contain lines like
8621 .code
8622 baddomain.com:  !postmaster : *
8623 .endd
8624 to reject all senders except &%postmaster%& from that domain.
8625
8626 .cindex "local part" "starting with !"
8627 If a local part that actually begins with an exclamation mark is required, it
8628 has to be specified using a regular expression. In &(lsearch)& files, an entry
8629 may be split over several lines by indenting the second and subsequent lines,
8630 but the separating colon must still be included at line breaks. White space
8631 surrounding the colons is ignored. For example:
8632 .code
8633 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8634   spammer3 : spammer4
8635 .endd
8636 As in all colon-separated lists in Exim, a colon can be included in an item by
8637 doubling.
8638
8639 If the last item in the list starts with a right angle-bracket, the remainder
8640 of the item is taken as a new key to look up in order to obtain a continuation
8641 list of local parts. The new key can be any sequence of characters. Thus one
8642 might have entries like
8643 .code
8644 aol.com: spammer1 : spammer 2 : >*
8645 xyz.com: spammer3 : >*
8646 *:       ^\d{8}$
8647 .endd
8648 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8649 local parts for all domains, in addition to the specific local parts listed for
8650 each domain. Of course, using this feature costs another lookup each time a
8651 chain is followed, but the effort needed to maintain the data is reduced.
8652
8653 .cindex "loop" "in lookups"
8654 It is possible to construct loops using this facility, and in order to catch
8655 them, the chains may be no more than fifty items long.
8656
8657 .next
8658 The @@<&'lookup'&> style of item can also be used with a query-style
8659 lookup, but in this case, the chaining facility is not available. The lookup
8660 can only return a single list of local parts.
8661 .endlist
8662
8663 &*Warning*&: There is an important difference between the address list items
8664 in these two examples:
8665 .code
8666 senders = +my_list
8667 senders = *@+my_list
8668 .endd
8669 In the first one, &`my_list`& is a named address list, whereas in the second
8670 example it is a named domain list.
8671
8672
8673
8674
8675 .section "Case of letters in address lists" "SECTcasletadd"
8676 .cindex "case of local parts"
8677 .cindex "address list" "case forcing"
8678 .cindex "case forcing in address lists"
8679 Domains in email addresses are always handled caselessly, but for local parts
8680 case may be significant on some systems (see &%caseful_local_part%& for how
8681 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8682 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8683 blocking lists should be done in a case-independent manner. Since most address
8684 lists in Exim are used for this kind of control, Exim attempts to do this by
8685 default.
8686
8687 The domain portion of an address is always lowercased before matching it to an
8688 address list. The local part is lowercased by default, and any string
8689 comparisons that take place are done caselessly. This means that the data in
8690 the address list itself, in files included as plain file names, and in any file
8691 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8692 keys in files that are looked up by a search type other than &(lsearch)& (which
8693 works caselessly) must be in lower case, because these lookups are not
8694 case-independent.
8695
8696 .cindex "&`+caseful`&"
8697 To allow for the possibility of caseful address list matching, if an item in
8698 an address list is the string &"+caseful"&, the original case of the local
8699 part is restored for any comparisons that follow, and string comparisons are no
8700 longer case-independent. This does not affect the domain, which remains in
8701 lower case. However, although independent matches on the domain alone are still
8702 performed caselessly, regular expressions that match against an entire address
8703 become case-sensitive after &"+caseful"& has been seen.
8704
8705
8706
8707 .section "Local part lists" "SECTlocparlis"
8708 .cindex "list" "local part list"
8709 .cindex "local part" "list"
8710 Case-sensitivity in local part lists is handled in the same way as for address
8711 lists, as just described. The &"+caseful"& item can be used if required. In a
8712 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8713 set false, the subject is lowercased and the matching is initially
8714 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8715 matching in the local part list, but not elsewhere in the router. If
8716 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8717 option is case-sensitive from the start.
8718
8719 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8720 comments are handled in the same way as address lists &-- they are recognized
8721 only if the # is preceded by white space or the start of the line.
8722 Otherwise, local part lists are matched in the same way as domain lists, except
8723 that the special items that refer to the local host (&`@`&, &`@[]`&,
8724 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8725 Refer to section &<<SECTdomainlist>>& for details of the other available item
8726 types.
8727 .ecindex IIDdohoadli
8728
8729
8730
8731
8732 . ////////////////////////////////////////////////////////////////////////////
8733 . ////////////////////////////////////////////////////////////////////////////
8734
8735 .chapter "String expansions" "CHAPexpand"
8736 .scindex IIDstrexp "expansion" "of strings"
8737 Many strings in Exim's run time configuration are expanded before use. Some of
8738 them are expanded every time they are used; others are expanded only once.
8739
8740 When a string is being expanded it is copied verbatim from left to right except
8741 when a dollar or backslash character is encountered. A dollar specifies the
8742 start of a portion of the string that is interpreted and replaced as described
8743 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8744 escape character, as described in the following section.
8745
8746 Whether a string is expanded depends upon the context.  Usually this is solely
8747 dependent upon the option for which a value is sought; in this documentation,
8748 options for which string expansion is performed are marked with &dagger; after
8749 the data type.  ACL rules always expand strings.  A couple of expansion
8750 conditions do not expand some of the brace-delimited branches, for security
8751 reasons.
8752
8753
8754
8755 .section "Literal text in expanded strings" "SECTlittext"
8756 .cindex "expansion" "including literal text"
8757 An uninterpreted dollar can be included in an expanded string by putting a
8758 backslash in front of it. A backslash can be used to prevent any special
8759 character being treated specially in an expansion, including backslash itself.
8760 If the string appears in quotes in the configuration file, two backslashes are
8761 required because the quotes themselves cause interpretation of backslashes when
8762 the string is read in (see section &<<SECTstrings>>&).
8763
8764 .cindex "expansion" "non-expandable substrings"
8765 A portion of the string can specified as non-expandable by placing it between
8766 two occurrences of &`\N`&. This is particularly useful for protecting regular
8767 expressions, which often contain backslashes and dollar signs. For example:
8768 .code
8769 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8770 .endd
8771 On encountering the first &`\N`&, the expander copies subsequent characters
8772 without interpretation until it reaches the next &`\N`& or the end of the
8773 string.
8774
8775
8776
8777 .section "Character escape sequences in expanded strings" "SECID82"
8778 .cindex "expansion" "escape sequences"
8779 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8780 expanded string is recognized as an escape sequence for the character newline,
8781 carriage return, or tab, respectively. A backslash followed by up to three
8782 octal digits is recognized as an octal encoding for a single character, and a
8783 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8784 encoding.
8785
8786 These escape sequences are also recognized in quoted strings when they are read
8787 in. Their interpretation in expansions as well is useful for unquoted strings,
8788 and for other cases such as looked-up strings that are then expanded.
8789
8790
8791 .section "Testing string expansions" "SECID83"
8792 .cindex "expansion" "testing"
8793 .cindex "testing" "string expansion"
8794 .oindex "&%-be%&"
8795 Many expansions can be tested by calling Exim with the &%-be%& option. This
8796 takes the command arguments, or lines from the standard input if there are no
8797 arguments, runs them through the string expansion code, and writes the results
8798 to the standard output. Variables based on configuration values are set up, but
8799 since no message is being processed, variables such as &$local_part$& have no
8800 value. Nevertheless the &%-be%& option can be useful for checking out file and
8801 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8802 and &%nhash%&.
8803
8804 Exim gives up its root privilege when it is called with the &%-be%& option, and
8805 instead runs under the uid and gid it was called with, to prevent users from
8806 using &%-be%& for reading files to which they do not have access.
8807
8808 .oindex "&%-bem%&"
8809 If you want to test expansions that include variables whose values are taken
8810 from a message, there are two other options that can be used. The &%-bem%&
8811 option is like &%-be%& except that it is followed by a file name. The file is
8812 read as a message before doing the test expansions. For example:
8813 .code
8814 exim -bem /tmp/test.message '$h_subject:'
8815 .endd
8816 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8817 Exim message identifier. For example:
8818 .code
8819 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8820 .endd
8821 This loads the message from Exim's spool before doing the test expansions, and
8822 is therefore restricted to admin users.
8823
8824
8825 .section "Forced expansion failure" "SECTforexpfai"
8826 .cindex "expansion" "forced failure"
8827 A number of expansions that are described in the following section have
8828 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8829 (which are sometimes called &"curly brackets"&). Which of the two strings is
8830 used depends on some condition that is evaluated as part of the expansion. If,
8831 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8832 the entire string expansion fails in a way that can be detected by the code
8833 that requested the expansion. This is called &"forced expansion failure"&, and
8834 its consequences depend on the circumstances. In some cases it is no different
8835 from any other expansion failure, but in others a different action may be
8836 taken. Such variations are mentioned in the documentation of the option that is
8837 being expanded.
8838
8839
8840
8841
8842 .section "Expansion items" "SECTexpansionitems"
8843 The following items are recognized in expanded strings. White space may be used
8844 between sub-items that are keywords or substrings enclosed in braces inside an
8845 outer set of braces, to improve readability. &*Warning*&: Within braces,
8846 white space is significant.
8847
8848 .vlist
8849 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8850 .cindex "expansion" "variables"
8851 Substitute the contents of the named variable, for example:
8852 .code
8853 $local_part
8854 ${domain}
8855 .endd
8856 The second form can be used to separate the name from subsequent alphanumeric
8857 characters. This form (using braces) is available only for variables; it does
8858 &'not'& apply to message headers. The names of the variables are given in
8859 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8860 given, the expansion fails.
8861
8862 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8863 .cindex "expansion" "operators"
8864 The string is first itself expanded, and then the operation specified by
8865 <&'op'&> is applied to it. For example:
8866 .code
8867 ${lc:$local_part}
8868 .endd
8869 The string starts with the first character after the colon, which may be
8870 leading white space. A list of operators is given in section &<<SECTexpop>>&
8871 below. The operator notation is used for simple expansion items that have just
8872 one argument, because it reduces the number of braces and therefore makes the
8873 string easier to understand.
8874
8875 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8876 This item inserts &"basic"& header lines. It is described with the &%header%&
8877 expansion item below.
8878
8879
8880 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8881 .cindex "expansion" "calling an acl"
8882 .cindex "&%acl%&" "call from expansion"
8883 The name and zero to nine argument strings are first expanded separately.  The expanded
8884 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8885 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8886 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8887 and may use the variables; if another acl expansion is used the values
8888 are restored after it returns.  If the ACL sets
8889 a value using a "message =" modifier and returns accept or deny, the value becomes
8890 the result of the expansion.
8891 If no message is set and the ACL returns accept or deny
8892 the expansion result is an empty string.
8893 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8894
8895
8896 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8897        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8898 .cindex "expansion" "extracting cerificate fields"
8899 .cindex "&%certextract%&" "certificate fields"
8900 .cindex "certificate" "extracting fields"
8901 The <&'certificate'&> must be a variable of type certificate.
8902 The field name is expanded and used to retrive the relevant field from
8903 the certificate.  Supported fields are:
8904 .display
8905 &`version        `&
8906 &`serial_number  `&
8907 &`subject        `& RFC4514 DN
8908 &`issuer         `& RFC4514 DN
8909 &`notbefore      `& time
8910 &`notafter       `& time
8911 &`sig_algorithm  `&
8912 &`signature      `&
8913 &`subj_altname   `& tagged list
8914 &`ocsp_uri       `& list
8915 &`crl_uri        `& list
8916 .endd
8917 If the field is found,
8918 <&'string2'&> is expanded, and replaces the whole item;
8919 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8920 variable &$value$& contains the value that has been extracted. Afterwards, it
8921 is restored to any previous value it might have had.
8922
8923 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8924 key is not found. If {<&'string2'&>} is also omitted, the value that was
8925 extracted is used.
8926
8927 Some field names take optional modifiers, appended and separated by commas.
8928
8929 The field selectors marked as "RFC4514" above
8930 output a Distinguished Name string which is
8931 not quite
8932 parseable by Exim as a comma-separated tagged list
8933 (the exceptions being elements containin commas).
8934 RDN elements of a single type may be selected by
8935 a modifier of the type label; if so the expansion
8936 result is a list (newline-separated by default).
8937 The separator may be changed by another modifer of
8938 a right angle-bracket followed immediately by the new separator.
8939 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8940
8941 The field selectors marked as "time" above
8942 take an optional modifier of "int"
8943 for which the result is the number of seconds since epoch.
8944 Otherwise the result is a human-readable string
8945 in the timezone selected by the main "timezone" option.
8946
8947 The field selectors marked as "list" above return a list,
8948 newline-separated by default,
8949 (embedded separator characters in elements are doubled).
8950 The separator may be changed by a modifier of
8951 a right angle-bracket followed immediately by the new separator.
8952
8953 The field selectors marked as "tagged" above
8954 prefix each list element with a type string and an equals sign.
8955 Elements of only one type may be selected by a modifier
8956 which is one of "dns", "uri" or "mail";
8957 if so the elenment tags are omitted.
8958
8959 If not otherwise noted field values are presented in human-readable form.
8960
8961 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8962        {*&<&'arg'&>&*}...}*&"
8963 .cindex &%dlfunc%&
8964 This expansion dynamically loads and then calls a locally-written C function.
8965 This functionality is available only if Exim is compiled with
8966 .code
8967 EXPAND_DLFUNC=yes
8968 .endd
8969 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8970 object so that it doesn't reload the same object file in the same Exim process
8971 (but of course Exim does start new processes frequently).
8972
8973 There may be from zero to eight arguments to the function. When compiling
8974 a local function that is to be called in this way, &_local_scan.h_& should be
8975 included. The Exim variables and functions that are defined by that API
8976 are also available for dynamically loaded functions. The function itself
8977 must have the following type:
8978 .code
8979 int dlfunction(uschar **yield, int argc, uschar *argv[])
8980 .endd
8981 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8982 function should return one of the following values:
8983
8984 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8985 into the expanded string that is being built.
8986
8987 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8988 from &'yield'&, if it is set.
8989
8990 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8991 taken from &'yield'& if it is set.
8992
8993 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8994
8995 When compiling a function that is to be used in this way with gcc,
8996 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8997 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8998
8999 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9000        {*&<&'string3'&>&*}}*&"
9001 .cindex "expansion" "extracting substrings by key"
9002 .cindex "&%extract%&" "substrings by key"
9003 The key and <&'string1'&> are first expanded separately. Leading and trailing
9004 white space is removed from the key (but not from any of the strings). The key
9005 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9006 form:
9007 .display
9008 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9009 .endd
9010 .vindex "&$value$&"
9011 where the equals signs and spaces (but not both) are optional. If any of the
9012 values contain white space, they must be enclosed in double quotes, and any
9013 values that are enclosed in double quotes are subject to escape processing as
9014 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9015 for the value that corresponds to the key. The search is case-insensitive. If
9016 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9017 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9018 variable &$value$& contains the value that has been extracted. Afterwards, it
9019 is restored to any previous value it might have had.
9020
9021 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9022 key is not found. If {<&'string2'&>} is also omitted, the value that was
9023 extracted is used. Thus, for example, these two expansions are identical, and
9024 yield &"2001"&:
9025 .code
9026 ${extract{gid}{uid=1984 gid=2001}}
9027 ${extract{gid}{uid=1984 gid=2001}{$value}}
9028 .endd
9029 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9030 appear, for example:
9031 .code
9032 ${extract{Z}{A=... B=...}{$value} fail }
9033 .endd
9034 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9035 {<&'string2'&>} must be present for &"fail"& to be recognized.
9036
9037
9038 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9039         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9040 .cindex "expansion" "extracting substrings by number"
9041 .cindex "&%extract%&" "substrings by number"
9042 The <&'number'&> argument must consist entirely of decimal digits,
9043 apart from leading and trailing white space, which is ignored.
9044 This is what distinguishes this form of &%extract%& from the previous kind. It
9045 behaves in the same way, except that, instead of extracting a named field, it
9046 extracts from <&'string1'&> the field whose number is given as the first
9047 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9048 <&'string3'&> as before.
9049
9050 The fields in the string are separated by any one of the characters in the
9051 separator string. These may include space or tab characters.
9052 The first field is numbered one. If the number is negative, the fields are
9053 counted from the end of the string, with the rightmost one numbered -1. If the
9054 number given is zero, the entire string is returned. If the modulus of the
9055 number is greater than the number of fields in the string, the result is the
9056 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9057 provided. For example:
9058 .code
9059 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9060 .endd
9061 yields &"42"&, and
9062 .code
9063 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9064 .endd
9065 yields &"99"&. Two successive separators mean that the field between them is
9066 empty (for example, the fifth field above).
9067
9068
9069 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9070 .cindex "list" "selecting by condition"
9071 .cindex "expansion" "selecting from list by condition"
9072 .vindex "&$item$&"
9073 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9074 default, but the separator can be changed in the usual way. For each item
9075 in this list, its value is place in &$item$&, and then the condition is
9076 evaluated. If the condition is true, &$item$& is added to the output as an
9077 item in a new list; if the condition is false, the item is discarded. The
9078 separator used for the output list is the same as the one used for the
9079 input, but a separator setting is not included in the output. For example:
9080 .code
9081 ${filter{a:b:c}{!eq{$item}{b}}
9082 .endd
9083 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9084 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9085
9086
9087 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9088 .cindex "hash function" "textual"
9089 .cindex "expansion" "textual hash"
9090 This is a textual hashing function, and was the first to be implemented in
9091 early versions of Exim. In current releases, there are other hashing functions
9092 (numeric, MD5, and SHA-1), which are described below.
9093
9094 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9095 <&'n'&>. If you are using fixed values for these numbers, that is, if
9096 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9097 use the simpler operator notation that avoids some of the braces:
9098 .code
9099 ${hash_<n>_<m>:<string>}
9100 .endd
9101 The second number is optional (in both notations). If <&'n'&> is greater than
9102 or equal to the length of the string, the expansion item returns the string.
9103 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9104 function to the string. The new string consists of characters taken from the
9105 first <&'m'&> characters of the string
9106 .code
9107 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9108 .endd
9109 If <&'m'&> is not present the value 26 is used, so that only lower case
9110 letters appear. For example:
9111 .display
9112 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9113 &`$hash{5}{monty}}           `&   yields  &`monty`&
9114 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9115 .endd
9116
9117 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9118         &*$h_*&<&'header&~name'&>&*:*&" &&&
9119        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9120         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9121        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9122         &*$rh_*&<&'header&~name'&>&*:*&"
9123 .cindex "expansion" "header insertion"
9124 .vindex "&$header_$&"
9125 .vindex "&$bheader_$&"
9126 .vindex "&$rheader_$&"
9127 .cindex "header lines" "in expansion strings"
9128 .cindex "header lines" "character sets"
9129 .cindex "header lines" "decoding"
9130 Substitute the contents of the named message header line, for example
9131 .code
9132 $header_reply-to:
9133 .endd
9134 The newline that terminates a header line is not included in the expansion, but
9135 internal newlines (caused by splitting the header line over several physical
9136 lines) may be present.
9137
9138 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9139 the data in the header line is interpreted.
9140
9141 .ilist
9142 .cindex "white space" "in header lines"
9143 &%rheader%& gives the original &"raw"& content of the header line, with no
9144 processing at all, and without the removal of leading and trailing white space.
9145
9146 .next
9147 .cindex "base64 encoding" "in header lines"
9148 &%bheader%& removes leading and trailing white space, and then decodes base64
9149 or quoted-printable MIME &"words"& within the header text, but does no
9150 character set translation. If decoding of what looks superficially like a MIME
9151 &"word"& fails, the raw string is returned. If decoding
9152 .cindex "binary zero" "in header line"
9153 produces a binary zero character, it is replaced by a question mark &-- this is
9154 what Exim does for binary zeros that are actually received in header lines.
9155
9156 .next
9157 &%header%& tries to translate the string as decoded by &%bheader%& to a
9158 standard character set. This is an attempt to produce the same string as would
9159 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9160 returned. Translation is attempted only on operating systems that support the
9161 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9162 a system Makefile or in &_Local/Makefile_&.
9163 .endlist ilist
9164
9165 In a filter file, the target character set for &%header%& can be specified by a
9166 command of the following form:
9167 .code
9168 headers charset "UTF-8"
9169 .endd
9170 This command affects all references to &$h_$& (or &$header_$&) expansions in
9171 subsequently obeyed filter commands. In the absence of this command, the target
9172 character set in a filter is taken from the setting of the &%headers_charset%&
9173 option in the runtime configuration. The value of this option defaults to the
9174 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9175 ISO-8859-1.
9176
9177 Header names follow the syntax of RFC 2822, which states that they may contain
9178 any printing characters except space and colon. Consequently, curly brackets
9179 &'do not'& terminate header names, and should not be used to enclose them as
9180 if they were variables. Attempting to do so causes a syntax error.
9181
9182 Only header lines that are common to all copies of a message are visible to
9183 this mechanism. These are the original header lines that are received with the
9184 message, and any that are added by an ACL statement or by a system
9185 filter. Header lines that are added to a particular copy of a message by a
9186 router or transport are not accessible.
9187
9188 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9189 before the DATA ACL, because the header structure is not set up until the
9190 message is received. Header lines that are added in a RCPT ACL (for example)
9191 are saved until the message's incoming header lines are available, at which
9192 point they are added. When a DATA ACL is running, however, header lines added
9193 by earlier ACLs are visible.
9194
9195 Upper case and lower case letters are synonymous in header names. If the
9196 following character is white space, the terminating colon may be omitted, but
9197 this is not recommended, because you may then forget it when it is needed. When
9198 white space terminates the header name, it is included in the expanded string.
9199 If the message does not contain the given header, the expansion item is
9200 replaced by an empty string. (See the &%def%& condition in section
9201 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9202
9203 If there is more than one header with the same name, they are all concatenated
9204 to form the substitution string, up to a maximum length of 64K. Unless
9205 &%rheader%& is being used, leading and trailing white space is removed from
9206 each header before concatenation, and a completely empty header is ignored. A
9207 newline character is then inserted between non-empty headers, but there is no
9208 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9209 those headers that contain lists of addresses, a comma is also inserted at the
9210 junctions between headers. This does not happen for the &%rheader%& expansion.
9211
9212
9213 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9214 .cindex "expansion" "hmac hashing"
9215 .cindex &%hmac%&
9216 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9217 shared secret and some text into a message authentication code, as specified in
9218 RFC 2104. This differs from &`${md5:secret_text...}`& or
9219 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9220 cryptographic hash, allowing for authentication that is not possible with MD5
9221 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9222 present. For example:
9223 .code
9224 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9225 .endd
9226 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9227 produces:
9228 .code
9229 dd97e3ba5d1a61b5006108f8c8252953
9230 .endd
9231 As an example of how this might be used, you might put in the main part of
9232 an Exim configuration:
9233 .code
9234 SPAMSCAN_SECRET=cohgheeLei2thahw
9235 .endd
9236 In a router or a transport you could then have:
9237 .code
9238 headers_add = \
9239   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9240   ${hmac{md5}{SPAMSCAN_SECRET}\
9241   {${primary_hostname},${message_exim_id},$h_message-id:}}
9242 .endd
9243 Then given a message, you can check where it was scanned by looking at the
9244 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9245 this header line is authentic by recomputing the authentication code from the
9246 host name, message ID and the &'Message-id:'& header line. This can be done
9247 using Exim's &%-be%& option, or by other means, for example by using the
9248 &'hmac_md5_hex()'& function in Perl.
9249
9250
9251 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9252 .cindex "expansion" "conditional"
9253 .cindex "&%if%&, expansion item"
9254 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9255 item; otherwise <&'string2'&> is used. The available conditions are described
9256 in section &<<SECTexpcond>>& below. For example:
9257 .code
9258 ${if eq {$local_part}{postmaster} {yes}{no} }
9259 .endd
9260 The second string need not be present; if it is not and the condition is not
9261 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9262 be present instead of the second string (without any curly brackets). In this
9263 case, the expansion is forced to fail if the condition is not true (see section
9264 &<<SECTforexpfai>>&).
9265
9266 If both strings are omitted, the result is the string &`true`& if the condition
9267 is true, and the empty string if the condition is false. This makes it less
9268 cumbersome to write custom ACL and router conditions. For example, instead of
9269 .code
9270 condition = ${if >{$acl_m4}{3}{true}{false}}
9271 .endd
9272 you can use
9273 .code
9274 condition = ${if >{$acl_m4}{3}}
9275 .endd
9276
9277 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9278 .cindex "expansion" "string truncation"
9279 .cindex "&%length%& expansion item"
9280 The &%length%& item is used to extract the initial portion of a string. Both
9281 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9282 you are using a fixed value for the number, that is, if <&'string1'&> does not
9283 change when expanded, you can use the simpler operator notation that avoids
9284 some of the braces:
9285 .code
9286 ${length_<n>:<string>}
9287 .endd
9288 The result of this item is either the first <&'n'&> characters or the whole
9289 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9290 &%strlen%&, which gives the length of a string.
9291
9292
9293 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9294         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9295 .cindex "expansion" "extracting list elements by number"
9296 .cindex "&%listextract%&" "extract list elements by number"
9297 .cindex "list" "extracting elements by number"
9298 The <&'number'&> argument must consist entirely of decimal digits,
9299 apart from an optional leading minus,
9300 and leading and trailing white space (which is ignored).
9301
9302 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9303 default, but the separator can be changed in the usual way.
9304
9305 The first field of the list is numbered one.
9306 If the number is negative, the fields are
9307 counted from the end of the list, with the rightmost one numbered -1.
9308 The numbered element of the list is extracted and placed in &$value$&,
9309 then <&'string2'&> is expanded as the result.
9310
9311 If the modulus of the
9312 number is zero or greater than the number of fields in the string,
9313 the result is the expansion of <&'string3'&>.
9314
9315 For example:
9316 .code
9317 ${listextract{2}{x:42:99}}
9318 .endd
9319 yields &"42"&, and
9320 .code
9321 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9322 .endd
9323 yields &"result: 99"&.
9324
9325 If {<&'string3'&>} is omitted, an empty string is used for string3.
9326 If {<&'string2'&>} is also omitted, the value that was
9327 extracted is used.
9328 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9329
9330
9331 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9332         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9333 This is the first of one of two different types of lookup item, which are both
9334 described in the next item.
9335
9336 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9337         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9338 .cindex "expansion" "lookup in"
9339 .cindex "file" "lookups"
9340 .cindex "lookup" "in expanded string"
9341 The two forms of lookup item specify data lookups in files and databases, as
9342 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9343 lookups, and the second is used for query-style lookups. The <&'key'&>,
9344 <&'file'&>, and <&'query'&> strings are expanded before use.
9345
9346 If there is any white space in a lookup item which is part of a filter command,
9347 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9348 other place where white space is significant, the lookup item must be enclosed
9349 in double quotes. The use of data lookups in users' filter files may be locked
9350 out by the system administrator.
9351
9352 .vindex "&$value$&"
9353 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9354 During its expansion, the variable &$value$& contains the data returned by the
9355 lookup. Afterwards it reverts to the value it had previously (at the outer
9356 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9357 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9358 string on failure. If <&'string2'&> is provided, it can itself be a nested
9359 lookup, thus providing a mechanism for looking up a default value when the
9360 original lookup fails.
9361
9362 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9363 data for the outer lookup while the parameters of the second lookup are
9364 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9365 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9366 appear, and in this case, if the lookup fails, the entire expansion is forced
9367 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9368 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9369 successful lookup, and nothing in the case of failure.
9370
9371 For single-key lookups, the string &"partial"& is permitted to precede the
9372 search type in order to do partial matching, and * or *@ may follow a search
9373 type to request default lookups if the key does not match (see sections
9374 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9375
9376 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9377 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9378 and non-wild parts of the key during the expansion of the replacement text.
9379 They return to their previous values at the end of the lookup item.
9380
9381 This example looks up the postmaster alias in the conventional alias file:
9382 .code
9383 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9384 .endd
9385 This example uses NIS+ to look up the full name of the user corresponding to
9386 the local part of an address, forcing the expansion to fail if it is not found:
9387 .code
9388 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9389   {$value}fail}
9390 .endd
9391
9392
9393 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9394 .cindex "expansion" "list creation"
9395 .vindex "&$item$&"
9396 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9397 default, but the separator can be changed in the usual way. For each item
9398 in this list, its value is place in &$item$&, and then <&'string2'&> is
9399 expanded and added to the output as an item in a new list. The separator used
9400 for the output list is the same as the one used for the input, but a separator
9401 setting is not included in the output. For example:
9402 .code
9403 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9404 .endd
9405 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9406 value of &$item$& is restored to what it was before. See also the &*filter*&
9407 and &*reduce*& expansion items.
9408
9409 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9410 .cindex "expansion" "numeric hash"
9411 .cindex "hash function" "numeric"
9412 The three strings are expanded; the first two must yield numbers. Call them
9413 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9414 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9415 can use the simpler operator notation that avoids some of the braces:
9416 .code
9417 ${nhash_<n>_<m>:<string>}
9418 .endd
9419 The second number is optional (in both notations). If there is only one number,
9420 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9421 processed by a div/mod hash function that returns two numbers, separated by a
9422 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9423 example,
9424 .code
9425 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9426 .endd
9427 returns the string &"6/33"&.
9428
9429
9430
9431 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9432 .cindex "Perl" "use in expanded string"
9433 .cindex "expansion" "calling Perl from"
9434 This item is available only if Exim has been built to include an embedded Perl
9435 interpreter. The subroutine name and the arguments are first separately
9436 expanded, and then the Perl subroutine is called with those arguments. No
9437 additional arguments need be given; the maximum number permitted, including the
9438 name of the subroutine, is nine.
9439
9440 The return value of the subroutine is inserted into the expanded string, unless
9441 the return value is &%undef%&. In that case, the expansion fails in the same
9442 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9443 Whatever you return is evaluated in a scalar context. For example, if you
9444 return the name of a Perl vector, the return value is the size of the vector,
9445 not its contents.
9446
9447 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9448 with the error message that was passed to &%die%&. More details of the embedded
9449 Perl facility are given in chapter &<<CHAPperl>>&.
9450
9451 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9452 out the use of this expansion item in filter files.
9453
9454
9455 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9456 .cindex "&%prvs%& expansion item"
9457 The first argument is a complete email address and the second is secret
9458 keystring. The third argument, specifying a key number, is optional. If absent,
9459 it defaults to 0. The result of the expansion is a prvs-signed email address,
9460 to be typically used with the &%return_path%& option on an &(smtp)& transport
9461 as part of a bounce address tag validation (BATV) scheme. For more discussion
9462 and an example, see section &<<SECTverifyPRVS>>&.
9463
9464 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9465         {*&<&'string'&>&*}}*&"
9466 .cindex "&%prvscheck%& expansion item"
9467 This expansion item is the complement of the &%prvs%& item. It is used for
9468 checking prvs-signed addresses. If the expansion of the first argument does not
9469 yield a syntactically valid prvs-signed address, the whole item expands to the
9470 empty string. When the first argument does expand to a syntactically valid
9471 prvs-signed address, the second argument is expanded, with the prvs-decoded
9472 version of the address and the key number extracted from the address in the
9473 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9474
9475 These two variables can be used in the expansion of the second argument to
9476 retrieve the secret. The validity of the prvs-signed address is then checked
9477 against the secret. The result is stored in the variable &$prvscheck_result$&,
9478 which is empty for failure or &"1"& for success.
9479
9480 The third argument is optional; if it is missing, it defaults to an empty
9481 string. This argument is now expanded. If the result is an empty string, the
9482 result of the expansion is the decoded version of the address. This is the case
9483 whether or not the signature was valid. Otherwise, the result of the expansion
9484 is the expansion of the third argument.
9485
9486 All three variables can be used in the expansion of the third argument.
9487 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9488 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9489
9490 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9491 .cindex "expansion" "inserting an entire file"
9492 .cindex "file" "inserting into expansion"
9493 .cindex "&%readfile%& expansion item"
9494 The file name and end-of-line string are first expanded separately. The file is
9495 then read, and its contents replace the entire item. All newline characters in
9496 the file are replaced by the end-of-line string if it is present. Otherwise,
9497 newlines are left in the string.
9498 String expansion is not applied to the contents of the file. If you want this,
9499 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9500 the string expansion fails.
9501
9502 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9503 locks out the use of this expansion item in filter files.
9504
9505
9506
9507 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9508         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9509 .cindex "expansion" "inserting from a socket"
9510 .cindex "socket, use of in expansion"
9511 .cindex "&%readsocket%& expansion item"
9512 This item inserts data from a Unix domain or Internet socket into the expanded
9513 string. The minimal way of using it uses just two arguments, as in these
9514 examples:
9515 .code
9516 ${readsocket{/socket/name}{request string}}
9517 ${readsocket{inet:some.host:1234}{request string}}
9518 .endd
9519 For a Unix domain socket, the first substring must be the path to the socket.
9520 For an Internet socket, the first substring must contain &`inet:`& followed by
9521 a host name or IP address, followed by a colon and a port, which can be a
9522 number or the name of a TCP port in &_/etc/services_&. An IP address may
9523 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9524 example:
9525 .code
9526 ${readsocket{inet:[::1]:1234}{request string}}
9527 .endd
9528 Only a single host name may be given, but if looking it up yields more than
9529 one IP address, they are each tried in turn until a connection is made. For
9530 both kinds of socket, Exim makes a connection, writes the request string
9531 (unless it is an empty string) and reads from the socket until an end-of-file
9532 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9533 extend what can be done. Firstly, you can vary the timeout. For example:
9534 .code
9535 ${readsocket{/socket/name}{request string}{3s}}
9536 .endd
9537 A fourth argument allows you to change any newlines that are in the data
9538 that is read, in the same way as for &%readfile%& (see above). This example
9539 turns them into spaces:
9540 .code
9541 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9542 .endd
9543 As with all expansions, the substrings are expanded before the processing
9544 happens. Errors in these sub-expansions cause the expansion to fail. In
9545 addition, the following errors can occur:
9546
9547 .ilist
9548 Failure to create a socket file descriptor;
9549 .next
9550 Failure to connect the socket;
9551 .next
9552 Failure to write the request string;
9553 .next
9554 Timeout on reading from the socket.
9555 .endlist
9556
9557 By default, any of these errors causes the expansion to fail. However, if
9558 you supply a fifth substring, it is expanded and used when any of the above
9559 errors occurs. For example:
9560 .code
9561 ${readsocket{/socket/name}{request string}{3s}{\n}\
9562   {socket failure}}
9563 .endd
9564 You can test for the existence of a Unix domain socket by wrapping this
9565 expansion in &`${if exists`&, but there is a race condition between that test
9566 and the actual opening of the socket, so it is safer to use the fifth argument
9567 if you want to be absolutely sure of avoiding an expansion error for a
9568 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9569
9570 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9571 locks out the use of this expansion item in filter files.
9572
9573
9574 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9575 .cindex "expansion" "reducing a list to a scalar"
9576 .cindex "list" "reducing to a scalar"
9577 .vindex "&$value$&"
9578 .vindex "&$item$&"
9579 This operation reduces a list to a single, scalar string. After expansion,
9580 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9581 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9582 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9583 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9584 them. The result of that expansion is assigned to &$value$& before the next
9585 iteration. When the end of the list is reached, the final value of &$value$& is
9586 added to the expansion output. The &*reduce*& expansion item can be used in a
9587 number of ways. For example, to add up a list of numbers:
9588 .code
9589 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9590 .endd
9591 The result of that expansion would be &`6`&. The maximum of a list of numbers
9592 can be found:
9593 .code
9594 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9595 .endd
9596 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9597 restored to what they were before. See also the &*filter*& and &*map*&
9598 expansion items.
9599
9600 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9601 This item inserts &"raw"& header lines. It is described with the &%header%&
9602 expansion item above.
9603
9604 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9605         {*&<&'string2'&>&*}}*&"
9606 .cindex "expansion" "running a command"
9607 .cindex "&%run%& expansion item"
9608 The command and its arguments are first expanded as one string. The string is
9609 split apart into individual arguments by spaces, and then the command is run
9610 in a separate process, but under the same uid and gid.  As in other command
9611 executions from Exim, a shell is not used by default. If the command requires
9612 a shell, you must explicitly code it.
9613
9614 Since the arguments are split by spaces, when there is a variable expansion
9615 which has an empty result, it will cause the situation that the argument will
9616 simply be omitted when the program is actually executed by Exim. If the
9617 script/program requires a specific number of arguments and the expanded
9618 variable could possibly result in this empty expansion, the variable must be
9619 quoted. This is more difficult if the expanded variable itself could result
9620 in a string containing quotes, because it would interfere with the quotes
9621 around the command arguments. A possible guard against this is to wrap the
9622 variable in the &%sg%& operator to change any quote marks to some other
9623 character.
9624
9625 The standard input for the command exists, but is empty. The standard output
9626 and standard error are set to the same file descriptor.
9627 .cindex "return code" "from &%run%& expansion"
9628 .vindex "&$value$&"
9629 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9630 and replaces the entire item; during this expansion, the standard output/error
9631 from the command is in the variable &$value$&. If the command fails,
9632 <&'string2'&>, if present, is expanded and used. Once again, during the
9633 expansion, the standard output/error from the command is in the variable
9634 &$value$&.
9635
9636 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9637 can be the word &"fail"& (not in braces) to force expansion failure if the
9638 command does not succeed. If both strings are omitted, the result is contents
9639 of the standard output/error on success, and nothing on failure.
9640
9641 .vindex "&$run_in_acl$&"
9642 The standard output/error of the command is put in the variable &$value$&.
9643 In this ACL example, the output of a command is logged for the admin to
9644 troubleshoot:
9645 .code
9646 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9647       log_message  = Output of id: $value
9648 .endd
9649 If the command requires shell idioms, such as the > redirect operator, the
9650 shell must be invoked directly, such as with:
9651 .code
9652 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9653 .endd
9654
9655 .vindex "&$runrc$&"
9656 The return code from the command is put in the variable &$runrc$&, and this
9657 remains set afterwards, so in a filter file you can do things like this:
9658 .code
9659 if "${run{x y z}{}}$runrc" is 1 then ...
9660   elif $runrc is 2 then ...
9661   ...
9662 endif
9663 .endd
9664 If execution of the command fails (for example, the command does not exist),
9665 the return code is 127 &-- the same code that shells use for non-existent
9666 commands.
9667
9668 &*Warning*&: In a router or transport, you cannot assume the order in which
9669 option values are expanded, except for those preconditions whose order of
9670 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9671 by the expansion of one option, and use it in another.
9672
9673 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9674 out the use of this expansion item in filter files.
9675
9676
9677 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9678 .cindex "expansion" "string substitution"
9679 .cindex "&%sg%& expansion item"
9680 This item works like Perl's substitution operator (s) with the global (/g)
9681 option; hence its name. However, unlike the Perl equivalent, Exim does not
9682 modify the subject string; instead it returns the modified string for insertion
9683 into the overall expansion. The item takes three arguments: the subject string,
9684 a regular expression, and a substitution string. For example:
9685 .code
9686 ${sg{abcdefabcdef}{abc}{xyz}}
9687 .endd
9688 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9689 if any $ or \ characters are required in the regular expression or in the
9690 substitution string, they have to be escaped. For example:
9691 .code
9692 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9693 .endd
9694 yields &"defabc"&, and
9695 .code
9696 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9697 .endd
9698 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9699 the regular expression from string expansion.
9700
9701
9702
9703 .new
9704 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9705 .cindex sorting a list
9706 .cindex list sorting
9707 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9708 default, but the separator can be changed in the usual way.
9709 The <&'comparator'&> argument is interpreted as the operator
9710 of a two-argument expansion condition.
9711 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9712 The comparison should return true when applied to two values
9713 if the first value should sort before the second value.
9714 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9715 the element being placed in &$item$&,
9716 to give values for comparison.
9717
9718 The item result is a sorted list,
9719 with the original list separator,
9720 of the list elements (in full) of the original.
9721
9722 Examples:
9723 .code
9724 ${sort{3:2:1:4}{<}{$item}}
9725 .endd
9726 sorts a list of numbers, and
9727 .code
9728 ${sort {$lookup dnsdb{>:,,mx=example.com}} {<} {${listextract{1}{<,$item}}}}
9729 .endd
9730 will sort an MX lookup into priority order.
9731 .wen
9732
9733
9734 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9735 .cindex "&%substr%& expansion item"
9736 .cindex "substring extraction"
9737 .cindex "expansion" "substring extraction"
9738 The three strings are expanded; the first two must yield numbers. Call them
9739 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9740 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9741 can use the simpler operator notation that avoids some of the braces:
9742 .code
9743 ${substr_<n>_<m>:<string>}
9744 .endd
9745 The second number is optional (in both notations).
9746 If it is absent in the simpler format, the preceding underscore must also be
9747 omitted.
9748
9749 The &%substr%& item can be used to extract more general substrings than
9750 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9751 length required. For example
9752 .code
9753 ${substr{3}{2}{$local_part}}
9754 .endd
9755 If the starting offset is greater than the string length the result is the
9756 null string; if the length plus starting offset is greater than the string
9757 length, the result is the right-hand part of the string, starting from the
9758 given offset. The first character in the string has offset zero.
9759
9760 The &%substr%& expansion item can take negative offset values to count
9761 from the right-hand end of its operand. The last character is offset -1, the
9762 second-last is offset -2, and so on. Thus, for example,
9763 .code
9764 ${substr{-5}{2}{1234567}}
9765 .endd
9766 yields &"34"&. If the absolute value of a negative offset is greater than the
9767 length of the string, the substring starts at the beginning of the string, and
9768 the length is reduced by the amount of overshoot. Thus, for example,
9769 .code
9770 ${substr{-5}{2}{12}}
9771 .endd
9772 yields an empty string, but
9773 .code
9774 ${substr{-3}{2}{12}}
9775 .endd
9776 yields &"1"&.
9777
9778 When the second number is omitted from &%substr%&, the remainder of the string
9779 is taken if the offset is positive. If it is negative, all characters in the
9780 string preceding the offset point are taken. For example, an offset of -1 and
9781 no length, as in these semantically identical examples:
9782 .code
9783 ${substr_-1:abcde}
9784 ${substr{-1}{abcde}}
9785 .endd
9786 yields all but the last character of the string, that is, &"abcd"&.
9787
9788
9789
9790 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9791         {*&<&'replacements'&>&*}}*&"
9792 .cindex "expansion" "character translation"
9793 .cindex "&%tr%& expansion item"
9794 This item does single-character translation on its subject string. The second
9795 argument is a list of characters to be translated in the subject string. Each
9796 matching character is replaced by the corresponding character from the
9797 replacement list. For example
9798 .code
9799 ${tr{abcdea}{ac}{13}}
9800 .endd
9801 yields &`1b3de1`&. If there are duplicates in the second character string, the
9802 last occurrence is used. If the third string is shorter than the second, its
9803 last character is replicated. However, if it is empty, no translation takes
9804 place.
9805 .endlist
9806
9807
9808
9809 .section "Expansion operators" "SECTexpop"
9810 .cindex "expansion" "operators"
9811 For expansion items that perform transformations on a single argument string,
9812 the &"operator"& notation is used because it is simpler and uses fewer braces.
9813 The substring is first expanded before the operation is applied to it. The
9814 following operations can be performed:
9815
9816 .vlist
9817 .vitem &*${address:*&<&'string'&>&*}*&
9818 .cindex "expansion" "RFC 2822 address handling"
9819 .cindex "&%address%& expansion item"
9820 The string is interpreted as an RFC 2822 address, as it might appear in a
9821 header line, and the effective address is extracted from it. If the string does
9822 not parse successfully, the result is empty.
9823
9824
9825 .vitem &*${addresses:*&<&'string'&>&*}*&
9826 .cindex "expansion" "RFC 2822 address handling"
9827 .cindex "&%addresses%& expansion item"
9828 The string (after expansion) is interpreted as a list of addresses in RFC
9829 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9830 operative address (&'local-part@domain'&) is extracted from each item, and the
9831 result of the expansion is a colon-separated list, with appropriate
9832 doubling of colons should any happen to be present in the email addresses.
9833 Syntactically invalid RFC2822 address items are omitted from the output.
9834
9835 It is possible to specify a character other than colon for the output
9836 separator by starting the string with > followed by the new separator
9837 character. For example:
9838 .code
9839 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9840 .endd
9841 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9842 expansion item, which extracts the working address from a single RFC2822
9843 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9844 processing lists.
9845
9846 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9847 a strict interpretation of header line formatting.  Exim parses the bare,
9848 unquoted portion of an email address and if it finds a comma, treats it as an
9849 email address seperator. For the example header line:
9850 .code
9851 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9852 .endd
9853 The first example below demonstrates that Q-encoded email addresses are parsed
9854 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9855 It does not see the comma because it's still encoded as "=2C".  The second
9856 example below is passed the contents of &`$header_from:`&, meaning it gets
9857 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9858 The third example shows that the presence of a comma is skipped when it is
9859 quoted.
9860 .code
9861 # exim -be '${addresses:From: \
9862 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9863 user@example.com
9864 # exim -be '${addresses:From: Last, First <user@example.com>}'
9865 Last:user@example.com
9866 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9867 user@example.com
9868 .endd
9869
9870 .vitem &*${base62:*&<&'digits'&>&*}*&
9871 .cindex "&%base62%& expansion item"
9872 .cindex "expansion" "conversion to base 62"
9873 The string must consist entirely of decimal digits. The number is converted to
9874 base 62 and output as a string of six characters, including leading zeros. In
9875 the few operating environments where Exim uses base 36 instead of base 62 for
9876 its message identifiers (because those systems do not have case-sensitive file
9877 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9878 be absolutely clear: this is &'not'& base64 encoding.
9879
9880 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9881 .cindex "&%base62d%& expansion item"
9882 .cindex "expansion" "conversion to base 62"
9883 The string must consist entirely of base-62 digits, or, in operating
9884 environments where Exim uses base 36 instead of base 62 for its message
9885 identifiers, base-36 digits. The number is converted to decimal and output as a
9886 string.
9887
9888
9889 .vitem &*${domain:*&<&'string'&>&*}*&
9890 .cindex "domain" "extraction"
9891 .cindex "expansion" "domain extraction"
9892 The string is interpreted as an RFC 2822 address and the domain is extracted
9893 from it. If the string does not parse successfully, the result is empty.
9894
9895
9896 .vitem &*${escape:*&<&'string'&>&*}*&
9897 .cindex "expansion" "escaping non-printing characters"
9898 .cindex "&%escape%& expansion item"
9899 If the string contains any non-printing characters, they are converted to
9900 escape sequences starting with a backslash. Whether characters with the most
9901 significant bit set (so-called &"8-bit characters"&) count as printing or not
9902 is controlled by the &%print_topbitchars%& option.
9903
9904
9905 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9906 .cindex "expansion" "expression evaluation"
9907 .cindex "expansion" "arithmetic expression"
9908 .cindex "&%eval%& expansion item"
9909 These items supports simple arithmetic and bitwise logical operations in
9910 expansion strings. The string (after expansion) must be a conventional
9911 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9912 logical operators, and parentheses. All operations are carried out using
9913 integer arithmetic. The operator priorities are as follows (the same as in the
9914 C programming language):
9915 .table2 70pt 300pt
9916 .irow &'highest:'& "not (~), negate (-)"
9917 .irow ""   "multiply (*), divide (/), remainder (%)"
9918 .irow ""   "plus (+), minus (-)"
9919 .irow ""   "shift-left (<<), shift-right (>>)"
9920 .irow ""   "and (&&)"
9921 .irow ""   "xor (^)"
9922 .irow &'lowest:'&  "or (|)"
9923 .endtable
9924 Binary operators with the same priority are evaluated from left to right. White
9925 space is permitted before or after operators.
9926
9927 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9928 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9929 decimal, even if they start with a leading zero; hexadecimal numbers are not
9930 permitted. This can be useful when processing numbers extracted from dates or
9931 times, which often do have leading zeros.
9932
9933 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9934 or 1024*1024*1024,
9935 respectively. Negative numbers are supported. The result of the computation is
9936 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9937
9938 .display
9939 &`${eval:1+1}            `&  yields 2
9940 &`${eval:1+2*3}          `&  yields 7
9941 &`${eval:(1+2)*3}        `&  yields 9
9942 &`${eval:2+42%5}         `&  yields 4
9943 &`${eval:0xc&amp;5}          `&  yields 4
9944 &`${eval:0xc|5}          `&  yields 13
9945 &`${eval:0xc^5}          `&  yields 9
9946 &`${eval:0xc>>1}         `&  yields 6
9947 &`${eval:0xc<<1}         `&  yields 24
9948 &`${eval:~255&amp;0x1234}    `&  yields 4608
9949 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9950 .endd
9951
9952 As a more realistic example, in an ACL you might have
9953 .code
9954 deny   message = Too many bad recipients
9955        condition =                    \
9956          ${if and {                   \
9957            {>{$rcpt_count}{10}}       \
9958            {                          \
9959            <                          \
9960              {$recipients_count}      \
9961              {${eval:$rcpt_count/2}}  \
9962            }                          \
9963          }{yes}{no}}
9964 .endd
9965 The condition is true if there have been more than 10 RCPT commands and
9966 fewer than half of them have resulted in a valid recipient.
9967
9968
9969 .vitem &*${expand:*&<&'string'&>&*}*&
9970 .cindex "expansion" "re-expansion of substring"
9971 The &%expand%& operator causes a string to be expanded for a second time. For
9972 example,
9973 .code
9974 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9975 .endd
9976 first looks up a string in a file while expanding the operand for &%expand%&,
9977 and then re-expands what it has found.
9978
9979
9980 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9981 .cindex "Unicode"
9982 .cindex "UTF-8" "conversion from"
9983 .cindex "expansion" "UTF-8 conversion"
9984 .cindex "&%from_utf8%& expansion item"
9985 The world is slowly moving towards Unicode, although there are no standards for
9986 email yet. However, other applications (including some databases) are starting
9987 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9988 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9989 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9990 the result is an undefined sequence of bytes.
9991
9992 Unicode code points with values less than 256 are compatible with ASCII and
9993 ISO-8859-1 (also known as Latin-1).
9994 For example, character 169 is the copyright symbol in both cases, though the
9995 way it is encoded is different. In UTF-8, more than one byte is needed for
9996 characters with code values greater than 127, whereas ISO-8859-1 is a
9997 single-byte encoding (but thereby limited to 256 characters). This makes
9998 translation from UTF-8 to ISO-8859-1 straightforward.
9999
10000
10001 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10002 .cindex "hash function" "textual"
10003 .cindex "expansion" "textual hash"
10004 The &%hash%& operator is a simpler interface to the hashing function that can
10005 be used when the two parameters are fixed numbers (as opposed to strings that
10006 change when expanded). The effect is the same as
10007 .code
10008 ${hash{<n>}{<m>}{<string>}}
10009 .endd
10010 See the description of the general &%hash%& item above for details. The
10011 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10012
10013
10014
10015 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10016 .cindex "base64 encoding" "conversion from hex"
10017 .cindex "expansion" "hex to base64"
10018 .cindex "&%hex2b64%& expansion item"
10019 This operator converts a hex string into one that is base64 encoded. This can
10020 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10021
10022
10023
10024 .vitem &*${hexquote:*&<&'string'&>&*}*&
10025 .cindex "quoting" "hex-encoded unprintable characters"
10026 .cindex "&%hexquote%& expansion item"
10027 This operator converts non-printable characters in a string into a hex
10028 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10029 as is, and other byte values are converted to &`\xNN`&, for example a
10030 byte value 127 is converted to &`\x7f`&.
10031
10032
10033 .vitem &*${lc:*&<&'string'&>&*}*&
10034 .cindex "case forcing in strings"
10035 .cindex "string" "case forcing"
10036 .cindex "lower casing"
10037 .cindex "expansion" "case forcing"
10038 .cindex "&%lc%& expansion item"
10039 This forces the letters in the string into lower-case, for example:
10040 .code
10041 ${lc:$local_part}
10042 .endd
10043
10044 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10045 .cindex "expansion" "string truncation"
10046 .cindex "&%length%& expansion item"
10047 The &%length%& operator is a simpler interface to the &%length%& function that
10048 can be used when the parameter is a fixed number (as opposed to a string that
10049 changes when expanded). The effect is the same as
10050 .code
10051 ${length{<number>}{<string>}}
10052 .endd
10053 See the description of the general &%length%& item above for details. Note that
10054 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10055 when &%length%& is used as an operator.
10056
10057
10058 .vitem &*${listcount:*&<&'string'&>&*}*&
10059 .cindex "expansion" "list item count"
10060 .cindex "list" "item count"
10061 .cindex "list" "count of items"
10062 .cindex "&%listcount%& expansion item"
10063 The string is interpreted as a list and the number of items is returned.
10064
10065
10066 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10067 .cindex "expansion" "named list"
10068 .cindex "&%listnamed%& expansion item"
10069 The name is interpreted as a named list and the content of the list is returned,
10070 expanding any referenced lists, re-quoting as needed for colon-separation.
10071 If the optional type is given it must be one of "a", "d", "h" or "l"
10072 and selects address-, domain-, host- or localpart- lists to search among respectively.
10073 Otherwise all types are searched in an undefined order and the first
10074 matching list is returned.
10075
10076
10077 .vitem &*${local_part:*&<&'string'&>&*}*&
10078 .cindex "expansion" "local part extraction"
10079 .cindex "&%local_part%& expansion item"
10080 The string is interpreted as an RFC 2822 address and the local part is
10081 extracted from it. If the string does not parse successfully, the result is
10082 empty.
10083
10084
10085 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10086 .cindex "masked IP address"
10087 .cindex "IP address" "masking"
10088 .cindex "CIDR notation"
10089 .cindex "expansion" "IP address masking"
10090 .cindex "&%mask%& expansion item"
10091 If the form of the string to be operated on is not an IP address followed by a
10092 slash and an integer (that is, a network address in CIDR notation), the
10093 expansion fails. Otherwise, this operator converts the IP address to binary,
10094 masks off the least significant bits according to the bit count, and converts
10095 the result back to text, with mask appended. For example,
10096 .code
10097 ${mask:10.111.131.206/28}
10098 .endd
10099 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10100 be mostly used for looking up masked addresses in files, the result for an IPv6
10101 address uses dots to separate components instead of colons, because colon
10102 terminates a key string in lsearch files. So, for example,
10103 .code
10104 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10105 .endd
10106 returns the string
10107 .code
10108 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10109 .endd
10110 Letters in IPv6 addresses are always output in lower case.
10111
10112
10113 .vitem &*${md5:*&<&'string'&>&*}*&
10114 .cindex "MD5 hash"
10115 .cindex "expansion" "MD5 hash"
10116 .cindex "certificate fingerprint"
10117 .cindex "&%md5%& expansion item"
10118 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10119 as a 32-digit hexadecimal number, in which any letters are in lower case.
10120
10121
10122 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10123 .cindex "expansion" "numeric hash"
10124 .cindex "hash function" "numeric"
10125 The &%nhash%& operator is a simpler interface to the numeric hashing function
10126 that can be used when the two parameters are fixed numbers (as opposed to
10127 strings that change when expanded). The effect is the same as
10128 .code
10129 ${nhash{<n>}{<m>}{<string>}}
10130 .endd
10131 See the description of the general &%nhash%& item above for details.
10132
10133
10134 .vitem &*${quote:*&<&'string'&>&*}*&
10135 .cindex "quoting" "in string expansions"
10136 .cindex "expansion" "quoting"
10137 .cindex "&%quote%& expansion item"
10138 The &%quote%& operator puts its argument into double quotes if it
10139 is an empty string or
10140 contains anything other than letters, digits, underscores, dots, and hyphens.
10141 Any occurrences of double quotes and backslashes are escaped with a backslash.
10142 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10143 respectively For example,
10144 .code
10145 ${quote:ab"*"cd}
10146 .endd
10147 becomes
10148 .code
10149 "ab\"*\"cd"
10150 .endd
10151 The place where this is useful is when the argument is a substitution from a
10152 variable or a message header.
10153
10154 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10155 .cindex "&%quote_local_part%& expansion item"
10156 This operator is like &%quote%&, except that it quotes the string only if
10157 required to do so by the rules of RFC 2822 for quoting local parts. For
10158 example, a plus sign would not cause quoting (but it would for &%quote%&).
10159 If you are creating a new email address from the contents of &$local_part$&
10160 (or any other unknown data), you should always use this operator.
10161
10162
10163 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10164 .cindex "quoting" "lookup-specific"
10165 This operator applies lookup-specific quoting rules to the string. Each
10166 query-style lookup type has its own quoting rules which are described with
10167 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10168 .code
10169 ${quote_ldap:two * two}
10170 .endd
10171 returns
10172 .code
10173 two%20%5C2A%20two
10174 .endd
10175 For single-key lookup types, no quoting is ever necessary and this operator
10176 yields an unchanged string.
10177
10178
10179 .vitem &*${randint:*&<&'n'&>&*}*&
10180 .cindex "random number"
10181 This operator returns a somewhat random number which is less than the
10182 supplied number and is at least 0.  The quality of this randomness depends
10183 on how Exim was built; the values are not suitable for keying material.
10184 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10185 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10186 for versions of GnuTLS with that function.
10187 Otherwise, the implementation may be arc4random(), random() seeded by
10188 srandomdev() or srandom(), or a custom implementation even weaker than
10189 random().
10190
10191
10192 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10193 .cindex "expansion" "IP address"
10194 This operator reverses an IP address; for IPv4 addresses, the result is in
10195 dotted-quad decimal form, while for IPv6 addreses the result is in
10196 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10197 for DNS.  For example,
10198 .code
10199 ${reverse_ip:192.0.2.4}
10200 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10201 .endd
10202 returns
10203 .code
10204 4.2.0.192
10205 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
10206 .endd
10207
10208
10209 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10210 .cindex "expansion" "RFC 2047"
10211 .cindex "RFC 2047" "expansion operator"
10212 .cindex "&%rfc2047%& expansion item"
10213 This operator encodes text according to the rules of RFC 2047. This is an
10214 encoding that is used in header lines to encode non-ASCII characters. It is
10215 assumed that the input string is in the encoding specified by the
10216 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10217 contains only characters in the range 33&--126, and no instances of the
10218 characters
10219 .code
10220 ? = ( ) < > @ , ; : \ " . [ ] _
10221 .endd
10222 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10223 string, using as many &"encoded words"& as necessary to encode all the
10224 characters.
10225
10226
10227 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10228 .cindex "expansion" "RFC 2047"
10229 .cindex "RFC 2047" "decoding"
10230 .cindex "&%rfc2047d%& expansion item"
10231 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10232 bytes are replaced by question marks. Characters are converted into the
10233 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10234 not recognized unless &%check_rfc2047_length%& is set false.
10235
10236 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10237 access a header line, RFC 2047 decoding is done automatically. You do not need
10238 to use this operator as well.
10239
10240
10241
10242 .vitem &*${rxquote:*&<&'string'&>&*}*&
10243 .cindex "quoting" "in regular expressions"
10244 .cindex "regular expressions" "quoting"
10245 .cindex "&%rxquote%& expansion item"
10246 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10247 characters in its argument. This is useful when substituting the values of
10248 variables or headers inside regular expressions.
10249
10250
10251 .vitem &*${sha1:*&<&'string'&>&*}*&
10252 .cindex "SHA-1 hash"
10253 .cindex "expansion" "SHA-1 hashing"
10254 .cindex "certificate fingerprint"
10255 .cindex "&%sha2%& expansion item"
10256 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10257 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10258
10259
10260 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10261 .cindex "SHA-256 hash"
10262 .cindex "certificate fingerprint"
10263 .cindex "expansion" "SHA-256 hashing"
10264 .cindex "&%sha256%& expansion item"
10265 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10266 certificate,
10267 and returns
10268 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10269 Only arguments which are a single variable of certificate type are supported.
10270
10271
10272 .vitem &*${stat:*&<&'string'&>&*}*&
10273 .cindex "expansion" "statting a file"
10274 .cindex "file" "extracting characteristics"
10275 .cindex "&%stat%& expansion item"
10276 The string, after expansion, must be a file path. A call to the &[stat()]&
10277 function is made for this path. If &[stat()]& fails, an error occurs and the
10278 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10279 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10280 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10281 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10282 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10283 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10284 can extract individual fields using the &%extract%& expansion item.
10285
10286 The use of the &%stat%& expansion in users' filter files can be locked out by
10287 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10288 systems for files larger than 2GB.
10289
10290 .vitem &*${str2b64:*&<&'string'&>&*}*&
10291 .cindex "expansion" "base64 encoding"
10292 .cindex "base64 encoding" "in string expansion"
10293 .cindex "&%str2b64%& expansion item"
10294 This operator converts a string into one that is base64 encoded.
10295
10296
10297
10298 .vitem &*${strlen:*&<&'string'&>&*}*&
10299 .cindex "expansion" "string length"
10300 .cindex "string" "length in expansion"
10301 .cindex "&%strlen%& expansion item"
10302 The item is replace by the length of the expanded string, expressed as a
10303 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10304
10305
10306 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10307 .cindex "&%substr%& expansion item"
10308 .cindex "substring extraction"
10309 .cindex "expansion" "substring expansion"
10310 The &%substr%& operator is a simpler interface to the &%substr%& function that
10311 can be used when the two parameters are fixed numbers (as opposed to strings
10312 that change when expanded). The effect is the same as
10313 .code
10314 ${substr{<start>}{<length>}{<string>}}
10315 .endd
10316 See the description of the general &%substr%& item above for details. The
10317 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10318
10319 .vitem &*${time_eval:*&<&'string'&>&*}*&
10320 .cindex "&%time_eval%& expansion item"
10321 .cindex "time interval" "decoding"
10322 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10323 seconds.
10324
10325 .vitem &*${time_interval:*&<&'string'&>&*}*&
10326 .cindex "&%time_interval%& expansion item"
10327 .cindex "time interval" "formatting"
10328 The argument (after sub-expansion) must be a sequence of decimal digits that
10329 represents an interval of time as a number of seconds. It is converted into a
10330 number of larger units and output in Exim's normal time format, for example,
10331 &`1w3d4h2m6s`&.
10332
10333 .vitem &*${uc:*&<&'string'&>&*}*&
10334 .cindex "case forcing in strings"
10335 .cindex "string" "case forcing"
10336 .cindex "upper casing"
10337 .cindex "expansion" "case forcing"
10338 .cindex "&%uc%& expansion item"
10339 This forces the letters in the string into upper-case.
10340
10341 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10342 .cindex "correction of invalid utf-8 sequences in strings"
10343 .cindex "utf-8" "utf-8 sequences"
10344 .cindex "incorrect utf-8"
10345 .cindex "expansion" "utf-8 forcing"
10346 .cindex "&%utf8clean%& expansion item"
10347 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10348 .endlist
10349
10350
10351
10352
10353
10354
10355 .section "Expansion conditions" "SECTexpcond"
10356 .scindex IIDexpcond "expansion" "conditions"
10357 The following conditions are available for testing by the &%${if%& construct
10358 while expanding strings:
10359
10360 .vlist
10361 .vitem &*!*&<&'condition'&>
10362 .cindex "expansion" "negating a condition"
10363 .cindex "negation" "in expansion condition"
10364 Preceding any condition with an exclamation mark negates the result of the
10365 condition.
10366
10367 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10368 .cindex "numeric comparison"
10369 .cindex "expansion" "numeric comparison"
10370 There are a number of symbolic operators for doing numeric comparisons. They
10371 are:
10372 .display
10373 &`=   `&   equal
10374 &`==  `&   equal
10375 &`>   `&   greater
10376 &`>=  `&   greater or equal
10377 &`<   `&   less
10378 &`<=  `&   less or equal
10379 .endd
10380 For example:
10381 .code
10382 ${if >{$message_size}{10M} ...
10383 .endd
10384 Note that the general negation operator provides for inequality testing. The
10385 two strings must take the form of optionally signed decimal integers,
10386 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10387 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10388 As a special case, the numerical value of an empty string is taken as
10389 zero.
10390
10391 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10392 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10393 10M, not if 10M is larger than &$message_size$&.
10394
10395
10396 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10397         {*&<&'arg2'&>&*}...}*&
10398 .cindex "expansion" "calling an acl"
10399 .cindex "&%acl%&" "expansion condition"
10400 The name and zero to nine argument strings are first expanded separately.  The expanded
10401 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10402 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10403 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10404 and may use the variables; if another acl expansion is used the values
10405 are restored after it returns.  If the ACL sets
10406 a value using a "message =" modifier the variable $value becomes
10407 the result of the expansion, otherwise it is empty.
10408 If the ACL returns accept the condition is true; if deny, false.
10409 If the ACL returns defer the result is a forced-fail.
10410
10411 .vitem &*bool&~{*&<&'string'&>&*}*&
10412 .cindex "expansion" "boolean parsing"
10413 .cindex "&%bool%& expansion condition"
10414 This condition turns a string holding a true or false representation into
10415 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10416 (case-insensitively); also integer numbers map to true if non-zero,
10417 false if zero.
10418 An empty string is treated as false.
10419 Leading and trailing whitespace is ignored;
10420 thus a string consisting only of whitespace is false.
10421 All other string values will result in expansion failure.
10422
10423 When combined with ACL variables, this expansion condition will let you
10424 make decisions in one place and act on those decisions in another place.
10425 For example:
10426 .code
10427 ${if bool{$acl_m_privileged_sender} ...
10428 .endd
10429
10430
10431 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10432 .cindex "expansion" "boolean parsing"
10433 .cindex "&%bool_lax%& expansion condition"
10434 Like &%bool%&, this condition turns a string into a boolean state.  But
10435 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10436 loose definition that the Router &%condition%& option uses.  The empty string
10437 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10438 true.  Leading and trailing whitespace is ignored.
10439
10440 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10441
10442 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10443 .cindex "expansion" "encrypted comparison"
10444 .cindex "encrypted strings, comparing"
10445 .cindex "&%crypteq%& expansion condition"
10446 This condition is included in the Exim binary if it is built to support any
10447 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10448 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10449 included in the binary.
10450
10451 The &%crypteq%& condition has two arguments. The first is encrypted and
10452 compared against the second, which is already encrypted. The second string may
10453 be in the LDAP form for storing encrypted strings, which starts with the
10454 encryption type in curly brackets, followed by the data. If the second string
10455 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10456 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10457 Typically this will be a field from a password file. An example of an encrypted
10458 string in LDAP form is:
10459 .code
10460 {md5}CY9rzUYh03PK3k6DJie09g==
10461 .endd
10462 If such a string appears directly in an expansion, the curly brackets have to
10463 be quoted, because they are part of the expansion syntax. For example:
10464 .code
10465 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10466 .endd
10467 The following encryption types (whose names are matched case-independently) are
10468 supported:
10469
10470 .ilist
10471 .cindex "MD5 hash"
10472 .cindex "base64 encoding" "in encrypted password"
10473 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10474 printable characters to compare with the remainder of the second string. If the
10475 length of the comparison string is 24, Exim assumes that it is base64 encoded
10476 (as in the above example). If the length is 32, Exim assumes that it is a
10477 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10478 comparison fails.
10479
10480 .next
10481 .cindex "SHA-1 hash"
10482 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10483 printable characters to compare with the remainder of the second string. If the
10484 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10485 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10486 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10487
10488 .next
10489 .cindex "&[crypt()]&"
10490 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10491 only the first eight characters of the password. However, in modern operating
10492 systems this is no longer true, and in many cases the entire password is used,
10493 whatever its length.
10494
10495 .next
10496 .cindex "&[crypt16()]&"
10497 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10498 use up to 16 characters of the password in some operating systems. Again, in
10499 modern operating systems, more characters may be used.
10500 .endlist
10501 Exim has its own version of &[crypt16()]&, which is just a double call to
10502 &[crypt()]&. For operating systems that have their own version, setting
10503 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10504 operating system version instead of its own. This option is set by default in
10505 the OS-dependent &_Makefile_& for those operating systems that are known to
10506 support &[crypt16()]&.
10507
10508 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10509 it was not using the same algorithm as some operating systems' versions. It
10510 turns out that as well as &[crypt16()]& there is a function called
10511 &[bigcrypt()]& in some operating systems. This may or may not use the same
10512 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10513
10514 However, since there is now a move away from the traditional &[crypt()]&
10515 functions towards using SHA1 and other algorithms, tidying up this area of
10516 Exim is seen as very low priority.
10517
10518 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10519 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10520 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10521 default is &`{crypt}`&. Whatever the default, you can always use either
10522 function by specifying it explicitly in curly brackets.
10523
10524 .vitem &*def:*&<&'variable&~name'&>
10525 .cindex "expansion" "checking for empty variable"
10526 .cindex "&%def%& expansion condition"
10527 The &%def%& condition must be followed by the name of one of the expansion
10528 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10529 variable does not contain the empty string. For example:
10530 .code
10531 ${if def:sender_ident {from $sender_ident}}
10532 .endd
10533 Note that the variable name is given without a leading &%$%& character. If the
10534 variable does not exist, the expansion fails.
10535
10536 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10537         &~&*def:h_*&<&'header&~name'&>&*:*&"
10538 .cindex "expansion" "checking header line existence"
10539 This condition is true if a message is being processed and the named header
10540 exists in the message. For example,
10541 .code
10542 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10543 .endd
10544 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10545 the header name must be terminated by a colon if white space does not follow.
10546
10547 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10548        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10549 .cindex "string" "comparison"
10550 .cindex "expansion" "string comparison"
10551 .cindex "&%eq%& expansion condition"
10552 .cindex "&%eqi%& expansion condition"
10553 The two substrings are first expanded. The condition is true if the two
10554 resulting strings are identical. For &%eq%& the comparison includes the case of
10555 letters, whereas for &%eqi%& the comparison is case-independent.
10556
10557 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10558 .cindex "expansion" "file existence test"
10559 .cindex "file" "existence test"
10560 .cindex "&%exists%&, expansion condition"
10561 The substring is first expanded and then interpreted as an absolute path. The
10562 condition is true if the named file (or directory) exists. The existence test
10563 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10564 users' filter files may be locked out by the system administrator.
10565
10566 .vitem &*first_delivery*&
10567 .cindex "delivery" "first"
10568 .cindex "first delivery"
10569 .cindex "expansion" "first delivery test"
10570 .cindex "&%first_delivery%& expansion condition"
10571 This condition, which has no data, is true during a message's first delivery
10572 attempt. It is false during any subsequent delivery attempts.
10573
10574
10575 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10576        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10577 .cindex "list" "iterative conditions"
10578 .cindex "expansion" "&*forall*& condition"
10579 .cindex "expansion" "&*forany*& condition"
10580 .vindex "&$item$&"
10581 These conditions iterate over a list. The first argument is expanded to form
10582 the list. By default, the list separator is a colon, but it can be changed by
10583 the normal method. The second argument is interpreted as a condition that is to
10584 be applied to each item in the list in turn. During the interpretation of the
10585 condition, the current list item is placed in a variable called &$item$&.
10586 .ilist
10587 For &*forany*&, interpretation stops if the condition is true for any item, and
10588 the result of the whole condition is true. If the condition is false for all
10589 items in the list, the overall condition is false.
10590 .next
10591 For &*forall*&, interpretation stops if the condition is false for any item,
10592 and the result of the whole condition is false. If the condition is true for
10593 all items in the list, the overall condition is true.
10594 .endlist
10595 Note that negation of &*forany*& means that the condition must be false for all
10596 items for the overall condition to succeed, and negation of &*forall*& means
10597 that the condition must be false for at least one item. In this example, the
10598 list separator is changed to a comma:
10599 .code
10600 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10601 .endd
10602 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10603 being processed, to enable these expansion items to be nested.
10604
10605 To scan a named list, expand it with the &*listnamed*& operator.
10606
10607
10608 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10609        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10610 .cindex "string" "comparison"
10611 .cindex "expansion" "string comparison"
10612 .cindex "&%ge%& expansion condition"
10613 .cindex "&%gei%& expansion condition"
10614 The two substrings are first expanded. The condition is true if the first
10615 string is lexically greater than or equal to the second string. For &%ge%& the
10616 comparison includes the case of letters, whereas for &%gei%& the comparison is
10617 case-independent.
10618
10619 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10620        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10621 .cindex "string" "comparison"
10622 .cindex "expansion" "string comparison"
10623 .cindex "&%gt%& expansion condition"
10624 .cindex "&%gti%& expansion condition"
10625 The two substrings are first expanded. The condition is true if the first
10626 string is lexically greater than the second string. For &%gt%& the comparison
10627 includes the case of letters, whereas for &%gti%& the comparison is
10628 case-independent.
10629
10630 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10631        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10632 .cindex "string" "comparison"
10633 .cindex "list" "iterative conditions"
10634 Both strings are expanded; the second string is treated as a list of simple
10635 strings; if the first string is a member of the second, then the condition
10636 is true.
10637
10638 These are simpler to use versions of the more powerful &*forany*& condition.
10639 Examples, and the &*forany*& equivalents:
10640 .code
10641 ${if inlist{needle}{foo:needle:bar}}
10642   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10643 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10644   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10645 .endd
10646
10647 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10648        &*isip4&~{*&<&'string'&>&*}*& &&&
10649        &*isip6&~{*&<&'string'&>&*}*&
10650 .cindex "IP address" "testing string format"
10651 .cindex "string" "testing for IP address"
10652 .cindex "&%isip%& expansion condition"
10653 .cindex "&%isip4%& expansion condition"
10654 .cindex "&%isip6%& expansion condition"
10655 The substring is first expanded, and then tested to see if it has the form of
10656 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10657 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10658
10659 For an IPv4 address, the test is for four dot-separated components, each of
10660 which consists of from one to three digits. For an IPv6 address, up to eight
10661 colon-separated components are permitted, each containing from one to four
10662 hexadecimal digits. There may be fewer than eight components if an empty
10663 component (adjacent colons) is present. Only one empty component is permitted.
10664
10665 &*Note*&: The checks are just on the form of the address; actual numerical
10666 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10667 check. The main use of these tests is to distinguish between IP addresses and
10668 host names, or between IPv4 and IPv6 addresses. For example, you could use
10669 .code
10670 ${if isip4{$sender_host_address}...
10671 .endd
10672 to test which IP version an incoming SMTP connection is using.
10673
10674 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10675 .cindex "LDAP" "use for authentication"
10676 .cindex "expansion" "LDAP authentication test"
10677 .cindex "&%ldapauth%& expansion condition"
10678 This condition supports user authentication using LDAP. See section
10679 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10680 queries. For this use, the query must contain a user name and password. The
10681 query itself is not used, and can be empty. The condition is true if the
10682 password is not empty, and the user name and password are accepted by the LDAP
10683 server. An empty password is rejected without calling LDAP because LDAP binds
10684 with an empty password are considered anonymous regardless of the username, and
10685 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10686 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10687 this can be used.
10688
10689
10690 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10691        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10692 .cindex "string" "comparison"
10693 .cindex "expansion" "string comparison"
10694 .cindex "&%le%& expansion condition"
10695 .cindex "&%lei%& expansion condition"
10696 The two substrings are first expanded. The condition is true if the first
10697 string is lexically less than or equal to the second string. For &%le%& the
10698 comparison includes the case of letters, whereas for &%lei%& the comparison is
10699 case-independent.
10700
10701 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10702        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10703 .cindex "string" "comparison"
10704 .cindex "expansion" "string comparison"
10705 .cindex "&%lt%& expansion condition"
10706 .cindex "&%lti%& expansion condition"
10707 The two substrings are first expanded. The condition is true if the first
10708 string is lexically less than the second string. For &%lt%& the comparison
10709 includes the case of letters, whereas for &%lti%& the comparison is
10710 case-independent.
10711
10712
10713 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10714 .cindex "expansion" "regular expression comparison"
10715 .cindex "regular expressions" "match in expanded string"
10716 .cindex "&%match%& expansion condition"
10717 The two substrings are first expanded. The second is then treated as a regular
10718 expression and applied to the first. Because of the pre-expansion, if the
10719 regular expression contains dollar, or backslash characters, they must be
10720 escaped. Care must also be taken if the regular expression contains braces
10721 (curly brackets). A closing brace must be escaped so that it is not taken as a
10722 premature termination of <&'string2'&>. The easiest approach is to use the
10723 &`\N`& feature to disable expansion of the regular expression.
10724 For example,
10725 .code
10726 ${if match {$local_part}{\N^\d{3}\N} ...
10727 .endd
10728 If the whole expansion string is in double quotes, further escaping of
10729 backslashes is also required.
10730
10731 The condition is true if the regular expression match succeeds.
10732 The regular expression is not required to begin with a circumflex
10733 metacharacter, but if there is no circumflex, the expression is not anchored,
10734 and it may match anywhere in the subject, not just at the start. If you want
10735 the pattern to match at the end of the subject, you must include the &`$`&
10736 metacharacter at an appropriate point.
10737
10738 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10739 At the start of an &%if%& expansion the values of the numeric variable
10740 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10741 succeeds causes them to be reset to the substrings of that condition and they
10742 will have these values during the expansion of the success string. At the end
10743 of the &%if%& expansion, the previous values are restored. After testing a
10744 combination of conditions using &%or%&, the subsequent values of the numeric
10745 variables are those of the condition that succeeded.
10746
10747 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10748 .cindex "&%match_address%& expansion condition"
10749 See &*match_local_part*&.
10750
10751 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10752 .cindex "&%match_domain%& expansion condition"
10753 See &*match_local_part*&.
10754
10755 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10756 .cindex "&%match_ip%& expansion condition"
10757 This condition matches an IP address to a list of IP address patterns. It must
10758 be followed by two argument strings. The first (after expansion) must be an IP
10759 address or an empty string. The second (not expanded) is a restricted host
10760 list that can match only an IP address, not a host name. For example:
10761 .code
10762 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10763 .endd
10764 The specific types of host list item that are permitted in the list are:
10765
10766 .ilist
10767 An IP address, optionally with a CIDR mask.
10768 .next
10769 A single asterisk, which matches any IP address.
10770 .next
10771 An empty item, which matches only if the IP address is empty. This could be
10772 useful for testing for a locally submitted message or one from specific hosts
10773 in a single test such as
10774 . ==== As this is a nested list, any displays it contains must be indented
10775 . ==== as otherwise they are too far to the left. This comment applies to
10776 . ==== the use of xmlto plus fop. There's no problem when formatting with
10777 . ==== sdop, with or without the extra indent.
10778 .code
10779   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10780 .endd
10781 where the first item in the list is the empty string.
10782 .next
10783 The item @[] matches any of the local host's interface addresses.
10784 .next
10785 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10786 even if &`net-`& is not specified. There is never any attempt to turn the IP
10787 address into a host name. The most common type of linear search for
10788 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10789 masks. For example:
10790 .code
10791   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10792 .endd
10793 It is of course possible to use other kinds of lookup, and in such a case, you
10794 do need to specify the &`net-`& prefix if you want to specify a specific
10795 address mask, for example:
10796 .code
10797   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10798 .endd
10799 However, unless you are combining a &%match_ip%& condition with others, it is
10800 just as easy to use the fact that a lookup is itself a condition, and write:
10801 .code
10802   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10803 .endd
10804 .endlist ilist
10805
10806 Note that <&'string2'&> is not itself subject to string expansion, unless
10807 Exim was built with the EXPAND_LISTMATCH_RHS option.
10808
10809 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10810
10811 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10812 .cindex "domain list" "in expansion condition"
10813 .cindex "address list" "in expansion condition"
10814 .cindex "local part" "list, in expansion condition"
10815 .cindex "&%match_local_part%& expansion condition"
10816 This condition, together with &%match_address%& and &%match_domain%&, make it
10817 possible to test domain, address, and local part lists within expansions. Each
10818 condition requires two arguments: an item and a list to match. A trivial
10819 example is:
10820 .code
10821 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10822 .endd
10823 In each case, the second argument may contain any of the allowable items for a
10824 list of the appropriate type. Also, because the second argument (after
10825 expansion) is a standard form of list, it is possible to refer to a named list.
10826 Thus, you can use conditions like this:
10827 .code
10828 ${if match_domain{$domain}{+local_domains}{...
10829 .endd
10830 .cindex "&`+caseful`&"
10831 For address lists, the matching starts off caselessly, but the &`+caseful`&
10832 item can be used, as in all address lists, to cause subsequent items to
10833 have their local parts matched casefully. Domains are always matched
10834 caselessly.
10835
10836 Note that <&'string2'&> is not itself subject to string expansion, unless
10837 Exim was built with the EXPAND_LISTMATCH_RHS option.
10838
10839 &*Note*&: Host lists are &'not'& supported in this way. This is because
10840 hosts have two identities: a name and an IP address, and it is not clear
10841 how to specify cleanly how such a test would work. However, IP addresses can be
10842 matched using &%match_ip%&.
10843
10844 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10845 .cindex "PAM authentication"
10846 .cindex "AUTH" "with PAM"
10847 .cindex "Solaris" "PAM support"
10848 .cindex "expansion" "PAM authentication test"
10849 .cindex "&%pam%& expansion condition"
10850 &'Pluggable Authentication Modules'&
10851 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10852 available in the latest releases of Solaris and in some GNU/Linux
10853 distributions. The Exim support, which is intended for use in conjunction with
10854 the SMTP AUTH command, is available only if Exim is compiled with
10855 .code
10856 SUPPORT_PAM=yes
10857 .endd
10858 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10859 in some releases of GNU/Linux &%-ldl%& is also needed.
10860
10861 The argument string is first expanded, and the result must be a
10862 colon-separated list of strings. Leading and trailing white space is ignored.
10863 The PAM module is initialized with the service name &"exim"& and the user name
10864 taken from the first item in the colon-separated data string (<&'string1'&>).
10865 The remaining items in the data string are passed over in response to requests
10866 from the authentication function. In the simple case there will only be one
10867 request, for a password, so the data consists of just two strings.
10868
10869 There can be problems if any of the strings are permitted to contain colon
10870 characters. In the usual way, these have to be doubled to avoid being taken as
10871 separators. If the data is being inserted from a variable, the &%sg%& expansion
10872 item can be used to double any existing colons. For example, the configuration
10873 of a LOGIN authenticator might contain this setting:
10874 .code
10875 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10876 .endd
10877 For a PLAIN authenticator you could use:
10878 .code
10879 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10880 .endd
10881 In some operating systems, PAM authentication can be done only from a process
10882 running as root. Since Exim is running as the Exim user when receiving
10883 messages, this means that PAM cannot be used directly in those systems.
10884 A patched version of the &'pam_unix'& module that comes with the
10885 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10886 The patched module allows one special uid/gid combination, in addition to root,
10887 to authenticate. If you build the patched module to allow the Exim user and
10888 group, PAM can then be used from an Exim authenticator.
10889
10890
10891 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10892 .cindex "&'pwcheck'& daemon"
10893 .cindex "Cyrus"
10894 .cindex "expansion" "&'pwcheck'& authentication test"
10895 .cindex "&%pwcheck%& expansion condition"
10896 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10897 This is one way of making it possible for passwords to be checked by a process
10898 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10899 deprecated. Its replacement is &'saslauthd'& (see below).
10900
10901 The pwcheck support is not included in Exim by default. You need to specify
10902 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10903 building Exim. For example:
10904 .code
10905 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10906 .endd
10907 You do not need to install the full Cyrus software suite in order to use
10908 the pwcheck daemon. You can compile and install just the daemon alone
10909 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10910 access to the &_/var/pwcheck_& directory.
10911
10912 The &%pwcheck%& condition takes one argument, which must be the user name and
10913 password, separated by a colon. For example, in a LOGIN authenticator
10914 configuration, you might have this:
10915 .code
10916 server_condition = ${if pwcheck{$auth1:$auth2}}
10917 .endd
10918 Again, for a PLAIN authenticator configuration, this would be:
10919 .code
10920 server_condition = ${if pwcheck{$auth2:$auth3}}
10921 .endd
10922 .vitem &*queue_running*&
10923 .cindex "queue runner" "detecting when delivering from"
10924 .cindex "expansion" "queue runner test"
10925 .cindex "&%queue_running%& expansion condition"
10926 This condition, which has no data, is true during delivery attempts that are
10927 initiated by queue runner processes, and false otherwise.
10928
10929
10930 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10931 .cindex "Radius"
10932 .cindex "expansion" "Radius authentication"
10933 .cindex "&%radius%& expansion condition"
10934 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10935 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10936 the Radius client configuration file in order to build Exim with Radius
10937 support.
10938
10939 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10940 library, using the original API. If you are using release 0.4.0 or later of
10941 this library, you need to set
10942 .code
10943 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10944 .endd
10945 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10946 &%libradius%& library that comes with FreeBSD. To do this, set
10947 .code
10948 RADIUS_LIB_TYPE=RADLIB
10949 .endd
10950 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10951 You may also have to supply a suitable setting in EXTRALIBS so that the
10952 Radius library can be found when Exim is linked.
10953
10954 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10955 Radius client library, which calls the Radius server. The condition is true if
10956 the authentication is successful. For example:
10957 .code
10958 server_condition = ${if radius{<arguments>}}
10959 .endd
10960
10961
10962 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10963         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10964 .cindex "&'saslauthd'& daemon"
10965 .cindex "Cyrus"
10966 .cindex "expansion" "&'saslauthd'& authentication test"
10967 .cindex "&%saslauthd%& expansion condition"
10968 This condition supports user authentication using the Cyrus &'saslauthd'&
10969 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10970 Using this daemon is one way of making it possible for passwords to be checked
10971 by a process that is not running as root.
10972
10973 The saslauthd support is not included in Exim by default. You need to specify
10974 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10975 building Exim. For example:
10976 .code
10977 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10978 .endd
10979 You do not need to install the full Cyrus software suite in order to use
10980 the saslauthd daemon. You can compile and install just the daemon alone
10981 from the Cyrus SASL library.
10982
10983 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10984 two are mandatory. For example:
10985 .code
10986 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10987 .endd
10988 The service and the realm are optional (which is why the arguments are enclosed
10989 in their own set of braces). For details of the meaning of the service and
10990 realm, and how to run the daemon, consult the Cyrus documentation.
10991 .endlist vlist
10992
10993
10994
10995 .section "Combining expansion conditions" "SECID84"
10996 .cindex "expansion" "combining conditions"
10997 Several conditions can be tested at once by combining them using the &%and%&
10998 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10999 conditions on their own, and precede their lists of sub-conditions. Each
11000 sub-condition must be enclosed in braces within the overall braces that contain
11001 the list. No repetition of &%if%& is used.
11002
11003
11004 .vlist
11005 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11006 .cindex "&""or""& expansion condition"
11007 .cindex "expansion" "&""or""& of conditions"
11008 The sub-conditions are evaluated from left to right. The condition is true if
11009 any one of the sub-conditions is true.
11010 For example,
11011 .code
11012 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11013 .endd
11014 When a true sub-condition is found, the following ones are parsed but not
11015 evaluated. If there are several &"match"& sub-conditions the values of the
11016 numeric variables afterwards are taken from the first one that succeeds.
11017
11018 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11019 .cindex "&""and""& expansion condition"
11020 .cindex "expansion" "&""and""& of conditions"
11021 The sub-conditions are evaluated from left to right. The condition is true if
11022 all of the sub-conditions are true. If there are several &"match"&
11023 sub-conditions, the values of the numeric variables afterwards are taken from
11024 the last one. When a false sub-condition is found, the following ones are
11025 parsed but not evaluated.
11026 .endlist
11027 .ecindex IIDexpcond
11028
11029
11030
11031
11032 .section "Expansion variables" "SECTexpvar"
11033 .cindex "expansion" "variables, list of"
11034 This section contains an alphabetical list of all the expansion variables. Some
11035 of them are available only when Exim is compiled with specific options such as
11036 support for TLS or the content scanning extension.
11037
11038 .vlist
11039 .vitem "&$0$&, &$1$&, etc"
11040 .cindex "numerical variables (&$1$& &$2$& etc)"
11041 When a &%match%& expansion condition succeeds, these variables contain the
11042 captured substrings identified by the regular expression during subsequent
11043 processing of the success string of the containing &%if%& expansion item.
11044 However, they do not retain their values afterwards; in fact, their previous
11045 values are restored at the end of processing an &%if%& item. The numerical
11046 variables may also be set externally by some other matching process which
11047 precedes the expansion of the string. For example, the commands available in
11048 Exim filter files include an &%if%& command with its own regular expression
11049 matching condition.
11050
11051 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11052 Within an acl condition, expansion condition or expansion item
11053 any arguments are copied to these variables,
11054 any unused variables being made empty.
11055
11056 .vitem "&$acl_c...$&"
11057 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11058 can be given any name that starts with &$acl_c$& and is at least six characters
11059 long, but the sixth character must be either a digit or an underscore. For
11060 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11061 variables persist throughout the lifetime of an SMTP connection. They can be
11062 used to pass information between ACLs and between different invocations of the
11063 same ACL. When a message is received, the values of these variables are saved
11064 with the message, and can be accessed by filters, routers, and transports
11065 during subsequent delivery.
11066
11067 .vitem "&$acl_m...$&"
11068 These variables are like the &$acl_c...$& variables, except that their values
11069 are reset after a message has been received. Thus, if several messages are
11070 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11071 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11072 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11073 message is received, the values of these variables are saved with the message,
11074 and can be accessed by filters, routers, and transports during subsequent
11075 delivery.
11076
11077 .vitem &$acl_narg$&
11078 Within an acl condition, expansion condition or expansion item
11079 this variable has the number of arguments.
11080
11081 .vitem &$acl_verify_message$&
11082 .vindex "&$acl_verify_message$&"
11083 After an address verification has failed, this variable contains the failure
11084 message. It retains its value for use in subsequent modifiers. The message can
11085 be preserved by coding like this:
11086 .code
11087 warn !verify = sender
11088      set acl_m0 = $acl_verify_message
11089 .endd
11090 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11091 &%log_message%& modifiers, to include information about the verification
11092 failure.
11093
11094 .vitem &$address_data$&
11095 .vindex "&$address_data$&"
11096 This variable is set by means of the &%address_data%& option in routers. The
11097 value then remains with the address while it is processed by subsequent routers
11098 and eventually a transport. If the transport is handling multiple addresses,
11099 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11100 for more details. &*Note*&: The contents of &$address_data$& are visible in
11101 user filter files.
11102
11103 If &$address_data$& is set when the routers are called from an ACL to verify
11104 a recipient address, the final value is still in the variable for subsequent
11105 conditions and modifiers of the ACL statement. If routing the address caused it
11106 to be redirected to just one address, the child address is also routed as part
11107 of the verification, and in this case the final value of &$address_data$& is
11108 from the child's routing.
11109
11110 If &$address_data$& is set when the routers are called from an ACL to verify a
11111 sender address, the final value is also preserved, but this time in
11112 &$sender_address_data$&, to distinguish it from data from a recipient
11113 address.
11114
11115 In both cases (recipient and sender verification), the value does not persist
11116 after the end of the current ACL statement. If you want to preserve
11117 these values for longer, you can save them in ACL variables.
11118
11119 .vitem &$address_file$&
11120 .vindex "&$address_file$&"
11121 When, as a result of aliasing, forwarding, or filtering, a message is directed
11122 to a specific file, this variable holds the name of the file when the transport
11123 is running. At other times, the variable is empty. For example, using the
11124 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11125 .code
11126 /home/r2d2/savemail
11127 .endd
11128 then when the &(address_file)& transport is running, &$address_file$&
11129 contains the text string &`/home/r2d2/savemail`&.
11130 .cindex "Sieve filter" "value of &$address_file$&"
11131 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11132 then up to the transport configuration to generate an appropriate absolute path
11133 to the relevant file.
11134
11135 .vitem &$address_pipe$&
11136 .vindex "&$address_pipe$&"
11137 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11138 this variable holds the pipe command when the transport is running.
11139
11140 .vitem "&$auth1$& &-- &$auth3$&"
11141 .vindex "&$auth1$&, &$auth2$&, etc"
11142 These variables are used in SMTP authenticators (see chapters
11143 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11144
11145 .vitem &$authenticated_id$&
11146 .cindex "authentication" "id"
11147 .vindex "&$authenticated_id$&"
11148 When a server successfully authenticates a client it may be configured to
11149 preserve some of the authentication information in the variable
11150 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11151 user/password authenticator configuration might preserve the user name for use
11152 in the routers. Note that this is not the same information that is saved in
11153 &$sender_host_authenticated$&.
11154 When a message is submitted locally (that is, not over a TCP connection)
11155 the value of &$authenticated_id$& is normally the login name of the calling
11156 process. However, a trusted user can override this by means of the &%-oMai%&
11157 command line option.
11158
11159 .vitem &$authenticated_fail_id$&
11160 .cindex "authentication" "fail" "id"
11161 .vindex "&$authenticated_fail_id$&"
11162 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11163 will contain the failed authentication id. If more than one authentication
11164 id is attempted, it will contain only the last one. The variable is
11165 available for processing in the ACL's, generally the quit or notquit ACL.
11166 A message to a local recipient could still be accepted without requiring
11167 authentication, which means this variable could also be visible in all of
11168 the ACL's as well.
11169
11170
11171 .vitem &$authenticated_sender$&
11172 .cindex "sender" "authenticated"
11173 .cindex "authentication" "sender"
11174 .cindex "AUTH" "on MAIL command"
11175 .vindex "&$authenticated_sender$&"
11176 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11177 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11178 described in section &<<SECTauthparamail>>&. Unless the data is the string
11179 &"<>"&, it is set as the authenticated sender of the message, and the value is
11180 available during delivery in the &$authenticated_sender$& variable. If the
11181 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11182
11183 .vindex "&$qualify_domain$&"
11184 When a message is submitted locally (that is, not over a TCP connection), the
11185 value of &$authenticated_sender$& is an address constructed from the login
11186 name of the calling process and &$qualify_domain$&, except that a trusted user
11187 can override this by means of the &%-oMas%& command line option.
11188
11189
11190 .vitem &$authentication_failed$&
11191 .cindex "authentication" "failure"
11192 .vindex "&$authentication_failed$&"
11193 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11194 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11195 possible to distinguish between &"did not try to authenticate"&
11196 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11197 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11198 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11199 negative response to an AUTH command, including (for example) an attempt to use
11200 an undefined mechanism.
11201
11202 .vitem &$av_failed$&
11203 .cindex "content scanning" "AV scanner failure"
11204 This variable is available when Exim is compiled with the content-scanning
11205 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11206 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11207 the ACL malware condition.
11208
11209 .vitem &$body_linecount$&
11210 .cindex "message body" "line count"
11211 .cindex "body of message" "line count"
11212 .vindex "&$body_linecount$&"
11213 When a message is being received or delivered, this variable contains the
11214 number of lines in the message's body. See also &$message_linecount$&.
11215
11216 .vitem &$body_zerocount$&
11217 .cindex "message body" "binary zero count"
11218 .cindex "body of message" "binary zero count"
11219 .cindex "binary zero" "in message body"
11220 .vindex "&$body_zerocount$&"
11221 When a message is being received or delivered, this variable contains the
11222 number of binary zero bytes (ASCII NULs) in the message's body.
11223
11224 .vitem &$bounce_recipient$&
11225 .vindex "&$bounce_recipient$&"
11226 This is set to the recipient address of a bounce message while Exim is creating
11227 it. It is useful if a customized bounce message text file is in use (see
11228 chapter &<<CHAPemsgcust>>&).
11229
11230 .vitem &$bounce_return_size_limit$&
11231 .vindex "&$bounce_return_size_limit$&"
11232 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11233 up to a multiple of 1000. It is useful when a customized error message text
11234 file is in use (see chapter &<<CHAPemsgcust>>&).
11235
11236 .vitem &$caller_gid$&
11237 .cindex "gid (group id)" "caller"
11238 .vindex "&$caller_gid$&"
11239 The real group id under which the process that called Exim was running. This is
11240 not the same as the group id of the originator of a message (see
11241 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11242 incarnation normally contains the Exim gid.
11243
11244 .vitem &$caller_uid$&
11245 .cindex "uid (user id)" "caller"
11246 .vindex "&$caller_uid$&"
11247 The real user id under which the process that called Exim was running. This is
11248 not the same as the user id of the originator of a message (see
11249 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11250 incarnation normally contains the Exim uid.
11251
11252 .vitem &$compile_date$&
11253 .vindex "&$compile_date$&"
11254 The date on which the Exim binary was compiled.
11255
11256 .vitem &$compile_number$&
11257 .vindex "&$compile_number$&"
11258 The building process for Exim keeps a count of the number
11259 of times it has been compiled. This serves to distinguish different
11260 compilations of the same version of the program.
11261
11262 .vitem &$demime_errorlevel$&
11263 .vindex "&$demime_errorlevel$&"
11264 This variable is available when Exim is compiled with
11265 the content-scanning extension and the obsolete &%demime%& condition. For
11266 details, see section &<<SECTdemimecond>>&.
11267
11268 .vitem &$demime_reason$&
11269 .vindex "&$demime_reason$&"
11270 This variable is available when Exim is compiled with the
11271 content-scanning extension and the obsolete &%demime%& condition. For details,
11272 see section &<<SECTdemimecond>>&.
11273
11274 .vitem &$dnslist_domain$& &&&
11275        &$dnslist_matched$& &&&
11276        &$dnslist_text$& &&&
11277        &$dnslist_value$&
11278 .vindex "&$dnslist_domain$&"
11279 .vindex "&$dnslist_matched$&"
11280 .vindex "&$dnslist_text$&"
11281 .vindex "&$dnslist_value$&"
11282 .cindex "black list (DNS)"
11283 When a DNS (black) list lookup succeeds, these variables are set to contain
11284 the following data from the lookup: the list's domain name, the key that was
11285 looked up, the contents of any associated TXT record, and the value from the
11286 main A record. See section &<<SECID204>>& for more details.
11287
11288 .vitem &$domain$&
11289 .vindex "&$domain$&"
11290 When an address is being routed, or delivered on its own, this variable
11291 contains the domain. Uppercase letters in the domain are converted into lower
11292 case for &$domain$&.
11293
11294 Global address rewriting happens when a message is received, so the value of
11295 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11296 is set during user filtering, but not during system filtering, because a
11297 message may have many recipients and the system filter is called just once.
11298
11299 When more than one address is being delivered at once (for example, several
11300 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11301 have the same domain. Transports can be restricted to handling only one domain
11302 at a time if the value of &$domain$& is required at transport time &-- this is
11303 the default for local transports. For further details of the environment in
11304 which local transports are run, see chapter &<<CHAPenvironment>>&.
11305
11306 .oindex "&%delay_warning_condition%&"
11307 At the end of a delivery, if all deferred addresses have the same domain, it is
11308 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11309
11310 The &$domain$& variable is also used in some other circumstances:
11311
11312 .ilist
11313 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11314 the recipient address. The domain of the &'sender'& address is in
11315 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11316 normally set during the running of the MAIL ACL. However, if the sender address
11317 is verified with a callout during the MAIL ACL, the sender domain is placed in
11318 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11319 the &(smtp)& transport.
11320
11321 .next
11322 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11323 &$domain$& contains the domain portion of the address that is being rewritten;
11324 it can be used in the expansion of the replacement address, for example, to
11325 rewrite domains by file lookup.
11326
11327 .next
11328 With one important exception, whenever a domain list is being scanned,
11329 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11330 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11331 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11332 that, in a RCPT ACL, the sender domain list can be dependent on the
11333 recipient domain (which is what is in &$domain$& at this time).
11334
11335 .next
11336 .cindex "ETRN" "value of &$domain$&"
11337 .oindex "&%smtp_etrn_command%&"
11338 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11339 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11340 .endlist
11341
11342
11343 .vitem &$domain_data$&
11344 .vindex "&$domain_data$&"
11345 When the &%domains%& option on a router matches a domain by
11346 means of a lookup, the data read by the lookup is available during the running
11347 of the router as &$domain_data$&. In addition, if the driver routes the
11348 address to a transport, the value is available in that transport. If the
11349 transport is handling multiple addresses, the value from the first address is
11350 used.
11351
11352 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11353 domain by means of a lookup. The data read by the lookup is available during
11354 the rest of the ACL statement. In all other situations, this variable expands
11355 to nothing.
11356
11357 .vitem &$exim_gid$&
11358 .vindex "&$exim_gid$&"
11359 This variable contains the numerical value of the Exim group id.
11360
11361 .vitem &$exim_path$&
11362 .vindex "&$exim_path$&"
11363 This variable contains the path to the Exim binary.
11364
11365 .vitem &$exim_uid$&
11366 .vindex "&$exim_uid$&"
11367 This variable contains the numerical value of the Exim user id.
11368
11369 .vitem &$found_extension$&
11370 .vindex "&$found_extension$&"
11371 This variable is available when Exim is compiled with the
11372 content-scanning extension and the obsolete &%demime%& condition. For details,
11373 see section &<<SECTdemimecond>>&.
11374
11375 .vitem &$header_$&<&'name'&>
11376 This is not strictly an expansion variable. It is expansion syntax for
11377 inserting the message header line with the given name. Note that the name must
11378 be terminated by colon or white space, because it may contain a wide variety of
11379 characters. Note also that braces must &'not'& be used.
11380
11381 .vitem &$headers_added$&
11382 .vindex "&$headers_added$&"
11383 Within an ACL this variable contains the headers added so far by
11384 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11385 The headers are a newline-separated list.
11386
11387 .vitem &$home$&
11388 .vindex "&$home$&"
11389 When the &%check_local_user%& option is set for a router, the user's home
11390 directory is placed in &$home$& when the check succeeds. In particular, this
11391 means it is set during the running of users' filter files. A router may also
11392 explicitly set a home directory for use by a transport; this can be overridden
11393 by a setting on the transport itself.
11394
11395 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11396 of the environment variable HOME.
11397
11398 .vitem &$host$&
11399 .vindex "&$host$&"
11400 If a router assigns an address to a transport (any transport), and passes a
11401 list of hosts with the address, the value of &$host$& when the transport starts
11402 to run is the name of the first host on the list. Note that this applies both
11403 to local and remote transports.
11404
11405 .cindex "transport" "filter"
11406 .cindex "filter" "transport filter"
11407 For the &(smtp)& transport, if there is more than one host, the value of
11408 &$host$& changes as the transport works its way through the list. In
11409 particular, when the &(smtp)& transport is expanding its options for encryption
11410 using TLS, or for specifying a transport filter (see chapter
11411 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11412 is connected.
11413
11414 When used in the client part of an authenticator configuration (see chapter
11415 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11416 client is connected.
11417
11418
11419 .vitem &$host_address$&
11420 .vindex "&$host_address$&"
11421 This variable is set to the remote host's IP address whenever &$host$& is set
11422 for a remote connection. It is also set to the IP address that is being checked
11423 when the &%ignore_target_hosts%& option is being processed.
11424
11425 .vitem &$host_data$&
11426 .vindex "&$host_data$&"
11427 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11428 result of the lookup is made available in the &$host_data$& variable. This
11429 allows you, for example, to do things like this:
11430 .code
11431 deny  hosts = net-lsearch;/some/file
11432 message = $host_data
11433 .endd
11434 .vitem &$host_lookup_deferred$&
11435 .cindex "host name" "lookup, failure of"
11436 .vindex "&$host_lookup_deferred$&"
11437 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11438 message comes from a remote host and there is an attempt to look up the host's
11439 name from its IP address, and the attempt is not successful, one of these
11440 variables is set to &"1"&.
11441
11442 .ilist
11443 If the lookup receives a definite negative response (for example, a DNS lookup
11444 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11445
11446 .next
11447 If there is any kind of problem during the lookup, such that Exim cannot
11448 tell whether or not the host name is defined (for example, a timeout for a DNS
11449 lookup), &$host_lookup_deferred$& is set to &"1"&.
11450 .endlist ilist
11451
11452 Looking up a host's name from its IP address consists of more than just a
11453 single reverse lookup. Exim checks that a forward lookup of at least one of the
11454 names it receives from a reverse lookup yields the original IP address. If this
11455 is not the case, Exim does not accept the looked up name(s), and
11456 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11457 IP address (for example, the existence of a PTR record in the DNS) is not
11458 sufficient on its own for the success of a host name lookup. If the reverse
11459 lookup succeeds, but there is a lookup problem such as a timeout when checking
11460 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11461 &"1"&. See also &$sender_host_name$&.
11462
11463 .vitem &$host_lookup_failed$&
11464 .vindex "&$host_lookup_failed$&"
11465 See &$host_lookup_deferred$&.
11466
11467 .vitem &$host_port$&
11468 .vindex "&$host_port$&"
11469 This variable is set to the remote host's TCP port whenever &$host$& is set
11470 for an outbound connection.
11471
11472
11473 .vitem &$inode$&
11474 .vindex "&$inode$&"
11475 The only time this variable is set is while expanding the &%directory_file%&
11476 option in the &(appendfile)& transport. The variable contains the inode number
11477 of the temporary file which is about to be renamed. It can be used to construct
11478 a unique name for the file.
11479
11480 .vitem &$interface_address$&
11481 .vindex "&$interface_address$&"
11482 This is an obsolete name for &$received_ip_address$&.
11483
11484 .vitem &$interface_port$&
11485 .vindex "&$interface_port$&"
11486 This is an obsolete name for &$received_port$&.
11487
11488 .vitem &$item$&
11489 .vindex "&$item$&"
11490 This variable is used during the expansion of &*forall*& and &*forany*&
11491 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11492 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11493 empty.
11494
11495 .vitem &$ldap_dn$&
11496 .vindex "&$ldap_dn$&"
11497 This variable, which is available only when Exim is compiled with LDAP support,
11498 contains the DN from the last entry in the most recently successful LDAP
11499 lookup.
11500
11501 .vitem &$load_average$&
11502 .vindex "&$load_average$&"
11503 This variable contains the system load average, multiplied by 1000 so that it
11504 is an integer. For example, if the load average is 0.21, the value of the
11505 variable is 210. The value is recomputed every time the variable is referenced.
11506
11507 .vitem &$local_part$&
11508 .vindex "&$local_part$&"
11509 When an address is being routed, or delivered on its own, this
11510 variable contains the local part. When a number of addresses are being
11511 delivered together (for example, multiple RCPT commands in an SMTP
11512 session), &$local_part$& is not set.
11513
11514 Global address rewriting happens when a message is received, so the value of
11515 &$local_part$& during routing and delivery is the value after rewriting.
11516 &$local_part$& is set during user filtering, but not during system filtering,
11517 because a message may have many recipients and the system filter is called just
11518 once.
11519
11520 .vindex "&$local_part_prefix$&"
11521 .vindex "&$local_part_suffix$&"
11522 If a local part prefix or suffix has been recognized, it is not included in the
11523 value of &$local_part$& during routing and subsequent delivery. The values of
11524 any prefix or suffix are in &$local_part_prefix$& and
11525 &$local_part_suffix$&, respectively.
11526
11527 When a message is being delivered to a file, pipe, or autoreply transport as a
11528 result of aliasing or forwarding, &$local_part$& is set to the local part of
11529 the parent address, not to the file name or command (see &$address_file$& and
11530 &$address_pipe$&).
11531
11532 When an ACL is running for a RCPT command, &$local_part$& contains the
11533 local part of the recipient address.
11534
11535 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11536 &$local_part$& contains the local part of the address that is being rewritten;
11537 it can be used in the expansion of the replacement address, for example.
11538
11539 In all cases, all quoting is removed from the local part. For example, for both
11540 the addresses
11541 .code
11542 "abc:xyz"@test.example
11543 abc\:xyz@test.example
11544 .endd
11545 the value of &$local_part$& is
11546 .code
11547 abc:xyz
11548 .endd
11549 If you use &$local_part$& to create another address, you should always wrap it
11550 inside a quoting operator. For example, in a &(redirect)& router you could
11551 have:
11552 .code
11553 data = ${quote_local_part:$local_part}@new.domain.example
11554 .endd
11555 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11556 to process local parts in a case-dependent manner in a router, you can set the
11557 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11558
11559 .vitem &$local_part_data$&
11560 .vindex "&$local_part_data$&"
11561 When the &%local_parts%& option on a router matches a local part by means of a
11562 lookup, the data read by the lookup is available during the running of the
11563 router as &$local_part_data$&. In addition, if the driver routes the address
11564 to a transport, the value is available in that transport. If the transport is
11565 handling multiple addresses, the value from the first address is used.
11566
11567 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11568 matches a local part by means of a lookup. The data read by the lookup is
11569 available during the rest of the ACL statement. In all other situations, this
11570 variable expands to nothing.
11571
11572 .vitem &$local_part_prefix$&
11573 .vindex "&$local_part_prefix$&"
11574 When an address is being routed or delivered, and a
11575 specific prefix for the local part was recognized, it is available in this
11576 variable, having been removed from &$local_part$&.
11577
11578 .vitem &$local_part_suffix$&
11579 .vindex "&$local_part_suffix$&"
11580 When an address is being routed or delivered, and a
11581 specific suffix for the local part was recognized, it is available in this
11582 variable, having been removed from &$local_part$&.
11583
11584 .vitem &$local_scan_data$&
11585 .vindex "&$local_scan_data$&"
11586 This variable contains the text returned by the &[local_scan()]& function when
11587 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11588
11589 .vitem &$local_user_gid$&
11590 .vindex "&$local_user_gid$&"
11591 See &$local_user_uid$&.
11592
11593 .vitem &$local_user_uid$&
11594 .vindex "&$local_user_uid$&"
11595 This variable and &$local_user_gid$& are set to the uid and gid after the
11596 &%check_local_user%& router precondition succeeds. This means that their values
11597 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11598 and &%condition%&), for the &%address_data%& expansion, and for any
11599 router-specific expansions. At all other times, the values in these variables
11600 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11601
11602 .vitem &$localhost_number$&
11603 .vindex "&$localhost_number$&"
11604 This contains the expanded value of the
11605 &%localhost_number%& option. The expansion happens after the main options have
11606 been read.
11607
11608 .vitem &$log_inodes$&
11609 .vindex "&$log_inodes$&"
11610 The number of free inodes in the disk partition where Exim's
11611 log files are being written. The value is recalculated whenever the variable is
11612 referenced. If the relevant file system does not have the concept of inodes,
11613 the value of is -1. See also the &%check_log_inodes%& option.
11614
11615 .vitem &$log_space$&
11616 .vindex "&$log_space$&"
11617 The amount of free space (as a number of kilobytes) in the disk
11618 partition where Exim's log files are being written. The value is recalculated
11619 whenever the variable is referenced. If the operating system does not have the
11620 ability to find the amount of free space (only true for experimental systems),
11621 the space value is -1. See also the &%check_log_space%& option.
11622
11623
11624 .vitem &$lookup_dnssec_authenticated$&
11625 .vindex "&$lookup_dnssec_authenticated$&"
11626 This variable is set after a DNS lookup done by
11627 a dnsdb lookup expansion, dnslookup router or smtp transport.
11628 It will be empty if &(DNSSEC)& was not requested,
11629 &"no"& if the result was not labelled as authenticated data
11630 and &"yes"& if it was.
11631
11632 .vitem &$mailstore_basename$&
11633 .vindex "&$mailstore_basename$&"
11634 This variable is set only when doing deliveries in &"mailstore"& format in the
11635 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11636 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11637 contains the basename of the files that are being written, that is, the name
11638 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11639 variable is empty.
11640
11641 .vitem &$malware_name$&
11642 .vindex "&$malware_name$&"
11643 This variable is available when Exim is compiled with the
11644 content-scanning extension. It is set to the name of the virus that was found
11645 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11646
11647 .vitem &$max_received_linelength$&
11648 .vindex "&$max_received_linelength$&"
11649 .cindex "maximum" "line length"
11650 .cindex "line length" "maximum"
11651 This variable contains the number of bytes in the longest line that was
11652 received as part of the message, not counting the line termination
11653 character(s).
11654
11655 .vitem &$message_age$&
11656 .cindex "message" "age of"
11657 .vindex "&$message_age$&"
11658 This variable is set at the start of a delivery attempt to contain the number
11659 of seconds since the message was received. It does not change during a single
11660 delivery attempt.
11661
11662 .vitem &$message_body$&
11663 .cindex "body of message" "expansion variable"
11664 .cindex "message body" "in expansion"
11665 .cindex "binary zero" "in message body"
11666 .vindex "&$message_body$&"
11667 .oindex "&%message_body_visible%&"
11668 This variable contains the initial portion of a message's body while it is
11669 being delivered, and is intended mainly for use in filter files. The maximum
11670 number of characters of the body that are put into the variable is set by the
11671 &%message_body_visible%& configuration option; the default is 500.
11672
11673 .oindex "&%message_body_newlines%&"
11674 By default, newlines are converted into spaces in &$message_body$&, to make it
11675 easier to search for phrases that might be split over a line break. However,
11676 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11677 zeros are always converted into spaces.
11678
11679 .vitem &$message_body_end$&
11680 .cindex "body of message" "expansion variable"
11681 .cindex "message body" "in expansion"
11682 .vindex "&$message_body_end$&"
11683 This variable contains the final portion of a message's
11684 body while it is being delivered. The format and maximum size are as for
11685 &$message_body$&.
11686
11687 .vitem &$message_body_size$&
11688 .cindex "body of message" "size"
11689 .cindex "message body" "size"
11690 .vindex "&$message_body_size$&"
11691 When a message is being delivered, this variable contains the size of the body
11692 in bytes. The count starts from the character after the blank line that
11693 separates the body from the header. Newlines are included in the count. See
11694 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11695
11696 .vitem &$message_exim_id$&
11697 .vindex "&$message_exim_id$&"
11698 When a message is being received or delivered, this variable contains the
11699 unique message id that is generated and used by Exim to identify the message.
11700 An id is not created for a message until after its header has been successfully
11701 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11702 line; it is the local id that Exim assigns to the message, for example:
11703 &`1BXTIK-0001yO-VA`&.
11704
11705 .vitem &$message_headers$&
11706 .vindex &$message_headers$&
11707 This variable contains a concatenation of all the header lines when a message
11708 is being processed, except for lines added by routers or transports. The header
11709 lines are separated by newline characters. Their contents are decoded in the
11710 same way as a header line that is inserted by &%bheader%&.
11711
11712 .vitem &$message_headers_raw$&
11713 .vindex &$message_headers_raw$&
11714 This variable is like &$message_headers$& except that no processing of the
11715 contents of header lines is done.
11716
11717 .vitem &$message_id$&
11718 This is an old name for &$message_exim_id$&. It is now deprecated.
11719
11720 .vitem &$message_linecount$&
11721 .vindex "&$message_linecount$&"
11722 This variable contains the total number of lines in the header and body of the
11723 message. Compare &$body_linecount$&, which is the count for the body only.
11724 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11725 number of lines received. Before delivery happens (that is, before filters,
11726 routers, and transports run) the count is increased to include the
11727 &'Received:'& header line that Exim standardly adds, and also any other header
11728 lines that are added by ACLs. The blank line that separates the message header
11729 from the body is not counted.
11730
11731 As with the special case of &$message_size$&, during the expansion of the
11732 appendfile transport's maildir_tag option in maildir format, the value of
11733 &$message_linecount$& is the precise size of the number of newlines in the
11734 file that has been written (minus one for the blank line between the
11735 header and the body).
11736
11737 Here is an example of the use of this variable in a DATA ACL:
11738 .code
11739 deny message   = Too many lines in message header
11740      condition = \
11741       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11742 .endd
11743 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11744 message has not yet been received.
11745
11746 .vitem &$message_size$&
11747 .cindex "size" "of message"
11748 .cindex "message" "size"
11749 .vindex "&$message_size$&"
11750 When a message is being processed, this variable contains its size in bytes. In
11751 most cases, the size includes those headers that were received with the
11752 message, but not those (such as &'Envelope-to:'&) that are added to individual
11753 deliveries as they are written. However, there is one special case: during the
11754 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11755 doing a delivery in maildir format, the value of &$message_size$& is the
11756 precise size of the file that has been written. See also
11757 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11758
11759 .cindex "RCPT" "value of &$message_size$&"
11760 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11761 contains the size supplied on the MAIL command, or -1 if no size was given. The
11762 value may not, of course, be truthful.
11763
11764 .vitem &$mime_$&&'xxx'&
11765 A number of variables whose names start with &$mime$& are
11766 available when Exim is compiled with the content-scanning extension. For
11767 details, see section &<<SECTscanmimepart>>&.
11768
11769 .vitem "&$n0$& &-- &$n9$&"
11770 These variables are counters that can be incremented by means
11771 of the &%add%& command in filter files.
11772
11773 .vitem &$original_domain$&
11774 .vindex "&$domain$&"
11775 .vindex "&$original_domain$&"
11776 When a top-level address is being processed for delivery, this contains the
11777 same value as &$domain$&. However, if a &"child"& address (for example,
11778 generated by an alias, forward, or filter file) is being processed, this
11779 variable contains the domain of the original address (lower cased). This
11780 differs from &$parent_domain$& only when there is more than one level of
11781 aliasing or forwarding. When more than one address is being delivered in a
11782 single transport run, &$original_domain$& is not set.
11783
11784 If a new address is created by means of a &%deliver%& command in a system
11785 filter, it is set up with an artificial &"parent"& address. This has the local
11786 part &'system-filter'& and the default qualify domain.
11787
11788 .vitem &$original_local_part$&
11789 .vindex "&$local_part$&"
11790 .vindex "&$original_local_part$&"
11791 When a top-level address is being processed for delivery, this contains the
11792 same value as &$local_part$&, unless a prefix or suffix was removed from the
11793 local part, because &$original_local_part$& always contains the full local
11794 part. When a &"child"& address (for example, generated by an alias, forward, or
11795 filter file) is being processed, this variable contains the full local part of
11796 the original address.
11797
11798 If the router that did the redirection processed the local part
11799 case-insensitively, the value in &$original_local_part$& is in lower case.
11800 This variable differs from &$parent_local_part$& only when there is more than
11801 one level of aliasing or forwarding. When more than one address is being
11802 delivered in a single transport run, &$original_local_part$& is not set.
11803
11804 If a new address is created by means of a &%deliver%& command in a system
11805 filter, it is set up with an artificial &"parent"& address. This has the local
11806 part &'system-filter'& and the default qualify domain.
11807
11808 .vitem &$originator_gid$&
11809 .cindex "gid (group id)" "of originating user"
11810 .cindex "sender" "gid"
11811 .vindex "&$caller_gid$&"
11812 .vindex "&$originator_gid$&"
11813 This variable contains the value of &$caller_gid$& that was set when the
11814 message was received. For messages received via the command line, this is the
11815 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11816 normally the gid of the Exim user.
11817
11818 .vitem &$originator_uid$&
11819 .cindex "uid (user id)" "of originating user"
11820 .cindex "sender" "uid"
11821 .vindex "&$caller_uid$&"
11822 .vindex "&$originaltor_uid$&"
11823 The value of &$caller_uid$& that was set when the message was received. For
11824 messages received via the command line, this is the uid of the sending user.
11825 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11826 user.
11827
11828 .vitem &$parent_domain$&
11829 .vindex "&$parent_domain$&"
11830 This variable is similar to &$original_domain$& (see
11831 above), except that it refers to the immediately preceding parent address.
11832
11833 .vitem &$parent_local_part$&
11834 .vindex "&$parent_local_part$&"
11835 This variable is similar to &$original_local_part$&
11836 (see above), except that it refers to the immediately preceding parent address.
11837
11838 .vitem &$pid$&
11839 .cindex "pid (process id)" "of current process"
11840 .vindex "&$pid$&"
11841 This variable contains the current process id.
11842
11843 .vitem &$pipe_addresses$&
11844 .cindex "filter" "transport filter"
11845 .cindex "transport" "filter"
11846 .vindex "&$pipe_addresses$&"
11847 This is not an expansion variable, but is mentioned here because the string
11848 &`$pipe_addresses`& is handled specially in the command specification for the
11849 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11850 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11851 It cannot be used in general expansion strings, and provokes an &"unknown
11852 variable"& error if encountered.
11853
11854 .vitem &$primary_hostname$&
11855 .vindex "&$primary_hostname$&"
11856 This variable contains the value set by &%primary_hostname%& in the
11857 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11858 a single-component name, Exim calls &[gethostbyname()]& (or
11859 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11860 qualified host name. See also &$smtp_active_hostname$&.
11861
11862
11863 .vitem &$prvscheck_address$&
11864 This variable is used in conjunction with the &%prvscheck%& expansion item,
11865 which is described in sections &<<SECTexpansionitems>>& and
11866 &<<SECTverifyPRVS>>&.
11867
11868 .vitem &$prvscheck_keynum$&
11869 This variable is used in conjunction with the &%prvscheck%& expansion item,
11870 which is described in sections &<<SECTexpansionitems>>& and
11871 &<<SECTverifyPRVS>>&.
11872
11873 .vitem &$prvscheck_result$&
11874 This variable is used in conjunction with the &%prvscheck%& expansion item,
11875 which is described in sections &<<SECTexpansionitems>>& and
11876 &<<SECTverifyPRVS>>&.
11877
11878 .vitem &$qualify_domain$&
11879 .vindex "&$qualify_domain$&"
11880 The value set for the &%qualify_domain%& option in the configuration file.
11881
11882 .vitem &$qualify_recipient$&
11883 .vindex "&$qualify_recipient$&"
11884 The value set for the &%qualify_recipient%& option in the configuration file,
11885 or if not set, the value of &$qualify_domain$&.
11886
11887 .vitem &$rcpt_count$&
11888 .vindex "&$rcpt_count$&"
11889 When a message is being received by SMTP, this variable contains the number of
11890 RCPT commands received for the current message. If this variable is used in a
11891 RCPT ACL, its value includes the current command.
11892
11893 .vitem &$rcpt_defer_count$&
11894 .vindex "&$rcpt_defer_count$&"
11895 .cindex "4&'xx'& responses" "count of"
11896 When a message is being received by SMTP, this variable contains the number of
11897 RCPT commands in the current message that have previously been rejected with a
11898 temporary (4&'xx'&) response.
11899
11900 .vitem &$rcpt_fail_count$&
11901 .vindex "&$rcpt_fail_count$&"
11902 When a message is being received by SMTP, this variable contains the number of
11903 RCPT commands in the current message that have previously been rejected with a
11904 permanent (5&'xx'&) response.
11905
11906 .vitem &$received_count$&
11907 .vindex "&$received_count$&"
11908 This variable contains the number of &'Received:'& header lines in the message,
11909 including the one added by Exim (so its value is always greater than zero). It
11910 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11911 delivering.
11912
11913 .vitem &$received_for$&
11914 .vindex "&$received_for$&"
11915 If there is only a single recipient address in an incoming message, this
11916 variable contains that address when the &'Received:'& header line is being
11917 built. The value is copied after recipient rewriting has happened, but before
11918 the &[local_scan()]& function is run.
11919
11920 .vitem &$received_ip_address$&
11921 .vindex "&$received_ip_address$&"
11922 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11923 variable is set to the address of the local IP interface, and &$received_port$&
11924 is set to the local port number. (The remote IP address and port are in
11925 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11926 the port value is -1 unless it has been set using the &%-oMi%& command line
11927 option.
11928
11929 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11930 could be used, for example, to make the file name for a TLS certificate depend
11931 on which interface and/or port is being used for the incoming connection. The
11932 values of &$received_ip_address$& and &$received_port$& are saved with any
11933 messages that are received, thus making these variables available at delivery
11934 time.
11935 For outbound connections see &$sending_ip_address$&.
11936
11937 .vitem &$received_port$&
11938 .vindex "&$received_port$&"
11939 See &$received_ip_address$&.
11940
11941 .vitem &$received_protocol$&
11942 .vindex "&$received_protocol$&"
11943 When a message is being processed, this variable contains the name of the
11944 protocol by which it was received. Most of the names used by Exim are defined
11945 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11946 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11947 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11948 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11949 connection and the client was successfully authenticated.
11950
11951 Exim uses the protocol name &"smtps"& for the case when encryption is
11952 automatically set up on connection without the use of STARTTLS (see
11953 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11954 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11955 where the client initially uses EHLO, sets up an encrypted connection using
11956 STARTTLS, and then uses HELO afterwards.
11957
11958 The &%-oMr%& option provides a way of specifying a custom protocol name for
11959 messages that are injected locally by trusted callers. This is commonly used to
11960 identify messages that are being re-injected after some kind of scanning.
11961
11962 .vitem &$received_time$&
11963 .vindex "&$received_time$&"
11964 This variable contains the date and time when the current message was received,
11965 as a number of seconds since the start of the Unix epoch.
11966
11967 .vitem &$recipient_data$&
11968 .vindex "&$recipient_data$&"
11969 This variable is set after an indexing lookup success in an ACL &%recipients%&
11970 condition. It contains the data from the lookup, and the value remains set
11971 until the next &%recipients%& test. Thus, you can do things like this:
11972 .display
11973 &`require recipients  = cdb*@;/some/file`&
11974 &`deny    `&&'some further test involving'& &`$recipient_data`&
11975 .endd
11976 &*Warning*&: This variable is set only when a lookup is used as an indexing
11977 method in the address list, using the semicolon syntax as in the example above.
11978 The variable is not set for a lookup that is used as part of the string
11979 expansion that all such lists undergo before being interpreted.
11980
11981 .vitem &$recipient_verify_failure$&
11982 .vindex "&$recipient_verify_failure$&"
11983 In an ACL, when a recipient verification fails, this variable contains
11984 information about the failure. It is set to one of the following words:
11985
11986 .ilist
11987 &"qualify"&: The address was unqualified (no domain), and the message
11988 was neither local nor came from an exempted host.
11989
11990 .next
11991 &"route"&: Routing failed.
11992
11993 .next
11994 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11995 or before the MAIL command (that is, on initial connection, HELO, or
11996 MAIL).
11997
11998 .next
11999 &"recipient"&: The RCPT command in a callout was rejected.
12000 .next
12001
12002 &"postmaster"&: The postmaster check in a callout was rejected.
12003 .endlist
12004
12005 The main use of this variable is expected to be to distinguish between
12006 rejections of MAIL and rejections of RCPT.
12007
12008 .vitem &$recipients$&
12009 .vindex "&$recipients$&"
12010 This variable contains a list of envelope recipients for a message. A comma and
12011 a space separate the addresses in the replacement text. However, the variable
12012 is not generally available, to prevent exposure of Bcc recipients in
12013 unprivileged users' filter files. You can use &$recipients$& only in these
12014 cases:
12015
12016 .olist
12017 In a system filter file.
12018 .next
12019 In the ACLs associated with the DATA command and with non-SMTP messages, that
12020 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12021 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12022 &%acl_not_smtp_mime%&.
12023 .next
12024 From within a &[local_scan()]& function.
12025 .endlist
12026
12027
12028 .vitem &$recipients_count$&
12029 .vindex "&$recipients_count$&"
12030 When a message is being processed, this variable contains the number of
12031 envelope recipients that came with the message. Duplicates are not excluded
12032 from the count. While a message is being received over SMTP, the number
12033 increases for each accepted recipient. It can be referenced in an ACL.
12034
12035
12036 .vitem &$regex_match_string$&
12037 .vindex "&$regex_match_string$&"
12038 This variable is set to contain the matching regular expression after a
12039 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12040
12041
12042 .vitem &$reply_address$&
12043 .vindex "&$reply_address$&"
12044 When a message is being processed, this variable contains the contents of the
12045 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12046 contents of the &'From:'& header line. Apart from the removal of leading
12047 white space, the value is not processed in any way. In particular, no RFC 2047
12048 decoding or character code translation takes place.
12049
12050 .vitem &$return_path$&
12051 .vindex "&$return_path$&"
12052 When a message is being delivered, this variable contains the return path &--
12053 the sender field that will be sent as part of the envelope. It is not enclosed
12054 in <> characters. At the start of routing an address, &$return_path$& has the
12055 same value as &$sender_address$&, but if, for example, an incoming message to a
12056 mailing list has been expanded by a router which specifies a different address
12057 for bounce messages, &$return_path$& subsequently contains the new bounce
12058 address, whereas &$sender_address$& always contains the original sender address
12059 that was received with the message. In other words, &$sender_address$& contains
12060 the incoming envelope sender, and &$return_path$& contains the outgoing
12061 envelope sender.
12062
12063 .vitem &$return_size_limit$&
12064 .vindex "&$return_size_limit$&"
12065 This is an obsolete name for &$bounce_return_size_limit$&.
12066
12067 .vitem &$router_name$&
12068 .cindex "router" "name"
12069 .cindex "name" "of router"
12070 .vindex "&$router_name$&"
12071 During the running of a router this variable contains its name.
12072
12073 .vitem &$runrc$&
12074 .cindex "return code" "from &%run%& expansion"
12075 .vindex "&$runrc$&"
12076 This variable contains the return code from a command that is run by the
12077 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12078 assume the order in which option values are expanded, except for those
12079 preconditions whose order of testing is documented. Therefore, you cannot
12080 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12081 another.
12082
12083 .vitem &$self_hostname$&
12084 .oindex "&%self%&" "value of host name"
12085 .vindex "&$self_hostname$&"
12086 When an address is routed to a supposedly remote host that turns out to be the
12087 local host, what happens is controlled by the &%self%& generic router option.
12088 One of its values causes the address to be passed to another router. When this
12089 happens, &$self_hostname$& is set to the name of the local host that the
12090 original router encountered. In other circumstances its contents are null.
12091
12092 .vitem &$sender_address$&
12093 .vindex "&$sender_address$&"
12094 When a message is being processed, this variable contains the sender's address
12095 that was received in the message's envelope. The case of letters in the address
12096 is retained, in both the local part and the domain. For bounce messages, the
12097 value of this variable is the empty string. See also &$return_path$&.
12098
12099 .vitem &$sender_address_data$&
12100 .vindex "&$address_data$&"
12101 .vindex "&$sender_address_data$&"
12102 If &$address_data$& is set when the routers are called from an ACL to verify a
12103 sender address, the final value is preserved in &$sender_address_data$&, to
12104 distinguish it from data from a recipient address. The value does not persist
12105 after the end of the current ACL statement. If you want to preserve it for
12106 longer, you can save it in an ACL variable.
12107
12108 .vitem &$sender_address_domain$&
12109 .vindex "&$sender_address_domain$&"
12110 The domain portion of &$sender_address$&.
12111
12112 .vitem &$sender_address_local_part$&
12113 .vindex "&$sender_address_local_part$&"
12114 The local part portion of &$sender_address$&.
12115
12116 .vitem &$sender_data$&
12117 .vindex "&$sender_data$&"
12118 This variable is set after a lookup success in an ACL &%senders%& condition or
12119 in a router &%senders%& option. It contains the data from the lookup, and the
12120 value remains set until the next &%senders%& test. Thus, you can do things like
12121 this:
12122 .display
12123 &`require senders      = cdb*@;/some/file`&
12124 &`deny    `&&'some further test involving'& &`$sender_data`&
12125 .endd
12126 &*Warning*&: This variable is set only when a lookup is used as an indexing
12127 method in the address list, using the semicolon syntax as in the example above.
12128 The variable is not set for a lookup that is used as part of the string
12129 expansion that all such lists undergo before being interpreted.
12130
12131 .vitem &$sender_fullhost$&
12132 .vindex "&$sender_fullhost$&"
12133 When a message is received from a remote host, this variable contains the host
12134 name and IP address in a single string. It ends with the IP address in square
12135 brackets, followed by a colon and a port number if the logging of ports is
12136 enabled. The format of the rest of the string depends on whether the host
12137 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12138 looking up its IP address. (Looking up the IP address can be forced by the
12139 &%host_lookup%& option, independent of verification.) A plain host name at the
12140 start of the string is a verified host name; if this is not present,
12141 verification either failed or was not requested. A host name in parentheses is
12142 the argument of a HELO or EHLO command. This is omitted if it is identical to
12143 the verified host name or to the host's IP address in square brackets.
12144
12145 .vitem &$sender_helo_name$&
12146 .vindex "&$sender_helo_name$&"
12147 When a message is received from a remote host that has issued a HELO or EHLO
12148 command, the argument of that command is placed in this variable. It is also
12149 set if HELO or EHLO is used when a message is received using SMTP locally via
12150 the &%-bs%& or &%-bS%& options.
12151
12152 .vitem &$sender_host_address$&
12153 .vindex "&$sender_host_address$&"
12154 When a message is received from a remote host using SMTP,
12155 this variable contains that
12156 host's IP address. For locally non-SMTP submitted messages, it is empty.
12157
12158 .vitem &$sender_host_authenticated$&
12159 .vindex "&$sender_host_authenticated$&"
12160 This variable contains the name (not the public name) of the authenticator
12161 driver that successfully authenticated the client from which the message was
12162 received. It is empty if there was no successful authentication. See also
12163 &$authenticated_id$&.
12164
12165 .vitem &$sender_host_dnssec$&
12166 .vindex "&$sender_host_dnssec$&"
12167 If an attempt to populate &$sender_host_name$& has been made
12168 (by reference, &%hosts_lookup%& or
12169 otherwise) then this boolean will have been set true if, and only if, the
12170 resolver library states that the reverse DNS was authenticated data.  At all
12171 other times, this variable is false.
12172
12173 It is likely that you will need to coerce DNSSEC support on in the resolver
12174 library, by setting:
12175 .code
12176 dns_dnssec_ok = 1
12177 .endd
12178
12179 Exim does not perform DNSSEC validation itself, instead leaving that to a
12180 validating resolver (eg, unbound, or bind with suitable configuration).
12181
12182 Exim does not (currently) check to see if the forward DNS was also secured
12183 with DNSSEC, only the reverse DNS.
12184
12185 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12186 mechanism in the list, then this variable will be false.
12187
12188
12189 .vitem &$sender_host_name$&
12190 .vindex "&$sender_host_name$&"
12191 When a message is received from a remote host, this variable contains the
12192 host's name as obtained by looking up its IP address. For messages received by
12193 other means, this variable is empty.
12194
12195 .vindex "&$host_lookup_failed$&"
12196 If the host name has not previously been looked up, a reference to
12197 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12198 A looked up name is accepted only if it leads back to the original IP address
12199 via a forward lookup. If either the reverse or the forward lookup fails to find
12200 any data, or if the forward lookup does not yield the original IP address,
12201 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12202
12203 .vindex "&$host_lookup_deferred$&"
12204 However, if either of the lookups cannot be completed (for example, there is a
12205 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12206 &$host_lookup_failed$& remains set to &"0"&.
12207
12208 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12209 host name again if there is a subsequent reference to &$sender_host_name$&
12210 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12211 is set to &"1"&.
12212
12213 Exim does not automatically look up every calling host's name. If you want
12214 maximum efficiency, you should arrange your configuration so that it avoids
12215 these lookups altogether. The lookup happens only if one or more of the
12216 following are true:
12217
12218 .ilist
12219 A string containing &$sender_host_name$& is expanded.
12220 .next
12221 The calling host matches the list in &%host_lookup%&. In the default
12222 configuration, this option is set to *, so it must be changed if lookups are
12223 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12224 .next
12225 Exim needs the host name in order to test an item in a host list. The items
12226 that require this are described in sections &<<SECThoslispatnam>>& and
12227 &<<SECThoslispatnamsk>>&.
12228 .next
12229 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12230 In this case, the host name is required to compare with the name quoted in any
12231 EHLO or HELO commands that the client issues.
12232 .next
12233 The remote host issues a EHLO or HELO command that quotes one of the
12234 domains in &%helo_lookup_domains%&. The default value of this option is
12235 . ==== As this is a nested list, any displays it contains must be indented
12236 . ==== as otherwise they are too far to the left.
12237 .code
12238   helo_lookup_domains = @ : @[]
12239 .endd
12240 which causes a lookup if a remote host (incorrectly) gives the server's name or
12241 IP address in an EHLO or HELO command.
12242 .endlist
12243
12244
12245 .vitem &$sender_host_port$&
12246 .vindex "&$sender_host_port$&"
12247 When a message is received from a remote host, this variable contains the port
12248 number that was used on the remote host.
12249
12250 .vitem &$sender_ident$&
12251 .vindex "&$sender_ident$&"
12252 When a message is received from a remote host, this variable contains the
12253 identification received in response to an RFC 1413 request. When a message has
12254 been received locally, this variable contains the login name of the user that
12255 called Exim.
12256
12257 .vitem &$sender_rate_$&&'xxx'&
12258 A number of variables whose names begin &$sender_rate_$& are set as part of the
12259 &%ratelimit%& ACL condition. Details are given in section
12260 &<<SECTratelimiting>>&.
12261
12262 .vitem &$sender_rcvhost$&
12263 .cindex "DNS" "reverse lookup"
12264 .cindex "reverse DNS lookup"
12265 .vindex "&$sender_rcvhost$&"
12266 This is provided specifically for use in &'Received:'& headers. It starts with
12267 either the verified host name (as obtained from a reverse DNS lookup) or, if
12268 there is no verified host name, the IP address in square brackets. After that
12269 there may be text in parentheses. When the first item is a verified host name,
12270 the first thing in the parentheses is the IP address in square brackets,
12271 followed by a colon and a port number if port logging is enabled. When the
12272 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12273 the parentheses.
12274
12275 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12276 was used and its argument was not identical to the real host name or IP
12277 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12278 all three items are present in the parentheses, a newline and tab are inserted
12279 into the string, to improve the formatting of the &'Received:'& header.
12280
12281 .vitem &$sender_verify_failure$&
12282 .vindex "&$sender_verify_failure$&"
12283 In an ACL, when a sender verification fails, this variable contains information
12284 about the failure. The details are the same as for
12285 &$recipient_verify_failure$&.
12286
12287 .vitem &$sending_ip_address$&
12288 .vindex "&$sending_ip_address$&"
12289 This variable is set whenever an outgoing SMTP connection to another host has
12290 been set up. It contains the IP address of the local interface that is being
12291 used. This is useful if a host that has more than one IP address wants to take
12292 on different personalities depending on which one is being used. For incoming
12293 connections, see &$received_ip_address$&.
12294
12295 .vitem &$sending_port$&
12296 .vindex "&$sending_port$&"
12297 This variable is set whenever an outgoing SMTP connection to another host has
12298 been set up. It contains the local port that is being used. For incoming
12299 connections, see &$received_port$&.
12300
12301 .vitem &$smtp_active_hostname$&
12302 .vindex "&$smtp_active_hostname$&"
12303 During an incoming SMTP session, this variable contains the value of the active
12304 host name, as specified by the &%smtp_active_hostname%& option. The value of
12305 &$smtp_active_hostname$& is saved with any message that is received, so its
12306 value can be consulted during routing and delivery.
12307
12308 .vitem &$smtp_command$&
12309 .vindex "&$smtp_command$&"
12310 During the processing of an incoming SMTP command, this variable contains the
12311 entire command. This makes it possible to distinguish between HELO and EHLO in
12312 the HELO ACL, and also to distinguish between commands such as these:
12313 .code
12314 MAIL FROM:<>
12315 MAIL FROM: <>
12316 .endd
12317 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12318 command, the address in &$smtp_command$& is the original address before any
12319 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12320 the address after SMTP-time rewriting.
12321
12322 .vitem &$smtp_command_argument$&
12323 .cindex "SMTP" "command, argument for"
12324 .vindex "&$smtp_command_argument$&"
12325 While an ACL is running to check an SMTP command, this variable contains the
12326 argument, that is, the text that follows the command name, with leading white
12327 space removed. Following the introduction of &$smtp_command$&, this variable is
12328 somewhat redundant, but is retained for backwards compatibility.
12329
12330 .vitem &$smtp_count_at_connection_start$&
12331 .vindex "&$smtp_count_at_connection_start$&"
12332 This variable is set greater than zero only in processes spawned by the Exim
12333 daemon for handling incoming SMTP connections. The name is deliberately long,
12334 in order to emphasize what the contents are. When the daemon accepts a new
12335 connection, it increments this variable. A copy of the variable is passed to
12336 the child process that handles the connection, but its value is fixed, and
12337 never changes. It is only an approximation of how many incoming connections
12338 there actually are, because many other connections may come and go while a
12339 single connection is being processed. When a child process terminates, the
12340 daemon decrements its copy of the variable.
12341
12342 .vitem "&$sn0$& &-- &$sn9$&"
12343 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12344 that were current at the end of the system filter file. This allows a system
12345 filter file to set values that can be tested in users' filter files. For
12346 example, a system filter could set a value indicating how likely it is that a
12347 message is junk mail.
12348
12349 .vitem &$spam_$&&'xxx'&
12350 A number of variables whose names start with &$spam$& are available when Exim
12351 is compiled with the content-scanning extension. For details, see section
12352 &<<SECTscanspamass>>&.
12353
12354
12355 .vitem &$spool_directory$&
12356 .vindex "&$spool_directory$&"
12357 The name of Exim's spool directory.
12358
12359 .vitem &$spool_inodes$&
12360 .vindex "&$spool_inodes$&"
12361 The number of free inodes in the disk partition where Exim's spool files are
12362 being written. The value is recalculated whenever the variable is referenced.
12363 If the relevant file system does not have the concept of inodes, the value of
12364 is -1. See also the &%check_spool_inodes%& option.
12365
12366 .vitem &$spool_space$&
12367 .vindex "&$spool_space$&"
12368 The amount of free space (as a number of kilobytes) in the disk partition where
12369 Exim's spool files are being written. The value is recalculated whenever the
12370 variable is referenced. If the operating system does not have the ability to
12371 find the amount of free space (only true for experimental systems), the space
12372 value is -1. For example, to check in an ACL that there is at least 50
12373 megabytes free on the spool, you could write:
12374 .code
12375 condition = ${if > {$spool_space}{50000}}
12376 .endd
12377 See also the &%check_spool_space%& option.
12378
12379
12380 .vitem &$thisaddress$&
12381 .vindex "&$thisaddress$&"
12382 This variable is set only during the processing of the &%foranyaddress%&
12383 command in a filter file. Its use is explained in the description of that
12384 command, which can be found in the separate document entitled &'Exim's
12385 interfaces to mail filtering'&.
12386
12387 .vitem &$tls_in_bits$&
12388 .vindex "&$tls_in_bits$&"
12389 Contains an approximation of the TLS cipher's bit-strength
12390 on the inbound connection; the meaning of
12391 this depends upon the TLS implementation used.
12392 If TLS has not been negotiated, the value will be 0.
12393 The value of this is automatically fed into the Cyrus SASL authenticator
12394 when acting as a server, to specify the "external SSF" (a SASL term).
12395
12396 The deprecated &$tls_bits$& variable refers to the inbound side
12397 except when used in the context of an outbound SMTP delivery, when it refers to
12398 the outbound.
12399
12400 .vitem &$tls_out_bits$&
12401 .vindex "&$tls_out_bits$&"
12402 Contains an approximation of the TLS cipher's bit-strength
12403 on an outbound SMTP connection; the meaning of
12404 this depends upon the TLS implementation used.
12405 If TLS has not been negotiated, the value will be 0.
12406
12407 .vitem &$tls_in_ourcert$&
12408 .vindex "&$tls_in_ourcert$&"
12409 This variable refers to the certificate presented to the peer of an
12410 inbound connection when the message was received.
12411 It is only useful as the argument of a
12412 .new
12413 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12414 .wen
12415 or a &%def%& condition.
12416
12417 .vitem &$tls_in_peercert$&
12418 .vindex "&$tls_in_peercert$&"
12419 This variable refers to the certificate presented by the peer of an
12420 inbound connection when the message was received.
12421 It is only useful as the argument of a
12422 .new
12423 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12424 .wen
12425 or a &%def%& condition.
12426
12427 .vitem &$tls_out_ourcert$&
12428 .vindex "&$tls_out_ourcert$&"
12429 This variable refers to the certificate presented to the peer of an
12430 outbound connection.  It is only useful as the argument of a
12431 .new
12432 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12433 .wen
12434 or a &%def%& condition.
12435
12436 .vitem &$tls_out_peercert$&
12437 .vindex "&$tls_out_peercert$&"
12438 This variable refers to the certificate presented by the peer of an
12439 outbound connection.  It is only useful as the argument of a
12440 .new
12441 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12442 .wen
12443 or a &%def%& condition.
12444
12445 .vitem &$tls_in_certificate_verified$&
12446 .vindex "&$tls_in_certificate_verified$&"
12447 This variable is set to &"1"& if a TLS certificate was verified when the
12448 message was received, and &"0"& otherwise.
12449
12450 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12451 except when used in the context of an outbound SMTP delivery, when it refers to
12452 the outbound.
12453
12454 .vitem &$tls_out_certificate_verified$&
12455 .vindex "&$tls_out_certificate_verified$&"
12456 This variable is set to &"1"& if a TLS certificate was verified when an
12457 outbound SMTP connection was made,
12458 and &"0"& otherwise.
12459
12460 .vitem &$tls_in_cipher$&
12461 .vindex "&$tls_in_cipher$&"
12462 .vindex "&$tls_cipher$&"
12463 When a message is received from a remote host over an encrypted SMTP
12464 connection, this variable is set to the cipher suite that was negotiated, for
12465 example DES-CBC3-SHA. In other circumstances, in particular, for message
12466 received over unencrypted connections, the variable is empty. Testing
12467 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12468 non-encrypted connections during ACL processing.
12469
12470 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12471 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12472 becomes the same as &$tls_out_cipher$&.
12473
12474 .vitem &$tls_out_cipher$&
12475 .vindex "&$tls_out_cipher$&"
12476 This variable is
12477 cleared before any outgoing SMTP connection is made,
12478 and then set to the outgoing cipher suite if one is negotiated. See chapter
12479 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12480 details of the &(smtp)& transport.
12481
12482 .vitem &$tls_in_ocsp$&
12483 .vindex "&$tls_in_ocsp$&"
12484 When a message is received from a remote client connection
12485 the result of any OCSP request from the client is encoded in this variable:
12486 .code
12487 0 OCSP proof was not requested (default value)
12488 1 No response to request
12489 2 Response not verified
12490 3 Verification failed
12491 4 Verification succeeded
12492 .endd
12493
12494 .vitem &$tls_out_ocsp$&
12495 .vindex "&$tls_out_ocsp$&"
12496 When a message is sent to a remote host connection
12497 the result of any OCSP request made is encoded in this variable.
12498 See &$tls_in_ocsp$& for values.
12499
12500 .vitem &$tls_in_peerdn$&
12501 .vindex "&$tls_in_peerdn$&"
12502 .vindex "&$tls_peerdn$&"
12503 When a message is received from a remote host over an encrypted SMTP
12504 connection, and Exim is configured to request a certificate from the client,
12505 the value of the Distinguished Name of the certificate is made available in the
12506 &$tls_in_peerdn$& during subsequent processing.
12507
12508 The deprecated &$tls_peerdn$& variable refers to the inbound side
12509 except when used in the context of an outbound SMTP delivery, when it refers to
12510 the outbound.
12511
12512 .vitem &$tls_out_peerdn$&
12513 .vindex "&$tls_out_peerdn$&"
12514 When a message is being delivered to a remote host over an encrypted SMTP
12515 connection, and Exim is configured to request a certificate from the server,
12516 the value of the Distinguished Name of the certificate is made available in the
12517 &$tls_out_peerdn$& during subsequent processing.
12518
12519 .vitem &$tls_in_sni$&
12520 .vindex "&$tls_in_sni$&"
12521 .vindex "&$tls_sni$&"
12522 .cindex "TLS" "Server Name Indication"
12523 When a TLS session is being established, if the client sends the Server
12524 Name Indication extension, the value will be placed in this variable.
12525 If the variable appears in &%tls_certificate%& then this option and
12526 some others, described in &<<SECTtlssni>>&,
12527 will be re-expanded early in the TLS session, to permit
12528 a different certificate to be presented (and optionally a different key to be
12529 used) to the client, based upon the value of the SNI extension.
12530
12531 The deprecated &$tls_sni$& variable refers to the inbound side
12532 except when used in the context of an outbound SMTP delivery, when it refers to
12533 the outbound.
12534
12535 .vitem &$tls_out_sni$&
12536 .vindex "&$tls_out_sni$&"
12537 .cindex "TLS" "Server Name Indication"
12538 During outbound
12539 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12540 the transport.
12541
12542 .vitem &$tod_bsdinbox$&
12543 .vindex "&$tod_bsdinbox$&"
12544 The time of day and the date, in the format required for BSD-style mailbox
12545 files, for example: Thu Oct 17 17:14:09 1995.
12546
12547 .vitem &$tod_epoch$&
12548 .vindex "&$tod_epoch$&"
12549 The time and date as a number of seconds since the start of the Unix epoch.
12550
12551 .vitem &$tod_epoch_l$&
12552 .vindex "&$tod_epoch_l$&"
12553 The time and date as a number of microseconds since the start of the Unix epoch.
12554
12555 .vitem &$tod_full$&
12556 .vindex "&$tod_full$&"
12557 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12558 +0100. The timezone is always given as a numerical offset from UTC, with
12559 positive values used for timezones that are ahead (east) of UTC, and negative
12560 values for those that are behind (west).
12561
12562 .vitem &$tod_log$&
12563 .vindex "&$tod_log$&"
12564 The time and date in the format used for writing Exim's log files, for example:
12565 1995-10-12 15:32:29, but without a timezone.
12566
12567 .vitem &$tod_logfile$&
12568 .vindex "&$tod_logfile$&"
12569 This variable contains the date in the format yyyymmdd. This is the format that
12570 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12571 flag.
12572
12573 .vitem &$tod_zone$&
12574 .vindex "&$tod_zone$&"
12575 This variable contains the numerical value of the local timezone, for example:
12576 -0500.
12577
12578 .vitem &$tod_zulu$&
12579 .vindex "&$tod_zulu$&"
12580 This variable contains the UTC date and time in &"Zulu"& format, as specified
12581 by ISO 8601, for example: 20030221154023Z.
12582
12583 .vitem &$transport_name$&
12584 .cindex "transport" "name"
12585 .cindex "name" "of transport"
12586 .vindex "&$transport_name$&"
12587 During the running of a transport, this variable contains its name.
12588
12589 .vitem &$value$&
12590 .vindex "&$value$&"
12591 This variable contains the result of an expansion lookup, extraction operation,
12592 or external command, as described above. It is also used during a
12593 &*reduce*& expansion.
12594
12595 .vitem &$verify_mode$&
12596 .vindex "&$verify_mode$&"
12597 While a router or transport is being run in verify mode
12598 or for cutthrough delivery,
12599 contains "S" for sender-verification or "R" for recipient-verification.
12600 Otherwise, empty.
12601
12602 .vitem &$version_number$&
12603 .vindex "&$version_number$&"
12604 The version number of Exim.
12605
12606 .vitem &$warn_message_delay$&
12607 .vindex "&$warn_message_delay$&"
12608 This variable is set only during the creation of a message warning about a
12609 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12610
12611 .vitem &$warn_message_recipients$&
12612 .vindex "&$warn_message_recipients$&"
12613 This variable is set only during the creation of a message warning about a
12614 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12615 .endlist
12616 .ecindex IIDstrexp
12617
12618
12619
12620 . ////////////////////////////////////////////////////////////////////////////
12621 . ////////////////////////////////////////////////////////////////////////////
12622
12623 .chapter "Embedded Perl" "CHAPperl"
12624 .scindex IIDperl "Perl" "calling from Exim"
12625 Exim can be built to include an embedded Perl interpreter. When this is done,
12626 Perl subroutines can be called as part of the string expansion process. To make
12627 use of the Perl support, you need version 5.004 or later of Perl installed on
12628 your system. To include the embedded interpreter in the Exim binary, include
12629 the line
12630 .code
12631 EXIM_PERL = perl.o
12632 .endd
12633 in your &_Local/Makefile_& and then build Exim in the normal way.
12634
12635
12636 .section "Setting up so Perl can be used" "SECID85"
12637 .oindex "&%perl_startup%&"
12638 Access to Perl subroutines is via a global configuration option called
12639 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12640 no &%perl_startup%& option in the Exim configuration file then no Perl
12641 interpreter is started and there is almost no overhead for Exim (since none of
12642 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12643 option then the associated value is taken to be Perl code which is executed in
12644 a newly created Perl interpreter.
12645
12646 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12647 need backslashes before any characters to escape special meanings. The option
12648 should usually be something like
12649 .code
12650 perl_startup = do '/etc/exim.pl'
12651 .endd
12652 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12653 use from Exim. Exim can be configured either to start up a Perl interpreter as
12654 soon as it is entered, or to wait until the first time it is needed. Starting
12655 the interpreter at the beginning ensures that it is done while Exim still has
12656 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12657 fact used in a particular run. Also, note that this does not mean that Exim is
12658 necessarily running as root when Perl is called at a later time. By default,
12659 the interpreter is started only when it is needed, but this can be changed in
12660 two ways:
12661
12662 .ilist
12663 .oindex "&%perl_at_start%&"
12664 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12665 a startup when Exim is entered.
12666 .next
12667 The command line option &%-ps%& also requests a startup when Exim is entered,
12668 overriding the setting of &%perl_at_start%&.
12669 .endlist
12670
12671 There is also a command line option &%-pd%& (for delay) which suppresses the
12672 initial startup, even if &%perl_at_start%& is set.
12673
12674
12675 .section "Calling Perl subroutines" "SECID86"
12676 When the configuration file includes a &%perl_startup%& option you can make use
12677 of the string expansion item to call the Perl subroutines that are defined
12678 by the &%perl_startup%& code. The operator is used in any of the following
12679 forms:
12680 .code
12681 ${perl{foo}}
12682 ${perl{foo}{argument}}
12683 ${perl{foo}{argument1}{argument2} ... }
12684 .endd
12685 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12686 arguments may be passed. Passing more than this results in an expansion failure
12687 with an error message of the form
12688 .code
12689 Too many arguments passed to Perl subroutine "foo" (max is 8)
12690 .endd
12691 The return value of the Perl subroutine is evaluated in a scalar context before
12692 it is passed back to Exim to be inserted into the expanded string. If the
12693 return value is &'undef'&, the expansion is forced to fail in the same way as
12694 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12695 by obeying Perl's &%die%& function, the expansion fails with the error message
12696 that was passed to &%die%&.
12697
12698
12699 .section "Calling Exim functions from Perl" "SECID87"
12700 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12701 is available to call back into Exim's string expansion function. For example,
12702 the Perl code
12703 .code
12704 my $lp = Exim::expand_string('$local_part');
12705 .endd
12706 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12707 Note those are single quotes and not double quotes to protect against
12708 &$local_part$& being interpolated as a Perl variable.
12709
12710 If the string expansion is forced to fail by a &"fail"& item, the result of
12711 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12712 expansion string, the Perl call from the original expansion string fails with
12713 an appropriate error message, in the same way as if &%die%& were used.
12714
12715 .cindex "debugging" "from embedded Perl"
12716 .cindex "log" "writing from embedded Perl"
12717 Two other Exim functions are available for use from within Perl code.
12718 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12719 debugging is enabled. If you want a newline at the end, you must supply it.
12720 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12721 timestamp. In this case, you should not supply a terminating newline.
12722
12723
12724 .section "Use of standard output and error by Perl" "SECID88"
12725 .cindex "Perl" "standard output and error"
12726 You should not write to the standard error or output streams from within your
12727 Perl code, as it is not defined how these are set up. In versions of Exim
12728 before 4.50, it is possible for the standard output or error to refer to the
12729 SMTP connection during message reception via the daemon. Writing to this stream
12730 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12731 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12732 avoided, but the output is lost.
12733
12734 .cindex "Perl" "use of &%warn%&"
12735 The Perl &%warn%& statement writes to the standard error stream by default.
12736 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12737 you have no control. When Exim starts up the Perl interpreter, it arranges for
12738 output from the &%warn%& statement to be written to the Exim main log. You can
12739 change this by including appropriate Perl magic somewhere in your Perl code.
12740 For example, to discard &%warn%& output completely, you need this:
12741 .code
12742 $SIG{__WARN__} = sub { };
12743 .endd
12744 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12745 example, the code for the subroutine is empty, so it does nothing, but you can
12746 include any Perl code that you like. The text of the &%warn%& message is passed
12747 as the first subroutine argument.
12748 .ecindex IIDperl
12749
12750
12751 . ////////////////////////////////////////////////////////////////////////////
12752 . ////////////////////////////////////////////////////////////////////////////
12753
12754 .chapter "Starting the daemon and the use of network interfaces" &&&
12755          "CHAPinterfaces" &&&
12756          "Starting the daemon"
12757 .cindex "daemon" "starting"
12758 .cindex "interface" "listening"
12759 .cindex "network interface"
12760 .cindex "interface" "network"
12761 .cindex "IP address" "for listening"
12762 .cindex "daemon" "listening IP addresses"
12763 .cindex "TCP/IP" "setting listening interfaces"
12764 .cindex "TCP/IP" "setting listening ports"
12765 A host that is connected to a TCP/IP network may have one or more physical
12766 hardware network interfaces. Each of these interfaces may be configured as one
12767 or more &"logical"& interfaces, which are the entities that a program actually
12768 works with. Each of these logical interfaces is associated with an IP address.
12769 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12770 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12771 knowledge about the host's interfaces for use in three different circumstances:
12772
12773 .olist
12774 When a listening daemon is started, Exim needs to know which interfaces
12775 and ports to listen on.
12776 .next
12777 When Exim is routing an address, it needs to know which IP addresses
12778 are associated with local interfaces. This is required for the correct
12779 processing of MX lists by removing the local host and others with the
12780 same or higher priority values. Also, Exim needs to detect cases
12781 when an address is routed to an IP address that in fact belongs to the
12782 local host. Unless the &%self%& router option or the &%allow_localhost%&
12783 option of the smtp transport is set (as appropriate), this is treated
12784 as an error situation.
12785 .next
12786 When Exim connects to a remote host, it may need to know which interface to use
12787 for the outgoing connection.
12788 .endlist
12789
12790
12791 Exim's default behaviour is likely to be appropriate in the vast majority
12792 of cases. If your host has only one interface, and you want all its IP
12793 addresses to be treated in the same way, and you are using only the
12794 standard SMTP port, you should not need to take any special action. The
12795 rest of this chapter does not apply to you.
12796
12797 In a more complicated situation you may want to listen only on certain
12798 interfaces, or on different ports, and for this reason there are a number of
12799 options that can be used to influence Exim's behaviour. The rest of this
12800 chapter describes how they operate.
12801
12802 When a message is received over TCP/IP, the interface and port that were
12803 actually used are set in &$received_ip_address$& and &$received_port$&.
12804
12805
12806
12807 .section "Starting a listening daemon" "SECID89"
12808 When a listening daemon is started (by means of the &%-bd%& command line
12809 option), the interfaces and ports on which it listens are controlled by the
12810 following options:
12811
12812 .ilist
12813 &%daemon_smtp_ports%& contains a list of default ports
12814 or service names.
12815 (For backward compatibility, this option can also be specified in the singular.)
12816 .next
12817 &%local_interfaces%& contains list of interface IP addresses on which to
12818 listen. Each item may optionally also specify a port.
12819 .endlist
12820
12821 The default list separator in both cases is a colon, but this can be changed as
12822 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12823 it is usually best to change the separator to avoid having to double all the
12824 colons. For example:
12825 .code
12826 local_interfaces = <; 127.0.0.1 ; \
12827                       192.168.23.65 ; \
12828                       ::1 ; \
12829                       3ffe:ffff:836f::fe86:a061
12830 .endd
12831 There are two different formats for specifying a port along with an IP address
12832 in &%local_interfaces%&:
12833
12834 .olist
12835 The port is added onto the address with a dot separator. For example, to listen
12836 on port 1234 on two different IP addresses:
12837 .code
12838 local_interfaces = <; 192.168.23.65.1234 ; \
12839                       3ffe:ffff:836f::fe86:a061.1234
12840 .endd
12841 .next
12842 The IP address is enclosed in square brackets, and the port is added
12843 with a colon separator, for example:
12844 .code
12845 local_interfaces = <; [192.168.23.65]:1234 ; \
12846                       [3ffe:ffff:836f::fe86:a061]:1234
12847 .endd
12848 .endlist
12849
12850 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12851 default setting contains just one port:
12852 .code
12853 daemon_smtp_ports = smtp
12854 .endd
12855 If more than one port is listed, each interface that does not have its own port
12856 specified listens on all of them. Ports that are listed in
12857 &%daemon_smtp_ports%& can be identified either by name (defined in
12858 &_/etc/services_&) or by number. However, when ports are given with individual
12859 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12860
12861
12862
12863 .section "Special IP listening addresses" "SECID90"
12864 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12865 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12866 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12867 instead of setting up separate listening sockets for each interface. The
12868 default value of &%local_interfaces%& is
12869 .code
12870 local_interfaces = 0.0.0.0
12871 .endd
12872 when Exim is built without IPv6 support; otherwise it is:
12873 .code
12874 local_interfaces = <; ::0 ; 0.0.0.0
12875 .endd
12876 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12877
12878
12879
12880 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12881 The &%-oX%& command line option can be used to override the values of
12882 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12883 instance. Another way of doing this would be to use macros and the &%-D%&
12884 option. However, &%-oX%& can be used by any admin user, whereas modification of
12885 the runtime configuration by &%-D%& is allowed only when the caller is root or
12886 exim.
12887
12888 The value of &%-oX%& is a list of items. The default colon separator can be
12889 changed in the usual way if required. If there are any items that do not
12890 contain dots or colons (that is, are not IP addresses), the value of
12891 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12892 items that do contain dots or colons, the value of &%local_interfaces%& is
12893 replaced by those items. Thus, for example,
12894 .code
12895 -oX 1225
12896 .endd
12897 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12898 whereas
12899 .code
12900 -oX 192.168.34.5.1125
12901 .endd
12902 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12903 (However, since &%local_interfaces%& now contains no items without ports, the
12904 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12905
12906
12907
12908 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12909 .cindex "ssmtp protocol"
12910 .cindex "smtps protocol"
12911 .cindex "SMTP" "ssmtp protocol"
12912 .cindex "SMTP" "smtps protocol"
12913 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12914 before the STARTTLS command was standardized for SMTP. Some legacy clients
12915 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12916 list of port numbers or service names,
12917 connections to those ports must use SSMTP. The most
12918 common use of this option is expected to be
12919 .code
12920 tls_on_connect_ports = 465
12921 .endd
12922 because 465 is the usual port number used by the legacy clients. There is also
12923 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12924 this way when a daemon is started.
12925
12926 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12927 daemon to listen on those ports. You must still specify them in
12928 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12929 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12930 connections via the daemon.)
12931
12932
12933
12934
12935 .section "IPv6 address scopes" "SECID92"
12936 .cindex "IPv6" "address scopes"
12937 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12938 can, in principle, have the same link-local IPv6 address on different
12939 interfaces. Thus, additional information is needed, over and above the IP
12940 address, to distinguish individual interfaces. A convention of using a
12941 percent sign followed by something (often the interface name) has been
12942 adopted in some cases, leading to addresses like this:
12943 .code
12944 fe80::202:b3ff:fe03:45c1%eth0
12945 .endd
12946 To accommodate this usage, a percent sign followed by an arbitrary string is
12947 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12948 to convert a textual IPv6 address for actual use. This function recognizes the
12949 percent convention in operating systems that support it, and it processes the
12950 address appropriately. Unfortunately, some older libraries have problems with
12951 &[getaddrinfo()]&. If
12952 .code
12953 IPV6_USE_INET_PTON=yes
12954 .endd
12955 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12956 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12957 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12958 function.) Of course, this means that the additional functionality of
12959 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12960
12961 .section "Disabling IPv6" "SECID93"
12962 .cindex "IPv6" "disabling"
12963 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12964 run on a host whose kernel does not support IPv6. The binary will fall back to
12965 using IPv4, but it may waste resources looking up AAAA records, and trying to
12966 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12967 .oindex "&%disable_ipv6%&"
12968 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12969 activities take place. AAAA records are never looked up, and any IPv6 addresses
12970 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12971 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12972 to handle IPv6 literal addresses.
12973
12974 On the other hand, when IPv6 is in use, there may be times when you want to
12975 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12976 option to globally suppress the lookup of AAAA records for specified domains,
12977 and you can use the &%ignore_target_hosts%& generic router option to ignore
12978 IPv6 addresses in an individual router.
12979
12980
12981
12982 .section "Examples of starting a listening daemon" "SECID94"
12983 The default case in an IPv6 environment is
12984 .code
12985 daemon_smtp_ports = smtp
12986 local_interfaces = <; ::0 ; 0.0.0.0
12987 .endd
12988 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12989 Either one or two sockets may be used, depending on the characteristics of
12990 the TCP/IP stack. (This is complicated and messy; for more information,
12991 read the comments in the &_daemon.c_& source file.)
12992
12993 To specify listening on ports 25 and 26 on all interfaces:
12994 .code
12995 daemon_smtp_ports = 25 : 26
12996 .endd
12997 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12998 .code
12999 local_interfaces = <; ::0.25     ; ::0.26 \
13000                       0.0.0.0.25 ; 0.0.0.0.26
13001 .endd
13002 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13003 IPv4 loopback address only:
13004 .code
13005 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13006 .endd
13007 To specify listening on the default port on specific interfaces only:
13008 .code
13009 local_interfaces = 10.0.0.67 : 192.168.34.67
13010 .endd
13011 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13012
13013
13014
13015 .section "Recognizing the local host" "SECTreclocipadd"
13016 The &%local_interfaces%& option is also used when Exim needs to determine
13017 whether or not an IP address refers to the local host. That is, the IP
13018 addresses of all the interfaces on which a daemon is listening are always
13019 treated as local.
13020
13021 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13022 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13023 available interfaces from the operating system, and extracts the relevant
13024 (that is, IPv4 or IPv6) addresses to use for checking.
13025
13026 Some systems set up large numbers of virtual interfaces in order to provide
13027 many virtual web servers. In this situation, you may want to listen for
13028 email on only a few of the available interfaces, but nevertheless treat all
13029 interfaces as local when routing. You can do this by setting
13030 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13031 &"all"& wildcard values. These addresses are recognized as local, but are not
13032 used for listening. Consider this example:
13033 .code
13034 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13035                       192.168.53.235 ; \
13036                       3ffe:2101:12:1:a00:20ff:fe86:a061
13037
13038 extra_local_interfaces = <; ::0 ; 0.0.0.0
13039 .endd
13040 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13041 address, but all available interface addresses are treated as local when
13042 Exim is routing.
13043
13044 In some environments the local host name may be in an MX list, but with an IP
13045 address that is not assigned to any local interface. In other cases it may be
13046 desirable to treat other host names as if they referred to the local host. Both
13047 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13048 This contains host names rather than IP addresses. When a host is referenced
13049 during routing, either via an MX record or directly, it is treated as the local
13050 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13051 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13052
13053
13054
13055 .section "Delivering to a remote host" "SECID95"
13056 Delivery to a remote host is handled by the smtp transport. By default, it
13057 allows the system's TCP/IP functions to choose which interface to use (if
13058 there is more than one) when connecting to a remote host. However, the
13059 &%interface%& option can be set to specify which interface is used. See the
13060 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13061 details.
13062
13063
13064
13065
13066 . ////////////////////////////////////////////////////////////////////////////
13067 . ////////////////////////////////////////////////////////////////////////////
13068
13069 .chapter "Main configuration" "CHAPmainconfig"
13070 .scindex IIDconfima "configuration file" "main section"
13071 .scindex IIDmaiconf "main configuration"
13072 The first part of the run time configuration file contains three types of item:
13073
13074 .ilist
13075 Macro definitions: These lines start with an upper case letter. See section
13076 &<<SECTmacrodefs>>& for details of macro processing.
13077 .next
13078 Named list definitions: These lines start with one of the words &"domainlist"&,
13079 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13080 section &<<SECTnamedlists>>&.
13081 .next
13082 Main configuration settings: Each setting occupies one line of the file
13083 (with possible continuations). If any setting is preceded by the word
13084 &"hide"&, the &%-bP%& command line option displays its value to admin users
13085 only. See section &<<SECTcos>>& for a description of the syntax of these option
13086 settings.
13087 .endlist
13088
13089 This chapter specifies all the main configuration options, along with their
13090 types and default values. For ease of finding a particular option, they appear
13091 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13092 are now so many options, they are first listed briefly in functional groups, as
13093 an aid to finding the name of the option you are looking for. Some options are
13094 listed in more than one group.
13095
13096 .section "Miscellaneous" "SECID96"
13097 .table2
13098 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13099 .row &%disable_ipv6%&                "do no IPv6 processing"
13100 .row &%keep_malformed%&              "for broken files &-- should not happen"
13101 .row &%localhost_number%&            "for unique message ids in clusters"
13102 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13103 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13104 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13105 .row &%print_topbitchars%&           "top-bit characters are printing"
13106 .row &%timezone%&                    "force time zone"
13107 .endtable
13108
13109
13110 .section "Exim parameters" "SECID97"
13111 .table2
13112 .row &%exim_group%&                  "override compiled-in value"
13113 .row &%exim_path%&                   "override compiled-in value"
13114 .row &%exim_user%&                   "override compiled-in value"
13115 .row &%primary_hostname%&            "default from &[uname()]&"
13116 .row &%split_spool_directory%&       "use multiple directories"
13117 .row &%spool_directory%&             "override compiled-in value"
13118 .endtable
13119
13120
13121
13122 .section "Privilege controls" "SECID98"
13123 .table2
13124 .row &%admin_groups%&                "groups that are Exim admin users"
13125 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13126 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13127 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13128 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13129 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13130 .row &%never_users%&                 "do not run deliveries as these"
13131 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13132 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13133 .row &%trusted_groups%&              "groups that are trusted"
13134 .row &%trusted_users%&               "users that are trusted"
13135 .endtable
13136
13137
13138
13139 .section "Logging" "SECID99"
13140 .table2
13141 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13142 .row &%log_file_path%&               "override compiled-in value"
13143 .row &%log_selector%&                "set/unset optional logging"
13144 .row &%log_timezone%&                "add timezone to log lines"
13145 .row &%message_logs%&                "create per-message logs"
13146 .row &%preserve_message_logs%&       "after message completion"
13147 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13148 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13149 .row &%syslog_facility%&             "set syslog &""facility""& field"
13150 .row &%syslog_processname%&          "set syslog &""ident""& field"
13151 .row &%syslog_timestamp%&            "timestamp syslog lines"
13152 .row &%write_rejectlog%&             "control use of message log"
13153 .endtable
13154
13155
13156
13157 .section "Frozen messages" "SECID100"
13158 .table2
13159 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13160 .row &%freeze_tell%&                 "send message when freezing"
13161 .row &%move_frozen_messages%&        "to another directory"
13162 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13163 .endtable
13164
13165
13166
13167 .section "Data lookups" "SECID101"
13168 .table2
13169 .row &%ibase_servers%&               "InterBase servers"
13170 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13171 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13172 .row &%ldap_cert_file%&              "client cert file for LDAP"
13173 .row &%ldap_cert_key%&               "client key file for LDAP"
13174 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13175 .row &%ldap_default_servers%&        "used if no server in query"
13176 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13177 .row &%ldap_start_tls%&              "require TLS within LDAP"
13178 .row &%ldap_version%&                "set protocol version"
13179 .row &%lookup_open_max%&             "lookup files held open"
13180 .row &%mysql_servers%&               "default MySQL servers"
13181 .row &%oracle_servers%&              "Oracle servers"
13182 .row &%pgsql_servers%&               "default PostgreSQL servers"
13183 .row &%sqlite_lock_timeout%&         "as it says"
13184 .endtable
13185
13186
13187
13188 .section "Message ids" "SECID102"
13189 .table2
13190 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13191 .row &%message_id_header_text%&      "ditto"
13192 .endtable
13193
13194
13195
13196 .section "Embedded Perl Startup" "SECID103"
13197 .table2
13198 .row &%perl_at_start%&               "always start the interpreter"
13199 .row &%perl_startup%&                "code to obey when starting Perl"
13200 .endtable
13201
13202
13203
13204 .section "Daemon" "SECID104"
13205 .table2
13206 .row &%daemon_smtp_ports%&           "default ports"
13207 .row &%daemon_startup_retries%&      "number of times to retry"
13208 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13209 .row &%extra_local_interfaces%&      "not necessarily listened on"
13210 .row &%local_interfaces%&            "on which to listen, with optional ports"
13211 .row &%pid_file_path%&               "override compiled-in value"
13212 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13213 .endtable
13214
13215
13216
13217 .section "Resource control" "SECID105"
13218 .table2
13219 .row &%check_log_inodes%&            "before accepting a message"
13220 .row &%check_log_space%&             "before accepting a message"
13221 .row &%check_spool_inodes%&          "before accepting a message"
13222 .row &%check_spool_space%&           "before accepting a message"
13223 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13224 .row &%queue_only_load%&             "queue incoming if load high"
13225 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13226 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13227 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13228 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13229 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13230 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13231 .row &%smtp_accept_max_per_connection%& "messages per connection"
13232 .row &%smtp_accept_max_per_host%&    "connections from one host"
13233 .row &%smtp_accept_queue%&           "queue mail if more connections"
13234 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13235                                            connection"
13236 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13237 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13238 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13239 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13240 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13241 .endtable
13242
13243
13244
13245 .section "Policy controls" "SECID106"
13246 .table2
13247 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13248 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13249 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13250 .row &%acl_smtp_auth%&               "ACL for AUTH"
13251 .row &%acl_smtp_connect%&            "ACL for connection"
13252 .row &%acl_smtp_data%&               "ACL for DATA"
13253 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13254 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13255 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13256 .row &%acl_smtp_expn%&               "ACL for EXPN"
13257 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13258 .row &%acl_smtp_mail%&               "ACL for MAIL"
13259 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13260 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13261 .row &%acl_smtp_predata%&            "ACL for start of data"
13262 .row &%acl_smtp_quit%&               "ACL for QUIT"
13263 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13264 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13265 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13266 .row &%av_scanner%&                  "specify virus scanner"
13267 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13268                                       words""&"
13269 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13270 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13271 .row &%header_maxsize%&              "total size of message header"
13272 .row &%header_line_maxsize%&         "individual header line limit"
13273 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13274 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13275 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13276 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13277 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13278 .row &%host_lookup%&                 "host name looked up for these hosts"
13279 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13280 .row &%host_reject_connection%&      "reject connection from these hosts"
13281 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13282 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13283 .row &%message_size_limit%&          "for all messages"
13284 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13285 .row &%spamd_address%&               "set interface to SpamAssassin"
13286 .row &%strict_acl_vars%&             "object to unset ACL variables"
13287 .endtable
13288
13289
13290
13291 .section "Callout cache" "SECID107"
13292 .table2
13293 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13294                                          item"
13295 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13296                                          item"
13297 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13298 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13299 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13300 .endtable
13301
13302
13303
13304 .section "TLS" "SECID108"
13305 .table2
13306 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13307 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13308 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13309 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13310 .row &%tls_certificate%&             "location of server certificate"
13311 .row &%tls_crl%&                     "certificate revocation list"
13312 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13313 .row &%tls_dhparam%&                 "DH parameters for server"
13314 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13315 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13316 .row &%tls_privatekey%&              "location of server private key"
13317 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13318 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13319 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13320 .row &%tls_verify_certificates%&     "expected client certificates"
13321 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13322 .endtable
13323
13324
13325
13326 .section "Local user handling" "SECID109"
13327 .table2
13328 .row &%finduser_retries%&            "useful in NIS environments"
13329 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13330 .row &%gecos_pattern%&               "ditto"
13331 .row &%max_username_length%&         "for systems that truncate"
13332 .row &%unknown_login%&               "used when no login name found"
13333 .row &%unknown_username%&            "ditto"
13334 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13335 .row &%uucp_from_sender%&            "ditto"
13336 .endtable
13337
13338
13339
13340 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13341 .table2
13342 .row &%header_maxsize%&              "total size of message header"
13343 .row &%header_line_maxsize%&         "individual header line limit"
13344 .row &%message_size_limit%&          "applies to all messages"
13345 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13346 .row &%received_header_text%&        "expanded to make &'Received:'&"
13347 .row &%received_headers_max%&        "for mail loop detection"
13348 .row &%recipients_max%&              "limit per message"
13349 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13350 .endtable
13351
13352
13353
13354
13355 .section "Non-SMTP incoming messages" "SECID111"
13356 .table2
13357 .row &%receive_timeout%&             "for non-SMTP messages"
13358 .endtable
13359
13360
13361
13362
13363
13364 .section "Incoming SMTP messages" "SECID112"
13365 See also the &'Policy controls'& section above.
13366
13367 .table2
13368 .row &%host_lookup%&                 "host name looked up for these hosts"
13369 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13370 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13371 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13372 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13373 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13374 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13375 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13376 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13377 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13378 .row &%smtp_accept_max_per_connection%& "messages per connection"
13379 .row &%smtp_accept_max_per_host%&    "connections from one host"
13380 .row &%smtp_accept_queue%&           "queue mail if more connections"
13381 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13382                                            connection"
13383 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13384 .row &%smtp_active_hostname%&        "host name to use in messages"
13385 .row &%smtp_banner%&                 "text for welcome banner"
13386 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13387 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13388 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13389 .row &%smtp_etrn_command%&           "what to run for ETRN"
13390 .row &%smtp_etrn_serialize%&         "only one at once"
13391 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13392 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13393 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13394 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13395 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13396 .row &%smtp_receive_timeout%&        "per command or data line"
13397 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13398 .row &%smtp_return_error_details%&   "give detail on rejections"
13399 .endtable
13400
13401
13402
13403 .section "SMTP extensions" "SECID113"
13404 .table2
13405 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13406 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13407 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13408 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13409 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13410 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13411 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13412 .endtable
13413
13414
13415
13416 .section "Processing messages" "SECID114"
13417 .table2
13418 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13419 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13420 .row &%allow_utf8_domains%&          "in addresses"
13421 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13422                                       words""&"
13423 .row &%delivery_date_remove%&        "from incoming messages"
13424 .row &%envelope_to_remove%&          "from incoming messages"
13425 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13426 .row &%headers_charset%&             "default for translations"
13427 .row &%qualify_domain%&              "default for senders"
13428 .row &%qualify_recipient%&           "default for recipients"
13429 .row &%return_path_remove%&          "from incoming messages"
13430 .row &%strip_excess_angle_brackets%& "in addresses"
13431 .row &%strip_trailing_dot%&          "at end of addresses"
13432 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13433 .endtable
13434
13435
13436
13437 .section "System filter" "SECID115"
13438 .table2
13439 .row &%system_filter%&               "locate system filter"
13440 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13441                                             directory"
13442 .row &%system_filter_file_transport%& "transport for delivery to a file"
13443 .row &%system_filter_group%&         "group for filter running"
13444 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13445 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13446 .row &%system_filter_user%&          "user for filter running"
13447 .endtable
13448
13449
13450
13451 .section "Routing and delivery" "SECID116"
13452 .table2
13453 .row &%disable_ipv6%&                "do no IPv6 processing"
13454 .row &%dns_again_means_nonexist%&    "for broken domains"
13455 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13456 .row &%dns_dnssec_ok%&               "parameter for resolver"
13457 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13458 .row &%dns_retrans%&                 "parameter for resolver"
13459 .row &%dns_retry%&                   "parameter for resolver"
13460 .row &%dns_use_edns0%&               "parameter for resolver"
13461 .row &%hold_domains%&                "hold delivery for these domains"
13462 .row &%local_interfaces%&            "for routing checks"
13463 .row &%queue_domains%&               "no immediate delivery for these"
13464 .row &%queue_only%&                  "no immediate delivery at all"
13465 .row &%queue_only_file%&             "no immediate delivery if file exists"
13466 .row &%queue_only_load%&             "no immediate delivery if load is high"
13467 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13468 .row &%queue_only_override%&         "allow command line to override"
13469 .row &%queue_run_in_order%&          "order of arrival"
13470 .row &%queue_run_max%&               "of simultaneous queue runners"
13471 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13472 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13473 .row &%remote_sort_domains%&         "order of remote deliveries"
13474 .row &%retry_data_expire%&           "timeout for retry data"
13475 .row &%retry_interval_max%&          "safety net for retry rules"
13476 .endtable
13477
13478
13479
13480 .section "Bounce and warning messages" "SECID117"
13481 .table2
13482 .row &%bounce_message_file%&         "content of bounce"
13483 .row &%bounce_message_text%&         "content of bounce"
13484 .row &%bounce_return_body%&          "include body if returning message"
13485 .row &%bounce_return_message%&       "include original message in bounce"
13486 .row &%bounce_return_size_limit%&    "limit on returned message"
13487 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13488 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13489 .row &%errors_copy%&                 "copy bounce messages"
13490 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13491 .row &%delay_warning%&               "time schedule"
13492 .row &%delay_warning_condition%&     "condition for warning messages"
13493 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13494 .row &%smtp_return_error_details%&   "give detail on rejections"
13495 .row &%warn_message_file%&           "content of warning message"
13496 .endtable
13497
13498
13499
13500 .section "Alphabetical list of main options" "SECTalomo"
13501 Those options that undergo string expansion before use are marked with
13502 &dagger;.
13503
13504 .option accept_8bitmime main boolean true
13505 .cindex "8BITMIME"
13506 .cindex "8-bit characters"
13507 .cindex "log" "selectors"
13508 .cindex "log" "8BITMIME"
13509 This option causes Exim to send 8BITMIME in its response to an SMTP
13510 EHLO command, and to accept the BODY= parameter on MAIL commands.
13511 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13512 takes no steps to do anything special with messages received by this route.
13513
13514 Historically Exim kept this option off by default, but the maintainers
13515 feel that in today's Internet, this causes more problems than it solves.
13516 It now defaults to true.
13517 A more detailed analysis of the issues is provided by Dan Bernstein:
13518 .display
13519 &url(http://cr.yp.to/smtp/8bitmime.html)
13520 .endd
13521
13522 To log received 8BITMIME status use
13523 .code
13524 log_selector = +8bitmime
13525 .endd
13526
13527 .option acl_not_smtp main string&!! unset
13528 .cindex "&ACL;" "for non-SMTP messages"
13529 .cindex "non-SMTP messages" "ACLs for"
13530 This option defines the ACL that is run when a non-SMTP message has been
13531 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13532 further details.
13533
13534 .option acl_not_smtp_mime main string&!! unset
13535 This option defines the ACL that is run for individual MIME parts of non-SMTP
13536 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13537 SMTP messages.
13538
13539 .option acl_not_smtp_start main string&!! unset
13540 .cindex "&ACL;" "at start of non-SMTP message"
13541 .cindex "non-SMTP messages" "ACLs for"
13542 This option defines the ACL that is run before Exim starts reading a
13543 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13544
13545 .option acl_smtp_auth main string&!! unset
13546 .cindex "&ACL;" "setting up for SMTP commands"
13547 .cindex "AUTH" "ACL for"
13548 This option defines the ACL that is run when an SMTP AUTH command is
13549 received. See chapter &<<CHAPACL>>& for further details.
13550
13551 .option acl_smtp_connect main string&!! unset
13552 .cindex "&ACL;" "on SMTP connection"
13553 This option defines the ACL that is run when an SMTP connection is received.
13554 See chapter &<<CHAPACL>>& for further details.
13555
13556 .option acl_smtp_data main string&!! unset
13557 .cindex "DATA" "ACL for"
13558 This option defines the ACL that is run after an SMTP DATA command has been
13559 processed and the message itself has been received, but before the final
13560 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13561
13562 .option acl_smtp_data_prdr main string&!! unset
13563 .cindex "DATA" "ACL for"
13564 .cindex "&ACL;" "PRDR-related"
13565 .cindex "&ACL;" "per-user data processing"
13566 This option defines the ACL that,
13567 if the PRDR feature has been negotiated,
13568 is run for each recipient after an SMTP DATA command has been
13569 processed and the message itself has been received, but before the
13570 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13571
13572 .option acl_smtp_etrn main string&!! unset
13573 .cindex "ETRN" "ACL for"
13574 This option defines the ACL that is run when an SMTP ETRN command is
13575 received. See chapter &<<CHAPACL>>& for further details.
13576
13577 .option acl_smtp_expn main string&!! unset
13578 .cindex "EXPN" "ACL for"
13579 This option defines the ACL that is run when an SMTP EXPN command is
13580 received. See chapter &<<CHAPACL>>& for further details.
13581
13582 .option acl_smtp_helo main string&!! unset
13583 .cindex "EHLO" "ACL for"
13584 .cindex "HELO" "ACL for"
13585 This option defines the ACL that is run when an SMTP EHLO or HELO
13586 command is received. See chapter &<<CHAPACL>>& for further details.
13587
13588
13589 .option acl_smtp_mail main string&!! unset
13590 .cindex "MAIL" "ACL for"
13591 This option defines the ACL that is run when an SMTP MAIL command is
13592 received. See chapter &<<CHAPACL>>& for further details.
13593
13594 .option acl_smtp_mailauth main string&!! unset
13595 .cindex "AUTH" "on MAIL command"
13596 This option defines the ACL that is run when there is an AUTH parameter on
13597 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13598 &<<CHAPSMTPAUTH>>& for details of authentication.
13599
13600 .option acl_smtp_mime main string&!! unset
13601 .cindex "MIME content scanning" "ACL for"
13602 This option is available when Exim is built with the content-scanning
13603 extension. It defines the ACL that is run for each MIME part in a message. See
13604 section &<<SECTscanmimepart>>& for details.
13605
13606 .option acl_smtp_predata main string&!! unset
13607 This option defines the ACL that is run when an SMTP DATA command is
13608 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13609 further details.
13610
13611 .option acl_smtp_quit main string&!! unset
13612 .cindex "QUIT, ACL for"
13613 This option defines the ACL that is run when an SMTP QUIT command is
13614 received. See chapter &<<CHAPACL>>& for further details.
13615
13616 .option acl_smtp_rcpt main string&!! unset
13617 .cindex "RCPT" "ACL for"
13618 This option defines the ACL that is run when an SMTP RCPT command is
13619 received. See chapter &<<CHAPACL>>& for further details.
13620
13621 .option acl_smtp_starttls main string&!! unset
13622 .cindex "STARTTLS, ACL for"
13623 This option defines the ACL that is run when an SMTP STARTTLS command is
13624 received. See chapter &<<CHAPACL>>& for further details.
13625
13626 .option acl_smtp_vrfy main string&!! unset
13627 .cindex "VRFY" "ACL for"
13628 This option defines the ACL that is run when an SMTP VRFY command is
13629 received. See chapter &<<CHAPACL>>& for further details.
13630
13631 .option admin_groups main "string list&!!" unset
13632 .cindex "admin user"
13633 This option is expanded just once, at the start of Exim's processing. If the
13634 current group or any of the supplementary groups of an Exim caller is in this
13635 colon-separated list, the caller has admin privileges. If all your system
13636 programmers are in a specific group, for example, you can give them all Exim
13637 admin privileges by putting that group in &%admin_groups%&. However, this does
13638 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13639 To permit this, you have to add individuals to the Exim group.
13640
13641 .option allow_domain_literals main boolean false
13642 .cindex "domain literal"
13643 If this option is set, the RFC 2822 domain literal format is permitted in
13644 email addresses. The option is not set by default, because the domain literal
13645 format is not normally required these days, and few people know about it. It
13646 has, however, been exploited by mail abusers.
13647
13648 Unfortunately, it seems that some DNS black list maintainers are using this
13649 format to report black listing to postmasters. If you want to accept messages
13650 addressed to your hosts by IP address, you need to set
13651 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13652 domains (defined in the named domain list &%local_domains%& in the default
13653 configuration). This &"magic string"& matches the domain literal form of all
13654 the local host's IP addresses.
13655
13656
13657 .option allow_mx_to_ip main boolean false
13658 .cindex "MX record" "pointing to IP address"
13659 It appears that more and more DNS zone administrators are breaking the rules
13660 and putting domain names that look like IP addresses on the right hand side of
13661 MX records. Exim follows the rules and rejects this, giving an error message
13662 that explains the mis-configuration. However, some other MTAs support this
13663 practice, so to avoid &"Why can't Exim do this?"& complaints,
13664 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13665 recommended, except when you have no other choice.
13666
13667 .option allow_utf8_domains main boolean false
13668 .cindex "domain" "UTF-8 characters in"
13669 .cindex "UTF-8" "in domain name"
13670 Lots of discussion is going on about internationalized domain names. One
13671 camp is strongly in favour of just using UTF-8 characters, and it seems
13672 that at least two other MTAs permit this. This option allows Exim users to
13673 experiment if they wish.
13674
13675 If it is set true, Exim's domain parsing function allows valid
13676 UTF-8 multicharacters to appear in domain name components, in addition to
13677 letters, digits, and hyphens. However, just setting this option is not
13678 enough; if you want to look up these domain names in the DNS, you must also
13679 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13680 suitable setting is:
13681 .code
13682 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13683   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13684 .endd
13685 Alternatively, you can just disable this feature by setting
13686 .code
13687 dns_check_names_pattern =
13688 .endd
13689 That is, set the option to an empty string so that no check is done.
13690
13691
13692 .option auth_advertise_hosts main "host list&!!" *
13693 .cindex "authentication" "advertising"
13694 .cindex "AUTH" "advertising"
13695 If any server authentication mechanisms are configured, Exim advertises them in
13696 response to an EHLO command only if the calling host matches this list.
13697 Otherwise, Exim does not advertise AUTH.
13698 Exim does not accept AUTH commands from clients to which it has not
13699 advertised the availability of AUTH. The advertising of individual
13700 authentication mechanisms can be controlled by the use of the
13701 &%server_advertise_condition%& generic authenticator option on the individual
13702 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13703
13704 Certain mail clients (for example, Netscape) require the user to provide a name
13705 and password for authentication if AUTH is advertised, even though it may
13706 not be needed (the host may accept messages from hosts on its local LAN without
13707 authentication, for example). The &%auth_advertise_hosts%& option can be used
13708 to make these clients more friendly by excluding them from the set of hosts to
13709 which Exim advertises AUTH.
13710
13711 .cindex "AUTH" "advertising when encrypted"
13712 If you want to advertise the availability of AUTH only when the connection
13713 is encrypted using TLS, you can make use of the fact that the value of this
13714 option is expanded, with a setting like this:
13715 .code
13716 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13717 .endd
13718 .vindex "&$tls_in_cipher$&"
13719 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13720 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13721 expansion is *, which matches all hosts.
13722
13723
13724 .option auto_thaw main time 0s
13725 .cindex "thawing messages"
13726 .cindex "unfreezing messages"
13727 If this option is set to a time greater than zero, a queue runner will try a
13728 new delivery attempt on any frozen message, other than a bounce message, if
13729 this much time has passed since it was frozen. This may result in the message
13730 being re-frozen if nothing has changed since the last attempt. It is a way of
13731 saying &"keep on trying, even though there are big problems"&.
13732
13733 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13734 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13735 thought to be very useful any more, and its use should probably be avoided.
13736
13737
13738 .option av_scanner main string "see below"
13739 This option is available if Exim is built with the content-scanning extension.
13740 It specifies which anti-virus scanner to use. The default value is:
13741 .code
13742 sophie:/var/run/sophie
13743 .endd
13744 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13745 before use. See section &<<SECTscanvirus>>& for further details.
13746
13747
13748 .option bi_command main string unset
13749 .oindex "&%-bi%&"
13750 This option supplies the name of a command that is run when Exim is called with
13751 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13752 just the command name, it is not a complete command line. If an argument is
13753 required, it must come from the &%-oA%& command line option.
13754
13755
13756 .option bounce_message_file main string unset
13757 .cindex "bounce message" "customizing"
13758 .cindex "customizing" "bounce message"
13759 This option defines a template file containing paragraphs of text to be used
13760 for constructing bounce messages.  Details of the file's contents are given in
13761 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13762
13763
13764 .option bounce_message_text main string unset
13765 When this option is set, its contents are included in the default bounce
13766 message immediately after &"This message was created automatically by mail
13767 delivery software."& It is not used if &%bounce_message_file%& is set.
13768
13769 .option bounce_return_body main boolean true
13770 .cindex "bounce message" "including body"
13771 This option controls whether the body of an incoming message is included in a
13772 bounce message when &%bounce_return_message%& is true. The default setting
13773 causes the entire message, both header and body, to be returned (subject to the
13774 value of &%bounce_return_size_limit%&). If this option is false, only the
13775 message header is included. In the case of a non-SMTP message containing an
13776 error that is detected during reception, only those header lines preceding the
13777 point at which the error was detected are returned.
13778 .cindex "bounce message" "including original"
13779
13780 .option bounce_return_message main boolean true
13781 If this option is set false, none of the original message is included in
13782 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13783 &%bounce_return_body%&.
13784
13785
13786 .option bounce_return_size_limit main integer 100K
13787 .cindex "size" "of bounce, limit"
13788 .cindex "bounce message" "size limit"
13789 .cindex "limit" "bounce message size"
13790 This option sets a limit in bytes on the size of messages that are returned to
13791 senders as part of bounce messages when &%bounce_return_message%& is true. The
13792 limit should be less than the value of the global &%message_size_limit%& and of
13793 any &%message_size_limit%& settings on transports, to allow for the bounce text
13794 that Exim generates. If this option is set to zero there is no limit.
13795
13796 When the body of any message that is to be included in a bounce message is
13797 greater than the limit, it is truncated, and a comment pointing this out is
13798 added at the top. The actual cutoff may be greater than the value given, owing
13799 to the use of buffering for transferring the message in chunks (typically 8K in
13800 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13801 messages.
13802
13803 .option bounce_sender_authentication main string unset
13804 .cindex "bounce message" "sender authentication"
13805 .cindex "authentication" "bounce message"
13806 .cindex "AUTH" "on bounce message"
13807 This option provides an authenticated sender address that is sent with any
13808 bounce messages generated by Exim that are sent over an authenticated SMTP
13809 connection. A typical setting might be:
13810 .code
13811 bounce_sender_authentication = mailer-daemon@my.domain.example
13812 .endd
13813 which would cause bounce messages to be sent using the SMTP command:
13814 .code
13815 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13816 .endd
13817 The value of &%bounce_sender_authentication%& must always be a complete email
13818 address.
13819
13820 .option callout_domain_negative_expire main time 3h
13821 .cindex "caching" "callout timeouts"
13822 .cindex "callout" "caching timeouts"
13823 This option specifies the expiry time for negative callout cache data for a
13824 domain. See section &<<SECTcallver>>& for details of callout verification, and
13825 section &<<SECTcallvercache>>& for details of the caching.
13826
13827
13828 .option callout_domain_positive_expire main time 7d
13829 This option specifies the expiry time for positive callout cache data for a
13830 domain. See section &<<SECTcallver>>& for details of callout verification, and
13831 section &<<SECTcallvercache>>& for details of the caching.
13832
13833
13834 .option callout_negative_expire main time 2h
13835 This option specifies the expiry time for negative callout cache data for an
13836 address. See section &<<SECTcallver>>& for details of callout verification, and
13837 section &<<SECTcallvercache>>& for details of the caching.
13838
13839
13840 .option callout_positive_expire main time 24h
13841 This option specifies the expiry time for positive callout cache data for an
13842 address. See section &<<SECTcallver>>& for details of callout verification, and
13843 section &<<SECTcallvercache>>& for details of the caching.
13844
13845
13846 .option callout_random_local_part main string&!! "see below"
13847 This option defines the &"random"& local part that can be used as part of
13848 callout verification. The default value is
13849 .code
13850 $primary_hostname-$tod_epoch-testing
13851 .endd
13852 See section &<<CALLaddparcall>>& for details of how this value is used.
13853
13854
13855 .option check_log_inodes main integer 0
13856 See &%check_spool_space%& below.
13857
13858
13859 .option check_log_space main integer 0
13860 See &%check_spool_space%& below.
13861
13862 .oindex "&%check_rfc2047_length%&"
13863 .cindex "RFC 2047" "disabling length check"
13864 .option check_rfc2047_length main boolean true
13865 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13866 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13867 word; strings to be encoded that exceed this length are supposed to use
13868 multiple encoded words. By default, Exim does not recognize encoded words that
13869 exceed the maximum length. However, it seems that some software, in violation
13870 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13871 set false, Exim recognizes encoded words of any length.
13872
13873
13874 .option check_spool_inodes main integer 0
13875 See &%check_spool_space%& below.
13876
13877
13878 .option check_spool_space main integer 0
13879 .cindex "checking disk space"
13880 .cindex "disk space, checking"
13881 .cindex "spool directory" "checking space"
13882 The four &%check_...%& options allow for checking of disk resources before a
13883 message is accepted.
13884
13885 .vindex "&$log_inodes$&"
13886 .vindex "&$log_space$&"
13887 .vindex "&$spool_inodes$&"
13888 .vindex "&$spool_space$&"
13889 When any of these options are set, they apply to all incoming messages. If you
13890 want to apply different checks to different kinds of message, you can do so by
13891 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13892 &$spool_space$& in an ACL with appropriate additional conditions.
13893
13894
13895 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13896 either value is greater than zero, for example:
13897 .code
13898 check_spool_space = 10M
13899 check_spool_inodes = 100
13900 .endd
13901 The spool partition is the one that contains the directory defined by
13902 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13903 transit.
13904
13905 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13906 files are written if either is greater than zero. These should be set only if
13907 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13908
13909 If there is less space or fewer inodes than requested, Exim refuses to accept
13910 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13911 error response to the MAIL command. If ESMTP is in use and there was a
13912 SIZE parameter on the MAIL command, its value is added to the
13913 &%check_spool_space%& value, and the check is performed even if
13914 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13915
13916 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13917 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13918
13919 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13920 failure a message is written to stderr and Exim exits with a non-zero code, as
13921 it obviously cannot send an error message of any kind.
13922
13923 .option daemon_smtp_ports main string &`smtp`&
13924 .cindex "port" "for daemon"
13925 .cindex "TCP/IP" "setting listening ports"
13926 This option specifies one or more default SMTP ports on which the Exim daemon
13927 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13928 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13929
13930 .option daemon_startup_retries main integer 9
13931 .cindex "daemon startup, retrying"
13932 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13933 the daemon at startup when it cannot immediately bind a listening socket
13934 (typically because the socket is already in use): &%daemon_startup_retries%&
13935 defines the number of retries after the first failure, and
13936 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13937
13938 .option daemon_startup_sleep main time 30s
13939 See &%daemon_startup_retries%&.
13940
13941 .option delay_warning main "time list" 24h
13942 .cindex "warning of delay"
13943 .cindex "delay warning, specifying"
13944 When a message is delayed, Exim sends a warning message to the sender at
13945 intervals specified by this option. The data is a colon-separated list of times
13946 after which to send warning messages. If the value of the option is an empty
13947 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13948 message has been on the queue for longer than the last time, the last interval
13949 between the times is used to compute subsequent warning times. For example,
13950 with
13951 .code
13952 delay_warning = 4h:8h:24h
13953 .endd
13954 the first message is sent after 4 hours, the second after 8 hours, and
13955 the third one after 24 hours. After that, messages are sent every 16 hours,
13956 because that is the interval between the last two times on the list. If you set
13957 just one time, it specifies the repeat interval. For example, with:
13958 .code
13959 delay_warning = 6h
13960 .endd
13961 messages are repeated every six hours. To stop warnings after a given time, set
13962 a very large time at the end of the list. For example:
13963 .code
13964 delay_warning = 2h:12h:99d
13965 .endd
13966 Note that the option is only evaluated at the time a delivery attempt fails,
13967 which depends on retry and queue-runner configuration.
13968 Typically retries will be configured more frequently than warning messages.
13969
13970 .option delay_warning_condition main string&!! "see below"
13971 .vindex "&$domain$&"
13972 The string is expanded at the time a warning message might be sent. If all the
13973 deferred addresses have the same domain, it is set in &$domain$& during the
13974 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13975 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13976 &"false"& (the comparison being done caselessly) then the warning message is
13977 not sent. The default is:
13978 .code
13979 delay_warning_condition = ${if or {\
13980   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13981   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13982   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13983   } {no}{yes}}
13984 .endd
13985 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13986 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13987 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13988 &"auto-replied"& in an &'Auto-Submitted:'& header.
13989
13990 .option deliver_drop_privilege main boolean false
13991 .cindex "unprivileged delivery"
13992 .cindex "delivery" "unprivileged"
13993 If this option is set true, Exim drops its root privilege at the start of a
13994 delivery process, and runs as the Exim user throughout. This severely restricts
13995 the kinds of local delivery that are possible, but is viable in certain types
13996 of configuration. There is a discussion about the use of root privilege in
13997 chapter &<<CHAPsecurity>>&.
13998
13999 .option deliver_queue_load_max main fixed-point unset
14000 .cindex "load average"
14001 .cindex "queue runner" "abandoning"
14002 When this option is set, a queue run is abandoned if the system load average
14003 becomes greater than the value of the option. The option has no effect on
14004 ancient operating systems on which Exim cannot determine the load average.
14005 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14006
14007
14008 .option delivery_date_remove main boolean true
14009 .cindex "&'Delivery-date:'& header line"
14010 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14011 message when it is delivered, in exactly the same way as &'Return-path:'& is
14012 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14013 should not be present in incoming messages, and this option causes them to be
14014 removed at the time the message is received, to avoid any problems that might
14015 occur when a delivered message is subsequently sent on to some other recipient.
14016
14017 .option disable_fsync main boolean false
14018 .cindex "&[fsync()]&, disabling"
14019 This option is available only if Exim was built with the compile-time option
14020 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14021 a runtime configuration generates an &"unknown option"& error. You should not
14022 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14023 really, really, really understand what you are doing. &'No pre-compiled
14024 distributions of Exim should ever make this option available.'&
14025
14026 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14027 updated files' data to be written to disc before continuing. Unexpected events
14028 such as crashes and power outages may cause data to be lost or scrambled.
14029 Here be Dragons. &*Beware.*&
14030
14031
14032 .option disable_ipv6 main boolean false
14033 .cindex "IPv6" "disabling"
14034 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14035 activities take place. AAAA records are never looked up, and any IPv6 addresses
14036 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14037 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14038 to handle IPv6 literal addresses.
14039
14040
14041 .option dns_again_means_nonexist main "domain list&!!" unset
14042 .cindex "DNS" "&""try again""& response; overriding"
14043 DNS lookups give a &"try again"& response for the DNS errors
14044 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14045 keep trying to deliver a message, or to give repeated temporary errors to
14046 incoming mail. Sometimes the effect is caused by a badly set up name server and
14047 may persist for a long time. If a domain which exhibits this problem matches
14048 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14049 This option should be used with care. You can make it apply to reverse lookups
14050 by a setting such as this:
14051 .code
14052 dns_again_means_nonexist = *.in-addr.arpa
14053 .endd
14054 This option applies to all DNS lookups that Exim does. It also applies when the
14055 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14056 since these are most likely to be caused by DNS lookup problems. The
14057 &(dnslookup)& router has some options of its own for controlling what happens
14058 when lookups for MX or SRV records give temporary errors. These more specific
14059 options are applied after this global option.
14060
14061 .option dns_check_names_pattern main string "see below"
14062 .cindex "DNS" "pre-check of name syntax"
14063 When this option is set to a non-empty string, it causes Exim to check domain
14064 names for characters that are not allowed in host names before handing them to
14065 the DNS resolver, because some resolvers give temporary errors for names that
14066 contain unusual characters. If a domain name contains any unwanted characters,
14067 a &"not found"& result is forced, and the resolver is not called. The check is
14068 done by matching the domain name against a regular expression, which is the
14069 value of this option. The default pattern is
14070 .code
14071 dns_check_names_pattern = \
14072   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14073 .endd
14074 which permits only letters, digits, slashes, and hyphens in components, but
14075 they must start and end with a letter or digit. Slashes are not, in fact,
14076 permitted in host names, but they are found in certain NS records (which can be
14077 accessed in Exim by using a &%dnsdb%& lookup). If you set
14078 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14079 empty string.
14080
14081 .option dns_csa_search_limit main integer 5
14082 This option controls the depth of parental searching for CSA SRV records in the
14083 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14084
14085 .option dns_csa_use_reverse main boolean true
14086 This option controls whether or not an IP address, given as a CSA domain, is
14087 reversed and looked up in the reverse DNS, as described in more detail in
14088 section &<<SECTverifyCSA>>&.
14089
14090
14091 .option dns_dnssec_ok main integer -1
14092 .cindex "DNS" "resolver options"
14093 .cindex "DNS" "DNSSEC"
14094 If this option is set to a non-negative number then Exim will initialise the
14095 DNS resolver library to either use or not use DNSSEC, overriding the system
14096 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14097
14098 If the resolver library does not support DNSSEC then this option has no effect.
14099
14100
14101 .option dns_ipv4_lookup main "domain list&!!" unset
14102 .cindex "IPv6" "DNS lookup for AAAA records"
14103 .cindex "DNS" "IPv6 lookup for AAAA records"
14104 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14105 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14106 (A records) when trying to find IP addresses for hosts, unless the host's
14107 domain matches this list.
14108
14109 This is a fudge to help with name servers that give big delays or otherwise do
14110 not work for the AAAA record type. In due course, when the world's name
14111 servers have all been upgraded, there should be no need for this option.
14112
14113
14114 .option dns_retrans main time 0s
14115 .cindex "DNS" "resolver options"
14116 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14117 retransmission and retry parameters for DNS lookups. Values of zero (the
14118 defaults) leave the system default settings unchanged. The first value is the
14119 time between retries, and the second is the number of retries. It isn't
14120 totally clear exactly how these settings affect the total time a DNS lookup may
14121 take. I haven't found any documentation about timeouts on DNS lookups; these
14122 parameter values are available in the external resolver interface structure,
14123 but nowhere does it seem to describe how they are used or what you might want
14124 to set in them.
14125
14126
14127 .option dns_retry main integer 0
14128 See &%dns_retrans%& above.
14129
14130
14131 .option dns_use_edns0 main integer -1
14132 .cindex "DNS" "resolver options"
14133 .cindex "DNS" "EDNS0"
14134 If this option is set to a non-negative number then Exim will initialise the
14135 DNS resolver library to either use or not use EDNS0 extensions, overriding
14136 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14137 on.
14138
14139 If the resolver library does not support EDNS0 then this option has no effect.
14140
14141
14142 .option drop_cr main boolean false
14143 This is an obsolete option that is now a no-op. It used to affect the way Exim
14144 handled CR and LF characters in incoming messages. What happens now is
14145 described in section &<<SECTlineendings>>&.
14146
14147 .option dsn_from main "string&!!" "see below"
14148 .cindex "&'From:'& header line" "in bounces"
14149 .cindex "bounce messages" "&'From:'& line, specifying"
14150 This option can be used to vary the contents of &'From:'& header lines in
14151 bounces and other automatically generated messages (&"Delivery Status
14152 Notifications"& &-- hence the name of the option). The default setting is:
14153 .code
14154 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14155 .endd
14156 The value is expanded every time it is needed. If the expansion fails, a
14157 panic is logged, and the default value is used.
14158
14159 .option envelope_to_remove main boolean true
14160 .cindex "&'Envelope-to:'& header line"
14161 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14162 message when it is delivered, in exactly the same way as &'Return-path:'& is
14163 handled. &'Envelope-to:'& records the original recipient address from the
14164 messages's envelope that caused the delivery to happen. Such headers should not
14165 be present in incoming messages, and this option causes them to be removed at
14166 the time the message is received, to avoid any problems that might occur when a
14167 delivered message is subsequently sent on to some other recipient.
14168
14169
14170 .option errors_copy main "string list&!!" unset
14171 .cindex "bounce message" "copy to other address"
14172 .cindex "copy of bounce message"
14173 Setting this option causes Exim to send bcc copies of bounce messages that it
14174 generates to other addresses. &*Note*&: This does not apply to bounce messages
14175 coming from elsewhere. The value of the option is a colon-separated list of
14176 items. Each item consists of a pattern, terminated by white space, followed by
14177 a comma-separated list of email addresses. If a pattern contains spaces, it
14178 must be enclosed in double quotes.
14179
14180 Each pattern is processed in the same way as a single item in an address list
14181 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14182 the bounce message, the message is copied to the addresses on the list. The
14183 items are scanned in order, and once a matching one is found, no further items
14184 are examined. For example:
14185 .code
14186 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14187               rqps@mydomain   hostmaster@mydomain.example,\
14188                               postmaster@mydomain.example
14189 .endd
14190 .vindex "&$domain$&"
14191 .vindex "&$local_part$&"
14192 The address list is expanded before use. The expansion variables &$local_part$&
14193 and &$domain$& are set from the original recipient of the error message, and if
14194 there was any wildcard matching in the pattern, the expansion
14195 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14196 variables &$0$&, &$1$&, etc. are set in the normal way.
14197
14198
14199 .option errors_reply_to main string unset
14200 .cindex "bounce message" "&'Reply-to:'& in"
14201 By default, Exim's bounce and delivery warning messages contain the header line
14202 .display
14203 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14204 .endd
14205 .oindex &%quota_warn_message%&
14206 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14207 A warning message that is generated by the &%quota_warn_message%& option in an
14208 &(appendfile)& transport may contain its own &'From:'& header line that
14209 overrides the default.
14210
14211 Experience shows that people reply to bounce messages. If the
14212 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14213 and warning messages. For example:
14214 .code
14215 errors_reply_to = postmaster@my.domain.example
14216 .endd
14217 The value of the option is not expanded. It must specify a valid RFC 2822
14218 address. However, if a warning message that is generated by the
14219 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14220 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14221 not used.
14222
14223
14224 .option exim_group main string "compile-time configured"
14225 .cindex "gid (group id)" "Exim's own"
14226 .cindex "Exim group"
14227 This option changes the gid under which Exim runs when it gives up root
14228 privilege. The default value is compiled into the binary. The value of this
14229 option is used only when &%exim_user%& is also set. Unless it consists entirely
14230 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14231 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14232 security issues.
14233
14234
14235 .option exim_path main string "see below"
14236 .cindex "Exim binary, path name"
14237 This option specifies the path name of the Exim binary, which is used when Exim
14238 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14239 the directory configured at compile time by the BIN_DIRECTORY setting. It
14240 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14241 other place.
14242 &*Warning*&: Do not use a macro to define the value of this option, because
14243 you will break those Exim utilities that scan the configuration file to find
14244 where the binary is. (They then use the &%-bP%& option to extract option
14245 settings such as the value of &%spool_directory%&.)
14246
14247
14248 .option exim_user main string "compile-time configured"
14249 .cindex "uid (user id)" "Exim's own"
14250 .cindex "Exim user"
14251 This option changes the uid under which Exim runs when it gives up root
14252 privilege. The default value is compiled into the binary. Ownership of the run
14253 time configuration file and the use of the &%-C%& and &%-D%& command line
14254 options is checked against the values in the binary, not what is set here.
14255
14256 Unless it consists entirely of digits, the string is looked up using
14257 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14258 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14259 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14260
14261
14262 .option extra_local_interfaces main "string list" unset
14263 This option defines network interfaces that are to be considered local when
14264 routing, but which are not used for listening by the daemon. See section
14265 &<<SECTreclocipadd>>& for details.
14266
14267
14268 . Allow this long option name to split; give it unsplit as a fifth argument
14269 . for the automatic .oindex that is generated by .option.
14270
14271 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14272          extract_addresses_remove_arguments
14273 .oindex "&%-t%&"
14274 .cindex "command line" "addresses with &%-t%&"
14275 .cindex "Sendmail compatibility" "&%-t%& option"
14276 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14277 are present on the command line when the &%-t%& option is used to build an
14278 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14279 line addresses are removed from the recipients list. This is also how Smail
14280 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14281 command line addresses are added to those obtained from the header lines. When
14282 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14283 argument headers. If it is set false, Exim adds rather than removes argument
14284 addresses.
14285
14286
14287 .option finduser_retries main integer 0
14288 .cindex "NIS, retrying user lookups"
14289 On systems running NIS or other schemes in which user and group information is
14290 distributed from a remote system, there can be times when &[getpwnam()]& and
14291 related functions fail, even when given valid data, because things time out.
14292 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14293 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14294 many extra times to find a user or a group, waiting for one second between
14295 retries.
14296
14297 .cindex "&_/etc/passwd_&" "multiple reading of"
14298 You should not set this option greater than zero if your user information is in
14299 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14300 search the file multiple times for non-existent users, and also cause delay.
14301
14302
14303
14304 .option freeze_tell main "string list, comma separated" unset
14305 .cindex "freezing messages" "sending a message when freezing"
14306 On encountering certain errors, or when configured to do so in a system filter,
14307 ACL, or special router, Exim freezes a message. This means that no further
14308 delivery attempts take place until an administrator thaws the message, or the
14309 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14310 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14311 warning message whenever it freezes something, unless the message it is
14312 freezing is a locally-generated bounce message. (Without this exception there
14313 is the possibility of looping.) The warning message is sent to the addresses
14314 supplied as the comma-separated value of this option. If several of the
14315 message's addresses cause freezing, only a single message is sent. If the
14316 freezing was automatic, the reason(s) for freezing can be found in the message
14317 log. If you configure freezing in a filter or ACL, you must arrange for any
14318 logging that you require.
14319
14320
14321 .option gecos_name main string&!! unset
14322 .cindex "HP-UX"
14323 .cindex "&""gecos""& field, parsing"
14324 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14325 password file to hold other information in addition to users' real names. Exim
14326 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14327 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14328 of the field are used unchanged, except that, if an ampersand is encountered,
14329 it is replaced by the user's login name with the first character forced to
14330 upper case, since this is a convention that is observed on many systems.
14331
14332 When these options are set, &%gecos_pattern%& is treated as a regular
14333 expression that is to be applied to the field (again with && replaced by the
14334 login name), and if it matches, &%gecos_name%& is expanded and used as the
14335 user's name.
14336
14337 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14338 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14339 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14340 name terminates at the first comma, the following can be used:
14341 .code
14342 gecos_pattern = ([^,]*)
14343 gecos_name = $1
14344 .endd
14345
14346 .option gecos_pattern main string unset
14347 See &%gecos_name%& above.
14348
14349
14350 .option gnutls_compat_mode main boolean unset
14351 This option controls whether GnuTLS is used in compatibility mode in an Exim
14352 server. This reduces security slightly, but improves interworking with older
14353 implementations of TLS.
14354
14355
14356 option gnutls_allow_auto_pkcs11 main boolean unset
14357 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14358 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14359
14360 See
14361 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14362 for documentation.
14363
14364
14365
14366 .option headers_charset main string "see below"
14367 This option sets a default character set for translating from encoded MIME
14368 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14369 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14370 ultimate default is ISO-8859-1. For more details see the description of header
14371 insertions in section &<<SECTexpansionitems>>&.
14372
14373
14374
14375 .option header_maxsize main integer "see below"
14376 .cindex "header section" "maximum size of"
14377 .cindex "limit" "size of message header section"
14378 This option controls the overall maximum size of a message's header
14379 section. The default is the value of HEADER_MAXSIZE in
14380 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14381 sections are rejected.
14382
14383
14384 .option header_line_maxsize main integer 0
14385 .cindex "header lines" "maximum size of"
14386 .cindex "limit" "size of one header line"
14387 This option limits the length of any individual header line in a message, after
14388 all the continuations have been joined together. Messages with individual
14389 header lines that are longer than the limit are rejected. The default value of
14390 zero means &"no limit"&.
14391
14392
14393
14394
14395 .option helo_accept_junk_hosts main "host list&!!" unset
14396 .cindex "HELO" "accepting junk data"
14397 .cindex "EHLO" "accepting junk data"
14398 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14399 mail, and gives an error response for invalid data. Unfortunately, there are
14400 some SMTP clients that send syntactic junk. They can be accommodated by setting
14401 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14402 if you want to do semantic checking.
14403 See also &%helo_allow_chars%& for a way of extending the permitted character
14404 set.
14405
14406
14407 .option helo_allow_chars main string unset
14408 .cindex "HELO" "underscores in"
14409 .cindex "EHLO" "underscores in"
14410 .cindex "underscore in EHLO/HELO"
14411 This option can be set to a string of rogue characters that are permitted in
14412 all EHLO and HELO names in addition to the standard letters, digits,
14413 hyphens, and dots. If you really must allow underscores, you can set
14414 .code
14415 helo_allow_chars = _
14416 .endd
14417 Note that the value is one string, not a list.
14418
14419
14420 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14421 .cindex "HELO" "forcing reverse lookup"
14422 .cindex "EHLO" "forcing reverse lookup"
14423 If the domain given by a client in a HELO or EHLO command matches this
14424 list, a reverse lookup is done in order to establish the host's true name. The
14425 default forces a lookup if the client host gives the server's name or any of
14426 its IP addresses (in brackets), something that broken clients have been seen to
14427 do.
14428
14429
14430 .option helo_try_verify_hosts main "host list&!!" unset
14431 .cindex "HELO verifying" "optional"
14432 .cindex "EHLO" "verifying, optional"
14433 By default, Exim just checks the syntax of HELO and EHLO commands (see
14434 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14435 to do more extensive checking of the data supplied by these commands. The ACL
14436 condition &`verify = helo`& is provided to make this possible.
14437 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14438 to force the check to occur. From release 4.53 onwards, this is no longer
14439 necessary. If the check has not been done before &`verify = helo`& is
14440 encountered, it is done at that time. Consequently, this option is obsolete.
14441 Its specification is retained here for backwards compatibility.
14442
14443 When an EHLO or HELO command is received, if the calling host matches
14444 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14445 EHLO command either:
14446
14447 .ilist
14448 is an IP literal matching the calling address of the host, or
14449 .next
14450 .cindex "DNS" "reverse lookup"
14451 .cindex "reverse DNS lookup"
14452 matches the host name that Exim obtains by doing a reverse lookup of the
14453 calling host address, or
14454 .next
14455 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14456 available) yields the calling host address.
14457 .endlist
14458
14459 However, the EHLO or HELO command is not rejected if any of the checks
14460 fail. Processing continues, but the result of the check is remembered, and can
14461 be detected later in an ACL by the &`verify = helo`& condition.
14462
14463 .option helo_verify_hosts main "host list&!!" unset
14464 .cindex "HELO verifying" "mandatory"
14465 .cindex "EHLO" "verifying, mandatory"
14466 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14467 backwards compatibility. For hosts that match this option, Exim checks the host
14468 name given in the HELO or EHLO in the same way as for
14469 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14470 rejected with a 550 error, and entries are written to the main and reject logs.
14471 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14472 error.
14473
14474 .option hold_domains main "domain list&!!" unset
14475 .cindex "domain" "delaying delivery"
14476 .cindex "delivery" "delaying certain domains"
14477 This option allows mail for particular domains to be held on the queue
14478 manually. The option is overridden if a message delivery is forced with the
14479 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14480 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14481 item in &%hold_domains%&, no routing or delivery for that address is done, and
14482 it is deferred every time the message is looked at.
14483
14484 This option is intended as a temporary operational measure for delaying the
14485 delivery of mail while some problem is being sorted out, or some new
14486 configuration tested. If you just want to delay the processing of some
14487 domains until a queue run occurs, you should use &%queue_domains%& or
14488 &%queue_smtp_domains%&, not &%hold_domains%&.
14489
14490 A setting of &%hold_domains%& does not override Exim's code for removing
14491 messages from the queue if they have been there longer than the longest retry
14492 time in any retry rule. If you want to hold messages for longer than the normal
14493 retry times, insert a dummy retry rule with a long retry time.
14494
14495
14496 .option host_lookup main "host list&!!" unset
14497 .cindex "host name" "lookup, forcing"
14498 Exim does not look up the name of a calling host from its IP address unless it
14499 is required to compare against some host list, or the host matches
14500 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14501 option (which normally contains IP addresses rather than host names). The
14502 default configuration file contains
14503 .code
14504 host_lookup = *
14505 .endd
14506 which causes a lookup to happen for all hosts. If the expense of these lookups
14507 is felt to be too great, the setting can be changed or removed.
14508
14509 After a successful reverse lookup, Exim does a forward lookup on the name it
14510 has obtained, to verify that it yields the IP address that it started with. If
14511 this check fails, Exim behaves as if the name lookup failed.
14512
14513 .vindex "&$host_lookup_failed$&"
14514 .vindex "&$sender_host_name$&"
14515 After any kind of failure, the host name (in &$sender_host_name$&) remains
14516 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14517 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14518 &`verify = reverse_host_lookup`& in ACLs.
14519
14520
14521 .option host_lookup_order main "string list" &`bydns:byaddr`&
14522 This option specifies the order of different lookup methods when Exim is trying
14523 to find a host name from an IP address. The default is to do a DNS lookup
14524 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14525 if that fails. You can change the order of these lookups, or omit one entirely,
14526 if you want.
14527
14528 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14529 multiple PTR records in the DNS and the IP address is not listed in
14530 &_/etc/hosts_&. Different operating systems give different results in this
14531 case. That is why the default tries a DNS lookup first.
14532
14533
14534
14535 .option host_reject_connection main "host list&!!" unset
14536 .cindex "host" "rejecting connections from"
14537 If this option is set, incoming SMTP calls from the hosts listed are rejected
14538 as soon as the connection is made.
14539 This option is obsolete, and retained only for backward compatibility, because
14540 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14541 connections immediately.
14542
14543 The ability to give an immediate rejection (either by this option or using an
14544 ACL) is provided for use in unusual cases. Many hosts will just try again,
14545 sometimes without much delay. Normally, it is better to use an ACL to reject
14546 incoming messages at a later stage, such as after RCPT commands. See
14547 chapter &<<CHAPACL>>&.
14548
14549
14550 .option hosts_connection_nolog main "host list&!!" unset
14551 .cindex "host" "not logging connections from"
14552 This option defines a list of hosts for which connection logging does not
14553 happen, even though the &%smtp_connection%& log selector is set. For example,
14554 you might want not to log SMTP connections from local processes, or from
14555 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14556 the daemon; you should therefore strive to restrict its value to a short inline
14557 list of IP addresses and networks. To disable logging SMTP connections from
14558 local processes, you must create a host list with an empty item. For example:
14559 .code
14560 hosts_connection_nolog = :
14561 .endd
14562 If the &%smtp_connection%& log selector is not set, this option has no effect.
14563
14564
14565
14566 .option hosts_treat_as_local main "domain list&!!" unset
14567 .cindex "local host" "domains treated as"
14568 .cindex "host" "treated as local"
14569 If this option is set, any host names that match the domain list are treated as
14570 if they were the local host when Exim is scanning host lists obtained from MX
14571 records
14572 or other sources. Note that the value of this option is a domain list, not a
14573 host list, because it is always used to check host names, not IP addresses.
14574
14575 This option also applies when Exim is matching the special items
14576 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14577 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14578 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14579 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14580 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14581 interfaces and recognizing the local host.
14582
14583
14584 .option ibase_servers main "string list" unset
14585 .cindex "InterBase" "server list"
14586 This option provides a list of InterBase servers and associated connection data,
14587 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14588 The option is available only if Exim has been built with InterBase support.
14589
14590
14591
14592 .option ignore_bounce_errors_after main time 10w
14593 .cindex "bounce message" "discarding"
14594 .cindex "discarding bounce message"
14595 This option affects the processing of bounce messages that cannot be delivered,
14596 that is, those that suffer a permanent delivery failure. (Bounce messages that
14597 suffer temporary delivery failures are of course retried in the usual way.)
14598
14599 After a permanent delivery failure, bounce messages are frozen,
14600 because there is no sender to whom they can be returned. When a frozen bounce
14601 message has been on the queue for more than the given time, it is unfrozen at
14602 the next queue run, and a further delivery is attempted. If delivery fails
14603 again, the bounce message is discarded. This makes it possible to keep failed
14604 bounce messages around for a shorter time than the normal maximum retry time
14605 for frozen messages. For example,
14606 .code
14607 ignore_bounce_errors_after = 12h
14608 .endd
14609 retries failed bounce message deliveries after 12 hours, discarding any further
14610 failures. If the value of this option is set to a zero time period, bounce
14611 failures are discarded immediately. Setting a very long time (as in the default
14612 value) has the effect of disabling this option. For ways of automatically
14613 dealing with other kinds of frozen message, see &%auto_thaw%& and
14614 &%timeout_frozen_after%&.
14615
14616
14617 .option ignore_fromline_hosts main "host list&!!" unset
14618 .cindex "&""From""& line"
14619 .cindex "UUCP" "&""From""& line"
14620 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14621 the headers of a message. By default this is treated as the start of the
14622 message's body, which means that any following headers are not recognized as
14623 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14624 match those hosts that insist on sending it. If the sender is actually a local
14625 process rather than a remote host, and is using &%-bs%& to inject the messages,
14626 &%ignore_fromline_local%& must be set to achieve this effect.
14627
14628
14629 .option ignore_fromline_local main boolean false
14630 See &%ignore_fromline_hosts%& above.
14631
14632
14633 .option keep_malformed main time 4d
14634 This option specifies the length of time to keep messages whose spool files
14635 have been corrupted in some way. This should, of course, never happen. At the
14636 next attempt to deliver such a message, it gets removed. The incident is
14637 logged.
14638
14639
14640 .option ldap_ca_cert_dir main string unset
14641 .cindex "LDAP", "TLS CA certificate directory"
14642 This option indicates which directory contains CA certificates for verifying
14643 a TLS certificate presented by an LDAP server.
14644 While Exim does not provide a default value, your SSL library may.
14645 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14646 and constrained to be a directory.
14647
14648
14649 .option ldap_ca_cert_file main string unset
14650 .cindex "LDAP", "TLS CA certificate file"
14651 This option indicates which file contains CA certificates for verifying
14652 a TLS certificate presented by an LDAP server.
14653 While Exim does not provide a default value, your SSL library may.
14654 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14655 and constrained to be a file.
14656
14657
14658 .option ldap_cert_file main string unset
14659 .cindex "LDAP" "TLS client certificate file"
14660 This option indicates which file contains an TLS client certificate which
14661 Exim should present to the LDAP server during TLS negotiation.
14662 Should be used together with &%ldap_cert_key%&.
14663
14664
14665 .option ldap_cert_key main string unset
14666 .cindex "LDAP" "TLS client key file"
14667 This option indicates which file contains the secret/private key to use
14668 to prove identity to the LDAP server during TLS negotiation.
14669 Should be used together with &%ldap_cert_file%&, which contains the
14670 identity to be proven.
14671
14672
14673 .option ldap_cipher_suite main string unset
14674 .cindex "LDAP" "TLS cipher suite"
14675 This controls the TLS cipher-suite negotiation during TLS negotiation with
14676 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14677 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14678
14679
14680 .option ldap_default_servers main "string list" unset
14681 .cindex "LDAP" "default servers"
14682 This option provides a list of LDAP servers which are tried in turn when an
14683 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14684 details of LDAP queries. This option is available only when Exim has been built
14685 with LDAP support.
14686
14687
14688 .option ldap_require_cert main string unset.
14689 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14690 This should be one of the values "hard", "demand", "allow", "try" or "never".
14691 A value other than one of these is interpreted as "never".
14692 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14693 Although Exim does not set a default, the LDAP library probably defaults
14694 to hard/demand.
14695
14696
14697 .option ldap_start_tls main boolean false
14698 .cindex "LDAP" "whether or not to negotiate TLS"
14699 If set, Exim will attempt to negotiate TLS with the LDAP server when
14700 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14701 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14702 of SSL-on-connect.
14703 In the event of failure to negotiate TLS, the action taken is controlled
14704 by &%ldap_require_cert%&.
14705
14706
14707 .option ldap_version main integer unset
14708 .cindex "LDAP" "protocol version, forcing"
14709 This option can be used to force Exim to set a specific protocol version for
14710 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14711 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14712 the LDAP headers; otherwise it is 2. This option is available only when Exim
14713 has been built with LDAP support.
14714
14715
14716
14717 .option local_from_check main boolean true
14718 .cindex "&'Sender:'& header line" "disabling addition of"
14719 .cindex "&'From:'& header line" "disabling checking of"
14720 When a message is submitted locally (that is, not over a TCP/IP connection) by
14721 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14722 checks that the &'From:'& header line matches the login of the calling user and
14723 the domain specified by &%qualify_domain%&.
14724
14725 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14726 locally submitted message is automatically qualified by Exim, unless the
14727 &%-bnq%& command line option is used.
14728
14729 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14730 on the local part. If the &'From:'& header line does not match, Exim adds a
14731 &'Sender:'& header with an address constructed from the calling user's login
14732 and the default qualify domain.
14733
14734 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14735 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14736 &'Sender:'& header lines supplied by untrusted users, you must also set
14737 &%local_sender_retain%& to be true.
14738
14739 .cindex "envelope sender"
14740 These options affect only the header lines in the message. The envelope sender
14741 is still forced to be the login id at the qualify domain unless
14742 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14743
14744 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14745 request similar header line checking. See section &<<SECTthesenhea>>&, which
14746 has more details about &'Sender:'& processing.
14747
14748
14749
14750
14751 .option local_from_prefix main string unset
14752 When Exim checks the &'From:'& header line of locally submitted messages for
14753 matching the login id (see &%local_from_check%& above), it can be configured to
14754 ignore certain prefixes and suffixes in the local part of the address. This is
14755 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14756 appropriate lists, in the same form as the &%local_part_prefix%& and
14757 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14758 example, if
14759 .code
14760 local_from_prefix = *-
14761 .endd
14762 is set, a &'From:'& line containing
14763 .code
14764 From: anything-user@your.domain.example
14765 .endd
14766 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14767 matches the actual sender address that is constructed from the login name and
14768 qualify domain.
14769
14770
14771 .option local_from_suffix main string unset
14772 See &%local_from_prefix%& above.
14773
14774
14775 .option local_interfaces main "string list" "see below"
14776 This option controls which network interfaces are used by the daemon for
14777 listening; they are also used to identify the local host when routing. Chapter
14778 &<<CHAPinterfaces>>& contains a full description of this option and the related
14779 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14780 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14781 &%local_interfaces%& is
14782 .code
14783 local_interfaces = 0.0.0.0
14784 .endd
14785 when Exim is built without IPv6 support; otherwise it is
14786 .code
14787 local_interfaces = <; ::0 ; 0.0.0.0
14788 .endd
14789
14790 .option local_scan_timeout main time 5m
14791 .cindex "timeout" "for &[local_scan()]& function"
14792 .cindex "&[local_scan()]& function" "timeout"
14793 This timeout applies to the &[local_scan()]& function (see chapter
14794 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14795 the incoming message is rejected with a temporary error if it is an SMTP
14796 message. For a non-SMTP message, the message is dropped and Exim ends with a
14797 non-zero code. The incident is logged on the main and reject logs.
14798
14799
14800
14801 .option local_sender_retain main boolean false
14802 .cindex "&'Sender:'& header line" "retaining from local submission"
14803 When a message is submitted locally (that is, not over a TCP/IP connection) by
14804 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14805 do not want this to happen, you must set &%local_sender_retain%&, and you must
14806 also set &%local_from_check%& to be false (Exim will complain if you do not).
14807 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14808 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14809
14810
14811
14812
14813 .option localhost_number main string&!! unset
14814 .cindex "host" "locally unique number for"
14815 .cindex "message ids" "with multiple hosts"
14816 .vindex "&$localhost_number$&"
14817 Exim's message ids are normally unique only within the local host. If
14818 uniqueness among a set of hosts is required, each host must set a different
14819 value for the &%localhost_number%& option. The string is expanded immediately
14820 after reading the configuration file (so that a number can be computed from the
14821 host name, for example) and the result of the expansion must be a number in the
14822 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14823 systems). This is available in subsequent string expansions via the variable
14824 &$localhost_number$&. When &%localhost_number is set%&, the final two
14825 characters of the message id, instead of just being a fractional part of the
14826 time, are computed from the time and the local host number as described in
14827 section &<<SECTmessiden>>&.
14828
14829
14830
14831 .option log_file_path main "string list&!!" "set at compile time"
14832 .cindex "log" "file path for"
14833 This option sets the path which is used to determine the names of Exim's log
14834 files, or indicates that logging is to be to syslog, or both. It is expanded
14835 when Exim is entered, so it can, for example, contain a reference to the host
14836 name. If no specific path is set for the log files at compile or run time, they
14837 are written in a sub-directory called &_log_& in Exim's spool directory.
14838 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14839 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14840 used. If this string is fixed at your installation (contains no expansion
14841 variables) it is recommended that you do not set this option in the
14842 configuration file, but instead supply the path using LOG_FILE_PATH in
14843 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14844 early on &-- in particular, failure to read the configuration file.
14845
14846
14847 .option log_selector main string unset
14848 .cindex "log" "selectors"
14849 This option can be used to reduce or increase the number of things that Exim
14850 writes to its log files. Its argument is made up of names preceded by plus or
14851 minus characters. For example:
14852 .code
14853 log_selector = +arguments -retry_defer
14854 .endd
14855 A list of possible names and what they control is given in the chapter on
14856 logging, in section &<<SECTlogselector>>&.
14857
14858
14859 .option log_timezone main boolean false
14860 .cindex "log" "timezone for entries"
14861 .vindex "&$tod_log$&"
14862 .vindex "&$tod_zone$&"
14863 By default, the timestamps on log lines are in local time without the
14864 timezone. This means that if your timezone changes twice a year, the timestamps
14865 in log lines are ambiguous for an hour when the clocks go back. One way of
14866 avoiding this problem is to set the timezone to UTC. An alternative is to set
14867 &%log_timezone%& true. This turns on the addition of the timezone offset to
14868 timestamps in log lines. Turning on this option can add quite a lot to the size
14869 of log files because each line is extended by 6 characters. Note that the
14870 &$tod_log$& variable contains the log timestamp without the zone, but there is
14871 another variable called &$tod_zone$& that contains just the timezone offset.
14872
14873
14874 .option lookup_open_max main integer 25
14875 .cindex "too many open files"
14876 .cindex "open files, too many"
14877 .cindex "file" "too many open"
14878 .cindex "lookup" "maximum open files"
14879 .cindex "limit" "open files for lookups"
14880 This option limits the number of simultaneously open files for single-key
14881 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14882 Exim normally keeps these files open during routing, because often the same
14883 file is required several times. If the limit is reached, Exim closes the least
14884 recently used file. Note that if you are using the &'ndbm'& library, it
14885 actually opens two files for each logical DBM database, though it still counts
14886 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14887 open files"& errors with NDBM, you need to reduce the value of
14888 &%lookup_open_max%&.
14889
14890
14891 .option max_username_length main integer 0
14892 .cindex "length of login name"
14893 .cindex "user name" "maximum length"
14894 .cindex "limit" "user name length"
14895 Some operating systems are broken in that they truncate long arguments to
14896 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14897 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14898 an argument that is longer behaves as if &[getpwnam()]& failed.
14899
14900
14901 .option message_body_newlines main bool false
14902 .cindex "message body" "newlines in variables"
14903 .cindex "newline" "in message body variables"
14904 .vindex "&$message_body$&"
14905 .vindex "&$message_body_end$&"
14906 By default, newlines in the message body are replaced by spaces when setting
14907 the &$message_body$& and &$message_body_end$& expansion variables. If this
14908 option is set true, this no longer happens.
14909
14910
14911 .option message_body_visible main integer 500
14912 .cindex "body of message" "visible size"
14913 .cindex "message body" "visible size"
14914 .vindex "&$message_body$&"
14915 .vindex "&$message_body_end$&"
14916 This option specifies how much of a message's body is to be included in the
14917 &$message_body$& and &$message_body_end$& expansion variables.
14918
14919
14920 .option message_id_header_domain main string&!! unset
14921 .cindex "&'Message-ID:'& header line"
14922 If this option is set, the string is expanded and used as the right hand side
14923 (domain) of the &'Message-ID:'& header that Exim creates if a
14924 locally-originated incoming message does not have one. &"Locally-originated"&
14925 means &"not received over TCP/IP."&
14926 Otherwise, the primary host name is used.
14927 Only letters, digits, dot and hyphen are accepted; any other characters are
14928 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14929 empty string, the option is ignored.
14930
14931
14932 .option message_id_header_text main string&!! unset
14933 If this variable is set, the string is expanded and used to augment the text of
14934 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14935 message does not have one. The text of this header is required by RFC 2822 to
14936 take the form of an address. By default, Exim uses its internal message id as
14937 the local part, and the primary host name as the domain. If this option is set,
14938 it is expanded, and provided the expansion is not forced to fail, and does not
14939 yield an empty string, the result is inserted into the header immediately
14940 before the @, separated from the internal message id by a dot. Any characters
14941 that are illegal in an address are automatically converted into hyphens. This
14942 means that variables such as &$tod_log$& can be used, because the spaces and
14943 colons will become hyphens.
14944
14945
14946 .option message_logs main boolean true
14947 .cindex "message logs" "disabling"
14948 .cindex "log" "message log; disabling"
14949 If this option is turned off, per-message log files are not created in the
14950 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14951 Exim, by reducing the number of files involved in handling a message from a
14952 minimum of four (header spool file, body spool file, delivery journal, and
14953 per-message log) to three. The other major I/O activity is Exim's main log,
14954 which is not affected by this option.
14955
14956
14957 .option message_size_limit main string&!! 50M
14958 .cindex "message" "size limit"
14959 .cindex "limit" "message size"
14960 .cindex "size" "of message, limit"
14961 This option limits the maximum size of message that Exim will process. The
14962 value is expanded for each incoming connection so, for example, it can be made
14963 to depend on the IP address of the remote host for messages arriving via
14964 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14965 optionally followed by K or M.
14966
14967 &*Note*&: This limit cannot be made to depend on a message's sender or any
14968 other properties of an individual message, because it has to be advertised in
14969 the server's response to EHLO. String expansion failure causes a temporary
14970 error. A value of zero means no limit, but its use is not recommended. See also
14971 &%bounce_return_size_limit%&.
14972
14973 Incoming SMTP messages are failed with a 552 error if the limit is
14974 exceeded; locally-generated messages either get a stderr message or a delivery
14975 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14976 an oversized message is logged in both the main and the reject logs. See also
14977 the generic transport option &%message_size_limit%&, which limits the size of
14978 message that an individual transport can process.
14979
14980 If you use a virus-scanner and set this option to to a value larger than the
14981 maximum size that your virus-scanner is configured to support, you may get
14982 failures triggered by large mails.  The right size to configure for the
14983 virus-scanner depends upon what data is passed and the options in use but it's
14984 probably safest to just set it to a little larger than this value.  Eg, with a
14985 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14986 some problems may result.
14987
14988 A value of 0 will disable size limit checking; Exim will still advertise the
14989 SIZE extension in an EHLO response, but without a limit, so as to permit
14990 SMTP clients to still indicate the message size along with the MAIL verb.
14991
14992
14993 .option move_frozen_messages main boolean false
14994 .cindex "frozen messages" "moving"
14995 This option, which is available only if Exim has been built with the setting
14996 .code
14997 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14998 .endd
14999 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15000 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15001 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15002 standard utilities for handling such moved messages, and they do not show up in
15003 lists generated by &%-bp%& or by the Exim monitor.
15004
15005
15006 .option mua_wrapper main boolean false
15007 Setting this option true causes Exim to run in a very restrictive mode in which
15008 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15009 contains a full description of this facility.
15010
15011
15012
15013 .option mysql_servers main "string list" unset
15014 .cindex "MySQL" "server list"
15015 This option provides a list of MySQL servers and associated connection data, to
15016 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15017 option is available only if Exim has been built with MySQL support.
15018
15019
15020 .option never_users main "string list&!!" unset
15021 This option is expanded just once, at the start of Exim's processing. Local
15022 message deliveries are normally run in processes that are setuid to the
15023 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15024 It is usually desirable to prevent any deliveries from running as root, as a
15025 safety precaution.
15026
15027 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15028 list of users that must not be used for local deliveries. This list is fixed in
15029 the binary and cannot be overridden by the configuration file. By default, it
15030 contains just the single user name &"root"&. The &%never_users%& runtime option
15031 can be used to add more users to the fixed list.
15032
15033 If a message is to be delivered as one of the users on the fixed list or the
15034 &%never_users%& list, an error occurs, and delivery is deferred. A common
15035 example is
15036 .code
15037 never_users = root:daemon:bin
15038 .endd
15039 Including root is redundant if it is also on the fixed list, but it does no
15040 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15041 transport driver.
15042
15043
15044 .option openssl_options main "string list" "+no_sslv2"
15045 .cindex "OpenSSL "compatibility options"
15046 This option allows an administrator to adjust the SSL options applied
15047 by OpenSSL to connections.  It is given as a space-separated list of items,
15048 each one to be +added or -subtracted from the current value.
15049
15050 This option is only available if Exim is built against OpenSSL.  The values
15051 available for this option vary according to the age of your OpenSSL install.
15052 The &"all"& value controls a subset of flags which are available, typically
15053 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15054 list the values known on your system and Exim should support all the
15055 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15056 names lose the leading &"SSL_OP_"& and are lower-cased.
15057
15058 Note that adjusting the options can have severe impact upon the security of
15059 SSL as used by Exim.  It is possible to disable safety checks and shoot
15060 yourself in the foot in various unpleasant ways.  This option should not be
15061 adjusted lightly.  An unrecognised item will be detected at startup, by
15062 invoking Exim with the &%-bV%& flag.
15063
15064 The option affects Exim operating both as a server and as a client.
15065
15066 Historical note: prior to release 4.80, Exim defaulted this value to
15067 "+dont_insert_empty_fragments", which may still be needed for compatibility
15068 with some clients, but which lowers security by increasing exposure to
15069 some now infamous attacks.
15070
15071 Examples:
15072 .code
15073 # Make both old MS and old Eudora happy:
15074 openssl_options = -all +microsoft_big_sslv3_buffer \
15075                        +dont_insert_empty_fragments
15076
15077 # Disable older protocol versions:
15078 openssl_options = +no_sslv2 +no_sslv3
15079 .endd
15080
15081 Possible options may include:
15082 .ilist
15083 &`all`&
15084 .next
15085 &`allow_unsafe_legacy_renegotiation`&
15086 .next
15087 &`cipher_server_preference`&
15088 .next
15089 &`dont_insert_empty_fragments`&
15090 .next
15091 &`ephemeral_rsa`&
15092 .next
15093 &`legacy_server_connect`&
15094 .next
15095 &`microsoft_big_sslv3_buffer`&
15096 .next
15097 &`microsoft_sess_id_bug`&
15098 .next
15099 &`msie_sslv2_rsa_padding`&
15100 .next
15101 &`netscape_challenge_bug`&
15102 .next
15103 &`netscape_reuse_cipher_change_bug`&
15104 .next
15105 &`no_compression`&
15106 .next
15107 &`no_session_resumption_on_renegotiation`&
15108 .next
15109 &`no_sslv2`&
15110 .next
15111 &`no_sslv3`&
15112 .next
15113 &`no_ticket`&
15114 .next
15115 &`no_tlsv1`&
15116 .next
15117 &`no_tlsv1_1`&
15118 .next
15119 &`no_tlsv1_2`&
15120 .next
15121 &`safari_ecdhe_ecdsa_bug`&
15122 .next
15123 &`single_dh_use`&
15124 .next
15125 &`single_ecdh_use`&
15126 .next
15127 &`ssleay_080_client_dh_bug`&
15128 .next
15129 &`sslref2_reuse_cert_type_bug`&
15130 .next
15131 &`tls_block_padding_bug`&
15132 .next
15133 &`tls_d5_bug`&
15134 .next
15135 &`tls_rollback_bug`&
15136 .endlist
15137
15138 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15139 all clients connecting using the MacOS SecureTransport TLS facility prior
15140 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15141 to negotiate TLS then this option value might help, provided that your OpenSSL
15142 release is new enough to contain this work-around.  This may be a situation
15143 where you have to upgrade OpenSSL to get buggy clients working.
15144
15145
15146 .option oracle_servers main "string list" unset
15147 .cindex "Oracle" "server list"
15148 This option provides a list of Oracle servers and associated connection data,
15149 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15150 The option is available only if Exim has been built with Oracle support.
15151
15152
15153 .option percent_hack_domains main "domain list&!!" unset
15154 .cindex "&""percent hack""&"
15155 .cindex "source routing" "in email address"
15156 .cindex "address" "source-routed"
15157 The &"percent hack"& is the convention whereby a local part containing a
15158 percent sign is re-interpreted as a new email address, with the percent
15159 replaced by @. This is sometimes called &"source routing"&, though that term is
15160 also applied to RFC 2822 addresses that begin with an @ character. If this
15161 option is set, Exim implements the percent facility for those domains listed,
15162 but no others. This happens before an incoming SMTP address is tested against
15163 an ACL.
15164
15165 &*Warning*&: The &"percent hack"& has often been abused by people who are
15166 trying to get round relaying restrictions. For this reason, it is best avoided
15167 if at all possible. Unfortunately, a number of less security-conscious MTAs
15168 implement it unconditionally. If you are running Exim on a gateway host, and
15169 routing mail through to internal MTAs without processing the local parts, it is
15170 a good idea to reject recipient addresses with percent characters in their
15171 local parts. Exim's default configuration does this.
15172
15173
15174 .option perl_at_start main boolean false
15175 This option is available only when Exim is built with an embedded Perl
15176 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15177
15178
15179 .option perl_startup main string unset
15180 This option is available only when Exim is built with an embedded Perl
15181 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15182
15183
15184 .option pgsql_servers main "string list" unset
15185 .cindex "PostgreSQL lookup type" "server list"
15186 This option provides a list of PostgreSQL servers and associated connection
15187 data, to be used in conjunction with &(pgsql)& lookups (see section
15188 &<<SECID72>>&). The option is available only if Exim has been built with
15189 PostgreSQL support.
15190
15191
15192 .option pid_file_path main string&!! "set at compile time"
15193 .cindex "daemon" "pid file path"
15194 .cindex "pid file, path for"
15195 This option sets the name of the file to which the Exim daemon writes its
15196 process id. The string is expanded, so it can contain, for example, references
15197 to the host name:
15198 .code
15199 pid_file_path = /var/log/$primary_hostname/exim.pid
15200 .endd
15201 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15202 spool directory.
15203 The value set by the option can be overridden by the &%-oP%& command line
15204 option. A pid file is not written if a &"non-standard"& daemon is run by means
15205 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15206
15207
15208 .option pipelining_advertise_hosts main "host list&!!" *
15209 .cindex "PIPELINING" "suppressing advertising"
15210 This option can be used to suppress the advertisement of the SMTP
15211 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15212 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15213 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15214 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15215 that clients will use it; &"out of order"& commands that are &"expected"& do
15216 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15217
15218
15219 .option prdr_enable main boolean false
15220 .cindex "PRDR" "enabling on server"
15221 This option can be used to enable the Per-Recipient Data Response extension
15222 to SMTP, defined by Eric Hall.
15223 If the option is set, PRDR is advertised by Exim when operating as a server.
15224 If the client requests PRDR, and more than one recipient, for a message 
15225 an additional ACL is called for each recipient after the message content
15226 is recieved.  See section &<<SECTPRDRACL>>&.
15227
15228 .option preserve_message_logs main boolean false
15229 .cindex "message logs" "preserving"
15230 If this option is set, message log files are not deleted when messages are
15231 completed. Instead, they are moved to a sub-directory of the spool directory
15232 called &_msglog.OLD_&, where they remain available for statistical or debugging
15233 purposes. This is a dangerous option to set on systems with any appreciable
15234 volume of mail. Use with care!
15235
15236
15237 .option primary_hostname main string "see below"
15238 .cindex "name" "of local host"
15239 .cindex "host" "name of local"
15240 .cindex "local host" "name of"
15241 .vindex "&$primary_hostname$&"
15242 This specifies the name of the current host. It is used in the default EHLO or
15243 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15244 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15245 The value is also used by default in some SMTP response messages from an Exim
15246 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15247
15248 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15249 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15250 contains only one component, Exim passes it to &[gethostbyname()]& (or
15251 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15252 version. The variable &$primary_hostname$& contains the host name, whether set
15253 explicitly by this option, or defaulted.
15254
15255
15256 .option print_topbitchars main boolean false
15257 .cindex "printing characters"
15258 .cindex "8-bit characters"
15259 By default, Exim considers only those characters whose codes lie in the range
15260 32&--126 to be printing characters. In a number of circumstances (for example,
15261 when writing log entries) non-printing characters are converted into escape
15262 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15263 is set, code values of 128 and above are also considered to be printing
15264 characters.
15265
15266 This option also affects the header syntax checks performed by the
15267 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15268 the user's full name when constructing From: and Sender: addresses (as
15269 described in section &<<SECTconstr>>&). Setting this option can cause
15270 Exim to generate eight bit message headers that do not conform to the
15271 standards.
15272
15273
15274 .option process_log_path main string unset
15275 .cindex "process log path"
15276 .cindex "log" "process log"
15277 .cindex "&'exiwhat'&"
15278 This option sets the name of the file to which an Exim process writes its
15279 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15280 utility script. If this option is unset, the file called &_exim-process.info_&
15281 in Exim's spool directory is used. The ability to specify the name explicitly
15282 can be useful in environments where two different Exims are running, using
15283 different spool directories.
15284
15285
15286 .option prod_requires_admin main boolean true
15287 .oindex "&%-M%&"
15288 .oindex "&%-R%&"
15289 .oindex "&%-q%&"
15290 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15291 admin user unless &%prod_requires_admin%& is set false. See also
15292 &%queue_list_requires_admin%&.
15293
15294
15295 .option qualify_domain main string "see below"
15296 .cindex "domain" "for qualifying addresses"
15297 .cindex "address" "qualification"
15298 This option specifies the domain name that is added to any envelope sender
15299 addresses that do not have a domain qualification. It also applies to
15300 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15301 are accepted by default only for locally-generated messages. Qualification is
15302 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15303 locally-generated messages, unless the &%-bnq%& command line option is used.
15304
15305 Messages from external sources must always contain fully qualified addresses,
15306 unless the sending host matches &%sender_unqualified_hosts%& or
15307 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15308 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15309 necessary. Internally, Exim always works with fully qualified envelope
15310 addresses. If &%qualify_domain%& is not set, it defaults to the
15311 &%primary_hostname%& value.
15312
15313
15314 .option qualify_recipient main string "see below"
15315 This option allows you to specify a different domain for qualifying recipient
15316 addresses to the one that is used for senders. See &%qualify_domain%& above.
15317
15318
15319
15320 .option queue_domains main "domain list&!!" unset
15321 .cindex "domain" "specifying non-immediate delivery"
15322 .cindex "queueing incoming messages"
15323 .cindex "message" "queueing certain domains"
15324 This option lists domains for which immediate delivery is not required.
15325 A delivery process is started whenever a message is received, but only those
15326 domains that do not match are processed. All other deliveries wait until the
15327 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15328
15329
15330 .option queue_list_requires_admin main boolean true
15331 .oindex "&%-bp%&"
15332 The &%-bp%& command-line option, which lists the messages that are on the
15333 queue, requires the caller to be an admin user unless
15334 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15335
15336
15337 .option queue_only main boolean false
15338 .cindex "queueing incoming messages"
15339 .cindex "message" "queueing unconditionally"
15340 If &%queue_only%& is set, a delivery process is not automatically started
15341 whenever a message is received. Instead, the message waits on the queue for the
15342 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15343 delivered immediately when certain conditions (such as heavy load) occur.
15344
15345 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15346 and &%-odi%& command line options override &%queue_only%& unless
15347 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15348 &%queue_only_load%&, and &%smtp_accept_queue%&.
15349
15350
15351 .option queue_only_file main string unset
15352 .cindex "queueing incoming messages"
15353 .cindex "message" "queueing by file existence"
15354 This option can be set to a colon-separated list of absolute path names, each
15355 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15356 it tests for the existence of each listed path using a call to &[stat()]&. For
15357 each path that exists, the corresponding queueing option is set.
15358 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15359 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15360 .code
15361 queue_only_file = smtp/some/file
15362 .endd
15363 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15364 &_/some/file_& exists.
15365
15366
15367 .option queue_only_load main fixed-point unset
15368 .cindex "load average"
15369 .cindex "queueing incoming messages"
15370 .cindex "message" "queueing by load"
15371 If the system load average is higher than this value, incoming messages from
15372 all sources are queued, and no automatic deliveries are started. If this
15373 happens during local or remote SMTP input, all subsequent messages received on
15374 the same SMTP connection are queued by default, whatever happens to the load in
15375 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15376 false.
15377
15378 Deliveries will subsequently be performed by queue runner processes. This
15379 option has no effect on ancient operating systems on which Exim cannot
15380 determine the load average. See also &%deliver_queue_load_max%& and
15381 &%smtp_load_reserve%&.
15382
15383
15384 .option queue_only_load_latch main boolean true
15385 .cindex "load average" "re-evaluating per message"
15386 When this option is true (the default), once one message has been queued
15387 because the load average is higher than the value set by &%queue_only_load%&,
15388 all subsequent messages received on the same SMTP connection are also queued.
15389 This is a deliberate choice; even though the load average may fall below the
15390 threshold, it doesn't seem right to deliver later messages on the same
15391 connection when not delivering earlier ones. However, there are special
15392 circumstances such as very long-lived connections from scanning appliances
15393 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15394 should be set false. This causes the value of the load average to be
15395 re-evaluated for each message.
15396
15397
15398 .option queue_only_override main boolean true
15399 .cindex "queueing incoming messages"
15400 When this option is true, the &%-od%&&'x'& command line options override the
15401 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15402 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15403 to override; they are accepted, but ignored.
15404
15405
15406 .option queue_run_in_order main boolean false
15407 .cindex "queue runner" "processing messages in order"
15408 If this option is set, queue runs happen in order of message arrival instead of
15409 in an arbitrary order. For this to happen, a complete list of the entire queue
15410 must be set up before the deliveries start. When the queue is all held in a
15411 single directory (the default), a single list is created for both the ordered
15412 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15413 single list is not created when &%queue_run_in_order%& is false. In this case,
15414 the sub-directories are processed one at a time (in a random order), and this
15415 avoids setting up one huge list for the whole queue. Thus, setting
15416 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15417 when the queue is large, because of the extra work in setting up the single,
15418 large list. In most situations, &%queue_run_in_order%& should not be set.
15419
15420
15421
15422 .option queue_run_max main integer 5
15423 .cindex "queue runner" "maximum number of"
15424 This controls the maximum number of queue runner processes that an Exim daemon
15425 can run simultaneously. This does not mean that it starts them all at once,
15426 but rather that if the maximum number are still running when the time comes to
15427 start another one, it refrains from starting another one. This can happen with
15428 very large queues and/or very sluggish deliveries. This option does not,
15429 however, interlock with other processes, so additional queue runners can be
15430 started by other means, or by killing and restarting the daemon.
15431
15432 Setting this option to zero does not suppress queue runs; rather, it disables
15433 the limit, allowing any number of simultaneous queue runner processes to be
15434 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15435 the daemon's command line.
15436
15437 .option queue_smtp_domains main "domain list&!!" unset
15438 .cindex "queueing incoming messages"
15439 .cindex "message" "queueing remote deliveries"
15440 When this option is set, a delivery process is started whenever a message is
15441 received, routing is performed, and local deliveries take place.
15442 However, if any SMTP deliveries are required for domains that match
15443 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15444 message waits on the queue for the next queue run. Since routing of the message
15445 has taken place, Exim knows to which remote hosts it must be delivered, and so
15446 when the queue run happens, multiple messages for the same host are delivered
15447 over a single SMTP connection. The &%-odqs%& command line option causes all
15448 SMTP deliveries to be queued in this way, and is equivalent to setting
15449 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15450 &%queue_domains%&.
15451
15452
15453 .option receive_timeout main time 0s
15454 .cindex "timeout" "for non-SMTP input"
15455 This option sets the timeout for accepting a non-SMTP message, that is, the
15456 maximum time that Exim waits when reading a message on the standard input. If
15457 the value is zero, it will wait for ever. This setting is overridden by the
15458 &%-or%& command line option. The timeout for incoming SMTP messages is
15459 controlled by &%smtp_receive_timeout%&.
15460
15461 .option received_header_text main string&!! "see below"
15462 .cindex "customizing" "&'Received:'& header"
15463 .cindex "&'Received:'& header line" "customizing"
15464 This string defines the contents of the &'Received:'& message header that is
15465 added to each message, except for the timestamp, which is automatically added
15466 on at the end (preceded by a semicolon). The string is expanded each time it is
15467 used. If the expansion yields an empty string, no &'Received:'& header line is
15468 added to the message. Otherwise, the string should start with the text
15469 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15470 header lines. The default setting is:
15471
15472 .code
15473 received_header_text = Received: \
15474   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15475   {${if def:sender_ident \
15476   {from ${quote_local_part:$sender_ident} }}\
15477   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15478   by $primary_hostname \
15479   ${if def:received_protocol {with $received_protocol}} \
15480   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15481   (Exim $version_number)\n\t\
15482   ${if def:sender_address \
15483   {(envelope-from <$sender_address>)\n\t}}\
15484   id $message_exim_id\
15485   ${if def:received_for {\n\tfor $received_for}}
15486 .endd
15487
15488 The reference to the TLS cipher is omitted when Exim is built without TLS
15489 support. The use of conditional expansions ensures that this works for both
15490 locally generated messages and messages received from remote hosts, giving
15491 header lines such as the following:
15492 .code
15493 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15494 by marley.carol.example with esmtp (Exim 4.00)
15495 (envelope-from <bob@carol.example>)
15496 id 16IOWa-00019l-00
15497 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15498 Received: by scrooge.carol.example with local (Exim 4.00)
15499 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15500 .endd
15501 Until the body of the message has been received, the timestamp is the time when
15502 the message started to be received. Once the body has arrived, and all policy
15503 checks have taken place, the timestamp is updated to the time at which the
15504 message was accepted.
15505
15506
15507 .option received_headers_max main integer 30
15508 .cindex "loop" "prevention"
15509 .cindex "mail loop prevention"
15510 .cindex "&'Received:'& header line" "counting"
15511 When a message is to be delivered, the number of &'Received:'& headers is
15512 counted, and if it is greater than this parameter, a mail loop is assumed to
15513 have occurred, the delivery is abandoned, and an error message is generated.
15514 This applies to both local and remote deliveries.
15515
15516
15517 .option recipient_unqualified_hosts main "host list&!!" unset
15518 .cindex "unqualified addresses"
15519 .cindex "host" "unqualified addresses from"
15520 This option lists those hosts from which Exim is prepared to accept unqualified
15521 recipient addresses in message envelopes. The addresses are made fully
15522 qualified by the addition of the &%qualify_recipient%& value. This option also
15523 affects message header lines. Exim does not reject unqualified recipient
15524 addresses in headers, but it qualifies them only if the message came from a
15525 host that matches &%recipient_unqualified_hosts%&,
15526 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15527 option was not set.
15528
15529
15530 .option recipients_max main integer 0
15531 .cindex "limit" "number of recipients"
15532 .cindex "recipient" "maximum number"
15533 If this option is set greater than zero, it specifies the maximum number of
15534 original recipients for any message. Additional recipients that are generated
15535 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15536 all recipients over the limit; earlier recipients are delivered as normal.
15537 Non-SMTP messages with too many recipients are failed, and no deliveries are
15538 done.
15539
15540 .cindex "RCPT" "maximum number of incoming"
15541 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15542 RCPT commands in a single message.
15543
15544
15545 .option recipients_max_reject main boolean false
15546 If this option is set true, Exim rejects SMTP messages containing too many
15547 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15548 error to the eventual DATA command. Otherwise (the default) it gives a 452
15549 error to the surplus RCPT commands and accepts the message on behalf of the
15550 initial set of recipients. The remote server should then re-send the message
15551 for the remaining recipients at a later time.
15552
15553
15554 .option remote_max_parallel main integer 2
15555 .cindex "delivery" "parallelism for remote"
15556 This option controls parallel delivery of one message to a number of remote
15557 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15558 does all the remote deliveries for a message one by one. Otherwise, if a single
15559 message has to be delivered to more than one remote host, or if several copies
15560 have to be sent to the same remote host, up to &%remote_max_parallel%&
15561 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15562 deliveries are required, the maximum number of processes are started, and as
15563 each one finishes, another is begun. The order of starting processes is the
15564 same as if sequential delivery were being done, and can be controlled by the
15565 &%remote_sort_domains%& option. If parallel delivery takes place while running
15566 with debugging turned on, the debugging output from each delivery process is
15567 tagged with its process id.
15568
15569 This option controls only the maximum number of parallel deliveries for one
15570 message in one Exim delivery process. Because Exim has no central queue
15571 manager, there is no way of controlling the total number of simultaneous
15572 deliveries if the configuration allows a delivery attempt as soon as a message
15573 is received.
15574
15575 .cindex "number of deliveries"
15576 .cindex "delivery" "maximum number of"
15577 If you want to control the total number of deliveries on the system, you
15578 need to set the &%queue_only%& option. This ensures that all incoming messages
15579 are added to the queue without starting a delivery process. Then set up an Exim
15580 daemon to start queue runner processes at appropriate intervals (probably
15581 fairly often, for example, every minute), and limit the total number of queue
15582 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15583 delivers only one message at a time, the maximum number of deliveries that can
15584 then take place at once is &%queue_run_max%& multiplied by
15585 &%remote_max_parallel%&.
15586
15587 If it is purely remote deliveries you want to control, use
15588 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15589 doing the SMTP routing before queueing, so that several messages for the same
15590 host will eventually get delivered down the same connection.
15591
15592
15593 .option remote_sort_domains main "domain list&!!" unset
15594 .cindex "sorting remote deliveries"
15595 .cindex "delivery" "sorting remote"
15596 When there are a number of remote deliveries for a message, they are sorted by
15597 domain into the order given by this list. For example,
15598 .code
15599 remote_sort_domains = *.cam.ac.uk:*.uk
15600 .endd
15601 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15602 then to those in the &%uk%& domain, then to any others.
15603
15604
15605 .option retry_data_expire main time 7d
15606 .cindex "hints database" "data expiry"
15607 This option sets a &"use before"& time on retry information in Exim's hints
15608 database. Any older retry data is ignored. This means that, for example, once a
15609 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15610 past failures.
15611
15612
15613 .option retry_interval_max main time 24h
15614 .cindex "retry" "limit on interval"
15615 .cindex "limit" "on retry interval"
15616 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15617 intervals between delivery attempts for messages that cannot be delivered
15618 straight away. This option sets an overall limit to the length of time between
15619 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15620 the default value.
15621
15622
15623 .option return_path_remove main boolean true
15624 .cindex "&'Return-path:'& header line" "removing"
15625 RFC 2821, section 4.4, states that an SMTP server must insert a
15626 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15627 The &'Return-path:'& header preserves the sender address as received in the
15628 MAIL command. This description implies that this header should not be present
15629 in an incoming message. If &%return_path_remove%& is true, any existing
15630 &'Return-path:'& headers are removed from messages at the time they are
15631 received. Exim's transports have options for adding &'Return-path:'& headers at
15632 the time of delivery. They are normally used only for final local deliveries.
15633
15634
15635 .option return_size_limit main integer 100K
15636 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15637
15638
15639 .option rfc1413_hosts main "host list&!!" *
15640 .cindex "RFC 1413"
15641 .cindex "host" "for RFC 1413 calls"
15642 RFC 1413 identification calls are made to any client host which matches an item
15643 in the list.
15644
15645 .option rfc1413_query_timeout main time 5s
15646 .cindex "RFC 1413" "query timeout"
15647 .cindex "timeout" "for RFC 1413 call"
15648 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15649 no RFC 1413 calls are ever made.
15650
15651
15652 .option sender_unqualified_hosts main "host list&!!" unset
15653 .cindex "unqualified addresses"
15654 .cindex "host" "unqualified addresses from"
15655 This option lists those hosts from which Exim is prepared to accept unqualified
15656 sender addresses. The addresses are made fully qualified by the addition of
15657 &%qualify_domain%&. This option also affects message header lines. Exim does
15658 not reject unqualified addresses in headers that contain sender addresses, but
15659 it qualifies them only if the message came from a host that matches
15660 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15661 using TCP/IP), and the &%-bnq%& option was not set.
15662
15663
15664 .option smtp_accept_keepalive main boolean true
15665 .cindex "keepalive" "on incoming connection"
15666 This option controls the setting of the SO_KEEPALIVE option on incoming
15667 TCP/IP socket connections. When set, it causes the kernel to probe idle
15668 connections periodically, by sending packets with &"old"& sequence numbers. The
15669 other end of the connection should send an acknowledgment if the connection is
15670 still okay or a reset if the connection has been aborted. The reason for doing
15671 this is that it has the beneficial effect of freeing up certain types of
15672 connection that can get stuck when the remote host is disconnected without
15673 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15674 hours to detect unreachable hosts.
15675
15676
15677
15678 .option smtp_accept_max main integer 20
15679 .cindex "limit" "incoming SMTP connections"
15680 .cindex "SMTP" "incoming connection count"
15681 .cindex "inetd"
15682 This option specifies the maximum number of simultaneous incoming SMTP calls
15683 that Exim will accept. It applies only to the listening daemon; there is no
15684 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15685 value is set to zero, no limit is applied. However, it is required to be
15686 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15687 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15688
15689 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15690 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15691 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15692 and &%smtp_load_reserve%& are then checked before accepting the connection.
15693
15694
15695 .option smtp_accept_max_nonmail main integer 10
15696 .cindex "limit" "non-mail SMTP commands"
15697 .cindex "SMTP" "limiting non-mail commands"
15698 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15699 the connection if there are too many. This option defines &"too many"&. The
15700 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15701 client looping sending EHLO, for example. The check is applied only if the
15702 client host matches &%smtp_accept_max_nonmail_hosts%&.
15703
15704 When a new message is expected, one occurrence of RSET is not counted. This
15705 allows a client to send one RSET between messages (this is not necessary,
15706 but some clients do it). Exim also allows one uncounted occurrence of HELO
15707 or EHLO, and one occurrence of STARTTLS between messages. After
15708 starting up a TLS session, another EHLO is expected, and so it too is not
15709 counted. The first occurrence of AUTH in a connection, or immediately
15710 following STARTTLS is not counted. Otherwise, all commands other than
15711 MAIL, RCPT, DATA, and QUIT are counted.
15712
15713
15714 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15715 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15716 check by setting this option. The default value makes it apply to all hosts. By
15717 changing the value, you can exclude any badly-behaved hosts that you have to
15718 live with.
15719
15720
15721 . Allow this long option name to split; give it unsplit as a fifth argument
15722 . for the automatic .oindex that is generated by .option.
15723 . We insert " &~&~" which is both pretty nasty visually and results in
15724 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15725 . zero-width-space, which would be nicer visually and results in (at least)
15726 . html that Firefox will split on when it's forced to reflow (rather than
15727 . inserting a horizontal scrollbar).  However, the text is still not
15728 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15729 . the option name to split.
15730
15731 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15732          smtp_accept_max_per_connection
15733 .cindex "SMTP" "limiting incoming message count"
15734 .cindex "limit" "messages per SMTP connection"
15735 The value of this option limits the number of MAIL commands that Exim is
15736 prepared to accept over a single SMTP connection, whether or not each command
15737 results in the transfer of a message. After the limit is reached, a 421
15738 response is given to subsequent MAIL commands. This limit is a safety
15739 precaution against a client that goes mad (incidents of this type have been
15740 seen).
15741
15742
15743 .option smtp_accept_max_per_host main string&!! unset
15744 .cindex "limit" "SMTP connections from one host"
15745 .cindex "host" "limiting SMTP connections from"
15746 This option restricts the number of simultaneous IP connections from a single
15747 host (strictly, from a single IP address) to the Exim daemon. The option is
15748 expanded, to enable different limits to be applied to different hosts by
15749 reference to &$sender_host_address$&. Once the limit is reached, additional
15750 connection attempts from the same host are rejected with error code 421. This
15751 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15752 of zero imposes no limit. If this option is set greater than zero, it is
15753 required that &%smtp_accept_max%& be non-zero.
15754
15755 &*Warning*&: When setting this option you should not use any expansion
15756 constructions that take an appreciable amount of time. The expansion and test
15757 happen in the main daemon loop, in order to reject additional connections
15758 without forking additional processes (otherwise a denial-of-service attack
15759 could cause a vast number or processes to be created). While the daemon is
15760 doing this processing, it cannot accept any other incoming connections.
15761
15762
15763
15764 .option smtp_accept_queue main integer 0
15765 .cindex "SMTP" "incoming connection count"
15766 .cindex "queueing incoming messages"
15767 .cindex "message" "queueing by SMTP connection count"
15768 If the number of simultaneous incoming SMTP connections being handled via the
15769 listening daemon exceeds this value, messages received by SMTP are just placed
15770 on the queue; no delivery processes are started automatically. The count is
15771 fixed at the start of an SMTP connection. It cannot be updated in the
15772 subprocess that receives messages, and so the queueing or not queueing applies
15773 to all messages received in the same connection.
15774
15775 A value of zero implies no limit, and clearly any non-zero value is useful only
15776 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15777 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15778 various &%-od%&&'x'& command line options.
15779
15780
15781 . See the comment on smtp_accept_max_per_connection
15782
15783 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15784          smtp_accept_queue_per_connection
15785 .cindex "queueing incoming messages"
15786 .cindex "message" "queueing by message count"
15787 This option limits the number of delivery processes that Exim starts
15788 automatically when receiving messages via SMTP, whether via the daemon or by
15789 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15790 and the number of messages received in a single SMTP session exceeds this
15791 number, subsequent messages are placed on the queue, but no delivery processes
15792 are started. This helps to limit the number of Exim processes when a server
15793 restarts after downtime and there is a lot of mail waiting for it on other
15794 systems. On large systems, the default should probably be increased, and on
15795 dial-in client systems it should probably be set to zero (that is, disabled).
15796
15797
15798 .option smtp_accept_reserve main integer 0
15799 .cindex "SMTP" "incoming call count"
15800 .cindex "host" "reserved"
15801 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15802 number of SMTP connections that are reserved for connections from the hosts
15803 that are specified in &%smtp_reserve_hosts%&. The value set in
15804 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15805 restricted to this number of connections; the option specifies a minimum number
15806 of connection slots for them, not a maximum. It is a guarantee that this group
15807 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15808 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15809 individual host.
15810
15811 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15812 set to 5, once there are 45 active connections (from any hosts), new
15813 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15814 provided the other criteria for acceptance are met.
15815
15816
15817 .option smtp_active_hostname main string&!! unset
15818 .cindex "host" "name in SMTP responses"
15819 .cindex "SMTP" "host name in responses"
15820 .vindex "&$primary_hostname$&"
15821 This option is provided for multi-homed servers that want to masquerade as
15822 several different hosts. At the start of an incoming SMTP connection, its value
15823 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15824 responses. For example, it is used as domain name in the response to an
15825 incoming HELO or EHLO command.
15826
15827 .vindex "&$smtp_active_hostname$&"
15828 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15829 is saved with any messages that are received. It is therefore available for use
15830 in routers and transports when the message is later delivered.
15831
15832 If this option is unset, or if its expansion is forced to fail, or if the
15833 expansion results in an empty string, the value of &$primary_hostname$& is
15834 used. Other expansion failures cause a message to be written to the main and
15835 panic logs, and the SMTP command receives a temporary error. Typically, the
15836 value of &%smtp_active_hostname%& depends on the incoming interface address.
15837 For example:
15838 .code
15839 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15840   {cox.mydomain}{box.mydomain}}
15841 .endd
15842
15843 Although &$smtp_active_hostname$& is primarily concerned with incoming
15844 messages, it is also used as the default for HELO commands in callout
15845 verification if there is no remote transport from which to obtain a
15846 &%helo_data%& value.
15847
15848 .option smtp_banner main string&!! "see below"
15849 .cindex "SMTP" "welcome banner"
15850 .cindex "banner for SMTP"
15851 .cindex "welcome banner for SMTP"
15852 .cindex "customizing" "SMTP banner"
15853 This string, which is expanded every time it is used, is output as the initial
15854 positive response to an SMTP connection. The default setting is:
15855 .code
15856 smtp_banner = $smtp_active_hostname ESMTP Exim \
15857   $version_number $tod_full
15858 .endd
15859 Failure to expand the string causes a panic error. If you want to create a
15860 multiline response to the initial SMTP connection, use &"\n"& in the string at
15861 appropriate points, but not at the end. Note that the 220 code is not included
15862 in this string. Exim adds it automatically (several times in the case of a
15863 multiline response).
15864
15865
15866 .option smtp_check_spool_space main boolean true
15867 .cindex "checking disk space"
15868 .cindex "disk space, checking"
15869 .cindex "spool directory" "checking space"
15870 When this option is set, if an incoming SMTP session encounters the SIZE
15871 option on a MAIL command, it checks that there is enough space in the
15872 spool directory's partition to accept a message of that size, while still
15873 leaving free the amount specified by &%check_spool_space%& (even if that value
15874 is zero). If there isn't enough space, a temporary error code is returned.
15875
15876
15877 .option smtp_connect_backlog main integer 20
15878 .cindex "connection backlog"
15879 .cindex "SMTP" "connection backlog"
15880 .cindex "backlog of connections"
15881 This option specifies a maximum number of waiting SMTP connections. Exim passes
15882 this value to the TCP/IP system when it sets up its listener. Once this number
15883 of connections are waiting for the daemon's attention, subsequent connection
15884 attempts are refused at the TCP/IP level. At least, that is what the manuals
15885 say; in some circumstances such connection attempts have been observed to time
15886 out instead. For large systems it is probably a good idea to increase the
15887 value (to 50, say). It also gives some protection against denial-of-service
15888 attacks by SYN flooding.
15889
15890
15891 .option smtp_enforce_sync main boolean true
15892 .cindex "SMTP" "synchronization checking"
15893 .cindex "synchronization checking in SMTP"
15894 The SMTP protocol specification requires the client to wait for a response from
15895 the server at certain points in the dialogue. Without PIPELINING these
15896 synchronization points are after every command; with PIPELINING they are
15897 fewer, but they still exist.
15898
15899 Some spamming sites send out a complete set of SMTP commands without waiting
15900 for any response. Exim protects against this by rejecting a message if the
15901 client has sent further input when it should not have. The error response &"554
15902 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15903 for this error cannot be perfect because of transmission delays (unexpected
15904 input may be on its way but not yet received when Exim checks). However, it
15905 does detect many instances.
15906
15907 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15908 If you want to disable the check selectively (for example, only for certain
15909 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15910 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15911
15912
15913
15914 .option smtp_etrn_command main string&!! unset
15915 .cindex "ETRN" "command to be run"
15916 .vindex "&$domain$&"
15917 If this option is set, the given command is run whenever an SMTP ETRN
15918 command is received from a host that is permitted to issue such commands (see
15919 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15920 are independently expanded. The expansion variable &$domain$& is set to the
15921 argument of the ETRN command, and no syntax checking is done on it. For
15922 example:
15923 .code
15924 smtp_etrn_command = /etc/etrn_command $domain \
15925                     $sender_host_address
15926 .endd
15927 A new process is created to run the command, but Exim does not wait for it to
15928 complete. Consequently, its status cannot be checked. If the command cannot be
15929 run, a line is written to the panic log, but the ETRN caller still receives
15930 a 250 success response. Exim is normally running under its own uid when
15931 receiving SMTP, so it is not possible for it to change the uid before running
15932 the command.
15933
15934
15935 .option smtp_etrn_serialize main boolean true
15936 .cindex "ETRN" "serializing"
15937 When this option is set, it prevents the simultaneous execution of more than
15938 one identical command as a result of ETRN in an SMTP connection. See
15939 section &<<SECTETRN>>& for details.
15940
15941
15942 .option smtp_load_reserve main fixed-point unset
15943 .cindex "load average"
15944 If the system load average ever gets higher than this, incoming SMTP calls are
15945 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15946 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15947 the load is over the limit. The option has no effect on ancient operating
15948 systems on which Exim cannot determine the load average. See also
15949 &%deliver_queue_load_max%& and &%queue_only_load%&.
15950
15951
15952
15953 .option smtp_max_synprot_errors main integer 3
15954 .cindex "SMTP" "limiting syntax and protocol errors"
15955 .cindex "limit" "SMTP syntax and protocol errors"
15956 Exim rejects SMTP commands that contain syntax or protocol errors. In
15957 particular, a syntactically invalid email address, as in this command:
15958 .code
15959 RCPT TO:<abc xyz@a.b.c>
15960 .endd
15961 causes immediate rejection of the command, before any other tests are done.
15962 (The ACL cannot be run if there is no valid address to set up for it.) An
15963 example of a protocol error is receiving RCPT before MAIL. If there are
15964 too many syntax or protocol errors in one SMTP session, the connection is
15965 dropped. The limit is set by this option.
15966
15967 .cindex "PIPELINING" "expected errors"
15968 When the PIPELINING extension to SMTP is in use, some protocol errors are
15969 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15970 Exim assumes that PIPELINING will be used if it advertises it (see
15971 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15972 not count towards the limit.
15973
15974
15975
15976 .option smtp_max_unknown_commands main integer 3
15977 .cindex "SMTP" "limiting unknown commands"
15978 .cindex "limit" "unknown SMTP commands"
15979 If there are too many unrecognized commands in an incoming SMTP session, an
15980 Exim server drops the connection. This is a defence against some kinds of abuse
15981 that subvert web
15982 clients
15983 into making connections to SMTP ports; in these circumstances, a number of
15984 non-SMTP command lines are sent first.
15985
15986
15987
15988 .option smtp_ratelimit_hosts main "host list&!!" unset
15989 .cindex "SMTP" "rate limiting"
15990 .cindex "limit" "rate of message arrival"
15991 .cindex "RCPT" "rate limiting"
15992 Some sites find it helpful to be able to limit the rate at which certain hosts
15993 can send them messages, and the rate at which an individual message can specify
15994 recipients.
15995
15996 Exim has two rate-limiting facilities. This section describes the older
15997 facility, which can limit rates within a single connection. The newer
15998 &%ratelimit%& ACL condition can limit rates across all connections. See section
15999 &<<SECTratelimiting>>& for details of the newer facility.
16000
16001 When a host matches &%smtp_ratelimit_hosts%&, the values of
16002 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16003 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16004 respectively. Each option, if set, must contain a set of four comma-separated
16005 values:
16006
16007 .ilist
16008 A threshold, before which there is no rate limiting.
16009 .next
16010 An initial time delay. Unlike other times in Exim, numbers with decimal
16011 fractional parts are allowed here.
16012 .next
16013 A factor by which to increase the delay each time.
16014 .next
16015 A maximum value for the delay. This should normally be less than 5 minutes,
16016 because after that time, the client is liable to timeout the SMTP command.
16017 .endlist
16018
16019 For example, these settings have been used successfully at the site which
16020 first suggested this feature, for controlling mail from their customers:
16021 .code
16022 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16023 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16024 .endd
16025 The first setting specifies delays that are applied to MAIL commands after
16026 two have been received over a single connection. The initial delay is 0.5
16027 seconds, increasing by a factor of 1.05 each time. The second setting applies
16028 delays to RCPT commands when more than four occur in a single message.
16029
16030
16031 .option smtp_ratelimit_mail main string unset
16032 See &%smtp_ratelimit_hosts%& above.
16033
16034
16035 .option smtp_ratelimit_rcpt main string unset
16036 See &%smtp_ratelimit_hosts%& above.
16037
16038
16039 .option smtp_receive_timeout main time 5m
16040 .cindex "timeout" "for SMTP input"
16041 .cindex "SMTP" "input timeout"
16042 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16043 input, including batch SMTP. If a line of input (either an SMTP command or a
16044 data line) is not received within this time, the SMTP connection is dropped and
16045 the message is abandoned.
16046 A line is written to the log containing one of the following messages:
16047 .code
16048 SMTP command timeout on connection from...
16049 SMTP data timeout on connection from...
16050 .endd
16051 The former means that Exim was expecting to read an SMTP command; the latter
16052 means that it was in the DATA phase, reading the contents of a message.
16053
16054
16055 .oindex "&%-os%&"
16056 The value set by this option can be overridden by the
16057 &%-os%& command-line option. A setting of zero time disables the timeout, but
16058 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16059 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16060 timeout is controlled by &%receive_timeout%& and &%-or%&.
16061
16062
16063 .option smtp_reserve_hosts main "host list&!!" unset
16064 This option defines hosts for which SMTP connections are reserved; see
16065 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16066
16067
16068 .option smtp_return_error_details main boolean false
16069 .cindex "SMTP" "details policy failures"
16070 .cindex "policy control" "rejection, returning details"
16071 In the default state, Exim uses bland messages such as
16072 &"Administrative prohibition"& when it rejects SMTP commands for policy
16073 reasons. Many sysadmins like this because it gives away little information
16074 to spammers. However, some other sysadmins who are applying strict checking
16075 policies want to give out much fuller information about failures. Setting
16076 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16077 example, instead of &"Administrative prohibition"&, it might give:
16078 .code
16079 550-Rejected after DATA: '>' missing at end of address:
16080 550 failing address in "From" header is: <user@dom.ain
16081 .endd
16082
16083 .option spamd_address main string "see below"
16084 This option is available when Exim is compiled with the content-scanning
16085 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16086 The default value is
16087 .code
16088 127.0.0.1 783
16089 .endd
16090 See section &<<SECTscanspamass>>& for more details.
16091
16092
16093
16094 .option split_spool_directory main boolean false
16095 .cindex "multiple spool directories"
16096 .cindex "spool directory" "split"
16097 .cindex "directories, multiple"
16098 If this option is set, it causes Exim to split its input directory into 62
16099 subdirectories, each with a single alphanumeric character as its name. The
16100 sixth character of the message id is used to allocate messages to
16101 subdirectories; this is the least significant base-62 digit of the time of
16102 arrival of the message.
16103
16104 Splitting up the spool in this way may provide better performance on systems
16105 where there are long mail queues, by reducing the number of files in any one
16106 directory. The msglog directory is also split up in a similar way to the input
16107 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16108 are still placed in the single directory &_msglog.OLD_&.
16109
16110 It is not necessary to take any special action for existing messages when
16111 changing &%split_spool_directory%&. Exim notices messages that are in the
16112 &"wrong"& place, and continues to process them. If the option is turned off
16113 after a period of being on, the subdirectories will eventually empty and be
16114 automatically deleted.
16115
16116 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16117 changes. Instead of creating a list of all messages in the queue, and then
16118 trying to deliver each one in turn, it constructs a list of those in one
16119 sub-directory and tries to deliver them, before moving on to the next
16120 sub-directory. The sub-directories are processed in a random order. This
16121 spreads out the scanning of the input directories, and uses less memory. It is
16122 particularly beneficial when there are lots of messages on the queue. However,
16123 if &%queue_run_in_order%& is set, none of this new processing happens. The
16124 entire queue has to be scanned and sorted before any deliveries can start.
16125
16126
16127 .option spool_directory main string&!! "set at compile time"
16128 .cindex "spool directory" "path to"
16129 This defines the directory in which Exim keeps its spool, that is, the messages
16130 it is waiting to deliver. The default value is taken from the compile-time
16131 configuration setting, if there is one. If not, this option must be set. The
16132 string is expanded, so it can contain, for example, a reference to
16133 &$primary_hostname$&.
16134
16135 If the spool directory name is fixed on your installation, it is recommended
16136 that you set it at build time rather than from this option, particularly if the
16137 log files are being written to the spool directory (see &%log_file_path%&).
16138 Otherwise log files cannot be used for errors that are detected early on, such
16139 as failures in the configuration file.
16140
16141 By using this option to override the compiled-in path, it is possible to run
16142 tests of Exim without using the standard spool.
16143
16144 .option sqlite_lock_timeout main time 5s
16145 .cindex "sqlite lookup type" "lock timeout"
16146 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16147 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16148
16149 .option strict_acl_vars main boolean false
16150 .cindex "&ACL;" "variables, handling unset"
16151 This option controls what happens if a syntactically valid but undefined ACL
16152 variable is referenced. If it is false (the default), an empty string
16153 is substituted; if it is true, an error is generated. See section
16154 &<<SECTaclvariables>>& for details of ACL variables.
16155
16156 .option strip_excess_angle_brackets main boolean false
16157 .cindex "angle brackets, excess"
16158 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16159 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16160 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16161 passed on to another MTA, the excess angle brackets are not passed on. If this
16162 option is not set, multiple pairs of angle brackets cause a syntax error.
16163
16164
16165 .option strip_trailing_dot main boolean false
16166 .cindex "trailing dot on domain"
16167 .cindex "dot" "trailing on domain"
16168 If this option is set, a trailing dot at the end of a domain in an address is
16169 ignored. If this is in the envelope and the message is passed on to another
16170 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16171 domain causes a syntax error.
16172 However, addresses in header lines are checked only when an ACL requests header
16173 syntax checking.
16174
16175
16176 .option syslog_duplication main boolean true
16177 .cindex "syslog" "duplicate log lines; suppressing"
16178 When Exim is logging to syslog, it writes the log lines for its three
16179 separate logs at different syslog priorities so that they can in principle
16180 be separated on the logging hosts. Some installations do not require this
16181 separation, and in those cases, the duplication of certain log lines is a
16182 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16183 particular log line is written to syslog. For lines that normally go to
16184 both the main log and the reject log, the reject log version (possibly
16185 containing message header lines) is written, at LOG_NOTICE priority.
16186 Lines that normally go to both the main and the panic log are written at
16187 the LOG_ALERT priority.
16188
16189
16190 .option syslog_facility main string unset
16191 .cindex "syslog" "facility; setting"
16192 This option sets the syslog &"facility"& name, used when Exim is logging to
16193 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16194 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16195 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16196 details of Exim's logging.
16197
16198
16199
16200 .option syslog_processname main string &`exim`&
16201 .cindex "syslog" "process name; setting"
16202 This option sets the syslog &"ident"& name, used when Exim is logging to
16203 syslog. The value must be no longer than 32 characters. See chapter
16204 &<<CHAPlog>>& for details of Exim's logging.
16205
16206
16207
16208 .option syslog_timestamp main boolean true
16209 .cindex "syslog" "timestamps"
16210 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16211 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16212 details of Exim's logging.
16213
16214
16215 .option system_filter main string&!! unset
16216 .cindex "filter" "system filter"
16217 .cindex "system filter" "specifying"
16218 .cindex "Sieve filter" "not available for system filter"
16219 This option specifies an Exim filter file that is applied to all messages at
16220 the start of each delivery attempt, before any routing is done. System filters
16221 must be Exim filters; they cannot be Sieve filters. If the system filter
16222 generates any deliveries to files or pipes, or any new mail messages, the
16223 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16224 which transports are to be used. Details of this facility are given in chapter
16225 &<<CHAPsystemfilter>>&.
16226
16227
16228 .option system_filter_directory_transport main string&!! unset
16229 .vindex "&$address_file$&"
16230 This sets the name of the transport driver that is to be used when the
16231 &%save%& command in a system message filter specifies a path ending in &"/"&,
16232 implying delivery of each message into a separate file in some directory.
16233 During the delivery, the variable &$address_file$& contains the path name.
16234
16235
16236 .option system_filter_file_transport main string&!! unset
16237 .cindex "file" "transport for system filter"
16238 This sets the name of the transport driver that is to be used when the &%save%&
16239 command in a system message filter specifies a path not ending in &"/"&. During
16240 the delivery, the variable &$address_file$& contains the path name.
16241
16242 .option system_filter_group main string unset
16243 .cindex "gid (group id)" "system filter"
16244 This option is used only when &%system_filter_user%& is also set. It sets the
16245 gid under which the system filter is run, overriding any gid that is associated
16246 with the user. The value may be numerical or symbolic.
16247
16248 .option system_filter_pipe_transport main string&!! unset
16249 .cindex "&(pipe)& transport" "for system filter"
16250 .vindex "&$address_pipe$&"
16251 This specifies the transport driver that is to be used when a &%pipe%& command
16252 is used in a system filter. During the delivery, the variable &$address_pipe$&
16253 contains the pipe command.
16254
16255
16256 .option system_filter_reply_transport main string&!! unset
16257 .cindex "&(autoreply)& transport" "for system filter"
16258 This specifies the transport driver that is to be used when a &%mail%& command
16259 is used in a system filter.
16260
16261
16262 .option system_filter_user main string unset
16263 .cindex "uid (user id)" "system filter"
16264 If this option is set to root, the system filter is run in the main Exim
16265 delivery process, as root.  Otherwise, the system filter runs in a separate
16266 process, as the given user, defaulting to the Exim run-time user.
16267 Unless the string consists entirely of digits, it
16268 is looked up in the password data. Failure to find the named user causes a
16269 configuration error. The gid is either taken from the password data, or
16270 specified by &%system_filter_group%&. When the uid is specified numerically,
16271 &%system_filter_group%& is required to be set.
16272
16273 If the system filter generates any pipe, file, or reply deliveries, the uid
16274 under which the filter is run is used when transporting them, unless a
16275 transport option overrides.
16276
16277
16278 .option tcp_nodelay main boolean true
16279 .cindex "daemon" "TCP_NODELAY on sockets"
16280 .cindex "Nagle algorithm"
16281 .cindex "TCP_NODELAY on listening sockets"
16282 If this option is set false, it stops the Exim daemon setting the
16283 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16284 turns off the &"Nagle algorithm"&, which is a way of improving network
16285 performance in interactive (character-by-character) situations. Turning it off
16286 should improve Exim's performance a bit, so that is what happens by default.
16287 However, it appears that some broken clients cannot cope, and time out. Hence
16288 this option. It affects only those sockets that are set up for listening by the
16289 daemon. Sockets created by the smtp transport for delivering mail always set
16290 TCP_NODELAY.
16291
16292
16293 .option timeout_frozen_after main time 0s
16294 .cindex "frozen messages" "timing out"
16295 .cindex "timeout" "frozen messages"
16296 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16297 message of any kind that has been on the queue for longer than the given time
16298 is automatically cancelled at the next queue run. If the frozen message is a
16299 bounce message, it is just discarded; otherwise, a bounce is sent to the
16300 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16301 If you want to timeout frozen bounce messages earlier than other kinds of
16302 frozen message, see &%ignore_bounce_errors_after%&.
16303
16304 &*Note:*& the default value of zero means no timeouts; with this setting,
16305 frozen messages remain on the queue forever (except for any frozen bounce
16306 messages that are released by &%ignore_bounce_errors_after%&).
16307
16308
16309 .option timezone main string unset
16310 .cindex "timezone, setting"
16311 The value of &%timezone%& is used to set the environment variable TZ while
16312 running Exim (if it is different on entry). This ensures that all timestamps
16313 created by Exim are in the required timezone. If you want all your timestamps
16314 to be in UTC (aka GMT) you should set
16315 .code
16316 timezone = UTC
16317 .endd
16318 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16319 or, if that is not set, from the value of the TZ environment variable when Exim
16320 is built. If &%timezone%& is set to the empty string, either at build or run
16321 time, any existing TZ variable is removed from the environment when Exim
16322 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16323 unfortunately not all, operating systems.
16324
16325
16326 .option tls_advertise_hosts main "host list&!!" unset
16327 .cindex "TLS" "advertising"
16328 .cindex "encryption" "on SMTP connection"
16329 .cindex "SMTP" "encrypted connection"
16330 When Exim is built with support for TLS encrypted connections, the availability
16331 of the STARTTLS command to set up an encrypted session is advertised in
16332 response to EHLO only to those client hosts that match this option. See
16333 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16334
16335
16336 .option tls_certificate main string&!! unset
16337 .cindex "TLS" "server certificate; location of"
16338 .cindex "certificate" "server, location of"
16339 The value of this option is expanded, and must then be the absolute path to a
16340 file which contains the server's certificates. The server's private key is also
16341 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16342 &<<CHAPTLS>>& for further details.
16343
16344 &*Note*&: The certificates defined by this option are used only when Exim is
16345 receiving incoming messages as a server. If you want to supply certificates for
16346 use when sending messages as a client, you must set the &%tls_certificate%&
16347 option in the relevant &(smtp)& transport.
16348
16349 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16350 if the OpenSSL build supports TLS extensions and the TLS client sends the
16351 Server Name Indication extension, then this option and others documented in
16352 &<<SECTtlssni>>& will be re-expanded.
16353
16354 .option tls_crl main string&!! unset
16355 .cindex "TLS" "server certificate revocation list"
16356 .cindex "certificate" "revocation list for server"
16357 This option specifies a certificate revocation list. The expanded value must
16358 be the name of a file that contains a CRL in PEM format.
16359
16360 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16361
16362
16363 .option tls_dh_max_bits main integer 2236
16364 .cindex "TLS" "D-H bit count"
16365 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16366 the chosen TLS library.  That value might prove to be too high for
16367 interoperability.  This option provides a maximum clamp on the value
16368 suggested, trading off security for interoperability.
16369
16370 The value must be at least 1024.
16371
16372 The value 2236 was chosen because, at time of adding the option, it was the
16373 hard-coded maximum value supported by the NSS cryptographic library, as used
16374 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16375
16376 If you prefer more security and are willing to break some clients, raise this
16377 number.
16378
16379 Note that the value passed to GnuTLS for *generating* a new prime may be a
16380 little less than this figure, because GnuTLS is inexact and may produce a
16381 larger prime than requested.
16382
16383
16384 .option tls_dhparam main string&!! unset
16385 .cindex "TLS" "D-H parameters for server"
16386 The value of this option is expanded and indicates the source of DH parameters
16387 to be used by Exim.
16388
16389 If it is a filename starting with a &`/`&, then it names a file from which DH
16390 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16391 PKCS#3 representation of the DH prime.  If the file does not exist, for
16392 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16393 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16394 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16395 and treated as though the &%tls_dhparam%& were set to "none".
16396
16397 If this option expands to the string "none", then no DH parameters will be
16398 loaded by Exim.
16399
16400 If this option expands to the string "historic" and Exim is using GnuTLS, then
16401 Exim will attempt to load a file from inside the spool directory.  If the file
16402 does not exist, Exim will attempt to create it.
16403 See section &<<SECTgnutlsparam>>& for further details.
16404
16405 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16406 a default DH prime; the default is the 2048 bit prime described in section
16407 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16408 in IKE is assigned number 23.
16409
16410 Otherwise, the option must expand to the name used by Exim for any of a number
16411 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16412 "ike" followed by the number used by IKE, of "default" which corresponds to
16413 "ike23".
16414
16415 The available primes are:
16416 &`ike1`&, &`ike2`&, &`ike5`&,
16417 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16418 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16419
16420 Some of these will be too small to be accepted by clients.
16421 Some may be too large to be accepted by clients.
16422
16423 The TLS protocol does not negotiate an acceptable size for this; clients tend
16424 to hard-drop connections if what is offered by the server is unacceptable,
16425 whether too large or too small, and there's no provision for the client to
16426 tell the server what these constraints are.  Thus, as a server operator, you
16427 need to make an educated guess as to what is most likely to work for your
16428 userbase.
16429
16430 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16431 is most likely to maximise interoperability.  The upper bound comes from
16432 applications using the Mozilla Network Security Services (NSS) library, which
16433 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16434 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16435 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16436 acceptable bound from 1024 to 2048.
16437
16438
16439 .option tls_ocsp_file main string&!! unset
16440 This option
16441 must if set expand to the absolute path to a file which contains a current
16442 status proof for the server's certificate, as obtained from the
16443 Certificate Authority.
16444
16445
16446 .option tls_on_connect_ports main "string list" unset
16447 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16448 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16449 set up without waiting for the client to issue a STARTTLS command. For
16450 further details, see section &<<SECTsupobssmt>>&.
16451
16452
16453
16454 .option tls_privatekey main string&!! unset
16455 .cindex "TLS" "server private key; location of"
16456 The value of this option is expanded, and must then be the absolute path to a
16457 file which contains the server's private key. If this option is unset, or if
16458 the expansion is forced to fail, or the result is an empty string, the private
16459 key is assumed to be in the same file as the server's certificates. See chapter
16460 &<<CHAPTLS>>& for further details.
16461
16462 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16463
16464
16465 .option tls_remember_esmtp main boolean false
16466 .cindex "TLS" "esmtp state; remembering"
16467 .cindex "TLS" "broken clients"
16468 If this option is set true, Exim violates the RFCs by remembering that it is in
16469 &"esmtp"& state after successfully negotiating a TLS session. This provides
16470 support for broken clients that fail to send a new EHLO after starting a
16471 TLS session.
16472
16473
16474 .option tls_require_ciphers main string&!! unset
16475 .cindex "TLS" "requiring specific ciphers"
16476 .cindex "cipher" "requiring specific"
16477 This option controls which ciphers can be used for incoming TLS connections.
16478 The &(smtp)& transport has an option of the same name for controlling outgoing
16479 connections. This option is expanded for each connection, so can be varied for
16480 different clients if required. The value of this option must be a list of
16481 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16482 in somewhat different ways. If GnuTLS is being used, the client controls the
16483 preference order of the available ciphers. Details are given in sections
16484 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16485
16486
16487 .option tls_try_verify_hosts main "host list&!!" unset
16488 .cindex "TLS" "client certificate verification"
16489 .cindex "certificate" "verification of client"
16490 See &%tls_verify_hosts%& below.
16491
16492
16493 .option tls_verify_certificates main string&!! unset
16494 .cindex "TLS" "client certificate verification"
16495 .cindex "certificate" "verification of client"
16496 The value of this option is expanded, and must then be the absolute path to
16497 a file containing permitted certificates for clients that
16498 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16499 are using either GnuTLS version 3.3.6 (or later) or OpenSSL,
16500 you can set &%tls_verify_certificates%& to the name of a
16501 directory containing certificate files.
16502 For earlier versions of GnuTLS
16503 the option must be set to the name of a single file.
16504
16505 With OpenSSL the certificates specified
16506 explicitly
16507 either by file or directory
16508 are added to those given by the system default location.
16509
16510 These certificates should be for the certificate authorities trusted, rather
16511 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16512 the value is a file then the certificates are sent by Exim as a server to
16513 connecting clients, defining the list of accepted certificate authorities.
16514 Thus the values defined should be considered public data.  To avoid this,
16515 use the explicit directory version.
16516
16517 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16518
16519 A forced expansion failure or setting to an empty string is equivalent to
16520 being unset.
16521
16522
16523 .option tls_verify_hosts main "host list&!!" unset
16524 .cindex "TLS" "client certificate verification"
16525 .cindex "certificate" "verification of client"
16526 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16527 certificates from clients. The expected certificates are defined by
16528 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16529 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16530 &%tls_verify_certificates%& is not set.
16531
16532 Any client that matches &%tls_verify_hosts%& is constrained by
16533 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16534 present one of the listed certificates. If it does not, the connection is
16535 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16536 the host to use TLS. It can still send SMTP commands through unencrypted
16537 connections. Forcing a client to use TLS has to be done separately using an
16538 ACL to reject inappropriate commands when the connection is not encrypted.
16539
16540 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16541 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16542 certificate and checks it against &%tls_verify_certificates%&, but does not
16543 abort the connection if there is no certificate or if it does not match. This
16544 state can be detected in an ACL, which makes it possible to implement policies
16545 such as &"accept for relay only if a verified certificate has been received,
16546 but accept for local delivery if encrypted, even without a verified
16547 certificate"&.
16548
16549 Client hosts that match neither of these lists are not asked to present
16550 certificates.
16551
16552
16553 .option trusted_groups main "string list&!!" unset
16554 .cindex "trusted groups"
16555 .cindex "groups" "trusted"
16556 This option is expanded just once, at the start of Exim's processing. If this
16557 option is set, any process that is running in one of the listed groups, or
16558 which has one of them as a supplementary group, is trusted. The groups can be
16559 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16560 details of what trusted callers are permitted to do. If neither
16561 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16562 are trusted.
16563
16564 .option trusted_users main "string list&!!" unset
16565 .cindex "trusted users"
16566 .cindex "user" "trusted"
16567 This option is expanded just once, at the start of Exim's processing. If this
16568 option is set, any process that is running as one of the listed users is
16569 trusted. The users can be specified numerically or by name. See section
16570 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16571 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16572 Exim user are trusted.
16573
16574 .option unknown_login main string&!! unset
16575 .cindex "uid (user id)" "unknown caller"
16576 .vindex "&$caller_uid$&"
16577 This is a specialized feature for use in unusual configurations. By default, if
16578 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16579 gives up. The &%unknown_login%& option can be used to set a login name to be
16580 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16581 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16582 is used for the user's real name (gecos field), unless this has been set by the
16583 &%-F%& option.
16584
16585 .option unknown_username main string unset
16586 See &%unknown_login%&.
16587
16588 .option untrusted_set_sender main "address list&!!" unset
16589 .cindex "trusted users"
16590 .cindex "sender" "setting by untrusted user"
16591 .cindex "untrusted user setting sender"
16592 .cindex "user" "untrusted setting sender"
16593 .cindex "envelope sender"
16594 When an untrusted user submits a message to Exim using the standard input, Exim
16595 normally creates an envelope sender address from the user's login and the
16596 default qualification domain. Data from the &%-f%& option (for setting envelope
16597 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16598 is used) is ignored.
16599
16600 However, untrusted users are permitted to set an empty envelope sender address,
16601 to declare that a message should never generate any bounces. For example:
16602 .code
16603 exim -f '<>' user@domain.example
16604 .endd
16605 .vindex "&$sender_ident$&"
16606 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16607 other envelope sender addresses in a controlled way. When it is set, untrusted
16608 users are allowed to set envelope sender addresses that match any of the
16609 patterns in the list. Like all address lists, the string is expanded. The
16610 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16611 users to setting senders that start with their login ids
16612 followed by a hyphen
16613 by a setting like this:
16614 .code
16615 untrusted_set_sender = ^$sender_ident-
16616 .endd
16617 If you want to allow untrusted users to set envelope sender addresses without
16618 restriction, you can use
16619 .code
16620 untrusted_set_sender = *
16621 .endd
16622 The &%untrusted_set_sender%& option applies to all forms of local input, but
16623 only to the setting of the envelope sender. It does not permit untrusted users
16624 to use the other options which trusted user can use to override message
16625 parameters. Furthermore, it does not stop Exim from removing an existing
16626 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16627 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16628 overriding these actions. The handling of the &'Sender:'& header is also
16629 described in section &<<SECTthesenhea>>&.
16630
16631 The log line for a message's arrival shows the envelope sender following
16632 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16633 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16634 envelope sender address, the user's login is shown in parentheses after the
16635 sender address.
16636
16637
16638 .option uucp_from_pattern main string "see below"
16639 .cindex "&""From""& line"
16640 .cindex "UUCP" "&""From""& line"
16641 Some applications that pass messages to an MTA via a command line interface use
16642 an initial line starting with &"From&~"& to pass the envelope sender. In
16643 particular, this is used by UUCP software. Exim recognizes such a line by means
16644 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16645 matches, the sender address is constructed by expanding the contents of
16646 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16647 default pattern recognizes lines in the following two forms:
16648 .code
16649 From ph10 Fri Jan  5 12:35 GMT 1996
16650 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16651 .endd
16652 The pattern can be seen by running
16653 .code
16654 exim -bP uucp_from_pattern
16655 .endd
16656 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16657 year in the second case. The first word after &"From&~"& is matched in the
16658 regular expression by a parenthesized subpattern. The default value for
16659 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16660 (&"ph10"& in the example above) as the message's sender. See also
16661 &%ignore_fromline_hosts%&.
16662
16663
16664 .option uucp_from_sender main string&!! &`$1`&
16665 See &%uucp_from_pattern%& above.
16666
16667
16668 .option warn_message_file main string unset
16669 .cindex "warning of delay" "customizing the message"
16670 .cindex "customizing" "warning message"
16671 This option defines a template file containing paragraphs of text to be used
16672 for constructing the warning message which is sent by Exim when a message has
16673 been on the queue for a specified amount of time, as specified by
16674 &%delay_warning%&. Details of the file's contents are given in chapter
16675 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16676
16677
16678 .option write_rejectlog main boolean true
16679 .cindex "reject log" "disabling"
16680 If this option is set false, Exim no longer writes anything to the reject log.
16681 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16682 .ecindex IIDconfima
16683 .ecindex IIDmaiconf
16684
16685
16686
16687
16688 . ////////////////////////////////////////////////////////////////////////////
16689 . ////////////////////////////////////////////////////////////////////////////
16690
16691 .chapter "Generic options for routers" "CHAProutergeneric"
16692 .scindex IIDgenoprou1 "options" "generic; for routers"
16693 .scindex IIDgenoprou2 "generic options" "router"
16694 This chapter describes the generic options that apply to all routers.
16695 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16696
16697 For a general description of how a router operates, see sections
16698 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16699 which the preconditions are tested. The order of expansion of the options that
16700 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16701 &%headers_remove%&, &%transport%&.
16702
16703
16704
16705 .option address_data routers string&!! unset
16706 .cindex "router" "data attached to address"
16707 The string is expanded just before the router is run, that is, after all the
16708 precondition tests have succeeded. If the expansion is forced to fail, the
16709 router declines, the value of &%address_data%& remains unchanged, and the
16710 &%more%& option controls what happens next. Other expansion failures cause
16711 delivery of the address to be deferred.
16712
16713 .vindex "&$address_data$&"
16714 When the expansion succeeds, the value is retained with the address, and can be
16715 accessed using the variable &$address_data$& in the current router, subsequent
16716 routers, and the eventual transport.
16717
16718 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16719 that runs a user's filter file, the contents of &$address_data$& are accessible
16720 in the filter. This is not normally a problem, because such data is usually
16721 either not confidential or it &"belongs"& to the current user, but if you do
16722 put confidential data into &$address_data$& you need to remember this point.
16723
16724 Even if the router declines or passes, the value of &$address_data$& remains
16725 with the address, though it can be changed by another &%address_data%& setting
16726 on a subsequent router. If a router generates child addresses, the value of
16727 &$address_data$& propagates to them. This also applies to the special kind of
16728 &"child"& that is generated by a router with the &%unseen%& option.
16729
16730 The idea of &%address_data%& is that you can use it to look up a lot of data
16731 for the address once, and then pick out parts of the data later. For example,
16732 you could use a single LDAP lookup to return a string of the form
16733 .code
16734 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16735 .endd
16736 In the transport you could pick out the mailbox by a setting such as
16737 .code
16738 file = ${extract{mailbox}{$address_data}}
16739 .endd
16740 This makes the configuration file less messy, and also reduces the number of
16741 lookups (though Exim does cache lookups).
16742
16743 .vindex "&$sender_address_data$&"
16744 .vindex "&$address_data$&"
16745 The &%address_data%& facility is also useful as a means of passing information
16746 from one router to another, and from a router to a transport. In addition, if
16747 &$address_data$& is set by a router when verifying a recipient address from an
16748 ACL, it remains available for use in the rest of the ACL statement. After
16749 verifying a sender, the value is transferred to &$sender_address_data$&.
16750
16751
16752
16753 .option address_test routers&!? boolean true
16754 .oindex "&%-bt%&"
16755 .cindex "router" "skipping when address testing"
16756 If this option is set false, the router is skipped when routing is being tested
16757 by means of the &%-bt%& command line option. This can be a convenience when
16758 your first router sends messages to an external scanner, because it saves you
16759 having to set the &"already scanned"& indicator when testing real address
16760 routing.
16761
16762
16763
16764 .option cannot_route_message routers string&!! unset
16765 .cindex "router" "customizing &""cannot route""& message"
16766 .cindex "customizing" "&""cannot route""& message"
16767 This option specifies a text message that is used when an address cannot be
16768 routed because Exim has run out of routers. The default message is
16769 &"Unrouteable address"&. This option is useful only on routers that have
16770 &%more%& set false, or on the very last router in a configuration, because the
16771 value that is used is taken from the last router that is considered. This
16772 includes a router that is skipped because its preconditions are not met, as
16773 well as a router that declines. For example, using the default configuration,
16774 you could put:
16775 .code
16776 cannot_route_message = Remote domain not found in DNS
16777 .endd
16778 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16779 and
16780 .code
16781 cannot_route_message = Unknown local user
16782 .endd
16783 on the final router that checks for local users. If string expansion fails for
16784 this option, the default message is used. Unless the expansion failure was
16785 explicitly forced, a message about the failure is written to the main and panic
16786 logs, in addition to the normal message about the routing failure.
16787
16788
16789 .option caseful_local_part routers boolean false
16790 .cindex "case of local parts"
16791 .cindex "router" "case of local parts"
16792 By default, routers handle the local parts of addresses in a case-insensitive
16793 manner, though the actual case is preserved for transmission with the message.
16794 If you want the case of letters to be significant in a router, you must set
16795 this option true. For individual router options that contain address or local
16796 part lists (for example, &%local_parts%&), case-sensitive matching can be
16797 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16798 more details.
16799
16800 .vindex "&$local_part$&"
16801 .vindex "&$original_local_part$&"
16802 .vindex "&$parent_local_part$&"
16803 The value of the &$local_part$& variable is forced to lower case while a
16804 router is running unless &%caseful_local_part%& is set. When a router assigns
16805 an address to a transport, the value of &$local_part$& when the transport runs
16806 is the same as it was in the router. Similarly, when a router generates child
16807 addresses by aliasing or forwarding, the values of &$original_local_part$&
16808 and &$parent_local_part$& are those that were used by the redirecting router.
16809
16810 This option applies to the processing of an address by a router. When a
16811 recipient address is being processed in an ACL, there is a separate &%control%&
16812 modifier that can be used to specify case-sensitive processing within the ACL
16813 (see section &<<SECTcontrols>>&).
16814
16815
16816
16817 .option check_local_user routers&!? boolean false
16818 .cindex "local user, checking in router"
16819 .cindex "router" "checking for local user"
16820 .cindex "&_/etc/passwd_&"
16821 .vindex "&$home$&"
16822 When this option is true, Exim checks that the local part of the recipient
16823 address (with affixes removed if relevant) is the name of an account on the
16824 local system. The check is done by calling the &[getpwnam()]& function rather
16825 than trying to read &_/etc/passwd_& directly. This means that other methods of
16826 holding password data (such as NIS) are supported. If the local part is a local
16827 user, &$home$& is set from the password data, and can be tested in other
16828 preconditions that are evaluated after this one (the order of evaluation is
16829 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16830 overridden by &%router_home_directory%&. If the local part is not a local user,
16831 the router is skipped.
16832
16833 If you want to check that the local part is either the name of a local user
16834 or matches something else, you cannot combine &%check_local_user%& with a
16835 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16836 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16837 setting to achieve this. For example:
16838 .code
16839 local_parts = passwd;$local_part : lsearch;/etc/other/users
16840 .endd
16841 Note, however, that the side effects of &%check_local_user%& (such as setting
16842 up a home directory) do not occur when a &(passwd)& lookup is used in a
16843 &%local_parts%& (or any other) precondition.
16844
16845
16846
16847 .option condition routers&!? string&!! unset
16848 .cindex "router" "customized precondition"
16849 This option specifies a general precondition test that has to succeed for the
16850 router to be called. The &%condition%& option is the last precondition to be
16851 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16852 result is a forced failure, or an empty string, or one of the strings &"0"& or
16853 &"no"& or &"false"& (checked without regard to the case of the letters), the
16854 router is skipped, and the address is offered to the next one.
16855
16856 If the result is any other value, the router is run (as this is the last
16857 precondition to be evaluated, all the other preconditions must be true).
16858
16859 This option is unusual in that multiple &%condition%& options may be present.
16860 All &%condition%& options must succeed.
16861
16862 The &%condition%& option provides a means of applying custom conditions to the
16863 running of routers. Note that in the case of a simple conditional expansion,
16864 the default expansion values are exactly what is wanted. For example:
16865 .code
16866 condition = ${if >{$message_age}{600}}
16867 .endd
16868 Because of the default behaviour of the string expansion, this is equivalent to
16869 .code
16870 condition = ${if >{$message_age}{600}{true}{}}
16871 .endd
16872
16873 A multiple condition example, which succeeds:
16874 .code
16875 condition = ${if >{$message_age}{600}}
16876 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16877 condition = foobar
16878 .endd
16879
16880 If the expansion fails (other than forced failure) delivery is deferred. Some
16881 of the other precondition options are common special cases that could in fact
16882 be specified using &%condition%&.
16883
16884 .new
16885 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16886 are far older, and use one set of semantics.  ACLs are newer and when
16887 they were created, the ACL &%condition%& process was given far stricter
16888 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
16889 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
16890 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
16891 Router rules processing behavior.
16892
16893 This is best illustrated in an example:
16894 .code
16895 # If used in an ACL condition will fail with a syntax error, but
16896 # in a router condition any extra characters are treated as a string
16897
16898 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16899 true {yes} {no}}
16900
16901 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16902  {yes} {no}}
16903 .endd
16904 In each example above, the &%if%& statement actually ends after
16905 &"{google.com}}"&.  Since no true or false braces were defined, the
16906 default &%if%& behavior is to return a boolean true or a null answer
16907 (which evaluates to false). The rest of the line is then treated as a
16908 string. So the first example resulted in the boolean answer &"true"&
16909 with the string &" {yes} {no}}"& appended to it. The second example
16910 resulted in the null output (indicating false) with the string
16911 &" {yes} {no}}"& appended to it.
16912
16913 In fact you can put excess forward braces in too.  In the router
16914 &%condition%&, Exim's parser only looks for &"{"& symbols when they
16915 mean something, like after a &"$"& or when required as part of a
16916 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16917 string characters.
16918
16919 Thus, in a Router, the above expansion strings will both always evaluate
16920 true, as the result of expansion is a non-empty string which doesn't
16921 match an explicit false value.  This can be tricky to debug.  By
16922 contrast, in an ACL either of those strings will always result in an
16923 expansion error because the result doesn't look sufficiently boolean.
16924 .wen
16925
16926
16927 .option debug_print routers string&!! unset
16928 .cindex "testing" "variables in drivers"
16929 If this option is set and debugging is enabled (see the &%-d%& command line
16930 option) or in address-testing mode (see the &%-bt%& command line option),
16931 the string is expanded and included in the debugging output.
16932 If expansion of the string fails, the error message is written to the debugging
16933 output, and Exim carries on processing.
16934 This option is provided to help with checking out the values of variables and
16935 so on when debugging router configurations. For example, if a &%condition%&
16936 option appears not to be working, &%debug_print%& can be used to output the
16937 variables it references. The output happens after checks for &%domains%&,
16938 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16939 are tested. A newline is added to the text if it does not end with one.
16940 The variable &$router_name$& contains the name of the router.
16941
16942
16943
16944 .option disable_logging routers boolean false
16945 If this option is set true, nothing is logged for any routing errors
16946 or for any deliveries caused by this router. You should not set this option
16947 unless you really, really know what you are doing. See also the generic
16948 transport option of the same name.
16949
16950
16951 .option domains routers&!? "domain list&!!" unset
16952 .cindex "router" "restricting to specific domains"
16953 .vindex "&$domain_data$&"
16954 If this option is set, the router is skipped unless the current domain matches
16955 the list. If the match is achieved by means of a file lookup, the data that the
16956 lookup returned for the domain is placed in &$domain_data$& for use in string
16957 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16958 a list of the order in which preconditions are evaluated.
16959
16960
16961
16962 .option driver routers string unset
16963 This option must always be set. It specifies which of the available routers is
16964 to be used.
16965
16966
16967
16968 .option errors_to routers string&!! unset
16969 .cindex "envelope sender"
16970 .cindex "router" "changing address for errors"
16971 If a router successfully handles an address, it may assign the address to a
16972 transport for delivery or it may generate child addresses. In both cases, if
16973 there is a delivery problem during later processing, the resulting bounce
16974 message is sent to the address that results from expanding this string,
16975 provided that the address verifies successfully. The &%errors_to%& option is
16976 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16977
16978 The &%errors_to%& setting associated with an address can be overridden if it
16979 subsequently passes through other routers that have their own &%errors_to%&
16980 settings, or if the message is delivered by a transport with a &%return_path%&
16981 setting.
16982
16983 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16984 the expansion fails to verify, the errors address associated with the incoming
16985 address is used. At top level, this is the envelope sender. A non-forced
16986 expansion failure causes delivery to be deferred.
16987
16988 If an address for which &%errors_to%& has been set ends up being delivered over
16989 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16990 any bounces that are generated by other MTAs on the delivery route are also
16991 sent there. You can set &%errors_to%& to the empty string by either of these
16992 settings:
16993 .code
16994 errors_to =
16995 errors_to = ""
16996 .endd
16997 An expansion item that yields an empty string has the same effect. If you do
16998 this, a locally detected delivery error for addresses processed by this router
16999 no longer gives rise to a bounce message; the error is discarded. If the
17000 address is delivered to a remote host, the return path is set to &`<>`&, unless
17001 overridden by the &%return_path%& option on the transport.
17002
17003 .vindex "&$address_data$&"
17004 If for some reason you want to discard local errors, but use a non-empty
17005 MAIL command for remote delivery, you can preserve the original return
17006 path in &$address_data$& in the router, and reinstate it in the transport by
17007 setting &%return_path%&.
17008
17009 The most common use of &%errors_to%& is to direct mailing list bounces to the
17010 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17011 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17012
17013
17014
17015 .option expn routers&!? boolean true
17016 .cindex "address" "testing"
17017 .cindex "testing" "addresses"
17018 .cindex "EXPN" "router skipping"
17019 .cindex "router" "skipping for EXPN"
17020 If this option is turned off, the router is skipped when testing an address
17021 as a result of processing an SMTP EXPN command. You might, for example,
17022 want to turn it off on a router for users' &_.forward_& files, while leaving it
17023 on for the system alias file.
17024 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17025 are evaluated.
17026
17027 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17028 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17029 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17030
17031
17032
17033 .option fail_verify routers boolean false
17034 .cindex "router" "forcing verification failure"
17035 Setting this option has the effect of setting both &%fail_verify_sender%& and
17036 &%fail_verify_recipient%& to the same value.
17037
17038
17039
17040 .option fail_verify_recipient routers boolean false
17041 If this option is true and an address is accepted by this router when
17042 verifying a recipient, verification fails.
17043
17044
17045
17046 .option fail_verify_sender routers boolean false
17047 If this option is true and an address is accepted by this router when
17048 verifying a sender, verification fails.
17049
17050
17051
17052 .option fallback_hosts routers "string list" unset
17053 .cindex "router" "fallback hosts"
17054 .cindex "fallback" "hosts specified on router"
17055 String expansion is not applied to this option. The argument must be a
17056 colon-separated list of host names or IP addresses. The list separator can be
17057 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17058 each name or address. In fact, the format of each item is exactly the same as
17059 defined for the list of hosts in a &(manualroute)& router (see section
17060 &<<SECTformatonehostitem>>&).
17061
17062 If a router queues an address for a remote transport, this host list is
17063 associated with the address, and used instead of the transport's fallback host
17064 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17065 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17066 transport for further details.
17067
17068
17069 .option group routers string&!! "see below"
17070 .cindex "gid (group id)" "local delivery"
17071 .cindex "local transports" "uid and gid"
17072 .cindex "transport" "local"
17073 .cindex "router" "setting group"
17074 When a router queues an address for a transport, and the transport does not
17075 specify a group, the group given here is used when running the delivery
17076 process.
17077 The group may be specified numerically or by name. If expansion fails, the
17078 error is logged and delivery is deferred.
17079 The default is unset, unless &%check_local_user%& is set, when the default
17080 is taken from the password information. See also &%initgroups%& and &%user%&
17081 and the discussion in chapter &<<CHAPenvironment>>&.
17082
17083
17084
17085 .option headers_add routers list&!! unset
17086 .cindex "header lines" "adding"
17087 .cindex "router" "adding header lines"
17088 This option specifies a list of text headers, newline-separated,
17089 that is associated with any addresses that are accepted by the router.
17090 Each item is separately expanded, at routing time.  However, this
17091 option has no effect when an address is just being verified. The way in which
17092 the text is used to add header lines at transport time is described in section
17093 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17094 message is in the process of being transported. This means that references to
17095 header lines in string expansions in the transport's configuration do not
17096 &"see"& the added header lines.
17097
17098 The &%headers_add%& option is expanded after &%errors_to%&, but before
17099 &%headers_remove%& and &%transport%&. If an item is empty, or if
17100 an item expansion is forced to fail, the item has no effect. Other expansion
17101 failures are treated as configuration errors.
17102
17103 Unlike most options, &%headers_add%& can be specified multiple times
17104 for a router; all listed headers are added.
17105
17106 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17107 router that has the &%one_time%& option set.
17108
17109 .cindex "duplicate addresses"
17110 .oindex "&%unseen%&"
17111 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17112 additions are deleted when the address is passed on to subsequent routers.
17113 For a &%redirect%& router, if a generated address is the same as the incoming
17114 address, this can lead to duplicate addresses with different header
17115 modifications. Exim does not do duplicate deliveries (except, in certain
17116 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17117 which of the duplicates is discarded, so this ambiguous situation should be
17118 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17119
17120
17121
17122 .option headers_remove routers list&!! unset
17123 .cindex "header lines" "removing"
17124 .cindex "router" "removing header lines"
17125 This option specifies a list of text headers, colon-separated,
17126 that is associated with any addresses that are accepted by the router.
17127 Each item is separately expanded, at routing time.  However, this
17128 option has no effect when an address is just being verified. The way in which
17129 the text is used to remove header lines at transport time is described in
17130 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17131 the message is in the process of being transported. This means that references
17132 to header lines in string expansions in the transport's configuration still
17133 &"see"& the original header lines.
17134
17135 The &%headers_remove%& option is expanded after &%errors_to%& and
17136 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17137 the item has no effect. Other expansion failures are treated as configuration
17138 errors.
17139
17140 Unlike most options, &%headers_remove%& can be specified multiple times
17141 for a router; all listed headers are removed.
17142
17143 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17144 router that has the &%one_time%& option set.
17145
17146 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17147 removal requests are deleted when the address is passed on to subsequent
17148 routers, and this can lead to problems with duplicates -- see the similar
17149 warning for &%headers_add%& above.
17150
17151
17152 .option ignore_target_hosts routers "host list&!!" unset
17153 .cindex "IP address" "discarding"
17154 .cindex "router" "discarding IP addresses"
17155 Although this option is a host list, it should normally contain IP address
17156 entries rather than names. If any host that is looked up by the router has an
17157 IP address that matches an item in this list, Exim behaves as if that IP
17158 address did not exist. This option allows you to cope with rogue DNS entries
17159 like
17160 .code
17161 remote.domain.example.  A  127.0.0.1
17162 .endd
17163 by setting
17164 .code
17165 ignore_target_hosts = 127.0.0.1
17166 .endd
17167 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17168 discarded in this way, the router declines. In a conventional configuration, an
17169 attempt to mail to such a domain would normally provoke the &"unrouteable
17170 domain"& error, and an attempt to verify an address in the domain would fail.
17171 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17172 router declines if presented with one of the listed addresses.
17173
17174 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17175 means of the first or the second of the following settings, respectively:
17176 .code
17177 ignore_target_hosts = 0.0.0.0/0
17178 ignore_target_hosts = <; 0::0/0
17179 .endd
17180 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17181 in the second line matches all IPv6 addresses.
17182
17183 This option may also be useful for ignoring link-local and site-local IPv6
17184 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17185 is expanded before use as a list, it is possible to make it dependent on the
17186 domain that is being routed.
17187
17188 .vindex "&$host_address$&"
17189 During its expansion, &$host_address$& is set to the IP address that is being
17190 checked.
17191
17192 .option initgroups routers boolean false
17193 .cindex "additional groups"
17194 .cindex "groups" "additional"
17195 .cindex "local transports" "uid and gid"
17196 .cindex "transport" "local"
17197 If the router queues an address for a transport, and this option is true, and
17198 the uid supplied by the router is not overridden by the transport, the
17199 &[initgroups()]& function is called when running the transport to ensure that
17200 any additional groups associated with the uid are set up. See also &%group%&
17201 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17202
17203
17204
17205 .option local_part_prefix routers&!? "string list" unset
17206 .cindex "router" "prefix for local part"
17207 .cindex "prefix" "for local part, used in router"
17208 If this option is set, the router is skipped unless the local part starts with
17209 one of the given strings, or &%local_part_prefix_optional%& is true. See
17210 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17211 evaluated.
17212
17213 The list is scanned from left to right, and the first prefix that matches is
17214 used. A limited form of wildcard is available; if the prefix begins with an
17215 asterisk, it matches the longest possible sequence of arbitrary characters at
17216 the start of the local part. An asterisk should therefore always be followed by
17217 some character that does not occur in normal local parts.
17218 .cindex "multiple mailboxes"
17219 .cindex "mailbox" "multiple"
17220 Wildcarding can be used to set up multiple user mailboxes, as described in
17221 section &<<SECTmulbox>>&.
17222
17223 .vindex "&$local_part$&"
17224 .vindex "&$local_part_prefix$&"
17225 During the testing of the &%local_parts%& option, and while the router is
17226 running, the prefix is removed from the local part, and is available in the
17227 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17228 the router accepts the address, this remains true during subsequent delivery by
17229 a transport. In particular, the local part that is transmitted in the RCPT
17230 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17231 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17232 the relevant transport.
17233
17234 When an address is being verified, &%local_part_prefix%& affects only the
17235 behaviour of the router. If the callout feature of verification is in use, this
17236 means that the full address, including the prefix, will be used during the
17237 callout.
17238
17239 The prefix facility is commonly used to handle local parts of the form
17240 &%owner-something%&. Another common use is to support local parts of the form
17241 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17242 to tell a user their forwarding is broken &-- by placing a router like this one
17243 immediately before the router that handles &_.forward_& files:
17244 .code
17245 real_localuser:
17246   driver = accept
17247   local_part_prefix = real-
17248   check_local_user
17249   transport = local_delivery
17250 .endd
17251 For security, it would probably be a good idea to restrict the use of this
17252 router to locally-generated messages, using a condition such as this:
17253 .code
17254   condition = ${if match {$sender_host_address}\
17255                          {\N^(|127\.0\.0\.1)$\N}}
17256 .endd
17257
17258 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17259 both conditions must be met if not optional. Care must be taken if wildcards
17260 are used in both a prefix and a suffix on the same router. Different
17261 separator characters must be used to avoid ambiguity.
17262
17263
17264 .option local_part_prefix_optional routers boolean false
17265 See &%local_part_prefix%& above.
17266
17267
17268
17269 .option local_part_suffix routers&!? "string list" unset
17270 .cindex "router" "suffix for local part"
17271 .cindex "suffix for local part" "used in router"
17272 This option operates in the same way as &%local_part_prefix%&, except that the
17273 local part must end (rather than start) with the given string, the
17274 &%local_part_suffix_optional%& option determines whether the suffix is
17275 mandatory, and the wildcard * character, if present, must be the last
17276 character of the suffix. This option facility is commonly used to handle local
17277 parts of the form &%something-request%& and multiple user mailboxes of the form
17278 &%username-foo%&.
17279
17280
17281 .option local_part_suffix_optional routers boolean false
17282 See &%local_part_suffix%& above.
17283
17284
17285
17286 .option local_parts routers&!? "local part list&!!" unset
17287 .cindex "router" "restricting to specific local parts"
17288 .cindex "local part" "checking in router"
17289 The router is run only if the local part of the address matches the list.
17290 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17291 are evaluated, and
17292 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17293 string is expanded, it is possible to make it depend on the domain, for
17294 example:
17295 .code
17296 local_parts = dbm;/usr/local/specials/$domain
17297 .endd
17298 .vindex "&$local_part_data$&"
17299 If the match is achieved by a lookup, the data that the lookup returned
17300 for the local part is placed in the variable &$local_part_data$& for use in
17301 expansions of the router's private options. You might use this option, for
17302 example, if you have a large number of local virtual domains, and you want to
17303 send all postmaster mail to the same place without having to set up an alias in
17304 each virtual domain:
17305 .code
17306 postmaster:
17307   driver = redirect
17308   local_parts = postmaster
17309   data = postmaster@real.domain.example
17310 .endd
17311
17312
17313 .option log_as_local routers boolean "see below"
17314 .cindex "log" "delivery line"
17315 .cindex "delivery" "log line format"
17316 Exim has two logging styles for delivery, the idea being to make local
17317 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17318 recipient address is given just as the local part, without a domain. The use of
17319 this style is controlled by this option. It defaults to true for the &(accept)&
17320 router, and false for all the others. This option applies only when a
17321 router assigns an address to a transport. It has no effect on routers that
17322 redirect addresses.
17323
17324
17325
17326 .option more routers boolean&!! true
17327 The result of string expansion for this option must be a valid boolean value,
17328 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17329 result causes an error, and delivery is deferred. If the expansion is forced to
17330 fail, the default value for the option (true) is used. Other failures cause
17331 delivery to be deferred.
17332
17333 If this option is set false, and the router declines to handle the address, no
17334 further routers are tried, routing fails, and the address is bounced.
17335 .oindex "&%self%&"
17336 However, if the router explicitly passes an address to the following router by
17337 means of the setting
17338 .code
17339 self = pass
17340 .endd
17341 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17342 does not affect the behaviour if one of the precondition tests fails. In that
17343 case, the address is always passed to the next router.
17344
17345 Note that &%address_data%& is not considered to be a precondition. If its
17346 expansion is forced to fail, the router declines, and the value of &%more%&
17347 controls what happens next.
17348
17349
17350 .option pass_on_timeout routers boolean false
17351 .cindex "timeout" "of router"
17352 .cindex "router" "timeout"
17353 If a router times out during a host lookup, it normally causes deferral of the
17354 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17355 router, overriding &%no_more%&. This may be helpful for systems that are
17356 intermittently connected to the Internet, or those that want to pass to a smart
17357 host any messages that cannot immediately be delivered.
17358
17359 There are occasional other temporary errors that can occur while doing DNS
17360 lookups. They are treated in the same way as a timeout, and this option
17361 applies to all of them.
17362
17363
17364
17365 .option pass_router routers string unset
17366 .cindex "router" "go to after &""pass""&"
17367 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17368 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17369 routing to continue, and overriding a false setting of &%more%&. When one of
17370 these routers returns &"pass"&, the address is normally handed on to the next
17371 router in sequence. This can be changed by setting &%pass_router%& to the name
17372 of another router. However (unlike &%redirect_router%&) the named router must
17373 be below the current router, to avoid loops. Note that this option applies only
17374 to the special case of &"pass"&. It does not apply when a router returns
17375 &"decline"& because it cannot handle an address.
17376
17377
17378
17379 .option redirect_router routers string unset
17380 .cindex "router" "start at after redirection"
17381 Sometimes an administrator knows that it is pointless to reprocess addresses
17382 generated from alias or forward files with the same router again. For
17383 example, if an alias file translates real names into login ids there is no
17384 point searching the alias file a second time, especially if it is a large file.
17385
17386 The &%redirect_router%& option can be set to the name of any router instance.
17387 It causes the routing of any generated addresses to start at the named router
17388 instead of at the first router. This option has no effect if the router in
17389 which it is set does not generate new addresses.
17390
17391
17392
17393 .option require_files routers&!? "string list&!!" unset
17394 .cindex "file" "requiring for router"
17395 .cindex "router" "requiring file existence"
17396 This option provides a general mechanism for predicating the running of a
17397 router on the existence or non-existence of certain files or directories.
17398 Before running a router, as one of its precondition tests, Exim works its way
17399 through the &%require_files%& list, expanding each item separately.
17400
17401 Because the list is split before expansion, any colons in expansion items must
17402 be doubled, or the facility for using a different list separator must be used.
17403 If any expansion is forced to fail, the item is ignored. Other expansion
17404 failures cause routing of the address to be deferred.
17405
17406 If any expanded string is empty, it is ignored. Otherwise, except as described
17407 below, each string must be a fully qualified file path, optionally preceded by
17408 &"!"&. The paths are passed to the &[stat()]& function to test for the
17409 existence of the files or directories. The router is skipped if any paths not
17410 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17411
17412 .cindex "NFS"
17413 If &[stat()]& cannot determine whether a file exists or not, delivery of
17414 the message is deferred. This can happen when NFS-mounted filesystems are
17415 unavailable.
17416
17417 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17418 options, so you cannot use it to check for the existence of a file in which to
17419 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17420 full list of the order in which preconditions are evaluated.) However, as
17421 these options are all expanded, you can use the &%exists%& expansion condition
17422 to make such tests. The &%require_files%& option is intended for checking files
17423 that the router may be going to use internally, or which are needed by a
17424 transport (for example &_.procmailrc_&).
17425
17426 During delivery, the &[stat()]& function is run as root, but there is a
17427 facility for some checking of the accessibility of a file by another user.
17428 This is not a proper permissions check, but just a &"rough"& check that
17429 operates as follows:
17430
17431 If an item in a &%require_files%& list does not contain any forward slash
17432 characters, it is taken to be the user (and optional group, separated by a
17433 comma) to be checked for subsequent files in the list. If no group is specified
17434 but the user is specified symbolically, the gid associated with the uid is
17435 used. For example:
17436 .code
17437 require_files = mail:/some/file
17438 require_files = $local_part:$home/.procmailrc
17439 .endd
17440 If a user or group name in a &%require_files%& list does not exist, the
17441 &%require_files%& condition fails.
17442
17443 Exim performs the check by scanning along the components of the file path, and
17444 checking the access for the given uid and gid. It checks for &"x"& access on
17445 directories, and &"r"& access on the final file. Note that this means that file
17446 access control lists, if the operating system has them, are ignored.
17447
17448 &*Warning 1*&: When the router is being run to verify addresses for an
17449 incoming SMTP message, Exim is not running as root, but under its own uid. This
17450 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17451 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17452 user is not permitted to read one of the directories on the file's path.
17453
17454 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17455 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17456 without root access. In this case, if a check for access by a particular user
17457 is requested, Exim creates a subprocess that runs as that user, and tries the
17458 check again in that process.
17459
17460 The default action for handling an unresolved EACCES is to consider it to
17461 be caused by a configuration error, and routing is deferred because the
17462 existence or non-existence of the file cannot be determined. However, in some
17463 circumstances it may be desirable to treat this condition as if the file did
17464 not exist. If the file name (or the exclamation mark that precedes the file
17465 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17466 as if the file did not exist. For example:
17467 .code
17468 require_files = +/some/file
17469 .endd
17470 If the router is not an essential part of verification (for example, it
17471 handles users' &_.forward_& files), another solution is to set the &%verify%&
17472 option false so that the router is skipped when verifying.
17473
17474
17475
17476 .option retry_use_local_part routers boolean "see below"
17477 .cindex "hints database" "retry keys"
17478 .cindex "local part" "in retry keys"
17479 When a delivery suffers a temporary routing failure, a retry record is created
17480 in Exim's hints database. For addresses whose routing depends only on the
17481 domain, the key for the retry record should not involve the local part, but for
17482 other addresses, both the domain and the local part should be included.
17483 Usually, remote routing is of the former kind, and local routing is of the
17484 latter kind.
17485
17486 This option controls whether the local part is used to form the key for retry
17487 hints for addresses that suffer temporary errors while being handled by this
17488 router. The default value is true for any router that has &%check_local_user%&
17489 set, and false otherwise. Note that this option does not apply to hints keys
17490 for transport delays; they are controlled by a generic transport option of the
17491 same name.
17492
17493 The setting of &%retry_use_local_part%& applies only to the router on which it
17494 appears. If the router generates child addresses, they are routed
17495 independently; this setting does not become attached to them.
17496
17497
17498
17499 .option router_home_directory routers string&!! unset
17500 .cindex "router" "home directory for"
17501 .cindex "home directory" "for router"
17502 .vindex "&$home$&"
17503 This option sets a home directory for use while the router is running. (Compare
17504 &%transport_home_directory%&, which sets a home directory for later
17505 transporting.) In particular, if used on a &(redirect)& router, this option
17506 sets a value for &$home$& while a filter is running. The value is expanded;
17507 forced expansion failure causes the option to be ignored &-- other failures
17508 cause the router to defer.
17509
17510 Expansion of &%router_home_directory%& happens immediately after the
17511 &%check_local_user%& test (if configured), before any further expansions take
17512 place.
17513 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17514 are evaluated.)
17515 While the router is running, &%router_home_directory%& overrides the value of
17516 &$home$& that came from &%check_local_user%&.
17517
17518 When a router accepts an address and assigns it to a local transport (including
17519 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17520 delivery), the home directory setting for the transport is taken from the first
17521 of these values that is set:
17522
17523 .ilist
17524 The &%home_directory%& option on the transport;
17525 .next
17526 The &%transport_home_directory%& option on the router;
17527 .next
17528 The password data if &%check_local_user%& is set on the router;
17529 .next
17530 The &%router_home_directory%& option on the router.
17531 .endlist
17532
17533 In other words, &%router_home_directory%& overrides the password data for the
17534 router, but not for the transport.
17535
17536
17537
17538 .option self routers string freeze
17539 .cindex "MX record" "pointing to local host"
17540 .cindex "local host" "MX pointing to"
17541 This option applies to those routers that use a recipient address to find a
17542 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17543 and &(manualroute)& routers.
17544 Certain configurations of the &(queryprogram)& router can also specify a list
17545 of remote hosts.
17546 Usually such routers are configured to send the message to a remote host via an
17547 &(smtp)& transport. The &%self%& option specifies what happens when the first
17548 host on the list turns out to be the local host.
17549 The way in which Exim checks for the local host is described in section
17550 &<<SECTreclocipadd>>&.
17551
17552 Normally this situation indicates either an error in Exim's configuration (for
17553 example, the router should be configured not to process this domain), or an
17554 error in the DNS (for example, the MX should not point to this host). For this
17555 reason, the default action is to log the incident, defer the address, and
17556 freeze the message. The following alternatives are provided for use in special
17557 cases:
17558
17559 .vlist
17560 .vitem &%defer%&
17561 Delivery of the message is tried again later, but the message is not frozen.
17562
17563 .vitem "&%reroute%&: <&'domain'&>"
17564 The domain is changed to the given domain, and the address is passed back to
17565 be reprocessed by the routers. No rewriting of headers takes place. This
17566 behaviour is essentially a redirection.
17567
17568 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17569 The domain is changed to the given domain, and the address is passed back to be
17570 reprocessed by the routers. Any headers that contain the original domain are
17571 rewritten.
17572
17573 .vitem &%pass%&
17574 .oindex "&%more%&"
17575 .vindex "&$self_hostname$&"
17576 The router passes the address to the next router, or to the router named in the
17577 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17578 subsequent routing and delivery, the variable &$self_hostname$& contains the
17579 name of the local host that the router encountered. This can be used to
17580 distinguish between different cases for hosts with multiple names. The
17581 combination
17582 .code
17583 self = pass
17584 no_more
17585 .endd
17586 ensures that only those addresses that routed to the local host are passed on.
17587 Without &%no_more%&, addresses that were declined for other reasons would also
17588 be passed to the next router.
17589
17590 .vitem &%fail%&
17591 Delivery fails and an error report is generated.
17592
17593 .vitem &%send%&
17594 .cindex "local host" "sending to"
17595 The anomaly is ignored and the address is queued for the transport. This
17596 setting should be used with extreme caution. For an &(smtp)& transport, it
17597 makes sense only in cases where the program that is listening on the SMTP port
17598 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17599 different configuration file that handles the domain in another way.
17600 .endlist
17601
17602
17603
17604 .option senders routers&!? "address list&!!" unset
17605 .cindex "router" "checking senders"
17606 If this option is set, the router is skipped unless the message's sender
17607 address matches something on the list.
17608 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17609 are evaluated.
17610
17611 There are issues concerning verification when the running of routers is
17612 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17613 setting, it sets the sender to the null string. When using the &%-bt%& option
17614 to check a configuration file, it is necessary also to use the &%-f%& option to
17615 set an appropriate sender. For incoming mail, the sender is unset when
17616 verifying the sender, but is available when verifying any recipients. If the
17617 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17618 matters.
17619
17620
17621 .option translate_ip_address routers string&!! unset
17622 .cindex "IP address" "translating"
17623 .cindex "packet radio"
17624 .cindex "router" "IP address translation"
17625 There exist some rare networking situations (for example, packet radio) where
17626 it is helpful to be able to translate IP addresses generated by normal routing
17627 mechanisms into other IP addresses, thus performing a kind of manual IP
17628 routing. This should be done only if the normal IP routing of the TCP/IP stack
17629 is inadequate or broken. Because this is an extremely uncommon requirement, the
17630 code to support this option is not included in the Exim binary unless
17631 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17632
17633 .vindex "&$host_address$&"
17634 The &%translate_ip_address%& string is expanded for every IP address generated
17635 by the router, with the generated address set in &$host_address$&. If the
17636 expansion is forced to fail, no action is taken.
17637 For any other expansion error, delivery of the message is deferred.
17638 If the result of the expansion is an IP address, that replaces the original
17639 address; otherwise the result is assumed to be a host name &-- this is looked
17640 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17641 produce one or more replacement IP addresses. For example, to subvert all IP
17642 addresses in some specific networks, this could be added to a router:
17643 .code
17644 translate_ip_address = \
17645   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17646     {$value}fail}}
17647 .endd
17648 The file would contain lines like
17649 .code
17650 10.2.3.128/26    some.host
17651 10.8.4.34/26     10.44.8.15
17652 .endd
17653 You should not make use of this facility unless you really understand what you
17654 are doing.
17655
17656
17657
17658 .option transport routers string&!! unset
17659 This option specifies the transport to be used when a router accepts an address
17660 and sets it up for delivery. A transport is never needed if a router is used
17661 only for verification. The value of the option is expanded at routing time,
17662 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17663 and result must be the name of one of the configured transports. If it is not,
17664 delivery is deferred.
17665
17666 The &%transport%& option is not used by the &(redirect)& router, but it does
17667 have some private options that set up transports for pipe and file deliveries
17668 (see chapter &<<CHAPredirect>>&).
17669
17670
17671
17672 .option transport_current_directory routers string&!! unset
17673 .cindex "current directory for local transport"
17674 This option associates a current directory with any address that is routed
17675 to a local transport. This can happen either because a transport is
17676 explicitly configured for the router, or because it generates a delivery to a
17677 file or a pipe. During the delivery process (that is, at transport time), this
17678 option string is expanded and is set as the current directory, unless
17679 overridden by a setting on the transport.
17680 If the expansion fails for any reason, including forced failure, an error is
17681 logged, and delivery is deferred.
17682 See chapter &<<CHAPenvironment>>& for details of the local delivery
17683 environment.
17684
17685
17686
17687
17688 .option transport_home_directory routers string&!! "see below"
17689 .cindex "home directory" "for local transport"
17690 This option associates a home directory with any address that is routed to a
17691 local transport. This can happen either because a transport is explicitly
17692 configured for the router, or because it generates a delivery to a file or a
17693 pipe. During the delivery process (that is, at transport time), the option
17694 string is expanded and is set as the home directory, unless overridden by a
17695 setting of &%home_directory%& on the transport.
17696 If the expansion fails for any reason, including forced failure, an error is
17697 logged, and delivery is deferred.
17698
17699 If the transport does not specify a home directory, and
17700 &%transport_home_directory%& is not set for the router, the home directory for
17701 the transport is taken from the password data if &%check_local_user%& is set for
17702 the router. Otherwise it is taken from &%router_home_directory%& if that option
17703 is set; if not, no home directory is set for the transport.
17704
17705 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17706 environment.
17707
17708
17709
17710
17711 .option unseen routers boolean&!! false
17712 .cindex "router" "carrying on after success"
17713 The result of string expansion for this option must be a valid boolean value,
17714 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17715 result causes an error, and delivery is deferred. If the expansion is forced to
17716 fail, the default value for the option (false) is used. Other failures cause
17717 delivery to be deferred.
17718
17719 When this option is set true, routing does not cease if the router accepts the
17720 address. Instead, a copy of the incoming address is passed to the next router,
17721 overriding a false setting of &%more%&. There is little point in setting
17722 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17723 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17724 sometimes true and sometimes false).
17725
17726 .cindex "copy of message (&%unseen%& option)"
17727 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17728 qualifier in filter files. It can be used to cause copies of messages to be
17729 delivered to some other destination, while also carrying out a normal delivery.
17730 In effect, the current address is made into a &"parent"& that has two children
17731 &-- one that is delivered as specified by this router, and a clone that goes on
17732 to be routed further. For this reason, &%unseen%& may not be combined with the
17733 &%one_time%& option in a &(redirect)& router.
17734
17735 &*Warning*&: Header lines added to the address (or specified for removal) by
17736 this router or by previous routers affect the &"unseen"& copy of the message
17737 only. The clone that continues to be processed by further routers starts with
17738 no added headers and none specified for removal. For a &%redirect%& router, if
17739 a generated address is the same as the incoming address, this can lead to
17740 duplicate addresses with different header modifications. Exim does not do
17741 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17742 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17743 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17744 &%redirect%& router may be of help.
17745
17746 Unlike the handling of header modifications, any data that was set by the
17747 &%address_data%& option in the current or previous routers &'is'& passed on to
17748 subsequent routers.
17749
17750
17751 .option user routers string&!! "see below"
17752 .cindex "uid (user id)" "local delivery"
17753 .cindex "local transports" "uid and gid"
17754 .cindex "transport" "local"
17755 .cindex "router" "user for filter processing"
17756 .cindex "filter" "user for processing"
17757 When a router queues an address for a transport, and the transport does not
17758 specify a user, the user given here is used when running the delivery process.
17759 The user may be specified numerically or by name. If expansion fails, the
17760 error is logged and delivery is deferred.
17761 This user is also used by the &(redirect)& router when running a filter file.
17762 The default is unset, except when &%check_local_user%& is set. In this case,
17763 the default is taken from the password information. If the user is specified as
17764 a name, and &%group%& is not set, the group associated with the user is used.
17765 See also &%initgroups%& and &%group%& and the discussion in chapter
17766 &<<CHAPenvironment>>&.
17767
17768
17769
17770 .option verify routers&!? boolean true
17771 Setting this option has the effect of setting &%verify_sender%& and
17772 &%verify_recipient%& to the same value.
17773
17774
17775 .option verify_only routers&!? boolean false
17776 .cindex "EXPN" "with &%verify_only%&"
17777 .oindex "&%-bv%&"
17778 .cindex "router" "used only when verifying"
17779 If this option is set, the router is used only when verifying an address,
17780 delivering in cutthrough mode or
17781 testing with the &%-bv%& option, not when actually doing a delivery, testing
17782 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17783 restricted to verifying only senders or recipients by means of
17784 &%verify_sender%& and &%verify_recipient%&.
17785
17786 &*Warning*&: When the router is being run to verify addresses for an incoming
17787 SMTP message, Exim is not running as root, but under its own uid. If the router
17788 accesses any files, you need to make sure that they are accessible to the Exim
17789 user or group.
17790
17791
17792 .option verify_recipient routers&!? boolean true
17793 If this option is false, the router is skipped when verifying recipient
17794 addresses,
17795 delivering in cutthrough mode
17796 or testing recipient verification using &%-bv%&.
17797 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17798 are evaluated.
17799 See also the &$verify_mode$& variable.
17800
17801
17802 .option verify_sender routers&!? boolean true
17803 If this option is false, the router is skipped when verifying sender addresses
17804 or testing sender verification using &%-bvs%&.
17805 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17806 are evaluated.
17807 See also the &$verify_mode$& variable.
17808 .ecindex IIDgenoprou1
17809 .ecindex IIDgenoprou2
17810
17811
17812
17813
17814
17815
17816 . ////////////////////////////////////////////////////////////////////////////
17817 . ////////////////////////////////////////////////////////////////////////////
17818
17819 .chapter "The accept router" "CHID4"
17820 .cindex "&(accept)& router"
17821 .cindex "routers" "&(accept)&"
17822 The &(accept)& router has no private options of its own. Unless it is being
17823 used purely for verification (see &%verify_only%&) a transport is required to
17824 be defined by the generic &%transport%& option. If the preconditions that are
17825 specified by generic options are met, the router accepts the address and queues
17826 it for the given transport. The most common use of this router is for setting
17827 up deliveries to local mailboxes. For example:
17828 .code
17829 localusers:
17830   driver = accept
17831   domains = mydomain.example
17832   check_local_user
17833   transport = local_delivery
17834 .endd
17835 The &%domains%& condition in this example checks the domain of the address, and
17836 &%check_local_user%& checks that the local part is the login of a local user.
17837 When both preconditions are met, the &(accept)& router runs, and queues the
17838 address for the &(local_delivery)& transport.
17839
17840
17841
17842
17843
17844
17845 . ////////////////////////////////////////////////////////////////////////////
17846 . ////////////////////////////////////////////////////////////////////////////
17847
17848 .chapter "The dnslookup router" "CHAPdnslookup"
17849 .scindex IIDdnsrou1 "&(dnslookup)& router"
17850 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17851 The &(dnslookup)& router looks up the hosts that handle mail for the
17852 recipient's domain in the DNS. A transport must always be set for this router,
17853 unless &%verify_only%& is set.
17854
17855 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17856 SRV records. If none are found, or if SRV support is not configured,
17857 MX records are looked up. If no MX records exist, address records are sought.
17858 However, &%mx_domains%& can be set to disable the direct use of address
17859 records.
17860
17861 MX records of equal priority are sorted by Exim into a random order. Exim then
17862 looks for address records for the host names obtained from MX or SRV records.
17863 When a host has more than one IP address, they are sorted into a random order,
17864 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17865 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17866 generic option, the router declines.
17867
17868 Unless they have the highest priority (lowest MX value), MX records that point
17869 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17870 are discarded, together with any other MX records of equal or lower priority.
17871
17872 .cindex "MX record" "pointing to local host"
17873 .cindex "local host" "MX pointing to"
17874 .oindex "&%self%&" "in &(dnslookup)& router"
17875 If the host pointed to by the highest priority MX record, or looked up as an
17876 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17877 happens is controlled by the generic &%self%& option.
17878
17879
17880 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17881 There have been problems with DNS servers when SRV records are looked up.
17882 Some mis-behaving servers return a DNS error or timeout when a non-existent
17883 SRV record is sought. Similar problems have in the past been reported for
17884 MX records. The global &%dns_again_means_nonexist%& option can help with this
17885 problem, but it is heavy-handed because it is a global option.
17886
17887 For this reason, there are two options, &%srv_fail_domains%& and
17888 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17889 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17890 an attempt to look up an SRV or MX record causes one of these results, and the
17891 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17892 such record"&. In the case of an SRV lookup, this means that the router
17893 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17894 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17895 case routing fails.
17896
17897
17898 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17899 .cindex "&(dnslookup)& router" "declines"
17900 There are a few cases where a &(dnslookup)& router will decline to accept
17901 an address; if such a router is expected to handle "all remaining non-local
17902 domains", then it is important to set &%no_more%&.
17903
17904 Reasons for a &(dnslookup)& router to decline currently include:
17905 .ilist
17906 The domain does not exist in DNS
17907 .next
17908 The domain exists but the MX record's host part is just "."; this is a common
17909 convention (borrowed from SRV) used to indicate that there is no such service
17910 for this domain and to not fall back to trying A/AAAA records.
17911 .next
17912 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17913 .next
17914 MX record points to a non-existent host.
17915 .next
17916 MX record points to an IP address and the main section option
17917 &%allow_mx_to_ip%& is not set.
17918 .next
17919 MX records exist and point to valid hosts, but all hosts resolve only to
17920 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17921 .next
17922 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17923 &%dns_check_names_pattern%& for handling one variant of this)
17924 .next
17925 &%check_secondary_mx%& is set on this router but the local host can
17926 not be found in the MX records (see below)
17927 .endlist
17928
17929
17930
17931
17932 .section "Private options for dnslookup" "SECID118"
17933 .cindex "options" "&(dnslookup)& router"
17934 The private options for the &(dnslookup)& router are as follows:
17935
17936 .option check_secondary_mx dnslookup boolean false
17937 .cindex "MX record" "checking for secondary"
17938 If this option is set, the router declines unless the local host is found in
17939 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17940 process domains for which the local host is a secondary mail exchanger
17941 differently to other domains. The way in which Exim decides whether a host is
17942 the local host is described in section &<<SECTreclocipadd>>&.
17943
17944
17945 .option check_srv dnslookup string&!! unset
17946 .cindex "SRV record" "enabling use of"
17947 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17948 addition to MX and address records. The support is disabled by default. To
17949 enable SRV support, set the &%check_srv%& option to the name of the service
17950 required. For example,
17951 .code
17952 check_srv = smtp
17953 .endd
17954 looks for SRV records that refer to the normal smtp service. The option is
17955 expanded, so the service name can vary from message to message or address
17956 to address. This might be helpful if SRV records are being used for a
17957 submission service. If the expansion is forced to fail, the &%check_srv%&
17958 option is ignored, and the router proceeds to look for MX records in the
17959 normal way.
17960
17961 When the expansion succeeds, the router searches first for SRV records for
17962 the given service (it assumes TCP protocol). A single SRV record with a
17963 host name that consists of just a single dot indicates &"no such service for
17964 this domain"&; if this is encountered, the router declines. If other kinds of
17965 SRV record are found, they are used to construct a host list for delivery
17966 according to the rules of RFC 2782. MX records are not sought in this case.
17967
17968 When no SRV records are found, MX records (and address records) are sought in
17969 the traditional way. In other words, SRV records take precedence over MX
17970 records, just as MX records take precedence over address records. Note that
17971 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17972 defined it. It is apparently believed that MX records are sufficient for email
17973 and that SRV records should not be used for this purpose. However, SRV records
17974 have an additional &"weight"& feature which some people might find useful when
17975 trying to split an SMTP load between hosts of different power.
17976
17977 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17978 when there is a DNS lookup error.
17979
17980
17981
17982 .option dnssec_request_domains dnslookup "domain list&!!" unset
17983 .cindex "MX record" "security"
17984 .cindex "DNSSEC" "MX lookup"
17985 .cindex "security" "MX lookup"
17986 .cindex "DNS" "DNSSEC"
17987 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17988 the dnssec request bit set.
17989 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17990
17991
17992
17993 .option dnssec_require_domains dnslookup "domain list&!!" unset
17994 .cindex "MX record" "security"
17995 .cindex "DNSSEC" "MX lookup"
17996 .cindex "security" "MX lookup"
17997 .cindex "DNS" "DNSSEC"
17998 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17999 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18000 (AD bit) set wil be ignored and logged as a host-lookup failure.
18001 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18002
18003
18004
18005 .option mx_domains dnslookup "domain list&!!" unset
18006 .cindex "MX record" "required to exist"
18007 .cindex "SRV record" "required to exist"
18008 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18009 record in order to be recognized. (The name of this option could be improved.)
18010 For example, if all the mail hosts in &'fict.example'& are known to have MX
18011 records, except for those in &'discworld.fict.example'&, you could use this
18012 setting:
18013 .code
18014 mx_domains = ! *.discworld.fict.example : *.fict.example
18015 .endd
18016 This specifies that messages addressed to a domain that matches the list but
18017 has no MX record should be bounced immediately instead of being routed using
18018 the address record.
18019
18020
18021 .option mx_fail_domains dnslookup "domain list&!!" unset
18022 If the DNS lookup for MX records for one of the domains in this list causes a
18023 DNS lookup error, Exim behaves as if no MX records were found. See section
18024 &<<SECTprowitdnsloo>>& for more discussion.
18025
18026
18027
18028
18029 .option qualify_single dnslookup boolean true
18030 .cindex "DNS" "resolver options"
18031 .cindex "DNS" "qualifying single-component names"
18032 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18033 lookups. Typically, but not standardly, this causes the resolver to qualify
18034 single-component names with the default domain. For example, on a machine
18035 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18036 &'thesaurus.ref.example'& inside the resolver. For details of what your
18037 resolver actually does, consult your man pages for &'resolver'& and
18038 &'resolv.conf'&.
18039
18040
18041
18042 .option rewrite_headers dnslookup boolean true
18043 .cindex "rewriting" "header lines"
18044 .cindex "header lines" "rewriting"
18045 If the domain name in the address that is being processed is not fully
18046 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18047 an address is specified as &'dormouse@teaparty'&, the domain might be
18048 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18049 occur as a result of setting the &%widen_domains%& option. If
18050 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18051 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18052 header lines of the message are rewritten with the full domain name.
18053
18054 This option should be turned off only when it is known that no message is
18055 ever going to be sent outside an environment where the abbreviation makes
18056 sense.
18057
18058 When an MX record is looked up in the DNS and matches a wildcard record, name
18059 servers normally return a record containing the name that has been looked up,
18060 making it impossible to detect whether a wildcard was present or not. However,
18061 some name servers have recently been seen to return the wildcard entry. If the
18062 name returned by a DNS lookup begins with an asterisk, it is not used for
18063 header rewriting.
18064
18065
18066 .option same_domain_copy_routing dnslookup boolean false
18067 .cindex "address" "copying routing"
18068 Addresses with the same domain are normally routed by the &(dnslookup)& router
18069 to the same list of hosts. However, this cannot be presumed, because the router
18070 options and preconditions may refer to the local part of the address. By
18071 default, therefore, Exim routes each address in a message independently. DNS
18072 servers run caches, so repeated DNS lookups are not normally expensive, and in
18073 any case, personal messages rarely have more than a few recipients.
18074
18075 If you are running mailing lists with large numbers of subscribers at the same
18076 domain, and you are using a &(dnslookup)& router which is independent of the
18077 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18078 lookups for identical domains in one message. In this case, when &(dnslookup)&
18079 routes an address to a remote transport, any other unrouted addresses in the
18080 message that have the same domain are automatically given the same routing
18081 without processing them independently,
18082 provided the following conditions are met:
18083
18084 .ilist
18085 No router that processed the address specified &%headers_add%& or
18086 &%headers_remove%&.
18087 .next
18088 The router did not change the address in any way, for example, by &"widening"&
18089 the domain.
18090 .endlist
18091
18092
18093
18094
18095 .option search_parents dnslookup boolean false
18096 .cindex "DNS" "resolver options"
18097 When this option is true, the resolver option RES_DNSRCH is set for DNS
18098 lookups. This is different from the &%qualify_single%& option in that it
18099 applies to domains containing dots. Typically, but not standardly, it causes
18100 the resolver to search for the name in the current domain and in parent
18101 domains. For example, on a machine in the &'fict.example'& domain, if looking
18102 up &'teaparty.wonderland'& failed, the resolver would try
18103 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18104 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18105
18106 Setting this option true can cause problems in domains that have a wildcard MX
18107 record, because any domain that does not have its own MX record matches the
18108 local wildcard.
18109
18110
18111
18112 .option srv_fail_domains dnslookup "domain list&!!" unset
18113 If the DNS lookup for SRV records for one of the domains in this list causes a
18114 DNS lookup error, Exim behaves as if no SRV records were found. See section
18115 &<<SECTprowitdnsloo>>& for more discussion.
18116
18117
18118
18119
18120 .option widen_domains dnslookup "string list" unset
18121 .cindex "domain" "partial; widening"
18122 If a DNS lookup fails and this option is set, each of its strings in turn is
18123 added onto the end of the domain, and the lookup is tried again. For example,
18124 if
18125 .code
18126 widen_domains = fict.example:ref.example
18127 .endd
18128 is set and a lookup of &'klingon.dictionary'& fails,
18129 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18130 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18131 and &%search_parents%& options can cause some widening to be undertaken inside
18132 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18133 when verifying, unless &%rewrite_headers%& is false (not the default).
18134
18135
18136 .section "Effect of qualify_single and search_parents" "SECID119"
18137 When a domain from an envelope recipient is changed by the resolver as a result
18138 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18139 corresponding address in the message's header lines unless &%rewrite_headers%&
18140 is set false. Exim then re-routes the address, using the full domain.
18141
18142 These two options affect only the DNS lookup that takes place inside the router
18143 for the domain of the address that is being routed. They do not affect lookups
18144 such as that implied by
18145 .code
18146 domains = @mx_any
18147 .endd
18148 that may happen while processing a router precondition before the router is
18149 entered. No widening ever takes place for these lookups.
18150 .ecindex IIDdnsrou1
18151 .ecindex IIDdnsrou2
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161 . ////////////////////////////////////////////////////////////////////////////
18162 . ////////////////////////////////////////////////////////////////////////////
18163
18164 .chapter "The ipliteral router" "CHID5"
18165 .cindex "&(ipliteral)& router"
18166 .cindex "domain literal" "routing"
18167 .cindex "routers" "&(ipliteral)&"
18168 This router has no private options. Unless it is being used purely for
18169 verification (see &%verify_only%&) a transport is required to be defined by the
18170 generic &%transport%& option. The router accepts the address if its domain part
18171 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18172 router handles the address
18173 .code
18174 root@[192.168.1.1]
18175 .endd
18176 by setting up delivery to the host with that IP address. IPv4 domain literals
18177 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18178 are similar, but the address is preceded by &`ipv6:`&. For example:
18179 .code
18180 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18181 .endd
18182 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18183 grounds that sooner or later somebody will try it.
18184
18185 .oindex "&%self%&" "in &(ipliteral)& router"
18186 If the IP address matches something in &%ignore_target_hosts%&, the router
18187 declines. If an IP literal turns out to refer to the local host, the generic
18188 &%self%& option determines what happens.
18189
18190 The RFCs require support for domain literals; however, their use is
18191 controversial in today's Internet. If you want to use this router, you must
18192 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18193 Exim will not recognize the domain literal syntax in addresses.
18194
18195
18196
18197 . ////////////////////////////////////////////////////////////////////////////
18198 . ////////////////////////////////////////////////////////////////////////////
18199
18200 .chapter "The iplookup router" "CHID6"
18201 .cindex "&(iplookup)& router"
18202 .cindex "routers" "&(iplookup)&"
18203 The &(iplookup)& router was written to fulfil a specific requirement in
18204 Cambridge University (which in fact no longer exists). For this reason, it is
18205 not included in the binary of Exim by default. If you want to include it, you
18206 must set
18207 .code
18208 ROUTER_IPLOOKUP=yes
18209 .endd
18210 in your &_Local/Makefile_& configuration file.
18211
18212 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18213 connection to one or more specific hosts. The host can then return the same or
18214 a different address &-- in effect rewriting the recipient address in the
18215 message's envelope. The new address is then passed on to subsequent routers. If
18216 this process fails, the address can be passed on to other routers, or delivery
18217 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18218 must not be specified for it.
18219
18220 .cindex "options" "&(iplookup)& router"
18221 .option hosts iplookup string unset
18222 This option must be supplied. Its value is a colon-separated list of host
18223 names. The hosts are looked up using &[gethostbyname()]&
18224 (or &[getipnodebyname()]& when available)
18225 and are tried in order until one responds to the query. If none respond, what
18226 happens is controlled by &%optional%&.
18227
18228
18229 .option optional iplookup boolean false
18230 If &%optional%& is true, if no response is obtained from any host, the address
18231 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18232 delivery to the address is deferred.
18233
18234
18235 .option port iplookup integer 0
18236 .cindex "port" "&(iplookup)& router"
18237 This option must be supplied. It specifies the port number for the TCP or UDP
18238 call.
18239
18240
18241 .option protocol iplookup string udp
18242 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18243 protocols is to be used.
18244
18245
18246 .option query iplookup string&!! "see below"
18247 This defines the content of the query that is sent to the remote hosts. The
18248 default value is:
18249 .code
18250 $local_part@$domain $local_part@$domain
18251 .endd
18252 The repetition serves as a way of checking that a response is to the correct
18253 query in the default case (see &%response_pattern%& below).
18254
18255
18256 .option reroute iplookup string&!! unset
18257 If this option is not set, the rerouted address is precisely the byte string
18258 returned by the remote host, up to the first white space, if any. If set, the
18259 string is expanded to form the rerouted address. It can include parts matched
18260 in the response by &%response_pattern%& by means of numeric variables such as
18261 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18262 whether or not a pattern is in use. In all cases, the rerouted address must end
18263 up in the form &'local_part@domain'&.
18264
18265
18266 .option response_pattern iplookup string unset
18267 This option can be set to a regular expression that is applied to the string
18268 returned from the remote host. If the pattern does not match the response, the
18269 router declines. If &%response_pattern%& is not set, no checking of the
18270 response is done, unless the query was defaulted, in which case there is a
18271 check that the text returned after the first white space is the original
18272 address. This checks that the answer that has been received is in response to
18273 the correct question. For example, if the response is just a new domain, the
18274 following could be used:
18275 .code
18276 response_pattern = ^([^@]+)$
18277 reroute = $local_part@$1
18278 .endd
18279
18280 .option timeout iplookup time 5s
18281 This specifies the amount of time to wait for a response from the remote
18282 machine. The same timeout is used for the &[connect()]& function for a TCP
18283 call. It does not apply to UDP.
18284
18285
18286
18287
18288 . ////////////////////////////////////////////////////////////////////////////
18289 . ////////////////////////////////////////////////////////////////////////////
18290
18291 .chapter "The manualroute router" "CHID7"
18292 .scindex IIDmanrou1 "&(manualroute)& router"
18293 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18294 .cindex "domain" "manually routing"
18295 The &(manualroute)& router is so-called because it provides a way of manually
18296 routing an address according to its domain. It is mainly used when you want to
18297 route addresses to remote hosts according to your own rules, bypassing the
18298 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18299 route to local transports, a facility that may be useful if you want to save
18300 messages for dial-in hosts in local files.
18301
18302 The &(manualroute)& router compares a list of domain patterns with the domain
18303 it is trying to route. If there is no match, the router declines. Each pattern
18304 has associated with it a list of hosts and some other optional data, which may
18305 include a transport. The combination of a pattern and its data is called a
18306 &"routing rule"&. For patterns that do not have an associated transport, the
18307 generic &%transport%& option must specify a transport, unless the router is
18308 being used purely for verification (see &%verify_only%&).
18309
18310 .vindex "&$host$&"
18311 In the case of verification, matching the domain pattern is sufficient for the
18312 router to accept the address. When actually routing an address for delivery,
18313 an address that matches a domain pattern is queued for the associated
18314 transport. If the transport is not a local one, a host list must be associated
18315 with the pattern; IP addresses are looked up for the hosts, and these are
18316 passed to the transport along with the mail address. For local transports, a
18317 host list is optional. If it is present, it is passed in &$host$& as a single
18318 text string.
18319
18320 The list of routing rules can be provided as an inline string in
18321 &%route_list%&, or the data can be obtained by looking up the domain in a file
18322 or database by setting &%route_data%&. Only one of these settings may appear in
18323 any one instance of &(manualroute)&. The format of routing rules is described
18324 below, following the list of private options.
18325
18326
18327 .section "Private options for manualroute" "SECTprioptman"
18328
18329 .cindex "options" "&(manualroute)& router"
18330 The private options for the &(manualroute)& router are as follows:
18331
18332 .option host_all_ignored manualroute string defer
18333 See &%host_find_failed%&.
18334
18335 .option host_find_failed manualroute string freeze
18336 This option controls what happens when &(manualroute)& tries to find an IP
18337 address for a host, and the host does not exist. The option can be set to one
18338 of the following values:
18339 .code
18340 decline
18341 defer
18342 fail
18343 freeze
18344 ignore
18345 pass
18346 .endd
18347 The default (&"freeze"&) assumes that this state is a serious configuration
18348 error. The difference between &"pass"& and &"decline"& is that the former
18349 forces the address to be passed to the next router (or the router defined by
18350 &%pass_router%&),
18351 .oindex "&%more%&"
18352 overriding &%no_more%&, whereas the latter passes the address to the next
18353 router only if &%more%& is true.
18354
18355 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18356 cannot be found. If all the hosts in the list are ignored, the behaviour is
18357 controlled by the &%host_all_ignored%& option. This takes the same values
18358 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18359
18360 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18361 state; if a host lookup gets a temporary error, delivery is deferred unless the
18362 generic &%pass_on_timeout%& option is set.
18363
18364
18365 .option hosts_randomize manualroute boolean false
18366 .cindex "randomized host list"
18367 .cindex "host" "list of; randomized"
18368 If this option is set, the order of the items in a host list in a routing rule
18369 is randomized each time the list is used, unless an option in the routing rule
18370 overrides (see below). Randomizing the order of a host list can be used to do
18371 crude load sharing. However, if more than one mail address is routed by the
18372 same router to the same host list, the host lists are considered to be the same
18373 (even though they may be randomized into different orders) for the purpose of
18374 deciding whether to batch the deliveries into a single SMTP transaction.
18375
18376 When &%hosts_randomize%& is true, a host list may be split
18377 into groups whose order is separately randomized. This makes it possible to
18378 set up MX-like behaviour. The boundaries between groups are indicated by an
18379 item that is just &`+`& in the host list. For example:
18380 .code
18381 route_list = * host1:host2:host3:+:host4:host5
18382 .endd
18383 The order of the first three hosts and the order of the last two hosts is
18384 randomized for each use, but the first three always end up before the last two.
18385 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18386 randomized host list is passed to an &(smtp)& transport that also has
18387 &%hosts_randomize set%&, the list is not re-randomized.
18388
18389
18390 .option route_data manualroute string&!! unset
18391 If this option is set, it must expand to yield the data part of a routing rule.
18392 Typically, the expansion string includes a lookup based on the domain. For
18393 example:
18394 .code
18395 route_data = ${lookup{$domain}dbm{/etc/routes}}
18396 .endd
18397 If the expansion is forced to fail, or the result is an empty string, the
18398 router declines. Other kinds of expansion failure cause delivery to be
18399 deferred.
18400
18401
18402 .option route_list manualroute "string list" unset
18403 This string is a list of routing rules, in the form defined below. Note that,
18404 unlike most string lists, the items are separated by semicolons. This is so
18405 that they may contain colon-separated host lists.
18406
18407
18408 .option same_domain_copy_routing manualroute boolean false
18409 .cindex "address" "copying routing"
18410 Addresses with the same domain are normally routed by the &(manualroute)&
18411 router to the same list of hosts. However, this cannot be presumed, because the
18412 router options and preconditions may refer to the local part of the address. By
18413 default, therefore, Exim routes each address in a message independently. DNS
18414 servers run caches, so repeated DNS lookups are not normally expensive, and in
18415 any case, personal messages rarely have more than a few recipients.
18416
18417 If you are running mailing lists with large numbers of subscribers at the same
18418 domain, and you are using a &(manualroute)& router which is independent of the
18419 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18420 lookups for identical domains in one message. In this case, when
18421 &(manualroute)& routes an address to a remote transport, any other unrouted
18422 addresses in the message that have the same domain are automatically given the
18423 same routing without processing them independently. However, this is only done
18424 if &%headers_add%& and &%headers_remove%& are unset.
18425
18426
18427
18428
18429 .section "Routing rules in route_list" "SECID120"
18430 The value of &%route_list%& is a string consisting of a sequence of routing
18431 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18432 entered as two semicolons. Alternatively, the list separator can be changed as
18433 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18434 Empty rules are ignored. The format of each rule is
18435 .display
18436 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18437 .endd
18438 The following example contains two rules, each with a simple domain pattern and
18439 no options:
18440 .code
18441 route_list = \
18442   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18443   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18444 .endd
18445 The three parts of a rule are separated by white space. The pattern and the
18446 list of hosts can be enclosed in quotes if necessary, and if they are, the
18447 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18448 single domain pattern, which is the only mandatory item in the rule. The
18449 pattern is in the same format as one item in a domain list (see section
18450 &<<SECTdomainlist>>&),
18451 except that it may not be the name of an interpolated file.
18452 That is, it may be wildcarded, or a regular expression, or a file or database
18453 lookup (with semicolons doubled, because of the use of semicolon as a separator
18454 in a &%route_list%&).
18455
18456 The rules in &%route_list%& are searched in order until one of the patterns
18457 matches the domain that is being routed. The list of hosts and then options are
18458 then used as described below. If there is no match, the router declines. When
18459 &%route_list%& is set, &%route_data%& must not be set.
18460
18461
18462
18463 .section "Routing rules in route_data" "SECID121"
18464 The use of &%route_list%& is convenient when there are only a small number of
18465 routing rules. For larger numbers, it is easier to use a file or database to
18466 hold the routing information, and use the &%route_data%& option instead.
18467 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18468 Most commonly, &%route_data%& is set as a string that contains an
18469 expansion lookup. For example, suppose we place two routing rules in a file
18470 like this:
18471 .code
18472 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18473 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18474 .endd
18475 This data can be accessed by setting
18476 .code
18477 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18478 .endd
18479 Failure of the lookup results in an empty string, causing the router to
18480 decline. However, you do not have to use a lookup in &%route_data%&. The only
18481 requirement is that the result of expanding the string is a list of hosts,
18482 possibly followed by options, separated by white space. The list of hosts must
18483 be enclosed in quotes if it contains white space.
18484
18485
18486
18487
18488 .section "Format of the list of hosts" "SECID122"
18489 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18490 always separately expanded before use. If the expansion fails, the router
18491 declines. The result of the expansion must be a colon-separated list of names
18492 and/or IP addresses, optionally also including ports. The format of each item
18493 in the list is described in the next section. The list separator can be changed
18494 as described in section &<<SECTlistconstruct>>&.
18495
18496 If the list of hosts was obtained from a &%route_list%& item, the following
18497 variables are set during its expansion:
18498
18499 .ilist
18500 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18501 If the domain was matched against a regular expression, the numeric variables
18502 &$1$&, &$2$&, etc. may be set. For example:
18503 .code
18504 route_list = ^domain(\d+)   host-$1.text.example
18505 .endd
18506 .next
18507 &$0$& is always set to the entire domain.
18508 .next
18509 &$1$& is also set when partial matching is done in a file lookup.
18510
18511 .next
18512 .vindex "&$value$&"
18513 If the pattern that matched the domain was a lookup item, the data that was
18514 looked up is available in the expansion variable &$value$&. For example:
18515 .code
18516 route_list = lsearch;;/some/file.routes  $value
18517 .endd
18518 .endlist
18519
18520 Note the doubling of the semicolon in the pattern that is necessary because
18521 semicolon is the default route list separator.
18522
18523
18524
18525 .section "Format of one host item" "SECTformatonehostitem"
18526 Each item in the list of hosts is either a host name or an IP address,
18527 optionally with an attached port number. When no port is given, an IP address
18528 is not enclosed in brackets. When a port is specified, it overrides the port
18529 specification on the transport. The port is separated from the name or address
18530 by a colon. This leads to some complications:
18531
18532 .ilist
18533 Because colon is the default separator for the list of hosts, either
18534 the colon that specifies a port must be doubled, or the list separator must
18535 be changed. The following two examples have the same effect:
18536 .code
18537 route_list = * "host1.tld::1225 : host2.tld::1226"
18538 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18539 .endd
18540 .next
18541 When IPv6 addresses are involved, it gets worse, because they contain
18542 colons of their own. To make this case easier, it is permitted to
18543 enclose an IP address (either v4 or v6) in square brackets if a port
18544 number follows. For example:
18545 .code
18546 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18547 .endd
18548 .endlist
18549
18550 .section "How the list of hosts is used" "SECThostshowused"
18551 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18552 the hosts is tried, in the order specified, when carrying out the SMTP
18553 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18554 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18555 transport.
18556
18557 Hosts may be listed by name or by IP address. An unadorned name in the list of
18558 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18559 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18560 records in the DNS. For example:
18561 .code
18562 route_list = *  x.y.z:p.q.r/MX:e.f.g
18563 .endd
18564 If this feature is used with a port specifier, the port must come last. For
18565 example:
18566 .code
18567 route_list = *  dom1.tld/mx::1225
18568 .endd
18569 If the &%hosts_randomize%& option is set, the order of the items in the list is
18570 randomized before any lookups are done. Exim then scans the list; for any name
18571 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18572 be an interface on the local host and the item is not the first in the list,
18573 Exim discards it and any subsequent items. If it is the first item, what
18574 happens is controlled by the
18575 .oindex "&%self%&" "in &(manualroute)& router"
18576 &%self%& option of the router.
18577
18578 A name on the list that is followed by &`/MX`& is replaced with the list of
18579 hosts obtained by looking up MX records for the name. This is always a DNS
18580 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18581 below) are not relevant here. The order of these hosts is determined by the
18582 preference values in the MX records, according to the usual rules. Because
18583 randomizing happens before the MX lookup, it does not affect the order that is
18584 defined by MX preferences.
18585
18586 If the local host is present in the sublist obtained from MX records, but is
18587 not the most preferred host in that list, it and any equally or less
18588 preferred hosts are removed before the sublist is inserted into the main list.
18589
18590 If the local host is the most preferred host in the MX list, what happens
18591 depends on where in the original list of hosts the &`/MX`& item appears. If it
18592 is not the first item (that is, there are previous hosts in the main list),
18593 Exim discards this name and any subsequent items in the main list.
18594
18595 If the MX item is first in the list of hosts, and the local host is the
18596 most preferred host, what happens is controlled by the &%self%& option of the
18597 router.
18598
18599 DNS failures when lookup up the MX records are treated in the same way as DNS
18600 failures when looking up IP addresses: &%pass_on_timeout%& and
18601 &%host_find_failed%& are used when relevant.
18602
18603 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18604 whether obtained from an MX lookup or not.
18605
18606
18607
18608 .section "How the options are used" "SECThowoptused"
18609 The options are a sequence of words; in practice no more than three are ever
18610 present. One of the words can be the name of a transport; this overrides the
18611 &%transport%& option on the router for this particular routing rule only. The
18612 other words (if present) control randomization of the list of hosts on a
18613 per-rule basis, and how the IP addresses of the hosts are to be found when
18614 routing to a remote transport. These options are as follows:
18615
18616 .ilist
18617 &%randomize%&: randomize the order of the hosts in this list, overriding the
18618 setting of &%hosts_randomize%& for this routing rule only.
18619 .next
18620 &%no_randomize%&: do not randomize the order of the hosts in this list,
18621 overriding the setting of &%hosts_randomize%& for this routing rule only.
18622 .next
18623 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18624 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18625 also look in &_/etc/hosts_& or other sources of information.
18626 .next
18627 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18628 no address records are found. If there is a temporary DNS error (such as a
18629 timeout), delivery is deferred.
18630 .endlist
18631
18632 For example:
18633 .code
18634 route_list = domain1  host1:host2:host3  randomize bydns;\
18635              domain2  host4:host5
18636 .endd
18637 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18638 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18639 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18640 or &[gethostbyname()]&, and the result of the lookup is the result of that
18641 call.
18642
18643 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18644 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18645 instead of TRY_AGAIN. That is why the default action is to try a DNS
18646 lookup first. Only if that gives a definite &"no such host"& is the local
18647 function called.
18648
18649
18650
18651 If no IP address for a host can be found, what happens is controlled by the
18652 &%host_find_failed%& option.
18653
18654 .vindex "&$host$&"
18655 When an address is routed to a local transport, IP addresses are not looked up.
18656 The host list is passed to the transport in the &$host$& variable.
18657
18658
18659
18660 .section "Manualroute examples" "SECID123"
18661 In some of the examples that follow, the presence of the &%remote_smtp%&
18662 transport, as defined in the default configuration file, is assumed:
18663
18664 .ilist
18665 .cindex "smart host" "example router"
18666 The &(manualroute)& router can be used to forward all external mail to a
18667 &'smart host'&. If you have set up, in the main part of the configuration, a
18668 named domain list that contains your local domains, for example:
18669 .code
18670 domainlist local_domains = my.domain.example
18671 .endd
18672 You can arrange for all other domains to be routed to a smart host by making
18673 your first router something like this:
18674 .code
18675 smart_route:
18676   driver = manualroute
18677   domains = !+local_domains
18678   transport = remote_smtp
18679   route_list = * smarthost.ref.example
18680 .endd
18681 This causes all non-local addresses to be sent to the single host
18682 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18683 they are tried in order
18684 (but you can use &%hosts_randomize%& to vary the order each time).
18685 Another way of configuring the same thing is this:
18686 .code
18687 smart_route:
18688   driver = manualroute
18689   transport = remote_smtp
18690   route_list = !+local_domains  smarthost.ref.example
18691 .endd
18692 There is no difference in behaviour between these two routers as they stand.
18693 However, they behave differently if &%no_more%& is added to them. In the first
18694 example, the router is skipped if the domain does not match the &%domains%&
18695 precondition; the following router is always tried. If the router runs, it
18696 always matches the domain and so can never decline. Therefore, &%no_more%&
18697 would have no effect. In the second case, the router is never skipped; it
18698 always runs. However, if it doesn't match the domain, it declines. In this case
18699 &%no_more%& would prevent subsequent routers from running.
18700
18701 .next
18702 .cindex "mail hub example"
18703 A &'mail hub'& is a host which receives mail for a number of domains via MX
18704 records in the DNS and delivers it via its own private routing mechanism. Often
18705 the final destinations are behind a firewall, with the mail hub being the one
18706 machine that can connect to machines both inside and outside the firewall. The
18707 &(manualroute)& router is usually used on a mail hub to route incoming messages
18708 to the correct hosts. For a small number of domains, the routing can be inline,
18709 using the &%route_list%& option, but for a larger number a file or database
18710 lookup is easier to manage.
18711
18712 If the domain names are in fact the names of the machines to which the mail is
18713 to be sent by the mail hub, the configuration can be quite simple. For
18714 example:
18715 .code
18716 hub_route:
18717   driver = manualroute
18718   transport = remote_smtp
18719   route_list = *.rhodes.tvs.example  $domain
18720 .endd
18721 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18722 whose names are the same as the mail domains. A similar approach can be taken
18723 if the host name can be obtained from the domain name by a string manipulation
18724 that the expansion facilities can handle. Otherwise, a lookup based on the
18725 domain can be used to find the host:
18726 .code
18727 through_firewall:
18728   driver = manualroute
18729   transport = remote_smtp
18730   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18731 .endd
18732 The result of the lookup must be the name or IP address of the host (or
18733 hosts) to which the address is to be routed. If the lookup fails, the route
18734 data is empty, causing the router to decline. The address then passes to the
18735 next router.
18736
18737 .next
18738 .cindex "batched SMTP output example"
18739 .cindex "SMTP" "batched outgoing; example"
18740 You can use &(manualroute)& to deliver messages to pipes or files in batched
18741 SMTP format for onward transportation by some other means. This is one way of
18742 storing mail for a dial-up host when it is not connected. The route list entry
18743 can be as simple as a single domain name in a configuration like this:
18744 .code
18745 save_in_file:
18746   driver = manualroute
18747   transport = batchsmtp_appendfile
18748   route_list = saved.domain.example
18749 .endd
18750 though often a pattern is used to pick up more than one domain. If there are
18751 several domains or groups of domains with different transport requirements,
18752 different transports can be listed in the routing information:
18753 .code
18754 save_in_file:
18755   driver = manualroute
18756   route_list = \
18757     *.saved.domain1.example  $domain  batch_appendfile; \
18758     *.saved.domain2.example  \
18759       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18760       batch_pipe
18761 .endd
18762 .vindex "&$domain$&"
18763 .vindex "&$host$&"
18764 The first of these just passes the domain in the &$host$& variable, which
18765 doesn't achieve much (since it is also in &$domain$&), but the second does a
18766 file lookup to find a value to pass, causing the router to decline to handle
18767 the address if the lookup fails.
18768
18769 .next
18770 .cindex "UUCP" "example of router for"
18771 Routing mail directly to UUCP software is a specific case of the use of
18772 &(manualroute)& in a gateway to another mail environment. This is an example of
18773 one way it can be done:
18774 .code
18775 # Transport
18776 uucp:
18777   driver = pipe
18778   user = nobody
18779   command = /usr/local/bin/uux -r - \
18780     ${substr_-5:$host}!rmail ${local_part}
18781   return_fail_output = true
18782
18783 # Router
18784 uucphost:
18785   transport = uucp
18786   driver = manualroute
18787   route_data = \
18788     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18789 .endd
18790 The file &_/usr/local/exim/uucphosts_& contains entries like
18791 .code
18792 darksite.ethereal.example:           darksite.UUCP
18793 .endd
18794 It can be set up more simply without adding and removing &".UUCP"& but this way
18795 makes clear the distinction between the domain name
18796 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18797 .endlist
18798 .ecindex IIDmanrou1
18799 .ecindex IIDmanrou2
18800
18801
18802
18803
18804
18805
18806
18807
18808 . ////////////////////////////////////////////////////////////////////////////
18809 . ////////////////////////////////////////////////////////////////////////////
18810
18811 .chapter "The queryprogram router" "CHAPdriverlast"
18812 .scindex IIDquerou1 "&(queryprogram)& router"
18813 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18814 .cindex "routing" "by external program"
18815 The &(queryprogram)& router routes an address by running an external command
18816 and acting on its output. This is an expensive way to route, and is intended
18817 mainly for use in lightly-loaded systems, or for performing experiments.
18818 However, if it is possible to use the precondition options (&%domains%&,
18819 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18820 be used in special cases, even on a busy host. There are the following private
18821 options:
18822 .cindex "options" "&(queryprogram)& router"
18823
18824 .option command queryprogram string&!! unset
18825 This option must be set. It specifies the command that is to be run. The
18826 command is split up into a command name and arguments, and then each is
18827 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18828 &<<CHAPpipetransport>>&).
18829
18830
18831 .option command_group queryprogram string unset
18832 .cindex "gid (group id)" "in &(queryprogram)& router"
18833 This option specifies a gid to be set when running the command while routing an
18834 address for deliver. It must be set if &%command_user%& specifies a numerical
18835 uid. If it begins with a digit, it is interpreted as the numerical value of the
18836 gid. Otherwise it is looked up using &[getgrnam()]&.
18837
18838
18839 .option command_user queryprogram string unset
18840 .cindex "uid (user id)" "for &(queryprogram)&"
18841 This option must be set. It specifies the uid which is set when running the
18842 command while routing an address for delivery. If the value begins with a digit,
18843 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18844 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18845 not set, a value for the gid also.
18846
18847 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18848 root, which it does during a normal delivery in a conventional configuration.
18849 However, when an address is being verified during message reception, Exim is
18850 usually running as the Exim user, not as root. If the &(queryprogram)& router
18851 is called from a non-root process, Exim cannot change uid or gid before running
18852 the command. In this circumstance the command runs under the current uid and
18853 gid.
18854
18855
18856 .option current_directory queryprogram string /
18857 This option specifies an absolute path which is made the current directory
18858 before running the command.
18859
18860
18861 .option timeout queryprogram time 1h
18862 If the command does not complete within the timeout period, its process group
18863 is killed and the message is frozen. A value of zero time specifies no
18864 timeout.
18865
18866
18867 The standard output of the command is connected to a pipe, which is read when
18868 the command terminates. It should consist of a single line of output,
18869 containing up to five fields, separated by white space. The maximum length of
18870 the line is 1023 characters. Longer lines are silently truncated. The first
18871 field is one of the following words (case-insensitive):
18872
18873 .ilist
18874 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18875 below).
18876 .next
18877 &'Decline'&: the router declines; pass the address to the next router, unless
18878 &%no_more%& is set.
18879 .next
18880 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18881 subsequent text on the line is an error message. If the router is run as part
18882 of address verification during an incoming SMTP message, the message is
18883 included in the SMTP response.
18884 .next
18885 &'Defer'&: routing could not be completed at this time; try again later. Any
18886 subsequent text on the line is an error message which is logged. It is not
18887 included in any SMTP response.
18888 .next
18889 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18890 .next
18891 &'Pass'&: pass the address to the next router (or the router specified by
18892 &%pass_router%&), overriding &%no_more%&.
18893 .next
18894 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18895 new addresses, which are routed independently, starting with the first router,
18896 or the router specified by &%redirect_router%&, if set.
18897 .endlist
18898
18899 When the first word is &'accept'&, the remainder of the line consists of a
18900 number of keyed data values, as follows (split into two lines here, to fit on
18901 the page):
18902 .code
18903 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18904 LOOKUP=byname|bydns DATA=<text>
18905 .endd
18906 The data items can be given in any order, and all are optional. If no transport
18907 is included, the transport specified by the generic &%transport%& option is
18908 used. The list of hosts and the lookup type are needed only if the transport is
18909 an &(smtp)& transport that does not itself supply a list of hosts.
18910
18911 The format of the list of hosts is the same as for the &(manualroute)& router.
18912 As well as host names and IP addresses with optional port numbers, as described
18913 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18914 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18915 (see section &<<SECThostshowused>>&).
18916
18917 If the lookup type is not specified, Exim behaves as follows when trying to
18918 find an IP address for each host: First, a DNS lookup is done. If this yields
18919 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18920 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18921 result of the lookup is the result of that call.
18922
18923 .vindex "&$address_data$&"
18924 If the DATA field is set, its value is placed in the &$address_data$&
18925 variable. For example, this return line
18926 .code
18927 accept hosts=x1.y.example:x2.y.example data="rule1"
18928 .endd
18929 routes the address to the default transport, passing a list of two hosts. When
18930 the transport runs, the string &"rule1"& is in &$address_data$&.
18931 .ecindex IIDquerou1
18932 .ecindex IIDquerou2
18933
18934
18935
18936
18937 . ////////////////////////////////////////////////////////////////////////////
18938 . ////////////////////////////////////////////////////////////////////////////
18939
18940 .chapter "The redirect router" "CHAPredirect"
18941 .scindex IIDredrou1 "&(redirect)& router"
18942 .scindex IIDredrou2 "routers" "&(redirect)&"
18943 .cindex "alias file" "in a &(redirect)& router"
18944 .cindex "address redirection" "&(redirect)& router"
18945 The &(redirect)& router handles several kinds of address redirection. Its most
18946 common uses are for resolving local part aliases from a central alias file
18947 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18948 files, but it has many other potential uses. The incoming address can be
18949 redirected in several different ways:
18950
18951 .ilist
18952 It can be replaced by one or more new addresses which are themselves routed
18953 independently.
18954 .next
18955 It can be routed to be delivered to a given file or directory.
18956 .next
18957 It can be routed to be delivered to a specified pipe command.
18958 .next
18959 It can cause an automatic reply to be generated.
18960 .next
18961 It can be forced to fail, optionally with a custom error message.
18962 .next
18963 It can be temporarily deferred, optionally with a custom message.
18964 .next
18965 It can be discarded.
18966 .endlist
18967
18968 The generic &%transport%& option must not be set for &(redirect)& routers.
18969 However, there are some private options which define transports for delivery to
18970 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18971 &%pipe_transport%& and &%reply_transport%& descriptions below.
18972
18973
18974
18975 .section "Redirection data" "SECID124"
18976 The router operates by interpreting a text string which it obtains either by
18977 expanding the contents of the &%data%& option, or by reading the entire
18978 contents of a file whose name is given in the &%file%& option. These two
18979 options are mutually exclusive. The first is commonly used for handling system
18980 aliases, in a configuration like this:
18981 .code
18982 system_aliases:
18983   driver = redirect
18984   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18985 .endd
18986 If the lookup fails, the expanded string in this example is empty. When the
18987 expansion of &%data%& results in an empty string, the router declines. A forced
18988 expansion failure also causes the router to decline; other expansion failures
18989 cause delivery to be deferred.
18990
18991 A configuration using &%file%& is commonly used for handling users'
18992 &_.forward_& files, like this:
18993 .code
18994 userforward:
18995   driver = redirect
18996   check_local_user
18997   file = $home/.forward
18998   no_verify
18999 .endd
19000 If the file does not exist, or causes no action to be taken (for example, it is
19001 empty or consists only of comments), the router declines. &*Warning*&: This
19002 is not the case when the file contains syntactically valid items that happen to
19003 yield empty addresses, for example, items containing only RFC 2822 address
19004 comments.
19005
19006
19007
19008 .section "Forward files and address verification" "SECID125"
19009 .cindex "address redirection" "while verifying"
19010 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19011 &_.forward_& files, as in the example above. There are two reasons for this:
19012
19013 .ilist
19014 When Exim is receiving an incoming SMTP message from a remote host, it is
19015 running under the Exim uid, not as root. Exim is unable to change uid to read
19016 the file as the user, and it may not be able to read it as the Exim user. So in
19017 practice the router may not be able to operate.
19018 .next
19019 However, even when the router can operate, the existence of a &_.forward_& file
19020 is unimportant when verifying an address. What should be checked is whether the
19021 local part is a valid user name or not. Cutting out the redirection processing
19022 saves some resources.
19023 .endlist
19024
19025
19026
19027
19028
19029
19030 .section "Interpreting redirection data" "SECID126"
19031 .cindex "Sieve filter" "specifying in redirection data"
19032 .cindex "filter" "specifying in redirection data"
19033 The contents of the data string, whether obtained from &%data%& or &%file%&,
19034 can be interpreted in two different ways:
19035
19036 .ilist
19037 If the &%allow_filter%& option is set true, and the data begins with the text
19038 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19039 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19040 respectively. Details of the syntax and semantics of filter files are described
19041 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19042 document is intended for use by end users.
19043 .next
19044 Otherwise, the data must be a comma-separated list of redirection items, as
19045 described in the next section.
19046 .endlist
19047
19048 When a message is redirected to a file (a &"mail folder"&), the file name given
19049 in a non-filter redirection list must always be an absolute path. A filter may
19050 generate a relative path &-- how this is handled depends on the transport's
19051 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19052 for the &(appendfile)& transport.
19053
19054
19055
19056 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19057 .cindex "address redirection" "non-filter list items"
19058 When the redirection data is not an Exim or Sieve filter, for example, if it
19059 comes from a conventional alias or forward file, it consists of a list of
19060 addresses, file names, pipe commands, or certain special items (see section
19061 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19062 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19063 depending on their default values. The items in the list are separated by
19064 commas or newlines.
19065 If a comma is required in an item, the entire item must be enclosed in double
19066 quotes.
19067
19068 Lines starting with a # character are comments, and are ignored, and # may
19069 also appear following a comma, in which case everything between the # and the
19070 next newline character is ignored.
19071
19072 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19073 double quotes are retained because some forms of mail address require their use
19074 (but never to enclose the entire address). In the following description,
19075 &"item"& refers to what remains after any surrounding double quotes have been
19076 removed.
19077
19078 .vindex "&$local_part$&"
19079 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19080 and the expansion contains a reference to &$local_part$&, you should make use
19081 of the &%quote_local_part%& expansion operator, in case the local part contains
19082 special characters. For example, to redirect all mail for the domain
19083 &'obsolete.example'&, retaining the existing local part, you could use this
19084 setting:
19085 .code
19086 data = ${quote_local_part:$local_part}@newdomain.example
19087 .endd
19088
19089
19090 .section "Redirecting to a local mailbox" "SECTredlocmai"
19091 .cindex "routing" "loops in"
19092 .cindex "loop" "while routing, avoidance of"
19093 .cindex "address redirection" "to local mailbox"
19094 A redirection item may safely be the same as the address currently under
19095 consideration. This does not cause a routing loop, because a router is
19096 automatically skipped if any ancestor of the address that is being processed
19097 is the same as the current address and was processed by the current router.
19098 Such an address is therefore passed to the following routers, so it is handled
19099 as if there were no redirection. When making this loop-avoidance test, the
19100 complete local part, including any prefix or suffix, is used.
19101
19102 .cindex "address redirection" "local part without domain"
19103 Specifying the same local part without a domain is a common usage in personal
19104 filter files when the user wants to have messages delivered to the local
19105 mailbox and also forwarded elsewhere. For example, the user whose login is
19106 &'cleo'& might have a &_.forward_& file containing this:
19107 .code
19108 cleo, cleopatra@egypt.example
19109 .endd
19110 .cindex "backslash in alias file"
19111 .cindex "alias file" "backslash in"
19112 For compatibility with other MTAs, such unqualified local parts may be
19113 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19114 it does make a difference if more than one domain is being handled
19115 synonymously.
19116
19117 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19118 2822 address that does not include a domain, the item is qualified using the
19119 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19120 addresses are qualified using the value in &%qualify_recipient%&, but you can
19121 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19122
19123 Care must be taken if there are alias names for local users.
19124 Consider an MTA handling a single local domain where the system alias file
19125 contains:
19126 .code
19127 Sam.Reman: spqr
19128 .endd
19129 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19130 messages in the local mailbox, and also forward copies elsewhere. He creates
19131 this forward file:
19132 .code
19133 Sam.Reman, spqr@reme.elsewhere.example
19134 .endd
19135 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19136 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19137 second time round, because it has previously routed it,
19138 and the following routers presumably cannot handle the alias. The forward file
19139 should really contain
19140 .code
19141 spqr, spqr@reme.elsewhere.example
19142 .endd
19143 but because this is such a common error, the &%check_ancestor%& option (see
19144 below) exists to provide a way to get round it. This is normally set on a
19145 &(redirect)& router that is handling users' &_.forward_& files.
19146
19147
19148
19149 .section "Special items in redirection lists" "SECTspecitredli"
19150 In addition to addresses, the following types of item may appear in redirection
19151 lists (that is, in non-filter redirection data):
19152
19153 .ilist
19154 .cindex "pipe" "in redirection list"
19155 .cindex "address redirection" "to pipe"
19156 An item is treated as a pipe command if it begins with &"|"& and does not parse
19157 as a valid RFC 2822 address that includes a domain. A transport for running the
19158 command must be specified by the &%pipe_transport%& option.
19159 Normally, either the router or the transport specifies a user and a group under
19160 which to run the delivery. The default is to use the Exim user and group.
19161
19162 Single or double quotes can be used for enclosing the individual arguments of
19163 the pipe command; no interpretation of escapes is done for single quotes. If
19164 the command contains a comma character, it is necessary to put the whole item
19165 in double quotes, for example:
19166 .code
19167 "|/some/command ready,steady,go"
19168 .endd
19169 since items in redirection lists are terminated by commas. Do not, however,
19170 quote just the command. An item such as
19171 .code
19172 |"/some/command ready,steady,go"
19173 .endd
19174 is interpreted as a pipe with a rather strange command name, and no arguments.
19175
19176 Note that the above example assumes that the text comes from a lookup source
19177 of some sort, so that the quotes are part of the data.  If composing a
19178 redirect router with a &%data%& option directly specifying this command, the
19179 quotes will be used by the configuration parser to define the extent of one
19180 string, but will not be passed down into the redirect router itself.  There
19181 are two main approaches to get around this: escape quotes to be part of the
19182 data itself, or avoid using this mechanism and instead create a custom
19183 transport with the &%command%& option set and reference that transport from
19184 an &%accept%& router.
19185
19186 .next
19187 .cindex "file" "in redirection list"
19188 .cindex "address redirection" "to file"
19189 An item is interpreted as a path name if it begins with &"/"& and does not
19190 parse as a valid RFC 2822 address that includes a domain. For example,
19191 .code
19192 /home/world/minbari
19193 .endd
19194 is treated as a file name, but
19195 .code
19196 /s=molari/o=babylon/@x400gate.way
19197 .endd
19198 is treated as an address. For a file name, a transport must be specified using
19199 the &%file_transport%& option. However, if the generated path name ends with a
19200 forward slash character, it is interpreted as a directory name rather than a
19201 file name, and &%directory_transport%& is used instead.
19202
19203 Normally, either the router or the transport specifies a user and a group under
19204 which to run the delivery. The default is to use the Exim user and group.
19205
19206 .cindex "&_/dev/null_&"
19207 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19208 bypassed at a high level, and the log entry shows &"**bypassed**"&
19209 instead of a transport name. In this case the user and group are not used.
19210
19211 .next
19212 .cindex "included address list"
19213 .cindex "address redirection" "included external list"
19214 If an item is of the form
19215 .code
19216 :include:<path name>
19217 .endd
19218 a list of further items is taken from the given file and included at that
19219 point. &*Note*&: Such a file can not be a filter file; it is just an
19220 out-of-line addition to the list. The items in the included list are separated
19221 by commas or newlines and are not subject to expansion. If this is the first
19222 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19223 the alias name. This example is incorrect:
19224 .code
19225 list1    :include:/opt/lists/list1
19226 .endd
19227 It must be given as
19228 .code
19229 list1:   :include:/opt/lists/list1
19230 .endd
19231 .next
19232 .cindex "address redirection" "to black hole"
19233 Sometimes you want to throw away mail to a particular local part. Making the
19234 &%data%& option expand to an empty string does not work, because that causes
19235 the router to decline. Instead, the alias item
19236 .cindex "black hole"
19237 .cindex "abandoning mail"
19238 &':blackhole:'& can be used. It does what its name implies. No delivery is
19239 done, and no error message is generated. This has the same effect as specifing
19240 &_/dev/null_& as a destination, but it can be independently disabled.
19241
19242 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19243 delivery is done for the original local part, even if other redirection items
19244 are present. If you are generating a multi-item list (for example, by reading a
19245 database) and need the ability to provide a no-op item, you must use
19246 &_/dev/null_&.
19247
19248 .next
19249 .cindex "delivery" "forcing failure"
19250 .cindex "delivery" "forcing deferral"
19251 .cindex "failing delivery" "forcing"
19252 .cindex "deferred delivery, forcing"
19253 .cindex "customizing" "failure message"
19254 An attempt to deliver a particular address can be deferred or forced to fail by
19255 redirection items of the form
19256 .code
19257 :defer:
19258 :fail:
19259 .endd
19260 respectively. When a redirection list contains such an item, it applies
19261 to the entire redirection; any other items in the list are ignored. Any
19262 text following &':fail:'& or &':defer:'& is placed in the error text
19263 associated with the failure. For example, an alias file might contain:
19264 .code
19265 X.Employee:  :fail: Gone away, no forwarding address
19266 .endd
19267 In the case of an address that is being verified from an ACL or as the subject
19268 of a
19269 .cindex "VRFY" "error text, display of"
19270 VRFY command, the text is included in the SMTP error response by
19271 default.
19272 .cindex "EXPN" "error text, display of"
19273 The text is not included in the response to an EXPN command. In non-SMTP cases
19274 the text is included in the error message that Exim generates.
19275
19276 .cindex "SMTP" "error codes"
19277 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19278 &':fail:'&. However, if the message starts with three digits followed by a
19279 space, optionally followed by an extended code of the form &'n.n.n'&, also
19280 followed by a space, and the very first digit is the same as the default error
19281 code, the code from the message is used instead. If the very first digit is
19282 incorrect, a panic error is logged, and the default code is used. You can
19283 suppress the use of the supplied code in a redirect router by setting the
19284 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19285 ignored.
19286
19287 .vindex "&$acl_verify_message$&"
19288 In an ACL, an explicitly provided message overrides the default, but the
19289 default message is available in the variable &$acl_verify_message$& and can
19290 therefore be included in a custom message if this is desired.
19291
19292 Normally the error text is the rest of the redirection list &-- a comma does
19293 not terminate it &-- but a newline does act as a terminator. Newlines are not
19294 normally present in alias expansions. In &(lsearch)& lookups they are removed
19295 as part of the continuation process, but they may exist in other kinds of
19296 lookup and in &':include:'& files.
19297
19298 During routing for message delivery (as opposed to verification), a redirection
19299 containing &':fail:'& causes an immediate failure of the incoming address,
19300 whereas &':defer:'& causes the message to remain on the queue so that a
19301 subsequent delivery attempt can happen at a later time. If an address is
19302 deferred for too long, it will ultimately fail, because the normal retry
19303 rules still apply.
19304
19305 .next
19306 .cindex "alias file" "exception to default"
19307 Sometimes it is useful to use a single-key search type with a default (see
19308 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19309 for exceptions to the default. These can be handled by aliasing them to
19310 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19311 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19312 results in an empty redirection list has the same effect.
19313 .endlist
19314
19315
19316 .section "Duplicate addresses" "SECTdupaddr"
19317 .cindex "duplicate addresses"
19318 .cindex "address duplicate, discarding"
19319 .cindex "pipe" "duplicated"
19320 Exim removes duplicate addresses from the list to which it is delivering, so as
19321 to deliver just one copy to each address. This does not apply to deliveries
19322 routed to pipes by different immediate parent addresses, but an indirect
19323 aliasing scheme of the type
19324 .code
19325 pipe:       |/some/command $local_part
19326 localpart1: pipe
19327 localpart2: pipe
19328 .endd
19329 does not work with a message that is addressed to both local parts, because
19330 when the second is aliased to the intermediate local part &"pipe"& it gets
19331 discarded as being the same as a previously handled address. However, a scheme
19332 such as
19333 .code
19334 localpart1: |/some/command $local_part
19335 localpart2: |/some/command $local_part
19336 .endd
19337 does result in two different pipe deliveries, because the immediate parents of
19338 the pipes are distinct.
19339
19340
19341
19342 .section "Repeated redirection expansion" "SECID128"
19343 .cindex "repeated redirection expansion"
19344 .cindex "address redirection" "repeated for each delivery attempt"
19345 When a message cannot be delivered to all of its recipients immediately,
19346 leading to two or more delivery attempts, redirection expansion is carried out
19347 afresh each time for those addresses whose children were not all previously
19348 delivered. If redirection is being used as a mailing list, this can lead to new
19349 members of the list receiving copies of old messages. The &%one_time%& option
19350 can be used to avoid this.
19351
19352
19353 .section "Errors in redirection lists" "SECID129"
19354 .cindex "address redirection" "errors"
19355 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19356 error is skipped, and an entry is written to the main log. This may be useful
19357 for mailing lists that are automatically managed. Otherwise, if an error is
19358 detected while generating the list of new addresses, the original address is
19359 deferred. See also &%syntax_errors_to%&.
19360
19361
19362
19363 .section "Private options for the redirect router" "SECID130"
19364
19365 .cindex "options" "&(redirect)& router"
19366 The private options for the &(redirect)& router are as follows:
19367
19368
19369 .option allow_defer redirect boolean false
19370 Setting this option allows the use of &':defer:'& in non-filter redirection
19371 data, or the &%defer%& command in an Exim filter file.
19372
19373
19374 .option allow_fail redirect boolean false
19375 .cindex "failing delivery" "from filter"
19376 If this option is true, the &':fail:'& item can be used in a redirection list,
19377 and the &%fail%& command may be used in an Exim filter file.
19378
19379
19380 .option allow_filter redirect boolean false
19381 .cindex "filter" "enabling use of"
19382 .cindex "Sieve filter" "enabling use of"
19383 Setting this option allows Exim to interpret redirection data that starts with
19384 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19385 are some features of Exim filter files that some administrators may wish to
19386 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19387
19388 It is also possible to lock out Exim filters or Sieve filters while allowing
19389 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19390
19391
19392 The filter is run using the uid and gid set by the generic &%user%& and
19393 &%group%& options. These take their defaults from the password data if
19394 &%check_local_user%& is set, so in the normal case of users' personal filter
19395 files, the filter is run as the relevant user. When &%allow_filter%& is set
19396 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19397
19398
19399
19400 .option allow_freeze redirect boolean false
19401 .cindex "freezing messages" "allowing in filter"
19402 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19403 This command is more normally encountered in system filters, and is disabled by
19404 default for redirection filters because it isn't something you usually want to
19405 let ordinary users do.
19406
19407
19408
19409 .option check_ancestor redirect boolean false
19410 This option is concerned with handling generated addresses that are the same
19411 as some address in the list of redirection ancestors of the current address.
19412 Although it is turned off by default in the code, it is set in the default
19413 configuration file for handling users' &_.forward_& files. It is recommended
19414 for this use of the &(redirect)& router.
19415
19416 When &%check_ancestor%& is set, if a generated address (including the domain)
19417 is the same as any ancestor of the current address, it is replaced by a copy of
19418 the current address. This helps in the case where local part A is aliased to B,
19419 and B has a &_.forward_& file pointing back to A. For example, within a single
19420 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19421 &_&~jb/.forward_& contains:
19422 .code
19423 \Joe.Bloggs, <other item(s)>
19424 .endd
19425 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19426 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19427 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19428 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19429 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19430 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19431 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19432 original address. See also the &%repeat_use%& option below.
19433
19434
19435 .option check_group redirect boolean "see below"
19436 When the &%file%& option is used, the group owner of the file is checked only
19437 when this option is set. The permitted groups are those listed in the
19438 &%owngroups%& option, together with the user's default group if
19439 &%check_local_user%& is set. If the file has the wrong group, routing is
19440 deferred. The default setting for this option is true if &%check_local_user%&
19441 is set and the &%modemask%& option permits the group write bit, or if the
19442 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19443
19444
19445
19446 .option check_owner redirect boolean "see below"
19447 When the &%file%& option is used, the owner of the file is checked only when
19448 this option is set. If &%check_local_user%& is set, the local user is
19449 permitted; otherwise the owner must be one of those listed in the &%owners%&
19450 option. The default value for this option is true if &%check_local_user%& or
19451 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19452
19453
19454 .option data redirect string&!! unset
19455 This option is mutually exclusive with &%file%&. One or other of them must be
19456 set, but not both. The contents of &%data%& are expanded, and then used as the
19457 list of forwarding items, or as a set of filtering instructions. If the
19458 expansion is forced to fail, or the result is an empty string or a string that
19459 has no effect (consists entirely of comments), the router declines.
19460
19461 When filtering instructions are used, the string must begin with &"#Exim
19462 filter"&, and all comments in the string, including this initial one, must be
19463 terminated with newline characters. For example:
19464 .code
19465 data = #Exim filter\n\
19466        if $h_to: contains Exim then save $home/mail/exim endif
19467 .endd
19468 If you are reading the data from a database where newlines cannot be included,
19469 you can use the &${sg}$& expansion item to turn the escape string of your
19470 choice into a newline.
19471
19472
19473 .option directory_transport redirect string&!! unset
19474 A &(redirect)& router sets up a direct delivery to a directory when a path name
19475 ending with a slash is specified as a new &"address"&. The transport used is
19476 specified by this option, which, after expansion, must be the name of a
19477 configured transport. This should normally be an &(appendfile)& transport.
19478
19479
19480 .option file redirect string&!! unset
19481 This option specifies the name of a file that contains the redirection data. It
19482 is mutually exclusive with the &%data%& option. The string is expanded before
19483 use; if the expansion is forced to fail, the router declines. Other expansion
19484 failures cause delivery to be deferred. The result of a successful expansion
19485 must be an absolute path. The entire file is read and used as the redirection
19486 data. If the data is an empty string or a string that has no effect (consists
19487 entirely of comments), the router declines.
19488
19489 .cindex "NFS" "checking for file existence"
19490 If the attempt to open the file fails with a &"does not exist"& error, Exim
19491 runs a check on the containing directory,
19492 unless &%ignore_enotdir%& is true (see below).
19493 If the directory does not appear to exist, delivery is deferred. This can
19494 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19495 is a mount problem. If the containing directory does exist, but the file does
19496 not, the router declines.
19497
19498
19499 .option file_transport redirect string&!! unset
19500 .vindex "&$address_file$&"
19501 A &(redirect)& router sets up a direct delivery to a file when a path name not
19502 ending in a slash is specified as a new &"address"&. The transport used is
19503 specified by this option, which, after expansion, must be the name of a
19504 configured transport. This should normally be an &(appendfile)& transport. When
19505 it is running, the file name is in &$address_file$&.
19506
19507
19508 .option filter_prepend_home redirect boolean true
19509 When this option is true, if a &(save)& command in an Exim filter specifies a
19510 relative path, and &$home$& is defined, it is automatically prepended to the
19511 relative path. If this option is set false, this action does not happen. The
19512 relative path is then passed to the transport unmodified.
19513
19514
19515 .option forbid_blackhole redirect boolean false
19516 If this option is true, the &':blackhole:'& item may not appear in a
19517 redirection list.
19518
19519
19520 .option forbid_exim_filter redirect boolean false
19521 If this option is set true, only Sieve filters are permitted when
19522 &%allow_filter%& is true.
19523
19524
19525
19526
19527 .option forbid_file redirect boolean false
19528 .cindex "delivery" "to file; forbidding"
19529 .cindex "Sieve filter" "forbidding delivery to a file"
19530 .cindex "Sieve filter" "&""keep""& facility; disabling"
19531 If this option is true, this router may not generate a new address that
19532 specifies delivery to a local file or directory, either from a filter or from a
19533 conventional forward file. This option is forced to be true if &%one_time%& is
19534 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19535 locks out the Sieve's &"keep"& facility.
19536
19537
19538 .option forbid_filter_dlfunc redirect boolean false
19539 .cindex "filter" "locking out certain features"
19540 If this option is true, string expansions in Exim filters are not allowed to
19541 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19542 functions.
19543
19544 .option forbid_filter_existstest redirect boolean false
19545 .cindex "expansion" "statting a file"
19546 If this option is true, string expansions in Exim filters are not allowed to
19547 make use of the &%exists%& condition or the &%stat%& expansion item.
19548
19549 .option forbid_filter_logwrite redirect boolean false
19550 If this option is true, use of the logging facility in Exim filters is not
19551 permitted. Logging is in any case available only if the filter is being run
19552 under some unprivileged uid (which is normally the case for ordinary users'
19553 &_.forward_& files).
19554
19555
19556 .option forbid_filter_lookup redirect boolean false
19557 If this option is true, string expansions in Exim filter files are not allowed
19558 to make use of &%lookup%& items.
19559
19560
19561 .option forbid_filter_perl redirect boolean false
19562 This option has an effect only if Exim is built with embedded Perl support. If
19563 it is true, string expansions in Exim filter files are not allowed to make use
19564 of the embedded Perl support.
19565
19566
19567 .option forbid_filter_readfile redirect boolean false
19568 If this option is true, string expansions in Exim filter files are not allowed
19569 to make use of &%readfile%& items.
19570
19571
19572 .option forbid_filter_readsocket redirect boolean false
19573 If this option is true, string expansions in Exim filter files are not allowed
19574 to make use of &%readsocket%& items.
19575
19576
19577 .option forbid_filter_reply redirect boolean false
19578 If this option is true, this router may not generate an automatic reply
19579 message. Automatic replies can be generated only from Exim or Sieve filter
19580 files, not from traditional forward files. This option is forced to be true if
19581 &%one_time%& is set.
19582
19583
19584 .option forbid_filter_run redirect boolean false
19585 If this option is true, string expansions in Exim filter files are not allowed
19586 to make use of &%run%& items.
19587
19588
19589 .option forbid_include redirect boolean false
19590 If this option is true, items of the form
19591 .code
19592 :include:<path name>
19593 .endd
19594 are not permitted in non-filter redirection lists.
19595
19596
19597 .option forbid_pipe redirect boolean false
19598 .cindex "delivery" "to pipe; forbidding"
19599 If this option is true, this router may not generate a new address which
19600 specifies delivery to a pipe, either from an Exim filter or from a conventional
19601 forward file. This option is forced to be true if &%one_time%& is set.
19602
19603
19604 .option forbid_sieve_filter redirect boolean false
19605 If this option is set true, only Exim filters are permitted when
19606 &%allow_filter%& is true.
19607
19608
19609 .cindex "SMTP" "error codes"
19610 .option forbid_smtp_code redirect boolean false
19611 If this option is set true, any SMTP error codes that are present at the start
19612 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19613 the default codes (451 and 550, respectively) are always used.
19614
19615
19616
19617
19618 .option hide_child_in_errmsg redirect boolean false
19619 .cindex "bounce message" "redirection details; suppressing"
19620 If this option is true, it prevents Exim from quoting a child address if it
19621 generates a bounce or delay message for it. Instead it says &"an address
19622 generated from <&'the top level address'&>"&. Of course, this applies only to
19623 bounces generated locally. If a message is forwarded to another host, &'its'&
19624 bounce may well quote the generated address.
19625
19626
19627 .option ignore_eacces redirect boolean false
19628 .cindex "EACCES"
19629 If this option is set and an attempt to open a redirection file yields the
19630 EACCES error (permission denied), the &(redirect)& router behaves as if the
19631 file did not exist.
19632
19633
19634 .option ignore_enotdir redirect boolean false
19635 .cindex "ENOTDIR"
19636 If this option is set and an attempt to open a redirection file yields the
19637 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19638 router behaves as if the file did not exist.
19639
19640 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19641 router that has the &%file%& option set discovers that the file does not exist
19642 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19643 against unmounted NFS directories. If the parent can not be statted, delivery
19644 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19645 is set, because that option tells Exim to ignore &"something on the path is not
19646 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19647 that some operating systems give ENOENT where others give ENOTDIR.
19648
19649
19650
19651 .option include_directory redirect string unset
19652 If this option is set, the path names of any &':include:'& items in a
19653 redirection list must start with this directory.
19654
19655
19656 .option modemask redirect "octal integer" 022
19657 This specifies mode bits which must not be set for a file specified by the
19658 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19659
19660
19661 .option one_time redirect boolean false
19662 .cindex "one-time aliasing/forwarding expansion"
19663 .cindex "alias file" "one-time expansion"
19664 .cindex "forward file" "one-time expansion"
19665 .cindex "mailing lists" "one-time expansion"
19666 .cindex "address redirection" "one-time expansion"
19667 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19668 files each time it tries to deliver a message causes a problem when one or more
19669 of the generated addresses fails be delivered at the first attempt. The problem
19670 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19671 but of what happens when the redirection list changes during the time that the
19672 message is on Exim's queue. This is particularly true in the case of mailing
19673 lists, where new subscribers might receive copies of messages that were posted
19674 before they subscribed.
19675
19676 If &%one_time%& is set and any addresses generated by the router fail to
19677 deliver at the first attempt, the failing addresses are added to the message as
19678 &"top level"& addresses, and the parent address that generated them is marked
19679 &"delivered"&. Thus, redirection does not happen again at the next delivery
19680 attempt.
19681
19682 &*Warning 1*&: Any header line addition or removal that is specified by this
19683 router would be lost if delivery did not succeed at the first attempt. For this
19684 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19685 permitted when &%one_time%& is set.
19686
19687 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19688 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19689 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19690
19691 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19692 &%one_time%&.
19693
19694 The original top-level address is remembered with each of the generated
19695 addresses, and is output in any log messages. However, any intermediate parent
19696 addresses are not recorded. This makes a difference to the log only if
19697 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19698 typically be used for mailing lists, where there is normally just one level of
19699 expansion.
19700
19701
19702 .option owners redirect "string list" unset
19703 .cindex "ownership" "alias file"
19704 .cindex "ownership" "forward file"
19705 .cindex "alias file" "ownership"
19706 .cindex "forward file" "ownership"
19707 This specifies a list of permitted owners for the file specified by &%file%&.
19708 This list is in addition to the local user when &%check_local_user%& is set.
19709 See &%check_owner%& above.
19710
19711
19712 .option owngroups redirect "string list" unset
19713 This specifies a list of permitted groups for the file specified by &%file%&.
19714 The list is in addition to the local user's primary group when
19715 &%check_local_user%& is set. See &%check_group%& above.
19716
19717
19718 .option pipe_transport redirect string&!! unset
19719 .vindex "&$address_pipe$&"
19720 A &(redirect)& router sets up a direct delivery to a pipe when a string
19721 starting with a vertical bar character is specified as a new &"address"&. The
19722 transport used is specified by this option, which, after expansion, must be the
19723 name of a configured transport. This should normally be a &(pipe)& transport.
19724 When the transport is run, the pipe command is in &$address_pipe$&.
19725
19726
19727 .option qualify_domain redirect string&!! unset
19728 .vindex "&$qualify_recipient$&"
19729 If this option is set, and an unqualified address (one without a domain) is
19730 generated, and that address would normally be qualified by the global setting
19731 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19732 expanding this string. If the expansion fails, the router declines. If you want
19733 to revert to the default, you can have the expansion generate
19734 &$qualify_recipient$&.
19735
19736 This option applies to all unqualified addresses generated by Exim filters,
19737 but for traditional &_.forward_& files, it applies only to addresses that are
19738 not preceded by a backslash. Sieve filters cannot generate unqualified
19739 addresses.
19740
19741 .option qualify_preserve_domain redirect boolean false
19742 .cindex "domain" "in redirection; preserving"
19743 .cindex "preserving domain in redirection"
19744 .cindex "address redirection" "domain; preserving"
19745 If this option is set, the router's local &%qualify_domain%& option must not be
19746 set (a configuration error occurs if it is). If an unqualified address (one
19747 without a domain) is generated, it is qualified with the domain of the parent
19748 address (the immediately preceding ancestor) instead of the global
19749 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19750 this applies whether or not the address is preceded by a backslash.
19751
19752
19753 .option repeat_use redirect boolean true
19754 If this option is set false, the router is skipped for a child address that has
19755 any ancestor that was routed by this router. This test happens before any of
19756 the other preconditions are tested. Exim's default anti-looping rules skip
19757 only when the ancestor is the same as the current address. See also
19758 &%check_ancestor%& above and the generic &%redirect_router%& option.
19759
19760
19761 .option reply_transport redirect string&!! unset
19762 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19763 &%vacation%& command is used in a filter file. The transport used is specified
19764 by this option, which, after expansion, must be the name of a configured
19765 transport. This should normally be an &(autoreply)& transport. Other transports
19766 are unlikely to do anything sensible or useful.
19767
19768
19769 .option rewrite redirect boolean true
19770 .cindex "address redirection" "disabling rewriting"
19771 If this option is set false, addresses generated by the router are not
19772 subject to address rewriting. Otherwise, they are treated like new addresses
19773 and are rewritten according to the global rewriting rules.
19774
19775
19776 .option sieve_subaddress redirect string&!! unset
19777 The value of this option is passed to a Sieve filter to specify the
19778 :subaddress part of an address.
19779
19780 .option sieve_useraddress redirect string&!! unset
19781 The value of this option is passed to a Sieve filter to specify the :user part
19782 of an address. However, if it is unset, the entire original local part
19783 (including any prefix or suffix) is used for :user.
19784
19785
19786 .option sieve_vacation_directory redirect string&!! unset
19787 .cindex "Sieve filter" "vacation directory"
19788 To enable the &"vacation"& extension for Sieve filters, you must set
19789 &%sieve_vacation_directory%& to the directory where vacation databases are held
19790 (do not put anything else in that directory), and ensure that the
19791 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19792 needs their own directory; Exim will create it if necessary.
19793
19794
19795
19796 .option skip_syntax_errors redirect boolean false
19797 .cindex "forward file" "broken"
19798 .cindex "address redirection" "broken files"
19799 .cindex "alias file" "broken"
19800 .cindex "broken alias or forward files"
19801 .cindex "ignoring faulty addresses"
19802 .cindex "skipping faulty addresses"
19803 .cindex "error" "skipping bad syntax"
19804 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19805 non-filter redirection data are skipped, and each failing address is logged. If
19806 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19807 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19808 are expanded and placed at the head of the error message generated by
19809 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19810 be the same address as the generic &%errors_to%& option. The
19811 &%skip_syntax_errors%& option is often used when handling mailing lists.
19812
19813 If all the addresses in a redirection list are skipped because of syntax
19814 errors, the router declines to handle the original address, and it is passed to
19815 the following routers.
19816
19817 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19818 error in the filter causes filtering to be abandoned without any action being
19819 taken. The incident is logged, and the router declines to handle the address,
19820 so it is passed to the following routers.
19821
19822 .cindex "Sieve filter" "syntax errors in"
19823 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19824 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19825 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19826
19827 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19828 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19829 option, used with an address that does not get redirected, can be used to
19830 notify users of these errors, by means of a router like this:
19831 .code
19832 userforward:
19833   driver = redirect
19834   allow_filter
19835   check_local_user
19836   file = $home/.forward
19837   file_transport = address_file
19838   pipe_transport = address_pipe
19839   reply_transport = address_reply
19840   no_verify
19841   skip_syntax_errors
19842   syntax_errors_to = real-$local_part@$domain
19843   syntax_errors_text = \
19844    This is an automatically generated message. An error has\n\
19845    been found in your .forward file. Details of the error are\n\
19846    reported below. While this error persists, you will receive\n\
19847    a copy of this message for every message that is addressed\n\
19848    to you. If your .forward file is a filter file, or if it is\n\
19849    a non-filter file containing no valid forwarding addresses,\n\
19850    a copy of each incoming message will be put in your normal\n\
19851    mailbox. If a non-filter file contains at least one valid\n\
19852    forwarding address, forwarding to the valid addresses will\n\
19853    happen, and those will be the only deliveries that occur.
19854 .endd
19855 You also need a router to ensure that local addresses that are prefixed by
19856 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19857 put this immediately before the &(userforward)& router:
19858 .code
19859 real_localuser:
19860   driver = accept
19861   check_local_user
19862   local_part_prefix = real-
19863   transport = local_delivery
19864 .endd
19865 For security, it would probably be a good idea to restrict the use of this
19866 router to locally-generated messages, using a condition such as this:
19867 .code
19868   condition = ${if match {$sender_host_address}\
19869                          {\N^(|127\.0\.0\.1)$\N}}
19870 .endd
19871
19872
19873 .option syntax_errors_text redirect string&!! unset
19874 See &%skip_syntax_errors%& above.
19875
19876
19877 .option syntax_errors_to redirect string unset
19878 See &%skip_syntax_errors%& above.
19879 .ecindex IIDredrou1
19880 .ecindex IIDredrou2
19881
19882
19883
19884
19885
19886
19887 . ////////////////////////////////////////////////////////////////////////////
19888 . ////////////////////////////////////////////////////////////////////////////
19889
19890 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19891          "Environment for local transports"
19892 .scindex IIDenvlotra1 "local transports" "environment for"
19893 .scindex IIDenvlotra2 "environment for local transports"
19894 .scindex IIDenvlotra3 "transport" "local; environment for"
19895 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19896 transport can be thought of as similar to a pipe.) Exim always runs transports
19897 in subprocesses, under specified uids and gids. Typical deliveries to local
19898 mailboxes run under the uid and gid of the local user.
19899
19900 Exim also sets a specific current directory while running the transport; for
19901 some transports a home directory setting is also relevant. The &(pipe)&
19902 transport is the only one that sets up environment variables; see section
19903 &<<SECTpipeenv>>& for details.
19904
19905 The values used for the uid, gid, and the directories may come from several
19906 different places. In many cases, the router that handles the address associates
19907 settings with that address as a result of its &%check_local_user%&, &%group%&,
19908 or &%user%& options. However, values may also be given in the transport's own
19909 configuration, and these override anything that comes from the router.
19910
19911
19912
19913 .section "Concurrent deliveries" "SECID131"
19914 .cindex "concurrent deliveries"
19915 .cindex "simultaneous deliveries"
19916 If two different messages for the same local recipient arrive more or less
19917 simultaneously, the two delivery processes are likely to run concurrently. When
19918 the &(appendfile)& transport is used to write to a file, Exim applies locking
19919 rules to stop concurrent processes from writing to the same file at the same
19920 time.
19921
19922 However, when you use a &(pipe)& transport, it is up to you to arrange any
19923 locking that is needed. Here is a silly example:
19924 .code
19925 my_transport:
19926   driver = pipe
19927   command = /bin/sh -c 'cat >>/some/file'
19928 .endd
19929 This is supposed to write the message at the end of the file. However, if two
19930 messages arrive at the same time, the file will be scrambled. You can use the
19931 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19932 file using the same algorithm that Exim itself uses.
19933
19934
19935
19936
19937 .section "Uids and gids" "SECTenvuidgid"
19938 .cindex "local transports" "uid and gid"
19939 .cindex "transport" "local; uid and gid"
19940 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19941 overrides any group that the router set in the address, even if &%user%& is not
19942 set for the transport. This makes it possible, for example, to run local mail
19943 delivery under the uid of the recipient (set by the router), but in a special
19944 group (set by the transport). For example:
19945 .code
19946 # Routers ...
19947 # User/group are set by check_local_user in this router
19948 local_users:
19949   driver = accept
19950   check_local_user
19951   transport = group_delivery
19952
19953 # Transports ...
19954 # This transport overrides the group
19955 group_delivery:
19956   driver = appendfile
19957   file = /var/spool/mail/$local_part
19958   group = mail
19959 .endd
19960 If &%user%& is set for a transport, its value overrides what is set in the
19961 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19962 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19963 set.
19964
19965 .oindex "&%initgroups%&"
19966 When the uid is taken from the transport's configuration, the &[initgroups()]&
19967 function is called for the groups associated with that uid if the
19968 &%initgroups%& option is set for the transport. When the uid is not specified
19969 by the transport, but is associated with the address by a router, the option
19970 for calling &[initgroups()]& is taken from the router configuration.
19971
19972 .cindex "&(pipe)& transport" "uid for"
19973 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19974 is set and &%user%& is not set, the uid of the process that called Exim to
19975 receive the message is used, and if &%group%& is not set, the corresponding
19976 original gid is also used.
19977
19978 This is the detailed preference order for obtaining a gid; the first of the
19979 following that is set is used:
19980
19981 .ilist
19982 A &%group%& setting of the transport;
19983 .next
19984 A &%group%& setting of the router;
19985 .next
19986 A gid associated with a user setting of the router, either as a result of
19987 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19988 .next
19989 The group associated with a non-numeric &%user%& setting of the transport;
19990 .next
19991 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19992 the uid is the creator's uid;
19993 .next
19994 The Exim gid if the Exim uid is being used as a default.
19995 .endlist
19996
19997 If, for example, the user is specified numerically on the router and there are
19998 no group settings, no gid is available. In this situation, an error occurs.
19999 This is different for the uid, for which there always is an ultimate default.
20000 The first of the following that is set is used:
20001
20002 .ilist
20003 A &%user%& setting of the transport;
20004 .next
20005 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20006 .next
20007 A &%user%& setting of the router;
20008 .next
20009 A &%check_local_user%& setting of the router;
20010 .next
20011 The Exim uid.
20012 .endlist
20013
20014 Of course, an error will still occur if the uid that is chosen is on the
20015 &%never_users%& list.
20016
20017
20018
20019
20020
20021 .section "Current and home directories" "SECID132"
20022 .cindex "current directory for local transport"
20023 .cindex "home directory" "for local transport"
20024 .cindex "transport" "local; home directory for"
20025 .cindex "transport" "local; current directory for"
20026 Routers may set current and home directories for local transports by means of
20027 the &%transport_current_directory%& and &%transport_home_directory%& options.
20028 However, if the transport's &%current_directory%& or &%home_directory%& options
20029 are set, they override the router's values. In detail, the home directory
20030 for a local transport is taken from the first of these values that is set:
20031
20032 .ilist
20033 The &%home_directory%& option on the transport;
20034 .next
20035 The &%transport_home_directory%& option on the router;
20036 .next
20037 The password data if &%check_local_user%& is set on the router;
20038 .next
20039 The &%router_home_directory%& option on the router.
20040 .endlist
20041
20042 The current directory is taken from the first of these values that is set:
20043
20044 .ilist
20045 The &%current_directory%& option on the transport;
20046 .next
20047 The &%transport_current_directory%& option on the router.
20048 .endlist
20049
20050
20051 If neither the router nor the transport sets a current directory, Exim uses the
20052 value of the home directory, if it is set. Otherwise it sets the current
20053 directory to &_/_& before running a local transport.
20054
20055
20056
20057 .section "Expansion variables derived from the address" "SECID133"
20058 .vindex "&$domain$&"
20059 .vindex "&$local_part$&"
20060 .vindex "&$original_domain$&"
20061 Normally a local delivery is handling a single address, and in that case the
20062 variables such as &$domain$& and &$local_part$& are set during local
20063 deliveries. However, in some circumstances more than one address may be handled
20064 at once (for example, while writing batch SMTP for onward transmission by some
20065 other means). In this case, the variables associated with the local part are
20066 never set, &$domain$& is set only if all the addresses have the same domain,
20067 and &$original_domain$& is never set.
20068 .ecindex IIDenvlotra1
20069 .ecindex IIDenvlotra2
20070 .ecindex IIDenvlotra3
20071
20072
20073
20074
20075
20076
20077
20078 . ////////////////////////////////////////////////////////////////////////////
20079 . ////////////////////////////////////////////////////////////////////////////
20080
20081 .chapter "Generic options for transports" "CHAPtransportgeneric"
20082 .scindex IIDgenoptra1 "generic options" "transport"
20083 .scindex IIDgenoptra2 "options" "generic; for transports"
20084 .scindex IIDgenoptra3 "transport" "generic options for"
20085 The following generic options apply to all transports:
20086
20087
20088 .option body_only transports boolean false
20089 .cindex "transport" "body only"
20090 .cindex "message" "transporting body only"
20091 .cindex "body of message" "transporting"
20092 If this option is set, the message's headers are not transported. It is
20093 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20094 or &(pipe)& transports, the settings of &%message_prefix%& and
20095 &%message_suffix%& should be checked, because this option does not
20096 automatically suppress them.
20097
20098
20099 .option current_directory transports string&!! unset
20100 .cindex "transport" "current directory for"
20101 This specifies the current directory that is to be set while running the
20102 transport, overriding any value that may have been set by the router.
20103 If the expansion fails for any reason, including forced failure, an error is
20104 logged, and delivery is deferred.
20105
20106
20107 .option disable_logging transports boolean false
20108 If this option is set true, nothing is logged for any
20109 deliveries by the transport or for any
20110 transport errors. You should not set this option unless you really, really know
20111 what you are doing.
20112
20113
20114 .option debug_print transports string&!! unset
20115 .cindex "testing" "variables in drivers"
20116 If this option is set and debugging is enabled (see the &%-d%& command line
20117 option), the string is expanded and included in the debugging output when the
20118 transport is run.
20119 If expansion of the string fails, the error message is written to the debugging
20120 output, and Exim carries on processing.
20121 This facility is provided to help with checking out the values of variables and
20122 so on when debugging driver configurations. For example, if a &%headers_add%&
20123 option is not working properly, &%debug_print%& could be used to output the
20124 variables it references. A newline is added to the text if it does not end with
20125 one.
20126 The variables &$transport_name$& and &$router_name$& contain the name of the
20127 transport and the router that called it.
20128
20129 .option delivery_date_add transports boolean false
20130 .cindex "&'Delivery-date:'& header line"
20131 If this option is true, a &'Delivery-date:'& header is added to the message.
20132 This gives the actual time the delivery was made. As this is not a standard
20133 header, Exim has a configuration option (&%delivery_date_remove%&) which
20134 requests its removal from incoming messages, so that delivered messages can
20135 safely be resent to other recipients.
20136
20137
20138 .option driver transports string unset
20139 This specifies which of the available transport drivers is to be used.
20140 There is no default, and this option must be set for every transport.
20141
20142
20143 .option envelope_to_add transports boolean false
20144 .cindex "&'Envelope-to:'& header line"
20145 If this option is true, an &'Envelope-to:'& header is added to the message.
20146 This gives the original address(es) in the incoming envelope that caused this
20147 delivery to happen. More than one address may be present if the transport is
20148 configured to handle several addresses at once, or if more than one original
20149 address was redirected to the same final address. As this is not a standard
20150 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20151 its removal from incoming messages, so that delivered messages can safely be
20152 resent to other recipients.
20153
20154
20155 .option group transports string&!! "Exim group"
20156 .cindex "transport" "group; specifying"
20157 This option specifies a gid for running the transport process, overriding any
20158 value that the router supplies, and also overriding any value associated with
20159 &%user%& (see below).
20160
20161
20162 .option headers_add transports list&!! unset
20163 .cindex "header lines" "adding in transport"
20164 .cindex "transport" "header lines; adding"
20165 This option specifies a list of text headers, newline-separated,
20166 which are (separately) expanded and added to the header
20167 portion of a message as it is transported, as described in section
20168 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20169 routers. If the result of the expansion is an empty string, or if the expansion
20170 is forced to fail, no action is taken. Other expansion failures are treated as
20171 errors and cause the delivery to be deferred.
20172
20173 Unlike most options, &%headers_add%& can be specified multiple times
20174 for a transport; all listed headers are added.
20175
20176
20177 .option headers_only transports boolean false
20178 .cindex "transport" "header lines only"
20179 .cindex "message" "transporting headers only"
20180 .cindex "header lines" "transporting"
20181 If this option is set, the message's body is not transported. It is mutually
20182 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20183 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20184 checked, since this option does not automatically suppress them.
20185
20186
20187 .option headers_remove transports list&!! unset
20188 .cindex "header lines" "removing"
20189 .cindex "transport" "header lines; removing"
20190 This option specifies a list of header names, colon-separated;
20191 these headers are omitted from the message as it is transported, as described
20192 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20193 routers.
20194 Each list item is separately expanded.
20195 If the result of the expansion is an empty string, or if the expansion
20196 is forced to fail, no action is taken. Other expansion failures are treated as
20197 errors and cause the delivery to be deferred.
20198
20199 Unlike most options, &%headers_remove%& can be specified multiple times
20200 for a router; all listed headers are removed.
20201
20202
20203
20204 .option headers_rewrite transports string unset
20205 .cindex "transport" "header lines; rewriting"
20206 .cindex "rewriting" "at transport time"
20207 This option allows addresses in header lines to be rewritten at transport time,
20208 that is, as the message is being copied to its destination. The contents of the
20209 option are a colon-separated list of rewriting rules. Each rule is in exactly
20210 the same form as one of the general rewriting rules that are applied when a
20211 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20212 example,
20213 .code
20214 headers_rewrite = a@b c@d f : \
20215                   x@y w@z
20216 .endd
20217 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20218 &'w@z'& in all address-bearing header lines. The rules are applied to the
20219 header lines just before they are written out at transport time, so they affect
20220 only those copies of the message that pass through the transport. However, only
20221 the message's original header lines, and any that were added by a system
20222 filter, are rewritten. If a router or transport adds header lines, they are not
20223 affected by this option. These rewriting rules are &'not'& applied to the
20224 envelope. You can change the return path using &%return_path%&, but you cannot
20225 change envelope recipients at this time.
20226
20227
20228 .option home_directory transports string&!! unset
20229 .cindex "transport" "home directory for"
20230 .vindex "&$home$&"
20231 This option specifies a home directory setting for a local transport,
20232 overriding any value that may be set by the router. The home directory is
20233 placed in &$home$& while expanding the transport's private options. It is also
20234 used as the current directory if no current directory is set by the
20235 &%current_directory%& option on the transport or the
20236 &%transport_current_directory%& option on the router. If the expansion fails
20237 for any reason, including forced failure, an error is logged, and delivery is
20238 deferred.
20239
20240
20241 .option initgroups transports boolean false
20242 .cindex "additional groups"
20243 .cindex "groups" "additional"
20244 .cindex "transport" "group; additional"
20245 If this option is true and the uid for the delivery process is provided by the
20246 transport, the &[initgroups()]& function is called when running the transport
20247 to ensure that any additional groups associated with the uid are set up.
20248
20249
20250 .option message_size_limit transports string&!! 0
20251 .cindex "limit" "message size per transport"
20252 .cindex "size" "of message, limit"
20253 .cindex "transport" "message size; limiting"
20254 This option controls the size of messages passed through the transport. It is
20255 expanded before use; the result of the expansion must be a sequence of decimal
20256 digits, optionally followed by K or M. If the expansion fails for any reason,
20257 including forced failure, or if the result is not of the required form,
20258 delivery is deferred. If the value is greater than zero and the size of a
20259 message exceeds this limit, the address is failed. If there is any chance that
20260 the resulting bounce message could be routed to the same transport, you should
20261 ensure that &%return_size_limit%& is less than the transport's
20262 &%message_size_limit%&, as otherwise the bounce message will fail to get
20263 delivered.
20264
20265
20266
20267 .option rcpt_include_affixes transports boolean false
20268 .cindex "prefix" "for local part, including in envelope"
20269 .cindex "suffix for local part" "including in envelope"
20270 .cindex "local part" "prefix"
20271 .cindex "local part" "suffix"
20272 When this option is false (the default), and an address that has had any
20273 affixes (prefixes or suffixes) removed from the local part is delivered by any
20274 form of SMTP or LMTP, the affixes are not included. For example, if a router
20275 that contains
20276 .code
20277 local_part_prefix = *-
20278 .endd
20279 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20280 is delivered with
20281 .code
20282 RCPT TO:<xyz@some.domain>
20283 .endd
20284 This is also the case when an ACL-time callout is being used to verify a
20285 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20286 whole local part is included in the RCPT command. This option applies to BSMTP
20287 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20288 &(lmtp)& and &(smtp)& transports.
20289
20290
20291 .option retry_use_local_part transports boolean "see below"
20292 .cindex "hints database" "retry keys"
20293 When a delivery suffers a temporary failure, a retry record is created
20294 in Exim's hints database. For remote deliveries, the key for the retry record
20295 is based on the name and/or IP address of the failing remote host. For local
20296 deliveries, the key is normally the entire address, including both the local
20297 part and the domain. This is suitable for most common cases of local delivery
20298 temporary failure &-- for example, exceeding a mailbox quota should delay only
20299 deliveries to that mailbox, not to the whole domain.
20300
20301 However, in some special cases you may want to treat a temporary local delivery
20302 as a failure associated with the domain, and not with a particular local part.
20303 (For example, if you are storing all mail for some domain in files.) You can do
20304 this by setting &%retry_use_local_part%& false.
20305
20306 For all the local transports, its default value is true. For remote transports,
20307 the default value is false for tidiness, but changing the value has no effect
20308 on a remote transport in the current implementation.
20309
20310
20311 .option return_path transports string&!! unset
20312 .cindex "envelope sender"
20313 .cindex "transport" "return path; changing"
20314 .cindex "return path" "changing in transport"
20315 If this option is set, the string is expanded at transport time and replaces
20316 the existing return path (envelope sender) value in the copy of the message
20317 that is being delivered. An empty return path is permitted. This feature is
20318 designed for remote deliveries, where the value of this option is used in the
20319 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20320 only effect is to change the address that is placed in the &'Return-path:'&
20321 header line, if one is added to the message (see the next option).
20322
20323 &*Note:*& A changed return path is not logged unless you add
20324 &%return_path_on_delivery%& to the log selector.
20325
20326 .vindex "&$return_path$&"
20327 The expansion can refer to the existing value via &$return_path$&. This is
20328 either the message's envelope sender, or an address set by the
20329 &%errors_to%& option on a router. If the expansion is forced to fail, no
20330 replacement occurs; if it fails for another reason, delivery is deferred. This
20331 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20332 section &<<SECTverp>>&.
20333
20334 &*Note*&: If a delivery error is detected locally, including the case when a
20335 remote server rejects a message at SMTP time, the bounce message is not sent to
20336 the value of this option. It is sent to the previously set errors address.
20337 This defaults to the incoming sender address, but can be changed by setting
20338 &%errors_to%& in a router.
20339
20340
20341
20342 .option return_path_add transports boolean false
20343 .cindex "&'Return-path:'& header line"
20344 If this option is true, a &'Return-path:'& header is added to the message.
20345 Although the return path is normally available in the prefix line of BSD
20346 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20347 have easy access to it.
20348
20349 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20350 the delivery SMTP server makes the final delivery"&. This implies that this
20351 header should not be present in incoming messages. Exim has a configuration
20352 option, &%return_path_remove%&, which requests removal of this header from
20353 incoming messages, so that delivered messages can safely be resent to other
20354 recipients.
20355
20356
20357 .option shadow_condition transports string&!! unset
20358 See &%shadow_transport%& below.
20359
20360
20361 .option shadow_transport transports string unset
20362 .cindex "shadow transport"
20363 .cindex "transport" "shadow"
20364 A local transport may set the &%shadow_transport%& option to the name of
20365 another local transport. Shadow remote transports are not supported.
20366
20367 Whenever a delivery to the main transport succeeds, and either
20368 &%shadow_condition%& is unset, or its expansion does not result in the empty
20369 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20370 passed to the shadow transport, with the same delivery address or addresses. If
20371 expansion fails, no action is taken except that non-forced expansion failures
20372 cause a log line to be written.
20373
20374 The result of the shadow transport is discarded and does not affect the
20375 subsequent processing of the message. Only a single level of shadowing is
20376 provided; the &%shadow_transport%& option is ignored on any transport when it
20377 is running as a shadow. Options concerned with output from pipes are also
20378 ignored. The log line for the successful delivery has an item added on the end,
20379 of the form
20380 .code
20381 ST=<shadow transport name>
20382 .endd
20383 If the shadow transport did not succeed, the error message is put in
20384 parentheses afterwards. Shadow transports can be used for a number of different
20385 purposes, including keeping more detailed log information than Exim normally
20386 provides, and implementing automatic acknowledgment policies based on message
20387 headers that some sites insist on.
20388
20389
20390 .option transport_filter transports string&!! unset
20391 .cindex "transport" "filter"
20392 .cindex "filter" "transport filter"
20393 This option sets up a filtering (in the Unix shell sense) process for messages
20394 at transport time. It should not be confused with mail filtering as set up by
20395 individual users or via a system filter.
20396
20397 When the message is about to be written out, the command specified by
20398 &%transport_filter%& is started up in a separate, parallel process, and
20399 the entire message, including the header lines, is passed to it on its standard
20400 input (this in fact is done from a third process, to avoid deadlock). The
20401 command must be specified as an absolute path.
20402
20403 The lines of the message that are written to the transport filter are
20404 terminated by newline (&"\n"&). The message is passed to the filter before any
20405 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20406 lines beginning with a dot, and also before any processing implied by the
20407 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20408 &(pipe)& transports.
20409
20410 The standard error for the filter process is set to the same destination as its
20411 standard output; this is read and written to the message's ultimate
20412 destination. The process that writes the message to the filter, the
20413 filter itself, and the original process that reads the result and delivers it
20414 are all run in parallel, like a shell pipeline.
20415
20416 The filter can perform any transformations it likes, but of course should take
20417 care not to break RFC 2822 syntax. Exim does not check the result, except to
20418 test for a final newline when SMTP is in use. All messages transmitted over
20419 SMTP must end with a newline, so Exim supplies one if it is missing.
20420
20421 .cindex "content scanning" "per user"
20422 A transport filter can be used to provide content-scanning on a per-user basis
20423 at delivery time if the only required effect of the scan is to modify the
20424 message. For example, a content scan could insert a new header line containing
20425 a spam score. This could be interpreted by a filter in the user's MUA. It is
20426 not possible to discard a message at this stage.
20427
20428 .cindex "SMTP" "SIZE"
20429 A problem might arise if the filter increases the size of a message that is
20430 being sent down an SMTP connection. If the receiving SMTP server has indicated
20431 support for the SIZE parameter, Exim will have sent the size of the message
20432 at the start of the SMTP session. If what is actually sent is substantially
20433 more, the server might reject the message. This can be worked round by setting
20434 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20435 additions to the message, or to disable the use of SIZE altogether.
20436
20437 .vindex "&$pipe_addresses$&"
20438 The value of the &%transport_filter%& option is the command string for starting
20439 the filter, which is run directly from Exim, not under a shell. The string is
20440 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20441 Exim breaks it up into arguments and then expands each argument separately (see
20442 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20443 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20444 of arguments, one for each address that applies to this delivery. (This isn't
20445 an ideal name for this feature here, but as it was already implemented for the
20446 &(pipe)& transport, it seemed sensible not to change it.)
20447
20448 .vindex "&$host$&"
20449 .vindex "&$host_address$&"
20450 The expansion variables &$host$& and &$host_address$& are available when the
20451 transport is a remote one. They contain the name and IP address of the host to
20452 which the message is being sent. For example:
20453 .code
20454 transport_filter = /some/directory/transport-filter.pl \
20455   $host $host_address $sender_address $pipe_addresses
20456 .endd
20457
20458 Two problems arise if you want to use more complicated expansion items to
20459 generate transport filter commands, both of which due to the fact that the
20460 command is split up &'before'& expansion.
20461 .ilist
20462 If an expansion item contains white space, you must quote it, so that it is all
20463 part of the same command item. If the entire option setting is one such
20464 expansion item, you have to take care what kind of quoting you use. For
20465 example:
20466 .code
20467 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20468 .endd
20469 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20470 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20471 stripped by Exim when it read the option's value. When the value is used, if
20472 the single quotes were missing, the line would be split into two items,
20473 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20474 Exim tried to expand the first one.
20475 .next
20476 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20477 expansion cannot generate multiple arguments, or a command name followed by
20478 arguments. Consider this example:
20479 .code
20480 transport_filter = ${lookup{$host}lsearch{/a/file}\
20481                     {$value}{/bin/cat}}
20482 .endd
20483 The result of the lookup is interpreted as the name of the command, even
20484 if it contains white space. The simplest way round this is to use a shell:
20485 .code
20486 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20487                                {$value}{/bin/cat}}
20488 .endd
20489 .endlist
20490
20491 The filter process is run under the same uid and gid as the normal delivery.
20492 For remote deliveries this is the Exim uid/gid by default. The command should
20493 normally yield a zero return code. Transport filters are not supposed to fail.
20494 A non-zero code is taken to mean that the transport filter encountered some
20495 serious problem. Delivery of the message is deferred; the message remains on
20496 the queue and is tried again later. It is not possible to cause a message to be
20497 bounced from a transport filter.
20498
20499 If a transport filter is set on an autoreply transport, the original message is
20500 passed through the filter as it is being copied into the newly generated
20501 message, which happens if the &%return_message%& option is set.
20502
20503
20504 .option transport_filter_timeout transports time 5m
20505 .cindex "transport" "filter, timeout"
20506 When Exim is reading the output of a transport filter, it applies a timeout
20507 that can be set by this option. Exceeding the timeout is normally treated as a
20508 temporary delivery failure. However, if a transport filter is used with a
20509 &(pipe)& transport, a timeout in the transport filter is treated in the same
20510 way as a timeout in the pipe command itself. By default, a timeout is a hard
20511 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20512 becomes a temporary error.
20513
20514
20515 .option user transports string&!! "Exim user"
20516 .cindex "uid (user id)" "local delivery"
20517 .cindex "transport" "user, specifying"
20518 This option specifies the user under whose uid the delivery process is to be
20519 run, overriding any uid that may have been set by the router. If the user is
20520 given as a name, the uid is looked up from the password data, and the
20521 associated group is taken as the value of the gid to be used if the &%group%&
20522 option is not set.
20523
20524 For deliveries that use local transports, a user and group are normally
20525 specified explicitly or implicitly (for example, as a result of
20526 &%check_local_user%&) by the router or transport.
20527
20528 .cindex "hints database" "access by remote transport"
20529 For remote transports, you should leave this option unset unless you really are
20530 sure you know what you are doing. When a remote transport is running, it needs
20531 to be able to access Exim's hints databases, because each host may have its own
20532 retry data.
20533 .ecindex IIDgenoptra1
20534 .ecindex IIDgenoptra2
20535 .ecindex IIDgenoptra3
20536
20537
20538
20539
20540
20541
20542 . ////////////////////////////////////////////////////////////////////////////
20543 . ////////////////////////////////////////////////////////////////////////////
20544
20545 .chapter "Address batching in local transports" "CHAPbatching" &&&
20546          "Address batching"
20547 .cindex "transport" "local; address batching in"
20548 The only remote transport (&(smtp)&) is normally configured to handle more than
20549 one address at a time, so that when several addresses are routed to the same
20550 remote host, just one copy of the message is sent. Local transports, however,
20551 normally handle one address at a time. That is, a separate instance of the
20552 transport is run for each address that is routed to the transport. A separate
20553 copy of the message is delivered each time.
20554
20555 .cindex "batched local delivery"
20556 .oindex "&%batch_max%&"
20557 .oindex "&%batch_id%&"
20558 In special cases, it may be desirable to handle several addresses at once in a
20559 local transport, for example:
20560
20561 .ilist
20562 In an &(appendfile)& transport, when storing messages in files for later
20563 delivery by some other means, a single copy of the message with multiple
20564 recipients saves space.
20565 .next
20566 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20567 a single copy saves time, and is the normal way LMTP is expected to work.
20568 .next
20569 In a &(pipe)& transport, when passing the message
20570 to a scanner program or
20571 to some other delivery mechanism such as UUCP, multiple recipients may be
20572 acceptable.
20573 .endlist
20574
20575 These three local transports all have the same options for controlling multiple
20576 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20577 repeating the information for each transport, these options are described here.
20578
20579 The &%batch_max%& option specifies the maximum number of addresses that can be
20580 delivered together in a single run of the transport. Its default value is one
20581 (no batching). When more than one address is routed to a transport that has a
20582 &%batch_max%& value greater than one, the addresses are delivered in a batch
20583 (that is, in a single run of the transport with multiple recipients), subject
20584 to certain conditions:
20585
20586 .ilist
20587 .vindex "&$local_part$&"
20588 If any of the transport's options contain a reference to &$local_part$&, no
20589 batching is possible.
20590 .next
20591 .vindex "&$domain$&"
20592 If any of the transport's options contain a reference to &$domain$&, only
20593 addresses with the same domain are batched.
20594 .next
20595 .cindex "customizing" "batching condition"
20596 If &%batch_id%& is set, it is expanded for each address, and only those
20597 addresses with the same expanded value are batched. This allows you to specify
20598 customized batching conditions. Failure of the expansion for any reason,
20599 including forced failure, disables batching, but it does not stop the delivery
20600 from taking place.
20601 .next
20602 Batched addresses must also have the same errors address (where to send
20603 delivery errors), the same header additions and removals, the same user and
20604 group for the transport, and if a host list is present, the first host must
20605 be the same.
20606 .endlist
20607
20608 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20609 both when the file or pipe command is specified in the transport, and when it
20610 is specified by a &(redirect)& router, but all the batched addresses must of
20611 course be routed to the same file or pipe command. These two transports have an
20612 option called &%use_bsmtp%&, which causes them to deliver the message in
20613 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20614 &%check_string%& and &%escape_string%& options are forced to the values
20615 .code
20616 check_string = "."
20617 escape_string = ".."
20618 .endd
20619 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20620 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20621 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20622
20623 .cindex "&'Envelope-to:'& header line"
20624 If the generic &%envelope_to_add%& option is set for a batching transport, the
20625 &'Envelope-to:'& header that is added to the message contains all the addresses
20626 that are being processed together. If you are using a batching &(appendfile)&
20627 transport without &%use_bsmtp%&, the only way to preserve the recipient
20628 addresses is to set the &%envelope_to_add%& option.
20629
20630 .cindex "&(pipe)& transport" "with multiple addresses"
20631 .vindex "&$pipe_addresses$&"
20632 If you are using a &(pipe)& transport without BSMTP, and setting the
20633 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20634 the command. This is not a true variable; it is a bit of magic that causes each
20635 of the recipient addresses to be inserted into the command as a separate
20636 argument. This provides a way of accessing all the addresses that are being
20637 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20638 are specified by a &(redirect)& router.
20639
20640
20641
20642
20643 . ////////////////////////////////////////////////////////////////////////////
20644 . ////////////////////////////////////////////////////////////////////////////
20645
20646 .chapter "The appendfile transport" "CHAPappendfile"
20647 .scindex IIDapptra1 "&(appendfile)& transport"
20648 .scindex IIDapptra2 "transports" "&(appendfile)&"
20649 .cindex "directory creation"
20650 .cindex "creating directories"
20651 The &(appendfile)& transport delivers a message by appending it to an existing
20652 file, or by creating an entirely new file in a specified directory. Single
20653 files to which messages are appended can be in the traditional Unix mailbox
20654 format, or optionally in the MBX format supported by the Pine MUA and
20655 University of Washington IMAP daemon, &'inter alia'&. When each message is
20656 being delivered as a separate file, &"maildir"& format can optionally be used
20657 to give added protection against failures that happen part-way through the
20658 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20659 supported. For all file formats, Exim attempts to create as many levels of
20660 directory as necessary, provided that &%create_directory%& is set.
20661
20662 The code for the optional formats is not included in the Exim binary by
20663 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20664 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20665 included.
20666
20667 .cindex "quota" "system"
20668 Exim recognizes system quota errors, and generates an appropriate message. Exim
20669 also supports its own quota control within the transport, for use when the
20670 system facility is unavailable or cannot be used for some reason.
20671
20672 If there is an error while appending to a file (for example, quota exceeded or
20673 partition filled), Exim attempts to reset the file's length and last
20674 modification time back to what they were before. If there is an error while
20675 creating an entirely new file, the new file is removed.
20676
20677 Before appending to a file, a number of security checks are made, and the
20678 file is locked. A detailed description is given below, after the list of
20679 private options.
20680
20681 The &(appendfile)& transport is most commonly used for local deliveries to
20682 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20683 putting messages into files for remote delivery by some means other than Exim.
20684 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20685 option).
20686
20687
20688
20689 .section "The file and directory options" "SECTfildiropt"
20690 The &%file%& option specifies a single file, to which the message is appended;
20691 the &%directory%& option specifies a directory, in which a new file containing
20692 the message is created. Only one of these two options can be set, and for
20693 normal deliveries to mailboxes, one of them &'must'& be set.
20694
20695 .vindex "&$address_file$&"
20696 .vindex "&$local_part$&"
20697 However, &(appendfile)& is also used for delivering messages to files or
20698 directories whose names (or parts of names) are obtained from alias,
20699 forwarding, or filtering operations (for example, a &%save%& command in a
20700 user's Exim filter). When such a transport is running, &$local_part$& contains
20701 the local part that was aliased or forwarded, and &$address_file$& contains the
20702 name (or partial name) of the file or directory generated by the redirection
20703 operation. There are two cases:
20704
20705 .ilist
20706 If neither &%file%& nor &%directory%& is set, the redirection operation
20707 must specify an absolute path (one that begins with &`/`&). This is the most
20708 common case when users with local accounts use filtering to sort mail into
20709 different folders. See for example, the &(address_file)& transport in the
20710 default configuration. If the path ends with a slash, it is assumed to be the
20711 name of a directory. A delivery to a directory can also be forced by setting
20712 &%maildir_format%& or &%mailstore_format%&.
20713 .next
20714 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20715 used to determine the file or directory name for the delivery. Normally, the
20716 contents of &$address_file$& are used in some way in the string expansion.
20717 .endlist
20718
20719
20720 .cindex "Sieve filter" "configuring &(appendfile)&"
20721 .cindex "Sieve filter" "relative mailbox path handling"
20722 As an example of the second case, consider an environment where users do not
20723 have home directories. They may be permitted to use Exim filter commands of the
20724 form:
20725 .code
20726 save folder23
20727 .endd
20728 or Sieve filter commands of the form:
20729 .code
20730 require "fileinto";
20731 fileinto "folder23";
20732 .endd
20733 In this situation, the expansion of &%file%& or &%directory%& in the transport
20734 must transform the relative path into an appropriate absolute file name. In the
20735 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20736 is used as a result of a &"keep"& action in the filter. This example shows one
20737 way of handling this requirement:
20738 .code
20739 file = ${if eq{$address_file}{inbox} \
20740             {/var/mail/$local_part} \
20741             {${if eq{${substr_0_1:$address_file}}{/} \
20742                   {$address_file} \
20743                   {$home/mail/$address_file} \
20744             }} \
20745        }
20746 .endd
20747 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20748 location, absolute paths are used without change, and other folders are in the
20749 &_mail_& directory within the home directory.
20750
20751 &*Note 1*&: While processing an Exim filter, a relative path such as
20752 &_folder23_& is turned into an absolute path if a home directory is known to
20753 the router. In particular, this is the case if &%check_local_user%& is set. If
20754 you want to prevent this happening at routing time, you can set
20755 &%router_home_directory%& empty. This forces the router to pass the relative
20756 path to the transport.
20757
20758 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20759 the &%file%& or &%directory%& option is still used if it is set.
20760
20761
20762
20763
20764 .section "Private options for appendfile" "SECID134"
20765 .cindex "options" "&(appendfile)& transport"
20766
20767
20768
20769 .option allow_fifo appendfile boolean false
20770 .cindex "fifo (named pipe)"
20771 .cindex "named pipe (fifo)"
20772 .cindex "pipe" "named (fifo)"
20773 Setting this option permits delivery to named pipes (FIFOs) as well as to
20774 regular files. If no process is reading the named pipe at delivery time, the
20775 delivery is deferred.
20776
20777
20778 .option allow_symlink appendfile boolean false
20779 .cindex "symbolic link" "to mailbox"
20780 .cindex "mailbox" "symbolic link"
20781 By default, &(appendfile)& will not deliver if the path name for the file is
20782 that of a symbolic link. Setting this option relaxes that constraint, but there
20783 are security issues involved in the use of symbolic links. Be sure you know
20784 what you are doing if you set this. Details of exactly what this option affects
20785 are included in the discussion which follows this list of options.
20786
20787
20788 .option batch_id appendfile string&!! unset
20789 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20790 However, batching is automatically disabled for &(appendfile)& deliveries that
20791 happen as a result of forwarding or aliasing or other redirection directly to a
20792 file.
20793
20794
20795 .option batch_max appendfile integer 1
20796 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20797
20798
20799 .option check_group appendfile boolean false
20800 When this option is set, the group owner of the file defined by the &%file%&
20801 option is checked to see that it is the same as the group under which the
20802 delivery process is running. The default setting is false because the default
20803 file mode is 0600, which means that the group is irrelevant.
20804
20805
20806 .option check_owner appendfile boolean true
20807 When this option is set, the owner of the file defined by the &%file%& option
20808 is checked to ensure that it is the same as the user under which the delivery
20809 process is running.
20810
20811
20812 .option check_string appendfile string "see below"
20813 .cindex "&""From""& line"
20814 As &(appendfile)& writes the message, the start of each line is tested for
20815 matching &%check_string%&, and if it does, the initial matching characters are
20816 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20817 a literal string, not a regular expression, and the case of any letters it
20818 contains is significant.
20819
20820 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20821 are forced to &"."& and &".."& respectively, and any settings in the
20822 configuration are ignored. Otherwise, they default to &"From&~"& and
20823 &">From&~"& when the &%file%& option is set, and unset when any of the
20824 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20825
20826 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20827 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20828 &"From&~"& indicates the start of a new message. All four options need changing
20829 if another format is used. For example, to deliver to mailboxes in MMDF format:
20830 .cindex "MMDF format mailbox"
20831 .cindex "mailbox" "MMDF format"
20832 .code
20833 check_string = "\1\1\1\1\n"
20834 escape_string = "\1\1\1\1 \n"
20835 message_prefix = "\1\1\1\1\n"
20836 message_suffix = "\1\1\1\1\n"
20837 .endd
20838 .option create_directory appendfile boolean true
20839 .cindex "directory creation"
20840 When this option is true, Exim attempts to create any missing superior
20841 directories for the file that it is about to write. A created directory's mode
20842 is given by the &%directory_mode%& option.
20843
20844 The group ownership of a newly created directory is highly dependent on the
20845 operating system (and possibly the file system) that is being used. For
20846 example, in Solaris, if the parent directory has the setgid bit set, its group
20847 is propagated to the child; if not, the currently set group is used. However,
20848 in FreeBSD, the parent's group is always used.
20849
20850
20851
20852 .option create_file appendfile string anywhere
20853 This option constrains the location of files and directories that are created
20854 by this transport. It applies to files defined by the &%file%& option and
20855 directories defined by the &%directory%& option. In the case of maildir
20856 delivery, it applies to the top level directory, not the maildir directories
20857 beneath.
20858
20859 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20860 &"belowhome"&. In the second and third cases, a home directory must have been
20861 set for the transport. This option is not useful when an explicit file name is
20862 given for normal mailbox deliveries. It is intended for the case when file
20863 names are generated from users' &_.forward_& files. These are usually handled
20864 by an &(appendfile)& transport called &%address_file%&. See also
20865 &%file_must_exist%&.
20866
20867
20868 .option directory appendfile string&!! unset
20869 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20870 or &%directory%& must be set, unless the delivery is the direct result of a
20871 redirection (see section &<<SECTfildiropt>>&).
20872
20873 When &%directory%& is set, the string is expanded, and the message is delivered
20874 into a new file or files in or below the given directory, instead of being
20875 appended to a single mailbox file. A number of different formats are provided
20876 (see &%maildir_format%& and &%mailstore_format%&), and see section
20877 &<<SECTopdir>>& for further details of this form of delivery.
20878
20879
20880 .option directory_file appendfile string&!! "see below"
20881 .cindex "base62"
20882 .vindex "&$inode$&"
20883 When &%directory%& is set, but neither &%maildir_format%& nor
20884 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20885 whose name is obtained by expanding this string. The default value is:
20886 .code
20887 q${base62:$tod_epoch}-$inode
20888 .endd
20889 This generates a unique name from the current time, in base 62 form, and the
20890 inode of the file. The variable &$inode$& is available only when expanding this
20891 option.
20892
20893
20894 .option directory_mode appendfile "octal integer" 0700
20895 If &(appendfile)& creates any directories as a result of the
20896 &%create_directory%& option, their mode is specified by this option.
20897
20898
20899 .option escape_string appendfile string "see description"
20900 See &%check_string%& above.
20901
20902
20903 .option file appendfile string&!! unset
20904 This option is mutually exclusive with the &%directory%& option, but one of
20905 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20906 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20907 specifies a single file, to which the message is appended. One or more of
20908 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20909 &%file%&.
20910
20911 .cindex "NFS" "lock file"
20912 .cindex "locking files"
20913 .cindex "lock files"
20914 If you are using more than one host to deliver over NFS into the same
20915 mailboxes, you should always use lock files.
20916
20917 The string value is expanded for each delivery, and must yield an absolute
20918 path. The most common settings of this option are variations on one of these
20919 examples:
20920 .code
20921 file = /var/spool/mail/$local_part
20922 file = /home/$local_part/inbox
20923 file = $home/inbox
20924 .endd
20925 .cindex "&""sticky""& bit"
20926 In the first example, all deliveries are done into the same directory. If Exim
20927 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20928 create a file in the directory, so the &"sticky"& bit must be turned on for
20929 deliveries to be possible, or alternatively the &%group%& option can be used to
20930 run the delivery under a group id which has write access to the directory.
20931
20932
20933
20934 .option file_format appendfile string unset
20935 .cindex "file" "mailbox; checking existing format"
20936 This option requests the transport to check the format of an existing file
20937 before adding to it. The check consists of matching a specific string at the
20938 start of the file. The value of the option consists of an even number of
20939 colon-separated strings. The first of each pair is the test string, and the
20940 second is the name of a transport. If the transport associated with a matched
20941 string is not the current transport, control is passed over to the other
20942 transport. For example, suppose the standard &(local_delivery)& transport has
20943 this added to it:
20944 .code
20945 file_format = "From       : local_delivery :\
20946                \1\1\1\1\n : local_mmdf_delivery"
20947 .endd
20948 Mailboxes that begin with &"From"& are still handled by this transport, but if
20949 a mailbox begins with four binary ones followed by a newline, control is passed
20950 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20951 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20952 is assumed to match the current transport. If the start of a mailbox doesn't
20953 match any string, or if the transport named for a given string is not defined,
20954 delivery is deferred.
20955
20956
20957 .option file_must_exist appendfile boolean false
20958 If this option is true, the file specified by the &%file%& option must exist.
20959 A temporary error occurs if it does not, causing delivery to be deferred.
20960 If this option is false, the file is created if it does not exist.
20961
20962
20963 .option lock_fcntl_timeout appendfile time 0s
20964 .cindex "timeout" "mailbox locking"
20965 .cindex "mailbox" "locking, blocking and non-blocking"
20966 .cindex "locking files"
20967 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20968 when locking an open mailbox file. If the call fails, the delivery process
20969 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20970 Non-blocking calls are used so that the file is not kept open during the wait
20971 for the lock; the reason for this is to make it as safe as possible for
20972 deliveries over NFS in the case when processes might be accessing an NFS
20973 mailbox without using a lock file. This should not be done, but
20974 misunderstandings and hence misconfigurations are not unknown.
20975
20976 On a busy system, however, the performance of a non-blocking lock approach is
20977 not as good as using a blocking lock with a timeout. In this case, the waiting
20978 is done inside the system call, and Exim's delivery process acquires the lock
20979 and can proceed as soon as the previous lock holder releases it.
20980
20981 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20982 timeout, are used. There may still be some retrying: the maximum number of
20983 retries is
20984 .code
20985 (lock_retries * lock_interval) / lock_fcntl_timeout
20986 .endd
20987 rounded up to the next whole number. In other words, the total time during
20988 which &(appendfile)& is trying to get a lock is roughly the same, unless
20989 &%lock_fcntl_timeout%& is set very large.
20990
20991 You should consider setting this option if you are getting a lot of delayed
20992 local deliveries because of errors of the form
20993 .code
20994 failed to lock mailbox /some/file (fcntl)
20995 .endd
20996
20997 .option lock_flock_timeout appendfile time 0s
20998 This timeout applies to file locking when using &[flock()]& (see
20999 &%use_flock%&); the timeout operates in a similar manner to
21000 &%lock_fcntl_timeout%&.
21001
21002
21003 .option lock_interval appendfile time 3s
21004 This specifies the time to wait between attempts to lock the file. See below
21005 for details of locking.
21006
21007
21008 .option lock_retries appendfile integer 10
21009 This specifies the maximum number of attempts to lock the file. A value of zero
21010 is treated as 1. See below for details of locking.
21011
21012
21013 .option lockfile_mode appendfile "octal integer" 0600
21014 This specifies the mode of the created lock file, when a lock file is being
21015 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21016
21017
21018 .option lockfile_timeout appendfile time 30m
21019 .cindex "timeout" "mailbox locking"
21020 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21021 exists and is older than this value, it is assumed to have been left behind by
21022 accident, and Exim attempts to remove it.
21023
21024
21025 .option mailbox_filecount appendfile string&!! unset
21026 .cindex "mailbox" "specifying size of"
21027 .cindex "size" "of mailbox"
21028 If this option is set, it is expanded, and the result is taken as the current
21029 number of files in the mailbox. It must be a decimal number, optionally
21030 followed by K or M. This provides a way of obtaining this information from an
21031 external source that maintains the data.
21032
21033
21034 .option mailbox_size appendfile string&!! unset
21035 .cindex "mailbox" "specifying size of"
21036 .cindex "size" "of mailbox"
21037 If this option is set, it is expanded, and the result is taken as the current
21038 size the mailbox. It must be a decimal number, optionally followed by K or M.
21039 This provides a way of obtaining this information from an external source that
21040 maintains the data. This is likely to be helpful for maildir deliveries where
21041 it is computationally expensive to compute the size of a mailbox.
21042
21043
21044
21045 .option maildir_format appendfile boolean false
21046 .cindex "maildir format" "specifying"
21047 If this option is set with the &%directory%& option, the delivery is into a new
21048 file, in the &"maildir"& format that is used by other mail software. When the
21049 transport is activated directly from a &(redirect)& router (for example, the
21050 &(address_file)& transport in the default configuration), setting
21051 &%maildir_format%& causes the path received from the router to be treated as a
21052 directory, whether or not it ends with &`/`&. This option is available only if
21053 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21054 &<<SECTmaildirdelivery>>& below for further details.
21055
21056
21057 .option maildir_quota_directory_regex appendfile string "See below"
21058 .cindex "maildir format" "quota; directories included in"
21059 .cindex "quota" "maildir; directories included in"
21060 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21061 a regular expression for specifying directories, relative to the quota
21062 directory (see &%quota_directory%&), that should be included in the quota
21063 calculation. The default value is:
21064 .code
21065 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21066 .endd
21067 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21068 (directories whose names begin with a dot). If you want to exclude the
21069 &_Trash_&
21070 folder from the count (as some sites do), you need to change this setting to
21071 .code
21072 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21073 .endd
21074 This uses a negative lookahead in the regular expression to exclude the
21075 directory whose name is &_.Trash_&. When a directory is excluded from quota
21076 calculations, quota processing is bypassed for any messages that are delivered
21077 directly into that directory.
21078
21079
21080 .option maildir_retries appendfile integer 10
21081 This option specifies the number of times to retry when writing a file in
21082 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21083
21084
21085 .option maildir_tag appendfile string&!! unset
21086 This option applies only to deliveries in maildir format, and is described in
21087 section &<<SECTmaildirdelivery>>& below.
21088
21089
21090 .option maildir_use_size_file appendfile&!! boolean false
21091 .cindex "maildir format" "&_maildirsize_& file"
21092 The result of string expansion for this option must be a valid boolean value.
21093 If it is true, it enables support for &_maildirsize_& files. Exim
21094 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21095 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21096 value is zero. See &%maildir_quota_directory_regex%& above and section
21097 &<<SECTmaildirdelivery>>& below for further details.
21098
21099 .option maildirfolder_create_regex appendfile string unset
21100 .cindex "maildir format" "&_maildirfolder_& file"
21101 .cindex "&_maildirfolder_&, creating"
21102 The value of this option is a regular expression. If it is unset, it has no
21103 effect. Otherwise, before a maildir delivery takes place, the pattern is
21104 matched against the name of the maildir directory, that is, the directory
21105 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21106 delivery. If there is a match, Exim checks for the existence of a file called
21107 &_maildirfolder_& in the directory, and creates it if it does not exist.
21108 See section &<<SECTmaildirdelivery>>& for more details.
21109
21110
21111 .option mailstore_format appendfile boolean false
21112 .cindex "mailstore format" "specifying"
21113 If this option is set with the &%directory%& option, the delivery is into two
21114 new files in  &"mailstore"& format. The option is available only if
21115 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21116 below for further details.
21117
21118
21119 .option mailstore_prefix appendfile string&!! unset
21120 This option applies only to deliveries in mailstore format, and is described in
21121 section &<<SECTopdir>>& below.
21122
21123
21124 .option mailstore_suffix appendfile string&!! unset
21125 This option applies only to deliveries in mailstore format, and is described in
21126 section &<<SECTopdir>>& below.
21127
21128
21129 .option mbx_format appendfile boolean false
21130 .cindex "locking files"
21131 .cindex "file" "locking"
21132 .cindex "file" "MBX format"
21133 .cindex "MBX format, specifying"
21134 This option is available only if Exim has been compiled with SUPPORT_MBX
21135 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21136 the message is appended to the mailbox file in MBX format instead of
21137 traditional Unix format. This format is supported by Pine4 and its associated
21138 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21139
21140 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21141 automatically changed by the use of &%mbx_format%&. They should normally be set
21142 empty when using MBX format, so this option almost always appears in this
21143 combination:
21144 .code
21145 mbx_format = true
21146 message_prefix =
21147 message_suffix =
21148 .endd
21149 If none of the locking options are mentioned in the configuration,
21150 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21151 is possible to specify the other kinds of locking with &%mbx_format%&, but
21152 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21153 interworks with &'c-client'&, providing for shared access to the mailbox. It
21154 should not be used if any program that does not use this form of locking is
21155 going to access the mailbox, nor should it be used if the mailbox file is NFS
21156 mounted, because it works only when the mailbox is accessed from a single host.
21157
21158 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21159 the standard version of &'c-client'&, because as long as it has a mailbox open
21160 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21161 append messages to it.
21162
21163
21164 .option message_prefix appendfile string&!! "see below"
21165 .cindex "&""From""& line"
21166 The string specified here is expanded and output at the start of every message.
21167 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21168 in which case it is:
21169 .code
21170 message_prefix = "From ${if def:return_path{$return_path}\
21171   {MAILER-DAEMON}} $tod_bsdinbox\n"
21172 .endd
21173 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21174 &`\n`& to &`\r\n`& in &%message_prefix%&.
21175
21176 .option message_suffix appendfile string&!! "see below"
21177 The string specified here is expanded and output at the end of every message.
21178 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21179 in which case it is a single newline character. The suffix can be suppressed by
21180 setting
21181 .code
21182 message_suffix =
21183 .endd
21184 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21185 &`\n`& to &`\r\n`& in &%message_suffix%&.
21186
21187 .option mode appendfile "octal integer" 0600
21188 If the output file is created, it is given this mode. If it already exists and
21189 has wider permissions, they are reduced to this mode. If it has narrower
21190 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21191 if the delivery is the result of a &%save%& command in a filter file specifying
21192 a particular mode, the mode of the output file is always forced to take that
21193 value, and this option is ignored.
21194
21195
21196 .option mode_fail_narrower appendfile boolean true
21197 This option applies in the case when an existing mailbox file has a narrower
21198 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21199 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21200 continues with the delivery attempt, using the existing mode of the file.
21201
21202
21203 .option notify_comsat appendfile boolean false
21204 If this option is true, the &'comsat'& daemon is notified after every
21205 successful delivery to a user mailbox. This is the daemon that notifies logged
21206 on users about incoming mail.
21207
21208
21209 .option quota appendfile string&!! unset
21210 .cindex "quota" "imposed by Exim"
21211 This option imposes a limit on the size of the file to which Exim is appending,
21212 or to the total space used in the directory tree when the &%directory%& option
21213 is set. In the latter case, computation of the space used is expensive, because
21214 all the files in the directory (and any sub-directories) have to be
21215 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21216 &%maildir_use_size_file%& for ways to avoid this in environments where users
21217 have no shell access to their mailboxes).
21218
21219 As there is no interlock against two simultaneous deliveries into a
21220 multi-file mailbox, it is possible for the quota to be overrun in this case.
21221 For single-file mailboxes, of course, an interlock is a necessity.
21222
21223 A file's size is taken as its &'used'& value. Because of blocking effects, this
21224 may be a lot less than the actual amount of disk space allocated to the file.
21225 If the sizes of a number of files are being added up, the rounding effect can
21226 become quite noticeable, especially on systems that have large block sizes.
21227 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21228 the obvious value which users understand most easily.
21229
21230 The value of the option is expanded, and must then be a numerical value
21231 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21232 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21233 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21234 be handled.
21235
21236 &*Note*&: A value of zero is interpreted as &"no quota"&.
21237
21238 The expansion happens while Exim is running as root, before it changes uid for
21239 the delivery. This means that files that are inaccessible to the end user can
21240 be used to hold quota values that are looked up in the expansion. When delivery
21241 fails because this quota is exceeded, the handling of the error is as for
21242 system quota failures.
21243
21244 By default, Exim's quota checking mimics system quotas, and restricts the
21245 mailbox to the specified maximum size, though the value is not accurate to the
21246 last byte, owing to separator lines and additional headers that may get added
21247 during message delivery. When a mailbox is nearly full, large messages may get
21248 refused even though small ones are accepted, because the size of the current
21249 message is added to the quota when the check is made. This behaviour can be
21250 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21251 for exceeding the quota does not include the current message. Thus, deliveries
21252 continue until the quota has been exceeded; thereafter, no further messages are
21253 delivered. See also &%quota_warn_threshold%&.
21254
21255
21256 .option quota_directory appendfile string&!! unset
21257 This option defines the directory to check for quota purposes when delivering
21258 into individual files. The default is the delivery directory, or, if a file
21259 called &_maildirfolder_& exists in a maildir directory, the parent of the
21260 delivery directory.
21261
21262
21263 .option quota_filecount appendfile string&!! 0
21264 This option applies when the &%directory%& option is set. It limits the total
21265 number of files in the directory (compare the inode limit in system quotas). It
21266 can only be used if &%quota%& is also set. The value is expanded; an expansion
21267 failure causes delivery to be deferred. A value of zero is interpreted as
21268 &"no quota"&.
21269
21270
21271 .option quota_is_inclusive appendfile boolean true
21272 See &%quota%& above.
21273
21274
21275 .option quota_size_regex appendfile string unset
21276 This option applies when one of the delivery modes that writes a separate file
21277 for each message is being used. When Exim wants to find the size of one of
21278 these files in order to test the quota, it first checks &%quota_size_regex%&.
21279 If this is set to a regular expression that matches the file name, and it
21280 captures one string, that string is interpreted as a representation of the
21281 file's size. The value of &%quota_size_regex%& is not expanded.
21282
21283 This feature is useful only when users have no shell access to their mailboxes
21284 &-- otherwise they could defeat the quota simply by renaming the files. This
21285 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21286 the file length to the file name. For example:
21287 .code
21288 maildir_tag = ,S=$message_size
21289 quota_size_regex = ,S=(\d+)
21290 .endd
21291 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21292 number of lines in the message.
21293
21294 The regular expression should not assume that the length is at the end of the
21295 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21296 sometimes add other information onto the ends of message file names.
21297
21298 Section &<<SECID136>>& contains further information.
21299
21300
21301 .option quota_warn_message appendfile string&!! "see below"
21302 See below for the use of this option. If it is not set when
21303 &%quota_warn_threshold%& is set, it defaults to
21304 .code
21305 quota_warn_message = "\
21306   To: $local_part@$domain\n\
21307   Subject: Your mailbox\n\n\
21308   This message is automatically created \
21309   by mail delivery software.\n\n\
21310   The size of your mailbox has exceeded \
21311   a warning threshold that is\n\
21312   set by the system administrator.\n"
21313 .endd
21314
21315
21316 .option quota_warn_threshold appendfile string&!! 0
21317 .cindex "quota" "warning threshold"
21318 .cindex "mailbox" "size warning"
21319 .cindex "size" "of mailbox"
21320 This option is expanded in the same way as &%quota%& (see above). If the
21321 resulting value is greater than zero, and delivery of the message causes the
21322 size of the file or total space in the directory tree to cross the given
21323 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21324 may be specified as a percentage of it by following the value with a percent
21325 sign. For example:
21326 .code
21327 quota = 10M
21328 quota_warn_threshold = 75%
21329 .endd
21330 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21331 percent sign is ignored.
21332
21333 The warning message itself is specified by the &%quota_warn_message%& option,
21334 and it must start with a &'To:'& header line containing the recipient(s) of the
21335 warning message. These do not necessarily have to include the recipient(s) of
21336 the original message. A &'Subject:'& line should also normally be supplied. You
21337 can include any other header lines that you want. If you do not include a
21338 &'From:'& line, the default is:
21339 .code
21340 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21341 .endd
21342 .oindex &%errors_reply_to%&
21343 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21344 option.
21345
21346 The &%quota%& option does not have to be set in order to use this option; they
21347 are independent of one another except when the threshold is specified as a
21348 percentage.
21349
21350
21351 .option use_bsmtp appendfile boolean false
21352 .cindex "envelope sender"
21353 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21354 format, with the envelope sender and recipient(s) included as SMTP commands. If
21355 you want to include a leading HELO command with such messages, you can do
21356 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21357 for details of batch SMTP.
21358
21359
21360 .option use_crlf appendfile boolean false
21361 .cindex "carriage return"
21362 .cindex "linefeed"
21363 This option causes lines to be terminated with the two-character CRLF sequence
21364 (carriage return, linefeed) instead of just a linefeed character. In the case
21365 of batched SMTP, the byte sequence written to the file is then an exact image
21366 of what would be sent down a real SMTP connection.
21367
21368 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21369 (which are used to supply the traditional &"From&~"& and blank line separators
21370 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21371 carriage return characters if these are needed. In cases where these options
21372 have non-empty defaults, the values end with a single linefeed, so they must be
21373 changed to end with &`\r\n`& if &%use_crlf%& is set.
21374
21375
21376 .option use_fcntl_lock appendfile boolean "see below"
21377 This option controls the use of the &[fcntl()]& function to lock a file for
21378 exclusive use when a message is being appended. It is set by default unless
21379 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21380 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21381 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21382
21383
21384 .option use_flock_lock appendfile boolean false
21385 This option is provided to support the use of &[flock()]& for file locking, for
21386 the few situations where it is needed. Most modern operating systems support
21387 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21388 each other. Exim uses &[fcntl()]& locking by default.
21389
21390 This option is required only if you are using an operating system where
21391 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21392 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21393 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21394
21395 .cindex "Solaris" "&[flock()]& support"
21396 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21397 have it (and some, I think, provide a not quite right version built on top of
21398 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21399 the ability to use it, and any attempt to do so will cause a configuration
21400 error.
21401
21402 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21403 is just being mapped onto &[fcntl()]& by the OS).
21404
21405
21406 .option use_lockfile appendfile boolean "see below"
21407 If this option is turned off, Exim does not attempt to create a lock file when
21408 appending to a mailbox file. In this situation, the only locking is by
21409 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21410 sure that every MUA that is ever going to look at your users' mailboxes uses
21411 &[fcntl()]& rather than a lock file, and even then only when you are not
21412 delivering over NFS from more than one host.
21413
21414 .cindex "NFS" "lock file"
21415 In order to append to an NFS file safely from more than one host, it is
21416 necessary to take out a lock &'before'& opening the file, and the lock file
21417 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21418 file corruption.
21419
21420 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21421 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21422 except when &%mbx_format%& is set.
21423
21424
21425 .option use_mbx_lock appendfile boolean "see below"
21426 This option is available only if Exim has been compiled with SUPPORT_MBX
21427 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21428 locking rules be used. It is set by default if &%mbx_format%& is set and none
21429 of the locking options are mentioned in the configuration. The locking rules
21430 are the same as are used by the &'c-client'& library that underlies Pine and
21431 the IMAP4 and POP daemons that come with it (see the discussion below). The
21432 rules allow for shared access to the mailbox. However, this kind of locking
21433 does not work when the mailbox is NFS mounted.
21434
21435 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21436 &%use_flock_lock%& to control what kind of locking is used in implementing the
21437 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21438 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21439
21440
21441
21442
21443 .section "Operational details for appending" "SECTopappend"
21444 .cindex "appending to a file"
21445 .cindex "file" "appending"
21446 Before appending to a file, the following preparations are made:
21447
21448 .ilist
21449 If the name of the file is &_/dev/null_&, no action is taken, and a success
21450 return is given.
21451
21452 .next
21453 .cindex "directory creation"
21454 If any directories on the file's path are missing, Exim creates them if the
21455 &%create_directory%& option is set. A created directory's mode is given by the
21456 &%directory_mode%& option.
21457
21458 .next
21459 If &%file_format%& is set, the format of an existing file is checked. If this
21460 indicates that a different transport should be used, control is passed to that
21461 transport.
21462
21463 .next
21464 .cindex "file" "locking"
21465 .cindex "locking files"
21466 .cindex "NFS" "lock file"
21467 If &%use_lockfile%& is set, a lock file is built in a way that will work
21468 reliably over NFS, as follows:
21469
21470 .olist
21471 Create a &"hitching post"& file whose name is that of the lock file with the
21472 current time, primary host name, and process id added, by opening for writing
21473 as a new file. If this fails with an access error, delivery is deferred.
21474 .next
21475 Close the hitching post file, and hard link it to the lock file name.
21476 .next
21477 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21478 Unlink the hitching post name.
21479 .next
21480 Otherwise, use &[stat()]& to get information about the hitching post file, and
21481 then unlink hitching post name. If the number of links is exactly two, creation
21482 of the lock file succeeded but something (for example, an NFS server crash and
21483 restart) caused this fact not to be communicated to the &[link()]& call.
21484 .next
21485 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21486 up to &%lock_retries%& times. However, since any program that writes to a
21487 mailbox should complete its task very quickly, it is reasonable to time out old
21488 lock files that are normally the result of user agent and system crashes. If an
21489 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21490 it before trying again.
21491 .endlist olist
21492
21493 .next
21494 A call is made to &[lstat()]& to discover whether the main file exists, and if
21495 so, what its characteristics are. If &[lstat()]& fails for any reason other
21496 than non-existence, delivery is deferred.
21497
21498 .next
21499 .cindex "symbolic link" "to mailbox"
21500 .cindex "mailbox" "symbolic link"
21501 If the file does exist and is a symbolic link, delivery is deferred, unless the
21502 &%allow_symlink%& option is set, in which case the ownership of the link is
21503 checked, and then &[stat()]& is called to find out about the real file, which
21504 is then subjected to the checks below. The check on the top-level link
21505 ownership prevents one user creating a link for another's mailbox in a sticky
21506 directory, though allowing symbolic links in this case is definitely not a good
21507 idea. If there is a chain of symbolic links, the intermediate ones are not
21508 checked.
21509
21510 .next
21511 If the file already exists but is not a regular file, or if the file's owner
21512 and group (if the group is being checked &-- see &%check_group%& above) are
21513 different from the user and group under which the delivery is running,
21514 delivery is deferred.
21515
21516 .next
21517 If the file's permissions are more generous than specified, they are reduced.
21518 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21519 is set false, in which case the delivery is tried using the existing
21520 permissions.
21521
21522 .next
21523 The file's inode number is saved, and the file is then opened for appending.
21524 If this fails because the file has vanished, &(appendfile)& behaves as if it
21525 hadn't existed (see below). For any other failures, delivery is deferred.
21526
21527 .next
21528 If the file is opened successfully, check that the inode number hasn't
21529 changed, that it is still a regular file, and that the owner and permissions
21530 have not changed. If anything is wrong, defer delivery and freeze the message.
21531
21532 .next
21533 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21534 option is set. Otherwise, check that the file is being created in a permitted
21535 directory if the &%create_file%& option is set (deferring on failure), and then
21536 open for writing as a new file, with the O_EXCL and O_CREAT options,
21537 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21538 set). In this case, which can happen if the link points to a non-existent file,
21539 the file is opened for writing using O_CREAT but not O_EXCL, because
21540 that prevents link following.
21541
21542 .next
21543 .cindex "loop" "while file testing"
21544 If opening fails because the file exists, obey the tests given above for
21545 existing files. However, to avoid looping in a situation where the file is
21546 being continuously created and destroyed, the exists/not-exists loop is broken
21547 after 10 repetitions, and the message is then frozen.
21548
21549 .next
21550 If opening fails with any other error, defer delivery.
21551
21552 .next
21553 .cindex "file" "locking"
21554 .cindex "locking files"
21555 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21556 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21557 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21558 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21559 file, and an exclusive lock on the file whose name is
21560 .code
21561 /tmp/.<device-number>.<inode-number>
21562 .endd
21563 using the device and inode numbers of the open mailbox file, in accordance with
21564 the MBX locking rules. This file is created with a mode that is specified by
21565 the &%lockfile_mode%& option.
21566
21567 If Exim fails to lock the file, there are two possible courses of action,
21568 depending on the value of the locking timeout. This is obtained from
21569 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21570
21571 If the timeout value is zero, the file is closed, Exim waits for
21572 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21573 to lock it again. This happens up to &%lock_retries%& times, after which the
21574 delivery is deferred.
21575
21576 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21577 &[flock()]& are used (with the given timeout), so there has already been some
21578 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21579 immediately. It retries up to
21580 .code
21581 (lock_retries * lock_interval) / <timeout>
21582 .endd
21583 times (rounded up).
21584 .endlist
21585
21586 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21587 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21588
21589
21590 .section "Operational details for delivery to a new file" "SECTopdir"
21591 .cindex "delivery" "to single file"
21592 .cindex "&""From""& line"
21593 When the &%directory%& option is set instead of &%file%&, each message is
21594 delivered into a newly-created file or set of files. When &(appendfile)& is
21595 activated directly from a &(redirect)& router, neither &%file%& nor
21596 &%directory%& is normally set, because the path for delivery is supplied by the
21597 router. (See for example, the &(address_file)& transport in the default
21598 configuration.) In this case, delivery is to a new file if either the path name
21599 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21600
21601 No locking is required while writing the message to a new file, so the various
21602 locking options of the transport are ignored. The &"From"& line that by default
21603 separates messages in a single file is not normally needed, nor is the escaping
21604 of message lines that start with &"From"&, and there is no need to ensure a
21605 newline at the end of each message. Consequently, the default values for
21606 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21607 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21608
21609 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21610 the files in the delivery directory by default. However, you can specify a
21611 different directory by setting &%quota_directory%&. Also, for maildir
21612 deliveries (see below) the &_maildirfolder_& convention is honoured.
21613
21614
21615 .cindex "maildir format"
21616 .cindex "mailstore format"
21617 There are three different ways in which delivery to individual files can be
21618 done, controlled by the settings of the &%maildir_format%& and
21619 &%mailstore_format%& options. Note that code to support maildir or mailstore
21620 formats is not included in the binary unless SUPPORT_MAILDIR or
21621 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21622
21623 .cindex "directory creation"
21624 In all three cases an attempt is made to create the directory and any necessary
21625 sub-directories if they do not exist, provided that the &%create_directory%&
21626 option is set (the default). The location of a created directory can be
21627 constrained by setting &%create_file%&. A created directory's mode is given by
21628 the &%directory_mode%& option. If creation fails, or if the
21629 &%create_directory%& option is not set when creation is required, delivery is
21630 deferred.
21631
21632
21633
21634 .section "Maildir delivery" "SECTmaildirdelivery"
21635 .cindex "maildir format" "description of"
21636 If the &%maildir_format%& option is true, Exim delivers each message by writing
21637 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21638 directory that is defined by the &%directory%& option (the &"delivery
21639 directory"&). If the delivery is successful, the file is renamed into the
21640 &_new_& subdirectory.
21641
21642 In the file name, <&'stime'&> is the current time of day in seconds, and
21643 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21644 Exim checks that the time-of-day clock has moved on by at least one microsecond
21645 before terminating the delivery process. This guarantees uniqueness for the
21646 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21647 opening it. If any response other than ENOENT (does not exist) is given,
21648 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21649
21650 Before Exim carries out a maildir delivery, it ensures that subdirectories
21651 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21652 do not exist, Exim tries to create them and any superior directories in their
21653 path, subject to the &%create_directory%& and &%create_file%& options. If the
21654 &%maildirfolder_create_regex%& option is set, and the regular expression it
21655 contains matches the delivery directory, Exim also ensures that a file called
21656 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21657 &_maildirfolder_& file cannot be created, delivery is deferred.
21658
21659 These features make it possible to use Exim to create all the necessary files
21660 and directories in a maildir mailbox, including subdirectories for maildir++
21661 folders. Consider this example:
21662 .code
21663 maildir_format = true
21664 directory = /var/mail/$local_part\
21665            ${if eq{$local_part_suffix}{}{}\
21666            {/.${substr_1:$local_part_suffix}}}
21667 maildirfolder_create_regex = /\.[^/]+$
21668 .endd
21669 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21670 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21671 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21672 not match this name, so Exim will not look for or create the file
21673 &_/var/mail/pimbo/maildirfolder_&, though it will create
21674 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21675
21676 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21677 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21678 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21679 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21680 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21681
21682 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21683 not inadvertently match the toplevel maildir directory, because a
21684 &_maildirfolder_& file at top level would completely break quota calculations.
21685
21686 .cindex "quota" "in maildir delivery"
21687 .cindex "maildir++"
21688 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21689 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21690 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21691 Exim assumes the directory is a maildir++ folder directory, which is one level
21692 down from the user's top level mailbox directory. This causes it to start at
21693 the parent directory instead of the current directory when calculating the
21694 amount of space used.
21695
21696 One problem with delivering into a multi-file mailbox is that it is
21697 computationally expensive to compute the size of the mailbox for quota
21698 checking. Various approaches have been taken to reduce the amount of work
21699 needed. The next two sections describe two of them. A third alternative is to
21700 use some external process for maintaining the size data, and use the expansion
21701 of the &%mailbox_size%& option as a way of importing it into Exim.
21702
21703
21704
21705
21706 .section "Using tags to record message sizes" "SECID135"
21707 If &%maildir_tag%& is set, the string is expanded for each delivery.
21708 When the maildir file is renamed into the &_new_& sub-directory, the
21709 tag is added to its name. However, if adding the tag takes the length of the
21710 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21711 the tag is dropped and the maildir file is created with no tag.
21712
21713
21714 .vindex "&$message_size$&"
21715 Tags can be used to encode the size of files in their names; see
21716 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21717 happens after the message has been written. The value of the &$message_size$&
21718 variable is set to the number of bytes actually written. If the expansion is
21719 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21720 be deferred. The expanded tag may contain any printing characters except &"/"&.
21721 Non-printing characters in the string are ignored; if the resulting string is
21722 empty, it is ignored. If it starts with an alphanumeric character, a leading
21723 colon is inserted; this default has not proven to be the path that popular
21724 maildir implementations have chosen (but changing it in Exim would break
21725 backwards compatibility).
21726
21727 For one common implementation, you might set:
21728 .code
21729 maildir_tag = ,S=${message_size}
21730 .endd
21731 but you should check the documentation of the other software to be sure.
21732
21733 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21734 as this allows Exim to extract the size from your tag, instead of having to
21735 &[stat()]& each message file.
21736
21737
21738 .section "Using a maildirsize file" "SECID136"
21739 .cindex "quota" "in maildir delivery"
21740 .cindex "maildir format" "&_maildirsize_& file"
21741 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21742 storing quota and message size information in a file called &_maildirsize_&
21743 within the toplevel maildir directory. If this file does not exist, Exim
21744 creates it, setting the quota from the &%quota%& option of the transport. If
21745 the maildir directory itself does not exist, it is created before any attempt
21746 to write a &_maildirsize_& file.
21747
21748 The &_maildirsize_& file is used to hold information about the sizes of
21749 messages in the maildir, thus speeding up quota calculations. The quota value
21750 in the file is just a cache; if the quota is changed in the transport, the new
21751 value overrides the cached value when the next message is delivered. The cache
21752 is maintained for the benefit of other programs that access the maildir and
21753 need to know the quota.
21754
21755 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21756 file is maintained (with a zero quota setting), but no quota is imposed.
21757
21758 A regular expression is available for controlling which directories in the
21759 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21760 See the description of the &%maildir_quota_directory_regex%& option above for
21761 details.
21762
21763
21764 .section "Mailstore delivery" "SECID137"
21765 .cindex "mailstore format" "description of"
21766 If the &%mailstore_format%& option is true, each message is written as two
21767 files in the given directory. A unique base name is constructed from the
21768 message id and the current delivery process, and the files that are written use
21769 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21770 contains the message's envelope, and the &_.msg_& file contains the message
21771 itself. The base name is placed in the variable &$mailstore_basename$&.
21772
21773 During delivery, the envelope is first written to a file with the suffix
21774 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21775 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21776 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21777 file before accessing either of them. An alternative approach is to wait for
21778 the absence of a &_.tmp_& file.
21779
21780 The envelope file starts with any text defined by the &%mailstore_prefix%&
21781 option, expanded and terminated by a newline if there isn't one. Then follows
21782 the sender address on one line, then all the recipient addresses, one per line.
21783 There can be more than one recipient only if the &%batch_max%& option is set
21784 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21785 appended to the file, followed by a newline if it does not end with one.
21786
21787 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21788 failure, it is ignored. Other expansion errors are treated as serious
21789 configuration errors, and delivery is deferred. The variable
21790 &$mailstore_basename$& is available for use during these expansions.
21791
21792
21793 .section "Non-special new file delivery" "SECID138"
21794 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21795 file is created directly in the named directory. For example, when delivering
21796 messages into files in batched SMTP format for later delivery to some host (see
21797 section &<<SECTbatchSMTP>>&), a setting such as
21798 .code
21799 directory = /var/bsmtp/$host
21800 .endd
21801 might be used. A message is written to a file with a temporary name, which is
21802 then renamed when the delivery is complete. The final name is obtained by
21803 expanding the contents of the &%directory_file%& option.
21804 .ecindex IIDapptra1
21805 .ecindex IIDapptra2
21806
21807
21808
21809
21810
21811
21812 . ////////////////////////////////////////////////////////////////////////////
21813 . ////////////////////////////////////////////////////////////////////////////
21814
21815 .chapter "The autoreply transport" "CHID8"
21816 .scindex IIDauttra1 "transports" "&(autoreply)&"
21817 .scindex IIDauttra2 "&(autoreply)& transport"
21818 The &(autoreply)& transport is not a true transport in that it does not cause
21819 the message to be transmitted. Instead, it generates a new mail message as an
21820 automatic reply to the incoming message. &'References:'& and
21821 &'Auto-Submitted:'& header lines are included. These are constructed according
21822 to the rules in RFCs 2822 and 3834, respectively.
21823
21824 If the router that passes the message to this transport does not have the
21825 &%unseen%& option set, the original message (for the current recipient) is not
21826 delivered anywhere. However, when the &%unseen%& option is set on the router
21827 that passes the message to this transport, routing of the address continues, so
21828 another router can set up a normal message delivery.
21829
21830
21831 The &(autoreply)& transport is usually run as the result of mail filtering, a
21832 &"vacation"& message being the standard example. However, it can also be run
21833 directly from a router like any other transport. To reduce the possibility of
21834 message cascades, messages created by the &(autoreply)& transport always have
21835 empty envelope sender addresses, like bounce messages.
21836
21837 The parameters of the message to be sent can be specified in the configuration
21838 by options described below. However, these are used only when the address
21839 passed to the transport does not contain its own reply information. When the
21840 transport is run as a consequence of a
21841 &%mail%&
21842 or &%vacation%& command in a filter file, the parameters of the message are
21843 supplied by the filter, and passed with the address. The transport's options
21844 that define the message are then ignored (so they are not usually set in this
21845 case). The message is specified entirely by the filter or by the transport; it
21846 is never built from a mixture of options. However, the &%file_optional%&,
21847 &%mode%&, and &%return_message%& options apply in all cases.
21848
21849 &(Autoreply)& is implemented as a local transport. When used as a result of a
21850 command in a user's filter file, &(autoreply)& normally runs under the uid and
21851 gid of the user, and with appropriate current and home directories (see chapter
21852 &<<CHAPenvironment>>&).
21853
21854 There is a subtle difference between routing a message to a &(pipe)& transport
21855 that generates some text to be returned to the sender, and routing it to an
21856 &(autoreply)& transport. This difference is noticeable only if more than one
21857 address from the same message is so handled. In the case of a pipe, the
21858 separate outputs from the different addresses are gathered up and returned to
21859 the sender in a single message, whereas if &(autoreply)& is used, a separate
21860 message is generated for each address that is passed to it.
21861
21862 Non-printing characters are not permitted in the header lines generated for the
21863 message that &(autoreply)& creates, with the exception of newlines that are
21864 immediately followed by white space. If any non-printing characters are found,
21865 the transport defers.
21866 Whether characters with the top bit set count as printing characters or not is
21867 controlled by the &%print_topbitchars%& global option.
21868
21869 If any of the generic options for manipulating headers (for example,
21870 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21871 of the original message that is included in the generated message when
21872 &%return_message%& is set. They do not apply to the generated message itself.
21873
21874 .vindex "&$sender_address$&"
21875 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21876 the message, indicating that there were no recipients, it does not treat this
21877 as an error. This means that autoreplies sent to &$sender_address$& when this
21878 is empty (because the incoming message is a bounce message) do not cause
21879 problems. They are just discarded.
21880
21881
21882
21883 .section "Private options for autoreply" "SECID139"
21884 .cindex "options" "&(autoreply)& transport"
21885
21886 .option bcc autoreply string&!! unset
21887 This specifies the addresses that are to receive &"blind carbon copies"& of the
21888 message when the message is specified by the transport.
21889
21890
21891 .option cc autoreply string&!! unset
21892 This specifies recipients of the message and the contents of the &'Cc:'& header
21893 when the message is specified by the transport.
21894
21895
21896 .option file autoreply string&!! unset
21897 The contents of the file are sent as the body of the message when the message
21898 is specified by the transport. If both &%file%& and &%text%& are set, the text
21899 string comes first.
21900
21901
21902 .option file_expand autoreply boolean false
21903 If this is set, the contents of the file named by the &%file%& option are
21904 subjected to string expansion as they are added to the message.
21905
21906
21907 .option file_optional autoreply boolean false
21908 If this option is true, no error is generated if the file named by the &%file%&
21909 option or passed with the address does not exist or cannot be read.
21910
21911
21912 .option from autoreply string&!! unset
21913 This specifies the contents of the &'From:'& header when the message is
21914 specified by the transport.
21915
21916
21917 .option headers autoreply string&!! unset
21918 This specifies additional RFC 2822 headers that are to be added to the message
21919 when the message is specified by the transport. Several can be given by using
21920 &"\n"& to separate them. There is no check on the format.
21921
21922
21923 .option log autoreply string&!! unset
21924 This option names a file in which a record of every message sent is logged when
21925 the message is specified by the transport.
21926
21927
21928 .option mode autoreply "octal integer" 0600
21929 If either the log file or the &"once"& file has to be created, this mode is
21930 used.
21931
21932
21933 .option never_mail autoreply "address list&!!" unset
21934 If any run of the transport creates a message with a recipient that matches any
21935 item in the list, that recipient is quietly discarded. If all recipients are
21936 discarded, no message is created. This applies both when the recipients are
21937 generated by a filter and when they are specified in the transport.
21938
21939
21940
21941 .option once autoreply string&!! unset
21942 This option names a file or DBM database in which a record of each &'To:'&
21943 recipient is kept when the message is specified by the transport. &*Note*&:
21944 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21945
21946 If &%once%& is unset, or is set to an empty string, the message is always sent.
21947 By default, if &%once%& is set to a non-empty file name, the message
21948 is not sent if a potential recipient is already listed in the database.
21949 However, if the &%once_repeat%& option specifies a time greater than zero, the
21950 message is sent if that much time has elapsed since a message was last sent to
21951 this recipient. A setting of zero time for &%once_repeat%& (the default)
21952 prevents a message from being sent a second time &-- in this case, zero means
21953 infinity.
21954
21955 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21956 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21957 greater than zero, it changes the way Exim implements the &%once%& option.
21958 Instead of using a DBM file to record every recipient it sends to, it uses a
21959 regular file, whose size will never get larger than the given value.
21960
21961 In the file, Exim keeps a linear list of recipient addresses and the times at
21962 which they were sent messages. If the file is full when a new address needs to
21963 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21964 means that a given recipient may receive multiple messages, but at
21965 unpredictable intervals that depend on the rate of turnover of addresses in the
21966 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21967
21968
21969 .option once_file_size autoreply integer 0
21970 See &%once%& above.
21971
21972
21973 .option once_repeat autoreply time&!! 0s
21974 See &%once%& above.
21975 After expansion, the value of this option must be a valid time value.
21976
21977
21978 .option reply_to autoreply string&!! unset
21979 This specifies the contents of the &'Reply-To:'& header when the message is
21980 specified by the transport.
21981
21982
21983 .option return_message autoreply boolean false
21984 If this is set, a copy of the original message is returned with the new
21985 message, subject to the maximum size set in the &%return_size_limit%& global
21986 configuration option.
21987
21988
21989 .option subject autoreply string&!! unset
21990 This specifies the contents of the &'Subject:'& header when the message is
21991 specified by the transport. It is tempting to quote the original subject in
21992 automatic responses. For example:
21993 .code
21994 subject = Re: $h_subject:
21995 .endd
21996 There is a danger in doing this, however. It may allow a third party to
21997 subscribe your users to an opt-in mailing list, provided that the list accepts
21998 bounce messages as subscription confirmations. Well-managed lists require a
21999 non-bounce message to confirm a subscription, so the danger is relatively
22000 small.
22001
22002
22003
22004 .option text autoreply string&!! unset
22005 This specifies a single string to be used as the body of the message when the
22006 message is specified by the transport. If both &%text%& and &%file%& are set,
22007 the text comes first.
22008
22009
22010 .option to autoreply string&!! unset
22011 This specifies recipients of the message and the contents of the &'To:'& header
22012 when the message is specified by the transport.
22013 .ecindex IIDauttra1
22014 .ecindex IIDauttra2
22015
22016
22017
22018
22019 . ////////////////////////////////////////////////////////////////////////////
22020 . ////////////////////////////////////////////////////////////////////////////
22021
22022 .chapter "The lmtp transport" "CHAPLMTP"
22023 .cindex "transports" "&(lmtp)&"
22024 .cindex "&(lmtp)& transport"
22025 .cindex "LMTP" "over a pipe"
22026 .cindex "LMTP" "over a socket"
22027 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22028 specified command
22029 or by interacting with a Unix domain socket.
22030 This transport is something of a cross between the &(pipe)& and &(smtp)&
22031 transports. Exim also has support for using LMTP over TCP/IP; this is
22032 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22033 to be of minority interest, the default build-time configure in &_src/EDITME_&
22034 has it commented out. You need to ensure that
22035 .code
22036 TRANSPORT_LMTP=yes
22037 .endd
22038 .cindex "options" "&(lmtp)& transport"
22039 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22040 included in the Exim binary. The private options of the &(lmtp)& transport are
22041 as follows:
22042
22043 .option batch_id lmtp string&!! unset
22044 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22045
22046
22047 .option batch_max lmtp integer 1
22048 This limits the number of addresses that can be handled in a single delivery.
22049 Most LMTP servers can handle several addresses at once, so it is normally a
22050 good idea to increase this value. See the description of local delivery
22051 batching in chapter &<<CHAPbatching>>&.
22052
22053
22054 .option command lmtp string&!! unset
22055 This option must be set if &%socket%& is not set. The string is a command which
22056 is run in a separate process. It is split up into a command name and list of
22057 arguments, each of which is separately expanded (so expansion cannot change the
22058 number of arguments). The command is run directly, not via a shell. The message
22059 is passed to the new process using the standard input and output to operate the
22060 LMTP protocol.
22061
22062 .option ignore_quota lmtp boolean false
22063 .cindex "LMTP" "ignoring quota errors"
22064 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22065 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22066 in its response to the LHLO command.
22067
22068 .option socket lmtp string&!! unset
22069 This option must be set if &%command%& is not set. The result of expansion must
22070 be the name of a Unix domain socket. The transport connects to the socket and
22071 delivers the message to it using the LMTP protocol.
22072
22073
22074 .option timeout lmtp time 5m
22075 The transport is aborted if the created process or Unix domain socket does not
22076 respond to LMTP commands or message input within this timeout. Delivery
22077 is deferred, and will be tried again later. Here is an example of a typical
22078 LMTP transport:
22079 .code
22080 lmtp:
22081   driver = lmtp
22082   command = /some/local/lmtp/delivery/program
22083   batch_max = 20
22084   user = exim
22085 .endd
22086 This delivers up to 20 addresses at a time, in a mixture of domains if
22087 necessary, running as the user &'exim'&.
22088
22089
22090
22091 . ////////////////////////////////////////////////////////////////////////////
22092 . ////////////////////////////////////////////////////////////////////////////
22093
22094 .chapter "The pipe transport" "CHAPpipetransport"
22095 .scindex IIDpiptra1 "transports" "&(pipe)&"
22096 .scindex IIDpiptra2 "&(pipe)& transport"
22097 The &(pipe)& transport is used to deliver messages via a pipe to a command
22098 running in another process. One example is the use of &(pipe)& as a
22099 pseudo-remote transport for passing messages to some other delivery mechanism
22100 (such as UUCP). Another is the use by individual users to automatically process
22101 their incoming messages. The &(pipe)& transport can be used in one of the
22102 following ways:
22103
22104 .ilist
22105 .vindex "&$local_part$&"
22106 A router routes one address to a transport in the normal way, and the
22107 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22108 contains the local part of the address (as usual), and the command that is run
22109 is specified by the &%command%& option on the transport.
22110 .next
22111 .vindex "&$pipe_addresses$&"
22112 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22113 transport can handle more than one address in a single run. In this case, when
22114 more than one address is routed to the transport, &$local_part$& is not set
22115 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22116 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22117 that are routed to the transport.
22118 .next
22119 .vindex "&$address_pipe$&"
22120 A router redirects an address directly to a pipe command (for example, from an
22121 alias or forward file). In this case, &$address_pipe$& contains the text of the
22122 pipe command, and the &%command%& option on the transport is ignored unless
22123 &%force_command%& is set. If only one address is being transported
22124 (&%batch_max%& is not greater than one, or only one address was redirected to
22125 this pipe command), &$local_part$& contains the local part that was redirected.
22126 .endlist
22127
22128
22129 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22130 deliver messages over pipes using the LMTP interactive protocol. This is
22131 implemented by the &(lmtp)& transport.
22132
22133 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22134 &_.forward_& file, the command runs under the uid and gid of that user. In
22135 other cases, the uid and gid have to be specified explicitly, either on the
22136 transport or on the router that handles the address. Current and &"home"&
22137 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22138 details of the local delivery environment and chapter &<<CHAPbatching>>&
22139 for a discussion of local delivery batching.
22140
22141
22142 .section "Concurrent delivery" "SECID140"
22143 If two messages arrive at almost the same time, and both are routed to a pipe
22144 delivery, the two pipe transports may be run concurrently. You must ensure that
22145 any pipe commands you set up are robust against this happening. If the commands
22146 write to a file, the &%exim_lock%& utility might be of use.
22147
22148
22149
22150
22151 .section "Returned status and data" "SECID141"
22152 .cindex "&(pipe)& transport" "returned data"
22153 If the command exits with a non-zero return code, the delivery is deemed to
22154 have failed, unless either the &%ignore_status%& option is set (in which case
22155 the return code is treated as zero), or the return code is one of those listed
22156 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22157 later"&. In this case, delivery is deferred. Details of a permanent failure are
22158 logged, but are not included in the bounce message, which merely contains
22159 &"local delivery failed"&.
22160
22161 If the command exits on a signal and the &%freeze_signal%& option is set then
22162 the message will be frozen in the queue. If that option is not set, a bounce
22163 will be sent as normal.
22164
22165 If the return code is greater than 128 and the command being run is a shell
22166 script, it normally means that the script was terminated by a signal whose
22167 value is the return code minus 128. The &%freeze_signal%& option does not
22168 apply in this case.
22169
22170 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22171 return code is set to 127. This is the value that a shell returns if it is
22172 asked to run a non-existent command. The wording for the log line suggests that
22173 a non-existent command may be the problem.
22174
22175 The &%return_output%& option can affect the result of a pipe delivery. If it is
22176 set and the command produces any output on its standard output or standard
22177 error streams, the command is considered to have failed, even if it gave a zero
22178 return code or if &%ignore_status%& is set. The output from the command is
22179 included as part of the bounce message. The &%return_fail_output%& option is
22180 similar, except that output is returned only when the command exits with a
22181 failure return code, that is, a value other than zero or a code that matches
22182 &%temp_errors%&.
22183
22184
22185
22186 .section "How the command is run" "SECThowcommandrun"
22187 .cindex "&(pipe)& transport" "path for command"
22188 The command line is (by default) broken down into a command name and arguments
22189 by the &(pipe)& transport itself. The &%allow_commands%& and
22190 &%restrict_to_path%& options can be used to restrict the commands that may be
22191 run.
22192
22193 .cindex "quoting" "in pipe command"
22194 Unquoted arguments are delimited by white space. If an argument appears in
22195 double quotes, backslash is interpreted as an escape character in the usual
22196 way. If an argument appears in single quotes, no escaping is done.
22197
22198 String expansion is applied to the command line except when it comes from a
22199 traditional &_.forward_& file (commands from a filter file are expanded). The
22200 expansion is applied to each argument in turn rather than to the whole line.
22201 For this reason, any string expansion item that contains white space must be
22202 quoted so as to be contained within a single argument. A setting such as
22203 .code
22204 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22205 .endd
22206 will not work, because the expansion item gets split between several
22207 arguments. You have to write
22208 .code
22209 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22210 .endd
22211 to ensure that it is all in one argument. The expansion is done in this way,
22212 argument by argument, so that the number of arguments cannot be changed as a
22213 result of expansion, and quotes or backslashes in inserted variables do not
22214 interact with external quoting. However, this leads to problems if you want to
22215 generate multiple arguments (or the command name plus arguments) from a single
22216 expansion. In this situation, the simplest solution is to use a shell. For
22217 example:
22218 .code
22219 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22220 .endd
22221
22222 .cindex "transport" "filter"
22223 .cindex "filter" "transport filter"
22224 .vindex "&$pipe_addresses$&"
22225 Special handling takes place when an argument consists of precisely the text
22226 &`$pipe_addresses`&. This is not a general expansion variable; the only
22227 place this string is recognized is when it appears as an argument for a pipe or
22228 transport filter command. It causes each address that is being handled to be
22229 inserted in the argument list at that point &'as a separate argument'&. This
22230 avoids any problems with spaces or shell metacharacters, and is of use when a
22231 &(pipe)& transport is handling groups of addresses in a batch.
22232
22233 If &%force_command%& is enabled on the transport, Special handling takes place
22234 for an argument that consists of precisely the text &`$address_pipe`&.  It
22235 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22236 argument is inserted in the argument list at that point
22237 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22238 the only item in the argument; in fact, if it were then &%force_command%&
22239 should behave as a no-op.  Rather, it should be used to adjust the command
22240 run while preserving the argument vector separation.
22241
22242 After splitting up into arguments and expansion, the resulting command is run
22243 in a subprocess directly from the transport, &'not'& under a shell. The
22244 message that is being delivered is supplied on the standard input, and the
22245 standard output and standard error are both connected to a single pipe that is
22246 read by Exim. The &%max_output%& option controls how much output the command
22247 may produce, and the &%return_output%& and &%return_fail_output%& options
22248 control what is done with it.
22249
22250 Not running the command under a shell (by default) lessens the security risks
22251 in cases when a command from a user's filter file is built out of data that was
22252 taken from an incoming message. If a shell is required, it can of course be
22253 explicitly specified as the command to be run. However, there are circumstances
22254 where existing commands (for example, in &_.forward_& files) expect to be run
22255 under a shell and cannot easily be modified. To allow for these cases, there is
22256 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22257 works. Instead of breaking up the command line as just described, it expands it
22258 as a single string and passes the result to &_/bin/sh_&. The
22259 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22260 with &%use_shell%&, and the whole mechanism is inherently less secure.
22261
22262
22263
22264 .section "Environment variables" "SECTpipeenv"
22265 .cindex "&(pipe)& transport" "environment for command"
22266 .cindex "environment for pipe transport"
22267 The environment variables listed below are set up when the command is invoked.
22268 This list is a compromise for maximum compatibility with other MTAs. Note that
22269 the &%environment%& option can be used to add additional variables to this
22270 environment.
22271 .display
22272 &`DOMAIN            `&   the domain of the address
22273 &`HOME              `&   the home directory, if set
22274 &`HOST              `&   the host name when called from a router (see below)
22275 &`LOCAL_PART        `&   see below
22276 &`LOCAL_PART_PREFIX `&   see below
22277 &`LOCAL_PART_SUFFIX `&   see below
22278 &`LOGNAME           `&   see below
22279 &`MESSAGE_ID        `&   Exim's local ID for the message
22280 &`PATH              `&   as specified by the &%path%& option below
22281 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22282 &`RECIPIENT         `&   the complete recipient address
22283 &`SENDER            `&   the sender of the message (empty if a bounce)
22284 &`SHELL             `&   &`/bin/sh`&
22285 &`TZ                `&   the value of the &%timezone%& option, if set
22286 &`USER              `&   see below
22287 .endd
22288 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22289 router, LOCAL_PART is set to the local part of the address. When it is
22290 called as a result of a forward or alias expansion, LOCAL_PART is set to
22291 the local part of the address that was expanded. In both cases, any affixes are
22292 removed from the local part, and made available in LOCAL_PART_PREFIX and
22293 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22294 same value as LOCAL_PART for compatibility with other MTAs.
22295
22296 .cindex "HOST"
22297 HOST is set only when a &(pipe)& transport is called from a router that
22298 associates hosts with an address, typically when using &(pipe)& as a
22299 pseudo-remote transport. HOST is set to the first host name specified by
22300 the router.
22301
22302 .cindex "HOME"
22303 If the transport's generic &%home_directory%& option is set, its value is used
22304 for the HOME environment variable. Otherwise, a home directory may be set
22305 by the router's &%transport_home_directory%& option, which defaults to the
22306 user's home directory if &%check_local_user%& is set.
22307
22308
22309 .section "Private options for pipe" "SECID142"
22310 .cindex "options" "&(pipe)& transport"
22311
22312
22313
22314 .option allow_commands pipe "string list&!!" unset
22315 .cindex "&(pipe)& transport" "permitted commands"
22316 The string is expanded, and is then interpreted as a colon-separated list of
22317 permitted commands. If &%restrict_to_path%& is not set, the only commands
22318 permitted are those in the &%allow_commands%& list. They need not be absolute
22319 paths; the &%path%& option is still used for relative paths. If
22320 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22321 in the &%allow_commands%& list, or a name without any slashes that is found on
22322 the path. In other words, if neither &%allow_commands%& nor
22323 &%restrict_to_path%& is set, there is no restriction on the command, but
22324 otherwise only commands that are permitted by one or the other are allowed. For
22325 example, if
22326 .code
22327 allow_commands = /usr/bin/vacation
22328 .endd
22329 and &%restrict_to_path%& is not set, the only permitted command is
22330 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22331 &%use_shell%& is set.
22332
22333
22334 .option batch_id pipe string&!! unset
22335 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22336
22337
22338 .option batch_max pipe integer 1
22339 This limits the number of addresses that can be handled in a single delivery.
22340 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22341
22342
22343 .option check_string pipe string unset
22344 As &(pipe)& writes the message, the start of each line is tested for matching
22345 &%check_string%&, and if it does, the initial matching characters are replaced
22346 by the contents of &%escape_string%&, provided both are set. The value of
22347 &%check_string%& is a literal string, not a regular expression, and the case of
22348 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22349 of &%check_string%& and &%escape_string%& are forced to values that implement
22350 the SMTP escaping protocol. Any settings made in the configuration file are
22351 ignored.
22352
22353
22354 .option command pipe string&!! unset
22355 This option need not be set when &(pipe)& is being used to deliver to pipes
22356 obtained directly from address redirections. In other cases, the option must be
22357 set, to provide a command to be run. It need not yield an absolute path (see
22358 the &%path%& option below). The command is split up into separate arguments by
22359 Exim, and each argument is separately expanded, as described in section
22360 &<<SECThowcommandrun>>& above.
22361
22362
22363 .option environment pipe string&!! unset
22364 .cindex "&(pipe)& transport" "environment for command"
22365 .cindex "environment for &(pipe)& transport"
22366 This option is used to add additional variables to the environment in which the
22367 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22368 a string which is expanded, and then interpreted as a colon-separated list of
22369 environment settings of the form <&'name'&>=<&'value'&>.
22370
22371
22372 .option escape_string pipe string unset
22373 See &%check_string%& above.
22374
22375
22376 .option freeze_exec_fail pipe boolean false
22377 .cindex "exec failure"
22378 .cindex "failure of exec"
22379 .cindex "&(pipe)& transport" "failure of exec"
22380 Failure to exec the command in a pipe transport is by default treated like
22381 any other failure while running the command. However, if &%freeze_exec_fail%&
22382 is set, failure to exec is treated specially, and causes the message to be
22383 frozen, whatever the setting of &%ignore_status%&.
22384
22385
22386 .option freeze_signal pipe boolean false
22387 .cindex "signal exit"
22388 .cindex "&(pipe)& transport", "signal exit"
22389 Normally if the process run by a command in a pipe transport exits on a signal,
22390 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22391 frozen in Exim's queue instead.
22392
22393
22394 .option force_command pipe boolean false
22395 .cindex "force command"
22396 .cindex "&(pipe)& transport", "force command"
22397 Normally when a router redirects an address directly to a pipe command
22398 the &%command%& option on the transport is ignored.  If &%force_command%&
22399 is set, the &%command%& option will used. This is especially
22400 useful for forcing a wrapper or additional argument to be added to the
22401 command. For example:
22402 .code
22403 command = /usr/bin/remote_exec myhost -- $address_pipe
22404 force_command
22405 .endd
22406
22407 Note that &$address_pipe$& is handled specially in &%command%& when
22408 &%force_command%& is set, expanding out to the original argument vector as
22409 separate items, similarly to a Unix shell &`"$@"`& construct.
22410
22411 .option ignore_status pipe boolean false
22412 If this option is true, the status returned by the subprocess that is set up to
22413 run the command is ignored, and Exim behaves as if zero had been returned.
22414 Otherwise, a non-zero status or termination by signal causes an error return
22415 from the transport unless the status value is one of those listed in
22416 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22417
22418 &*Note*&: This option does not apply to timeouts, which do not return a status.
22419 See the &%timeout_defer%& option for how timeouts are handled.
22420
22421 .option log_defer_output pipe boolean false
22422 .cindex "&(pipe)& transport" "logging output"
22423 If this option is set, and the status returned by the command is
22424 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22425 and any output was produced, the first line of it is written to the main log.
22426
22427
22428 .option log_fail_output pipe boolean false
22429 If this option is set, and the command returns any output, and also ends with a
22430 return code that is neither zero nor one of the return codes listed in
22431 &%temp_errors%& (that is, the delivery failed), the first line of output is
22432 written to the main log. This option and &%log_output%& are mutually exclusive.
22433 Only one of them may be set.
22434
22435
22436
22437 .option log_output pipe boolean false
22438 If this option is set and the command returns any output, the first line of
22439 output is written to the main log, whatever the return code. This option and
22440 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22441
22442
22443
22444 .option max_output pipe integer 20K
22445 This specifies the maximum amount of output that the command may produce on its
22446 standard output and standard error file combined. If the limit is exceeded, the
22447 process running the command is killed. This is intended as a safety measure to
22448 catch runaway processes. The limit is applied independently of the settings of
22449 the options that control what is done with such output (for example,
22450 &%return_output%&). Because of buffering effects, the amount of output may
22451 exceed the limit by a small amount before Exim notices.
22452
22453
22454 .option message_prefix pipe string&!! "see below"
22455 The string specified here is expanded and output at the start of every message.
22456 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22457 .code
22458 message_prefix = \
22459   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22460   ${tod_bsdinbox}\n
22461 .endd
22462 .cindex "Cyrus"
22463 .cindex "&%tmail%&"
22464 .cindex "&""From""& line"
22465 This is required by the commonly used &_/usr/bin/vacation_& program.
22466 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22467 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22468 setting
22469 .code
22470 message_prefix =
22471 .endd
22472 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22473 &`\n`& to &`\r\n`& in &%message_prefix%&.
22474
22475
22476 .option message_suffix pipe string&!! "see below"
22477 The string specified here is expanded and output at the end of every message.
22478 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22479 The suffix can be suppressed by setting
22480 .code
22481 message_suffix =
22482 .endd
22483 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22484 &`\n`& to &`\r\n`& in &%message_suffix%&.
22485
22486
22487 .option path pipe string "see below"
22488 This option specifies the string that is set up in the PATH environment
22489 variable of the subprocess. The default is:
22490 .code
22491 /bin:/usr/bin
22492 .endd
22493 If the &%command%& option does not yield an absolute path name, the command is
22494 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22495 apply to a command specified as a transport filter.
22496
22497
22498 .option permit_coredump pipe boolean false
22499 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22500 a core-dump of a pipe command, enable this command.  This enables core-dumps
22501 during delivery and affects both the Exim binary and the pipe command run.
22502 It is recommended that this option remain off unless and until you have a need
22503 for it and that this only be enabled when needed, as the risk of excessive
22504 resource consumption can be quite high.  Note also that Exim is typically
22505 installed as a setuid binary and most operating systems will inhibit coredumps
22506 of these by default, so further OS-specific action may be required.
22507
22508
22509 .option pipe_as_creator pipe boolean false
22510 .cindex "uid (user id)" "local delivery"
22511 If the generic &%user%& option is not set and this option is true, the delivery
22512 process is run under the uid that was in force when Exim was originally called
22513 to accept the message. If the group id is not otherwise set (via the generic
22514 &%group%& option), the gid that was in force when Exim was originally called to
22515 accept the message is used.
22516
22517
22518 .option restrict_to_path pipe boolean false
22519 When this option is set, any command name not listed in &%allow_commands%& must
22520 contain no slashes. The command is searched for only in the directories listed
22521 in the &%path%& option. This option is intended for use in the case when a pipe
22522 command has been generated from a user's &_.forward_& file. This is usually
22523 handled by a &(pipe)& transport called &%address_pipe%&.
22524
22525
22526 .option return_fail_output pipe boolean false
22527 If this option is true, and the command produced any output and ended with a
22528 return code other than zero or one of the codes listed in &%temp_errors%& (that
22529 is, the delivery failed), the output is returned in the bounce message.
22530 However, if the message has a null sender (that is, it is itself a bounce
22531 message), output from the command is discarded. This option and
22532 &%return_output%& are mutually exclusive. Only one of them may be set.
22533
22534
22535
22536 .option return_output pipe boolean false
22537 If this option is true, and the command produced any output, the delivery is
22538 deemed to have failed whatever the return code from the command, and the output
22539 is returned in the bounce message. Otherwise, the output is just discarded.
22540 However, if the message has a null sender (that is, it is a bounce message),
22541 output from the command is always discarded, whatever the setting of this
22542 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22543 of them may be set.
22544
22545
22546
22547 .option temp_errors pipe "string list" "see below"
22548 .cindex "&(pipe)& transport" "temporary failure"
22549 This option contains either a colon-separated list of numbers, or a single
22550 asterisk. If &%ignore_status%& is false
22551 and &%return_output%& is not set,
22552 and the command exits with a non-zero return code, the failure is treated as
22553 temporary and the delivery is deferred if the return code matches one of the
22554 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22555 codes are treated as permanent errors. The default setting contains the codes
22556 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22557 compiled on a system that does not define these macros, it assumes values of 75
22558 and 73, respectively.
22559
22560
22561 .option timeout pipe time 1h
22562 If the command fails to complete within this time, it is killed. This normally
22563 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22564 specifies no timeout. In order to ensure that any subprocesses created by the
22565 command are also killed, Exim makes the initial process a process group leader,
22566 and kills the whole process group on a timeout. However, this can be defeated
22567 if one of the processes starts a new process group.
22568
22569 .option timeout_defer pipe boolean false
22570 A timeout in a &(pipe)& transport, either in the command that the transport
22571 runs, or in a transport filter that is associated with it, is by default
22572 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22573 is set true, both kinds of timeout become temporary errors, causing the
22574 delivery to be deferred.
22575
22576 .option umask pipe "octal integer" 022
22577 This specifies the umask setting for the subprocess that runs the command.
22578
22579
22580 .option use_bsmtp pipe boolean false
22581 .cindex "envelope sender"
22582 If this option is set true, the &(pipe)& transport writes messages in &"batch
22583 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22584 commands. If you want to include a leading HELO command with such messages,
22585 you can do so by setting the &%message_prefix%& option. See section
22586 &<<SECTbatchSMTP>>& for details of batch SMTP.
22587
22588 .option use_classresources pipe boolean false
22589 .cindex "class resources (BSD)"
22590 This option is available only when Exim is running on FreeBSD, NetBSD, or
22591 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22592 resource limits when a &(pipe)& transport is run to perform a delivery. The
22593 limits for the uid under which the pipe is to run are obtained from the login
22594 class database.
22595
22596
22597 .option use_crlf pipe boolean false
22598 .cindex "carriage return"
22599 .cindex "linefeed"
22600 This option causes lines to be terminated with the two-character CRLF sequence
22601 (carriage return, linefeed) instead of just a linefeed character. In the case
22602 of batched SMTP, the byte sequence written to the pipe is then an exact image
22603 of what would be sent down a real SMTP connection.
22604
22605 The contents of the &%message_prefix%& and &%message_suffix%& options are
22606 written verbatim, so must contain their own carriage return characters if these
22607 are needed. When &%use_bsmtp%& is not set, the default values for both
22608 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22609 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22610
22611
22612 .option use_shell pipe boolean false
22613 .vindex "&$pipe_addresses$&"
22614 If this option is set, it causes the command to be passed to &_/bin/sh_&
22615 instead of being run directly from the transport, as described in section
22616 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22617 where the command is expected to be run under a shell and cannot easily be
22618 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22619 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22620 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22621 its &%-c%& option.
22622
22623
22624
22625 .section "Using an external local delivery agent" "SECID143"
22626 .cindex "local delivery" "using an external agent"
22627 .cindex "&'procmail'&"
22628 .cindex "external local delivery"
22629 .cindex "delivery" "&'procmail'&"
22630 .cindex "delivery" "by external agent"
22631 The &(pipe)& transport can be used to pass all messages that require local
22632 delivery to a separate local delivery agent such as &%procmail%&. When doing
22633 this, care must be taken to ensure that the pipe is run under an appropriate
22634 uid and gid. In some configurations one wants this to be a uid that is trusted
22635 by the delivery agent to supply the correct sender of the message. It may be
22636 necessary to recompile or reconfigure the delivery agent so that it trusts an
22637 appropriate user. The following is an example transport and router
22638 configuration for &%procmail%&:
22639 .code
22640 # transport
22641 procmail_pipe:
22642   driver = pipe
22643   command = /usr/local/bin/procmail -d $local_part
22644   return_path_add
22645   delivery_date_add
22646   envelope_to_add
22647   check_string = "From "
22648   escape_string = ">From "
22649   umask = 077
22650   user = $local_part
22651   group = mail
22652
22653 # router
22654 procmail:
22655   driver = accept
22656   check_local_user
22657   transport = procmail_pipe
22658 .endd
22659 In this example, the pipe is run as the local user, but with the group set to
22660 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22661 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22662 user to supply a correct sender address. If you do not specify either a
22663 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22664 home directory is the user's home directory by default.
22665
22666 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22667 .code
22668 IFS=" "
22669 .endd
22670 as shown in some &%procmail%& documentation, because Exim does not by default
22671 use a shell to run pipe commands.
22672
22673 .cindex "Cyrus"
22674 The next example shows a transport and a router for a system where local
22675 deliveries are handled by the Cyrus IMAP server.
22676 .code
22677 # transport
22678 local_delivery_cyrus:
22679   driver = pipe
22680   command = /usr/cyrus/bin/deliver \
22681             -m ${substr_1:$local_part_suffix} -- $local_part
22682   user = cyrus
22683   group = mail
22684   return_output
22685   log_output
22686   message_prefix =
22687   message_suffix =
22688
22689 # router
22690 local_user_cyrus:
22691   driver = accept
22692   check_local_user
22693   local_part_suffix = .*
22694   transport = local_delivery_cyrus
22695 .endd
22696 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22697 &%return_output%& to cause any text written by Cyrus to be returned to the
22698 sender.
22699 .ecindex IIDpiptra1
22700 .ecindex IIDpiptra2
22701
22702
22703 . ////////////////////////////////////////////////////////////////////////////
22704 . ////////////////////////////////////////////////////////////////////////////
22705
22706 .chapter "The smtp transport" "CHAPsmtptrans"
22707 .scindex IIDsmttra1 "transports" "&(smtp)&"
22708 .scindex IIDsmttra2 "&(smtp)& transport"
22709 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22710 or LMTP protocol. The list of hosts to try can either be taken from the address
22711 that is being processed (having been set up by the router), or specified
22712 explicitly for the transport. Timeout and retry processing (see chapter
22713 &<<CHAPretry>>&) is applied to each IP address independently.
22714
22715
22716 .section "Multiple messages on a single connection" "SECID144"
22717 The sending of multiple messages over a single TCP/IP connection can arise in
22718 two ways:
22719
22720 .ilist
22721 If a message contains more than &%max_rcpt%& (see below) addresses that are
22722 routed to the same host, more than one copy of the message has to be sent to
22723 that host. In this situation, multiple copies may be sent in a single run of
22724 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22725 does when it has too many addresses to send in one message also depends on the
22726 value of the global &%remote_max_parallel%& option. Details are given in
22727 section &<<SECToutSMTPTCP>>&.)
22728 .next
22729 .cindex "hints database" "remembering routing"
22730 When a message has been successfully delivered over a TCP/IP connection, Exim
22731 looks in its hints database to see if there are any other messages awaiting a
22732 connection to the same host. If there are, a new delivery process is started
22733 for one of them, and the current TCP/IP connection is passed on to it. The new
22734 process may in turn send multiple copies and possibly create yet another
22735 process.
22736 .endlist
22737
22738
22739 For each copy sent over the same TCP/IP connection, a sequence counter is
22740 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22741 no further messages are sent over that connection.
22742
22743
22744
22745 .section "Use of the $host and $host_address variables" "SECID145"
22746 .vindex "&$host$&"
22747 .vindex "&$host_address$&"
22748 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22749 &$host_address$& are the name and IP address of the first host on the host list
22750 passed by the router. However, when the transport is about to connect to a
22751 specific host, and while it is connected to that host, &$host$& and
22752 &$host_address$& are set to the values for that host. These are the values
22753 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22754 &%serialize_hosts%&, and the various TLS options are expanded.
22755
22756
22757 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22758 .vindex &$tls_bits$&
22759 .vindex &$tls_cipher$&
22760 .vindex &$tls_peerdn$&
22761 .vindex &$tls_sni$&
22762 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22763 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22764 are the values that were set when the message was received.
22765 These are the values that are used for options that are expanded before any
22766 SMTP connections are made. Just before each connection is made, these four
22767 variables are emptied. If TLS is subsequently started, they are set to the
22768 appropriate values for the outgoing connection, and these are the values that
22769 are in force when any authenticators are run and when the
22770 &%authenticated_sender%& option is expanded.
22771
22772 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22773 and will be removed in a future release.
22774
22775
22776 .section "Private options for smtp" "SECID146"
22777 .cindex "options" "&(smtp)& transport"
22778 The private options of the &(smtp)& transport are as follows:
22779
22780
22781 .option address_retry_include_sender smtp boolean true
22782 .cindex "4&'xx'& responses" "retrying after"
22783 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22784 is the combination of sender and recipient that is delayed in subsequent queue
22785 runs until the retry time is reached. You can delay the recipient without
22786 reference to the sender (which is what earlier versions of Exim did), by
22787 setting &%address_retry_include_sender%& false. However, this can lead to
22788 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22789
22790 .option allow_localhost smtp boolean false
22791 .cindex "local host" "sending to"
22792 .cindex "fallback" "hosts specified on transport"
22793 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22794 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22795 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22796 the delivery anyway. This should be used only in special cases when the
22797 configuration ensures that no looping will result (for example, a differently
22798 configured Exim is listening on the port to which the message is sent).
22799
22800
22801 .option authenticated_sender smtp string&!! unset
22802 .cindex "Cyrus"
22803 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22804 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22805 overriding any existing authenticated sender value. If the string expansion is
22806 forced to fail, the option is ignored. Other expansion failures cause delivery
22807 to be deferred. If the result of expansion is an empty string, that is also
22808 ignored.
22809
22810 The expansion happens after the outgoing connection has been made and TLS
22811 started, if required. This means that the &$host$&, &$host_address$&,
22812 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22813 particular connection.
22814
22815 If the SMTP session is not authenticated, the expansion of
22816 &%authenticated_sender%& still happens (and can cause the delivery to be
22817 deferred if it fails), but no AUTH= item is added to MAIL commands
22818 unless &%authenticated_sender_force%& is true.
22819
22820 This option allows you to use the &(smtp)& transport in LMTP mode to
22821 deliver mail to Cyrus IMAP and provide the proper local part as the
22822 &"authenticated sender"&, via a setting such as:
22823 .code
22824 authenticated_sender = $local_part
22825 .endd
22826 This removes the need for IMAP subfolders to be assigned special ACLs to
22827 allow direct delivery to those subfolders.
22828
22829 Because of expected uses such as that just described for Cyrus (when no
22830 domain is involved), there is no checking on the syntax of the provided
22831 value.
22832
22833
22834 .option authenticated_sender_force smtp boolean false
22835 If this option is set true, the &%authenticated_sender%& option's value
22836 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22837 authenticated as a client.
22838
22839
22840 .option command_timeout smtp time 5m
22841 This sets a timeout for receiving a response to an SMTP command that has been
22842 sent out. It is also used when waiting for the initial banner line from the
22843 remote host. Its value must not be zero.
22844
22845
22846 .option connect_timeout smtp time 5m
22847 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22848 to a remote host. A setting of zero allows the system timeout (typically
22849 several minutes) to act. To have any effect, the value of this option must be
22850 less than the system timeout. However, it has been observed that on some
22851 systems there is no system timeout, which is why the default value for this
22852 option is 5 minutes, a value recommended by RFC 1123.
22853
22854
22855 .option connection_max_messages smtp integer 500
22856 .cindex "SMTP" "passed connection"
22857 .cindex "SMTP" "multiple deliveries"
22858 .cindex "multiple SMTP deliveries"
22859 This controls the maximum number of separate message deliveries that are sent
22860 over a single TCP/IP connection. If the value is zero, there is no limit.
22861 For testing purposes, this value can be overridden by the &%-oB%& command line
22862 option.
22863
22864
22865 .option data_timeout smtp time 5m
22866 This sets a timeout for the transmission of each block in the data portion of
22867 the message. As a result, the overall timeout for a message depends on the size
22868 of the message. Its value must not be zero. See also &%final_timeout%&.
22869
22870
22871 .option delay_after_cutoff smtp boolean true
22872 This option controls what happens when all remote IP addresses for a given
22873 domain have been inaccessible for so long that they have passed their retry
22874 cutoff times.
22875
22876 In the default state, if the next retry time has not been reached for any of
22877 them, the address is bounced without trying any deliveries. In other words,
22878 Exim delays retrying an IP address after the final cutoff time until a new
22879 retry time is reached, and can therefore bounce an address without ever trying
22880 a delivery, when machines have been down for a long time. Some people are
22881 unhappy at this prospect, so...
22882
22883 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22884 addresses are past their final cutoff time, Exim tries to deliver to those
22885 IP addresses that have not been tried since the message arrived. If there are
22886 none, of if they all fail, the address is bounced. In other words, it does not
22887 delay when a new message arrives, but immediately tries those expired IP
22888 addresses that haven't been tried since the message arrived. If there is a
22889 continuous stream of messages for the dead hosts, unsetting
22890 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22891 to them.
22892
22893
22894 .option dns_qualify_single smtp boolean true
22895 If the &%hosts%& or &%fallback_hosts%& option is being used,
22896 and the &%gethostbyname%& option is false,
22897 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22898 in chapter &<<CHAPdnslookup>>& for more details.
22899
22900
22901 .option dns_search_parents smtp boolean false
22902 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22903 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22904 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22905 details.
22906
22907
22908 .option dnssec_request_domains smtp "domain list&!!" unset
22909 .cindex "MX record" "security"
22910 .cindex "DNSSEC" "MX lookup"
22911 .cindex "security" "MX lookup"
22912 .cindex "DNS" "DNSSEC"
22913 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22914 the dnssec request bit set.
22915 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22916
22917
22918
22919 .option dnssec_require_domains smtp "domain list&!!" unset
22920 .cindex "MX record" "security"
22921 .cindex "DNSSEC" "MX lookup"
22922 .cindex "security" "MX lookup"
22923 .cindex "DNS" "DNSSEC"
22924 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22925 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22926 (AD bit) set wil be ignored and logged as a host-lookup failure.
22927 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22928
22929
22930
22931 .option dscp smtp string&!! unset
22932 .cindex "DCSP" "outbound"
22933 This option causes the DSCP value associated with a socket to be set to one
22934 of a number of fixed strings or to numeric value.
22935 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22936 Common values include &`throughput`&, &`mincost`&, and on newer systems
22937 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22938
22939 The outbound packets from Exim will be marked with this value in the header
22940 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22941 that these values will have any effect, not be stripped by networking
22942 equipment, or do much of anything without cooperation with your Network
22943 Engineer and those of all network operators between the source and destination.
22944
22945
22946 .option fallback_hosts smtp "string list" unset
22947 .cindex "fallback" "hosts specified on transport"
22948 String expansion is not applied to this option. The argument must be a
22949 colon-separated list of host names or IP addresses, optionally also including
22950 port numbers, though the separator can be changed, as described in section
22951 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22952 item in a &%route_list%& setting for the &(manualroute)& router, as described
22953 in section &<<SECTformatonehostitem>>&.
22954
22955 Fallback hosts can also be specified on routers, which associate them with the
22956 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22957 &%fallback_hosts%& specified on the transport is used only if the address does
22958 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22959 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22960 However, &%hosts_randomize%& does apply to fallback host lists.
22961
22962 If Exim is unable to deliver to any of the hosts for a particular address, and
22963 the errors are not permanent rejections, the address is put on a separate
22964 transport queue with its host list replaced by the fallback hosts, unless the
22965 address was routed via MX records and the current host was in the original MX
22966 list. In that situation, the fallback host list is not used.
22967
22968 Once normal deliveries are complete, the fallback queue is delivered by
22969 re-running the same transports with the new host lists. If several failing
22970 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22971 copy of the message is sent.
22972
22973 The resolution of the host names on the fallback list is controlled by the
22974 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22975 both to cases when the host list comes with the address and when it is taken
22976 from &%hosts%&. This option provides a &"use a smart host only if delivery
22977 fails"& facility.
22978
22979
22980 .option final_timeout smtp time 10m
22981 This is the timeout that applies while waiting for the response to the final
22982 line containing just &"."& that terminates a message. Its value must not be
22983 zero.
22984
22985 .option gethostbyname smtp boolean false
22986 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22987 being used, names are looked up using &[gethostbyname()]&
22988 (or &[getipnodebyname()]& when available)
22989 instead of using the DNS. Of course, that function may in fact use the DNS, but
22990 it may also consult other sources of information such as &_/etc/hosts_&.
22991
22992 .option gnutls_compat_mode smtp boolean unset
22993 This option controls whether GnuTLS is used in compatibility mode in an Exim
22994 server. This reduces security slightly, but improves interworking with older
22995 implementations of TLS.
22996
22997 .option helo_data smtp string&!! "see below"
22998 .cindex "HELO" "argument, setting"
22999 .cindex "EHLO" "argument, setting"
23000 .cindex "LHLO argument setting"
23001 The value of this option is expanded after a connection to a another host has
23002 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23003 command that starts the outgoing SMTP or LMTP session. The default value of the
23004 option is:
23005 .code
23006 $primary_hostname
23007 .endd
23008 During the expansion, the variables &$host$& and &$host_address$& are set to
23009 the identity of the remote host, and the variables &$sending_ip_address$& and
23010 &$sending_port$& are set to the local IP address and port number that are being
23011 used. These variables can be used to generate different values for different
23012 servers or different local IP addresses. For example, if you want the string
23013 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23014 interface address, you could use this:
23015 .code
23016 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23017   {$primary_hostname}}
23018 .endd
23019 The use of &%helo_data%& applies both to sending messages and when doing
23020 callouts.
23021
23022 .option hosts smtp "string list&!!" unset
23023 Hosts are associated with an address by a router such as &(dnslookup)&, which
23024 finds the hosts by looking up the address domain in the DNS, or by
23025 &(manualroute)&, which has lists of hosts in its configuration. However,
23026 email addresses can be passed to the &(smtp)& transport by any router, and not
23027 all of them can provide an associated list of hosts.
23028
23029 The &%hosts%& option specifies a list of hosts to be used if the address being
23030 processed does not have any hosts associated with it. The hosts specified by
23031 &%hosts%& are also used, whether or not the address has its own hosts, if
23032 &%hosts_override%& is set.
23033
23034 The string is first expanded, before being interpreted as a colon-separated
23035 list of host names or IP addresses, possibly including port numbers. The
23036 separator may be changed to something other than colon, as described in section
23037 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23038 item in a &%route_list%& setting for the &(manualroute)& router, as described
23039 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23040 of the &(manualroute)& router is not available here.
23041
23042 If the expansion fails, delivery is deferred. Unless the failure was caused by
23043 the inability to complete a lookup, the error is logged to the panic log as
23044 well as the main log. Host names are looked up either by searching directly for
23045 address records in the DNS or by calling &[gethostbyname()]& (or
23046 &[getipnodebyname()]& when available), depending on the setting of the
23047 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23048 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23049 address are used.
23050
23051 During delivery, the hosts are tried in order, subject to their retry status,
23052 unless &%hosts_randomize%& is set.
23053
23054
23055 .option hosts_avoid_esmtp smtp "host list&!!" unset
23056 .cindex "ESMTP, avoiding use of"
23057 .cindex "HELO" "forcing use of"
23058 .cindex "EHLO" "avoiding use of"
23059 .cindex "PIPELINING" "avoiding the use of"
23060 This option is for use with broken hosts that announce ESMTP facilities (for
23061 example, PIPELINING) and then fail to implement them properly. When a host
23062 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23063 start of the SMTP session. This means that it cannot use any of the ESMTP
23064 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23065
23066
23067 .option hosts_avoid_pipelining smtp "host list&!!" unset
23068 .cindex "PIPELINING" "avoiding the use of"
23069 Exim will not use the SMTP PIPELINING extension when delivering to any host
23070 that matches this list, even if the server host advertises PIPELINING support.
23071
23072
23073 .option hosts_avoid_tls smtp "host list&!!" unset
23074 .cindex "TLS" "avoiding for certain hosts"
23075 Exim will not try to start a TLS session when delivering to any host that
23076 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23077
23078 .option hosts_verify_avoid_tls smtp "host list&!!" *
23079 .cindex "TLS" "avoiding for certain hosts"
23080 Exim will not try to start a TLS session for a verify callout,
23081 or when delivering in cutthrough mode,
23082 to any host that matches this list.
23083 Note that the default is to not use TLS.
23084
23085
23086 .option hosts_max_try smtp integer 5
23087 .cindex "host" "maximum number to try"
23088 .cindex "limit" "number of hosts tried"
23089 .cindex "limit" "number of MX tried"
23090 .cindex "MX record" "maximum tried"
23091 This option limits the number of IP addresses that are tried for any one
23092 delivery in cases where there are temporary delivery errors. Section
23093 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23094
23095
23096 .option hosts_max_try_hardlimit smtp integer 50
23097 This is an additional check on the maximum number of IP addresses that Exim
23098 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23099 why it exists.
23100
23101
23102
23103 .option hosts_nopass_tls smtp "host list&!!" unset
23104 .cindex "TLS" "passing connection"
23105 .cindex "multiple SMTP deliveries"
23106 .cindex "TLS" "multiple message deliveries"
23107 For any host that matches this list, a connection on which a TLS session has
23108 been started will not be passed to a new delivery process for sending another
23109 message on the same connection. See section &<<SECTmulmessam>>& for an
23110 explanation of when this might be needed.
23111
23112
23113 .option hosts_override smtp boolean false
23114 If this option is set and the &%hosts%& option is also set, any hosts that are
23115 attached to the address are ignored, and instead the hosts specified by the
23116 &%hosts%& option are always used. This option does not apply to
23117 &%fallback_hosts%&.
23118
23119
23120 .option hosts_randomize smtp boolean false
23121 .cindex "randomized host list"
23122 .cindex "host" "list of; randomized"
23123 .cindex "fallback" "randomized hosts"
23124 If this option is set, and either the list of hosts is taken from the
23125 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23126 were not obtained from MX records (this includes fallback hosts from the
23127 router), and were not randomized by the router, the order of trying the hosts
23128 is randomized each time the transport runs. Randomizing the order of a host
23129 list can be used to do crude load sharing.
23130
23131 When &%hosts_randomize%& is true, a host list may be split into groups whose
23132 order is separately randomized. This makes it possible to set up MX-like
23133 behaviour. The boundaries between groups are indicated by an item that is just
23134 &`+`& in the host list. For example:
23135 .code
23136 hosts = host1:host2:host3:+:host4:host5
23137 .endd
23138 The order of the first three hosts and the order of the last two hosts is
23139 randomized for each use, but the first three always end up before the last two.
23140 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23141
23142 .option hosts_require_auth smtp "host list&!!" unset
23143 .cindex "authentication" "required by client"
23144 This option provides a list of servers for which authentication must succeed
23145 before Exim will try to transfer a message. If authentication fails for
23146 servers which are not in this list, Exim tries to send unauthenticated. If
23147 authentication fails for one of these servers, delivery is deferred. This
23148 temporary error is detectable in the retry rules, so it can be turned into a
23149 hard failure if required. See also &%hosts_try_auth%&, and chapter
23150 &<<CHAPSMTPAUTH>>& for details of authentication.
23151
23152
23153 .option hosts_request_ocsp smtp "host list&!!" *
23154 .cindex "TLS" "requiring for certain servers"
23155 Exim will request a Certificate Status on a
23156 TLS session for any host that matches this list.
23157 &%tls_verify_certificates%& should also be set for the transport.
23158
23159 .option hosts_require_ocsp smtp "host list&!!" unset
23160 .cindex "TLS" "requiring for certain servers"
23161 Exim will request, and check for a valid Certificate Status being given, on a
23162 TLS session for any host that matches this list.
23163 &%tls_verify_certificates%& should also be set for the transport.
23164
23165 .option hosts_require_tls smtp "host list&!!" unset
23166 .cindex "TLS" "requiring for certain servers"
23167 Exim will insist on using a TLS session when delivering to any host that
23168 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23169 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23170 incoming messages, use an appropriate ACL.
23171
23172 .option hosts_try_auth smtp "host list&!!" unset
23173 .cindex "authentication" "optional in client"
23174 This option provides a list of servers to which, provided they announce
23175 authentication support, Exim will attempt to authenticate as a client when it
23176 connects. If authentication fails, Exim will try to transfer the message
23177 unauthenticated. See also &%hosts_require_auth%&, and chapter
23178 &<<CHAPSMTPAUTH>>& for details of authentication.
23179
23180 .option hosts_try_prdr smtp "host list&!!" unset
23181 .cindex "PRDR" "enabling, optional in client"
23182 This option provides a list of servers to which, provided they announce
23183 PRDR support, Exim will attempt to negotiate PRDR
23184 for multi-recipient messages.
23185
23186 .option interface smtp "string list&!!" unset
23187 .cindex "bind IP address"
23188 .cindex "IP address" "binding"
23189 .vindex "&$host$&"
23190 .vindex "&$host_address$&"
23191 This option specifies which interface to bind to when making an outgoing SMTP
23192 call. The value is an IP address, not an interface name such as
23193 &`eth0`&. Do not confuse this with the interface address that was used when a
23194 message was received, which is in &$received_ip_address$&, formerly known as
23195 &$interface_address$&. The name was changed to minimize confusion with the
23196 outgoing interface address. There is no variable that contains an outgoing
23197 interface address because, unless it is set by this option, its value is
23198 unknown.
23199
23200 During the expansion of the &%interface%& option the variables &$host$& and
23201 &$host_address$& refer to the host to which a connection is about to be made
23202 during the expansion of the string. Forced expansion failure, or an empty
23203 string result causes the option to be ignored. Otherwise, after expansion, the
23204 string must be a list of IP addresses, colon-separated by default, but the
23205 separator can be changed in the usual way. For example:
23206 .code
23207 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23208 .endd
23209 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23210 connection. If none of them are the correct type, the option is ignored. If
23211 &%interface%& is not set, or is ignored, the system's IP functions choose which
23212 interface to use if the host has more than one.
23213
23214
23215 .option keepalive smtp boolean true
23216 .cindex "keepalive" "on outgoing connection"
23217 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23218 connections. When set, it causes the kernel to probe idle connections
23219 periodically, by sending packets with &"old"& sequence numbers. The other end
23220 of the connection should send a acknowledgment if the connection is still okay
23221 or a reset if the connection has been aborted. The reason for doing this is
23222 that it has the beneficial effect of freeing up certain types of connection
23223 that can get stuck when the remote host is disconnected without tidying up the
23224 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23225 unreachable hosts.
23226
23227
23228 .option lmtp_ignore_quota smtp boolean false
23229 .cindex "LMTP" "ignoring quota errors"
23230 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23231 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23232 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23233
23234 .option max_rcpt smtp integer 100
23235 .cindex "RCPT" "maximum number of outgoing"
23236 This option limits the number of RCPT commands that are sent in a single
23237 SMTP message transaction. Each set of addresses is treated independently, and
23238 so can cause parallel connections to the same host if &%remote_max_parallel%&
23239 permits this.
23240
23241
23242 .option multi_domain smtp boolean true
23243 .vindex "&$domain$&"
23244 When this option is set, the &(smtp)& transport can handle a number of
23245 addresses containing a mixture of different domains provided they all resolve
23246 to the same list of hosts. Turning the option off restricts the transport to
23247 handling only one domain at a time. This is useful if you want to use
23248 &$domain$& in an expansion for the transport, because it is set only when there
23249 is a single domain involved in a remote delivery.
23250
23251
23252 .option port smtp string&!! "see below"
23253 .cindex "port" "sending TCP/IP"
23254 .cindex "TCP/IP" "setting outgoing port"
23255 This option specifies the TCP/IP port on the server to which Exim connects.
23256 &*Note:*& Do not confuse this with the port that was used when a message was
23257 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23258 The name was changed to minimize confusion with the outgoing port. There is no
23259 variable that contains an outgoing port.
23260
23261 If the value of this option begins with a digit it is taken as a port number;
23262 otherwise it is looked up using &[getservbyname()]&. The default value is
23263 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23264 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23265 is deferred.
23266
23267
23268
23269 .option protocol smtp string smtp
23270 .cindex "LMTP" "over TCP/IP"
23271 .cindex "ssmtp protocol" "outbound"
23272 .cindex "TLS" "SSL-on-connect outbound"
23273 .vindex "&$port$&"
23274 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23275 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23276 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23277 deliveries into closed message stores. Exim also has support for running LMTP
23278 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23279
23280 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23281 changes to &"smtps"&, and the transport initiates TLS immediately after
23282 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23283 The Internet standards bodies strongly discourage use of this mode.
23284
23285
23286 .option retry_include_ip_address smtp boolean true
23287 Exim normally includes both the host name and the IP address in the key it
23288 constructs for indexing retry data after a temporary delivery failure. This
23289 means that when one of several IP addresses for a host is failing, it gets
23290 tried periodically (controlled by the retry rules), but use of the other IP
23291 addresses is not affected.
23292
23293 However, in some dialup environments hosts are assigned a different IP address
23294 each time they connect. In this situation the use of the IP address as part of
23295 the retry key leads to undesirable behaviour. Setting this option false causes
23296 Exim to use only the host name. This should normally be done on a separate
23297 instance of the &(smtp)& transport, set up specially to handle the dialup
23298 hosts.
23299
23300
23301 .option serialize_hosts smtp "host list&!!" unset
23302 .cindex "serializing connections"
23303 .cindex "host" "serializing connections"
23304 Because Exim operates in a distributed manner, if several messages for the same
23305 host arrive at around the same time, more than one simultaneous connection to
23306 the remote host can occur. This is not usually a problem except when there is a
23307 slow link between the hosts. In that situation it may be helpful to restrict
23308 Exim to one connection at a time. This can be done by setting
23309 &%serialize_hosts%& to match the relevant hosts.
23310
23311 .cindex "hints database" "serializing deliveries to a host"
23312 Exim implements serialization by means of a hints database in which a record is
23313 written whenever a process connects to one of the restricted hosts. The record
23314 is deleted when the connection is completed. Obviously there is scope for
23315 records to get left lying around if there is a system or program crash. To
23316 guard against this, Exim ignores any records that are more than six hours old.
23317
23318 If you set up this kind of serialization, you should also arrange to delete the
23319 relevant hints database whenever your system reboots. The names of the files
23320 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23321 may be one or two files, depending on the type of DBM in use. The same files
23322 are used for ETRN serialization.
23323
23324
23325 .option size_addition smtp integer 1024
23326 .cindex "SMTP" "SIZE"
23327 .cindex "message" "size issue for transport filter"
23328 .cindex "size" "of message"
23329 .cindex "transport" "filter"
23330 .cindex "filter" "transport filter"
23331 If a remote SMTP server indicates that it supports the SIZE option of the
23332 MAIL command, Exim uses this to pass over the message size at the start of
23333 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23334 sends, to allow for headers and other text that may be added during delivery by
23335 configuration options or in a transport filter. It may be necessary to increase
23336 this if a lot of text is added to messages.
23337
23338 Alternatively, if the value of &%size_addition%& is set negative, it disables
23339 the use of the SIZE option altogether.
23340
23341
23342 .option tls_certificate smtp string&!! unset
23343 .cindex "TLS" "client certificate, location of"
23344 .cindex "certificate" "client, location of"
23345 .vindex "&$host$&"
23346 .vindex "&$host_address$&"
23347 The value of this option must be the absolute path to a file which contains the
23348 client's certificate, for possible use when sending a message over an encrypted
23349 connection. The values of &$host$& and &$host_address$& are set to the name and
23350 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23351 details of TLS.
23352
23353 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23354 certificate when sending messages as a client. The global option of the same
23355 name specifies the certificate for Exim as a server; it is not automatically
23356 assumed that the same certificate should be used when Exim is operating as a
23357 client.
23358
23359
23360 .option tls_crl smtp string&!! unset
23361 .cindex "TLS" "client certificate revocation list"
23362 .cindex "certificate" "revocation list for client"
23363 This option specifies a certificate revocation list. The expanded value must
23364 be the name of a file that contains a CRL in PEM format.
23365
23366
23367 .option tls_dh_min_bits smtp integer 1024
23368 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23369 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23370 key agreement is negotiated, the server will provide a large prime number
23371 for use.  This option establishes the minimum acceptable size of that number.
23372 If the parameter offered by the server is too small, then the TLS handshake
23373 will fail.
23374
23375 Only supported when using GnuTLS.
23376
23377
23378 .option tls_privatekey smtp string&!! unset
23379 .cindex "TLS" "client private key, location of"
23380 .vindex "&$host$&"
23381 .vindex "&$host_address$&"
23382 The value of this option must be the absolute path to a file which contains the
23383 client's private key. This is used when sending a message over an encrypted
23384 connection using a client certificate. The values of &$host$& and
23385 &$host_address$& are set to the name and address of the server during the
23386 expansion. If this option is unset, or the expansion is forced to fail, or the
23387 result is an empty string, the private key is assumed to be in the same file as
23388 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23389
23390
23391 .option tls_require_ciphers smtp string&!! unset
23392 .cindex "TLS" "requiring specific ciphers"
23393 .cindex "cipher" "requiring specific"
23394 .vindex "&$host$&"
23395 .vindex "&$host_address$&"
23396 The value of this option must be a list of permitted cipher suites, for use
23397 when setting up an outgoing encrypted connection. (There is a global option of
23398 the same name for controlling incoming connections.) The values of &$host$& and
23399 &$host_address$& are set to the name and address of the server during the
23400 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23401 is used in different ways by OpenSSL and GnuTLS (see sections
23402 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23403 ciphers is a preference order.
23404
23405
23406
23407 .option tls_sni smtp string&!! unset
23408 .cindex "TLS" "Server Name Indication"
23409 .vindex "&$tls_sni$&"
23410 If this option is set then it sets the $tls_out_sni variable and causes any
23411 TLS session to pass this value as the Server Name Indication extension to
23412 the remote side, which can be used by the remote side to select an appropriate
23413 certificate and private key for the session.
23414
23415 See &<<SECTtlssni>>& for more information.
23416
23417 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23418 TLS extensions.
23419
23420
23421
23422
23423 .option tls_tempfail_tryclear smtp boolean true
23424 .cindex "4&'xx'& responses" "to STARTTLS"
23425 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23426 setting up a TLS session, this option determines whether or not Exim should try
23427 to deliver the message unencrypted. If it is set false, delivery to the
23428 current host is deferred; if there are other hosts, they are tried. If this
23429 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23430 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23431 TLS negotiation fails, Exim closes the current connection (because it is in an
23432 unknown state), opens a new one to the same host, and then tries the delivery
23433 in clear.
23434
23435
23436 .option tls_try_verify_hosts smtp "host list&!!" unset
23437 .cindex "TLS" "server certificate verification"
23438 .cindex "certificate" "verification of server"
23439 This option gives a list of hosts for which, on encrypted connections,
23440 certificate verification will be tried but need not succeed.
23441 The &%tls_verify_certificates%& option must also be set.
23442 Note that unless the host is in this list
23443 TLS connections will be denied to hosts using self-signed certificates
23444 when &%tls_verify_certificates%& is matched.
23445 The &$tls_out_certificate_verified$& variable is set when
23446 certificate verification succeeds.
23447
23448
23449 .option tls_verify_certificates smtp string&!! unset
23450 .cindex "TLS" "server certificate verification"
23451 .cindex "certificate" "verification of server"
23452 .vindex "&$host$&"
23453 .vindex "&$host_address$&"
23454 The value of this option must be the absolute path to a file containing
23455 permitted server certificates, for use when setting up an encrypted connection.
23456 Alternatively,
23457 if you are using either GnuTLS version 3.3.6 (or later) or OpenSSL,
23458 you can set
23459 &%tls_verify_certificates%& to the name of a directory containing certificate
23460 files.
23461 For earlier versions of GnuTLS the option must be set to the name of a
23462 single file.
23463
23464 With OpenSSL the certificates specified
23465 explicitly
23466 either by file or directory
23467 are added to those given by the system default location.
23468
23469 The values of &$host$& and
23470 &$host_address$& are set to the name and address of the server during the
23471 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23472
23473 For back-compatability,
23474 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23475 and certificate verification fails the TLS connection is closed.
23476
23477
23478 .option tls_verify_hosts smtp "host list&!!" unset
23479 .cindex "TLS" "server certificate verification"
23480 .cindex "certificate" "verification of server"
23481 This option gives a list of hosts for which. on encrypted connections,
23482 certificate verification must succeed.
23483 The &%tls_verify_certificates%& option must also be set.
23484 If both this option and &%tls_try_verify_hosts%& are unset
23485 operation is as if this option selected all hosts.
23486
23487
23488
23489
23490 .section "How the limits for the number of hosts to try are used" &&&
23491          "SECTvalhosmax"
23492 .cindex "host" "maximum number to try"
23493 .cindex "limit" "hosts; maximum number tried"
23494 There are two options that are concerned with the number of hosts that are
23495 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23496 &%hosts_max_try_hardlimit%&.
23497
23498
23499 The &%hosts_max_try%& option limits the number of hosts that are tried
23500 for a single delivery. However, despite the term &"host"& in its name, the
23501 option actually applies to each IP address independently. In other words, a
23502 multihomed host is treated as several independent hosts, just as it is for
23503 retrying.
23504
23505 Many of the larger ISPs have multiple MX records which often point to
23506 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23507 created as a result of routing one of these domains.
23508
23509 Trying every single IP address on such a long list does not seem sensible; if
23510 several at the top of the list fail, it is reasonable to assume there is some
23511 problem that is likely to affect all of them. Roughly speaking, the value of
23512 &%hosts_max_try%& is the maximum number that are tried before deferring the
23513 delivery. However, the logic cannot be quite that simple.
23514
23515 Firstly, IP addresses that are skipped because their retry times have not
23516 arrived do not count, and in addition, addresses that are past their retry
23517 limits are also not counted, even when they are tried. This means that when
23518 some IP addresses are past their retry limits, more than the value of
23519 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23520 that all IP addresses are considered before timing out an email address (but
23521 see below for an exception).
23522
23523 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23524 list to see if there is a subsequent host with a different (higher valued) MX.
23525 If there is, that host is considered next, and the current IP address is used
23526 but not counted. This behaviour helps in the case of a domain with a retry rule
23527 that hardly ever delays any hosts, as is now explained:
23528
23529 Consider the case of a long list of hosts with one MX value, and a few with a
23530 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23531 hosts at the top of the list are tried at first. With the default retry rule,
23532 which specifies increasing retry times, the higher MX hosts are eventually
23533 tried when those at the top of the list are skipped because they have not
23534 reached their retry times.
23535
23536 However, it is common practice to put a fixed short retry time on domains for
23537 large ISPs, on the grounds that their servers are rarely down for very long.
23538 Unfortunately, these are exactly the domains that tend to resolve to long lists
23539 of hosts. The short retry time means that the lowest MX hosts are tried every
23540 time. The attempts may be in a different order because of random sorting, but
23541 without the special MX check, the higher MX hosts would never be tried until
23542 all the lower MX hosts had timed out (which might be several days), because
23543 there are always some lower MX hosts that have reached their retry times. With
23544 the special check, Exim considers at least one IP address from each MX value at
23545 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23546 reached.
23547
23548 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23549 particular, Exim normally eventually tries all the IP addresses before timing
23550 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23551 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23552 been set up with hundreds of IP addresses for some domains. It can
23553 take a very long time indeed for an address to time out in these cases.
23554
23555 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23556 Exim never tries more than this number of IP addresses; if it hits this limit
23557 and they are all timed out, the email address is bounced, even though not all
23558 possible IP addresses have been tried.
23559 .ecindex IIDsmttra1
23560 .ecindex IIDsmttra2
23561
23562
23563
23564
23565
23566 . ////////////////////////////////////////////////////////////////////////////
23567 . ////////////////////////////////////////////////////////////////////////////
23568
23569 .chapter "Address rewriting" "CHAPrewrite"
23570 .scindex IIDaddrew "rewriting" "addresses"
23571 There are some circumstances in which Exim automatically rewrites domains in
23572 addresses. The two most common are when an address is given without a domain
23573 (referred to as an &"unqualified address"&) or when an address contains an
23574 abbreviated domain that is expanded by DNS lookup.
23575
23576 Unqualified envelope addresses are accepted only for locally submitted
23577 messages, or for messages that are received from hosts matching
23578 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23579 appropriate. Unqualified addresses in header lines are qualified if they are in
23580 locally submitted messages, or messages from hosts that are permitted to send
23581 unqualified envelope addresses. Otherwise, unqualified addresses in header
23582 lines are neither qualified nor rewritten.
23583
23584 One situation in which Exim does &'not'& automatically rewrite a domain is
23585 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23586 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23587 do this. The new RFCs do not contain this suggestion.
23588
23589
23590 .section "Explicitly configured address rewriting" "SECID147"
23591 This chapter describes the rewriting rules that can be used in the
23592 main rewrite section of the configuration file, and also in the generic
23593 &%headers_rewrite%& option that can be set on any transport.
23594
23595 Some people believe that configured address rewriting is a Mortal Sin.
23596 Others believe that life is not possible without it. Exim provides the
23597 facility; you do not have to use it.
23598
23599 The main rewriting rules that appear in the &"rewrite"& section of the
23600 configuration file are applied to addresses in incoming messages, both envelope
23601 addresses and addresses in header lines. Each rule specifies the types of
23602 address to which it applies.
23603
23604 Whether or not addresses in header lines are rewritten depends on the origin of
23605 the headers and the type of rewriting. Global rewriting, that is, rewriting
23606 rules from the rewrite section of the configuration file, is applied only to
23607 those headers that were received with the message. Header lines that are added
23608 by ACLs or by a system filter or by individual routers or transports (which
23609 are specific to individual recipient addresses) are not rewritten by the global
23610 rules.
23611
23612 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23613 applies all headers except those added by routers and transports. That is, as
23614 well as the headers that were received with the message, it also applies to
23615 headers that were added by an ACL or a system filter.
23616
23617
23618 In general, rewriting addresses from your own system or domain has some
23619 legitimacy. Rewriting other addresses should be done only with great care and
23620 in special circumstances. The author of Exim believes that rewriting should be
23621 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23622 Although it can sometimes be used as a routing tool, this is very strongly
23623 discouraged.
23624
23625 There are two commonly encountered circumstances where rewriting is used, as
23626 illustrated by these examples:
23627
23628 .ilist
23629 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23630 exchange mail with each other behind a firewall, but there is only a single
23631 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23632 &'hitch.fict.example'& when sending mail off-site.
23633 .next
23634 A host rewrites the local parts of its own users so that, for example,
23635 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23636 .endlist
23637
23638
23639
23640 .section "When does rewriting happen?" "SECID148"
23641 .cindex "rewriting" "timing of"
23642 .cindex "&ACL;" "rewriting addresses in"
23643 Configured address rewriting can take place at several different stages of a
23644 message's processing.
23645
23646 .vindex "&$sender_address$&"
23647 At the start of an ACL for MAIL, the sender address may have been rewritten
23648 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23649 ordinary rewrite rules have yet been applied. If, however, the sender address
23650 is verified in the ACL, it is rewritten before verification, and remains
23651 rewritten thereafter. The subsequent value of &$sender_address$& is the
23652 rewritten address. This also applies if sender verification happens in a
23653 RCPT ACL. Otherwise, when the sender address is not verified, it is
23654 rewritten as soon as a message's header lines have been received.
23655
23656 .vindex "&$domain$&"
23657 .vindex "&$local_part$&"
23658 Similarly, at the start of an ACL for RCPT, the current recipient's address
23659 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23660 rewrite rules have yet been applied to it. However, the behaviour is different
23661 from the sender address when a recipient is verified. The address is rewritten
23662 for the verification, but the rewriting is not remembered at this stage. The
23663 value of &$local_part$& and &$domain$& after verification are always the same
23664 as they were before (that is, they contain the unrewritten &-- except for
23665 SMTP-time rewriting &-- address).
23666
23667 As soon as a message's header lines have been received, all the envelope
23668 recipient addresses are permanently rewritten, and rewriting is also applied to
23669 the addresses in the header lines (if configured). This happens before adding
23670 any header lines that were specified in MAIL or RCPT ACLs, and
23671 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23672 before the DATA ACL and &[local_scan()]& functions are run.
23673
23674 When an address is being routed, either for delivery or for verification,
23675 rewriting is applied immediately to child addresses that are generated by
23676 redirection, unless &%no_rewrite%& is set on the router.
23677
23678 .cindex "envelope sender" "rewriting at transport time"
23679 .cindex "rewriting" "at transport time"
23680 .cindex "header lines" "rewriting at transport time"
23681 At transport time, additional rewriting of addresses in header lines can be
23682 specified by setting the generic &%headers_rewrite%& option on a transport.
23683 This option contains rules that are identical in form to those in the rewrite
23684 section of the configuration file. They are applied to the original message
23685 header lines and any that were added by ACLs or a system filter. They are not
23686 applied to header lines that are added by routers or the transport.
23687
23688 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23689 transport option. However, it is not possible to rewrite envelope recipients at
23690 transport time.
23691
23692
23693
23694
23695 .section "Testing the rewriting rules that apply on input" "SECID149"
23696 .cindex "rewriting" "testing"
23697 .cindex "testing" "rewriting"
23698 Exim's input rewriting configuration appears in a part of the run time
23699 configuration file headed by &"begin rewrite"&. It can be tested by the
23700 &%-brw%& command line option. This takes an address (which can be a full RFC
23701 2822 address) as its argument. The output is a list of how the address would be
23702 transformed by the rewriting rules for each of the different places it might
23703 appear in an incoming message, that is, for each different header and for the
23704 envelope sender and recipient fields. For example,
23705 .code
23706 exim -brw ph10@exim.workshop.example
23707 .endd
23708 might produce the output
23709 .code
23710 sender: Philip.Hazel@exim.workshop.example
23711 from: Philip.Hazel@exim.workshop.example
23712 to: ph10@exim.workshop.example
23713 cc: ph10@exim.workshop.example
23714 bcc: ph10@exim.workshop.example
23715 reply-to: Philip.Hazel@exim.workshop.example
23716 env-from: Philip.Hazel@exim.workshop.example
23717 env-to: ph10@exim.workshop.example
23718 .endd
23719 which shows that rewriting has been set up for that address when used in any of
23720 the source fields, but not when it appears as a recipient address. At the
23721 present time, there is no equivalent way of testing rewriting rules that are
23722 set for a particular transport.
23723
23724
23725 .section "Rewriting rules" "SECID150"
23726 .cindex "rewriting" "rules"
23727 The rewrite section of the configuration file consists of lines of rewriting
23728 rules in the form
23729 .display
23730 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23731 .endd
23732 Rewriting rules that are specified for the &%headers_rewrite%& generic
23733 transport option are given as a colon-separated list. Each item in the list
23734 takes the same form as a line in the main rewriting configuration (except that
23735 any colons must be doubled, of course).
23736
23737 The formats of source patterns and replacement strings are described below.
23738 Each is terminated by white space, unless enclosed in double quotes, in which
23739 case normal quoting conventions apply inside the quotes. The flags are single
23740 characters which may appear in any order. Spaces and tabs between them are
23741 ignored.
23742
23743 For each address that could potentially be rewritten, the rules are scanned in
23744 order, and replacements for the address from earlier rules can themselves be
23745 replaced by later rules (but see the &"q"& and &"R"& flags).
23746
23747 The order in which addresses are rewritten is undefined, may change between
23748 releases, and must not be relied on, with one exception: when a message is
23749 received, the envelope sender is always rewritten first, before any header
23750 lines are rewritten. For example, the replacement string for a rewrite of an
23751 address in &'To:'& must not assume that the message's address in &'From:'& has
23752 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23753 that the envelope sender has already been rewritten.
23754
23755 .vindex "&$domain$&"
23756 .vindex "&$local_part$&"
23757 The variables &$local_part$& and &$domain$& can be used in the replacement
23758 string to refer to the address that is being rewritten. Note that lookup-driven
23759 rewriting can be done by a rule of the form
23760 .code
23761 *@*   ${lookup ...
23762 .endd
23763 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23764 refer to the address that is being rewritten.
23765
23766
23767 .section "Rewriting patterns" "SECID151"
23768 .cindex "rewriting" "patterns"
23769 .cindex "address list" "in a rewriting pattern"
23770 The source pattern in a rewriting rule is any item which may appear in an
23771 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23772 single-item address list, which means that it is expanded before being tested
23773 against the address. As always, if you use a regular expression as a pattern,
23774 you must take care to escape dollar and backslash characters, or use the &`\N`&
23775 facility to suppress string expansion within the regular expression.
23776
23777 Domains in patterns should be given in lower case. Local parts in patterns are
23778 case-sensitive. If you want to do case-insensitive matching of local parts, you
23779 can use a regular expression that starts with &`^(?i)`&.
23780
23781 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23782 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23783 depending on the type of match which occurred. These can be used in the
23784 replacement string to insert portions of the incoming address. &$0$& always
23785 refers to the complete incoming address. When a regular expression is used, the
23786 numerical variables are set from its capturing subexpressions. For other types
23787 of pattern they are set as follows:
23788
23789 .ilist
23790 If a local part or domain starts with an asterisk, the numerical variables
23791 refer to the character strings matched by asterisks, with &$1$& associated with
23792 the first asterisk, and &$2$& with the second, if present. For example, if the
23793 pattern
23794 .code
23795 *queen@*.fict.example
23796 .endd
23797 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23798 .code
23799 $0 = hearts-queen@wonderland.fict.example
23800 $1 = hearts-
23801 $2 = wonderland
23802 .endd
23803 Note that if the local part does not start with an asterisk, but the domain
23804 does, it is &$1$& that contains the wild part of the domain.
23805
23806 .next
23807 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23808 of the domain are placed in the next available numerical variables. Suppose,
23809 for example, that the address &'foo@bar.baz.example'& is processed by a
23810 rewriting rule of the form
23811 .display
23812 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23813 .endd
23814 and the key in the file that matches the domain is &`*.baz.example`&. Then
23815 .code
23816 $1 = foo
23817 $2 = bar
23818 $3 = baz.example
23819 .endd
23820 If the address &'foo@baz.example'& is looked up, this matches the same
23821 wildcard file entry, and in this case &$2$& is set to the empty string, but
23822 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23823 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23824 whole domain. For non-partial domain lookups, no numerical variables are set.
23825 .endlist
23826
23827
23828 .section "Rewriting replacements" "SECID152"
23829 .cindex "rewriting" "replacements"
23830 If the replacement string for a rule is a single asterisk, addresses that
23831 match the pattern and the flags are &'not'& rewritten, and no subsequent
23832 rewriting rules are scanned. For example,
23833 .code
23834 hatta@lookingglass.fict.example  *  f
23835 .endd
23836 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23837 &'From:'& headers.
23838
23839 .vindex "&$domain$&"
23840 .vindex "&$local_part$&"
23841 If the replacement string is not a single asterisk, it is expanded, and must
23842 yield a fully qualified address. Within the expansion, the variables
23843 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23844 Any letters they contain retain their original case &-- they are not lower
23845 cased. The numerical variables are set up according to the type of pattern that
23846 matched the address, as described above. If the expansion is forced to fail by
23847 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23848 current rule is abandoned, but subsequent rules may take effect. Any other
23849 expansion failure causes the entire rewriting operation to be abandoned, and an
23850 entry written to the panic log.
23851
23852
23853
23854 .section "Rewriting flags" "SECID153"
23855 There are three different kinds of flag that may appear on rewriting rules:
23856
23857 .ilist
23858 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23859 c, f, h, r, s, t.
23860 .next
23861 A flag that specifies rewriting at SMTP time: S.
23862 .next
23863 Flags that control the rewriting process: Q, q, R, w.
23864 .endlist
23865
23866 For rules that are part of the &%headers_rewrite%& generic transport option,
23867 E, F, T, and S are not permitted.
23868
23869
23870
23871 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23872          "SECID154"
23873 .cindex "rewriting" "flags"
23874 If none of the following flag letters, nor the &"S"& flag (see section
23875 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23876 and to both the sender and recipient fields of the envelope, whereas a
23877 transport-time rewriting rule just applies to all headers. Otherwise, the
23878 rewriting rule is skipped unless the relevant addresses are being processed.
23879 .display
23880 &`E`&       rewrite all envelope fields
23881 &`F`&       rewrite the envelope From field
23882 &`T`&       rewrite the envelope To field
23883 &`b`&       rewrite the &'Bcc:'& header
23884 &`c`&       rewrite the &'Cc:'& header
23885 &`f`&       rewrite the &'From:'& header
23886 &`h`&       rewrite all headers
23887 &`r`&       rewrite the &'Reply-To:'& header
23888 &`s`&       rewrite the &'Sender:'& header
23889 &`t`&       rewrite the &'To:'& header
23890 .endd
23891 "All headers" means all of the headers listed above that can be selected
23892 individually, plus their &'Resent-'& versions. It does not include
23893 other headers such as &'Subject:'& etc.
23894
23895 You should be particularly careful about rewriting &'Sender:'& headers, and
23896 restrict this to special known cases in your own domains.
23897
23898
23899 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23900 .cindex "SMTP" "rewriting malformed addresses"
23901 .cindex "RCPT" "rewriting argument of"
23902 .cindex "MAIL" "rewriting argument of"
23903 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23904 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23905 before any other processing; even before syntax checking. The pattern is
23906 required to be a regular expression, and it is matched against the whole of the
23907 data for the command, including any surrounding angle brackets.
23908
23909 .vindex "&$domain$&"
23910 .vindex "&$local_part$&"
23911 This form of rewrite rule allows for the handling of addresses that are not
23912 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23913 input). Because the input is not required to be a syntactically valid address,
23914 the variables &$local_part$& and &$domain$& are not available during the
23915 expansion of the replacement string. The result of rewriting replaces the
23916 original address in the MAIL or RCPT command.
23917
23918
23919 .section "Flags controlling the rewriting process" "SECID155"
23920 There are four flags which control the way the rewriting process works. These
23921 take effect only when a rule is invoked, that is, when the address is of the
23922 correct type (matches the flags) and matches the pattern:
23923
23924 .ilist
23925 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23926 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23927 absence of &"Q"& the rewritten address must always include a domain.
23928 .next
23929 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23930 even if no rewriting actually takes place because of a &"fail"& in the
23931 expansion. The &"q"& flag is not effective if the address is of the wrong type
23932 (does not match the flags) or does not match the pattern.
23933 .next
23934 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23935 address, up to ten times. It can be combined with the &"q"& flag, to stop
23936 rewriting once it fails to match (after at least one successful rewrite).
23937 .next
23938 .cindex "rewriting" "whole addresses"
23939 When an address in a header is rewritten, the rewriting normally applies only
23940 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23941 left unchanged. For example, rewriting might change
23942 .code
23943 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23944 .endd
23945 into
23946 .code
23947 From: Ford Prefect <prefectf@hitch.fict.example>
23948 .endd
23949 .cindex "RFC 2047"
23950 Sometimes there is a need to replace the whole address item, and this can be
23951 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23952 causes an address in a header line to be rewritten, the entire address is
23953 replaced, not just the working part. The replacement must be a complete RFC
23954 2822 address, including the angle brackets if necessary. If text outside angle
23955 brackets contains a character whose value is greater than 126 or less than 32
23956 (except for tab), the text is encoded according to RFC 2047. The character set
23957 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23958
23959 When the &"w"& flag is set on a rule that causes an envelope address to be
23960 rewritten, all but the working part of the replacement address is discarded.
23961 .endlist
23962
23963
23964 .section "Rewriting examples" "SECID156"
23965 Here is an example of the two common rewriting paradigms:
23966 .code
23967 *@*.hitch.fict.example  $1@hitch.fict.example
23968 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23969                      {$value}fail}@hitch.fict.example bctfrF
23970 .endd
23971 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23972 the string expansion to fail if the lookup does not succeed. In this context it
23973 has the effect of leaving the original address unchanged, but Exim goes on to
23974 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23975 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23976 explicitly, which would cause the rewritten address to be the same as before,
23977 at the cost of a small bit of processing. Not supplying either of these is an
23978 error, since the rewritten address would then contain no local part.
23979
23980 The first example above replaces the domain with a superior, more general
23981 domain. This may not be desirable for certain local parts. If the rule
23982 .code
23983 root@*.hitch.fict.example  *
23984 .endd
23985 were inserted before the first rule, rewriting would be suppressed for the
23986 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23987
23988 Rewriting can be made conditional on a number of tests, by making use of
23989 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23990 messages that originate outside the local host:
23991 .code
23992 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23993                          {$1@hitch.fict.example}fail}"
23994 .endd
23995 The replacement string is quoted in this example because it contains white
23996 space.
23997
23998 .cindex "rewriting" "bang paths"
23999 .cindex "bang paths" "rewriting"
24000 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24001 an address it treats it as an unqualified local part which it qualifies with
24002 the local qualification domain (if the source of the message is local or if the
24003 remote host is permitted to send unqualified addresses). Rewriting can
24004 sometimes be used to handle simple bang paths with a fixed number of
24005 components. For example, the rule
24006 .code
24007 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24008 .endd
24009 rewrites a two-component bang path &'host.name!user'& as the domain address
24010 &'user@host.name'&. However, there is a security implication in using this as
24011 a global rewriting rule for envelope addresses. It can provide a backdoor
24012 method for using your system as a relay, because the incoming addresses appear
24013 to be local. If the bang path addresses are received via SMTP, it is safer to
24014 use the &"S"& flag to rewrite them as they are received, so that relay checking
24015 can be done on the rewritten addresses.
24016 .ecindex IIDaddrew
24017
24018
24019
24020
24021
24022 . ////////////////////////////////////////////////////////////////////////////
24023 . ////////////////////////////////////////////////////////////////////////////
24024
24025 .chapter "Retry configuration" "CHAPretry"
24026 .scindex IIDretconf1 "retry" "configuration, description of"
24027 .scindex IIDregconf2 "configuration file" "retry section"
24028 The &"retry"& section of the runtime configuration file contains a list of
24029 retry rules that control how often Exim tries to deliver messages that cannot
24030 be delivered at the first attempt. If there are no retry rules (the section is
24031 empty or not present), there are no retries. In this situation, temporary
24032 errors are treated as permanent. The default configuration contains a single,
24033 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24034 line option can be used to test which retry rule will be used for a given
24035 address, domain and error.
24036
24037 The most common cause of retries is temporary failure to deliver to a remote
24038 host because the host is down, or inaccessible because of a network problem.
24039 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24040 address) basis, not on a per-message basis. Thus, if one message has recently
24041 been delayed, delivery of a new message to the same host is not immediately
24042 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24043 log selector is set, the message
24044 .cindex "retry" "time not reached"
24045 &"retry time not reached"& is written to the main log whenever a delivery is
24046 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24047 the handling of errors during remote deliveries.
24048
24049 Retry processing applies to routing as well as to delivering, except as covered
24050 in the next paragraph. The retry rules do not distinguish between these
24051 actions. It is not possible, for example, to specify different behaviour for
24052 failures to route the domain &'snark.fict.example'& and failures to deliver to
24053 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24054 added complication, so did not implement it. However, although they share the
24055 same retry rule, the actual retry times for routing and transporting a given
24056 domain are maintained independently.
24057
24058 When a delivery is not part of a queue run (typically an immediate delivery on
24059 receipt of a message), the routers are always run, and local deliveries are
24060 always attempted, even if retry times are set for them. This makes for better
24061 behaviour if one particular message is causing problems (for example, causing
24062 quota overflow, or provoking an error in a filter file). If such a delivery
24063 suffers a temporary failure, the retry data is updated as normal, and
24064 subsequent delivery attempts from queue runs occur only when the retry time for
24065 the local address is reached.
24066
24067 .section "Changing retry rules" "SECID157"
24068 If you change the retry rules in your configuration, you should consider
24069 whether or not to delete the retry data that is stored in Exim's spool area in
24070 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24071 always safe; that is why they are called &"hints"&.
24072
24073 The hints retry data contains suggested retry times based on the previous
24074 rules. In the case of a long-running problem with a remote host, it might
24075 record the fact that the host has timed out. If your new rules increase the
24076 timeout time for such a host, you should definitely remove the old retry data
24077 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24078 messages that it should now be retaining.
24079
24080
24081
24082 .section "Format of retry rules" "SECID158"
24083 .cindex "retry" "rules"
24084 Each retry rule occupies one line and consists of three or four parts,
24085 separated by white space: a pattern, an error name, an optional list of sender
24086 addresses, and a list of retry parameters. The pattern and sender lists must be
24087 enclosed in double quotes if they contain white space. The rules are searched
24088 in order until one is found where the pattern, error name, and sender list (if
24089 present) match the failing host or address, the error that occurred, and the
24090 message's sender, respectively.
24091
24092
24093 The pattern is any single item that may appear in an address list (see section
24094 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24095 which means that it is expanded before being tested against the address that
24096 has been delayed. A negated address list item is permitted. Address
24097 list processing treats a plain domain name as if it were preceded by &"*@"&,
24098 which makes it possible for many retry rules to start with just a domain. For
24099 example,
24100 .code
24101 lookingglass.fict.example        *  F,24h,30m;
24102 .endd
24103 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24104 whereas
24105 .code
24106 alice@lookingglass.fict.example  *  F,24h,30m;
24107 .endd
24108 applies only to temporary failures involving the local part &%alice%&.
24109 In practice, almost all rules start with a domain name pattern without a local
24110 part.
24111
24112 .cindex "regular expressions" "in retry rules"
24113 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24114 must match a complete address, not just a domain, because that is how regular
24115 expressions work in address lists.
24116 .display
24117 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24118 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24119 .endd
24120
24121
24122 .section "Choosing which retry rule to use for address errors" "SECID159"
24123 When Exim is looking for a retry rule after a routing attempt has failed (for
24124 example, after a DNS timeout), each line in the retry configuration is tested
24125 against the complete address only if &%retry_use_local_part%& is set for the
24126 router. Otherwise, only the domain is used, except when matching against a
24127 regular expression, when the local part of the address is replaced with &"*"&.
24128 A domain on its own can match a domain pattern, or a pattern that starts with
24129 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24130 &%check_local_user%& is true, and false for other routers.
24131
24132 Similarly, when Exim is looking for a retry rule after a local delivery has
24133 failed (for example, after a mailbox full error), each line in the retry
24134 configuration is tested against the complete address only if
24135 &%retry_use_local_part%& is set for the transport (it defaults true for all
24136 local transports).
24137
24138 .cindex "4&'xx'& responses" "retry rules for"
24139 However, when Exim is looking for a retry rule after a remote delivery attempt
24140 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24141 whole address is always used as the key when searching the retry rules. The
24142 rule that is found is used to create a retry time for the combination of the
24143 failing address and the message's sender. It is the combination of sender and
24144 recipient that is delayed in subsequent queue runs until its retry time is
24145 reached. You can delay the recipient without regard to the sender by setting
24146 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24147 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24148 commands.
24149
24150
24151
24152 .section "Choosing which retry rule to use for host and message errors" &&&
24153          "SECID160"
24154 For a temporary error that is not related to an individual address (for
24155 example, a connection timeout), each line in the retry configuration is checked
24156 twice. First, the name of the remote host is used as a domain name (preceded by
24157 &"*@"& when matching a regular expression). If this does not match the line,
24158 the domain from the email address is tried in a similar fashion. For example,
24159 suppose the MX records for &'a.b.c.example'& are
24160 .code
24161 a.b.c.example  MX  5  x.y.z.example
24162                MX  6  p.q.r.example
24163                MX  7  m.n.o.example
24164 .endd
24165 and the retry rules are
24166 .code
24167 p.q.r.example    *      F,24h,30m;
24168 a.b.c.example    *      F,4d,45m;
24169 .endd
24170 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24171 first rule matches neither the host nor the domain, so Exim looks at the second
24172 rule. This does not match the host, but it does match the domain, so it is used
24173 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24174 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24175 first retry rule is used, because it matches the host.
24176
24177 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24178 first rule to determine retry times, but for all the other hosts for the domain
24179 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24180 routing to &'a.b.c.example'& suffers a temporary failure.
24181
24182 &*Note*&: The host name is used when matching the patterns, not its IP address.
24183 However, if a message is routed directly to an IP address without the use of a
24184 host name, for example, if a &(manualroute)& router contains a setting such as:
24185 .code
24186 route_list = *.a.example  192.168.34.23
24187 .endd
24188 then the &"host name"& that is used when searching for a retry rule is the
24189 textual form of the IP address.
24190
24191 .section "Retry rules for specific errors" "SECID161"
24192 .cindex "retry" "specific errors; specifying"
24193 The second field in a retry rule is the name of a particular error, or an
24194 asterisk, which matches any error. The errors that can be tested for are:
24195
24196 .vlist
24197 .vitem &%auth_failed%&
24198 Authentication failed when trying to send to a host in the
24199 &%hosts_require_auth%& list in an &(smtp)& transport.
24200
24201 .vitem &%data_4xx%&
24202 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24203 after the command, or after sending the message's data.
24204
24205 .vitem &%mail_4xx%&
24206 A 4&'xx'& error was received for an outgoing MAIL command.
24207
24208 .vitem &%rcpt_4xx%&
24209 A 4&'xx'& error was received for an outgoing RCPT command.
24210 .endlist
24211
24212 For the three 4&'xx'& errors, either the first or both of the x's can be given
24213 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24214 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24215 and have retries every ten minutes with a one-hour timeout, you could set up a
24216 retry rule of this form:
24217 .code
24218 the.domain.name  rcpt_452   F,1h,10m
24219 .endd
24220 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24221 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24222
24223 .vlist
24224 .vitem &%lost_connection%&
24225 A server unexpectedly closed the SMTP connection. There may, of course,
24226 legitimate reasons for this (host died, network died), but if it repeats a lot
24227 for the same host, it indicates something odd.
24228
24229 .vitem &%refused_MX%&
24230 A connection to a host obtained from an MX record was refused.
24231
24232 .vitem &%refused_A%&
24233 A connection to a host not obtained from an MX record was refused.
24234
24235 .vitem &%refused%&
24236 A connection was refused.
24237
24238 .vitem &%timeout_connect_MX%&
24239 A connection attempt to a host obtained from an MX record timed out.
24240
24241 .vitem &%timeout_connect_A%&
24242 A connection attempt to a host not obtained from an MX record timed out.
24243
24244 .vitem &%timeout_connect%&
24245 A connection attempt timed out.
24246
24247 .vitem &%timeout_MX%&
24248 There was a timeout while connecting or during an SMTP session with a host
24249 obtained from an MX record.
24250
24251 .vitem &%timeout_A%&
24252 There was a timeout while connecting or during an SMTP session with a host not
24253 obtained from an MX record.
24254
24255 .vitem &%timeout%&
24256 There was a timeout while connecting or during an SMTP session.
24257
24258 .vitem &%tls_required%&
24259 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24260 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24261 to STARTTLS, or there was a problem setting up the TLS connection.
24262
24263 .vitem &%quota%&
24264 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24265 transport.
24266
24267 .vitem &%quota_%&<&'time'&>
24268 .cindex "quota" "error testing in retry rule"
24269 .cindex "retry" "quota error testing"
24270 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24271 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24272 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24273 for four days.
24274 .endlist
24275
24276 .cindex "mailbox" "time of last read"
24277 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24278 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24279 it should be based on the last time that the user accessed the mailbox.
24280 However, it is not always possible to determine this. Exim uses the following
24281 heuristic rules:
24282
24283 .ilist
24284 If the mailbox is a single file, the time of last access (the &"atime"&) is
24285 used. As no new messages are being delivered (because the mailbox is over
24286 quota), Exim does not access the file, so this is the time of last user access.
24287 .next
24288 .cindex "maildir format" "time of last read"
24289 For a maildir delivery, the time of last modification of the &_new_&
24290 subdirectory is used. As the mailbox is over quota, no new files are created in
24291 the &_new_& subdirectory, because no new messages are being delivered. Any
24292 change to the &_new_& subdirectory is therefore assumed to be the result of an
24293 MUA moving a new message to the &_cur_& directory when it is first read. The
24294 time that is used is therefore the last time that the user read a new message.
24295 .next
24296 For other kinds of multi-file mailbox, the time of last access cannot be
24297 obtained, so a retry rule that uses this type of error field is never matched.
24298 .endlist
24299
24300 The quota errors apply both to system-enforced quotas and to Exim's own quota
24301 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24302 when a local delivery is deferred because a partition is full (the ENOSPC
24303 error).
24304
24305
24306
24307 .section "Retry rules for specified senders" "SECID162"
24308 .cindex "retry" "rules; sender-specific"
24309 You can specify retry rules that apply only when the failing message has a
24310 specific sender. In particular, this can be used to define retry rules that
24311 apply only to bounce messages. The third item in a retry rule can be of this
24312 form:
24313 .display
24314 &`senders=`&<&'address list'&>
24315 .endd
24316 The retry timings themselves are then the fourth item. For example:
24317 .code
24318 *   rcpt_4xx   senders=:   F,1h,30m
24319 .endd
24320 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24321 host. If the address list contains white space, it must be enclosed in quotes.
24322 For example:
24323 .code
24324 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24325 .endd
24326 &*Warning*&: This facility can be unhelpful if it is used for host errors
24327 (which do not depend on the recipient). The reason is that the sender is used
24328 only to match the retry rule. Once the rule has been found for a host error,
24329 its contents are used to set a retry time for the host, and this will apply to
24330 all messages, not just those with specific senders.
24331
24332 When testing retry rules using &%-brt%&, you can supply a sender using the
24333 &%-f%& command line option, like this:
24334 .code
24335 exim -f "" -brt user@dom.ain
24336 .endd
24337 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24338 list is never matched.
24339
24340
24341
24342
24343
24344 .section "Retry parameters" "SECID163"
24345 .cindex "retry" "parameters in rules"
24346 The third (or fourth, if a senders list is present) field in a retry rule is a
24347 sequence of retry parameter sets, separated by semicolons. Each set consists of
24348 .display
24349 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24350 .endd
24351 The letter identifies the algorithm for computing a new retry time; the cutoff
24352 time is the time beyond which this algorithm no longer applies, and the
24353 arguments vary the algorithm's action. The cutoff time is measured from the
24354 time that the first failure for the domain (combined with the local part if
24355 relevant) was detected, not from the time the message was received.
24356
24357 .cindex "retry" "algorithms"
24358 .cindex "retry" "fixed intervals"
24359 .cindex "retry" "increasing intervals"
24360 .cindex "retry" "random intervals"
24361 The available algorithms are:
24362
24363 .ilist
24364 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24365 the interval.
24366 .next
24367 &'G'&: retry at geometrically increasing intervals. The first argument
24368 specifies a starting value for the interval, and the second a multiplier, which
24369 is used to increase the size of the interval at each retry.
24370 .next
24371 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24372 retry, the previous interval is multiplied by the factor in order to get a
24373 maximum for the next interval. The minimum interval is the first argument of
24374 the parameter, and an actual interval is chosen randomly between them. Such a
24375 rule has been found to be helpful in cluster configurations when all the
24376 members of the cluster restart at once, and may therefore synchronize their
24377 queue processing times.
24378 .endlist
24379
24380 When computing the next retry time, the algorithm definitions are scanned in
24381 order until one whose cutoff time has not yet passed is reached. This is then
24382 used to compute a new retry time that is later than the current time. In the
24383 case of fixed interval retries, this simply means adding the interval to the
24384 current time. For geometrically increasing intervals, retry intervals are
24385 computed from the rule's parameters until one that is greater than the previous
24386 interval is found. The main configuration variable
24387 .cindex "limit" "retry interval"
24388 .cindex "retry" "interval, maximum"
24389 .oindex "&%retry_interval_max%&"
24390 &%retry_interval_max%& limits the maximum interval between retries. It
24391 cannot be set greater than &`24h`&, which is its default value.
24392
24393 A single remote domain may have a number of hosts associated with it, and each
24394 host may have more than one IP address. Retry algorithms are selected on the
24395 basis of the domain name, but are applied to each IP address independently. If,
24396 for example, a host has two IP addresses and one is unusable, Exim will
24397 generate retry times for it and will not try to use it until its next retry
24398 time comes. Thus the good IP address is likely to be tried first most of the
24399 time.
24400
24401 .cindex "hints database" "use for retrying"
24402 Retry times are hints rather than promises. Exim does not make any attempt to
24403 run deliveries exactly at the computed times. Instead, a queue runner process
24404 starts delivery processes for delayed messages periodically, and these attempt
24405 new deliveries only for those addresses that have passed their next retry time.
24406 If a new message arrives for a deferred address, an immediate delivery attempt
24407 occurs only if the address has passed its retry time. In the absence of new
24408 messages, the minimum time between retries is the interval between queue runner
24409 processes. There is not much point in setting retry times of five minutes if
24410 your queue runners happen only once an hour, unless there are a significant
24411 number of incoming messages (which might be the case on a system that is
24412 sending everything to a smart host, for example).
24413
24414 The data in the retry hints database can be inspected by using the
24415 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24416 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24417 &'exinext'& utility script can be used to find out what the next retry times
24418 are for the hosts associated with a particular mail domain, and also for local
24419 deliveries that have been deferred.
24420
24421
24422 .section "Retry rule examples" "SECID164"
24423 Here are some example retry rules:
24424 .code
24425 alice@wonderland.fict.example quota_5d  F,7d,3h
24426 wonderland.fict.example       quota_5d
24427 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24428 lookingglass.fict.example     *         F,24h,30m;
24429 *                 refused_A   F,2h,20m;
24430 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24431 .endd
24432 The first rule sets up special handling for mail to
24433 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24434 mailbox has not been read for at least 5 days. Retries continue every three
24435 hours for 7 days. The second rule handles over-quota errors for all other local
24436 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24437 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24438 fail are bounced immediately if the mailbox has not been read for at least 5
24439 days.
24440
24441 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24442 happen every 15 minutes for an hour, then with geometrically increasing
24443 intervals until two days have passed since a delivery first failed. After the
24444 first hour there is a delay of one hour, then two hours, then four hours, and
24445 so on (this is a rather extreme example).
24446
24447 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24448 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24449 all other domains, with special action for connection refusal from hosts that
24450 were not obtained from an MX record.
24451
24452 The final rule in a retry configuration should always have asterisks in the
24453 first two fields so as to provide a general catch-all for any addresses that do
24454 not have their own special handling. This example tries every 15 minutes for 2
24455 hours, then with intervals starting at one hour and increasing by a factor of
24456 1.5 up to 16 hours, then every 8 hours up to 5 days.
24457
24458
24459
24460 .section "Timeout of retry data" "SECID165"
24461 .cindex "timeout" "of retry data"
24462 .oindex "&%retry_data_expire%&"
24463 .cindex "hints database" "data expiry"
24464 .cindex "retry" "timeout of data"
24465 Exim timestamps the data that it writes to its retry hints database. When it
24466 consults the data during a delivery it ignores any that is older than the value
24467 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24468 been tried for 7 days, Exim will try to deliver to it immediately a message
24469 arrives, and if that fails, it will calculate a retry time as if it were
24470 failing for the first time.
24471
24472 This improves the behaviour for messages routed to rarely-used hosts such as MX
24473 backups. If such a host was down at one time, and happens to be down again when
24474 Exim tries a month later, using the old retry data would imply that it had been
24475 down all the time, which is not a justified assumption.
24476
24477 If a host really is permanently dead, this behaviour causes a burst of retries
24478 every now and again, but only if messages routed to it are rare. If there is a
24479 message at least once every 7 days the retry data never expires.
24480
24481
24482
24483
24484 .section "Long-term failures" "SECID166"
24485 .cindex "delivery failure, long-term"
24486 .cindex "retry" "after long-term failure"
24487 Special processing happens when an email address has been failing for so long
24488 that the cutoff time for the last algorithm is reached. For example, using the
24489 default retry rule:
24490 .code
24491 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24492 .endd
24493 the cutoff time is four days. Reaching the retry cutoff is independent of how
24494 long any specific message has been failing; it is the length of continuous
24495 failure for the recipient address that counts.
24496
24497 When the cutoff time is reached for a local delivery, or for all the IP
24498 addresses associated with a remote delivery, a subsequent delivery failure
24499 causes Exim to give up on the address, and a bounce message is generated.
24500 In order to cater for new messages that use the failing address, a next retry
24501 time is still computed from the final algorithm, and is used as follows:
24502
24503 For local deliveries, one delivery attempt is always made for any subsequent
24504 messages. If this delivery fails, the address fails immediately. The
24505 post-cutoff retry time is not used.
24506
24507 If the delivery is remote, there are two possibilities, controlled by the
24508 .oindex "&%delay_after_cutoff%&"
24509 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24510 default. Until the post-cutoff retry time for one of the IP addresses is
24511 reached, the failing email address is bounced immediately, without a delivery
24512 attempt taking place. After that time, one new delivery attempt is made to
24513 those IP addresses that are past their retry times, and if that still fails,
24514 the address is bounced and new retry times are computed.
24515
24516 In other words, when all the hosts for a given email address have been failing
24517 for a long time, Exim bounces rather then defers until one of the hosts' retry
24518 times is reached. Then it tries once, and bounces if that attempt fails. This
24519 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24520 to a broken destination, but if the host does recover, Exim will eventually
24521 notice.
24522
24523 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24524 addresses are past their final cutoff time, Exim tries to deliver to those IP
24525 addresses that have not been tried since the message arrived. If there are
24526 no suitable IP addresses, or if they all fail, the address is bounced. In other
24527 words, it does not delay when a new message arrives, but tries the expired
24528 addresses immediately, unless they have been tried since the message arrived.
24529 If there is a continuous stream of messages for the failing domains, setting
24530 &%delay_after_cutoff%& false means that there will be many more attempts to
24531 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24532 true.
24533
24534 .section "Deliveries that work intermittently" "SECID167"
24535 .cindex "retry" "intermittently working deliveries"
24536 Some additional logic is needed to cope with cases where a host is
24537 intermittently available, or when a message has some attribute that prevents
24538 its delivery when others to the same address get through. In this situation,
24539 because some messages are successfully delivered, the &"retry clock"& for the
24540 host or address keeps getting reset by the successful deliveries, and so
24541 failing messages remain on the queue for ever because the cutoff time is never
24542 reached.
24543
24544 Two exceptional actions are applied to prevent this happening. The first
24545 applies to errors that are related to a message rather than a remote host.
24546 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24547 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24548 commands, and quota failures. For this type of error, if a message's arrival
24549 time is earlier than the &"first failed"& time for the error, the earlier time
24550 is used when scanning the retry rules to decide when to try next and when to
24551 time out the address.
24552
24553 The exceptional second action applies in all cases. If a message has been on
24554 the queue for longer than the cutoff time of any applicable retry rule for a
24555 given address, a delivery is attempted for that address, even if it is not yet
24556 time, and if this delivery fails, the address is timed out. A new retry time is
24557 not computed in this case, so that other messages for the same address are
24558 considered immediately.
24559 .ecindex IIDretconf1
24560 .ecindex IIDregconf2
24561
24562
24563
24564
24565
24566
24567 . ////////////////////////////////////////////////////////////////////////////
24568 . ////////////////////////////////////////////////////////////////////////////
24569
24570 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24571 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24572 .scindex IIDauthconf2 "authentication"
24573 The &"authenticators"& section of Exim's run time configuration is concerned
24574 with SMTP authentication. This facility is an extension to the SMTP protocol,
24575 described in RFC 2554, which allows a client SMTP host to authenticate itself
24576 to a server. This is a common way for a server to recognize clients that are
24577 permitted to use it as a relay. SMTP authentication is not of relevance to the
24578 transfer of mail between servers that have no managerial connection with each
24579 other.
24580
24581 .cindex "AUTH" "description of"
24582 Very briefly, the way SMTP authentication works is as follows:
24583
24584 .ilist
24585 The server advertises a number of authentication &'mechanisms'& in response to
24586 the client's EHLO command.
24587 .next
24588 The client issues an AUTH command, naming a specific mechanism. The command
24589 may, optionally, contain some authentication data.
24590 .next
24591 The server may issue one or more &'challenges'&, to which the client must send
24592 appropriate responses. In simple authentication mechanisms, the challenges are
24593 just prompts for user names and passwords. The server does not have to issue
24594 any challenges &-- in some mechanisms the relevant data may all be transmitted
24595 with the AUTH command.
24596 .next
24597 The server either accepts or denies authentication.
24598 .next
24599 If authentication succeeds, the client may optionally make use of the AUTH
24600 option on the MAIL command to pass an authenticated sender in subsequent
24601 mail transactions. Authentication lasts for the remainder of the SMTP
24602 connection.
24603 .next
24604 If authentication fails, the client may give up, or it may try a different
24605 authentication mechanism, or it may try transferring mail over the
24606 unauthenticated connection.
24607 .endlist
24608
24609 If you are setting up a client, and want to know which authentication
24610 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24611 SMTP port) on the server, and issue an EHLO command. The response to this
24612 includes the list of supported mechanisms. For example:
24613 .display
24614 &`$ `&&*&`telnet server.example 25`&*&
24615 &`Trying 192.168.34.25...`&
24616 &`Connected to server.example.`&
24617 &`Escape character is &#x0027;^]&#x0027;.`&
24618 &`220 server.example ESMTP Exim 4.20 ...`&
24619 &*&`ehlo client.example`&*&
24620 &`250-server.example Hello client.example [10.8.4.5]`&
24621 &`250-SIZE 52428800`&
24622 &`250-PIPELINING`&
24623 &`250-AUTH PLAIN`&
24624 &`250 HELP`&
24625 .endd
24626 The second-last line of this example output shows that the server supports
24627 authentication using the PLAIN mechanism. In Exim, the different authentication
24628 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24629 routers and transports, which authenticators are included in the binary is
24630 controlled by build-time definitions. The following are currently available,
24631 included by setting
24632 .code
24633 AUTH_CRAM_MD5=yes
24634 AUTH_CYRUS_SASL=yes
24635 AUTH_DOVECOT=yes
24636 AUTH_GSASL=yes
24637 AUTH_HEIMDAL_GSSAPI=yes
24638 AUTH_PLAINTEXT=yes
24639 AUTH_SPA=yes
24640 .endd
24641 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24642 authentication mechanism (RFC 2195), and the second provides an interface to
24643 the Cyrus SASL authentication library.
24644 The third is an interface to Dovecot's authentication system, delegating the
24645 work via a socket interface.
24646 The fourth provides an interface to the GNU SASL authentication library, which
24647 provides mechanisms but typically not data sources.
24648 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24649 supporting setting a server keytab.
24650 The sixth can be configured to support
24651 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24652 not formally documented, but used by several MUAs. The seventh authenticator
24653 supports Microsoft's &'Secure Password Authentication'& mechanism.
24654
24655 The authenticators are configured using the same syntax as other drivers (see
24656 section &<<SECTfordricon>>&). If no authenticators are required, no
24657 authentication section need be present in the configuration file. Each
24658 authenticator can in principle have both server and client functions. When Exim
24659 is receiving SMTP mail, it is acting as a server; when it is sending out
24660 messages over SMTP, it is acting as a client. Authenticator configuration
24661 options are provided for use in both these circumstances.
24662
24663 To make it clear which options apply to which situation, the prefixes
24664 &%server_%& and &%client_%& are used on option names that are specific to
24665 either the server or the client function, respectively. Server and client
24666 functions are disabled if none of their options are set. If an authenticator is
24667 to be used for both server and client functions, a single definition, using
24668 both sets of options, is required. For example:
24669 .code
24670 cram:
24671   driver = cram_md5
24672   public_name = CRAM-MD5
24673   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24674   client_name = ph10
24675   client_secret = secret2
24676 .endd
24677 The &%server_%& option is used when Exim is acting as a server, and the
24678 &%client_%& options when it is acting as a client.
24679
24680 Descriptions of the individual authenticators are given in subsequent chapters.
24681 The remainder of this chapter covers the generic options for the
24682 authenticators, followed by general discussion of the way authentication works
24683 in Exim.
24684
24685 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24686 per-mechanism basis.  Please read carefully to determine which variables hold
24687 account labels such as usercodes and which hold passwords or other
24688 authenticating data.
24689
24690 Note that some mechanisms support two different identifiers for accounts: the
24691 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24692 and &'authz'& are commonly encountered.  The American spelling is standard here.
24693 Conceptually, authentication data such as passwords are tied to the identifier
24694 used to authenticate; servers may have rules to permit one user to act as a
24695 second user, so that after login the session is treated as though that second
24696 user had logged in.  That second user is the &'authorization id'&.  A robust
24697 configuration might confirm that the &'authz'& field is empty or matches the
24698 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24699 as verified data, the &'authz'& as an unverified request which the server might
24700 choose to honour.
24701
24702 A &'realm'& is a text string, typically a domain name, presented by a server
24703 to a client to help it select an account and credentials to use.  In some
24704 mechanisms, the client and server provably agree on the realm, but clients
24705 typically can not treat the realm as secure data to be blindly trusted.
24706
24707
24708
24709 .section "Generic options for authenticators" "SECID168"
24710 .cindex "authentication" "generic options"
24711 .cindex "options" "generic; for authenticators"
24712
24713 .option client_condition authenticators string&!! unset
24714 When Exim is authenticating as a client, it skips any authenticator whose
24715 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24716 used, for example, to skip plain text authenticators when the connection is not
24717 encrypted by a setting such as:
24718 .code
24719 client_condition = ${if !eq{$tls_out_cipher}{}}
24720 .endd
24721
24722
24723 .option client_set_id authenticators string&!! unset
24724 When client authentication succeeds, this condition is expanded; the
24725 result is used in the log lines for outbound messasges.
24726 Typically it will be the user name used for authentication.
24727
24728
24729 .option driver authenticators string unset
24730 This option must always be set. It specifies which of the available
24731 authenticators is to be used.
24732
24733
24734 .option public_name authenticators string unset
24735 This option specifies the name of the authentication mechanism that the driver
24736 implements, and by which it is known to the outside world. These names should
24737 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24738 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24739 defaults to the driver's instance name.
24740
24741
24742 .option server_advertise_condition authenticators string&!! unset
24743 When a server is about to advertise an authentication mechanism, the condition
24744 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24745 mechanism is not advertised.
24746 If the expansion fails, the mechanism is not advertised. If the failure was not
24747 forced, and was not caused by a lookup defer, the incident is logged.
24748 See section &<<SECTauthexiser>>& below for further discussion.
24749
24750
24751 .option server_condition authenticators string&!! unset
24752 This option must be set for a &%plaintext%& server authenticator, where it
24753 is used directly to control authentication. See section &<<SECTplainserver>>&
24754 for details.
24755
24756 For the &(gsasl)& authenticator, this option is required for various
24757 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24758
24759 For the other authenticators, &%server_condition%& can be used as an additional
24760 authentication or authorization mechanism that is applied after the other
24761 authenticator conditions succeed. If it is set, it is expanded when the
24762 authenticator would otherwise return a success code. If the expansion is forced
24763 to fail, authentication fails. Any other expansion failure causes a temporary
24764 error code to be returned. If the result of a successful expansion is an empty
24765 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24766 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24767 other result, a temporary error code is returned, with the expanded string as
24768 the error text.
24769
24770
24771 .option server_debug_print authenticators string&!! unset
24772 If this option is set and authentication debugging is enabled (see the &%-d%&
24773 command line option), the string is expanded and included in the debugging
24774 output when the authenticator is run as a server. This can help with checking
24775 out the values of variables.
24776 If expansion of the string fails, the error message is written to the debugging
24777 output, and Exim carries on processing.
24778
24779
24780 .option server_set_id authenticators string&!! unset
24781 .vindex "&$authenticated_id$&"
24782 When an Exim server successfully authenticates a client, this string is
24783 expanded using data from the authentication, and preserved for any incoming
24784 messages in the variable &$authenticated_id$&. It is also included in the log
24785 lines for incoming messages. For example, a user/password authenticator
24786 configuration might preserve the user name that was used to authenticate, and
24787 refer to it subsequently during delivery of the message.
24788 If expansion fails, the option is ignored.
24789
24790
24791 .option server_mail_auth_condition authenticators string&!! unset
24792 This option allows a server to discard authenticated sender addresses supplied
24793 as part of MAIL commands in SMTP connections that are authenticated by the
24794 driver on which &%server_mail_auth_condition%& is set. The option is not used
24795 as part of the authentication process; instead its (unexpanded) value is
24796 remembered for later use.
24797 How it is used is described in the following section.
24798
24799
24800
24801
24802
24803 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24804 .cindex "authentication" "sender; authenticated"
24805 .cindex "AUTH" "on MAIL command"
24806 When a client supplied an AUTH= item on a MAIL command, Exim applies
24807 the following checks before accepting it as the authenticated sender of the
24808 message:
24809
24810 .ilist
24811 If the connection is not using extended SMTP (that is, HELO was used rather
24812 than EHLO), the use of AUTH= is a syntax error.
24813 .next
24814 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24815 .next
24816 .vindex "&$authenticated_sender$&"
24817 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24818 running, the value of &$authenticated_sender$& is set to the value obtained
24819 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24820 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24821 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24822 given for the MAIL command.
24823 .next
24824 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24825 is accepted and placed in &$authenticated_sender$& only if the client has
24826 authenticated.
24827 .next
24828 If the AUTH= value was accepted by either of the two previous rules, and
24829 the client has authenticated, and the authenticator has a setting for the
24830 &%server_mail_auth_condition%&, the condition is checked at this point. The
24831 valued that was saved from the authenticator is expanded. If the expansion
24832 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24833 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24834 the value of &$authenticated_sender$& is retained and passed on with the
24835 message.
24836 .endlist
24837
24838
24839 When &$authenticated_sender$& is set for a message, it is passed on to other
24840 hosts to which Exim authenticates as a client. Do not confuse this value with
24841 &$authenticated_id$&, which is a string obtained from the authentication
24842 process, and which is not usually a complete email address.
24843
24844 .vindex "&$sender_address$&"
24845 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24846 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24847 therefore make use of &$authenticated_sender$&. The converse is not true: the
24848 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24849 ACL is run.
24850
24851
24852
24853 .section "Authentication on an Exim server" "SECTauthexiser"
24854 .cindex "authentication" "on an Exim server"
24855 When Exim receives an EHLO command, it advertises the public names of those
24856 authenticators that are configured as servers, subject to the following
24857 conditions:
24858
24859 .ilist
24860 The client host must match &%auth_advertise_hosts%& (default *).
24861 .next
24862 It the &%server_advertise_condition%& option is set, its expansion must not
24863 yield the empty string, &"0"&, &"no"&, or &"false"&.
24864 .endlist
24865
24866 The order in which the authenticators are defined controls the order in which
24867 the mechanisms are advertised.
24868
24869 Some mail clients (for example, some versions of Netscape) require the user to
24870 provide a name and password for authentication whenever AUTH is advertised,
24871 even though authentication may not in fact be needed (for example, Exim may be
24872 set up to allow unconditional relaying from the client by an IP address check).
24873 You can make such clients more friendly by not advertising AUTH to them.
24874 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24875 that runs for RCPT) to relay without authentication, you should set
24876 .code
24877 auth_advertise_hosts = ! 10.9.8.0/24
24878 .endd
24879 so that no authentication mechanisms are advertised to them.
24880
24881 The &%server_advertise_condition%& controls the advertisement of individual
24882 authentication mechanisms. For example, it can be used to restrict the
24883 advertisement of a particular mechanism to encrypted connections, by a setting
24884 such as:
24885 .code
24886 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24887 .endd
24888 .vindex "&$tls_in_cipher$&"
24889 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24890 yields &"yes"&, which allows the advertisement to happen.
24891
24892 When an Exim server receives an AUTH command from a client, it rejects it
24893 immediately if AUTH was not advertised in response to an earlier EHLO
24894 command. This is the case if
24895
24896 .ilist
24897 The client host does not match &%auth_advertise_hosts%&; or
24898 .next
24899 No authenticators are configured with server options; or
24900 .next
24901 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24902 server authenticators.
24903 .endlist
24904
24905
24906 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24907 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24908 AUTH is accepted from any client host.
24909
24910 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24911 server authentication mechanism that was advertised in response to EHLO and
24912 that matches the one named in the AUTH command. If it finds one, it runs
24913 the appropriate authentication protocol, and authentication either succeeds or
24914 fails. If there is no matching advertised mechanism, the AUTH command is
24915 rejected with a 504 error.
24916
24917 .vindex "&$received_protocol$&"
24918 .vindex "&$sender_host_authenticated$&"
24919 When a message is received from an authenticated host, the value of
24920 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24921 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24922 public name) of the authenticator driver that successfully authenticated the
24923 client from which the message was received. This variable is empty if there was
24924 no successful authentication.
24925
24926
24927
24928
24929 .section "Testing server authentication" "SECID169"
24930 .cindex "authentication" "testing a server"
24931 .cindex "AUTH" "testing a server"
24932 .cindex "base64 encoding" "creating authentication test data"
24933 Exim's &%-bh%& option can be useful for testing server authentication
24934 configurations. The data for the AUTH command has to be sent using base64
24935 encoding. A quick way to produce such data for testing is the following Perl
24936 script:
24937 .code
24938 use MIME::Base64;
24939 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24940 .endd
24941 .cindex "binary zero" "in authentication data"
24942 This interprets its argument as a Perl string, and then encodes it. The
24943 interpretation as a Perl string allows binary zeros, which are required for
24944 some kinds of authentication, to be included in the data. For example, a
24945 command line to run this script on such data might be
24946 .code
24947 encode '\0user\0password'
24948 .endd
24949 Note the use of single quotes to prevent the shell interpreting the
24950 backslashes, so that they can be interpreted by Perl to specify characters
24951 whose code value is zero.
24952
24953 &*Warning 1*&: If either of the user or password strings starts with an octal
24954 digit, you must use three zeros instead of one after the leading backslash. If
24955 you do not, the octal digit that starts your string will be incorrectly
24956 interpreted as part of the code for the first character.
24957
24958 &*Warning 2*&: If there are characters in the strings that Perl interprets
24959 specially, you must use a Perl escape to prevent them being misinterpreted. For
24960 example, a command such as
24961 .code
24962 encode '\0user@domain.com\0pas$$word'
24963 .endd
24964 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24965
24966 If you have the &%mimencode%& command installed, another way to do produce
24967 base64-encoded strings is to run the command
24968 .code
24969 echo -e -n `\0user\0password' | mimencode
24970 .endd
24971 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24972 in the argument, and the &%-n%& option specifies no newline at the end of its
24973 output. However, not all versions of &%echo%& recognize these options, so you
24974 should check your version before relying on this suggestion.
24975
24976
24977
24978 .section "Authentication by an Exim client" "SECID170"
24979 .cindex "authentication" "on an Exim client"
24980 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24981 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24982 announces support for authentication, and the host matches an entry in either
24983 of these options, Exim (as a client) tries to authenticate as follows:
24984
24985 .ilist
24986 For each authenticator that is configured as a client, in the order in which
24987 they are defined in the configuration, it searches the authentication
24988 mechanisms announced by the server for one whose name matches the public name
24989 of the authenticator.
24990 .next
24991 .vindex "&$host$&"
24992 .vindex "&$host_address$&"
24993 When it finds one that matches, it runs the authenticator's client code. The
24994 variables &$host$& and &$host_address$& are available for any string expansions
24995 that the client might do. They are set to the server's name and IP address. If
24996 any expansion is forced to fail, the authentication attempt is abandoned, and
24997 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24998 delivery to be deferred.
24999 .next
25000 If the result of the authentication attempt is a temporary error or a timeout,
25001 Exim abandons trying to send the message to the host for the moment. It will
25002 try again later. If there are any backup hosts available, they are tried in the
25003 usual way.
25004 .next
25005 If the response to authentication is a permanent error (5&'xx'& code), Exim
25006 carries on searching the list of authenticators and tries another one if
25007 possible. If all authentication attempts give permanent errors, or if there are
25008 no attempts because no mechanisms match (or option expansions force failure),
25009 what happens depends on whether the host matches &%hosts_require_auth%& or
25010 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25011 delivery is deferred. The error can be detected in the retry rules, and thereby
25012 turned into a permanent error if you wish. In the second case, Exim tries to
25013 deliver the message unauthenticated.
25014 .endlist
25015
25016 .cindex "AUTH" "on MAIL command"
25017 When Exim has authenticated itself to a remote server, it adds the AUTH
25018 parameter to the MAIL commands it sends, if it has an authenticated sender for
25019 the message. If the message came from a remote host, the authenticated sender
25020 is the one that was receiving on an incoming MAIL command, provided that the
25021 incoming connection was authenticated and the &%server_mail_auth%& condition
25022 allowed the authenticated sender to be retained. If a local process calls Exim
25023 to send a message, the sender address that is built from the login name and
25024 &%qualify_domain%& is treated as authenticated. However, if the
25025 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25026 the authenticated sender that was received with the message.
25027 .ecindex IIDauthconf1
25028 .ecindex IIDauthconf2
25029
25030
25031
25032
25033
25034
25035 . ////////////////////////////////////////////////////////////////////////////
25036 . ////////////////////////////////////////////////////////////////////////////
25037
25038 .chapter "The plaintext authenticator" "CHAPplaintext"
25039 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25040 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25041 The &(plaintext)& authenticator can be configured to support the PLAIN and
25042 LOGIN authentication mechanisms, both of which transfer authentication data as
25043 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25044 security risk; you are strongly advised to insist on the use of SMTP encryption
25045 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25046 use unencrypted plain text, you should not use the same passwords for SMTP
25047 connections as you do for login accounts.
25048
25049 .section "Plaintext options" "SECID171"
25050 .cindex "options" "&(plaintext)& authenticator (server)"
25051 When configured as a server, &(plaintext)& uses the following options:
25052
25053 .option server_condition authenticators string&!! unset
25054 This is actually a global authentication option, but it must be set in order to
25055 configure the &(plaintext)& driver as a server. Its use is described below.
25056
25057 .option server_prompts plaintext string&!! unset
25058 The contents of this option, after expansion, must be a colon-separated list of
25059 prompt strings. If expansion fails, a temporary authentication rejection is
25060 given.
25061
25062 .section "Using plaintext in a server" "SECTplainserver"
25063 .cindex "AUTH" "in &(plaintext)& authenticator"
25064 .cindex "binary zero" "in &(plaintext)& authenticator"
25065 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25066         "in &(plaintext)& authenticator"
25067 .vindex "&$auth1$&, &$auth2$&, etc"
25068 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25069
25070 When running as a server, &(plaintext)& performs the authentication test by
25071 expanding a string. The data sent by the client with the AUTH command, or in
25072 response to subsequent prompts, is base64 encoded, and so may contain any byte
25073 values when decoded. If any data is supplied with the command, it is treated as
25074 a list of strings, separated by NULs (binary zeros), the first three of which
25075 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25076 (neither LOGIN nor PLAIN uses more than three strings).
25077
25078 For compatibility with previous releases of Exim, the values are also placed in
25079 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25080 variables for this purpose is now deprecated, as it can lead to confusion in
25081 string expansions that also use them for other things.
25082
25083 If there are more strings in &%server_prompts%& than the number of strings
25084 supplied with the AUTH command, the remaining prompts are used to obtain more
25085 data. Each response from the client may be a list of NUL-separated strings.
25086
25087 .vindex "&$authenticated_id$&"
25088 Once a sufficient number of data strings have been received,
25089 &%server_condition%& is expanded. If the expansion is forced to fail,
25090 authentication fails. Any other expansion failure causes a temporary error code
25091 to be returned. If the result of a successful expansion is an empty string,
25092 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25093 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25094 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25095 For any other result, a temporary error code is returned, with the expanded
25096 string as the error text
25097
25098 &*Warning*&: If you use a lookup in the expansion to find the user's
25099 password, be sure to make the authentication fail if the user is unknown.
25100 There are good and bad examples at the end of the next section.
25101
25102
25103
25104 .section "The PLAIN authentication mechanism" "SECID172"
25105 .cindex "PLAIN authentication mechanism"
25106 .cindex "authentication" "PLAIN mechanism"
25107 .cindex "binary zero" "in &(plaintext)& authenticator"
25108 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25109 sent as one item of data (that is, one combined string containing two NUL
25110 separators). The data is sent either as part of the AUTH command, or
25111 subsequently in response to an empty prompt from the server.
25112
25113 The second and third strings are a user name and a corresponding password.
25114 Using a single fixed user name and password as an example, this could be
25115 configured as follows:
25116 .code
25117 fixed_plain:
25118   driver = plaintext
25119   public_name = PLAIN
25120   server_prompts = :
25121   server_condition = \
25122     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25123   server_set_id = $auth2
25124 .endd
25125 Note that the default result strings from &%if%& (&"true"& or an empty string)
25126 are exactly what we want here, so they need not be specified. Obviously, if the
25127 password contains expansion-significant characters such as dollar, backslash,
25128 or closing brace, they have to be escaped.
25129
25130 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25131 the end of a string list are ignored). If all the data comes as part of the
25132 AUTH command, as is commonly the case, the prompt is not used. This
25133 authenticator is advertised in the response to EHLO as
25134 .code
25135 250-AUTH PLAIN
25136 .endd
25137 and a client host can authenticate itself by sending the command
25138 .code
25139 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25140 .endd
25141 As this contains three strings (more than the number of prompts), no further
25142 data is required from the client. Alternatively, the client may just send
25143 .code
25144 AUTH PLAIN
25145 .endd
25146 to initiate authentication, in which case the server replies with an empty
25147 prompt. The client must respond with the combined data string.
25148
25149 The data string is base64 encoded, as required by the RFC. This example,
25150 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25151 represents a zero byte. This is split up into three strings, the first of which
25152 is empty. The &%server_condition%& option in the authenticator checks that the
25153 second two are &`username`& and &`mysecret`& respectively.
25154
25155 Having just one fixed user name and password, as in this example, is not very
25156 realistic, though for a small organization with only a handful of
25157 authenticating clients it could make sense.
25158
25159 A more sophisticated instance of this authenticator could use the user name in
25160 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25161 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25162 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25163 This is an incorrect example:
25164 .code
25165 server_condition = \
25166   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25167 .endd
25168 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25169 which it then compares to the supplied password (&$auth3$&). Why is this example
25170 incorrect? It works fine for existing users, but consider what happens if a
25171 non-existent user name is given. The lookup fails, but as no success/failure
25172 strings are given for the lookup, it yields an empty string. Thus, to defeat
25173 the authentication, all a client has to do is to supply a non-existent user
25174 name and an empty password. The correct way of writing this test is:
25175 .code
25176 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25177   {${if eq{$value}{$auth3}}} {false}}
25178 .endd
25179 In this case, if the lookup succeeds, the result is checked; if the lookup
25180 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25181 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25182 always fails if its second argument is empty. However, the second way of
25183 writing the test makes the logic clearer.
25184
25185
25186 .section "The LOGIN authentication mechanism" "SECID173"
25187 .cindex "LOGIN authentication mechanism"
25188 .cindex "authentication" "LOGIN mechanism"
25189 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25190 in a number of programs. No data is sent with the AUTH command. Instead, a
25191 user name and password are supplied separately, in response to prompts. The
25192 plaintext authenticator can be configured to support this as in this example:
25193 .code
25194 fixed_login:
25195   driver = plaintext
25196   public_name = LOGIN
25197   server_prompts = User Name : Password
25198   server_condition = \
25199     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25200   server_set_id = $auth1
25201 .endd
25202 Because of the way plaintext operates, this authenticator accepts data supplied
25203 with the AUTH command (in contravention of the specification of LOGIN), but
25204 if the client does not supply it (as is the case for LOGIN clients), the prompt
25205 strings are used to obtain two data items.
25206
25207 Some clients are very particular about the precise text of the prompts. For
25208 example, Outlook Express is reported to recognize only &"Username:"& and
25209 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25210 strings. It uses the &%ldapauth%& expansion condition to check the user
25211 name and password by binding to an LDAP server:
25212 .code
25213 login:
25214   driver = plaintext
25215   public_name = LOGIN
25216   server_prompts = Username:: : Password::
25217   server_condition = ${if and{{ \
25218     !eq{}{$auth1} }{ \
25219     ldapauth{\
25220       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25221       pass=${quote:$auth2} \
25222       ldap://ldap.example.org/} }} }
25223   server_set_id = uid=$auth1,ou=people,o=example.org
25224 .endd
25225 We have to check that the username is not empty before using it, because LDAP
25226 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25227 operator to correctly quote the DN for authentication. However, the basic
25228 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25229 correct one to use for the password, because quoting is needed only to make
25230 the password conform to the Exim syntax. At the LDAP level, the password is an
25231 uninterpreted string.
25232
25233
25234 .section "Support for different kinds of authentication" "SECID174"
25235 A number of string expansion features are provided for the purpose of
25236 interfacing to different ways of user authentication. These include checking
25237 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25238 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25239 &<<SECTexpcond>>&.
25240
25241
25242
25243
25244 .section "Using plaintext in a client" "SECID175"
25245 .cindex "options" "&(plaintext)& authenticator (client)"
25246 The &(plaintext)& authenticator has two client options:
25247
25248 .option client_ignore_invalid_base64 plaintext boolean false
25249 If the client receives a server prompt that is not a valid base64 string,
25250 authentication is abandoned by default. However, if this option is set true,
25251 the error in the challenge is ignored and the client sends the response as
25252 usual.
25253
25254 .option client_send plaintext string&!! unset
25255 The string is a colon-separated list of authentication data strings. Each
25256 string is independently expanded before being sent to the server. The first
25257 string is sent with the AUTH command; any more strings are sent in response
25258 to prompts from the server. Before each string is expanded, the value of the
25259 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25260 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25261 way. Thus, the prompt that is received in response to sending the first string
25262 (with the AUTH command) can be used in the expansion of the second string, and
25263 so on. If an invalid base64 string is received when
25264 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25265 &$auth$&<&'n'&> variable.
25266
25267 &*Note*&: You cannot use expansion to create multiple strings, because
25268 splitting takes priority and happens first.
25269
25270 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25271 the data, further processing is applied to each string before it is sent. If
25272 there are any single circumflex characters in the string, they are converted to
25273 NULs. Should an actual circumflex be required as data, it must be doubled in
25274 the string.
25275
25276 This is an example of a client configuration that implements the PLAIN
25277 authentication mechanism with a fixed user name and password:
25278 .code
25279 fixed_plain:
25280   driver = plaintext
25281   public_name = PLAIN
25282   client_send = ^username^mysecret
25283 .endd
25284 The lack of colons means that the entire text is sent with the AUTH
25285 command, with the circumflex characters converted to NULs. A similar example
25286 that uses the LOGIN mechanism is:
25287 .code
25288 fixed_login:
25289   driver = plaintext
25290   public_name = LOGIN
25291   client_send = : username : mysecret
25292 .endd
25293 The initial colon means that the first string is empty, so no data is sent with
25294 the AUTH command itself. The remaining strings are sent in response to
25295 prompts.
25296 .ecindex IIDplaiauth1
25297 .ecindex IIDplaiauth2
25298
25299
25300
25301
25302 . ////////////////////////////////////////////////////////////////////////////
25303 . ////////////////////////////////////////////////////////////////////////////
25304
25305 .chapter "The cram_md5 authenticator" "CHID9"
25306 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25307 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25308 .cindex "CRAM-MD5 authentication mechanism"
25309 .cindex "authentication" "CRAM-MD5 mechanism"
25310 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25311 sends a challenge string to the client, and the response consists of a user
25312 name and the CRAM-MD5 digest of the challenge string combined with a secret
25313 string (password) which is known to both server and client. Thus, the secret
25314 is not sent over the network as plain text, which makes this authenticator more
25315 secure than &(plaintext)&. However, the downside is that the secret has to be
25316 available in plain text at either end.
25317
25318
25319 .section "Using cram_md5 as a server" "SECID176"
25320 .cindex "options" "&(cram_md5)& authenticator (server)"
25321 This authenticator has one server option, which must be set to configure the
25322 authenticator as a server:
25323
25324 .option server_secret cram_md5 string&!! unset
25325 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25326 When the server receives the client's response, the user name is placed in
25327 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25328 obtain the password for that user. The server then computes the CRAM-MD5 digest
25329 that the client should have sent, and checks that it received the correct
25330 string. If the expansion of &%server_secret%& is forced to fail, authentication
25331 fails. If the expansion fails for some other reason, a temporary error code is
25332 returned to the client.
25333
25334 For compatibility with previous releases of Exim, the user name is also placed
25335 in &$1$&. However, the use of this variables for this purpose is now
25336 deprecated, as it can lead to confusion in string expansions that also use
25337 numeric variables for other things.
25338
25339 For example, the following authenticator checks that the user name given by the
25340 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25341 user name, authentication fails.
25342 .code
25343 fixed_cram:
25344   driver = cram_md5
25345   public_name = CRAM-MD5
25346   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25347   server_set_id = $auth1
25348 .endd
25349 .vindex "&$authenticated_id$&"
25350 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25351 name in &$authenticated_id$&. A more typical configuration might look up the
25352 secret string in a file, using the user name as the key. For example:
25353 .code
25354 lookup_cram:
25355   driver = cram_md5
25356   public_name = CRAM-MD5
25357   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25358                   {$value}fail}
25359   server_set_id = $auth1
25360 .endd
25361 Note that this expansion explicitly forces failure if the lookup fails
25362 because &$auth1$& contains an unknown user name.
25363
25364 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25365 using the relevant libraries, you need to know the realm to specify in the
25366 lookup and then ask for the &"userPassword"& attribute for that user in that
25367 realm, with:
25368 .code
25369 cyrusless_crammd5:
25370   driver = cram_md5
25371   public_name = CRAM-MD5
25372   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25373                   dbmjz{/etc/sasldb2}}
25374   server_set_id = $auth1
25375 .endd
25376
25377 .section "Using cram_md5 as a client" "SECID177"
25378 .cindex "options" "&(cram_md5)& authenticator (client)"
25379 When used as a client, the &(cram_md5)& authenticator has two options:
25380
25381
25382
25383 .option client_name cram_md5 string&!! "the primary host name"
25384 This string is expanded, and the result used as the user name data when
25385 computing the response to the server's challenge.
25386
25387
25388 .option client_secret cram_md5 string&!! unset
25389 This option must be set for the authenticator to work as a client. Its value is
25390 expanded and the result used as the secret string when computing the response.
25391
25392
25393 .vindex "&$host$&"
25394 .vindex "&$host_address$&"
25395 Different user names and secrets can be used for different servers by referring
25396 to &$host$& or &$host_address$& in the options. Forced failure of either
25397 expansion string is treated as an indication that this authenticator is not
25398 prepared to handle this case. Exim moves on to the next configured client
25399 authenticator. Any other expansion failure causes Exim to give up trying to
25400 send the message to the current server.
25401
25402 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25403 strings, is:
25404 .code
25405 fixed_cram:
25406   driver = cram_md5
25407   public_name = CRAM-MD5
25408   client_name = ph10
25409   client_secret = secret
25410 .endd
25411 .ecindex IIDcramauth1
25412 .ecindex IIDcramauth2
25413
25414
25415
25416 . ////////////////////////////////////////////////////////////////////////////
25417 . ////////////////////////////////////////////////////////////////////////////
25418
25419 .chapter "The cyrus_sasl authenticator" "CHID10"
25420 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25421 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25422 .cindex "Cyrus" "SASL library"
25423 .cindex "Kerberos"
25424 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25425 Digital Ltd (&url(http://www.aldigital.co.uk)).
25426
25427 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25428 library implementation of the RFC 2222 (&"Simple Authentication and Security
25429 Layer"&). This library supports a number of authentication mechanisms,
25430 including PLAIN and LOGIN, but also several others that Exim does not support
25431 directly. In particular, there is support for Kerberos authentication.
25432
25433 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25434 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25435 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25436 name of the driver to determine which mechanism to support.
25437
25438 Where access to some kind of secret file is required, for example in GSSAPI
25439 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25440 user, and that the Cyrus SASL library has no way of escalating privileges
25441 by default. You may also find you need to set environment variables,
25442 depending on the driver you are using.
25443
25444 The application name provided by Exim is &"exim"&, so various SASL options may
25445 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25446 Kerberos, note that because of limitations in the GSSAPI interface,
25447 changing the server keytab might need to be communicated down to the Kerberos
25448 layer independently. The mechanism for doing so is dependent upon the Kerberos
25449 implementation.
25450
25451 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25452 may be set to point to an alternative keytab file. Exim will pass this
25453 variable through from its own inherited environment when started as root or the
25454 Exim user. The keytab file needs to be readable by the Exim user.
25455 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25456 environment variable.  In practice, for those releases, the Cyrus authenticator
25457 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25458 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25459
25460
25461 .section "Using cyrus_sasl as a server" "SECID178"
25462 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25463 (on a successful authentication) into &$auth1$&. For compatibility with
25464 previous releases of Exim, the username is also placed in &$1$&. However, the
25465 use of this variable for this purpose is now deprecated, as it can lead to
25466 confusion in string expansions that also use numeric variables for other
25467 things.
25468
25469
25470 .option server_hostname cyrus_sasl string&!! "see below"
25471 This option selects the hostname that is used when communicating with the
25472 library. The default value is &`$primary_hostname`&. It is up to the underlying
25473 SASL plug-in what it does with this data.
25474
25475
25476 .option server_mech cyrus_sasl string "see below"
25477 This option selects the authentication mechanism this driver should use. The
25478 default is the value of the generic &%public_name%& option. This option allows
25479 you to use a different underlying mechanism from the advertised name. For
25480 example:
25481 .code
25482 sasl:
25483   driver = cyrus_sasl
25484   public_name = X-ANYTHING
25485   server_mech = CRAM-MD5
25486   server_set_id = $auth1
25487 .endd
25488
25489 .option server_realm cyrus_sasl string&!! unset
25490 This specifies the SASL realm that the server claims to be in.
25491
25492
25493 .option server_service cyrus_sasl string &`smtp`&
25494 This is the SASL service that the server claims to implement.
25495
25496
25497 For straightforward cases, you do not need to set any of the authenticator's
25498 private options. All you need to do is to specify an appropriate mechanism as
25499 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25500 PLAIN, you could have two authenticators as follows:
25501 .code
25502 sasl_cram_md5:
25503   driver = cyrus_sasl
25504   public_name = CRAM-MD5
25505   server_set_id = $auth1
25506
25507 sasl_plain:
25508   driver = cyrus_sasl
25509   public_name = PLAIN
25510   server_set_id = $auth2
25511 .endd
25512 Cyrus SASL does implement the LOGIN authentication method, even though it is
25513 not a standard method. It is disabled by default in the source distribution,
25514 but it is present in many binary distributions.
25515 .ecindex IIDcyrauth1
25516 .ecindex IIDcyrauth2
25517
25518
25519
25520
25521 . ////////////////////////////////////////////////////////////////////////////
25522 . ////////////////////////////////////////////////////////////////////////////
25523 .chapter "The dovecot authenticator" "CHAPdovecot"
25524 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25525 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25526 This authenticator is an interface to the authentication facility of the
25527 Dovecot POP/IMAP server, which can support a number of authentication methods.
25528 Note that Dovecot must be configured to use auth-client not auth-userdb.
25529 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25530 to use the same mechanisms for SMTP authentication. This is a server
25531 authenticator only. There is only one option:
25532
25533 .option server_socket dovecot string unset
25534
25535 This option must specify the socket that is the interface to Dovecot
25536 authentication. The &%public_name%& option must specify an authentication
25537 mechanism that Dovecot is configured to support. You can have several
25538 authenticators for different mechanisms. For example:
25539 .code
25540 dovecot_plain:
25541   driver = dovecot
25542   public_name = PLAIN
25543   server_socket = /var/run/dovecot/auth-client
25544   server_set_id = $auth1
25545
25546 dovecot_ntlm:
25547   driver = dovecot
25548   public_name = NTLM
25549   server_socket = /var/run/dovecot/auth-client
25550   server_set_id = $auth1
25551 .endd
25552 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25553 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25554 option is passed in the Dovecot authentication command. If, for a TLS
25555 connection, a client certificate has been verified, the &"valid-client-cert"&
25556 option is passed. When authentication succeeds, the identity of the user
25557 who authenticated is placed in &$auth1$&.
25558 .ecindex IIDdcotauth1
25559 .ecindex IIDdcotauth2
25560
25561
25562 . ////////////////////////////////////////////////////////////////////////////
25563 . ////////////////////////////////////////////////////////////////////////////
25564 .chapter "The gsasl authenticator" "CHAPgsasl"
25565 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25566 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25567 .cindex "authentication" "GNU SASL"
25568 .cindex "authentication" "SASL"
25569 .cindex "authentication" "EXTERNAL"
25570 .cindex "authentication" "ANONYMOUS"
25571 .cindex "authentication" "PLAIN"
25572 .cindex "authentication" "LOGIN"
25573 .cindex "authentication" "DIGEST-MD5"
25574 .cindex "authentication" "CRAM-MD5"
25575 .cindex "authentication" "SCRAM-SHA-1"
25576 The &(gsasl)& authenticator provides server integration for the GNU SASL
25577 library and the mechanisms it provides.  This is new as of the 4.80 release
25578 and there are a few areas where the library does not let Exim smoothly
25579 scale to handle future authentication mechanisms, so no guarantee can be
25580 made that any particular new authentication mechanism will be supported
25581 without code changes in Exim.
25582
25583
25584 .option server_channelbinding gsasl boolean false
25585 Some authentication mechanisms are able to use external context at both ends
25586 of the session to bind the authentication to that context, and fail the
25587 authentication process if that context differs.  Specifically, some TLS
25588 ciphersuites can provide identifying information about the cryptographic
25589 context.
25590
25591 This means that certificate identity and verification becomes a non-issue,
25592 as a man-in-the-middle attack will cause the correct client and server to
25593 see different identifiers and authentication will fail.
25594
25595 This is currently only supported when using the GnuTLS library.  This is
25596 only usable by mechanisms which support "channel binding"; at time of
25597 writing, that's the SCRAM family.
25598
25599 This defaults off to ensure smooth upgrade across Exim releases, in case
25600 this option causes some clients to start failing.  Some future release
25601 of Exim may switch the default to be true.
25602
25603
25604 .option server_hostname gsasl string&!! "see below"
25605 This option selects the hostname that is used when communicating with the
25606 library. The default value is &`$primary_hostname`&.
25607 Some mechanisms will use this data.
25608
25609
25610 .option server_mech gsasl string "see below"
25611 This option selects the authentication mechanism this driver should use. The
25612 default is the value of the generic &%public_name%& option. This option allows
25613 you to use a different underlying mechanism from the advertised name. For
25614 example:
25615 .code
25616 sasl:
25617   driver = gsasl
25618   public_name = X-ANYTHING
25619   server_mech = CRAM-MD5
25620   server_set_id = $auth1
25621 .endd
25622
25623
25624 .option server_password gsasl string&!! unset
25625 Various mechanisms need access to the cleartext password on the server, so
25626 that proof-of-possession can be demonstrated on the wire, without sending
25627 the password itself.
25628
25629 The data available for lookup varies per mechanism.
25630 In all cases, &$auth1$& is set to the &'authentication id'&.
25631 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25632 if available, else the empty string.
25633 The &$auth3$& variable will always be the &'realm'& if available,
25634 else the empty string.
25635
25636 A forced failure will cause authentication to defer.
25637
25638 If using this option, it may make sense to set the &%server_condition%&
25639 option to be simply "true".
25640
25641
25642 .option server_realm gsasl string&!! unset
25643 This specifies the SASL realm that the server claims to be in.
25644 Some mechanisms will use this data.
25645
25646
25647 .option server_scram_iter gsasl string&!! unset
25648 This option provides data for the SCRAM family of mechanisms.
25649 &$auth1$& is not available at evaluation time.
25650 (This may change, as we receive feedback on use)
25651
25652
25653 .option server_scram_salt gsasl string&!! unset
25654 This option provides data for the SCRAM family of mechanisms.
25655 &$auth1$& is not available at evaluation time.
25656 (This may change, as we receive feedback on use)
25657
25658
25659 .option server_service gsasl string &`smtp`&
25660 This is the SASL service that the server claims to implement.
25661 Some mechanisms will use this data.
25662
25663
25664 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25665 .vindex "&$auth1$&, &$auth2$&, etc"
25666 These may be set when evaluating specific options, as detailed above.
25667 They will also be set when evaluating &%server_condition%&.
25668
25669 Unless otherwise stated below, the &(gsasl)& integration will use the following
25670 meanings for these variables:
25671
25672 .ilist
25673 .vindex "&$auth1$&"
25674 &$auth1$&: the &'authentication id'&
25675 .next
25676 .vindex "&$auth2$&"
25677 &$auth2$&: the &'authorization id'&
25678 .next
25679 .vindex "&$auth3$&"
25680 &$auth3$&: the &'realm'&
25681 .endlist
25682
25683 On a per-mechanism basis:
25684
25685 .ilist
25686 .cindex "authentication" "EXTERNAL"
25687 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25688 the &%server_condition%& option must be present.
25689 .next
25690 .cindex "authentication" "ANONYMOUS"
25691 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25692 the &%server_condition%& option must be present.
25693 .next
25694 .cindex "authentication" "GSSAPI"
25695 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25696 &$auth2$& will be set to the &'authorization id'&,
25697 the &%server_condition%& option must be present.
25698 .endlist
25699
25700 An &'anonymous token'& is something passed along as an unauthenticated
25701 identifier; this is analogous to FTP anonymous authentication passing an
25702 email address, or software-identifier@, as the "password".
25703
25704
25705 An example showing the password having the realm specified in the callback
25706 and demonstrating a Cyrus SASL to GSASL migration approach is:
25707 .code
25708 gsasl_cyrusless_crammd5:
25709   driver = gsasl
25710   public_name = CRAM-MD5
25711   server_realm = imap.example.org
25712   server_password = ${lookup{$auth1:$auth3:userPassword}\
25713                     dbmjz{/etc/sasldb2}{$value}fail}
25714   server_set_id = ${quote:$auth1}
25715   server_condition = yes
25716 .endd
25717
25718
25719 . ////////////////////////////////////////////////////////////////////////////
25720 . ////////////////////////////////////////////////////////////////////////////
25721
25722 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25723 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25724 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25725 .cindex "authentication" "GSSAPI"
25726 .cindex "authentication" "Kerberos"
25727 The &(heimdal_gssapi)& authenticator provides server integration for the
25728 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25729 reliably.
25730
25731 .option server_hostname heimdal_gssapi string&!! "see below"
25732 This option selects the hostname that is used, with &%server_service%&,
25733 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25734 identifier.  The default value is &`$primary_hostname`&.
25735
25736 .option server_keytab heimdal_gssapi string&!! unset
25737 If set, then Heimdal will not use the system default keytab (typically
25738 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25739 The value should be a pathname, with no &"file:"& prefix.
25740
25741 .option server_service heimdal_gssapi string&!! "smtp"
25742 This option specifies the service identifier used, in conjunction with
25743 &%server_hostname%&, for building the identifer for finding credentials
25744 from the keytab.
25745
25746
25747 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25748 Beware that these variables will typically include a realm, thus will appear
25749 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25750 not verified, so a malicious client can set it to anything.
25751
25752 The &$auth1$& field should be safely trustable as a value from the Key
25753 Distribution Center.  Note that these are not quite email addresses.
25754 Each identifier is for a role, and so the left-hand-side may include a
25755 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25756
25757 .vindex "&$auth1$&, &$auth2$&, etc"
25758 .ilist
25759 .vindex "&$auth1$&"
25760 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25761 .next
25762 .vindex "&$auth2$&"
25763 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25764 authentication.  If that was empty, this will also be set to the
25765 GSS Display Name.
25766 .endlist
25767
25768
25769 . ////////////////////////////////////////////////////////////////////////////
25770 . ////////////////////////////////////////////////////////////////////////////
25771
25772 .chapter "The spa authenticator" "CHAPspa"
25773 .scindex IIDspaauth1 "&(spa)& authenticator"
25774 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25775 .cindex "authentication" "Microsoft Secure Password"
25776 .cindex "authentication" "NTLM"
25777 .cindex "Microsoft Secure Password Authentication"
25778 .cindex "NTLM authentication"
25779 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25780 Password Authentication'& mechanism,
25781 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25782 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25783 taken from the Samba project (&url(http://www.samba.org)). The code for the
25784 server side was subsequently contributed by Tom Kistner. The mechanism works as
25785 follows:
25786
25787 .ilist
25788 After the AUTH command has been accepted, the client sends an SPA
25789 authentication request based on the user name and optional domain.
25790 .next
25791 The server sends back a challenge.
25792 .next
25793 The client builds a challenge response which makes use of the user's password
25794 and sends it to the server, which then accepts or rejects it.
25795 .endlist
25796
25797 Encryption is used to protect the password in transit.
25798
25799
25800
25801 .section "Using spa as a server" "SECID179"
25802 .cindex "options" "&(spa)& authenticator (server)"
25803 The &(spa)& authenticator has just one server option:
25804
25805 .option server_password spa string&!! unset
25806 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25807 This option is expanded, and the result must be the cleartext password for the
25808 authenticating user, whose name is at this point in &$auth1$&. For
25809 compatibility with previous releases of Exim, the user name is also placed in
25810 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25811 it can lead to confusion in string expansions that also use numeric variables
25812 for other things. For example:
25813 .code
25814 spa:
25815   driver = spa
25816   public_name = NTLM
25817   server_password = \
25818     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25819 .endd
25820 If the expansion is forced to fail, authentication fails. Any other expansion
25821 failure causes a temporary error code to be returned.
25822
25823
25824
25825
25826
25827 .section "Using spa as a client" "SECID180"
25828 .cindex "options" "&(spa)& authenticator (client)"
25829 The &(spa)& authenticator has the following client options:
25830
25831
25832
25833 .option client_domain spa string&!! unset
25834 This option specifies an optional domain for the authentication.
25835
25836
25837 .option client_password spa string&!! unset
25838 This option specifies the user's password, and must be set.
25839
25840
25841 .option client_username spa string&!! unset
25842 This option specifies the user name, and must be set. Here is an example of a
25843 configuration of this authenticator for use with the mail servers at
25844 &'msn.com'&:
25845 .code
25846 msn:
25847   driver = spa
25848   public_name = MSN
25849   client_username = msn/msn_username
25850   client_password = msn_plaintext_password
25851   client_domain = DOMAIN_OR_UNSET
25852 .endd
25853 .ecindex IIDspaauth1
25854 .ecindex IIDspaauth2
25855
25856
25857
25858
25859
25860 . ////////////////////////////////////////////////////////////////////////////
25861 . ////////////////////////////////////////////////////////////////////////////
25862
25863 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25864          "Encrypted SMTP connections"
25865 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25866 .scindex IIDencsmtp2 "SMTP" "encryption"
25867 .cindex "TLS" "on SMTP connection"
25868 .cindex "OpenSSL"
25869 .cindex "GnuTLS"
25870 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25871 Sockets Layer), is implemented by making use of the OpenSSL library or the
25872 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25873 cryptographic code in the Exim distribution itself for implementing TLS. In
25874 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25875 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25876 You also need to understand the basic concepts of encryption at a managerial
25877 level, and in particular, the way that public keys, private keys, and
25878 certificates are used.
25879
25880 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25881 connection is established, the client issues a STARTTLS command. If the
25882 server accepts this, the client and the server negotiate an encryption
25883 mechanism. If the negotiation succeeds, the data that subsequently passes
25884 between them is encrypted.
25885
25886 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25887 and if so, what cipher suite is in use, whether the client supplied a
25888 certificate, and whether or not that certificate was verified. This makes it
25889 possible for an Exim server to deny or accept certain commands based on the
25890 encryption state.
25891
25892 &*Warning*&: Certain types of firewall and certain anti-virus products can
25893 disrupt TLS connections. You need to turn off SMTP scanning for these products
25894 in order to get TLS to work.
25895
25896
25897
25898 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25899          "SECID284"
25900 .cindex "ssmtp protocol"
25901 .cindex "smtps protocol"
25902 .cindex "SMTP" "ssmtp protocol"
25903 .cindex "SMTP" "smtps protocol"
25904 Early implementations of encrypted SMTP used a different TCP port from normal
25905 SMTP, and expected an encryption negotiation to start immediately, instead of
25906 waiting for a STARTTLS command from the client using the standard SMTP
25907 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25908 allocated for this purpose.
25909
25910 This approach was abandoned when encrypted SMTP was standardized, but there are
25911 still some legacy clients that use it. Exim supports these clients by means of
25912 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25913 numbers; the most common use is expected to be:
25914 .code
25915 tls_on_connect_ports = 465
25916 .endd
25917 The port numbers specified by this option apply to all SMTP connections, both
25918 via the daemon and via &'inetd'&. You still need to specify all the ports that
25919 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25920 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25921 an extra port &-- rather, it specifies different behaviour on a port that is
25922 defined elsewhere.
25923
25924 There is also a &%-tls-on-connect%& command line option. This overrides
25925 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25926
25927
25928
25929
25930
25931
25932 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25933 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25934 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25935 followed later, when the first versions of GnuTLS were released. To build Exim
25936 to use GnuTLS, you need to set
25937 .code
25938 USE_GNUTLS=yes
25939 .endd
25940 in Local/Makefile, in addition to
25941 .code
25942 SUPPORT_TLS=yes
25943 .endd
25944 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25945 include files and libraries for GnuTLS can be found.
25946
25947 There are some differences in usage when using GnuTLS instead of OpenSSL:
25948
25949 .ilist
25950 The &%tls_verify_certificates%& option must contain the name of a file, not the
25951 name of a directory for GnuTLS versions before 3.3.6
25952 (for later versions, or OpenSSL, it can be either).
25953 .next
25954 The default value for &%tls_dhparam%& differs for historical reasons.
25955 .next
25956 .vindex "&$tls_in_peerdn$&"
25957 .vindex "&$tls_out_peerdn$&"
25958 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25959 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25960 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25961 .next
25962 OpenSSL identifies cipher suites using hyphens as separators, for example:
25963 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25964 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25965 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25966 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25967 to handle its own older variants) when processing lists of cipher suites in the
25968 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25969 option).
25970 .next
25971 The &%tls_require_ciphers%& options operate differently, as described in the
25972 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25973 .next
25974 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25975 When using OpenSSL, this option is ignored.
25976 (If an API is found to let OpenSSL be configured in this way,
25977 let the Exim Maintainers know and we'll likely use it).
25978 .next
25979 Some other recently added features may only be available in one or the other.
25980 This should be documented with the feature.  If the documentation does not
25981 explicitly state that the feature is infeasible in the other TLS
25982 implementation, then patches are welcome.
25983 .endlist
25984
25985
25986 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25987 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25988 an explicit path; if the latter, then the text about generation still applies,
25989 but not the chosen filename.
25990 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25991 See the documentation of &%tls_dhparam%& for more information.
25992
25993 GnuTLS uses D-H parameters that may take a substantial amount of time
25994 to compute. It is unreasonable to re-compute them for every TLS session.
25995 Therefore, Exim keeps this data in a file in its spool directory, called
25996 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25997 of bits requested.
25998 The file is owned by the Exim user and is readable only by
25999 its owner. Every Exim process that start up GnuTLS reads the D-H
26000 parameters from this file. If the file does not exist, the first Exim process
26001 that needs it computes the data and writes it to a temporary file which is
26002 renamed once it is complete. It does not matter if several Exim processes do
26003 this simultaneously (apart from wasting a few resources). Once a file is in
26004 place, new Exim processes immediately start using it.
26005
26006 For maximum security, the parameters that are stored in this file should be
26007 recalculated periodically, the frequency depending on your paranoia level.
26008 If you are avoiding using the fixed D-H primes published in RFCs, then you
26009 are concerned about some advanced attacks and will wish to do this; if you do
26010 not regenerate then you might as well stick to the standard primes.
26011
26012 Arranging this is easy in principle; just delete the file when you want new
26013 values to be computed. However, there may be a problem. The calculation of new
26014 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26015 If the system is not very active, &_/dev/random_& may delay returning data
26016 until enough randomness (entropy) is available. This may cause Exim to hang for
26017 a substantial amount of time, causing timeouts on incoming connections.
26018
26019 The solution is to generate the parameters externally to Exim. They are stored
26020 in &_gnutls-params-N_& in PEM format, which means that they can be
26021 generated externally using the &(certtool)& command that is part of GnuTLS.
26022
26023 To replace the parameters with new ones, instead of deleting the file
26024 and letting Exim re-create it, you can generate new parameters using
26025 &(certtool)& and, when this has been done, replace Exim's cache file by
26026 renaming. The relevant commands are something like this:
26027 .code
26028 # ls
26029 [ look for file; assume gnutls-params-2236 is the most recent ]
26030 # rm -f new-params
26031 # touch new-params
26032 # chown exim:exim new-params
26033 # chmod 0600 new-params
26034 # certtool --generate-dh-params --bits 2236 >>new-params
26035 # openssl dhparam -noout -text -in new-params | head
26036 [ check the first line, make sure it's not more than 2236;
26037   if it is, then go back to the start ("rm") and repeat
26038   until the size generated is at most the size requested ]
26039 # chmod 0400 new-params
26040 # mv new-params gnutls-params-2236
26041 .endd
26042 If Exim never has to generate the parameters itself, the possibility of
26043 stalling is removed.
26044
26045 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26046 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26047 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26048 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26049 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26050 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26051 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26052 which applies to all D-H usage, client or server.  If the value returned by
26053 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26054 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26055 limit, which is still much higher than Exim historically used.
26056
26057 The filename and bits used will change as the GnuTLS maintainers change the
26058 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26059 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26060 2432 bits, while NSS is limited to 2236 bits.
26061
26062 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26063 increase the chance of the generated prime actually being within acceptable
26064 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26065 procedure above.  There is no sane procedure available to Exim to double-check
26066 the size of the generated prime, so it might still be too large.
26067
26068
26069 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26070 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26071 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26072 There is a function in the OpenSSL library that can be passed a list of cipher
26073 suites before the cipher negotiation takes place. This specifies which ciphers
26074 are acceptable. The list is colon separated and may contain names like
26075 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26076 directly to this function call.
26077 Many systems will install the OpenSSL manual-pages, so you may have
26078 &'ciphers(1)'& available to you.
26079 The following quotation from the OpenSSL
26080 documentation specifies what forms of item are allowed in the cipher string:
26081
26082 .ilist
26083 It can consist of a single cipher suite such as RC4-SHA.
26084 .next
26085 It can represent a list of cipher suites containing a certain algorithm,
26086 or cipher suites of a certain type. For example SHA1 represents all
26087 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26088 SSL v3 algorithms.
26089 .next
26090 Lists of cipher suites can be combined in a single cipher string using
26091 the + character. This is used as a logical and operation. For example
26092 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26093 algorithms.
26094 .endlist
26095
26096 Each cipher string can be optionally preceded by one of the characters &`!`&,
26097 &`-`& or &`+`&.
26098 .ilist
26099 If &`!`& is used, the ciphers are permanently deleted from the list. The
26100 ciphers deleted can never reappear in the list even if they are explicitly
26101 stated.
26102 .next
26103 If &`-`& is used, the ciphers are deleted from the list, but some or all
26104 of the ciphers can be added again by later options.
26105 .next
26106 If &`+`& is used, the ciphers are moved to the end of the list. This
26107 option does not add any new ciphers; it just moves matching existing ones.
26108 .endlist
26109
26110 If none of these characters is present, the string is interpreted as
26111 a list of ciphers to be appended to the current preference list. If the list
26112 includes any ciphers already present they will be ignored: that is, they will
26113 not be moved to the end of the list.
26114 .endlist
26115
26116 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26117 string:
26118 .code
26119 # note single-quotes to get ! past any shell history expansion
26120 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26121 .endd
26122
26123 This example will let the library defaults be permitted on the MX port, where
26124 there's probably no identity verification anyway, but ups the ante on the
26125 submission ports where the administrator might have some influence on the
26126 choice of clients used:
26127 .code
26128 # OpenSSL variant; see man ciphers(1)
26129 tls_require_ciphers = ${if =={$received_port}{25}\
26130                            {DEFAULT}\
26131                            {HIGH:!MD5:!SHA1}}
26132 .endd
26133
26134
26135
26136 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26137          "SECTreqciphgnu"
26138 .cindex "GnuTLS" "specifying parameters for"
26139 .cindex "TLS" "specifying ciphers (GnuTLS)"
26140 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26141 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26142 .cindex "TLS" "specifying protocols (GnuTLS)"
26143 .cindex "TLS" "specifying priority string (GnuTLS)"
26144 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26145 The GnuTLS library allows the caller to provide a "priority string", documented
26146 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26147 ciphersuite specification in OpenSSL.
26148
26149 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26150 and controls both protocols and ciphers.
26151
26152 The &%tls_require_ciphers%& option is available both as an global option,
26153 controlling how Exim behaves as a server, and also as an option of the
26154 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26155 the value is string expanded.  The resulting string is not an Exim list and
26156 the string is given to the GnuTLS library, so that Exim does not need to be
26157 aware of future feature enhancements of GnuTLS.
26158
26159 Documentation of the strings accepted may be found in the GnuTLS manual, under
26160 "Priority strings".  This is online as
26161 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26162 but beware that this relates to GnuTLS 3, which may be newer than the version
26163 installed on your system.  If you are using GnuTLS 3,
26164 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26165 on that site can be used to test a given string.
26166
26167 For example:
26168 .code
26169 # Disable older versions of protocols
26170 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26171 .endd
26172
26173 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26174 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26175 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26176
26177 This example will let the library defaults be permitted on the MX port, where
26178 there's probably no identity verification anyway, and lowers security further
26179 by increasing compatibility; but this ups the ante on the submission ports
26180 where the administrator might have some influence on the choice of clients
26181 used:
26182 .code
26183 # GnuTLS variant
26184 tls_require_ciphers = ${if =={$received_port}{25}\
26185                            {NORMAL:%COMPAT}\
26186                            {SECURE128}}
26187 .endd
26188
26189
26190 .section "Configuring an Exim server to use TLS" "SECID182"
26191 .cindex "TLS" "configuring an Exim server"
26192 When Exim has been built with TLS support, it advertises the availability of
26193 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26194 but not to any others. The default value of this option is unset, which means
26195 that STARTTLS is not advertised at all. This default is chosen because you
26196 need to set some other options in order to make TLS available, and also it is
26197 sensible for systems that want to use TLS only as a client.
26198
26199 If a client issues a STARTTLS command and there is some configuration
26200 problem in the server, the command is rejected with a 454 error. If the client
26201 persists in trying to issue SMTP commands, all except QUIT are rejected
26202 with the error
26203 .code
26204 554 Security failure
26205 .endd
26206 If a STARTTLS command is issued within an existing TLS session, it is
26207 rejected with a 554 error code.
26208
26209 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26210 match some hosts. You can, of course, set it to * to match all hosts.
26211 However, this is not all you need to do. TLS sessions to a server won't work
26212 without some further configuration at the server end.
26213
26214 It is rumoured that all existing clients that support TLS/SSL use RSA
26215 encryption. To make this work you need to set, in the server,
26216 .code
26217 tls_certificate = /some/file/name
26218 tls_privatekey = /some/file/name
26219 .endd
26220 These options are, in fact, expanded strings, so you can make them depend on
26221 the identity of the client that is connected if you wish. The first file
26222 contains the server's X509 certificate, and the second contains the private key
26223 that goes with it. These files need to be
26224 PEM format and readable by the Exim user, and must
26225 always be given as full path names.
26226 The key must not be password-protected.
26227 They can be the same file if both the
26228 certificate and the key are contained within it. If &%tls_privatekey%& is not
26229 set, or if its expansion is forced to fail or results in an empty string, this
26230 is assumed to be the case. The certificate file may also contain intermediate
26231 certificates that need to be sent to the client to enable it to authenticate
26232 the server's certificate.
26233
26234 If you do not understand about certificates and keys, please try to find a
26235 source of this background information, which is not Exim-specific. (There are a
26236 few comments below in section &<<SECTcerandall>>&.)
26237
26238 &*Note*&: These options do not apply when Exim is operating as a client &--
26239 they apply only in the case of a server. If you need to use a certificate in an
26240 Exim client, you must set the options of the same names in an &(smtp)&
26241 transport.
26242
26243 With just these options, an Exim server will be able to use TLS. It does not
26244 require the client to have a certificate (but see below for how to insist on
26245 this). There is one other option that may be needed in other situations. If
26246 .code
26247 tls_dhparam = /some/file/name
26248 .endd
26249 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26250 with the parameters contained in the file.
26251 Set this to &`none`& to disable use of DH entirely, by making no prime
26252 available:
26253 .code
26254 tls_dhparam = none
26255 .endd
26256 This may also be set to a string identifying a standard prime to be used for
26257 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26258 used is &`ike23`&.  There are a few standard primes available, see the
26259 documentation for &%tls_dhparam%& for the complete list.
26260
26261 See the command
26262 .code
26263 openssl dhparam
26264 .endd
26265 for a way of generating file data.
26266
26267 The strings supplied for these three options are expanded every time a client
26268 host connects. It is therefore possible to use different certificates and keys
26269 for different hosts, if you so wish, by making use of the client's IP address
26270 in &$sender_host_address$& to control the expansion. If a string expansion is
26271 forced to fail, Exim behaves as if the option is not set.
26272
26273 .cindex "cipher" "logging"
26274 .cindex "log" "TLS cipher"
26275 .vindex "&$tls_in_cipher$&"
26276 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26277 an incoming TLS connection. It is included in the &'Received:'& header of an
26278 incoming message (by default &-- you can, of course, change this), and it is
26279 also included in the log line that records a message's arrival, keyed by
26280 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26281 condition can be used to test for specific cipher suites in ACLs.
26282
26283 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26284 can check the name of the cipher suite and vary their actions accordingly. The
26285 cipher suite names vary, depending on which TLS library is being used. For
26286 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26287 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26288 documentation for more details.
26289
26290 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26291 (again depending on the &%tls_cipher%& log selector).
26292
26293
26294 .section "Requesting and verifying client certificates" "SECID183"
26295 .cindex "certificate" "verification of client"
26296 .cindex "TLS" "client certificate verification"
26297 If you want an Exim server to request a certificate when negotiating a TLS
26298 session with a client, you must set either &%tls_verify_hosts%& or
26299 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26300 apply to all TLS connections. For any host that matches one of these options,
26301 Exim requests a certificate as part of the setup of the TLS session. The
26302 contents of the certificate are verified by comparing it with a list of
26303 expected certificates. These must be available in a file or,
26304 for OpenSSL only (not GnuTLS), a directory, identified by
26305 &%tls_verify_certificates%&.
26306
26307 A file can contain multiple certificates, concatenated end to end. If a
26308 directory is used
26309 (OpenSSL only),
26310 each certificate must be in a separate file, with a name (or a symbolic link)
26311 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26312 certificate. You can compute the relevant hash by running the command
26313 .code
26314 openssl x509 -hash -noout -in /cert/file
26315 .endd
26316 where &_/cert/file_& contains a single certificate.
26317
26318 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26319 what happens if the client does not supply a certificate, or if the certificate
26320 does not match any of the certificates in the collection named by
26321 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26322 attempt to set up a TLS session is aborted, and the incoming connection is
26323 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26324 session continues. ACLs that run for subsequent SMTP commands can detect the
26325 fact that no certificate was verified, and vary their actions accordingly. For
26326 example, you can insist on a certificate before accepting a message for
26327 relaying, but not when the message is destined for local delivery.
26328
26329 .vindex "&$tls_in_peerdn$&"
26330 When a client supplies a certificate (whether it verifies or not), the value of
26331 the Distinguished Name of the certificate is made available in the variable
26332 &$tls_in_peerdn$& during subsequent processing of the message.
26333
26334 .cindex "log" "distinguished name"
26335 Because it is often a long text string, it is not included in the log line or
26336 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26337 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26338 &%received_header_text%& to change the &'Received:'& header. When no
26339 certificate is supplied, &$tls_in_peerdn$& is empty.
26340
26341
26342 .section "Revoked certificates" "SECID184"
26343 .cindex "TLS" "revoked certificates"
26344 .cindex "revocation list"
26345 .cindex "certificate" "revocation list"
26346 .cindex "OCSP" "stapling"
26347 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26348 certificates are revoked. If you have such a list, you can pass it to an Exim
26349 server using the global option called &%tls_crl%& and to an Exim client using
26350 an identically named option for the &(smtp)& transport. In each case, the value
26351 of the option is expanded and must then be the name of a file that contains a
26352 CRL in PEM format.
26353 The downside is that clients have to periodically re-download a potentially huge
26354 file from every certificate authority they know of.
26355
26356 The way with most moving parts at query time is Online Certificate
26357 Status Protocol (OCSP), where the client verifies the certificate
26358 against an OCSP server run by the CA.  This lets the CA track all
26359 usage of the certs.  It requires running software with access to the
26360 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26361 is based on HTTP and can be proxied accordingly.
26362
26363 The only widespread OCSP server implementation (known to this writer)
26364 comes as part of OpenSSL and aborts on an invalid request, such as
26365 connecting to the port and then disconnecting.  This requires
26366 re-entering the passphrase each time some random client does this.
26367
26368 The third way is OCSP Stapling; in this, the server using a certificate
26369 issued by the CA periodically requests an OCSP proof of validity from
26370 the OCSP server, then serves it up inline as part of the TLS
26371 negotiation.   This approach adds no extra round trips, does not let the
26372 CA track users, scales well with number of certs issued by the CA and is
26373 resilient to temporary OCSP server failures, as long as the server
26374 starts retrying to fetch an OCSP proof some time before its current
26375 proof expires.  The downside is that it requires server support.
26376
26377 Unless Exim is built with the support disabled,
26378 or with GnuTLS earlier than version 3.1.3,
26379 support for OCSP stapling is included.
26380
26381 There is a global option called &%tls_ocsp_file%&.
26382 The file specified therein is expected to be in DER format, and contain
26383 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26384 option will be re-expanded for SNI, if the &%tls_certificate%& option
26385 contains &`tls_in_sni`&, as per other TLS options.
26386
26387 Exim does not at this time implement any support for fetching a new OCSP
26388 proof.  The burden is on the administrator to handle this, outside of
26389 Exim.  The file specified should be replaced atomically, so that the
26390 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26391 on each connection, so a new file will be handled transparently on the
26392 next connection.
26393
26394 When built with OpenSSL Exim will check for a valid next update timestamp
26395 in the OCSP proof; if not present, or if the proof has expired, it will be
26396 ignored.
26397
26398 For the client to be able to verify the stapled OCSP the server must
26399 also supply, in its stapled information, any intermediate
26400 certificates for the chain leading to the OCSP proof from the signer
26401 of the server certificate.  There may be zero or one such. These
26402 intermediate certificates should be added to the server OCSP stapling
26403 file named by &%tls_ocsp_file%&.
26404
26405 Note that the proof only covers the terminal server certificate,
26406 not any of the chain from CA to it.
26407
26408 There is no current way to staple a proof for a client certificate.
26409
26410 .code
26411   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26412   OCSP server is supplied.  The server URL may be included in the
26413   server certificate, if the CA is helpful.
26414
26415   One failure mode seen was the OCSP Signer cert expiring before the end
26416   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26417   noted this as invalid overall, but the re-fetch script did not.
26418 .endd
26419
26420
26421
26422
26423 .section "Configuring an Exim client to use TLS" "SECID185"
26424 .cindex "cipher" "logging"
26425 .cindex "log" "TLS cipher"
26426 .cindex "log" "distinguished name"
26427 .cindex "TLS" "configuring an Exim client"
26428 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26429 deliveries as well as to incoming, the latter one causing logging of the
26430 server certificate's DN. The remaining client configuration for TLS is all
26431 within the &(smtp)& transport.
26432
26433 It is not necessary to set any options to have TLS work in the &(smtp)&
26434 transport. If Exim is built with TLS support, and TLS is advertised by a
26435 server, the &(smtp)& transport always tries to start a TLS session. However,
26436 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26437 transport) to a list of server hosts for which TLS should not be used.
26438
26439 If you do not want Exim to attempt to send messages unencrypted when an attempt
26440 to set up an encrypted connection fails in any way, you can set
26441 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26442 those hosts, delivery is always deferred if an encrypted connection cannot be
26443 set up. If there are any other hosts for the address, they are tried in the
26444 usual way.
26445
26446 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26447 the message unencrypted. It always does this if the response to STARTTLS is
26448 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26449 session after a success response code, what happens is controlled by the
26450 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26451 delivery to this host is deferred, and other hosts (if available) are tried. If
26452 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26453 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26454 negotiation fails, Exim closes the current connection (because it is in an
26455 unknown state), opens a new one to the same host, and then tries the delivery
26456 unencrypted.
26457
26458 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26459 transport provide the client with a certificate, which is passed to the server
26460 if it requests it. If the server is Exim, it will request a certificate only if
26461 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26462
26463 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26464 must name a file or,
26465 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
26466 expected server certificates. The client verifies the server's certificate
26467 against this collection, taking into account any revoked certificates that are
26468 in the list defined by &%tls_crl%&.
26469 Failure to verify fails the TLS connection unless either of the
26470 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26471
26472 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26473 certificate verification to the listed servers.  Verification either must
26474 or need not succeed respectively.
26475
26476 The &(smtp)& transport has two OCSP-related options:
26477 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26478 is requested and required for the connection to proceed.  The default
26479 value is empty.
26480 &%hosts_request_ocsp%&; a host-list for which (additionally)
26481 a Certificate Status is requested (but not necessarily verified).  The default
26482 value is "*" meaning that requests are made unless configured
26483 otherwise.
26484
26485 The host(s) should also be in &%hosts_require_tls%&, and
26486 &%tls_verify_certificates%& configured for the transport,
26487 for OCSP to be relevant.
26488
26489 If
26490 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26491 list of permitted cipher suites. If either of these checks fails, delivery to
26492 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26493 alternative hosts, if any.
26494
26495  &*Note*&:
26496 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26497 is operating as a client. Exim does not assume that a server certificate (set
26498 by the global options of the same name) should also be used when operating as a
26499 client.
26500
26501 .vindex "&$host$&"
26502 .vindex "&$host_address$&"
26503 All the TLS options in the &(smtp)& transport are expanded before use, with
26504 &$host$& and &$host_address$& containing the name and address of the server to
26505 which the client is connected. Forced failure of an expansion causes Exim to
26506 behave as if the relevant option were unset.
26507
26508 .vindex &$tls_out_bits$&
26509 .vindex &$tls_out_cipher$&
26510 .vindex &$tls_out_peerdn$&
26511 .vindex &$tls_out_sni$&
26512 Before an SMTP connection is established, the
26513 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26514 variables are emptied. (Until the first connection, they contain the values
26515 that were set when the message was received.) If STARTTLS is subsequently
26516 successfully obeyed, these variables are set to the relevant values for the
26517 outgoing connection.
26518
26519
26520
26521 .section "Use of TLS Server Name Indication" "SECTtlssni"
26522 .cindex "TLS" "Server Name Indication"
26523 .vindex "&$tls_in_sni$&"
26524 .oindex "&%tls_in_sni%&"
26525 With TLS1.0 or above, there is an extension mechanism by which extra
26526 information can be included at various points in the protocol.  One of these
26527 extensions, documented in RFC 6066 (and before that RFC 4366) is
26528 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26529 client in the initial handshake, so that the server can examine the servername
26530 within and possibly choose to use different certificates and keys (and more)
26531 for this session.
26532
26533 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26534 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26535 address.
26536
26537 With SMTP to MX, there are the same problems here as in choosing the identity
26538 against which to validate a certificate: you can't rely on insecure DNS to
26539 provide the identity which you then cryptographically verify.  So this will
26540 be of limited use in that environment.
26541
26542 With SMTP to Submission, there is a well-defined hostname which clients are
26543 connecting to and can validate certificates against.  Thus clients &*can*&
26544 choose to include this information in the TLS negotiation.  If this becomes
26545 wide-spread, then hosters can choose to present different certificates to
26546 different clients.  Or even negotiate different cipher suites.
26547
26548 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26549 if not empty, will be sent on a TLS session as part of the handshake.  There's
26550 nothing more to it.  Choosing a sensible value not derived insecurely is the
26551 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26552 for the lifetime of the client connection (including during authentication).
26553
26554 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26555 received from a client.
26556 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26557
26558 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26559 option (prior to expansion) then the following options will be re-expanded
26560 during TLS session handshake, to permit alternative values to be chosen:
26561
26562 .ilist
26563 .vindex "&%tls_certificate%&"
26564 &%tls_certificate%&
26565 .next
26566 .vindex "&%tls_crl%&"
26567 &%tls_crl%&
26568 .next
26569 .vindex "&%tls_privatekey%&"
26570 &%tls_privatekey%&
26571 .next
26572 .vindex "&%tls_verify_certificates%&"
26573 &%tls_verify_certificates%&
26574 .next
26575 .vindex "&%tls_ocsp_file%&"
26576 &%tls_ocsp_file%&
26577 .endlist
26578
26579 Great care should be taken to deal with matters of case, various injection
26580 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26581 can always be referenced; it is important to remember that &$tls_sni$& is
26582 arbitrary unverified data provided prior to authentication.
26583
26584 The Exim developers are proceeding cautiously and so far no other TLS options
26585 are re-expanded.
26586
26587 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26588 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26589 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26590 see &`-servername`& in the output, then OpenSSL has support.
26591
26592 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26593 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26594 built, then you have SNI support).
26595
26596
26597
26598 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26599          "SECTmulmessam"
26600 .cindex "multiple SMTP deliveries with TLS"
26601 .cindex "TLS" "multiple message deliveries"
26602 Exim sends multiple messages down the same TCP/IP connection by starting up
26603 an entirely new delivery process for each message, passing the socket from
26604 one process to the next. This implementation does not fit well with the use
26605 of TLS, because there is quite a lot of state information associated with a TLS
26606 connection, not just a socket identification. Passing all the state information
26607 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26608 session before passing the socket to a new process. The new process may then
26609 try to start a new TLS session, and if successful, may try to re-authenticate
26610 if AUTH is in use, before sending the next message.
26611
26612 The RFC is not clear as to whether or not an SMTP session continues in clear
26613 after TLS has been shut down, or whether TLS may be restarted again later, as
26614 just described. However, if the server is Exim, this shutdown and
26615 reinitialization works. It is not known which (if any) other servers operate
26616 successfully if the client closes a TLS session and continues with unencrypted
26617 SMTP, but there are certainly some that do not work. For such servers, Exim
26618 should not pass the socket to another process, because the failure of the
26619 subsequent attempt to use it would cause Exim to record a temporary host error,
26620 and delay other deliveries to that host.
26621
26622 To test for this case, Exim sends an EHLO command to the server after
26623 closing down the TLS session. If this fails in any way, the connection is
26624 closed instead of being passed to a new delivery process, but no retry
26625 information is recorded.
26626
26627 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26628 &(smtp)& transport to match those hosts for which Exim should not pass
26629 connections to new processes if TLS has been used.
26630
26631
26632
26633
26634 .section "Certificates and all that" "SECTcerandall"
26635 .cindex "certificate" "references to discussion"
26636 In order to understand fully how TLS works, you need to know about
26637 certificates, certificate signing, and certificate authorities. This is not the
26638 place to give a tutorial, especially as I do not know very much about it
26639 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26640 to Apache, currently at
26641 .display
26642 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26643 .endd
26644 Other parts of the &'modssl'& documentation are also helpful, and have
26645 links to further files.
26646 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26647 0-201-61598-3), contains both introductory and more in-depth descriptions.
26648 Some sample programs taken from the book are available from
26649 .display
26650 &url(http://www.rtfm.com/openssl-examples/)
26651 .endd
26652
26653
26654 .section "Certificate chains" "SECID186"
26655 The file named by &%tls_certificate%& may contain more than one
26656 certificate. This is useful in the case where the certificate that is being
26657 sent is validated by an intermediate certificate which the other end does
26658 not have. Multiple certificates must be in the correct order in the file.
26659 First the host's certificate itself, then the first intermediate
26660 certificate to validate the issuer of the host certificate, then the next
26661 intermediate certificate to validate the issuer of the first intermediate
26662 certificate, and so on, until finally (optionally) the root certificate.
26663 The root certificate must already be trusted by the recipient for
26664 validation to succeed, of course, but if it's not preinstalled, sending the
26665 root certificate along with the rest makes it available for the user to
26666 install if the receiving end is a client MUA that can interact with a user.
26667
26668 Note that certificates using MD5 are unlikely to work on today's Internet;
26669 even if your libraries allow loading them for use in Exim when acting as a
26670 server, increasingly clients will not accept such certificates.  The error
26671 diagnostics in such a case can be frustratingly vague.
26672
26673
26674
26675 .section "Self-signed certificates" "SECID187"
26676 .cindex "certificate" "self-signed"
26677 You can create a self-signed certificate using the &'req'& command provided
26678 with OpenSSL, like this:
26679 . ==== Do not shorten the duration here without reading and considering
26680 . ==== the text below.  Please leave it at 9999 days.
26681 .code
26682 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26683             -days 9999 -nodes
26684 .endd
26685 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26686 delimited and so can be identified independently. The &%-days%& option
26687 specifies a period for which the certificate is valid. The &%-nodes%& option is
26688 important: if you do not set it, the key is encrypted with a passphrase
26689 that you are prompted for, and any use that is made of the key causes more
26690 prompting for the passphrase. This is not helpful if you are going to use
26691 this certificate and key in an MTA, where prompting is not possible.
26692
26693 . ==== I expect to still be working 26 years from now.  The less technical
26694 . ==== debt I create, in terms of storing up trouble for my later years, the
26695 . ==== happier I will be then.  We really have reached the point where we
26696 . ==== should start, at the very least, provoking thought and making folks
26697 . ==== pause before proceeding, instead of leaving all the fixes until two
26698 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26699 . ==== -pdp, 2012
26700 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26701 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26702 the above command might produce a date in the past.  Think carefully about
26703 the lifetime of the systems you're deploying, and either reduce the duration
26704 of the certificate or reconsider your platform deployment.  (At time of
26705 writing, reducing the duration is the most likely choice, but the inexorable
26706 progression of time takes us steadily towards an era where this will not
26707 be a sensible resolution).
26708
26709 A self-signed certificate made in this way is sufficient for testing, and
26710 may be adequate for all your requirements if you are mainly interested in
26711 encrypting transfers, and not in secure identification.
26712
26713 However, many clients require that the certificate presented by the server be a
26714 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26715 certificate. In this situation, the self-signed certificate described above
26716 must be installed on the client host as a trusted root &'certification
26717 authority'& (CA), and the certificate used by Exim must be a user certificate
26718 signed with that self-signed certificate.
26719
26720 For information on creating self-signed CA certificates and using them to sign
26721 user certificates, see the &'General implementation overview'& chapter of the
26722 Open-source PKI book, available online at
26723 &url(http://ospkibook.sourceforge.net/).
26724 .ecindex IIDencsmtp1
26725 .ecindex IIDencsmtp2
26726
26727
26728
26729 . ////////////////////////////////////////////////////////////////////////////
26730 . ////////////////////////////////////////////////////////////////////////////
26731
26732 .chapter "Access control lists" "CHAPACL"
26733 .scindex IIDacl "&ACL;" "description"
26734 .cindex "control of incoming mail"
26735 .cindex "message" "controlling incoming"
26736 .cindex "policy control" "access control lists"
26737 Access Control Lists (ACLs) are defined in a separate section of the run time
26738 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26739 name, terminated by a colon. Here is a complete ACL section that contains just
26740 one very small ACL:
26741 .code
26742 begin acl
26743 small_acl:
26744   accept   hosts = one.host.only
26745 .endd
26746 You can have as many lists as you like in the ACL section, and the order in
26747 which they appear does not matter. The lists are self-terminating.
26748
26749 The majority of ACLs are used to control Exim's behaviour when it receives
26750 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26751 when a local process submits a message using SMTP by specifying the &%-bs%&
26752 option. The most common use is for controlling which recipients are accepted
26753 in incoming messages. In addition, you can define an ACL that is used to check
26754 local non-SMTP messages. The default configuration file contains an example of
26755 a realistic ACL for checking RCPT commands. This is discussed in chapter
26756 &<<CHAPdefconfil>>&.
26757
26758
26759 .section "Testing ACLs" "SECID188"
26760 The &%-bh%& command line option provides a way of testing your ACL
26761 configuration locally by running a fake SMTP session with which you interact.
26762 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26763 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26764
26765
26766
26767 .section "Specifying when ACLs are used" "SECID189"
26768 .cindex "&ACL;" "options for specifying"
26769 In order to cause an ACL to be used, you have to name it in one of the relevant
26770 options in the main part of the configuration. These options are:
26771 .cindex "AUTH" "ACL for"
26772 .cindex "DATA" "ACLs for"
26773 .cindex "ETRN" "ACL for"
26774 .cindex "EXPN" "ACL for"
26775 .cindex "HELO" "ACL for"
26776 .cindex "EHLO" "ACL for"
26777 .cindex "MAIL" "ACL for"
26778 .cindex "QUIT, ACL for"
26779 .cindex "RCPT" "ACL for"
26780 .cindex "STARTTLS, ACL for"
26781 .cindex "VRFY" "ACL for"
26782 .cindex "SMTP" "connection, ACL for"
26783 .cindex "non-SMTP messages" "ACLs for"
26784 .cindex "MIME content scanning" "ACL for"
26785 .cindex "PRDR" "ACL for"
26786
26787 .table2 140pt
26788 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26789 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26790 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26791 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26792 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26793 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26794 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26795 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26796 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26797 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26798 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26799 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26800 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26801 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26802 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26803 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26804 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26805 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26806 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26807 .endtable
26808
26809 For example, if you set
26810 .code
26811 acl_smtp_rcpt = small_acl
26812 .endd
26813 the little ACL defined above is used whenever Exim receives a RCPT command
26814 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26815 done when RCPT commands arrive. A rejection of RCPT should cause the
26816 sending MTA to give up on the recipient address contained in the RCPT
26817 command, whereas rejection at other times may cause the client MTA to keep on
26818 trying to deliver the message. It is therefore recommended that you do as much
26819 testing as possible at RCPT time.
26820
26821
26822 .section "The non-SMTP ACLs" "SECID190"
26823 .cindex "non-SMTP messages" "ACLs for"
26824 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26825 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26826 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26827 the state of the SMTP connection such as encryption and authentication) are not
26828 relevant and are forbidden in these ACLs. However, the sender and recipients
26829 are known, so the &%senders%& and &%sender_domains%& conditions and the
26830 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26831 &$authenticated_sender$& are also available. You can specify added header lines
26832 in any of these ACLs.
26833
26834 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26835 non-SMTP message, before any of the message has been read. (This is the
26836 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26837 batched SMTP input, it runs after the DATA command has been reached. The
26838 result of this ACL is ignored; it cannot be used to reject a message. If you
26839 really need to, you could set a value in an ACL variable here and reject based
26840 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26841 controls, and in particular, it can be used to set
26842 .code
26843 control = suppress_local_fixups
26844 .endd
26845 This cannot be used in the other non-SMTP ACLs because by the time they are
26846 run, it is too late.
26847
26848 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26849 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26850
26851 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26852 kind of rejection is treated as permanent, because there is no way of sending a
26853 temporary error for these kinds of message.
26854
26855
26856 .section "The SMTP connect ACL" "SECID191"
26857 .cindex "SMTP" "connection, ACL for"
26858 .oindex &%smtp_banner%&
26859 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26860 session, after the test specified by &%host_reject_connection%& (which is now
26861 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26862 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26863 the message override the banner message that is otherwise specified by the
26864 &%smtp_banner%& option.
26865
26866
26867 .section "The EHLO/HELO ACL" "SECID192"
26868 .cindex "EHLO" "ACL for"
26869 .cindex "HELO" "ACL for"
26870 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26871 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26872 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26873 Note that a client may issue more than one EHLO or HELO command in an SMTP
26874 session, and indeed is required to issue a new EHLO or HELO after successfully
26875 setting up encryption following a STARTTLS command.
26876
26877 If the command is accepted by an &%accept%& verb that has a &%message%&
26878 modifier, the message may not contain more than one line (it will be truncated
26879 at the first newline and a panic logged if it does). Such a message cannot
26880 affect the EHLO options that are listed on the second and subsequent lines of
26881 an EHLO response.
26882
26883
26884 .section "The DATA ACLs" "SECID193"
26885 .cindex "DATA" "ACLs for"
26886 Two ACLs are associated with the DATA command, because it is two-stage
26887 command, with two responses being sent to the client.
26888 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26889 is obeyed. This gives you control after all the RCPT commands, but before
26890 the message itself is received. It offers the opportunity to give a negative
26891 response to the DATA command before the data is transmitted. Header lines
26892 added by MAIL or RCPT ACLs are not visible at this time, but any that
26893 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26894
26895 You cannot test the contents of the message, for example, to verify addresses
26896 in the headers, at RCPT time or when the DATA command is received. Such
26897 tests have to appear in the ACL that is run after the message itself has been
26898 received, before the final response to the DATA command is sent. This is
26899 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26900 associated with the DATA command.
26901
26902 For both of these ACLs, it is not possible to reject individual recipients. An
26903 error response rejects the entire message. Unfortunately, it is known that some
26904 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26905 before or after the data) correctly &-- they keep the message on their queues
26906 and try again later, but that is their problem, though it does waste some of
26907 your resources.
26908
26909 The &%acl_smtp_data%& ACL is run after
26910 the &%acl_smtp_data_prdr%&,
26911 the &%acl_smtp_dkim%&
26912 and the &%acl_smtp_mime%& ACLs.
26913
26914 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26915 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26916 enabled (which is the default).
26917
26918 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26919 received, and is executed for each DKIM signature found in a message.  If not
26920 otherwise specified, the default action is to accept.
26921
26922 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26923
26924 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26925
26926
26927 .section "The SMTP MIME ACL" "SECID194"
26928 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26929 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26930
26931 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26932
26933
26934 .section "The SMTP PRDR ACL" "SECTPRDRACL"
26935 .oindex "&%prdr_enable%&"
26936 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
26937 with PRDR support enabled (which is the default).
26938 It becomes active only when the PRDR feature is negotiated between
26939 client and server for a message, and more than one recipient
26940 has been accepted.
26941
26942 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
26943 has been recieved, and is executed for each recipient of the message.
26944 The test may accept or deny for inividual recipients.
26945 The &%acl_smtp_data%& will still be called after this ACL and
26946 can reject the message overall, even if this ACL has accepted it
26947 for some or all recipients.
26948
26949 PRDR may be used to support per-user content filtering.  Without it
26950 one must defer any recipient after the first that has a different
26951 content-filter configuration.  With PRDR, the RCPT-time check
26952 for this can be disabled when the MAIL-time $smtp_command included
26953 "PRDR".  Any required difference in behaviour of the main DATA-time
26954 ACL should however depend on the PRDR-time ACL having run, as Exim
26955 will avoid doing so in some situations (eg.  single-recipient mails).
26956
26957 See also the &%prdr_enable%& global option
26958 and the &%hosts_try_prdr%& smtp transport option.
26959
26960 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26961 If the ACL is not defined, processing completes as if
26962 the feature was not requested by the client.
26963
26964 .section "The QUIT ACL" "SECTQUITACL"
26965 .cindex "QUIT, ACL for"
26966 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26967 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26968 does not in fact control any access. For this reason, the only verbs that are
26969 permitted are &%accept%& and &%warn%&.
26970
26971 This ACL can be used for tasks such as custom logging at the end of an SMTP
26972 session. For example, you can use ACL variables in other ACLs to count
26973 messages, recipients, etc., and log the totals at QUIT time using one or
26974 more &%logwrite%& modifiers on a &%warn%& verb.
26975
26976 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26977 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26978
26979 You do not need to have a final &%accept%&, but if you do, you can use a
26980 &%message%& modifier to specify custom text that is sent as part of the 221
26981 response to QUIT.
26982
26983 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26984 failure (for example, failure to open a log file, or when Exim is bombing out
26985 because it has detected an unrecoverable error), all SMTP commands from the
26986 client are given temporary error responses until QUIT is received or the
26987 connection is closed. In these special cases, the QUIT ACL does not run.
26988
26989
26990 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26991 .vindex &$acl_smtp_notquit$&
26992 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26993 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26994 trouble, such as being unable to write to its log files, this ACL is not run,
26995 because it might try to do things (such as write to log files) that make the
26996 situation even worse.
26997
26998 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26999 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27000 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27001 and &%warn%&.
27002
27003 .vindex &$smtp_notquit_reason$&
27004 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27005 to a string that indicates the reason for the termination of the SMTP
27006 connection. The possible values are:
27007 .table2
27008 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27009 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27010 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27011 .irow &`connection-lost`&          "The SMTP connection has been lost"
27012 .irow &`data-timeout`&             "Timeout while reading message data"
27013 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27014 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27015 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27016 .irow &`synchronization-error`&    "SMTP synchronization error"
27017 .irow &`tls-failed`&               "TLS failed to start"
27018 .endtable
27019 In most cases when an SMTP connection is closed without having received QUIT,
27020 Exim sends an SMTP response message before actually closing the connection.
27021 With the exception of the &`acl-drop`& case, the default message can be
27022 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27023 &%drop%& verb in another ACL, it is the message from the other ACL that is
27024 used.
27025
27026
27027 .section "Finding an ACL to use" "SECID195"
27028 .cindex "&ACL;" "finding which to use"
27029 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27030 you can use different ACLs in different circumstances. For example,
27031 .code
27032 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27033                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27034 .endd
27035 In the default configuration file there are some example settings for
27036 providing an RFC 4409 message submission service on port 587 and a
27037 non-standard &"smtps"& service on port 465. You can use a string
27038 expansion like this to choose an ACL for MUAs on these ports which is
27039 more appropriate for this purpose than the default ACL on port 25.
27040
27041 The expanded string does not have to be the name of an ACL in the
27042 configuration file; there are other possibilities. Having expanded the
27043 string, Exim searches for an ACL as follows:
27044
27045 .ilist
27046 If the string begins with a slash, Exim uses it as a file name, and reads its
27047 contents as an ACL. The lines are processed in the same way as lines in the
27048 Exim configuration file. In particular, continuation lines are supported, blank
27049 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27050 If the file does not exist or cannot be read, an error occurs (typically
27051 causing a temporary failure of whatever caused the ACL to be run). For example:
27052 .code
27053 acl_smtp_data = /etc/acls/\
27054   ${lookup{$sender_host_address}lsearch\
27055   {/etc/acllist}{$value}{default}}
27056 .endd
27057 This looks up an ACL file to use on the basis of the host's IP address, falling
27058 back to a default if the lookup fails. If an ACL is successfully read from a
27059 file, it is retained in memory for the duration of the Exim process, so that it
27060 can be re-used without having to re-read the file.
27061 .next
27062 If the string does not start with a slash, and does not contain any spaces,
27063 Exim searches the ACL section of the configuration for an ACL whose name
27064 matches the string.
27065 .next
27066 If no named ACL is found, or if the string contains spaces, Exim parses
27067 the string as an inline ACL. This can save typing in cases where you just
27068 want to have something like
27069 .code
27070 acl_smtp_vrfy = accept
27071 .endd
27072 in order to allow free use of the VRFY command. Such a string may contain
27073 newlines; it is processed in the same way as an ACL that is read from a file.
27074 .endlist
27075
27076
27077
27078
27079 .section "ACL return codes" "SECID196"
27080 .cindex "&ACL;" "return codes"
27081 Except for the QUIT ACL, which does not affect the SMTP return code (see
27082 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27083 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27084 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27085 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27086 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27087 This also causes a 4&'xx'& return code.
27088
27089 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27090 &"deny"&, because there is no mechanism for passing temporary errors to the
27091 submitters of non-SMTP messages.
27092
27093
27094 ACLs that are relevant to message reception may also return &"discard"&. This
27095 has the effect of &"accept"&, but causes either the entire message or an
27096 individual recipient address to be discarded. In other words, it is a
27097 blackholing facility. Use it with care.
27098
27099 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27100 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27101 RCPT ACL is to discard just the one recipient address. If there are no
27102 recipients left when the message's data is received, the DATA ACL is not
27103 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27104 remaining recipients. The &"discard"& return is not permitted for the
27105 &%acl_smtp_predata%& ACL.
27106
27107
27108 .cindex "&[local_scan()]& function" "when all recipients discarded"
27109 The &[local_scan()]& function is always run, even if there are no remaining
27110 recipients; it may create new recipients.
27111
27112
27113
27114 .section "Unset ACL options" "SECID197"
27115 .cindex "&ACL;" "unset options"
27116 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27117 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27118 not defined at all. For any defined ACL, the default action when control
27119 reaches the end of the ACL statements is &"deny"&.
27120
27121 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27122 these two are ACLs that are used only for their side effects. They cannot be
27123 used to accept or reject anything.
27124
27125 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27126 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27127 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27128 when the ACL is not defined is &"accept"&.
27129
27130 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27131 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27132 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27133 messages over an SMTP connection. For an example, see the ACL in the default
27134 configuration file.
27135
27136
27137
27138
27139 .section "Data for message ACLs" "SECID198"
27140 .cindex "&ACL;" "data for message ACL"
27141 .vindex &$domain$&
27142 .vindex &$local_part$&
27143 .vindex &$sender_address$&
27144 .vindex &$sender_host_address$&
27145 .vindex &$smtp_command$&
27146 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27147 that contain information about the host and the message's sender (for example,
27148 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27149 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27150 &$local_part$& are set from the argument address. The entire SMTP command
27151 is available in &$smtp_command$&.
27152
27153 When an ACL for the AUTH parameter of MAIL is running, the variables that
27154 contain information about the host are set, but &$sender_address$& is not yet
27155 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27156 how it is used.
27157
27158 .vindex "&$message_size$&"
27159 The &$message_size$& variable is set to the value of the SIZE parameter on
27160 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27161 that parameter is not given. The value is updated to the true message size by
27162 the time the final DATA ACL is run (after the message data has been
27163 received).
27164
27165 .vindex "&$rcpt_count$&"
27166 .vindex "&$recipients_count$&"
27167 The &$rcpt_count$& variable increases by one for each RCPT command received.
27168 The &$recipients_count$& variable increases by one each time a RCPT command is
27169 accepted, so while an ACL for RCPT is being processed, it contains the number
27170 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27171 &$rcpt_count$& contains the total number of RCPT commands, and
27172 &$recipients_count$& contains the total number of accepted recipients.
27173
27174
27175
27176
27177
27178 .section "Data for non-message ACLs" "SECTdatfornon"
27179 .cindex "&ACL;" "data for non-message ACL"
27180 .vindex &$smtp_command_argument$&
27181 .vindex &$smtp_command$&
27182 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27183 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27184 and the entire SMTP command is available in &$smtp_command$&.
27185 These variables can be tested using a &%condition%& condition. For example,
27186 here is an ACL for use with AUTH, which insists that either the session is
27187 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27188 does not permit authentication methods that use cleartext passwords on
27189 unencrypted connections.
27190 .code
27191 acl_check_auth:
27192   accept encrypted = *
27193   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27194                      {CRAM-MD5}}
27195   deny   message   = TLS encryption or CRAM-MD5 required
27196 .endd
27197 (Another way of applying this restriction is to arrange for the authenticators
27198 that use cleartext passwords not to be advertised when the connection is not
27199 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27200 option to do this.)
27201
27202
27203
27204 .section "Format of an ACL" "SECID199"
27205 .cindex "&ACL;" "format of"
27206 .cindex "&ACL;" "verbs, definition of"
27207 An individual ACL consists of a number of statements. Each statement starts
27208 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27209 Modifiers can change the way the verb operates, define error and log messages,
27210 set variables, insert delays, and vary the processing of accepted messages.
27211
27212 If all the conditions are met, the verb is obeyed. The same condition may be
27213 used (with different arguments) more than once in the same statement. This
27214 provides a means of specifying an &"and"& conjunction between conditions. For
27215 example:
27216 .code
27217 deny  dnslists = list1.example
27218 dnslists = list2.example
27219 .endd
27220 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27221 the conditions and modifiers when it reaches a condition that fails. What
27222 happens then depends on the verb (and in one case, on a special modifier). Not
27223 all the conditions make sense at every testing point. For example, you cannot
27224 test a sender address in the ACL that is run for a VRFY command.
27225
27226
27227 .section "ACL verbs" "SECID200"
27228 The ACL verbs are as follows:
27229
27230 .ilist
27231 .cindex "&%accept%& ACL verb"
27232 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27233 of the conditions are not met, what happens depends on whether &%endpass%&
27234 appears among the conditions (for syntax see below). If the failing condition
27235 is before &%endpass%&, control is passed to the next ACL statement; if it is
27236 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27237 check a RCPT command:
27238 .code
27239 accept domains = +local_domains
27240 endpass
27241 verify = recipient
27242 .endd
27243 If the recipient domain does not match the &%domains%& condition, control
27244 passes to the next statement. If it does match, the recipient is verified, and
27245 the command is accepted if verification succeeds. However, if verification
27246 fails, the ACL yields &"deny"&, because the failing condition is after
27247 &%endpass%&.
27248
27249 The &%endpass%& feature has turned out to be confusing to many people, so its
27250 use is not recommended nowadays. It is always possible to rewrite an ACL so
27251 that &%endpass%& is not needed, and it is no longer used in the default
27252 configuration.
27253
27254 .cindex "&%message%& ACL modifier" "with &%accept%&"
27255 If a &%message%& modifier appears on an &%accept%& statement, its action
27256 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27257 (when an &%accept%& verb either accepts or passes control to the next
27258 statement), &%message%& can be used to vary the message that is sent when an
27259 SMTP command is accepted. For example, in a RCPT ACL you could have:
27260 .display
27261 &`accept  `&<&'some conditions'&>
27262 &`        message = OK, I will allow you through today`&
27263 .endd
27264 You can specify an SMTP response code, optionally followed by an &"extended
27265 response code"& at the start of the message, but the first digit must be the
27266 same as would be sent by default, which is 2 for an &%accept%& verb.
27267
27268 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27269 an error message that is used when access is denied. This behaviour is retained
27270 for backward compatibility, but current &"best practice"& is to avoid the use
27271 of &%endpass%&.
27272
27273
27274 .next
27275 .cindex "&%defer%& ACL verb"
27276 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27277 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27278 &%defer%& is the same as &%deny%&, because there is no way of sending a
27279 temporary error. For a RCPT command, &%defer%& is much the same as using a
27280 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27281 be used in any ACL, and even for a recipient it might be a simpler approach.
27282
27283
27284 .next
27285 .cindex "&%deny%& ACL verb"
27286 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27287 the conditions are not met, control is passed to the next ACL statement. For
27288 example,
27289 .code
27290 deny dnslists = blackholes.mail-abuse.org
27291 .endd
27292 rejects commands from hosts that are on a DNS black list.
27293
27294
27295 .next
27296 .cindex "&%discard%& ACL verb"
27297 &%discard%&: This verb behaves like &%accept%&, except that it returns
27298 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27299 that are concerned with receiving messages. When all the conditions are true,
27300 the sending entity receives a &"success"& response. However, &%discard%& causes
27301 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27302 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27303 message's recipients are discarded. Recipients that are discarded before DATA
27304 do not appear in the log line when the &%received_recipients%& log selector is set.
27305
27306 If the &%log_message%& modifier is set when &%discard%& operates,
27307 its contents are added to the line that is automatically written to the log.
27308 The &%message%& modifier operates exactly as it does for &%accept%&.
27309
27310
27311 .next
27312 .cindex "&%drop%& ACL verb"
27313 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27314 forcibly closed after the 5&'xx'& error message has been sent. For example:
27315 .code
27316 drop   message   = I don't take more than 20 RCPTs
27317        condition = ${if > {$rcpt_count}{20}}
27318 .endd
27319 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27320 The connection is always dropped after sending a 550 response.
27321
27322 .next
27323 .cindex "&%require%& ACL verb"
27324 &%require%&: If all the conditions are met, control is passed to the next ACL
27325 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27326 example, when checking a RCPT command,
27327 .code
27328 require message = Sender did not verify
27329         verify  = sender
27330 .endd
27331 passes control to subsequent statements only if the message's sender can be
27332 verified. Otherwise, it rejects the command. Note the positioning of the
27333 &%message%& modifier, before the &%verify%& condition. The reason for this is
27334 discussed in section &<<SECTcondmodproc>>&.
27335
27336 .next
27337 .cindex "&%warn%& ACL verb"
27338 &%warn%&: If all the conditions are true, a line specified by the
27339 &%log_message%& modifier is written to Exim's main log. Control always passes
27340 to the next ACL statement. If any condition is false, the log line is not
27341 written. If an identical log line is requested several times in the same
27342 message, only one copy is actually written to the log. If you want to force
27343 duplicates to be written, use the &%logwrite%& modifier instead.
27344
27345 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27346 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27347 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27348 first failing condition. There is more about adding header lines in section
27349 &<<SECTaddheadacl>>&.
27350
27351 If any condition on a &%warn%& statement cannot be completed (that is, there is
27352 some sort of defer), the log line specified by &%log_message%& is not written.
27353 This does not include the case of a forced failure from a lookup, which
27354 is considered to be a successful completion. After a defer, no further
27355 conditions or modifiers in the &%warn%& statement are processed. The incident
27356 is logged, and the ACL continues to be processed, from the next statement
27357 onwards.
27358
27359
27360 .vindex "&$acl_verify_message$&"
27361 When one of the &%warn%& conditions is an address verification that fails, the
27362 text of the verification failure message is in &$acl_verify_message$&. If you
27363 want this logged, you must set it up explicitly. For example:
27364 .code
27365 warn   !verify = sender
27366        log_message = sender verify failed: $acl_verify_message
27367 .endd
27368 .endlist
27369
27370 At the end of each ACL there is an implicit unconditional &%deny%&.
27371
27372 As you can see from the examples above, the conditions and modifiers are
27373 written one to a line, with the first one on the same line as the verb, and
27374 subsequent ones on following lines. If you have a very long condition, you can
27375 continue it onto several physical lines by the usual backslash continuation
27376 mechanism. It is conventional to align the conditions vertically.
27377
27378
27379
27380 .section "ACL variables" "SECTaclvariables"
27381 .cindex "&ACL;" "variables"
27382 There are some special variables that can be set during ACL processing. They
27383 can be used to pass information between different ACLs, different invocations
27384 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27385 transports, and filters that are used to deliver a message. The names of these
27386 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27387 an underscore, but the remainder of the name can be any sequence of
27388 alphanumeric characters and underscores that you choose. There is no limit on
27389 the number of ACL variables. The two sets act as follows:
27390 .ilist
27391 The values of those variables whose names begin with &$acl_c$& persist
27392 throughout an SMTP connection. They are never reset. Thus, a value that is set
27393 while receiving one message is still available when receiving the next message
27394 on the same SMTP connection.
27395 .next
27396 The values of those variables whose names begin with &$acl_m$& persist only
27397 while a message is being received. They are reset afterwards. They are also
27398 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27399 .endlist
27400
27401 When a message is accepted, the current values of all the ACL variables are
27402 preserved with the message and are subsequently made available at delivery
27403 time. The ACL variables are set by a modifier called &%set%&. For example:
27404 .code
27405 accept hosts = whatever
27406        set acl_m4 = some value
27407 accept authenticated = *
27408        set acl_c_auth = yes
27409 .endd
27410 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27411 be set. If you want to set a variable without taking any action, you can use a
27412 &%warn%& verb without any other modifiers or conditions.
27413
27414 .oindex &%strict_acl_vars%&
27415 What happens if a syntactically valid but undefined ACL variable is
27416 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27417 false (the default), an empty string is substituted; if it is true, an
27418 error is generated.
27419
27420 Versions of Exim before 4.64 have a limited set of numbered variables, but
27421 their names are compatible, so there is no problem with upgrading.
27422
27423
27424 .section "Condition and modifier processing" "SECTcondmodproc"
27425 .cindex "&ACL;" "conditions; processing"
27426 .cindex "&ACL;" "modifiers; processing"
27427 An exclamation mark preceding a condition negates its result. For example:
27428 .code
27429 deny   domains = *.dom.example
27430       !verify  = recipient
27431 .endd
27432 causes the ACL to return &"deny"& if the recipient domain ends in
27433 &'dom.example'& and the recipient address cannot be verified. Sometimes
27434 negation can be used on the right-hand side of a condition. For example, these
27435 two statements are equivalent:
27436 .code
27437 deny  hosts = !192.168.3.4
27438 deny !hosts =  192.168.3.4
27439 .endd
27440 However, for many conditions (&%verify%& being a good example), only left-hand
27441 side negation of the whole condition is possible.
27442
27443 The arguments of conditions and modifiers are expanded. A forced failure
27444 of an expansion causes a condition to be ignored, that is, it behaves as if the
27445 condition is true. Consider these two statements:
27446 .code
27447 accept  senders = ${lookup{$host_name}lsearch\
27448                   {/some/file}{$value}fail}
27449 accept  senders = ${lookup{$host_name}lsearch\
27450                   {/some/file}{$value}{}}
27451 .endd
27452 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27453 the returned list is searched, but if the lookup fails the behaviour is
27454 different in the two cases. The &%fail%& in the first statement causes the
27455 condition to be ignored, leaving no further conditions. The &%accept%& verb
27456 therefore succeeds. The second statement, however, generates an empty list when
27457 the lookup fails. No sender can match an empty list, so the condition fails,
27458 and therefore the &%accept%& also fails.
27459
27460 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27461 specify actions that are taken as the conditions for a statement are checked;
27462 others specify text for messages that are used when access is denied or a
27463 warning is generated. The &%control%& modifier affects the way an incoming
27464 message is handled.
27465
27466 The positioning of the modifiers in an ACL statement is important, because the
27467 processing of a verb ceases as soon as its outcome is known. Only those
27468 modifiers that have already been encountered will take effect. For example,
27469 consider this use of the &%message%& modifier:
27470 .code
27471 require message = Can't verify sender
27472         verify  = sender
27473         message = Can't verify recipient
27474         verify  = recipient
27475         message = This message cannot be used
27476 .endd
27477 If sender verification fails, Exim knows that the result of the statement is
27478 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27479 so its text is used as the error message. If sender verification succeeds, but
27480 recipient verification fails, the second message is used. If recipient
27481 verification succeeds, the third message becomes &"current"&, but is never used
27482 because there are no more conditions to cause failure.
27483
27484 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27485 modifier that is used, because all the conditions must be true for rejection to
27486 happen. Specifying more than one &%message%& modifier does not make sense, and
27487 the message can even be specified after all the conditions. For example:
27488 .code
27489 deny   hosts = ...
27490       !senders = *@my.domain.example
27491        message = Invalid sender from client host
27492 .endd
27493 The &"deny"& result does not happen until the end of the statement is reached,
27494 by which time Exim has set up the message.
27495
27496
27497
27498 .section "ACL modifiers" "SECTACLmodi"
27499 .cindex "&ACL;" "modifiers; list of"
27500 The ACL modifiers are as follows:
27501
27502 .vlist
27503 .vitem &*add_header*&&~=&~<&'text'&>
27504 This modifier specifies one or more header lines that are to be added to an
27505 incoming message, assuming, of course, that the message is ultimately
27506 accepted. For details, see section &<<SECTaddheadacl>>&.
27507
27508 .vitem &*continue*&&~=&~<&'text'&>
27509 .cindex "&%continue%& ACL modifier"
27510 .cindex "database" "updating in ACL"
27511 This modifier does nothing of itself, and processing of the ACL always
27512 continues with the next condition or modifier. The value of &%continue%& is in
27513 the side effects of expanding its argument. Typically this could be used to
27514 update a database. It is really just a syntactic tidiness, to avoid having to
27515 write rather ugly lines like this:
27516 .display
27517 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27518 .endd
27519 Instead, all you need is
27520 .display
27521 &`continue = `&<&'some expansion'&>
27522 .endd
27523
27524 .vitem &*control*&&~=&~<&'text'&>
27525 .cindex "&%control%& ACL modifier"
27526 This modifier affects the subsequent processing of the SMTP connection or of an
27527 incoming message that is accepted. The effect of the first type of control
27528 lasts for the duration of the connection, whereas the effect of the second type
27529 lasts only until the current message has been received. The message-specific
27530 controls always apply to the whole message, not to individual recipients,
27531 even if the &%control%& modifier appears in a RCPT ACL.
27532
27533 As there are now quite a few controls that can be applied, they are described
27534 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27535 in several different ways. For example:
27536
27537 . ==== As this is a nested list, any displays it contains must be indented
27538 . ==== as otherwise they are too far to the left. That comment applies only
27539 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27540 . ==== way.
27541
27542 .ilist
27543 It can be at the end of an &%accept%& statement:
27544 .code
27545     accept  ...some conditions
27546             control = queue_only
27547 .endd
27548 In this case, the control is applied when this statement yields &"accept"&, in
27549 other words, when the conditions are all true.
27550
27551 .next
27552 It can be in the middle of an &%accept%& statement:
27553 .code
27554     accept  ...some conditions...
27555             control = queue_only
27556             ...some more conditions...
27557 .endd
27558 If the first set of conditions are true, the control is applied, even if the
27559 statement does not accept because one of the second set of conditions is false.
27560 In this case, some subsequent statement must yield &"accept"& for the control
27561 to be relevant.
27562
27563 .next
27564 It can be used with &%warn%& to apply the control, leaving the
27565 decision about accepting or denying to a subsequent verb. For
27566 example:
27567 .code
27568     warn    ...some conditions...
27569             control = freeze
27570     accept  ...
27571 .endd
27572 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27573 &%logwrite%&, so it does not add anything to the message and does not write a
27574 log entry.
27575
27576 .next
27577 If you want to apply a control unconditionally, you can use it with a
27578 &%require%& verb. For example:
27579 .code
27580     require  control = no_multiline_responses
27581 .endd
27582 .endlist
27583
27584 .vitem &*delay*&&~=&~<&'time'&>
27585 .cindex "&%delay%& ACL modifier"
27586 .oindex "&%-bh%&"
27587 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27588 the time interval before proceeding. However, when testing Exim using the
27589 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27590 output instead). The time is given in the usual Exim notation, and the delay
27591 happens as soon as the modifier is processed. In an SMTP session, pending
27592 output is flushed before the delay is imposed.
27593
27594 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27595 example:
27596 .code
27597 deny    ...some conditions...
27598         delay = 30s
27599 .endd
27600 The delay happens if all the conditions are true, before the statement returns
27601 &"deny"&. Compare this with:
27602 .code
27603 deny    delay = 30s
27604         ...some conditions...
27605 .endd
27606 which waits for 30s before processing the conditions. The &%delay%& modifier
27607 can also be used with &%warn%& and together with &%control%&:
27608 .code
27609 warn    ...some conditions...
27610         delay = 2m
27611         control = freeze
27612 accept  ...
27613 .endd
27614
27615 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27616 responses to several commands are no longer buffered and sent in one packet (as
27617 they would normally be) because all output is flushed before imposing the
27618 delay. This optimization is disabled so that a number of small delays do not
27619 appear to the client as one large aggregated delay that might provoke an
27620 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27621 using a &%control%& modifier to set &%no_delay_flush%&.
27622
27623
27624 .vitem &*endpass*&
27625 .cindex "&%endpass%& ACL modifier"
27626 This modifier, which has no argument, is recognized only in &%accept%& and
27627 &%discard%& statements. It marks the boundary between the conditions whose
27628 failure causes control to pass to the next statement, and the conditions whose
27629 failure causes the ACL to return &"deny"&. This concept has proved to be
27630 confusing to some people, so the use of &%endpass%& is no longer recommended as
27631 &"best practice"&. See the description of &%accept%& above for more details.
27632
27633
27634 .vitem &*log_message*&&~=&~<&'text'&>
27635 .cindex "&%log_message%& ACL modifier"
27636 This modifier sets up a message that is used as part of the log message if the
27637 ACL denies access or a &%warn%& statement's conditions are true. For example:
27638 .code
27639 require log_message = wrong cipher suite $tls_in_cipher
27640         encrypted   = DES-CBC3-SHA
27641 .endd
27642 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27643 example:
27644 .display
27645 &`discard `&<&'some conditions'&>
27646 &`        log_message = Discarded $local_part@$domain because...`&
27647 .endd
27648 When access is denied, &%log_message%& adds to any underlying error message
27649 that may exist because of a condition failure. For example, while verifying a
27650 recipient address, a &':fail:'& redirection might have already set up a
27651 message.
27652
27653 The message may be defined before the conditions to which it applies, because
27654 the string expansion does not happen until Exim decides that access is to be
27655 denied. This means that any variables that are set by the condition are
27656 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27657 variables are set after a DNS black list lookup succeeds. If the expansion of
27658 &%log_message%& fails, or if the result is an empty string, the modifier is
27659 ignored.
27660
27661 .vindex "&$acl_verify_message$&"
27662 If you want to use a &%warn%& statement to log the result of an address
27663 verification, you can use &$acl_verify_message$& to include the verification
27664 error message.
27665
27666 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27667 the start of the logged message. If the same warning log message is requested
27668 more than once while receiving  a single email message, only one copy is
27669 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27670 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27671 is logged for a successful &%warn%& statement.
27672
27673 If &%log_message%& is not present and there is no underlying error message (for
27674 example, from the failure of address verification), but &%message%& is present,
27675 the &%message%& text is used for logging rejections. However, if any text for
27676 logging contains newlines, only the first line is logged. In the absence of
27677 both &%log_message%& and &%message%&, a default built-in message is used for
27678 logging rejections.
27679
27680
27681 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27682 .cindex "&%log_reject_target%& ACL modifier"
27683 .cindex "logging in ACL" "specifying which log"
27684 This modifier makes it possible to specify which logs are used for messages
27685 about ACL rejections. Its argument is a colon-separated list of words that can
27686 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27687 may be empty, in which case a rejection is not logged at all. For example, this
27688 ACL fragment writes no logging information when access is denied:
27689 .display
27690 &`deny `&<&'some conditions'&>
27691 &`     log_reject_target =`&
27692 .endd
27693 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27694 permanent and temporary rejections. Its effect lasts for the rest of the
27695 current ACL.
27696
27697
27698 .vitem &*logwrite*&&~=&~<&'text'&>
27699 .cindex "&%logwrite%& ACL modifier"
27700 .cindex "logging in ACL" "immediate"
27701 This modifier writes a message to a log file as soon as it is encountered when
27702 processing an ACL. (Compare &%log_message%&, which, except in the case of
27703 &%warn%& and &%discard%&, is used only if the ACL statement denies
27704 access.) The &%logwrite%& modifier can be used to log special incidents in
27705 ACLs. For example:
27706 .display
27707 &`accept `&<&'some special conditions'&>
27708 &`       control  = freeze`&
27709 &`       logwrite = froze message because ...`&
27710 .endd
27711 By default, the message is written to the main log. However, it may begin
27712 with a colon, followed by a comma-separated list of log names, and then
27713 another colon, to specify exactly which logs are to be written. For
27714 example:
27715 .code
27716 logwrite = :main,reject: text for main and reject logs
27717 logwrite = :panic: text for panic log only
27718 .endd
27719
27720
27721 .vitem &*message*&&~=&~<&'text'&>
27722 .cindex "&%message%& ACL modifier"
27723 This modifier sets up a text string that is expanded and used as a response
27724 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27725 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27726 there is some complication if &%endpass%& is involved; see the description of
27727 &%accept%& for details.)
27728
27729 The expansion of the message happens at the time Exim decides that the ACL is
27730 to end, not at the time it processes &%message%&. If the expansion fails, or
27731 generates an empty string, the modifier is ignored. Here is an example where
27732 &%message%& must be specified first, because the ACL ends with a rejection if
27733 the &%hosts%& condition fails:
27734 .code
27735 require  message = Host not recognized
27736          hosts = 10.0.0.0/8
27737 .endd
27738 (Once a condition has failed, no further conditions or modifiers are
27739 processed.)
27740
27741 .cindex "SMTP" "error codes"
27742 .oindex "&%smtp_banner%&
27743 For ACLs that are triggered by SMTP commands, the message is returned as part
27744 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27745 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27746 is accepted. In the case of the connect ACL, accepting with a message modifier
27747 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27748 accept message may not contain more than one line (otherwise it will be
27749 truncated at the first newline and a panic logged), and it cannot affect the
27750 EHLO options.
27751
27752 When SMTP is involved, the message may begin with an overriding response code,
27753 consisting of three digits optionally followed by an &"extended response code"&
27754 of the form &'n.n.n'&, each code being followed by a space. For example:
27755 .code
27756 deny  message = 599 1.2.3 Host not welcome
27757       hosts = 192.168.34.0/24
27758 .endd
27759 The first digit of the supplied response code must be the same as would be sent
27760 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27761 access, but for the predata ACL, note that the default success code is 354, not
27762 2&'xx'&.
27763
27764 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27765 the message modifier cannot override the 221 response code.
27766
27767 The text in a &%message%& modifier is literal; any quotes are taken as
27768 literals, but because the string is expanded, backslash escapes are processed
27769 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27770 response.
27771
27772 .vindex "&$acl_verify_message$&"
27773 .new
27774 For ACLs that are called by an &%acl =%& ACL condition, the message is
27775 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27776 .wen
27777
27778 If &%message%& is used on a statement that verifies an address, the message
27779 specified overrides any message that is generated by the verification process.
27780 However, the original message is available in the variable
27781 &$acl_verify_message$&, so you can incorporate it into your message if you
27782 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27783 routers to be passed back as part of the SMTP response, you should either not
27784 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27785
27786 For compatibility with previous releases of Exim, a &%message%& modifier that
27787 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27788 modifier, but this usage is now deprecated. However, &%message%& acts only when
27789 all the conditions are true, wherever it appears in an ACL command, whereas
27790 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27791 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27792 effect.
27793
27794
27795 .vitem &*remove_header*&&~=&~<&'text'&>
27796 This modifier specifies one or more header names in a colon-separated list
27797  that are to be removed from an incoming message, assuming, of course, that
27798 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27799
27800
27801 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27802 .cindex "&%set%& ACL modifier"
27803 This modifier puts a value into one of the ACL variables (see section
27804 &<<SECTaclvariables>>&).
27805
27806
27807 .vitem &*udpsend*&&~=&~<&'parameters'&>
27808 This modifier sends a UDP packet, for purposes such as statistics
27809 collection or behaviour monitoring. The parameters are expanded, and
27810 the result of the expansion must be a colon-separated list consisting
27811 of a destination server, port number, and the packet contents. The
27812 server can be specified as a host name or IPv4 or IPv6 address. The
27813 separator can be changed with the usual angle bracket syntax. For
27814 example, you might want to collect information on which hosts connect
27815 when:
27816 .code
27817 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27818              $tod_zulu $sender_host_address
27819 .endd
27820 .endlist
27821
27822
27823
27824
27825 .section "Use of the control modifier" "SECTcontrols"
27826 .cindex "&%control%& ACL modifier"
27827 The &%control%& modifier supports the following settings:
27828
27829 .vlist
27830 .vitem &*control&~=&~allow_auth_unadvertised*&
27831 This modifier allows a client host to use the SMTP AUTH command even when it
27832 has not been advertised in response to EHLO. Furthermore, because there are
27833 apparently some really broken clients that do this, Exim will accept AUTH after
27834 HELO (rather than EHLO) when this control is set. It should be used only if you
27835 really need it, and you should limit its use to those broken clients that do
27836 not work without it. For example:
27837 .code
27838 warn hosts   = 192.168.34.25
27839      control = allow_auth_unadvertised
27840 .endd
27841 Normally, when an Exim server receives an AUTH command, it checks the name of
27842 the authentication mechanism that is given in the command to ensure that it
27843 matches an advertised mechanism. When this control is set, the check that a
27844 mechanism has been advertised is bypassed. Any configured mechanism can be used
27845 by the client. This control is permitted only in the connection and HELO ACLs.
27846
27847
27848 .vitem &*control&~=&~caseful_local_part*& &&&
27849        &*control&~=&~caselower_local_part*&
27850 .cindex "&ACL;" "case of local part in"
27851 .cindex "case of local parts"
27852 .vindex "&$local_part$&"
27853 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27854 (that is, during RCPT processing). By default, the contents of &$local_part$&
27855 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27856 any uppercase letters in the original local part are restored in &$local_part$&
27857 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27858 is encountered.
27859
27860 These controls affect only the current recipient. Moreover, they apply only to
27861 local part handling that takes place directly in the ACL (for example, as a key
27862 in lookups). If a test to verify the recipient is obeyed, the case-related
27863 handling of the local part during the verification is controlled by the router
27864 configuration (see the &%caseful_local_part%& generic router option).
27865
27866 This facility could be used, for example, to add a spam score to local parts
27867 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27868 spam score:
27869 .code
27870 warn  control = caseful_local_part
27871       set acl_m4 = ${eval:\
27872                      $acl_m4 + \
27873                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27874                     }
27875       control = caselower_local_part
27876 .endd
27877 Notice that we put back the lower cased version afterwards, assuming that
27878 is what is wanted for subsequent tests.
27879
27880
27881 .vitem &*control&~=&~cutthrough_delivery*&
27882 .cindex "&ACL;" "cutthrough routing"
27883 .cindex "cutthrough" "requesting"
27884 This option requests delivery be attempted while the item is being received.
27885 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27886 from one SMTP connection to another.  If a recipient-verify callout connection is
27887 requested in the same ACL it is held open and used for the data, otherwise one is made
27888 after the ACL completes.
27889
27890 Note that routers are used in verify mode,
27891 and cannot depend on content of received headers.
27892 Note also that headers cannot be
27893 modified by any of the post-data ACLs (DATA, MIME and DKIM).
27894 Headers may be modified by routers (subject to the above) and transports.
27895
27896 Cutthrough delivery is not supported via transport-filters or when DKIM signing
27897 of outgoing messages is done, because it sends data to the ultimate destination
27898 before the entire message has been received from the source.
27899
27900 Should the ultimate destination system positively accept or reject the mail,
27901 a corresponding indication is given to the source system and nothing is queued.
27902 If there is a temporary error the item is queued for later delivery in the
27903 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27904 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27905 line.
27906
27907 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27908 sender when the destination system is doing content-scan based rejection.
27909
27910
27911 .vitem &*control&~=&~debug/*&<&'options'&>
27912 .cindex "&ACL;" "enabling debug logging"
27913 .cindex "debugging" "enabling from an ACL"
27914 This control turns on debug logging, almost as though Exim had been invoked
27915 with &`-d`&, with the output going to a new logfile, by default called
27916 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27917 may access any variables already defined.  The logging may be adjusted with
27918 the &'opts'& option, which takes the same values as the &`-d`& command-line
27919 option.  Some examples (which depend on variables that don't exist in all
27920 contexts):
27921 .code
27922       control = debug
27923       control = debug/tag=.$sender_host_address
27924       control = debug/opts=+expand+acl
27925       control = debug/tag=.$message_exim_id/opts=+expand
27926 .endd
27927
27928
27929 .vitem &*control&~=&~dkim_disable_verify*&
27930 .cindex "disable DKIM verify"
27931 .cindex "DKIM" "disable verify"
27932 This control turns off DKIM verification processing entirely.  For details on
27933 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27934
27935
27936 .vitem &*control&~=&~dscp/*&<&'value'&>
27937 .cindex "&ACL;" "setting DSCP value"
27938 .cindex "DSCP" "inbound"
27939 This option causes the DSCP value associated with the socket for the inbound
27940 connection to be adjusted to a given value, given as one of a number of fixed
27941 strings or to numeric value.
27942 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27943 Common values include &`throughput`&, &`mincost`&, and on newer systems
27944 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27945
27946 The outbound packets from Exim will be marked with this value in the header
27947 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27948 that these values will have any effect, not be stripped by networking
27949 equipment, or do much of anything without cooperation with your Network
27950 Engineer and those of all network operators between the source and destination.
27951
27952
27953 .vitem &*control&~=&~enforce_sync*& &&&
27954        &*control&~=&~no_enforce_sync*&
27955 .cindex "SMTP" "synchronization checking"
27956 .cindex "synchronization checking in SMTP"
27957 These controls make it possible to be selective about when SMTP synchronization
27958 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27959 state of the switch (it is true by default). See the description of this option
27960 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27961
27962 The effect of these two controls lasts for the remainder of the SMTP
27963 connection. They can appear in any ACL except the one for the non-SMTP
27964 messages. The most straightforward place to put them is in the ACL defined by
27965 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27966 before the first synchronization check. The expected use is to turn off the
27967 synchronization checks for badly-behaved hosts that you nevertheless need to
27968 work with.
27969
27970
27971 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27972 .cindex "fake defer"
27973 .cindex "defer, fake"
27974 This control works in exactly the same way as &%fakereject%& (described below)
27975 except that it causes an SMTP 450 response after the message data instead of a
27976 550 response. You must take care when using &%fakedefer%& because it causes the
27977 messages to be duplicated when the sender retries. Therefore, you should not
27978 use &%fakedefer%& if the message is to be delivered normally.
27979
27980 .vitem &*control&~=&~fakereject/*&<&'message'&>
27981 .cindex "fake rejection"
27982 .cindex "rejection, fake"
27983 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27984 words, only when an SMTP message is being received. If Exim accepts the
27985 message, instead the final 250 response, a 550 rejection message is sent.
27986 However, Exim proceeds to deliver the message as normal. The control applies
27987 only to the current message, not to any subsequent ones that may be received in
27988 the same SMTP connection.
27989
27990 The text for the 550 response is taken from the &%control%& modifier. If no
27991 message is supplied, the following is used:
27992 .code
27993 550-Your message has been rejected but is being
27994 550-kept for evaluation.
27995 550-If it was a legitimate message, it may still be
27996 550 delivered to the target recipient(s).
27997 .endd
27998 This facility should be used with extreme caution.
27999
28000 .vitem &*control&~=&~freeze*&
28001 .cindex "frozen messages" "forcing in ACL"
28002 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28003 other words, only when a message is being received. If the message is accepted,
28004 it is placed on Exim's queue and frozen. The control applies only to the
28005 current message, not to any subsequent ones that may be received in the same
28006 SMTP connection.
28007
28008 This modifier can optionally be followed by &`/no_tell`&. If the global option
28009 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28010 is told about the freezing), provided all the &*control=freeze*& modifiers that
28011 are obeyed for the current message have the &`/no_tell`& option.
28012
28013 .vitem &*control&~=&~no_delay_flush*&
28014 .cindex "SMTP" "output flushing, disabling for delay"
28015 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28016 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28017 use. This control, as long as it is encountered before the &%delay%& modifier,
28018 disables such output flushing.
28019
28020 .vitem &*control&~=&~no_callout_flush*&
28021 .cindex "SMTP" "output flushing, disabling for callout"
28022 Exim normally flushes SMTP output before performing a callout in an ACL, to
28023 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28024 use. This control, as long as it is encountered before the &%verify%& condition
28025 that causes the callout, disables such output flushing.
28026
28027 .vitem &*control&~=&~no_mbox_unspool*&
28028 This control is available when Exim is compiled with the content scanning
28029 extension. Content scanning may require a copy of the current message, or parts
28030 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28031 or spam scanner. Normally, such copies are deleted when they are no longer
28032 needed. If this control is set, the copies are not deleted. The control applies
28033 only to the current message, not to any subsequent ones that may be received in
28034 the same SMTP connection. It is provided for debugging purposes and is unlikely
28035 to be useful in production.
28036
28037 .vitem &*control&~=&~no_multiline_responses*&
28038 .cindex "multiline responses, suppressing"
28039 This control is permitted for any ACL except the one for non-SMTP messages.
28040 It seems that there are broken clients in use that cannot handle multiline
28041 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28042
28043 If this control is set, multiline SMTP responses from ACL rejections are
28044 suppressed. One way of doing this would have been to put out these responses as
28045 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28046 (&"use multiline responses for more"& it says &-- ha!), and some of the
28047 responses might get close to that. So this facility, which is after all only a
28048 sop to broken clients, is implemented by doing two very easy things:
28049
28050 .ilist
28051 Extra information that is normally output as part of a rejection caused by
28052 sender verification failure is omitted. Only the final line (typically &"sender
28053 verification failed"&) is sent.
28054 .next
28055 If a &%message%& modifier supplies a multiline response, only the first
28056 line is output.
28057 .endlist
28058
28059 The setting of the switch can, of course, be made conditional on the
28060 calling host. Its effect lasts until the end of the SMTP connection.
28061
28062 .vitem &*control&~=&~no_pipelining*&
28063 .cindex "PIPELINING" "suppressing advertising"
28064 This control turns off the advertising of the PIPELINING extension to SMTP in
28065 the current session. To be useful, it must be obeyed before Exim sends its
28066 response to an EHLO command. Therefore, it should normally appear in an ACL
28067 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28068 &%pipelining_advertise_hosts%&.
28069
28070 .vitem &*control&~=&~queue_only*&
28071 .oindex "&%queue_only%&"
28072 .cindex "queueing incoming messages"
28073 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28074 other words, only when a message is being received. If the message is accepted,
28075 it is placed on Exim's queue and left there for delivery by a subsequent queue
28076 runner. No immediate delivery process is started. In other words, it has the
28077 effect as the &%queue_only%& global option. However, the control applies only
28078 to the current message, not to any subsequent ones that may be received in the
28079 same SMTP connection.
28080
28081 .vitem &*control&~=&~submission/*&<&'options'&>
28082 .cindex "message" "submission"
28083 .cindex "submission mode"
28084 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28085 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28086 the current message is a submission from a local MUA. In this case, Exim
28087 operates in &"submission mode"&, and applies certain fixups to the message if
28088 necessary. For example, it adds a &'Date:'& header line if one is not present.
28089 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28090 late (the message has already been created).
28091
28092 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28093 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28094 submission mode; the available options for this control are described there.
28095 The control applies only to the current message, not to any subsequent ones
28096 that may be received in the same SMTP connection.
28097
28098 .vitem &*control&~=&~suppress_local_fixups*&
28099 .cindex "submission fixups, suppressing"
28100 This control applies to locally submitted (non TCP/IP) messages, and is the
28101 complement of &`control = submission`&. It disables the fixups that are
28102 normally applied to locally-submitted messages. Specifically:
28103
28104 .ilist
28105 Any &'Sender:'& header line is left alone (in this respect, it is a
28106 dynamic version of &%local_sender_retain%&).
28107 .next
28108 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28109 .next
28110 There is no check that &'From:'& corresponds to the actual sender.
28111 .endlist ilist
28112
28113 This control may be useful when a remotely-originated message is accepted,
28114 passed to some scanning program, and then re-submitted for delivery. It can be
28115 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28116 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28117 data is read.
28118
28119 &*Note:*& This control applies only to the current message, not to any others
28120 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28121 .endlist vlist
28122
28123
28124 .section "Summary of message fixup control" "SECTsummesfix"
28125 All four possibilities for message fixups can be specified:
28126
28127 .ilist
28128 Locally submitted, fixups applied: the default.
28129 .next
28130 Locally submitted, no fixups applied: use
28131 &`control = suppress_local_fixups`&.
28132 .next
28133 Remotely submitted, no fixups applied: the default.
28134 .next
28135 Remotely submitted, fixups applied: use &`control = submission`&.
28136 .endlist
28137
28138
28139
28140 .section "Adding header lines in ACLs" "SECTaddheadacl"
28141 .cindex "header lines" "adding in an ACL"
28142 .cindex "header lines" "position of added lines"
28143 .cindex "&%add_header%& ACL modifier"
28144 The &%add_header%& modifier can be used to add one or more extra header lines
28145 to an incoming message, as in this example:
28146 .code
28147 warn dnslists = sbl.spamhaus.org : \
28148                 dialup.mail-abuse.org
28149      add_header = X-blacklisted-at: $dnslist_domain
28150 .endd
28151 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28152 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28153 receiving a message). The message must ultimately be accepted for
28154 &%add_header%& to have any significant effect. You can use &%add_header%& with
28155 any ACL verb, including &%deny%& (though this is potentially useful only in a
28156 RCPT ACL).
28157
28158 Headers will not be added to the message if the modifier is used in
28159 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28160
28161 Leading and trailing newlines are removed from
28162 the data for the &%add_header%& modifier; if it then
28163 contains one or more newlines that
28164 are not followed by a space or a tab, it is assumed to contain multiple header
28165 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28166 front of any line that is not a valid header line.
28167
28168 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28169 They are added to the message before processing the DATA and MIME ACLs.
28170 However, if an identical header line is requested more than once, only one copy
28171 is actually added to the message. Further header lines may be accumulated
28172 during the DATA and MIME ACLs, after which they are added to the message, again
28173 with duplicates suppressed. Thus, it is possible to add two identical header
28174 lines to an SMTP message, but only if one is added before DATA and one after.
28175 In the case of non-SMTP messages, new headers are accumulated during the
28176 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28177 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28178 are included in the entry that is written to the reject log.
28179
28180 .cindex "header lines" "added; visibility of"
28181 Header lines are not visible in string expansions
28182 of message headers
28183 until they are added to the
28184 message. It follows that header lines defined in the MAIL, RCPT, and predata
28185 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28186 header lines that are added by the DATA or MIME ACLs are not visible in those
28187 ACLs. Because of this restriction, you cannot use header lines as a way of
28188 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28189 this, you can use ACL variables, as described in section
28190 &<<SECTaclvariables>>&.
28191
28192 The list of headers yet to be added is given by the &%$headers_added%& variable.
28193
28194 The &%add_header%& modifier acts immediately as it is encountered during the
28195 processing of an ACL. Notice the difference between these two cases:
28196 .display
28197 &`accept add_header = ADDED: some text`&
28198 &`       `&<&'some condition'&>
28199
28200 &`accept `&<&'some condition'&>
28201 &`       add_header = ADDED: some text`&
28202 .endd
28203 In the first case, the header line is always added, whether or not the
28204 condition is true. In the second case, the header line is added only if the
28205 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28206 ACL statement. All those that are encountered before a condition fails are
28207 honoured.
28208
28209 .cindex "&%warn%& ACL verb"
28210 For compatibility with previous versions of Exim, a &%message%& modifier for a
28211 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28212 effect only if all the conditions are true, even if it appears before some of
28213 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28214 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28215 are present on a &%warn%& verb, both are processed according to their
28216 specifications.
28217
28218 By default, new header lines are added to a message at the end of the existing
28219 header lines. However, you can specify that any particular header line should
28220 be added right at the start (before all the &'Received:'& lines), immediately
28221 after the first block of &'Received:'& lines, or immediately before any line
28222 that is not a &'Received:'& or &'Resent-something:'& header.
28223
28224 This is done by specifying &":at_start:"&, &":after_received:"&, or
28225 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28226 header line, respectively. (Header text cannot start with a colon, as there has
28227 to be a header name first.) For example:
28228 .code
28229 warn add_header = \
28230        :after_received:X-My-Header: something or other...
28231 .endd
28232 If more than one header line is supplied in a single &%add_header%& modifier,
28233 each one is treated independently and can therefore be placed differently. If
28234 you add more than one line at the start, or after the Received: block, they end
28235 up in reverse order.
28236
28237 &*Warning*&: This facility currently applies only to header lines that are
28238 added in an ACL. It does NOT work for header lines that are added in a
28239 system filter or in a router or transport.
28240
28241
28242
28243 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28244 .cindex "header lines" "removing in an ACL"
28245 .cindex "header lines" "position of removed lines"
28246 .cindex "&%remove_header%& ACL modifier"
28247 The &%remove_header%& modifier can be used to remove one or more header lines
28248 from an incoming message, as in this example:
28249 .code
28250 warn   message        = Remove internal headers
28251        remove_header  = x-route-mail1 : x-route-mail2
28252 .endd
28253 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28254 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28255 receiving a message). The message must ultimately be accepted for
28256 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28257 with any ACL verb, including &%deny%&, though this is really not useful for
28258 any verb that doesn't result in a delivered message.
28259
28260 Headers will not be removed to the message if the modifier is used in
28261 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28262
28263 More than one header can be removed at the same time by using a colon separated
28264 list of header names. The header matching is case insensitive. Wildcards are
28265 not permitted, nor is list expansion performed, so you cannot use hostlists to
28266 create a list of headers, however both connection and message variable expansion
28267 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28268 .code
28269 warn   hosts           = +internal_hosts
28270        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28271 warn   message         = Remove internal headers
28272        remove_header   = $acl_c_ihdrs
28273 .endd
28274 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28275 They are removed from the message before processing the DATA and MIME ACLs.
28276 There is no harm in attempting to remove the same header twice nor is removing
28277 a non-existent header. Further header lines to be removed may be accumulated
28278 during the DATA and MIME ACLs, after which they are removed from the message,
28279 if present. In the case of non-SMTP messages, headers to be removed are
28280 accumulated during the non-SMTP ACLs, and are removed from the message after
28281 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28282 ACL, there really is no effect because there is no logging of what headers
28283 would have been removed.
28284
28285 .cindex "header lines" "removed; visibility of"
28286 Header lines are not visible in string expansions until the DATA phase when it
28287 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28288 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28289 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28290 this restriction, you cannot use header lines as a way of controlling data
28291 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28292 you should instead use ACL variables, as described in section
28293 &<<SECTaclvariables>>&.
28294
28295 The &%remove_header%& modifier acts immediately as it is encountered during the
28296 processing of an ACL. Notice the difference between these two cases:
28297 .display
28298 &`accept remove_header = X-Internal`&
28299 &`       `&<&'some condition'&>
28300
28301 &`accept `&<&'some condition'&>
28302 &`       remove_header = X-Internal`&
28303 .endd
28304 In the first case, the header line is always removed, whether or not the
28305 condition is true. In the second case, the header line is removed only if the
28306 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28307 same ACL statement. All those that are encountered before a condition fails
28308 are honoured.
28309
28310 &*Warning*&: This facility currently applies only to header lines that are
28311 present during ACL processing. It does NOT remove header lines that are added
28312 in a system filter or in a router or transport.
28313
28314
28315
28316
28317 .section "ACL conditions" "SECTaclconditions"
28318 .cindex "&ACL;" "conditions; list of"
28319 Some of the conditions listed in this section are available only when Exim is
28320 compiled with the content-scanning extension. They are included here briefly
28321 for completeness. More detailed descriptions can be found in the discussion on
28322 content scanning in chapter &<<CHAPexiscan>>&.
28323
28324 Not all conditions are relevant in all circumstances. For example, testing
28325 senders and recipients does not make sense in an ACL that is being run as the
28326 result of the arrival of an ETRN command, and checks on message headers can be
28327 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28328 can use the same condition (with different parameters) more than once in the
28329 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28330 The conditions are as follows:
28331
28332
28333 .vlist
28334 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28335 .cindex "&ACL;" "nested"
28336 .cindex "&ACL;" "indirect"
28337 .cindex "&ACL;" "arguments"
28338 .cindex "&%acl%& ACL condition"
28339 The possible values of the argument are the same as for the
28340 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28341 &"accept"& the condition is true; if it returns &"deny"& the condition is
28342 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28343 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28344 condition false. This means that further processing of the &%warn%& verb
28345 ceases, but processing of the ACL continues.
28346
28347 If the argument is a named ACL, up to nine space-separated optional values
28348 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28349 and $acl_narg is set to the count of values.
28350 Previous values of these variables are restored after the call returns.
28351 The name and values are expanded separately.
28352 Note that spaces in complex expansions which are used as arguments
28353 will act as argument separators.
28354
28355 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28356 the connection is dropped. If it returns &"discard"&, the verb must be
28357 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28358 conditions are tested.
28359
28360 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28361 loops. This condition allows you to use different ACLs in different
28362 circumstances. For example, different ACLs can be used to handle RCPT commands
28363 for different local users or different local domains.
28364
28365 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28366 .cindex "&%authenticated%& ACL condition"
28367 .cindex "authentication" "ACL checking"
28368 .cindex "&ACL;" "testing for authentication"
28369 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28370 the name of the authenticator is tested against the list. To test for
28371 authentication by any authenticator, you can set
28372 .code
28373 authenticated = *
28374 .endd
28375
28376 .vitem &*condition&~=&~*&<&'string'&>
28377 .cindex "&%condition%& ACL condition"
28378 .cindex "customizing" "ACL condition"
28379 .cindex "&ACL;" "customized test"
28380 .cindex "&ACL;" "testing, customized"
28381 This feature allows you to make up custom conditions. If the result of
28382 expanding the string is an empty string, the number zero, or one of the strings
28383 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28384 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28385 any other value, some error is assumed to have occurred, and the ACL returns
28386 &"defer"&. However, if the expansion is forced to fail, the condition is
28387 ignored. The effect is to treat it as true, whether it is positive or
28388 negative.
28389
28390 .vitem &*decode&~=&~*&<&'location'&>
28391 .cindex "&%decode%& ACL condition"
28392 This condition is available only when Exim is compiled with the
28393 content-scanning extension, and it is allowed only in the ACL defined by
28394 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28395 If all goes well, the condition is true. It is false only if there are
28396 problems such as a syntax error or a memory shortage. For more details, see
28397 chapter &<<CHAPexiscan>>&.
28398
28399 .vitem &*demime&~=&~*&<&'extension&~list'&>
28400 .cindex "&%demime%& ACL condition"
28401 This condition is available only when Exim is compiled with the
28402 content-scanning extension. Its use is described in section
28403 &<<SECTdemimecond>>&.
28404
28405 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28406 .cindex "&%dnslists%& ACL condition"
28407 .cindex "DNS list" "in ACL"
28408 .cindex "black list (DNS)"
28409 .cindex "&ACL;" "testing a DNS list"
28410 This condition checks for entries in DNS black lists. These are also known as
28411 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28412 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28413 different variants of this condition to describe briefly here. See sections
28414 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28415
28416 .vitem &*domains&~=&~*&<&'domain&~list'&>
28417 .cindex "&%domains%& ACL condition"
28418 .cindex "domain" "ACL checking"
28419 .cindex "&ACL;" "testing a recipient domain"
28420 .vindex "&$domain_data$&"
28421 This condition is relevant only after a RCPT command. It checks that the domain
28422 of the recipient address is in the domain list. If percent-hack processing is
28423 enabled, it is done before this test is done. If the check succeeds with a
28424 lookup, the result of the lookup is placed in &$domain_data$& until the next
28425 &%domains%& test.
28426
28427 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28428 use &%domains%& in a DATA ACL.
28429
28430
28431 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28432 .cindex "&%encrypted%& ACL condition"
28433 .cindex "encryption" "checking in an ACL"
28434 .cindex "&ACL;" "testing for encryption"
28435 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28436 name of the cipher suite in use is tested against the list. To test for
28437 encryption without testing for any specific cipher suite(s), set
28438 .code
28439 encrypted = *
28440 .endd
28441
28442
28443 .vitem &*hosts&~=&~*&<&'host&~list'&>
28444 .cindex "&%hosts%& ACL condition"
28445 .cindex "host" "ACL checking"
28446 .cindex "&ACL;" "testing the client host"
28447 This condition tests that the calling host matches the host list. If you have
28448 name lookups or wildcarded host names and IP addresses in the same host list,
28449 you should normally put the IP addresses first. For example, you could have:
28450 .code
28451 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28452 .endd
28453 The lookup in this example uses the host name for its key. This is implied by
28454 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28455 and it wouldn't matter which way round you had these two items.)
28456
28457 The reason for the problem with host names lies in the left-to-right way that
28458 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28459 but when it reaches an item that requires a host name, it fails if it cannot
28460 find a host name to compare with the pattern. If the above list is given in the
28461 opposite order, the &%accept%& statement fails for a host whose name cannot be
28462 found, even if its IP address is 10.9.8.7.
28463
28464 If you really do want to do the name check first, and still recognize the IP
28465 address even if the name lookup fails, you can rewrite the ACL like this:
28466 .code
28467 accept hosts = dbm;/etc/friendly/hosts
28468 accept hosts = 10.9.8.7
28469 .endd
28470 The default action on failing to find the host name is to assume that the host
28471 is not in the list, so the first &%accept%& statement fails. The second
28472 statement can then check the IP address.
28473
28474 .vindex "&$host_data$&"
28475 If a &%hosts%& condition is satisfied by means of a lookup, the result
28476 of the lookup is made available in the &$host_data$& variable. This
28477 allows you, for example, to set up a statement like this:
28478 .code
28479 deny  hosts = net-lsearch;/some/file
28480 message = $host_data
28481 .endd
28482 which gives a custom error message for each denied host.
28483
28484 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28485 .cindex "&%local_parts%& ACL condition"
28486 .cindex "local part" "ACL checking"
28487 .cindex "&ACL;" "testing a local part"
28488 .vindex "&$local_part_data$&"
28489 This condition is relevant only after a RCPT command. It checks that the local
28490 part of the recipient address is in the list. If percent-hack processing is
28491 enabled, it is done before this test. If the check succeeds with a lookup, the
28492 result of the lookup is placed in &$local_part_data$&, which remains set until
28493 the next &%local_parts%& test.
28494
28495 .vitem &*malware&~=&~*&<&'option'&>
28496 .cindex "&%malware%& ACL condition"
28497 .cindex "&ACL;" "virus scanning"
28498 .cindex "&ACL;" "scanning for viruses"
28499 This condition is available only when Exim is compiled with the
28500 content-scanning extension. It causes the incoming message to be scanned for
28501 viruses. For details, see chapter &<<CHAPexiscan>>&.
28502
28503 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28504 .cindex "&%mime_regex%& ACL condition"
28505 .cindex "&ACL;" "testing by regex matching"
28506 This condition is available only when Exim is compiled with the
28507 content-scanning extension, and it is allowed only in the ACL defined by
28508 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28509 with any of the regular expressions. For details, see chapter
28510 &<<CHAPexiscan>>&.
28511
28512 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28513 .cindex "rate limiting"
28514 This condition can be used to limit the rate at which a user or host submits
28515 messages. Details are given in section &<<SECTratelimiting>>&.
28516
28517 .vitem &*recipients&~=&~*&<&'address&~list'&>
28518 .cindex "&%recipients%& ACL condition"
28519 .cindex "recipient" "ACL checking"
28520 .cindex "&ACL;" "testing a recipient"
28521 This condition is relevant only after a RCPT command. It checks the entire
28522 recipient address against a list of recipients.
28523
28524 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28525 .cindex "&%regex%& ACL condition"
28526 .cindex "&ACL;" "testing by regex matching"
28527 This condition is available only when Exim is compiled with the
28528 content-scanning extension, and is available only in the DATA, MIME, and
28529 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28530 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28531
28532 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28533 .cindex "&%sender_domains%& ACL condition"
28534 .cindex "sender" "ACL checking"
28535 .cindex "&ACL;" "testing a sender domain"
28536 .vindex "&$domain$&"
28537 .vindex "&$sender_address_domain$&"
28538 This condition tests the domain of the sender of the message against the given
28539 domain list. &*Note*&: The domain of the sender address is in
28540 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28541 of this condition. This is an exception to the general rule for testing domain
28542 lists. It is done this way so that, if this condition is used in an ACL for a
28543 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28544 influence the sender checking.
28545
28546 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28547 relaying, because sender addresses are easily, and commonly, forged.
28548
28549 .vitem &*senders&~=&~*&<&'address&~list'&>
28550 .cindex "&%senders%& ACL condition"
28551 .cindex "sender" "ACL checking"
28552 .cindex "&ACL;" "testing a sender"
28553 This condition tests the sender of the message against the given list. To test
28554 for a bounce message, which has an empty sender, set
28555 .code
28556 senders = :
28557 .endd
28558 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28559 relaying, because sender addresses are easily, and commonly, forged.
28560
28561 .vitem &*spam&~=&~*&<&'username'&>
28562 .cindex "&%spam%& ACL condition"
28563 .cindex "&ACL;" "scanning for spam"
28564 This condition is available only when Exim is compiled with the
28565 content-scanning extension. It causes the incoming message to be scanned by
28566 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28567
28568 .vitem &*verify&~=&~certificate*&
28569 .cindex "&%verify%& ACL condition"
28570 .cindex "TLS" "client certificate verification"
28571 .cindex "certificate" "verification of client"
28572 .cindex "&ACL;" "certificate verification"
28573 .cindex "&ACL;" "testing a TLS certificate"
28574 This condition is true in an SMTP session if the session is encrypted, and a
28575 certificate was received from the client, and the certificate was verified. The
28576 server requests a certificate only if the client matches &%tls_verify_hosts%&
28577 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28578
28579 .vitem &*verify&~=&~csa*&
28580 .cindex "CSA verification"
28581 This condition checks whether the sending host (the client) is authorized to
28582 send email. Details of how this works are given in section
28583 &<<SECTverifyCSA>>&.
28584
28585 .vitem &*verify&~=&~header_names_ascii*&
28586 .cindex "&%verify%& ACL condition"
28587 .cindex "&ACL;" "verifying header names only ASCII"
28588 .cindex "header lines" "verifying header names only ASCII"
28589 .cindex "verifying" "header names only ASCII"
28590 This condition is relevant only in an ACL that is run after a message has been
28591 received, that is, in an ACL specified by &%acl_smtp_data%& or
28592 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28593 there are no non-ASCII characters, also excluding control characters.  The
28594 allowable characters are decimal ASCII values 33 through 126.
28595
28596 Exim itself will handle headers with non-ASCII characters, but it can cause
28597 problems for downstream applications, so this option will allow their
28598 detection and rejection in the DATA ACL's.
28599
28600 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28601 .cindex "&%verify%& ACL condition"
28602 .cindex "&ACL;" "verifying sender in the header"
28603 .cindex "header lines" "verifying the sender in"
28604 .cindex "sender" "verifying in header"
28605 .cindex "verifying" "sender in header"
28606 This condition is relevant only in an ACL that is run after a message has been
28607 received, that is, in an ACL specified by &%acl_smtp_data%& or
28608 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28609 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28610 is loosely thought of as a &"sender"& address (hence the name of the test).
28611 However, an address that appears in one of these headers need not be an address
28612 that accepts bounce messages; only sender addresses in envelopes are required
28613 to accept bounces. Therefore, if you use the callout option on this check, you
28614 might want to arrange for a non-empty address in the MAIL command.
28615
28616 Details of address verification and the options are given later, starting at
28617 section &<<SECTaddressverification>>& (callouts are described in section
28618 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28619 condition to restrict it to bounce messages only:
28620 .code
28621 deny    senders = :
28622         message = A valid sender header is required for bounces
28623        !verify  = header_sender
28624 .endd
28625
28626 .vitem &*verify&~=&~header_syntax*&
28627 .cindex "&%verify%& ACL condition"
28628 .cindex "&ACL;" "verifying header syntax"
28629 .cindex "header lines" "verifying syntax"
28630 .cindex "verifying" "header syntax"
28631 This condition is relevant only in an ACL that is run after a message has been
28632 received, that is, in an ACL specified by &%acl_smtp_data%& or
28633 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28634 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28635 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28636 permitted only in locally generated messages and from hosts that match
28637 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28638 appropriate.
28639
28640 Note that this condition is a syntax check only. However, a common spamming
28641 ploy used to be to send syntactically invalid headers such as
28642 .code
28643 To: @
28644 .endd
28645 and this condition can be used to reject such messages, though they are not as
28646 common as they used to be.
28647
28648 .vitem &*verify&~=&~helo*&
28649 .cindex "&%verify%& ACL condition"
28650 .cindex "&ACL;" "verifying HELO/EHLO"
28651 .cindex "HELO" "verifying"
28652 .cindex "EHLO" "verifying"
28653 .cindex "verifying" "EHLO"
28654 .cindex "verifying" "HELO"
28655 This condition is true if a HELO or EHLO command has been received from the
28656 client host, and its contents have been verified. If there has been no previous
28657 attempt to verify the HELO/EHLO contents, it is carried out when this
28658 condition is encountered. See the description of the &%helo_verify_hosts%& and
28659 &%helo_try_verify_hosts%& options for details of how to request verification
28660 independently of this condition.
28661
28662 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28663 option), this condition is always true.
28664
28665
28666 .vitem &*verify&~=&~not_blind*&
28667 .cindex "verifying" "not blind"
28668 .cindex "bcc recipients, verifying none"
28669 This condition checks that there are no blind (bcc) recipients in the message.
28670 Every envelope recipient must appear either in a &'To:'& header line or in a
28671 &'Cc:'& header line for this condition to be true. Local parts are checked
28672 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28673 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28674 used only in a DATA or non-SMTP ACL.
28675
28676 There are, of course, many legitimate messages that make use of blind (bcc)
28677 recipients. This check should not be used on its own for blocking messages.
28678
28679
28680 .vitem &*verify&~=&~recipient/*&<&'options'&>
28681 .cindex "&%verify%& ACL condition"
28682 .cindex "&ACL;" "verifying recipient"
28683 .cindex "recipient" "verifying"
28684 .cindex "verifying" "recipient"
28685 .vindex "&$address_data$&"
28686 This condition is relevant only after a RCPT command. It verifies the current
28687 recipient. Details of address verification are given later, starting at section
28688 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28689 of &$address_data$& is the last value that was set while routing the address.
28690 This applies even if the verification fails. When an address that is being
28691 verified is redirected to a single address, verification continues with the new
28692 address, and in that case, the subsequent value of &$address_data$& is the
28693 value for the child address.
28694
28695 .vitem &*verify&~=&~reverse_host_lookup*&
28696 .cindex "&%verify%& ACL condition"
28697 .cindex "&ACL;" "verifying host reverse lookup"
28698 .cindex "host" "verifying reverse lookup"
28699 This condition ensures that a verified host name has been looked up from the IP
28700 address of the client host. (This may have happened already if the host name
28701 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28702 Verification ensures that the host name obtained from a reverse DNS lookup, or
28703 one of its aliases, does, when it is itself looked up in the DNS, yield the
28704 original IP address.
28705
28706 If this condition is used for a locally generated message (that is, when there
28707 is no client host involved), it always succeeds.
28708
28709 .vitem &*verify&~=&~sender/*&<&'options'&>
28710 .cindex "&%verify%& ACL condition"
28711 .cindex "&ACL;" "verifying sender"
28712 .cindex "sender" "verifying"
28713 .cindex "verifying" "sender"
28714 This condition is relevant only after a MAIL or RCPT command, or after a
28715 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28716 the message's sender is empty (that is, this is a bounce message), the
28717 condition is true. Otherwise, the sender address is verified.
28718
28719 .vindex "&$address_data$&"
28720 .vindex "&$sender_address_data$&"
28721 If there is data in the &$address_data$& variable at the end of routing, its
28722 value is placed in &$sender_address_data$& at the end of verification. This
28723 value can be used in subsequent conditions and modifiers in the same ACL
28724 statement. It does not persist after the end of the current statement. If you
28725 want to preserve the value for longer, you can save it in an ACL variable.
28726
28727 Details of verification are given later, starting at section
28728 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28729 to avoid doing it more than once per message.
28730
28731 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28732 .cindex "&%verify%& ACL condition"
28733 This is a variation of the previous option, in which a modified address is
28734 verified as a sender.
28735 .endlist
28736
28737
28738
28739 .section "Using DNS lists" "SECTmorednslists"
28740 .cindex "DNS list" "in ACL"
28741 .cindex "black list (DNS)"
28742 .cindex "&ACL;" "testing a DNS list"
28743 In its simplest form, the &%dnslists%& condition tests whether the calling host
28744 is on at least one of a number of DNS lists by looking up the inverted IP
28745 address in one or more DNS domains. (Note that DNS list domains are not mail
28746 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28747 special options instead.) For example, if the calling host's IP
28748 address is 192.168.62.43, and the ACL statement is
28749 .code
28750 deny dnslists = blackholes.mail-abuse.org : \
28751                 dialups.mail-abuse.org
28752 .endd
28753 the following records are looked up:
28754 .code
28755 43.62.168.192.blackholes.mail-abuse.org
28756 43.62.168.192.dialups.mail-abuse.org
28757 .endd
28758 As soon as Exim finds an existing DNS record, processing of the list stops.
28759 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28760 to test that a host is on more than one list (an &"and"& conjunction), you can
28761 use two separate conditions:
28762 .code
28763 deny dnslists = blackholes.mail-abuse.org
28764      dnslists = dialups.mail-abuse.org
28765 .endd
28766 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28767 behaves as if the host does not match the list item, that is, as if the DNS
28768 record does not exist. If there are further items in the DNS list, they are
28769 processed.
28770
28771 This is usually the required action when &%dnslists%& is used with &%deny%&
28772 (which is the most common usage), because it prevents a DNS failure from
28773 blocking mail. However, you can change this behaviour by putting one of the
28774 following special items in the list:
28775 .display
28776 &`+include_unknown `&   behave as if the item is on the list
28777 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28778 &`+defer_unknown   `&   give a temporary error
28779 .endd
28780 .cindex "&`+include_unknown`&"
28781 .cindex "&`+exclude_unknown`&"
28782 .cindex "&`+defer_unknown`&"
28783 Each of these applies to any subsequent items on the list. For example:
28784 .code
28785 deny dnslists = +defer_unknown : foo.bar.example
28786 .endd
28787 Testing the list of domains stops as soon as a match is found. If you want to
28788 warn for one list and block for another, you can use two different statements:
28789 .code
28790 deny  dnslists = blackholes.mail-abuse.org
28791 warn  message  = X-Warn: sending host is on dialups list
28792       dnslists = dialups.mail-abuse.org
28793 .endd
28794 DNS list lookups are cached by Exim for the duration of the SMTP session,
28795 so a lookup based on the IP address is done at most once for any incoming
28796 connection. Exim does not share information between multiple incoming
28797 connections (but your local name server cache should be active).
28798
28799
28800
28801 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28802 .cindex "DNS list" "keyed by explicit IP address"
28803 By default, the IP address that is used in a DNS list lookup is the IP address
28804 of the calling host. However, you can specify another IP address by listing it
28805 after the domain name, introduced by a slash. For example:
28806 .code
28807 deny dnslists = black.list.tld/192.168.1.2
28808 .endd
28809 This feature is not very helpful with explicit IP addresses; it is intended for
28810 use with IP addresses that are looked up, for example, the IP addresses of the
28811 MX hosts or nameservers of an email sender address. For an example, see section
28812 &<<SECTmulkeyfor>>& below.
28813
28814
28815
28816
28817 .section "DNS lists keyed on domain names" "SECID202"
28818 .cindex "DNS list" "keyed by domain name"
28819 There are some lists that are keyed on domain names rather than inverted IP
28820 addresses (see for example the &'domain based zones'& link at
28821 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28822 with these lists. You can change the name that is looked up in a DNS list by
28823 listing it after the domain name, introduced by a slash. For example,
28824 .code
28825 deny  message  = Sender's domain is listed at $dnslist_domain
28826       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28827 .endd
28828 This particular example is useful only in ACLs that are obeyed after the
28829 RCPT or DATA commands, when a sender address is available. If (for
28830 example) the message's sender is &'user@tld.example'& the name that is looked
28831 up by this example is
28832 .code
28833 tld.example.dsn.rfc-ignorant.org
28834 .endd
28835 A single &%dnslists%& condition can contain entries for both names and IP
28836 addresses. For example:
28837 .code
28838 deny dnslists = sbl.spamhaus.org : \
28839                 dsn.rfc-ignorant.org/$sender_address_domain
28840 .endd
28841 The first item checks the sending host's IP address; the second checks a domain
28842 name. The whole condition is true if either of the DNS lookups succeeds.
28843
28844
28845
28846
28847 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28848 .cindex "DNS list" "multiple keys for"
28849 The syntax described above for looking up explicitly-defined values (either
28850 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28851 name for the DNS list, what follows the slash can in fact be a list of items.
28852 As with all lists in Exim, the default separator is a colon. However, because
28853 this is a sublist within the list of DNS blacklist domains, it is necessary
28854 either to double the separators like this:
28855 .code
28856 dnslists = black.list.tld/name.1::name.2
28857 .endd
28858 or to change the separator character, like this:
28859 .code
28860 dnslists = black.list.tld/<;name.1;name.2
28861 .endd
28862 If an item in the list is an IP address, it is inverted before the DNS
28863 blacklist domain is appended. If it is not an IP address, no inversion
28864 occurs. Consider this condition:
28865 .code
28866 dnslists = black.list.tld/<;192.168.1.2;a.domain
28867 .endd
28868 The DNS lookups that occur are:
28869 .code
28870 2.1.168.192.black.list.tld
28871 a.domain.black.list.tld
28872 .endd
28873 Once a DNS record has been found (that matches a specific IP return
28874 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28875 are done. If there is a temporary DNS error, the rest of the sublist of domains
28876 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28877 only if no other DNS lookup in this sublist succeeds. In other words, a
28878 successful lookup for any of the items in the sublist overrides a temporary
28879 error for a previous item.
28880
28881 The ability to supply a list of items after the slash is in some sense just a
28882 syntactic convenience. These two examples have the same effect:
28883 .code
28884 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28885 dnslists = black.list.tld/a.domain::b.domain
28886 .endd
28887 However, when the data for the list is obtained from a lookup, the second form
28888 is usually much more convenient. Consider this example:
28889 .code
28890 deny message  = The mail servers for the domain \
28891                 $sender_address_domain \
28892                 are listed at $dnslist_domain ($dnslist_value); \
28893                 see $dnslist_text.
28894      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28895                                    ${lookup dnsdb {>|mxh=\
28896                                    $sender_address_domain} }} }
28897 .endd
28898 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28899 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28900 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28901 of expanding the condition might be something like this:
28902 .code
28903 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28904 .endd
28905 Thus, this example checks whether or not the IP addresses of the sender
28906 domain's mail servers are on the Spamhaus black list.
28907
28908 The key that was used for a successful DNS list lookup is put into the variable
28909 &$dnslist_matched$& (see section &<<SECID204>>&).
28910
28911
28912
28913
28914 .section "Data returned by DNS lists" "SECID203"
28915 .cindex "DNS list" "data returned from"
28916 DNS lists are constructed using address records in the DNS. The original RBL
28917 just used the address 127.0.0.1 on the right hand side of each record, but the
28918 RBL+ list and some other lists use a number of values with different meanings.
28919 The values used on the RBL+ list are:
28920 .display
28921 127.1.0.1  RBL
28922 127.1.0.2  DUL
28923 127.1.0.3  DUL and RBL
28924 127.1.0.4  RSS
28925 127.1.0.5  RSS and RBL
28926 127.1.0.6  RSS and DUL
28927 127.1.0.7  RSS and DUL and RBL
28928 .endd
28929 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28930 different values. Some DNS lists may return more than one address record;
28931 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28932
28933
28934 .section "Variables set from DNS lists" "SECID204"
28935 .cindex "expansion" "variables, set from DNS list"
28936 .cindex "DNS list" "variables set from"
28937 .vindex "&$dnslist_domain$&"
28938 .vindex "&$dnslist_matched$&"
28939 .vindex "&$dnslist_text$&"
28940 .vindex "&$dnslist_value$&"
28941 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28942 the name of the overall domain that matched (for example,
28943 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28944 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28945 the DNS record. When the key is an IP address, it is not reversed in
28946 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28947 cases, for example:
28948 .code
28949 deny dnslists = spamhaus.example
28950 .endd
28951 the key is also available in another variable (in this case,
28952 &$sender_host_address$&). In more complicated cases, however, this is not true.
28953 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28954 might generate a dnslists lookup like this:
28955 .code
28956 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28957 .endd
28958 If this condition succeeds, the value in &$dnslist_matched$& might be
28959 &`192.168.6.7`& (for example).
28960
28961 If more than one address record is returned by the DNS lookup, all the IP
28962 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28963 The variable &$dnslist_text$& contains the contents of any associated TXT
28964 record. For lists such as RBL+ the TXT record for a merged entry is often not
28965 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28966 information.
28967
28968 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28969 &-- although these appear before the condition in the ACL, they are not
28970 expanded until after it has failed. For example:
28971 .code
28972 deny    hosts = !+local_networks
28973         message = $sender_host_address is listed \
28974                   at $dnslist_domain
28975         dnslists = rbl-plus.mail-abuse.example
28976 .endd
28977
28978
28979
28980 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28981 .cindex "DNS list" "matching specific returned data"
28982 You can add an equals sign and an IP address after a &%dnslists%& domain name
28983 in order to restrict its action to DNS records with a matching right hand side.
28984 For example,
28985 .code
28986 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28987 .endd
28988 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28989 any address record is considered to be a match. For the moment, we assume
28990 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28991 describes how multiple records are handled.
28992
28993 More than one IP address may be given for checking, using a comma as a
28994 separator. These are alternatives &-- if any one of them matches, the
28995 &%dnslists%& condition is true. For example:
28996 .code
28997 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28998 .endd
28999 If you want to specify a constraining address list and also specify names or IP
29000 addresses to be looked up, the constraining address list must be specified
29001 first. For example:
29002 .code
29003 deny dnslists = dsn.rfc-ignorant.org\
29004                 =127.0.0.2/$sender_address_domain
29005 .endd
29006
29007 If the character &`&&`& is used instead of &`=`&, the comparison for each
29008 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29009 In other words, the listed addresses are used as bit masks. The comparison is
29010 true if all the bits in the mask are present in the address that is being
29011 tested. For example:
29012 .code
29013 dnslists = a.b.c&0.0.0.3
29014 .endd
29015 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29016 want to test whether one bit or another bit is present (as opposed to both
29017 being present), you must use multiple values. For example:
29018 .code
29019 dnslists = a.b.c&0.0.0.1,0.0.0.2
29020 .endd
29021 matches if the final component of the address is an odd number or two times
29022 an odd number.
29023
29024
29025
29026 .section "Negated DNS matching conditions" "SECID205"
29027 You can supply a negative list of IP addresses as part of a &%dnslists%&
29028 condition. Whereas
29029 .code
29030 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29031 .endd
29032 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29033 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29034 .code
29035 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29036 .endd
29037 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29038 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29039 words, the result of the test is inverted if an exclamation mark appears before
29040 the &`=`& (or the &`&&`&) sign.
29041
29042 &*Note*&: This kind of negation is not the same as negation in a domain,
29043 host, or address list (which is why the syntax is different).
29044
29045 If you are using just one list, the negation syntax does not gain you much. The
29046 previous example is precisely equivalent to
29047 .code
29048 deny  dnslists = a.b.c
29049      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29050 .endd
29051 However, if you are using multiple lists, the negation syntax is clearer.
29052 Consider this example:
29053 .code
29054 deny  dnslists = sbl.spamhaus.org : \
29055                  list.dsbl.org : \
29056                  dnsbl.njabl.org!=127.0.0.3 : \
29057                  relays.ordb.org
29058 .endd
29059 Using only positive lists, this would have to be:
29060 .code
29061 deny  dnslists = sbl.spamhaus.org : \
29062                  list.dsbl.org
29063 deny  dnslists = dnsbl.njabl.org
29064      !dnslists = dnsbl.njabl.org=127.0.0.3
29065 deny  dnslists = relays.ordb.org
29066 .endd
29067 which is less clear, and harder to maintain.
29068
29069
29070
29071
29072 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29073 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29074 thereby providing more than one IP address. When an item in a &%dnslists%& list
29075 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29076 the match to specific results from the DNS lookup, there are two ways in which
29077 the checking can be handled. For example, consider the condition:
29078 .code
29079 dnslists = a.b.c=127.0.0.1
29080 .endd
29081 What happens if the DNS lookup for the incoming IP address yields both
29082 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29083 condition true because at least one given value was found, or is it false
29084 because at least one of the found values was not listed? And how does this
29085 affect negated conditions? Both possibilities are provided for with the help of
29086 additional separators &`==`& and &`=&&`&.
29087
29088 .ilist
29089 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29090 IP addresses matches one of the listed addresses. For the example above, the
29091 condition is true because 127.0.0.1 matches.
29092 .next
29093 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29094 looked up IP addresses matches one of the listed addresses. If the condition is
29095 changed to:
29096 .code
29097 dnslists = a.b.c==127.0.0.1
29098 .endd
29099 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29100 false because 127.0.0.2 is not listed. You would need to have:
29101 .code
29102 dnslists = a.b.c==127.0.0.1,127.0.0.2
29103 .endd
29104 for the condition to be true.
29105 .endlist
29106
29107 When &`!`& is used to negate IP address matching, it inverts the result, giving
29108 the precise opposite of the behaviour above. Thus:
29109 .ilist
29110 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29111 addresses matches one of the listed addresses. Consider:
29112 .code
29113 dnslists = a.b.c!&0.0.0.1
29114 .endd
29115 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29116 false because 127.0.0.1 matches.
29117 .next
29118 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29119 looked up IP address that does not match. Consider:
29120 .code
29121 dnslists = a.b.c!=&0.0.0.1
29122 .endd
29123 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29124 true, because 127.0.0.2 does not match. You would need to have:
29125 .code
29126 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29127 .endd
29128 for the condition to be false.
29129 .endlist
29130 When the DNS lookup yields only a single IP address, there is no difference
29131 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29132
29133
29134
29135
29136 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29137 .cindex "DNS list" "information from merged"
29138 When the facility for restricting the matching IP values in a DNS list is used,
29139 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29140 the true reason for rejection. This happens when lists are merged and the IP
29141 address in the A record is used to distinguish them; unfortunately there is
29142 only one TXT record. One way round this is not to use merged lists, but that
29143 can be inefficient because it requires multiple DNS lookups where one would do
29144 in the vast majority of cases when the host of interest is not on any of the
29145 lists.
29146
29147 A less inefficient way of solving this problem is available. If
29148 two domain names, comma-separated, are given, the second is used first to
29149 do an initial check, making use of any IP value restrictions that are set.
29150 If there is a match, the first domain is used, without any IP value
29151 restrictions, to get the TXT record. As a byproduct of this, there is also
29152 a check that the IP being tested is indeed on the first list. The first
29153 domain is the one that is put in &$dnslist_domain$&. For example:
29154 .code
29155 reject message  = \
29156          rejected because $sender_host_address is blacklisted \
29157          at $dnslist_domain\n$dnslist_text
29158        dnslists = \
29159          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29160          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29161 .endd
29162 For the first blacklist item, this starts by doing a lookup in
29163 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29164 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29165 value, and as long as something is found, it looks for the corresponding TXT
29166 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29167 The second blacklist item is processed similarly.
29168
29169 If you are interested in more than one merged list, the same list must be
29170 given several times, but because the results of the DNS lookups are cached,
29171 the DNS calls themselves are not repeated. For example:
29172 .code
29173 reject dnslists = \
29174          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29175          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29176          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29177          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29178 .endd
29179 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29180 values matches (or if no record is found), this is the only lookup that is
29181 done. Only if there is a match is one of the more specific lists consulted.
29182
29183
29184
29185 .section "DNS lists and IPv6" "SECTmorednslistslast"
29186 .cindex "IPv6" "DNS black lists"
29187 .cindex "DNS list" "IPv6 usage"
29188 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29189 nibble by nibble. For example, if the calling host's IP address is
29190 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29191 .code
29192 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29193   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29194 .endd
29195 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29196 lists contain wildcard records, intended for IPv4, that interact badly with
29197 IPv6. For example, the DNS entry
29198 .code
29199 *.3.some.list.example.    A    127.0.0.1
29200 .endd
29201 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29202 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29203
29204 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29205 &%condition%& condition, as in this example:
29206 .code
29207 deny   condition = ${if isip4{$sender_host_address}}
29208        dnslists  = some.list.example
29209 .endd
29210
29211 If an explicit key is being used for a DNS lookup and it may be an IPv6
29212 address you should specify alternate list separators for both the outer
29213 (DNS list name) list and inner (lookup keys) list:
29214 .code
29215        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29216 .endd
29217
29218 .section "Rate limiting incoming messages" "SECTratelimiting"
29219 .cindex "rate limiting" "client sending"
29220 .cindex "limiting client sending rates"
29221 .oindex "&%smtp_ratelimit_*%&"
29222 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29223 which clients can send email. This is more powerful than the
29224 &%smtp_ratelimit_*%& options, because those options control the rate of
29225 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29226 works across all connections (concurrent and sequential) from the same client
29227 host. The syntax of the &%ratelimit%& condition is:
29228 .display
29229 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29230 .endd
29231 If the average client sending rate is less than &'m'& messages per time
29232 period &'p'& then the condition is false; otherwise it is true.
29233
29234 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29235 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29236 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29237 of &'p'&.
29238
29239 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29240 time interval, for example, &`8h`& for eight hours. A larger time constant
29241 means that it takes Exim longer to forget a client's past behaviour. The
29242 parameter &'m'& is the maximum number of messages that a client is permitted to
29243 send in each time interval. It also specifies the number of messages permitted
29244 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29245 constant, you can allow a client to send more messages in a burst without
29246 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29247 both small, messages must be sent at an even rate.
29248
29249 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29250 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29251 when deploying the &%ratelimit%& ACL condition. The script prints usage
29252 instructions when it is run with no arguments.
29253
29254 The key is used to look up the data for calculating the client's average
29255 sending rate. This data is stored in Exim's spool directory, alongside the
29256 retry and other hints databases. The default key is &$sender_host_address$&,
29257 which means Exim computes the sending rate of each client host IP address.
29258 By changing the key you can change how Exim identifies clients for the purpose
29259 of ratelimiting. For example, to limit the sending rate of each authenticated
29260 user, independent of the computer they are sending from, set the key to
29261 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29262 example, &$authenticated_id$& is only meaningful if the client has
29263 authenticated (which you can check with the &%authenticated%& ACL condition).
29264
29265 The lookup key does not have to identify clients: If you want to limit the
29266 rate at which a recipient receives messages, you can use the key
29267 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29268 ACL.
29269
29270 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29271 specifies what Exim measures the rate of, for example messages or recipients
29272 or bytes. You can adjust the measurement using the &%unique=%& and/or
29273 &%count=%& options. You can also control when Exim updates the recorded rate
29274 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29275 separated by a slash, like the other parameters. They may appear in any order.
29276
29277 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29278 any options that alter the meaning of the stored data. The limit &'m'& is not
29279 stored, so you can alter the configured maximum rate and Exim will still
29280 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29281 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29282 behaviour. The lookup key is not affected by changes to the update mode and
29283 the &%count=%& option.
29284
29285
29286 .section "Ratelimit options for what is being measured" "ratoptmea"
29287 .cindex "rate limiting" "per_* options"
29288 The &%per_conn%& option limits the client's connection rate. It is not
29289 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29290 &%acl_not_smtp_start%& ACLs.
29291
29292 The &%per_mail%& option limits the client's rate of sending messages. This is
29293 the default if none of the &%per_*%& options is specified. It can be used in
29294 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29295 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29296
29297 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29298 the same ACLs as the &%per_mail%& option, though it is best to use this option
29299 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29300 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29301 in its MAIL command, which may be inaccurate or completely missing. You can
29302 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29303 in kilobytes, megabytes, or gigabytes, respectively.
29304
29305 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29306 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29307 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29308 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29309 ACLs the rate is updated with the total recipient count in one go. Note that
29310 in either case the rate limiting engine will see a message with many
29311 recipients as a large high-speed burst.
29312
29313 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29314 number of different recipients that the client has sent messages to in the
29315 last time period. That is, if the client repeatedly sends messages to the same
29316 recipient, its measured rate is not increased. This option can only be used in
29317 &%acl_smtp_rcpt%&.
29318
29319 The &%per_cmd%& option causes Exim to recompute the rate every time the
29320 condition is processed. This can be used to limit the rate of any SMTP
29321 command. If it is used in multiple ACLs it can limit the aggregate rate of
29322 multiple different commands.
29323
29324 The &%count=%& option can be used to alter how much Exim adds to the client's
29325 measured rate. For example, the &%per_byte%& option is equivalent to
29326 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29327 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29328 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29329
29330 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29331
29332
29333 .section "Ratelimit update modes" "ratoptupd"
29334 .cindex "rate limiting" "reading data without updating"
29335 You can specify one of three options with the &%ratelimit%& condition to
29336 control when its database is updated. This section describes the &%readonly%&
29337 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29338
29339 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29340 previously-computed rate to check against the limit.
29341
29342 For example, you can test the client's sending rate and deny it access (when
29343 it is too fast) in the connect ACL. If the client passes this check then it
29344 can go on to send a message, in which case its recorded rate will be updated
29345 in the MAIL ACL. Subsequent connections from the same client will check this
29346 new rate.
29347 .code
29348 acl_check_connect:
29349  deny ratelimit = 100 / 5m / readonly
29350     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29351                   (max $sender_rate_limit)
29352 # ...
29353 acl_check_mail:
29354  warn ratelimit = 100 / 5m / strict
29355     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29356                   (max $sender_rate_limit)
29357 .endd
29358
29359 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29360 processing a message then it may increase the client's measured rate more than
29361 it should. For example, this will happen if you check the &%per_rcpt%& option
29362 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29363 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29364 multiple update problems by using the &%readonly%& option on later ratelimit
29365 checks.
29366
29367 The &%per_*%& options described above do not make sense in some ACLs. If you
29368 use a &%per_*%& option in an ACL where it is not normally permitted then the
29369 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29370 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29371 next section) so you must specify the &%readonly%& option explicitly.
29372
29373
29374 .section "Ratelimit options for handling fast clients" "ratoptfast"
29375 .cindex "rate limiting" "strict and leaky modes"
29376 If a client's average rate is greater than the maximum, the rate limiting
29377 engine can react in two possible ways, depending on the presence of the
29378 &%strict%& or &%leaky%& update modes. This is independent of the other
29379 counter-measures (such as rejecting the message) that may be specified by the
29380 rest of the ACL.
29381
29382 The &%leaky%& (default) option means that the client's recorded rate is not
29383 updated if it is above the limit. The effect of this is that Exim measures the
29384 client's average rate of successfully sent email, which cannot be greater than
29385 the maximum allowed. If the client is over the limit it may suffer some
29386 counter-measures (as specified in the ACL), but it will still be able to send
29387 email at the configured maximum rate, whatever the rate of its attempts. This
29388 is generally the better choice if you have clients that retry automatically.
29389 For example, it does not prevent a sender with an over-aggressive retry rate
29390 from getting any email through.
29391
29392 The &%strict%& option means that the client's recorded rate is always
29393 updated. The effect of this is that Exim measures the client's average rate
29394 of attempts to send email, which can be much higher than the maximum it is
29395 actually allowed. If the client is over the limit it may be subjected to
29396 counter-measures by the ACL. It must slow down and allow sufficient time to
29397 pass that its computed rate falls below the maximum before it can send email
29398 again. The time (the number of smoothing periods) it must wait and not
29399 attempt to send mail can be calculated with this formula:
29400 .code
29401         ln(peakrate/maxrate)
29402 .endd
29403
29404
29405 .section "Limiting the rate of different events" "ratoptuniq"
29406 .cindex "rate limiting" "counting unique events"
29407 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29408 rate of different events. For example, the &%per_addr%& option uses this
29409 mechanism to count the number of different recipients that the client has
29410 sent messages to in the last time period; it is equivalent to
29411 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29412 measure the rate that a client uses different sender addresses with the
29413 options &`per_mail/unique=$sender_address`&.
29414
29415 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29416 has seen for that key. The whole set is thrown away when it is older than the
29417 rate smoothing period &'p'&, so each different event is counted at most once
29418 per period. In the &%leaky%& update mode, an event that causes the client to
29419 go over the limit is not added to the set, in the same way that the client's
29420 recorded rate is not updated in the same situation.
29421
29422 When you combine the &%unique=%& and &%readonly%& options, the specific
29423 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29424 rate.
29425
29426 The &%unique=%& mechanism needs more space in the ratelimit database than the
29427 other &%ratelimit%& options in order to store the event set. The number of
29428 unique values is potentially as large as the rate limit, so the extra space
29429 required increases with larger limits.
29430
29431 The uniqueification is not perfect: there is a small probability that Exim
29432 will think a new event has happened before. If the sender's rate is less than
29433 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29434 the measured rate can go above the limit, in which case Exim may under-count
29435 events by a significant margin. Fortunately, if the rate is high enough (2.7
29436 times the limit) that the false positive rate goes above 9%, then Exim will
29437 throw away the over-full event set before the measured rate falls below the
29438 limit. Therefore the only harm should be that exceptionally high sending rates
29439 are logged incorrectly; any countermeasures you configure will be as effective
29440 as intended.
29441
29442
29443 .section "Using rate limiting" "useratlim"
29444 Exim's other ACL facilities are used to define what counter-measures are taken
29445 when the rate limit is exceeded. This might be anything from logging a warning
29446 (for example, while measuring existing sending rates in order to define
29447 policy), through time delays to slow down fast senders, up to rejecting the
29448 message. For example:
29449 .code
29450 # Log all senders' rates
29451 warn ratelimit = 0 / 1h / strict
29452      log_message = Sender rate $sender_rate / $sender_rate_period
29453
29454 # Slow down fast senders; note the need to truncate $sender_rate
29455 # at the decimal point.
29456 warn ratelimit = 100 / 1h / per_rcpt / strict
29457      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29458                    $sender_rate_limit }s
29459
29460 # Keep authenticated users under control
29461 deny authenticated = *
29462      ratelimit = 100 / 1d / strict / $authenticated_id
29463
29464 # System-wide rate limit
29465 defer message = Sorry, too busy. Try again later.
29466      ratelimit = 10 / 1s / $primary_hostname
29467
29468 # Restrict incoming rate from each host, with a default
29469 # set using a macro and special cases looked up in a table.
29470 defer message = Sender rate exceeds $sender_rate_limit \
29471                messages per $sender_rate_period
29472      ratelimit = ${lookup {$sender_host_address} \
29473                    cdb {DB/ratelimits.cdb} \
29474                    {$value} {RATELIMIT} }
29475 .endd
29476 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29477 especially with the &%per_rcpt%& option, you may suffer from a performance
29478 bottleneck caused by locking on the ratelimit hints database. Apart from
29479 making your ACLs less complicated, you can reduce the problem by using a
29480 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29481 this means that Exim will lose its hints data after a reboot (including retry
29482 hints, the callout cache, and ratelimit data).
29483
29484
29485
29486 .section "Address verification" "SECTaddressverification"
29487 .cindex "verifying address" "options for"
29488 .cindex "policy control" "address verification"
29489 Several of the &%verify%& conditions described in section
29490 &<<SECTaclconditions>>& cause addresses to be verified. Section
29491 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29492 The verification conditions can be followed by options that modify the
29493 verification process. The options are separated from the keyword and from each
29494 other by slashes, and some of them contain parameters. For example:
29495 .code
29496 verify = sender/callout
29497 verify = recipient/defer_ok/callout=10s,defer_ok
29498 .endd
29499 The first stage of address verification, which always happens, is to run the
29500 address through the routers, in &"verify mode"&. Routers can detect the
29501 difference between verification and routing for delivery, and their actions can
29502 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29503 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29504 The available options are as follows:
29505
29506 .ilist
29507 If the &%callout%& option is specified, successful routing to one or more
29508 remote hosts is followed by a &"callout"& to those hosts as an additional
29509 check. Callouts and their sub-options are discussed in the next section.
29510 .next
29511 If there is a defer error while doing verification routing, the ACL
29512 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29513 options, the condition is forced to be true instead. Note that this is a main
29514 verification option as well as a suboption for callouts.
29515 .next
29516 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29517 discusses the reporting of sender address verification failures.
29518 .next
29519 The &%success_on_redirect%& option causes verification always to succeed
29520 immediately after a successful redirection. By default, if a redirection
29521 generates just one address, that address is also verified. See further
29522 discussion in section &<<SECTredirwhilveri>>&.
29523 .endlist
29524
29525 .cindex "verifying address" "differentiating failures"
29526 .vindex "&$recipient_verify_failure$&"
29527 .vindex "&$sender_verify_failure$&"
29528 .vindex "&$acl_verify_message$&"
29529 After an address verification failure, &$acl_verify_message$& contains the
29530 error message that is associated with the failure. It can be preserved by
29531 coding like this:
29532 .code
29533 warn  !verify = sender
29534        set acl_m0 = $acl_verify_message
29535 .endd
29536 If you are writing your own custom rejection message or log message when
29537 denying access, you can use this variable to include information about the
29538 verification failure.
29539
29540 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29541 appropriate) contains one of the following words:
29542
29543 .ilist
29544 &%qualify%&: The address was unqualified (no domain), and the message
29545 was neither local nor came from an exempted host.
29546 .next
29547 &%route%&: Routing failed.
29548 .next
29549 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29550 occurred at or before the MAIL command (that is, on initial
29551 connection, HELO, or MAIL).
29552 .next
29553 &%recipient%&: The RCPT command in a callout was rejected.
29554 .next
29555 &%postmaster%&: The postmaster check in a callout was rejected.
29556 .endlist
29557
29558 The main use of these variables is expected to be to distinguish between
29559 rejections of MAIL and rejections of RCPT in callouts.
29560
29561
29562
29563
29564 .section "Callout verification" "SECTcallver"
29565 .cindex "verifying address" "by callout"
29566 .cindex "callout" "verification"
29567 .cindex "SMTP" "callout verification"
29568 For non-local addresses, routing verifies the domain, but is unable to do any
29569 checking of the local part. There are situations where some means of verifying
29570 the local part is desirable. One way this can be done is to make an SMTP
29571 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29572 a subsequent host for a recipient address, to see if the host accepts the
29573 address. We use the term &'callout'& to cover both cases. Note that for a
29574 sender address, the callback is not to the client host that is trying to
29575 deliver the message, but to one of the hosts that accepts incoming mail for the
29576 sender's domain.
29577
29578 Exim does not do callouts by default. If you want them to happen, you must
29579 request them by setting appropriate options on the &%verify%& condition, as
29580 described below. This facility should be used with care, because it can add a
29581 lot of resource usage to the cost of verifying an address. However, Exim does
29582 cache the results of callouts, which helps to reduce the cost. Details of
29583 caching are in section &<<SECTcallvercache>>&.
29584
29585 Recipient callouts are usually used only between hosts that are controlled by
29586 the same administration. For example, a corporate gateway host could use
29587 callouts to check for valid recipients on an internal mailserver. A successful
29588 callout does not guarantee that a real delivery to the address would succeed;
29589 on the other hand, a failing callout does guarantee that a delivery would fail.
29590
29591 If the &%callout%& option is present on a condition that verifies an address, a
29592 second stage of verification occurs if the address is successfully routed to
29593 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29594 &(manualroute)& router, where the router specifies the hosts. However, if a
29595 router that does not set up hosts routes to an &(smtp)& transport with a
29596 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29597 &%hosts_override%& set, its hosts are always used, whether or not the router
29598 supplies a host list.
29599 Callouts are only supported on &(smtp)& transports.
29600
29601 The port that is used is taken from the transport, if it is specified and is a
29602 remote transport. (For routers that do verification only, no transport need be
29603 specified.) Otherwise, the default SMTP port is used. If a remote transport
29604 specifies an outgoing interface, this is used; otherwise the interface is not
29605 specified. Likewise, the text that is used for the HELO command is taken from
29606 the transport's &%helo_data%& option; if there is no transport, the value of
29607 &$smtp_active_hostname$& is used.
29608
29609 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29610 test whether a bounce message could be delivered to the sender address. The
29611 following SMTP commands are sent:
29612 .display
29613 &`HELO `&<&'local host name'&>
29614 &`MAIL FROM:<>`&
29615 &`RCPT TO:`&<&'the address to be tested'&>
29616 &`QUIT`&
29617 .endd
29618 LHLO is used instead of HELO if the transport's &%protocol%& option is
29619 set to &"lmtp"&.
29620
29621 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29622 settings.
29623
29624 A recipient callout check is similar. By default, it also uses an empty address
29625 for the sender. This default is chosen because most hosts do not make use of
29626 the sender address when verifying a recipient. Using the same address means
29627 that a single cache entry can be used for each recipient. Some sites, however,
29628 do make use of the sender address when verifying. These are catered for by the
29629 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29630
29631 If the response to the RCPT command is a 2&'xx'& code, the verification
29632 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29633 Exim tries the next host, if any. If there is a problem with all the remote
29634 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29635 &%callout%& option is given, in which case the condition is forced to succeed.
29636
29637 .cindex "SMTP" "output flushing, disabling for callout"
29638 A callout may take a little time. For this reason, Exim normally flushes SMTP
29639 output before performing a callout in an ACL, to avoid unexpected timeouts in
29640 clients when the SMTP PIPELINING extension is in use. The flushing can be
29641 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29642
29643
29644
29645
29646 .section "Additional parameters for callouts" "CALLaddparcall"
29647 .cindex "callout" "additional parameters for"
29648 The &%callout%& option can be followed by an equals sign and a number of
29649 optional parameters, separated by commas. For example:
29650 .code
29651 verify = recipient/callout=10s,defer_ok
29652 .endd
29653 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29654 separate verify options, is retained for backwards compatibility, but is now
29655 deprecated. The additional parameters for &%callout%& are as follows:
29656
29657
29658 .vlist
29659 .vitem <&'a&~time&~interval'&>
29660 .cindex "callout" "timeout, specifying"
29661 This specifies the timeout that applies for the callout attempt to each host.
29662 For example:
29663 .code
29664 verify = sender/callout=5s
29665 .endd
29666 The default is 30 seconds. The timeout is used for each response from the
29667 remote host. It is also used for the initial connection, unless overridden by
29668 the &%connect%& parameter.
29669
29670
29671 .vitem &*connect&~=&~*&<&'time&~interval'&>
29672 .cindex "callout" "connection timeout, specifying"
29673 This parameter makes it possible to set a different (usually smaller) timeout
29674 for making the SMTP connection. For example:
29675 .code
29676 verify = sender/callout=5s,connect=1s
29677 .endd
29678 If not specified, this timeout defaults to the general timeout value.
29679
29680 .vitem &*defer_ok*&
29681 .cindex "callout" "defer, action on"
29682 When this parameter is present, failure to contact any host, or any other kind
29683 of temporary error, is treated as success by the ACL. However, the cache is not
29684 updated in this circumstance.
29685
29686 .vitem &*fullpostmaster*&
29687 .cindex "callout" "full postmaster check"
29688 This operates like the &%postmaster%& option (see below), but if the check for
29689 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29690 accordance with the specification in RFC 2821. The RFC states that the
29691 unqualified address &'postmaster'& should be accepted.
29692
29693
29694 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29695 .cindex "callout" "sender when verifying header"
29696 When verifying addresses in header lines using the &%header_sender%&
29697 verification option, Exim behaves by default as if the addresses are envelope
29698 sender addresses from a message. Callout verification therefore tests to see
29699 whether a bounce message could be delivered, by using an empty address in the
29700 MAIL command. However, it is arguable that these addresses might never be used
29701 as envelope senders, and could therefore justifiably reject bounce messages
29702 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29703 address to use in the MAIL command. For example:
29704 .code
29705 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29706 .endd
29707 This parameter is available only for the &%header_sender%& verification option.
29708
29709
29710 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29711 .cindex "callout" "overall timeout, specifying"
29712 This parameter sets an overall timeout for performing a callout verification.
29713 For example:
29714 .code
29715 verify = sender/callout=5s,maxwait=30s
29716 .endd
29717 This timeout defaults to four times the callout timeout for individual SMTP
29718 commands. The overall timeout applies when there is more than one host that can
29719 be tried. The timeout is checked before trying the next host. This prevents
29720 very long delays if there are a large number of hosts and all are timing out
29721 (for example, when network connections are timing out).
29722
29723
29724 .vitem &*no_cache*&
29725 .cindex "callout" "cache, suppressing"
29726 .cindex "caching callout, suppressing"
29727 When this parameter is given, the callout cache is neither read nor updated.
29728
29729 .vitem &*postmaster*&
29730 .cindex "callout" "postmaster; checking"
29731 When this parameter is set, a successful callout check is followed by a similar
29732 check for the local part &'postmaster'& at the same domain. If this address is
29733 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29734 the postmaster check is recorded in a cache record; if it is a failure, this is
29735 used to fail subsequent callouts for the domain without a connection being
29736 made, until the cache record expires.
29737
29738 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29739 The postmaster check uses an empty sender in the MAIL command by default.
29740 You can use this parameter to do a postmaster check using a different address.
29741 For example:
29742 .code
29743 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29744 .endd
29745 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29746 one overrides. The &%postmaster%& parameter is equivalent to this example:
29747 .code
29748 require  verify = sender/callout=postmaster_mailfrom=
29749 .endd
29750 &*Warning*&: The caching arrangements for postmaster checking do not take
29751 account of the sender address. It is assumed that either the empty address or
29752 a fixed non-empty address will be used. All that Exim remembers is that the
29753 postmaster check for the domain succeeded or failed.
29754
29755
29756 .vitem &*random*&
29757 .cindex "callout" "&""random""& check"
29758 When this parameter is set, before doing the normal callout check, Exim does a
29759 check for a &"random"& local part at the same domain. The local part is not
29760 really random &-- it is defined by the expansion of the option
29761 &%callout_random_local_part%&, which defaults to
29762 .code
29763 $primary_hostname-$tod_epoch-testing
29764 .endd
29765 The idea here is to try to determine whether the remote host accepts all local
29766 parts without checking. If it does, there is no point in doing callouts for
29767 specific local parts. If the &"random"& check succeeds, the result is saved in
29768 a cache record, and used to force the current and subsequent callout checks to
29769 succeed without a connection being made, until the cache record expires.
29770
29771 .vitem &*use_postmaster*&
29772 .cindex "callout" "sender for recipient check"
29773 This parameter applies to recipient callouts only. For example:
29774 .code
29775 deny  !verify = recipient/callout=use_postmaster
29776 .endd
29777 .vindex "&$qualify_domain$&"
29778 It causes a non-empty postmaster address to be used in the MAIL command when
29779 performing the callout for the recipient, and also for a &"random"& check if
29780 that is configured. The local part of the address is &`postmaster`& and the
29781 domain is the contents of &$qualify_domain$&.
29782
29783 .vitem &*use_sender*&
29784 This option applies to recipient callouts only. For example:
29785 .code
29786 require  verify = recipient/callout=use_sender
29787 .endd
29788 It causes the message's actual sender address to be used in the MAIL
29789 command when performing the callout, instead of an empty address. There is no
29790 need to use this option unless you know that the called hosts make use of the
29791 sender when checking recipients. If used indiscriminately, it reduces the
29792 usefulness of callout caching.
29793 .endlist
29794
29795 If you use any of the parameters that set a non-empty sender for the MAIL
29796 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29797 &%use_sender%&), you should think about possible loops. Recipient checking is
29798 usually done between two hosts that are under the same management, and the host
29799 that receives the callouts is not normally configured to do callouts itself.
29800 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29801 these circumstances.
29802
29803 However, if you use a non-empty sender address for a callout to an arbitrary
29804 host, there is the likelihood that the remote host will itself initiate a
29805 callout check back to your host. As it is checking what appears to be a message
29806 sender, it is likely to use an empty address in MAIL, thus avoiding a
29807 callout loop. However, to be on the safe side it would be best to set up your
29808 own ACLs so that they do not do sender verification checks when the recipient
29809 is the address you use for header sender or postmaster callout checking.
29810
29811 Another issue to think about when using non-empty senders for callouts is
29812 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29813 by the sender/recipient combination; thus, for any given recipient, many more
29814 actual callouts are performed than when an empty sender or postmaster is used.
29815
29816
29817
29818
29819 .section "Callout caching" "SECTcallvercache"
29820 .cindex "hints database" "callout cache"
29821 .cindex "callout" "cache, description of"
29822 .cindex "caching" "callout"
29823 Exim caches the results of callouts in order to reduce the amount of resources
29824 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29825 option. A hints database called &"callout"& is used for the cache. Two
29826 different record types are used: one records the result of a callout check for
29827 a specific address, and the other records information that applies to the
29828 entire domain (for example, that it accepts the local part &'postmaster'&).
29829
29830 When an original callout fails, a detailed SMTP error message is given about
29831 the failure. However, for subsequent failures use the cache data, this message
29832 is not available.
29833
29834 The expiry times for negative and positive address cache records are
29835 independent, and can be set by the global options &%callout_negative_expire%&
29836 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29837
29838 If a host gives a negative response to an SMTP connection, or rejects any
29839 commands up to and including
29840 .code
29841 MAIL FROM:<>
29842 .endd
29843 (but not including the MAIL command with a non-empty address),
29844 any callout attempt is bound to fail. Exim remembers such failures in a
29845 domain cache record, which it uses to fail callouts for the domain without
29846 making new connections, until the domain record times out. There are two
29847 separate expiry times for domain cache records:
29848 &%callout_domain_negative_expire%& (default 3h) and
29849 &%callout_domain_positive_expire%& (default 7d).
29850
29851 Domain records expire when the negative expiry time is reached if callouts
29852 cannot be made for the domain, or if the postmaster check failed.
29853 Otherwise, they expire when the positive expiry time is reached. This
29854 ensures that, for example, a host that stops accepting &"random"& local parts
29855 will eventually be noticed.
29856
29857 The callout caching mechanism is based on the domain of the address that is
29858 being tested. If the domain routes to several hosts, it is assumed that their
29859 behaviour will be the same.
29860
29861
29862
29863 .section "Sender address verification reporting" "SECTsenaddver"
29864 .cindex "verifying" "suppressing error details"
29865 See section &<<SECTaddressverification>>& for a general discussion of
29866 verification. When sender verification fails in an ACL, the details of the
29867 failure are given as additional output lines before the 550 response to the
29868 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29869 you might see:
29870 .code
29871 MAIL FROM:<xyz@abc.example>
29872 250 OK
29873 RCPT TO:<pqr@def.example>
29874 550-Verification failed for <xyz@abc.example>
29875 550-Called:   192.168.34.43
29876 550-Sent:     RCPT TO:<xyz@abc.example>
29877 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29878 550 Sender verification failed
29879 .endd
29880 If more than one RCPT command fails in the same way, the details are given
29881 only for the first of them. However, some administrators do not want to send
29882 out this much information. You can suppress the details by adding
29883 &`/no_details`& to the ACL statement that requests sender verification. For
29884 example:
29885 .code
29886 verify = sender/no_details
29887 .endd
29888
29889 .section "Redirection while verifying" "SECTredirwhilveri"
29890 .cindex "verifying" "redirection while"
29891 .cindex "address redirection" "while verifying"
29892 A dilemma arises when a local address is redirected by aliasing or forwarding
29893 during verification: should the generated addresses themselves be verified,
29894 or should the successful expansion of the original address be enough to verify
29895 it? By default, Exim takes the following pragmatic approach:
29896
29897 .ilist
29898 When an incoming address is redirected to just one child address, verification
29899 continues with the child address, and if that fails to verify, the original
29900 verification also fails.
29901 .next
29902 When an incoming address is redirected to more than one child address,
29903 verification does not continue. A success result is returned.
29904 .endlist
29905
29906 This seems the most reasonable behaviour for the common use of aliasing as a
29907 way of redirecting different local parts to the same mailbox. It means, for
29908 example, that a pair of alias entries of the form
29909 .code
29910 A.Wol:   aw123
29911 aw123:   :fail: Gone away, no forwarding address
29912 .endd
29913 work as expected, with both local parts causing verification failure. When a
29914 redirection generates more than one address, the behaviour is more like a
29915 mailing list, where the existence of the alias itself is sufficient for
29916 verification to succeed.
29917
29918 It is possible, however, to change the default behaviour so that all successful
29919 redirections count as successful verifications, however many new addresses are
29920 generated. This is specified by the &%success_on_redirect%& verification
29921 option. For example:
29922 .code
29923 require verify = recipient/success_on_redirect/callout=10s
29924 .endd
29925 In this example, verification succeeds if a router generates a new address, and
29926 the callout does not occur, because no address was routed to a remote host.
29927
29928 When verification is being tested via the &%-bv%& option, the treatment of
29929 redirections is as just described, unless the &%-v%& or any debugging option is
29930 also specified. In that case, full verification is done for every generated
29931 address and a report is output for each of them.
29932
29933
29934
29935 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29936 .cindex "CSA" "verifying"
29937 Client SMTP Authorization is a system that allows a site to advertise
29938 which machines are and are not permitted to send email. This is done by placing
29939 special SRV records in the DNS; these are looked up using the client's HELO
29940 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29941 Authorization checks in Exim are performed by the ACL condition:
29942 .code
29943 verify = csa
29944 .endd
29945 This fails if the client is not authorized. If there is a DNS problem, or if no
29946 valid CSA SRV record is found, or if the client is authorized, the condition
29947 succeeds. These three cases can be distinguished using the expansion variable
29948 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29949 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29950 be likely to cause problems for legitimate email.
29951
29952 The error messages produced by the CSA code include slightly more
29953 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29954 looking up the CSA SRV record, or problems looking up the CSA target
29955 address record. There are four reasons for &$csa_status$& being &"fail"&:
29956
29957 .ilist
29958 The client's host name is explicitly not authorized.
29959 .next
29960 The client's IP address does not match any of the CSA target IP addresses.
29961 .next
29962 The client's host name is authorized but it has no valid target IP addresses
29963 (for example, the target's addresses are IPv6 and the client is using IPv4).
29964 .next
29965 The client's host name has no CSA SRV record but a parent domain has asserted
29966 that all subdomains must be explicitly authorized.
29967 .endlist
29968
29969 The &%csa%& verification condition can take an argument which is the domain to
29970 use for the DNS query. The default is:
29971 .code
29972 verify = csa/$sender_helo_name
29973 .endd
29974 This implementation includes an extension to CSA. If the query domain
29975 is an address literal such as [192.0.2.95], or if it is a bare IP
29976 address, Exim searches for CSA SRV records in the reverse DNS as if
29977 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29978 meaningful to say:
29979 .code
29980 verify = csa/$sender_host_address
29981 .endd
29982 In fact, this is the check that Exim performs if the client does not say HELO.
29983 This extension can be turned off by setting the main configuration option
29984 &%dns_csa_use_reverse%& to be false.
29985
29986 If a CSA SRV record is not found for the domain itself, a search
29987 is performed through its parent domains for a record which might be
29988 making assertions about subdomains. The maximum depth of this search is limited
29989 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29990 default. Exim does not look for CSA SRV records in a top level domain, so the
29991 default settings handle HELO domains as long as seven
29992 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29993 of legitimate HELO domains.
29994
29995 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29996 direct SRV lookups, this is not sufficient because of the extra parent domain
29997 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29998 addresses into lookups in the reverse DNS space. The result of a successful
29999 lookup such as:
30000 .code
30001 ${lookup dnsdb {csa=$sender_helo_name}}
30002 .endd
30003 has two space-separated fields: an authorization code and a target host name.
30004 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30005 authorization required but absent, or &"?"& for unknown.
30006
30007
30008
30009
30010 .section "Bounce address tag validation" "SECTverifyPRVS"
30011 .cindex "BATV, verifying"
30012 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30013 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30014 Genuine incoming bounce messages should therefore always be addressed to
30015 recipients that have a valid tag. This scheme is a way of detecting unwanted
30016 bounce messages caused by sender address forgeries (often called &"collateral
30017 spam"&), because the recipients of such messages do not include valid tags.
30018
30019 There are two expansion items to help with the implementation of the BATV
30020 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30021 the original envelope sender address by using a simple key to add a hash of the
30022 address and some time-based randomizing information. The &%prvs%& expansion
30023 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30024 The syntax of these expansion items is described in section
30025 &<<SECTexpansionitems>>&.
30026
30027 As an example, suppose the secret per-address keys are stored in an MySQL
30028 database. A query to look up the key for an address could be defined as a macro
30029 like this:
30030 .code
30031 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30032                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30033                 }{$value}}
30034 .endd
30035 Suppose also that the senders who make use of BATV are defined by an address
30036 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30037 use this:
30038 .code
30039 # Bounces: drop unsigned addresses for BATV senders
30040 deny message = This address does not send an unsigned reverse path
30041      senders = :
30042      recipients = +batv_senders
30043
30044 # Bounces: In case of prvs-signed address, check signature.
30045 deny message = Invalid reverse path signature.
30046      senders = :
30047      condition  = ${prvscheck {$local_part@$domain}\
30048                   {PRVSCHECK_SQL}{1}}
30049      !condition = $prvscheck_result
30050 .endd
30051 The first statement rejects recipients for bounce messages that are addressed
30052 to plain BATV sender addresses, because it is known that BATV senders do not
30053 send out messages with plain sender addresses. The second statement rejects
30054 recipients that are prvs-signed, but with invalid signatures (either because
30055 the key is wrong, or the signature has timed out).
30056
30057 A non-prvs-signed address is not rejected by the second statement, because the
30058 &%prvscheck%& expansion yields an empty string if its first argument is not a
30059 prvs-signed address, thus causing the &%condition%& condition to be false. If
30060 the first argument is a syntactically valid prvs-signed address, the yield is
30061 the third string (in this case &"1"&), whether or not the cryptographic and
30062 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30063 of the checks (empty for failure, &"1"& for success).
30064
30065 There is one more issue you must consider when implementing prvs-signing:
30066 you have to ensure that the routers accept prvs-signed addresses and
30067 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30068 router to remove the signature with a configuration along these lines:
30069 .code
30070 batv_redirect:
30071   driver = redirect
30072   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30073 .endd
30074 This works because, if the third argument of &%prvscheck%& is empty, the result
30075 of the expansion of a prvs-signed address is the decoded value of the original
30076 address. This router should probably be the first of your routers that handles
30077 local addresses.
30078
30079 To create BATV-signed addresses in the first place, a transport of this form
30080 can be used:
30081 .code
30082 external_smtp_batv:
30083   driver = smtp
30084   return_path = ${prvs {$return_path} \
30085                        {${lookup mysql{SELECT \
30086                        secret FROM batv_prvs WHERE \
30087                        sender='${quote_mysql:$sender_address}'} \
30088                        {$value}fail}}}
30089 .endd
30090 If no key can be found for the existing return path, no signing takes place.
30091
30092
30093
30094 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30095 .cindex "&ACL;" "relay control"
30096 .cindex "relaying" "control by ACL"
30097 .cindex "policy control" "relay control"
30098 An MTA is said to &'relay'& a message if it receives it from some host and
30099 delivers it directly to another host as a result of a remote address contained
30100 within it. Redirecting a local address via an alias or forward file and then
30101 passing the message on to another host is not relaying,
30102 .cindex "&""percent hack""&"
30103 but a redirection as a result of the &"percent hack"& is.
30104
30105 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30106 A host which is acting as a gateway or an MX backup is concerned with incoming
30107 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30108 a host which is acting as a smart host for a number of clients is concerned
30109 with outgoing relaying from those clients to the Internet at large. Often the
30110 same host is fulfilling both functions,
30111 . ///
30112 . as illustrated in the diagram below,
30113 . ///
30114 but in principle these two kinds of relaying are entirely independent. What is
30115 not wanted is the transmission of mail from arbitrary remote hosts through your
30116 system to arbitrary domains.
30117
30118
30119 You can implement relay control by means of suitable statements in the ACL that
30120 runs for each RCPT command. For convenience, it is often easiest to use
30121 Exim's named list facility to define the domains and hosts involved. For
30122 example, suppose you want to do the following:
30123
30124 .ilist
30125 Deliver a number of domains to mailboxes on the local host (or process them
30126 locally in some other way). Let's say these are &'my.dom1.example'& and
30127 &'my.dom2.example'&.
30128 .next
30129 Relay mail for a number of other domains for which you are the secondary MX.
30130 These might be &'friend1.example'& and &'friend2.example'&.
30131 .next
30132 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30133 Suppose your LAN is 192.168.45.0/24.
30134 .endlist
30135
30136
30137 In the main part of the configuration, you put the following definitions:
30138 .code
30139 domainlist local_domains    = my.dom1.example : my.dom2.example
30140 domainlist relay_to_domains = friend1.example : friend2.example
30141 hostlist   relay_from_hosts = 192.168.45.0/24
30142 .endd
30143 Now you can use these definitions in the ACL that is run for every RCPT
30144 command:
30145 .code
30146 acl_check_rcpt:
30147   accept domains = +local_domains : +relay_to_domains
30148   accept hosts   = +relay_from_hosts
30149 .endd
30150 The first statement accepts any RCPT command that contains an address in
30151 the local or relay domains. For any other domain, control passes to the second
30152 statement, which accepts the command only if it comes from one of the relay
30153 hosts. In practice, you will probably want to make your ACL more sophisticated
30154 than this, for example, by including sender and recipient verification. The
30155 default configuration includes a more comprehensive example, which is described
30156 in chapter &<<CHAPdefconfil>>&.
30157
30158
30159
30160 .section "Checking a relay configuration" "SECTcheralcon"
30161 .cindex "relaying" "checking control of"
30162 You can check the relay characteristics of your configuration in the same way
30163 that you can test any ACL behaviour for an incoming SMTP connection, by using
30164 the &%-bh%& option to run a fake SMTP session with which you interact.
30165
30166 For specifically testing for unwanted relaying, the host
30167 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30168 host from the host on which Exim is running, using the normal telnet port, you
30169 will see a normal telnet connection message and then quite a long delay. Be
30170 patient. The remote host is making an SMTP connection back to your host, and
30171 trying a number of common probes to test for open relay vulnerability. The
30172 results of the tests will eventually appear on your terminal.
30173 .ecindex IIDacl
30174
30175
30176
30177 . ////////////////////////////////////////////////////////////////////////////
30178 . ////////////////////////////////////////////////////////////////////////////
30179
30180 .chapter "Content scanning at ACL time" "CHAPexiscan"
30181 .scindex IIDcosca "content scanning" "at ACL time"
30182 The extension of Exim to include content scanning at ACL time, formerly known
30183 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30184 was integrated into the main source for Exim release 4.50, and Tom continues to
30185 maintain it. Most of the wording of this chapter is taken from Tom's
30186 specification.
30187
30188 It is also possible to scan the content of messages at other times. The
30189 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30190 scanning after all the ACLs have run. A transport filter can be used to scan
30191 messages at delivery time (see the &%transport_filter%& option, described in
30192 chapter &<<CHAPtransportgeneric>>&).
30193
30194 If you want to include the ACL-time content-scanning features when you compile
30195 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30196 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30197
30198 .ilist
30199 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30200 for all MIME parts for SMTP and non-SMTP messages, respectively.
30201 .next
30202 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30203 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30204 run at the end of message reception (the &%acl_smtp_data%& ACL).
30205 .next
30206 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30207 of messages, or parts of messages, for debugging purposes.
30208 .next
30209 Additional expansion variables that are set in the new ACL and by the new
30210 conditions.
30211 .next
30212 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30213 .endlist
30214
30215 There is another content-scanning configuration option for &_Local/Makefile_&,
30216 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30217 condition is compiled, in addition to all the other content-scanning features.
30218
30219 Content-scanning is continually evolving, and new features are still being
30220 added. While such features are still unstable and liable to incompatible
30221 changes, they are made available in Exim by setting options whose names begin
30222 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30223 this manual. You can find out about them by reading the file called
30224 &_doc/experimental.txt_&.
30225
30226 All the content-scanning facilities work on a MBOX copy of the message that is
30227 temporarily created in a file called:
30228 .display
30229 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30230 .endd
30231 The &_.eml_& extension is a friendly hint to virus scanners that they can
30232 expect an MBOX-like structure inside that file. The file is created when the
30233 first content scanning facility is called. Subsequent calls to content
30234 scanning conditions open the same file again. The directory is recursively
30235 removed when the &%acl_smtp_data%& ACL has finished running, unless
30236 .code
30237 control = no_mbox_unspool
30238 .endd
30239 has been encountered. When the MIME ACL decodes files, they are put into the
30240 same directory by default.
30241
30242
30243
30244 .section "Scanning for viruses" "SECTscanvirus"
30245 .cindex "virus scanning"
30246 .cindex "content scanning" "for viruses"
30247 .cindex "content scanning" "the &%malware%& condition"
30248 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30249 It supports a &"generic"& interface to scanners called via the shell, and
30250 specialized interfaces for &"daemon"& type virus scanners, which are resident
30251 in memory and thus are much faster.
30252
30253
30254 .oindex "&%av_scanner%&"
30255 You can set the &%av_scanner%& option in first part of the Exim configuration
30256 file to specify which scanner to use, together with any additional options that
30257 are needed. The basic syntax is as follows:
30258 .display
30259 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30260 .endd
30261 If you do not set &%av_scanner%&, it defaults to
30262 .code
30263 av_scanner = sophie:/var/run/sophie
30264 .endd
30265 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30266 before use.
30267 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30268 The following scanner types are supported in this release:
30269
30270 .vlist
30271 .vitem &%aveserver%&
30272 .cindex "virus scanners" "Kaspersky"
30273 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30274 at &url(http://www.kaspersky.com). This scanner type takes one option,
30275 which is the path to the daemon's UNIX socket. The default is shown in this
30276 example:
30277 .code
30278 av_scanner = aveserver:/var/run/aveserver
30279 .endd
30280
30281
30282 .vitem &%clamd%&
30283 .cindex "virus scanners" "clamd"
30284 This daemon-type scanner is GPL and free. You can get it at
30285 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30286 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30287 in the MIME ACL. This no longer believed to be necessary. One option is
30288 required: either the path and name of a UNIX socket file, or a hostname or IP
30289 number, and a port, separated by space, as in the second of these examples:
30290 .code
30291 av_scanner = clamd:/opt/clamd/socket
30292 av_scanner = clamd:192.0.2.3 1234
30293 av_scanner = clamd:192.0.2.3 1234:local
30294 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30295 .endd
30296 If the value of av_scanner points to a UNIX socket file or contains the local
30297 keyword, then the ClamAV interface will pass a filename containing the data
30298 to be scanned, which will should normally result in less I/O happening and be
30299 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30300 Exim does not assume that there is a common filesystem with the remote host.
30301 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30302 you be running a version of ClamAV prior to 0.95.
30303
30304 The final example shows that multiple TCP targets can be specified.  Exim will
30305 randomly use one for each incoming email (i.e. it load balances them).  Note
30306 that only TCP targets may be used if specifying a list of scanners; a UNIX
30307 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30308 unavailable, Exim will try the remaining one(s) until it finds one that works.
30309 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30310 not keep track of scanner state between multiple messages, and the scanner
30311 selection is random, so the message will get logged in the mainlog for each
30312 email that the down scanner gets chosen first (message wrapped to be readable):
30313 .code
30314 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30315    clamd: connection to localhost, port 3310 failed
30316    (Connection refused)
30317 .endd
30318
30319 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30320 contributing the code for this scanner.
30321
30322 .vitem &%cmdline%&
30323 .cindex "virus scanners" "command line interface"
30324 This is the keyword for the generic command line scanner interface. It can be
30325 used to attach virus scanners that are invoked from the shell. This scanner
30326 type takes 3 mandatory options:
30327
30328 .olist
30329 The full path and name of the scanner binary, with all command line options,
30330 and a placeholder (&`%s`&) for the directory to scan.
30331
30332 .next
30333 A regular expression to match against the STDOUT and STDERR output of the
30334 virus scanner. If the expression matches, a virus was found. You must make
30335 absolutely sure that this expression matches on &"virus found"&. This is called
30336 the &"trigger"& expression.
30337
30338 .next
30339 Another regular expression, containing exactly one pair of parentheses, to
30340 match the name of the virus found in the scanners output. This is called the
30341 &"name"& expression.
30342 .endlist olist
30343
30344 For example, Sophos Sweep reports a virus on a line like this:
30345 .code
30346 Virus 'W32/Magistr-B' found in file ./those.bat
30347 .endd
30348 For the trigger expression, we can match the phrase &"found in file"&. For the
30349 name expression, we want to extract the W32/Magistr-B string, so we can match
30350 for the single quotes left and right of it. Altogether, this makes the
30351 configuration setting:
30352 .code
30353 av_scanner = cmdline:\
30354              /path/to/sweep -ss -all -rec -archive %s:\
30355              found in file:'(.+)'
30356 .endd
30357 .vitem &%drweb%&
30358 .cindex "virus scanners" "DrWeb"
30359 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30360 takes one option,
30361 either a full path to a UNIX socket,
30362 or host and port specifiers separated by white space.
30363 The host may be a name or an IP address; the port is either a
30364 single number or a pair of numbers with a dash between.
30365 For example:
30366 .code
30367 av_scanner = drweb:/var/run/drwebd.sock
30368 av_scanner = drweb:192.168.2.20 31337
30369 .endd
30370 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30371 is used. Thanks to Alex Miller for contributing the code for this scanner.
30372
30373 .vitem &%f-protd%&
30374 .cindex "virus scanners" "f-protd"
30375 The f-protd scanner is accessed via HTTP over TCP.
30376 One argument is taken, being a space-separated hostname and port number
30377 (or port-range).
30378 For example:
30379 .code
30380 av_scanner = f-protd:localhost 10200-10204
30381 .endd
30382 If you omit the argument, the default values show above are used.
30383
30384 .vitem &%fsecure%&
30385 .cindex "virus scanners" "F-Secure"
30386 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30387 argument which is the path to a UNIX socket. For example:
30388 .code
30389 av_scanner = fsecure:/path/to/.fsav
30390 .endd
30391 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30392 Thelmen for contributing the code for this scanner.
30393
30394 .vitem &%kavdaemon%&
30395 .cindex "virus scanners" "Kaspersky"
30396 This is the scanner daemon of Kaspersky Version 4. This version of the
30397 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30398 scanner type takes one option, which is the path to the daemon's UNIX socket.
30399 For example:
30400 .code
30401 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30402 .endd
30403 The default path is &_/var/run/AvpCtl_&.
30404
30405 .vitem &%mksd%&
30406 .cindex "virus scanners" "mksd"
30407 This is a daemon type scanner that is aimed mainly at Polish users, though some
30408 parts of documentation are now available in English. You can get it at
30409 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30410 the maximum number of processes used simultaneously to scan the attachments,
30411 provided that the demime facility is employed and also provided that mksd has
30412 been run with at least the same number of child processes. For example:
30413 .code
30414 av_scanner = mksd:2
30415 .endd
30416 You can safely omit this option (the default value is 1).
30417
30418 .vitem &%sock%&
30419 .cindex "virus scanners" "simple socket-connected"
30420 This is a general-purpose way of talking to simple scanner daemons
30421 running on the local machine.
30422 There are four options:
30423 an address (which may be an IP addres and port, or the path of a Unix socket),
30424 a commandline to send (may include a single %s which will be replaced with
30425 the path to the mail file to be scanned),
30426 an RE to trigger on from the returned data,
30427 an RE to extract malware_name from the returned data.
30428 For example:
30429 .code
30430 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30431 .endd
30432 Default for the socket specifier is &_/tmp/malware.sock_&.
30433 Default for the commandline is &_%s\n_&.
30434 Both regular-expressions are required.
30435
30436 .vitem &%sophie%&
30437 .cindex "virus scanners" "Sophos and Sophie"
30438 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30439 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30440 for this scanner type is the path to the UNIX socket that Sophie uses for
30441 client communication. For example:
30442 .code
30443 av_scanner = sophie:/tmp/sophie
30444 .endd
30445 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30446 the option.
30447 .endlist
30448
30449 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30450 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30451 ACL.
30452
30453 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30454 makes it possible to use different scanners. See further below for an example.
30455 The &%malware%& condition caches its results, so when you use it multiple times
30456 for the same message, the actual scanning process is only carried out once.
30457 However, using expandable items in &%av_scanner%& disables this caching, in
30458 which case each use of the &%malware%& condition causes a new scan of the
30459 message.
30460
30461 The &%malware%& condition takes a right-hand argument that is expanded before
30462 use. It can then be one of
30463
30464 .ilist
30465 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30466 The condition succeeds if a virus was found, and fail otherwise. This is the
30467 recommended usage.
30468 .next
30469 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30470 the condition fails immediately.
30471 .next
30472 A regular expression, in which case the message is scanned for viruses. The
30473 condition succeeds if a virus is found and its name matches the regular
30474 expression. This allows you to take special actions on certain types of virus.
30475 .endlist
30476
30477 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
30478 even if there is a problem with the virus scanner. Otherwise, such a problem
30479 causes the ACL to defer.
30480
30481 .vindex "&$malware_name$&"
30482 When a virus is found, the condition sets up an expansion variable called
30483 &$malware_name$& that contains the name of the virus. You can use it in a
30484 &%message%& modifier that specifies the error returned to the sender, and/or in
30485 logging data.
30486
30487 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30488 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30489 &%malware%& condition.
30490
30491 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30492 imposed by your anti-virus scanner.
30493
30494 Here is a very simple scanning example:
30495 .code
30496 deny message = This message contains malware ($malware_name)
30497      demime = *
30498      malware = *
30499 .endd
30500 The next example accepts messages when there is a problem with the scanner:
30501 .code
30502 deny message = This message contains malware ($malware_name)
30503      demime = *
30504      malware = */defer_ok
30505 .endd
30506 The next example shows how to use an ACL variable to scan with both sophie and
30507 aveserver. It assumes you have set:
30508 .code
30509 av_scanner = $acl_m0
30510 .endd
30511 in the main Exim configuration.
30512 .code
30513 deny message = This message contains malware ($malware_name)
30514      set acl_m0 = sophie
30515      malware = *
30516
30517 deny message = This message contains malware ($malware_name)
30518      set acl_m0 = aveserver
30519      malware = *
30520 .endd
30521
30522
30523 .section "Scanning with SpamAssassin" "SECTscanspamass"
30524 .cindex "content scanning" "for spam"
30525 .cindex "spam scanning"
30526 .cindex "SpamAssassin"
30527 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30528 score and a report for the message. You can get SpamAssassin at
30529 &url(http://www.spamassassin.org), or, if you have a working Perl
30530 installation, you can use CPAN by running:
30531 .code
30532 perl -MCPAN -e 'install Mail::SpamAssassin'
30533 .endd
30534 SpamAssassin has its own set of configuration files. Please review its
30535 documentation to see how you can tweak it. The default installation should work
30536 nicely, however.
30537
30538 .oindex "&%spamd_address%&"
30539 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30540 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30541 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30542 part of the Exim configuration as follows (example):
30543 .code
30544 spamd_address = 192.168.99.45 387
30545 .endd
30546 You do not need to set this option if you use the default. As of version 2.60,
30547 &%spamd%& also supports communication over UNIX sockets. If you want to use
30548 these, supply &%spamd_address%& with an absolute file name instead of a
30549 address/port pair:
30550 .code
30551 spamd_address = /var/run/spamd_socket
30552 .endd
30553 You can have multiple &%spamd%& servers to improve scalability. These can
30554 reside on other hardware reachable over the network. To specify multiple
30555 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30556 option, separated with colons:
30557 .code
30558 spamd_address = 192.168.2.10 783 : \
30559                 192.168.2.11 783 : \
30560                 192.168.2.12 783
30561 .endd
30562 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30563 fashion. When a server fails to respond to the connection attempt, all other
30564 servers are tried until one succeeds. If no server responds, the &%spam%&
30565 condition defers.
30566
30567 &*Warning*&: It is not possible to use the UNIX socket connection method with
30568 multiple &%spamd%& servers.
30569
30570 The &%spamd_address%& variable is expanded before use if it starts with
30571 a dollar sign. In this case, the expansion may return a string that is
30572 used as the list so that multiple spamd servers can be the result of an
30573 expansion.
30574
30575 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30576 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30577 .code
30578 deny message = This message was classified as SPAM
30579      spam = joe
30580 .endd
30581 The right-hand side of the &%spam%& condition specifies a name. This is
30582 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30583 to scan using a specific profile, but rather use the SpamAssassin system-wide
30584 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30585 However, you must put something on the right-hand side.
30586
30587 The name allows you to use per-domain or per-user antispam profiles in
30588 principle, but this is not straightforward in practice, because a message may
30589 have multiple recipients, not necessarily all in the same domain. Because the
30590 &%spam%& condition has to be called from a DATA ACL in order to be able to
30591 read the contents of the message, the variables &$local_part$& and &$domain$&
30592 are not set.
30593
30594 The right-hand side of the &%spam%& condition is expanded before being used, so
30595 you can put lookups or conditions there. When the right-hand side evaluates to
30596 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30597
30598
30599 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30600 large ones may cause significant performance degradation. As most spam messages
30601 are quite small, it is recommended that you do not scan the big ones. For
30602 example:
30603 .code
30604 deny message = This message was classified as SPAM
30605      condition = ${if < {$message_size}{10K}}
30606      spam = nobody
30607 .endd
30608
30609 The &%spam%& condition returns true if the threshold specified in the user's
30610 SpamAssassin profile has been matched or exceeded. If you want to use the
30611 &%spam%& condition for its side effects (see the variables below), you can make
30612 it always return &"true"& by appending &`:true`& to the username.
30613
30614 .cindex "spam scanning" "returned variables"
30615 When the &%spam%& condition is run, it sets up a number of expansion
30616 variables. These variables are saved with the received message, thus they are
30617 available for use at delivery time.
30618
30619 .vlist
30620 .vitem &$spam_score$&
30621 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30622 for inclusion in log or reject messages.
30623
30624 .vitem &$spam_score_int$&
30625 The spam score of the message, multiplied by ten, as an integer value. For
30626 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30627 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30628 The integer value is useful for numeric comparisons in conditions.
30629
30630 .vitem &$spam_bar$&
30631 A string consisting of a number of &"+"& or &"-"& characters, representing the
30632 integer part of the spam score value. A spam score of 4.4 would have a
30633 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30634 headers, since MUAs can match on such strings.
30635
30636 .vitem &$spam_report$&
30637 A multiline text table, containing the full SpamAssassin report for the
30638 message. Useful for inclusion in headers or reject messages.
30639 .endlist
30640
30641 The &%spam%& condition caches its results unless expansion in
30642 spamd_address was used. If you call it again with the same user name, it
30643 does not scan again, but rather returns the same values as before.
30644
30645 The &%spam%& condition returns DEFER if there is any error while running
30646 the message through SpamAssassin or if the expansion of spamd_address
30647 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30648 statement block), append &`/defer_ok`& to the right-hand side of the
30649 spam condition, like this:
30650 .code
30651 deny message = This message was classified as SPAM
30652      spam    = joe/defer_ok
30653 .endd
30654 This causes messages to be accepted even if there is a problem with &%spamd%&.
30655
30656 Here is a longer, commented example of the use of the &%spam%&
30657 condition:
30658 .code
30659 # put headers in all messages (no matter if spam or not)
30660 warn  spam = nobody:true
30661       add_header = X-Spam-Score: $spam_score ($spam_bar)
30662       add_header = X-Spam-Report: $spam_report
30663
30664 # add second subject line with *SPAM* marker when message
30665 # is over threshold
30666 warn  spam = nobody
30667       add_header = Subject: *SPAM* $h_Subject:
30668
30669 # reject spam at high scores (> 12)
30670 deny  message = This message scored $spam_score spam points.
30671       spam = nobody:true
30672       condition = ${if >{$spam_score_int}{120}{1}{0}}
30673 .endd
30674
30675
30676
30677 .section "Scanning MIME parts" "SECTscanmimepart"
30678 .cindex "content scanning" "MIME parts"
30679 .cindex "MIME content scanning"
30680 .oindex "&%acl_smtp_mime%&"
30681 .oindex "&%acl_not_smtp_mime%&"
30682 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30683 each MIME part of an SMTP message, including multipart types, in the sequence
30684 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30685 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30686 options may both refer to the same ACL if you want the same processing in both
30687 cases.
30688
30689 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30690 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30691 the case of a non-SMTP message. However, a MIME ACL is called only if the
30692 message contains a &'Content-Type:'& header line. When a call to a MIME
30693 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30694 result code is sent to the client. In the case of an SMTP message, the
30695 &%acl_smtp_data%& ACL is not called when this happens.
30696
30697 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30698 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30699 condition to match against the raw MIME part. You can also use the
30700 &%mime_regex%& condition to match against the decoded MIME part (see section
30701 &<<SECTscanregex>>&).
30702
30703 At the start of a MIME ACL, a number of variables are set from the header
30704 information for the relevant MIME part. These are described below. The contents
30705 of the MIME part are not by default decoded into a disk file except for MIME
30706 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30707 part into a disk file, you can use the &%decode%& condition. The general
30708 syntax is:
30709 .display
30710 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30711 .endd
30712 The right hand side is expanded before use. After expansion,
30713 the value can be:
30714
30715 .olist
30716 &"0"& or &"false"&, in which case no decoding is done.
30717 .next
30718 The string &"default"&. In that case, the file is put in the temporary
30719 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30720 a sequential file name consisting of the message id and a sequence number. The
30721 full path and name is available in &$mime_decoded_filename$& after decoding.
30722 .next
30723 A full path name starting with a slash. If the full name is an existing
30724 directory, it is used as a replacement for the default directory. The filename
30725 is then sequentially assigned. If the path does not exist, it is used as
30726 the full path and file name.
30727 .next
30728 If the string does not start with a slash, it is used as the
30729 filename, and the default path is then used.
30730 .endlist
30731 The &%decode%& condition normally succeeds. It is only false for syntax
30732 errors or unusual circumstances such as memory shortages. You can easily decode
30733 a file with its original, proposed filename using
30734 .code
30735 decode = $mime_filename
30736 .endd
30737 However, you should keep in mind that &$mime_filename$& might contain
30738 anything. If you place files outside of the default path, they are not
30739 automatically unlinked.
30740
30741 For RFC822 attachments (these are messages attached to messages, with a
30742 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30743 as for the primary message, only that the &$mime_is_rfc822$& expansion
30744 variable is set (see below). Attached messages are always decoded to disk
30745 before being checked, and the files are unlinked once the check is done.
30746
30747 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30748 used to match regular expressions against raw and decoded MIME parts,
30749 respectively. They are described in section &<<SECTscanregex>>&.
30750
30751 .cindex "MIME content scanning" "returned variables"
30752 The following list describes all expansion variables that are
30753 available in the MIME ACL:
30754
30755 .vlist
30756 .vitem &$mime_boundary$&
30757 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30758 have a boundary string, which is stored in this variable. If the current part
30759 has no boundary parameter in the &'Content-Type:'& header, this variable
30760 contains the empty string.
30761
30762 .vitem &$mime_charset$&
30763 This variable contains the character set identifier, if one was found in the
30764 &'Content-Type:'& header. Examples for charset identifiers are:
30765 .code
30766 us-ascii
30767 gb2312 (Chinese)
30768 iso-8859-1
30769 .endd
30770 Please note that this value is not normalized, so you should do matches
30771 case-insensitively.
30772
30773 .vitem &$mime_content_description$&
30774 This variable contains the normalized content of the &'Content-Description:'&
30775 header. It can contain a human-readable description of the parts content. Some
30776 implementations repeat the filename for attachments here, but they are usually
30777 only used for display purposes.
30778
30779 .vitem &$mime_content_disposition$&
30780 This variable contains the normalized content of the &'Content-Disposition:'&
30781 header. You can expect strings like &"attachment"& or &"inline"& here.
30782
30783 .vitem &$mime_content_id$&
30784 This variable contains the normalized content of the &'Content-ID:'& header.
30785 This is a unique ID that can be used to reference a part from another part.
30786
30787 .vitem &$mime_content_size$&
30788 This variable is set only after the &%decode%& modifier (see above) has been
30789 successfully run. It contains the size of the decoded part in kilobytes. The
30790 size is always rounded up to full kilobytes, so only a completely empty part
30791 has a &$mime_content_size$& of zero.
30792
30793 .vitem &$mime_content_transfer_encoding$&
30794 This variable contains the normalized content of the
30795 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30796 type. Typical values are &"base64"& and &"quoted-printable"&.
30797
30798 .vitem &$mime_content_type$&
30799 If the MIME part has a &'Content-Type:'& header, this variable contains its
30800 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30801 are some examples of popular MIME types, as they may appear in this variable:
30802 .code
30803 text/plain
30804 text/html
30805 application/octet-stream
30806 image/jpeg
30807 audio/midi
30808 .endd
30809 If the MIME part has no &'Content-Type:'& header, this variable contains the
30810 empty string.
30811
30812 .vitem &$mime_decoded_filename$&
30813 This variable is set only after the &%decode%& modifier (see above) has been
30814 successfully run. It contains the full path and file name of the file
30815 containing the decoded data.
30816 .endlist
30817
30818 .cindex "RFC 2047"
30819 .vlist
30820 .vitem &$mime_filename$&
30821 This is perhaps the most important of the MIME variables. It contains a
30822 proposed filename for an attachment, if one was found in either the
30823 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30824 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30825 found, this variable contains the empty string.
30826
30827 .vitem &$mime_is_coverletter$&
30828 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30829 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30830 content in the cover letter, while not restricting attachments at all.
30831
30832 The variable contains 1 (true) for a MIME part believed to be part of the
30833 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30834 follows:
30835
30836 .olist
30837 The outermost MIME part of a message is always a cover letter.
30838
30839 .next
30840 If a multipart/alternative or multipart/related MIME part is a cover letter,
30841 so are all MIME subparts within that multipart.
30842
30843 .next
30844 If any other multipart is a cover letter, the first subpart is a cover letter,
30845 and the rest are attachments.
30846
30847 .next
30848 All parts contained within an attachment multipart are attachments.
30849 .endlist olist
30850
30851 As an example, the following will ban &"HTML mail"& (including that sent with
30852 alternative plain text), while allowing HTML files to be attached. HTML
30853 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30854 .code
30855 deny message = HTML mail is not accepted here
30856 !condition = $mime_is_rfc822
30857 condition = $mime_is_coverletter
30858 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30859 .endd
30860 .vitem &$mime_is_multipart$&
30861 This variable has the value 1 (true) when the current part has the main type
30862 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30863 Since multipart entities only serve as containers for other parts, you may not
30864 want to carry out specific actions on them.
30865
30866 .vitem &$mime_is_rfc822$&
30867 This variable has the value 1 (true) if the current part is not a part of the
30868 checked message itself, but part of an attached message. Attached message
30869 decoding is fully recursive.
30870
30871 .vitem &$mime_part_count$&
30872 This variable is a counter that is raised for each processed MIME part. It
30873 starts at zero for the very first part (which is usually a multipart). The
30874 counter is per-message, so it is reset when processing RFC822 attachments (see
30875 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30876 complete, so you can use it in the DATA ACL to determine the number of MIME
30877 parts of a message. For non-MIME messages, this variable contains the value -1.
30878 .endlist
30879
30880
30881
30882 .section "Scanning with regular expressions" "SECTscanregex"
30883 .cindex "content scanning" "with regular expressions"
30884 .cindex "regular expressions" "content scanning with"
30885 You can specify your own custom regular expression matches on the full body of
30886 the message, or on individual MIME parts.
30887
30888 The &%regex%& condition takes one or more regular expressions as arguments and
30889 matches them against the full message (when called in the DATA ACL) or a raw
30890 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30891 linewise, with a maximum line length of 32K characters. That means you cannot
30892 have multiline matches with the &%regex%& condition.
30893
30894 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30895 to 32K of decoded content (the whole content at once, not linewise). If the
30896 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30897 is decoded automatically when &%mime_regex%& is executed (using default path
30898 and filename values). If the decoded data is larger than  32K, only the first
30899 32K characters are checked.
30900
30901 The regular expressions are passed as a colon-separated list. To include a
30902 literal colon, you must double it. Since the whole right-hand side string is
30903 expanded before being used, you must also escape dollar signs and backslashes
30904 with more backslashes, or use the &`\N`& facility to disable expansion.
30905 Here is a simple example that contains two regular expressions:
30906 .code
30907 deny message = contains blacklisted regex ($regex_match_string)
30908      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30909 .endd
30910 The conditions returns true if any one of the regular expressions matches. The
30911 &$regex_match_string$& expansion variable is then set up and contains the
30912 matching regular expression.
30913
30914 &*Warning*&: With large messages, these conditions can be fairly
30915 CPU-intensive.
30916
30917
30918
30919
30920 .section "The demime condition" "SECTdemimecond"
30921 .cindex "content scanning" "MIME checking"
30922 .cindex "MIME content scanning"
30923 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30924 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30925 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30926 ACL functionality, but provides no additional facilities. Please note that this
30927 condition is deprecated and kept only for backward compatibility. You must set
30928 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30929 use the &%demime%& condition.
30930
30931 The &%demime%& condition unpacks MIME containers in the message. It detects
30932 errors in MIME containers and can match file extensions found in the message
30933 against a list. Using this facility produces files containing the unpacked MIME
30934 parts of the message in the temporary scan directory. If you do antivirus
30935 scanning, it is recommended that you use the &%demime%& condition before the
30936 antivirus (&%malware%&) condition.
30937
30938 On the right-hand side of the &%demime%& condition you can pass a
30939 colon-separated list of file extensions that it should match against. For
30940 example:
30941 .code
30942 deny message = Found blacklisted file attachment
30943      demime  = vbs:com:bat:pif:prf:lnk
30944 .endd
30945 If one of the file extensions is found, the condition is true, otherwise it is
30946 false. If there is a temporary error while demimeing (for example, &"disk
30947 full"&), the condition defers, and the message is temporarily rejected (unless
30948 the condition is on a &%warn%& verb).
30949
30950 The right-hand side is expanded before being treated as a list, so you can have
30951 conditions and lookups there. If it expands to an empty string, &"false"&, or
30952 zero (&"0"&), no demimeing is done and the condition is false.
30953
30954 The &%demime%& condition set the following variables:
30955
30956 .vlist
30957 .vitem &$demime_errorlevel$&
30958 .vindex "&$demime_errorlevel$&"
30959 When an error is detected in a MIME container, this variable contains the
30960 severity of the error, as an integer number. The higher the value, the more
30961 severe the error (the current maximum value is 3). If this variable is unset or
30962 zero, no error occurred.
30963
30964 .vitem &$demime_reason$&
30965 .vindex "&$demime_reason$&"
30966 When &$demime_errorlevel$& is greater than zero, this variable contains a
30967 human-readable text string describing the MIME error that occurred.
30968 .endlist
30969
30970 .vlist
30971 .vitem &$found_extension$&
30972 .vindex "&$found_extension$&"
30973 When the &%demime%& condition is true, this variable contains the file
30974 extension it found.
30975 .endlist
30976
30977 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30978 the &%demime%& condition, and are not changed on subsequent calls.
30979
30980 If you do not want to check for file extensions, but rather use the &%demime%&
30981 condition for unpacking or error checking purposes, pass &"*"& as the
30982 right-hand side value. Here is a more elaborate example of how to use this
30983 facility:
30984 .code
30985 # Reject messages with serious MIME container errors
30986 deny  message = Found MIME error ($demime_reason).
30987       demime = *
30988       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30989
30990 # Reject known virus spreading file extensions.
30991 # Accepting these is pretty much braindead.
30992 deny  message = contains $found_extension file (blacklisted).
30993       demime  = com:vbs:bat:pif:scr
30994
30995 # Freeze .exe and .doc files. Postmaster can
30996 # examine them and eventually thaw them.
30997 deny  log_message = Another $found_extension file.
30998       demime = exe:doc
30999       control = freeze
31000 .endd
31001 .ecindex IIDcosca
31002
31003
31004
31005
31006 . ////////////////////////////////////////////////////////////////////////////
31007 . ////////////////////////////////////////////////////////////////////////////
31008
31009 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31010          "Local scan function"
31011 .scindex IIDlosca "&[local_scan()]& function" "description of"
31012 .cindex "customizing" "input scan using C function"
31013 .cindex "policy control" "by local scan function"
31014 In these days of email worms, viruses, and ever-increasing spam, some sites
31015 want to apply a lot of checking to messages before accepting them.
31016
31017 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31018 passing messages to external virus and spam scanning software. You can also do
31019 a certain amount in Exim itself through string expansions and the &%condition%&
31020 condition in the ACL that runs after the SMTP DATA command or the ACL for
31021 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31022
31023 To allow for further customization to a site's own requirements, there is the
31024 possibility of linking Exim with a private message scanning function, written
31025 in C. If you want to run code that is written in something other than C, you
31026 can of course use a little C stub to call it.
31027
31028 The local scan function is run once for every incoming message, at the point
31029 when Exim is just about to accept the message.
31030 It can therefore be used to control non-SMTP messages from local processes as
31031 well as messages arriving via SMTP.
31032
31033 Exim applies a timeout to calls of the local scan function, and there is an
31034 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31035 Zero means &"no timeout"&.
31036 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31037 before calling the local scan function, so that the most common types of crash
31038 are caught. If the timeout is exceeded or one of those signals is caught, the
31039 incoming message is rejected with a temporary error if it is an SMTP message.
31040 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31041 code. The incident is logged on the main and reject logs.
31042
31043
31044
31045 .section "Building Exim to use a local scan function" "SECID207"
31046 .cindex "&[local_scan()]& function" "building Exim to use"
31047 To make use of the local scan function feature, you must tell Exim where your
31048 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31049 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31050 directory, so you might set
31051 .code
31052 LOCAL_SCAN_SOURCE=Local/local_scan.c
31053 .endd
31054 for example. The function must be called &[local_scan()]&. It is called by
31055 Exim after it has received a message, when the success return code is about to
31056 be sent. This is after all the ACLs have been run. The return code from your
31057 function controls whether the message is actually accepted or not. There is a
31058 commented template function (that just accepts the message) in the file
31059 _src/local_scan.c_.
31060
31061 If you want to make use of Exim's run time configuration file to set options
31062 for your &[local_scan()]& function, you must also set
31063 .code
31064 LOCAL_SCAN_HAS_OPTIONS=yes
31065 .endd
31066 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31067
31068
31069
31070
31071 .section "API for local_scan()" "SECTapiforloc"
31072 .cindex "&[local_scan()]& function" "API description"
31073 You must include this line near the start of your code:
31074 .code
31075 #include "local_scan.h"
31076 .endd
31077 This header file defines a number of variables and other values, and the
31078 prototype for the function itself. Exim is coded to use unsigned char values
31079 almost exclusively, and one of the things this header defines is a shorthand
31080 for &`unsigned char`& called &`uschar`&.
31081 It also contains the following macro definitions, to simplify casting character
31082 strings and pointers to character strings:
31083 .code
31084 #define CS   (char *)
31085 #define CCS  (const char *)
31086 #define CSS  (char **)
31087 #define US   (unsigned char *)
31088 #define CUS  (const unsigned char *)
31089 #define USS  (unsigned char **)
31090 .endd
31091 The function prototype for &[local_scan()]& is:
31092 .code
31093 extern int local_scan(int fd, uschar **return_text);
31094 .endd
31095 The arguments are as follows:
31096
31097 .ilist
31098 &%fd%& is a file descriptor for the file that contains the body of the message
31099 (the -D file). The file is open for reading and writing, but updating it is not
31100 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31101
31102 The descriptor is positioned at character 19 of the file, which is the first
31103 character of the body itself, because the first 19 characters are the message
31104 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31105 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31106 case this changes in some future version.
31107 .next
31108 &%return_text%& is an address which you can use to return a pointer to a text
31109 string at the end of the function. The value it points to on entry is NULL.
31110 .endlist
31111
31112 The function must return an &%int%& value which is one of the following macros:
31113
31114 .vlist
31115 .vitem &`LOCAL_SCAN_ACCEPT`&
31116 .vindex "&$local_scan_data$&"
31117 The message is accepted. If you pass back a string of text, it is saved with
31118 the message, and made available in the variable &$local_scan_data$&. No
31119 newlines are permitted (if there are any, they are turned into spaces) and the
31120 maximum length of text is 1000 characters.
31121
31122 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31123 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31124 queued without immediate delivery, and is frozen.
31125
31126 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31127 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31128 queued without immediate delivery.
31129
31130 .vitem &`LOCAL_SCAN_REJECT`&
31131 The message is rejected; the returned text is used as an error message which is
31132 passed back to the sender and which is also logged. Newlines are permitted &--
31133 they cause a multiline response for SMTP rejections, but are converted to
31134 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31135 used.
31136
31137 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31138 The message is temporarily rejected; the returned text is used as an error
31139 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31140 problem"& is used.
31141
31142 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31143 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31144 message is not written to the reject log. It has the effect of unsetting the
31145 &%rejected_header%& log selector for just this rejection. If
31146 &%rejected_header%& is already unset (see the discussion of the
31147 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31148 same as LOCAL_SCAN_REJECT.
31149
31150 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31151 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31152 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31153 .endlist
31154
31155 If the message is not being received by interactive SMTP, rejections are
31156 reported by writing to &%stderr%& or by sending an email, as configured by the
31157 &%-oe%& command line options.
31158
31159
31160
31161 .section "Configuration options for local_scan()" "SECTconoptloc"
31162 .cindex "&[local_scan()]& function" "configuration options"
31163 It is possible to have option settings in the main configuration file
31164 that set values in static variables in the &[local_scan()]& module. If you
31165 want to do this, you must have the line
31166 .code
31167 LOCAL_SCAN_HAS_OPTIONS=yes
31168 .endd
31169 in your &_Local/Makefile_& when you build Exim. (This line is in
31170 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31171 file, you must define static variables to hold the option values, and a table
31172 to define them.
31173
31174 The table must be a vector called &%local_scan_options%&, of type
31175 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31176 and a pointer to the variable that holds the value. The entries must appear in
31177 alphabetical order. Following &%local_scan_options%& you must also define a
31178 variable called &%local_scan_options_count%& that contains the number of
31179 entries in the table. Here is a short example, showing two kinds of option:
31180 .code
31181 static int my_integer_option = 42;
31182 static uschar *my_string_option = US"a default string";
31183
31184 optionlist local_scan_options[] = {
31185   { "my_integer", opt_int,       &my_integer_option },
31186   { "my_string",  opt_stringptr, &my_string_option }
31187 };
31188
31189 int local_scan_options_count =
31190   sizeof(local_scan_options)/sizeof(optionlist);
31191 .endd
31192 The values of the variables can now be changed from Exim's runtime
31193 configuration file by including a local scan section as in this example:
31194 .code
31195 begin local_scan
31196 my_integer = 99
31197 my_string = some string of text...
31198 .endd
31199 The available types of option data are as follows:
31200
31201 .vlist
31202 .vitem &*opt_bool*&
31203 This specifies a boolean (true/false) option. The address should point to a
31204 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31205 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31206 whether such a variable has been set at all, you can initialize it to
31207 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31208 values.)
31209
31210 .vitem &*opt_fixed*&
31211 This specifies a fixed point number, such as is used for load averages.
31212 The address should point to a variable of type &`int`&. The value is stored
31213 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31214
31215 .vitem &*opt_int*&
31216 This specifies an integer; the address should point to a variable of type
31217 &`int`&. The value may be specified in any of the integer formats accepted by
31218 Exim.
31219
31220 .vitem &*opt_mkint*&
31221 This is the same as &%opt_int%&, except that when such a value is output in a
31222 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31223 printed with the suffix K or M.
31224
31225 .vitem &*opt_octint*&
31226 This also specifies an integer, but the value is always interpreted as an
31227 octal integer, whether or not it starts with the digit zero, and it is
31228 always output in octal.
31229
31230 .vitem &*opt_stringptr*&
31231 This specifies a string value; the address must be a pointer to a
31232 variable that points to a string (for example, of type &`uschar *`&).
31233
31234 .vitem &*opt_time*&
31235 This specifies a time interval value. The address must point to a variable of
31236 type &`int`&. The value that is placed there is a number of seconds.
31237 .endlist
31238
31239 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31240 out the values of all the &[local_scan()]& options.
31241
31242
31243
31244 .section "Available Exim variables" "SECID208"
31245 .cindex "&[local_scan()]& function" "available Exim variables"
31246 The header &_local_scan.h_& gives you access to a number of C variables. These
31247 are the only ones that are guaranteed to be maintained from release to release.
31248 Note, however, that you can obtain the value of any Exim expansion variable,
31249 including &$recipients$&, by calling &'expand_string()'&. The exported
31250 C variables are as follows:
31251
31252 .vlist
31253 .vitem &*int&~body_linecount*&
31254 This variable contains the number of lines in the message's body.
31255
31256 .vitem &*int&~body_zerocount*&
31257 This variable contains the number of binary zero bytes in the message's body.
31258
31259 .vitem &*unsigned&~int&~debug_selector*&
31260 This variable is set to zero when no debugging is taking place. Otherwise, it
31261 is a bitmap of debugging selectors. Two bits are identified for use in
31262 &[local_scan()]&; they are defined as macros:
31263
31264 .ilist
31265 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31266 testing option that is not privileged &-- any caller may set it. All the
31267 other selector bits can be set only by admin users.
31268
31269 .next
31270 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31271 by the &`+local_scan`& debug selector. It is not included in the default set
31272 of debugging bits.
31273 .endlist ilist
31274
31275 Thus, to write to the debugging output only when &`+local_scan`& has been
31276 selected, you should use code like this:
31277 .code
31278 if ((debug_selector & D_local_scan) != 0)
31279   debug_printf("xxx", ...);
31280 .endd
31281 .vitem &*uschar&~*expand_string_message*&
31282 After a failing call to &'expand_string()'& (returned value NULL), the
31283 variable &%expand_string_message%& contains the error message, zero-terminated.
31284
31285 .vitem &*header_line&~*header_list*&
31286 A pointer to a chain of header lines. The &%header_line%& structure is
31287 discussed below.
31288
31289 .vitem &*header_line&~*header_last*&
31290 A pointer to the last of the header lines.
31291
31292 .vitem &*uschar&~*headers_charset*&
31293 The value of the &%headers_charset%& configuration option.
31294
31295 .vitem &*BOOL&~host_checking*&
31296 This variable is TRUE during a host checking session that is initiated by the
31297 &%-bh%& command line option.
31298
31299 .vitem &*uschar&~*interface_address*&
31300 The IP address of the interface that received the message, as a string. This
31301 is NULL for locally submitted messages.
31302
31303 .vitem &*int&~interface_port*&
31304 The port on which this message was received. When testing with the &%-bh%&
31305 command line option, the value of this variable is -1 unless a port has been
31306 specified via the &%-oMi%& option.
31307
31308 .vitem &*uschar&~*message_id*&
31309 This variable contains Exim's message id for the incoming message (the value of
31310 &$message_exim_id$&) as a zero-terminated string.
31311
31312 .vitem &*uschar&~*received_protocol*&
31313 The name of the protocol by which the message was received.
31314
31315 .vitem &*int&~recipients_count*&
31316 The number of accepted recipients.
31317
31318 .vitem &*recipient_item&~*recipients_list*&
31319 .cindex "recipient" "adding in local scan"
31320 .cindex "recipient" "removing in local scan"
31321 The list of accepted recipients, held in a vector of length
31322 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31323 can add additional recipients by calling &'receive_add_recipient()'& (see
31324 below). You can delete recipients by removing them from the vector and
31325 adjusting the value in &%recipients_count%&. In particular, by setting
31326 &%recipients_count%& to zero you remove all recipients. If you then return the
31327 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31328 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31329 and then call &'receive_add_recipient()'& as often as needed.
31330
31331 .vitem &*uschar&~*sender_address*&
31332 The envelope sender address. For bounce messages this is the empty string.
31333
31334 .vitem &*uschar&~*sender_host_address*&
31335 The IP address of the sending host, as a string. This is NULL for
31336 locally-submitted messages.
31337
31338 .vitem &*uschar&~*sender_host_authenticated*&
31339 The name of the authentication mechanism that was used, or NULL if the message
31340 was not received over an authenticated SMTP connection.
31341
31342 .vitem &*uschar&~*sender_host_name*&
31343 The name of the sending host, if known.
31344
31345 .vitem &*int&~sender_host_port*&
31346 The port on the sending host.
31347
31348 .vitem &*BOOL&~smtp_input*&
31349 This variable is TRUE for all SMTP input, including BSMTP.
31350
31351 .vitem &*BOOL&~smtp_batched_input*&
31352 This variable is TRUE for BSMTP input.
31353
31354 .vitem &*int&~store_pool*&
31355 The contents of this variable control which pool of memory is used for new
31356 requests. See section &<<SECTmemhanloc>>& for details.
31357 .endlist
31358
31359
31360 .section "Structure of header lines" "SECID209"
31361 The &%header_line%& structure contains the members listed below.
31362 You can add additional header lines by calling the &'header_add()'& function
31363 (see below). You can cause header lines to be ignored (deleted) by setting
31364 their type to *.
31365
31366
31367 .vlist
31368 .vitem &*struct&~header_line&~*next*&
31369 A pointer to the next header line, or NULL for the last line.
31370
31371 .vitem &*int&~type*&
31372 A code identifying certain headers that Exim recognizes. The codes are printing
31373 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31374 Notice in particular that any header line whose type is * is not transmitted
31375 with the message. This flagging is used for header lines that have been
31376 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31377 lines.) Effectively, * means &"deleted"&.
31378
31379 .vitem &*int&~slen*&
31380 The number of characters in the header line, including the terminating and any
31381 internal newlines.
31382
31383 .vitem &*uschar&~*text*&
31384 A pointer to the text of the header. It always ends with a newline, followed by
31385 a zero byte. Internal newlines are preserved.
31386 .endlist
31387
31388
31389
31390 .section "Structure of recipient items" "SECID210"
31391 The &%recipient_item%& structure contains these members:
31392
31393 .vlist
31394 .vitem &*uschar&~*address*&
31395 This is a pointer to the recipient address as it was received.
31396
31397 .vitem &*int&~pno*&
31398 This is used in later Exim processing when top level addresses are created by
31399 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31400 and must always contain -1 at this stage.
31401
31402 .vitem &*uschar&~*errors_to*&
31403 If this value is not NULL, bounce messages caused by failing to deliver to the
31404 recipient are sent to the address it contains. In other words, it overrides the
31405 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31406 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31407 an unqualified address, Exim qualifies it using the domain from
31408 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31409 is NULL for all recipients.
31410 .endlist
31411
31412
31413
31414 .section "Available Exim functions" "SECID211"
31415 .cindex "&[local_scan()]& function" "available Exim functions"
31416 The header &_local_scan.h_& gives you access to a number of Exim functions.
31417 These are the only ones that are guaranteed to be maintained from release to
31418 release:
31419
31420 .vlist
31421 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31422        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31423
31424 This function creates a child process that runs the command specified by
31425 &%argv%&. The environment for the process is specified by &%envp%&, which can
31426 be NULL if no environment variables are to be passed. A new umask is supplied
31427 for the process in &%newumask%&.
31428
31429 Pipes to the standard input and output of the new process are set up
31430 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31431 standard error is cloned to the standard output. If there are any file
31432 descriptors &"in the way"& in the new process, they are closed. If the final
31433 argument is TRUE, the new process is made into a process group leader.
31434
31435 The function returns the pid of the new process, or -1 if things go wrong.
31436
31437 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31438 This function waits for a child process to terminate, or for a timeout (in
31439 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31440 return value is as follows:
31441
31442 .ilist
31443 >= 0
31444
31445 The process terminated by a normal exit and the value is the process
31446 ending status.
31447
31448 .next
31449 < 0 and > &--256
31450
31451 The process was terminated by a signal and the value is the negation of the
31452 signal number.
31453
31454 .next
31455 &--256
31456
31457 The process timed out.
31458 .next
31459 &--257
31460
31461 The was some other error in wait(); &%errno%& is still set.
31462 .endlist
31463
31464 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31465 This function provide you with a means of submitting a new message to
31466 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31467 want, but this packages it all up for you.) The function creates a pipe,
31468 forks a subprocess that is running
31469 .code
31470 exim -t -oem -oi -f <>
31471 .endd
31472 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31473 that is connected to the standard input. The yield of the function is the PID
31474 of the subprocess. You can then write a message to the file descriptor, with
31475 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31476
31477 When you have finished, call &'child_close()'& to wait for the process to
31478 finish and to collect its ending status. A timeout value of zero is usually
31479 fine in this circumstance. Unless you have made a mistake with the recipient
31480 addresses, you should get a return code of zero.
31481
31482
31483 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31484        *sender_authentication)*&
31485 This function is a more sophisticated version of &'child_open()'&. The command
31486 that it runs is:
31487 .display
31488 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31489 .endd
31490 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31491
31492
31493 .vitem &*void&~debug_printf(char&~*,&~...)*&
31494 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31495 output is written to the standard error stream. If no debugging is selected,
31496 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31497 conditional on the &`local_scan`& debug selector by coding like this:
31498 .code
31499 if ((debug_selector & D_local_scan) != 0)
31500   debug_printf("xxx", ...);
31501 .endd
31502
31503 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31504 This is an interface to Exim's string expansion code. The return value is the
31505 expanded string, or NULL if there was an expansion failure.
31506 The C variable &%expand_string_message%& contains an error message after an
31507 expansion failure. If expansion does not change the string, the return value is
31508 the pointer to the input string. Otherwise, the return value points to a new
31509 block of memory that was obtained by a call to &'store_get()'&. See section
31510 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31511
31512 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31513 This function allows you to an add additional header line at the end of the
31514 existing ones. The first argument is the type, and should normally be a space
31515 character. The second argument is a format string and any number of
31516 substitution arguments as for &[sprintf()]&. You may include internal newlines
31517 if you want, and you must ensure that the string ends with a newline.
31518
31519 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31520         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31521 This function adds a new header line at a specified point in the header
31522 chain. The header itself is specified as for &'header_add()'&.
31523
31524 If &%name%& is NULL, the new header is added at the end of the chain if
31525 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31526 NULL, the header lines are searched for the first non-deleted header that
31527 matches the name. If one is found, the new header is added before it if
31528 &%after%& is false. If &%after%& is true, the new header is added after the
31529 found header and any adjacent subsequent ones with the same name (even if
31530 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31531 option controls where the header is added. If it is true, addition is at the
31532 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31533 headers, or at the top if there are no &'Received:'& headers, you could use
31534 .code
31535 header_add_at_position(TRUE, US"Received", TRUE,
31536   ' ', "X-xxx: ...");
31537 .endd
31538 Normally, there is always at least one non-deleted &'Received:'& header, but
31539 there may not be if &%received_header_text%& expands to an empty string.
31540
31541
31542 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31543 This function removes header lines. If &%occurrence%& is zero or negative, all
31544 occurrences of the header are removed. If occurrence is greater than zero, that
31545 particular instance of the header is removed. If no header(s) can be found that
31546 match the specification, the function does nothing.
31547
31548
31549 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31550         int&~length,&~BOOL&~notdel)*&"
31551 This function tests whether the given header has the given name. It is not just
31552 a string comparison, because white space is permitted between the name and the
31553 colon. If the &%notdel%& argument is true, a false return is forced for all
31554 &"deleted"& headers; otherwise they are not treated specially. For example:
31555 .code
31556 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31557 .endd
31558 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31559 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31560 This function base64-encodes a string, which is passed by address and length.
31561 The text may contain bytes of any value, including zero. The result is passed
31562 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31563 zero-terminated.
31564
31565 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31566 This function decodes a base64-encoded string. Its arguments are a
31567 zero-terminated base64-encoded string and the address of a variable that is set
31568 to point to the result, which is in dynamic memory. The length of the decoded
31569 string is the yield of the function. If the input is invalid base64 data, the
31570 yield is -1. A zero byte is added to the end of the output string to make it
31571 easy to interpret as a C string (assuming it contains no zeros of its own). The
31572 added zero byte is not included in the returned count.
31573
31574 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31575 This function checks for a match in a domain list. Domains are always
31576 matched caselessly. The return value is one of the following:
31577 .display
31578 &`OK     `& match succeeded
31579 &`FAIL   `& match failed
31580 &`DEFER  `& match deferred
31581 .endd
31582 DEFER is usually caused by some kind of lookup defer, such as the
31583 inability to contact a database.
31584
31585 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31586         BOOL&~caseless)*&"
31587 This function checks for a match in a local part list. The third argument
31588 controls case-sensitivity. The return values are as for
31589 &'lss_match_domain()'&.
31590
31591 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31592         BOOL&~caseless)*&"
31593 This function checks for a match in an address list. The third argument
31594 controls the case-sensitivity of the local part match. The domain is always
31595 matched caselessly. The return values are as for &'lss_match_domain()'&.
31596
31597 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31598         uschar&~*list)*&"
31599 This function checks for a match in a host list. The most common usage is
31600 expected to be
31601 .code
31602 lss_match_host(sender_host_name, sender_host_address, ...)
31603 .endd
31604 .vindex "&$sender_host_address$&"
31605 An empty address field matches an empty item in the host list. If the host name
31606 is NULL, the name corresponding to &$sender_host_address$& is automatically
31607 looked up if a host name is required to match an item in the list. The return
31608 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31609 returns ERROR in the case when it had to look up a host name, but the lookup
31610 failed.
31611
31612 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31613         *format,&~...)*&"
31614 This function writes to Exim's log files. The first argument should be zero (it
31615 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31616 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31617 them. It specifies to which log or logs the message is written. The remaining
31618 arguments are a format and relevant insertion arguments. The string should not
31619 contain any newlines, not even at the end.
31620
31621
31622 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31623 This function adds an additional recipient to the message. The first argument
31624 is the recipient address. If it is unqualified (has no domain), it is qualified
31625 with the &%qualify_recipient%& domain. The second argument must always be -1.
31626
31627 This function does not allow you to specify a private &%errors_to%& address (as
31628 described with the structure of &%recipient_item%& above), because it pre-dates
31629 the addition of that field to the structure. However, it is easy to add such a
31630 value afterwards. For example:
31631 .code
31632  receive_add_recipient(US"monitor@mydom.example", -1);
31633  recipients_list[recipients_count-1].errors_to =
31634    US"postmaster@mydom.example";
31635 .endd
31636
31637 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31638 This is a convenience function to remove a named recipient from the list of
31639 recipients. It returns true if a recipient was removed, and false if no
31640 matching recipient could be found. The argument must be a complete email
31641 address.
31642 .endlist
31643
31644
31645 .cindex "RFC 2047"
31646 .vlist
31647 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31648   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31649 This function decodes strings that are encoded according to RFC 2047. Typically
31650 these are the contents of header lines. First, each &"encoded word"& is decoded
31651 from the Q or B encoding into a byte-string. Then, if provided with the name of
31652 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31653 made  to translate the result to the named character set. If this fails, the
31654 binary string is returned with an error message.
31655
31656 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31657 maximum MIME word length is enforced. The third argument is the target
31658 encoding, or NULL if no translation is wanted.
31659
31660 .cindex "binary zero" "in RFC 2047 decoding"
31661 .cindex "RFC 2047" "binary zero in"
31662 If a binary zero is encountered in the decoded string, it is replaced by the
31663 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31664 not be 0 because header lines are handled as zero-terminated strings.
31665
31666 The function returns the result of processing the string, zero-terminated; if
31667 &%lenptr%& is not NULL, the length of the result is set in the variable to
31668 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31669
31670 If an error is encountered, the function returns NULL and uses the &%error%&
31671 argument to return an error message. The variable pointed to by &%error%& is
31672 set to NULL if there is no error; it may be set non-NULL even when the function
31673 returns a non-NULL value if decoding was successful, but there was a problem
31674 with translation.
31675
31676
31677 .vitem &*int&~smtp_fflush(void)*&
31678 This function is used in conjunction with &'smtp_printf()'&, as described
31679 below.
31680
31681 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31682 The arguments of this function are like &[printf()]&; it writes to the SMTP
31683 output stream. You should use this function only when there is an SMTP output
31684 stream, that is, when the incoming message is being received via interactive
31685 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31686 is FALSE. If you want to test for an incoming message from another host (as
31687 opposed to a local process that used the &%-bs%& command line option), you can
31688 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31689 is involved.
31690
31691 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31692 output function, so it can be used for all forms of SMTP connection.
31693
31694 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31695 must start with an appropriate response code: 550 if you are going to return
31696 LOCAL_SCAN_REJECT, 451 if you are going to return
31697 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31698 initial lines of a multi-line response, the code must be followed by a hyphen
31699 to indicate that the line is not the final response line. You must also ensure
31700 that the lines you write terminate with CRLF. For example:
31701 .code
31702 smtp_printf("550-this is some extra info\r\n");
31703 return LOCAL_SCAN_REJECT;
31704 .endd
31705 Note that you can also create multi-line responses by including newlines in
31706 the data returned via the &%return_text%& argument. The added value of using
31707 &'smtp_printf()'& is that, for instance, you could introduce delays between
31708 multiple output lines.
31709
31710 The &'smtp_printf()'& function does not return any error indication, because it
31711 does not automatically flush pending output, and therefore does not test
31712 the state of the stream. (In the main code of Exim, flushing and error
31713 detection is done when Exim is ready for the next SMTP input command.) If
31714 you want to flush the output and check for an error (for example, the
31715 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31716 arguments. It flushes the output stream, and returns a non-zero value if there
31717 is an error.
31718
31719 .vitem &*void&~*store_get(int)*&
31720 This function accesses Exim's internal store (memory) manager. It gets a new
31721 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31722 runs out of memory. See the next section for a discussion of memory handling.
31723
31724 .vitem &*void&~*store_get_perm(int)*&
31725 This function is like &'store_get()'&, but it always gets memory from the
31726 permanent pool. See the next section for a discussion of memory handling.
31727
31728 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31729 See below.
31730
31731 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31732 See below.
31733
31734 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31735 These three functions create strings using Exim's dynamic memory facilities.
31736 The first makes a copy of an entire string. The second copies up to a maximum
31737 number of characters, indicated by the second argument. The third uses a format
31738 and insertion arguments to create a new string. In each case, the result is a
31739 pointer to a new string in the current memory pool. See the next section for
31740 more discussion.
31741 .endlist
31742
31743
31744
31745 .section "More about Exim's memory handling" "SECTmemhanloc"
31746 .cindex "&[local_scan()]& function" "memory handling"
31747 No function is provided for freeing memory, because that is never needed.
31748 The dynamic memory that Exim uses when receiving a message is automatically
31749 recycled if another message is received by the same process (this applies only
31750 to incoming SMTP connections &-- other input methods can supply only one
31751 message at a time). After receiving the last message, a reception process
31752 terminates.
31753
31754 Because it is recycled, the normal dynamic memory cannot be used for holding
31755 data that must be preserved over a number of incoming messages on the same SMTP
31756 connection. However, Exim in fact uses two pools of dynamic memory; the second
31757 one is not recycled, and can be used for this purpose.
31758
31759 If you want to allocate memory that remains available for subsequent messages
31760 in the same SMTP connection, you should set
31761 .code
31762 store_pool = POOL_PERM
31763 .endd
31764 before calling the function that does the allocation. There is no need to
31765 restore the value if you do not need to; however, if you do want to revert to
31766 the normal pool, you can either restore the previous value of &%store_pool%& or
31767 set it explicitly to POOL_MAIN.
31768
31769 The pool setting applies to all functions that get dynamic memory, including
31770 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31771 There is also a convenience function called &'store_get_perm()'& that gets a
31772 block of memory from the permanent pool while preserving the value of
31773 &%store_pool%&.
31774 .ecindex IIDlosca
31775
31776
31777
31778
31779 . ////////////////////////////////////////////////////////////////////////////
31780 . ////////////////////////////////////////////////////////////////////////////
31781
31782 .chapter "System-wide message filtering" "CHAPsystemfilter"
31783 .scindex IIDsysfil1 "filter" "system filter"
31784 .scindex IIDsysfil2 "filtering all mail"
31785 .scindex IIDsysfil3 "system filter"
31786 The previous chapters (on ACLs and the local scan function) describe checks
31787 that can be applied to messages before they are accepted by a host. There is
31788 also a mechanism for checking messages once they have been received, but before
31789 they are delivered. This is called the &'system filter'&.
31790
31791 The system filter operates in a similar manner to users' filter files, but it
31792 is run just once per message (however many recipients the message has).
31793 It should not normally be used as a substitute for routing, because &%deliver%&
31794 commands in a system router provide new envelope recipient addresses.
31795 The system filter must be an Exim filter. It cannot be a Sieve filter.
31796
31797 The system filter is run at the start of a delivery attempt, before any routing
31798 is done. If a message fails to be completely delivered at the first attempt,
31799 the system filter is run again at the start of every retry.
31800 If you want your filter to do something only once per message, you can make use
31801 of the &%first_delivery%& condition in an &%if%& command in the filter to
31802 prevent it happening on retries.
31803
31804 .vindex "&$domain$&"
31805 .vindex "&$local_part$&"
31806 &*Warning*&: Because the system filter runs just once, variables that are
31807 specific to individual recipient addresses, such as &$local_part$& and
31808 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31809 you want to run a centrally-specified filter for each recipient address
31810 independently, you can do so by setting up a suitable &(redirect)& router, as
31811 described in section &<<SECTperaddfil>>& below.
31812
31813
31814 .section "Specifying a system filter" "SECID212"
31815 .cindex "uid (user id)" "system filter"
31816 .cindex "gid (group id)" "system filter"
31817 The name of the file that contains the system filter must be specified by
31818 setting &%system_filter%&. If you want the filter to run under a uid and gid
31819 other than root, you must also set &%system_filter_user%& and
31820 &%system_filter_group%& as appropriate. For example:
31821 .code
31822 system_filter = /etc/mail/exim.filter
31823 system_filter_user = exim
31824 .endd
31825 If a system filter generates any deliveries directly to files or pipes (via the
31826 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31827 specified by setting &%system_filter_file_transport%& and
31828 &%system_filter_pipe_transport%&, respectively. Similarly,
31829 &%system_filter_reply_transport%& must be set to handle any messages generated
31830 by the &%reply%& command.
31831
31832
31833 .section "Testing a system filter" "SECID213"
31834 You can run simple tests of a system filter in the same way as for a user
31835 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31836 are permitted only in system filters are recognized.
31837
31838 If you want to test the combined effect of a system filter and a user filter,
31839 you can use both &%-bF%& and &%-bf%& on the same command line.
31840
31841
31842
31843 .section "Contents of a system filter" "SECID214"
31844 The language used to specify system filters is the same as for users' filter
31845 files. It is described in the separate end-user document &'Exim's interface to
31846 mail filtering'&. However, there are some additional features that are
31847 available only in system filters; these are described in subsequent sections.
31848 If they are encountered in a user's filter file or when testing with &%-bf%&,
31849 they cause errors.
31850
31851 .cindex "frozen messages" "manual thaw; testing in filter"
31852 There are two special conditions which, though available in users' filter
31853 files, are designed for use in system filters. The condition &%first_delivery%&
31854 is true only for the first attempt at delivering a message, and
31855 &%manually_thawed%& is true only if the message has been frozen, and
31856 subsequently thawed by an admin user. An explicit forced delivery counts as a
31857 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31858
31859 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31860 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31861 succeed, it will not be tried again.
31862 If you want Exim to retry an unseen delivery until it succeeds, you should
31863 arrange to set it up every time the filter runs.
31864
31865 When a system filter finishes running, the values of the variables &$n0$& &--
31866 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31867 users' filter files. Thus a system filter can, for example, set up &"scores"&
31868 to which users' filter files can refer.
31869
31870
31871
31872 .section "Additional variable for system filters" "SECID215"
31873 .vindex "&$recipients$&"
31874 The expansion variable &$recipients$&, containing a list of all the recipients
31875 of the message (separated by commas and white space), is available in system
31876 filters. It is not available in users' filters for privacy reasons.
31877
31878
31879
31880 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31881 .cindex "freezing messages"
31882 .cindex "message" "freezing"
31883 .cindex "message" "forced failure"
31884 .cindex "&%fail%&" "in system filter"
31885 .cindex "&%freeze%& in system filter"
31886 .cindex "&%defer%& in system filter"
31887 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31888 always available in system filters, but are not normally enabled in users'
31889 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31890 for the &(redirect)& router.) These commands can optionally be followed by the
31891 word &%text%& and a string containing an error message, for example:
31892 .code
31893 fail text "this message looks like spam to me"
31894 .endd
31895 The keyword &%text%& is optional if the next character is a double quote.
31896
31897 The &%defer%& command defers delivery of the original recipients of the
31898 message. The &%fail%& command causes all the original recipients to be failed,
31899 and a bounce message to be created. The &%freeze%& command suspends all
31900 delivery attempts for the original recipients. In all cases, any new deliveries
31901 that are specified by the filter are attempted as normal after the filter has
31902 run.
31903
31904 The &%freeze%& command is ignored if the message has been manually unfrozen and
31905 not manually frozen since. This means that automatic freezing by a system
31906 filter can be used as a way of checking out suspicious messages. If a message
31907 is found to be all right, manually unfreezing it allows it to be delivered.
31908
31909 .cindex "log" "&%fail%& command log line"
31910 .cindex "&%fail%&" "log line; reducing"
31911 The text given with a fail command is used as part of the bounce message as
31912 well as being written to the log. If the message is quite long, this can fill
31913 up a lot of log space when such failures are common. To reduce the size of the
31914 log message, Exim interprets the text in a special way if it starts with the
31915 two characters &`<<`& and contains &`>>`& later. The text between these two
31916 strings is written to the log, and the rest of the text is used in the bounce
31917 message. For example:
31918 .code
31919 fail "<<filter test 1>>Your message is rejected \
31920      because it contains attachments that we are \
31921      not prepared to receive."
31922 .endd
31923
31924 .cindex "loop" "caused by &%fail%&"
31925 Take great care with the &%fail%& command when basing the decision to fail on
31926 the contents of the message, because the bounce message will of course include
31927 the contents of the original message and will therefore trigger the &%fail%&
31928 command again (causing a mail loop) unless steps are taken to prevent this.
31929 Testing the &%error_message%& condition is one way to prevent this. You could
31930 use, for example
31931 .code
31932 if $message_body contains "this is spam" and not error_message
31933 then fail text "spam is not wanted here" endif
31934 .endd
31935 though of course that might let through unwanted bounce messages. The
31936 alternative is clever checking of the body and/or headers to detect bounces
31937 generated by the filter.
31938
31939 The interpretation of a system filter file ceases after a
31940 &%defer%&,
31941 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31942 set up earlier in the filter file are honoured, so you can use a sequence such
31943 as
31944 .code
31945 mail ...
31946 freeze
31947 .endd
31948 to send a specified message when the system filter is freezing (or deferring or
31949 failing) a message. The normal deliveries for the message do not, of course,
31950 take place.
31951
31952
31953
31954 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31955 .cindex "header lines" "adding; in system filter"
31956 .cindex "header lines" "removing; in system filter"
31957 .cindex "filter" "header lines; adding/removing"
31958 Two filter commands that are available only in system filters are:
31959 .code
31960 headers add <string>
31961 headers remove <string>
31962 .endd
31963 The argument for the &%headers add%& is a string that is expanded and then
31964 added to the end of the message's headers. It is the responsibility of the
31965 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31966 space is ignored, and if the string is otherwise empty, or if the expansion is
31967 forced to fail, the command has no effect.
31968
31969 You can use &"\n"& within the string, followed by white space, to specify
31970 continued header lines. More than one header may be added in one command by
31971 including &"\n"& within the string without any following white space. For
31972 example:
31973 .code
31974 headers add "X-header-1: ....\n  \
31975              continuation of X-header-1 ...\n\
31976              X-header-2: ...."
31977 .endd
31978 Note that the header line continuation white space after the first newline must
31979 be placed before the backslash that continues the input string, because white
31980 space after input continuations is ignored.
31981
31982 The argument for &%headers remove%& is a colon-separated list of header names.
31983 This command applies only to those headers that are stored with the message;
31984 those that are added at delivery time (such as &'Envelope-To:'& and
31985 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31986 header with the same name, they are all removed.
31987
31988 The &%headers%& command in a system filter makes an immediate change to the set
31989 of header lines that was received with the message (with possible additions
31990 from ACL processing). Subsequent commands in the system filter operate on the
31991 modified set, which also forms the basis for subsequent message delivery.
31992 Unless further modified during routing or transporting, this set of headers is
31993 used for all recipients of the message.
31994
31995 During routing and transporting, the variables that refer to the contents of
31996 header lines refer only to those lines that are in this set. Thus, header lines
31997 that are added by a system filter are visible to users' filter files and to all
31998 routers and transports. This contrasts with the manipulation of header lines by
31999 routers and transports, which is not immediate, but which instead is saved up
32000 until the message is actually being written (see section
32001 &<<SECTheadersaddrem>>&).
32002
32003 If the message is not delivered at the first attempt, header lines that were
32004 added by the system filter are stored with the message, and so are still
32005 present at the next delivery attempt. Header lines that were removed are still
32006 present, but marked &"deleted"& so that they are not transported with the
32007 message. For this reason, it is usual to make the &%headers%& command
32008 conditional on &%first_delivery%& so that the set of header lines is not
32009 modified more than once.
32010
32011 Because header modification in a system filter acts immediately, you have to
32012 use an indirect approach if you want to modify the contents of a header line.
32013 For example:
32014 .code
32015 headers add "Old-Subject: $h_subject:"
32016 headers remove "Subject"
32017 headers add "Subject: new subject (was: $h_old-subject:)"
32018 headers remove "Old-Subject"
32019 .endd
32020
32021
32022
32023 .section "Setting an errors address in a system filter" "SECID217"
32024 .cindex "envelope sender"
32025 In a system filter, if a &%deliver%& command is followed by
32026 .code
32027 errors_to <some address>
32028 .endd
32029 in order to change the envelope sender (and hence the error reporting) for that
32030 delivery, any address may be specified. (In a user filter, only the current
32031 user's address can be set.) For example, if some mail is being monitored, you
32032 might use
32033 .code
32034 unseen deliver monitor@spying.example errors_to root@local.example
32035 .endd
32036 to take a copy which would not be sent back to the normal error reporting
32037 address if its delivery failed.
32038
32039
32040
32041 .section "Per-address filtering" "SECTperaddfil"
32042 .vindex "&$domain$&"
32043 .vindex "&$local_part$&"
32044 In contrast to the system filter, which is run just once per message for each
32045 delivery attempt, it is also possible to set up a system-wide filtering
32046 operation that runs once for each recipient address. In this case, variables
32047 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32048 filter file could be made dependent on them. This is an example of a router
32049 which implements such a filter:
32050 .code
32051 central_filter:
32052   check_local_user
32053   driver = redirect
32054   domains = +local_domains
32055   file = /central/filters/$local_part
32056   no_verify
32057   allow_filter
32058   allow_freeze
32059 .endd
32060 The filter is run in a separate process under its own uid. Therefore, either
32061 &%check_local_user%& must be set (as above), in which case the filter is run as
32062 the local user, or the &%user%& option must be used to specify which user to
32063 use. If both are set, &%user%& overrides.
32064
32065 Care should be taken to ensure that none of the commands in the filter file
32066 specify a significant delivery if the message is to go on to be delivered to
32067 its intended recipient. The router will not then claim to have dealt with the
32068 address, so it will be passed on to subsequent routers to be delivered in the
32069 normal way.
32070 .ecindex IIDsysfil1
32071 .ecindex IIDsysfil2
32072 .ecindex IIDsysfil3
32073
32074
32075
32076
32077
32078
32079 . ////////////////////////////////////////////////////////////////////////////
32080 . ////////////////////////////////////////////////////////////////////////////
32081
32082 .chapter "Message processing" "CHAPmsgproc"
32083 .scindex IIDmesproc "message" "general processing"
32084 Exim performs various transformations on the sender and recipient addresses of
32085 all messages that it handles, and also on the messages' header lines. Some of
32086 these are optional and configurable, while others always take place. All of
32087 this processing, except rewriting as a result of routing, and the addition or
32088 removal of header lines while delivering, happens when a message is received,
32089 before it is placed on Exim's queue.
32090
32091 Some of the automatic processing takes place by default only for
32092 &"locally-originated"& messages. This adjective is used to describe messages
32093 that are not received over TCP/IP, but instead are passed to an Exim process on
32094 its standard input. This includes the interactive &"local SMTP"& case that is
32095 set up by the &%-bs%& command line option.
32096
32097 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32098 or ::1) are not considered to be locally-originated. Exim does not treat the
32099 loopback interface specially in any way.
32100
32101 If you want the loopback interface to be treated specially, you must ensure
32102 that there are appropriate entries in your ACLs.
32103
32104
32105
32106
32107 .section "Submission mode for non-local messages" "SECTsubmodnon"
32108 .cindex "message" "submission"
32109 .cindex "submission mode"
32110 Processing that happens automatically for locally-originated messages (unless
32111 &%suppress_local_fixups%& is set) can also be requested for messages that are
32112 received over TCP/IP. The term &"submission mode"& is used to describe this
32113 state. Submission mode is set by the modifier
32114 .code
32115 control = submission
32116 .endd
32117 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32118 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32119 a local submission, and is normally used when the source of the message is
32120 known to be an MUA running on a client host (as opposed to an MTA). For
32121 example, to set submission mode for messages originating on the IPv4 loopback
32122 interface, you could include the following in the MAIL ACL:
32123 .code
32124 warn  hosts = 127.0.0.1
32125       control = submission
32126 .endd
32127 .cindex "&%sender_retain%& submission option"
32128 There are some options that can be used when setting submission mode. A slash
32129 is used to separate options. For example:
32130 .code
32131 control = submission/sender_retain
32132 .endd
32133 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32134 true and &%local_from_check%& false for the current incoming message. The first
32135 of these allows an existing &'Sender:'& header in the message to remain, and
32136 the second suppresses the check to ensure that &'From:'& matches the
32137 authenticated sender. With this setting, Exim still fixes up messages by adding
32138 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32139 attempt to check sender authenticity in header lines.
32140
32141 When &%sender_retain%& is not set, a submission mode setting may specify a
32142 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32143 example:
32144 .code
32145 control = submission/domain=some.domain
32146 .endd
32147 The domain may be empty. How this value is used is described in sections
32148 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32149 that allows you to specify the user's full name for inclusion in a created
32150 &'Sender:'& or &'From:'& header line. For example:
32151 .code
32152 accept authenticated = *
32153        control = submission/domain=wonderland.example/\
32154                             name=${lookup {$authenticated_id} \
32155                                    lsearch {/etc/exim/namelist}}
32156 .endd
32157 Because the name may contain any characters, including slashes, the &%name%&
32158 option must be given last. The remainder of the string is used as the name. For
32159 the example above, if &_/etc/exim/namelist_& contains:
32160 .code
32161 bigegg:  Humpty Dumpty
32162 .endd
32163 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32164 line would be:
32165 .code
32166 Sender: Humpty Dumpty <bigegg@wonderland.example>
32167 .endd
32168 .cindex "return path" "in submission mode"
32169 By default, submission mode forces the return path to the same address as is
32170 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32171 specified, the return path is also left unchanged.
32172
32173 &*Note*&: The changes caused by submission mode take effect after the predata
32174 ACL. This means that any sender checks performed before the fix-ups use the
32175 untrusted sender address specified by the user, not the trusted sender address
32176 specified by submission mode. Although this might be slightly unexpected, it
32177 does mean that you can configure ACL checks to spot that a user is trying to
32178 spoof another's address.
32179
32180 .section "Line endings" "SECTlineendings"
32181 .cindex "line endings"
32182 .cindex "carriage return"
32183 .cindex "linefeed"
32184 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32185 linefeed) is the line ending for messages transmitted over the Internet using
32186 SMTP over TCP/IP. However, within individual operating systems, different
32187 conventions are used. For example, Unix-like systems use just LF, but others
32188 use CRLF or just CR.
32189
32190 Exim was designed for Unix-like systems, and internally, it stores messages
32191 using the system's convention of a single LF as a line terminator. When
32192 receiving a message, all line endings are translated to this standard format.
32193 Originally, it was thought that programs that passed messages directly to an
32194 MTA within an operating system would use that system's convention. Experience
32195 has shown that this is not the case; for example, there are Unix applications
32196 that use CRLF in this circumstance. For this reason, and for compatibility with
32197 other MTAs, the way Exim handles line endings for all messages is now as
32198 follows:
32199
32200 .ilist
32201 LF not preceded by CR is treated as a line ending.
32202 .next
32203 CR is treated as a line ending; if it is immediately followed by LF, the LF
32204 is ignored.
32205 .next
32206 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32207 nor a local message in the state where a line containing only a dot is a
32208 terminator.
32209 .next
32210 If a bare CR is encountered within a header line, an extra space is added after
32211 the line terminator so as not to end the header line. The reasoning behind this
32212 is that bare CRs in header lines are most likely either to be mistakes, or
32213 people trying to play silly games.
32214 .next
32215 If the first header line received in a message ends with CRLF, a subsequent
32216 bare LF in a header line is treated in the same way as a bare CR in a header
32217 line.
32218 .endlist
32219
32220
32221
32222
32223
32224 .section "Unqualified addresses" "SECID218"
32225 .cindex "unqualified addresses"
32226 .cindex "address" "qualification"
32227 By default, Exim expects every envelope address it receives from an external
32228 host to be fully qualified. Unqualified addresses cause negative responses to
32229 SMTP commands. However, because SMTP is used as a means of transporting
32230 messages from MUAs running on personal workstations, there is sometimes a
32231 requirement to accept unqualified addresses from specific hosts or IP networks.
32232
32233 Exim has two options that separately control which hosts may send unqualified
32234 sender or recipient addresses in SMTP commands, namely
32235 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32236 cases, if an unqualified address is accepted, it is qualified by adding the
32237 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32238
32239 .oindex "&%qualify_domain%&"
32240 .oindex "&%qualify_recipient%&"
32241 Unqualified addresses in header lines are automatically qualified for messages
32242 that are locally originated, unless the &%-bnq%& option is given on the command
32243 line. For messages received over SMTP, unqualified addresses in header lines
32244 are qualified only if unqualified addresses are permitted in SMTP commands. In
32245 other words, such qualification is also controlled by
32246 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32247
32248
32249
32250
32251 .section "The UUCP From line" "SECID219"
32252 .cindex "&""From""& line"
32253 .cindex "UUCP" "&""From""& line"
32254 .cindex "sender" "address"
32255 .oindex "&%uucp_from_pattern%&"
32256 .oindex "&%uucp_from_sender%&"
32257 .cindex "envelope sender"
32258 .cindex "Sendmail compatibility" "&""From""& line"
32259 Messages that have come from UUCP (and some other applications) often begin
32260 with a line containing the envelope sender and a timestamp, following the word
32261 &"From"&. Examples of two common formats are:
32262 .code
32263 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32264 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32265 .endd
32266 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32267 Exim recognizes such lines at the start of messages that are submitted to it
32268 via the command line (that is, on the standard input). It does not recognize
32269 such lines in incoming SMTP messages, unless the sending host matches
32270 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32271 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32272 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32273 default value matches the two common cases shown above and puts the address
32274 that follows &"From"& into &$1$&.
32275
32276 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32277 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32278 a trusted user, the message's sender address is constructed by expanding the
32279 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32280 then parsed as an RFC 2822 address. If there is no domain, the local part is
32281 qualified with &%qualify_domain%& unless it is the empty string. However, if
32282 the command line &%-f%& option is used, it overrides the &"From"& line.
32283
32284 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32285 sender address is not changed. This is also the case for incoming SMTP messages
32286 that are permitted to contain &"From"& lines.
32287
32288 Only one &"From"& line is recognized. If there is more than one, the second is
32289 treated as a data line that starts the body of the message, as it is not valid
32290 as a header line. This also happens if a &"From"& line is present in an
32291 incoming SMTP message from a source that is not permitted to send them.
32292
32293
32294
32295 .section "Resent- header lines" "SECID220"
32296 .cindex "&%Resent-%& header lines"
32297 RFC 2822 makes provision for sets of header lines starting with the string
32298 &`Resent-`& to be added to a message when it is resent by the original
32299 recipient to somebody else. These headers are &'Resent-Date:'&,
32300 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32301 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32302
32303 .blockquote
32304 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32305 processing of replies or other such automatic actions on messages.'&
32306 .endblockquote
32307
32308 This leaves things a bit vague as far as other processing actions such as
32309 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32310 follows:
32311
32312 .ilist
32313 A &'Resent-From:'& line that just contains the login id of the submitting user
32314 is automatically rewritten in the same way as &'From:'& (see below).
32315 .next
32316 If there's a rewriting rule for a particular header line, it is also applied to
32317 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32318 &'From:'& also rewrites &'Resent-From:'&.
32319 .next
32320 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32321 also removed.
32322 .next
32323 For a locally-submitted message,
32324 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32325 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32326 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32327 included in log lines in this case.
32328 .next
32329 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32330 &%Resent-%& header lines are present.
32331 .endlist
32332
32333
32334
32335
32336 .section "The Auto-Submitted: header line" "SECID221"
32337 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32338 includes the header line:
32339 .code
32340 Auto-Submitted: auto-replied
32341 .endd
32342
32343 .section "The Bcc: header line" "SECID222"
32344 .cindex "&'Bcc:'& header line"
32345 If Exim is called with the &%-t%& option, to take recipient addresses from a
32346 message's header, it removes any &'Bcc:'& header line that may exist (after
32347 extracting its addresses). If &%-t%& is not present on the command line, any
32348 existing &'Bcc:'& is not removed.
32349
32350
32351 .section "The Date: header line" "SECID223"
32352 .cindex "&'Date:'& header line"
32353 If a locally-generated or submission-mode message has no &'Date:'& header line,
32354 Exim adds one, using the current date and time, unless the
32355 &%suppress_local_fixups%& control has been specified.
32356
32357 .section "The Delivery-date: header line" "SECID224"
32358 .cindex "&'Delivery-date:'& header line"
32359 .oindex "&%delivery_date_remove%&"
32360 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32361 set. Exim can be configured to add them to the final delivery of messages. (See
32362 the generic &%delivery_date_add%& transport option.) They should not be present
32363 in messages in transit. If the &%delivery_date_remove%& configuration option is
32364 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32365 messages.
32366
32367
32368 .section "The Envelope-to: header line" "SECID225"
32369 .cindex "&'Envelope-to:'& header line"
32370 .oindex "&%envelope_to_remove%&"
32371 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32372 Exim can be configured to add them to the final delivery of messages. (See the
32373 generic &%envelope_to_add%& transport option.) They should not be present in
32374 messages in transit. If the &%envelope_to_remove%& configuration option is set
32375 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32376 messages.
32377
32378
32379 .section "The From: header line" "SECTthefrohea"
32380 .cindex "&'From:'& header line"
32381 .cindex "Sendmail compatibility" "&""From""& line"
32382 .cindex "message" "submission"
32383 .cindex "submission mode"
32384 If a submission-mode message does not contain a &'From:'& header line, Exim
32385 adds one if either of the following conditions is true:
32386
32387 .ilist
32388 The envelope sender address is not empty (that is, this is not a bounce
32389 message). The added header line copies the envelope sender address.
32390 .next
32391 .vindex "&$authenticated_id$&"
32392 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32393 .olist
32394 .vindex "&$qualify_domain$&"
32395 If no domain is specified by the submission control, the local part is
32396 &$authenticated_id$& and the domain is &$qualify_domain$&.
32397 .next
32398 If a non-empty domain is specified by the submission control, the local
32399 part is &$authenticated_id$&, and the domain is the specified domain.
32400 .next
32401 If an empty domain is specified by the submission control,
32402 &$authenticated_id$& is assumed to be the complete address.
32403 .endlist
32404 .endlist
32405
32406 A non-empty envelope sender takes precedence.
32407
32408 If a locally-generated incoming message does not contain a &'From:'& header
32409 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32410 containing the sender's address. The calling user's login name and full name
32411 are used to construct the address, as described in section &<<SECTconstr>>&.
32412 They are obtained from the password data by calling &[getpwuid()]& (but see the
32413 &%unknown_login%& configuration option). The address is qualified with
32414 &%qualify_domain%&.
32415
32416 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32417 &'From:'& header line containing just the unqualified login name of the calling
32418 user, this is replaced by an address containing the user's login name and full
32419 name as described in section &<<SECTconstr>>&.
32420
32421
32422 .section "The Message-ID: header line" "SECID226"
32423 .cindex "&'Message-ID:'& header line"
32424 .cindex "message" "submission"
32425 .oindex "&%message_id_header_text%&"
32426 If a locally-generated or submission-mode incoming message does not contain a
32427 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32428 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32429 to the message. If there are any &'Resent-:'& headers in the message, it
32430 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32431 message id, preceded by the letter E to ensure it starts with a letter, and
32432 followed by @ and the primary host name. Additional information can be included
32433 in this header line by setting the &%message_id_header_text%& and/or
32434 &%message_id_header_domain%& options.
32435
32436
32437 .section "The Received: header line" "SECID227"
32438 .cindex "&'Received:'& header line"
32439 A &'Received:'& header line is added at the start of every message. The
32440 contents are defined by the &%received_header_text%& configuration option, and
32441 Exim automatically adds a semicolon and a timestamp to the configured string.
32442
32443 The &'Received:'& header is generated as soon as the message's header lines
32444 have been received. At this stage, the timestamp in the &'Received:'& header
32445 line is the time that the message started to be received. This is the value
32446 that is seen by the DATA ACL and by the &[local_scan()]& function.
32447
32448 Once a message is accepted, the timestamp in the &'Received:'& header line is
32449 changed to the time of acceptance, which is (apart from a small delay while the
32450 -H spool file is written) the earliest time at which delivery could start.
32451
32452
32453 .section "The References: header line" "SECID228"
32454 .cindex "&'References:'& header line"
32455 Messages created by the &(autoreply)& transport include a &'References:'&
32456 header line. This is constructed according to the rules that are described in
32457 section 3.64 of RFC 2822 (which states that replies should contain such a
32458 header line), and section 3.14 of RFC 3834 (which states that automatic
32459 responses are not different in this respect). However, because some mail
32460 processing software does not cope well with very long header lines, no more
32461 than 12 message IDs are copied from the &'References:'& header line in the
32462 incoming message. If there are more than 12, the first one and then the final
32463 11 are copied, before adding the message ID of the incoming message.
32464
32465
32466
32467 .section "The Return-path: header line" "SECID229"
32468 .cindex "&'Return-path:'& header line"
32469 .oindex "&%return_path_remove%&"
32470 &'Return-path:'& header lines are defined as something an MTA may insert when
32471 it does the final delivery of messages. (See the generic &%return_path_add%&
32472 transport option.) Therefore, they should not be present in messages in
32473 transit. If the &%return_path_remove%& configuration option is set (the
32474 default), Exim removes &'Return-path:'& header lines from incoming messages.
32475
32476
32477
32478 .section "The Sender: header line" "SECTthesenhea"
32479 .cindex "&'Sender:'& header line"
32480 .cindex "message" "submission"
32481 For a locally-originated message from an untrusted user, Exim may remove an
32482 existing &'Sender:'& header line, and it may add a new one. You can modify
32483 these actions by setting the &%local_sender_retain%& option true, the
32484 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32485 control setting.
32486
32487 When a local message is received from an untrusted user and
32488 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32489 control has not been set, a check is made to see if the address given in the
32490 &'From:'& header line is the correct (local) sender of the message. The address
32491 that is expected has the login name as the local part and the value of
32492 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32493 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32494 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32495 line is added to the message.
32496
32497 If you set &%local_from_check%& false, this checking does not occur. However,
32498 the removal of an existing &'Sender:'& line still happens, unless you also set
32499 &%local_sender_retain%& to be true. It is not possible to set both of these
32500 options true at the same time.
32501
32502 .cindex "submission mode"
32503 By default, no processing of &'Sender:'& header lines is done for messages
32504 received over TCP/IP or for messages submitted by trusted users. However, when
32505 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32506 not specified on the submission control, the following processing takes place:
32507
32508 .vindex "&$authenticated_id$&"
32509 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32510 authenticated, and &$authenticated_id$& is not empty, a sender address is
32511 created as follows:
32512
32513 .ilist
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 part
32519 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
32525 This address is compared with the address in the &'From:'& header line. If they
32526 are different, a &'Sender:'& header line containing the created address is
32527 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32528 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32529
32530 .cindex "return path" "created from &'Sender:'&"
32531 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32532 the message (the envelope sender address) is changed to be the same address,
32533 except in the case of submission mode when &%sender_retain%& is specified.
32534
32535
32536
32537 .section "Adding and removing header lines in routers and transports" &&&
32538          "SECTheadersaddrem"
32539 .cindex "header lines" "adding; in router or transport"
32540 .cindex "header lines" "removing; in router or transport"
32541 When a message is delivered, the addition and removal of header lines can be
32542 specified in a system filter, or on any of the routers and transports that
32543 process the message. Section &<<SECTaddremheasys>>& contains details about
32544 modifying headers in a system filter. Header lines can also be added in an ACL
32545 as a message is received (see section &<<SECTaddheadacl>>&).
32546
32547 In contrast to what happens in a system filter, header modifications that are
32548 specified on routers and transports apply only to the particular recipient
32549 addresses that are being processed by those routers and transports. These
32550 changes do not actually take place until a copy of the message is being
32551 transported. Therefore, they do not affect the basic set of header lines, and
32552 they do not affect the values of the variables that refer to header lines.
32553
32554 &*Note*&: In particular, this means that any expansions in the configuration of
32555 the transport cannot refer to the modified header lines, because such
32556 expansions all occur before the message is actually transported.
32557
32558 For both routers and transports, the argument of a &%headers_add%&
32559 option must be in the form of one or more RFC 2822 header lines, separated by
32560 newlines (coded as &"\n"&). For example:
32561 .code
32562 headers_add = X-added-header: added by $primary_hostname\n\
32563               X-added-second: another added header line
32564 .endd
32565 Exim does not check the syntax of these added header lines.
32566
32567 Multiple &%headers_add%& options for a single router or transport can be
32568 specified; the values will append to a single list of header lines.
32569 Each header-line is separately expanded.
32570
32571 The argument of a &%headers_remove%& option must consist of a colon-separated
32572 list of header names. This is confusing, because header names themselves are
32573 often terminated by colons. In this case, the colons are the list separators,
32574 not part of the names. For example:
32575 .code
32576 headers_remove = return-receipt-to:acknowledge-to
32577 .endd
32578
32579 Multiple &%headers_remove%& options for a single router or transport can be
32580 specified; the arguments will append to a single header-names list.
32581 Each item is separately expanded.
32582 Note that colons in complex expansions which are used to
32583 form all or part of a &%headers_remove%& list
32584 will act as list separators.
32585
32586 When &%headers_add%& or &%headers_remove%& is specified on a router,
32587 items are expanded at routing time,
32588 and then associated with all addresses that are
32589 accepted by that router, and also with any new addresses that it generates. If
32590 an address passes through several routers as a result of aliasing or
32591 forwarding, the changes are cumulative.
32592
32593 .oindex "&%unseen%&"
32594 However, this does not apply to multiple routers that result from the use of
32595 the &%unseen%& option. Any header modifications that were specified by the
32596 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32597
32598 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32599 settings cannot be delivered together in a batch, so a transport is always
32600 dealing with a set of addresses that have the same header-processing
32601 requirements.
32602
32603 The transport starts by writing the original set of header lines that arrived
32604 with the message, possibly modified by the system filter. As it writes out
32605 these lines, it consults the list of header names that were attached to the
32606 recipient address(es) by &%headers_remove%& options in routers, and it also
32607 consults the transport's own &%headers_remove%& option. Header lines whose
32608 names are on either of these lists are not written out. If there are multiple
32609 instances of any listed header, they are all skipped.
32610
32611 After the remaining original header lines have been written, new header
32612 lines that were specified by routers' &%headers_add%& options are written, in
32613 the order in which they were attached to the address. These are followed by any
32614 header lines specified by the transport's &%headers_add%& option.
32615
32616 This way of handling header line modifications in routers and transports has
32617 the following consequences:
32618
32619 .ilist
32620 The original set of header lines, possibly modified by the system filter,
32621 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32622 to it, at all times.
32623 .next
32624 Header lines that are added by a router's
32625 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32626 expansion syntax in subsequent routers or the transport.
32627 .next
32628 Conversely, header lines that are specified for removal by &%headers_remove%&
32629 in a router remain visible to subsequent routers and the transport.
32630 .next
32631 Headers added to an address by &%headers_add%& in a router cannot be removed by
32632 a later router or by a transport.
32633 .next
32634 An added header can refer to the contents of an original header that is to be
32635 removed, even it has the same name as the added header. For example:
32636 .code
32637 headers_remove = subject
32638 headers_add = Subject: new subject (was: $h_subject:)
32639 .endd
32640 .endlist
32641
32642 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32643 for a &(redirect)& router that has the &%one_time%& option set.
32644
32645
32646
32647
32648
32649 .section "Constructed addresses" "SECTconstr"
32650 .cindex "address" "constructed"
32651 .cindex "constructed address"
32652 When Exim constructs a sender address for a locally-generated message, it uses
32653 the form
32654 .display
32655 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32656 .endd
32657 For example:
32658 .code
32659 Zaphod Beeblebrox <zaphod@end.univ.example>
32660 .endd
32661 The user name is obtained from the &%-F%& command line option if set, or
32662 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32663 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32664 ampersand character, this is replaced by the login name with the first letter
32665 upper cased, as is conventional in a number of operating systems. See the
32666 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32667 The &%unknown_username%& option can be used to specify user names in cases when
32668 there is no password file entry.
32669
32670 .cindex "RFC 2047"
32671 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32672 parts of it if necessary. In addition, if it contains any non-printing
32673 characters, it is encoded as described in RFC 2047, which defines a way of
32674 including non-ASCII characters in header lines. The value of the
32675 &%headers_charset%& option specifies the name of the encoding that is used (the
32676 characters are assumed to be in this encoding). The setting of
32677 &%print_topbitchars%& controls whether characters with the top bit set (that
32678 is, with codes greater than 127) count as printing characters or not.
32679
32680
32681
32682 .section "Case of local parts" "SECID230"
32683 .cindex "case of local parts"
32684 .cindex "local part" "case of"
32685 RFC 2822 states that the case of letters in the local parts of addresses cannot
32686 be assumed to be non-significant. Exim preserves the case of local parts of
32687 addresses, but by default it uses a lower-cased form when it is routing,
32688 because on most Unix systems, usernames are in lower case and case-insensitive
32689 routing is required. However, any particular router can be made to use the
32690 original case for local parts by setting the &%caseful_local_part%& generic
32691 router option.
32692
32693 .cindex "mixed-case login names"
32694 If you must have mixed-case user names on your system, the best way to proceed,
32695 assuming you want case-independent handling of incoming email, is to set up
32696 your first router to convert incoming local parts in your domains to the
32697 correct case by means of a file lookup. For example:
32698 .code
32699 correct_case:
32700   driver = redirect
32701   domains = +local_domains
32702   data = ${lookup{$local_part}cdb\
32703               {/etc/usercased.cdb}{$value}fail}\
32704               @$domain
32705 .endd
32706 For this router, the local part is forced to lower case by the default action
32707 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32708 up a new local part in the correct case. If you then set &%caseful_local_part%&
32709 on any subsequent routers which process your domains, they will operate on
32710 local parts with the correct case in a case-sensitive manner.
32711
32712
32713
32714 .section "Dots in local parts" "SECID231"
32715 .cindex "dot" "in local part"
32716 .cindex "local part" "dots in"
32717 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32718 part may not begin or end with a dot, nor have two consecutive dots in the
32719 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32720 empty components for compatibility.
32721
32722
32723
32724 .section "Rewriting addresses" "SECID232"
32725 .cindex "rewriting" "addresses"
32726 Rewriting of sender and recipient addresses, and addresses in headers, can
32727 happen automatically, or as the result of configuration options, as described
32728 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32729 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32730
32731 Automatic rewriting includes qualification, as mentioned above. The other case
32732 in which it can happen is when an incomplete non-local domain is given. The
32733 routing process may cause this to be expanded into the full domain name. For
32734 example, a header such as
32735 .code
32736 To: hare@teaparty
32737 .endd
32738 might get rewritten as
32739 .code
32740 To: hare@teaparty.wonderland.fict.example
32741 .endd
32742 Rewriting as a result of routing is the one kind of message processing that
32743 does not happen at input time, as it cannot be done until the address has
32744 been routed.
32745
32746 Strictly, one should not do &'any'& deliveries of a message until all its
32747 addresses have been routed, in case any of the headers get changed as a
32748 result of routing. However, doing this in practice would hold up many
32749 deliveries for unreasonable amounts of time, just because one address could not
32750 immediately be routed. Exim therefore does not delay other deliveries when
32751 routing of one or more addresses is deferred.
32752 .ecindex IIDmesproc
32753
32754
32755
32756 . ////////////////////////////////////////////////////////////////////////////
32757 . ////////////////////////////////////////////////////////////////////////////
32758
32759 .chapter "SMTP processing" "CHAPSMTP"
32760 .scindex IIDsmtpproc1 "SMTP" "processing details"
32761 .scindex IIDsmtpproc2 "LMTP" "processing details"
32762 Exim supports a number of different ways of using the SMTP protocol, and its
32763 LMTP variant, which is an interactive protocol for transferring messages into a
32764 closed mail store application. This chapter contains details of how SMTP is
32765 processed. For incoming mail, the following are available:
32766
32767 .ilist
32768 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32769 .next
32770 SMTP over the standard input and output (the &%-bs%& option);
32771 .next
32772 Batched SMTP on the standard input (the &%-bS%& option).
32773 .endlist
32774
32775 For mail delivery, the following are available:
32776
32777 .ilist
32778 SMTP over TCP/IP (the &(smtp)& transport);
32779 .next
32780 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32781 &"lmtp"&);
32782 .next
32783 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32784 transport);
32785 .next
32786 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32787 the &%use_bsmtp%& option set).
32788 .endlist
32789
32790 &'Batched SMTP'& is the name for a process in which batches of messages are
32791 stored in or read from files (or pipes), in a format in which SMTP commands are
32792 used to contain the envelope information.
32793
32794
32795
32796 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32797 .cindex "SMTP" "outgoing over TCP/IP"
32798 .cindex "outgoing SMTP over TCP/IP"
32799 .cindex "LMTP" "over TCP/IP"
32800 .cindex "outgoing LMTP over TCP/IP"
32801 .cindex "EHLO"
32802 .cindex "HELO"
32803 .cindex "SIZE option on MAIL command"
32804 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32805 The &%protocol%& option selects which protocol is to be used, but the actual
32806 processing is the same in both cases.
32807
32808 If, in response to its EHLO command, Exim is told that the SIZE
32809 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32810 command. The value of <&'n'&> is the message size plus the value of the
32811 &%size_addition%& option (default 1024) to allow for additions to the message
32812 such as per-transport header lines, or changes made in a
32813 .cindex "transport" "filter"
32814 .cindex "filter" "transport filter"
32815 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32816 suppressed.
32817
32818 If the remote server advertises support for PIPELINING, Exim uses the
32819 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32820 required for the transaction.
32821
32822 If the remote server advertises support for the STARTTLS command, and Exim
32823 was built to support TLS encryption, it tries to start a TLS session unless the
32824 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32825 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32826 is called for verification.
32827
32828 If the remote server advertises support for the AUTH command, Exim scans
32829 the authenticators configuration for any suitable client settings, as described
32830 in chapter &<<CHAPSMTPAUTH>>&.
32831
32832 .cindex "carriage return"
32833 .cindex "linefeed"
32834 Responses from the remote host are supposed to be terminated by CR followed by
32835 LF. However, there are known to be hosts that do not send CR characters, so in
32836 order to be able to interwork with such hosts, Exim treats LF on its own as a
32837 line terminator.
32838
32839 If a message contains a number of different addresses, all those with the same
32840 characteristics (for example, the same envelope sender) that resolve to the
32841 same set of hosts, in the same order, are sent in a single SMTP transaction,
32842 even if they are for different domains, unless there are more than the setting
32843 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32844 they are split into groups containing no more than &%max_rcpt%&s addresses
32845 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32846 in parallel sessions. The order of hosts with identical MX values is not
32847 significant when checking whether addresses can be batched in this way.
32848
32849 When the &(smtp)& transport suffers a temporary failure that is not
32850 message-related, Exim updates its transport-specific database, which contains
32851 records indexed by host name that remember which messages are waiting for each
32852 particular host. It also updates the retry database with new retry times.
32853
32854 .cindex "hints database" "retry keys"
32855 Exim's retry hints are based on host name plus IP address, so if one address of
32856 a multi-homed host is broken, it will soon be skipped most of the time.
32857 See the next section for more detail about error handling.
32858
32859 .cindex "SMTP" "passed connection"
32860 .cindex "SMTP" "batching over TCP/IP"
32861 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32862 looks in the hints database for the transport to see if there are any queued
32863 messages waiting for the host to which it is connected. If it finds one, it
32864 creates a new Exim process using the &%-MC%& option (which can only be used by
32865 a process running as root or the Exim user) and passes the TCP/IP socket to it
32866 so that it can deliver another message using the same socket. The new process
32867 does only those deliveries that are routed to the connected host, and may in
32868 turn pass the socket on to a third process, and so on.
32869
32870 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32871 limit the number of messages sent down a single TCP/IP connection.
32872
32873 .cindex "asterisk" "after IP address"
32874 The second and subsequent messages delivered down an existing connection are
32875 identified in the main log by the addition of an asterisk after the closing
32876 square bracket of the IP address.
32877
32878
32879
32880
32881 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32882 .cindex "error" "in outgoing SMTP"
32883 .cindex "SMTP" "errors in outgoing"
32884 .cindex "host" "error"
32885 Three different kinds of error are recognized for outgoing SMTP: host errors,
32886 message errors, and recipient errors.
32887
32888 .vlist
32889 .vitem "&*Host errors*&"
32890 A host error is not associated with a particular message or with a
32891 particular recipient of a message. The host errors are:
32892
32893 .ilist
32894 Connection refused or timed out,
32895 .next
32896 Any error response code on connection,
32897 .next
32898 Any error response code to EHLO or HELO,
32899 .next
32900 Loss of connection at any time, except after &"."&,
32901 .next
32902 I/O errors at any time,
32903 .next
32904 Timeouts during the session, other than in response to MAIL, RCPT or
32905 the &"."& at the end of the data.
32906 .endlist ilist
32907
32908 For a host error, a permanent error response on connection, or in response to
32909 EHLO, causes all addresses routed to the host to be failed. Any other host
32910 error causes all addresses to be deferred, and retry data to be created for the
32911 host. It is not tried again, for any message, until its retry time arrives. If
32912 the current set of addresses are not all delivered in this run (to some
32913 alternative host), the message is added to the list of those waiting for this
32914 host, so if it is still undelivered when a subsequent successful delivery is
32915 made to the host, it will be sent down the same SMTP connection.
32916
32917 .vitem "&*Message errors*&"
32918 .cindex "message" "error"
32919 A message error is associated with a particular message when sent to a
32920 particular host, but not with a particular recipient of the message. The
32921 message errors are:
32922
32923 .ilist
32924 Any error response code to MAIL, DATA, or the &"."& that terminates
32925 the data,
32926 .next
32927 Timeout after MAIL,
32928 .next
32929 Timeout or loss of connection after the &"."& that terminates the data. A
32930 timeout after the DATA command itself is treated as a host error, as is loss of
32931 connection at any other time.
32932 .endlist ilist
32933
32934 For a message error, a permanent error response (5&'xx'&) causes all addresses
32935 to be failed, and a delivery error report to be returned to the sender. A
32936 temporary error response (4&'xx'&), or one of the timeouts, causes all
32937 addresses to be deferred. Retry data is not created for the host, but instead,
32938 a retry record for the combination of host plus message id is created. The
32939 message is not added to the list of those waiting for this host. This ensures
32940 that the failing message will not be sent to this host again until the retry
32941 time arrives. However, other messages that are routed to the host are not
32942 affected, so if it is some property of the message that is causing the error,
32943 it will not stop the delivery of other mail.
32944
32945 If the remote host specified support for the SIZE parameter in its response
32946 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32947 over-large message will cause a message error because the error arrives as a
32948 response to MAIL.
32949
32950 .vitem "&*Recipient errors*&"
32951 .cindex "recipient" "error"
32952 A recipient error is associated with a particular recipient of a message. The
32953 recipient errors are:
32954
32955 .ilist
32956 Any error response to RCPT,
32957 .next
32958 Timeout after RCPT.
32959 .endlist
32960
32961 For a recipient error, a permanent error response (5&'xx'&) causes the
32962 recipient address to be failed, and a bounce message to be returned to the
32963 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32964 address to be deferred, and routing retry data to be created for it. This is
32965 used to delay processing of the address in subsequent queue runs, until its
32966 routing retry time arrives. This applies to all messages, but because it
32967 operates only in queue runs, one attempt will be made to deliver a new message
32968 to the failing address before the delay starts to operate. This ensures that,
32969 if the failure is really related to the message rather than the recipient
32970 (&"message too big for this recipient"& is a possible example), other messages
32971 have a chance of getting delivered. If a delivery to the address does succeed,
32972 the retry information gets cleared, so all stuck messages get tried again, and
32973 the retry clock is reset.
32974
32975 The message is not added to the list of those waiting for this host. Use of the
32976 host for other messages is unaffected, and except in the case of a timeout,
32977 other recipients are processed independently, and may be successfully delivered
32978 in the current SMTP session. After a timeout it is of course impossible to
32979 proceed with the session, so all addresses get deferred. However, those other
32980 than the one that failed do not suffer any subsequent retry delays. Therefore,
32981 if one recipient is causing trouble, the others have a chance of getting
32982 through when a subsequent delivery attempt occurs before the failing
32983 recipient's retry time.
32984 .endlist
32985
32986 In all cases, if there are other hosts (or IP addresses) available for the
32987 current set of addresses (for example, from multiple MX records), they are
32988 tried in this run for any undelivered addresses, subject of course to their
32989 own retry data. In other words, recipient error retry data does not take effect
32990 until the next delivery attempt.
32991
32992 Some hosts have been observed to give temporary error responses to every
32993 MAIL command at certain times (&"insufficient space"& has been seen). It
32994 would be nice if such circumstances could be recognized, and defer data for the
32995 host itself created, but this is not possible within the current Exim design.
32996 What actually happens is that retry data for every (host, message) combination
32997 is created.
32998
32999 The reason that timeouts after MAIL and RCPT are treated specially is that
33000 these can sometimes arise as a result of the remote host's verification
33001 procedures. Exim makes this assumption, and treats them as if a temporary error
33002 response had been received. A timeout after &"."& is treated specially because
33003 it is known that some broken implementations fail to recognize the end of the
33004 message if the last character of the last line is a binary zero. Thus, it is
33005 helpful to treat this case as a message error.
33006
33007 Timeouts at other times are treated as host errors, assuming a problem with the
33008 host, or the connection to it. If a timeout after MAIL, RCPT,
33009 or &"."& is really a connection problem, the assumption is that at the next try
33010 the timeout is likely to occur at some other point in the dialogue, causing it
33011 then to be treated as a host error.
33012
33013 There is experimental evidence that some MTAs drop the connection after the
33014 terminating &"."& if they do not like the contents of the message for some
33015 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33016 should be given. That is why Exim treats this case as a message rather than a
33017 host error, in order not to delay other messages to the same host.
33018
33019
33020
33021
33022 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33023 .cindex "SMTP" "incoming over TCP/IP"
33024 .cindex "incoming SMTP over TCP/IP"
33025 .cindex "inetd"
33026 .cindex "daemon"
33027 Incoming SMTP messages can be accepted in one of two ways: by running a
33028 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33029 &_/etc/inetd.conf_& should be like this:
33030 .code
33031 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33032 .endd
33033 Exim distinguishes between this case and the case of a locally running user
33034 agent using the &%-bs%& option by checking whether or not the standard input is
33035 a socket. When it is, either the port must be privileged (less than 1024), or
33036 the caller must be root or the Exim user. If any other user passes a socket
33037 with an unprivileged port number, Exim prints a message on the standard error
33038 stream and exits with an error code.
33039
33040 By default, Exim does not make a log entry when a remote host connects or
33041 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33042 unexpected. It can be made to write such log entries by setting the
33043 &%smtp_connection%& log selector.
33044
33045 .cindex "carriage return"
33046 .cindex "linefeed"
33047 Commands from the remote host are supposed to be terminated by CR followed by
33048 LF. However, there are known to be hosts that do not send CR characters. In
33049 order to be able to interwork with such hosts, Exim treats LF on its own as a
33050 line terminator.
33051 Furthermore, because common code is used for receiving messages from all
33052 sources, a CR on its own is also interpreted as a line terminator. However, the
33053 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33054
33055 .cindex "EHLO" "invalid data"
33056 .cindex "HELO" "invalid data"
33057 One area that sometimes gives rise to problems concerns the EHLO or
33058 HELO commands. Some clients send syntactically invalid versions of these
33059 commands, which Exim rejects by default. (This is nothing to do with verifying
33060 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33061 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33062 match the broken hosts that send invalid commands.
33063
33064 .cindex "SIZE option on MAIL command"
33065 .cindex "MAIL" "SIZE option"
33066 The amount of disk space available is checked whenever SIZE is received on
33067 a MAIL command, independently of whether &%message_size_limit%& or
33068 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33069 false. A temporary error is given if there is not enough space. If
33070 &%check_spool_space%& is set, the check is for that amount of space plus the
33071 value given with SIZE, that is, it checks that the addition of the incoming
33072 message will not reduce the space below the threshold.
33073
33074 When a message is successfully received, Exim includes the local message id in
33075 its response to the final &"."& that terminates the data. If the remote host
33076 logs this text it can help with tracing what has happened to a message.
33077
33078 The Exim daemon can limit the number of simultaneous incoming connections it is
33079 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33080 number of simultaneous incoming connections from a single remote host (see the
33081 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33082 rejected using the SMTP temporary error code 421.
33083
33084 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33085 subprocess has finished, as this can get lost at busy times. Instead, it looks
33086 for completed subprocesses every time it wakes up. Provided there are other
33087 things happening (new incoming calls, starts of queue runs), completed
33088 processes will be noticed and tidied away. On very quiet systems you may
33089 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33090 it will be noticed when the daemon next wakes up.
33091
33092 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33093 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33094 high system load &-- for details see the &%smtp_accept_reserve%&,
33095 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33096 applies in both the daemon and &'inetd'& cases.
33097
33098 Exim normally starts a delivery process for each message received, though this
33099 can be varied by means of the &%-odq%& command line option and the
33100 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33101 number of simultaneously running delivery processes started in this way from
33102 SMTP input can be limited by the &%smtp_accept_queue%& and
33103 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33104 subsequently received messages are just put on the input queue without starting
33105 a delivery process.
33106
33107 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33108 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33109 started up from the &'inetd'& daemon, because in that case each connection is
33110 handled by an entirely independent Exim process. Control by load average is,
33111 however, available with &'inetd'&.
33112
33113 Exim can be configured to verify addresses in incoming SMTP commands as they
33114 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33115 to rewrite addresses at this time &-- before any syntax checking is done. See
33116 section &<<SECTrewriteS>>&.
33117
33118 Exim can also be configured to limit the rate at which a client host submits
33119 MAIL and RCPT commands in a single SMTP session. See the
33120 &%smtp_ratelimit_hosts%& option.
33121
33122
33123
33124 .section "Unrecognized SMTP commands" "SECID234"
33125 .cindex "SMTP" "unrecognized commands"
33126 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33127 commands during a single SMTP connection, it drops the connection after sending
33128 the error response to the last command. The default value for
33129 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33130 abuse that subvert web servers into making connections to SMTP ports; in these
33131 circumstances, a number of non-SMTP lines are sent first.
33132
33133
33134 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33135 .cindex "SMTP" "syntax errors"
33136 .cindex "SMTP" "protocol errors"
33137 A syntax error is detected if an SMTP command is recognized, but there is
33138 something syntactically wrong with its data, for example, a malformed email
33139 address in a RCPT command. Protocol errors include invalid command
33140 sequencing such as RCPT before MAIL. If Exim receives more than
33141 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33142 drops the connection after sending the error response to the last command. The
33143 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33144 broken clients that loop sending bad commands (yes, it has been seen).
33145
33146
33147
33148 .section "Use of non-mail SMTP commands" "SECID236"
33149 .cindex "SMTP" "non-mail commands"
33150 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33151 DATA. Exim counts such commands, and drops the connection if there are too
33152 many of them in a single SMTP session. This action catches some
33153 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33154 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33155 defines what &"too many"& means. Its default value is 10.
33156
33157 When a new message is expected, one occurrence of RSET is not counted. This
33158 allows a client to send one RSET between messages (this is not necessary,
33159 but some clients do it). Exim also allows one uncounted occurrence of HELO
33160 or EHLO, and one occurrence of STARTTLS between messages. After
33161 starting up a TLS session, another EHLO is expected, and so it too is not
33162 counted.
33163
33164 The first occurrence of AUTH in a connection, or immediately following
33165 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33166 RCPT, DATA, and QUIT are counted.
33167
33168 You can control which hosts are subject to the limit set by
33169 &%smtp_accept_max_nonmail%& by setting
33170 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33171 the limit apply to all hosts. This option means that you can exclude any
33172 specific badly-behaved hosts that you have to live with.
33173
33174
33175
33176
33177 .section "The VRFY and EXPN commands" "SECID237"
33178 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33179 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33180 appropriate) in order to decide whether the command should be accepted or not.
33181 If no ACL is defined, the command is rejected.
33182
33183 .cindex "VRFY" "processing"
33184 When VRFY is accepted, it runs exactly the same code as when Exim is
33185 called with the &%-bv%& option.
33186
33187 .cindex "EXPN" "processing"
33188 When EXPN is accepted, a single-level expansion of the address is done.
33189 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33190 than a verification (the &%-bv%& option). If an unqualified local part is given
33191 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33192 of VRFY and EXPN commands are logged on the main and reject logs, and
33193 VRFY verification failures are logged on the main log for consistency with
33194 RCPT failures.
33195
33196
33197
33198 .section "The ETRN command" "SECTETRN"
33199 .cindex "ETRN" "processing"
33200 RFC 1985 describes an SMTP command called ETRN that is designed to
33201 overcome the security problems of the TURN command (which has fallen into
33202 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33203 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33204 should be accepted or not. If no ACL is defined, the command is rejected.
33205
33206 The ETRN command is concerned with &"releasing"& messages that are awaiting
33207 delivery to certain hosts. As Exim does not organize its message queue by host,
33208 the only form of ETRN that is supported by default is the one where the
33209 text starts with the &"#"& prefix, in which case the remainder of the text is
33210 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33211 the &%-R%& option to happen, with the remainder of the ETRN text as its
33212 argument. For example,
33213 .code
33214 ETRN #brigadoon
33215 .endd
33216 runs the command
33217 .code
33218 exim -R brigadoon
33219 .endd
33220 which causes a delivery attempt on all messages with undelivered addresses
33221 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33222 default), Exim prevents the simultaneous execution of more than one queue run
33223 for the same argument string as a result of an ETRN command. This stops
33224 a misbehaving client from starting more than one queue runner at once.
33225
33226 .cindex "hints database" "ETRN serialization"
33227 Exim implements the serialization by means of a hints database in which a
33228 record is written whenever a process is started by ETRN, and deleted when
33229 the process completes. However, Exim does not keep the SMTP session waiting for
33230 the ETRN process to complete. Once ETRN is accepted, the client is sent
33231 a &"success"& return code. Obviously there is scope for hints records to get
33232 left lying around if there is a system or program crash. To guard against this,
33233 Exim ignores any records that are more than six hours old.
33234
33235 .oindex "&%smtp_etrn_command%&"
33236 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33237 used. This specifies a command that is run whenever ETRN is received,
33238 whatever the form of its argument. For
33239 example:
33240 .code
33241 smtp_etrn_command = /etc/etrn_command $domain \
33242                     $sender_host_address
33243 .endd
33244 .vindex "&$domain$&"
33245 The string is split up into arguments which are independently expanded. The
33246 expansion variable &$domain$& is set to the argument of the ETRN command,
33247 and no syntax checking is done on the contents of this argument. Exim does not
33248 wait for the command to complete, so its status code is not checked. Exim runs
33249 under its own uid and gid when receiving incoming SMTP, so it is not possible
33250 for it to change them before running the command.
33251
33252
33253
33254 .section "Incoming local SMTP" "SECID238"
33255 .cindex "SMTP" "local incoming"
33256 Some user agents use SMTP to pass messages to their local MTA using the
33257 standard input and output, as opposed to passing the envelope on the command
33258 line and writing the message to the standard input. This is supported by the
33259 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33260 messages over TCP/IP (including the use of ACLs), except that the envelope
33261 sender given in a MAIL command is ignored unless the caller is trusted. In
33262 an ACL you can detect this form of SMTP input by testing for an empty host
33263 identification. It is common to have this as the first line in the ACL that
33264 runs for RCPT commands:
33265 .code
33266 accept hosts = :
33267 .endd
33268 This accepts SMTP messages from local processes without doing any other tests.
33269
33270
33271
33272 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33273 .cindex "SMTP" "batched outgoing"
33274 .cindex "batched SMTP output"
33275 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33276 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33277 be output in BSMTP format. No SMTP responses are possible for this form of
33278 delivery. All it is doing is using SMTP commands as a way of transmitting the
33279 envelope along with the message.
33280
33281 The message is written to the file or pipe preceded by the SMTP commands
33282 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33283 the message that start with a dot have an extra dot added. The SMTP command
33284 HELO is not normally used. If it is required, the &%message_prefix%& option
33285 can be used to specify it.
33286
33287 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33288 one recipient address at a time by default. However, you can arrange for them
33289 to handle several addresses at once by setting the &%batch_max%& option. When
33290 this is done for BSMTP, messages may contain multiple RCPT commands. See
33291 chapter &<<CHAPbatching>>& for more details.
33292
33293 .vindex "&$host$&"
33294 When one or more addresses are routed to a BSMTP transport by a router that
33295 sets up a host list, the name of the first host on the list is available to the
33296 transport in the variable &$host$&. Here is an example of such a transport and
33297 router:
33298 .code
33299 begin routers
33300 route_append:
33301   driver = manualroute
33302   transport = smtp_appendfile
33303   route_list = domain.example  batch.host.example
33304
33305 begin transports
33306 smtp_appendfile:
33307   driver = appendfile
33308   directory = /var/bsmtp/$host
33309   batch_max = 1000
33310   use_bsmtp
33311   user = exim
33312 .endd
33313 This causes messages addressed to &'domain.example'& to be written in BSMTP
33314 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33315 message (unless there are more than 1000 recipients).
33316
33317
33318
33319 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33320 .cindex "SMTP" "batched incoming"
33321 .cindex "batched SMTP input"
33322 The &%-bS%& command line option causes Exim to accept one or more messages by
33323 reading SMTP on the standard input, but to generate no responses. If the caller
33324 is trusted, the senders in the MAIL commands are believed; otherwise the
33325 sender is always the caller of Exim. Unqualified senders and receivers are not
33326 rejected (there seems little point) but instead just get qualified. HELO
33327 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33328 as NOOP; QUIT quits.
33329
33330 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33331 ACL is run in the same way as for non-SMTP local input.
33332
33333 If an error is detected while reading a message, including a missing &"."& at
33334 the end, Exim gives up immediately. It writes details of the error to the
33335 standard output in a stylized way that the calling program should be able to
33336 make some use of automatically, for example:
33337 .code
33338 554 Unexpected end of file
33339 Transaction started in line 10
33340 Error detected in line 14
33341 .endd
33342 It writes a more verbose version, for human consumption, to the standard error
33343 file, for example:
33344 .code
33345 An error was detected while processing a file of BSMTP input.
33346 The error message was:
33347
33348 501 '>' missing at end of address
33349
33350 The SMTP transaction started in line 10.
33351 The error was detected in line 12.
33352 The SMTP command at fault was:
33353
33354 rcpt to:<malformed@in.com.plete
33355
33356 1 previous message was successfully processed.
33357 The rest of the batch was abandoned.
33358 .endd
33359 The return code from Exim is zero only if there were no errors. It is 1 if some
33360 messages were accepted before an error was detected, and 2 if no messages were
33361 accepted.
33362 .ecindex IIDsmtpproc1
33363 .ecindex IIDsmtpproc2
33364
33365
33366
33367 . ////////////////////////////////////////////////////////////////////////////
33368 . ////////////////////////////////////////////////////////////////////////////
33369
33370 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33371          "Customizing messages"
33372 When a message fails to be delivered, or remains on the queue for more than a
33373 configured amount of time, Exim sends a message to the original sender, or
33374 to an alternative configured address. The text of these messages is built into
33375 the code of Exim, but it is possible to change it, either by adding a single
33376 string, or by replacing each of the paragraphs by text supplied in a file.
33377
33378 The &'From:'& and &'To:'& header lines are automatically generated; you can
33379 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33380 option. Exim also adds the line
33381 .code
33382 Auto-Submitted: auto-generated
33383 .endd
33384 to all warning and bounce messages,
33385
33386
33387 .section "Customizing bounce messages" "SECID239"
33388 .cindex "customizing" "bounce message"
33389 .cindex "bounce message" "customizing"
33390 If &%bounce_message_text%& is set, its contents are included in the default
33391 message immediately after &"This message was created automatically by mail
33392 delivery software."& The string is not expanded. It is not used if
33393 &%bounce_message_file%& is set.
33394
33395 When &%bounce_message_file%& is set, it must point to a template file for
33396 constructing error messages. The file consists of a series of text items,
33397 separated by lines consisting of exactly four asterisks. If the file cannot be
33398 opened, default text is used and a message is written to the main and panic
33399 logs. If any text item in the file is empty, default text is used for that
33400 item.
33401
33402 .vindex "&$bounce_recipient$&"
33403 .vindex "&$bounce_return_size_limit$&"
33404 Each item of text that is read from the file is expanded, and there are two
33405 expansion variables which can be of use here: &$bounce_recipient$& is set to
33406 the recipient of an error message while it is being created, and
33407 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33408 option, rounded to a whole number.
33409
33410 The items must appear in the file in the following order:
33411
33412 .ilist
33413 The first item is included in the headers, and should include at least a
33414 &'Subject:'& header. Exim does not check the syntax of these headers.
33415 .next
33416 The second item forms the start of the error message. After it, Exim lists the
33417 failing addresses with their error messages.
33418 .next
33419 The third item is used to introduce any text from pipe transports that is to be
33420 returned to the sender. It is omitted if there is no such text.
33421 .next
33422 The fourth item is used to introduce the copy of the message that is returned
33423 as part of the error report.
33424 .next
33425 The fifth item is added after the fourth one if the returned message is
33426 truncated because it is bigger than &%return_size_limit%&.
33427 .next
33428 The sixth item is added after the copy of the original message.
33429 .endlist
33430
33431 The default state (&%bounce_message_file%& unset) is equivalent to the
33432 following file, in which the sixth item is empty. The &'Subject:'& and some
33433 other lines have been split in order to fit them on the page:
33434 .code
33435 Subject: Mail delivery failed
33436   ${if eq{$sender_address}{$bounce_recipient}
33437   {: returning message to sender}}
33438 ****
33439 This message was created automatically by mail delivery software.
33440
33441 A message ${if eq{$sender_address}{$bounce_recipient}
33442   {that you sent }{sent by
33443
33444 <$sender_address>
33445
33446 }}could not be delivered to all of its recipients.
33447 This is a permanent error. The following address(es) failed:
33448 ****
33449 The following text was generated during the delivery attempt(s):
33450 ****
33451 ------ This is a copy of the message, including all the headers.
33452   ------
33453 ****
33454 ------ The body of the message is $message_size characters long;
33455   only the first
33456 ------ $bounce_return_size_limit or so are included here.
33457 ****
33458 .endd
33459 .section "Customizing warning messages" "SECTcustwarn"
33460 .cindex "customizing" "warning message"
33461 .cindex "warning of delay" "customizing the message"
33462 The option &%warn_message_file%& can be pointed at a template file for use when
33463 warnings about message delays are created. In this case there are only three
33464 text sections:
33465
33466 .ilist
33467 The first item is included in the headers, and should include at least a
33468 &'Subject:'& header. Exim does not check the syntax of these headers.
33469 .next
33470 The second item forms the start of the warning message. After it, Exim lists
33471 the delayed addresses.
33472 .next
33473 The third item then ends the message.
33474 .endlist
33475
33476 The default state is equivalent to the following file, except that some lines
33477 have been split here, in order to fit them on the page:
33478 .code
33479 Subject: Warning: message $message_exim_id delayed
33480   $warn_message_delay
33481 ****
33482 This message was created automatically by mail delivery software.
33483
33484 A message ${if eq{$sender_address}{$warn_message_recipients}
33485 {that you sent }{sent by
33486
33487 <$sender_address>
33488
33489 }}has not been delivered to all of its recipients after
33490 more than $warn_message_delay on the queue on $primary_hostname.
33491
33492 The message identifier is:     $message_exim_id
33493 The subject of the message is: $h_subject
33494 The date of the message is:    $h_date
33495
33496 The following address(es) have not yet been delivered:
33497 ****
33498 No action is required on your part. Delivery attempts will
33499 continue for some time, and this warning may be repeated at
33500 intervals if the message remains undelivered. Eventually the
33501 mail delivery software will give up, and when that happens,
33502 the message will be returned to you.
33503 .endd
33504 .vindex "&$warn_message_delay$&"
33505 .vindex "&$warn_message_recipients$&"
33506 However, in the default state the subject and date lines are omitted if no
33507 appropriate headers exist. During the expansion of this file,
33508 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33509 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33510 of recipients for the warning message. There may be more than one if there are
33511 multiple addresses with different &%errors_to%& settings on the routers that
33512 handled them.
33513
33514
33515
33516
33517 . ////////////////////////////////////////////////////////////////////////////
33518 . ////////////////////////////////////////////////////////////////////////////
33519
33520 .chapter "Some common configuration settings" "CHAPcomconreq"
33521 This chapter discusses some configuration settings that seem to be fairly
33522 common. More examples and discussion can be found in the Exim book.
33523
33524
33525
33526 .section "Sending mail to a smart host" "SECID240"
33527 .cindex "smart host" "example router"
33528 If you want to send all mail for non-local domains to a &"smart host"&, you
33529 should replace the default &(dnslookup)& router with a router which does the
33530 routing explicitly:
33531 .code
33532 send_to_smart_host:
33533   driver = manualroute
33534   route_list = !+local_domains smart.host.name
33535   transport = remote_smtp
33536 .endd
33537 You can use the smart host's IP address instead of the name if you wish.
33538 If you are using Exim only to submit messages to a smart host, and not for
33539 receiving incoming messages, you can arrange for it to do the submission
33540 synchronously by setting the &%mua_wrapper%& option (see chapter
33541 &<<CHAPnonqueueing>>&).
33542
33543
33544
33545
33546 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33547 .cindex "mailing lists"
33548 Exim can be used to run simple mailing lists, but for large and/or complicated
33549 requirements, the use of additional specialized mailing list software such as
33550 Majordomo or Mailman is recommended.
33551
33552 The &(redirect)& router can be used to handle mailing lists where each list
33553 is maintained in a separate file, which can therefore be managed by an
33554 independent manager. The &%domains%& router option can be used to run these
33555 lists in a separate domain from normal mail. For example:
33556 .code
33557 lists:
33558   driver = redirect
33559   domains = lists.example
33560   file = /usr/lists/$local_part
33561   forbid_pipe
33562   forbid_file
33563   errors_to = $local_part-request@lists.example
33564   no_more
33565 .endd
33566 This router is skipped for domains other than &'lists.example'&. For addresses
33567 in that domain, it looks for a file that matches the local part. If there is no
33568 such file, the router declines, but because &%no_more%& is set, no subsequent
33569 routers are tried, and so the whole delivery fails.
33570
33571 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33572 expanded into a file name or a pipe delivery, which is usually inappropriate in
33573 a mailing list.
33574
33575 .oindex "&%errors_to%&"
33576 The &%errors_to%& option specifies that any delivery errors caused by addresses
33577 taken from a mailing list are to be sent to the given address rather than the
33578 original sender of the message. However, before acting on this, Exim verifies
33579 the error address, and ignores it if verification fails.
33580
33581 For example, using the configuration above, mail sent to
33582 &'dicts@lists.example'& is passed on to those addresses contained in
33583 &_/usr/lists/dicts_&, with error reports directed to
33584 &'dicts-request@lists.example'&, provided that this address can be verified.
33585 There could be a file called &_/usr/lists/dicts-request_& containing
33586 the address(es) of this particular list's manager(s), but other approaches,
33587 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33588 or &%local_part_suffix%& options) to handle addresses of the form
33589 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33590
33591
33592
33593 .section "Syntax errors in mailing lists" "SECID241"
33594 .cindex "mailing lists" "syntax errors in"
33595 If an entry in redirection data contains a syntax error, Exim normally defers
33596 delivery of the original address. That means that a syntax error in a mailing
33597 list holds up all deliveries to the list. This may not be appropriate when a
33598 list is being maintained automatically from data supplied by users, and the
33599 addresses are not rigorously checked.
33600
33601 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33602 entries that fail to parse, noting the incident in the log. If in addition
33603 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33604 whenever a broken address is skipped. It is usually appropriate to set
33605 &%syntax_errors_to%& to the same address as &%errors_to%&.
33606
33607
33608
33609 .section "Re-expansion of mailing lists" "SECID242"
33610 .cindex "mailing lists" "re-expansion of"
33611 Exim remembers every individual address to which a message has been delivered,
33612 in order to avoid duplication, but it normally stores only the original
33613 recipient addresses with a message. If all the deliveries to a mailing list
33614 cannot be done at the first attempt, the mailing list is re-expanded when the
33615 delivery is next tried. This means that alterations to the list are taken into
33616 account at each delivery attempt, so addresses that have been added to
33617 the list since the message arrived will therefore receive a copy of the
33618 message, even though it pre-dates their subscription.
33619
33620 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33621 on the &(redirect)& router. If this is done, any addresses generated by the
33622 router that fail to deliver at the first attempt are added to the message as
33623 &"top level"& addresses, and the parent address that generated them is marked
33624 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33625 subsequent delivery attempts. The disadvantage of this is that if any of the
33626 failing addresses are incorrect, correcting them in the file has no effect on
33627 pre-existing messages.
33628
33629 The original top-level address is remembered with each of the generated
33630 addresses, and is output in any log messages. However, any intermediate parent
33631 addresses are not recorded. This makes a difference to the log only if the
33632 &%all_parents%& selector is set, but for mailing lists there is normally only
33633 one level of expansion anyway.
33634
33635
33636
33637 .section "Closed mailing lists" "SECID243"
33638 .cindex "mailing lists" "closed"
33639 The examples so far have assumed open mailing lists, to which anybody may
33640 send mail. It is also possible to set up closed lists, where mail is accepted
33641 from specified senders only. This is done by making use of the generic
33642 &%senders%& option to restrict the router that handles the list.
33643
33644 The following example uses the same file as a list of recipients and as a list
33645 of permitted senders. It requires three routers:
33646 .code
33647 lists_request:
33648   driver = redirect
33649   domains = lists.example
33650   local_part_suffix = -request
33651   file = /usr/lists/$local_part$local_part_suffix
33652   no_more
33653
33654 lists_post:
33655   driver = redirect
33656   domains = lists.example
33657   senders = ${if exists {/usr/lists/$local_part}\
33658              {lsearch;/usr/lists/$local_part}{*}}
33659   file = /usr/lists/$local_part
33660   forbid_pipe
33661   forbid_file
33662   errors_to = $local_part-request@lists.example
33663   no_more
33664
33665 lists_closed:
33666   driver = redirect
33667   domains = lists.example
33668   allow_fail
33669   data = :fail: $local_part@lists.example is a closed mailing list
33670 .endd
33671 All three routers have the same &%domains%& setting, so for any other domains,
33672 they are all skipped. The first router runs only if the local part ends in
33673 &%-request%&. It handles messages to the list manager(s) by means of an open
33674 mailing list.
33675
33676 The second router runs only if the &%senders%& precondition is satisfied. It
33677 checks for the existence of a list that corresponds to the local part, and then
33678 checks that the sender is on the list by means of a linear search. It is
33679 necessary to check for the existence of the file before trying to search it,
33680 because otherwise Exim thinks there is a configuration error. If the file does
33681 not exist, the expansion of &%senders%& is *, which matches all senders. This
33682 means that the router runs, but because there is no list, declines, and
33683 &%no_more%& ensures that no further routers are run. The address fails with an
33684 &"unrouteable address"& error.
33685
33686 The third router runs only if the second router is skipped, which happens when
33687 a mailing list exists, but the sender is not on it. This router forcibly fails
33688 the address, giving a suitable error message.
33689
33690
33691
33692
33693 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33694 .cindex "VERP"
33695 .cindex "Variable Envelope Return Paths"
33696 .cindex "envelope sender"
33697 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33698 are a way of helping mailing list administrators discover which subscription
33699 address is the cause of a particular delivery failure. The idea is to encode
33700 the original recipient address in the outgoing envelope sender address, so that
33701 if the message is forwarded by another host and then subsequently bounces, the
33702 original recipient can be extracted from the recipient address of the bounce.
33703
33704 .oindex &%errors_to%&
33705 .oindex &%return_path%&
33706 Envelope sender addresses can be modified by Exim using two different
33707 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33708 list examples), or the &%return_path%& option on a transport. The second of
33709 these is effective only if the message is successfully delivered to another
33710 host; it is not used for errors detected on the local host (see the description
33711 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33712 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33713 .code
33714 verp_smtp:
33715   driver = smtp
33716   max_rcpt = 1
33717   return_path = \
33718     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33719       {$1-request+$local_part=$domain@your.dom.example}fail}
33720 .endd
33721 This has the effect of rewriting the return path (envelope sender) on outgoing
33722 SMTP messages, if the local part of the original return path ends in
33723 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33724 local part and domain of the recipient into the return path. Suppose, for
33725 example, that a message whose return path has been set to
33726 &'somelist-request@your.dom.example'& is sent to
33727 &'subscriber@other.dom.example'&. In the transport, the return path is
33728 rewritten as
33729 .code
33730 somelist-request+subscriber=other.dom.example@your.dom.example
33731 .endd
33732 .vindex "&$local_part$&"
33733 For this to work, you must tell Exim to send multiple copies of messages that
33734 have more than one recipient, so that each copy has just one recipient. This is
33735 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33736 might be sent to several different recipients in the same domain, in which case
33737 &$local_part$& is not available in the transport, because it is not unique.
33738
33739 Unless your host is doing nothing but mailing list deliveries, you should
33740 probably use a separate transport for the VERP deliveries, so as not to use
33741 extra resources in making one-per-recipient copies for other deliveries. This
33742 can easily be done by expanding the &%transport%& option in the router:
33743 .code
33744 dnslookup:
33745   driver = dnslookup
33746   domains = ! +local_domains
33747   transport = \
33748     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33749       {verp_smtp}{remote_smtp}}
33750   no_more
33751 .endd
33752 If you want to change the return path using &%errors_to%& in a router instead
33753 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33754 routers that handle mailing list addresses. This will ensure that all delivery
33755 errors, including those detected on the local host, are sent to the VERP
33756 address.
33757
33758 On a host that does no local deliveries and has no manual routing, only the
33759 &(dnslookup)& router needs to be changed. A special transport is not needed for
33760 SMTP deliveries. Every mailing list recipient has its own return path value,
33761 and so Exim must hand them to the transport one at a time. Here is an example
33762 of a &(dnslookup)& router that implements VERP:
33763 .code
33764 verp_dnslookup:
33765   driver = dnslookup
33766   domains = ! +local_domains
33767   transport = remote_smtp
33768   errors_to = \
33769     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33770      {$1-request+$local_part=$domain@your.dom.example}fail}
33771   no_more
33772 .endd
33773 Before you start sending out messages with VERPed return paths, you must also
33774 configure Exim to accept the bounce messages that come back to those paths.
33775 Typically this is done by setting a &%local_part_suffix%& option for a
33776 router, and using this to route the messages to wherever you want to handle
33777 them.
33778
33779 The overhead incurred in using VERP depends very much on the size of the
33780 message, the number of recipient addresses that resolve to the same remote
33781 host, and the speed of the connection over which the message is being sent. If
33782 a lot of addresses resolve to the same host and the connection is slow, sending
33783 a separate copy of the message for each address may take substantially longer
33784 than sending a single copy with many recipients (for which VERP cannot be
33785 used).
33786
33787
33788
33789
33790
33791
33792 .section "Virtual domains" "SECTvirtualdomains"
33793 .cindex "virtual domains"
33794 .cindex "domain" "virtual"
33795 The phrase &'virtual domain'& is unfortunately used with two rather different
33796 meanings:
33797
33798 .ilist
33799 A domain for which there are no real mailboxes; all valid local parts are
33800 aliases for other email addresses. Common examples are organizational
33801 top-level domains and &"vanity"& domains.
33802 .next
33803 One of a number of independent domains that are all handled by the same host,
33804 with mailboxes on that host, but where the mailbox owners do not necessarily
33805 have login accounts on that host.
33806 .endlist
33807
33808 The first usage is probably more common, and does seem more &"virtual"& than
33809 the second. This kind of domain can be handled in Exim with a straightforward
33810 aliasing router. One approach is to create a separate alias file for each
33811 virtual domain. Exim can test for the existence of the alias file to determine
33812 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33813 to a router of this form:
33814 .code
33815 virtual:
33816   driver = redirect
33817   domains = dsearch;/etc/mail/virtual
33818   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33819   no_more
33820 .endd
33821 The &%domains%& option specifies that the router is to be skipped, unless there
33822 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33823 domain that is being processed. When the router runs, it looks up the local
33824 part in the file to find a new address (or list of addresses). The &%no_more%&
33825 setting ensures that if the lookup fails (leading to &%data%& being an empty
33826 string), Exim gives up on the address without trying any subsequent routers.
33827
33828 This one router can handle all the virtual domains because the alias file names
33829 follow a fixed pattern. Permissions can be arranged so that appropriate people
33830 can edit the different alias files. A successful aliasing operation results in
33831 a new envelope recipient address, which is then routed from scratch.
33832
33833 The other kind of &"virtual"& domain can also be handled in a straightforward
33834 way. One approach is to create a file for each domain containing a list of
33835 valid local parts, and use it in a router like this:
33836 .code
33837 my_domains:
33838   driver = accept
33839   domains = dsearch;/etc/mail/domains
33840   local_parts = lsearch;/etc/mail/domains/$domain
33841   transport = my_mailboxes
33842 .endd
33843 The address is accepted if there is a file for the domain, and the local part
33844 can be found in the file. The &%domains%& option is used to check for the
33845 file's existence because &%domains%& is tested before the &%local_parts%&
33846 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33847 because that option is tested after &%local_parts%&. The transport is as
33848 follows:
33849 .code
33850 my_mailboxes:
33851   driver = appendfile
33852   file = /var/mail/$domain/$local_part
33853   user = mail
33854 .endd
33855 This uses a directory of mailboxes for each domain. The &%user%& setting is
33856 required, to specify which uid is to be used for writing to the mailboxes.
33857
33858 The configuration shown here is just one example of how you might support this
33859 requirement. There are many other ways this kind of configuration can be set
33860 up, for example, by using a database instead of separate files to hold all the
33861 information about the domains.
33862
33863
33864
33865 .section "Multiple user mailboxes" "SECTmulbox"
33866 .cindex "multiple mailboxes"
33867 .cindex "mailbox" "multiple"
33868 .cindex "local part" "prefix"
33869 .cindex "local part" "suffix"
33870 Heavy email users often want to operate with multiple mailboxes, into which
33871 incoming mail is automatically sorted. A popular way of handling this is to
33872 allow users to use multiple sender addresses, so that replies can easily be
33873 identified. Users are permitted to add prefixes or suffixes to their local
33874 parts for this purpose. The wildcard facility of the generic router options
33875 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33876 example, consider this router:
33877 .code
33878 userforward:
33879   driver = redirect
33880   check_local_user
33881   file = $home/.forward
33882   local_part_suffix = -*
33883   local_part_suffix_optional
33884   allow_filter
33885 .endd
33886 .vindex "&$local_part_suffix$&"
33887 It runs a user's &_.forward_& file for all local parts of the form
33888 &'username-*'&. Within the filter file the user can distinguish different
33889 cases by testing the variable &$local_part_suffix$&. For example:
33890 .code
33891 if $local_part_suffix contains -special then
33892 save /home/$local_part/Mail/special
33893 endif
33894 .endd
33895 If the filter file does not exist, or does not deal with such addresses, they
33896 fall through to subsequent routers, and, assuming no subsequent use of the
33897 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33898 control over which suffixes are valid.
33899
33900 Alternatively, a suffix can be used to trigger the use of a different
33901 &_.forward_& file &-- which is the way a similar facility is implemented in
33902 another MTA:
33903 .code
33904 userforward:
33905   driver = redirect
33906   check_local_user
33907   file = $home/.forward$local_part_suffix
33908   local_part_suffix = -*
33909   local_part_suffix_optional
33910   allow_filter
33911 .endd
33912 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33913 example, &_.forward-special_& is used. Once again, if the appropriate file
33914 does not exist, or does not deal with the address, it is passed on to
33915 subsequent routers, which could, if required, look for an unqualified
33916 &_.forward_& file to use as a default.
33917
33918
33919
33920 .section "Simplified vacation processing" "SECID244"
33921 .cindex "vacation processing"
33922 The traditional way of running the &'vacation'& program is for a user to set up
33923 a pipe command in a &_.forward_& file
33924 (see section &<<SECTspecitredli>>& for syntax details).
33925 This is prone to error by inexperienced users. There are two features of Exim
33926 that can be used to make this process simpler for users:
33927
33928 .ilist
33929 A local part prefix such as &"vacation-"& can be specified on a router which
33930 can cause the message to be delivered directly to the &'vacation'& program, or
33931 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33932 &_.forward_& file are then much simpler. For example:
33933 .code
33934 spqr, vacation-spqr
33935 .endd
33936 .next
33937 The &%require_files%& generic router option can be used to trigger a
33938 vacation delivery by checking for the existence of a certain file in the
33939 user's home directory. The &%unseen%& generic option should also be used, to
33940 ensure that the original delivery also proceeds. In this case, all the user has
33941 to do is to create a file called, say, &_.vacation_&, containing a vacation
33942 message.
33943 .endlist
33944
33945 Another advantage of both these methods is that they both work even when the
33946 use of arbitrary pipes by users is locked out.
33947
33948
33949
33950 .section "Taking copies of mail" "SECID245"
33951 .cindex "message" "copying every"
33952 Some installations have policies that require archive copies of all messages to
33953 be made. A single copy of each message can easily be taken by an appropriate
33954 command in a system filter, which could, for example, use a different file for
33955 each day's messages.
33956
33957 There is also a shadow transport mechanism that can be used to take copies of
33958 messages that are successfully delivered by local transports, one copy per
33959 delivery. This could be used, &'inter alia'&, to implement automatic
33960 notification of delivery by sites that insist on doing such things.
33961
33962
33963
33964 .section "Intermittently connected hosts" "SECID246"
33965 .cindex "intermittently connected hosts"
33966 It has become quite common (because it is cheaper) for hosts to connect to the
33967 Internet periodically rather than remain connected all the time. The normal
33968 arrangement is that mail for such hosts accumulates on a system that is
33969 permanently connected.
33970
33971 Exim was designed for use on permanently connected hosts, and so it is not
33972 particularly well-suited to use in an intermittently connected environment.
33973 Nevertheless there are some features that can be used.
33974
33975
33976 .section "Exim on the upstream server host" "SECID247"
33977 It is tempting to arrange for incoming mail for the intermittently connected
33978 host to remain on Exim's queue until the client connects. However, this
33979 approach does not scale very well. Two different kinds of waiting message are
33980 being mixed up in the same queue &-- those that cannot be delivered because of
33981 some temporary problem, and those that are waiting for their destination host
33982 to connect. This makes it hard to manage the queue, as well as wasting
33983 resources, because each queue runner scans the entire queue.
33984
33985 A better approach is to separate off those messages that are waiting for an
33986 intermittently connected host. This can be done by delivering these messages
33987 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33988 format, from where they are transmitted by other software when their
33989 destination connects. This makes it easy to collect all the mail for one host
33990 in a single directory, and to apply local timeout rules on a per-message basis
33991 if required.
33992
33993 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33994 you are doing this, you should configure Exim with a long retry period for the
33995 intermittent host. For example:
33996 .code
33997 cheshire.wonderland.fict.example    *   F,5d,24h
33998 .endd
33999 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34000 which messages it has queued up for that host. Once the intermittent host comes
34001 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34002 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34003 causes all the queued up messages to be delivered, often down a single SMTP
34004 connection. While the host remains connected, any new messages get delivered
34005 immediately.
34006
34007 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34008 issued with a different IP address each time it connects, Exim's retry
34009 mechanisms on the holding host get confused, because the IP address is normally
34010 used as part of the key string for holding retry information. This can be
34011 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34012 Since this has disadvantages for permanently connected hosts, it is best to
34013 arrange a separate transport for the intermittently connected ones.
34014
34015
34016
34017 .section "Exim on the intermittently connected client host" "SECID248"
34018 The value of &%smtp_accept_queue_per_connection%& should probably be
34019 increased, or even set to zero (that is, disabled) on the intermittently
34020 connected host, so that all incoming messages down a single connection get
34021 delivered immediately.
34022
34023 .cindex "SMTP" "passed connection"
34024 .cindex "SMTP" "multiple deliveries"
34025 .cindex "multiple SMTP deliveries"
34026 Mail waiting to be sent from an intermittently connected host will probably
34027 not have been routed, because without a connection DNS lookups are not
34028 possible. This means that if a normal queue run is done at connection time,
34029 each message is likely to be sent in a separate SMTP session. This can be
34030 avoided by starting the queue run with a command line option beginning with
34031 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34032 first pass, routing is done but no deliveries take place. The second pass is a
34033 normal queue run; since all the messages have been previously routed, those
34034 destined for the same host are likely to get sent as multiple deliveries in a
34035 single SMTP connection.
34036
34037
34038
34039 . ////////////////////////////////////////////////////////////////////////////
34040 . ////////////////////////////////////////////////////////////////////////////
34041
34042 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34043          "Exim as a non-queueing client"
34044 .cindex "client, non-queueing"
34045 .cindex "smart host" "suppressing queueing"
34046 On a personal computer, it is a common requirement for all
34047 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34048 configured to operate that way, for all the popular operating systems.
34049 However, there are some MUAs for Unix-like systems that cannot be so
34050 configured: they submit messages using the command line interface of
34051 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34052 messages this way.
34053
34054 If the personal computer runs continuously, there is no problem, because it can
34055 run a conventional MTA that handles delivery to the smart host, and deal with
34056 any delays via its queueing mechanism. However, if the computer does not run
34057 continuously or runs different operating systems at different times, queueing
34058 email is not desirable.
34059
34060 There is therefore a requirement for something that can provide the
34061 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34062 any queueing or retrying facilities. Furthermore, the delivery to the smart
34063 host should be synchronous, so that if it fails, the sending MUA is immediately
34064 informed. In other words, we want something that extends an MUA that submits
34065 to a local MTA via the command line so that it behaves like one that submits
34066 to a remote smart host using TCP/SMTP.
34067
34068 There are a number of applications (for example, there is one called &'ssmtp'&)
34069 that do this job. However, people have found them to be lacking in various
34070 ways. For instance, you might want to allow aliasing and forwarding to be done
34071 before sending a message to the smart host.
34072
34073 Exim already had the necessary infrastructure for doing this job. Just a few
34074 tweaks were needed to make it behave as required, though it is somewhat of an
34075 overkill to use a fully-featured MTA for this purpose.
34076
34077 .oindex "&%mua_wrapper%&"
34078 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34079 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34080 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34081 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34082 compatible router and transport configuration. Typically there will be just one
34083 router and one transport, sending everything to a smart host.
34084
34085 When run in MUA wrapping mode, the behaviour of Exim changes in the
34086 following ways:
34087
34088 .ilist
34089 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34090 In other words, the only way to submit messages is via the command line.
34091 .next
34092 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34093 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34094 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34095 does not finish until the delivery attempt is complete. If the delivery is
34096 successful, a zero return code is given.
34097 .next
34098 Address redirection is permitted, but the final routing for all addresses must
34099 be to the same remote transport, and to the same list of hosts. Furthermore,
34100 the return address (envelope sender) must be the same for all recipients, as
34101 must any added or deleted header lines. In other words, it must be possible to
34102 deliver the message in a single SMTP transaction, however many recipients there
34103 are.
34104 .next
34105 If these conditions are not met, or if routing any address results in a
34106 failure or defer status, or if Exim is unable to deliver all the recipients
34107 successfully to one of the smart hosts, delivery of the entire message fails.
34108 .next
34109 Because no queueing is allowed, all failures are treated as permanent; there
34110 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34111 smart host. Furthermore, because only a single yes/no response can be given to
34112 the caller, it is not possible to deliver to some recipients and not others. If
34113 there is an error (temporary or permanent) for any recipient, all are failed.
34114 .next
34115 If more than one smart host is listed, Exim will try another host after a
34116 connection failure or a timeout, in the normal way. However, if this kind of
34117 failure happens for all the hosts, the delivery fails.
34118 .next
34119 When delivery fails, an error message is written to the standard error stream
34120 (as well as to Exim's log), and Exim exits to the caller with a return code
34121 value 1. The message is expunged from Exim's spool files. No bounce messages
34122 are ever generated.
34123 .next
34124 No retry data is maintained, and any retry rules are ignored.
34125 .next
34126 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34127 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34128 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34129 .endlist
34130
34131 The overall effect is that Exim makes a single synchronous attempt to deliver
34132 the message, failing if there is any kind of problem. Because no local
34133 deliveries are done and no daemon can be run, Exim does not need root
34134 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34135 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34136 the advantages and disadvantages of running without root privilege.
34137
34138
34139
34140
34141 . ////////////////////////////////////////////////////////////////////////////
34142 . ////////////////////////////////////////////////////////////////////////////
34143
34144 .chapter "Log files" "CHAPlog"
34145 .scindex IIDloggen "log" "general description"
34146 .cindex "log" "types of"
34147 Exim writes three different logs, referred to as the main log, the reject log,
34148 and the panic log:
34149
34150 .ilist
34151 .cindex "main log"
34152 The main log records the arrival of each message and each delivery in a single
34153 line in each case. The format is as compact as possible, in an attempt to keep
34154 down the size of log files. Two-character flag sequences make it easy to pick
34155 out these lines. A number of other events are recorded in the main log. Some of
34156 them are optional, in which case the &%log_selector%& option controls whether
34157 they are included or not. A Perl script called &'eximstats'&, which does simple
34158 analysis of main log files, is provided in the Exim distribution (see section
34159 &<<SECTmailstat>>&).
34160 .next
34161 .cindex "reject log"
34162 The reject log records information from messages that are rejected as a result
34163 of a configuration option (that is, for policy reasons).
34164 The first line of each rejection is a copy of the line that is also written to
34165 the main log. Then, if the message's header has been read at the time the log
34166 is written, its contents are written to this log. Only the original header
34167 lines are available; header lines added by ACLs are not logged. You can use the
34168 reject log to check that your policy controls are working correctly; on a busy
34169 host this may be easier than scanning the main log for rejection messages. You
34170 can suppress the writing of the reject log by setting &%write_rejectlog%&
34171 false.
34172 .next
34173 .cindex "panic log"
34174 .cindex "system log"
34175 When certain serious errors occur, Exim writes entries to its panic log. If the
34176 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34177 are usually written to the main log as well, but can get lost amid the mass of
34178 other entries. The panic log should be empty under normal circumstances. It is
34179 therefore a good idea to check it (or to have a &'cron'& script check it)
34180 regularly, in order to become aware of any problems. When Exim cannot open its
34181 panic log, it tries as a last resort to write to the system log (syslog). This
34182 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34183 message itself is written at priority LOG_CRIT.
34184 .endlist
34185
34186 Every log line starts with a timestamp, in the format shown in the following
34187 example. Note that many of the examples shown in this chapter are line-wrapped.
34188 In the log file, this would be all on one line:
34189 .code
34190 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34191   by QUIT
34192 .endd
34193 By default, the timestamps are in the local timezone. There are two
34194 ways of changing this:
34195
34196 .ilist
34197 You can set the &%timezone%& option to a different time zone; in particular, if
34198 you set
34199 .code
34200 timezone = UTC
34201 .endd
34202 the timestamps will be in UTC (aka GMT).
34203 .next
34204 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34205 example:
34206 .code
34207 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34208 .endd
34209 .endlist
34210
34211 .cindex "log" "process ids in"
34212 .cindex "pid (process id)" "in log lines"
34213 Exim does not include its process id in log lines by default, but you can
34214 request that it does so by specifying the &`pid`& log selector (see section
34215 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34216 brackets, immediately after the time and date.
34217
34218
34219
34220
34221 .section "Where the logs are written" "SECTwhelogwri"
34222 .cindex "log" "destination"
34223 .cindex "log" "to file"
34224 .cindex "log" "to syslog"
34225 .cindex "syslog"
34226 The logs may be written to local files, or to syslog, or both. However, it
34227 should be noted that many syslog implementations use UDP as a transport, and
34228 are therefore unreliable in the sense that messages are not guaranteed to
34229 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34230 It has also been reported that on large log files (tens of megabytes) you may
34231 need to tweak syslog to prevent it syncing the file with each write &-- on
34232 Linux this has been seen to make syslog take 90% plus of CPU time.
34233
34234 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34235 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34236 configuration. This latter string is expanded, so it can contain, for example,
34237 references to the host name:
34238 .code
34239 log_file_path = /var/log/$primary_hostname/exim_%slog
34240 .endd
34241 It is generally advisable, however, to set the string in &_Local/Makefile_&
34242 rather than at run time, because then the setting is available right from the
34243 start of Exim's execution. Otherwise, if there's something it wants to log
34244 before it has read the configuration file (for example, an error in the
34245 configuration file) it will not use the path you want, and may not be able to
34246 log at all.
34247
34248 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34249 list, currently limited to at most two items. This is one option where the
34250 facility for changing a list separator may not be used. The list must always be
34251 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34252 otherwise the item must either be an absolute path, containing &`%s`& at the
34253 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34254 implying the use of a default path.
34255
34256 When Exim encounters an empty item in the list, it searches the list defined by
34257 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34258 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34259 mean &"use the path specified at build time"&. It no such item exists, log
34260 files are written in the &_log_& subdirectory of the spool directory. This is
34261 equivalent to the setting:
34262 .code
34263 log_file_path = $spool_directory/log/%slog
34264 .endd
34265 If you do not specify anything at build time or run time, that is where the
34266 logs are written.
34267
34268 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34269 are in use &-- see section &<<SECTdatlogfil>>& below.
34270
34271 Here are some examples of possible settings:
34272 .display
34273 &`LOG_FILE_PATH=syslog                    `& syslog only
34274 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34275 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34276 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34277 .endd
34278 If there are more than two paths in the list, the first is used and a panic
34279 error is logged.
34280
34281
34282
34283 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34284 .cindex "log" "cycling local files"
34285 .cindex "cycling logs"
34286 .cindex "&'exicyclog'&"
34287 .cindex "log" "local files; writing to"
34288 Some operating systems provide centralized and standardized methods for cycling
34289 log files. For those that do not, a utility script called &'exicyclog'& is
34290 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34291 main and reject logs each time it is called. The maximum number of old logs to
34292 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34293
34294 An Exim delivery process opens the main log when it first needs to write to it,
34295 and it keeps the file open in case subsequent entries are required &-- for
34296 example, if a number of different deliveries are being done for the same
34297 message. However, remote SMTP deliveries can take a long time, and this means
34298 that the file may be kept open long after it is renamed if &'exicyclog'& or
34299 something similar is being used to rename log files on a regular basis. To
34300 ensure that a switch of log files is noticed as soon as possible, Exim calls
34301 &[stat()]& on the main log's name before reusing an open file, and if the file
34302 does not exist, or its inode has changed, the old file is closed and Exim
34303 tries to open the main log from scratch. Thus, an old log file may remain open
34304 for quite some time, but no Exim processes should write to it once it has been
34305 renamed.
34306
34307
34308
34309 .section "Datestamped log files" "SECTdatlogfil"
34310 .cindex "log" "datestamped files"
34311 Instead of cycling the main and reject log files by renaming them
34312 periodically, some sites like to use files whose names contain a datestamp,
34313 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34314 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34315 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34316 point where the datestamp is required. For example:
34317 .code
34318 log_file_path = /var/spool/exim/log/%slog-%D
34319 log_file_path = /var/log/exim-%s-%D.log
34320 log_file_path = /var/spool/exim/log/%D-%slog
34321 log_file_path = /var/log/exim/%s.%M
34322 .endd
34323 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34324 examples of names generated by the above examples:
34325 .code
34326 /var/spool/exim/log/mainlog-20021225
34327 /var/log/exim-reject-20021225.log
34328 /var/spool/exim/log/20021225-mainlog
34329 /var/log/exim/main.200212
34330 .endd
34331 When this form of log file is specified, Exim automatically switches to new
34332 files at midnight. It does not make any attempt to compress old logs; you
34333 will need to write your own script if you require this. You should not
34334 run &'exicyclog'& with this form of logging.
34335
34336 The location of the panic log is also determined by &%log_file_path%&, but it
34337 is not datestamped, because rotation of the panic log does not make sense.
34338 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34339 the string. In addition, if it immediately follows a slash, a following
34340 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34341 character is removed. Thus, the four examples above would give these panic
34342 log names:
34343 .code
34344 /var/spool/exim/log/paniclog
34345 /var/log/exim-panic.log
34346 /var/spool/exim/log/paniclog
34347 /var/log/exim/panic
34348 .endd
34349
34350
34351 .section "Logging to syslog" "SECID249"
34352 .cindex "log" "syslog; writing to"
34353 The use of syslog does not change what Exim logs or the format of its messages,
34354 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34355 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34356 that, the same strings are written to syslog as to log files. The syslog
34357 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34358 by default, but you can change these by setting the &%syslog_facility%& and
34359 &%syslog_processname%& options, respectively. If Exim was compiled with
34360 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34361 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34362 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34363 the time and host name to each line.
34364 The three log streams are mapped onto syslog priorities as follows:
34365
34366 .ilist
34367 &'mainlog'& is mapped to LOG_INFO
34368 .next
34369 &'rejectlog'& is mapped to LOG_NOTICE
34370 .next
34371 &'paniclog'& is mapped to LOG_ALERT
34372 .endlist
34373
34374 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34375 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34376 these are routed by syslog to the same place. You can suppress this duplication
34377 by setting &%syslog_duplication%& false.
34378
34379 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34380 entries contain multiple lines when headers are included. To cope with both
34381 these cases, entries written to syslog are split into separate &[syslog()]&
34382 calls at each internal newline, and also after a maximum of
34383 870 data characters. (This allows for a total syslog line length of 1024, when
34384 additions such as timestamps are added.) If you are running a syslog
34385 replacement that can handle lines longer than the 1024 characters allowed by
34386 RFC 3164, you should set
34387 .code
34388 SYSLOG_LONG_LINES=yes
34389 .endd
34390 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34391 lines, but it still splits at internal newlines in &'reject'& log entries.
34392
34393 To make it easy to re-assemble split lines later, each component of a split
34394 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34395 where <&'n'&> is the component number and <&'m'&> is the total number of
34396 components in the entry. The / delimiter is used when the line was split
34397 because it was too long; if it was split because of an internal newline, the \
34398 delimiter is used. For example, supposing the length limit to be 50 instead of
34399 870, the following would be the result of a typical rejection message to
34400 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34401 name, and pid as added by syslog:
34402 .code
34403 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34404 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34405 [3/5]  when scanning for sender: missing or malformed lo
34406 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34407 [5/5] mple>)
34408 .endd
34409 The same error might cause the following lines to be written to &"rejectlog"&
34410 (LOG_NOTICE):
34411 .code
34412 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34413 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34414 [3/18] er when scanning for sender: missing or malformed
34415 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34416 [5\18] .example>)
34417 [6\18] Recipients: ph10@some.domain.cam.example
34418 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34419 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34420 [9\18]        id 16RdAL-0006pc-00
34421 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34422 [11\18] 09:43 +0100
34423 [12\18] F From: <>
34424 [13\18]   Subject: this is a test header
34425 [18\18]   X-something: this is another header
34426 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34427 [16\18] le>
34428 [17\18] B Bcc:
34429 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34430 .endd
34431 Log lines that are neither too long nor contain newlines are written to syslog
34432 without modification.
34433
34434 If only syslog is being used, the Exim monitor is unable to provide a log tail
34435 display, unless syslog is routing &'mainlog'& to a file on the local host and
34436 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34437 where it is.
34438
34439
34440
34441 .section "Log line flags" "SECID250"
34442 One line is written to the main log for each message received, and for each
34443 successful, unsuccessful, and delayed delivery. These lines can readily be
34444 picked out by the distinctive two-character flags that immediately follow the
34445 timestamp. The flags are:
34446 .display
34447 &`<=`&     message arrival
34448 &`=>`&     normal message delivery
34449 &`->`&     additional address in same delivery
34450 &`>>`&     cutthrough message delivery
34451 &`*>`&     delivery suppressed by &%-N%&
34452 &`**`&     delivery failed; address bounced
34453 &`==`&     delivery deferred; temporary problem
34454 .endd
34455
34456
34457 .section "Logging message reception" "SECID251"
34458 .cindex "log" "reception line"
34459 The format of the single-line entry in the main log that is written for every
34460 message received is shown in the basic example below, which is split over
34461 several lines in order to fit it on the page:
34462 .code
34463 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34464   H=mailer.fict.example [192.168.123.123] U=exim
34465   P=smtp S=5678 id=<incoming message id>
34466 .endd
34467 The address immediately following &"<="& is the envelope sender address. A
34468 bounce message is shown with the sender address &"<>"&, and if it is locally
34469 generated, this is followed by an item of the form
34470 .code
34471 R=<message id>
34472 .endd
34473 which is a reference to the message that caused the bounce to be sent.
34474
34475 .cindex "HELO"
34476 .cindex "EHLO"
34477 For messages from other hosts, the H and U fields identify the remote host and
34478 record the RFC 1413 identity of the user that sent the message, if one was
34479 received. The number given in square brackets is the IP address of the sending
34480 host. If there is a single, unparenthesized  host name in the H field, as
34481 above, it has been verified to correspond to the IP address (see the
34482 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34483 by the remote host in the SMTP HELO or EHLO command, and has not been
34484 verified. If verification yields a different name to that given for HELO or
34485 EHLO, the verified name appears first, followed by the HELO or EHLO
34486 name in parentheses.
34487
34488 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34489 without brackets, in the HELO or EHLO command, leading to entries in
34490 the log containing text like these examples:
34491 .code
34492 H=(10.21.32.43) [192.168.8.34]
34493 H=([10.21.32.43]) [192.168.8.34]
34494 .endd
34495 This can be confusing. Only the final address in square brackets can be relied
34496 on.
34497
34498 For locally generated messages (that is, messages not received over TCP/IP),
34499 the H field is omitted, and the U field contains the login name of the caller
34500 of Exim.
34501
34502 .cindex "authentication" "logging"
34503 .cindex "AUTH" "logging"
34504 For all messages, the P field specifies the protocol used to receive the
34505 message. This is the value that is stored in &$received_protocol$&. In the case
34506 of incoming SMTP messages, the value indicates whether or not any SMTP
34507 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34508 session was encrypted, there is an additional X field that records the cipher
34509 suite that was used.
34510
34511 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34512 hosts that have authenticated themselves using the SMTP AUTH command. The first
34513 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34514 there is an additional item A= followed by the name of the authenticator that
34515 was used. If an authenticated identification was set up by the authenticator's
34516 &%server_set_id%& option, this is logged too, separated by a colon from the
34517 authenticator name.
34518
34519 .cindex "size" "of message"
34520 The id field records the existing message id, if present. The size of the
34521 received message is given by the S field. When the message is delivered,
34522 headers may be removed or added, so that the size of delivered copies of the
34523 message may not correspond with this value (and indeed may be different to each
34524 other).
34525
34526 The &%log_selector%& option can be used to request the logging of additional
34527 data when a message is received. See section &<<SECTlogselector>>& below.
34528
34529
34530
34531 .section "Logging deliveries" "SECID252"
34532 .cindex "log" "delivery line"
34533 The format of the single-line entry in the main log that is written for every
34534 delivery is shown in one of the examples below, for local and remote
34535 deliveries, respectively. Each example has been split into two lines in order
34536 to fit it on the page:
34537 .code
34538 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34539   <marv@hitch.fict.example> R=localuser T=local_delivery
34540 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34541   monk@holistic.fict.example R=dnslookup T=remote_smtp
34542   H=holistic.fict.example [192.168.234.234]
34543 .endd
34544 For ordinary local deliveries, the original address is given in angle brackets
34545 after the final delivery address, which might be a pipe or a file. If
34546 intermediate address(es) exist between the original and the final address, the
34547 last of these is given in parentheses after the final address. The R and T
34548 fields record the router and transport that were used to process the address.
34549
34550 If SMTP AUTH was used for the delivery there is an additional item A=
34551 followed by the name of the authenticator that was used.
34552 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34553 option, this is logged too, separated by a colon from the authenticator name.
34554
34555 If a shadow transport was run after a successful local delivery, the log line
34556 for the successful delivery has an item added on the end, of the form
34557 .display
34558 &`ST=<`&&'shadow transport name'&&`>`&
34559 .endd
34560 If the shadow transport did not succeed, the error message is put in
34561 parentheses afterwards.
34562
34563 .cindex "asterisk" "after IP address"
34564 When more than one address is included in a single delivery (for example, two
34565 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34566 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34567 down a single SMTP connection, an asterisk follows the IP address in the log
34568 lines for the second and subsequent messages.
34569
34570 .cindex "delivery" "cutthrough; logging"
34571 .cindex "cutthrough" "logging"
34572 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34573 line precedes the reception line, since cutthrough waits for a possible
34574 rejection from the destination in case it can reject the sourced item.
34575
34576 The generation of a reply message by a filter file gets logged as a
34577 &"delivery"& to the addressee, preceded by &">"&.
34578
34579 The &%log_selector%& option can be used to request the logging of additional
34580 data when a message is delivered. See section &<<SECTlogselector>>& below.
34581
34582
34583 .section "Discarded deliveries" "SECID253"
34584 .cindex "discarded messages"
34585 .cindex "message" "discarded"
34586 .cindex "delivery" "discarded; logging"
34587 When a message is discarded as a result of the command &"seen finish"& being
34588 obeyed in a filter file which generates no deliveries, a log entry of the form
34589 .code
34590 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34591   <low.club@bridge.example> R=userforward
34592 .endd
34593 is written, to record why no deliveries are logged. When a message is discarded
34594 because it is aliased to &":blackhole:"& the log line is like this:
34595 .code
34596 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34597   <hole@nowhere.example> R=blackhole_router
34598 .endd
34599
34600
34601 .section "Deferred deliveries" "SECID254"
34602 When a delivery is deferred, a line of the following form is logged:
34603 .code
34604 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34605   R=dnslookup T=smtp defer (146): Connection refused
34606 .endd
34607 In the case of remote deliveries, the error is the one that was given for the
34608 last IP address that was tried. Details of individual SMTP failures are also
34609 written to the log, so the above line would be preceded by something like
34610 .code
34611 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34612   mail1.endrest.example [192.168.239.239]: Connection refused
34613 .endd
34614 When a deferred address is skipped because its retry time has not been reached,
34615 a message is written to the log, but this can be suppressed by setting an
34616 appropriate value in &%log_selector%&.
34617
34618
34619
34620 .section "Delivery failures" "SECID255"
34621 .cindex "delivery" "failure; logging"
34622 If a delivery fails because an address cannot be routed, a line of the
34623 following form is logged:
34624 .code
34625 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34626   <jim@trek99.example>: unknown mail domain
34627 .endd
34628 If a delivery fails at transport time, the router and transport are shown, and
34629 the response from the remote host is included, as in this example:
34630 .code
34631 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34632   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34633   after pipelined RCPT TO:<ace400@pb.example>: host
34634   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34635   <ace400@pb.example>...Addressee unknown
34636 .endd
34637 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34638 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34639 disabling PIPELINING. The log lines for all forms of delivery failure are
34640 flagged with &`**`&.
34641
34642
34643
34644 .section "Fake deliveries" "SECID256"
34645 .cindex "delivery" "fake; logging"
34646 If a delivery does not actually take place because the &%-N%& option has been
34647 used to suppress it, a normal delivery line is written to the log, except that
34648 &"=>"& is replaced by &"*>"&.
34649
34650
34651
34652 .section "Completion" "SECID257"
34653 A line of the form
34654 .code
34655 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34656 .endd
34657 is written to the main log when a message is about to be removed from the spool
34658 at the end of its processing.
34659
34660
34661
34662
34663 .section "Summary of Fields in Log Lines" "SECID258"
34664 .cindex "log" "summary of fields"
34665 A summary of the field identifiers that are used in log lines is shown in
34666 the following table:
34667 .display
34668 &`A   `&        authenticator name (and optional id and sender)
34669 &`C   `&        SMTP confirmation on delivery
34670 &`    `&        command list for &"no mail in SMTP session"&
34671 &`CV  `&        certificate verification status
34672 &`D   `&        duration of &"no mail in SMTP session"&
34673 &`DN  `&        distinguished name from peer certificate
34674 &`DT  `&        on &`=>`& lines: time taken for a delivery
34675 &`F   `&        sender address (on delivery lines)
34676 &`H   `&        host name and IP address
34677 &`I   `&        local interface used
34678 &`id  `&        message id for incoming message
34679 &`P   `&        on &`<=`& lines: protocol used
34680 &`    `&        on &`=>`& and &`**`& lines: return path
34681 &`QT  `&        on &`=>`& lines: time spent on queue so far
34682 &`    `&        on &"Completed"& lines: time spent on queue
34683 &`R   `&        on &`<=`& lines: reference for local bounce
34684 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34685 &`S   `&        size of message
34686 &`SNI `&        server name indication from TLS client hello
34687 &`ST  `&        shadow transport name
34688 &`T   `&        on &`<=`& lines: message subject (topic)
34689 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34690 &`U   `&        local user or RFC 1413 identity
34691 &`X   `&        TLS cipher suite
34692 .endd
34693
34694
34695 .section "Other log entries" "SECID259"
34696 Various other types of log entry are written from time to time. Most should be
34697 self-explanatory. Among the more common are:
34698
34699 .ilist
34700 .cindex "retry" "time not reached"
34701 &'retry time not reached'&&~&~An address previously suffered a temporary error
34702 during routing or local delivery, and the time to retry has not yet arrived.
34703 This message is not written to an individual message log file unless it happens
34704 during the first delivery attempt.
34705 .next
34706 &'retry time not reached for any host'&&~&~An address previously suffered
34707 temporary errors during remote delivery, and the retry time has not yet arrived
34708 for any of the hosts to which it is routed.
34709 .next
34710 .cindex "spool directory" "file locked"
34711 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34712 some other Exim process is already working on the message. This can be quite
34713 common if queue running processes are started at frequent intervals. The
34714 &'exiwhat'& utility script can be used to find out what Exim processes are
34715 doing.
34716 .next
34717 .cindex "error" "ignored"
34718 &'error ignored'&&~&~There are several circumstances that give rise to this
34719 message:
34720 .olist
34721 Exim failed to deliver a bounce message whose age was greater than
34722 &%ignore_bounce_errors_after%&. The bounce was discarded.
34723 .next
34724 A filter file set up a delivery using the &"noerror"& option, and the delivery
34725 failed. The delivery was discarded.
34726 .next
34727 A delivery set up by a router configured with
34728 . ==== As this is a nested list, any displays it contains must be indented
34729 . ==== as otherwise they are too far to the left.
34730 .code
34731     errors_to = <>
34732 .endd
34733 failed. The delivery was discarded.
34734 .endlist olist
34735 .endlist ilist
34736
34737
34738
34739
34740
34741 .section "Reducing or increasing what is logged" "SECTlogselector"
34742 .cindex "log" "selectors"
34743 By setting the &%log_selector%& global option, you can disable some of Exim's
34744 default logging, or you can request additional logging. The value of
34745 &%log_selector%& is made up of names preceded by plus or minus characters. For
34746 example:
34747 .code
34748 log_selector = +arguments -retry_defer
34749 .endd
34750 The list of optional log items is in the following table, with the default
34751 selection marked by asterisks:
34752 .display
34753 &` 8bitmime                   `&  received 8BITMIME status
34754 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34755 &` address_rewrite            `&  address rewriting
34756 &` all_parents                `&  all parents in => lines
34757 &` arguments                  `&  command line arguments
34758 &`*connection_reject          `&  connection rejections
34759 &`*delay_delivery             `&  immediate delivery delayed
34760 &` deliver_time               `&  time taken to perform delivery
34761 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34762 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34763 &`*etrn                       `&  ETRN commands
34764 &`*host_lookup_failed         `&  as it says
34765 &` ident_timeout              `&  timeout for ident connection
34766 &` incoming_interface         `&  incoming interface on <= lines
34767 &` incoming_port              `&  incoming port on <= lines
34768 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34769 &` outgoing_port              `&  add remote port to => lines
34770 &`*queue_run                  `&  start and end queue runs
34771 &` queue_time                 `&  time on queue for one recipient
34772 &` queue_time_overall         `&  time on queue for whole message
34773 &` pid                        `&  Exim process id
34774 &` received_recipients        `&  recipients on <= lines
34775 &` received_sender            `&  sender on <= lines
34776 &`*rejected_header            `&  header contents on reject log
34777 &`*retry_defer                `&  &"retry time not reached"&
34778 &` return_path_on_delivery    `&  put return path on => and ** lines
34779 &` sender_on_delivery         `&  add sender to => lines
34780 &`*sender_verify_fail         `&  sender verification failures
34781 &`*size_reject                `&  rejection because too big
34782 &`*skip_delivery              `&  delivery skipped in a queue run
34783 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34784 &` smtp_connection            `&  SMTP connections
34785 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34786 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34787 &` smtp_no_mail               `&  session with no MAIL commands
34788 &` smtp_protocol_error        `&  SMTP protocol errors
34789 &` smtp_syntax_error          `&  SMTP syntax errors
34790 &` subject                    `&  contents of &'Subject:'& on <= lines
34791 &` tls_certificate_verified   `&  certificate verification status
34792 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34793 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34794 &` tls_sni                    `&  TLS SNI on <= lines
34795 &` unknown_in_list            `&  DNS lookup failed in list match
34796
34797 &` all                        `&  all of the above
34798 .endd
34799 More details on each of these items follows:
34800
34801 .ilist
34802 .cindex "8BITMIME"
34803 .cindex "log" "8BITMIME"
34804 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34805 which may help in tracking down interoperability issues with ancient MTAs
34806 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34807 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34808 &`7BIT`& and &`8BITMIME`& respectively.
34809 .next
34810 .cindex "&%warn%& ACL verb" "log when skipping"
34811 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34812 its conditions cannot be evaluated, a log line to this effect is written if
34813 this log selector is set.
34814 .next
34815 .cindex "log" "rewriting"
34816 .cindex "rewriting" "logging"
34817 &%address_rewrite%&: This applies both to global rewrites and per-transport
34818 rewrites, but not to rewrites in filters run as an unprivileged user (because
34819 such users cannot access the log).
34820 .next
34821 .cindex "log" "full parentage"
34822 &%all_parents%&: Normally only the original and final addresses are logged on
34823 delivery lines; with this selector, intermediate parents are given in
34824 parentheses between them.
34825 .next
34826 .cindex "log" "Exim arguments"
34827 .cindex "Exim arguments, logging"
34828 &%arguments%&: This causes Exim to write the arguments with which it was called
34829 to the main log, preceded by the current working directory. This is a debugging
34830 feature, added to make it easier to find out how certain MUAs call
34831 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34832 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34833 that are empty or that contain white space are quoted. Non-printing characters
34834 are shown as escape sequences. This facility cannot log unrecognized arguments,
34835 because the arguments are checked before the configuration file is read. The
34836 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34837 between the caller and Exim.
34838 .next
34839 .cindex "log" "connection rejections"
34840 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34841 connection is rejected, for whatever reason.
34842 .next
34843 .cindex "log" "delayed delivery"
34844 .cindex "delayed delivery, logging"
34845 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34846 started for an incoming message because the load is too high or too many
34847 messages were received on one connection. Logging does not occur if no delivery
34848 process is started because &%queue_only%& is set or &%-odq%& was used.
34849 .next
34850 .cindex "log" "delivery duration"
34851 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34852 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34853 .next
34854 .cindex "log" "message size on delivery"
34855 .cindex "size" "of message"
34856 &%delivery_size%&: For each delivery, the size of message delivered is added to
34857 the &"=>"& line, tagged with S=.
34858 .next
34859 .cindex "log" "dnslist defer"
34860 .cindex "DNS list" "logging defer"
34861 .cindex "black list (DNS)"
34862 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34863 DNS black list suffers a temporary error.
34864 .next
34865 .cindex "log" "ETRN commands"
34866 .cindex "ETRN" "logging"
34867 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34868 is run to determine whether or not it is actually accepted. An invalid ETRN
34869 command, or one received within a message transaction is not logged by this
34870 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34871 .next
34872 .cindex "log" "host lookup failure"
34873 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34874 any addresses, or when a lookup of an IP address fails to find a host name, a
34875 log line is written. This logging does not apply to direct DNS lookups when
34876 routing email addresses, but it does apply to &"byname"& lookups.
34877 .next
34878 .cindex "log" "ident timeout"
34879 .cindex "RFC 1413" "logging timeout"
34880 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34881 client's ident port times out.
34882 .next
34883 .cindex "log" "incoming interface"
34884 .cindex "interface" "logging"
34885 &%incoming_interface%&: The interface on which a message was received is added
34886 to the &"<="& line as an IP address in square brackets, tagged by I= and
34887 followed by a colon and the port number. The local interface and port are also
34888 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34889 rejection lines.
34890 .next
34891 .cindex "log" "incoming remote port"
34892 .cindex "port" "logging remote"
34893 .cindex "TCP/IP" "logging incoming remote port"
34894 .vindex "&$sender_fullhost$&"
34895 .vindex "&$sender_rcvhost$&"
34896 &%incoming_port%&: The remote port number from which a message was received is
34897 added to log entries and &'Received:'& header lines, following the IP address
34898 in square brackets, and separated from it by a colon. This is implemented by
34899 changing the value that is put in the &$sender_fullhost$& and
34900 &$sender_rcvhost$& variables. Recording the remote port number has become more
34901 important with the widening use of NAT (see RFC 2505).
34902 .next
34903 .cindex "log" "dropped connection"
34904 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34905 connection is unexpectedly dropped.
34906 .next
34907 .cindex "log" "outgoing remote port"
34908 .cindex "port" "logging outgoint remote"
34909 .cindex "TCP/IP" "logging ougtoing remote port"
34910 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34911 containing => tags) following the IP address. This option is not included in
34912 the default setting, because for most ordinary configurations, the remote port
34913 number is always 25 (the SMTP port).
34914 .next
34915 .cindex "log" "process ids in"
34916 .cindex "pid (process id)" "in log lines"
34917 &%pid%&: The current process id is added to every log line, in square brackets,
34918 immediately after the time and date.
34919 .next
34920 .cindex "log" "queue run"
34921 .cindex "queue runner" "logging"
34922 &%queue_run%&: The start and end of every queue run are logged.
34923 .next
34924 .cindex "log" "queue time"
34925 &%queue_time%&: The amount of time the message has been in the queue on the
34926 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34927 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34928 includes reception time as well as the delivery time for the current address.
34929 This means that it may be longer than the difference between the arrival and
34930 delivery log line times, because the arrival log line is not written until the
34931 message has been successfully received.
34932 .next
34933 &%queue_time_overall%&: The amount of time the message has been in the queue on
34934 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34935 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34936 message, so it includes reception time as well as the total delivery time.
34937 .next
34938 .cindex "log" "recipients"
34939 &%received_recipients%&: The recipients of a message are listed in the main log
34940 as soon as the message is received. The list appears at the end of the log line
34941 that is written when a message is received, preceded by the word &"for"&. The
34942 addresses are listed after they have been qualified, but before any rewriting
34943 has taken place.
34944 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34945 in the list.
34946 .next
34947 .cindex "log" "sender reception"
34948 &%received_sender%&: The unrewritten original sender of a message is added to
34949 the end of the log line that records the message's arrival, after the word
34950 &"from"& (before the recipients if &%received_recipients%& is also set).
34951 .next
34952 .cindex "log" "header lines for rejection"
34953 &%rejected_header%&: If a message's header has been received at the time a
34954 rejection is written to the reject log, the complete header is added to the
34955 log. Header logging can be turned off individually for messages that are
34956 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34957 .next
34958 .cindex "log" "retry defer"
34959 &%retry_defer%&: A log line is written if a delivery is deferred because a
34960 retry time has not yet been reached. However, this &"retry time not reached"&
34961 message is always omitted from individual message logs after the first delivery
34962 attempt.
34963 .next
34964 .cindex "log" "return path"
34965 &%return_path_on_delivery%&: The return path that is being transmitted with
34966 the message is included in delivery and bounce lines, using the tag P=.
34967 This is omitted if no delivery actually happens, for example, if routing fails,
34968 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34969 .next
34970 .cindex "log" "sender on delivery"
34971 &%sender_on_delivery%&: The message's sender address is added to every delivery
34972 and bounce line, tagged by F= (for &"from"&).
34973 This is the original sender that was received with the message; it is not
34974 necessarily the same as the outgoing return path.
34975 .next
34976 .cindex "log" "sender verify failure"
34977 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34978 gives details of a sender verification failure is not written. Log lines for
34979 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34980 detail is lost.
34981 .next
34982 .cindex "log" "size rejection"
34983 &%size_reject%&: A log line is written whenever a message is rejected because
34984 it is too big.
34985 .next
34986 .cindex "log" "frozen messages; skipped"
34987 .cindex "frozen messages" "logging skipping"
34988 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34989 queue run because it is frozen or because another process is already delivering
34990 it.
34991 .cindex "&""spool file is locked""&"
34992 The message that is written is &"spool file is locked"&.
34993 .next
34994 .cindex "log" "smtp confirmation"
34995 .cindex "SMTP" "logging confirmation"
34996 .cindex "LMTP" "logging confirmation"
34997 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
34998 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34999 A number of MTAs (including Exim) return an identifying string in this
35000 response.
35001 .next
35002 .cindex "log" "SMTP connections"
35003 .cindex "SMTP" "logging connections"
35004 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35005 established or closed, unless the connection is from a host that matches
35006 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35007 only when the closure is unexpected.) This applies to connections from local
35008 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35009 dropped in the middle of a message, a log line is always written, whether or
35010 not this selector is set, but otherwise nothing is written at the start and end
35011 of connections unless this selector is enabled.
35012
35013 For TCP/IP connections to an Exim daemon, the current number of connections is
35014 included in the log message for each new connection, but note that the count is
35015 reset if the daemon is restarted.
35016 Also, because connections are closed (and the closure is logged) in
35017 subprocesses, the count may not include connections that have been closed but
35018 whose termination the daemon has not yet noticed. Thus, while it is possible to
35019 match up the opening and closing of connections in the log, the value of the
35020 logged counts may not be entirely accurate.
35021 .next
35022 .cindex "log" "SMTP transaction; incomplete"
35023 .cindex "SMTP" "logging incomplete transactions"
35024 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35025 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35026 and the message sender plus any accepted recipients are included in the log
35027 line. This can provide evidence of dictionary attacks.
35028 .next
35029 .cindex "log" "non-MAIL SMTP sessions"
35030 .cindex "MAIL" "logging session without"
35031 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35032 connection terminates without having issued a MAIL command. This includes both
35033 the case when the connection is dropped, and the case when QUIT is used. It
35034 does not include cases where the connection is rejected right at the start (by
35035 an ACL, or because there are too many connections, or whatever). These cases
35036 already have their own log lines.
35037
35038 The log line that is written contains the identity of the client in the usual
35039 way, followed by D= and a time, which records the duration of the connection.
35040 If the connection was authenticated, this fact is logged exactly as it is for
35041 an incoming message, with an A= item. If the connection was encrypted, CV=,
35042 DN=, and X= items may appear as they do for an incoming message, controlled by
35043 the same logging options.
35044
35045 Finally, if any SMTP commands were issued during the connection, a C= item
35046 is added to the line, listing the commands that were used. For example,
35047 .code
35048 C=EHLO,QUIT
35049 .endd
35050 shows that the client issued QUIT straight after EHLO. If there were fewer
35051 than 20 commands, they are all listed. If there were more than 20 commands,
35052 the last 20 are listed, preceded by &"..."&. However, with the default
35053 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35054 have been aborted before 20 non-mail commands are processed.
35055 .next
35056 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35057 colon-separated, is appended to the A= item for a message arrival or delivery
35058 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35059 was accepted or used.
35060 .next
35061 .cindex "log" "SMTP protocol error"
35062 .cindex "SMTP" "logging protocol error"
35063 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35064 encountered. Exim does not have perfect detection of all protocol errors
35065 because of transmission delays and the use of pipelining. If PIPELINING has
35066 been advertised to a client, an Exim server assumes that the client will use
35067 it, and therefore it does not count &"expected"& errors (for example, RCPT
35068 received after rejecting MAIL) as protocol errors.
35069 .next
35070 .cindex "SMTP" "logging syntax errors"
35071 .cindex "SMTP" "syntax errors; logging"
35072 .cindex "SMTP" "unknown command; logging"
35073 .cindex "log" "unknown SMTP command"
35074 .cindex "log" "SMTP syntax error"
35075 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35076 encountered. An unrecognized command is treated as a syntax error. For an
35077 external connection, the host identity is given; for an internal connection
35078 using &%-bs%& the sender identification (normally the calling user) is given.
35079 .next
35080 .cindex "log" "subject"
35081 .cindex "subject, logging"
35082 &%subject%&: The subject of the message is added to the arrival log line,
35083 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35084 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35085 specifies whether characters with values greater than 127 should be logged
35086 unchanged, or whether they should be rendered as escape sequences.
35087 .next
35088 .cindex "log" "certificate verification"
35089 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35090 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35091 verified, and &`CV=no`& if not.
35092 .next
35093 .cindex "log" "TLS cipher"
35094 .cindex "TLS" "logging cipher"
35095 &%tls_cipher%&: When a message is sent or received over an encrypted
35096 connection, the cipher suite used is added to the log line, preceded by X=.
35097 .next
35098 .cindex "log" "TLS peer DN"
35099 .cindex "TLS" "logging peer DN"
35100 &%tls_peerdn%&: When a message is sent or received over an encrypted
35101 connection, and a certificate is supplied by the remote host, the peer DN is
35102 added to the log line, preceded by DN=.
35103 .next
35104 .cindex "log" "TLS SNI"
35105 .cindex "TLS" "logging SNI"
35106 &%tls_sni%&: When a message is received over an encrypted connection, and
35107 the remote host provided the Server Name Indication extension, the SNI is
35108 added to the log line, preceded by SNI=.
35109 .next
35110 .cindex "log" "DNS failure in list"
35111 &%unknown_in_list%&: This setting causes a log entry to be written when the
35112 result of a list match is failure because a DNS lookup failed.
35113 .endlist
35114
35115
35116 .section "Message log" "SECID260"
35117 .cindex "message" "log file for"
35118 .cindex "log" "message log; description of"
35119 .cindex "&_msglog_& directory"
35120 .oindex "&%preserve_message_logs%&"
35121 In addition to the general log files, Exim writes a log file for each message
35122 that it handles. The names of these per-message logs are the message ids, and
35123 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35124 message log contains copies of the log lines that apply to the message. This
35125 makes it easier to inspect the status of an individual message without having
35126 to search the main log. A message log is deleted when processing of the message
35127 is complete, unless &%preserve_message_logs%& is set, but this should be used
35128 only with great care because they can fill up your disk very quickly.
35129
35130 On a heavily loaded system, it may be desirable to disable the use of
35131 per-message logs, in order to reduce disk I/O. This can be done by setting the
35132 &%message_logs%& option false.
35133 .ecindex IIDloggen
35134
35135
35136
35137
35138 . ////////////////////////////////////////////////////////////////////////////
35139 . ////////////////////////////////////////////////////////////////////////////
35140
35141 .chapter "Exim utilities" "CHAPutils"
35142 .scindex IIDutils "utilities"
35143 A number of utility scripts and programs are supplied with Exim and are
35144 described in this chapter. There is also the Exim Monitor, which is covered in
35145 the next chapter. The utilities described here are:
35146
35147 .itable none 0 0 3  7* left  15* left  40* left
35148 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35149   "list what Exim processes are doing"
35150 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35151 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35152 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35153 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35154                                                 various criteria"
35155 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35156 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35157   "extract statistics from the log"
35158 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35159   "check address acceptance from given IP"
35160 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35161 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35162 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35163 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35164 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35165 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35166 .endtable
35167
35168 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35169 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35170 &url(http://duncanthrax.net/exilog/) for details.
35171
35172
35173
35174
35175 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35176 .cindex "&'exiwhat'&"
35177 .cindex "process, querying"
35178 .cindex "SIGUSR1"
35179 On operating systems that can restart a system call after receiving a signal
35180 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35181 a line describing what it is doing to the file &_exim-process.info_& in the
35182 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35183 processes it can find, having first emptied the file. It then waits for one
35184 second to allow the Exim processes to react before displaying the results. In
35185 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35186 send the signal to the Exim processes, so it is normally run as root.
35187
35188 &*Warning*&: This is not an efficient process. It is intended for occasional
35189 use by system administrators. It is not sensible, for example, to set up a
35190 script that sends SIGUSR1 signals to Exim processes at short intervals.
35191
35192
35193 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35194 varies in different operating systems. Not only are different options used,
35195 but the format of the output is different. For this reason, there are some
35196 system configuration options that configure exactly how &'exiwhat'& works. If
35197 it doesn't seem to be working for you, check the following compile-time
35198 options:
35199 .display
35200 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35201 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35202 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35203 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35204 .endd
35205 An example of typical output from &'exiwhat'& is
35206 .code
35207 164 daemon: -q1h, listening on port 25
35208 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35209 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35210   [10.19.42.42] (editor@ref.example)
35211 10592 handling incoming call from [192.168.243.242]
35212 10628 accepting a local non-SMTP message
35213 .endd
35214 The first number in the output line is the process number. The third line has
35215 been split here, in order to fit it on the page.
35216
35217
35218
35219 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35220 .cindex "&'exiqgrep'&"
35221 .cindex "queue" "grepping"
35222 This utility is a Perl script contributed by Matt Hubbard. It runs
35223 .code
35224 exim -bpu
35225 .endd
35226 or (in case &*-a*& switch is specified)
35227 .code
35228 exim -bp
35229 .endd
35230 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35231 contain alternate exim configuration the queue management might be using.
35232
35233 to obtain a queue listing, and then greps the output to select messages 
35234 that match given criteria. The following selection options are available:
35235
35236 .vlist
35237 .vitem &*-f*&&~<&'regex'&>
35238 Match the sender address using a case-insensitive search. The field that is
35239 tested is enclosed in angle brackets, so you can test for bounce messages with
35240 .code
35241 exiqgrep -f '^<>$'
35242 .endd
35243 .vitem &*-r*&&~<&'regex'&>
35244 Match a recipient address using a case-insensitve search. The field that is
35245 tested is not enclosed in angle brackets.
35246
35247 .vitem &*-s*&&~<&'regex'&>
35248 Match against the size field.
35249
35250 .vitem &*-y*&&~<&'seconds'&>
35251 Match messages that are younger than the given time.
35252
35253 .vitem &*-o*&&~<&'seconds'&>
35254 Match messages that are older than the given time.
35255
35256 .vitem &*-z*&
35257 Match only frozen messages.
35258
35259 .vitem &*-x*&
35260 Match only non-frozen messages.
35261 .endlist
35262
35263 The following options control the format of the output:
35264
35265 .vlist
35266 .vitem &*-c*&
35267 Display only the count of matching messages.
35268
35269 .vitem &*-l*&
35270 Long format &-- display the full message information as output by Exim. This is
35271 the default.
35272
35273 .vitem &*-i*&
35274 Display message ids only.
35275
35276 .vitem &*-b*&
35277 Brief format &-- one line per message.
35278
35279 .vitem &*-R*&
35280 Display messages in reverse order.
35281
35282 .vitem &*-a*&
35283 Include delivered recipients in queue listing.
35284 .endlist
35285
35286 There is one more option, &%-h%&, which outputs a list of options.
35287
35288
35289
35290 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35291 .cindex "&'exiqsumm'&"
35292 .cindex "queue" "summary"
35293 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35294 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35295 running a command such as
35296 .code
35297 exim -bp | exiqsumm
35298 .endd
35299 The output consists of one line for each domain that has messages waiting for
35300 it, as in the following example:
35301 .code
35302 3   2322   74m   66m  msn.com.example
35303 .endd
35304 Each line lists the number of pending deliveries for a domain, their total
35305 volume, and the length of time that the oldest and the newest messages have
35306 been waiting. Note that the number of pending deliveries is greater than the
35307 number of messages when messages have more than one recipient.
35308
35309 A summary line is output at the end. By default the output is sorted on the
35310 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35311 the output to be sorted by oldest message and by count of messages,
35312 respectively. There are also three options that split the messages for each
35313 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35314 separates frozen messages, and &%-s%& separates messages according to their
35315 sender.
35316
35317 The output of &'exim -bp'& contains the original addresses in the message, so
35318 this also applies to the output from &'exiqsumm'&. No domains from addresses
35319 generated by aliasing or forwarding are included (unless the &%one_time%&
35320 option of the &(redirect)& router has been used to convert them into &"top
35321 level"& addresses).
35322
35323
35324
35325
35326 .section "Extracting specific information from the log (exigrep)" &&&
35327          "SECTextspeinf"
35328 .cindex "&'exigrep'&"
35329 .cindex "log" "extracts; grepping for"
35330 The &'exigrep'& utility is a Perl script that searches one or more main log
35331 files for entries that match a given pattern. When it finds a match, it
35332 extracts all the log entries for the relevant message, not just those that
35333 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35334 given message, or all mail for a given user, or for a given host, for example.
35335 The input files can be in Exim log format or syslog format.
35336 If a matching log line is not associated with a specific message, it is
35337 included in &'exigrep'&'s output without any additional lines. The usage is:
35338 .new
35339 .display
35340 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35341 .endd
35342 .wen
35343 If no log file names are given on the command line, the standard input is read.
35344
35345 The &%-t%& argument specifies a number of seconds. It adds an additional
35346 condition for message selection. Messages that are complete are shown only if
35347 they spent more than <&'n'&> seconds on the queue.
35348
35349 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35350 makes it case-sensitive. This may give a performance improvement when searching
35351 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35352 option; with &%-I%& they do not. In both cases it is possible to change the
35353 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35354
35355 The &%-l%& option means &"literal"&, that is, treat all characters in the
35356 pattern as standing for themselves. Otherwise the pattern must be a Perl
35357 regular expression.
35358
35359 The &%-v%& option inverts the matching condition. That is, a line is selected
35360 if it does &'not'& match the pattern.
35361
35362 .new
35363 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35364 that are generated as a result/response to a message that &'exigrep'& matched
35365 normally.
35366
35367 Example of &%-M%&:
35368 user_a sends a message to user_b, which generates a bounce back to user_b. If
35369 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35370 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35371 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35372 when searching for &"user_a"& will show both messages since the bounce is
35373 &"related"& to or a &"result"& of the first message that was found by the
35374 search term.
35375 .wen
35376
35377 If the location of a &'zcat'& command is known from the definition of
35378 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35379 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35380
35381
35382 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35383 .cindex "&'exipick'&"
35384 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35385 lists messages from the queue according to a variety of criteria. For details
35386 of &'exipick'&'s facilities, visit the web page at
35387 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35388 the &%--help%& option.
35389
35390
35391 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35392 .cindex "log" "cycling local files"
35393 .cindex "cycling logs"
35394 .cindex "&'exicyclog'&"
35395 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35396 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35397 you are using log files with datestamps in their names (see section
35398 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35399 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35400 There are two command line options for &'exicyclog'&:
35401 .ilist
35402 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35403 default that is set when Exim is built. The default default is 10.
35404 .next
35405 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35406 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35407 overriding the script's default, which is to find the setting from Exim's
35408 configuration.
35409 .endlist
35410
35411 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35412 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35413 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35414 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35415 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35416 logs are handled similarly.
35417
35418 If the limit is greater than 99, the script uses 3-digit numbers such as
35419 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35420 to one that is greater, or &'vice versa'&, you will have to fix the names of
35421 any existing log files.
35422
35423 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35424 the end are deleted. All files with numbers greater than 01 are compressed,
35425 using a compression command which is configured by the COMPRESS_COMMAND
35426 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35427 root &%crontab%& entry of the form
35428 .code
35429 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35430 .endd
35431 assuming you have used the name &"exim"& for the Exim user. You can run
35432 &'exicyclog'& as root if you wish, but there is no need.
35433
35434
35435
35436 .section "Mail statistics (eximstats)" "SECTmailstat"
35437 .cindex "statistics"
35438 .cindex "&'eximstats'&"
35439 A Perl script called &'eximstats'& is provided for extracting statistical
35440 information from log files. The output is either plain text, or HTML.
35441 Exim log files are also supported by the &'Lire'& system produced by the
35442 LogReport Foundation &url(http://www.logreport.org).
35443
35444 The &'eximstats'& script has been hacked about quite a bit over time. The
35445 latest version is the result of some extensive revision by Steve Campbell. A
35446 lot of information is given by default, but there are options for suppressing
35447 various parts of it. Following any options, the arguments to the script are a
35448 list of files, which should be main log files. For example:
35449 .code
35450 eximstats -nr /var/spool/exim/log/mainlog.01
35451 .endd
35452 By default, &'eximstats'& extracts information about the number and volume of
35453 messages received from or delivered to various hosts. The information is sorted
35454 both by message count and by volume, and the top fifty hosts in each category
35455 are listed on the standard output. Similar information, based on email
35456 addresses or domains instead of hosts can be requested by means of various
35457 options. For messages delivered and received locally, similar statistics are
35458 also produced per user.
35459
35460 The output also includes total counts and statistics about delivery errors, and
35461 histograms showing the number of messages received and deliveries made in each
35462 hour of the day. A delivery with more than one address in its envelope (for
35463 example, an SMTP transaction with more than one RCPT command) is counted
35464 as a single delivery by &'eximstats'&.
35465
35466 Though normally more deliveries than receipts are reported (as messages may
35467 have multiple recipients), it is possible for &'eximstats'& to report more
35468 messages received than delivered, even though the queue is empty at the start
35469 and end of the period in question. If an incoming message contains no valid
35470 recipients, no deliveries are recorded for it. A bounce message is handled as
35471 an entirely separate message.
35472
35473 &'eximstats'& always outputs a grand total summary giving the volume and number
35474 of messages received and deliveries made, and the number of hosts involved in
35475 each case. It also outputs the number of messages that were delayed (that is,
35476 not completely delivered at the first attempt), and the number that had at
35477 least one address that failed.
35478
35479 The remainder of the output is in sections that can be independently disabled
35480 or modified by various options. It consists of a summary of deliveries by
35481 transport, histograms of messages received and delivered per time interval
35482 (default per hour), information about the time messages spent on the queue,
35483 a list of relayed messages, lists of the top fifty sending hosts, local
35484 senders, destination hosts, and destination local users by count and by volume,
35485 and a list of delivery errors that occurred.
35486
35487 The relay information lists messages that were actually relayed, that is, they
35488 came from a remote host and were directly delivered to some other remote host,
35489 without being processed (for example, for aliasing or forwarding) locally.
35490
35491 There are quite a few options for &'eximstats'& to control exactly what it
35492 outputs. These are documented in the Perl script itself, and can be extracted
35493 by running the command &(perldoc)& on the script. For example:
35494 .code
35495 perldoc /usr/exim/bin/eximstats
35496 .endd
35497
35498 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35499 .cindex "&'exim_checkaccess'&"
35500 .cindex "policy control" "checking access"
35501 .cindex "checking access"
35502 The &%-bh%& command line argument allows you to run a fake SMTP session with
35503 debugging output, in order to check what Exim is doing when it is applying
35504 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35505 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35506 sometimes you just want to answer the question &"Does this address have
35507 access?"& without bothering with any further details.
35508
35509 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35510 two arguments, an IP address and an email address:
35511 .code
35512 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35513 .endd
35514 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35515 given email address would be accepted in a RCPT command in a TCP/IP
35516 connection from the host with the given IP address. The output of the utility
35517 is either the word &"accepted"&, or the SMTP error response, for example:
35518 .code
35519 Rejected:
35520 550 Relay not permitted
35521 .endd
35522 When running this test, the utility uses &`<>`& as the envelope sender address
35523 for the MAIL command, but you can change this by providing additional
35524 options. These are passed directly to the Exim command. For example, to specify
35525 that the test is to be run with the sender address &'himself@there.example'&
35526 you can use:
35527 .code
35528 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35529                  -f himself@there.example
35530 .endd
35531 Note that these additional Exim command line items must be given after the two
35532 mandatory arguments.
35533
35534 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35535 while running its checks. You can run checks that include callouts by using
35536 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35537
35538
35539
35540 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35541 .cindex "DBM" "building dbm files"
35542 .cindex "building DBM files"
35543 .cindex "&'exim_dbmbuild'&"
35544 .cindex "lower casing"
35545 .cindex "binary zero" "in lookup key"
35546 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35547 the format used by the &(lsearch)& lookup (see section
35548 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35549 names as keys and the remainder of the information as data. The lower-casing
35550 can be prevented by calling the program with the &%-nolc%& option.
35551
35552 A terminating zero is included as part of the key string. This is expected by
35553 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35554 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35555 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35556 files.
35557
35558 The program requires two arguments: the name of the input file (which can be a
35559 single hyphen to indicate the standard input), and the name of the output file.
35560 It creates the output under a temporary name, and then renames it if all went
35561 well.
35562
35563 .cindex "USE_DB"
35564 If the native DB interface is in use (USE_DB is set in a compile-time
35565 configuration file &-- this is common in free versions of Unix) the two file
35566 names must be different, because in this mode the Berkeley DB functions create
35567 a single output file using exactly the name given. For example,
35568 .code
35569 exim_dbmbuild /etc/aliases /etc/aliases.db
35570 .endd
35571 reads the system alias file and creates a DBM version of it in
35572 &_/etc/aliases.db_&.
35573
35574 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35575 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35576 environment, the suffixes are added to the second argument of
35577 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35578 when the Berkeley functions are used in compatibility mode (though this is not
35579 recommended), because in that case it adds a &_.db_& suffix to the file name.
35580
35581 If a duplicate key is encountered, the program outputs a warning, and when it
35582 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35583 option is used. By default, only the first of a set of duplicates is used &--
35584 this makes it compatible with &(lsearch)& lookups. There is an option
35585 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35586 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35587 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35588 return code is 2.
35589
35590
35591
35592
35593 .section "Finding individual retry times (exinext)" "SECTfinindret"
35594 .cindex "retry" "times"
35595 .cindex "&'exinext'&"
35596 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35597 fish specific information out of the retry database. Given a mail domain (or a
35598 complete address), it looks up the hosts for that domain, and outputs any retry
35599 information for the hosts or for the domain. At present, the retry information
35600 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35601 output. For example:
35602 .code
35603 $ exinext piglet@milne.fict.example
35604 kanga.milne.example:192.168.8.1 error 146: Connection refused
35605   first failed: 21-Feb-1996 14:57:34
35606   last tried:   21-Feb-1996 14:57:34
35607   next try at:  21-Feb-1996 15:02:34
35608 roo.milne.example:192.168.8.3 error 146: Connection refused
35609   first failed: 20-Jan-1996 13:12:08
35610   last tried:   21-Feb-1996 11:42:03
35611   next try at:  21-Feb-1996 19:42:03
35612   past final cutoff time
35613 .endd
35614 You can also give &'exinext'& a local part, without a domain, and it
35615 will give any retry information for that local part in your default domain.
35616 A message id can be used to obtain retry information pertaining to a specific
35617 message. This exists only when an attempt to deliver a message to a remote host
35618 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35619 &'exinext'& is not particularly efficient, but then it is not expected to be
35620 run very often.
35621
35622 The &'exinext'& utility calls Exim to find out information such as the location
35623 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35624 passed on to the &'exim'& commands. The first specifies an alternate Exim
35625 configuration file, and the second sets macros for use within the configuration
35626 file. These features are mainly to help in testing, but might also be useful in
35627 environments where more than one configuration file is in use.
35628
35629
35630
35631 .section "Hints database maintenance" "SECThindatmai"
35632 .cindex "hints database" "maintenance"
35633 .cindex "maintaining Exim's hints database"
35634 Three utility programs are provided for maintaining the DBM files that Exim
35635 uses to contain its delivery hint information. Each program requires two
35636 arguments. The first specifies the name of Exim's spool directory, and the
35637 second is the name of the database it is to operate on. These are as follows:
35638
35639 .ilist
35640 &'retry'&: the database of retry information
35641 .next
35642 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35643 for remote hosts
35644 .next
35645 &'callout'&: the callout cache
35646 .next
35647 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35648 .next
35649 &'misc'&: other hints data
35650 .endlist
35651
35652 The &'misc'& database is used for
35653
35654 .ilist
35655 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35656 .next
35657 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35658 &(smtp)& transport)
35659 .endlist
35660
35661
35662
35663 .section "exim_dumpdb" "SECID261"
35664 .cindex "&'exim_dumpdb'&"
35665 The entire contents of a database are written to the standard output by the
35666 &'exim_dumpdb'& program, which has no options or arguments other than the
35667 spool and database names. For example, to dump the retry database:
35668 .code
35669 exim_dumpdb /var/spool/exim retry
35670 .endd
35671 Two lines of output are produced for each entry:
35672 .code
35673 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35674 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35675 .endd
35676 The first item on the first line is the key of the record. It starts with one
35677 of the letters R, or T, depending on whether it refers to a routing or
35678 transport retry. For a local delivery, the next part is the local address; for
35679 a remote delivery it is the name of the remote host, followed by its failing IP
35680 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35681 transport). If the remote port is not the standard one (port 25), it is added
35682 to the IP address. Then there follows an error code, an additional error code,
35683 and a textual description of the error.
35684
35685 The three times on the second line are the time of first failure, the time of
35686 the last delivery attempt, and the computed time for the next attempt. The line
35687 ends with an asterisk if the cutoff time for the last retry rule has been
35688 exceeded.
35689
35690 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35691 consists of a host name followed by a list of ids for messages that are or were
35692 waiting to be delivered to that host. If there are a very large number for any
35693 one host, continuation records, with a sequence number added to the host name,
35694 may be seen. The data in these records is often out of date, because a message
35695 may be routed to several alternative hosts, and Exim makes no effort to keep
35696 cross-references.
35697
35698
35699
35700 .section "exim_tidydb" "SECID262"
35701 .cindex "&'exim_tidydb'&"
35702 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35703 database. If run with no options, it removes all records that are more than 30
35704 days old. The age is calculated from the date and time that the record was last
35705 updated. Note that, in the case of the retry database, it is &'not'& the time
35706 since the first delivery failure. Information about a host that has been down
35707 for more than 30 days will remain in the database, provided that the record is
35708 updated sufficiently often.
35709
35710 The cutoff date can be altered by means of the &%-t%& option, which must be
35711 followed by a time. For example, to remove all records older than a week from
35712 the retry database:
35713 .code
35714 exim_tidydb -t 7d /var/spool/exim retry
35715 .endd
35716 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35717 message ids. In the former these appear as data in records keyed by host &--
35718 they were messages that were waiting for that host &-- and in the latter they
35719 are the keys for retry information for messages that have suffered certain
35720 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35721 message ids in database records are those of messages that are still on the
35722 queue. Message ids for messages that no longer exist are removed from
35723 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35724 For the &'retry'& database, records whose keys are non-existent message ids are
35725 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35726 whenever it removes information from the database.
35727
35728 Certain records are automatically removed by Exim when they are no longer
35729 needed, but others are not. For example, if all the MX hosts for a domain are
35730 down, a retry record is created for each one. If the primary MX host comes back
35731 first, its record is removed when Exim successfully delivers to it, but the
35732 records for the others remain because Exim has not tried to use those hosts.
35733
35734 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35735 hints databases. You should do this at a quiet time of day, because it requires
35736 a database to be locked (and therefore inaccessible to Exim) while it does its
35737 work. Removing records from a DBM file does not normally make the file smaller,
35738 but all the common DBM libraries are able to re-use the space that is released.
35739 After an initial phase of increasing in size, the databases normally reach a
35740 point at which they no longer get any bigger, as long as they are regularly
35741 tidied.
35742
35743 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35744 databases is likely to keep on increasing.
35745
35746
35747
35748
35749 .section "exim_fixdb" "SECID263"
35750 .cindex "&'exim_fixdb'&"
35751 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35752 Its main use is for testing Exim, but it might also be occasionally useful for
35753 getting round problems in a live system. It has no options, and its interface
35754 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35755 key of a database record can then be entered, and the data for that record is
35756 displayed.
35757
35758 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35759 except the &'retry'& database, that is the only operation that can be carried
35760 out. For the &'retry'& database, each field is output preceded by a number, and
35761 data for individual fields can be changed by typing the field number followed
35762 by new data, for example:
35763 .code
35764 > 4 951102:1000
35765 .endd
35766 resets the time of the next delivery attempt. Time values are given as a
35767 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35768 used as optional separators.
35769
35770
35771
35772
35773 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35774 .cindex "mailbox" "maintenance"
35775 .cindex "&'exim_lock'&"
35776 .cindex "locking mailboxes"
35777 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35778 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35779 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35780 a user agent while investigating a problem. The utility requires the name of
35781 the file as its first argument. If the locking is successful, the second
35782 argument is run as a command (using C's &[system()]& function); if there is no
35783 second argument, the value of the SHELL environment variable is used; if this
35784 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35785 is unlocked and the utility ends. The following options are available:
35786
35787 .vlist
35788 .vitem &%-fcntl%&
35789 Use &[fcntl()]& locking on the open mailbox.
35790
35791 .vitem &%-flock%&
35792 Use &[flock()]& locking on the open mailbox, provided the operating system
35793 supports it.
35794
35795 .vitem &%-interval%&
35796 This must be followed by a number, which is a number of seconds; it sets the
35797 interval to sleep between retries (default 3).
35798
35799 .vitem &%-lockfile%&
35800 Create a lock file before opening the mailbox.
35801
35802 .vitem &%-mbx%&
35803 Lock the mailbox using MBX rules.
35804
35805 .vitem &%-q%&
35806 Suppress verification output.
35807
35808 .vitem &%-retries%&
35809 This must be followed by a number; it sets the number of times to try to get
35810 the lock (default 10).
35811
35812 .vitem &%-restore_time%&
35813 This option causes &%exim_lock%& to restore the modified and read times to the
35814 locked file before exiting. This allows you to access a locked mailbox (for
35815 example, to take a backup copy) without disturbing the times that the user
35816 subsequently sees.
35817
35818 .vitem &%-timeout%&
35819 This must be followed by a number, which is a number of seconds; it sets a
35820 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35821 default), a non-blocking call is used.
35822
35823 .vitem &%-v%&
35824 Generate verbose output.
35825 .endlist
35826
35827 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35828 default is to create a lock file and also to use &[fcntl()]& locking on the
35829 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35830 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35831 requires that the directory containing the file be writeable. Locking by lock
35832 file does not last for ever; Exim assumes that a lock file is expired if it is
35833 more than 30 minutes old.
35834
35835 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35836 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35837 to be taken out on the open mailbox, and an exclusive lock on the file
35838 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35839 number of the mailbox file. When the locking is released, if an exclusive lock
35840 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35841
35842 The default output contains verification of the locking that takes place. The
35843 &%-v%& option causes some additional information to be given. The &%-q%& option
35844 suppresses all output except error messages.
35845
35846 A command such as
35847 .code
35848 exim_lock /var/spool/mail/spqr
35849 .endd
35850 runs an interactive shell while the file is locked, whereas
35851 .display
35852 &`exim_lock -q /var/spool/mail/spqr <<End`&
35853 <&'some commands'&>
35854 &`End`&
35855 .endd
35856 runs a specific non-interactive sequence of commands while the file is locked,
35857 suppressing all verification output. A single command can be run by a command
35858 such as
35859 .code
35860 exim_lock -q /var/spool/mail/spqr \
35861   "cp /var/spool/mail/spqr /some/where"
35862 .endd
35863 Note that if a command is supplied, it must be entirely contained within the
35864 second argument &-- hence the quotes.
35865 .ecindex IIDutils
35866
35867
35868 . ////////////////////////////////////////////////////////////////////////////
35869 . ////////////////////////////////////////////////////////////////////////////
35870
35871 .chapter "The Exim monitor" "CHAPeximon"
35872 .scindex IIDeximon "Exim monitor" "description"
35873 .cindex "X-windows"
35874 .cindex "&'eximon'&"
35875 .cindex "Local/eximon.conf"
35876 .cindex "&_exim_monitor/EDITME_&"
35877 The Exim monitor is an application which displays in an X window information
35878 about the state of Exim's queue and what Exim is doing. An admin user can
35879 perform certain operations on messages from this GUI interface; however all
35880 such facilities are also available from the command line, and indeed, the
35881 monitor itself makes use of the command line to perform any actions requested.
35882
35883
35884
35885 .section "Running the monitor" "SECID264"
35886 The monitor is started by running the script called &'eximon'&. This is a shell
35887 script that sets up a number of environment variables, and then runs the
35888 binary called &_eximon.bin_&. The default appearance of the monitor window can
35889 be changed by editing the &_Local/eximon.conf_& file created by editing
35890 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35891 parameters are for.
35892
35893 The parameters that get built into the &'eximon'& script can be overridden for
35894 a particular invocation by setting up environment variables of the same names,
35895 preceded by &`EXIMON_`&. For example, a shell command such as
35896 .code
35897 EXIMON_LOG_DEPTH=400 eximon
35898 .endd
35899 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35900 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35901 overrides the Exim log file configuration. This makes it possible to have
35902 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35903 syslog messages are routed to a file on the local host.
35904
35905 X resources can be used to change the appearance of the window in the normal
35906 way. For example, a resource setting of the form
35907 .code
35908 Eximon*background: gray94
35909 .endd
35910 changes the colour of the background to light grey rather than white. The
35911 stripcharts are drawn with both the data lines and the reference lines in
35912 black. This means that the reference lines are not visible when on top of the
35913 data. However, their colour can be changed by setting a resource called
35914 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35915 For example, if your X server is running Unix, you could set up lighter
35916 reference lines in the stripcharts by obeying
35917 .code
35918 xrdb -merge <<End
35919 Eximon*highlight: gray
35920 End
35921 .endd
35922 .cindex "admin user"
35923 In order to see the contents of messages on the queue, and to operate on them,
35924 &'eximon'& must either be run as root or by an admin user.
35925
35926 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35927 contain X11 resource parameters interpreted by the X11 library.  In addition,
35928 if the first parameter starts with the string "gdb" then it is removed and the
35929 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35930 versioned variants of gdb can be invoked).
35931
35932 The monitor's window is divided into three parts. The first contains one or
35933 more stripcharts and two action buttons, the second contains a &"tail"& of the
35934 main log file, and the third is a display of the queue of messages awaiting
35935 delivery, with two more action buttons. The following sections describe these
35936 different parts of the display.
35937
35938
35939
35940
35941 .section "The stripcharts" "SECID265"
35942 .cindex "stripchart"
35943 The first stripchart is always a count of messages on the queue. Its name can
35944 be configured by setting QUEUE_STRIPCHART_NAME in the
35945 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35946 configuration script by regular expression matches on log file entries, making
35947 it possible to display, for example, counts of messages delivered to certain
35948 hosts or using certain transports. The supplied defaults display counts of
35949 received and delivered messages, and of local and SMTP deliveries. The default
35950 period between stripchart updates is one minute; this can be adjusted by a
35951 parameter in the &_Local/eximon.conf_& file.
35952
35953 The stripchart displays rescale themselves automatically as the value they are
35954 displaying changes. There are always 10 horizontal lines in each chart; the
35955 title string indicates the value of each division when it is greater than one.
35956 For example, &"x2"& means that each division represents a value of 2.
35957
35958 It is also possible to have a stripchart which shows the percentage fullness of
35959 a particular disk partition, which is useful when local deliveries are confined
35960 to a single partition.
35961
35962 .cindex "&%statvfs%& function"
35963 This relies on the availability of the &[statvfs()]& function or equivalent in
35964 the operating system. Most, but not all versions of Unix that support Exim have
35965 this. For this particular stripchart, the top of the chart always represents
35966 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35967 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35968 &_Local/eximon.conf_& file.
35969
35970
35971
35972
35973 .section "Main action buttons" "SECID266"
35974 .cindex "size" "of monitor window"
35975 .cindex "Exim monitor" "window size"
35976 .cindex "window size"
35977 Below the stripcharts there is an action button for quitting the monitor. Next
35978 to this is another button marked &"Size"&. They are placed here so that
35979 shrinking the window to its default minimum size leaves just the queue count
35980 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35981 the window to expand to its maximum size, unless it is already at the maximum,
35982 in which case it is reduced to its minimum.
35983
35984 When expanding to the maximum, if the window cannot be fully seen where it
35985 currently is, it is moved back to where it was the last time it was at full
35986 size. When it is expanding from its minimum size, the old position is
35987 remembered, and next time it is reduced to the minimum it is moved back there.
35988
35989 The idea is that you can keep a reduced window just showing one or two
35990 stripcharts at a convenient place on your screen, easily expand it to show
35991 the full window when required, and just as easily put it back to what it was.
35992 The idea is copied from what the &'twm'& window manager does for its
35993 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35994 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35995
35996 Normally, the monitor starts up with the window at its full size, but it can be
35997 built so that it starts up with the window at its smallest size, by setting
35998 START_SMALL=yes in &_Local/eximon.conf_&.
35999
36000
36001
36002 .section "The log display" "SECID267"
36003 .cindex "log" "tail of; in monitor"
36004 The second section of the window is an area in which a display of the tail of
36005 the main log is maintained.
36006 To save space on the screen, the timestamp on each log line is shortened by
36007 removing the date and, if &%log_timezone%& is set, the timezone.
36008 The log tail is not available when the only destination for logging data is
36009 syslog, unless the syslog lines are routed to a local file whose name is passed
36010 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36011
36012 The log sub-window has a scroll bar at its lefthand side which can be used to
36013 move back to look at earlier text, and the up and down arrow keys also have a
36014 scrolling effect. The amount of log that is kept depends on the setting of
36015 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36016 to use. When this is full, the earlier 50% of data is discarded &-- this is
36017 much more efficient than throwing it away line by line. The sub-window also has
36018 a horizontal scroll bar for accessing the ends of long log lines. This is the
36019 only means of horizontal scrolling; the right and left arrow keys are not
36020 available. Text can be cut from this part of the window using the mouse in the
36021 normal way. The size of this subwindow is controlled by parameters in the
36022 configuration file &_Local/eximon.conf_&.
36023
36024 Searches of the text in the log window can be carried out by means of the ^R
36025 and ^S keystrokes, which default to a reverse and a forward search,
36026 respectively. The search covers only the text that is displayed in the window.
36027 It cannot go further back up the log.
36028
36029 The point from which the search starts is indicated by a caret marker. This is
36030 normally at the end of the text in the window, but can be positioned explicitly
36031 by pointing and clicking with the left mouse button, and is moved automatically
36032 by a successful search. If new text arrives in the window when it is scrolled
36033 back, the caret remains where it is, but if the window is not scrolled back,
36034 the caret is moved to the end of the new text.
36035
36036 Pressing ^R or ^S pops up a window into which the search text can be typed.
36037 There are buttons for selecting forward or reverse searching, for carrying out
36038 the search, and for cancelling. If the &"Search"& button is pressed, the search
36039 happens and the window remains so that further searches can be done. If the
36040 &"Return"& key is pressed, a single search is done and the window is closed. If
36041 ^C is typed the search is cancelled.
36042
36043 The searching facility is implemented using the facilities of the Athena text
36044 widget. By default this pops up a window containing both &"search"& and
36045 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36046 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36047 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36048 provided version of &%TextPop%& when the remaining parts of the text widget
36049 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36050 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36051 on these systems, at the expense of having unwanted items in the search popup
36052 window.
36053
36054
36055
36056 .section "The queue display" "SECID268"
36057 .cindex "queue" "display in monitor"
36058 The bottom section of the monitor window contains a list of all messages that
36059 are on the queue, which includes those currently being received or delivered,
36060 as well as those awaiting delivery. The size of this subwindow is controlled by
36061 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36062 at which it is updated is controlled by another parameter in the same file &--
36063 the default is 5 minutes, since queue scans can be quite expensive. However,
36064 there is an &"Update"& action button just above the display which can be used
36065 to force an update of the queue display at any time.
36066
36067 When a host is down for some time, a lot of pending mail can build up for it,
36068 and this can make it hard to deal with other messages on the queue. To help
36069 with this situation there is a button next to &"Update"& called &"Hide"&. If
36070 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36071 type anything in here and press &"Return"&, the text is added to a chain of
36072 such texts, and if every undelivered address in a message matches at least one
36073 of the texts, the message is not displayed.
36074
36075 If there is an address that does not match any of the texts, all the addresses
36076 are displayed as normal. The matching happens on the ends of addresses so, for
36077 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36078 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36079 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36080 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36081 a hide request is automatically cancelled after one hour.
36082
36083 While the dialogue box is displayed, you can't press any buttons or do anything
36084 else to the monitor window. For this reason, if you want to cut text from the
36085 queue display to use in the dialogue box, you have to do the cutting before
36086 pressing the &"Hide"& button.
36087
36088 The queue display contains, for each unhidden queued message, the length of
36089 time it has been on the queue, the size of the message, the message id, the
36090 message sender, and the first undelivered recipient, all on one line. If it is
36091 a bounce message, the sender is shown as &"<>"&. If there is more than one
36092 recipient to which the message has not yet been delivered, subsequent ones are
36093 listed on additional lines, up to a maximum configured number, following which
36094 an ellipsis is displayed. Recipients that have already received the message are
36095 not shown.
36096
36097 .cindex "frozen messages" "display"
36098 If a message is frozen, an asterisk is displayed at the left-hand side.
36099
36100 The queue display has a vertical scroll bar, and can also be scrolled by means
36101 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36102 The text searching facilities, as described above for the log window, are also
36103 available, but the caret is always moved to the end of the text when the queue
36104 display is updated.
36105
36106
36107
36108 .section "The queue menu" "SECID269"
36109 .cindex "queue" "menu in monitor"
36110 If the &%shift%& key is held down and the left button is clicked when the mouse
36111 pointer is over the text for any message, an action menu pops up, and the first
36112 line of the queue display for the message is highlighted. This does not affect
36113 any selected text.
36114
36115 If you want to use some other event for popping up the menu, you can set the
36116 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36117 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36118 value set in this parameter is a standard X event description. For example, to
36119 run eximon using &%ctrl%& rather than &%shift%& you could use
36120 .code
36121 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36122 .endd
36123 The title of the menu is the message id, and it contains entries which act as
36124 follows:
36125
36126 .ilist
36127 &'message log'&: The contents of the message log for the message are displayed
36128 in a new text window.
36129 .next
36130 &'headers'&: Information from the spool file that contains the envelope
36131 information and headers is displayed in a new text window. See chapter
36132 &<<CHAPspool>>& for a description of the format of spool files.
36133 .next
36134 &'body'&: The contents of the spool file containing the body of the message are
36135 displayed in a new text window. There is a default limit of 20,000 bytes to the
36136 amount of data displayed. This can be changed by setting the BODY_MAX
36137 option at compile time, or the EXIMON_BODY_MAX option at run time.
36138 .next
36139 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36140 delivery of the message. This causes an automatic thaw if the message is
36141 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36142 a new text window. The delivery is run in a separate process, to avoid holding
36143 up the monitor while the delivery proceeds.
36144 .next
36145 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36146 that the message be frozen.
36147 .next
36148 .cindex "thawing messages"
36149 .cindex "unfreezing messages"
36150 .cindex "frozen messages" "thawing"
36151 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36152 that the message be thawed.
36153 .next
36154 .cindex "delivery" "forcing failure"
36155 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36156 that Exim gives up trying to deliver the message. A bounce message is generated
36157 for any remaining undelivered addresses.
36158 .next
36159 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36160 that the message be deleted from the system without generating a bounce
36161 message.
36162 .next
36163 &'add recipient'&: A dialog box is displayed into which a recipient address can
36164 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36165 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36166 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36167 causes a call to Exim to be made using the &%-Mar%& option to request that an
36168 additional recipient be added to the message, unless the entry box is empty, in
36169 which case no action is taken.
36170 .next
36171 &'mark delivered'&: A dialog box is displayed into which a recipient address
36172 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36173 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36174 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36175 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36176 recipient address as already delivered, unless the entry box is empty, in which
36177 case no action is taken.
36178 .next
36179 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36180 mark all recipient addresses as already delivered.
36181 .next
36182 &'edit sender'&: A dialog box is displayed initialized with the current
36183 sender's address. Pressing RETURN causes a call to Exim to be made using the
36184 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36185 in which case no action is taken. If you want to set an empty sender (as in
36186 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36187 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36188 the address is qualified with that domain.
36189 .endlist
36190
36191 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36192 other cases when a call to Exim is made, if there is any output from Exim (in
36193 particular, if the command fails) a window containing the command and the
36194 output is displayed. Otherwise, the results of the action are normally apparent
36195 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36196 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36197 if no output is generated.
36198
36199 The queue display is automatically updated for actions such as freezing and
36200 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36201 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36202 force an update of the display after one of these actions.
36203
36204 In any text window that is displayed as result of a menu action, the normal
36205 cut-and-paste facility is available, and searching can be carried out using ^R
36206 and ^S, as described above for the log tail window.
36207 .ecindex IIDeximon
36208
36209
36210
36211
36212
36213 . ////////////////////////////////////////////////////////////////////////////
36214 . ////////////////////////////////////////////////////////////////////////////
36215
36216 .chapter "Security considerations" "CHAPsecurity"
36217 .scindex IIDsecurcon "security" "discussion of"
36218 This chapter discusses a number of issues concerned with security, some of
36219 which are also covered in other parts of this manual.
36220
36221 For reasons that this author does not understand, some people have promoted
36222 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36223 existence of this chapter in the documentation. However, the intent of the
36224 chapter is simply to describe the way Exim works in relation to certain
36225 security concerns, not to make any specific claims about the effectiveness of
36226 its security as compared with other MTAs.
36227
36228 What follows is a description of the way Exim is supposed to be. Best efforts
36229 have been made to try to ensure that the code agrees with the theory, but an
36230 absence of bugs can never be guaranteed. Any that are reported will get fixed
36231 as soon as possible.
36232
36233
36234 .section "Building a more &""hardened""& Exim" "SECID286"
36235 .cindex "security" "build-time features"
36236 There are a number of build-time options that can be set in &_Local/Makefile_&
36237 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36238 Exim administrator who does not have the root password, or by someone who has
36239 penetrated the Exim (but not the root) account. These options are as follows:
36240
36241 .ilist
36242 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36243 start of any file names used with the &%-C%& option. When it is set, these file
36244 names are also not allowed to contain the sequence &"/../"&. (However, if the
36245 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36246 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36247 default setting for &%ALT_CONFIG_PREFIX%&.
36248
36249 If the permitted configuration files are confined to a directory to
36250 which only root has access, this guards against someone who has broken
36251 into the Exim account from running a privileged Exim with an arbitrary
36252 configuration file, and using it to break into other accounts.
36253 .next
36254
36255 If a non-trusted configuration file (i.e. not the default configuration file
36256 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36257 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36258 the next item), then root privilege is retained only if the caller of Exim is
36259 root. This locks out the possibility of testing a configuration using &%-C%&
36260 right through message reception and delivery, even if the caller is root. The
36261 reception works, but by that time, Exim is running as the Exim user, so when
36262 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36263 privilege to be lost. However, root can test reception and delivery using two
36264 separate commands.
36265
36266 .next
36267 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36268 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36269 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36270 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36271 the restrictive side.  Requiring build-time selection of safe macros is onerous
36272 but this option is intended solely as a transition mechanism to permit
36273 previously-working configurations to continue to work after release 4.73.
36274 .next
36275 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36276 is disabled.
36277 .next
36278 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36279 never to be used for any deliveries. This is like the &%never_users%& runtime
36280 option, but it cannot be overridden; the runtime option adds additional users
36281 to the list. The default setting is &"root"&; this prevents a non-root user who
36282 is permitted to modify the runtime file from using Exim as a way to get root.
36283 .endlist
36284
36285
36286
36287 .section "Root privilege" "SECID270"
36288 .cindex "setuid"
36289 .cindex "root privilege"
36290 The Exim binary is normally setuid to root, which means that it gains root
36291 privilege (runs as root) when it starts execution. In some special cases (for
36292 example, when the daemon is not in use and there are no local deliveries), it
36293 may be possible to run Exim setuid to some user other than root. This is
36294 discussed in the next section. However, in most installations, root privilege
36295 is required for two things:
36296
36297 .ilist
36298 To set up a socket connected to the standard SMTP port (25) when initialising
36299 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36300 not required.
36301 .next
36302 To be able to change uid and gid in order to read users' &_.forward_& files and
36303 perform local deliveries as the receiving user or as specified in the
36304 configuration.
36305 .endlist
36306
36307 It is not necessary to be root to do any of the other things Exim does, such as
36308 receiving messages and delivering them externally over SMTP, and it is
36309 obviously more secure if Exim does not run as root except when necessary.
36310 For this reason, a user and group for Exim to use must be defined in
36311 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36312 group"&. Their values can be changed by the run time configuration, though this
36313 is not recommended. Often a user called &'exim'& is used, but some sites use
36314 &'mail'& or another user name altogether.
36315
36316 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36317 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36318 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36319
36320 After a new Exim process has interpreted its command line options, it changes
36321 uid and gid in the following cases:
36322
36323 .ilist
36324 .oindex "&%-C%&"
36325 .oindex "&%-D%&"
36326 If the &%-C%& option is used to specify an alternate configuration file, or if
36327 the &%-D%& option is used to define macro values for the configuration, and the
36328 calling process is not running as root, the uid and gid are changed to those of
36329 the calling process.
36330 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36331 option may not be used at all.
36332 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36333 can be supplied if the calling process is running as root, the Exim run-time
36334 user or CONFIGURE_OWNER, if defined.
36335 .next
36336 .oindex "&%-be%&"
36337 .oindex "&%-bf%&"
36338 .oindex "&%-bF%&"
36339 If the expansion test option (&%-be%&) or one of the filter testing options
36340 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36341 calling process.
36342 .next
36343 If the process is not a daemon process or a queue runner process or a delivery
36344 process or a process for testing address routing (started with &%-bt%&), the
36345 uid and gid are changed to the Exim user and group. This means that Exim always
36346 runs under its own uid and gid when receiving messages. This also applies when
36347 testing address verification
36348 .oindex "&%-bv%&"
36349 .oindex "&%-bh%&"
36350 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36351 option).
36352 .next
36353 For a daemon, queue runner, delivery, or address testing process, the uid
36354 remains as root at this stage, but the gid is changed to the Exim group.
36355 .endlist
36356
36357 The processes that initially retain root privilege behave as follows:
36358
36359 .ilist
36360 A daemon process changes the gid to the Exim group and the uid to the Exim
36361 user after setting up one or more listening sockets. The &[initgroups()]&
36362 function is called, so that if the Exim user is in any additional groups, they
36363 will be used during message reception.
36364 .next
36365 A queue runner process retains root privilege throughout its execution. Its
36366 job is to fork a controlled sequence of delivery processes.
36367 .next
36368 A delivery process retains root privilege throughout most of its execution,
36369 but any actual deliveries (that is, the transports themselves) are run in
36370 subprocesses which always change to a non-root uid and gid. For local
36371 deliveries this is typically the uid and gid of the owner of the mailbox; for
36372 remote deliveries, the Exim uid and gid are used. Once all the delivery
36373 subprocesses have been run, a delivery process changes to the Exim uid and gid
36374 while doing post-delivery tidying up such as updating the retry database and
36375 generating bounce and warning messages.
36376
36377 While the recipient addresses in a message are being routed, the delivery
36378 process runs as root. However, if a user's filter file has to be processed,
36379 this is done in a subprocess that runs under the individual user's uid and
36380 gid. A system filter is run as root unless &%system_filter_user%& is set.
36381 .next
36382 A process that is testing addresses (the &%-bt%& option) runs as root so that
36383 the routing is done in the same environment as a message delivery.
36384 .endlist
36385
36386
36387
36388
36389 .section "Running Exim without privilege" "SECTrunexiwitpri"
36390 .cindex "privilege, running without"
36391 .cindex "unprivileged running"
36392 .cindex "root privilege" "running without"
36393 Some installations like to run Exim in an unprivileged state for more of its
36394 operation, for added security. Support for this mode of operation is provided
36395 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36396 gid are changed to the Exim user and group at the start of a delivery process
36397 (and also queue runner and address testing processes). This means that address
36398 routing is no longer run as root, and the deliveries themselves cannot change
36399 to any other uid.
36400
36401 .cindex SIGHUP
36402 .cindex "daemon" "restarting"
36403 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36404 that the daemon can still be started in the usual way, and it can respond
36405 correctly to SIGHUP because the re-invocation regains root privilege.
36406
36407 An alternative approach is to make Exim setuid to the Exim user and also setgid
36408 to the Exim group. If you do this, the daemon must be started from a root
36409 process. (Calling Exim from a root process makes it behave in the way it does
36410 when it is setuid root.) However, the daemon cannot restart itself after a
36411 SIGHUP signal because it cannot regain privilege.
36412
36413 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36414 stops Exim from trying to re-invoke itself to do a delivery after a message has
36415 been received. Such a re-invocation is a waste of resources because it has no
36416 effect.
36417
36418 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36419 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36420 to the Exim user seems a clean approach, but there is one complication:
36421
36422 In this style of operation, Exim is running with the real uid and gid set to
36423 those of the calling process, and the effective uid/gid set to Exim's values.
36424 Ideally, any association with the calling process' uid/gid should be dropped,
36425 that is, the real uid/gid should be reset to the effective values so as to
36426 discard any privileges that the caller may have. While some operating systems
36427 have a function that permits this action for a non-root effective uid, quite a
36428 number of them do not. Because of this lack of standardization, Exim does not
36429 address this problem at this time.
36430
36431 For this reason, the recommended approach for &"mostly unprivileged"& running
36432 is to keep the Exim binary setuid to root, and to set
36433 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36434 be used in the most straightforward way.
36435
36436 If you configure Exim not to run delivery processes as root, there are a
36437 number of restrictions on what you can do:
36438
36439 .ilist
36440 You can deliver only as the Exim user/group. You should  explicitly use the
36441 &%user%& and &%group%& options to override routers or local transports that
36442 normally deliver as the recipient. This makes sure that configurations that
36443 work in this mode function the same way in normal mode. Any implicit or
36444 explicit specification of another user causes an error.
36445 .next
36446 Use of &_.forward_& files is severely restricted, such that it is usually
36447 not worthwhile to include them in the configuration.
36448 .next
36449 Users who wish to use &_.forward_& would have to make their home directory and
36450 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36451 and their equivalents in Exim filters, cannot be used. While they could be
36452 enabled in the Exim user's name, that would be insecure and not very useful.
36453 .next
36454 Unless the local user mailboxes are all owned by the Exim user (possible in
36455 some POP3 or IMAP-only environments):
36456
36457 .olist
36458 They must be owned by the Exim group and be writeable by that group. This
36459 implies you must set &%mode%& in the appendfile configuration, as well as the
36460 mode of the mailbox files themselves.
36461 .next
36462 You must set &%no_check_owner%&, since most or all of the files will not be
36463 owned by the Exim user.
36464 .next
36465 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36466 on a newly created mailbox when unprivileged. This also implies that new
36467 mailboxes need to be created manually.
36468 .endlist olist
36469 .endlist ilist
36470
36471
36472 These restrictions severely restrict what can be done in local deliveries.
36473 However, there are no restrictions on remote deliveries. If you are running a
36474 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36475 gives more security at essentially no cost.
36476
36477 If you are using the &%mua_wrapper%& facility (see chapter
36478 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36479
36480
36481
36482
36483 .section "Delivering to local files" "SECID271"
36484 Full details of the checks applied by &(appendfile)& before it writes to a file
36485 are given in chapter &<<CHAPappendfile>>&.
36486
36487
36488
36489 .section "Running local commands" "SECTsecconslocalcmds"
36490 .cindex "security" "local commands"
36491 .cindex "security" "command injection attacks"
36492 There are a number of ways in which an administrator can configure Exim to run
36493 commands based upon received, untrustworthy, data. Further, in some
36494 configurations a user who can control a &_.forward_& file can also arrange to
36495 run commands. Configuration to check includes, but is not limited to:
36496
36497 .ilist
36498 Use of &%use_shell%& in the pipe transport: various forms of shell command
36499 injection may be possible with this option present. It is dangerous and should
36500 be used only with considerable caution. Consider constraints which whitelist
36501 allowed characters in a variable which is to be used in a pipe transport that
36502 has &%use_shell%& enabled.
36503 .next
36504 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36505 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36506 &_.forward_& files in a redirect router. If Exim is running on a central mail
36507 hub to which ordinary users do not have shell access, but home directories are
36508 NFS mounted (for instance) then administrators should review the list of these
36509 forbid options available, and should bear in mind that the options that may
36510 need forbidding can change as new features are added between releases.
36511 .next
36512 The &%${run...}%& expansion item does not use a shell by default, but
36513 administrators can configure use of &_/bin/sh_& as part of the command.
36514 Such invocations should be viewed with prejudicial suspicion.
36515 .next
36516 Administrators who use embedded Perl are advised to explore how Perl's
36517 taint checking might apply to their usage.
36518 .next
36519 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36520 administrators are well advised to view its use with suspicion, in case (for
36521 instance) it allows a local-part to contain embedded Exim directives.
36522 .next
36523 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36524 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36525 each can reference arbitrary lists and files, rather than just being a list
36526 of opaque strings.
36527 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36528 real-world security vulnerabilities caused by its use with untrustworthy data
36529 injected in, for SQL injection attacks.
36530 Consider the use of the &%inlisti%& expansion condition instead.
36531 .endlist
36532
36533
36534
36535
36536 .section "Trust in configuration data" "SECTsecconfdata"
36537 .cindex "security" "data sources"
36538 .cindex "security" "regular expressions"
36539 .cindex "regular expressions" "security"
36540 .cindex "PCRE" "security"
36541 If configuration data for Exim can come from untrustworthy sources, there
36542 are some issues to be aware of:
36543
36544 .ilist
36545 Use of &%${expand...}%& may provide a path for shell injection attacks.
36546 .next
36547 Letting untrusted data provide a regular expression is unwise.
36548 .next
36549 Using &%${match...}%& to apply a fixed regular expression against untrusted
36550 data may result in pathological behaviour within PCRE.  Be aware of what
36551 "backtracking" means and consider options for being more strict with a regular
36552 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36553 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36554 possessive quantifiers or just not using regular expressions against untrusted
36555 data.
36556 .next
36557 It can be important to correctly use &%${quote:...}%&,
36558 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36559 items to ensure that data is correctly constructed.
36560 .next
36561 Some lookups might return multiple results, even though normal usage is only
36562 expected to yield one result.
36563 .endlist
36564
36565
36566
36567
36568 .section "IPv4 source routing" "SECID272"
36569 .cindex "source routing" "in IP packets"
36570 .cindex "IP source routing"
36571 Many operating systems suppress IP source-routed packets in the kernel, but
36572 some cannot be made to do this, so Exim does its own check. It logs incoming
36573 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36574 IPv6. No special checking is currently done.
36575
36576
36577
36578 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36579 Support for these SMTP commands is disabled by default. If required, they can
36580 be enabled by defining suitable ACLs.
36581
36582
36583
36584
36585 .section "Privileged users" "SECID274"
36586 .cindex "trusted users"
36587 .cindex "admin user"
36588 .cindex "privileged user"
36589 .cindex "user" "trusted"
36590 .cindex "user" "admin"
36591 Exim recognizes two sets of users with special privileges. Trusted users are
36592 able to submit new messages to Exim locally, but supply their own sender
36593 addresses and information about a sending host. For other users submitting
36594 local messages, Exim sets up the sender address from the uid, and doesn't
36595 permit a remote host to be specified.
36596
36597 .oindex "&%-f%&"
36598 However, an untrusted user is permitted to use the &%-f%& command line option
36599 in the special form &%-f <>%& to indicate that a delivery failure for the
36600 message should not cause an error report. This affects the message's envelope,
36601 but it does not affect the &'Sender:'& header. Untrusted users may also be
36602 permitted to use specific forms of address with the &%-f%& option by setting
36603 the &%untrusted_set_sender%& option.
36604
36605 Trusted users are used to run processes that receive mail messages from some
36606 other mail domain and pass them on to Exim for delivery either locally, or over
36607 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36608 as any user listed in the &%trusted_users%& configuration option, or under any
36609 group listed in the &%trusted_groups%& option.
36610
36611 Admin users are permitted to do things to the messages on Exim's queue. They
36612 can freeze or thaw messages, cause them to be returned to their senders, remove
36613 them entirely, or modify them in various ways. In addition, admin users can run
36614 the Exim monitor and see all the information it is capable of providing, which
36615 includes the contents of files on the spool.
36616
36617 .oindex "&%-M%&"
36618 .oindex "&%-q%&"
36619 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36620 delivery of messages on its queue is restricted to admin users. This
36621 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36622 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36623 queue is also restricted to admin users. This restriction can be relaxed by
36624 setting &%no_queue_list_requires_admin%&.
36625
36626 Exim recognizes an admin user if the calling process is running as root or as
36627 the Exim user or if any of the groups associated with the calling process is
36628 the Exim group. It is not necessary actually to be running under the Exim
36629 group. However, if admin users who are not root or the Exim user are to access
36630 the contents of files on the spool via the Exim monitor (which runs
36631 unprivileged), Exim must be built to allow group read access to its spool
36632 files.
36633
36634
36635
36636 .section "Spool files" "SECID275"
36637 .cindex "spool directory" "files"
36638 Exim's spool directory and everything it contains is owned by the Exim user and
36639 set to the Exim group. The mode for spool files is defined in the
36640 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36641 any user who is a member of the Exim group can access these files.
36642
36643
36644
36645 .section "Use of argv[0]" "SECID276"
36646 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36647 of specific strings, Exim assumes certain options. For example, calling Exim
36648 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36649 to calling it with the option &%-bS%&. There are no security implications in
36650 this.
36651
36652
36653
36654 .section "Use of %f formatting" "SECID277"
36655 The only use made of &"%f"& by Exim is in formatting load average values. These
36656 are actually stored in integer variables as 1000 times the load average.
36657 Consequently, their range is limited and so therefore is the length of the
36658 converted output.
36659
36660
36661
36662 .section "Embedded Exim path" "SECID278"
36663 Exim uses its own path name, which is embedded in the code, only when it needs
36664 to re-exec in order to regain root privilege. Therefore, it is not root when it
36665 does so. If some bug allowed the path to get overwritten, it would lead to an
36666 arbitrary program's being run as exim, not as root.
36667
36668
36669
36670 .section "Dynamic module directory" "SECTdynmoddir"
36671 Any dynamically loadable modules must be installed into the directory
36672 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36673 loading it.
36674
36675
36676 .section "Use of sprintf()" "SECID279"
36677 .cindex "&[sprintf()]&"
36678 A large number of occurrences of &"sprintf"& in the code are actually calls to
36679 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36680 The intermediate formatting is done into a large fixed buffer by a function
36681 that runs through the format string itself, and checks the length of each
36682 conversion before performing it, thus preventing buffer overruns.
36683
36684 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36685 the output buffer is known to be sufficiently long to contain the converted
36686 string.
36687
36688
36689
36690 .section "Use of debug_printf() and log_write()" "SECID280"
36691 Arbitrary strings are passed to both these functions, but they do their
36692 formatting by calling the function &'string_vformat()'&, which runs through
36693 the format string itself, and checks the length of each conversion.
36694
36695
36696
36697 .section "Use of strcat() and strcpy()" "SECID281"
36698 These are used only in cases where the output buffer is known to be large
36699 enough to hold the result.
36700 .ecindex IIDsecurcon
36701
36702
36703
36704
36705 . ////////////////////////////////////////////////////////////////////////////
36706 . ////////////////////////////////////////////////////////////////////////////
36707
36708 .chapter "Format of spool files" "CHAPspool"
36709 .scindex IIDforspo1 "format" "spool files"
36710 .scindex IIDforspo2 "spool directory" "format of files"
36711 .scindex IIDforspo3 "spool files" "format of"
36712 .cindex "spool files" "editing"
36713 A message on Exim's queue consists of two files, whose names are the message id
36714 followed by -D and -H, respectively. The data portion of the message is kept in
36715 the -D file on its own. The message's envelope, status, and headers are all
36716 kept in the -H file, whose format is described in this chapter. Each of these
36717 two files contains the final component of its own name as its first line. This
36718 is insurance against disk crashes where the directory is lost but the files
36719 themselves are recoverable.
36720
36721 Some people are tempted into editing -D files in order to modify messages. You
36722 need to be extremely careful if you do this; it is not recommended and you are
36723 on your own if you do it. Here are some of the pitfalls:
36724
36725 .ilist
36726 You must ensure that Exim does not try to deliver the message while you are
36727 fiddling with it. The safest way is to take out a write lock on the -D file,
36728 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36729 place, the lock will be retained. If you write a new file and rename it, the
36730 lock will be lost at the instant of rename.
36731 .next
36732 .vindex "&$body_linecount$&"
36733 If you change the number of lines in the file, the value of
36734 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36735 present, this value is not used by Exim, but there is no guarantee that this
36736 will always be the case.
36737 .next
36738 If the message is in MIME format, you must take care not to break it.
36739 .next
36740 If the message is cryptographically signed, any change will invalidate the
36741 signature.
36742 .endlist
36743 All in all, modifying -D files is fraught with danger.
36744
36745 Files whose names end with -J may also be seen in the &_input_& directory (or
36746 its subdirectories when &%split_spool_directory%& is set). These are journal
36747 files, used to record addresses to which the message has been delivered during
36748 the course of a delivery attempt. If there are still undelivered recipients at
36749 the end, the -H file is updated, and the -J file is deleted. If, however, there
36750 is some kind of crash (for example, a power outage) before this happens, the -J
36751 file remains in existence. When Exim next processes the message, it notices the
36752 -J file and uses it to update the -H file before starting the next delivery
36753 attempt.
36754
36755 .section "Format of the -H file" "SECID282"
36756 .cindex "uid (user id)" "in spool file"
36757 .cindex "gid (group id)" "in spool file"
36758 The second line of the -H file contains the login name for the uid of the
36759 process that called Exim to read the message, followed by the numerical uid and
36760 gid. For a locally generated message, this is normally the user who sent the
36761 message. For a message received over TCP/IP via the daemon, it is
36762 normally the Exim user.
36763
36764 The third line of the file contains the address of the message's sender as
36765 transmitted in the envelope, contained in angle brackets. The sender address is
36766 empty for bounce messages. For incoming SMTP mail, the sender address is given
36767 in the MAIL command. For locally generated mail, the sender address is
36768 created by Exim from the login name of the current user and the configured
36769 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36770 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36771 &"<>"& or an address that matches &%untrusted_set_senders%&.
36772
36773 The fourth line contains two numbers. The first is the time that the message
36774 was received, in the conventional Unix form &-- the number of seconds since the
36775 start of the epoch. The second number is a count of the number of messages
36776 warning of delayed delivery that have been sent to the sender.
36777
36778 There follow a number of lines starting with a hyphen. These can appear in any
36779 order, and are omitted when not relevant:
36780
36781 .vlist
36782 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36783 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36784 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36785 recognized, to provide backward compatibility. In the old format, a line of
36786 this form is present for every ACL variable that is not empty. The number
36787 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36788 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36789 the data string for the variable. The string itself starts at the beginning of
36790 the next line, and is followed by a newline character. It may contain internal
36791 newlines.
36792
36793 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36794 A line of this form is present for every ACL connection variable that is
36795 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36796 The length is the length of the data string for the variable. The string itself
36797 starts at the beginning of the next line, and is followed by a newline
36798 character. It may contain internal newlines.
36799
36800 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36801 A line of this form is present for every ACL message variable that is defined.
36802 Note that there is a space between &%-aclm%& and the rest of the name. The
36803 length is the length of the data string for the variable. The string itself
36804 starts at the beginning of the next line, and is followed by a newline
36805 character. It may contain internal newlines.
36806
36807 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36808 This is present if, when the message was received over SMTP, the value of
36809 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36810
36811 .vitem &%-allow_unqualified_recipient%&
36812 This is present if unqualified recipient addresses are permitted in header
36813 lines (to stop such addresses from being qualified if rewriting occurs at
36814 transport time). Local messages that were input using &%-bnq%& and remote
36815 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36816
36817 .vitem &%-allow_unqualified_sender%&
36818 This is present if unqualified sender addresses are permitted in header lines
36819 (to stop such addresses from being qualified if rewriting occurs at transport
36820 time). Local messages that were input using &%-bnq%& and remote messages from
36821 hosts that match &%sender_unqualified_hosts%& set this flag.
36822
36823 .vitem "&%-auth_id%&&~<&'text'&>"
36824 The id information for a message received on an authenticated SMTP connection
36825 &-- the value of the &$authenticated_id$& variable.
36826
36827 .vitem "&%-auth_sender%&&~<&'address'&>"
36828 The address of an authenticated sender &-- the value of the
36829 &$authenticated_sender$& variable.
36830
36831 .vitem "&%-body_linecount%&&~<&'number'&>"
36832 This records the number of lines in the body of the message, and is always
36833 present.
36834
36835 .vitem "&%-body_zerocount%&&~<&'number'&>"
36836 This records the number of binary zero bytes in the body of the message, and is
36837 present if the number is greater than zero.
36838
36839 .vitem &%-deliver_firsttime%&
36840 This is written when a new message is first added to the spool. When the spool
36841 file is updated after a deferral, it is omitted.
36842
36843 .vitem "&%-frozen%&&~<&'time'&>"
36844 .cindex "frozen messages" "spool data"
36845 The message is frozen, and the freezing happened at <&'time'&>.
36846
36847 .vitem "&%-helo_name%&&~<&'text'&>"
36848 This records the host name as specified by a remote host in a HELO or EHLO
36849 command.
36850
36851 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36852 This records the IP address of the host from which the message was received and
36853 the remote port number that was used. It is omitted for locally generated
36854 messages.
36855
36856 .vitem "&%-host_auth%&&~<&'text'&>"
36857 If the message was received on an authenticated SMTP connection, this records
36858 the name of the authenticator &-- the value of the
36859 &$sender_host_authenticated$& variable.
36860
36861 .vitem &%-host_lookup_failed%&
36862 This is present if an attempt to look up the sending host's name from its IP
36863 address failed. It corresponds to the &$host_lookup_failed$& variable.
36864
36865 .vitem "&%-host_name%&&~<&'text'&>"
36866 .cindex "reverse DNS lookup"
36867 .cindex "DNS" "reverse lookup"
36868 This records the name of the remote host from which the message was received,
36869 if the host name was looked up from the IP address when the message was being
36870 received. It is not present if no reverse lookup was done.
36871
36872 .vitem "&%-ident%&&~<&'text'&>"
36873 For locally submitted messages, this records the login of the originating user,
36874 unless it was a trusted user and the &%-oMt%& option was used to specify an
36875 ident value. For messages received over TCP/IP, this records the ident string
36876 supplied by the remote host, if any.
36877
36878 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36879 This records the IP address of the local interface and the port number through
36880 which a message was received from a remote host. It is omitted for locally
36881 generated messages.
36882
36883 .vitem &%-local%&
36884 The message is from a local sender.
36885
36886 .vitem &%-localerror%&
36887 The message is a locally-generated bounce message.
36888
36889 .vitem "&%-local_scan%&&~<&'string'&>"
36890 This records the data string that was returned by the &[local_scan()]& function
36891 when the message was received &-- the value of the &$local_scan_data$&
36892 variable. It is omitted if no data was returned.
36893
36894 .vitem &%-manual_thaw%&
36895 The message was frozen but has been thawed manually, that is, by an explicit
36896 Exim command rather than via the auto-thaw process.
36897
36898 .vitem &%-N%&
36899 A testing delivery process was started using the &%-N%& option to suppress any
36900 actual deliveries, but delivery was deferred. At any further delivery attempts,
36901 &%-N%& is assumed.
36902
36903 .vitem &%-received_protocol%&
36904 This records the value of the &$received_protocol$& variable, which contains
36905 the name of the protocol by which the message was received.
36906
36907 .vitem &%-sender_set_untrusted%&
36908 The envelope sender of this message was set by an untrusted local caller (used
36909 to ensure that the caller is displayed in queue listings).
36910
36911 .vitem "&%-spam_score_int%&&~<&'number'&>"
36912 If a message was scanned by SpamAssassin, this is present. It records the value
36913 of &$spam_score_int$&.
36914
36915 .vitem &%-tls_certificate_verified%&
36916 A TLS certificate was received from the client that sent this message, and the
36917 certificate was verified by the server.
36918
36919 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36920 When the message was received over an encrypted connection, this records the
36921 name of the cipher suite that was used.
36922
36923 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36924 When the message was received over an encrypted connection, and a certificate
36925 was received from the client, this records the Distinguished Name from that
36926 certificate.
36927 .endlist
36928
36929 Following the options there is a list of those addresses to which the message
36930 is not to be delivered. This set of addresses is initialized from the command
36931 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36932 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36933 the address is added to this set. The addresses are kept internally as a
36934 balanced binary tree, and it is a representation of that tree which is written
36935 to the spool file. If an address is expanded via an alias or forward file, the
36936 original address is added to the tree when deliveries to all its child
36937 addresses are complete.
36938
36939 If the tree is empty, there is a single line in the spool file containing just
36940 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36941 Y or N, followed by an address. The address is the value for the node of the
36942 tree, and the letters indicate whether the node has a left branch and/or a
36943 right branch attached to it, respectively. If branches exist, they immediately
36944 follow. Here is an example of a three-node tree:
36945 .code
36946 YY darcy@austen.fict.example
36947 NN alice@wonderland.fict.example
36948 NN editor@thesaurus.ref.example
36949 .endd
36950 After the non-recipients tree, there is a list of the message's recipients.
36951 This is a simple list, preceded by a count. It includes all the original
36952 recipients of the message, including those to whom the message has already been
36953 delivered. In the simplest case, the list contains one address per line. For
36954 example:
36955 .code
36956 4
36957 editor@thesaurus.ref.example
36958 darcy@austen.fict.example
36959 rdo@foundation
36960 alice@wonderland.fict.example
36961 .endd
36962 However, when a child address has been added to the top-level addresses as a
36963 result of the use of the &%one_time%& option on a &(redirect)& router, each
36964 line is of the following form:
36965 .display
36966 <&'top-level address'&> <&'errors_to address'&> &&&
36967   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36968 .endd
36969 The 01 flag bit indicates the presence of the three other fields that follow
36970 the top-level address. Other bits may be used in future to support additional
36971 fields. The <&'parent number'&> is the offset in the recipients list of the
36972 original parent of the &"one time"& address. The first two fields are the
36973 envelope sender that is associated with this address and its length. If the
36974 length is zero, there is no special envelope sender (there are then two space
36975 characters in the line). A non-empty field can arise from a &(redirect)& router
36976 that has an &%errors_to%& setting.
36977
36978
36979 A blank line separates the envelope and status information from the headers
36980 which follow. A header may occupy several lines of the file, and to save effort
36981 when reading it in, each header is preceded by a number and an identifying
36982 character. The number is the number of characters in the header, including any
36983 embedded newlines and the terminating newline. The character is one of the
36984 following:
36985
36986 .table2 50pt
36987 .row <&'blank'&>         "header in which Exim has no special interest"
36988 .row &`B`&               "&'Bcc:'& header"
36989 .row &`C`&               "&'Cc:'& header"
36990 .row &`F`&               "&'From:'& header"
36991 .row &`I`&               "&'Message-id:'& header"
36992 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
36993 .row &`R`&               "&'Reply-To:'& header"
36994 .row &`S`&               "&'Sender:'& header"
36995 .row &`T`&               "&'To:'& header"
36996 .row &`*`&               "replaced or deleted header"
36997 .endtable
36998
36999 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37000 purposes. They are not transmitted when the message is delivered. Here is a
37001 typical set of headers:
37002 .code
37003 111P Received: by hobbit.fict.example with local (Exim 4.00)
37004 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37005 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37006 038* X-rewrote-sender: bb@hobbit.fict.example
37007 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37008 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37009 099* To: alice@wonderland.fict.example, rdo@foundation,
37010 darcy@austen.fict.example, editor@thesaurus.ref.example
37011 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37012 darcy@austen.fict.example, editor@thesaurus.ref.example
37013 038  Date: Fri, 11 May 2001 10:28:59 +0100
37014 .endd
37015 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37016 &'To:'& header have been rewritten, the last one because routing expanded the
37017 unqualified domain &'foundation'&.
37018 .ecindex IIDforspo1
37019 .ecindex IIDforspo2
37020 .ecindex IIDforspo3
37021
37022 . ////////////////////////////////////////////////////////////////////////////
37023 . ////////////////////////////////////////////////////////////////////////////
37024
37025 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37026          "DKIM Support"
37027 .cindex "DKIM"
37028
37029 DKIM is a mechanism by which messages sent by some entity can be provably
37030 linked to a domain which that entity controls.  It permits reputation to
37031 be tracked on a per-domain basis, rather than merely upon source IP address.
37032 DKIM is documented in RFC 4871.
37033
37034 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37035 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37036
37037 Exim's DKIM implementation allows to
37038 .olist
37039 Sign outgoing messages: This function is implemented in the SMTP transport.
37040 It can co-exist with all other Exim features
37041 (including transport filters)
37042 except cutthrough delivery.
37043 .next
37044 Verify signatures in incoming messages: This is implemented by an additional
37045 ACL (acl_smtp_dkim), which can be called several times per message, with
37046 different signature contexts.
37047 .endlist
37048
37049 In typical Exim style, the verification implementation does not include any
37050 default "policy". Instead it enables you to build your own policy using
37051 Exim's standard controls.
37052
37053 Please note that verification of DKIM signatures in incoming mail is turned
37054 on by default for logging purposes. For each signature in incoming email,
37055 exim will log a line displaying the most important signature details, and the
37056 signature status. Here is an example (with line-breaks added for clarity):
37057 .code
37058 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37059     d=facebookmail.com s=q1-2009b
37060     c=relaxed/relaxed a=rsa-sha1
37061     i=@facebookmail.com t=1252484542 [verification succeeded]
37062 .endd
37063 You might want to turn off DKIM verification processing entirely for internal
37064 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37065 control modifier. This should typically be done in the RCPT ACL, at points
37066 where you accept mail from relay sources (internal hosts or authenticated
37067 senders).
37068
37069
37070 .section "Signing outgoing messages" "SECID513"
37071 .cindex "DKIM" "signing"
37072
37073 Signing is implemented by setting private options on the SMTP transport.
37074 These options take (expandable) strings as arguments.
37075
37076 .option dkim_domain smtp string&!! unset
37077 MANDATORY:
37078 The domain you want to sign with. The result of this expanded
37079 option is put into the &%$dkim_domain%& expansion variable.
37080
37081 .option dkim_selector smtp string&!! unset
37082 MANDATORY:
37083 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37084 variable to look up a matching selector. The result is put in the expansion
37085 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37086 option along with &%$dkim_domain%&.
37087
37088 .option dkim_private_key smtp string&!! unset
37089 MANDATORY:
37090 This sets the private key to use. You can use the &%$dkim_domain%& and
37091 &%$dkim_selector%& expansion variables to determine the private key to use.
37092 The result can either
37093 .ilist
37094 be a valid RSA private key in ASCII armor, including line breaks.
37095 .next
37096 start with a slash, in which case it is treated as a file that contains
37097 the private key.
37098 .next
37099 be "0", "false" or the empty string, in which case the message will not
37100 be signed. This case will not result in an error, even if &%dkim_strict%&
37101 is set.
37102 .endlist
37103
37104 .option dkim_canon smtp string&!! unset
37105 OPTIONAL:
37106 This option sets the canonicalization method used when signing a message.
37107 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37108 The option defaults to "relaxed" when unset. Note: the current implementation
37109 only supports using the same canonicalization method for both headers and body.
37110
37111 .option dkim_strict smtp string&!! unset
37112 OPTIONAL:
37113 This  option  defines  how  Exim  behaves  when  signing a message that
37114 should be signed fails for some reason.  When the expansion evaluates to
37115 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37116 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37117 variables here.
37118
37119 .option dkim_sign_headers smtp string&!! unset
37120 OPTIONAL:
37121 When set, this option must expand to (or be specified as) a colon-separated
37122 list of header names. Headers with these names will be included in the message
37123 signature. When unspecified, the header names recommended in RFC4871 will be
37124 used.
37125
37126
37127 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37128 .cindex "DKIM" "verification"
37129
37130 Verification of DKIM signatures in incoming email is implemented via the
37131 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37132 syntactically(!) correct signature in the incoming message.
37133 A missing ACL definition defaults to accept.
37134 If any ACL call does not acccept, the message is not accepted.
37135 If a cutthrough delivery was in progress for the message it is
37136 summarily dropped (having wasted the transmission effort).
37137
37138 To evaluate the signature in the ACL a large number of expansion variables
37139 containing the signature status and its details are set up during the
37140 runtime of the ACL.
37141
37142 Calling the ACL only for existing signatures is not sufficient to build
37143 more advanced policies. For that reason, the global option
37144 &%dkim_verify_signers%&, and a global expansion variable
37145 &%$dkim_signers%& exist.
37146
37147 The global option &%dkim_verify_signers%& can be set to a colon-separated
37148 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37149 called. It is expanded when the message has been received. At this point,
37150 the expansion variable &%$dkim_signers%& already contains a colon-separated
37151 list of signer domains and identities for the message. When
37152 &%dkim_verify_signers%& is not specified in the main configuration,
37153 it defaults as:
37154 .code
37155 dkim_verify_signers = $dkim_signers
37156 .endd
37157 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37158 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37159 call the ACL for known domains or identities. This would be achieved as follows:
37160 .code
37161 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37162 .endd
37163 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37164 and "ebay.com", plus all domains and identities that have signatures in the message.
37165 You can also be more creative in constructing your policy. For example:
37166 .code
37167 dkim_verify_signers = $sender_address_domain:$dkim_signers
37168 .endd
37169
37170 If a domain or identity is listed several times in the (expanded) value of
37171 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37172
37173
37174 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37175 available (from most to least important):
37176
37177
37178 .vlist
37179 .vitem &%$dkim_cur_signer%&
37180 The signer that is being evaluated in this ACL run. This can be a domain or
37181 an identity. This is one of the list items from the expanded main option
37182 &%dkim_verify_signers%& (see above).
37183 .vitem &%$dkim_verify_status%&
37184 A string describing the general status of the signature. One of
37185 .ilist
37186 &%none%&: There is no signature in the message for the current domain or
37187 identity (as reflected by &%$dkim_cur_signer%&).
37188 .next
37189 &%invalid%&: The signature could not be verified due to a processing error.
37190 More detail is available in &%$dkim_verify_reason%&.
37191 .next
37192 &%fail%&: Verification of the signature failed.  More detail is
37193 available in &%$dkim_verify_reason%&.
37194 .next
37195 &%pass%&: The signature passed verification. It is valid.
37196 .endlist
37197 .vitem &%$dkim_verify_reason%&
37198 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37199 "fail" or "invalid". One of
37200 .ilist
37201 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37202 key for the domain could not be retrieved. This may be a temporary problem.
37203 .next
37204 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37205 record for the domain is syntactically invalid.
37206 .next
37207 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37208 body hash does not match the one specified in the signature header. This
37209 means that the message body was modified in transit.
37210 .next
37211 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37212 could not be verified. This may mean that headers were modified,
37213 re-written or otherwise changed in a way which is incompatible with
37214 DKIM verification. It may of course also mean that the signature is forged.
37215 .endlist
37216 .vitem &%$dkim_domain%&
37217 The signing domain. IMPORTANT: This variable is only populated if there is
37218 an actual signature in the message for the current domain or identity (as
37219 reflected by &%$dkim_cur_signer%&).
37220 .vitem &%$dkim_identity%&
37221 The signing identity, if present. IMPORTANT: This variable is only populated
37222 if there is an actual signature in the message for the current domain or
37223 identity (as reflected by &%$dkim_cur_signer%&).
37224 .vitem &%$dkim_selector%&
37225 The key record selector string.
37226 .vitem &%$dkim_algo%&
37227 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37228 .vitem &%$dkim_canon_body%&
37229 The body canonicalization method. One of 'relaxed' or 'simple'.
37230 .vitem &%dkim_canon_headers%&
37231 The header canonicalization method. One of 'relaxed' or 'simple'.
37232 .vitem &%$dkim_copiedheaders%&
37233 A transcript of headers and their values which are included in the signature
37234 (copied from the 'z=' tag of the signature).
37235 .vitem &%$dkim_bodylength%&
37236 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37237 limit was set by the signer, "9999999999999" is returned. This makes sure
37238 that this variable always expands to an integer value.
37239 .vitem &%$dkim_created%&
37240 UNIX timestamp reflecting the date and time when the signature was created.
37241 When this was not specified by the signer, "0" is returned.
37242 .vitem &%$dkim_expires%&
37243 UNIX timestamp reflecting the date and time when the signer wants the
37244 signature to be treated as "expired". When this was not specified by the
37245 signer, "9999999999999" is returned. This makes it possible to do useful
37246 integer size comparisons against this value.
37247 .vitem &%$dkim_headernames%&
37248 A colon-separated list of names of headers included in the signature.
37249 .vitem &%$dkim_key_testing%&
37250 "1" if the key record has the "testing" flag set, "0" if not.
37251 .vitem &%$dkim_key_nosubdomains%&
37252 "1" if the key record forbids subdomaining, "0" otherwise.
37253 .vitem &%$dkim_key_srvtype%&
37254 Service type (tag s=) from the key record. Defaults to "*" if not specified
37255 in the key record.
37256 .vitem &%$dkim_key_granularity%&
37257 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37258 in the key record.
37259 .vitem &%$dkim_key_notes%&
37260 Notes from the key record (tag n=).
37261 .endlist
37262
37263 In addition, two ACL conditions are provided:
37264
37265 .vlist
37266 .vitem &%dkim_signers%&
37267 ACL condition that checks a colon-separated list of domains or identities
37268 for a match against the domain or identity that the ACL is currently verifying
37269 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37270 verb to a group of domains or identities. For example:
37271
37272 .code
37273 # Warn when Mail purportedly from GMail has no signature at all
37274 warn log_message = GMail sender without DKIM signature
37275      sender_domains = gmail.com
37276      dkim_signers = gmail.com
37277      dkim_status = none
37278 .endd
37279
37280 .vitem &%dkim_status%&
37281 ACL condition that checks a colon-separated list of possible DKIM verification
37282 results against the actual result of verification. This is typically used
37283 to restrict an ACL verb to a list of verification outcomes, for example:
37284
37285 .code
37286 deny message = Mail from Paypal with invalid/missing signature
37287      sender_domains = paypal.com:paypal.de
37288      dkim_signers = paypal.com:paypal.de
37289      dkim_status = none:invalid:fail
37290 .endd
37291
37292 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37293 see the documentation of the &%$dkim_verify_status%& expansion variable above
37294 for more information of what they mean.
37295 .endlist
37296
37297 . ////////////////////////////////////////////////////////////////////////////
37298 . ////////////////////////////////////////////////////////////////////////////
37299
37300 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37301          "Adding drivers or lookups"
37302 .cindex "adding drivers"
37303 .cindex "new drivers, adding"
37304 .cindex "drivers" "adding new"
37305 The following actions have to be taken in order to add a new router, transport,
37306 authenticator, or lookup type to Exim:
37307
37308 .olist
37309 Choose a name for the driver or lookup type that does not conflict with any
37310 existing name; I will use &"newdriver"& in what follows.
37311 .next
37312 Add to &_src/EDITME_& the line:
37313 .display
37314 <&'type'&>&`_NEWDRIVER=yes`&
37315 .endd
37316 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37317 code is not to be included in the binary by default, comment this line out. You
37318 should also add any relevant comments about the driver or lookup type.
37319 .next
37320 Add to &_src/config.h.defaults_& the line:
37321 .code
37322 #define <type>_NEWDRIVER
37323 .endd
37324 .next
37325 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37326 and create a table entry as is done for all the other drivers and lookup types.
37327 .next
37328 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37329 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37330 Add your &`NEWDRIVER`& to that list.
37331 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37332 simple form that most lookups have.
37333 .next
37334 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37335 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37336 driver or lookup type and add it to the definition of OBJ.
37337 .next
37338 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37339 &_src_&.
37340 .next
37341 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37342 as for other drivers and lookups.
37343 .endlist
37344
37345 Then all you need to do is write the code! A good way to start is to make a
37346 proforma by copying an existing module of the same type, globally changing all
37347 occurrences of the name, and cutting out most of the code. Note that any
37348 options you create must be listed in alphabetical order, because the tables are
37349 searched using a binary chop procedure.
37350
37351 There is a &_README_& file in each of the sub-directories of &_src_& describing
37352 the interface that is expected.
37353
37354
37355
37356
37357 . ////////////////////////////////////////////////////////////////////////////
37358 . ////////////////////////////////////////////////////////////////////////////
37359
37360 . /////////////////////////////////////////////////////////////////////////////
37361 . These lines are processing instructions for the Simple DocBook Processor that
37362 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37363 . PDFs than using xmlto and fop. They will be ignored by all other XML
37364 . processors.
37365 . /////////////////////////////////////////////////////////////////////////////
37366
37367 .literal xml
37368 <?sdop
37369   format="newpage"
37370   foot_right_recto="&chaptertitle;"
37371   foot_right_verso="&chaptertitle;"
37372 ?>
37373 .literal off
37374
37375 .makeindex "Options index"   "option"
37376 .makeindex "Variables index" "variable"
37377 .makeindex "Concept index"   "concept"
37378
37379
37380 . /////////////////////////////////////////////////////////////////////////////
37381 . /////////////////////////////////////////////////////////////////////////////