tidying
[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.85"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2014
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default ISO-8859-1). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&. Exim used to
1989 have a compile option for including A6 record support but this has now been
1990 withdrawn.
1991
1992
1993
1994 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1995 .cindex "lookup modules"
1996 .cindex "dynamic modules"
1997 .cindex ".so building"
1998 On some platforms, Exim supports not compiling all lookup types directly into
1999 the main binary, instead putting some into external modules which can be loaded
2000 on demand.
2001 This permits packagers to build Exim with support for lookups with extensive
2002 library dependencies without requiring all users to install all of those
2003 dependencies.
2004 Most, but not all, lookup types can be built this way.
2005
2006 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2007 installed; Exim will only load modules from that directory, as a security
2008 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2009 for your OS; see &_OS/Makefile-Linux_& for an example.
2010 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2011 see &_src/EDITME_& for details.
2012
2013 Then, for each module to be loaded dynamically, define the relevant
2014 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2015 For example, this will build in lsearch but load sqlite and mysql support
2016 on demand:
2017 .code
2018 LOOKUP_LSEARCH=yes
2019 LOOKUP_SQLITE=2
2020 LOOKUP_MYSQL=2
2021 .endd
2022
2023
2024 .section "The building process" "SECID29"
2025 .cindex "build directory"
2026 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2027 created, run &'make'& at the top level. It determines the architecture and
2028 operating system types, and creates a build directory if one does not exist.
2029 For example, on a Sun system running Solaris 8, the directory
2030 &_build-SunOS5-5.8-sparc_& is created.
2031 .cindex "symbolic link" "to source files"
2032 Symbolic links to relevant source files are installed in the build directory.
2033
2034 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2035 building process fails if it is set.
2036
2037 If this is the first time &'make'& has been run, it calls a script that builds
2038 a make file inside the build directory, using the configuration files from the
2039 &_Local_& directory. The new make file is then passed to another instance of
2040 &'make'&. This does the real work, building a number of utility scripts, and
2041 then compiling and linking the binaries for the Exim monitor (if configured), a
2042 number of utility programs, and finally Exim itself. The command &`make
2043 makefile`& can be used to force a rebuild of the make file in the build
2044 directory, should this ever be necessary.
2045
2046 If you have problems building Exim, check for any comments there may be in the
2047 &_README_& file concerning your operating system, and also take a look at the
2048 FAQ, where some common problems are covered.
2049
2050
2051
2052 .section 'Output from &"make"&' "SECID283"
2053 The output produced by the &'make'& process for compile lines is often very
2054 unreadable, because these lines can be very long. For this reason, the normal
2055 output is suppressed by default, and instead output similar to that which
2056 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2057 each module that is being compiled or linked. However, it is still possible to
2058 get the full output, by calling &'make'& like this:
2059 .code
2060 FULLECHO='' make -e
2061 .endd
2062 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2063 command reflection in &'make'&. When you ask for the full output, it is
2064 given in addition to the short output.
2065
2066
2067
2068 .section "Overriding build-time options for Exim" "SECToverride"
2069 .cindex "build-time options, overriding"
2070 The main make file that is created at the beginning of the building process
2071 consists of the concatenation of a number of files which set configuration
2072 values, followed by a fixed set of &'make'& instructions. If a value is set
2073 more than once, the last setting overrides any previous ones. This provides a
2074 convenient way of overriding defaults. The files that are concatenated are, in
2075 order:
2076 .display
2077 &_OS/Makefile-Default_&
2078 &_OS/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile_&
2080 &_Local/Makefile-_&<&'ostype'&>
2081 &_Local/Makefile-_&<&'archtype'&>
2082 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2083 &_OS/Makefile-Base_&
2084 .endd
2085 .cindex "&_Local/Makefile_&"
2086 .cindex "building Exim" "operating system type"
2087 .cindex "building Exim" "architecture type"
2088 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2089 architecture type. &_Local/Makefile_& is required to exist, and the building
2090 process fails if it is absent. The other three &_Local_& files are optional,
2091 and are often not needed.
2092
2093 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2094 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2095 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2096 values are used, thereby providing a means of forcing particular settings.
2097 Otherwise, the scripts try to get values from the &%uname%& command. If this
2098 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2099 of &'ad hoc'& transformations are then applied, to produce the standard names
2100 that Exim expects. You can run these scripts directly from the shell in order
2101 to find out what values are being used on your system.
2102
2103
2104 &_OS/Makefile-Default_& contains comments about the variables that are set
2105 therein. Some (but not all) are mentioned below. If there is something that
2106 needs changing, review the contents of this file and the contents of the make
2107 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2108 default values are.
2109
2110
2111 .cindex "building Exim" "overriding default settings"
2112 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2113 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2114 need to change the original files. Instead, you should make the changes by
2115 putting the new values in an appropriate &_Local_& file. For example,
2116 .cindex "Tru64-Unix build-time settings"
2117 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2118 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2119 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2120 called with the option &%-std1%&, to make it recognize some of the features of
2121 Standard C that Exim uses. (Most other compilers recognize Standard C by
2122 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2123 containing the lines
2124 .code
2125 CC=cc
2126 CFLAGS=-std1
2127 .endd
2128 If you are compiling for just one operating system, it may be easier to put
2129 these lines directly into &_Local/Makefile_&.
2130
2131 Keeping all your local configuration settings separate from the distributed
2132 files makes it easy to transfer them to new versions of Exim simply by copying
2133 the contents of the &_Local_& directory.
2134
2135
2136 .cindex "NIS lookup type" "including support for"
2137 .cindex "NIS+ lookup type" "including support for"
2138 .cindex "LDAP" "including support for"
2139 .cindex "lookup" "inclusion in binary"
2140 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2141 lookup, but not all systems have these components installed, so the default is
2142 not to include the relevant code in the binary. All the different kinds of file
2143 and database lookup that Exim supports are implemented as separate code modules
2144 which are included only if the relevant compile-time options are set. In the
2145 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2146 .code
2147 LOOKUP_LDAP=yes
2148 LOOKUP_NIS=yes
2149 LOOKUP_NISPLUS=yes
2150 .endd
2151 and similar settings apply to the other lookup types. They are all listed in
2152 &_src/EDITME_&. In many cases the relevant include files and interface
2153 libraries need to be installed before compiling Exim.
2154 .cindex "cdb" "including support for"
2155 However, there are some optional lookup types (such as cdb) for which
2156 the code is entirely contained within Exim, and no external include
2157 files or libraries are required. When a lookup type is not included in the
2158 binary, attempts to configure Exim to use it cause run time configuration
2159 errors.
2160
2161 .cindex "pkg-config" "lookups"
2162 .cindex "pkg-config" "authenticators"
2163 Many systems now use a tool called &'pkg-config'& to encapsulate information
2164 about how to compile against a library; Exim has some initial support for
2165 being able to use pkg-config for lookups and authenticators.  For any given
2166 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2167 variable with the &`_PC`& suffix in the name and assign as the value the
2168 name of the package to be queried.  The results of querying via the
2169 &'pkg-config'& command will be added to the appropriate Makefile variables
2170 with &`+=`& directives, so your version of &'make'& will need to support that
2171 syntax.  For instance:
2172 .code
2173 LOOKUP_SQLITE=yes
2174 LOOKUP_SQLITE_PC=sqlite3
2175 AUTH_GSASL=yes
2176 AUTH_GSASL_PC=libgsasl
2177 AUTH_HEIMDAL_GSSAPI=yes
2178 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2179 .endd
2180
2181 .cindex "Perl" "including support for"
2182 Exim can be linked with an embedded Perl interpreter, allowing Perl
2183 subroutines to be called during string expansion. To enable this facility,
2184 .code
2185 EXIM_PERL=perl.o
2186 .endd
2187 must be defined in &_Local/Makefile_&. Details of this facility are given in
2188 chapter &<<CHAPperl>>&.
2189
2190 .cindex "X11 libraries, location of"
2191 The location of the X11 libraries is something that varies a lot between
2192 operating systems, and there may be different versions of X11 to cope
2193 with. Exim itself makes no use of X11, but if you are compiling the Exim
2194 monitor, the X11 libraries must be available.
2195 The following three variables are set in &_OS/Makefile-Default_&:
2196 .code
2197 X11=/usr/X11R6
2198 XINCLUDE=-I$(X11)/include
2199 XLFLAGS=-L$(X11)/lib
2200 .endd
2201 These are overridden in some of the operating-system configuration files. For
2202 example, in &_OS/Makefile-SunOS5_& there is
2203 .code
2204 X11=/usr/openwin
2205 XINCLUDE=-I$(X11)/include
2206 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2207 .endd
2208 If you need to override the default setting for your operating system, place a
2209 definition of all three of these variables into your
2210 &_Local/Makefile-<ostype>_& file.
2211
2212 .cindex "EXTRALIBS"
2213 If you need to add any extra libraries to the link steps, these can be put in a
2214 variable called EXTRALIBS, which appears in all the link commands, but by
2215 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2216 command for linking the main Exim binary, and not for any associated utilities.
2217
2218 .cindex "DBM libraries" "configuration for building"
2219 There is also DBMLIB, which appears in the link commands for binaries that
2220 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2221 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2222 binary, and which can be used, for example, to include additional X11
2223 libraries.
2224
2225 .cindex "configuration file" "editing"
2226 The make file copes with rebuilding Exim correctly if any of the configuration
2227 files are edited. However, if an optional configuration file is deleted, it is
2228 necessary to touch the associated non-optional file (that is,
2229 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2230
2231
2232 .section "OS-specific header files" "SECID30"
2233 .cindex "&_os.h_&"
2234 .cindex "building Exim" "OS-specific C header files"
2235 The &_OS_& directory contains a number of files with names of the form
2236 &_os.h-<ostype>_&. These are system-specific C header files that should not
2237 normally need to be changed. There is a list of macro settings that are
2238 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2239 are porting Exim to a new operating system.
2240
2241
2242
2243 .section "Overriding build-time options for the monitor" "SECID31"
2244 .cindex "building Eximon"
2245 A similar process is used for overriding things when building the Exim monitor,
2246 where the files that are involved are
2247 .display
2248 &_OS/eximon.conf-Default_&
2249 &_OS/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf_&
2251 &_Local/eximon.conf-_&<&'ostype'&>
2252 &_Local/eximon.conf-_&<&'archtype'&>
2253 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2254 .endd
2255 .cindex "&_Local/eximon.conf_&"
2256 As with Exim itself, the final three files need not exist, and in this case the
2257 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2258 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2259 variables of the same name, preceded by EXIMON_. For example, setting
2260 EXIMON_LOG_DEPTH in the environment overrides the value of
2261 LOG_DEPTH at run time.
2262 .ecindex IIDbuex
2263
2264
2265 .section "Installing Exim binaries and scripts" "SECID32"
2266 .cindex "installing Exim"
2267 .cindex "BIN_DIRECTORY"
2268 The command &`make install`& runs the &(exim_install)& script with no
2269 arguments. The script copies binaries and utility scripts into the directory
2270 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2271 .cindex "setuid" "installing Exim with"
2272 The install script copies files only if they are newer than the files they are
2273 going to replace. The Exim binary is required to be owned by root and have the
2274 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2275 install`& as root so that it can set up the Exim binary in this way. However, in
2276 some special situations (for example, if a host is doing no local deliveries)
2277 it may be possible to run Exim without making the binary setuid root (see
2278 chapter &<<CHAPsecurity>>& for details).
2279
2280 .cindex "CONFIGURE_FILE"
2281 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2282 in &_Local/Makefile_&. If this names a single file, and the file does not
2283 exist, the default configuration file &_src/configure.default_& is copied there
2284 by the installation script. If a run time configuration file already exists, it
2285 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2286 alternative files, no default is installed.
2287
2288 .cindex "system aliases file"
2289 .cindex "&_/etc/aliases_&"
2290 One change is made to the default configuration file when it is installed: the
2291 default configuration contains a router that references a system aliases file.
2292 The path to this file is set to the value specified by
2293 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2294 If the system aliases file does not exist, the installation script creates it,
2295 and outputs a comment to the user.
2296
2297 The created file contains no aliases, but it does contain comments about the
2298 aliases a site should normally have. Mail aliases have traditionally been
2299 kept in &_/etc/aliases_&. However, some operating systems are now using
2300 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2301 Exim's configuration if necessary.
2302
2303 The default configuration uses the local host's name as the only local domain,
2304 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2305 running as the local user. System aliases and &_.forward_& files in users' home
2306 directories are supported, but no NIS or NIS+ support is configured. Domains
2307 other than the name of the local host are routed using the DNS, with delivery
2308 over SMTP.
2309
2310 It is possible to install Exim for special purposes (such as building a binary
2311 distribution) in a private part of the file system. You can do this by a
2312 command such as
2313 .code
2314 make DESTDIR=/some/directory/ install
2315 .endd
2316 This has the effect of pre-pending the specified directory to all the file
2317 paths, except the name of the system aliases file that appears in the default
2318 configuration. (If a default alias file is created, its name &'is'& modified.)
2319 For backwards compatibility, ROOT is used if DESTDIR is not set,
2320 but this usage is deprecated.
2321
2322 .cindex "installing Exim" "what is not installed"
2323 Running &'make install'& does not copy the Exim 4 conversion script
2324 &'convert4r4'&. You will probably run this only once if you are
2325 upgrading from Exim 3. None of the documentation files in the &_doc_&
2326 directory are copied, except for the info files when you have set
2327 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2328
2329 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2330 to their names. The Exim binary itself, however, is handled differently. It is
2331 installed under a name that includes the version number and the compile number,
2332 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2333 called &_exim_& to point to the binary. If you are updating a previous version
2334 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2335 from the directory (as seen by other processes).
2336
2337 .cindex "installing Exim" "testing the script"
2338 If you want to see what the &'make install'& will do before running it for
2339 real, you can pass the &%-n%& option to the installation script by this
2340 command:
2341 .code
2342 make INSTALL_ARG=-n install
2343 .endd
2344 The contents of the variable INSTALL_ARG are passed to the installation
2345 script. You do not need to be root to run this test. Alternatively, you can run
2346 the installation script directly, but this must be from within the build
2347 directory. For example, from the top-level Exim directory you could use this
2348 command:
2349 .code
2350 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2351 .endd
2352 .cindex "installing Exim" "install script options"
2353 There are two other options that can be supplied to the installation script.
2354
2355 .ilist
2356 &%-no_chown%& bypasses the call to change the owner of the installed binary
2357 to root, and the call to make it a setuid binary.
2358 .next
2359 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2360 installed binary.
2361 .endlist
2362
2363 INSTALL_ARG can be used to pass these options to the script. For example:
2364 .code
2365 make INSTALL_ARG=-no_symlink install
2366 .endd
2367 The installation script can also be given arguments specifying which files are
2368 to be copied. For example, to install just the Exim binary, and nothing else,
2369 without creating the symbolic link, you could use:
2370 .code
2371 make INSTALL_ARG='-no_symlink exim' install
2372 .endd
2373
2374
2375
2376 .section "Installing info documentation" "SECTinsinfdoc"
2377 .cindex "installing Exim" "&'info'& documentation"
2378 Not all systems use the GNU &'info'& system for documentation, and for this
2379 reason, the Texinfo source of Exim's documentation is not included in the main
2380 distribution. Instead it is available separately from the ftp site (see section
2381 &<<SECTavail>>&).
2382
2383 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2384 source of the documentation is found in the source tree, running &`make
2385 install`& automatically builds the info files and installs them.
2386
2387
2388
2389 .section "Setting up the spool directory" "SECID33"
2390 .cindex "spool directory" "creating"
2391 When it starts up, Exim tries to create its spool directory if it does not
2392 exist. The Exim uid and gid are used for the owner and group of the spool
2393 directory. Sub-directories are automatically created in the spool directory as
2394 necessary.
2395
2396
2397
2398
2399 .section "Testing" "SECID34"
2400 .cindex "testing" "installation"
2401 Having installed Exim, you can check that the run time configuration file is
2402 syntactically valid by running the following command, which assumes that the
2403 Exim binary directory is within your PATH environment variable:
2404 .code
2405 exim -bV
2406 .endd
2407 If there are any errors in the configuration file, Exim outputs error messages.
2408 Otherwise it outputs the version number and build date,
2409 the DBM library that is being used, and information about which drivers and
2410 other optional code modules are included in the binary.
2411 Some simple routing tests can be done by using the address testing option. For
2412 example,
2413 .display
2414 &`exim -bt`& <&'local username'&>
2415 .endd
2416 should verify that it recognizes a local mailbox, and
2417 .display
2418 &`exim -bt`& <&'remote address'&>
2419 .endd
2420 a remote one. Then try getting it to deliver mail, both locally and remotely.
2421 This can be done by passing messages directly to Exim, without going through a
2422 user agent. For example:
2423 .code
2424 exim -v postmaster@your.domain.example
2425 From: user@your.domain.example
2426 To: postmaster@your.domain.example
2427 Subject: Testing Exim
2428
2429 This is a test message.
2430 ^D
2431 .endd
2432 The &%-v%& option causes Exim to output some verification of what it is doing.
2433 In this case you should see copies of three log lines, one for the message's
2434 arrival, one for its delivery, and one containing &"Completed"&.
2435
2436 .cindex "delivery" "problems with"
2437 If you encounter problems, look at Exim's log files (&'mainlog'& and
2438 &'paniclog'&) to see if there is any relevant information there. Another source
2439 of information is running Exim with debugging turned on, by specifying the
2440 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2441 with debugging turned on by a command of the form
2442 .display
2443 &`exim -d -M`& <&'exim-message-id'&>
2444 .endd
2445 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2446 produces rather a lot of output, but you can cut this down to specific areas.
2447 For example, if you use &%-d-all+route%& only the debugging information
2448 relevant to routing is included. (See the &%-d%& option in chapter
2449 &<<CHAPcommandline>>& for more details.)
2450
2451 .cindex '&"sticky"& bit'
2452 .cindex "lock files"
2453 One specific problem that has shown up on some sites is the inability to do
2454 local deliveries into a shared mailbox directory, because it does not have the
2455 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2456 writing to a mailbox file, and if it cannot create the lock file, the delivery
2457 is deferred. You can get round this either by setting the &"sticky bit"& on the
2458 directory, or by setting a specific group for local deliveries and allowing
2459 that group to create files in the directory (see the comments above the
2460 &(local_delivery)& transport in the default configuration file). Another
2461 approach is to configure Exim not to use lock files, but just to rely on
2462 &[fcntl()]& locking instead. However, you should do this only if all user
2463 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2464 see chapter &<<CHAPappendfile>>&.
2465
2466 One thing that cannot be tested on a system that is already running an MTA is
2467 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2468 &%-oX%& option can be used to run an Exim daemon that listens on some other
2469 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2470 &'exim_checkaccess'& utility can be used to check out policy controls on
2471 incoming SMTP mail.
2472
2473 Testing a new version on a system that is already running Exim can most easily
2474 be done by building a binary with a different CONFIGURE_FILE setting. From
2475 within the run time configuration, all other file and directory names
2476 that Exim uses can be altered, in order to keep it entirely clear of the
2477 production version.
2478
2479
2480 .section "Replacing another MTA with Exim" "SECID35"
2481 .cindex "replacing another MTA"
2482 Building and installing Exim for the first time does not of itself put it in
2483 general use. The name by which the system's MTA is called by mail user agents
2484 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2485 operating system), and it is necessary to make this name point to the &'exim'&
2486 binary in order to get the user agents to pass messages to Exim. This is
2487 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2488 or &_/usr/lib/sendmail_&
2489 .cindex "symbolic link" "to &'exim'& binary"
2490 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2491 privilege and executable status from the old MTA. It is then necessary to stop
2492 and restart the mailer daemon, if one is running.
2493
2494 .cindex "FreeBSD, MTA indirection"
2495 .cindex "&_/etc/mail/mailer.conf_&"
2496 Some operating systems have introduced alternative ways of switching MTAs. For
2497 example, if you are running FreeBSD, you need to edit the file
2498 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2499 described. A typical example of the contents of this file for running Exim is
2500 as follows:
2501 .code
2502 sendmail            /usr/exim/bin/exim
2503 send-mail           /usr/exim/bin/exim
2504 mailq               /usr/exim/bin/exim -bp
2505 newaliases          /usr/bin/true
2506 .endd
2507 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2508 your Exim installation is &"live"&. Check it by sending a message from your
2509 favourite user agent.
2510
2511 You should consider what to tell your users about the change of MTA. Exim may
2512 have different capabilities to what was previously running, and there are
2513 various operational differences such as the text of messages produced by
2514 command line options and in bounce messages. If you allow your users to make
2515 use of Exim's filtering capabilities, you should make the document entitled
2516 &'Exim's interface to mail filtering'& available to them.
2517
2518
2519
2520 .section "Upgrading Exim" "SECID36"
2521 .cindex "upgrading Exim"
2522 If you are already running Exim on your host, building and installing a new
2523 version automatically makes it available to MUAs, or any other programs that
2524 call the MTA directly. However, if you are running an Exim daemon, you do need
2525 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2526 new binary. You do not need to stop processing mail in order to install a new
2527 version of Exim. The install script does not modify an existing runtime
2528 configuration file.
2529
2530
2531
2532
2533 .section "Stopping the Exim daemon on Solaris" "SECID37"
2534 .cindex "Solaris" "stopping Exim on"
2535 The standard command for stopping the mailer daemon on Solaris is
2536 .code
2537 /etc/init.d/sendmail stop
2538 .endd
2539 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2540 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2541 for the text &"sendmail"&; this is not present because the actual program name
2542 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2543 solution is to replace the line that finds the process id with something like
2544 .code
2545 pid=`cat /var/spool/exim/exim-daemon.pid`
2546 .endd
2547 to obtain the daemon's pid directly from the file that Exim saves it in.
2548
2549 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2550 still be received from local processes, and if automatic delivery is configured
2551 (the normal case), deliveries will still occur.
2552
2553
2554
2555
2556 . ////////////////////////////////////////////////////////////////////////////
2557 . ////////////////////////////////////////////////////////////////////////////
2558
2559 .chapter "The Exim command line" "CHAPcommandline"
2560 .scindex IIDclo1 "command line" "options"
2561 .scindex IIDclo2 "options" "command line"
2562 Exim's command line takes the standard Unix form of a sequence of options,
2563 each starting with a hyphen character, followed by a number of arguments. The
2564 options are compatible with the main options of Sendmail, and there are also
2565 some additional options, some of which are compatible with Smail 3. Certain
2566 combinations of options do not make sense, and provoke an error if used.
2567 The form of the arguments depends on which options are set.
2568
2569
2570 .section "Setting options by program name" "SECID38"
2571 .cindex "&'mailq'&"
2572 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2573 were present before any other options.
2574 The &%-bp%& option requests a listing of the contents of the mail queue on the
2575 standard output.
2576 This feature is for compatibility with some systems that contain a command of
2577 that name in one of the standard libraries, symbolically linked to
2578 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2579
2580 .cindex "&'rsmtp'&"
2581 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2582 were present before any other options, for compatibility with Smail. The
2583 &%-bS%& option is used for reading in a number of messages in batched SMTP
2584 format.
2585
2586 .cindex "&'rmail'&"
2587 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2588 &%-oee%& options were present before any other options, for compatibility with
2589 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2590
2591 .cindex "&'runq'&"
2592 .cindex "queue runner"
2593 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2594 were present before any other options, for compatibility with Smail. The &%-q%&
2595 option causes a single queue runner process to be started.
2596
2597 .cindex "&'newaliases'&"
2598 .cindex "alias file" "building"
2599 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2600 If Exim is called under the name &'newaliases'& it behaves as if the option
2601 &%-bi%& were present before any other options, for compatibility with Sendmail.
2602 This option is used for rebuilding Sendmail's alias file. Exim does not have
2603 the concept of a single alias file, but can be configured to run a given
2604 command if called with the &%-bi%& option.
2605
2606
2607 .section "Trusted and admin users" "SECTtrustedadmin"
2608 Some Exim options are available only to &'trusted users'& and others are
2609 available only to &'admin users'&. In the description below, the phrases &"Exim
2610 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2611 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2612 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2613
2614 .ilist
2615 .cindex "trusted users" "definition of"
2616 .cindex "user" "trusted definition of"
2617 The trusted users are root, the Exim user, any user listed in the
2618 &%trusted_users%& configuration option, and any user whose current group or any
2619 supplementary group is one of those listed in the &%trusted_groups%&
2620 configuration option. Note that the Exim group is not automatically trusted.
2621
2622 .cindex '&"From"& line'
2623 .cindex "envelope sender"
2624 Trusted users are always permitted to use the &%-f%& option or a leading
2625 &"From&~"& line to specify the envelope sender of a message that is passed to
2626 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2627 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2628 users to set envelope senders.
2629
2630 .cindex "&'From:'& header line"
2631 .cindex "&'Sender:'& header line"
2632 For a trusted user, there is never any check on the contents of the &'From:'&
2633 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2634 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2635
2636 Trusted users may also specify a host name, host address, interface address,
2637 protocol name, ident value, and authentication data when submitting a message
2638 locally. Thus, they are able to insert messages into Exim's queue locally that
2639 have the characteristics of messages received from a remote host. Untrusted
2640 users may in some circumstances use &%-f%&, but can never set the other values
2641 that are available to trusted users.
2642 .next
2643 .cindex "user" "admin definition of"
2644 .cindex "admin user" "definition of"
2645 The admin users are root, the Exim user, and any user that is a member of the
2646 Exim group or of any group listed in the &%admin_groups%& configuration option.
2647 The current group does not have to be one of these groups.
2648
2649 Admin users are permitted to list the queue, and to carry out certain
2650 operations on messages, for example, to force delivery failures. It is also
2651 necessary to be an admin user in order to see the full information provided by
2652 the Exim monitor, and full debugging output.
2653
2654 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2655 Exim to attempt delivery of messages on its queue is restricted to admin users.
2656 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2657 option false (that is, specifying &%no_prod_requires_admin%&).
2658
2659 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2660 is restricted to admin users unless &%queue_list_requires_admin%& is set
2661 false.
2662 .endlist
2663
2664
2665 &*Warning*&: If you configure your system so that admin users are able to
2666 edit Exim's configuration file, you are giving those users an easy way of
2667 getting root. There is further discussion of this issue at the start of chapter
2668 &<<CHAPconf>>&.
2669
2670
2671
2672
2673 .section "Command line options" "SECID39"
2674 Exim's command line options are described in alphabetical order below. If none
2675 of the options that specifies a specific action (such as starting the daemon or
2676 a queue runner, or testing an address, or receiving a message in a specific
2677 format, or listing the queue) are present, and there is at least one argument
2678 on the command line, &%-bm%& (accept a local message on the standard input,
2679 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2680 outputs a brief message about itself and exits.
2681
2682 . ////////////////////////////////////////////////////////////////////////////
2683 . Insert a stylized XML comment here, to identify the start of the command line
2684 . options. This is for the benefit of the Perl script that automatically
2685 . creates a man page for the options.
2686 . ////////////////////////////////////////////////////////////////////////////
2687
2688 .literal xml
2689 <!-- === Start of command line options === -->
2690 .literal off
2691
2692
2693 .vlist
2694 .vitem &%--%&
2695 .oindex "--"
2696 .cindex "options" "command line; terminating"
2697 This is a pseudo-option whose only purpose is to terminate the options and
2698 therefore to cause subsequent command line items to be treated as arguments
2699 rather than options, even if they begin with hyphens.
2700
2701 .vitem &%--help%&
2702 .oindex "&%--help%&"
2703 This option causes Exim to output a few sentences stating what it is.
2704 The same output is generated if the Exim binary is called with no options and
2705 no arguments.
2706
2707 .vitem &%--version%&
2708 .oindex "&%--version%&"
2709 This option is an alias for &%-bV%& and causes version information to be
2710 displayed.
2711
2712 .vitem &%-Ac%& &&&
2713        &%-Am%&
2714 .oindex "&%-Ac%&"
2715 .oindex "&%-Am%&"
2716 These options are used by Sendmail for selecting configuration files and are
2717 ignored by Exim.
2718
2719 .vitem &%-B%&<&'type'&>
2720 .oindex "&%-B%&"
2721 .cindex "8-bit characters"
2722 .cindex "Sendmail compatibility" "8-bit characters"
2723 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2724 clean; it ignores this option.
2725
2726 .vitem &%-bd%&
2727 .oindex "&%-bd%&"
2728 .cindex "daemon"
2729 .cindex "SMTP" "listener"
2730 .cindex "queue runner"
2731 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2732 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2733 that the daemon should also initiate periodic queue runs.
2734
2735 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2736 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2737 disconnect from the controlling terminal. When running this way, it can be
2738 stopped by pressing ctrl-C.
2739
2740 By default, Exim listens for incoming connections to the standard SMTP port on
2741 all the host's running interfaces. However, it is possible to listen on other
2742 ports, on multiple ports, and only on specific interfaces. Chapter
2743 &<<CHAPinterfaces>>& contains a description of the options that control this.
2744
2745 When a listening daemon
2746 .cindex "daemon" "process id (pid)"
2747 .cindex "pid (process id)" "of daemon"
2748 is started without the use of &%-oX%& (that is, without overriding the normal
2749 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2750 in Exim's spool directory. This location can be overridden by setting
2751 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2752 running as root.
2753
2754 When &%-oX%& is used on the command line to start a listening daemon, the
2755 process id is not written to the normal pid file path. However, &%-oP%& can be
2756 used to specify a path on the command line if a pid file is required.
2757
2758 The SIGHUP signal
2759 .cindex "SIGHUP"
2760 .cindex "daemon" "restarting"
2761 can be used to cause the daemon to re-execute itself. This should be done
2762 whenever Exim's configuration file, or any file that is incorporated into it by
2763 means of the &%.include%& facility, is changed, and also whenever a new version
2764 of Exim is installed. It is not necessary to do this when other files that are
2765 referenced from the configuration (for example, alias files) are changed,
2766 because these are reread each time they are used.
2767
2768 .vitem &%-bdf%&
2769 .oindex "&%-bdf%&"
2770 This option has the same effect as &%-bd%& except that it never disconnects
2771 from the controlling terminal, even when no debugging is specified.
2772
2773 .vitem &%-be%&
2774 .oindex "&%-be%&"
2775 .cindex "testing" "string expansion"
2776 .cindex "expansion" "testing"
2777 Run Exim in expansion testing mode. Exim discards its root privilege, to
2778 prevent ordinary users from using this mode to read otherwise inaccessible
2779 files. If no arguments are given, Exim runs interactively, prompting for lines
2780 of data. Otherwise, it processes each argument in turn.
2781
2782 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2783 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2784 used without command line arguments. If successful, it uses the &[readline()]&
2785 function, which provides extensive line-editing facilities, for reading the
2786 test data. A line history is supported.
2787
2788 Long expansion expressions can be split over several lines by using backslash
2789 continuations. As in Exim's run time configuration, white space at the start of
2790 continuation lines is ignored. Each argument or data line is passed through the
2791 string expansion mechanism, and the result is output. Variable values from the
2792 configuration file (for example, &$qualify_domain$&) are available, but no
2793 message-specific values (such as &$sender_domain$&) are set, because no message
2794 is being processed (but see &%-bem%& and &%-Mset%&).
2795
2796 &*Note*&: If you use this mechanism to test lookups, and you change the data
2797 files or databases you are using, you must exit and restart Exim before trying
2798 the same lookup again. Otherwise, because each Exim process caches the results
2799 of lookups, you will just get the same result as before.
2800
2801 .vitem &%-bem%&&~<&'filename'&>
2802 .oindex "&%-bem%&"
2803 .cindex "testing" "string expansion"
2804 .cindex "expansion" "testing"
2805 This option operates like &%-be%& except that it must be followed by the name
2806 of a file. For example:
2807 .code
2808 exim -bem /tmp/testmessage
2809 .endd
2810 The file is read as a message (as if receiving a locally-submitted non-SMTP
2811 message) before any of the test expansions are done. Thus, message-specific
2812 variables such as &$message_size$& and &$header_from:$& are available. However,
2813 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2814 recipients are read from the headers in the normal way, and are shown in the
2815 &$recipients$& variable. Note that recipients cannot be given on the command
2816 line, because further arguments are taken as strings to expand (just like
2817 &%-be%&).
2818
2819 .vitem &%-bF%&&~<&'filename'&>
2820 .oindex "&%-bF%&"
2821 .cindex "system filter" "testing"
2822 .cindex "testing" "system filter"
2823 This option is the same as &%-bf%& except that it assumes that the filter being
2824 tested is a system filter. The additional commands that are available only in
2825 system filters are recognized.
2826
2827 .vitem &%-bf%&&~<&'filename'&>
2828 .oindex "&%-bf%&"
2829 .cindex "filter" "testing"
2830 .cindex "testing" "filter file"
2831 .cindex "forward file" "testing"
2832 .cindex "testing" "forward file"
2833 .cindex "Sieve filter" "testing"
2834 This option runs Exim in user filter testing mode; the file is the filter file
2835 to be tested, and a test message must be supplied on the standard input. If
2836 there are no message-dependent tests in the filter, an empty file can be
2837 supplied.
2838
2839 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2840 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2841 filter and a user filter in the same run. For example:
2842 .code
2843 exim -bF /system/filter -bf /user/filter </test/message
2844 .endd
2845 This is helpful when the system filter adds header lines or sets filter
2846 variables that are used by the user filter.
2847
2848 If the test filter file does not begin with one of the special lines
2849 .code
2850 # Exim filter
2851 # Sieve filter
2852 .endd
2853 it is taken to be a normal &_.forward_& file, and is tested for validity under
2854 that interpretation. See sections &<<SECTitenonfilred>>& to
2855 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2856 redirection lists.
2857
2858 The result of an Exim command that uses &%-bf%&, provided no errors are
2859 detected, is a list of the actions that Exim would try to take if presented
2860 with the message for real. More details of filter testing are given in the
2861 separate document entitled &'Exim's interfaces to mail filtering'&.
2862
2863 When testing a filter file,
2864 .cindex "&""From""& line"
2865 .cindex "envelope sender"
2866 .oindex "&%-f%&" "for filter testing"
2867 the envelope sender can be set by the &%-f%& option,
2868 or by a &"From&~"& line at the start of the test message. Various parameters
2869 that would normally be taken from the envelope recipient address of the message
2870 can be set by means of additional command line options (see the next four
2871 options).
2872
2873 .vitem &%-bfd%&&~<&'domain'&>
2874 .oindex "&%-bfd%&"
2875 .vindex "&$qualify_domain$&"
2876 This sets the domain of the recipient address when a filter file is being
2877 tested by means of the &%-bf%& option. The default is the value of
2878 &$qualify_domain$&.
2879
2880 .vitem &%-bfl%&&~<&'local&~part'&>
2881 .oindex "&%-bfl%&"
2882 This sets the local part of the recipient address when a filter file is being
2883 tested by means of the &%-bf%& option. The default is the username of the
2884 process that calls Exim. A local part should be specified with any prefix or
2885 suffix stripped, because that is how it appears to the filter when a message is
2886 actually being delivered.
2887
2888 .vitem &%-bfp%&&~<&'prefix'&>
2889 .oindex "&%-bfp%&"
2890 This sets the prefix of the local part of the recipient address when a filter
2891 file is being tested by means of the &%-bf%& option. The default is an empty
2892 prefix.
2893
2894 .vitem &%-bfs%&&~<&'suffix'&>
2895 .oindex "&%-bfs%&"
2896 This sets the suffix of the local part of the recipient address when a filter
2897 file is being tested by means of the &%-bf%& option. The default is an empty
2898 suffix.
2899
2900 .vitem &%-bh%&&~<&'IP&~address'&>
2901 .oindex "&%-bh%&"
2902 .cindex "testing" "incoming SMTP"
2903 .cindex "SMTP" "testing incoming"
2904 .cindex "testing" "relay control"
2905 .cindex "relaying" "testing configuration"
2906 .cindex "policy control" "testing"
2907 .cindex "debugging" "&%-bh%& option"
2908 This option runs a fake SMTP session as if from the given IP address, using the
2909 standard input and output. The IP address may include a port number at the end,
2910 after a full stop. For example:
2911 .code
2912 exim -bh 10.9.8.7.1234
2913 exim -bh fe80::a00:20ff:fe86:a061.5678
2914 .endd
2915 When an IPv6 address is given, it is converted into canonical form. In the case
2916 of the second example above, the value of &$sender_host_address$& after
2917 conversion to the canonical form is
2918 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2919
2920 Comments as to what is going on are written to the standard error file. These
2921 include lines beginning with &"LOG"& for anything that would have been logged.
2922 This facility is provided for testing configuration options for incoming
2923 messages, to make sure they implement the required policy. For example, you can
2924 test your relay controls using &%-bh%&.
2925
2926 &*Warning 1*&:
2927 .cindex "RFC 1413"
2928 You can test features of the configuration that rely on ident (RFC 1413)
2929 information by using the &%-oMt%& option. However, Exim cannot actually perform
2930 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2931 connection.
2932
2933 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2934 are also skipped when testing using &%-bh%&. If you want these callouts to
2935 occur, use &%-bhc%& instead.
2936
2937 Messages supplied during the testing session are discarded, and nothing is
2938 written to any of the real log files. There may be pauses when DNS (and other)
2939 lookups are taking place, and of course these may time out. The &%-oMi%& option
2940 can be used to specify a specific IP interface and port if this is important,
2941 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2942 session were authenticated.
2943
2944 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2945 output just states whether a given recipient address from a given host is
2946 acceptable or not. See section &<<SECTcheckaccess>>&.
2947
2948 Features such as authentication and encryption, where the client input is not
2949 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2950 specialized SMTP test program such as
2951 &url(http://jetmore.org/john/code/#swaks,swaks).
2952
2953 .vitem &%-bhc%&&~<&'IP&~address'&>
2954 .oindex "&%-bhc%&"
2955 This option operates in the same way as &%-bh%&, except that address
2956 verification callouts are performed if required. This includes consulting and
2957 updating the callout cache database.
2958
2959 .vitem &%-bi%&
2960 .oindex "&%-bi%&"
2961 .cindex "alias file" "building"
2962 .cindex "building alias file"
2963 .cindex "Sendmail compatibility" "&%-bi%& option"
2964 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2965 Exim does not have the concept of a single alias file, and so it cannot mimic
2966 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2967 tend to appear in various scripts such as NIS make files, so the option must be
2968 recognized.
2969
2970 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2971 configuration option is run, under the uid and gid of the caller of Exim. If
2972 the &%-oA%& option is used, its value is passed to the command as an argument.
2973 The command set by &%bi_command%& may not contain arguments. The command can
2974 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2975 if this is required. If the &%bi_command%& option is not set, calling Exim with
2976 &%-bi%& is a no-op.
2977
2978 . // Keep :help first, then the rest in alphabetical order
2979 .vitem &%-bI:help%&
2980 .oindex "&%-bI:help%&"
2981 .cindex "querying exim information"
2982 We shall provide various options starting &`-bI:`& for querying Exim for
2983 information.  The output of many of these will be intended for machine
2984 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2985 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2986 options shall cause Exim to exit after producing the requested output.
2987
2988 .vitem &%-bI:dscp%&
2989 .oindex "&%-bI:dscp%&"
2990 .cindex "DSCP" "values"
2991 This option causes Exim to emit an alphabetically sorted list of all
2992 recognised DSCP names.
2993
2994 .vitem &%-bI:sieve%&
2995 .oindex "&%-bI:sieve%&"
2996 .cindex "Sieve filter" "capabilities"
2997 This option causes Exim to emit an alphabetically sorted list of all supported
2998 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2999 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3000 &`SIEVE`& capability response line.  As the precise list may depend upon
3001 compile-time build options, which this option will adapt to, this is the only
3002 way to guarantee a correct response.
3003
3004 .vitem &%-bm%&
3005 .oindex "&%-bm%&"
3006 .cindex "local message reception"
3007 This option runs an Exim receiving process that accepts an incoming,
3008 locally-generated message on the standard input. The recipients are given as the
3009 command arguments (except when &%-t%& is also present &-- see below). Each
3010 argument can be a comma-separated list of RFC 2822 addresses. This is the
3011 default option for selecting the overall action of an Exim call; it is assumed
3012 if no other conflicting option is present.
3013
3014 If any addresses in the message are unqualified (have no domain), they are
3015 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3016 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3017 suppressing this for special cases.
3018
3019 Policy checks on the contents of local messages can be enforced by means of
3020 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3021
3022 .cindex "return code" "for &%-bm%&"
3023 The return code is zero if the message is successfully accepted. Otherwise, the
3024 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3025
3026 The format
3027 .cindex "message" "format"
3028 .cindex "format" "message"
3029 .cindex "&""From""& line"
3030 .cindex "UUCP" "&""From""& line"
3031 .cindex "Sendmail compatibility" "&""From""& line"
3032 of the message must be as defined in RFC 2822, except that, for
3033 compatibility with Sendmail and Smail, a line in one of the forms
3034 .code
3035 From sender Fri Jan  5 12:55 GMT 1997
3036 From sender Fri, 5 Jan 97 12:55:01
3037 .endd
3038 (with the weekday optional, and possibly with additional text after the date)
3039 is permitted to appear at the start of the message. There appears to be no
3040 authoritative specification of the format of this line. Exim recognizes it by
3041 matching against the regular expression defined by the &%uucp_from_pattern%&
3042 option, which can be changed if necessary.
3043
3044 .oindex "&%-f%&" "overriding &""From""& line"
3045 The specified sender is treated as if it were given as the argument to the
3046 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3047 preference to the address taken from the message. The caller of Exim must be a
3048 trusted user for the sender of a message to be set in this way.
3049
3050 .vitem &%-bmalware%&&~<&'filename'&>
3051 .oindex "&%-bmalware%&"
3052 .cindex "testing", "malware"
3053 .cindex "malware scan test"
3054 This debugging option causes Exim to scan the given file,
3055 using the malware scanning framework.  The option of &%av_scanner%& influences
3056 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3057 the expansion should have defaults which apply to this invocation.  ACLs are
3058 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3059 will never be populated and &%-bmalware%& will fail.
3060
3061 Exim will have changed working directory before resolving the filename, so
3062 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3063 user when it tries to open the file, rather than as the invoking user.
3064 This option requires admin privileges.
3065
3066 The &%-bmalware%& option will not be extended to be more generally useful,
3067 there are better tools for file-scanning.  This option exists to help
3068 administrators verify their Exim and AV scanner configuration.
3069
3070 .vitem &%-bnq%&
3071 .oindex "&%-bnq%&"
3072 .cindex "address qualification, suppressing"
3073 By default, Exim automatically qualifies unqualified addresses (those
3074 without domains) that appear in messages that are submitted locally (that
3075 is, not over TCP/IP). This qualification applies both to addresses in
3076 envelopes, and addresses in header lines. Sender addresses are qualified using
3077 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3078 defaults to the value of &%qualify_domain%&).
3079
3080 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3081 being used to re-submit messages that originally came from remote hosts after
3082 content scanning, you probably do not want to qualify unqualified addresses in
3083 header lines. (Such lines will be present only if you have not enabled a header
3084 syntax check in the appropriate ACL.)
3085
3086 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3087 messages that originate on the local host. When this is used, unqualified
3088 addresses in the envelope provoke errors (causing message rejection) and
3089 unqualified addresses in header lines are left alone.
3090
3091
3092 .vitem &%-bP%&
3093 .oindex "&%-bP%&"
3094 .cindex "configuration options" "extracting"
3095 .cindex "options" "configuration &-- extracting"
3096 If this option is given with no arguments, it causes the values of all Exim's
3097 main configuration options to be written to the standard output. The values
3098 of one or more specific options can be requested by giving their names as
3099 arguments, for example:
3100 .code
3101 exim -bP qualify_domain hold_domains
3102 .endd
3103 .cindex "hiding configuration option values"
3104 .cindex "configuration options" "hiding value of"
3105 .cindex "options" "hiding value of"
3106 However, any option setting that is preceded by the word &"hide"& in the
3107 configuration file is not shown in full, except to an admin user. For other
3108 users, the output is as in this example:
3109 .code
3110 mysql_servers = <value not displayable>
3111 .endd
3112 If &%configure_file%& is given as an argument, the name of the run time
3113 configuration file is output.
3114 If a list of configuration files was supplied, the value that is output here
3115 is the name of the file that was actually used.
3116
3117 .cindex "options" "hiding name of"
3118 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3119 name will not be output.
3120
3121 .cindex "daemon" "process id (pid)"
3122 .cindex "pid (process id)" "of daemon"
3123 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3124 directories where log files and daemon pid files are written are output,
3125 respectively. If these values are unset, log files are written in a
3126 sub-directory of the spool directory called &%log%&, and the pid file is
3127 written directly into the spool directory.
3128
3129 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3130 .code
3131 exim -bP +local_domains
3132 .endd
3133 it searches for a matching named list of any type (domain, host, address, or
3134 local part) and outputs what it finds.
3135
3136 .cindex "options" "router &-- extracting"
3137 .cindex "options" "transport &-- extracting"
3138 .cindex "options" "authenticator &-- extracting"
3139 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3140 followed by the name of an appropriate driver instance, the option settings for
3141 that driver are output. For example:
3142 .code
3143 exim -bP transport local_delivery
3144 .endd
3145 The generic driver options are output first, followed by the driver's private
3146 options. A list of the names of drivers of a particular type can be obtained by
3147 using one of the words &%router_list%&, &%transport_list%&, or
3148 &%authenticator_list%&, and a complete list of all drivers with their option
3149 settings can be obtained by using &%routers%&, &%transports%&, or
3150 &%authenticators%&.
3151
3152 .cindex "options" "macro &-- extracting"
3153 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3154 are available, similarly to the drivers.  Because macros are sometimes used
3155 for storing passwords, this option is restricted.
3156 The output format is one item per line.
3157
3158 .vitem &%-bp%&
3159 .oindex "&%-bp%&"
3160 .cindex "queue" "listing messages on"
3161 .cindex "listing" "messages on the queue"
3162 This option requests a listing of the contents of the mail queue on the
3163 standard output. If the &%-bp%& option is followed by a list of message ids,
3164 just those messages are listed. By default, this option can be used only by an
3165 admin user. However, the &%queue_list_requires_admin%& option can be set false
3166 to allow any user to see the queue.
3167
3168 Each message on the queue is displayed as in the following example:
3169 .code
3170 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3171           red.king@looking-glass.fict.example
3172           <other addresses>
3173 .endd
3174 .cindex "message" "size in queue listing"
3175 .cindex "size" "of message"
3176 The first line contains the length of time the message has been on the queue
3177 (in this case 25 minutes), the size of the message (2.9K), the unique local
3178 identifier for the message, and the message sender, as contained in the
3179 envelope. For bounce messages, the sender address is empty, and appears as
3180 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3181 the default sender address, the user's login name is shown in parentheses
3182 before the sender address.
3183
3184 .cindex "frozen messages" "in queue listing"
3185 If the message is frozen (attempts to deliver it are suspended) then the text
3186 &"*** frozen ***"& is displayed at the end of this line.
3187
3188 The recipients of the message (taken from the envelope, not the headers) are
3189 displayed on subsequent lines. Those addresses to which the message has already
3190 been delivered are marked with the letter D. If an original address gets
3191 expanded into several addresses via an alias or forward file, the original is
3192 displayed with a D only when deliveries for all of its child addresses are
3193 complete.
3194
3195
3196 .vitem &%-bpa%&
3197 .oindex "&%-bpa%&"
3198 This option operates like &%-bp%&, but in addition it shows delivered addresses
3199 that were generated from the original top level address(es) in each message by
3200 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3201 of just &"D"&.
3202
3203
3204 .vitem &%-bpc%&
3205 .oindex "&%-bpc%&"
3206 .cindex "queue" "count of messages on"
3207 This option counts the number of messages on the queue, and writes the total
3208 to the standard output. It is restricted to admin users, unless
3209 &%queue_list_requires_admin%& is set false.
3210
3211
3212 .vitem &%-bpr%&
3213 .oindex "&%-bpr%&"
3214 This option operates like &%-bp%&, but the output is not sorted into
3215 chronological order of message arrival. This can speed it up when there are
3216 lots of messages on the queue, and is particularly useful if the output is
3217 going to be post-processed in a way that doesn't need the sorting.
3218
3219 .vitem &%-bpra%&
3220 .oindex "&%-bpra%&"
3221 This option is a combination of &%-bpr%& and &%-bpa%&.
3222
3223 .vitem &%-bpru%&
3224 .oindex "&%-bpru%&"
3225 This option is a combination of &%-bpr%& and &%-bpu%&.
3226
3227
3228 .vitem &%-bpu%&
3229 .oindex "&%-bpu%&"
3230 This option operates like &%-bp%& but shows only undelivered top-level
3231 addresses for each message displayed. Addresses generated by aliasing or
3232 forwarding are not shown, unless the message was deferred after processing by a
3233 router with the &%one_time%& option set.
3234
3235
3236 .vitem &%-brt%&
3237 .oindex "&%-brt%&"
3238 .cindex "testing" "retry configuration"
3239 .cindex "retry" "configuration testing"
3240 This option is for testing retry rules, and it must be followed by up to three
3241 arguments. It causes Exim to look for a retry rule that matches the values
3242 and to write it to the standard output. For example:
3243 .code
3244 exim -brt bach.comp.mus.example
3245 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3246 .endd
3247 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3248 argument, which is required, can be a complete address in the form
3249 &'local_part@domain'&, or it can be just a domain name. If the second argument
3250 contains a dot, it is interpreted as an optional second domain name; if no
3251 retry rule is found for the first argument, the second is tried. This ties in
3252 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3253 rule is found that matches the host, one that matches the mail domain is
3254 sought. Finally, an argument that is the name of a specific delivery error, as
3255 used in setting up retry rules, can be given. For example:
3256 .code
3257 exim -brt haydn.comp.mus.example quota_3d
3258 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3259 .endd
3260
3261 .vitem &%-brw%&
3262 .oindex "&%-brw%&"
3263 .cindex "testing" "rewriting"
3264 .cindex "rewriting" "testing"
3265 This option is for testing address rewriting rules, and it must be followed by
3266 a single argument, consisting of either a local part without a domain, or a
3267 complete address with a fully qualified domain. Exim outputs how this address
3268 would be rewritten for each possible place it might appear. See chapter
3269 &<<CHAPrewrite>>& for further details.
3270
3271 .vitem &%-bS%&
3272 .oindex "&%-bS%&"
3273 .cindex "SMTP" "batched incoming"
3274 .cindex "batched SMTP input"
3275 This option is used for batched SMTP input, which is an alternative interface
3276 for non-interactive local message submission. A number of messages can be
3277 submitted in a single run. However, despite its name, this is not really SMTP
3278 input. Exim reads each message's envelope from SMTP commands on the standard
3279 input, but generates no responses. If the caller is trusted, or
3280 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3281 believed; otherwise the sender is always the caller of Exim.
3282
3283 The message itself is read from the standard input, in SMTP format (leading
3284 dots doubled), terminated by a line containing just a single dot. An error is
3285 provoked if the terminating dot is missing. A further message may then follow.
3286
3287 As for other local message submissions, the contents of incoming batch SMTP
3288 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3289 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3290 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3291
3292 Some other SMTP commands are recognized in the input. HELO and EHLO act
3293 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3294 QUIT quits, ignoring the rest of the standard input.
3295
3296 .cindex "return code" "for &%-bS%&"
3297 If any error is encountered, reports are written to the standard output and
3298 error streams, and Exim gives up immediately. The return code is 0 if no error
3299 was detected; it is 1 if one or more messages were accepted before the error
3300 was detected; otherwise it is 2.
3301
3302 More details of input using batched SMTP are given in section
3303 &<<SECTincomingbatchedSMTP>>&.
3304
3305 .vitem &%-bs%&
3306 .oindex "&%-bs%&"
3307 .cindex "SMTP" "local input"
3308 .cindex "local SMTP input"
3309 This option causes Exim to accept one or more messages by reading SMTP commands
3310 on the standard input, and producing SMTP replies on the standard output. SMTP
3311 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3312 Some user agents use this interface as a way of passing locally-generated
3313 messages to the MTA.
3314
3315 In
3316 .cindex "sender" "source of"
3317 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3318 set, the senders of messages are taken from the SMTP MAIL commands.
3319 Otherwise the content of these commands is ignored and the sender is set up as
3320 the calling user. Unqualified addresses are automatically qualified using
3321 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3322 &%-bnq%& option is used.
3323
3324 .cindex "inetd"
3325 The
3326 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3327 using a listening daemon. Exim can distinguish the two cases by checking
3328 whether the standard input is a TCP/IP socket. When Exim is called from
3329 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3330 above concerning senders and qualification do not apply. In this situation,
3331 Exim behaves in exactly the same way as it does when receiving a message via
3332 the listening daemon.
3333
3334 .vitem &%-bt%&
3335 .oindex "&%-bt%&"
3336 .cindex "testing" "addresses"
3337 .cindex "address" "testing"
3338 This option runs Exim in address testing mode, in which each argument is taken
3339 as a recipient address to be tested for deliverability. The results are
3340 written to the standard output. If a test fails, and the caller is not an admin
3341 user, no details of the failure are output, because these might contain
3342 sensitive information such as usernames and passwords for database lookups.
3343
3344 If no arguments are given, Exim runs in an interactive manner, prompting with a
3345 right angle bracket for addresses to be tested.
3346
3347 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3348 &[readline()]& function, because it is running as &'root'& and there are
3349 security issues.
3350
3351 Each address is handled as if it were the recipient address of a message
3352 (compare the &%-bv%& option). It is passed to the routers and the result is
3353 written to the standard output. However, any router that has
3354 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3355 genuine routing tests if your first router passes everything to a scanner
3356 program.
3357
3358 .cindex "return code" "for &%-bt%&"
3359 The return code is 2 if any address failed outright; it is 1 if no address
3360 failed outright but at least one could not be resolved for some reason. Return
3361 code 0 is given only when all addresses succeed.
3362
3363 .cindex "duplicate addresses"
3364 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3365 addresses after routing is complete, so that only one delivery takes place.
3366 This does not happen when testing with &%-bt%&; the full results of routing are
3367 always shown.
3368
3369 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3370 routers in the configuration makes any tests on the sender address of a
3371 message,
3372 .oindex "&%-f%&" "for address testing"
3373 you can use the &%-f%& option to set an appropriate sender when running
3374 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3375 default qualifying domain. However, if you have set up (for example) routers
3376 whose behaviour depends on the contents of an incoming message, you cannot test
3377 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3378 doing such tests.
3379
3380 .vitem &%-bV%&
3381 .oindex "&%-bV%&"
3382 .cindex "version number of Exim"
3383 This option causes Exim to write the current version number, compilation
3384 number, and compilation date of the &'exim'& binary to the standard output.
3385 It also lists the DBM library that is being used, the optional modules (such as
3386 specific lookup types), the drivers that are included in the binary, and the
3387 name of the run time configuration file that is in use.
3388
3389 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3390 configuration file. However, this is a static check only. It cannot check
3391 values that are to be expanded. For example, although a misspelt ACL verb is
3392 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3393 alone to discover (for example) all the typos in the configuration; some
3394 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3395 dynamic testing facilities.
3396
3397 .vitem &%-bv%&
3398 .oindex "&%-bv%&"
3399 .cindex "verifying address" "using &%-bv%&"
3400 .cindex "address" "verification"
3401 This option runs Exim in address verification mode, in which each argument is
3402 taken as a recipient address to be verified by the routers. (This does
3403 not involve any verification callouts). During normal operation, verification
3404 happens mostly as a consequence processing a &%verify%& condition in an ACL
3405 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3406 including callouts, see the &%-bh%& and &%-bhc%& options.
3407
3408 If verification fails, and the caller is not an admin user, no details of the
3409 failure are output, because these might contain sensitive information such as
3410 usernames and passwords for database lookups.
3411
3412 If no arguments are given, Exim runs in an interactive manner, prompting with a
3413 right angle bracket for addresses to be verified.
3414
3415 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3416 &[readline()]& function, because it is running as &'exim'& and there are
3417 security issues.
3418
3419 Verification differs from address testing (the &%-bt%& option) in that routers
3420 that have &%no_verify%& set are skipped, and if the address is accepted by a
3421 router that has &%fail_verify%& set, verification fails. The address is
3422 verified as a recipient if &%-bv%& is used; to test verification for a sender
3423 address, &%-bvs%& should be used.
3424
3425 If the &%-v%& option is not set, the output consists of a single line for each
3426 address, stating whether it was verified or not, and giving a reason in the
3427 latter case. Without &%-v%&, generating more than one address by redirection
3428 causes verification to end successfully, without considering the generated
3429 addresses. However, if just one address is generated, processing continues,
3430 and the generated address must verify successfully for the overall verification
3431 to succeed.
3432
3433 When &%-v%& is set, more details are given of how the address has been handled,
3434 and in the case of address redirection, all the generated addresses are also
3435 considered. Verification may succeed for some and fail for others.
3436
3437 The
3438 .cindex "return code" "for &%-bv%&"
3439 return code is 2 if any address failed outright; it is 1 if no address
3440 failed outright but at least one could not be resolved for some reason. Return
3441 code 0 is given only when all addresses succeed.
3442
3443 If any of the routers in the configuration makes any tests on the sender
3444 address of a message, you should use the &%-f%& option to set an appropriate
3445 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3446 calling user at the default qualifying domain.
3447
3448 .vitem &%-bvs%&
3449 .oindex "&%-bvs%&"
3450 This option acts like &%-bv%&, but verifies the address as a sender rather
3451 than a recipient address. This affects any rewriting and qualification that
3452 might happen.
3453
3454 .vitem &%-bw%&
3455 .oindex "&%-bw%&"
3456 .cindex "daemon"
3457 .cindex "inetd"
3458 .cindex "inetd" "wait mode"
3459 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3460 similarly to the &%-bd%& option.  All port specifications on the command-line
3461 and in the configuration file are ignored.  Queue-running may not be specified.
3462
3463 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3464 listening for connections.  This permits the system to start up and have
3465 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3466 each port only when the first connection is received.
3467
3468 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3469 which the daemon will exit, which should cause inetd to listen once more.
3470
3471 .vitem &%-C%&&~<&'filelist'&>
3472 .oindex "&%-C%&"
3473 .cindex "configuration file" "alternate"
3474 .cindex "CONFIGURE_FILE"
3475 .cindex "alternate configuration file"
3476 This option causes Exim to find the run time configuration file from the given
3477 list instead of from the list specified by the CONFIGURE_FILE
3478 compile-time setting. Usually, the list will consist of just a single file
3479 name, but it can be a colon-separated list of names. In this case, the first
3480 file that exists is used. Failure to open an existing file stops Exim from
3481 proceeding any further along the list, and an error is generated.
3482
3483 When this option is used by a caller other than root, and the list is different
3484 from the compiled-in list, Exim gives up its root privilege immediately, and
3485 runs with the real and effective uid and gid set to those of the caller.
3486 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3487 file contains a list of full pathnames, one per line, for configuration files
3488 which are trusted. Root privilege is retained for any configuration file so
3489 listed, as long as the caller is the Exim user (or the user specified in the
3490 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3491 not writeable by inappropriate users or groups.
3492
3493 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3494 configuration using &%-C%& right through message reception and delivery,
3495 even if the caller is root. The reception works, but by that time, Exim is
3496 running as the Exim user, so when it re-executes to regain privilege for the
3497 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3498 test reception and delivery using two separate commands (one to put a message
3499 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3500
3501 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3502 prefix string with which any file named in a &%-C%& command line option
3503 must start. In addition, the file name must not contain the sequence &`/../`&.
3504 However, if the value of the &%-C%& option is identical to the value of
3505 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3506 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3507 unset, any file name can be used with &%-C%&.
3508
3509 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3510 to a directory to which only root has access. This prevents someone who has
3511 broken into the Exim account from running a privileged Exim with an arbitrary
3512 configuration file.
3513
3514 The &%-C%& facility is useful for ensuring that configuration files are
3515 syntactically correct, but cannot be used for test deliveries, unless the
3516 caller is privileged, or unless it is an exotic configuration that does not
3517 require privilege. No check is made on the owner or group of the files
3518 specified by this option.
3519
3520
3521 .vitem &%-D%&<&'macro'&>=<&'value'&>
3522 .oindex "&%-D%&"
3523 .cindex "macro" "setting on command line"
3524 This option can be used to override macro definitions in the configuration file
3525 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3526 unprivileged caller, it causes Exim to give up its root privilege.
3527 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3528 completely disabled, and its use causes an immediate error exit.
3529
3530 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3531 colon-separated list of macros which are considered safe and, if &%-D%& only
3532 supplies macros from this list, and the values are acceptable, then Exim will
3533 not give up root privilege if the caller is root, the Exim run-time user, or
3534 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3535 to be removed in the future.  Acceptable values for the macros satisfy the
3536 regexp: &`^[A-Za-z0-9_/.-]*$`&
3537
3538 The entire option (including equals sign if present) must all be within one
3539 command line item. &%-D%& can be used to set the value of a macro to the empty
3540 string, in which case the equals sign is optional. These two commands are
3541 synonymous:
3542 .code
3543 exim -DABC  ...
3544 exim -DABC= ...
3545 .endd
3546 To include spaces in a macro definition item, quotes must be used. If you use
3547 quotes, spaces are permitted around the macro name and the equals sign. For
3548 example:
3549 .code
3550 exim '-D ABC = something' ...
3551 .endd
3552 &%-D%& may be repeated up to 10 times on a command line.
3553
3554
3555 .vitem &%-d%&<&'debug&~options'&>
3556 .oindex "&%-d%&"
3557 .cindex "debugging" "list of selectors"
3558 .cindex "debugging" "&%-d%& option"
3559 This option causes debugging information to be written to the standard
3560 error stream. It is restricted to admin users because debugging output may show
3561 database queries that contain password information. Also, the details of users'
3562 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3563 writes an error message to the standard error stream and exits with a non-zero
3564 return code.
3565
3566 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3567 standard debugging data is output. This can be reduced, or increased to include
3568 some more rarely needed information, by directly following &%-d%& with a string
3569 made up of names preceded by plus or minus characters. These add or remove sets
3570 of debugging data, respectively. For example, &%-d+filter%& adds filter
3571 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3572 no spaces are allowed in the debug setting. The available debugging categories
3573 are:
3574 .display
3575 &`acl            `& ACL interpretation
3576 &`auth           `& authenticators
3577 &`deliver        `& general delivery logic
3578 &`dns            `& DNS lookups (see also resolver)
3579 &`dnsbl          `& DNS black list (aka RBL) code
3580 &`exec           `& arguments for &[execv()]& calls
3581 &`expand         `& detailed debugging for string expansions
3582 &`filter         `& filter handling
3583 &`hints_lookup   `& hints data lookups
3584 &`host_lookup    `& all types of name-to-IP address handling
3585 &`ident          `& ident lookup
3586 &`interface      `& lists of local interfaces
3587 &`lists          `& matching things in lists
3588 &`load           `& system load checks
3589 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3590                     &<<CHAPlocalscan>>&)
3591 &`lookup         `& general lookup code and all lookups
3592 &`memory         `& memory handling
3593 &`pid            `& add pid to debug output lines
3594 &`process_info   `& setting info for the process log
3595 &`queue_run      `& queue runs
3596 &`receive        `& general message reception logic
3597 &`resolver       `& turn on the DNS resolver's debugging output
3598 &`retry          `& retry handling
3599 &`rewrite        `& address rewriting
3600 &`route          `& address routing
3601 &`timestamp      `& add timestamp to debug output lines
3602 &`tls            `& TLS logic
3603 &`transport      `& transports
3604 &`uid            `& changes of uid/gid and looking up uid/gid
3605 &`verify         `& address verification logic
3606 &`all            `& almost all of the above (see below), and also &%-v%&
3607 .endd
3608 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3609 for &`-all`&. The reason for this is that &`+all`& is something that people
3610 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3611 is included, an awful lot of output that is very rarely of interest is
3612 generated, so it now has to be explicitly requested. However, &`-all`& does
3613 turn everything off.
3614
3615 .cindex "resolver, debugging output"
3616 .cindex "DNS resolver, debugging output"
3617 The &`resolver`& option produces output only if the DNS resolver was compiled
3618 with DEBUG enabled. This is not the case in some operating systems. Also,
3619 unfortunately, debugging output from the DNS resolver is written to stdout
3620 rather than stderr.
3621
3622 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3623 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3624 However, the &`pid`& selector is forced when debugging is turned on for a
3625 daemon, which then passes it on to any re-executed Exims. Exim also
3626 automatically adds the pid to debug lines when several remote deliveries are
3627 run in parallel.
3628
3629 The &`timestamp`& selector causes the current time to be inserted at the start
3630 of all debug output lines. This can be useful when trying to track down delays
3631 in processing.
3632
3633 If the &%debug_print%& option is set in any driver, it produces output whenever
3634 any debugging is selected, or if &%-v%& is used.
3635
3636 .vitem &%-dd%&<&'debug&~options'&>
3637 .oindex "&%-dd%&"
3638 This option behaves exactly like &%-d%& except when used on a command that
3639 starts a daemon process. In that case, debugging is turned off for the
3640 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3641 behaviour of the daemon without creating as much output as full debugging does.
3642
3643 .vitem &%-dropcr%&
3644 .oindex "&%-dropcr%&"
3645 This is an obsolete option that is now a no-op. It used to affect the way Exim
3646 handled CR and LF characters in incoming messages. What happens now is
3647 described in section &<<SECTlineendings>>&.
3648
3649 .vitem &%-E%&
3650 .oindex "&%-E%&"
3651 .cindex "bounce message" "generating"
3652 This option specifies that an incoming message is a locally-generated delivery
3653 failure report. It is used internally by Exim when handling delivery failures
3654 and is not intended for external use. Its only effect is to stop Exim
3655 generating certain messages to the postmaster, as otherwise message cascades
3656 could occur in some situations. As part of the same option, a message id may
3657 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3658 new message contains the id, following &"R="&, as a cross-reference.
3659
3660 .vitem &%-e%&&'x'&
3661 .oindex "&%-e%&&'x'&"
3662 There are a number of Sendmail options starting with &%-oe%& which seem to be
3663 called by various programs without the leading &%o%& in the option. For
3664 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3665 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3666
3667 .vitem &%-F%&&~<&'string'&>
3668 .oindex "&%-F%&"
3669 .cindex "sender" "name"
3670 .cindex "name" "of sender"
3671 This option sets the sender's full name for use when a locally-generated
3672 message is being accepted. In the absence of this option, the user's &'gecos'&
3673 entry from the password data is used. As users are generally permitted to alter
3674 their &'gecos'& entries, no security considerations are involved. White space
3675 between &%-F%& and the <&'string'&> is optional.
3676
3677 .vitem &%-f%&&~<&'address'&>
3678 .oindex "&%-f%&"
3679 .cindex "sender" "address"
3680 .cindex "address" "sender"
3681 .cindex "trusted users"
3682 .cindex "envelope sender"
3683 .cindex "user" "trusted"
3684 This option sets the address of the envelope sender of a locally-generated
3685 message (also known as the return path). The option can normally be used only
3686 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3687 users to use it.
3688
3689 Processes running as root or the Exim user are always trusted. Other
3690 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3691 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3692 of a local message is set to the caller's login name at the default qualify
3693 domain.
3694
3695 There is one exception to the restriction on the use of &%-f%&: an empty sender
3696 can be specified by any user, trusted or not, to create a message that can
3697 never provoke a bounce. An empty sender can be specified either as an empty
3698 string, or as a pair of angle brackets with nothing between them, as in these
3699 examples of shell commands:
3700 .code
3701 exim -f '<>' user@domain
3702 exim -f "" user@domain
3703 .endd
3704 In addition, the use of &%-f%& is not restricted when testing a filter file
3705 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3706 &%-bv%& options.
3707
3708 Allowing untrusted users to change the sender address does not of itself make
3709 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3710 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3711 though this can be overridden by setting &%no_local_from_check%&.
3712
3713 White
3714 .cindex "&""From""& line"
3715 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3716 given as two arguments or one combined argument). The sender of a
3717 locally-generated message can also be set (when permitted) by an initial
3718 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3719 if &%-f%& is also present, it overrides &"From&~"&.
3720
3721 .vitem &%-G%&
3722 .oindex "&%-G%&"
3723 .cindex "submission fixups, suppressing (command-line)"
3724 This option is equivalent to an ACL applying:
3725 .code
3726 control = suppress_local_fixups
3727 .endd
3728 for every message received.  Note that Sendmail will complain about such
3729 bad formatting, where Exim silently just does not fix it up.  This may change
3730 in future.
3731
3732 As this affects audit information, the caller must be a trusted user to use
3733 this option.
3734
3735 .vitem &%-h%&&~<&'number'&>
3736 .oindex "&%-h%&"
3737 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3738 This option is accepted for compatibility with Sendmail, but has no effect. (In
3739 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3740 headers.)
3741
3742 .vitem &%-i%&
3743 .oindex "&%-i%&"
3744 .cindex "Solaris" "&'mail'& command"
3745 .cindex "dot" "in incoming non-SMTP message"
3746 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3747 line by itself should not terminate an incoming, non-SMTP message. I can find
3748 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3749 command in Solaris 2.4 uses it. See also &%-ti%&.
3750
3751 .vitem &%-L%&&~<&'tag'&>
3752 .oindex "&%-L%&"
3753 .cindex "syslog" "process name; set with flag"
3754 This option is equivalent to setting &%syslog_processname%& in the config
3755 file and setting &%log_file_path%& to &`syslog`&.
3756 Its use is restricted to administrators.  The configuration file has to be
3757 read and parsed, to determine access rights, before this is set and takes
3758 effect, so early configuration file errors will not honour this flag.
3759
3760 The tag should not be longer than 32 characters.
3761
3762 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3763 .oindex "&%-M%&"
3764 .cindex "forcing delivery"
3765 .cindex "delivery" "forcing attempt"
3766 .cindex "frozen messages" "forcing delivery"
3767 This option requests Exim to run a delivery attempt on each message in turn. If
3768 any of the messages are frozen, they are automatically thawed before the
3769 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3770 and &%hold_domains%& are ignored.
3771
3772 Retry
3773 .cindex "hints database" "overriding retry hints"
3774 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3775 the normal retry time has not yet been reached. This option requires the caller
3776 to be an admin user. However, there is an option called &%prod_requires_admin%&
3777 which can be set false to relax this restriction (and also the same requirement
3778 for the &%-q%&, &%-R%&, and &%-S%& options).
3779
3780 The deliveries happen synchronously, that is, the original Exim process does
3781 not terminate until all the delivery attempts have finished. No output is
3782 produced unless there is a serious error. If you want to see what is happening,
3783 use the &%-v%& option as well, or inspect Exim's main log.
3784
3785 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3786 .oindex "&%-Mar%&"
3787 .cindex "message" "adding recipients"
3788 .cindex "recipient" "adding"
3789 This option requests Exim to add the addresses to the list of recipients of the
3790 message (&"ar"& for &"add recipients"&). The first argument must be a message
3791 id, and the remaining ones must be email addresses. However, if the message is
3792 active (in the middle of a delivery attempt), it is not altered. This option
3793 can be used only by an admin user.
3794
3795 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3796         &~<&'message&~id'&>"
3797 .oindex "&%-MC%&"
3798 .cindex "SMTP" "passed connection"
3799 .cindex "SMTP" "multiple deliveries"
3800 .cindex "multiple SMTP deliveries"
3801 This option is not intended for use by external callers. It is used internally
3802 by Exim to invoke another instance of itself to deliver a waiting message using
3803 an existing SMTP connection, which is passed as the standard input. Details are
3804 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3805 must be root or the Exim user in order to use it.
3806
3807 .vitem &%-MCA%&
3808 .oindex "&%-MCA%&"
3809 This option is not intended for use by external callers. It is used internally
3810 by Exim in conjunction with the &%-MC%& option. It signifies that the
3811 connection to the remote host has been authenticated.
3812
3813 .new
3814 .vitem &%-MCD%&
3815 .oindex "&%-MCD%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option. It signifies that the
3818 remote host supports the ESMTP &_DSN_& extension.
3819 .wen
3820
3821 .vitem &%-MCP%&
3822 .oindex "&%-MCP%&"
3823 This option is not intended for use by external callers. It is used internally
3824 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3825 which Exim is connected supports pipelining.
3826
3827 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3828 .oindex "&%-MCQ%&"
3829 This option is not intended for use by external callers. It is used internally
3830 by Exim in conjunction with the &%-MC%& option when the original delivery was
3831 started by a queue runner. It passes on the process id of the queue runner,
3832 together with the file descriptor number of an open pipe. Closure of the pipe
3833 signals the final completion of the sequence of processes that are passing
3834 messages through the same SMTP connection.
3835
3836 .vitem &%-MCS%&
3837 .oindex "&%-MCS%&"
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 SMTP SIZE option should be used on messages delivered down the existing
3841 connection.
3842
3843 .vitem &%-MCT%&
3844 .oindex "&%-MCT%&"
3845 This option is not intended for use by external callers. It is used internally
3846 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3847 host to which Exim is connected supports TLS encryption.
3848
3849 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3850 .oindex "&%-Mc%&"
3851 .cindex "hints database" "not overridden by &%-Mc%&"
3852 .cindex "delivery" "manually started &-- not forced"
3853 This option requests Exim to run a delivery attempt on each message in turn,
3854 but unlike the &%-M%& option, it does check for retry hints, and respects any
3855 that are found. This option is not very useful to external callers. It is
3856 provided mainly for internal use by Exim when it needs to re-invoke itself in
3857 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3858 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3859 respects retry times and other options such as &%hold_domains%& that are
3860 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3861 If you want to run a specific delivery as if in a queue run, you should use
3862 &%-q%& with a message id argument. A distinction between queue run deliveries
3863 and other deliveries is made in one or two places.
3864
3865 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3866 .oindex "&%-Mes%&"
3867 .cindex "message" "changing sender"
3868 .cindex "sender" "changing"
3869 This option requests Exim to change the sender address in the message to the
3870 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3871 &"edit sender"&). There must be exactly two arguments. The first argument must
3872 be a message id, and the second one an email address. However, if the message
3873 is active (in the middle of a delivery attempt), its status is not altered.
3874 This option can be used only by an admin user.
3875
3876 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3877 .oindex "&%-Mf%&"
3878 .cindex "freezing messages"
3879 .cindex "message" "manually freezing"
3880 This option requests Exim to mark each listed message as &"frozen"&. This
3881 prevents any delivery attempts taking place until the message is &"thawed"&,
3882 either manually or as a result of the &%auto_thaw%& configuration option.
3883 However, if any of the messages are active (in the middle of a delivery
3884 attempt), their status is not altered. This option can be used only by an admin
3885 user.
3886
3887 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3888 .oindex "&%-Mg%&"
3889 .cindex "giving up on messages"
3890 .cindex "message" "abandoning delivery attempts"
3891 .cindex "delivery" "abandoning further attempts"
3892 This option requests Exim to give up trying to deliver the listed messages,
3893 including any that are frozen. However, if any of the messages are active,
3894 their status is not altered. For non-bounce messages, a delivery error message
3895 is sent to the sender, containing the text &"cancelled by administrator"&.
3896 Bounce messages are just discarded. This option can be used only by an admin
3897 user.
3898
3899 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3900 .oindex "&%-Mmad%&"
3901 .cindex "delivery" "cancelling all"
3902 This option requests Exim to mark all the recipient addresses in the messages
3903 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3904 message is active (in the middle of a delivery attempt), its status is not
3905 altered. This option can be used only by an admin user.
3906
3907 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3908 .oindex "&%-Mmd%&"
3909 .cindex "delivery" "cancelling by address"
3910 .cindex "recipient" "removing"
3911 .cindex "removing recipients"
3912 This option requests Exim to mark the given addresses as already delivered
3913 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3914 the remaining ones must be email addresses. These are matched to recipient
3915 addresses in the message in a case-sensitive manner. If the message is active
3916 (in the middle of a delivery attempt), its status is not altered. This option
3917 can be used only by an admin user.
3918
3919 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3920 .oindex "&%-Mrm%&"
3921 .cindex "removing messages"
3922 .cindex "abandoning mail"
3923 .cindex "message" "manually discarding"
3924 This option requests Exim to remove the given messages from the queue. No
3925 bounce messages are sent; each message is simply forgotten. However, if any of
3926 the messages are active, their status is not altered. This option can be used
3927 only by an admin user or by the user who originally caused the message to be
3928 placed on the queue.
3929
3930 .vitem &%-Mset%&&~<&'message&~id'&>
3931 .oindex "&%-Mset%&
3932 .cindex "testing" "string expansion"
3933 .cindex "expansion" "testing"
3934 This option is useful only in conjunction with &%-be%& (that is, when testing
3935 string expansions). Exim loads the given message from its spool before doing
3936 the test expansions, thus setting message-specific variables such as
3937 &$message_size$& and the header variables. The &$recipients$& variable is made
3938 available. This feature is provided to make it easier to test expansions that
3939 make use of these variables. However, this option can be used only by an admin
3940 user. See also &%-bem%&.
3941
3942 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3943 .oindex "&%-Mt%&"
3944 .cindex "thawing messages"
3945 .cindex "unfreezing messages"
3946 .cindex "frozen messages" "thawing"
3947 .cindex "message" "thawing frozen"
3948 This option requests Exim to &"thaw"& any of the listed messages that are
3949 &"frozen"&, so that delivery attempts can resume. However, if any of the
3950 messages are active, their status is not altered. This option can be used only
3951 by an admin user.
3952
3953 .vitem &%-Mvb%&&~<&'message&~id'&>
3954 .oindex "&%-Mvb%&"
3955 .cindex "listing" "message body"
3956 .cindex "message" "listing body of"
3957 This option causes the contents of the message body (-D) spool file to be
3958 written to the standard output. This option can be used only by an admin user.
3959
3960 .vitem &%-Mvc%&&~<&'message&~id'&>
3961 .oindex "&%-Mvc%&"
3962 .cindex "message" "listing in RFC 2822 format"
3963 .cindex "listing" "message in RFC 2822 format"
3964 This option causes a copy of the complete message (header lines plus body) to
3965 be written to the standard output in RFC 2822 format. This option can be used
3966 only by an admin user.
3967
3968 .vitem &%-Mvh%&&~<&'message&~id'&>
3969 .oindex "&%-Mvh%&"
3970 .cindex "listing" "message headers"
3971 .cindex "header lines" "listing"
3972 .cindex "message" "listing header lines"
3973 This option causes the contents of the message headers (-H) spool file to be
3974 written to the standard output. This option can be used only by an admin user.
3975
3976 .vitem &%-Mvl%&&~<&'message&~id'&>
3977 .oindex "&%-Mvl%&"
3978 .cindex "listing" "message log"
3979 .cindex "message" "listing message log"
3980 This option causes the contents of the message log spool file to be written to
3981 the standard output. This option can be used only by an admin user.
3982
3983 .vitem &%-m%&
3984 .oindex "&%-m%&"
3985 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3986 treats it that way too.
3987
3988 .vitem &%-N%&
3989 .oindex "&%-N%&"
3990 .cindex "debugging" "&%-N%& option"
3991 .cindex "debugging" "suppressing delivery"
3992 This is a debugging option that inhibits delivery of a message at the transport
3993 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3994 it just doesn't actually transport the message, but instead behaves as if it
3995 had successfully done so. However, it does not make any updates to the retry
3996 database, and the log entries for deliveries are flagged with &"*>"& rather
3997 than &"=>"&.
3998
3999 Because &%-N%& discards any message to which it applies, only root or the Exim
4000 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4001 words, an ordinary user can use it only when supplying an incoming message to
4002 which it will apply. Although transportation never fails when &%-N%& is set, an
4003 address may be deferred because of a configuration problem on a transport, or a
4004 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4005 the message, and applies to any subsequent delivery attempts that may happen
4006 for that message.
4007
4008 .vitem &%-n%&
4009 .oindex "&%-n%&"
4010 This option is interpreted by Sendmail to mean &"no aliasing"&.
4011 For normal modes of operation, it is ignored by Exim.
4012 When combined with &%-bP%& it suppresses the name of an option from being output.
4013
4014 .vitem &%-O%&&~<&'data'&>
4015 .oindex "&%-O%&"
4016 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4017 Exim.
4018
4019 .vitem &%-oA%&&~<&'file&~name'&>
4020 .oindex "&%-oA%&"
4021 .cindex "Sendmail compatibility" "&%-oA%& option"
4022 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4023 alternative alias file name. Exim handles &%-bi%& differently; see the
4024 description above.
4025
4026 .vitem &%-oB%&&~<&'n'&>
4027 .oindex "&%-oB%&"
4028 .cindex "SMTP" "passed connection"
4029 .cindex "SMTP" "multiple deliveries"
4030 .cindex "multiple SMTP deliveries"
4031 This is a debugging option which limits the maximum number of messages that can
4032 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4033 transport. If <&'n'&> is omitted, the limit is set to 1.
4034
4035 .vitem &%-odb%&
4036 .oindex "&%-odb%&"
4037 .cindex "background delivery"
4038 .cindex "delivery" "in the background"
4039 This option applies to all modes in which Exim accepts incoming messages,
4040 including the listening daemon. It requests &"background"& delivery of such
4041 messages, which means that the accepting process automatically starts a
4042 delivery process for each message received, but does not wait for the delivery
4043 processes to finish.
4044
4045 When all the messages have been received, the reception process exits,
4046 leaving the delivery processes to finish in their own time. The standard output
4047 and error streams are closed at the start of each delivery process.
4048 This is the default action if none of the &%-od%& options are present.
4049
4050 If one of the queueing options in the configuration file
4051 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4052 overrides it if &%queue_only_override%& is set true, which is the default
4053 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4054
4055 .vitem &%-odf%&
4056 .oindex "&%-odf%&"
4057 .cindex "foreground delivery"
4058 .cindex "delivery" "in the foreground"
4059 This option requests &"foreground"& (synchronous) delivery when Exim has
4060 accepted a locally-generated message. (For the daemon it is exactly the same as
4061 &%-odb%&.) A delivery process is automatically started to deliver the message,
4062 and Exim waits for it to complete before proceeding.
4063
4064 The original Exim reception process does not finish until the delivery
4065 process for the final message has ended. The standard error stream is left open
4066 during deliveries.
4067
4068 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4069 false and one of the queueing options in the configuration file is in effect.
4070
4071 If there is a temporary delivery error during foreground delivery, the
4072 message is left on the queue for later delivery, and the original reception
4073 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4074 restricted configuration that never queues messages.
4075
4076
4077 .vitem &%-odi%&
4078 .oindex "&%-odi%&"
4079 This option is synonymous with &%-odf%&. It is provided for compatibility with
4080 Sendmail.
4081
4082 .vitem &%-odq%&
4083 .oindex "&%-odq%&"
4084 .cindex "non-immediate delivery"
4085 .cindex "delivery" "suppressing immediate"
4086 .cindex "queueing incoming messages"
4087 This option applies to all modes in which Exim accepts incoming messages,
4088 including the listening daemon. It specifies that the accepting process should
4089 not automatically start a delivery process for each message received. Messages
4090 are placed on the queue, and remain there until a subsequent queue runner
4091 process encounters them. There are several configuration options (such as
4092 &%queue_only%&) that can be used to queue incoming messages under certain
4093 conditions. This option overrides all of them and also &%-odqs%&. It always
4094 forces queueing.
4095
4096 .vitem &%-odqs%&
4097 .oindex "&%-odqs%&"
4098 .cindex "SMTP" "delaying delivery"
4099 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4100 However, like &%-odb%& and &%-odi%&, this option has no effect if
4101 &%queue_only_override%& is false and one of the queueing options in the
4102 configuration file is in effect.
4103
4104 When &%-odqs%& does operate, a delivery process is started for each incoming
4105 message, in the background by default, but in the foreground if &%-odi%& is
4106 also present. The recipient addresses are routed, and local deliveries are done
4107 in the normal way. However, if any SMTP deliveries are required, they are not
4108 done at this time, so the message remains on the queue until a subsequent queue
4109 runner process encounters it. Because routing was done, Exim knows which
4110 messages are waiting for which hosts, and so a number of messages for the same
4111 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4112 configuration option has the same effect for specific domains. See also the
4113 &%-qq%& option.
4114
4115 .vitem &%-oee%&
4116 .oindex "&%-oee%&"
4117 .cindex "error" "reporting"
4118 If an error is detected while a non-SMTP message is being received (for
4119 example, a malformed address), the error is reported to the sender in a mail
4120 message.
4121
4122 .cindex "return code" "for &%-oee%&"
4123 Provided
4124 this error message is successfully sent, the Exim receiving process
4125 exits with a return code of zero. If not, the return code is 2 if the problem
4126 is that the original message has no recipients, or 1 for any other error.
4127 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4128
4129 .vitem &%-oem%&
4130 .oindex "&%-oem%&"
4131 .cindex "error" "reporting"
4132 .cindex "return code" "for &%-oem%&"
4133 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4134 return code, whether or not the error message was successfully sent.
4135 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4136
4137 .vitem &%-oep%&
4138 .oindex "&%-oep%&"
4139 .cindex "error" "reporting"
4140 If an error is detected while a non-SMTP message is being received, the
4141 error is reported by writing a message to the standard error file (stderr).
4142 .cindex "return code" "for &%-oep%&"
4143 The return code is 1 for all errors.
4144
4145 .vitem &%-oeq%&
4146 .oindex "&%-oeq%&"
4147 .cindex "error" "reporting"
4148 This option is supported for compatibility with Sendmail, but has the same
4149 effect as &%-oep%&.
4150
4151 .vitem &%-oew%&
4152 .oindex "&%-oew%&"
4153 .cindex "error" "reporting"
4154 This option is supported for compatibility with Sendmail, but has the same
4155 effect as &%-oem%&.
4156
4157 .vitem &%-oi%&
4158 .oindex "&%-oi%&"
4159 .cindex "dot" "in incoming non-SMTP message"
4160 This option, which has the same effect as &%-i%&, specifies that a dot on a
4161 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4162 single dot does terminate, though Exim does no special processing for other
4163 lines that start with a dot. This option is set by default if Exim is called as
4164 &'rmail'&. See also &%-ti%&.
4165
4166 .vitem &%-oitrue%&
4167 .oindex "&%-oitrue%&"
4168 This option is treated as synonymous with &%-oi%&.
4169
4170 .vitem &%-oMa%&&~<&'host&~address'&>
4171 .oindex "&%-oMa%&"
4172 .cindex "sender" "host address, specifying for local message"
4173 A number of options starting with &%-oM%& can be used to set values associated
4174 with remote hosts on locally-submitted messages (that is, messages not received
4175 over TCP/IP). These options can be used by any caller in conjunction with the
4176 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4177 other circumstances, they are ignored unless the caller is trusted.
4178
4179 The &%-oMa%& option sets the sender host address. This may include a port
4180 number at the end, after a full stop (period). For example:
4181 .code
4182 exim -bs -oMa 10.9.8.7.1234
4183 .endd
4184 An alternative syntax is to enclose the IP address in square brackets,
4185 followed by a colon and the port number:
4186 .code
4187 exim -bs -oMa [10.9.8.7]:1234
4188 .endd
4189 The IP address is placed in the &$sender_host_address$& variable, and the
4190 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4191 are present on the command line, the sender host IP address is taken from
4192 whichever one is last.
4193
4194 .vitem &%-oMaa%&&~<&'name'&>
4195 .oindex "&%-oMaa%&"
4196 .cindex "authentication" "name, specifying for local message"
4197 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4198 option sets the value of &$sender_host_authenticated$& (the authenticator
4199 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4200 This option can be used with &%-bh%& and &%-bs%& to set up an
4201 authenticated SMTP session without actually using the SMTP AUTH command.
4202
4203 .vitem &%-oMai%&&~<&'string'&>
4204 .oindex "&%-oMai%&"
4205 .cindex "authentication" "id, specifying for local message"
4206 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4207 option sets the value of &$authenticated_id$& (the id that was authenticated).
4208 This overrides the default value (the caller's login id, except with &%-bh%&,
4209 where there is no default) for messages from local sources. See chapter
4210 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4211
4212 .vitem &%-oMas%&&~<&'address'&>
4213 .oindex "&%-oMas%&"
4214 .cindex "authentication" "sender, specifying for local message"
4215 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4216 option sets the authenticated sender value in &$authenticated_sender$&. It
4217 overrides the sender address that is created from the caller's login id for
4218 messages from local sources, except when &%-bh%& is used, when there is no
4219 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4220 specified on a MAIL command overrides this value. See chapter
4221 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4222
4223 .vitem &%-oMi%&&~<&'interface&~address'&>
4224 .oindex "&%-oMi%&"
4225 .cindex "interface" "address, specifying for local message"
4226 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4227 option sets the IP interface address value. A port number may be included,
4228 using the same syntax as for &%-oMa%&. The interface address is placed in
4229 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4230
4231 .vitem &%-oMm%&&~<&'message&~reference'&>
4232 .oindex "&%-oMm%&"
4233 .cindex "message reference" "message reference, specifying for local message"
4234 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4235 option sets the message reference, e.g. message-id, and is logged during
4236 delivery. This is useful when some kind of audit trail is required to tie
4237 messages together. The format of the message reference is checked and will
4238 abort if the format is invalid. The option will only be accepted if exim is
4239 running in trusted mode, not as any regular user.
4240
4241 The best example of a message reference is when Exim sends a bounce message.
4242 The message reference is the message-id of the original message for which Exim
4243 is sending the bounce.
4244
4245 .vitem &%-oMr%&&~<&'protocol&~name'&>
4246 .oindex "&%-oMr%&"
4247 .cindex "protocol, specifying for local message"
4248 .vindex "&$received_protocol$&"
4249 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4250 option sets the received protocol value that is stored in
4251 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4252 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4253 SMTP protocol names (see the description of &$received_protocol$& in section
4254 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4255 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4256 be set by &%-oMr%&.
4257
4258 .vitem &%-oMs%&&~<&'host&~name'&>
4259 .oindex "&%-oMs%&"
4260 .cindex "sender" "host name, specifying for local message"
4261 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4262 option sets the sender host name in &$sender_host_name$&. When this option is
4263 present, Exim does not attempt to look up a host name from an IP address; it
4264 uses the name it is given.
4265
4266 .vitem &%-oMt%&&~<&'ident&~string'&>
4267 .oindex "&%-oMt%&"
4268 .cindex "sender" "ident string, specifying for local message"
4269 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4270 option sets the sender ident value in &$sender_ident$&. The default setting for
4271 local callers is the login id of the calling process, except when &%-bh%& is
4272 used, when there is no default.
4273
4274 .vitem &%-om%&
4275 .oindex "&%-om%&"
4276 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4277 In Sendmail, this option means &"me too"&, indicating that the sender of a
4278 message should receive a copy of the message if the sender appears in an alias
4279 expansion. Exim always does this, so the option does nothing.
4280
4281 .vitem &%-oo%&
4282 .oindex "&%-oo%&"
4283 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4284 This option is ignored. In Sendmail it specifies &"old style headers"&,
4285 whatever that means.
4286
4287 .vitem &%-oP%&&~<&'path'&>
4288 .oindex "&%-oP%&"
4289 .cindex "pid (process id)" "of daemon"
4290 .cindex "daemon" "process id (pid)"
4291 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4292 value. The option specifies the file to which the process id of the daemon is
4293 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4294 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4295 because in those cases, the normal pid file is not used.
4296
4297 .vitem &%-or%&&~<&'time'&>
4298 .oindex "&%-or%&"
4299 .cindex "timeout" "for non-SMTP input"
4300 This option sets a timeout value for incoming non-SMTP messages. If it is not
4301 set, Exim will wait forever for the standard input. The value can also be set
4302 by the &%receive_timeout%& option. The format used for specifying times is
4303 described in section &<<SECTtimeformat>>&.
4304
4305 .vitem &%-os%&&~<&'time'&>
4306 .oindex "&%-os%&"
4307 .cindex "timeout" "for SMTP input"
4308 .cindex "SMTP" "input timeout"
4309 This option sets a timeout value for incoming SMTP messages. The timeout
4310 applies to each SMTP command and block of data. The value can also be set by
4311 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4312 for specifying times is described in section &<<SECTtimeformat>>&.
4313
4314 .vitem &%-ov%&
4315 .oindex "&%-ov%&"
4316 This option has exactly the same effect as &%-v%&.
4317
4318 .vitem &%-oX%&&~<&'number&~or&~string'&>
4319 .oindex "&%-oX%&"
4320 .cindex "TCP/IP" "setting listening ports"
4321 .cindex "TCP/IP" "setting listening interfaces"
4322 .cindex "port" "receiving TCP/IP"
4323 This option is relevant only when the &%-bd%& (start listening daemon) option
4324 is also given. It controls which ports and interfaces the daemon uses. Details
4325 of the syntax, and how it interacts with configuration file options, are given
4326 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4327 file is written unless &%-oP%& is also present to specify a pid file name.
4328
4329 .vitem &%-pd%&
4330 .oindex "&%-pd%&"
4331 .cindex "Perl" "starting the interpreter"
4332 This option applies when an embedded Perl interpreter is linked with Exim (see
4333 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4334 option, forcing the starting of the interpreter to be delayed until it is
4335 needed.
4336
4337 .vitem &%-ps%&
4338 .oindex "&%-ps%&"
4339 .cindex "Perl" "starting the interpreter"
4340 This option applies when an embedded Perl interpreter is linked with Exim (see
4341 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4342 option, forcing the starting of the interpreter to occur as soon as Exim is
4343 started.
4344
4345 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4346 .oindex "&%-p%&"
4347 For compatibility with Sendmail, this option is equivalent to
4348 .display
4349 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4350 .endd
4351 It sets the incoming protocol and host name (for trusted callers). The
4352 host name and its colon can be omitted when only the protocol is to be set.
4353 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4354 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4355 or &`s`& using this option (but that does not seem a real limitation).
4356
4357 .vitem &%-q%&
4358 .oindex "&%-q%&"
4359 .cindex "queue runner" "starting manually"
4360 This option is normally restricted to admin users. However, there is a
4361 configuration option called &%prod_requires_admin%& which can be set false to
4362 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4363 and &%-S%& options).
4364
4365 .cindex "queue runner" "description of operation"
4366 The &%-q%& option starts one queue runner process. This scans the queue of
4367 waiting messages, and runs a delivery process for each one in turn. It waits
4368 for each delivery process to finish before starting the next one. A delivery
4369 process may not actually do any deliveries if the retry times for the addresses
4370 have not been reached. Use &%-qf%& (see below) if you want to override this.
4371
4372 If
4373 .cindex "SMTP" "passed connection"
4374 .cindex "SMTP" "multiple deliveries"
4375 .cindex "multiple SMTP deliveries"
4376 the delivery process spawns other processes to deliver other messages down
4377 passed SMTP connections, the queue runner waits for these to finish before
4378 proceeding.
4379
4380 When all the queued messages have been considered, the original queue runner
4381 process terminates. In other words, a single pass is made over the waiting
4382 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4383 this to be repeated periodically.
4384
4385 Exim processes the waiting messages in an unpredictable order. It isn't very
4386 random, but it is likely to be different each time, which is all that matters.
4387 If one particular message screws up a remote MTA, other messages to the same
4388 MTA have a chance of getting through if they get tried first.
4389
4390 It is possible to cause the messages to be processed in lexical message id
4391 order, which is essentially the order in which they arrived, by setting the
4392 &%queue_run_in_order%& option, but this is not recommended for normal use.
4393
4394 .vitem &%-q%&<&'qflags'&>
4395 The &%-q%& option may be followed by one or more flag letters that change its
4396 behaviour. They are all optional, but if more than one is present, they must
4397 appear in the correct order. Each flag is described in a separate item below.
4398
4399 .vitem &%-qq...%&
4400 .oindex "&%-qq%&"
4401 .cindex "queue" "double scanning"
4402 .cindex "queue" "routing"
4403 .cindex "routing" "whole queue before delivery"
4404 An option starting with &%-qq%& requests a two-stage queue run. In the first
4405 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4406 every domain. Addresses are routed, local deliveries happen, but no remote
4407 transports are run.
4408
4409 .cindex "hints database" "remembering routing"
4410 The hints database that remembers which messages are waiting for specific hosts
4411 is updated, as if delivery to those hosts had been deferred. After this is
4412 complete, a second, normal queue scan happens, with routing and delivery taking
4413 place as normal. Messages that are routed to the same host should mostly be
4414 delivered down a single SMTP
4415 .cindex "SMTP" "passed connection"
4416 .cindex "SMTP" "multiple deliveries"
4417 .cindex "multiple SMTP deliveries"
4418 connection because of the hints that were set up during the first queue scan.
4419 This option may be useful for hosts that are connected to the Internet
4420 intermittently.
4421
4422 .vitem &%-q[q]i...%&
4423 .oindex "&%-qi%&"
4424 .cindex "queue" "initial delivery"
4425 If the &'i'& flag is present, the queue runner runs delivery processes only for
4426 those messages that haven't previously been tried. (&'i'& stands for &"initial
4427 delivery"&.) This can be helpful if you are putting messages on the queue using
4428 &%-odq%& and want a queue runner just to process the new messages.
4429
4430 .vitem &%-q[q][i]f...%&
4431 .oindex "&%-qf%&"
4432 .cindex "queue" "forcing delivery"
4433 .cindex "delivery" "forcing in queue run"
4434 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4435 message, whereas without &'f'& only those non-frozen addresses that have passed
4436 their retry times are tried.
4437
4438 .vitem &%-q[q][i]ff...%&
4439 .oindex "&%-qff%&"
4440 .cindex "frozen messages" "forcing delivery"
4441 If &'ff'& is present, a delivery attempt is forced for every message, whether
4442 frozen or not.
4443
4444 .vitem &%-q[q][i][f[f]]l%&
4445 .oindex "&%-ql%&"
4446 .cindex "queue" "local deliveries only"
4447 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4448 be done. If a message requires any remote deliveries, it remains on the queue
4449 for later delivery.
4450
4451 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4452 .cindex "queue" "delivering specific messages"
4453 When scanning the queue, Exim can be made to skip over messages whose ids are
4454 lexically less than a given value by following the &%-q%& option with a
4455 starting message id. For example:
4456 .code
4457 exim -q 0t5C6f-0000c8-00
4458 .endd
4459 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4460 second message id is given, messages whose ids are lexically greater than it
4461 are also skipped. If the same id is given twice, for example,
4462 .code
4463 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4464 .endd
4465 just one delivery process is started, for that message. This differs from
4466 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4467 that it counts as a delivery from a queue run. Note that the selection
4468 mechanism does not affect the order in which the messages are scanned. There
4469 are also other ways of selecting specific sets of messages for delivery in a
4470 queue run &-- see &%-R%& and &%-S%&.
4471
4472 .vitem &%-q%&<&'qflags'&><&'time'&>
4473 .cindex "queue runner" "starting periodically"
4474 .cindex "periodic queue running"
4475 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4476 starting a queue runner process at intervals specified by the given time value
4477 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4478 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4479 single daemon process handles both functions. A common way of starting up a
4480 combined daemon at system boot time is to use a command such as
4481 .code
4482 /usr/exim/bin/exim -bd -q30m
4483 .endd
4484 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4485 process every 30 minutes.
4486
4487 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4488 pid file is written unless one is explicitly requested by the &%-oP%& option.
4489
4490 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4491 .oindex "&%-qR%&"
4492 This option is synonymous with &%-R%&. It is provided for Sendmail
4493 compatibility.
4494
4495 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4496 .oindex "&%-qS%&"
4497 This option is synonymous with &%-S%&.
4498
4499 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4500 .oindex "&%-R%&"
4501 .cindex "queue runner" "for specific recipients"
4502 .cindex "delivery" "to given domain"
4503 .cindex "domain" "delivery to"
4504 The <&'rsflags'&> may be empty, in which case the white space before the string
4505 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4506 which are the possible values for <&'rsflags'&>. White space is required if
4507 <&'rsflags'&> is not empty.
4508
4509 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4510 perform a single queue run, except that, when scanning the messages on the
4511 queue, Exim processes only those that have at least one undelivered recipient
4512 address containing the given string, which is checked in a case-independent
4513 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4514 regular expression; otherwise it is a literal string.
4515
4516 If you want to do periodic queue runs for messages with specific recipients,
4517 you can combine &%-R%& with &%-q%& and a time value. For example:
4518 .code
4519 exim -q25m -R @special.domain.example
4520 .endd
4521 This example does a queue run for messages with recipients in the given domain
4522 every 25 minutes. Any additional flags that are specified with &%-q%& are
4523 applied to each queue run.
4524
4525 Once a message is selected for delivery by this mechanism, all its addresses
4526 are processed. For the first selected message, Exim overrides any retry
4527 information and forces a delivery attempt for each undelivered address. This
4528 means that if delivery of any address in the first message is successful, any
4529 existing retry information is deleted, and so delivery attempts for that
4530 address in subsequently selected messages (which are processed without forcing)
4531 will run. However, if delivery of any address does not succeed, the retry
4532 information is updated, and in subsequently selected messages, the failing
4533 address will be skipped.
4534
4535 .cindex "frozen messages" "forcing delivery"
4536 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4537 all selected messages, not just the first; frozen messages are included when
4538 &'ff'& is present.
4539
4540 The &%-R%& option makes it straightforward to initiate delivery of all messages
4541 to a given domain after a host has been down for some time. When the SMTP
4542 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4543 effect is to run Exim with the &%-R%& option, but it can be configured to run
4544 an arbitrary command instead.
4545
4546 .vitem &%-r%&
4547 .oindex "&%-r%&"
4548 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4549
4550 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4551 .oindex "&%-S%&"
4552 .cindex "delivery" "from given sender"
4553 .cindex "queue runner" "for specific senders"
4554 This option acts like &%-R%& except that it checks the string against each
4555 message's sender instead of against the recipients. If &%-R%& is also set, both
4556 conditions must be met for a message to be selected. If either of the options
4557 has &'f'& or &'ff'& in its flags, the associated action is taken.
4558
4559 .vitem &%-Tqt%&&~<&'times'&>
4560 .oindex "&%-Tqt%&"
4561 This is an option that is exclusively for use by the Exim testing suite. It is not
4562 recognized when Exim is run normally. It allows for the setting up of explicit
4563 &"queue times"& so that various warning/retry features can be tested.
4564
4565 .vitem &%-t%&
4566 .oindex "&%-t%&"
4567 .cindex "recipient" "extracting from header lines"
4568 .cindex "&'Bcc:'& header line"
4569 .cindex "&'Cc:'& header line"
4570 .cindex "&'To:'& header line"
4571 When Exim is receiving a locally-generated, non-SMTP message on its standard
4572 input, the &%-t%& option causes the recipients of the message to be obtained
4573 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4574 from the command arguments. The addresses are extracted before any rewriting
4575 takes place and the &'Bcc:'& header line, if present, is then removed.
4576
4577 .cindex "Sendmail compatibility" "&%-t%& option"
4578 If the command has any arguments, they specify addresses to which the message
4579 is &'not'& to be delivered. That is, the argument addresses are removed from
4580 the recipients list obtained from the headers. This is compatible with Smail 3
4581 and in accordance with the documented behaviour of several versions of
4582 Sendmail, as described in man pages on a number of operating systems (e.g.
4583 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4584 argument addresses to those obtained from the headers, and the O'Reilly
4585 Sendmail book documents it that way. Exim can be made to add argument addresses
4586 instead of subtracting them by setting the option
4587 &%extract_addresses_remove_arguments%& false.
4588
4589 .cindex "&%Resent-%& header lines" "with &%-t%&"
4590 If there are any &%Resent-%& header lines in the message, Exim extracts
4591 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4592 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4593 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4594 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4595
4596 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4597 message is resent several times). The RFC also specifies that they should be
4598 added at the front of the message, and separated by &'Received:'& lines. It is
4599 not at all clear how &%-t%& should operate in the present of multiple sets,
4600 nor indeed exactly what constitutes a &"set"&.
4601 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4602 are often added at the end of the header, and if a message is resent more than
4603 once, it is common for the original set of &%Resent-%& headers to be renamed as
4604 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4605
4606 .vitem &%-ti%&
4607 .oindex "&%-ti%&"
4608 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4609 compatibility with Sendmail.
4610
4611 .vitem &%-tls-on-connect%&
4612 .oindex "&%-tls-on-connect%&"
4613 .cindex "TLS" "use without STARTTLS"
4614 .cindex "TLS" "automatic start"
4615 This option is available when Exim is compiled with TLS support. It forces all
4616 incoming SMTP connections to behave as if the incoming port is listed in the
4617 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4618 &<<CHAPTLS>>& for further details.
4619
4620
4621 .vitem &%-U%&
4622 .oindex "&%-U%&"
4623 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4624 Sendmail uses this option for &"initial message submission"&, and its
4625 documentation states that in future releases, it may complain about
4626 syntactically invalid messages rather than fixing them when this flag is not
4627 set. Exim ignores this option.
4628
4629 .vitem &%-v%&
4630 .oindex "&%-v%&"
4631 This option causes Exim to write information to the standard error stream,
4632 describing what it is doing. In particular, it shows the log lines for
4633 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4634 dialogue is shown. Some of the log lines shown may not actually be written to
4635 the log if the setting of &%log_selector%& discards them. Any relevant
4636 selectors are shown with each log line. If none are shown, the logging is
4637 unconditional.
4638
4639 .vitem &%-x%&
4640 .oindex "&%-x%&"
4641 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4642 National Language Support extended characters in the body of the mail item"&).
4643 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4644 this option.
4645
4646 .vitem &%-X%&&~<&'logfile'&>
4647 .oindex "&%-X%&"
4648 This option is interpreted by Sendmail to cause debug information to be sent
4649 to the named file.  It is ignored by Exim.
4650
4651 .vitem &%-z%&&~<&'log-line'&>
4652 .oindex "&%-z%&"
4653 This option writes its argument to Exim's logfile.
4654 Use is restricted to administrators; the intent is for operational notes.
4655 Quotes should be used to maintain a multi-word item as a single argument,
4656 under most shells.
4657 .endlist
4658
4659 .ecindex IIDclo1
4660 .ecindex IIDclo2
4661
4662
4663 . ////////////////////////////////////////////////////////////////////////////
4664 . Insert a stylized DocBook comment here, to identify the end of the command
4665 . line options. This is for the benefit of the Perl script that automatically
4666 . creates a man page for the options.
4667 . ////////////////////////////////////////////////////////////////////////////
4668
4669 .literal xml
4670 <!-- === End of command line options === -->
4671 .literal off
4672
4673
4674
4675
4676
4677 . ////////////////////////////////////////////////////////////////////////////
4678 . ////////////////////////////////////////////////////////////////////////////
4679
4680
4681 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4682          "The runtime configuration file"
4683
4684 .cindex "run time configuration"
4685 .cindex "configuration file" "general description"
4686 .cindex "CONFIGURE_FILE"
4687 .cindex "configuration file" "errors in"
4688 .cindex "error" "in configuration file"
4689 .cindex "return code" "for bad configuration"
4690 Exim uses a single run time configuration file that is read whenever an Exim
4691 binary is executed. Note that in normal operation, this happens frequently,
4692 because Exim is designed to operate in a distributed manner, without central
4693 control.
4694
4695 If a syntax error is detected while reading the configuration file, Exim
4696 writes a message on the standard error, and exits with a non-zero return code.
4697 The message is also written to the panic log. &*Note*&: Only simple syntax
4698 errors can be detected at this time. The values of any expanded options are
4699 not checked until the expansion happens, even when the expansion does not
4700 actually alter the string.
4701
4702 The name of the configuration file is compiled into the binary for security
4703 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4704 most configurations, this specifies a single file. However, it is permitted to
4705 give a colon-separated list of file names, in which case Exim uses the first
4706 existing file in the list.
4707
4708 .cindex "EXIM_USER"
4709 .cindex "EXIM_GROUP"
4710 .cindex "CONFIGURE_OWNER"
4711 .cindex "CONFIGURE_GROUP"
4712 .cindex "configuration file" "ownership"
4713 .cindex "ownership" "configuration file"
4714 The run time configuration file must be owned by root or by the user that is
4715 specified at compile time by the CONFIGURE_OWNER option (if set). The
4716 configuration file must not be world-writeable, or group-writeable unless its
4717 group is the root group or the one specified at compile time by the
4718 CONFIGURE_GROUP option.
4719
4720 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4721 to root, anybody who is able to edit the run time configuration file has an
4722 easy way to run commands as root. If you specify a user or group in the
4723 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4724 who are members of that group will trivially be able to obtain root privileges.
4725
4726 Up to Exim version 4.72, the run time configuration file was also permitted to
4727 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4728 since it offered a simple privilege escalation for any attacker who managed to
4729 compromise the Exim user account.
4730
4731 A default configuration file, which will work correctly in simple situations,
4732 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4733 defines just one file name, the installation process copies the default
4734 configuration to a new file of that name if it did not previously exist. If
4735 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4736 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4737 configuration.
4738
4739
4740
4741 .section "Using a different configuration file" "SECID40"
4742 .cindex "configuration file" "alternate"
4743 A one-off alternate configuration can be specified by the &%-C%& command line
4744 option, which may specify a single file or a list of files. However, when
4745 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4746 unless the argument for &%-C%& is identical to the built-in value from
4747 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4748 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4749 is useful mainly for checking the syntax of configuration files before
4750 installing them. No owner or group checks are done on a configuration file
4751 specified by &%-C%&, if root privilege has been dropped.
4752
4753 Even the Exim user is not trusted to specify an arbitrary configuration file
4754 with the &%-C%& option to be used with root privileges, unless that file is
4755 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4756 testing a configuration using &%-C%& right through message reception and
4757 delivery, even if the caller is root. The reception works, but by that time,
4758 Exim is running as the Exim user, so when it re-execs to regain privilege for
4759 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4760 can test reception and delivery using two separate commands (one to put a
4761 message on the queue, using &%-odq%&, and another to do the delivery, using
4762 &%-M%&).
4763
4764 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4765 prefix string with which any file named in a &%-C%& command line option must
4766 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4767 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4768 name can be used with &%-C%&.
4769
4770 One-off changes to a configuration can be specified by the &%-D%& command line
4771 option, which defines and overrides values for macros used inside the
4772 configuration file. However, like &%-C%&, the use of this option by a
4773 non-privileged user causes Exim to discard its root privilege.
4774 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4775 completely disabled, and its use causes an immediate error exit.
4776
4777 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4778 to declare certain macro names trusted, such that root privilege will not
4779 necessarily be discarded.
4780 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4781 considered safe and, if &%-D%& only supplies macros from this list, and the
4782 values are acceptable, then Exim will not give up root privilege if the caller
4783 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4784 transition mechanism and is expected to be removed in the future.  Acceptable
4785 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4786
4787 Some sites may wish to use the same Exim binary on different machines that
4788 share a file system, but to use different configuration files on each machine.
4789 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4790 looks for a file whose name is the configuration file name followed by a dot
4791 and the machine's node name, as obtained from the &[uname()]& function. If this
4792 file does not exist, the standard name is tried. This processing occurs for
4793 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4794
4795 In some esoteric situations different versions of Exim may be run under
4796 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4797 help with this. See the comments in &_src/EDITME_& for details.
4798
4799
4800
4801 .section "Configuration file format" "SECTconffilfor"
4802 .cindex "configuration file" "format of"
4803 .cindex "format" "configuration file"
4804 Exim's configuration file is divided into a number of different parts. General
4805 option settings must always appear at the start of the file. The other parts
4806 are all optional, and may appear in any order. Each part other than the first
4807 is introduced by the word &"begin"& followed by the name of the part. The
4808 optional parts are:
4809
4810 .ilist
4811 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4812 &<<CHAPACL>>&).
4813 .next
4814 .cindex "AUTH" "configuration"
4815 &'authenticators'&: Configuration settings for the authenticator drivers. These
4816 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4817 .next
4818 &'routers'&: Configuration settings for the router drivers. Routers process
4819 addresses and determine how the message is to be delivered (see chapters
4820 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4821 .next
4822 &'transports'&: Configuration settings for the transport drivers. Transports
4823 define mechanisms for copying messages to destinations (see chapters
4824 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4825 .next
4826 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4827 If there is no retry section, or if it is empty (that is, no retry rules are
4828 defined), Exim will not retry deliveries. In this situation, temporary errors
4829 are treated the same as permanent errors. Retry rules are discussed in chapter
4830 &<<CHAPretry>>&.
4831 .next
4832 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4833 when new addresses are generated during delivery. Rewriting is discussed in
4834 chapter &<<CHAPrewrite>>&.
4835 .next
4836 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4837 want to use this feature, you must set
4838 .code
4839 LOCAL_SCAN_HAS_OPTIONS=yes
4840 .endd
4841 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4842 facility are given in chapter &<<CHAPlocalscan>>&.
4843 .endlist
4844
4845 .cindex "configuration file" "leading white space in"
4846 .cindex "configuration file" "trailing white space in"
4847 .cindex "white space" "in configuration file"
4848 Leading and trailing white space in configuration lines is always ignored.
4849
4850 Blank lines in the file, and lines starting with a # character (ignoring
4851 leading white space) are treated as comments and are ignored. &*Note*&: A
4852 # character other than at the beginning of a line is not treated specially,
4853 and does not introduce a comment.
4854
4855 Any non-comment line can be continued by ending it with a backslash. Note that
4856 the general rule for white space means that trailing white space after the
4857 backslash and leading white space at the start of continuation
4858 lines is ignored. Comment lines beginning with # (but not empty lines) may
4859 appear in the middle of a sequence of continuation lines.
4860
4861 A convenient way to create a configuration file is to start from the
4862 default, which is supplied in &_src/configure.default_&, and add, delete, or
4863 change settings as required.
4864
4865 The ACLs, retry rules, and rewriting rules have their own syntax which is
4866 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4867 respectively. The other parts of the configuration file have some syntactic
4868 items in common, and these are described below, from section &<<SECTcos>>&
4869 onwards. Before that, the inclusion, macro, and conditional facilities are
4870 described.
4871
4872
4873
4874 .section "File inclusions in the configuration file" "SECID41"
4875 .cindex "inclusions in configuration file"
4876 .cindex "configuration file" "including other files"
4877 .cindex "&`.include`& in configuration file"
4878 .cindex "&`.include_if_exists`& in configuration file"
4879 You can include other files inside Exim's run time configuration file by
4880 using this syntax:
4881 .display
4882 &`.include`& <&'file name'&>
4883 &`.include_if_exists`& <&'file name'&>
4884 .endd
4885 on a line by itself. Double quotes round the file name are optional. If you use
4886 the first form, a configuration error occurs if the file does not exist; the
4887 second form does nothing for non-existent files. In all cases, an absolute file
4888 name is required.
4889
4890 Includes may be nested to any depth, but remember that Exim reads its
4891 configuration file often, so it is a good idea to keep them to a minimum.
4892 If you change the contents of an included file, you must HUP the daemon,
4893 because an included file is read only when the configuration itself is read.
4894
4895 The processing of inclusions happens early, at a physical line level, so, like
4896 comment lines, an inclusion can be used in the middle of an option setting,
4897 for example:
4898 .code
4899 hosts_lookup = a.b.c \
4900                .include /some/file
4901 .endd
4902 Include processing happens after macro processing (see below). Its effect is to
4903 process the lines of the included file as if they occurred inline where the
4904 inclusion appears.
4905
4906
4907
4908 .section "Macros in the configuration file" "SECTmacrodefs"
4909 .cindex "macro" "description of"
4910 .cindex "configuration file" "macros"
4911 If a line in the main part of the configuration (that is, before the first
4912 &"begin"& line) begins with an upper case letter, it is taken as a macro
4913 definition, and must be of the form
4914 .display
4915 <&'name'&> = <&'rest of line'&>
4916 .endd
4917 The name must consist of letters, digits, and underscores, and need not all be
4918 in upper case, though that is recommended. The rest of the line, including any
4919 continuations, is the replacement text, and has leading and trailing white
4920 space removed. Quotes are not removed. The replacement text can never end with
4921 a backslash character, but this doesn't seem to be a serious limitation.
4922
4923 Macros may also be defined between router, transport, authenticator, or ACL
4924 definitions. They may not, however, be defined within an individual driver or
4925 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4926
4927 .section "Macro substitution" "SECID42"
4928 Once a macro is defined, all subsequent lines in the file (and any included
4929 files) are scanned for the macro name; if there are several macros, the line is
4930 scanned for each in turn, in the order in which the macros are defined. The
4931 replacement text is not re-scanned for the current macro, though it is scanned
4932 for subsequently defined macros. For this reason, a macro name may not contain
4933 the name of a previously defined macro as a substring. You could, for example,
4934 define
4935 .display
4936 &`ABCD_XYZ = `&<&'something'&>
4937 &`ABCD = `&<&'something else'&>
4938 .endd
4939 but putting the definitions in the opposite order would provoke a configuration
4940 error. Macro expansion is applied to individual physical lines from the file,
4941 before checking for line continuation or file inclusion (see above). If a line
4942 consists solely of a macro name, and the expansion of the macro is empty, the
4943 line is ignored. A macro at the start of a line may turn the line into a
4944 comment line or a &`.include`& line.
4945
4946
4947 .section "Redefining macros" "SECID43"
4948 Once defined, the value of a macro can be redefined later in the configuration
4949 (or in an included file). Redefinition is specified by using &'=='& instead of
4950 &'='&. For example:
4951 .code
4952 MAC =  initial value
4953 ...
4954 MAC == updated value
4955 .endd
4956 Redefinition does not alter the order in which the macros are applied to the
4957 subsequent lines of the configuration file. It is still the same order in which
4958 the macros were originally defined. All that changes is the macro's value.
4959 Redefinition makes it possible to accumulate values. For example:
4960 .code
4961 MAC =  initial value
4962 ...
4963 MAC == MAC and something added
4964 .endd
4965 This can be helpful in situations where the configuration file is built
4966 from a number of other files.
4967
4968 .section "Overriding macro values" "SECID44"
4969 The values set for macros in the configuration file can be overridden by the
4970 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4971 used, unless called by root or the Exim user. A definition on the command line
4972 using the &%-D%& option causes all definitions and redefinitions within the
4973 file to be ignored.
4974
4975
4976
4977 .section "Example of macro usage" "SECID45"
4978 As an example of macro usage, consider a configuration where aliases are looked
4979 up in a MySQL database. It helps to keep the file less cluttered if long
4980 strings such as SQL statements are defined separately as macros, for example:
4981 .code
4982 ALIAS_QUERY = select mailbox from user where \
4983               login='${quote_mysql:$local_part}';
4984 .endd
4985 This can then be used in a &(redirect)& router setting like this:
4986 .code
4987 data = ${lookup mysql{ALIAS_QUERY}}
4988 .endd
4989 In earlier versions of Exim macros were sometimes used for domain, host, or
4990 address lists. In Exim 4 these are handled better by named lists &-- see
4991 section &<<SECTnamedlists>>&.
4992
4993
4994 .section "Conditional skips in the configuration file" "SECID46"
4995 .cindex "configuration file" "conditional skips"
4996 .cindex "&`.ifdef`&"
4997 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4998 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4999 portions of the configuration file. The processing happens whenever the file is
5000 read (that is, when an Exim binary starts to run).
5001
5002 The implementation is very simple. Instances of the first four directives must
5003 be followed by text that includes the names of one or macros. The condition
5004 that is tested is whether or not any macro substitution has taken place in the
5005 line. Thus:
5006 .code
5007 .ifdef AAA
5008 message_size_limit = 50M
5009 .else
5010 message_size_limit = 100M
5011 .endif
5012 .endd
5013 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5014 otherwise. If there is more than one macro named on the line, the condition
5015 is true if any of them are defined. That is, it is an &"or"& condition. To
5016 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5017
5018 Although you can use a macro expansion to generate one of these directives,
5019 it is not very useful, because the condition &"there was a macro substitution
5020 in this line"& will always be true.
5021
5022 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5023 to clarify complicated nestings.
5024
5025
5026
5027 .section "Common option syntax" "SECTcos"
5028 .cindex "common option syntax"
5029 .cindex "syntax of common options"
5030 .cindex "configuration file" "common option syntax"
5031 For the main set of options, driver options, and &[local_scan()]& options,
5032 each setting is on a line by itself, and starts with a name consisting of
5033 lower-case letters and underscores. Many options require a data value, and in
5034 these cases the name must be followed by an equals sign (with optional white
5035 space) and then the value. For example:
5036 .code
5037 qualify_domain = mydomain.example.com
5038 .endd
5039 .cindex "hiding configuration option values"
5040 .cindex "configuration options" "hiding value of"
5041 .cindex "options" "hiding value of"
5042 Some option settings may contain sensitive data, for example, passwords for
5043 accessing databases. To stop non-admin users from using the &%-bP%& command
5044 line option to read these values, you can precede the option settings with the
5045 word &"hide"&. For example:
5046 .code
5047 hide mysql_servers = localhost/users/admin/secret-password
5048 .endd
5049 For non-admin users, such options are displayed like this:
5050 .code
5051 mysql_servers = <value not displayable>
5052 .endd
5053 If &"hide"& is used on a driver option, it hides the value of that option on
5054 all instances of the same driver.
5055
5056 The following sections describe the syntax used for the different data types
5057 that are found in option settings.
5058
5059
5060 .section "Boolean options" "SECID47"
5061 .cindex "format" "boolean"
5062 .cindex "boolean configuration values"
5063 .oindex "&%no_%&&'xxx'&"
5064 .oindex "&%not_%&&'xxx'&"
5065 Options whose type is given as boolean are on/off switches. There are two
5066 different ways of specifying such options: with and without a data value. If
5067 the option name is specified on its own without data, the switch is turned on;
5068 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5069 boolean options may be followed by an equals sign and one of the words
5070 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5071 the following two settings have exactly the same effect:
5072 .code
5073 queue_only
5074 queue_only = true
5075 .endd
5076 The following two lines also have the same (opposite) effect:
5077 .code
5078 no_queue_only
5079 queue_only = false
5080 .endd
5081 You can use whichever syntax you prefer.
5082
5083
5084
5085
5086 .section "Integer values" "SECID48"
5087 .cindex "integer configuration values"
5088 .cindex "format" "integer"
5089 If an option's type is given as &"integer"&, the value can be given in decimal,
5090 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5091 number is assumed. Otherwise, it is treated as an octal number unless it starts
5092 with the characters &"0x"&, in which case the remainder is interpreted as a
5093 hexadecimal number.
5094
5095 If an integer value is followed by the letter K, it is multiplied by 1024; if
5096 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5097 of integer option settings are output, values which are an exact multiple of
5098 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5099 and M. The printing style is independent of the actual input format that was
5100 used.
5101
5102
5103 .section "Octal integer values" "SECID49"
5104 .cindex "integer format"
5105 .cindex "format" "octal integer"
5106 If an option's type is given as &"octal integer"&, its value is always
5107 interpreted as an octal number, whether or not it starts with the digit zero.
5108 Such options are always output in octal.
5109
5110
5111 .section "Fixed point numbers" "SECID50"
5112 .cindex "fixed point configuration values"
5113 .cindex "format" "fixed point"
5114 If an option's type is given as &"fixed-point"&, its value must be a decimal
5115 integer, optionally followed by a decimal point and up to three further digits.
5116
5117
5118
5119 .section "Time intervals" "SECTtimeformat"
5120 .cindex "time interval" "specifying in configuration"
5121 .cindex "format" "time interval"
5122 A time interval is specified as a sequence of numbers, each followed by one of
5123 the following letters, with no intervening white space:
5124
5125 .table2 30pt
5126 .irow &%s%& seconds
5127 .irow &%m%& minutes
5128 .irow &%h%& hours
5129 .irow &%d%& days
5130 .irow &%w%& weeks
5131 .endtable
5132
5133 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5134 intervals are output in the same format. Exim does not restrict the values; it
5135 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5136
5137
5138
5139 .section "String values" "SECTstrings"
5140 .cindex "string" "format of configuration values"
5141 .cindex "format" "string"
5142 If an option's type is specified as &"string"&, the value can be specified with
5143 or without double-quotes. If it does not start with a double-quote, the value
5144 consists of the remainder of the line plus any continuation lines, starting at
5145 the first character after any leading white space, with trailing white space
5146 removed, and with no interpretation of the characters in the string. Because
5147 Exim removes comment lines (those beginning with #) at an early stage, they can
5148 appear in the middle of a multi-line string. The following two settings are
5149 therefore equivalent:
5150 .code
5151 trusted_users = uucp:mail
5152 trusted_users = uucp:\
5153                 # This comment line is ignored
5154                 mail
5155 .endd
5156 .cindex "string" "quoted"
5157 .cindex "escape characters in quoted strings"
5158 If a string does start with a double-quote, it must end with a closing
5159 double-quote, and any backslash characters other than those used for line
5160 continuation are interpreted as escape characters, as follows:
5161
5162 .table2 100pt
5163 .irow &`\\`&                     "single backslash"
5164 .irow &`\n`&                     "newline"
5165 .irow &`\r`&                     "carriage return"
5166 .irow &`\t`&                     "tab"
5167 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5168 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5169                                    character"
5170 .endtable
5171
5172 If a backslash is followed by some other character, including a double-quote
5173 character, that character replaces the pair.
5174
5175 Quoting is necessary only if you want to make use of the backslash escapes to
5176 insert special characters, or if you need to specify a value with leading or
5177 trailing spaces. These cases are rare, so quoting is almost never needed in
5178 current versions of Exim. In versions of Exim before 3.14, quoting was required
5179 in order to continue lines, so you may come across older configuration files
5180 and examples that apparently quote unnecessarily.
5181
5182
5183 .section "Expanded strings" "SECID51"
5184 .cindex "expansion" "definition of"
5185 Some strings in the configuration file are subjected to &'string expansion'&,
5186 by which means various parts of the string may be changed according to the
5187 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5188 is as just described; in particular, the handling of backslashes in quoted
5189 strings is done as part of the input process, before expansion takes place.
5190 However, backslash is also an escape character for the expander, so any
5191 backslashes that are required for that reason must be doubled if they are
5192 within a quoted configuration string.
5193
5194
5195 .section "User and group names" "SECID52"
5196 .cindex "user name" "format of"
5197 .cindex "format" "user name"
5198 .cindex "groups" "name format"
5199 .cindex "format" "group name"
5200 User and group names are specified as strings, using the syntax described
5201 above, but the strings are interpreted specially. A user or group name must
5202 either consist entirely of digits, or be a name that can be looked up using the
5203 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5204
5205
5206 .section "List construction" "SECTlistconstruct"
5207 .cindex "list" "syntax of in configuration"
5208 .cindex "format" "list item in configuration"
5209 .cindex "string" "list, definition of"
5210 The data for some configuration options is a list of items, with colon as the
5211 default separator. Many of these options are shown with type &"string list"& in
5212 the descriptions later in this document. Others are listed as &"domain list"&,
5213 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5214 are all the same; however, those other than &"string list"& are subject to
5215 particular kinds of interpretation, as described in chapter
5216 &<<CHAPdomhosaddlists>>&.
5217
5218 In all these cases, the entire list is treated as a single string as far as the
5219 input syntax is concerned. The &%trusted_users%& setting in section
5220 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5221 in a list, it must be entered as two colons. Leading and trailing white space
5222 on each item in a list is ignored. This makes it possible to include items that
5223 start with a colon, and in particular, certain forms of IPv6 address. For
5224 example, the list
5225 .code
5226 local_interfaces = 127.0.0.1 : ::::1
5227 .endd
5228 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5229
5230 &*Note*&: Although leading and trailing white space is ignored in individual
5231 list items, it is not ignored when parsing the list. The space after the first
5232 colon in the example above is necessary. If it were not there, the list would
5233 be interpreted as the two items 127.0.0.1:: and 1.
5234
5235 .section "Changing list separators" "SECID53"
5236 .cindex "list separator" "changing"
5237 .cindex "IPv6" "addresses in lists"
5238 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5239 introduced to allow the separator character to be changed. If a list begins
5240 with a left angle bracket, followed by any punctuation character, that
5241 character is used instead of colon as the list separator. For example, the list
5242 above can be rewritten to use a semicolon separator like this:
5243 .code
5244 local_interfaces = <; 127.0.0.1 ; ::1
5245 .endd
5246 This facility applies to all lists, with the exception of the list in
5247 &%log_file_path%&. It is recommended that the use of non-colon separators be
5248 confined to circumstances where they really are needed.
5249
5250 .cindex "list separator" "newline as"
5251 .cindex "newline" "as list separator"
5252 It is also possible to use newline and other control characters (those with
5253 code values less than 32, plus DEL) as separators in lists. Such separators
5254 must be provided literally at the time the list is processed. For options that
5255 are string-expanded, you can write the separator using a normal escape
5256 sequence. This will be processed by the expander before the string is
5257 interpreted as a list. For example, if a newline-separated list of domains is
5258 generated by a lookup, you can process it directly by a line such as this:
5259 .code
5260 domains = <\n ${lookup mysql{.....}}
5261 .endd
5262 This avoids having to change the list separator in such data. You are unlikely
5263 to want to use a control character as a separator in an option that is not
5264 expanded, because the value is literal text. However, it can be done by giving
5265 the value in quotes. For example:
5266 .code
5267 local_interfaces = "<\n 127.0.0.1 \n ::1"
5268 .endd
5269 Unlike printing character separators, which can be included in list items by
5270 doubling, it is not possible to include a control character as data when it is
5271 set as the separator. Two such characters in succession are interpreted as
5272 enclosing an empty list item.
5273
5274
5275
5276 .section "Empty items in lists" "SECTempitelis"
5277 .cindex "list" "empty item in"
5278 An empty item at the end of a list is always ignored. In other words, trailing
5279 separator characters are ignored. Thus, the list in
5280 .code
5281 senders = user@domain :
5282 .endd
5283 contains only a single item. If you want to include an empty string as one item
5284 in a list, it must not be the last item. For example, this list contains three
5285 items, the second of which is empty:
5286 .code
5287 senders = user1@domain : : user2@domain
5288 .endd
5289 &*Note*&: There must be white space between the two colons, as otherwise they
5290 are interpreted as representing a single colon data character (and the list
5291 would then contain just one item). If you want to specify a list that contains
5292 just one, empty item, you can do it as in this example:
5293 .code
5294 senders = :
5295 .endd
5296 In this case, the first item is empty, and the second is discarded because it
5297 is at the end of the list.
5298
5299
5300
5301
5302 .section "Format of driver configurations" "SECTfordricon"
5303 .cindex "drivers" "configuration format"
5304 There are separate parts in the configuration for defining routers, transports,
5305 and authenticators. In each part, you are defining a number of driver
5306 instances, each with its own set of options. Each driver instance is defined by
5307 a sequence of lines like this:
5308 .display
5309 <&'instance name'&>:
5310   <&'option'&>
5311   ...
5312   <&'option'&>
5313 .endd
5314 In the following example, the instance name is &(localuser)&, and it is
5315 followed by three options settings:
5316 .code
5317 localuser:
5318   driver = accept
5319   check_local_user
5320   transport = local_delivery
5321 .endd
5322 For each driver instance, you specify which Exim code module it uses &-- by the
5323 setting of the &%driver%& option &-- and (optionally) some configuration
5324 settings. For example, in the case of transports, if you want a transport to
5325 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5326 a local file you would use the &(appendfile)& driver. Each of the drivers is
5327 described in detail in its own separate chapter later in this manual.
5328
5329 You can have several routers, transports, or authenticators that are based on
5330 the same underlying driver (each must have a different instance name).
5331
5332 The order in which routers are defined is important, because addresses are
5333 passed to individual routers one by one, in order. The order in which
5334 transports are defined does not matter at all. The order in which
5335 authenticators are defined is used only when Exim, as a client, is searching
5336 them to find one that matches an authentication mechanism offered by the
5337 server.
5338
5339 .cindex "generic options"
5340 .cindex "options" "generic &-- definition of"
5341 Within a driver instance definition, there are two kinds of option: &'generic'&
5342 and &'private'&. The generic options are those that apply to all drivers of the
5343 same type (that is, all routers, all transports or all authenticators). The
5344 &%driver%& option is a generic option that must appear in every definition.
5345 .cindex "private options"
5346 The private options are special for each driver, and none need appear, because
5347 they all have default values.
5348
5349 The options may appear in any order, except that the &%driver%& option must
5350 precede any private options, since these depend on the particular driver. For
5351 this reason, it is recommended that &%driver%& always be the first option.
5352
5353 Driver instance names, which are used for reference in log entries and
5354 elsewhere, can be any sequence of letters, digits, and underscores (starting
5355 with a letter) and must be unique among drivers of the same type. A router and
5356 a transport (for example) can each have the same name, but no two router
5357 instances can have the same name. The name of a driver instance should not be
5358 confused with the name of the underlying driver module. For example, the
5359 configuration lines:
5360 .code
5361 remote_smtp:
5362   driver = smtp
5363 .endd
5364 create an instance of the &(smtp)& transport driver whose name is
5365 &(remote_smtp)&. The same driver code can be used more than once, with
5366 different instance names and different option settings each time. A second
5367 instance of the &(smtp)& transport, with different options, might be defined
5368 thus:
5369 .code
5370 special_smtp:
5371   driver = smtp
5372   port = 1234
5373   command_timeout = 10s
5374 .endd
5375 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5376 these transport instances from routers, and these names would appear in log
5377 lines.
5378
5379 Comment lines may be present in the middle of driver specifications. The full
5380 list of option settings for any particular driver instance, including all the
5381 defaulted values, can be extracted by making use of the &%-bP%& command line
5382 option.
5383
5384
5385
5386
5387
5388
5389 . ////////////////////////////////////////////////////////////////////////////
5390 . ////////////////////////////////////////////////////////////////////////////
5391
5392 .chapter "The default configuration file" "CHAPdefconfil"
5393 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5394 .cindex "default" "configuration file &""walk through""&"
5395 The default configuration file supplied with Exim as &_src/configure.default_&
5396 is sufficient for a host with simple mail requirements. As an introduction to
5397 the way Exim is configured, this chapter &"walks through"& the default
5398 configuration, giving brief explanations of the settings. Detailed descriptions
5399 of the options are given in subsequent chapters. The default configuration file
5400 itself contains extensive comments about ways you might want to modify the
5401 initial settings. However, note that there are many options that are not
5402 mentioned at all in the default configuration.
5403
5404
5405
5406 .section "Main configuration settings" "SECTdefconfmain"
5407 The main (global) configuration option settings must always come first in the
5408 file. The first thing you'll see in the file, after some initial comments, is
5409 the line
5410 .code
5411 # primary_hostname =
5412 .endd
5413 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5414 to know the official, fully qualified name of your host, and this is where you
5415 can specify it. However, in most cases you do not need to set this option. When
5416 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5417
5418 The first three non-comment configuration lines are as follows:
5419 .code
5420 domainlist local_domains    = @
5421 domainlist relay_to_domains =
5422 hostlist   relay_from_hosts = 127.0.0.1
5423 .endd
5424 These are not, in fact, option settings. They are definitions of two named
5425 domain lists and one named host list. Exim allows you to give names to lists of
5426 domains, hosts, and email addresses, in order to make it easier to manage the
5427 configuration file (see section &<<SECTnamedlists>>&).
5428
5429 The first line defines a domain list called &'local_domains'&; this is used
5430 later in the configuration to identify domains that are to be delivered
5431 on the local host.
5432
5433 .cindex "@ in a domain list"
5434 There is just one item in this list, the string &"@"&. This is a special form
5435 of entry which means &"the name of the local host"&. Thus, if the local host is
5436 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5437 be delivered locally. Because the local host's name is referenced indirectly,
5438 the same configuration file can be used on different hosts.
5439
5440 The second line defines a domain list called &'relay_to_domains'&, but the
5441 list itself is empty. Later in the configuration we will come to the part that
5442 controls mail relaying through the local host; it allows relaying to any
5443 domains in this list. By default, therefore, no relaying on the basis of a mail
5444 domain is permitted.
5445
5446 The third line defines a host list called &'relay_from_hosts'&. This list is
5447 used later in the configuration to permit relaying from any host or IP address
5448 that matches the list. The default contains just the IP address of the IPv4
5449 loopback interface, which means that processes on the local host are able to
5450 submit mail for relaying by sending it over TCP/IP to that interface. No other
5451 hosts are permitted to submit messages for relaying.
5452
5453 Just to be sure there's no misunderstanding: at this point in the configuration
5454 we aren't actually setting up any controls. We are just defining some domains
5455 and hosts that will be used in the controls that are specified later.
5456
5457 The next two configuration lines are genuine option settings:
5458 .code
5459 acl_smtp_rcpt = acl_check_rcpt
5460 acl_smtp_data = acl_check_data
5461 .endd
5462 These options specify &'Access Control Lists'& (ACLs) that are to be used
5463 during an incoming SMTP session for every recipient of a message (every RCPT
5464 command), and after the contents of the message have been received,
5465 respectively. The names of the lists are &'acl_check_rcpt'& and
5466 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5467 section of the configuration. The RCPT ACL controls which recipients are
5468 accepted for an incoming message &-- if a configuration does not provide an ACL
5469 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5470 contents of a message to be checked.
5471
5472 Two commented-out option settings are next:
5473 .code
5474 # av_scanner = clamd:/tmp/clamd
5475 # spamd_address = 127.0.0.1 783
5476 .endd
5477 These are example settings that can be used when Exim is compiled with the
5478 content-scanning extension. The first specifies the interface to the virus
5479 scanner, and the second specifies the interface to SpamAssassin. Further
5480 details are given in chapter &<<CHAPexiscan>>&.
5481
5482 Three more commented-out option settings follow:
5483 .code
5484 # tls_advertise_hosts = *
5485 # tls_certificate = /etc/ssl/exim.crt
5486 # tls_privatekey = /etc/ssl/exim.pem
5487 .endd
5488 These are example settings that can be used when Exim is compiled with
5489 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5490 first one specifies the list of clients that are allowed to use TLS when
5491 connecting to this server; in this case the wildcard means all clients. The
5492 other options specify where Exim should find its TLS certificate and private
5493 key, which together prove the server's identity to any clients that connect.
5494 More details are given in chapter &<<CHAPTLS>>&.
5495
5496 Another two commented-out option settings follow:
5497 .code
5498 # daemon_smtp_ports = 25 : 465 : 587
5499 # tls_on_connect_ports = 465
5500 .endd
5501 .cindex "port" "465 and 587"
5502 .cindex "port" "for message submission"
5503 .cindex "message" "submission, ports for"
5504 .cindex "ssmtp protocol"
5505 .cindex "smtps protocol"
5506 .cindex "SMTP" "ssmtp protocol"
5507 .cindex "SMTP" "smtps protocol"
5508 These options provide better support for roaming users who wish to use this
5509 server for message submission. They are not much use unless you have turned on
5510 TLS (as described in the previous paragraph) and authentication (about which
5511 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5512 on end-user networks, so RFC 4409 specifies that message submission should use
5513 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5514 configured to use port 587 correctly, so these settings also enable the
5515 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5516 &<<SECTsupobssmt>>&).
5517
5518 Two more commented-out options settings follow:
5519 .code
5520 # qualify_domain =
5521 # qualify_recipient =
5522 .endd
5523 The first of these specifies a domain that Exim uses when it constructs a
5524 complete email address from a local login name. This is often needed when Exim
5525 receives a message from a local process. If you do not set &%qualify_domain%&,
5526 the value of &%primary_hostname%& is used. If you set both of these options,
5527 you can have different qualification domains for sender and recipient
5528 addresses. If you set only the first one, its value is used in both cases.
5529
5530 .cindex "domain literal" "recognizing format"
5531 The following line must be uncommented if you want Exim to recognize
5532 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5533 (an IP address within square brackets) instead of a named domain.
5534 .code
5535 # allow_domain_literals
5536 .endd
5537 The RFCs still require this form, but many people think that in the modern
5538 Internet it makes little sense to permit mail to be sent to specific hosts by
5539 quoting their IP addresses. This ancient format has been used by people who
5540 try to abuse hosts by using them for unwanted relaying. However, some
5541 people believe there are circumstances (for example, messages addressed to
5542 &'postmaster'&) where domain literals are still useful.
5543
5544 The next configuration line is a kind of trigger guard:
5545 .code
5546 never_users = root
5547 .endd
5548 It specifies that no delivery must ever be run as the root user. The normal
5549 convention is to set up &'root'& as an alias for the system administrator. This
5550 setting is a guard against slips in the configuration.
5551 The list of users specified by &%never_users%& is not, however, the complete
5552 list; the build-time configuration in &_Local/Makefile_& has an option called
5553 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5554 contents of &%never_users%& are added to this list. By default
5555 FIXED_NEVER_USERS also specifies root.
5556
5557 When a remote host connects to Exim in order to send mail, the only information
5558 Exim has about the host's identity is its IP address. The next configuration
5559 line,
5560 .code
5561 host_lookup = *
5562 .endd
5563 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5564 in order to get a host name. This improves the quality of the logging
5565 information, but if you feel it is too expensive, you can remove it entirely,
5566 or restrict the lookup to hosts on &"nearby"& networks.
5567 Note that it is not always possible to find a host name from an IP address,
5568 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5569 unreachable.
5570
5571 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5572 1413 (hence their names):
5573 .code
5574 rfc1413_hosts = *
5575 rfc1413_query_timeout = 0s
5576 .endd
5577 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5578 Few hosts offer RFC1413 service these days; calls have to be
5579 terminated by a timeout and this needlessly delays the startup
5580 of an incoming SMTP connection.
5581 If you have hosts for which you trust RFC1413 and need this
5582 information, you can change this.
5583
5584 This line enables an efficiency SMTP option.  It is negotiated by clients
5585 and not expected to cause problems but can be disabled if needed.
5586 .code
5587 prdr_enable = true
5588 .endd
5589
5590 When Exim receives messages over SMTP connections, it expects all addresses to
5591 be fully qualified with a domain, as required by the SMTP definition. However,
5592 if you are running a server to which simple clients submit messages, you may
5593 find that they send unqualified addresses. The two commented-out options:
5594 .code
5595 # sender_unqualified_hosts =
5596 # recipient_unqualified_hosts =
5597 .endd
5598 show how you can specify hosts that are permitted to send unqualified sender
5599 and recipient addresses, respectively.
5600
5601 The &%percent_hack_domains%& option is also commented out:
5602 .code
5603 # percent_hack_domains =
5604 .endd
5605 It provides a list of domains for which the &"percent hack"& is to operate.
5606 This is an almost obsolete form of explicit email routing. If you do not know
5607 anything about it, you can safely ignore this topic.
5608
5609 The last two settings in the main part of the default configuration are
5610 concerned with messages that have been &"frozen"& on Exim's queue. When a
5611 message is frozen, Exim no longer continues to try to deliver it. Freezing
5612 occurs when a bounce message encounters a permanent failure because the sender
5613 address of the original message that caused the bounce is invalid, so the
5614 bounce cannot be delivered. This is probably the most common case, but there
5615 are also other conditions that cause freezing, and frozen messages are not
5616 always bounce messages.
5617 .code
5618 ignore_bounce_errors_after = 2d
5619 timeout_frozen_after = 7d
5620 .endd
5621 The first of these options specifies that failing bounce messages are to be
5622 discarded after 2 days on the queue. The second specifies that any frozen
5623 message (whether a bounce message or not) is to be timed out (and discarded)
5624 after a week. In this configuration, the first setting ensures that no failing
5625 bounce message ever lasts a week.
5626
5627
5628
5629 .section "ACL configuration" "SECID54"
5630 .cindex "default" "ACLs"
5631 .cindex "&ACL;" "default configuration"
5632 In the default configuration, the ACL section follows the main configuration.
5633 It starts with the line
5634 .code
5635 begin acl
5636 .endd
5637 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5638 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5639 and &%acl_smtp_data%& above.
5640
5641 .cindex "RCPT" "ACL for"
5642 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5643 RCPT command specifies one of the message's recipients. The ACL statements
5644 are considered in order, until the recipient address is either accepted or
5645 rejected. The RCPT command is then accepted or rejected, according to the
5646 result of the ACL processing.
5647 .code
5648 acl_check_rcpt:
5649 .endd
5650 This line, consisting of a name terminated by a colon, marks the start of the
5651 ACL, and names it.
5652 .code
5653 accept  hosts = :
5654 .endd
5655 This ACL statement accepts the recipient if the sending host matches the list.
5656 But what does that strange list mean? It doesn't actually contain any host
5657 names or IP addresses. The presence of the colon puts an empty item in the
5658 list; Exim matches this only if the incoming message did not come from a remote
5659 host, because in that case, the remote hostname is empty. The colon is
5660 important. Without it, the list itself is empty, and can never match anything.
5661
5662 What this statement is doing is to accept unconditionally all recipients in
5663 messages that are submitted by SMTP from local processes using the standard
5664 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5665 manner.
5666 .code
5667 deny    message       = Restricted characters in address
5668         domains       = +local_domains
5669         local_parts   = ^[.] : ^.*[@%!/|]
5670
5671 deny    message       = Restricted characters in address
5672         domains       = !+local_domains
5673         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5674 .endd
5675 These statements are concerned with local parts that contain any of the
5676 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5677 Although these characters are entirely legal in local parts (in the case of
5678 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5679 in Internet mail addresses.
5680
5681 The first three have in the past been associated with explicitly routed
5682 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5683 option). Addresses containing these characters are regularly tried by spammers
5684 in an attempt to bypass relaying restrictions, and also by open relay testing
5685 programs. Unless you really need them it is safest to reject these characters
5686 at this early stage. This configuration is heavy-handed in rejecting these
5687 characters for all messages it accepts from remote hosts. This is a deliberate
5688 policy of being as safe as possible.
5689
5690 The first rule above is stricter, and is applied to messages that are addressed
5691 to one of the local domains handled by this host. This is implemented by the
5692 first condition, which restricts it to domains that are listed in the
5693 &'local_domains'& domain list. The &"+"& character is used to indicate a
5694 reference to a named list. In this configuration, there is just one domain in
5695 &'local_domains'&, but in general there may be many.
5696
5697 The second condition on the first statement uses two regular expressions to
5698 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5699 or &"|"&. If you have local accounts that include these characters, you will
5700 have to modify this rule.
5701
5702 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5703 allows them because they have been encountered in practice. (Consider the
5704 common convention of local parts constructed as
5705 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5706 the author of Exim, who has no second initial.) However, a local part starting
5707 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5708 file name (for example, for a mailing list). This is also true for local parts
5709 that contain slashes. A pipe symbol can also be troublesome if the local part
5710 is incorporated unthinkingly into a shell command line.
5711
5712 The second rule above applies to all other domains, and is less strict. This
5713 allows your own users to send outgoing messages to sites that use slashes
5714 and vertical bars in their local parts. It blocks local parts that begin
5715 with a dot, slash, or vertical bar, but allows these characters within the
5716 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5717 and &"!"& is blocked, as before. The motivation here is to prevent your users
5718 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5719 .code
5720 accept  local_parts   = postmaster
5721         domains       = +local_domains
5722 .endd
5723 This statement, which has two conditions, accepts an incoming address if the
5724 local part is &'postmaster'& and the domain is one of those listed in the
5725 &'local_domains'& domain list. The &"+"& character is used to indicate a
5726 reference to a named list. In this configuration, there is just one domain in
5727 &'local_domains'&, but in general there may be many.
5728
5729 The presence of this statement means that mail to postmaster is never blocked
5730 by any of the subsequent tests. This can be helpful while sorting out problems
5731 in cases where the subsequent tests are incorrectly denying access.
5732 .code
5733 require verify        = sender
5734 .endd
5735 This statement requires the sender address to be verified before any subsequent
5736 ACL statement can be used. If verification fails, the incoming recipient
5737 address is refused. Verification consists of trying to route the address, to
5738 see if a bounce message could be delivered to it. In the case of remote
5739 addresses, basic verification checks only the domain, but &'callouts'& can be
5740 used for more verification if required. Section &<<SECTaddressverification>>&
5741 discusses the details of address verification.
5742 .code
5743 accept  hosts         = +relay_from_hosts
5744         control       = submission
5745 .endd
5746 This statement accepts the address if the message is coming from one of the
5747 hosts that are defined as being allowed to relay through this host. Recipient
5748 verification is omitted here, because in many cases the clients are dumb MUAs
5749 that do not cope well with SMTP error responses. For the same reason, the
5750 second line specifies &"submission mode"& for messages that are accepted. This
5751 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5752 messages that are deficient in some way, for example, because they lack a
5753 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5754 probably add recipient verification here, and disable submission mode.
5755 .code
5756 accept  authenticated = *
5757         control       = submission
5758 .endd
5759 This statement accepts the address if the client host has authenticated itself.
5760 Submission mode is again specified, on the grounds that such messages are most
5761 likely to come from MUAs. The default configuration does not define any
5762 authenticators, though it does include some nearly complete commented-out
5763 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5764 fact authenticate until you complete the authenticator definitions.
5765 .code
5766 require message = relay not permitted
5767         domains = +local_domains : +relay_to_domains
5768 .endd
5769 This statement rejects the address if its domain is neither a local domain nor
5770 one of the domains for which this host is a relay.
5771 .code
5772 require verify = recipient
5773 .endd
5774 This statement requires the recipient address to be verified; if verification
5775 fails, the address is rejected.
5776 .code
5777 # deny    message     = rejected because $sender_host_address \
5778 #                       is in a black list at $dnslist_domain\n\
5779 #                       $dnslist_text
5780 #         dnslists    = black.list.example
5781 #
5782 # warn    dnslists    = black.list.example
5783 #         add_header  = X-Warning: $sender_host_address is in \
5784 #                       a black list at $dnslist_domain
5785 #         log_message = found in $dnslist_domain
5786 .endd
5787 These commented-out lines are examples of how you could configure Exim to check
5788 sending hosts against a DNS black list. The first statement rejects messages
5789 from blacklisted hosts, whereas the second just inserts a warning header
5790 line.
5791 .code
5792 # require verify = csa
5793 .endd
5794 This commented-out line is an example of how you could turn on client SMTP
5795 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5796 records.
5797 .code
5798 accept
5799 .endd
5800 The final statement in the first ACL unconditionally accepts any recipient
5801 address that has successfully passed all the previous tests.
5802 .code
5803 acl_check_data:
5804 .endd
5805 This line marks the start of the second ACL, and names it. Most of the contents
5806 of this ACL are commented out:
5807 .code
5808 # deny    malware   = *
5809 #         message   = This message contains a virus \
5810 #                     ($malware_name).
5811 .endd
5812 These lines are examples of how to arrange for messages to be scanned for
5813 viruses when Exim has been compiled with the content-scanning extension, and a
5814 suitable virus scanner is installed. If the message is found to contain a
5815 virus, it is rejected with the given custom error message.
5816 .code
5817 # warn    spam      = nobody
5818 #         message   = X-Spam_score: $spam_score\n\
5819 #                     X-Spam_score_int: $spam_score_int\n\
5820 #                     X-Spam_bar: $spam_bar\n\
5821 #                     X-Spam_report: $spam_report
5822 .endd
5823 These lines are an example of how to arrange for messages to be scanned by
5824 SpamAssassin when Exim has been compiled with the content-scanning extension,
5825 and SpamAssassin has been installed. The SpamAssassin check is run with
5826 &`nobody`& as its user parameter, and the results are added to the message as a
5827 series of extra header line. In this case, the message is not rejected,
5828 whatever the spam score.
5829 .code
5830 accept
5831 .endd
5832 This final line in the DATA ACL accepts the message unconditionally.
5833
5834
5835 .section "Router configuration" "SECID55"
5836 .cindex "default" "routers"
5837 .cindex "routers" "default"
5838 The router configuration comes next in the default configuration, introduced
5839 by the line
5840 .code
5841 begin routers
5842 .endd
5843 Routers are the modules in Exim that make decisions about where to send
5844 messages. An address is passed to each router in turn, until it is either
5845 accepted, or failed. This means that the order in which you define the routers
5846 matters. Each router is fully described in its own chapter later in this
5847 manual. Here we give only brief overviews.
5848 .code
5849 # domain_literal:
5850 #   driver = ipliteral
5851 #   domains = !+local_domains
5852 #   transport = remote_smtp
5853 .endd
5854 .cindex "domain literal" "default router"
5855 This router is commented out because the majority of sites do not want to
5856 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5857 you uncomment this router, you also need to uncomment the setting of
5858 &%allow_domain_literals%& in the main part of the configuration.
5859 .code
5860 dnslookup:
5861   driver = dnslookup
5862   domains = ! +local_domains
5863   transport = remote_smtp
5864   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5865   no_more
5866 .endd
5867 The first uncommented router handles addresses that do not involve any local
5868 domains. This is specified by the line
5869 .code
5870 domains = ! +local_domains
5871 .endd
5872 The &%domains%& option lists the domains to which this router applies, but the
5873 exclamation mark is a negation sign, so the router is used only for domains
5874 that are not in the domain list called &'local_domains'& (which was defined at
5875 the start of the configuration). The plus sign before &'local_domains'&
5876 indicates that it is referring to a named list. Addresses in other domains are
5877 passed on to the following routers.
5878
5879 The name of the router driver is &(dnslookup)&,
5880 and is specified by the &%driver%& option. Do not be confused by the fact that
5881 the name of this router instance is the same as the name of the driver. The
5882 instance name is arbitrary, but the name set in the &%driver%& option must be
5883 one of the driver modules that is in the Exim binary.
5884
5885 The &(dnslookup)& router routes addresses by looking up their domains in the
5886 DNS in order to obtain a list of hosts to which the address is routed. If the
5887 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5888 specified by the &%transport%& option. If the router does not find the domain
5889 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5890 the address fails and is bounced.
5891
5892 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5893 be entirely ignored. This option is present because a number of cases have been
5894 encountered where MX records in the DNS point to host names
5895 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5896 Completely ignoring these IP addresses causes Exim to fail to route the
5897 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5898 continue to try to deliver the message periodically until the address timed
5899 out.
5900 .code
5901 system_aliases:
5902   driver = redirect
5903   allow_fail
5904   allow_defer
5905   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5906 # user = exim
5907   file_transport = address_file
5908   pipe_transport = address_pipe
5909 .endd
5910 Control reaches this and subsequent routers only for addresses in the local
5911 domains. This router checks to see whether the local part is defined as an
5912 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5913 data that it looks up from that file. If no data is found for the local part,
5914 the value of the &%data%& option is empty, causing the address to be passed to
5915 the next router.
5916
5917 &_/etc/aliases_& is a conventional name for the system aliases file that is
5918 often used. That is why it is referenced by from the default configuration
5919 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5920 &_Local/Makefile_& before building Exim.
5921 .code
5922 userforward:
5923   driver = redirect
5924   check_local_user
5925 # local_part_suffix = +* : -*
5926 # local_part_suffix_optional
5927   file = $home/.forward
5928 # allow_filter
5929   no_verify
5930   no_expn
5931   check_ancestor
5932   file_transport = address_file
5933   pipe_transport = address_pipe
5934   reply_transport = address_reply
5935 .endd
5936 This is the most complicated router in the default configuration. It is another
5937 redirection router, but this time it is looking for forwarding data set up by
5938 individual users. The &%check_local_user%& setting specifies a check that the
5939 local part of the address is the login name of a local user. If it is not, the
5940 router is skipped. The two commented options that follow &%check_local_user%&,
5941 namely:
5942 .code
5943 # local_part_suffix = +* : -*
5944 # local_part_suffix_optional
5945 .endd
5946 .vindex "&$local_part_suffix$&"
5947 show how you can specify the recognition of local part suffixes. If the first
5948 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5949 by any sequence of characters, is removed from the local part and placed in the
5950 variable &$local_part_suffix$&. The second suffix option specifies that the
5951 presence of a suffix in the local part is optional. When a suffix is present,
5952 the check for a local login uses the local part with the suffix removed.
5953
5954 When a local user account is found, the file called &_.forward_& in the user's
5955 home directory is consulted. If it does not exist, or is empty, the router
5956 declines. Otherwise, the contents of &_.forward_& are interpreted as
5957 redirection data (see chapter &<<CHAPredirect>>& for more details).
5958
5959 .cindex "Sieve filter" "enabling in default router"
5960 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5961 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5962 is commented out by default), the contents of the file are interpreted as a set
5963 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5964 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5965 separate document entitled &'Exim's interfaces to mail filtering'&.
5966
5967 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5968 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5969 There are two reasons for doing this:
5970
5971 .olist
5972 Whether or not a local user has a &_.forward_& file is not really relevant when
5973 checking an address for validity; it makes sense not to waste resources doing
5974 unnecessary work.
5975 .next
5976 More importantly, when Exim is verifying addresses or handling an EXPN
5977 command during an SMTP session, it is running as the Exim user, not as root.
5978 The group is the Exim group, and no additional groups are set up.
5979 It may therefore not be possible for Exim to read users' &_.forward_& files at
5980 this time.
5981 .endlist
5982
5983 The setting of &%check_ancestor%& prevents the router from generating a new
5984 address that is the same as any previous address that was redirected. (This
5985 works round a problem concerning a bad interaction between aliasing and
5986 forwarding &-- see section &<<SECTredlocmai>>&).
5987
5988 The final three option settings specify the transports that are to be used when
5989 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5990 auto-reply, respectively. For example, if a &_.forward_& file contains
5991 .code
5992 a.nother@elsewhere.example, /home/spqr/archive
5993 .endd
5994 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5995 transport.
5996 .code
5997 localuser:
5998   driver = accept
5999   check_local_user
6000 # local_part_suffix = +* : -*
6001 # local_part_suffix_optional
6002   transport = local_delivery
6003 .endd
6004 The final router sets up delivery into local mailboxes, provided that the local
6005 part is the name of a local login, by accepting the address and assigning it to
6006 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6007 routers, so the address is bounced. The commented suffix settings fulfil the
6008 same purpose as they do for the &(userforward)& router.
6009
6010
6011 .section "Transport configuration" "SECID56"
6012 .cindex "default" "transports"
6013 .cindex "transports" "default"
6014 Transports define mechanisms for actually delivering messages. They operate
6015 only when referenced from routers, so the order in which they are defined does
6016 not matter. The transports section of the configuration starts with
6017 .code
6018 begin transports
6019 .endd
6020 One remote transport and four local transports are defined.
6021 .code
6022 remote_smtp:
6023   driver = smtp
6024   hosts_try_prdr = *
6025 .endd
6026 This transport is used for delivering messages over SMTP connections.
6027 The list of remote hosts comes from the router.
6028 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6029 It is negotiated between client and server
6030 and not expected to cause problems but can be disabled if needed.
6031 All other options are defaulted.
6032 .code
6033 local_delivery:
6034   driver = appendfile
6035   file = /var/mail/$local_part
6036   delivery_date_add
6037   envelope_to_add
6038   return_path_add
6039 # group = mail
6040 # mode = 0660
6041 .endd
6042 This &(appendfile)& transport is used for local delivery to user mailboxes in
6043 traditional BSD mailbox format. By default it runs under the uid and gid of the
6044 local user, which requires the sticky bit to be set on the &_/var/mail_&
6045 directory. Some systems use the alternative approach of running mail deliveries
6046 under a particular group instead of using the sticky bit. The commented options
6047 show how this can be done.
6048
6049 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6050 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6051 similarly-named options above.
6052 .code
6053 address_pipe:
6054   driver = pipe
6055   return_output
6056 .endd
6057 This transport is used for handling deliveries to pipes that are generated by
6058 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6059 option specifies that any output generated by the pipe is to be returned to the
6060 sender.
6061 .code
6062 address_file:
6063   driver = appendfile
6064   delivery_date_add
6065   envelope_to_add
6066   return_path_add
6067 .endd
6068 This transport is used for handling deliveries to files that are generated by
6069 redirection. The name of the file is not specified in this instance of
6070 &(appendfile)&, because it comes from the &(redirect)& router.
6071 .code
6072 address_reply:
6073   driver = autoreply
6074 .endd
6075 This transport is used for handling automatic replies generated by users'
6076 filter files.
6077
6078
6079
6080 .section "Default retry rule" "SECID57"
6081 .cindex "retry" "default rule"
6082 .cindex "default" "retry rule"
6083 The retry section of the configuration file contains rules which affect the way
6084 Exim retries deliveries that cannot be completed at the first attempt. It is
6085 introduced by the line
6086 .code
6087 begin retry
6088 .endd
6089 In the default configuration, there is just one rule, which applies to all
6090 errors:
6091 .code
6092 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6093 .endd
6094 This causes any temporarily failing address to be retried every 15 minutes for
6095 2 hours, then at intervals starting at one hour and increasing by a factor of
6096 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6097 is not delivered after 4 days of temporary failure, it is bounced.
6098
6099 If the retry section is removed from the configuration, or is empty (that is,
6100 if no retry rules are defined), Exim will not retry deliveries. This turns
6101 temporary errors into permanent errors.
6102
6103
6104 .section "Rewriting configuration" "SECID58"
6105 The rewriting section of the configuration, introduced by
6106 .code
6107 begin rewrite
6108 .endd
6109 contains rules for rewriting addresses in messages as they arrive. There are no
6110 rewriting rules in the default configuration file.
6111
6112
6113
6114 .section "Authenticators configuration" "SECTdefconfauth"
6115 .cindex "AUTH" "configuration"
6116 The authenticators section of the configuration, introduced by
6117 .code
6118 begin authenticators
6119 .endd
6120 defines mechanisms for the use of the SMTP AUTH command. The default
6121 configuration file contains two commented-out example authenticators
6122 which support plaintext username/password authentication using the
6123 standard PLAIN mechanism and the traditional but non-standard LOGIN
6124 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6125 to support most MUA software.
6126
6127 The example PLAIN authenticator looks like this:
6128 .code
6129 #PLAIN:
6130 #  driver                  = plaintext
6131 #  server_set_id           = $auth2
6132 #  server_prompts          = :
6133 #  server_condition        = Authentication is not yet configured
6134 #  server_advertise_condition = ${if def:tls_in_cipher }
6135 .endd
6136 And the example LOGIN authenticator looks like this:
6137 .code
6138 #LOGIN:
6139 #  driver                  = plaintext
6140 #  server_set_id           = $auth1
6141 #  server_prompts          = <| Username: | Password:
6142 #  server_condition        = Authentication is not yet configured
6143 #  server_advertise_condition = ${if def:tls_in_cipher }
6144 .endd
6145
6146 The &%server_set_id%& option makes Exim remember the authenticated username
6147 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6148 &%server_prompts%& option configures the &(plaintext)& authenticator so
6149 that it implements the details of the specific authentication mechanism,
6150 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6151 when Exim offers authentication to clients; in the examples, this is only
6152 when TLS or SSL has been started, so to enable the authenticators you also
6153 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6154
6155 The &%server_condition%& setting defines how to verify that the username and
6156 password are correct. In the examples it just produces an error message.
6157 To make the authenticators work, you can use a string expansion
6158 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6159
6160 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6161 usercode and password are in different positions.
6162 Chapter &<<CHAPplaintext>>& covers both.
6163
6164 .ecindex IIDconfiwal
6165
6166
6167
6168 . ////////////////////////////////////////////////////////////////////////////
6169 . ////////////////////////////////////////////////////////////////////////////
6170
6171 .chapter "Regular expressions" "CHAPregexp"
6172
6173 .cindex "regular expressions" "library"
6174 .cindex "PCRE"
6175 Exim supports the use of regular expressions in many of its options. It
6176 uses the PCRE regular expression library; this provides regular expression
6177 matching that is compatible with Perl 5. The syntax and semantics of
6178 regular expressions is discussed in many Perl reference books, and also in
6179 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6180 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6181
6182 The documentation for the syntax and semantics of the regular expressions that
6183 are supported by PCRE is included in the PCRE distribution, and no further
6184 description is included here. The PCRE functions are called from Exim using
6185 the default option settings (that is, with no PCRE options set), except that
6186 the PCRE_CASELESS option is set when the matching is required to be
6187 case-insensitive.
6188
6189 In most cases, when a regular expression is required in an Exim configuration,
6190 it has to start with a circumflex, in order to distinguish it from plain text
6191 or an &"ends with"& wildcard. In this example of a configuration setting, the
6192 second item in the colon-separated list is a regular expression.
6193 .code
6194 domains = a.b.c : ^\\d{3} : *.y.z : ...
6195 .endd
6196 The doubling of the backslash is required because of string expansion that
6197 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6198 of this issue, and a way of avoiding the need for doubling backslashes. The
6199 regular expression that is eventually used in this example contains just one
6200 backslash. The circumflex is included in the regular expression, and has the
6201 normal effect of &"anchoring"& it to the start of the string that is being
6202 matched.
6203
6204 There are, however, two cases where a circumflex is not required for the
6205 recognition of a regular expression: these are the &%match%& condition in a
6206 string expansion, and the &%matches%& condition in an Exim filter file. In
6207 these cases, the relevant string is always treated as a regular expression; if
6208 it does not start with a circumflex, the expression is not anchored, and can
6209 match anywhere in the subject string.
6210
6211 In all cases, if you want a regular expression to match at the end of a string,
6212 you must code the $ metacharacter to indicate this. For example:
6213 .code
6214 domains = ^\\d{3}\\.example
6215 .endd
6216 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6217 You need to use:
6218 .code
6219 domains = ^\\d{3}\\.example\$
6220 .endd
6221 if you want &'example'& to be the top-level domain. The backslash before the
6222 $ is needed because string expansion also interprets dollar characters.
6223
6224
6225
6226 . ////////////////////////////////////////////////////////////////////////////
6227 . ////////////////////////////////////////////////////////////////////////////
6228
6229 .chapter "File and database lookups" "CHAPfdlookup"
6230 .scindex IIDfidalo1 "file" "lookups"
6231 .scindex IIDfidalo2 "database" "lookups"
6232 .cindex "lookup" "description of"
6233 Exim can be configured to look up data in files or databases as it processes
6234 messages. Two different kinds of syntax are used:
6235
6236 .olist
6237 A string that is to be expanded may contain explicit lookup requests. These
6238 cause parts of the string to be replaced by data that is obtained from the
6239 lookup. Lookups of this type are conditional expansion items. Different results
6240 can be defined for the cases of lookup success and failure. See chapter
6241 &<<CHAPexpand>>&, where string expansions are described in detail.
6242 .next
6243 Lists of domains, hosts, and email addresses can contain lookup requests as a
6244 way of avoiding excessively long linear lists. In this case, the data that is
6245 returned by the lookup is often (but not always) discarded; whether the lookup
6246 succeeds or fails is what really counts. These kinds of list are described in
6247 chapter &<<CHAPdomhosaddlists>>&.
6248 .endlist
6249
6250 String expansions, lists, and lookups interact with each other in such a way
6251 that there is no order in which to describe any one of them that does not
6252 involve references to the others. Each of these three chapters makes more sense
6253 if you have read the other two first. If you are reading this for the first
6254 time, be aware that some of it will make a lot more sense after you have read
6255 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6256
6257 .section "Examples of different lookup syntax" "SECID60"
6258 It is easy to confuse the two different kinds of lookup, especially as the
6259 lists that may contain the second kind are always expanded before being
6260 processed as lists. Therefore, they may also contain lookups of the first kind.
6261 Be careful to distinguish between the following two examples:
6262 .code
6263 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6264 domains = lsearch;/some/file
6265 .endd
6266 The first uses a string expansion, the result of which must be a domain list.
6267 No strings have been specified for a successful or a failing lookup; the
6268 defaults in this case are the looked-up data and an empty string, respectively.
6269 The expansion takes place before the string is processed as a list, and the
6270 file that is searched could contain lines like this:
6271 .code
6272 192.168.3.4: domain1:domain2:...
6273 192.168.1.9: domain3:domain4:...
6274 .endd
6275 When the lookup succeeds, the result of the expansion is a list of domains (and
6276 possibly other types of item that are allowed in domain lists).
6277
6278 In the second example, the lookup is a single item in a domain list. It causes
6279 Exim to use a lookup to see if the domain that is being processed can be found
6280 in the file. The file could contains lines like this:
6281 .code
6282 domain1:
6283 domain2:
6284 .endd
6285 Any data that follows the keys is not relevant when checking that the domain
6286 matches the list item.
6287
6288 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6289 Consider a file containing lines like this:
6290 .code
6291 192.168.5.6: lsearch;/another/file
6292 .endd
6293 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6294 first &%domains%& setting above generates the second setting, which therefore
6295 causes a second lookup to occur.
6296
6297 The rest of this chapter describes the different lookup types that are
6298 available. Any of them can be used in any part of the configuration where a
6299 lookup is permitted.
6300
6301
6302 .section "Lookup types" "SECID61"
6303 .cindex "lookup" "types of"
6304 .cindex "single-key lookup" "definition of"
6305 Two different types of data lookup are implemented:
6306
6307 .ilist
6308 The &'single-key'& type requires the specification of a file in which to look,
6309 and a single key to search for. The key must be a non-empty string for the
6310 lookup to succeed. The lookup type determines how the file is searched.
6311 .next
6312 .cindex "query-style lookup" "definition of"
6313 The &'query-style'& type accepts a generalized database query. No particular
6314 key value is assumed by Exim for query-style lookups. You can use whichever
6315 Exim variables you need to construct the database query.
6316 .endlist
6317
6318 The code for each lookup type is in a separate source file that is included in
6319 the binary of Exim only if the corresponding compile-time option is set. The
6320 default settings in &_src/EDITME_& are:
6321 .code
6322 LOOKUP_DBM=yes
6323 LOOKUP_LSEARCH=yes
6324 .endd
6325 which means that only linear searching and DBM lookups are included by default.
6326 For some types of lookup (e.g. SQL databases), you need to install appropriate
6327 libraries and header files before building Exim.
6328
6329
6330
6331
6332 .section "Single-key lookup types" "SECTsinglekeylookups"
6333 .cindex "lookup" "single-key types"
6334 .cindex "single-key lookup" "list of types"
6335 The following single-key lookup types are implemented:
6336
6337 .ilist
6338 .cindex "cdb" "description of"
6339 .cindex "lookup" "cdb"
6340 .cindex "binary zero" "in lookup key"
6341 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6342 string without a terminating binary zero. The cdb format is designed for
6343 indexed files that are read frequently and never updated, except by total
6344 re-creation. As such, it is particularly suitable for large files containing
6345 aliases or other indexed data referenced by an MTA. Information about cdb can
6346 be found in several places:
6347 .display
6348 &url(http://www.pobox.com/~djb/cdb.html)
6349 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6350 &url(http://packages.debian.org/stable/utils/freecdb.html)
6351 .endd
6352 A cdb distribution is not needed in order to build Exim with cdb support,
6353 because the code for reading cdb files is included directly in Exim itself.
6354 However, no means of building or testing cdb files is provided with Exim, so
6355 you need to obtain a cdb distribution in order to do this.
6356 .next
6357 .cindex "DBM" "lookup type"
6358 .cindex "lookup" "dbm"
6359 .cindex "binary zero" "in lookup key"
6360 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6361 DBM file by looking up the record with the given key. A terminating binary
6362 zero is included in the key that is passed to the DBM library. See section
6363 &<<SECTdb>>& for a discussion of DBM libraries.
6364
6365 .cindex "Berkeley DB library" "file format"
6366 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6367 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6368 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6369 the DB_UNKNOWN option. This enables it to handle any of the types of database
6370 that the library supports, and can be useful for accessing DBM files created by
6371 other applications. (For earlier DB versions, DB_HASH is always used.)
6372 .next
6373 .cindex "lookup" "dbmjz"
6374 .cindex "lookup" "dbm &-- embedded NULs"
6375 .cindex "sasldb2"
6376 .cindex "dbmjz lookup type"
6377 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6378 interpreted as an Exim list; the elements of the list are joined together with
6379 ASCII NUL characters to form the lookup key.  An example usage would be to
6380 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6381 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6382 &(cram_md5)& authenticator.
6383 .next
6384 .cindex "lookup" "dbmnz"
6385 .cindex "lookup" "dbm &-- terminating zero"
6386 .cindex "binary zero" "in lookup key"
6387 .cindex "Courier"
6388 .cindex "&_/etc/userdbshadow.dat_&"
6389 .cindex "dbmnz lookup type"
6390 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6391 is not included in the key that is passed to the DBM library. You may need this
6392 if you want to look up data in files that are created by or shared with some
6393 other application that does not use terminating zeros. For example, you need to
6394 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6395 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6396 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6397 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6398 .next
6399 .cindex "lookup" "dsearch"
6400 .cindex "dsearch lookup type"
6401 &(dsearch)&: The given file must be a directory; this is searched for an entry
6402 whose name is the key by calling the &[lstat()]& function. The key may not
6403 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6404 the lookup is the name of the entry, which may be a file, directory,
6405 symbolic link, or any other kind of directory entry. An example of how this
6406 lookup can be used to support virtual domains is given in section
6407 &<<SECTvirtualdomains>>&.
6408 .next
6409 .cindex "lookup" "iplsearch"
6410 .cindex "iplsearch lookup type"
6411 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6412 terminated by a colon or white space or the end of the line. The keys in the
6413 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6414 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6415 being interpreted as a key terminator. For example:
6416 .code
6417 1.2.3.4:           data for 1.2.3.4
6418 192.168.0.0/16:    data for 192.168.0.0/16
6419 "abcd::cdab":      data for abcd::cdab
6420 "abcd:abcd::/32"   data for abcd:abcd::/32
6421 .endd
6422 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6423 file is searched linearly, using the CIDR masks where present, until a matching
6424 key is found. The first key that matches is used; there is no attempt to find a
6425 &"best"& match. Apart from the way the keys are matched, the processing for
6426 &(iplsearch)& is the same as for &(lsearch)&.
6427
6428 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6429 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6430 lookup types support only literal keys.
6431
6432 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6433 the implicit key is the host's IP address rather than its name (see section
6434 &<<SECThoslispatsikey>>&).
6435 .next
6436 .cindex "linear search"
6437 .cindex "lookup" "lsearch"
6438 .cindex "lsearch lookup type"
6439 .cindex "case sensitivity" "in lsearch lookup"
6440 &(lsearch)&: The given file is a text file that is searched linearly for a
6441 line beginning with the search key, terminated by a colon or white space or the
6442 end of the line. The search is case-insensitive; that is, upper and lower case
6443 letters are treated as the same. The first occurrence of the key that is found
6444 in the file is used.
6445
6446 White space between the key and the colon is permitted. The remainder of the
6447 line, with leading and trailing white space removed, is the data. This can be
6448 continued onto subsequent lines by starting them with any amount of white
6449 space, but only a single space character is included in the data at such a
6450 junction. If the data begins with a colon, the key must be terminated by a
6451 colon, for example:
6452 .code
6453 baduser:  :fail:
6454 .endd
6455 Empty lines and lines beginning with # are ignored, even if they occur in the
6456 middle of an item. This is the traditional textual format of alias files. Note
6457 that the keys in an &(lsearch)& file are literal strings. There is no
6458 wildcarding of any kind.
6459
6460 .cindex "lookup" "lsearch &-- colons in keys"
6461 .cindex "white space" "in lsearch key"
6462 In most &(lsearch)& files, keys are not required to contain colons or #
6463 characters, or white space. However, if you need this feature, it is available.
6464 If a key begins with a doublequote character, it is terminated only by a
6465 matching quote (or end of line), and the normal escaping rules apply to its
6466 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6467 quoted keys (exactly as for unquoted keys). There is no special handling of
6468 quotes for the data part of an &(lsearch)& line.
6469
6470 .next
6471 .cindex "NIS lookup type"
6472 .cindex "lookup" "NIS"
6473 .cindex "binary zero" "in lookup key"
6474 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6475 the given key, without a terminating binary zero. There is a variant called
6476 &(nis0)& which does include the terminating binary zero in the key. This is
6477 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6478 aliases; the full map names must be used.
6479
6480 .next
6481 .cindex "wildlsearch lookup type"
6482 .cindex "lookup" "wildlsearch"
6483 .cindex "nwildlsearch lookup type"
6484 .cindex "lookup" "nwildlsearch"
6485 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6486 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6487 the file may be wildcarded. The difference between these two lookup types is
6488 that for &(wildlsearch)&, each key in the file is string-expanded before being
6489 used, whereas for &(nwildlsearch)&, no expansion takes place.
6490
6491 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6492 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6493 file that are regular expressions can be made case-sensitive by the use of
6494 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6495
6496 . ==== As this is a nested list, any displays it contains must be indented
6497 . ==== as otherwise they are too far to the left.
6498
6499 .olist
6500 The string may begin with an asterisk to mean &"ends with"&. For example:
6501 .code
6502     *.a.b.c       data for anything.a.b.c
6503     *fish         data for anythingfish
6504 .endd
6505 .next
6506 The string may begin with a circumflex to indicate a regular expression. For
6507 example, for &(wildlsearch)&:
6508 .code
6509     ^\N\d+\.a\.b\N    data for <digits>.a.b
6510 .endd
6511 Note the use of &`\N`& to disable expansion of the contents of the regular
6512 expression. If you are using &(nwildlsearch)&, where the keys are not
6513 string-expanded, the equivalent entry is:
6514 .code
6515     ^\d+\.a\.b        data for <digits>.a.b
6516 .endd
6517 The case-insensitive flag is set at the start of compiling the regular
6518 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6519 For example, to make the entire pattern case-sensitive:
6520 .code
6521     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6522 .endd
6523
6524 If the regular expression contains white space or colon characters, you must
6525 either quote it (see &(lsearch)& above), or represent these characters in other
6526 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6527 colon. This may be easier than quoting, because if you quote, you have to
6528 escape all the backslashes inside the quotes.
6529
6530 &*Note*&: It is not possible to capture substrings in a regular expression
6531 match for later use, because the results of all lookups are cached. If a lookup
6532 is repeated, the result is taken from the cache, and no actual pattern matching
6533 takes place. The values of all the numeric variables are unset after a
6534 &((n)wildlsearch)& match.
6535
6536 .next
6537 Although I cannot see it being of much use, the general matching function that
6538 is used to implement &((n)wildlsearch)& means that the string may begin with a
6539 lookup name terminated by a semicolon, and followed by lookup data. For
6540 example:
6541 .code
6542     cdb;/some/file  data for keys that match the file
6543 .endd
6544 The data that is obtained from the nested lookup is discarded.
6545 .endlist olist
6546
6547 Keys that do not match any of these patterns are interpreted literally. The
6548 continuation rules for the data are the same as for &(lsearch)&, and keys may
6549 be followed by optional colons.
6550
6551 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6552 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6553 lookup types support only literal keys.
6554 .endlist ilist
6555
6556
6557 .section "Query-style lookup types" "SECID62"
6558 .cindex "lookup" "query-style types"
6559 .cindex "query-style lookup" "list of types"
6560 The supported query-style lookup types are listed below. Further details about
6561 many of them are given in later sections.
6562
6563 .ilist
6564 .cindex "DNS" "as a lookup type"
6565 .cindex "lookup" "DNS"
6566 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6567 are given in the supplied query. The resulting data is the contents of the
6568 records. See section &<<SECTdnsdb>>&.
6569 .next
6570 .cindex "InterBase lookup type"
6571 .cindex "lookup" "InterBase"
6572 &(ibase)&: This does a lookup in an InterBase database.
6573 .next
6574 .cindex "LDAP" "lookup type"
6575 .cindex "lookup" "LDAP"
6576 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6577 returns attributes from a single entry. There is a variant called &(ldapm)&
6578 that permits values from multiple entries to be returned. A third variant
6579 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6580 any attribute values. See section &<<SECTldap>>&.
6581 .next
6582 .cindex "MySQL" "lookup type"
6583 .cindex "lookup" "MySQL"
6584 &(mysql)&: The format of the query is an SQL statement that is passed to a
6585 MySQL database. See section &<<SECTsql>>&.
6586 .next
6587 .cindex "NIS+ lookup type"
6588 .cindex "lookup" "NIS+"
6589 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6590 the field to be returned. See section &<<SECTnisplus>>&.
6591 .next
6592 .cindex "Oracle" "lookup type"
6593 .cindex "lookup" "Oracle"
6594 &(oracle)&: The format of the query is an SQL statement that is passed to an
6595 Oracle database. See section &<<SECTsql>>&.
6596 .next
6597 .cindex "lookup" "passwd"
6598 .cindex "passwd lookup type"
6599 .cindex "&_/etc/passwd_&"
6600 &(passwd)& is a query-style lookup with queries that are just user names. The
6601 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6602 success, the result string is the same as you would get from an &(lsearch)&
6603 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6604 password value. For example:
6605 .code
6606 *:42:42:King Rat:/home/kr:/bin/bash
6607 .endd
6608 .next
6609 .cindex "PostgreSQL lookup type"
6610 .cindex "lookup" "PostgreSQL"
6611 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6612 PostgreSQL database. See section &<<SECTsql>>&.
6613
6614 .next
6615 .cindex "sqlite lookup type"
6616 .cindex "lookup" "sqlite"
6617 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6618 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6619
6620 .next
6621 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6622 not likely to be useful in normal operation.
6623 .next
6624 .cindex "whoson lookup type"
6625 .cindex "lookup" "whoson"
6626 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6627 allows a server to check whether a particular (dynamically allocated) IP
6628 address is currently allocated to a known (trusted) user and, optionally, to
6629 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6630 at one time for &"POP before SMTP"& authentication, but that approach has been
6631 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6632 &"POP before SMTP"& checking using ACL statements such as
6633 .code
6634 require condition = \
6635   ${lookup whoson {$sender_host_address}{yes}{no}}
6636 .endd
6637 The query consists of a single IP address. The value returned is the name of
6638 the authenticated user, which is stored in the variable &$value$&. However, in
6639 this example, the data in &$value$& is not used; the result of the lookup is
6640 one of the fixed strings &"yes"& or &"no"&.
6641 .endlist
6642
6643
6644
6645 .section "Temporary errors in lookups" "SECID63"
6646 .cindex "lookup" "temporary error in"
6647 Lookup functions can return temporary error codes if the lookup cannot be
6648 completed. For example, an SQL or LDAP database might be unavailable. For this
6649 reason, it is not advisable to use a lookup that might do this for critical
6650 options such as a list of local domains.
6651
6652 When a lookup cannot be completed in a router or transport, delivery
6653 of the message (to the relevant address) is deferred, as for any other
6654 temporary error. In other circumstances Exim may assume the lookup has failed,
6655 or may give up altogether.
6656
6657
6658
6659 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6660 .cindex "wildcard lookups"
6661 .cindex "lookup" "default values"
6662 .cindex "lookup" "wildcard"
6663 .cindex "lookup" "* added to type"
6664 .cindex "default" "in single-key lookups"
6665 In this context, a &"default value"& is a value specified by the administrator
6666 that is to be used if a lookup fails.
6667
6668 &*Note:*& This section applies only to single-key lookups. For query-style
6669 lookups, the facilities of the query language must be used. An attempt to
6670 specify a default for a query-style lookup provokes an error.
6671
6672 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6673 and the initial lookup fails, the key &"*"& is looked up in the file to
6674 provide a default value. See also the section on partial matching below.
6675
6676 .cindex "*@ with single-key lookup"
6677 .cindex "lookup" "*@ added to type"
6678 .cindex "alias file" "per-domain default"
6679 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6680 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6681 character, a second lookup is done with everything before the last @ replaced
6682 by *. This makes it possible to provide per-domain defaults in alias files
6683 that include the domains in the keys. If the second lookup fails (or doesn't
6684 take place because there is no @ in the key), &"*"& is looked up.
6685 For example, a &(redirect)& router might contain:
6686 .code
6687 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6688 .endd
6689 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6690 looks up these keys, in this order:
6691 .code
6692 jane@eyre.example
6693 *@eyre.example
6694 *
6695 .endd
6696 The data is taken from whichever key it finds first. &*Note*&: In an
6697 &(lsearch)& file, this does not mean the first of these keys in the file. A
6698 complete scan is done for each key, and only if it is not found at all does
6699 Exim move on to try the next key.
6700
6701
6702
6703 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6704 .cindex "partial matching"
6705 .cindex "wildcard lookups"
6706 .cindex "lookup" "partial matching"
6707 .cindex "lookup" "wildcard"
6708 .cindex "asterisk" "in search type"
6709 The normal operation of a single-key lookup is to search the file for an exact
6710 match with the given key. However, in a number of situations where domains are
6711 being looked up, it is useful to be able to do partial matching. In this case,
6712 information in the file that has a key starting with &"*."& is matched by any
6713 domain that ends with the components that follow the full stop. For example, if
6714 a key in a DBM file is
6715 .code
6716 *.dates.fict.example
6717 .endd
6718 then when partial matching is enabled this is matched by (amongst others)
6719 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6720 by &'dates.fict.example'&, if that does not appear as a separate key in the
6721 file.
6722
6723 &*Note*&: Partial matching is not available for query-style lookups. It is
6724 also not available for any lookup items in address lists (see section
6725 &<<SECTaddresslist>>&).
6726
6727 Partial matching is implemented by doing a series of separate lookups using
6728 keys constructed by modifying the original subject key. This means that it can
6729 be used with any of the single-key lookup types, provided that
6730 partial matching keys
6731 beginning with a special prefix (default &"*."&) are included in the data file.
6732 Keys in the file that do not begin with the prefix are matched only by
6733 unmodified subject keys when partial matching is in use.
6734
6735 Partial matching is requested by adding the string &"partial-"& to the front of
6736 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6737 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6738 is added at the start of the subject key, and it is looked up again. If that
6739 fails, further lookups are tried with dot-separated components removed from the
6740 start of the subject key, one-by-one, and &"*."& added on the front of what
6741 remains.
6742
6743 A minimum number of two non-* components are required. This can be adjusted
6744 by including a number before the hyphen in the search type. For example,
6745 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6746 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6747 subject key is &'2250.dates.fict.example'& then the following keys are looked
6748 up when the minimum number of non-* components is two:
6749 .code
6750 2250.dates.fict.example
6751 *.2250.dates.fict.example
6752 *.dates.fict.example
6753 *.fict.example
6754 .endd
6755 As soon as one key in the sequence is successfully looked up, the lookup
6756 finishes.
6757
6758 .cindex "lookup" "partial matching &-- changing prefix"
6759 .cindex "prefix" "for partial matching"
6760 The use of &"*."& as the partial matching prefix is a default that can be
6761 changed. The motivation for this feature is to allow Exim to operate with file
6762 formats that are used by other MTAs. A different prefix can be supplied in
6763 parentheses instead of the hyphen after &"partial"&. For example:
6764 .code
6765 domains = partial(.)lsearch;/some/file
6766 .endd
6767 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6768 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6769 components is unchanged). The prefix may consist of any punctuation characters
6770 other than a closing parenthesis. It may be empty, for example:
6771 .code
6772 domains = partial1()cdb;/some/file
6773 .endd
6774 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6775 &`a.b.c`&, &`b.c`&, and &`c`&.
6776
6777 If &"partial0"& is specified, what happens at the end (when the lookup with
6778 just one non-wild component has failed, and the original key is shortened right
6779 down to the null string) depends on the prefix:
6780
6781 .ilist
6782 If the prefix has zero length, the whole lookup fails.
6783 .next
6784 If the prefix has length 1, a lookup for just the prefix is done. For
6785 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6786 .next
6787 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6788 remainder is looked up. With the default prefix, therefore, the final lookup is
6789 for &"*"& on its own.
6790 .next
6791 Otherwise, the whole prefix is looked up.
6792 .endlist
6793
6794
6795 If the search type ends in &"*"& or &"*@"& (see section
6796 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6797 this implies happens after all partial lookups have failed. If &"partial0"& is
6798 specified, adding &"*"& to the search type has no effect with the default
6799 prefix, because the &"*"& key is already included in the sequence of partial
6800 lookups. However, there might be a use for lookup types such as
6801 &"partial0(.)lsearch*"&.
6802
6803 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6804 in domain lists and the like. Partial matching works only in terms of
6805 dot-separated components; a key such as &`*fict.example`&
6806 in a database file is useless, because the asterisk in a partial matching
6807 subject key is always followed by a dot.
6808
6809
6810
6811
6812 .section "Lookup caching" "SECID64"
6813 .cindex "lookup" "caching"
6814 .cindex "caching" "lookup data"
6815 Exim caches all lookup results in order to avoid needless repetition of
6816 lookups. However, because (apart from the daemon) Exim operates as a collection
6817 of independent, short-lived processes, this caching applies only within a
6818 single Exim process. There is no inter-process lookup caching facility.
6819
6820 For single-key lookups, Exim keeps the relevant files open in case there is
6821 another lookup that needs them. In some types of configuration this can lead to
6822 many files being kept open for messages with many recipients. To avoid hitting
6823 the operating system limit on the number of simultaneously open files, Exim
6824 closes the least recently used file when it needs to open more files than its
6825 own internal limit, which can be changed via the &%lookup_open_max%& option.
6826
6827 The single-key lookup files are closed and the lookup caches are flushed at
6828 strategic points during delivery &-- for example, after all routing is
6829 complete.
6830
6831
6832
6833
6834 .section "Quoting lookup data" "SECID65"
6835 .cindex "lookup" "quoting"
6836 .cindex "quoting" "in lookups"
6837 When data from an incoming message is included in a query-style lookup, there
6838 is the possibility of special characters in the data messing up the syntax of
6839 the query. For example, a NIS+ query that contains
6840 .code
6841 [name=$local_part]
6842 .endd
6843 will be broken if the local part happens to contain a closing square bracket.
6844 For NIS+, data can be enclosed in double quotes like this:
6845 .code
6846 [name="$local_part"]
6847 .endd
6848 but this still leaves the problem of a double quote in the data. The rule for
6849 NIS+ is that double quotes must be doubled. Other lookup types have different
6850 rules, and to cope with the differing requirements, an expansion operator
6851 of the following form is provided:
6852 .code
6853 ${quote_<lookup-type>:<string>}
6854 .endd
6855 For example, the safest way to write the NIS+ query is
6856 .code
6857 [name="${quote_nisplus:$local_part}"]
6858 .endd
6859 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6860 operator can be used for all lookup types, but has no effect for single-key
6861 lookups, since no quoting is ever needed in their key strings.
6862
6863
6864
6865
6866 .section "More about dnsdb" "SECTdnsdb"
6867 .cindex "dnsdb lookup"
6868 .cindex "lookup" "dnsdb"
6869 .cindex "DNS" "as a lookup type"
6870 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6871 of a record type and a domain name, separated by an equals sign. For example,
6872 an expansion string could contain:
6873 .code
6874 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6875 .endd
6876 If the lookup succeeds, the result is placed in &$value$&, which in this case
6877 is used on its own as the result. If the lookup does not succeed, the
6878 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6879 &<<SECTforexpfai>>& for an explanation of what this means.
6880
6881 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6882 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6883 If no type is given, TXT is assumed.
6884
6885 For any record type, if multiple records are found, the data is returned as a
6886 concatenation, with newline as the default separator. The order, of course,
6887 depends on the DNS resolver. You can specify a different separator character
6888 between multiple records by putting a right angle-bracket followed immediately
6889 by the new separator at the start of the query. For example:
6890 .code
6891 ${lookup dnsdb{>: a=host1.example}}
6892 .endd
6893 It is permitted to specify a space as the separator character. Further
6894 white space is ignored.
6895 For lookup types that return multiple fields per record,
6896 an alternate field separator can be specified using a comma after the main
6897 separator character, followed immediately by the field separator.
6898
6899 .cindex "PTR record" "in &(dnsdb)& lookup"
6900 When the type is PTR,
6901 the data can be an IP address, written as normal; inversion and the addition of
6902 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6903 .code
6904 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6905 .endd
6906 If the data for a PTR record is not a syntactically valid IP address, it is not
6907 altered and nothing is added.
6908
6909 .cindex "MX record" "in &(dnsdb)& lookup"
6910 .cindex "SRV record" "in &(dnsdb)& lookup"
6911 For an MX lookup, both the preference value and the host name are returned for
6912 each record, separated by a space. For an SRV lookup, the priority, weight,
6913 port, and host name are returned for each record, separated by spaces.
6914 The field separator can be modified as above.
6915
6916 .cindex "TXT record" "in &(dnsdb)& lookup"
6917 .cindex "SPF record" "in &(dnsdb)& lookup"
6918 For TXT records with multiple items of data, only the first item is returned,
6919 unless a field separator is specified.
6920 To concatenate items without a separator, use a semicolon instead.
6921 For SPF records the
6922 default behaviour is to concatenate multiple items without using a separator.
6923 .code
6924 ${lookup dnsdb{>\n,: txt=a.b.example}}
6925 ${lookup dnsdb{>\n; txt=a.b.example}}
6926 ${lookup dnsdb{spf=example.org}}
6927 .endd
6928 It is permitted to specify a space as the separator character. Further
6929 white space is ignored.
6930
6931 .cindex "SOA record" "in &(dnsdb)& lookup"
6932 For an SOA lookup, while no result is obtained the lookup is redone with
6933 successively more leading components dropped from the given domain.
6934 Only the primary-nameserver field is returned unless a field separator is
6935 specified.
6936 .code
6937 ${lookup dnsdb{>:,; soa=a.b.example.com}}
6938 .endd
6939
6940 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6941 .cindex "dnsdb modifiers"
6942 .cindex "modifiers" "dnsdb"
6943 .cindex "options" "dnsdb"
6944 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6945 each followed by a comma,
6946 that may appear before the record type.
6947
6948 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6949 temporary DNS error for any of them, the behaviour is controlled by
6950 a defer-option modifier.
6951 The possible keywords are
6952 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6953 With &"strict"& behaviour, any temporary DNS error causes the
6954 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6955 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6956 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6957 error causes the whole lookup to defer only if none of the other lookups
6958 succeed. The default is &"lax"&, so the following lookups are equivalent:
6959 .code
6960 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6961 ${lookup dnsdb{a=one.host.com:two.host.com}}
6962 .endd
6963 Thus, in the default case, as long as at least one of the DNS lookups
6964 yields some data, the lookup succeeds.
6965
6966 .cindex "DNSSEC" "dns lookup"
6967 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6968 The possible keywords are
6969 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6970 With &"strict"& or &"lax"& DNSSEC information is requested
6971 with the lookup.
6972 With &"strict"& a response from the DNS resolver that
6973 is not labelled as authenticated data
6974 is treated as equivalent to a temporary DNS error.
6975 The default is &"never"&.
6976
6977 See also the &$lookup_dnssec_authenticated$& variable.
6978
6979 .cindex timeout "dns lookup"
6980 .cindex "DNS" timeout
6981 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
6982 The form is &"retrans_VAL"& where VAL is an Exim time specification
6983 (eg &"5s"&).
6984 The default value is set by the main configuration option &%dns_retrans%&.
6985
6986 Retries for the dnsdb lookup can be controlled by a retry modifier.
6987 The form if &"retry_VAL"& where VAL is an integer.
6988 The default count is set by the main configuration option &%dns_retry%&.
6989
6990
6991 .section "Pseudo dnsdb record types" "SECID66"
6992 .cindex "MX record" "in &(dnsdb)& lookup"
6993 By default, both the preference value and the host name are returned for
6994 each MX record, separated by a space. If you want only host names, you can use
6995 the pseudo-type MXH:
6996 .code
6997 ${lookup dnsdb{mxh=a.b.example}}
6998 .endd
6999 In this case, the preference values are omitted, and just the host names are
7000 returned.
7001
7002 .cindex "name server for enclosing domain"
7003 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7004 records on the given domain, but if none are found, it removes the first
7005 component of the domain name, and tries again. This process continues until NS
7006 records are found or there are no more components left (or there is a DNS
7007 error). In other words, it may return the name servers for a top-level domain,
7008 but it never returns the root name servers. If there are no NS records for the
7009 top-level domain, the lookup fails. Consider these examples:
7010 .code
7011 ${lookup dnsdb{zns=xxx.quercite.com}}
7012 ${lookup dnsdb{zns=xxx.edu}}
7013 .endd
7014 Assuming that in each case there are no NS records for the full domain name,
7015 the first returns the name servers for &%quercite.com%&, and the second returns
7016 the name servers for &%edu%&.
7017
7018 You should be careful about how you use this lookup because, unless the
7019 top-level domain does not exist, the lookup always returns some host names. The
7020 sort of use to which this might be put is for seeing if the name servers for a
7021 given domain are on a blacklist. You can probably assume that the name servers
7022 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7023 such a list.
7024
7025 .cindex "CSA" "in &(dnsdb)& lookup"
7026 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7027 records according to the CSA rules, which are described in section
7028 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7029 not sufficient because of the extra parent domain search behaviour of CSA. The
7030 result of a successful lookup such as:
7031 .code
7032 ${lookup dnsdb {csa=$sender_helo_name}}
7033 .endd
7034 has two space-separated fields: an authorization code and a target host name.
7035 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7036 authorization required but absent, or &"?"& for unknown.
7037
7038 .cindex "A+" "in &(dnsdb)& lookup"
7039 The pseudo-type A+ performs an AAAA
7040 and then an A lookup.  All results are returned; defer processing
7041 (see below) is handled separately for each lookup.  Example:
7042 .code
7043 ${lookup dnsdb {>; a+=$sender_helo_name}}
7044 .endd
7045
7046
7047 .section "Multiple dnsdb lookups" "SECID67"
7048 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7049 However, you can specify a list of domains or IP addresses in a single
7050 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7051 the default separator, but with the ability to change this. For example:
7052 .code
7053 ${lookup dnsdb{one.domain.com:two.domain.com}}
7054 ${lookup dnsdb{a=one.host.com:two.host.com}}
7055 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7056 .endd
7057 In order to retain backwards compatibility, there is one special case: if
7058 the lookup type is PTR and no change of separator is specified, Exim looks
7059 to see if the rest of the string is precisely one IPv6 address. In this
7060 case, it does not treat it as a list.
7061
7062 The data from each lookup is concatenated, with newline separators by default,
7063 in the same way that multiple DNS records for a single item are handled. A
7064 different separator can be specified, as described above.
7065
7066
7067
7068
7069 .section "More about LDAP" "SECTldap"
7070 .cindex "LDAP" "lookup, more about"
7071 .cindex "lookup" "LDAP"
7072 .cindex "Solaris" "LDAP"
7073 The original LDAP implementation came from the University of Michigan; this has
7074 become &"Open LDAP"&, and there are now two different releases. Another
7075 implementation comes from Netscape, and Solaris 7 and subsequent releases
7076 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7077 the lookup function level, their error handling is different. For this reason
7078 it is necessary to set a compile-time variable when building Exim with LDAP, to
7079 indicate which LDAP library is in use. One of the following should appear in
7080 your &_Local/Makefile_&:
7081 .code
7082 LDAP_LIB_TYPE=UMICHIGAN
7083 LDAP_LIB_TYPE=OPENLDAP1
7084 LDAP_LIB_TYPE=OPENLDAP2
7085 LDAP_LIB_TYPE=NETSCAPE
7086 LDAP_LIB_TYPE=SOLARIS
7087 .endd
7088 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7089 same interface as the University of Michigan version.
7090
7091 There are three LDAP lookup types in Exim. These behave slightly differently in
7092 the way they handle the results of a query:
7093
7094 .ilist
7095 &(ldap)& requires the result to contain just one entry; if there are more, it
7096 gives an error.
7097 .next
7098 &(ldapdn)& also requires the result to contain just one entry, but it is the
7099 Distinguished Name that is returned rather than any attribute values.
7100 .next
7101 &(ldapm)& permits the result to contain more than one entry; the attributes
7102 from all of them are returned.
7103 .endlist
7104
7105
7106 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7107 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7108 the data returned by a successful lookup is described in the next section.
7109 First we explain how LDAP queries are coded.
7110
7111
7112 .section "Format of LDAP queries" "SECTforldaque"
7113 .cindex "LDAP" "query format"
7114 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7115 the configuration of a &(redirect)& router one might have this setting:
7116 .code
7117 data = ${lookup ldap \
7118   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7119   c=UK?mailbox?base?}}
7120 .endd
7121 .cindex "LDAP" "with TLS"
7122 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7123 secure (encrypted) LDAP connections. The second of these ensures that an
7124 encrypted TLS connection is used.
7125
7126 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7127 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7128 See the &%ldap_start_tls%& option.
7129
7130 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7131 controlled. Every part of the TLS configuration can be configured by settings in
7132 &_exim.conf_&. Depending on the version of the client libraries installed on
7133 your system, some of the initialization may have required setting options in
7134 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7135 certificates. This revealed a nuance where the current UID that exim was
7136 running as could affect which config files it read. With Exim 4.83, these
7137 methods become optional, only taking effect if not specifically set in
7138 &_exim.conf_&.
7139
7140
7141 .section "LDAP quoting" "SECID68"
7142 .cindex "LDAP" "quoting"
7143 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7144 and the second because the LDAP query is represented as a URL. Furthermore,
7145 within an LDAP query, two different kinds of quoting are required. For this
7146 reason, there are two different LDAP-specific quoting operators.
7147
7148 The &%quote_ldap%& operator is designed for use on strings that are part of
7149 filter specifications. Conceptually, it first does the following conversions on
7150 the string:
7151 .code
7152 *   =>   \2A
7153 (   =>   \28
7154 )   =>   \29
7155 \   =>   \5C
7156 .endd
7157 in accordance with RFC 2254. The resulting string is then quoted according
7158 to the rules for URLs, that is, all non-alphanumeric characters except
7159 .code
7160 ! $ ' - . _ ( ) * +
7161 .endd
7162 are converted to their hex values, preceded by a percent sign. For example:
7163 .code
7164 ${quote_ldap: a(bc)*, a<yz>; }
7165 .endd
7166 yields
7167 .code
7168 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7169 .endd
7170 Removing the URL quoting, this is (with a leading and a trailing space):
7171 .code
7172 a\28bc\29\2A, a<yz>;
7173 .endd
7174 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7175 base DN specifications in queries. Conceptually, it first converts the string
7176 by inserting a backslash in front of any of the following characters:
7177 .code
7178 , + " \ < > ;
7179 .endd
7180 It also inserts a backslash before any leading spaces or # characters, and
7181 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7182 is then quoted according to the rules for URLs. For example:
7183 .code
7184 ${quote_ldap_dn: a(bc)*, a<yz>; }
7185 .endd
7186 yields
7187 .code
7188 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7189 .endd
7190 Removing the URL quoting, this is (with a trailing space):
7191 .code
7192 \ a(bc)*\, a\<yz\>\;\
7193 .endd
7194 There are some further comments about quoting in the section on LDAP
7195 authentication below.
7196
7197
7198 .section "LDAP connections" "SECID69"
7199 .cindex "LDAP" "connections"
7200 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7201 is in use, via a Unix domain socket. The example given above does not specify
7202 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7203 by starting it with
7204 .code
7205 ldap://<hostname>:<port>/...
7206 .endd
7207 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7208 used. When no server is specified in a query, a list of default servers is
7209 taken from the &%ldap_default_servers%& configuration option. This supplies a
7210 colon-separated list of servers which are tried in turn until one successfully
7211 handles a query, or there is a serious error. Successful handling either
7212 returns the requested data, or indicates that it does not exist. Serious errors
7213 are syntactical, or multiple values when only a single value is expected.
7214 Errors which cause the next server to be tried are connection failures, bind
7215 failures, and timeouts.
7216
7217 For each server name in the list, a port number can be given. The standard way
7218 of specifying a host and port is to use a colon separator (RFC 1738). Because
7219 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7220 doubled. For example
7221 .code
7222 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7223 .endd
7224 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7225 to the LDAP library with no server name, and the library's default (normally
7226 the local host) is used.
7227
7228 If you are using the OpenLDAP library, you can connect to an LDAP server using
7229 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7230 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7231 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7232 not available.
7233
7234 For this type of connection, instead of a host name for the server, a pathname
7235 for the socket is required, and the port number is not relevant. The pathname
7236 can be specified either as an item in &%ldap_default_servers%&, or inline in
7237 the query. In the former case, you can have settings such as
7238 .code
7239 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7240 .endd
7241 When the pathname is given in the query, you have to escape the slashes as
7242 &`%2F`& to fit in with the LDAP URL syntax. For example:
7243 .code
7244 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7245 .endd
7246 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7247 a pathname, it uses the Unix domain socket code, even if the query actually
7248 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7249 socket connection. This behaviour means that you can use a setting of
7250 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7251 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7252 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7253 backup host.
7254
7255 If an explicit &`ldapi`& type is given in a query when a host name is
7256 specified, an error is diagnosed. However, if there are more items in
7257 &%ldap_default_servers%&, they are tried. In other words:
7258
7259 .ilist
7260 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7261 interface.
7262 .next
7263 Using &`ldapi`& with a host name causes an error.
7264 .endlist
7265
7266
7267 Using &`ldapi`& with no host or path in the query, and no setting of
7268 &%ldap_default_servers%&, does whatever the library does by default.
7269
7270
7271
7272 .section "LDAP authentication and control information" "SECID70"
7273 .cindex "LDAP" "authentication"
7274 The LDAP URL syntax provides no way of passing authentication and other control
7275 information to the server. To make this possible, the URL in an LDAP query may
7276 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7277 spaces. If a value contains spaces it must be enclosed in double quotes, and
7278 when double quotes are used, backslash is interpreted in the usual way inside
7279 them. The following names are recognized:
7280 .display
7281 &`DEREFERENCE`&  set the dereferencing parameter
7282 &`NETTIME    `&  set a timeout for a network operation
7283 &`USER       `&  set the DN, for authenticating the LDAP bind
7284 &`PASS       `&  set the password, likewise
7285 &`REFERRALS  `&  set the referrals parameter
7286 &`SERVERS    `&  set alternate server list for this query only
7287 &`SIZE       `&  set the limit for the number of entries returned
7288 &`TIME       `&  set the maximum waiting time for a query
7289 .endd
7290 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7291 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7292 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7293 library from trying to follow referrals issued by the LDAP server.
7294
7295 The name CONNECT is an obsolete name for NETTIME, retained for
7296 backwards compatibility. This timeout (specified as a number of seconds) is
7297 enforced from the client end for operations that can be carried out over a
7298 network. Specifically, it applies to network connections and calls to the
7299 &'ldap_result()'& function. If the value is greater than zero, it is used if
7300 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7301 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7302 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7303 Netscape SDK; for OpenLDAP no action is taken.
7304
7305 The TIME parameter (also a number of seconds) is passed to the server to
7306 set a server-side limit on the time taken to complete a search.
7307
7308 The SERVERS parameter allows you to specify an alternate list of ldap servers
7309 to use for an individual lookup.  The global ldap_servers option provides a
7310 default list of ldap servers, and a single lookup can specify a single ldap
7311 server to use.  But when you need to do a lookup with a list of servers that is
7312 different than the default list (maybe different order, maybe a completely
7313 different set of servers), the SERVERS parameter allows you to specify this
7314 alternate list (colon-separated).
7315
7316 Here is an example of an LDAP query in an Exim lookup that uses some of these
7317 values. This is a single line, folded to fit on the page:
7318 .code
7319 ${lookup ldap
7320   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7321   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7322   {$value}fail}
7323 .endd
7324 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7325 any of the auxiliary data. Exim configuration settings that include lookups
7326 which contain password information should be preceded by &"hide"& to prevent
7327 non-admin users from using the &%-bP%& option to see their values.
7328
7329 The auxiliary data items may be given in any order. The default is no
7330 connection timeout (the system timeout is used), no user or password, no limit
7331 on the number of entries returned, and no time limit on queries.
7332
7333 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7334 removes any URL quoting that it may contain before passing it LDAP. Apparently
7335 some libraries do this for themselves, but some do not. Removing the URL
7336 quoting has two advantages:
7337
7338 .ilist
7339 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7340 DNs as with DNs inside actual queries.
7341 .next
7342 It permits spaces inside USER= DNs.
7343 .endlist
7344
7345 For example, a setting such as
7346 .code
7347 USER=cn=${quote_ldap_dn:$1}
7348 .endd
7349 should work even if &$1$& contains spaces.
7350
7351 Expanded data for the PASS= value should be quoted using the &%quote%&
7352 expansion operator, rather than the LDAP quote operators. The only reason this
7353 field needs quoting is to ensure that it conforms to the Exim syntax, which
7354 does not allow unquoted spaces. For example:
7355 .code
7356 PASS=${quote:$3}
7357 .endd
7358 The LDAP authentication mechanism can be used to check passwords as part of
7359 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7360 &<<CHAPexpand>>&.
7361
7362
7363
7364 .section "Format of data returned by LDAP" "SECID71"
7365 .cindex "LDAP" "returned data formats"
7366 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7367 as a sequence of values, for example
7368 .code
7369 cn=manager, o=University of Cambridge, c=UK
7370 .endd
7371 The &(ldap)& lookup type generates an error if more than one entry matches the
7372 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7373 the result between the data from different entries. It is possible for multiple
7374 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7375 you know that whatever values are returned all came from a single entry in the
7376 directory.
7377
7378 In the common case where you specify a single attribute in your LDAP query, the
7379 result is not quoted, and does not contain the attribute name. If the attribute
7380 has multiple values, they are separated by commas.
7381
7382 If you specify multiple attributes, the result contains space-separated, quoted
7383 strings, each preceded by the attribute name and an equals sign. Within the
7384 quotes, the quote character, backslash, and newline are escaped with
7385 backslashes, and commas are used to separate multiple values for the attribute.
7386 Any commas in attribute values are doubled
7387 (permitting treatment of the values as a comma-separated list).
7388 Apart from the escaping, the string within quotes takes the same form as the
7389 output when a single attribute is requested. Specifying no attributes is the
7390 same as specifying all of an entry's attributes.
7391
7392 Here are some examples of the output format. The first line of each pair is an
7393 LDAP query, and the second is the data that is returned. The attribute called
7394 &%attr1%& has two values, one of them with an embedded comma, whereas
7395 &%attr2%& has only one value:
7396 .code
7397 ldap:///o=base?attr1?sub?(uid=fred)
7398 value1.1,value1,,2
7399
7400 ldap:///o=base?attr2?sub?(uid=fred)
7401 value two
7402
7403 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7404 attr1="value1.1,value1,,2" attr2="value two"
7405
7406 ldap:///o=base??sub?(uid=fred)
7407 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7408 .endd
7409 You can
7410 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7411 results of LDAP lookups.
7412 The &%extract%& operator in string expansions can be used to pick out
7413 individual fields from data that consists of &'key'&=&'value'& pairs.
7414 The &%listextract%& operator should be used to pick out individual values
7415 of attributes, even when only a single value is expected.
7416 The doubling of embedded commas allows you to use the returned data as a
7417 comma separated list (using the "<," syntax for changing the input list separator).
7418
7419
7420
7421
7422 .section "More about NIS+" "SECTnisplus"
7423 .cindex "NIS+ lookup type"
7424 .cindex "lookup" "NIS+"
7425 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7426 and field name. If this is given, the result of a successful query is the
7427 contents of the named field; otherwise the result consists of a concatenation
7428 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7429 values containing spaces are quoted. For example, the query
7430 .code
7431 [name=mg1456],passwd.org_dir
7432 .endd
7433 might return the string
7434 .code
7435 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7436 home=/home/mg1456 shell=/bin/bash shadow=""
7437 .endd
7438 (split over two lines here to fit on the page), whereas
7439 .code
7440 [name=mg1456],passwd.org_dir:gcos
7441 .endd
7442 would just return
7443 .code
7444 Martin Guerre
7445 .endd
7446 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7447 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7448 operator is to double any quote characters within the text.
7449
7450
7451
7452 .section "SQL lookups" "SECTsql"
7453 .cindex "SQL lookup types"
7454 .cindex "MySQL" "lookup type"
7455 .cindex "PostgreSQL lookup type"
7456 .cindex "lookup" "MySQL"
7457 .cindex "lookup" "PostgreSQL"
7458 .cindex "Oracle" "lookup type"
7459 .cindex "lookup" "Oracle"
7460 .cindex "InterBase lookup type"
7461 .cindex "lookup" "InterBase"
7462 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7463 databases. Queries for these databases contain SQL statements, so an example
7464 might be
7465 .code
7466 ${lookup mysql{select mailbox from users where id='userx'}\
7467   {$value}fail}
7468 .endd
7469 If the result of the query contains more than one field, the data for each
7470 field in the row is returned, preceded by its name, so the result of
7471 .code
7472 ${lookup pgsql{select home,name from users where id='userx'}\
7473   {$value}}
7474 .endd
7475 might be
7476 .code
7477 home=/home/userx name="Mister X"
7478 .endd
7479 Empty values and values containing spaces are double quoted, with embedded
7480 quotes escaped by a backslash. If the result of the query contains just one
7481 field, the value is passed back verbatim, without a field name, for example:
7482 .code
7483 Mister X
7484 .endd
7485 If the result of the query yields more than one row, it is all concatenated,
7486 with a newline between the data for each row.
7487
7488
7489 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7490 .cindex "MySQL" "lookup type"
7491 .cindex "PostgreSQL lookup type"
7492 .cindex "lookup" "MySQL"
7493 .cindex "lookup" "PostgreSQL"
7494 .cindex "Oracle" "lookup type"
7495 .cindex "lookup" "Oracle"
7496 .cindex "InterBase lookup type"
7497 .cindex "lookup" "InterBase"
7498 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7499 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7500 option (as appropriate) must be set to a colon-separated list of server
7501 information.
7502 (For MySQL and PostgreSQL only, the global option need not be set if all
7503 queries contain their own server information &-- see section
7504 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7505 items: host name, database name, user name, and password. In the case of
7506 Oracle, the host name field is used for the &"service name"&, and the database
7507 name field is not used and should be empty. For example:
7508 .code
7509 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7510 .endd
7511 Because password data is sensitive, you should always precede the setting with
7512 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7513 option. Here is an example where two MySQL servers are listed:
7514 .code
7515 hide mysql_servers = localhost/users/root/secret:\
7516                      otherhost/users/root/othersecret
7517 .endd
7518 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7519 because this is a colon-separated list, the colon has to be doubled. For each
7520 query, these parameter groups are tried in order until a connection is made and
7521 a query is successfully processed. The result of a query may be that no data is
7522 found, but that is still a successful query. In other words, the list of
7523 servers provides a backup facility, not a list of different places to look.
7524
7525 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7526 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7527 respectively, and the characters single-quote, double-quote, and backslash
7528 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7529 addition, escapes the percent and underscore characters. This cannot be done
7530 for MySQL because these escapes are not recognized in contexts where these
7531 characters are not special.
7532
7533 .section "Specifying the server in the query" "SECTspeserque"
7534 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7535 it is possible to specify a list of servers with an individual query. This is
7536 done by starting the query with
7537 .display
7538 &`servers=`&&'server1:server2:server3:...'&&`;`&
7539 .endd
7540 Each item in the list may take one of two forms:
7541 .olist
7542 If it contains no slashes it is assumed to be just a host name. The appropriate
7543 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7544 of the same name, and the remaining parameters (database, user, password) are
7545 taken from there.
7546 .next
7547 If it contains any slashes, it is taken as a complete parameter set.
7548 .endlist
7549 The list of servers is used in exactly the same way as the global list.
7550 Once a connection to a server has happened and a query has been
7551 successfully executed, processing of the lookup ceases.
7552
7553 This feature is intended for use in master/slave situations where updates
7554 are occurring and you want to update the master rather than a slave. If the
7555 master is in the list as a backup for reading, you might have a global setting
7556 like this:
7557 .code
7558 mysql_servers = slave1/db/name/pw:\
7559                 slave2/db/name/pw:\
7560                 master/db/name/pw
7561 .endd
7562 In an updating lookup, you could then write:
7563 .code
7564 ${lookup mysql{servers=master; UPDATE ...} }
7565 .endd
7566 That query would then be sent only to the master server. If, on the other hand,
7567 the master is not to be used for reading, and so is not present in the global
7568 option, you can still update it by a query of this form:
7569 .code
7570 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7571 .endd
7572
7573
7574 .section "Special MySQL features" "SECID73"
7575 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7576 causes a connection to the server on the local host by means of a Unix domain
7577 socket. An alternate socket can be specified in parentheses. The full syntax of
7578 each item in &%mysql_servers%& is:
7579 .display
7580 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7581   <&'user'&>/<&'password'&>
7582 .endd
7583 Any of the three sub-parts of the first field can be omitted. For normal use on
7584 the local host it can be left blank or set to just &"localhost"&.
7585
7586 No database need be supplied &-- but if it is absent here, it must be given in
7587 the queries.
7588
7589 If a MySQL query is issued that does not request any data (an insert, update,
7590 or delete command), the result of the lookup is the number of rows affected.
7591
7592 &*Warning*&: This can be misleading. If an update does not actually change
7593 anything (for example, setting a field to the value it already has), the result
7594 is zero because no rows are affected.
7595
7596
7597 .section "Special PostgreSQL features" "SECID74"
7598 PostgreSQL lookups can also use Unix domain socket connections to the database.
7599 This is usually faster and costs less CPU time than a TCP/IP connection.
7600 However it can be used only if the mail server runs on the same machine as the
7601 database server. A configuration line for PostgreSQL via Unix domain sockets
7602 looks like this:
7603 .code
7604 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7605 .endd
7606 In other words, instead of supplying a host name, a path to the socket is
7607 given. The path name is enclosed in parentheses so that its slashes aren't
7608 visually confused with the delimiters for the other server parameters.
7609
7610 If a PostgreSQL query is issued that does not request any data (an insert,
7611 update, or delete command), the result of the lookup is the number of rows
7612 affected.
7613
7614 .section "More about SQLite" "SECTsqlite"
7615 .cindex "lookup" "SQLite"
7616 .cindex "sqlite lookup type"
7617 SQLite is different to the other SQL lookups because a file name is required in
7618 addition to the SQL query. An SQLite database is a single file, and there is no
7619 daemon as in the other SQL databases. The interface to Exim requires the name
7620 of the file, as an absolute path, to be given at the start of the query. It is
7621 separated from the query by white space. This means that the path name cannot
7622 contain white space. Here is a lookup expansion example:
7623 .code
7624 ${lookup sqlite {/some/thing/sqlitedb \
7625   select name from aliases where id='userx';}}
7626 .endd
7627 In a list, the syntax is similar. For example:
7628 .code
7629 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7630    select * from relays where ip='$sender_host_address';
7631 .endd
7632 The only character affected by the &%quote_sqlite%& operator is a single
7633 quote, which it doubles.
7634
7635 The SQLite library handles multiple simultaneous accesses to the database
7636 internally. Multiple readers are permitted, but only one process can
7637 update at once. Attempts to access the database while it is being updated
7638 are rejected after a timeout period, during which the SQLite library
7639 waits for the lock to be released. In Exim, the default timeout is set
7640 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7641 option.
7642 .ecindex IIDfidalo1
7643 .ecindex IIDfidalo2
7644
7645
7646 . ////////////////////////////////////////////////////////////////////////////
7647 . ////////////////////////////////////////////////////////////////////////////
7648
7649 .chapter "Domain, host, address, and local part lists" &&&
7650          "CHAPdomhosaddlists" &&&
7651          "Domain, host, and address lists"
7652 .scindex IIDdohoadli "lists of domains; hosts; etc."
7653 A number of Exim configuration options contain lists of domains, hosts,
7654 email addresses, or local parts. For example, the &%hold_domains%& option
7655 contains a list of domains whose delivery is currently suspended. These lists
7656 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7657 arguments to expansion conditions such as &%match_domain%&.
7658
7659 Each item in one of these lists is a pattern to be matched against a domain,
7660 host, email address, or local part, respectively. In the sections below, the
7661 different types of pattern for each case are described, but first we cover some
7662 general facilities that apply to all four kinds of list.
7663
7664
7665
7666 .section "Expansion of lists" "SECID75"
7667 .cindex "expansion" "of lists"
7668 Each list is expanded as a single string before it is used. The result of
7669 expansion must be a list, possibly containing empty items, which is split up
7670 into separate items for matching. By default, colon is the separator character,
7671 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7672 &<<SECTempitelis>>& for details of the list syntax; the second of these
7673 discusses the way to specify empty list items.
7674
7675
7676 If the string expansion is forced to fail, Exim behaves as if the item it is
7677 testing (domain, host, address, or local part) is not in the list. Other
7678 expansion failures cause temporary errors.
7679
7680 If an item in a list is a regular expression, backslashes, dollars and possibly
7681 other special characters in the expression must be protected against
7682 misinterpretation by the string expander. The easiest way to do this is to use
7683 the &`\N`& expansion feature to indicate that the contents of the regular
7684 expression should not be expanded. For example, in an ACL you might have:
7685 .code
7686 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7687                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7688 .endd
7689 The first item is a regular expression that is protected from expansion by
7690 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7691 senders based on the receiving domain.
7692
7693
7694
7695
7696 .section "Negated items in lists" "SECID76"
7697 .cindex "list" "negation"
7698 .cindex "negation" "in lists"
7699 Items in a list may be positive or negative. Negative items are indicated by a
7700 leading exclamation mark, which may be followed by optional white space. A list
7701 defines a set of items (domains, etc). When Exim processes one of these lists,
7702 it is trying to find out whether a domain, host, address, or local part
7703 (respectively) is in the set that is defined by the list. It works like this:
7704
7705 The list is scanned from left to right. If a positive item is matched, the
7706 subject that is being checked is in the set; if a negative item is matched, the
7707 subject is not in the set. If the end of the list is reached without the
7708 subject having matched any of the patterns, it is in the set if the last item
7709 was a negative one, but not if it was a positive one. For example, the list in
7710 .code
7711 domainlist relay_to_domains = !a.b.c : *.b.c
7712 .endd
7713 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7714 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7715 list is positive. However, if the setting were
7716 .code
7717 domainlist relay_to_domains = !a.b.c
7718 .endd
7719 then all domains other than &'a.b.c'& would match because the last item in the
7720 list is negative. In other words, a list that ends with a negative item behaves
7721 as if it had an extra item &`:*`& on the end.
7722
7723 Another way of thinking about positive and negative items in lists is to read
7724 the connector as &"or"& after a positive item and as &"and"& after a negative
7725 item.
7726
7727
7728
7729 .section "File names in lists" "SECTfilnamlis"
7730 .cindex "list" "file name in"
7731 If an item in a domain, host, address, or local part list is an absolute file
7732 name (beginning with a slash character), each line of the file is read and
7733 processed as if it were an independent item in the list, except that further
7734 file names are not allowed,
7735 and no expansion of the data from the file takes place.
7736 Empty lines in the file are ignored, and the file may also contain comment
7737 lines:
7738
7739 .ilist
7740 For domain and host lists, if a # character appears anywhere in a line of the
7741 file, it and all following characters are ignored.
7742 .next
7743 Because local parts may legitimately contain # characters, a comment in an
7744 address list or local part list file is recognized only if # is preceded by
7745 white space or the start of the line. For example:
7746 .code
7747 not#comment@x.y.z   # but this is a comment
7748 .endd
7749 .endlist
7750
7751 Putting a file name in a list has the same effect as inserting each line of the
7752 file as an item in the list (blank lines and comments excepted). However, there
7753 is one important difference: the file is read each time the list is processed,
7754 so if its contents vary over time, Exim's behaviour changes.
7755
7756 If a file name is preceded by an exclamation mark, the sense of any match
7757 within the file is inverted. For example, if
7758 .code
7759 hold_domains = !/etc/nohold-domains
7760 .endd
7761 and the file contains the lines
7762 .code
7763 !a.b.c
7764 *.b.c
7765 .endd
7766 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7767 any domain matching &`*.b.c`& is not.
7768
7769
7770
7771 .section "An lsearch file is not an out-of-line list" "SECID77"
7772 As will be described in the sections that follow, lookups can be used in lists
7773 to provide indexed methods of checking list membership. There has been some
7774 confusion about the way &(lsearch)& lookups work in lists. Because
7775 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7776 sometimes thought that it is allowed to contain wild cards and other kinds of
7777 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7778 always fixed strings, just as for any other single-key lookup type.
7779
7780 If you want to use a file to contain wild-card patterns that form part of a
7781 list, just give the file name on its own, without a search type, as described
7782 in the previous section. You could also use the &(wildlsearch)& or
7783 &(nwildlsearch)&, but there is no advantage in doing this.
7784
7785
7786
7787
7788 .section "Named lists" "SECTnamedlists"
7789 .cindex "named lists"
7790 .cindex "list" "named"
7791 A list of domains, hosts, email addresses, or local parts can be given a name
7792 which is then used to refer to the list elsewhere in the configuration. This is
7793 particularly convenient if the same list is required in several different
7794 places. It also allows lists to be given meaningful names, which can improve
7795 the readability of the configuration. For example, it is conventional to define
7796 a domain list called &'local_domains'& for all the domains that are handled
7797 locally on a host, using a configuration line such as
7798 .code
7799 domainlist local_domains = localhost:my.dom.example
7800 .endd
7801 Named lists are referenced by giving their name preceded by a plus sign, so,
7802 for example, a router that is intended to handle local domains would be
7803 configured with the line
7804 .code
7805 domains = +local_domains
7806 .endd
7807 The first router in a configuration is often one that handles all domains
7808 except the local ones, using a configuration with a negated item like this:
7809 .code
7810 dnslookup:
7811   driver = dnslookup
7812   domains = ! +local_domains
7813   transport = remote_smtp
7814   no_more
7815 .endd
7816 The four kinds of named list are created by configuration lines starting with
7817 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7818 respectively. Then there follows the name that you are defining, followed by an
7819 equals sign and the list itself. For example:
7820 .code
7821 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7822 addresslist bad_senders = cdb;/etc/badsenders
7823 .endd
7824 A named list may refer to other named lists:
7825 .code
7826 domainlist  dom1 = first.example : second.example
7827 domainlist  dom2 = +dom1 : third.example
7828 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7829 .endd
7830 &*Warning*&: If the last item in a referenced list is a negative one, the
7831 effect may not be what you intended, because the negation does not propagate
7832 out to the higher level. For example, consider:
7833 .code
7834 domainlist  dom1 = !a.b
7835 domainlist  dom2 = +dom1 : *.b
7836 .endd
7837 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7838 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7839 means it matches the second list as well. The effect is not the same as
7840 .code
7841 domainlist  dom2 = !a.b : *.b
7842 .endd
7843 where &'x.y'& does not match. It's best to avoid negation altogether in
7844 referenced lists if you can.
7845
7846 Named lists may have a performance advantage. When Exim is routing an
7847 address or checking an incoming message, it caches the result of tests on named
7848 lists. So, if you have a setting such as
7849 .code
7850 domains = +local_domains
7851 .endd
7852 on several of your routers
7853 or in several ACL statements,
7854 the actual test is done only for the first one. However, the caching works only
7855 if there are no expansions within the list itself or any sublists that it
7856 references. In other words, caching happens only for lists that are known to be
7857 the same each time they are referenced.
7858
7859 By default, there may be up to 16 named lists of each type. This limit can be
7860 extended by changing a compile-time variable. The use of domain and host lists
7861 is recommended for concepts such as local domains, relay domains, and relay
7862 hosts. The default configuration is set up like this.
7863
7864
7865
7866 .section "Named lists compared with macros" "SECID78"
7867 .cindex "list" "named compared with macro"
7868 .cindex "macro" "compared with named list"
7869 At first sight, named lists might seem to be no different from macros in the
7870 configuration file. However, macros are just textual substitutions. If you
7871 write
7872 .code
7873 ALIST = host1 : host2
7874 auth_advertise_hosts = !ALIST
7875 .endd
7876 it probably won't do what you want, because that is exactly the same as
7877 .code
7878 auth_advertise_hosts = !host1 : host2
7879 .endd
7880 Notice that the second host name is not negated. However, if you use a host
7881 list, and write
7882 .code
7883 hostlist alist = host1 : host2
7884 auth_advertise_hosts = ! +alist
7885 .endd
7886 the negation applies to the whole list, and so that is equivalent to
7887 .code
7888 auth_advertise_hosts = !host1 : !host2
7889 .endd
7890
7891
7892 .section "Named list caching" "SECID79"
7893 .cindex "list" "caching of named"
7894 .cindex "caching" "named lists"
7895 While processing a message, Exim caches the result of checking a named list if
7896 it is sure that the list is the same each time. In practice, this means that
7897 the cache operates only if the list contains no $ characters, which guarantees
7898 that it will not change when it is expanded. Sometimes, however, you may have
7899 an expanded list that you know will be the same each time within a given
7900 message. For example:
7901 .code
7902 domainlist special_domains = \
7903            ${lookup{$sender_host_address}cdb{/some/file}}
7904 .endd
7905 This provides a list of domains that depends only on the sending host's IP
7906 address. If this domain list is referenced a number of times (for example,
7907 in several ACL lines, or in several routers) the result of the check is not
7908 cached by default, because Exim does not know that it is going to be the
7909 same list each time.
7910
7911 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7912 cache the result anyway. For example:
7913 .code
7914 domainlist_cache special_domains = ${lookup{...
7915 .endd
7916 If you do this, you should be absolutely sure that caching is going to do
7917 the right thing in all cases. When in doubt, leave it out.
7918
7919
7920
7921 .section "Domain lists" "SECTdomainlist"
7922 .cindex "domain list" "patterns for"
7923 .cindex "list" "domain list"
7924 Domain lists contain patterns that are to be matched against a mail domain.
7925 The following types of item may appear in domain lists:
7926
7927 .ilist
7928 .cindex "primary host name"
7929 .cindex "host name" "matched in domain list"
7930 .oindex "&%primary_hostname%&"
7931 .cindex "domain list" "matching primary host name"
7932 .cindex "@ in a domain list"
7933 If a pattern consists of a single @ character, it matches the local host name,
7934 as set by the &%primary_hostname%& option (or defaulted). This makes it
7935 possible to use the same configuration file on several different hosts that
7936 differ only in their names.
7937 .next
7938 .cindex "@[] in a domain list"
7939 .cindex "domain list" "matching local IP interfaces"
7940 .cindex "domain literal"
7941 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7942 in square brackets (as in an email address that contains a domain literal), but
7943 only if that IP address is recognized as local for email routing purposes. The
7944 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7945 control which of a host's several IP addresses are treated as local.
7946 In today's Internet, the use of domain literals is controversial.
7947 .next
7948 .cindex "@mx_any"
7949 .cindex "@mx_primary"
7950 .cindex "@mx_secondary"
7951 .cindex "domain list" "matching MX pointers to local host"
7952 If a pattern consists of the string &`@mx_any`& it matches any domain that
7953 has an MX record pointing to the local host or to any host that is listed in
7954 .oindex "&%hosts_treat_as_local%&"
7955 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7956 are similar, except that the first matches only when a primary MX target is the
7957 local host, and the second only when no primary MX target is the local host,
7958 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7959 preference value &-- there may of course be more than one of them.
7960
7961 The MX lookup that takes place when matching a pattern of this type is
7962 performed with the resolver options for widening names turned off. Thus, for
7963 example, a single-component domain will &'not'& be expanded by adding the
7964 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7965 options of the &(dnslookup)& router for a discussion of domain widening.
7966
7967 Sometimes you may want to ignore certain IP addresses when using one of these
7968 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7969 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7970 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7971 on a router). For example:
7972 .code
7973 domains = @mx_any/ignore=127.0.0.1
7974 .endd
7975 This example matches any domain that has an MX record pointing to one of
7976 the local host's IP addresses other than 127.0.0.1.
7977
7978 The list of IP addresses is in fact processed by the same code that processes
7979 host lists, so it may contain CIDR-coded network specifications and it may also
7980 contain negative items.
7981
7982 Because the list of IP addresses is a sublist within a domain list, you have to
7983 be careful about delimiters if there is more than one address. Like any other
7984 list, the default delimiter can be changed. Thus, you might have:
7985 .code
7986 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7987           an.other.domain : ...
7988 .endd
7989 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7990 involved, it is easiest to change the delimiter for the main list as well:
7991 .code
7992 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7993           an.other.domain ? ...
7994 .endd
7995 .next
7996 .cindex "asterisk" "in domain list"
7997 .cindex "domain list" "asterisk in"
7998 .cindex "domain list" "matching &""ends with""&"
7999 If a pattern starts with an asterisk, the remaining characters of the pattern
8000 are compared with the terminating characters of the domain. The use of &"*"& in
8001 domain lists differs from its use in partial matching lookups. In a domain
8002 list, the character following the asterisk need not be a dot, whereas partial
8003 matching works only in terms of dot-separated components. For example, a domain
8004 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8005 &'cipher.key.ex'&.
8006
8007 .next
8008 .cindex "regular expressions" "in domain list"
8009 .cindex "domain list" "matching regular expression"
8010 If a pattern starts with a circumflex character, it is treated as a regular
8011 expression, and matched against the domain using a regular expression matching
8012 function. The circumflex is treated as part of the regular expression.
8013 Email domains are case-independent, so this regular expression match is by
8014 default case-independent, but you can make it case-dependent by starting it
8015 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8016 are given in chapter &<<CHAPregexp>>&.
8017
8018 &*Warning*&: Because domain lists are expanded before being processed, you
8019 must escape any backslash and dollar characters in the regular expression, or
8020 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8021 it is not to be expanded (unless you really do want to build a regular
8022 expression by expansion, of course).
8023 .next
8024 .cindex "lookup" "in domain list"
8025 .cindex "domain list" "matching by lookup"
8026 If a pattern starts with the name of a single-key lookup type followed by a
8027 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8028 must be a file name in a suitable format for the lookup type. For example, for
8029 &"cdb;"& it must be an absolute path:
8030 .code
8031 domains = cdb;/etc/mail/local_domains.cdb
8032 .endd
8033 The appropriate type of lookup is done on the file using the domain name as the
8034 key. In most cases, the data that is looked up is not used; Exim is interested
8035 only in whether or not the key is present in the file. However, when a lookup
8036 is used for the &%domains%& option on a router
8037 or a &%domains%& condition in an ACL statement, the data is preserved in the
8038 &$domain_data$& variable and can be referred to in other router options or
8039 other statements in the same ACL.
8040
8041 .next
8042 Any of the single-key lookup type names may be preceded by
8043 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8044 .code
8045 domains = partial-dbm;/partial/domains
8046 .endd
8047 This causes partial matching logic to be invoked; a description of how this
8048 works is given in section &<<SECTpartiallookup>>&.
8049
8050 .next
8051 .cindex "asterisk" "in lookup type"
8052 Any of the single-key lookup types may be followed by an asterisk. This causes
8053 a default lookup for a key consisting of a single asterisk to be done if the
8054 original lookup fails. This is not a useful feature when using a domain list to
8055 select particular domains (because any domain would match), but it might have
8056 value if the result of the lookup is being used via the &$domain_data$&
8057 expansion variable.
8058 .next
8059 If the pattern starts with the name of a query-style lookup type followed by a
8060 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8061 pattern must be an appropriate query for the lookup type, as described in
8062 chapter &<<CHAPfdlookup>>&. For example:
8063 .code
8064 hold_domains = mysql;select domain from holdlist \
8065   where domain = '${quote_mysql:$domain}';
8066 .endd
8067 In most cases, the data that is looked up is not used (so for an SQL query, for
8068 example, it doesn't matter what field you select). Exim is interested only in
8069 whether or not the query succeeds. However, when a lookup is used for the
8070 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8071 variable and can be referred to in other options.
8072 .next
8073 .cindex "domain list" "matching literal domain name"
8074 If none of the above cases apply, a caseless textual comparison is made
8075 between the pattern and the domain.
8076 .endlist
8077
8078 Here is an example that uses several different kinds of pattern:
8079 .code
8080 domainlist funny_domains = \
8081   @ : \
8082   lib.unseen.edu : \
8083   *.foundation.fict.example : \
8084   \N^[1-2]\d{3}\.fict\.example$\N : \
8085   partial-dbm;/opt/data/penguin/book : \
8086   nis;domains.byname : \
8087   nisplus;[name=$domain,status=local],domains.org_dir
8088 .endd
8089 There are obvious processing trade-offs among the various matching modes. Using
8090 an asterisk is faster than a regular expression, and listing a few names
8091 explicitly probably is too. The use of a file or database lookup is expensive,
8092 but may be the only option if hundreds of names are required. Because the
8093 patterns are tested in order, it makes sense to put the most commonly matched
8094 patterns earlier.
8095
8096
8097
8098 .section "Host lists" "SECThostlist"
8099 .cindex "host list" "patterns in"
8100 .cindex "list" "host list"
8101 Host lists are used to control what remote hosts are allowed to do. For
8102 example, some hosts may be allowed to use the local host as a relay, and some
8103 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8104 two different ways, by name or by IP address. In a host list, some types of
8105 pattern are matched to a host name, and some are matched to an IP address.
8106 You need to be particularly careful with this when single-key lookups are
8107 involved, to ensure that the right value is being used as the key.
8108
8109
8110 .section "Special host list patterns" "SECID80"
8111 .cindex "empty item in hosts list"
8112 .cindex "host list" "empty string in"
8113 If a host list item is the empty string, it matches only when no remote host is
8114 involved. This is the case when a message is being received from a local
8115 process using SMTP on the standard input, that is, when a TCP/IP connection is
8116 not used.
8117
8118 .cindex "asterisk" "in host list"
8119 The special pattern &"*"& in a host list matches any host or no host. Neither
8120 the IP address nor the name is actually inspected.
8121
8122
8123
8124 .section "Host list patterns that match by IP address" "SECThoslispatip"
8125 .cindex "host list" "matching IP addresses"
8126 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8127 the incoming address actually appears in the IPv6 host as
8128 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8129 list, it is converted into a traditional IPv4 address first. (Not all operating
8130 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8131 concerns.)
8132
8133 The following types of pattern in a host list check the remote host by
8134 inspecting its IP address:
8135
8136 .ilist
8137 If the pattern is a plain domain name (not a regular expression, not starting
8138 with *, not a lookup of any kind), Exim calls the operating system function
8139 to find the associated IP address(es). Exim uses the newer
8140 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8141 This typically causes a forward DNS lookup of the name. The result is compared
8142 with the IP address of the subject host.
8143
8144 If there is a temporary problem (such as a DNS timeout) with the host name
8145 lookup, a temporary error occurs. For example, if the list is being used in an
8146 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8147 temporary SMTP error code. If no IP address can be found for the host name,
8148 what happens is described in section &<<SECTbehipnot>>& below.
8149
8150 .next
8151 .cindex "@ in a host list"
8152 If the pattern is &"@"&, the primary host name is substituted and used as a
8153 domain name, as just described.
8154
8155 .next
8156 If the pattern is an IP address, it is matched against the IP address of the
8157 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8158 IPv6 addresses can be given in colon-separated format, but the colons have to
8159 be doubled so as not to be taken as item separators when the default list
8160 separator is used. IPv6 addresses are recognized even when Exim is compiled
8161 without IPv6 support. This means that if they appear in a host list on an
8162 IPv4-only host, Exim will not treat them as host names. They are just addresses
8163 that can never match a client host.
8164
8165 .next
8166 .cindex "@[] in a host list"
8167 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8168 the local host. For example, if the local host is an IPv4 host with one
8169 interface address 10.45.23.56, these two ACL statements have the same effect:
8170 .code
8171 accept hosts = 127.0.0.1 : 10.45.23.56
8172 accept hosts = @[]
8173 .endd
8174 .next
8175 .cindex "CIDR notation"
8176 If the pattern is an IP address followed by a slash and a mask length (for
8177 example 10.11.42.0/24), it is matched against the IP address of the subject
8178 host under the given mask. This allows, an entire network of hosts to be
8179 included (or excluded) by a single item. The mask uses CIDR notation; it
8180 specifies the number of address bits that must match, starting from the most
8181 significant end of the address.
8182
8183 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8184 of a range of addresses. It is the number of bits in the network portion of the
8185 address. The above example specifies a 24-bit netmask, so it matches all 256
8186 addresses in the 10.11.42.0 network. An item such as
8187 .code
8188 192.168.23.236/31
8189 .endd
8190 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8191 32 for an IPv4 address is the same as no mask at all; just a single address
8192 matches.
8193
8194 Here is another example which shows an IPv4 and an IPv6 network:
8195 .code
8196 recipient_unqualified_hosts = 192.168.0.0/16: \
8197                               3ffe::ffff::836f::::/48
8198 .endd
8199 The doubling of list separator characters applies only when these items
8200 appear inline in a host list. It is not required when indirecting via a file.
8201 For example:
8202 .code
8203 recipient_unqualified_hosts = /opt/exim/unqualnets
8204 .endd
8205 could make use of a file containing
8206 .code
8207 172.16.0.0/12
8208 3ffe:ffff:836f::/48
8209 .endd
8210 to have exactly the same effect as the previous example. When listing IPv6
8211 addresses inline, it is usually more convenient to use the facility for
8212 changing separator characters. This list contains the same two networks:
8213 .code
8214 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8215                                  3ffe:ffff:836f::/48
8216 .endd
8217 The separator is changed to semicolon by the leading &"<;"& at the start of the
8218 list.
8219 .endlist
8220
8221
8222
8223 .section "Host list patterns for single-key lookups by host address" &&&
8224          "SECThoslispatsikey"
8225 .cindex "host list" "lookup of IP address"
8226 When a host is to be identified by a single-key lookup of its complete IP
8227 address, the pattern takes this form:
8228 .display
8229 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8230 .endd
8231 For example:
8232 .code
8233 hosts_lookup = net-cdb;/hosts-by-ip.db
8234 .endd
8235 The text form of the IP address of the subject host is used as the lookup key.
8236 IPv6 addresses are converted to an unabbreviated form, using lower case
8237 letters, with dots as separators because colon is the key terminator in
8238 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8239 quoting the keys, but this is a facility that was added later.] The data
8240 returned by the lookup is not used.
8241
8242 .cindex "IP address" "masking"
8243 .cindex "host list" "masked IP address"
8244 Single-key lookups can also be performed using masked IP addresses, using
8245 patterns of this form:
8246 .display
8247 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8248 .endd
8249 For example:
8250 .code
8251 net24-dbm;/networks.db
8252 .endd
8253 The IP address of the subject host is masked using <&'number'&> as the mask
8254 length. A textual string is constructed from the masked value, followed by the
8255 mask, and this is used as the lookup key. For example, if the host's IP address
8256 is 192.168.34.6, the key that is looked up for the above example is
8257 &"192.168.34.0/24"&.
8258
8259 When an IPv6 address is converted to a string, dots are normally used instead
8260 of colons, so that keys in &(lsearch)& files need not contain colons (which
8261 terminate &(lsearch)& keys). This was implemented some time before the ability
8262 to quote keys was made available in &(lsearch)& files. However, the more
8263 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8264 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8265 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8266 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8267 addresses are always used.
8268
8269 Ideally, it would be nice to tidy up this anomalous situation by changing to
8270 colons in all cases, given that quoting is now available for &(lsearch)&.
8271 However, this would be an incompatible change that might break some existing
8272 configurations.
8273
8274 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8275 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8276 the former case the key strings include the mask value, whereas in the latter
8277 case the IP address is used on its own.
8278
8279
8280
8281 .section "Host list patterns that match by host name" "SECThoslispatnam"
8282 .cindex "host" "lookup failures"
8283 .cindex "unknown host name"
8284 .cindex "host list" "matching host name"
8285 There are several types of pattern that require Exim to know the name of the
8286 remote host. These are either wildcard patterns or lookups by name. (If a
8287 complete hostname is given without any wildcarding, it is used to find an IP
8288 address to match against, as described in section &<<SECThoslispatip>>&
8289 above.)
8290
8291 If the remote host name is not already known when Exim encounters one of these
8292 patterns, it has to be found from the IP address.
8293 Although many sites on the Internet are conscientious about maintaining reverse
8294 DNS data for their hosts, there are also many that do not do this.
8295 Consequently, a name cannot always be found, and this may lead to unwanted
8296 effects. Take care when configuring host lists with wildcarded name patterns.
8297 Consider what will happen if a name cannot be found.
8298
8299 Because of the problems of determining host names from IP addresses, matching
8300 against host names is not as common as matching against IP addresses.
8301
8302 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8303 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8304 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8305 are done can be changed by setting the &%host_lookup_order%& option. For
8306 security, once Exim has found one or more names, it looks up the IP addresses
8307 for these names and compares them with the IP address that it started with.
8308 Only those names whose IP addresses match are accepted. Any other names are
8309 discarded. If no names are left, Exim behaves as if the host name cannot be
8310 found. In the most common case there is only one name and one IP address.
8311
8312 There are some options that control what happens if a host name cannot be
8313 found. These are described in section &<<SECTbehipnot>>& below.
8314
8315 .cindex "host" "alias for"
8316 .cindex "alias for host"
8317 As a result of aliasing, hosts may have more than one name. When processing any
8318 of the following types of pattern, all the host's names are checked:
8319
8320 .ilist
8321 .cindex "asterisk" "in host list"
8322 If a pattern starts with &"*"& the remainder of the item must match the end of
8323 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8324 &'.b.c'&. This special simple form is provided because this is a very common
8325 requirement. Other kinds of wildcarding require the use of a regular
8326 expression.
8327 .next
8328 .cindex "regular expressions" "in host list"
8329 .cindex "host list" "regular expression in"
8330 If the item starts with &"^"& it is taken to be a regular expression which is
8331 matched against the host name. Host names are case-independent, so this regular
8332 expression match is by default case-independent, but you can make it
8333 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8334 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8335 example,
8336 .code
8337 ^(a|b)\.c\.d$
8338 .endd
8339 is a regular expression that matches either of the two hosts &'a.c.d'& or
8340 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8341 that backslash and dollar characters are not misinterpreted as part of the
8342 string expansion. The simplest way to do this is to use &`\N`& to mark that
8343 part of the string as non-expandable. For example:
8344 .code
8345 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8346 .endd
8347 &*Warning*&: If you want to match a complete host name, you must include the
8348 &`$`& terminating metacharacter in the regular expression, as in the above
8349 example. Without it, a match at the start of the host name is all that is
8350 required.
8351 .endlist
8352
8353
8354
8355
8356 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8357 .cindex "host" "lookup failures, permanent"
8358 While processing a host list, Exim may need to look up an IP address from a
8359 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8360 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8361 behaviour when it fails to find the information it is seeking is the same.
8362
8363 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8364 apply to temporary DNS errors, whose handling is described in the next section.
8365
8366 .cindex "&`+include_unknown`&"
8367 .cindex "&`+ignore_unknown`&"
8368 Exim parses a host list from left to right. If it encounters a permanent
8369 lookup failure in any item in the host list before it has found a match,
8370 Exim treats it as a failure and the default behavior is as if the host
8371 does not match the list. This may not always be what you want to happen.
8372 To change Exim's behaviour, the special items &`+include_unknown`& or
8373 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8374 not recognized in an indirected file).
8375
8376 .ilist
8377 If any item that follows &`+include_unknown`& requires information that
8378 cannot found, Exim behaves as if the host does match the list. For example,
8379 .code
8380 host_reject_connection = +include_unknown:*.enemy.ex
8381 .endd
8382 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8383 any hosts whose name it cannot find.
8384
8385 .next
8386 If any item that follows &`+ignore_unknown`& requires information that cannot
8387 be found, Exim ignores that item and proceeds to the rest of the list. For
8388 example:
8389 .code
8390 accept hosts = +ignore_unknown : friend.example : \
8391                192.168.4.5
8392 .endd
8393 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8394 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8395 name can be found for 192.168.4.5, it is rejected.
8396 .endlist
8397
8398 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8399 list. The effect of each one lasts until the next, or until the end of the
8400 list.
8401
8402 .section "Mixing wildcarded host names and addresses in host lists" &&&
8403          "SECTmixwilhos"
8404 .cindex "host list" "mixing names and addresses in"
8405
8406 This section explains the host/ip processing logic with the same concepts
8407 as the previous section, but specifically addresses what happens when a
8408 wildcarded hostname is one of the items in the hostlist.
8409
8410 .ilist
8411 If you have name lookups or wildcarded host names and
8412 IP addresses in the same host list, you should normally put the IP
8413 addresses first. For example, in an ACL you could have:
8414 .code
8415 accept hosts = 10.9.8.7 : *.friend.example
8416 .endd
8417 The reason you normally would order it this way lies in the
8418 left-to-right way that Exim processes lists.  It can test IP addresses
8419 without doing any DNS lookups, but when it reaches an item that requires
8420 a host name, it fails if it cannot find a host name to compare with the
8421 pattern. If the above list is given in the opposite order, the
8422 &%accept%& statement fails for a host whose name cannot be found, even
8423 if its IP address is 10.9.8.7.
8424
8425 .next
8426 If you really do want to do the name check first, and still recognize the IP
8427 address, you can rewrite the ACL like this:
8428 .code
8429 accept hosts = *.friend.example
8430 accept hosts = 10.9.8.7
8431 .endd
8432 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8433 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8434 &`+ignore_unknown`&, which was discussed in depth in the first example in
8435 this section.
8436 .endlist
8437
8438
8439 .section "Temporary DNS errors when looking up host information" &&&
8440          "SECTtemdnserr"
8441 .cindex "host" "lookup failures, temporary"
8442 .cindex "&`+include_defer`&"
8443 .cindex "&`+ignore_defer`&"
8444 A temporary DNS lookup failure normally causes a defer action (except when
8445 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8446 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8447 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8448 section. These options should be used with care, probably only in non-critical
8449 host lists such as whitelists.
8450
8451
8452
8453 .section "Host list patterns for single-key lookups by host name" &&&
8454          "SECThoslispatnamsk"
8455 .cindex "unknown host name"
8456 .cindex "host list" "matching host name"
8457 If a pattern is of the form
8458 .display
8459 <&'single-key-search-type'&>;<&'search-data'&>
8460 .endd
8461 for example
8462 .code
8463 dbm;/host/accept/list
8464 .endd
8465 a single-key lookup is performed, using the host name as its key. If the
8466 lookup succeeds, the host matches the item. The actual data that is looked up
8467 is not used.
8468
8469 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8470 keys in the file, not IP addresses. If you want to do lookups based on IP
8471 addresses, you must precede the search type with &"net-"& (see section
8472 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8473 two items in the same list, one doing an address lookup and one doing a name
8474 lookup, both using the same file.
8475
8476
8477
8478 .section "Host list patterns for query-style lookups" "SECID81"
8479 If a pattern is of the form
8480 .display
8481 <&'query-style-search-type'&>;<&'query'&>
8482 .endd
8483 the query is obeyed, and if it succeeds, the host matches the item. The actual
8484 data that is looked up is not used. The variables &$sender_host_address$& and
8485 &$sender_host_name$& can be used in the query. For example:
8486 .code
8487 hosts_lookup = pgsql;\
8488   select ip from hostlist where ip='$sender_host_address'
8489 .endd
8490 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8491 can use the &%sg%& expansion item to change this if you need to. If you want to
8492 use masked IP addresses in database queries, you can use the &%mask%& expansion
8493 operator.
8494
8495 If the query contains a reference to &$sender_host_name$&, Exim automatically
8496 looks up the host name if it has not already done so. (See section
8497 &<<SECThoslispatnam>>& for comments on finding host names.)
8498
8499 Historical note: prior to release 4.30, Exim would always attempt to find a
8500 host name before running the query, unless the search type was preceded by
8501 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8502 still recognized for query-style lookups, but its presence or absence has no
8503 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8504 See section &<<SECThoslispatsikey>>&.)
8505
8506
8507
8508
8509
8510 .section "Address lists" "SECTaddresslist"
8511 .cindex "list" "address list"
8512 .cindex "address list" "empty item"
8513 .cindex "address list" "patterns"
8514 Address lists contain patterns that are matched against mail addresses. There
8515 is one special case to be considered: the sender address of a bounce message is
8516 always empty. You can test for this by providing an empty item in an address
8517 list. For example, you can set up a router to process bounce messages by
8518 using this option setting:
8519 .code
8520 senders = :
8521 .endd
8522 The presence of the colon creates an empty item. If you do not provide any
8523 data, the list is empty and matches nothing. The empty sender can also be
8524 detected by a regular expression that matches an empty string,
8525 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8526
8527 Non-empty items in an address list can be straightforward email addresses. For
8528 example:
8529 .code
8530 senders = jbc@askone.example : hs@anacreon.example
8531 .endd
8532 A certain amount of wildcarding is permitted. If a pattern contains an @
8533 character, but is not a regular expression and does not begin with a
8534 semicolon-terminated lookup type (described below), the local part of the
8535 subject address is compared with the local part of the pattern, which may start
8536 with an asterisk. If the local parts match, the domain is checked in exactly
8537 the same way as for a pattern in a domain list. For example, the domain can be
8538 wildcarded, refer to a named list, or be a lookup:
8539 .code
8540 deny senders = *@*.spamming.site:\
8541                *@+hostile_domains:\
8542                bozo@partial-lsearch;/list/of/dodgy/sites:\
8543                *@dbm;/bad/domains.db
8544 .endd
8545 .cindex "local part" "starting with !"
8546 .cindex "address list" "local part starting with !"
8547 If a local part that begins with an exclamation mark is required, it has to be
8548 specified using a regular expression, because otherwise the exclamation mark is
8549 treated as a sign of negation, as is standard in lists.
8550
8551 If a non-empty pattern that is not a regular expression or a lookup does not
8552 contain an @ character, it is matched against the domain part of the subject
8553 address. The only two formats that are recognized this way are a literal
8554 domain, or a domain pattern that starts with *. In both these cases, the effect
8555 is the same as if &`*@`& preceded the pattern. For example:
8556 .code
8557 deny senders = enemy.domain : *.enemy.domain
8558 .endd
8559
8560 The following kinds of more complicated address list pattern can match any
8561 address, including the empty address that is characteristic of bounce message
8562 senders:
8563
8564 .ilist
8565 .cindex "regular expressions" "in address list"
8566 .cindex "address list" "regular expression in"
8567 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8568 done against the complete address, with the pattern as the regular expression.
8569 You must take care that backslash and dollar characters are not misinterpreted
8570 as part of the string expansion. The simplest way to do this is to use &`\N`&
8571 to mark that part of the string as non-expandable. For example:
8572 .code
8573 deny senders = \N^.*this.*@example\.com$\N : \
8574                \N^\d{8}.+@spamhaus.example$\N : ...
8575 .endd
8576 The &`\N`& sequences are removed by the expansion, so these items do indeed
8577 start with &"^"& by the time they are being interpreted as address patterns.
8578
8579 .next
8580 .cindex "address list" "lookup for complete address"
8581 Complete addresses can be looked up by using a pattern that starts with a
8582 lookup type terminated by a semicolon, followed by the data for the lookup. For
8583 example:
8584 .code
8585 deny senders = cdb;/etc/blocked.senders : \
8586   mysql;select address from blocked where \
8587   address='${quote_mysql:$sender_address}'
8588 .endd
8589 Both query-style and single-key lookup types can be used. For a single-key
8590 lookup type, Exim uses the complete address as the key. However, empty keys are
8591 not supported for single-key lookups, so a match against the empty address
8592 always fails. This restriction does not apply to query-style lookups.
8593
8594 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8595 cannot be used, and is ignored if specified, with an entry being written to the
8596 panic log.
8597 .cindex "*@ with single-key lookup"
8598 However, you can configure lookup defaults, as described in section
8599 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8600 default. For example, with this lookup:
8601 .code
8602 accept senders = lsearch*@;/some/file
8603 .endd
8604 the file could contains lines like this:
8605 .code
8606 user1@domain1.example
8607 *@domain2.example
8608 .endd
8609 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8610 that are tried is:
8611 .code
8612 nimrod@jaeger.example
8613 *@jaeger.example
8614 *
8615 .endd
8616 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8617 would mean that every address matches, thus rendering the test useless.
8618
8619 &*Warning 2*&: Do not confuse these two kinds of item:
8620 .code
8621 deny recipients = dbm*@;/some/file
8622 deny recipients = *@dbm;/some/file
8623 .endd
8624 The first does a whole address lookup, with defaulting, as just described,
8625 because it starts with a lookup type. The second matches the local part and
8626 domain independently, as described in a bullet point below.
8627 .endlist
8628
8629
8630 The following kinds of address list pattern can match only non-empty addresses.
8631 If the subject address is empty, a match against any of these pattern types
8632 always fails.
8633
8634
8635 .ilist
8636 .cindex "@@ with single-key lookup"
8637 .cindex "address list" "@@ lookup type"
8638 .cindex "address list" "split local part and domain"
8639 If a pattern starts with &"@@"& followed by a single-key lookup item
8640 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8641 split into a local part and a domain. The domain is looked up in the file. If
8642 it is not found, there is no match. If it is found, the data that is looked up
8643 from the file is treated as a colon-separated list of local part patterns, each
8644 of which is matched against the subject local part in turn.
8645
8646 .cindex "asterisk" "in address list"
8647 The lookup may be a partial one, and/or one involving a search for a default
8648 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8649 patterns that are looked up can be regular expressions or begin with &"*"&, or
8650 even be further lookups. They may also be independently negated. For example,
8651 with
8652 .code
8653 deny senders = @@dbm;/etc/reject-by-domain
8654 .endd
8655 the data from which the DBM file is built could contain lines like
8656 .code
8657 baddomain.com:  !postmaster : *
8658 .endd
8659 to reject all senders except &%postmaster%& from that domain.
8660
8661 .cindex "local part" "starting with !"
8662 If a local part that actually begins with an exclamation mark is required, it
8663 has to be specified using a regular expression. In &(lsearch)& files, an entry
8664 may be split over several lines by indenting the second and subsequent lines,
8665 but the separating colon must still be included at line breaks. White space
8666 surrounding the colons is ignored. For example:
8667 .code
8668 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8669   spammer3 : spammer4
8670 .endd
8671 As in all colon-separated lists in Exim, a colon can be included in an item by
8672 doubling.
8673
8674 If the last item in the list starts with a right angle-bracket, the remainder
8675 of the item is taken as a new key to look up in order to obtain a continuation
8676 list of local parts. The new key can be any sequence of characters. Thus one
8677 might have entries like
8678 .code
8679 aol.com: spammer1 : spammer 2 : >*
8680 xyz.com: spammer3 : >*
8681 *:       ^\d{8}$
8682 .endd
8683 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8684 local parts for all domains, in addition to the specific local parts listed for
8685 each domain. Of course, using this feature costs another lookup each time a
8686 chain is followed, but the effort needed to maintain the data is reduced.
8687
8688 .cindex "loop" "in lookups"
8689 It is possible to construct loops using this facility, and in order to catch
8690 them, the chains may be no more than fifty items long.
8691
8692 .next
8693 The @@<&'lookup'&> style of item can also be used with a query-style
8694 lookup, but in this case, the chaining facility is not available. The lookup
8695 can only return a single list of local parts.
8696 .endlist
8697
8698 &*Warning*&: There is an important difference between the address list items
8699 in these two examples:
8700 .code
8701 senders = +my_list
8702 senders = *@+my_list
8703 .endd
8704 In the first one, &`my_list`& is a named address list, whereas in the second
8705 example it is a named domain list.
8706
8707
8708
8709
8710 .section "Case of letters in address lists" "SECTcasletadd"
8711 .cindex "case of local parts"
8712 .cindex "address list" "case forcing"
8713 .cindex "case forcing in address lists"
8714 Domains in email addresses are always handled caselessly, but for local parts
8715 case may be significant on some systems (see &%caseful_local_part%& for how
8716 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8717 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8718 blocking lists should be done in a case-independent manner. Since most address
8719 lists in Exim are used for this kind of control, Exim attempts to do this by
8720 default.
8721
8722 The domain portion of an address is always lowercased before matching it to an
8723 address list. The local part is lowercased by default, and any string
8724 comparisons that take place are done caselessly. This means that the data in
8725 the address list itself, in files included as plain file names, and in any file
8726 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8727 keys in files that are looked up by a search type other than &(lsearch)& (which
8728 works caselessly) must be in lower case, because these lookups are not
8729 case-independent.
8730
8731 .cindex "&`+caseful`&"
8732 To allow for the possibility of caseful address list matching, if an item in
8733 an address list is the string &"+caseful"&, the original case of the local
8734 part is restored for any comparisons that follow, and string comparisons are no
8735 longer case-independent. This does not affect the domain, which remains in
8736 lower case. However, although independent matches on the domain alone are still
8737 performed caselessly, regular expressions that match against an entire address
8738 become case-sensitive after &"+caseful"& has been seen.
8739
8740
8741
8742 .section "Local part lists" "SECTlocparlis"
8743 .cindex "list" "local part list"
8744 .cindex "local part" "list"
8745 Case-sensitivity in local part lists is handled in the same way as for address
8746 lists, as just described. The &"+caseful"& item can be used if required. In a
8747 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8748 set false, the subject is lowercased and the matching is initially
8749 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8750 matching in the local part list, but not elsewhere in the router. If
8751 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8752 option is case-sensitive from the start.
8753
8754 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8755 comments are handled in the same way as address lists &-- they are recognized
8756 only if the # is preceded by white space or the start of the line.
8757 Otherwise, local part lists are matched in the same way as domain lists, except
8758 that the special items that refer to the local host (&`@`&, &`@[]`&,
8759 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8760 Refer to section &<<SECTdomainlist>>& for details of the other available item
8761 types.
8762 .ecindex IIDdohoadli
8763
8764
8765
8766
8767 . ////////////////////////////////////////////////////////////////////////////
8768 . ////////////////////////////////////////////////////////////////////////////
8769
8770 .chapter "String expansions" "CHAPexpand"
8771 .scindex IIDstrexp "expansion" "of strings"
8772 Many strings in Exim's run time configuration are expanded before use. Some of
8773 them are expanded every time they are used; others are expanded only once.
8774
8775 When a string is being expanded it is copied verbatim from left to right except
8776 when a dollar or backslash character is encountered. A dollar specifies the
8777 start of a portion of the string that is interpreted and replaced as described
8778 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8779 escape character, as described in the following section.
8780
8781 Whether a string is expanded depends upon the context.  Usually this is solely
8782 dependent upon the option for which a value is sought; in this documentation,
8783 options for which string expansion is performed are marked with &dagger; after
8784 the data type.  ACL rules always expand strings.  A couple of expansion
8785 conditions do not expand some of the brace-delimited branches, for security
8786 reasons.
8787
8788
8789
8790 .section "Literal text in expanded strings" "SECTlittext"
8791 .cindex "expansion" "including literal text"
8792 An uninterpreted dollar can be included in an expanded string by putting a
8793 backslash in front of it. A backslash can be used to prevent any special
8794 character being treated specially in an expansion, including backslash itself.
8795 If the string appears in quotes in the configuration file, two backslashes are
8796 required because the quotes themselves cause interpretation of backslashes when
8797 the string is read in (see section &<<SECTstrings>>&).
8798
8799 .cindex "expansion" "non-expandable substrings"
8800 A portion of the string can specified as non-expandable by placing it between
8801 two occurrences of &`\N`&. This is particularly useful for protecting regular
8802 expressions, which often contain backslashes and dollar signs. For example:
8803 .code
8804 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8805 .endd
8806 On encountering the first &`\N`&, the expander copies subsequent characters
8807 without interpretation until it reaches the next &`\N`& or the end of the
8808 string.
8809
8810
8811
8812 .section "Character escape sequences in expanded strings" "SECID82"
8813 .cindex "expansion" "escape sequences"
8814 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8815 expanded string is recognized as an escape sequence for the character newline,
8816 carriage return, or tab, respectively. A backslash followed by up to three
8817 octal digits is recognized as an octal encoding for a single character, and a
8818 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8819 encoding.
8820
8821 These escape sequences are also recognized in quoted strings when they are read
8822 in. Their interpretation in expansions as well is useful for unquoted strings,
8823 and for other cases such as looked-up strings that are then expanded.
8824
8825
8826 .section "Testing string expansions" "SECID83"
8827 .cindex "expansion" "testing"
8828 .cindex "testing" "string expansion"
8829 .oindex "&%-be%&"
8830 Many expansions can be tested by calling Exim with the &%-be%& option. This
8831 takes the command arguments, or lines from the standard input if there are no
8832 arguments, runs them through the string expansion code, and writes the results
8833 to the standard output. Variables based on configuration values are set up, but
8834 since no message is being processed, variables such as &$local_part$& have no
8835 value. Nevertheless the &%-be%& option can be useful for checking out file and
8836 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8837 and &%nhash%&.
8838
8839 Exim gives up its root privilege when it is called with the &%-be%& option, and
8840 instead runs under the uid and gid it was called with, to prevent users from
8841 using &%-be%& for reading files to which they do not have access.
8842
8843 .oindex "&%-bem%&"
8844 If you want to test expansions that include variables whose values are taken
8845 from a message, there are two other options that can be used. The &%-bem%&
8846 option is like &%-be%& except that it is followed by a file name. The file is
8847 read as a message before doing the test expansions. For example:
8848 .code
8849 exim -bem /tmp/test.message '$h_subject:'
8850 .endd
8851 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8852 Exim message identifier. For example:
8853 .code
8854 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8855 .endd
8856 This loads the message from Exim's spool before doing the test expansions, and
8857 is therefore restricted to admin users.
8858
8859
8860 .section "Forced expansion failure" "SECTforexpfai"
8861 .cindex "expansion" "forced failure"
8862 A number of expansions that are described in the following section have
8863 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8864 (which are sometimes called &"curly brackets"&). Which of the two strings is
8865 used depends on some condition that is evaluated as part of the expansion. If,
8866 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8867 the entire string expansion fails in a way that can be detected by the code
8868 that requested the expansion. This is called &"forced expansion failure"&, and
8869 its consequences depend on the circumstances. In some cases it is no different
8870 from any other expansion failure, but in others a different action may be
8871 taken. Such variations are mentioned in the documentation of the option that is
8872 being expanded.
8873
8874
8875
8876
8877 .section "Expansion items" "SECTexpansionitems"
8878 The following items are recognized in expanded strings. White space may be used
8879 between sub-items that are keywords or substrings enclosed in braces inside an
8880 outer set of braces, to improve readability. &*Warning*&: Within braces,
8881 white space is significant.
8882
8883 .vlist
8884 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8885 .cindex "expansion" "variables"
8886 Substitute the contents of the named variable, for example:
8887 .code
8888 $local_part
8889 ${domain}
8890 .endd
8891 The second form can be used to separate the name from subsequent alphanumeric
8892 characters. This form (using braces) is available only for variables; it does
8893 &'not'& apply to message headers. The names of the variables are given in
8894 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8895 given, the expansion fails.
8896
8897 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8898 .cindex "expansion" "operators"
8899 The string is first itself expanded, and then the operation specified by
8900 <&'op'&> is applied to it. For example:
8901 .code
8902 ${lc:$local_part}
8903 .endd
8904 The string starts with the first character after the colon, which may be
8905 leading white space. A list of operators is given in section &<<SECTexpop>>&
8906 below. The operator notation is used for simple expansion items that have just
8907 one argument, because it reduces the number of braces and therefore makes the
8908 string easier to understand.
8909
8910 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8911 This item inserts &"basic"& header lines. It is described with the &%header%&
8912 expansion item below.
8913
8914
8915 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8916 .cindex "expansion" "calling an acl"
8917 .cindex "&%acl%&" "call from expansion"
8918 The name and zero to nine argument strings are first expanded separately.  The expanded
8919 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8920 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8921 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8922 and may use the variables; if another acl expansion is used the values
8923 are restored after it returns.  If the ACL sets
8924 a value using a "message =" modifier and returns accept or deny, the value becomes
8925 the result of the expansion.
8926 If no message is set and the ACL returns accept or deny
8927 the expansion result is an empty string.
8928 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8929
8930
8931 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8932        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8933 .cindex "expansion" "extracting cerificate fields"
8934 .cindex "&%certextract%&" "certificate fields"
8935 .cindex "certificate" "extracting fields"
8936 The <&'certificate'&> must be a variable of type certificate.
8937 The field name is expanded and used to retrive the relevant field from
8938 the certificate.  Supported fields are:
8939 .display
8940 &`version        `&
8941 &`serial_number  `&
8942 &`subject        `& RFC4514 DN
8943 &`issuer         `& RFC4514 DN
8944 &`notbefore      `& time
8945 &`notafter       `& time
8946 &`sig_algorithm  `&
8947 &`signature      `&
8948 &`subj_altname   `& tagged list
8949 &`ocsp_uri       `& list
8950 &`crl_uri        `& list
8951 .endd
8952 If the field is found,
8953 <&'string2'&> is expanded, and replaces the whole item;
8954 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8955 variable &$value$& contains the value that has been extracted. Afterwards, it
8956 is restored to any previous value it might have had.
8957
8958 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8959 key is not found. If {<&'string2'&>} is also omitted, the value that was
8960 extracted is used.
8961
8962 Some field names take optional modifiers, appended and separated by commas.
8963
8964 The field selectors marked as "RFC4514" above
8965 output a Distinguished Name string which is
8966 not quite
8967 parseable by Exim as a comma-separated tagged list
8968 (the exceptions being elements containing commas).
8969 RDN elements of a single type may be selected by
8970 a modifier of the type label; if so the expansion
8971 result is a list (newline-separated by default).
8972 The separator may be changed by another modifer of
8973 a right angle-bracket followed immediately by the new separator.
8974 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8975
8976 The field selectors marked as "time" above
8977 take an optional modifier of "int"
8978 for which the result is the number of seconds since epoch.
8979 Otherwise the result is a human-readable string
8980 in the timezone selected by the main "timezone" option.
8981
8982 The field selectors marked as "list" above return a list,
8983 newline-separated by default,
8984 (embedded separator characters in elements are doubled).
8985 The separator may be changed by a modifier of
8986 a right angle-bracket followed immediately by the new separator.
8987
8988 The field selectors marked as "tagged" above
8989 prefix each list element with a type string and an equals sign.
8990 Elements of only one type may be selected by a modifier
8991 which is one of "dns", "uri" or "mail";
8992 if so the elenment tags are omitted.
8993
8994 If not otherwise noted field values are presented in human-readable form.
8995
8996 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8997        {*&<&'arg'&>&*}...}*&"
8998 .cindex &%dlfunc%&
8999 This expansion dynamically loads and then calls a locally-written C function.
9000 This functionality is available only if Exim is compiled with
9001 .code
9002 EXPAND_DLFUNC=yes
9003 .endd
9004 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9005 object so that it doesn't reload the same object file in the same Exim process
9006 (but of course Exim does start new processes frequently).
9007
9008 There may be from zero to eight arguments to the function. When compiling
9009 a local function that is to be called in this way, &_local_scan.h_& should be
9010 included. The Exim variables and functions that are defined by that API
9011 are also available for dynamically loaded functions. The function itself
9012 must have the following type:
9013 .code
9014 int dlfunction(uschar **yield, int argc, uschar *argv[])
9015 .endd
9016 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9017 function should return one of the following values:
9018
9019 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9020 into the expanded string that is being built.
9021
9022 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9023 from &'yield'&, if it is set.
9024
9025 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9026 taken from &'yield'& if it is set.
9027
9028 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9029
9030 When compiling a function that is to be used in this way with gcc,
9031 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9032 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9033
9034 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9035        {*&<&'string3'&>&*}}*&"
9036 .cindex "expansion" "extracting substrings by key"
9037 .cindex "&%extract%&" "substrings by key"
9038 The key and <&'string1'&> are first expanded separately. Leading and trailing
9039 white space is removed from the key (but not from any of the strings). The key
9040 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9041 form:
9042 .display
9043 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9044 .endd
9045 .vindex "&$value$&"
9046 where the equals signs and spaces (but not both) are optional. If any of the
9047 values contain white space, they must be enclosed in double quotes, and any
9048 values that are enclosed in double quotes are subject to escape processing as
9049 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9050 for the value that corresponds to the key. The search is case-insensitive. If
9051 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9052 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9053 variable &$value$& contains the value that has been extracted. Afterwards, it
9054 is restored to any previous value it might have had.
9055
9056 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9057 key is not found. If {<&'string2'&>} is also omitted, the value that was
9058 extracted is used. Thus, for example, these two expansions are identical, and
9059 yield &"2001"&:
9060 .code
9061 ${extract{gid}{uid=1984 gid=2001}}
9062 ${extract{gid}{uid=1984 gid=2001}{$value}}
9063 .endd
9064 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9065 appear, for example:
9066 .code
9067 ${extract{Z}{A=... B=...}{$value} fail }
9068 .endd
9069 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9070 {<&'string2'&>} must be present for &"fail"& to be recognized.
9071
9072
9073 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9074         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9075 .cindex "expansion" "extracting substrings by number"
9076 .cindex "&%extract%&" "substrings by number"
9077 The <&'number'&> argument must consist entirely of decimal digits,
9078 apart from leading and trailing white space, which is ignored.
9079 This is what distinguishes this form of &%extract%& from the previous kind. It
9080 behaves in the same way, except that, instead of extracting a named field, it
9081 extracts from <&'string1'&> the field whose number is given as the first
9082 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9083 <&'string3'&> as before.
9084
9085 The fields in the string are separated by any one of the characters in the
9086 separator string. These may include space or tab characters.
9087 The first field is numbered one. If the number is negative, the fields are
9088 counted from the end of the string, with the rightmost one numbered -1. If the
9089 number given is zero, the entire string is returned. If the modulus of the
9090 number is greater than the number of fields in the string, the result is the
9091 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9092 provided. For example:
9093 .code
9094 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9095 .endd
9096 yields &"42"&, and
9097 .code
9098 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9099 .endd
9100 yields &"99"&. Two successive separators mean that the field between them is
9101 empty (for example, the fifth field above).
9102
9103
9104 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9105 .cindex "list" "selecting by condition"
9106 .cindex "expansion" "selecting from list by condition"
9107 .vindex "&$item$&"
9108 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9109 default, but the separator can be changed in the usual way. For each item
9110 in this list, its value is place in &$item$&, and then the condition is
9111 evaluated. If the condition is true, &$item$& is added to the output as an
9112 item in a new list; if the condition is false, the item is discarded. The
9113 separator used for the output list is the same as the one used for the
9114 input, but a separator setting is not included in the output. For example:
9115 .code
9116 ${filter{a:b:c}{!eq{$item}{b}}
9117 .endd
9118 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9119 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9120
9121
9122 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9123 .cindex "hash function" "textual"
9124 .cindex "expansion" "textual hash"
9125 This is a textual hashing function, and was the first to be implemented in
9126 early versions of Exim. In current releases, there are other hashing functions
9127 (numeric, MD5, and SHA-1), which are described below.
9128
9129 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9130 <&'n'&>. If you are using fixed values for these numbers, that is, if
9131 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9132 use the simpler operator notation that avoids some of the braces:
9133 .code
9134 ${hash_<n>_<m>:<string>}
9135 .endd
9136 The second number is optional (in both notations). If <&'n'&> is greater than
9137 or equal to the length of the string, the expansion item returns the string.
9138 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9139 function to the string. The new string consists of characters taken from the
9140 first <&'m'&> characters of the string
9141 .code
9142 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9143 .endd
9144 If <&'m'&> is not present the value 26 is used, so that only lower case
9145 letters appear. For example:
9146 .display
9147 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9148 &`$hash{5}{monty}}           `&   yields  &`monty`&
9149 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9150 .endd
9151
9152 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9153         &*$h_*&<&'header&~name'&>&*:*&" &&&
9154        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9155         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9156        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9157         &*$rh_*&<&'header&~name'&>&*:*&"
9158 .cindex "expansion" "header insertion"
9159 .vindex "&$header_$&"
9160 .vindex "&$bheader_$&"
9161 .vindex "&$rheader_$&"
9162 .cindex "header lines" "in expansion strings"
9163 .cindex "header lines" "character sets"
9164 .cindex "header lines" "decoding"
9165 Substitute the contents of the named message header line, for example
9166 .code
9167 $header_reply-to:
9168 .endd
9169 The newline that terminates a header line is not included in the expansion, but
9170 internal newlines (caused by splitting the header line over several physical
9171 lines) may be present.
9172
9173 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9174 the data in the header line is interpreted.
9175
9176 .ilist
9177 .cindex "white space" "in header lines"
9178 &%rheader%& gives the original &"raw"& content of the header line, with no
9179 processing at all, and without the removal of leading and trailing white space.
9180
9181 .next
9182 .cindex "base64 encoding" "in header lines"
9183 &%bheader%& removes leading and trailing white space, and then decodes base64
9184 or quoted-printable MIME &"words"& within the header text, but does no
9185 character set translation. If decoding of what looks superficially like a MIME
9186 &"word"& fails, the raw string is returned. If decoding
9187 .cindex "binary zero" "in header line"
9188 produces a binary zero character, it is replaced by a question mark &-- this is
9189 what Exim does for binary zeros that are actually received in header lines.
9190
9191 .next
9192 &%header%& tries to translate the string as decoded by &%bheader%& to a
9193 standard character set. This is an attempt to produce the same string as would
9194 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9195 returned. Translation is attempted only on operating systems that support the
9196 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9197 a system Makefile or in &_Local/Makefile_&.
9198 .endlist ilist
9199
9200 In a filter file, the target character set for &%header%& can be specified by a
9201 command of the following form:
9202 .code
9203 headers charset "UTF-8"
9204 .endd
9205 This command affects all references to &$h_$& (or &$header_$&) expansions in
9206 subsequently obeyed filter commands. In the absence of this command, the target
9207 character set in a filter is taken from the setting of the &%headers_charset%&
9208 option in the runtime configuration. The value of this option defaults to the
9209 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9210 ISO-8859-1.
9211
9212 Header names follow the syntax of RFC 2822, which states that they may contain
9213 any printing characters except space and colon. Consequently, curly brackets
9214 &'do not'& terminate header names, and should not be used to enclose them as
9215 if they were variables. Attempting to do so causes a syntax error.
9216
9217 Only header lines that are common to all copies of a message are visible to
9218 this mechanism. These are the original header lines that are received with the
9219 message, and any that are added by an ACL statement or by a system
9220 filter. Header lines that are added to a particular copy of a message by a
9221 router or transport are not accessible.
9222
9223 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9224 before the DATA ACL, because the header structure is not set up until the
9225 message is received. Header lines that are added in a RCPT ACL (for example)
9226 are saved until the message's incoming header lines are available, at which
9227 point they are added. When a DATA ACL is running, however, header lines added
9228 by earlier ACLs are visible.
9229
9230 Upper case and lower case letters are synonymous in header names. If the
9231 following character is white space, the terminating colon may be omitted, but
9232 this is not recommended, because you may then forget it when it is needed. When
9233 white space terminates the header name, it is included in the expanded string.
9234 If the message does not contain the given header, the expansion item is
9235 replaced by an empty string. (See the &%def%& condition in section
9236 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9237
9238 If there is more than one header with the same name, they are all concatenated
9239 to form the substitution string, up to a maximum length of 64K. Unless
9240 &%rheader%& is being used, leading and trailing white space is removed from
9241 each header before concatenation, and a completely empty header is ignored. A
9242 newline character is then inserted between non-empty headers, but there is no
9243 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9244 those headers that contain lists of addresses, a comma is also inserted at the
9245 junctions between headers. This does not happen for the &%rheader%& expansion.
9246
9247
9248 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9249 .cindex "expansion" "hmac hashing"
9250 .cindex &%hmac%&
9251 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9252 shared secret and some text into a message authentication code, as specified in
9253 RFC 2104. This differs from &`${md5:secret_text...}`& or
9254 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9255 cryptographic hash, allowing for authentication that is not possible with MD5
9256 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9257 present. For example:
9258 .code
9259 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9260 .endd
9261 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9262 produces:
9263 .code
9264 dd97e3ba5d1a61b5006108f8c8252953
9265 .endd
9266 As an example of how this might be used, you might put in the main part of
9267 an Exim configuration:
9268 .code
9269 SPAMSCAN_SECRET=cohgheeLei2thahw
9270 .endd
9271 In a router or a transport you could then have:
9272 .code
9273 headers_add = \
9274   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9275   ${hmac{md5}{SPAMSCAN_SECRET}\
9276   {${primary_hostname},${message_exim_id},$h_message-id:}}
9277 .endd
9278 Then given a message, you can check where it was scanned by looking at the
9279 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9280 this header line is authentic by recomputing the authentication code from the
9281 host name, message ID and the &'Message-id:'& header line. This can be done
9282 using Exim's &%-be%& option, or by other means, for example by using the
9283 &'hmac_md5_hex()'& function in Perl.
9284
9285
9286 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9287 .cindex "expansion" "conditional"
9288 .cindex "&%if%&, expansion item"
9289 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9290 item; otherwise <&'string2'&> is used. The available conditions are described
9291 in section &<<SECTexpcond>>& below. For example:
9292 .code
9293 ${if eq {$local_part}{postmaster} {yes}{no} }
9294 .endd
9295 The second string need not be present; if it is not and the condition is not
9296 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9297 be present instead of the second string (without any curly brackets). In this
9298 case, the expansion is forced to fail if the condition is not true (see section
9299 &<<SECTforexpfai>>&).
9300
9301 If both strings are omitted, the result is the string &`true`& if the condition
9302 is true, and the empty string if the condition is false. This makes it less
9303 cumbersome to write custom ACL and router conditions. For example, instead of
9304 .code
9305 condition = ${if >{$acl_m4}{3}{true}{false}}
9306 .endd
9307 you can use
9308 .code
9309 condition = ${if >{$acl_m4}{3}}
9310 .endd
9311
9312 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9313 .cindex "expansion" "string truncation"
9314 .cindex "&%length%& expansion item"
9315 The &%length%& item is used to extract the initial portion of a string. Both
9316 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9317 you are using a fixed value for the number, that is, if <&'string1'&> does not
9318 change when expanded, you can use the simpler operator notation that avoids
9319 some of the braces:
9320 .code
9321 ${length_<n>:<string>}
9322 .endd
9323 The result of this item is either the first <&'n'&> characters or the whole
9324 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9325 &%strlen%&, which gives the length of a string.
9326
9327
9328 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9329         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9330 .cindex "expansion" "extracting list elements by number"
9331 .cindex "&%listextract%&" "extract list elements by number"
9332 .cindex "list" "extracting elements by number"
9333 The <&'number'&> argument must consist entirely of decimal digits,
9334 apart from an optional leading minus,
9335 and leading and trailing white space (which is ignored).
9336
9337 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9338 default, but the separator can be changed in the usual way.
9339
9340 The first field of the list is numbered one.
9341 If the number is negative, the fields are
9342 counted from the end of the list, with the rightmost one numbered -1.
9343 The numbered element of the list is extracted and placed in &$value$&,
9344 then <&'string2'&> is expanded as the result.
9345
9346 If the modulus of the
9347 number is zero or greater than the number of fields in the string,
9348 the result is the expansion of <&'string3'&>.
9349
9350 For example:
9351 .code
9352 ${listextract{2}{x:42:99}}
9353 .endd
9354 yields &"42"&, and
9355 .code
9356 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9357 .endd
9358 yields &"result: 99"&.
9359
9360 If {<&'string3'&>} is omitted, an empty string is used for string3.
9361 If {<&'string2'&>} is also omitted, the value that was
9362 extracted is used.
9363 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9364
9365
9366 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9367         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9368 This is the first of one of two different types of lookup item, which are both
9369 described in the next item.
9370
9371 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9372         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9373 .cindex "expansion" "lookup in"
9374 .cindex "file" "lookups"
9375 .cindex "lookup" "in expanded string"
9376 The two forms of lookup item specify data lookups in files and databases, as
9377 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9378 lookups, and the second is used for query-style lookups. The <&'key'&>,
9379 <&'file'&>, and <&'query'&> strings are expanded before use.
9380
9381 If there is any white space in a lookup item which is part of a filter command,
9382 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9383 other place where white space is significant, the lookup item must be enclosed
9384 in double quotes. The use of data lookups in users' filter files may be locked
9385 out by the system administrator.
9386
9387 .vindex "&$value$&"
9388 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9389 During its expansion, the variable &$value$& contains the data returned by the
9390 lookup. Afterwards it reverts to the value it had previously (at the outer
9391 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9392 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9393 string on failure. If <&'string2'&> is provided, it can itself be a nested
9394 lookup, thus providing a mechanism for looking up a default value when the
9395 original lookup fails.
9396
9397 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9398 data for the outer lookup while the parameters of the second lookup are
9399 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9400 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9401 appear, and in this case, if the lookup fails, the entire expansion is forced
9402 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9403 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9404 successful lookup, and nothing in the case of failure.
9405
9406 For single-key lookups, the string &"partial"& is permitted to precede the
9407 search type in order to do partial matching, and * or *@ may follow a search
9408 type to request default lookups if the key does not match (see sections
9409 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9410
9411 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9412 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9413 and non-wild parts of the key during the expansion of the replacement text.
9414 They return to their previous values at the end of the lookup item.
9415
9416 This example looks up the postmaster alias in the conventional alias file:
9417 .code
9418 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9419 .endd
9420 This example uses NIS+ to look up the full name of the user corresponding to
9421 the local part of an address, forcing the expansion to fail if it is not found:
9422 .code
9423 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9424   {$value}fail}
9425 .endd
9426
9427
9428 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9429 .cindex "expansion" "list creation"
9430 .vindex "&$item$&"
9431 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9432 default, but the separator can be changed in the usual way. For each item
9433 in this list, its value is place in &$item$&, and then <&'string2'&> is
9434 expanded and added to the output as an item in a new list. The separator used
9435 for the output list is the same as the one used for the input, but a separator
9436 setting is not included in the output. For example:
9437 .code
9438 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9439 .endd
9440 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9441 value of &$item$& is restored to what it was before. See also the &*filter*&
9442 and &*reduce*& expansion items.
9443
9444 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9445 .cindex "expansion" "numeric hash"
9446 .cindex "hash function" "numeric"
9447 The three strings are expanded; the first two must yield numbers. Call them
9448 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9449 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9450 can use the simpler operator notation that avoids some of the braces:
9451 .code
9452 ${nhash_<n>_<m>:<string>}
9453 .endd
9454 The second number is optional (in both notations). If there is only one number,
9455 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9456 processed by a div/mod hash function that returns two numbers, separated by a
9457 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9458 example,
9459 .code
9460 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9461 .endd
9462 returns the string &"6/33"&.
9463
9464
9465
9466 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9467 .cindex "Perl" "use in expanded string"
9468 .cindex "expansion" "calling Perl from"
9469 This item is available only if Exim has been built to include an embedded Perl
9470 interpreter. The subroutine name and the arguments are first separately
9471 expanded, and then the Perl subroutine is called with those arguments. No
9472 additional arguments need be given; the maximum number permitted, including the
9473 name of the subroutine, is nine.
9474
9475 The return value of the subroutine is inserted into the expanded string, unless
9476 the return value is &%undef%&. In that case, the expansion fails in the same
9477 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9478 Whatever you return is evaluated in a scalar context. For example, if you
9479 return the name of a Perl vector, the return value is the size of the vector,
9480 not its contents.
9481
9482 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9483 with the error message that was passed to &%die%&. More details of the embedded
9484 Perl facility are given in chapter &<<CHAPperl>>&.
9485
9486 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9487 out the use of this expansion item in filter files.
9488
9489
9490 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9491 .cindex "&%prvs%& expansion item"
9492 The first argument is a complete email address and the second is secret
9493 keystring. The third argument, specifying a key number, is optional. If absent,
9494 it defaults to 0. The result of the expansion is a prvs-signed email address,
9495 to be typically used with the &%return_path%& option on an &(smtp)& transport
9496 as part of a bounce address tag validation (BATV) scheme. For more discussion
9497 and an example, see section &<<SECTverifyPRVS>>&.
9498
9499 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9500         {*&<&'string'&>&*}}*&"
9501 .cindex "&%prvscheck%& expansion item"
9502 This expansion item is the complement of the &%prvs%& item. It is used for
9503 checking prvs-signed addresses. If the expansion of the first argument does not
9504 yield a syntactically valid prvs-signed address, the whole item expands to the
9505 empty string. When the first argument does expand to a syntactically valid
9506 prvs-signed address, the second argument is expanded, with the prvs-decoded
9507 version of the address and the key number extracted from the address in the
9508 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9509
9510 These two variables can be used in the expansion of the second argument to
9511 retrieve the secret. The validity of the prvs-signed address is then checked
9512 against the secret. The result is stored in the variable &$prvscheck_result$&,
9513 which is empty for failure or &"1"& for success.
9514
9515 The third argument is optional; if it is missing, it defaults to an empty
9516 string. This argument is now expanded. If the result is an empty string, the
9517 result of the expansion is the decoded version of the address. This is the case
9518 whether or not the signature was valid. Otherwise, the result of the expansion
9519 is the expansion of the third argument.
9520
9521 All three variables can be used in the expansion of the third argument.
9522 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9523 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9524
9525 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9526 .cindex "expansion" "inserting an entire file"
9527 .cindex "file" "inserting into expansion"
9528 .cindex "&%readfile%& expansion item"
9529 The file name and end-of-line string are first expanded separately. The file is
9530 then read, and its contents replace the entire item. All newline characters in
9531 the file are replaced by the end-of-line string if it is present. Otherwise,
9532 newlines are left in the string.
9533 String expansion is not applied to the contents of the file. If you want this,
9534 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9535 the string expansion fails.
9536
9537 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9538 locks out the use of this expansion item in filter files.
9539
9540
9541
9542 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9543         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9544 .cindex "expansion" "inserting from a socket"
9545 .cindex "socket, use of in expansion"
9546 .cindex "&%readsocket%& expansion item"
9547 This item inserts data from a Unix domain or TCP socket into the expanded
9548 string. The minimal way of using it uses just two arguments, as in these
9549 examples:
9550 .code
9551 ${readsocket{/socket/name}{request string}}
9552 ${readsocket{inet:some.host:1234}{request string}}
9553 .endd
9554 For a Unix domain socket, the first substring must be the path to the socket.
9555 For an Internet socket, the first substring must contain &`inet:`& followed by
9556 a host name or IP address, followed by a colon and a port, which can be a
9557 number or the name of a TCP port in &_/etc/services_&. An IP address may
9558 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9559 example:
9560 .code
9561 ${readsocket{inet:[::1]:1234}{request string}}
9562 .endd
9563 Only a single host name may be given, but if looking it up yields more than
9564 one IP address, they are each tried in turn until a connection is made. For
9565 both kinds of socket, Exim makes a connection, writes the request string
9566 (unless it is an empty string) and reads from the socket until an end-of-file
9567 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9568 extend what can be done. Firstly, you can vary the timeout. For example:
9569 .code
9570 ${readsocket{/socket/name}{request string}{3s}}
9571 .endd
9572 A fourth argument allows you to change any newlines that are in the data
9573 that is read, in the same way as for &%readfile%& (see above). This example
9574 turns them into spaces:
9575 .code
9576 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9577 .endd
9578 As with all expansions, the substrings are expanded before the processing
9579 happens. Errors in these sub-expansions cause the expansion to fail. In
9580 addition, the following errors can occur:
9581
9582 .ilist
9583 Failure to create a socket file descriptor;
9584 .next
9585 Failure to connect the socket;
9586 .next
9587 Failure to write the request string;
9588 .next
9589 Timeout on reading from the socket.
9590 .endlist
9591
9592 By default, any of these errors causes the expansion to fail. However, if
9593 you supply a fifth substring, it is expanded and used when any of the above
9594 errors occurs. For example:
9595 .code
9596 ${readsocket{/socket/name}{request string}{3s}{\n}\
9597   {socket failure}}
9598 .endd
9599 You can test for the existence of a Unix domain socket by wrapping this
9600 expansion in &`${if exists`&, but there is a race condition between that test
9601 and the actual opening of the socket, so it is safer to use the fifth argument
9602 if you want to be absolutely sure of avoiding an expansion error for a
9603 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9604
9605 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9606 locks out the use of this expansion item in filter files.
9607
9608
9609 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9610 .cindex "expansion" "reducing a list to a scalar"
9611 .cindex "list" "reducing to a scalar"
9612 .vindex "&$value$&"
9613 .vindex "&$item$&"
9614 This operation reduces a list to a single, scalar string. After expansion,
9615 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9616 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9617 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9618 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9619 them. The result of that expansion is assigned to &$value$& before the next
9620 iteration. When the end of the list is reached, the final value of &$value$& is
9621 added to the expansion output. The &*reduce*& expansion item can be used in a
9622 number of ways. For example, to add up a list of numbers:
9623 .code
9624 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9625 .endd
9626 The result of that expansion would be &`6`&. The maximum of a list of numbers
9627 can be found:
9628 .code
9629 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9630 .endd
9631 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9632 restored to what they were before. See also the &*filter*& and &*map*&
9633 expansion items.
9634
9635 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9636 This item inserts &"raw"& header lines. It is described with the &%header%&
9637 expansion item above.
9638
9639 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9640         {*&<&'string2'&>&*}}*&"
9641 .cindex "expansion" "running a command"
9642 .cindex "&%run%& expansion item"
9643 The command and its arguments are first expanded as one string. The string is
9644 split apart into individual arguments by spaces, and then the command is run
9645 in a separate process, but under the same uid and gid.  As in other command
9646 executions from Exim, a shell is not used by default. If the command requires
9647 a shell, you must explicitly code it.
9648
9649 Since the arguments are split by spaces, when there is a variable expansion
9650 which has an empty result, it will cause the situation that the argument will
9651 simply be omitted when the program is actually executed by Exim. If the
9652 script/program requires a specific number of arguments and the expanded
9653 variable could possibly result in this empty expansion, the variable must be
9654 quoted. This is more difficult if the expanded variable itself could result
9655 in a string containing quotes, because it would interfere with the quotes
9656 around the command arguments. A possible guard against this is to wrap the
9657 variable in the &%sg%& operator to change any quote marks to some other
9658 character.
9659
9660 The standard input for the command exists, but is empty. The standard output
9661 and standard error are set to the same file descriptor.
9662 .cindex "return code" "from &%run%& expansion"
9663 .vindex "&$value$&"
9664 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9665 and replaces the entire item; during this expansion, the standard output/error
9666 from the command is in the variable &$value$&. If the command fails,
9667 <&'string2'&>, if present, is expanded and used. Once again, during the
9668 expansion, the standard output/error from the command is in the variable
9669 &$value$&.
9670
9671 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9672 can be the word &"fail"& (not in braces) to force expansion failure if the
9673 command does not succeed. If both strings are omitted, the result is contents
9674 of the standard output/error on success, and nothing on failure.
9675
9676 .vindex "&$run_in_acl$&"
9677 The standard output/error of the command is put in the variable &$value$&.
9678 In this ACL example, the output of a command is logged for the admin to
9679 troubleshoot:
9680 .code
9681 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9682       log_message  = Output of id: $value
9683 .endd
9684 If the command requires shell idioms, such as the > redirect operator, the
9685 shell must be invoked directly, such as with:
9686 .code
9687 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9688 .endd
9689
9690 .vindex "&$runrc$&"
9691 The return code from the command is put in the variable &$runrc$&, and this
9692 remains set afterwards, so in a filter file you can do things like this:
9693 .code
9694 if "${run{x y z}{}}$runrc" is 1 then ...
9695   elif $runrc is 2 then ...
9696   ...
9697 endif
9698 .endd
9699 If execution of the command fails (for example, the command does not exist),
9700 the return code is 127 &-- the same code that shells use for non-existent
9701 commands.
9702
9703 &*Warning*&: In a router or transport, you cannot assume the order in which
9704 option values are expanded, except for those preconditions whose order of
9705 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9706 by the expansion of one option, and use it in another.
9707
9708 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9709 out the use of this expansion item in filter files.
9710
9711
9712 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9713 .cindex "expansion" "string substitution"
9714 .cindex "&%sg%& expansion item"
9715 This item works like Perl's substitution operator (s) with the global (/g)
9716 option; hence its name. However, unlike the Perl equivalent, Exim does not
9717 modify the subject string; instead it returns the modified string for insertion
9718 into the overall expansion. The item takes three arguments: the subject string,
9719 a regular expression, and a substitution string. For example:
9720 .code
9721 ${sg{abcdefabcdef}{abc}{xyz}}
9722 .endd
9723 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9724 if any $ or \ characters are required in the regular expression or in the
9725 substitution string, they have to be escaped. For example:
9726 .code
9727 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9728 .endd
9729 yields &"defabc"&, and
9730 .code
9731 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9732 .endd
9733 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9734 the regular expression from string expansion.
9735
9736
9737
9738 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9739 .cindex sorting "a list"
9740 .cindex list sorting
9741 .cindex expansion "list sorting"
9742 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9743 default, but the separator can be changed in the usual way.
9744 The <&'comparator'&> argument is interpreted as the operator
9745 of a two-argument expansion condition.
9746 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9747 The comparison should return true when applied to two values
9748 if the first value should sort before the second value.
9749 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9750 the element being placed in &$item$&,
9751 to give values for comparison.
9752
9753 The item result is a sorted list,
9754 with the original list separator,
9755 of the list elements (in full) of the original.
9756
9757 Examples:
9758 .code
9759 ${sort{3:2:1:4}{<}{$item}}
9760 .endd
9761 sorts a list of numbers, and
9762 .code
9763 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9764 .endd
9765 will sort an MX lookup into priority order.
9766
9767
9768 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9769 .cindex "&%substr%& expansion item"
9770 .cindex "substring extraction"
9771 .cindex "expansion" "substring extraction"
9772 The three strings are expanded; the first two must yield numbers. Call them
9773 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9774 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9775 can use the simpler operator notation that avoids some of the braces:
9776 .code
9777 ${substr_<n>_<m>:<string>}
9778 .endd
9779 The second number is optional (in both notations).
9780 If it is absent in the simpler format, the preceding underscore must also be
9781 omitted.
9782
9783 The &%substr%& item can be used to extract more general substrings than
9784 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9785 length required. For example
9786 .code
9787 ${substr{3}{2}{$local_part}}
9788 .endd
9789 If the starting offset is greater than the string length the result is the
9790 null string; if the length plus starting offset is greater than the string
9791 length, the result is the right-hand part of the string, starting from the
9792 given offset. The first character in the string has offset zero.
9793
9794 The &%substr%& expansion item can take negative offset values to count
9795 from the right-hand end of its operand. The last character is offset -1, the
9796 second-last is offset -2, and so on. Thus, for example,
9797 .code
9798 ${substr{-5}{2}{1234567}}
9799 .endd
9800 yields &"34"&. If the absolute value of a negative offset is greater than the
9801 length of the string, the substring starts at the beginning of the string, and
9802 the length is reduced by the amount of overshoot. Thus, for example,
9803 .code
9804 ${substr{-5}{2}{12}}
9805 .endd
9806 yields an empty string, but
9807 .code
9808 ${substr{-3}{2}{12}}
9809 .endd
9810 yields &"1"&.
9811
9812 When the second number is omitted from &%substr%&, the remainder of the string
9813 is taken if the offset is positive. If it is negative, all characters in the
9814 string preceding the offset point are taken. For example, an offset of -1 and
9815 no length, as in these semantically identical examples:
9816 .code
9817 ${substr_-1:abcde}
9818 ${substr{-1}{abcde}}
9819 .endd
9820 yields all but the last character of the string, that is, &"abcd"&.
9821
9822
9823
9824 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9825         {*&<&'replacements'&>&*}}*&"
9826 .cindex "expansion" "character translation"
9827 .cindex "&%tr%& expansion item"
9828 This item does single-character translation on its subject string. The second
9829 argument is a list of characters to be translated in the subject string. Each
9830 matching character is replaced by the corresponding character from the
9831 replacement list. For example
9832 .code
9833 ${tr{abcdea}{ac}{13}}
9834 .endd
9835 yields &`1b3de1`&. If there are duplicates in the second character string, the
9836 last occurrence is used. If the third string is shorter than the second, its
9837 last character is replicated. However, if it is empty, no translation takes
9838 place.
9839 .endlist
9840
9841
9842
9843 .section "Expansion operators" "SECTexpop"
9844 .cindex "expansion" "operators"
9845 For expansion items that perform transformations on a single argument string,
9846 the &"operator"& notation is used because it is simpler and uses fewer braces.
9847 The substring is first expanded before the operation is applied to it. The
9848 following operations can be performed:
9849
9850 .vlist
9851 .vitem &*${address:*&<&'string'&>&*}*&
9852 .cindex "expansion" "RFC 2822 address handling"
9853 .cindex "&%address%& expansion item"
9854 The string is interpreted as an RFC 2822 address, as it might appear in a
9855 header line, and the effective address is extracted from it. If the string does
9856 not parse successfully, the result is empty.
9857
9858
9859 .vitem &*${addresses:*&<&'string'&>&*}*&
9860 .cindex "expansion" "RFC 2822 address handling"
9861 .cindex "&%addresses%& expansion item"
9862 The string (after expansion) is interpreted as a list of addresses in RFC
9863 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9864 operative address (&'local-part@domain'&) is extracted from each item, and the
9865 result of the expansion is a colon-separated list, with appropriate
9866 doubling of colons should any happen to be present in the email addresses.
9867 Syntactically invalid RFC2822 address items are omitted from the output.
9868
9869 It is possible to specify a character other than colon for the output
9870 separator by starting the string with > followed by the new separator
9871 character. For example:
9872 .code
9873 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9874 .endd
9875 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9876 expansion item, which extracts the working address from a single RFC2822
9877 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9878 processing lists.
9879
9880 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9881 a strict interpretation of header line formatting.  Exim parses the bare,
9882 unquoted portion of an email address and if it finds a comma, treats it as an
9883 email address seperator. For the example header line:
9884 .code
9885 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9886 .endd
9887 The first example below demonstrates that Q-encoded email addresses are parsed
9888 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9889 It does not see the comma because it's still encoded as "=2C".  The second
9890 example below is passed the contents of &`$header_from:`&, meaning it gets
9891 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9892 The third example shows that the presence of a comma is skipped when it is
9893 quoted.
9894 .code
9895 # exim -be '${addresses:From: \
9896 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9897 user@example.com
9898 # exim -be '${addresses:From: Last, First <user@example.com>}'
9899 Last:user@example.com
9900 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9901 user@example.com
9902 .endd
9903
9904 .vitem &*${base62:*&<&'digits'&>&*}*&
9905 .cindex "&%base62%& expansion item"
9906 .cindex "expansion" "conversion to base 62"
9907 The string must consist entirely of decimal digits. The number is converted to
9908 base 62 and output as a string of six characters, including leading zeros. In
9909 the few operating environments where Exim uses base 36 instead of base 62 for
9910 its message identifiers (because those systems do not have case-sensitive file
9911 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9912 be absolutely clear: this is &'not'& base64 encoding.
9913
9914 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9915 .cindex "&%base62d%& expansion item"
9916 .cindex "expansion" "conversion to base 62"
9917 The string must consist entirely of base-62 digits, or, in operating
9918 environments where Exim uses base 36 instead of base 62 for its message
9919 identifiers, base-36 digits. The number is converted to decimal and output as a
9920 string.
9921
9922
9923 .vitem &*${domain:*&<&'string'&>&*}*&
9924 .cindex "domain" "extraction"
9925 .cindex "expansion" "domain extraction"
9926 The string is interpreted as an RFC 2822 address and the domain is extracted
9927 from it. If the string does not parse successfully, the result is empty.
9928
9929
9930 .vitem &*${escape:*&<&'string'&>&*}*&
9931 .cindex "expansion" "escaping non-printing characters"
9932 .cindex "&%escape%& expansion item"
9933 If the string contains any non-printing characters, they are converted to
9934 escape sequences starting with a backslash. Whether characters with the most
9935 significant bit set (so-called &"8-bit characters"&) count as printing or not
9936 is controlled by the &%print_topbitchars%& option.
9937
9938
9939 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9940 .cindex "expansion" "expression evaluation"
9941 .cindex "expansion" "arithmetic expression"
9942 .cindex "&%eval%& expansion item"
9943 These items supports simple arithmetic and bitwise logical operations in
9944 expansion strings. The string (after expansion) must be a conventional
9945 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9946 logical operators, and parentheses. All operations are carried out using
9947 integer arithmetic. The operator priorities are as follows (the same as in the
9948 C programming language):
9949 .table2 70pt 300pt
9950 .irow &'highest:'& "not (~), negate (-)"
9951 .irow ""   "multiply (*), divide (/), remainder (%)"
9952 .irow ""   "plus (+), minus (-)"
9953 .irow ""   "shift-left (<<), shift-right (>>)"
9954 .irow ""   "and (&&)"
9955 .irow ""   "xor (^)"
9956 .irow &'lowest:'&  "or (|)"
9957 .endtable
9958 Binary operators with the same priority are evaluated from left to right. White
9959 space is permitted before or after operators.
9960
9961 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9962 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9963 decimal, even if they start with a leading zero; hexadecimal numbers are not
9964 permitted. This can be useful when processing numbers extracted from dates or
9965 times, which often do have leading zeros.
9966
9967 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9968 or 1024*1024*1024,
9969 respectively. Negative numbers are supported. The result of the computation is
9970 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9971
9972 .display
9973 &`${eval:1+1}            `&  yields 2
9974 &`${eval:1+2*3}          `&  yields 7
9975 &`${eval:(1+2)*3}        `&  yields 9
9976 &`${eval:2+42%5}         `&  yields 4
9977 &`${eval:0xc&amp;5}          `&  yields 4
9978 &`${eval:0xc|5}          `&  yields 13
9979 &`${eval:0xc^5}          `&  yields 9
9980 &`${eval:0xc>>1}         `&  yields 6
9981 &`${eval:0xc<<1}         `&  yields 24
9982 &`${eval:~255&amp;0x1234}    `&  yields 4608
9983 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9984 .endd
9985
9986 As a more realistic example, in an ACL you might have
9987 .code
9988 deny   message = Too many bad recipients
9989        condition =                    \
9990          ${if and {                   \
9991            {>{$rcpt_count}{10}}       \
9992            {                          \
9993            <                          \
9994              {$recipients_count}      \
9995              {${eval:$rcpt_count/2}}  \
9996            }                          \
9997          }{yes}{no}}
9998 .endd
9999 The condition is true if there have been more than 10 RCPT commands and
10000 fewer than half of them have resulted in a valid recipient.
10001
10002
10003 .vitem &*${expand:*&<&'string'&>&*}*&
10004 .cindex "expansion" "re-expansion of substring"
10005 The &%expand%& operator causes a string to be expanded for a second time. For
10006 example,
10007 .code
10008 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10009 .endd
10010 first looks up a string in a file while expanding the operand for &%expand%&,
10011 and then re-expands what it has found.
10012
10013
10014 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10015 .cindex "Unicode"
10016 .cindex "UTF-8" "conversion from"
10017 .cindex "expansion" "UTF-8 conversion"
10018 .cindex "&%from_utf8%& expansion item"
10019 The world is slowly moving towards Unicode, although there are no standards for
10020 email yet. However, other applications (including some databases) are starting
10021 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10022 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10023 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10024 the result is an undefined sequence of bytes.
10025
10026 Unicode code points with values less than 256 are compatible with ASCII and
10027 ISO-8859-1 (also known as Latin-1).
10028 For example, character 169 is the copyright symbol in both cases, though the
10029 way it is encoded is different. In UTF-8, more than one byte is needed for
10030 characters with code values greater than 127, whereas ISO-8859-1 is a
10031 single-byte encoding (but thereby limited to 256 characters). This makes
10032 translation from UTF-8 to ISO-8859-1 straightforward.
10033
10034
10035 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10036 .cindex "hash function" "textual"
10037 .cindex "expansion" "textual hash"
10038 The &%hash%& operator is a simpler interface to the hashing function that can
10039 be used when the two parameters are fixed numbers (as opposed to strings that
10040 change when expanded). The effect is the same as
10041 .code
10042 ${hash{<n>}{<m>}{<string>}}
10043 .endd
10044 See the description of the general &%hash%& item above for details. The
10045 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10046
10047
10048
10049 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10050 .cindex "base64 encoding" "conversion from hex"
10051 .cindex "expansion" "hex to base64"
10052 .cindex "&%hex2b64%& expansion item"
10053 This operator converts a hex string into one that is base64 encoded. This can
10054 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10055
10056
10057
10058 .vitem &*${hexquote:*&<&'string'&>&*}*&
10059 .cindex "quoting" "hex-encoded unprintable characters"
10060 .cindex "&%hexquote%& expansion item"
10061 This operator converts non-printable characters in a string into a hex
10062 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10063 as is, and other byte values are converted to &`\xNN`&, for example a
10064 byte value 127 is converted to &`\x7f`&.
10065
10066
10067 .vitem &*${lc:*&<&'string'&>&*}*&
10068 .cindex "case forcing in strings"
10069 .cindex "string" "case forcing"
10070 .cindex "lower casing"
10071 .cindex "expansion" "case forcing"
10072 .cindex "&%lc%& expansion item"
10073 This forces the letters in the string into lower-case, for example:
10074 .code
10075 ${lc:$local_part}
10076 .endd
10077
10078 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10079 .cindex "expansion" "string truncation"
10080 .cindex "&%length%& expansion item"
10081 The &%length%& operator is a simpler interface to the &%length%& function that
10082 can be used when the parameter is a fixed number (as opposed to a string that
10083 changes when expanded). The effect is the same as
10084 .code
10085 ${length{<number>}{<string>}}
10086 .endd
10087 See the description of the general &%length%& item above for details. Note that
10088 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10089 when &%length%& is used as an operator.
10090
10091
10092 .vitem &*${listcount:*&<&'string'&>&*}*&
10093 .cindex "expansion" "list item count"
10094 .cindex "list" "item count"
10095 .cindex "list" "count of items"
10096 .cindex "&%listcount%& expansion item"
10097 The string is interpreted as a list and the number of items is returned.
10098
10099
10100 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10101 .cindex "expansion" "named list"
10102 .cindex "&%listnamed%& expansion item"
10103 The name is interpreted as a named list and the content of the list is returned,
10104 expanding any referenced lists, re-quoting as needed for colon-separation.
10105 If the optional type is given it must be one of "a", "d", "h" or "l"
10106 and selects address-, domain-, host- or localpart- lists to search among respectively.
10107 Otherwise all types are searched in an undefined order and the first
10108 matching list is returned.
10109
10110
10111 .vitem &*${local_part:*&<&'string'&>&*}*&
10112 .cindex "expansion" "local part extraction"
10113 .cindex "&%local_part%& expansion item"
10114 The string is interpreted as an RFC 2822 address and the local part is
10115 extracted from it. If the string does not parse successfully, the result is
10116 empty.
10117
10118
10119 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10120 .cindex "masked IP address"
10121 .cindex "IP address" "masking"
10122 .cindex "CIDR notation"
10123 .cindex "expansion" "IP address masking"
10124 .cindex "&%mask%& expansion item"
10125 If the form of the string to be operated on is not an IP address followed by a
10126 slash and an integer (that is, a network address in CIDR notation), the
10127 expansion fails. Otherwise, this operator converts the IP address to binary,
10128 masks off the least significant bits according to the bit count, and converts
10129 the result back to text, with mask appended. For example,
10130 .code
10131 ${mask:10.111.131.206/28}
10132 .endd
10133 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10134 be mostly used for looking up masked addresses in files, the result for an IPv6
10135 address uses dots to separate components instead of colons, because colon
10136 terminates a key string in lsearch files. So, for example,
10137 .code
10138 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10139 .endd
10140 returns the string
10141 .code
10142 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10143 .endd
10144 Letters in IPv6 addresses are always output in lower case.
10145
10146
10147 .vitem &*${md5:*&<&'string'&>&*}*&
10148 .cindex "MD5 hash"
10149 .cindex "expansion" "MD5 hash"
10150 .cindex "certificate fingerprint"
10151 .cindex "&%md5%& expansion item"
10152 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10153 as a 32-digit hexadecimal number, in which any letters are in lower case.
10154
10155
10156 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10157 .cindex "expansion" "numeric hash"
10158 .cindex "hash function" "numeric"
10159 The &%nhash%& operator is a simpler interface to the numeric hashing function
10160 that can be used when the two parameters are fixed numbers (as opposed to
10161 strings that change when expanded). The effect is the same as
10162 .code
10163 ${nhash{<n>}{<m>}{<string>}}
10164 .endd
10165 See the description of the general &%nhash%& item above for details.
10166
10167
10168 .vitem &*${quote:*&<&'string'&>&*}*&
10169 .cindex "quoting" "in string expansions"
10170 .cindex "expansion" "quoting"
10171 .cindex "&%quote%& expansion item"
10172 The &%quote%& operator puts its argument into double quotes if it
10173 is an empty string or
10174 contains anything other than letters, digits, underscores, dots, and hyphens.
10175 Any occurrences of double quotes and backslashes are escaped with a backslash.
10176 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10177 respectively For example,
10178 .code
10179 ${quote:ab"*"cd}
10180 .endd
10181 becomes
10182 .code
10183 "ab\"*\"cd"
10184 .endd
10185 The place where this is useful is when the argument is a substitution from a
10186 variable or a message header.
10187
10188 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10189 .cindex "&%quote_local_part%& expansion item"
10190 This operator is like &%quote%&, except that it quotes the string only if
10191 required to do so by the rules of RFC 2822 for quoting local parts. For
10192 example, a plus sign would not cause quoting (but it would for &%quote%&).
10193 If you are creating a new email address from the contents of &$local_part$&
10194 (or any other unknown data), you should always use this operator.
10195
10196
10197 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10198 .cindex "quoting" "lookup-specific"
10199 This operator applies lookup-specific quoting rules to the string. Each
10200 query-style lookup type has its own quoting rules which are described with
10201 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10202 .code
10203 ${quote_ldap:two * two}
10204 .endd
10205 returns
10206 .code
10207 two%20%5C2A%20two
10208 .endd
10209 For single-key lookup types, no quoting is ever necessary and this operator
10210 yields an unchanged string.
10211
10212
10213 .vitem &*${randint:*&<&'n'&>&*}*&
10214 .cindex "random number"
10215 This operator returns a somewhat random number which is less than the
10216 supplied number and is at least 0.  The quality of this randomness depends
10217 on how Exim was built; the values are not suitable for keying material.
10218 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10219 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10220 for versions of GnuTLS with that function.
10221 Otherwise, the implementation may be arc4random(), random() seeded by
10222 srandomdev() or srandom(), or a custom implementation even weaker than
10223 random().
10224
10225
10226 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10227 .cindex "expansion" "IP address"
10228 This operator reverses an IP address; for IPv4 addresses, the result is in
10229 dotted-quad decimal form, while for IPv6 addreses the result is in
10230 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10231 for DNS.  For example,
10232 .code
10233 ${reverse_ip:192.0.2.4}
10234 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10235 .endd
10236 returns
10237 .code
10238 4.2.0.192
10239 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
10240 .endd
10241
10242
10243 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10244 .cindex "expansion" "RFC 2047"
10245 .cindex "RFC 2047" "expansion operator"
10246 .cindex "&%rfc2047%& expansion item"
10247 This operator encodes text according to the rules of RFC 2047. This is an
10248 encoding that is used in header lines to encode non-ASCII characters. It is
10249 assumed that the input string is in the encoding specified by the
10250 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10251 contains only characters in the range 33&--126, and no instances of the
10252 characters
10253 .code
10254 ? = ( ) < > @ , ; : \ " . [ ] _
10255 .endd
10256 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10257 string, using as many &"encoded words"& as necessary to encode all the
10258 characters.
10259
10260
10261 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10262 .cindex "expansion" "RFC 2047"
10263 .cindex "RFC 2047" "decoding"
10264 .cindex "&%rfc2047d%& expansion item"
10265 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10266 bytes are replaced by question marks. Characters are converted into the
10267 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10268 not recognized unless &%check_rfc2047_length%& is set false.
10269
10270 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10271 access a header line, RFC 2047 decoding is done automatically. You do not need
10272 to use this operator as well.
10273
10274
10275
10276 .vitem &*${rxquote:*&<&'string'&>&*}*&
10277 .cindex "quoting" "in regular expressions"
10278 .cindex "regular expressions" "quoting"
10279 .cindex "&%rxquote%& expansion item"
10280 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10281 characters in its argument. This is useful when substituting the values of
10282 variables or headers inside regular expressions.
10283
10284
10285 .vitem &*${sha1:*&<&'string'&>&*}*&
10286 .cindex "SHA-1 hash"
10287 .cindex "expansion" "SHA-1 hashing"
10288 .cindex "certificate fingerprint"
10289 .cindex "&%sha2%& expansion item"
10290 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10291 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10292
10293
10294 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10295 .cindex "SHA-256 hash"
10296 .cindex "certificate fingerprint"
10297 .cindex "expansion" "SHA-256 hashing"
10298 .cindex "&%sha256%& expansion item"
10299 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10300 certificate,
10301 and returns
10302 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10303 Only arguments which are a single variable of certificate type are supported.
10304
10305
10306 .vitem &*${stat:*&<&'string'&>&*}*&
10307 .cindex "expansion" "statting a file"
10308 .cindex "file" "extracting characteristics"
10309 .cindex "&%stat%& expansion item"
10310 The string, after expansion, must be a file path. A call to the &[stat()]&
10311 function is made for this path. If &[stat()]& fails, an error occurs and the
10312 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10313 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10314 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10315 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10316 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10317 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10318 can extract individual fields using the &%extract%& expansion item.
10319
10320 The use of the &%stat%& expansion in users' filter files can be locked out by
10321 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10322 systems for files larger than 2GB.
10323
10324 .vitem &*${str2b64:*&<&'string'&>&*}*&
10325 .cindex "expansion" "base64 encoding"
10326 .cindex "base64 encoding" "in string expansion"
10327 .cindex "&%str2b64%& expansion item"
10328 This operator converts a string into one that is base64 encoded.
10329
10330
10331
10332 .vitem &*${strlen:*&<&'string'&>&*}*&
10333 .cindex "expansion" "string length"
10334 .cindex "string" "length in expansion"
10335 .cindex "&%strlen%& expansion item"
10336 The item is replace by the length of the expanded string, expressed as a
10337 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10338
10339
10340 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10341 .cindex "&%substr%& expansion item"
10342 .cindex "substring extraction"
10343 .cindex "expansion" "substring expansion"
10344 The &%substr%& operator is a simpler interface to the &%substr%& function that
10345 can be used when the two parameters are fixed numbers (as opposed to strings
10346 that change when expanded). The effect is the same as
10347 .code
10348 ${substr{<start>}{<length>}{<string>}}
10349 .endd
10350 See the description of the general &%substr%& item above for details. The
10351 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10352
10353 .vitem &*${time_eval:*&<&'string'&>&*}*&
10354 .cindex "&%time_eval%& expansion item"
10355 .cindex "time interval" "decoding"
10356 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10357 seconds.
10358
10359 .vitem &*${time_interval:*&<&'string'&>&*}*&
10360 .cindex "&%time_interval%& expansion item"
10361 .cindex "time interval" "formatting"
10362 The argument (after sub-expansion) must be a sequence of decimal digits that
10363 represents an interval of time as a number of seconds. It is converted into a
10364 number of larger units and output in Exim's normal time format, for example,
10365 &`1w3d4h2m6s`&.
10366
10367 .vitem &*${uc:*&<&'string'&>&*}*&
10368 .cindex "case forcing in strings"
10369 .cindex "string" "case forcing"
10370 .cindex "upper casing"
10371 .cindex "expansion" "case forcing"
10372 .cindex "&%uc%& expansion item"
10373 This forces the letters in the string into upper-case.
10374
10375 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10376 .cindex "correction of invalid utf-8 sequences in strings"
10377 .cindex "utf-8" "utf-8 sequences"
10378 .cindex "incorrect utf-8"
10379 .cindex "expansion" "utf-8 forcing"
10380 .cindex "&%utf8clean%& expansion item"
10381 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10382 .endlist
10383
10384
10385
10386
10387
10388
10389 .section "Expansion conditions" "SECTexpcond"
10390 .scindex IIDexpcond "expansion" "conditions"
10391 The following conditions are available for testing by the &%${if%& construct
10392 while expanding strings:
10393
10394 .vlist
10395 .vitem &*!*&<&'condition'&>
10396 .cindex "expansion" "negating a condition"
10397 .cindex "negation" "in expansion condition"
10398 Preceding any condition with an exclamation mark negates the result of the
10399 condition.
10400
10401 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10402 .cindex "numeric comparison"
10403 .cindex "expansion" "numeric comparison"
10404 There are a number of symbolic operators for doing numeric comparisons. They
10405 are:
10406 .display
10407 &`=   `&   equal
10408 &`==  `&   equal
10409 &`>   `&   greater
10410 &`>=  `&   greater or equal
10411 &`<   `&   less
10412 &`<=  `&   less or equal
10413 .endd
10414 For example:
10415 .code
10416 ${if >{$message_size}{10M} ...
10417 .endd
10418 Note that the general negation operator provides for inequality testing. The
10419 two strings must take the form of optionally signed decimal integers,
10420 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10421 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10422 As a special case, the numerical value of an empty string is taken as
10423 zero.
10424
10425 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10426 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10427 10M, not if 10M is larger than &$message_size$&.
10428
10429
10430 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10431         {*&<&'arg2'&>&*}...}*&
10432 .cindex "expansion" "calling an acl"
10433 .cindex "&%acl%&" "expansion condition"
10434 The name and zero to nine argument strings are first expanded separately.  The expanded
10435 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10436 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10437 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10438 and may use the variables; if another acl expansion is used the values
10439 are restored after it returns.  If the ACL sets
10440 a value using a "message =" modifier the variable $value becomes
10441 the result of the expansion, otherwise it is empty.
10442 If the ACL returns accept the condition is true; if deny, false.
10443 If the ACL returns defer the result is a forced-fail.
10444
10445 .vitem &*bool&~{*&<&'string'&>&*}*&
10446 .cindex "expansion" "boolean parsing"
10447 .cindex "&%bool%& expansion condition"
10448 This condition turns a string holding a true or false representation into
10449 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10450 (case-insensitively); also integer numbers map to true if non-zero,
10451 false if zero.
10452 An empty string is treated as false.
10453 Leading and trailing whitespace is ignored;
10454 thus a string consisting only of whitespace is false.
10455 All other string values will result in expansion failure.
10456
10457 When combined with ACL variables, this expansion condition will let you
10458 make decisions in one place and act on those decisions in another place.
10459 For example:
10460 .code
10461 ${if bool{$acl_m_privileged_sender} ...
10462 .endd
10463
10464
10465 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10466 .cindex "expansion" "boolean parsing"
10467 .cindex "&%bool_lax%& expansion condition"
10468 Like &%bool%&, this condition turns a string into a boolean state.  But
10469 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10470 loose definition that the Router &%condition%& option uses.  The empty string
10471 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10472 true.  Leading and trailing whitespace is ignored.
10473
10474 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10475
10476 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10477 .cindex "expansion" "encrypted comparison"
10478 .cindex "encrypted strings, comparing"
10479 .cindex "&%crypteq%& expansion condition"
10480 This condition is included in the Exim binary if it is built to support any
10481 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10482 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10483 included in the binary.
10484
10485 The &%crypteq%& condition has two arguments. The first is encrypted and
10486 compared against the second, which is already encrypted. The second string may
10487 be in the LDAP form for storing encrypted strings, which starts with the
10488 encryption type in curly brackets, followed by the data. If the second string
10489 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10490 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10491 Typically this will be a field from a password file. An example of an encrypted
10492 string in LDAP form is:
10493 .code
10494 {md5}CY9rzUYh03PK3k6DJie09g==
10495 .endd
10496 If such a string appears directly in an expansion, the curly brackets have to
10497 be quoted, because they are part of the expansion syntax. For example:
10498 .code
10499 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10500 .endd
10501 The following encryption types (whose names are matched case-independently) are
10502 supported:
10503
10504 .ilist
10505 .cindex "MD5 hash"
10506 .cindex "base64 encoding" "in encrypted password"
10507 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10508 printable characters to compare with the remainder of the second string. If the
10509 length of the comparison string is 24, Exim assumes that it is base64 encoded
10510 (as in the above example). If the length is 32, Exim assumes that it is a
10511 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10512 comparison fails.
10513
10514 .next
10515 .cindex "SHA-1 hash"
10516 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10517 printable characters to compare with the remainder of the second string. If the
10518 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10519 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10520 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10521
10522 .next
10523 .cindex "&[crypt()]&"
10524 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10525 only the first eight characters of the password. However, in modern operating
10526 systems this is no longer true, and in many cases the entire password is used,
10527 whatever its length.
10528
10529 .next
10530 .cindex "&[crypt16()]&"
10531 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10532 use up to 16 characters of the password in some operating systems. Again, in
10533 modern operating systems, more characters may be used.
10534 .endlist
10535 Exim has its own version of &[crypt16()]&, which is just a double call to
10536 &[crypt()]&. For operating systems that have their own version, setting
10537 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10538 operating system version instead of its own. This option is set by default in
10539 the OS-dependent &_Makefile_& for those operating systems that are known to
10540 support &[crypt16()]&.
10541
10542 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10543 it was not using the same algorithm as some operating systems' versions. It
10544 turns out that as well as &[crypt16()]& there is a function called
10545 &[bigcrypt()]& in some operating systems. This may or may not use the same
10546 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10547
10548 However, since there is now a move away from the traditional &[crypt()]&
10549 functions towards using SHA1 and other algorithms, tidying up this area of
10550 Exim is seen as very low priority.
10551
10552 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10553 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10554 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10555 default is &`{crypt}`&. Whatever the default, you can always use either
10556 function by specifying it explicitly in curly brackets.
10557
10558 .vitem &*def:*&<&'variable&~name'&>
10559 .cindex "expansion" "checking for empty variable"
10560 .cindex "&%def%& expansion condition"
10561 The &%def%& condition must be followed by the name of one of the expansion
10562 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10563 variable does not contain the empty string. For example:
10564 .code
10565 ${if def:sender_ident {from $sender_ident}}
10566 .endd
10567 Note that the variable name is given without a leading &%$%& character. If the
10568 variable does not exist, the expansion fails.
10569
10570 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10571         &~&*def:h_*&<&'header&~name'&>&*:*&"
10572 .cindex "expansion" "checking header line existence"
10573 This condition is true if a message is being processed and the named header
10574 exists in the message. For example,
10575 .code
10576 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10577 .endd
10578 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10579 the header name must be terminated by a colon if white space does not follow.
10580
10581 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10582        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10583 .cindex "string" "comparison"
10584 .cindex "expansion" "string comparison"
10585 .cindex "&%eq%& expansion condition"
10586 .cindex "&%eqi%& expansion condition"
10587 The two substrings are first expanded. The condition is true if the two
10588 resulting strings are identical. For &%eq%& the comparison includes the case of
10589 letters, whereas for &%eqi%& the comparison is case-independent.
10590
10591 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10592 .cindex "expansion" "file existence test"
10593 .cindex "file" "existence test"
10594 .cindex "&%exists%&, expansion condition"
10595 The substring is first expanded and then interpreted as an absolute path. The
10596 condition is true if the named file (or directory) exists. The existence test
10597 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10598 users' filter files may be locked out by the system administrator.
10599
10600 .vitem &*first_delivery*&
10601 .cindex "delivery" "first"
10602 .cindex "first delivery"
10603 .cindex "expansion" "first delivery test"
10604 .cindex "&%first_delivery%& expansion condition"
10605 This condition, which has no data, is true during a message's first delivery
10606 attempt. It is false during any subsequent delivery attempts.
10607
10608
10609 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10610        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10611 .cindex "list" "iterative conditions"
10612 .cindex "expansion" "&*forall*& condition"
10613 .cindex "expansion" "&*forany*& condition"
10614 .vindex "&$item$&"
10615 These conditions iterate over a list. The first argument is expanded to form
10616 the list. By default, the list separator is a colon, but it can be changed by
10617 the normal method. The second argument is interpreted as a condition that is to
10618 be applied to each item in the list in turn. During the interpretation of the
10619 condition, the current list item is placed in a variable called &$item$&.
10620 .ilist
10621 For &*forany*&, interpretation stops if the condition is true for any item, and
10622 the result of the whole condition is true. If the condition is false for all
10623 items in the list, the overall condition is false.
10624 .next
10625 For &*forall*&, interpretation stops if the condition is false for any item,
10626 and the result of the whole condition is false. If the condition is true for
10627 all items in the list, the overall condition is true.
10628 .endlist
10629 Note that negation of &*forany*& means that the condition must be false for all
10630 items for the overall condition to succeed, and negation of &*forall*& means
10631 that the condition must be false for at least one item. In this example, the
10632 list separator is changed to a comma:
10633 .code
10634 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10635 .endd
10636 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10637 being processed, to enable these expansion items to be nested.
10638
10639 To scan a named list, expand it with the &*listnamed*& operator.
10640
10641
10642 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10643        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10644 .cindex "string" "comparison"
10645 .cindex "expansion" "string comparison"
10646 .cindex "&%ge%& expansion condition"
10647 .cindex "&%gei%& expansion condition"
10648 The two substrings are first expanded. The condition is true if the first
10649 string is lexically greater than or equal to the second string. For &%ge%& the
10650 comparison includes the case of letters, whereas for &%gei%& the comparison is
10651 case-independent.
10652
10653 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10654        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10655 .cindex "string" "comparison"
10656 .cindex "expansion" "string comparison"
10657 .cindex "&%gt%& expansion condition"
10658 .cindex "&%gti%& expansion condition"
10659 The two substrings are first expanded. The condition is true if the first
10660 string is lexically greater than the second string. For &%gt%& the comparison
10661 includes the case of letters, whereas for &%gti%& the comparison is
10662 case-independent.
10663
10664 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10665        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10666 .cindex "string" "comparison"
10667 .cindex "list" "iterative conditions"
10668 Both strings are expanded; the second string is treated as a list of simple
10669 strings; if the first string is a member of the second, then the condition
10670 is true.
10671
10672 These are simpler to use versions of the more powerful &*forany*& condition.
10673 Examples, and the &*forany*& equivalents:
10674 .code
10675 ${if inlist{needle}{foo:needle:bar}}
10676   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10677 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10678   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10679 .endd
10680
10681 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10682        &*isip4&~{*&<&'string'&>&*}*& &&&
10683        &*isip6&~{*&<&'string'&>&*}*&
10684 .cindex "IP address" "testing string format"
10685 .cindex "string" "testing for IP address"
10686 .cindex "&%isip%& expansion condition"
10687 .cindex "&%isip4%& expansion condition"
10688 .cindex "&%isip6%& expansion condition"
10689 The substring is first expanded, and then tested to see if it has the form of
10690 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10691 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10692
10693 For an IPv4 address, the test is for four dot-separated components, each of
10694 which consists of from one to three digits. For an IPv6 address, up to eight
10695 colon-separated components are permitted, each containing from one to four
10696 hexadecimal digits. There may be fewer than eight components if an empty
10697 component (adjacent colons) is present. Only one empty component is permitted.
10698
10699 &*Note*&: The checks are just on the form of the address; actual numerical
10700 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10701 check. The main use of these tests is to distinguish between IP addresses and
10702 host names, or between IPv4 and IPv6 addresses. For example, you could use
10703 .code
10704 ${if isip4{$sender_host_address}...
10705 .endd
10706 to test which IP version an incoming SMTP connection is using.
10707
10708 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10709 .cindex "LDAP" "use for authentication"
10710 .cindex "expansion" "LDAP authentication test"
10711 .cindex "&%ldapauth%& expansion condition"
10712 This condition supports user authentication using LDAP. See section
10713 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10714 queries. For this use, the query must contain a user name and password. The
10715 query itself is not used, and can be empty. The condition is true if the
10716 password is not empty, and the user name and password are accepted by the LDAP
10717 server. An empty password is rejected without calling LDAP because LDAP binds
10718 with an empty password are considered anonymous regardless of the username, and
10719 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10720 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10721 this can be used.
10722
10723
10724 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10725        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10726 .cindex "string" "comparison"
10727 .cindex "expansion" "string comparison"
10728 .cindex "&%le%& expansion condition"
10729 .cindex "&%lei%& expansion condition"
10730 The two substrings are first expanded. The condition is true if the first
10731 string is lexically less than or equal to the second string. For &%le%& the
10732 comparison includes the case of letters, whereas for &%lei%& the comparison is
10733 case-independent.
10734
10735 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10736        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10737 .cindex "string" "comparison"
10738 .cindex "expansion" "string comparison"
10739 .cindex "&%lt%& expansion condition"
10740 .cindex "&%lti%& expansion condition"
10741 The two substrings are first expanded. The condition is true if the first
10742 string is lexically less than the second string. For &%lt%& the comparison
10743 includes the case of letters, whereas for &%lti%& the comparison is
10744 case-independent.
10745
10746
10747 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10748 .cindex "expansion" "regular expression comparison"
10749 .cindex "regular expressions" "match in expanded string"
10750 .cindex "&%match%& expansion condition"
10751 The two substrings are first expanded. The second is then treated as a regular
10752 expression and applied to the first. Because of the pre-expansion, if the
10753 regular expression contains dollar, or backslash characters, they must be
10754 escaped. Care must also be taken if the regular expression contains braces
10755 (curly brackets). A closing brace must be escaped so that it is not taken as a
10756 premature termination of <&'string2'&>. The easiest approach is to use the
10757 &`\N`& feature to disable expansion of the regular expression.
10758 For example,
10759 .code
10760 ${if match {$local_part}{\N^\d{3}\N} ...
10761 .endd
10762 If the whole expansion string is in double quotes, further escaping of
10763 backslashes is also required.
10764
10765 The condition is true if the regular expression match succeeds.
10766 The regular expression is not required to begin with a circumflex
10767 metacharacter, but if there is no circumflex, the expression is not anchored,
10768 and it may match anywhere in the subject, not just at the start. If you want
10769 the pattern to match at the end of the subject, you must include the &`$`&
10770 metacharacter at an appropriate point.
10771
10772 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10773 At the start of an &%if%& expansion the values of the numeric variable
10774 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10775 succeeds causes them to be reset to the substrings of that condition and they
10776 will have these values during the expansion of the success string. At the end
10777 of the &%if%& expansion, the previous values are restored. After testing a
10778 combination of conditions using &%or%&, the subsequent values of the numeric
10779 variables are those of the condition that succeeded.
10780
10781 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10782 .cindex "&%match_address%& expansion condition"
10783 See &*match_local_part*&.
10784
10785 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10786 .cindex "&%match_domain%& expansion condition"
10787 See &*match_local_part*&.
10788
10789 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10790 .cindex "&%match_ip%& expansion condition"
10791 This condition matches an IP address to a list of IP address patterns. It must
10792 be followed by two argument strings. The first (after expansion) must be an IP
10793 address or an empty string. The second (not expanded) is a restricted host
10794 list that can match only an IP address, not a host name. For example:
10795 .code
10796 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10797 .endd
10798 The specific types of host list item that are permitted in the list are:
10799
10800 .ilist
10801 An IP address, optionally with a CIDR mask.
10802 .next
10803 A single asterisk, which matches any IP address.
10804 .next
10805 An empty item, which matches only if the IP address is empty. This could be
10806 useful for testing for a locally submitted message or one from specific hosts
10807 in a single test such as
10808 . ==== As this is a nested list, any displays it contains must be indented
10809 . ==== as otherwise they are too far to the left. This comment applies to
10810 . ==== the use of xmlto plus fop. There's no problem when formatting with
10811 . ==== sdop, with or without the extra indent.
10812 .code
10813   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10814 .endd
10815 where the first item in the list is the empty string.
10816 .next
10817 The item @[] matches any of the local host's interface addresses.
10818 .next
10819 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10820 even if &`net-`& is not specified. There is never any attempt to turn the IP
10821 address into a host name. The most common type of linear search for
10822 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10823 masks. For example:
10824 .code
10825   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10826 .endd
10827 It is of course possible to use other kinds of lookup, and in such a case, you
10828 do need to specify the &`net-`& prefix if you want to specify a specific
10829 address mask, for example:
10830 .code
10831   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10832 .endd
10833 However, unless you are combining a &%match_ip%& condition with others, it is
10834 just as easy to use the fact that a lookup is itself a condition, and write:
10835 .code
10836   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10837 .endd
10838 .endlist ilist
10839
10840 Note that <&'string2'&> is not itself subject to string expansion, unless
10841 Exim was built with the EXPAND_LISTMATCH_RHS option.
10842
10843 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10844
10845 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10846 .cindex "domain list" "in expansion condition"
10847 .cindex "address list" "in expansion condition"
10848 .cindex "local part" "list, in expansion condition"
10849 .cindex "&%match_local_part%& expansion condition"
10850 This condition, together with &%match_address%& and &%match_domain%&, make it
10851 possible to test domain, address, and local part lists within expansions. Each
10852 condition requires two arguments: an item and a list to match. A trivial
10853 example is:
10854 .code
10855 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10856 .endd
10857 In each case, the second argument may contain any of the allowable items for a
10858 list of the appropriate type. Also, because the second argument (after
10859 expansion) is a standard form of list, it is possible to refer to a named list.
10860 Thus, you can use conditions like this:
10861 .code
10862 ${if match_domain{$domain}{+local_domains}{...
10863 .endd
10864 .cindex "&`+caseful`&"
10865 For address lists, the matching starts off caselessly, but the &`+caseful`&
10866 item can be used, as in all address lists, to cause subsequent items to
10867 have their local parts matched casefully. Domains are always matched
10868 caselessly.
10869
10870 Note that <&'string2'&> is not itself subject to string expansion, unless
10871 Exim was built with the EXPAND_LISTMATCH_RHS option.
10872
10873 &*Note*&: Host lists are &'not'& supported in this way. This is because
10874 hosts have two identities: a name and an IP address, and it is not clear
10875 how to specify cleanly how such a test would work. However, IP addresses can be
10876 matched using &%match_ip%&.
10877
10878 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10879 .cindex "PAM authentication"
10880 .cindex "AUTH" "with PAM"
10881 .cindex "Solaris" "PAM support"
10882 .cindex "expansion" "PAM authentication test"
10883 .cindex "&%pam%& expansion condition"
10884 &'Pluggable Authentication Modules'&
10885 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10886 available in the latest releases of Solaris and in some GNU/Linux
10887 distributions. The Exim support, which is intended for use in conjunction with
10888 the SMTP AUTH command, is available only if Exim is compiled with
10889 .code
10890 SUPPORT_PAM=yes
10891 .endd
10892 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10893 in some releases of GNU/Linux &%-ldl%& is also needed.
10894
10895 The argument string is first expanded, and the result must be a
10896 colon-separated list of strings. Leading and trailing white space is ignored.
10897 The PAM module is initialized with the service name &"exim"& and the user name
10898 taken from the first item in the colon-separated data string (<&'string1'&>).
10899 The remaining items in the data string are passed over in response to requests
10900 from the authentication function. In the simple case there will only be one
10901 request, for a password, so the data consists of just two strings.
10902
10903 There can be problems if any of the strings are permitted to contain colon
10904 characters. In the usual way, these have to be doubled to avoid being taken as
10905 separators. If the data is being inserted from a variable, the &%sg%& expansion
10906 item can be used to double any existing colons. For example, the configuration
10907 of a LOGIN authenticator might contain this setting:
10908 .code
10909 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10910 .endd
10911 For a PLAIN authenticator you could use:
10912 .code
10913 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10914 .endd
10915 In some operating systems, PAM authentication can be done only from a process
10916 running as root. Since Exim is running as the Exim user when receiving
10917 messages, this means that PAM cannot be used directly in those systems.
10918 A patched version of the &'pam_unix'& module that comes with the
10919 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10920 The patched module allows one special uid/gid combination, in addition to root,
10921 to authenticate. If you build the patched module to allow the Exim user and
10922 group, PAM can then be used from an Exim authenticator.
10923
10924
10925 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10926 .cindex "&'pwcheck'& daemon"
10927 .cindex "Cyrus"
10928 .cindex "expansion" "&'pwcheck'& authentication test"
10929 .cindex "&%pwcheck%& expansion condition"
10930 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10931 This is one way of making it possible for passwords to be checked by a process
10932 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10933 deprecated. Its replacement is &'saslauthd'& (see below).
10934
10935 The pwcheck support is not included in Exim by default. You need to specify
10936 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10937 building Exim. For example:
10938 .code
10939 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10940 .endd
10941 You do not need to install the full Cyrus software suite in order to use
10942 the pwcheck daemon. You can compile and install just the daemon alone
10943 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10944 access to the &_/var/pwcheck_& directory.
10945
10946 The &%pwcheck%& condition takes one argument, which must be the user name and
10947 password, separated by a colon. For example, in a LOGIN authenticator
10948 configuration, you might have this:
10949 .code
10950 server_condition = ${if pwcheck{$auth1:$auth2}}
10951 .endd
10952 Again, for a PLAIN authenticator configuration, this would be:
10953 .code
10954 server_condition = ${if pwcheck{$auth2:$auth3}}
10955 .endd
10956 .vitem &*queue_running*&
10957 .cindex "queue runner" "detecting when delivering from"
10958 .cindex "expansion" "queue runner test"
10959 .cindex "&%queue_running%& expansion condition"
10960 This condition, which has no data, is true during delivery attempts that are
10961 initiated by queue runner processes, and false otherwise.
10962
10963
10964 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10965 .cindex "Radius"
10966 .cindex "expansion" "Radius authentication"
10967 .cindex "&%radius%& expansion condition"
10968 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10969 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10970 the Radius client configuration file in order to build Exim with Radius
10971 support.
10972
10973 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10974 library, using the original API. If you are using release 0.4.0 or later of
10975 this library, you need to set
10976 .code
10977 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10978 .endd
10979 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10980 &%libradius%& library that comes with FreeBSD. To do this, set
10981 .code
10982 RADIUS_LIB_TYPE=RADLIB
10983 .endd
10984 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10985 You may also have to supply a suitable setting in EXTRALIBS so that the
10986 Radius library can be found when Exim is linked.
10987
10988 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10989 Radius client library, which calls the Radius server. The condition is true if
10990 the authentication is successful. For example:
10991 .code
10992 server_condition = ${if radius{<arguments>}}
10993 .endd
10994
10995
10996 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10997         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10998 .cindex "&'saslauthd'& daemon"
10999 .cindex "Cyrus"
11000 .cindex "expansion" "&'saslauthd'& authentication test"
11001 .cindex "&%saslauthd%& expansion condition"
11002 This condition supports user authentication using the Cyrus &'saslauthd'&
11003 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11004 Using this daemon is one way of making it possible for passwords to be checked
11005 by a process that is not running as root.
11006
11007 The saslauthd support is not included in Exim by default. You need to specify
11008 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11009 building Exim. For example:
11010 .code
11011 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11012 .endd
11013 You do not need to install the full Cyrus software suite in order to use
11014 the saslauthd daemon. You can compile and install just the daemon alone
11015 from the Cyrus SASL library.
11016
11017 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11018 two are mandatory. For example:
11019 .code
11020 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11021 .endd
11022 The service and the realm are optional (which is why the arguments are enclosed
11023 in their own set of braces). For details of the meaning of the service and
11024 realm, and how to run the daemon, consult the Cyrus documentation.
11025 .endlist vlist
11026
11027
11028
11029 .section "Combining expansion conditions" "SECID84"
11030 .cindex "expansion" "combining conditions"
11031 Several conditions can be tested at once by combining them using the &%and%&
11032 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11033 conditions on their own, and precede their lists of sub-conditions. Each
11034 sub-condition must be enclosed in braces within the overall braces that contain
11035 the list. No repetition of &%if%& is used.
11036
11037
11038 .vlist
11039 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11040 .cindex "&""or""& expansion condition"
11041 .cindex "expansion" "&""or""& of conditions"
11042 The sub-conditions are evaluated from left to right. The condition is true if
11043 any one of the sub-conditions is true.
11044 For example,
11045 .code
11046 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11047 .endd
11048 When a true sub-condition is found, the following ones are parsed but not
11049 evaluated. If there are several &"match"& sub-conditions the values of the
11050 numeric variables afterwards are taken from the first one that succeeds.
11051
11052 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11053 .cindex "&""and""& expansion condition"
11054 .cindex "expansion" "&""and""& of conditions"
11055 The sub-conditions are evaluated from left to right. The condition is true if
11056 all of the sub-conditions are true. If there are several &"match"&
11057 sub-conditions, the values of the numeric variables afterwards are taken from
11058 the last one. When a false sub-condition is found, the following ones are
11059 parsed but not evaluated.
11060 .endlist
11061 .ecindex IIDexpcond
11062
11063
11064
11065
11066 .section "Expansion variables" "SECTexpvar"
11067 .cindex "expansion" "variables, list of"
11068 This section contains an alphabetical list of all the expansion variables. Some
11069 of them are available only when Exim is compiled with specific options such as
11070 support for TLS or the content scanning extension.
11071
11072 .vlist
11073 .vitem "&$0$&, &$1$&, etc"
11074 .cindex "numerical variables (&$1$& &$2$& etc)"
11075 When a &%match%& expansion condition succeeds, these variables contain the
11076 captured substrings identified by the regular expression during subsequent
11077 processing of the success string of the containing &%if%& expansion item.
11078 However, they do not retain their values afterwards; in fact, their previous
11079 values are restored at the end of processing an &%if%& item. The numerical
11080 variables may also be set externally by some other matching process which
11081 precedes the expansion of the string. For example, the commands available in
11082 Exim filter files include an &%if%& command with its own regular expression
11083 matching condition.
11084
11085 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11086 Within an acl condition, expansion condition or expansion item
11087 any arguments are copied to these variables,
11088 any unused variables being made empty.
11089
11090 .vitem "&$acl_c...$&"
11091 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11092 can be given any name that starts with &$acl_c$& and is at least six characters
11093 long, but the sixth character must be either a digit or an underscore. For
11094 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11095 variables persist throughout the lifetime of an SMTP connection. They can be
11096 used to pass information between ACLs and between different invocations of the
11097 same ACL. When a message is received, the values of these variables are saved
11098 with the message, and can be accessed by filters, routers, and transports
11099 during subsequent delivery.
11100
11101 .vitem "&$acl_m...$&"
11102 These variables are like the &$acl_c...$& variables, except that their values
11103 are reset after a message has been received. Thus, if several messages are
11104 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11105 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11106 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11107 message is received, the values of these variables are saved with the message,
11108 and can be accessed by filters, routers, and transports during subsequent
11109 delivery.
11110
11111 .vitem &$acl_narg$&
11112 Within an acl condition, expansion condition or expansion item
11113 this variable has the number of arguments.
11114
11115 .vitem &$acl_verify_message$&
11116 .vindex "&$acl_verify_message$&"
11117 After an address verification has failed, this variable contains the failure
11118 message. It retains its value for use in subsequent modifiers. The message can
11119 be preserved by coding like this:
11120 .code
11121 warn !verify = sender
11122      set acl_m0 = $acl_verify_message
11123 .endd
11124 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11125 &%log_message%& modifiers, to include information about the verification
11126 failure.
11127
11128 .vitem &$address_data$&
11129 .vindex "&$address_data$&"
11130 This variable is set by means of the &%address_data%& option in routers. The
11131 value then remains with the address while it is processed by subsequent routers
11132 and eventually a transport. If the transport is handling multiple addresses,
11133 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11134 for more details. &*Note*&: The contents of &$address_data$& are visible in
11135 user filter files.
11136
11137 If &$address_data$& is set when the routers are called from an ACL to verify
11138 a recipient address, the final value is still in the variable for subsequent
11139 conditions and modifiers of the ACL statement. If routing the address caused it
11140 to be redirected to just one address, the child address is also routed as part
11141 of the verification, and in this case the final value of &$address_data$& is
11142 from the child's routing.
11143
11144 If &$address_data$& is set when the routers are called from an ACL to verify a
11145 sender address, the final value is also preserved, but this time in
11146 &$sender_address_data$&, to distinguish it from data from a recipient
11147 address.
11148
11149 In both cases (recipient and sender verification), the value does not persist
11150 after the end of the current ACL statement. If you want to preserve
11151 these values for longer, you can save them in ACL variables.
11152
11153 .vitem &$address_file$&
11154 .vindex "&$address_file$&"
11155 When, as a result of aliasing, forwarding, or filtering, a message is directed
11156 to a specific file, this variable holds the name of the file when the transport
11157 is running. At other times, the variable is empty. For example, using the
11158 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11159 .code
11160 /home/r2d2/savemail
11161 .endd
11162 then when the &(address_file)& transport is running, &$address_file$&
11163 contains the text string &`/home/r2d2/savemail`&.
11164 .cindex "Sieve filter" "value of &$address_file$&"
11165 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11166 then up to the transport configuration to generate an appropriate absolute path
11167 to the relevant file.
11168
11169 .vitem &$address_pipe$&
11170 .vindex "&$address_pipe$&"
11171 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11172 this variable holds the pipe command when the transport is running.
11173
11174 .vitem "&$auth1$& &-- &$auth3$&"
11175 .vindex "&$auth1$&, &$auth2$&, etc"
11176 These variables are used in SMTP authenticators (see chapters
11177 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11178
11179 .vitem &$authenticated_id$&
11180 .cindex "authentication" "id"
11181 .vindex "&$authenticated_id$&"
11182 When a server successfully authenticates a client it may be configured to
11183 preserve some of the authentication information in the variable
11184 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11185 user/password authenticator configuration might preserve the user name for use
11186 in the routers. Note that this is not the same information that is saved in
11187 &$sender_host_authenticated$&.
11188 When a message is submitted locally (that is, not over a TCP connection)
11189 the value of &$authenticated_id$& is normally the login name of the calling
11190 process. However, a trusted user can override this by means of the &%-oMai%&
11191 command line option.
11192
11193 .vitem &$authenticated_fail_id$&
11194 .cindex "authentication" "fail" "id"
11195 .vindex "&$authenticated_fail_id$&"
11196 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11197 will contain the failed authentication id. If more than one authentication
11198 id is attempted, it will contain only the last one. The variable is
11199 available for processing in the ACL's, generally the quit or notquit ACL.
11200 A message to a local recipient could still be accepted without requiring
11201 authentication, which means this variable could also be visible in all of
11202 the ACL's as well.
11203
11204
11205 .vitem &$authenticated_sender$&
11206 .cindex "sender" "authenticated"
11207 .cindex "authentication" "sender"
11208 .cindex "AUTH" "on MAIL command"
11209 .vindex "&$authenticated_sender$&"
11210 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11211 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11212 described in section &<<SECTauthparamail>>&. Unless the data is the string
11213 &"<>"&, it is set as the authenticated sender of the message, and the value is
11214 available during delivery in the &$authenticated_sender$& variable. If the
11215 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11216
11217 .vindex "&$qualify_domain$&"
11218 When a message is submitted locally (that is, not over a TCP connection), the
11219 value of &$authenticated_sender$& is an address constructed from the login
11220 name of the calling process and &$qualify_domain$&, except that a trusted user
11221 can override this by means of the &%-oMas%& command line option.
11222
11223
11224 .vitem &$authentication_failed$&
11225 .cindex "authentication" "failure"
11226 .vindex "&$authentication_failed$&"
11227 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11228 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11229 possible to distinguish between &"did not try to authenticate"&
11230 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11231 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11232 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11233 negative response to an AUTH command, including (for example) an attempt to use
11234 an undefined mechanism.
11235
11236 .vitem &$av_failed$&
11237 .cindex "content scanning" "AV scanner failure"
11238 This variable is available when Exim is compiled with the content-scanning
11239 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11240 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11241 the ACL malware condition.
11242
11243 .vitem &$body_linecount$&
11244 .cindex "message body" "line count"
11245 .cindex "body of message" "line count"
11246 .vindex "&$body_linecount$&"
11247 When a message is being received or delivered, this variable contains the
11248 number of lines in the message's body. See also &$message_linecount$&.
11249
11250 .vitem &$body_zerocount$&
11251 .cindex "message body" "binary zero count"
11252 .cindex "body of message" "binary zero count"
11253 .cindex "binary zero" "in message body"
11254 .vindex "&$body_zerocount$&"
11255 When a message is being received or delivered, this variable contains the
11256 number of binary zero bytes (ASCII NULs) in the message's body.
11257
11258 .vitem &$bounce_recipient$&
11259 .vindex "&$bounce_recipient$&"
11260 This is set to the recipient address of a bounce message while Exim is creating
11261 it. It is useful if a customized bounce message text file is in use (see
11262 chapter &<<CHAPemsgcust>>&).
11263
11264 .vitem &$bounce_return_size_limit$&
11265 .vindex "&$bounce_return_size_limit$&"
11266 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11267 up to a multiple of 1000. It is useful when a customized error message text
11268 file is in use (see chapter &<<CHAPemsgcust>>&).
11269
11270 .vitem &$caller_gid$&
11271 .cindex "gid (group id)" "caller"
11272 .vindex "&$caller_gid$&"
11273 The real group id under which the process that called Exim was running. This is
11274 not the same as the group id of the originator of a message (see
11275 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11276 incarnation normally contains the Exim gid.
11277
11278 .vitem &$caller_uid$&
11279 .cindex "uid (user id)" "caller"
11280 .vindex "&$caller_uid$&"
11281 The real user id under which the process that called Exim was running. This is
11282 not the same as the user id of the originator of a message (see
11283 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11284 incarnation normally contains the Exim uid.
11285
11286 .vitem &$compile_date$&
11287 .vindex "&$compile_date$&"
11288 The date on which the Exim binary was compiled.
11289
11290 .vitem &$compile_number$&
11291 .vindex "&$compile_number$&"
11292 The building process for Exim keeps a count of the number
11293 of times it has been compiled. This serves to distinguish different
11294 compilations of the same version of the program.
11295
11296 .new
11297 .vitem &$config_dir$&
11298 .vindex "&$config_dir$&"
11299 The directory name of the main configuration file. That is, the content of
11300 &$config_file$& with the last component stripped. The value does not
11301 contain the trailing slash. If &$config_file$& does not contain a slash,
11302 &$config_dir$& is ".".
11303
11304 .vitem &$config_file$&
11305 .vindex "&$config_file$&"
11306 The name of the main configuration file Exim is using.
11307 .wen
11308
11309 .vitem &$demime_errorlevel$&
11310 .vindex "&$demime_errorlevel$&"
11311 This variable is available when Exim is compiled with
11312 the content-scanning extension and the obsolete &%demime%& condition. For
11313 details, see section &<<SECTdemimecond>>&.
11314
11315 .vitem &$demime_reason$&
11316 .vindex "&$demime_reason$&"
11317 This variable is available when Exim is compiled with the
11318 content-scanning extension and the obsolete &%demime%& condition. For details,
11319 see section &<<SECTdemimecond>>&.
11320
11321 .vitem &$dnslist_domain$& &&&
11322        &$dnslist_matched$& &&&
11323        &$dnslist_text$& &&&
11324        &$dnslist_value$&
11325 .vindex "&$dnslist_domain$&"
11326 .vindex "&$dnslist_matched$&"
11327 .vindex "&$dnslist_text$&"
11328 .vindex "&$dnslist_value$&"
11329 .cindex "black list (DNS)"
11330 When a DNS (black) list lookup succeeds, these variables are set to contain
11331 the following data from the lookup: the list's domain name, the key that was
11332 looked up, the contents of any associated TXT record, and the value from the
11333 main A record. See section &<<SECID204>>& for more details.
11334
11335 .vitem &$domain$&
11336 .vindex "&$domain$&"
11337 When an address is being routed, or delivered on its own, this variable
11338 contains the domain. Uppercase letters in the domain are converted into lower
11339 case for &$domain$&.
11340
11341 Global address rewriting happens when a message is received, so the value of
11342 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11343 is set during user filtering, but not during system filtering, because a
11344 message may have many recipients and the system filter is called just once.
11345
11346 When more than one address is being delivered at once (for example, several
11347 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11348 have the same domain. Transports can be restricted to handling only one domain
11349 at a time if the value of &$domain$& is required at transport time &-- this is
11350 the default for local transports. For further details of the environment in
11351 which local transports are run, see chapter &<<CHAPenvironment>>&.
11352
11353 .oindex "&%delay_warning_condition%&"
11354 At the end of a delivery, if all deferred addresses have the same domain, it is
11355 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11356
11357 The &$domain$& variable is also used in some other circumstances:
11358
11359 .ilist
11360 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11361 the recipient address. The domain of the &'sender'& address is in
11362 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11363 normally set during the running of the MAIL ACL. However, if the sender address
11364 is verified with a callout during the MAIL ACL, the sender domain is placed in
11365 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11366 the &(smtp)& transport.
11367
11368 .next
11369 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11370 &$domain$& contains the domain portion of the address that is being rewritten;
11371 it can be used in the expansion of the replacement address, for example, to
11372 rewrite domains by file lookup.
11373
11374 .next
11375 With one important exception, whenever a domain list is being scanned,
11376 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11377 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11378 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11379 that, in a RCPT ACL, the sender domain list can be dependent on the
11380 recipient domain (which is what is in &$domain$& at this time).
11381
11382 .next
11383 .cindex "ETRN" "value of &$domain$&"
11384 .oindex "&%smtp_etrn_command%&"
11385 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11386 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11387 .endlist
11388
11389
11390 .vitem &$domain_data$&
11391 .vindex "&$domain_data$&"
11392 When the &%domains%& option on a router matches a domain by
11393 means of a lookup, the data read by the lookup is available during the running
11394 of the router as &$domain_data$&. In addition, if the driver routes the
11395 address to a transport, the value is available in that transport. If the
11396 transport is handling multiple addresses, the value from the first address is
11397 used.
11398
11399 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11400 domain by means of a lookup. The data read by the lookup is available during
11401 the rest of the ACL statement. In all other situations, this variable expands
11402 to nothing.
11403
11404 .vitem &$exim_gid$&
11405 .vindex "&$exim_gid$&"
11406 This variable contains the numerical value of the Exim group id.
11407
11408 .vitem &$exim_path$&
11409 .vindex "&$exim_path$&"
11410 This variable contains the path to the Exim binary.
11411
11412 .vitem &$exim_uid$&
11413 .vindex "&$exim_uid$&"
11414 This variable contains the numerical value of the Exim user id.
11415
11416 .new
11417 .vitem &$exim_version$&
11418 .vindex "&$exim_uid$&"
11419 This variable contains the version string of the Exim build.
11420 The first character is a major version number, currently 4.
11421 Then after a dot, the next group of digits is a minor version number.
11422 There may be other characters following the minor version.
11423 .wen
11424
11425 .vitem &$found_extension$&
11426 .vindex "&$found_extension$&"
11427 This variable is available when Exim is compiled with the
11428 content-scanning extension and the obsolete &%demime%& condition. For details,
11429 see section &<<SECTdemimecond>>&.
11430
11431 .vitem &$header_$&<&'name'&>
11432 This is not strictly an expansion variable. It is expansion syntax for
11433 inserting the message header line with the given name. Note that the name must
11434 be terminated by colon or white space, because it may contain a wide variety of
11435 characters. Note also that braces must &'not'& be used.
11436
11437 .vitem &$headers_added$&
11438 .vindex "&$headers_added$&"
11439 Within an ACL this variable contains the headers added so far by
11440 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11441 The headers are a newline-separated list.
11442
11443 .vitem &$home$&
11444 .vindex "&$home$&"
11445 When the &%check_local_user%& option is set for a router, the user's home
11446 directory is placed in &$home$& when the check succeeds. In particular, this
11447 means it is set during the running of users' filter files. A router may also
11448 explicitly set a home directory for use by a transport; this can be overridden
11449 by a setting on the transport itself.
11450
11451 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11452 of the environment variable HOME.
11453
11454 .vitem &$host$&
11455 .vindex "&$host$&"
11456 If a router assigns an address to a transport (any transport), and passes a
11457 list of hosts with the address, the value of &$host$& when the transport starts
11458 to run is the name of the first host on the list. Note that this applies both
11459 to local and remote transports.
11460
11461 .cindex "transport" "filter"
11462 .cindex "filter" "transport filter"
11463 For the &(smtp)& transport, if there is more than one host, the value of
11464 &$host$& changes as the transport works its way through the list. In
11465 particular, when the &(smtp)& transport is expanding its options for encryption
11466 using TLS, or for specifying a transport filter (see chapter
11467 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11468 is connected.
11469
11470 When used in the client part of an authenticator configuration (see chapter
11471 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11472 client is connected.
11473
11474
11475 .vitem &$host_address$&
11476 .vindex "&$host_address$&"
11477 This variable is set to the remote host's IP address whenever &$host$& is set
11478 for a remote connection. It is also set to the IP address that is being checked
11479 when the &%ignore_target_hosts%& option is being processed.
11480
11481 .vitem &$host_data$&
11482 .vindex "&$host_data$&"
11483 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11484 result of the lookup is made available in the &$host_data$& variable. This
11485 allows you, for example, to do things like this:
11486 .code
11487 deny  hosts = net-lsearch;/some/file
11488 message = $host_data
11489 .endd
11490 .vitem &$host_lookup_deferred$&
11491 .cindex "host name" "lookup, failure of"
11492 .vindex "&$host_lookup_deferred$&"
11493 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11494 message comes from a remote host and there is an attempt to look up the host's
11495 name from its IP address, and the attempt is not successful, one of these
11496 variables is set to &"1"&.
11497
11498 .ilist
11499 If the lookup receives a definite negative response (for example, a DNS lookup
11500 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11501
11502 .next
11503 If there is any kind of problem during the lookup, such that Exim cannot
11504 tell whether or not the host name is defined (for example, a timeout for a DNS
11505 lookup), &$host_lookup_deferred$& is set to &"1"&.
11506 .endlist ilist
11507
11508 Looking up a host's name from its IP address consists of more than just a
11509 single reverse lookup. Exim checks that a forward lookup of at least one of the
11510 names it receives from a reverse lookup yields the original IP address. If this
11511 is not the case, Exim does not accept the looked up name(s), and
11512 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11513 IP address (for example, the existence of a PTR record in the DNS) is not
11514 sufficient on its own for the success of a host name lookup. If the reverse
11515 lookup succeeds, but there is a lookup problem such as a timeout when checking
11516 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11517 &"1"&. See also &$sender_host_name$&.
11518
11519 .vitem &$host_lookup_failed$&
11520 .vindex "&$host_lookup_failed$&"
11521 See &$host_lookup_deferred$&.
11522
11523 .vitem &$host_port$&
11524 .vindex "&$host_port$&"
11525 This variable is set to the remote host's TCP port whenever &$host$& is set
11526 for an outbound connection.
11527
11528
11529 .vitem &$inode$&
11530 .vindex "&$inode$&"
11531 The only time this variable is set is while expanding the &%directory_file%&
11532 option in the &(appendfile)& transport. The variable contains the inode number
11533 of the temporary file which is about to be renamed. It can be used to construct
11534 a unique name for the file.
11535
11536 .vitem &$interface_address$&
11537 .vindex "&$interface_address$&"
11538 This is an obsolete name for &$received_ip_address$&.
11539
11540 .vitem &$interface_port$&
11541 .vindex "&$interface_port$&"
11542 This is an obsolete name for &$received_port$&.
11543
11544 .vitem &$item$&
11545 .vindex "&$item$&"
11546 This variable is used during the expansion of &*forall*& and &*forany*&
11547 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11548 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11549 empty.
11550
11551 .vitem &$ldap_dn$&
11552 .vindex "&$ldap_dn$&"
11553 This variable, which is available only when Exim is compiled with LDAP support,
11554 contains the DN from the last entry in the most recently successful LDAP
11555 lookup.
11556
11557 .vitem &$load_average$&
11558 .vindex "&$load_average$&"
11559 This variable contains the system load average, multiplied by 1000 so that it
11560 is an integer. For example, if the load average is 0.21, the value of the
11561 variable is 210. The value is recomputed every time the variable is referenced.
11562
11563 .vitem &$local_part$&
11564 .vindex "&$local_part$&"
11565 When an address is being routed, or delivered on its own, this
11566 variable contains the local part. When a number of addresses are being
11567 delivered together (for example, multiple RCPT commands in an SMTP
11568 session), &$local_part$& is not set.
11569
11570 Global address rewriting happens when a message is received, so the value of
11571 &$local_part$& during routing and delivery is the value after rewriting.
11572 &$local_part$& is set during user filtering, but not during system filtering,
11573 because a message may have many recipients and the system filter is called just
11574 once.
11575
11576 .vindex "&$local_part_prefix$&"
11577 .vindex "&$local_part_suffix$&"
11578 If a local part prefix or suffix has been recognized, it is not included in the
11579 value of &$local_part$& during routing and subsequent delivery. The values of
11580 any prefix or suffix are in &$local_part_prefix$& and
11581 &$local_part_suffix$&, respectively.
11582
11583 When a message is being delivered to a file, pipe, or autoreply transport as a
11584 result of aliasing or forwarding, &$local_part$& is set to the local part of
11585 the parent address, not to the file name or command (see &$address_file$& and
11586 &$address_pipe$&).
11587
11588 When an ACL is running for a RCPT command, &$local_part$& contains the
11589 local part of the recipient address.
11590
11591 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11592 &$local_part$& contains the local part of the address that is being rewritten;
11593 it can be used in the expansion of the replacement address, for example.
11594
11595 In all cases, all quoting is removed from the local part. For example, for both
11596 the addresses
11597 .code
11598 "abc:xyz"@test.example
11599 abc\:xyz@test.example
11600 .endd
11601 the value of &$local_part$& is
11602 .code
11603 abc:xyz
11604 .endd
11605 If you use &$local_part$& to create another address, you should always wrap it
11606 inside a quoting operator. For example, in a &(redirect)& router you could
11607 have:
11608 .code
11609 data = ${quote_local_part:$local_part}@new.domain.example
11610 .endd
11611 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11612 to process local parts in a case-dependent manner in a router, you can set the
11613 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11614
11615 .vitem &$local_part_data$&
11616 .vindex "&$local_part_data$&"
11617 When the &%local_parts%& option on a router matches a local part by means of a
11618 lookup, the data read by the lookup is available during the running of the
11619 router as &$local_part_data$&. In addition, if the driver routes the address
11620 to a transport, the value is available in that transport. If the transport is
11621 handling multiple addresses, the value from the first address is used.
11622
11623 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11624 matches a local part by means of a lookup. The data read by the lookup is
11625 available during the rest of the ACL statement. In all other situations, this
11626 variable expands to nothing.
11627
11628 .vitem &$local_part_prefix$&
11629 .vindex "&$local_part_prefix$&"
11630 When an address is being routed or delivered, and a
11631 specific prefix for the local part was recognized, it is available in this
11632 variable, having been removed from &$local_part$&.
11633
11634 .vitem &$local_part_suffix$&
11635 .vindex "&$local_part_suffix$&"
11636 When an address is being routed or delivered, and a
11637 specific suffix for the local part was recognized, it is available in this
11638 variable, having been removed from &$local_part$&.
11639
11640 .vitem &$local_scan_data$&
11641 .vindex "&$local_scan_data$&"
11642 This variable contains the text returned by the &[local_scan()]& function when
11643 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11644
11645 .vitem &$local_user_gid$&
11646 .vindex "&$local_user_gid$&"
11647 See &$local_user_uid$&.
11648
11649 .vitem &$local_user_uid$&
11650 .vindex "&$local_user_uid$&"
11651 This variable and &$local_user_gid$& are set to the uid and gid after the
11652 &%check_local_user%& router precondition succeeds. This means that their values
11653 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11654 and &%condition%&), for the &%address_data%& expansion, and for any
11655 router-specific expansions. At all other times, the values in these variables
11656 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11657
11658 .vitem &$localhost_number$&
11659 .vindex "&$localhost_number$&"
11660 This contains the expanded value of the
11661 &%localhost_number%& option. The expansion happens after the main options have
11662 been read.
11663
11664 .vitem &$log_inodes$&
11665 .vindex "&$log_inodes$&"
11666 The number of free inodes in the disk partition where Exim's
11667 log files are being written. The value is recalculated whenever the variable is
11668 referenced. If the relevant file system does not have the concept of inodes,
11669 the value of is -1. See also the &%check_log_inodes%& option.
11670
11671 .vitem &$log_space$&
11672 .vindex "&$log_space$&"
11673 The amount of free space (as a number of kilobytes) in the disk
11674 partition where Exim's log files are being written. The value is recalculated
11675 whenever the variable is referenced. If the operating system does not have the
11676 ability to find the amount of free space (only true for experimental systems),
11677 the space value is -1. See also the &%check_log_space%& option.
11678
11679
11680 .vitem &$lookup_dnssec_authenticated$&
11681 .vindex "&$lookup_dnssec_authenticated$&"
11682 This variable is set after a DNS lookup done by
11683 a dnsdb lookup expansion, dnslookup router or smtp transport.
11684 It will be empty if &(DNSSEC)& was not requested,
11685 &"no"& if the result was not labelled as authenticated data
11686 and &"yes"& if it was.
11687
11688 .vitem &$mailstore_basename$&
11689 .vindex "&$mailstore_basename$&"
11690 This variable is set only when doing deliveries in &"mailstore"& format in the
11691 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11692 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11693 contains the basename of the files that are being written, that is, the name
11694 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11695 variable is empty.
11696
11697 .vitem &$malware_name$&
11698 .vindex "&$malware_name$&"
11699 This variable is available when Exim is compiled with the
11700 content-scanning extension. It is set to the name of the virus that was found
11701 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11702
11703 .vitem &$max_received_linelength$&
11704 .vindex "&$max_received_linelength$&"
11705 .cindex "maximum" "line length"
11706 .cindex "line length" "maximum"
11707 This variable contains the number of bytes in the longest line that was
11708 received as part of the message, not counting the line termination
11709 character(s).
11710
11711 .vitem &$message_age$&
11712 .cindex "message" "age of"
11713 .vindex "&$message_age$&"
11714 This variable is set at the start of a delivery attempt to contain the number
11715 of seconds since the message was received. It does not change during a single
11716 delivery attempt.
11717
11718 .vitem &$message_body$&
11719 .cindex "body of message" "expansion variable"
11720 .cindex "message body" "in expansion"
11721 .cindex "binary zero" "in message body"
11722 .vindex "&$message_body$&"
11723 .oindex "&%message_body_visible%&"
11724 This variable contains the initial portion of a message's body while it is
11725 being delivered, and is intended mainly for use in filter files. The maximum
11726 number of characters of the body that are put into the variable is set by the
11727 &%message_body_visible%& configuration option; the default is 500.
11728
11729 .oindex "&%message_body_newlines%&"
11730 By default, newlines are converted into spaces in &$message_body$&, to make it
11731 easier to search for phrases that might be split over a line break. However,
11732 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11733 zeros are always converted into spaces.
11734
11735 .vitem &$message_body_end$&
11736 .cindex "body of message" "expansion variable"
11737 .cindex "message body" "in expansion"
11738 .vindex "&$message_body_end$&"
11739 This variable contains the final portion of a message's
11740 body while it is being delivered. The format and maximum size are as for
11741 &$message_body$&.
11742
11743 .vitem &$message_body_size$&
11744 .cindex "body of message" "size"
11745 .cindex "message body" "size"
11746 .vindex "&$message_body_size$&"
11747 When a message is being delivered, this variable contains the size of the body
11748 in bytes. The count starts from the character after the blank line that
11749 separates the body from the header. Newlines are included in the count. See
11750 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11751
11752 .vitem &$message_exim_id$&
11753 .vindex "&$message_exim_id$&"
11754 When a message is being received or delivered, this variable contains the
11755 unique message id that is generated and used by Exim to identify the message.
11756 An id is not created for a message until after its header has been successfully
11757 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11758 line; it is the local id that Exim assigns to the message, for example:
11759 &`1BXTIK-0001yO-VA`&.
11760
11761 .vitem &$message_headers$&
11762 .vindex &$message_headers$&
11763 This variable contains a concatenation of all the header lines when a message
11764 is being processed, except for lines added by routers or transports. The header
11765 lines are separated by newline characters. Their contents are decoded in the
11766 same way as a header line that is inserted by &%bheader%&.
11767
11768 .vitem &$message_headers_raw$&
11769 .vindex &$message_headers_raw$&
11770 This variable is like &$message_headers$& except that no processing of the
11771 contents of header lines is done.
11772
11773 .vitem &$message_id$&
11774 This is an old name for &$message_exim_id$&. It is now deprecated.
11775
11776 .vitem &$message_linecount$&
11777 .vindex "&$message_linecount$&"
11778 This variable contains the total number of lines in the header and body of the
11779 message. Compare &$body_linecount$&, which is the count for the body only.
11780 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11781 number of lines received. Before delivery happens (that is, before filters,
11782 routers, and transports run) the count is increased to include the
11783 &'Received:'& header line that Exim standardly adds, and also any other header
11784 lines that are added by ACLs. The blank line that separates the message header
11785 from the body is not counted.
11786
11787 As with the special case of &$message_size$&, during the expansion of the
11788 appendfile transport's maildir_tag option in maildir format, the value of
11789 &$message_linecount$& is the precise size of the number of newlines in the
11790 file that has been written (minus one for the blank line between the
11791 header and the body).
11792
11793 Here is an example of the use of this variable in a DATA ACL:
11794 .code
11795 deny message   = Too many lines in message header
11796      condition = \
11797       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11798 .endd
11799 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11800 message has not yet been received.
11801
11802 .vitem &$message_size$&
11803 .cindex "size" "of message"
11804 .cindex "message" "size"
11805 .vindex "&$message_size$&"
11806 When a message is being processed, this variable contains its size in bytes. In
11807 most cases, the size includes those headers that were received with the
11808 message, but not those (such as &'Envelope-to:'&) that are added to individual
11809 deliveries as they are written. However, there is one special case: during the
11810 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11811 doing a delivery in maildir format, the value of &$message_size$& is the
11812 precise size of the file that has been written. See also
11813 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11814
11815 .cindex "RCPT" "value of &$message_size$&"
11816 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11817 contains the size supplied on the MAIL command, or -1 if no size was given. The
11818 value may not, of course, be truthful.
11819
11820 .vitem &$mime_$&&'xxx'&
11821 A number of variables whose names start with &$mime$& are
11822 available when Exim is compiled with the content-scanning extension. For
11823 details, see section &<<SECTscanmimepart>>&.
11824
11825 .vitem "&$n0$& &-- &$n9$&"
11826 These variables are counters that can be incremented by means
11827 of the &%add%& command in filter files.
11828
11829 .vitem &$original_domain$&
11830 .vindex "&$domain$&"
11831 .vindex "&$original_domain$&"
11832 When a top-level address is being processed for delivery, this contains the
11833 same value as &$domain$&. However, if a &"child"& address (for example,
11834 generated by an alias, forward, or filter file) is being processed, this
11835 variable contains the domain of the original address (lower cased). This
11836 differs from &$parent_domain$& only when there is more than one level of
11837 aliasing or forwarding. When more than one address is being delivered in a
11838 single transport run, &$original_domain$& is not set.
11839
11840 If a new address is created by means of a &%deliver%& command in a system
11841 filter, it is set up with an artificial &"parent"& address. This has the local
11842 part &'system-filter'& and the default qualify domain.
11843
11844 .vitem &$original_local_part$&
11845 .vindex "&$local_part$&"
11846 .vindex "&$original_local_part$&"
11847 When a top-level address is being processed for delivery, this contains the
11848 same value as &$local_part$&, unless a prefix or suffix was removed from the
11849 local part, because &$original_local_part$& always contains the full local
11850 part. When a &"child"& address (for example, generated by an alias, forward, or
11851 filter file) is being processed, this variable contains the full local part of
11852 the original address.
11853
11854 If the router that did the redirection processed the local part
11855 case-insensitively, the value in &$original_local_part$& is in lower case.
11856 This variable differs from &$parent_local_part$& only when there is more than
11857 one level of aliasing or forwarding. When more than one address is being
11858 delivered in a single transport run, &$original_local_part$& is not set.
11859
11860 If a new address is created by means of a &%deliver%& command in a system
11861 filter, it is set up with an artificial &"parent"& address. This has the local
11862 part &'system-filter'& and the default qualify domain.
11863
11864 .vitem &$originator_gid$&
11865 .cindex "gid (group id)" "of originating user"
11866 .cindex "sender" "gid"
11867 .vindex "&$caller_gid$&"
11868 .vindex "&$originator_gid$&"
11869 This variable contains the value of &$caller_gid$& that was set when the
11870 message was received. For messages received via the command line, this is the
11871 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11872 normally the gid of the Exim user.
11873
11874 .vitem &$originator_uid$&
11875 .cindex "uid (user id)" "of originating user"
11876 .cindex "sender" "uid"
11877 .vindex "&$caller_uid$&"
11878 .vindex "&$originaltor_uid$&"
11879 The value of &$caller_uid$& that was set when the message was received. For
11880 messages received via the command line, this is the uid of the sending user.
11881 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11882 user.
11883
11884 .vitem &$parent_domain$&
11885 .vindex "&$parent_domain$&"
11886 This variable is similar to &$original_domain$& (see
11887 above), except that it refers to the immediately preceding parent address.
11888
11889 .vitem &$parent_local_part$&
11890 .vindex "&$parent_local_part$&"
11891 This variable is similar to &$original_local_part$&
11892 (see above), except that it refers to the immediately preceding parent address.
11893
11894 .vitem &$pid$&
11895 .cindex "pid (process id)" "of current process"
11896 .vindex "&$pid$&"
11897 This variable contains the current process id.
11898
11899 .vitem &$pipe_addresses$&
11900 .cindex "filter" "transport filter"
11901 .cindex "transport" "filter"
11902 .vindex "&$pipe_addresses$&"
11903 This is not an expansion variable, but is mentioned here because the string
11904 &`$pipe_addresses`& is handled specially in the command specification for the
11905 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11906 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11907 It cannot be used in general expansion strings, and provokes an &"unknown
11908 variable"& error if encountered.
11909
11910 .vitem &$primary_hostname$&
11911 .vindex "&$primary_hostname$&"
11912 This variable contains the value set by &%primary_hostname%& in the
11913 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11914 a single-component name, Exim calls &[gethostbyname()]& (or
11915 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11916 qualified host name. See also &$smtp_active_hostname$&.
11917
11918
11919 .vitem &$prvscheck_address$&
11920 This variable is used in conjunction with the &%prvscheck%& expansion item,
11921 which is described in sections &<<SECTexpansionitems>>& and
11922 &<<SECTverifyPRVS>>&.
11923
11924 .vitem &$prvscheck_keynum$&
11925 This variable is used in conjunction with the &%prvscheck%& expansion item,
11926 which is described in sections &<<SECTexpansionitems>>& and
11927 &<<SECTverifyPRVS>>&.
11928
11929 .vitem &$prvscheck_result$&
11930 This variable is used in conjunction with the &%prvscheck%& expansion item,
11931 which is described in sections &<<SECTexpansionitems>>& and
11932 &<<SECTverifyPRVS>>&.
11933
11934 .vitem &$qualify_domain$&
11935 .vindex "&$qualify_domain$&"
11936 The value set for the &%qualify_domain%& option in the configuration file.
11937
11938 .vitem &$qualify_recipient$&
11939 .vindex "&$qualify_recipient$&"
11940 The value set for the &%qualify_recipient%& option in the configuration file,
11941 or if not set, the value of &$qualify_domain$&.
11942
11943 .vitem &$rcpt_count$&
11944 .vindex "&$rcpt_count$&"
11945 When a message is being received by SMTP, this variable contains the number of
11946 RCPT commands received for the current message. If this variable is used in a
11947 RCPT ACL, its value includes the current command.
11948
11949 .vitem &$rcpt_defer_count$&
11950 .vindex "&$rcpt_defer_count$&"
11951 .cindex "4&'xx'& responses" "count of"
11952 When a message is being received by SMTP, this variable contains the number of
11953 RCPT commands in the current message that have previously been rejected with a
11954 temporary (4&'xx'&) response.
11955
11956 .vitem &$rcpt_fail_count$&
11957 .vindex "&$rcpt_fail_count$&"
11958 When a message is being received by SMTP, this variable contains the number of
11959 RCPT commands in the current message that have previously been rejected with a
11960 permanent (5&'xx'&) response.
11961
11962 .vitem &$received_count$&
11963 .vindex "&$received_count$&"
11964 This variable contains the number of &'Received:'& header lines in the message,
11965 including the one added by Exim (so its value is always greater than zero). It
11966 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11967 delivering.
11968
11969 .vitem &$received_for$&
11970 .vindex "&$received_for$&"
11971 If there is only a single recipient address in an incoming message, this
11972 variable contains that address when the &'Received:'& header line is being
11973 built. The value is copied after recipient rewriting has happened, but before
11974 the &[local_scan()]& function is run.
11975
11976 .vitem &$received_ip_address$&
11977 .vindex "&$received_ip_address$&"
11978 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11979 variable is set to the address of the local IP interface, and &$received_port$&
11980 is set to the local port number. (The remote IP address and port are in
11981 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11982 the port value is -1 unless it has been set using the &%-oMi%& command line
11983 option.
11984
11985 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11986 could be used, for example, to make the file name for a TLS certificate depend
11987 on which interface and/or port is being used for the incoming connection. The
11988 values of &$received_ip_address$& and &$received_port$& are saved with any
11989 messages that are received, thus making these variables available at delivery
11990 time.
11991 For outbound connections see &$sending_ip_address$&.
11992
11993 .vitem &$received_port$&
11994 .vindex "&$received_port$&"
11995 See &$received_ip_address$&.
11996
11997 .vitem &$received_protocol$&
11998 .vindex "&$received_protocol$&"
11999 When a message is being processed, this variable contains the name of the
12000 protocol by which it was received. Most of the names used by Exim are defined
12001 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12002 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12003 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12004 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12005 connection and the client was successfully authenticated.
12006
12007 Exim uses the protocol name &"smtps"& for the case when encryption is
12008 automatically set up on connection without the use of STARTTLS (see
12009 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12010 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12011 where the client initially uses EHLO, sets up an encrypted connection using
12012 STARTTLS, and then uses HELO afterwards.
12013
12014 The &%-oMr%& option provides a way of specifying a custom protocol name for
12015 messages that are injected locally by trusted callers. This is commonly used to
12016 identify messages that are being re-injected after some kind of scanning.
12017
12018 .vitem &$received_time$&
12019 .vindex "&$received_time$&"
12020 This variable contains the date and time when the current message was received,
12021 as a number of seconds since the start of the Unix epoch.
12022
12023 .vitem &$recipient_data$&
12024 .vindex "&$recipient_data$&"
12025 This variable is set after an indexing lookup success in an ACL &%recipients%&
12026 condition. It contains the data from the lookup, and the value remains set
12027 until the next &%recipients%& test. Thus, you can do things like this:
12028 .display
12029 &`require recipients  = cdb*@;/some/file`&
12030 &`deny    `&&'some further test involving'& &`$recipient_data`&
12031 .endd
12032 &*Warning*&: This variable is set only when a lookup is used as an indexing
12033 method in the address list, using the semicolon syntax as in the example above.
12034 The variable is not set for a lookup that is used as part of the string
12035 expansion that all such lists undergo before being interpreted.
12036
12037 .vitem &$recipient_verify_failure$&
12038 .vindex "&$recipient_verify_failure$&"
12039 In an ACL, when a recipient verification fails, this variable contains
12040 information about the failure. It is set to one of the following words:
12041
12042 .ilist
12043 &"qualify"&: The address was unqualified (no domain), and the message
12044 was neither local nor came from an exempted host.
12045
12046 .next
12047 &"route"&: Routing failed.
12048
12049 .next
12050 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12051 or before the MAIL command (that is, on initial connection, HELO, or
12052 MAIL).
12053
12054 .next
12055 &"recipient"&: The RCPT command in a callout was rejected.
12056 .next
12057
12058 &"postmaster"&: The postmaster check in a callout was rejected.
12059 .endlist
12060
12061 The main use of this variable is expected to be to distinguish between
12062 rejections of MAIL and rejections of RCPT.
12063
12064 .vitem &$recipients$&
12065 .vindex "&$recipients$&"
12066 This variable contains a list of envelope recipients for a message. A comma and
12067 a space separate the addresses in the replacement text. However, the variable
12068 is not generally available, to prevent exposure of Bcc recipients in
12069 unprivileged users' filter files. You can use &$recipients$& only in these
12070 cases:
12071
12072 .olist
12073 In a system filter file.
12074 .next
12075 In the ACLs associated with the DATA command and with non-SMTP messages, that
12076 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12077 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12078 &%acl_not_smtp_mime%&.
12079 .next
12080 From within a &[local_scan()]& function.
12081 .endlist
12082
12083
12084 .vitem &$recipients_count$&
12085 .vindex "&$recipients_count$&"
12086 When a message is being processed, this variable contains the number of
12087 envelope recipients that came with the message. Duplicates are not excluded
12088 from the count. While a message is being received over SMTP, the number
12089 increases for each accepted recipient. It can be referenced in an ACL.
12090
12091
12092 .vitem &$regex_match_string$&
12093 .vindex "&$regex_match_string$&"
12094 This variable is set to contain the matching regular expression after a
12095 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12096
12097
12098 .vitem &$reply_address$&
12099 .vindex "&$reply_address$&"
12100 When a message is being processed, this variable contains the contents of the
12101 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12102 contents of the &'From:'& header line. Apart from the removal of leading
12103 white space, the value is not processed in any way. In particular, no RFC 2047
12104 decoding or character code translation takes place.
12105
12106 .vitem &$return_path$&
12107 .vindex "&$return_path$&"
12108 When a message is being delivered, this variable contains the return path &--
12109 the sender field that will be sent as part of the envelope. It is not enclosed
12110 in <> characters. At the start of routing an address, &$return_path$& has the
12111 same value as &$sender_address$&, but if, for example, an incoming message to a
12112 mailing list has been expanded by a router which specifies a different address
12113 for bounce messages, &$return_path$& subsequently contains the new bounce
12114 address, whereas &$sender_address$& always contains the original sender address
12115 that was received with the message. In other words, &$sender_address$& contains
12116 the incoming envelope sender, and &$return_path$& contains the outgoing
12117 envelope sender.
12118
12119 .vitem &$return_size_limit$&
12120 .vindex "&$return_size_limit$&"
12121 This is an obsolete name for &$bounce_return_size_limit$&.
12122
12123 .vitem &$router_name$&
12124 .cindex "router" "name"
12125 .cindex "name" "of router"
12126 .vindex "&$router_name$&"
12127 During the running of a router this variable contains its name.
12128
12129 .vitem &$runrc$&
12130 .cindex "return code" "from &%run%& expansion"
12131 .vindex "&$runrc$&"
12132 This variable contains the return code from a command that is run by the
12133 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12134 assume the order in which option values are expanded, except for those
12135 preconditions whose order of testing is documented. Therefore, you cannot
12136 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12137 another.
12138
12139 .vitem &$self_hostname$&
12140 .oindex "&%self%&" "value of host name"
12141 .vindex "&$self_hostname$&"
12142 When an address is routed to a supposedly remote host that turns out to be the
12143 local host, what happens is controlled by the &%self%& generic router option.
12144 One of its values causes the address to be passed to another router. When this
12145 happens, &$self_hostname$& is set to the name of the local host that the
12146 original router encountered. In other circumstances its contents are null.
12147
12148 .vitem &$sender_address$&
12149 .vindex "&$sender_address$&"
12150 When a message is being processed, this variable contains the sender's address
12151 that was received in the message's envelope. The case of letters in the address
12152 is retained, in both the local part and the domain. For bounce messages, the
12153 value of this variable is the empty string. See also &$return_path$&.
12154
12155 .vitem &$sender_address_data$&
12156 .vindex "&$address_data$&"
12157 .vindex "&$sender_address_data$&"
12158 If &$address_data$& is set when the routers are called from an ACL to verify a
12159 sender address, the final value is preserved in &$sender_address_data$&, to
12160 distinguish it from data from a recipient address. The value does not persist
12161 after the end of the current ACL statement. If you want to preserve it for
12162 longer, you can save it in an ACL variable.
12163
12164 .vitem &$sender_address_domain$&
12165 .vindex "&$sender_address_domain$&"
12166 The domain portion of &$sender_address$&.
12167
12168 .vitem &$sender_address_local_part$&
12169 .vindex "&$sender_address_local_part$&"
12170 The local part portion of &$sender_address$&.
12171
12172 .vitem &$sender_data$&
12173 .vindex "&$sender_data$&"
12174 This variable is set after a lookup success in an ACL &%senders%& condition or
12175 in a router &%senders%& option. It contains the data from the lookup, and the
12176 value remains set until the next &%senders%& test. Thus, you can do things like
12177 this:
12178 .display
12179 &`require senders      = cdb*@;/some/file`&
12180 &`deny    `&&'some further test involving'& &`$sender_data`&
12181 .endd
12182 &*Warning*&: This variable is set only when a lookup is used as an indexing
12183 method in the address list, using the semicolon syntax as in the example above.
12184 The variable is not set for a lookup that is used as part of the string
12185 expansion that all such lists undergo before being interpreted.
12186
12187 .vitem &$sender_fullhost$&
12188 .vindex "&$sender_fullhost$&"
12189 When a message is received from a remote host, this variable contains the host
12190 name and IP address in a single string. It ends with the IP address in square
12191 brackets, followed by a colon and a port number if the logging of ports is
12192 enabled. The format of the rest of the string depends on whether the host
12193 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12194 looking up its IP address. (Looking up the IP address can be forced by the
12195 &%host_lookup%& option, independent of verification.) A plain host name at the
12196 start of the string is a verified host name; if this is not present,
12197 verification either failed or was not requested. A host name in parentheses is
12198 the argument of a HELO or EHLO command. This is omitted if it is identical to
12199 the verified host name or to the host's IP address in square brackets.
12200
12201 .vitem &$sender_helo_name$&
12202 .vindex "&$sender_helo_name$&"
12203 When a message is received from a remote host that has issued a HELO or EHLO
12204 command, the argument of that command is placed in this variable. It is also
12205 set if HELO or EHLO is used when a message is received using SMTP locally via
12206 the &%-bs%& or &%-bS%& options.
12207
12208 .vitem &$sender_host_address$&
12209 .vindex "&$sender_host_address$&"
12210 When a message is received from a remote host using SMTP,
12211 this variable contains that
12212 host's IP address. For locally non-SMTP submitted messages, it is empty.
12213
12214 .vitem &$sender_host_authenticated$&
12215 .vindex "&$sender_host_authenticated$&"
12216 This variable contains the name (not the public name) of the authenticator
12217 driver that successfully authenticated the client from which the message was
12218 received. It is empty if there was no successful authentication. See also
12219 &$authenticated_id$&.
12220
12221 .vitem &$sender_host_dnssec$&
12222 .vindex "&$sender_host_dnssec$&"
12223 If an attempt to populate &$sender_host_name$& has been made
12224 (by reference, &%hosts_lookup%& or
12225 otherwise) then this boolean will have been set true if, and only if, the
12226 resolver library states that the reverse DNS was authenticated data.  At all
12227 other times, this variable is false.
12228
12229 It is likely that you will need to coerce DNSSEC support on in the resolver
12230 library, by setting:
12231 .code
12232 dns_dnssec_ok = 1
12233 .endd
12234
12235 Exim does not perform DNSSEC validation itself, instead leaving that to a
12236 validating resolver (eg, unbound, or bind with suitable configuration).
12237
12238 Exim does not (currently) check to see if the forward DNS was also secured
12239 with DNSSEC, only the reverse DNS.
12240
12241 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12242 mechanism in the list, then this variable will be false.
12243
12244
12245 .vitem &$sender_host_name$&
12246 .vindex "&$sender_host_name$&"
12247 When a message is received from a remote host, this variable contains the
12248 host's name as obtained by looking up its IP address. For messages received by
12249 other means, this variable is empty.
12250
12251 .vindex "&$host_lookup_failed$&"
12252 If the host name has not previously been looked up, a reference to
12253 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12254 A looked up name is accepted only if it leads back to the original IP address
12255 via a forward lookup. If either the reverse or the forward lookup fails to find
12256 any data, or if the forward lookup does not yield the original IP address,
12257 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12258
12259 .vindex "&$host_lookup_deferred$&"
12260 However, if either of the lookups cannot be completed (for example, there is a
12261 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12262 &$host_lookup_failed$& remains set to &"0"&.
12263
12264 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12265 host name again if there is a subsequent reference to &$sender_host_name$&
12266 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12267 is set to &"1"&.
12268
12269 Exim does not automatically look up every calling host's name. If you want
12270 maximum efficiency, you should arrange your configuration so that it avoids
12271 these lookups altogether. The lookup happens only if one or more of the
12272 following are true:
12273
12274 .ilist
12275 A string containing &$sender_host_name$& is expanded.
12276 .next
12277 The calling host matches the list in &%host_lookup%&. In the default
12278 configuration, this option is set to *, so it must be changed if lookups are
12279 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12280 .next
12281 Exim needs the host name in order to test an item in a host list. The items
12282 that require this are described in sections &<<SECThoslispatnam>>& and
12283 &<<SECThoslispatnamsk>>&.
12284 .next
12285 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12286 In this case, the host name is required to compare with the name quoted in any
12287 EHLO or HELO commands that the client issues.
12288 .next
12289 The remote host issues a EHLO or HELO command that quotes one of the
12290 domains in &%helo_lookup_domains%&. The default value of this option is
12291 . ==== As this is a nested list, any displays it contains must be indented
12292 . ==== as otherwise they are too far to the left.
12293 .code
12294   helo_lookup_domains = @ : @[]
12295 .endd
12296 which causes a lookup if a remote host (incorrectly) gives the server's name or
12297 IP address in an EHLO or HELO command.
12298 .endlist
12299
12300
12301 .vitem &$sender_host_port$&
12302 .vindex "&$sender_host_port$&"
12303 When a message is received from a remote host, this variable contains the port
12304 number that was used on the remote host.
12305
12306 .vitem &$sender_ident$&
12307 .vindex "&$sender_ident$&"
12308 When a message is received from a remote host, this variable contains the
12309 identification received in response to an RFC 1413 request. When a message has
12310 been received locally, this variable contains the login name of the user that
12311 called Exim.
12312
12313 .vitem &$sender_rate_$&&'xxx'&
12314 A number of variables whose names begin &$sender_rate_$& are set as part of the
12315 &%ratelimit%& ACL condition. Details are given in section
12316 &<<SECTratelimiting>>&.
12317
12318 .vitem &$sender_rcvhost$&
12319 .cindex "DNS" "reverse lookup"
12320 .cindex "reverse DNS lookup"
12321 .vindex "&$sender_rcvhost$&"
12322 This is provided specifically for use in &'Received:'& headers. It starts with
12323 either the verified host name (as obtained from a reverse DNS lookup) or, if
12324 there is no verified host name, the IP address in square brackets. After that
12325 there may be text in parentheses. When the first item is a verified host name,
12326 the first thing in the parentheses is the IP address in square brackets,
12327 followed by a colon and a port number if port logging is enabled. When the
12328 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12329 the parentheses.
12330
12331 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12332 was used and its argument was not identical to the real host name or IP
12333 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12334 all three items are present in the parentheses, a newline and tab are inserted
12335 into the string, to improve the formatting of the &'Received:'& header.
12336
12337 .vitem &$sender_verify_failure$&
12338 .vindex "&$sender_verify_failure$&"
12339 In an ACL, when a sender verification fails, this variable contains information
12340 about the failure. The details are the same as for
12341 &$recipient_verify_failure$&.
12342
12343 .vitem &$sending_ip_address$&
12344 .vindex "&$sending_ip_address$&"
12345 This variable is set whenever an outgoing SMTP connection to another host has
12346 been set up. It contains the IP address of the local interface that is being
12347 used. This is useful if a host that has more than one IP address wants to take
12348 on different personalities depending on which one is being used. For incoming
12349 connections, see &$received_ip_address$&.
12350
12351 .vitem &$sending_port$&
12352 .vindex "&$sending_port$&"
12353 This variable is set whenever an outgoing SMTP connection to another host has
12354 been set up. It contains the local port that is being used. For incoming
12355 connections, see &$received_port$&.
12356
12357 .vitem &$smtp_active_hostname$&
12358 .vindex "&$smtp_active_hostname$&"
12359 During an incoming SMTP session, this variable contains the value of the active
12360 host name, as specified by the &%smtp_active_hostname%& option. The value of
12361 &$smtp_active_hostname$& is saved with any message that is received, so its
12362 value can be consulted during routing and delivery.
12363
12364 .vitem &$smtp_command$&
12365 .vindex "&$smtp_command$&"
12366 During the processing of an incoming SMTP command, this variable contains the
12367 entire command. This makes it possible to distinguish between HELO and EHLO in
12368 the HELO ACL, and also to distinguish between commands such as these:
12369 .code
12370 MAIL FROM:<>
12371 MAIL FROM: <>
12372 .endd
12373 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12374 command, the address in &$smtp_command$& is the original address before any
12375 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12376 the address after SMTP-time rewriting.
12377
12378 .vitem &$smtp_command_argument$&
12379 .cindex "SMTP" "command, argument for"
12380 .vindex "&$smtp_command_argument$&"
12381 While an ACL is running to check an SMTP command, this variable contains the
12382 argument, that is, the text that follows the command name, with leading white
12383 space removed. Following the introduction of &$smtp_command$&, this variable is
12384 somewhat redundant, but is retained for backwards compatibility.
12385
12386 .vitem &$smtp_count_at_connection_start$&
12387 .vindex "&$smtp_count_at_connection_start$&"
12388 This variable is set greater than zero only in processes spawned by the Exim
12389 daemon for handling incoming SMTP connections. The name is deliberately long,
12390 in order to emphasize what the contents are. When the daemon accepts a new
12391 connection, it increments this variable. A copy of the variable is passed to
12392 the child process that handles the connection, but its value is fixed, and
12393 never changes. It is only an approximation of how many incoming connections
12394 there actually are, because many other connections may come and go while a
12395 single connection is being processed. When a child process terminates, the
12396 daemon decrements its copy of the variable.
12397
12398 .vitem "&$sn0$& &-- &$sn9$&"
12399 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12400 that were current at the end of the system filter file. This allows a system
12401 filter file to set values that can be tested in users' filter files. For
12402 example, a system filter could set a value indicating how likely it is that a
12403 message is junk mail.
12404
12405 .vitem &$spam_$&&'xxx'&
12406 A number of variables whose names start with &$spam$& are available when Exim
12407 is compiled with the content-scanning extension. For details, see section
12408 &<<SECTscanspamass>>&.
12409
12410
12411 .vitem &$spool_directory$&
12412 .vindex "&$spool_directory$&"
12413 The name of Exim's spool directory.
12414
12415 .vitem &$spool_inodes$&
12416 .vindex "&$spool_inodes$&"
12417 The number of free inodes in the disk partition where Exim's spool files are
12418 being written. The value is recalculated whenever the variable is referenced.
12419 If the relevant file system does not have the concept of inodes, the value of
12420 is -1. See also the &%check_spool_inodes%& option.
12421
12422 .vitem &$spool_space$&
12423 .vindex "&$spool_space$&"
12424 The amount of free space (as a number of kilobytes) in the disk partition where
12425 Exim's spool files are being written. The value is recalculated whenever the
12426 variable is referenced. If the operating system does not have the ability to
12427 find the amount of free space (only true for experimental systems), the space
12428 value is -1. For example, to check in an ACL that there is at least 50
12429 megabytes free on the spool, you could write:
12430 .code
12431 condition = ${if > {$spool_space}{50000}}
12432 .endd
12433 See also the &%check_spool_space%& option.
12434
12435
12436 .vitem &$thisaddress$&
12437 .vindex "&$thisaddress$&"
12438 This variable is set only during the processing of the &%foranyaddress%&
12439 command in a filter file. Its use is explained in the description of that
12440 command, which can be found in the separate document entitled &'Exim's
12441 interfaces to mail filtering'&.
12442
12443 .vitem &$tls_in_bits$&
12444 .vindex "&$tls_in_bits$&"
12445 Contains an approximation of the TLS cipher's bit-strength
12446 on the inbound connection; the meaning of
12447 this depends upon the TLS implementation used.
12448 If TLS has not been negotiated, the value will be 0.
12449 The value of this is automatically fed into the Cyrus SASL authenticator
12450 when acting as a server, to specify the "external SSF" (a SASL term).
12451
12452 The deprecated &$tls_bits$& variable refers to the inbound side
12453 except when used in the context of an outbound SMTP delivery, when it refers to
12454 the outbound.
12455
12456 .vitem &$tls_out_bits$&
12457 .vindex "&$tls_out_bits$&"
12458 Contains an approximation of the TLS cipher's bit-strength
12459 on an outbound SMTP connection; the meaning of
12460 this depends upon the TLS implementation used.
12461 If TLS has not been negotiated, the value will be 0.
12462
12463 .vitem &$tls_in_ourcert$&
12464 .vindex "&$tls_in_ourcert$&"
12465 This variable refers to the certificate presented to the peer of an
12466 inbound connection when the message was received.
12467 It is only useful as the argument of a
12468 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12469 or a &%def%& condition.
12470
12471 .vitem &$tls_in_peercert$&
12472 .vindex "&$tls_in_peercert$&"
12473 This variable refers to the certificate presented by the peer of an
12474 inbound connection when the message was received.
12475 It is only useful as the argument of a
12476 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12477 or a &%def%& condition.
12478 If certificate verification fails it may refer to a failing chain element
12479 which is not the leaf.
12480
12481 .vitem &$tls_out_ourcert$&
12482 .vindex "&$tls_out_ourcert$&"
12483 This variable refers to the certificate presented to the peer of an
12484 outbound connection.  It is only useful as the argument of a
12485 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12486 or a &%def%& condition.
12487
12488 .vitem &$tls_out_peercert$&
12489 .vindex "&$tls_out_peercert$&"
12490 This variable refers to the certificate presented by the peer of an
12491 outbound connection.  It is only useful as the argument of a
12492 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12493 or a &%def%& condition.
12494 If certificate verification fails it may refer to a failing chain element
12495 which is not the leaf.
12496
12497 .vitem &$tls_in_certificate_verified$&
12498 .vindex "&$tls_in_certificate_verified$&"
12499 This variable is set to &"1"& if a TLS certificate was verified when the
12500 message was received, and &"0"& otherwise.
12501
12502 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12503 except when used in the context of an outbound SMTP delivery, when it refers to
12504 the outbound.
12505
12506 .vitem &$tls_out_certificate_verified$&
12507 .vindex "&$tls_out_certificate_verified$&"
12508 This variable is set to &"1"& if a TLS certificate was verified when an
12509 outbound SMTP connection was made,
12510 and &"0"& otherwise.
12511
12512 .vitem &$tls_in_cipher$&
12513 .vindex "&$tls_in_cipher$&"
12514 .vindex "&$tls_cipher$&"
12515 When a message is received from a remote host over an encrypted SMTP
12516 connection, this variable is set to the cipher suite that was negotiated, for
12517 example DES-CBC3-SHA. In other circumstances, in particular, for message
12518 received over unencrypted connections, the variable is empty. Testing
12519 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12520 non-encrypted connections during ACL processing.
12521
12522 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12523 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12524 becomes the same as &$tls_out_cipher$&.
12525
12526 .vitem &$tls_out_cipher$&
12527 .vindex "&$tls_out_cipher$&"
12528 This variable is
12529 cleared before any outgoing SMTP connection is made,
12530 and then set to the outgoing cipher suite if one is negotiated. See chapter
12531 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12532 details of the &(smtp)& transport.
12533
12534 .vitem &$tls_in_ocsp$&
12535 .vindex "&$tls_in_ocsp$&"
12536 When a message is received from a remote client connection
12537 the result of any OCSP request from the client is encoded in this variable:
12538 .code
12539 0 OCSP proof was not requested (default value)
12540 1 No response to request
12541 2 Response not verified
12542 3 Verification failed
12543 4 Verification succeeded
12544 .endd
12545
12546 .vitem &$tls_out_ocsp$&
12547 .vindex "&$tls_out_ocsp$&"
12548 When a message is sent to a remote host connection
12549 the result of any OCSP request made is encoded in this variable.
12550 See &$tls_in_ocsp$& for values.
12551
12552 .vitem &$tls_in_peerdn$&
12553 .vindex "&$tls_in_peerdn$&"
12554 .vindex "&$tls_peerdn$&"
12555 When a message is received from a remote host over an encrypted SMTP
12556 connection, and Exim is configured to request a certificate from the client,
12557 the value of the Distinguished Name of the certificate is made available in the
12558 &$tls_in_peerdn$& during subsequent processing.
12559 If certificate verification fails it may refer to a failing chain element
12560 which is not the leaf.
12561
12562 The deprecated &$tls_peerdn$& variable refers to the inbound side
12563 except when used in the context of an outbound SMTP delivery, when it refers to
12564 the outbound.
12565
12566 .vitem &$tls_out_peerdn$&
12567 .vindex "&$tls_out_peerdn$&"
12568 When a message is being delivered to a remote host over an encrypted SMTP
12569 connection, and Exim is configured to request a certificate from the server,
12570 the value of the Distinguished Name of the certificate is made available in the
12571 &$tls_out_peerdn$& during subsequent processing.
12572 If certificate verification fails it may refer to a failing chain element
12573 which is not the leaf.
12574
12575 .vitem &$tls_in_sni$&
12576 .vindex "&$tls_in_sni$&"
12577 .vindex "&$tls_sni$&"
12578 .cindex "TLS" "Server Name Indication"
12579 When a TLS session is being established, if the client sends the Server
12580 Name Indication extension, the value will be placed in this variable.
12581 If the variable appears in &%tls_certificate%& then this option and
12582 some others, described in &<<SECTtlssni>>&,
12583 will be re-expanded early in the TLS session, to permit
12584 a different certificate to be presented (and optionally a different key to be
12585 used) to the client, based upon the value of the SNI extension.
12586
12587 The deprecated &$tls_sni$& variable refers to the inbound side
12588 except when used in the context of an outbound SMTP delivery, when it refers to
12589 the outbound.
12590
12591 .vitem &$tls_out_sni$&
12592 .vindex "&$tls_out_sni$&"
12593 .cindex "TLS" "Server Name Indication"
12594 During outbound
12595 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12596 the transport.
12597
12598 .vitem &$tod_bsdinbox$&
12599 .vindex "&$tod_bsdinbox$&"
12600 The time of day and the date, in the format required for BSD-style mailbox
12601 files, for example: Thu Oct 17 17:14:09 1995.
12602
12603 .vitem &$tod_epoch$&
12604 .vindex "&$tod_epoch$&"
12605 The time and date as a number of seconds since the start of the Unix epoch.
12606
12607 .vitem &$tod_epoch_l$&
12608 .vindex "&$tod_epoch_l$&"
12609 The time and date as a number of microseconds since the start of the Unix epoch.
12610
12611 .vitem &$tod_full$&
12612 .vindex "&$tod_full$&"
12613 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12614 +0100. The timezone is always given as a numerical offset from UTC, with
12615 positive values used for timezones that are ahead (east) of UTC, and negative
12616 values for those that are behind (west).
12617
12618 .vitem &$tod_log$&
12619 .vindex "&$tod_log$&"
12620 The time and date in the format used for writing Exim's log files, for example:
12621 1995-10-12 15:32:29, but without a timezone.
12622
12623 .vitem &$tod_logfile$&
12624 .vindex "&$tod_logfile$&"
12625 This variable contains the date in the format yyyymmdd. This is the format that
12626 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12627 flag.
12628
12629 .vitem &$tod_zone$&
12630 .vindex "&$tod_zone$&"
12631 This variable contains the numerical value of the local timezone, for example:
12632 -0500.
12633
12634 .vitem &$tod_zulu$&
12635 .vindex "&$tod_zulu$&"
12636 This variable contains the UTC date and time in &"Zulu"& format, as specified
12637 by ISO 8601, for example: 20030221154023Z.
12638
12639 .vitem &$transport_name$&
12640 .cindex "transport" "name"
12641 .cindex "name" "of transport"
12642 .vindex "&$transport_name$&"
12643 During the running of a transport, this variable contains its name.
12644
12645 .vitem &$value$&
12646 .vindex "&$value$&"
12647 This variable contains the result of an expansion lookup, extraction operation,
12648 or external command, as described above. It is also used during a
12649 &*reduce*& expansion.
12650
12651 .vitem &$verify_mode$&
12652 .vindex "&$verify_mode$&"
12653 While a router or transport is being run in verify mode
12654 or for cutthrough delivery,
12655 contains "S" for sender-verification or "R" for recipient-verification.
12656 Otherwise, empty.
12657
12658 .vitem &$version_number$&
12659 .vindex "&$version_number$&"
12660 The version number of Exim.
12661
12662 .vitem &$warn_message_delay$&
12663 .vindex "&$warn_message_delay$&"
12664 This variable is set only during the creation of a message warning about a
12665 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12666
12667 .vitem &$warn_message_recipients$&
12668 .vindex "&$warn_message_recipients$&"
12669 This variable is set only during the creation of a message warning about a
12670 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12671 .endlist
12672 .ecindex IIDstrexp
12673
12674
12675
12676 . ////////////////////////////////////////////////////////////////////////////
12677 . ////////////////////////////////////////////////////////////////////////////
12678
12679 .chapter "Embedded Perl" "CHAPperl"
12680 .scindex IIDperl "Perl" "calling from Exim"
12681 Exim can be built to include an embedded Perl interpreter. When this is done,
12682 Perl subroutines can be called as part of the string expansion process. To make
12683 use of the Perl support, you need version 5.004 or later of Perl installed on
12684 your system. To include the embedded interpreter in the Exim binary, include
12685 the line
12686 .code
12687 EXIM_PERL = perl.o
12688 .endd
12689 in your &_Local/Makefile_& and then build Exim in the normal way.
12690
12691
12692 .section "Setting up so Perl can be used" "SECID85"
12693 .oindex "&%perl_startup%&"
12694 Access to Perl subroutines is via a global configuration option called
12695 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12696 no &%perl_startup%& option in the Exim configuration file then no Perl
12697 interpreter is started and there is almost no overhead for Exim (since none of
12698 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12699 option then the associated value is taken to be Perl code which is executed in
12700 a newly created Perl interpreter.
12701
12702 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12703 need backslashes before any characters to escape special meanings. The option
12704 should usually be something like
12705 .code
12706 perl_startup = do '/etc/exim.pl'
12707 .endd
12708 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12709 use from Exim. Exim can be configured either to start up a Perl interpreter as
12710 soon as it is entered, or to wait until the first time it is needed. Starting
12711 the interpreter at the beginning ensures that it is done while Exim still has
12712 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12713 fact used in a particular run. Also, note that this does not mean that Exim is
12714 necessarily running as root when Perl is called at a later time. By default,
12715 the interpreter is started only when it is needed, but this can be changed in
12716 two ways:
12717
12718 .ilist
12719 .oindex "&%perl_at_start%&"
12720 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12721 a startup when Exim is entered.
12722 .next
12723 The command line option &%-ps%& also requests a startup when Exim is entered,
12724 overriding the setting of &%perl_at_start%&.
12725 .endlist
12726
12727 There is also a command line option &%-pd%& (for delay) which suppresses the
12728 initial startup, even if &%perl_at_start%& is set.
12729
12730
12731 .section "Calling Perl subroutines" "SECID86"
12732 When the configuration file includes a &%perl_startup%& option you can make use
12733 of the string expansion item to call the Perl subroutines that are defined
12734 by the &%perl_startup%& code. The operator is used in any of the following
12735 forms:
12736 .code
12737 ${perl{foo}}
12738 ${perl{foo}{argument}}
12739 ${perl{foo}{argument1}{argument2} ... }
12740 .endd
12741 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12742 arguments may be passed. Passing more than this results in an expansion failure
12743 with an error message of the form
12744 .code
12745 Too many arguments passed to Perl subroutine "foo" (max is 8)
12746 .endd
12747 The return value of the Perl subroutine is evaluated in a scalar context before
12748 it is passed back to Exim to be inserted into the expanded string. If the
12749 return value is &'undef'&, the expansion is forced to fail in the same way as
12750 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12751 by obeying Perl's &%die%& function, the expansion fails with the error message
12752 that was passed to &%die%&.
12753
12754
12755 .section "Calling Exim functions from Perl" "SECID87"
12756 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12757 is available to call back into Exim's string expansion function. For example,
12758 the Perl code
12759 .code
12760 my $lp = Exim::expand_string('$local_part');
12761 .endd
12762 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12763 Note those are single quotes and not double quotes to protect against
12764 &$local_part$& being interpolated as a Perl variable.
12765
12766 If the string expansion is forced to fail by a &"fail"& item, the result of
12767 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12768 expansion string, the Perl call from the original expansion string fails with
12769 an appropriate error message, in the same way as if &%die%& were used.
12770
12771 .cindex "debugging" "from embedded Perl"
12772 .cindex "log" "writing from embedded Perl"
12773 Two other Exim functions are available for use from within Perl code.
12774 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12775 debugging is enabled. If you want a newline at the end, you must supply it.
12776 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12777 timestamp. In this case, you should not supply a terminating newline.
12778
12779
12780 .section "Use of standard output and error by Perl" "SECID88"
12781 .cindex "Perl" "standard output and error"
12782 You should not write to the standard error or output streams from within your
12783 Perl code, as it is not defined how these are set up. In versions of Exim
12784 before 4.50, it is possible for the standard output or error to refer to the
12785 SMTP connection during message reception via the daemon. Writing to this stream
12786 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12787 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12788 avoided, but the output is lost.
12789
12790 .cindex "Perl" "use of &%warn%&"
12791 The Perl &%warn%& statement writes to the standard error stream by default.
12792 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12793 you have no control. When Exim starts up the Perl interpreter, it arranges for
12794 output from the &%warn%& statement to be written to the Exim main log. You can
12795 change this by including appropriate Perl magic somewhere in your Perl code.
12796 For example, to discard &%warn%& output completely, you need this:
12797 .code
12798 $SIG{__WARN__} = sub { };
12799 .endd
12800 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12801 example, the code for the subroutine is empty, so it does nothing, but you can
12802 include any Perl code that you like. The text of the &%warn%& message is passed
12803 as the first subroutine argument.
12804 .ecindex IIDperl
12805
12806
12807 . ////////////////////////////////////////////////////////////////////////////
12808 . ////////////////////////////////////////////////////////////////////////////
12809
12810 .chapter "Starting the daemon and the use of network interfaces" &&&
12811          "CHAPinterfaces" &&&
12812          "Starting the daemon"
12813 .cindex "daemon" "starting"
12814 .cindex "interface" "listening"
12815 .cindex "network interface"
12816 .cindex "interface" "network"
12817 .cindex "IP address" "for listening"
12818 .cindex "daemon" "listening IP addresses"
12819 .cindex "TCP/IP" "setting listening interfaces"
12820 .cindex "TCP/IP" "setting listening ports"
12821 A host that is connected to a TCP/IP network may have one or more physical
12822 hardware network interfaces. Each of these interfaces may be configured as one
12823 or more &"logical"& interfaces, which are the entities that a program actually
12824 works with. Each of these logical interfaces is associated with an IP address.
12825 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12826 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12827 knowledge about the host's interfaces for use in three different circumstances:
12828
12829 .olist
12830 When a listening daemon is started, Exim needs to know which interfaces
12831 and ports to listen on.
12832 .next
12833 When Exim is routing an address, it needs to know which IP addresses
12834 are associated with local interfaces. This is required for the correct
12835 processing of MX lists by removing the local host and others with the
12836 same or higher priority values. Also, Exim needs to detect cases
12837 when an address is routed to an IP address that in fact belongs to the
12838 local host. Unless the &%self%& router option or the &%allow_localhost%&
12839 option of the smtp transport is set (as appropriate), this is treated
12840 as an error situation.
12841 .next
12842 When Exim connects to a remote host, it may need to know which interface to use
12843 for the outgoing connection.
12844 .endlist
12845
12846
12847 Exim's default behaviour is likely to be appropriate in the vast majority
12848 of cases. If your host has only one interface, and you want all its IP
12849 addresses to be treated in the same way, and you are using only the
12850 standard SMTP port, you should not need to take any special action. The
12851 rest of this chapter does not apply to you.
12852
12853 In a more complicated situation you may want to listen only on certain
12854 interfaces, or on different ports, and for this reason there are a number of
12855 options that can be used to influence Exim's behaviour. The rest of this
12856 chapter describes how they operate.
12857
12858 When a message is received over TCP/IP, the interface and port that were
12859 actually used are set in &$received_ip_address$& and &$received_port$&.
12860
12861
12862
12863 .section "Starting a listening daemon" "SECID89"
12864 When a listening daemon is started (by means of the &%-bd%& command line
12865 option), the interfaces and ports on which it listens are controlled by the
12866 following options:
12867
12868 .ilist
12869 &%daemon_smtp_ports%& contains a list of default ports
12870 or service names.
12871 (For backward compatibility, this option can also be specified in the singular.)
12872 .next
12873 &%local_interfaces%& contains list of interface IP addresses on which to
12874 listen. Each item may optionally also specify a port.
12875 .endlist
12876
12877 The default list separator in both cases is a colon, but this can be changed as
12878 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12879 it is usually best to change the separator to avoid having to double all the
12880 colons. For example:
12881 .code
12882 local_interfaces = <; 127.0.0.1 ; \
12883                       192.168.23.65 ; \
12884                       ::1 ; \
12885                       3ffe:ffff:836f::fe86:a061
12886 .endd
12887 There are two different formats for specifying a port along with an IP address
12888 in &%local_interfaces%&:
12889
12890 .olist
12891 The port is added onto the address with a dot separator. For example, to listen
12892 on port 1234 on two different IP addresses:
12893 .code
12894 local_interfaces = <; 192.168.23.65.1234 ; \
12895                       3ffe:ffff:836f::fe86:a061.1234
12896 .endd
12897 .next
12898 The IP address is enclosed in square brackets, and the port is added
12899 with a colon separator, for example:
12900 .code
12901 local_interfaces = <; [192.168.23.65]:1234 ; \
12902                       [3ffe:ffff:836f::fe86:a061]:1234
12903 .endd
12904 .endlist
12905
12906 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12907 default setting contains just one port:
12908 .code
12909 daemon_smtp_ports = smtp
12910 .endd
12911 If more than one port is listed, each interface that does not have its own port
12912 specified listens on all of them. Ports that are listed in
12913 &%daemon_smtp_ports%& can be identified either by name (defined in
12914 &_/etc/services_&) or by number. However, when ports are given with individual
12915 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12916
12917
12918
12919 .section "Special IP listening addresses" "SECID90"
12920 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12921 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12922 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12923 instead of setting up separate listening sockets for each interface. The
12924 default value of &%local_interfaces%& is
12925 .code
12926 local_interfaces = 0.0.0.0
12927 .endd
12928 when Exim is built without IPv6 support; otherwise it is:
12929 .code
12930 local_interfaces = <; ::0 ; 0.0.0.0
12931 .endd
12932 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12933
12934
12935
12936 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12937 The &%-oX%& command line option can be used to override the values of
12938 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12939 instance. Another way of doing this would be to use macros and the &%-D%&
12940 option. However, &%-oX%& can be used by any admin user, whereas modification of
12941 the runtime configuration by &%-D%& is allowed only when the caller is root or
12942 exim.
12943
12944 The value of &%-oX%& is a list of items. The default colon separator can be
12945 changed in the usual way if required. If there are any items that do not
12946 contain dots or colons (that is, are not IP addresses), the value of
12947 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12948 items that do contain dots or colons, the value of &%local_interfaces%& is
12949 replaced by those items. Thus, for example,
12950 .code
12951 -oX 1225
12952 .endd
12953 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12954 whereas
12955 .code
12956 -oX 192.168.34.5.1125
12957 .endd
12958 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12959 (However, since &%local_interfaces%& now contains no items without ports, the
12960 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12961
12962
12963
12964 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12965 .cindex "ssmtp protocol"
12966 .cindex "smtps protocol"
12967 .cindex "SMTP" "ssmtp protocol"
12968 .cindex "SMTP" "smtps protocol"
12969 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12970 before the STARTTLS command was standardized for SMTP. Some legacy clients
12971 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12972 list of port numbers or service names,
12973 connections to those ports must use SSMTP. The most
12974 common use of this option is expected to be
12975 .code
12976 tls_on_connect_ports = 465
12977 .endd
12978 because 465 is the usual port number used by the legacy clients. There is also
12979 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12980 this way when a daemon is started.
12981
12982 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12983 daemon to listen on those ports. You must still specify them in
12984 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12985 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12986 connections via the daemon.)
12987
12988
12989
12990
12991 .section "IPv6 address scopes" "SECID92"
12992 .cindex "IPv6" "address scopes"
12993 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12994 can, in principle, have the same link-local IPv6 address on different
12995 interfaces. Thus, additional information is needed, over and above the IP
12996 address, to distinguish individual interfaces. A convention of using a
12997 percent sign followed by something (often the interface name) has been
12998 adopted in some cases, leading to addresses like this:
12999 .code
13000 fe80::202:b3ff:fe03:45c1%eth0
13001 .endd
13002 To accommodate this usage, a percent sign followed by an arbitrary string is
13003 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13004 to convert a textual IPv6 address for actual use. This function recognizes the
13005 percent convention in operating systems that support it, and it processes the
13006 address appropriately. Unfortunately, some older libraries have problems with
13007 &[getaddrinfo()]&. If
13008 .code
13009 IPV6_USE_INET_PTON=yes
13010 .endd
13011 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13012 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13013 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13014 function.) Of course, this means that the additional functionality of
13015 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13016
13017 .section "Disabling IPv6" "SECID93"
13018 .cindex "IPv6" "disabling"
13019 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13020 run on a host whose kernel does not support IPv6. The binary will fall back to
13021 using IPv4, but it may waste resources looking up AAAA records, and trying to
13022 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13023 .oindex "&%disable_ipv6%&"
13024 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13025 activities take place. AAAA records are never looked up, and any IPv6 addresses
13026 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13027 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13028 to handle IPv6 literal addresses.
13029
13030 On the other hand, when IPv6 is in use, there may be times when you want to
13031 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13032 option to globally suppress the lookup of AAAA records for specified domains,
13033 and you can use the &%ignore_target_hosts%& generic router option to ignore
13034 IPv6 addresses in an individual router.
13035
13036
13037
13038 .section "Examples of starting a listening daemon" "SECID94"
13039 The default case in an IPv6 environment is
13040 .code
13041 daemon_smtp_ports = smtp
13042 local_interfaces = <; ::0 ; 0.0.0.0
13043 .endd
13044 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13045 Either one or two sockets may be used, depending on the characteristics of
13046 the TCP/IP stack. (This is complicated and messy; for more information,
13047 read the comments in the &_daemon.c_& source file.)
13048
13049 To specify listening on ports 25 and 26 on all interfaces:
13050 .code
13051 daemon_smtp_ports = 25 : 26
13052 .endd
13053 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13054 .code
13055 local_interfaces = <; ::0.25     ; ::0.26 \
13056                       0.0.0.0.25 ; 0.0.0.0.26
13057 .endd
13058 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13059 IPv4 loopback address only:
13060 .code
13061 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13062 .endd
13063 To specify listening on the default port on specific interfaces only:
13064 .code
13065 local_interfaces = 10.0.0.67 : 192.168.34.67
13066 .endd
13067 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13068
13069
13070
13071 .section "Recognizing the local host" "SECTreclocipadd"
13072 The &%local_interfaces%& option is also used when Exim needs to determine
13073 whether or not an IP address refers to the local host. That is, the IP
13074 addresses of all the interfaces on which a daemon is listening are always
13075 treated as local.
13076
13077 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13078 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13079 available interfaces from the operating system, and extracts the relevant
13080 (that is, IPv4 or IPv6) addresses to use for checking.
13081
13082 Some systems set up large numbers of virtual interfaces in order to provide
13083 many virtual web servers. In this situation, you may want to listen for
13084 email on only a few of the available interfaces, but nevertheless treat all
13085 interfaces as local when routing. You can do this by setting
13086 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13087 &"all"& wildcard values. These addresses are recognized as local, but are not
13088 used for listening. Consider this example:
13089 .code
13090 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13091                       192.168.53.235 ; \
13092                       3ffe:2101:12:1:a00:20ff:fe86:a061
13093
13094 extra_local_interfaces = <; ::0 ; 0.0.0.0
13095 .endd
13096 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13097 address, but all available interface addresses are treated as local when
13098 Exim is routing.
13099
13100 In some environments the local host name may be in an MX list, but with an IP
13101 address that is not assigned to any local interface. In other cases it may be
13102 desirable to treat other host names as if they referred to the local host. Both
13103 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13104 This contains host names rather than IP addresses. When a host is referenced
13105 during routing, either via an MX record or directly, it is treated as the local
13106 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13107 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13108
13109
13110
13111 .section "Delivering to a remote host" "SECID95"
13112 Delivery to a remote host is handled by the smtp transport. By default, it
13113 allows the system's TCP/IP functions to choose which interface to use (if
13114 there is more than one) when connecting to a remote host. However, the
13115 &%interface%& option can be set to specify which interface is used. See the
13116 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13117 details.
13118
13119
13120
13121
13122 . ////////////////////////////////////////////////////////////////////////////
13123 . ////////////////////////////////////////////////////////////////////////////
13124
13125 .chapter "Main configuration" "CHAPmainconfig"
13126 .scindex IIDconfima "configuration file" "main section"
13127 .scindex IIDmaiconf "main configuration"
13128 The first part of the run time configuration file contains three types of item:
13129
13130 .ilist
13131 Macro definitions: These lines start with an upper case letter. See section
13132 &<<SECTmacrodefs>>& for details of macro processing.
13133 .next
13134 Named list definitions: These lines start with one of the words &"domainlist"&,
13135 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13136 section &<<SECTnamedlists>>&.
13137 .next
13138 Main configuration settings: Each setting occupies one line of the file
13139 (with possible continuations). If any setting is preceded by the word
13140 &"hide"&, the &%-bP%& command line option displays its value to admin users
13141 only. See section &<<SECTcos>>& for a description of the syntax of these option
13142 settings.
13143 .endlist
13144
13145 This chapter specifies all the main configuration options, along with their
13146 types and default values. For ease of finding a particular option, they appear
13147 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13148 are now so many options, they are first listed briefly in functional groups, as
13149 an aid to finding the name of the option you are looking for. Some options are
13150 listed in more than one group.
13151
13152 .section "Miscellaneous" "SECID96"
13153 .table2
13154 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13155 .row &%disable_ipv6%&                "do no IPv6 processing"
13156 .row &%keep_malformed%&              "for broken files &-- should not happen"
13157 .row &%localhost_number%&            "for unique message ids in clusters"
13158 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13159 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13160 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13161 .row &%print_topbitchars%&           "top-bit characters are printing"
13162 .row &%timezone%&                    "force time zone"
13163 .endtable
13164
13165
13166 .section "Exim parameters" "SECID97"
13167 .table2
13168 .row &%exim_group%&                  "override compiled-in value"
13169 .row &%exim_path%&                   "override compiled-in value"
13170 .row &%exim_user%&                   "override compiled-in value"
13171 .row &%primary_hostname%&            "default from &[uname()]&"
13172 .row &%split_spool_directory%&       "use multiple directories"
13173 .row &%spool_directory%&             "override compiled-in value"
13174 .endtable
13175
13176
13177
13178 .section "Privilege controls" "SECID98"
13179 .table2
13180 .row &%admin_groups%&                "groups that are Exim admin users"
13181 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13182 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13183 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13184 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13185 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13186 .row &%never_users%&                 "do not run deliveries as these"
13187 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13188 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13189 .row &%trusted_groups%&              "groups that are trusted"
13190 .row &%trusted_users%&               "users that are trusted"
13191 .endtable
13192
13193
13194
13195 .section "Logging" "SECID99"
13196 .table2
13197 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13198 .row &%log_file_path%&               "override compiled-in value"
13199 .row &%log_selector%&                "set/unset optional logging"
13200 .row &%log_timezone%&                "add timezone to log lines"
13201 .row &%message_logs%&                "create per-message logs"
13202 .row &%preserve_message_logs%&       "after message completion"
13203 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13204 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13205 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13206 .row &%syslog_facility%&             "set syslog &""facility""& field"
13207 .row &%syslog_processname%&          "set syslog &""ident""& field"
13208 .row &%syslog_timestamp%&            "timestamp syslog lines"
13209 .row &%write_rejectlog%&             "control use of message log"
13210 .endtable
13211
13212
13213
13214 .section "Frozen messages" "SECID100"
13215 .table2
13216 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13217 .row &%freeze_tell%&                 "send message when freezing"
13218 .row &%move_frozen_messages%&        "to another directory"
13219 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13220 .endtable
13221
13222
13223
13224 .section "Data lookups" "SECID101"
13225 .table2
13226 .row &%ibase_servers%&               "InterBase servers"
13227 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13228 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13229 .row &%ldap_cert_file%&              "client cert file for LDAP"
13230 .row &%ldap_cert_key%&               "client key file for LDAP"
13231 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13232 .row &%ldap_default_servers%&        "used if no server in query"
13233 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13234 .row &%ldap_start_tls%&              "require TLS within LDAP"
13235 .row &%ldap_version%&                "set protocol version"
13236 .row &%lookup_open_max%&             "lookup files held open"
13237 .row &%mysql_servers%&               "default MySQL servers"
13238 .row &%oracle_servers%&              "Oracle servers"
13239 .row &%pgsql_servers%&               "default PostgreSQL servers"
13240 .row &%sqlite_lock_timeout%&         "as it says"
13241 .endtable
13242
13243
13244
13245 .section "Message ids" "SECID102"
13246 .table2
13247 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13248 .row &%message_id_header_text%&      "ditto"
13249 .endtable
13250
13251
13252
13253 .section "Embedded Perl Startup" "SECID103"
13254 .table2
13255 .row &%perl_at_start%&               "always start the interpreter"
13256 .row &%perl_startup%&                "code to obey when starting Perl"
13257 .endtable
13258
13259
13260
13261 .section "Daemon" "SECID104"
13262 .table2
13263 .row &%daemon_smtp_ports%&           "default ports"
13264 .row &%daemon_startup_retries%&      "number of times to retry"
13265 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13266 .row &%extra_local_interfaces%&      "not necessarily listened on"
13267 .row &%local_interfaces%&            "on which to listen, with optional ports"
13268 .row &%pid_file_path%&               "override compiled-in value"
13269 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13270 .endtable
13271
13272
13273
13274 .section "Resource control" "SECID105"
13275 .table2
13276 .row &%check_log_inodes%&            "before accepting a message"
13277 .row &%check_log_space%&             "before accepting a message"
13278 .row &%check_spool_inodes%&          "before accepting a message"
13279 .row &%check_spool_space%&           "before accepting a message"
13280 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13281 .row &%queue_only_load%&             "queue incoming if load high"
13282 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13283 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13284 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13285 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13286 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13287 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13288 .row &%smtp_accept_max_per_connection%& "messages per connection"
13289 .row &%smtp_accept_max_per_host%&    "connections from one host"
13290 .row &%smtp_accept_queue%&           "queue mail if more connections"
13291 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13292                                            connection"
13293 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13294 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13295 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13296 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13297 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13298 .endtable
13299
13300
13301
13302 .section "Policy controls" "SECID106"
13303 .table2
13304 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13305 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13306 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13307 .row &%acl_smtp_auth%&               "ACL for AUTH"
13308 .row &%acl_smtp_connect%&            "ACL for connection"
13309 .row &%acl_smtp_data%&               "ACL for DATA"
13310 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13311 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13312 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13313 .row &%acl_smtp_expn%&               "ACL for EXPN"
13314 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13315 .row &%acl_smtp_mail%&               "ACL for MAIL"
13316 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13317 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13318 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13319 .row &%acl_smtp_predata%&            "ACL for start of data"
13320 .row &%acl_smtp_quit%&               "ACL for QUIT"
13321 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13322 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13323 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13324 .row &%av_scanner%&                  "specify virus scanner"
13325 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13326                                       words""&"
13327 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13328 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13329 .row &%header_maxsize%&              "total size of message header"
13330 .row &%header_line_maxsize%&         "individual header line limit"
13331 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13332 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13333 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13334 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13335 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13336 .row &%host_lookup%&                 "host name looked up for these hosts"
13337 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13338 .row &%host_reject_connection%&      "reject connection from these hosts"
13339 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13340 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13341 .row &%message_size_limit%&          "for all messages"
13342 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13343 .row &%spamd_address%&               "set interface to SpamAssassin"
13344 .row &%strict_acl_vars%&             "object to unset ACL variables"
13345 .endtable
13346
13347
13348
13349 .section "Callout cache" "SECID107"
13350 .table2
13351 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13352                                          item"
13353 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13354                                          item"
13355 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13356 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13357 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13358 .endtable
13359
13360
13361
13362 .section "TLS" "SECID108"
13363 .table2
13364 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13365 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13366 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13367 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13368 .row &%tls_certificate%&             "location of server certificate"
13369 .row &%tls_crl%&                     "certificate revocation list"
13370 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13371 .row &%tls_dhparam%&                 "DH parameters for server"
13372 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13373 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13374 .row &%tls_privatekey%&              "location of server private key"
13375 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13376 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13377 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13378 .row &%tls_verify_certificates%&     "expected client certificates"
13379 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13380 .endtable
13381
13382
13383
13384 .section "Local user handling" "SECID109"
13385 .table2
13386 .row &%finduser_retries%&            "useful in NIS environments"
13387 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13388 .row &%gecos_pattern%&               "ditto"
13389 .row &%max_username_length%&         "for systems that truncate"
13390 .row &%unknown_login%&               "used when no login name found"
13391 .row &%unknown_username%&            "ditto"
13392 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13393 .row &%uucp_from_sender%&            "ditto"
13394 .endtable
13395
13396
13397
13398 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13399 .table2
13400 .row &%header_maxsize%&              "total size of message header"
13401 .row &%header_line_maxsize%&         "individual header line limit"
13402 .row &%message_size_limit%&          "applies to all messages"
13403 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13404 .row &%received_header_text%&        "expanded to make &'Received:'&"
13405 .row &%received_headers_max%&        "for mail loop detection"
13406 .row &%recipients_max%&              "limit per message"
13407 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13408 .endtable
13409
13410
13411
13412
13413 .section "Non-SMTP incoming messages" "SECID111"
13414 .table2
13415 .row &%receive_timeout%&             "for non-SMTP messages"
13416 .endtable
13417
13418
13419
13420
13421
13422 .section "Incoming SMTP messages" "SECID112"
13423 See also the &'Policy controls'& section above.
13424
13425 .table2
13426 .row &%host_lookup%&                 "host name looked up for these hosts"
13427 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13428 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13429 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13430 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13431 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13432 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13433 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13434 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13435 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13436 .row &%smtp_accept_max_per_connection%& "messages per connection"
13437 .row &%smtp_accept_max_per_host%&    "connections from one host"
13438 .row &%smtp_accept_queue%&           "queue mail if more connections"
13439 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13440                                            connection"
13441 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13442 .row &%smtp_active_hostname%&        "host name to use in messages"
13443 .row &%smtp_banner%&                 "text for welcome banner"
13444 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13445 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13446 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13447 .row &%smtp_etrn_command%&           "what to run for ETRN"
13448 .row &%smtp_etrn_serialize%&         "only one at once"
13449 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13450 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13451 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13452 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13453 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13454 .row &%smtp_receive_timeout%&        "per command or data line"
13455 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13456 .row &%smtp_return_error_details%&   "give detail on rejections"
13457 .endtable
13458
13459
13460
13461 .section "SMTP extensions" "SECID113"
13462 .table2
13463 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13464 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13465 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13466 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13467 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13468 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13469 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13470 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13471 .endtable
13472
13473
13474
13475 .section "Processing messages" "SECID114"
13476 .table2
13477 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13478 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13479 .row &%allow_utf8_domains%&          "in addresses"
13480 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13481                                       words""&"
13482 .row &%delivery_date_remove%&        "from incoming messages"
13483 .row &%envelope_to_remove%&          "from incoming messages"
13484 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13485 .row &%headers_charset%&             "default for translations"
13486 .row &%qualify_domain%&              "default for senders"
13487 .row &%qualify_recipient%&           "default for recipients"
13488 .row &%return_path_remove%&          "from incoming messages"
13489 .row &%strip_excess_angle_brackets%& "in addresses"
13490 .row &%strip_trailing_dot%&          "at end of addresses"
13491 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13492 .endtable
13493
13494
13495
13496 .section "System filter" "SECID115"
13497 .table2
13498 .row &%system_filter%&               "locate system filter"
13499 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13500                                             directory"
13501 .row &%system_filter_file_transport%& "transport for delivery to a file"
13502 .row &%system_filter_group%&         "group for filter running"
13503 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13504 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13505 .row &%system_filter_user%&          "user for filter running"
13506 .endtable
13507
13508
13509
13510 .section "Routing and delivery" "SECID116"
13511 .table2
13512 .row &%disable_ipv6%&                "do no IPv6 processing"
13513 .row &%dns_again_means_nonexist%&    "for broken domains"
13514 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13515 .row &%dns_dnssec_ok%&               "parameter for resolver"
13516 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13517 .row &%dns_retrans%&                 "parameter for resolver"
13518 .row &%dns_retry%&                   "parameter for resolver"
13519 .row &%dns_use_edns0%&               "parameter for resolver"
13520 .row &%hold_domains%&                "hold delivery for these domains"
13521 .row &%local_interfaces%&            "for routing checks"
13522 .row &%queue_domains%&               "no immediate delivery for these"
13523 .row &%queue_only%&                  "no immediate delivery at all"
13524 .row &%queue_only_file%&             "no immediate delivery if file exists"
13525 .row &%queue_only_load%&             "no immediate delivery if load is high"
13526 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13527 .row &%queue_only_override%&         "allow command line to override"
13528 .row &%queue_run_in_order%&          "order of arrival"
13529 .row &%queue_run_max%&               "of simultaneous queue runners"
13530 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13531 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13532 .row &%remote_sort_domains%&         "order of remote deliveries"
13533 .row &%retry_data_expire%&           "timeout for retry data"
13534 .row &%retry_interval_max%&          "safety net for retry rules"
13535 .endtable
13536
13537
13538
13539 .section "Bounce and warning messages" "SECID117"
13540 .table2
13541 .row &%bounce_message_file%&         "content of bounce"
13542 .row &%bounce_message_text%&         "content of bounce"
13543 .row &%bounce_return_body%&          "include body if returning message"
13544 .row &%bounce_return_message%&       "include original message in bounce"
13545 .row &%bounce_return_size_limit%&    "limit on returned message"
13546 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13547 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13548 .row &%errors_copy%&                 "copy bounce messages"
13549 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13550 .row &%delay_warning%&               "time schedule"
13551 .row &%delay_warning_condition%&     "condition for warning messages"
13552 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13553 .row &%smtp_return_error_details%&   "give detail on rejections"
13554 .row &%warn_message_file%&           "content of warning message"
13555 .endtable
13556
13557
13558
13559 .section "Alphabetical list of main options" "SECTalomo"
13560 Those options that undergo string expansion before use are marked with
13561 &dagger;.
13562
13563 .option accept_8bitmime main boolean true
13564 .cindex "8BITMIME"
13565 .cindex "8-bit characters"
13566 .cindex "log" "selectors"
13567 .cindex "log" "8BITMIME"
13568 This option causes Exim to send 8BITMIME in its response to an SMTP
13569 EHLO command, and to accept the BODY= parameter on MAIL commands.
13570 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13571 takes no steps to do anything special with messages received by this route.
13572
13573 Historically Exim kept this option off by default, but the maintainers
13574 feel that in today's Internet, this causes more problems than it solves.
13575 It now defaults to true.
13576 A more detailed analysis of the issues is provided by Dan Bernstein:
13577 .display
13578 &url(http://cr.yp.to/smtp/8bitmime.html)
13579 .endd
13580
13581 To log received 8BITMIME status use
13582 .code
13583 log_selector = +8bitmime
13584 .endd
13585
13586 .option acl_not_smtp main string&!! unset
13587 .cindex "&ACL;" "for non-SMTP messages"
13588 .cindex "non-SMTP messages" "ACLs for"
13589 This option defines the ACL that is run when a non-SMTP message has been
13590 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13591 further details.
13592
13593 .option acl_not_smtp_mime main string&!! unset
13594 This option defines the ACL that is run for individual MIME parts of non-SMTP
13595 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13596 SMTP messages.
13597
13598 .option acl_not_smtp_start main string&!! unset
13599 .cindex "&ACL;" "at start of non-SMTP message"
13600 .cindex "non-SMTP messages" "ACLs for"
13601 This option defines the ACL that is run before Exim starts reading a
13602 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13603
13604 .option acl_smtp_auth main string&!! unset
13605 .cindex "&ACL;" "setting up for SMTP commands"
13606 .cindex "AUTH" "ACL for"
13607 This option defines the ACL that is run when an SMTP AUTH command is
13608 received. See chapter &<<CHAPACL>>& for further details.
13609
13610 .option acl_smtp_connect main string&!! unset
13611 .cindex "&ACL;" "on SMTP connection"
13612 This option defines the ACL that is run when an SMTP connection is received.
13613 See chapter &<<CHAPACL>>& for further details.
13614
13615 .option acl_smtp_data main string&!! unset
13616 .cindex "DATA" "ACL for"
13617 This option defines the ACL that is run after an SMTP DATA command has been
13618 processed and the message itself has been received, but before the final
13619 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13620
13621 .new
13622 .option acl_smtp_data_prdr main string&!! accept
13623 .cindex "PRDR" "ACL for"
13624 .cindex "DATA" "PRDR ACL for"
13625 .cindex "&ACL;" "PRDR-related"
13626 .cindex "&ACL;" "per-user data processing"
13627 .wen
13628 This option defines the ACL that,
13629 if the PRDR feature has been negotiated,
13630 is run for each recipient after an SMTP DATA command has been
13631 processed and the message itself has been received, but before the
13632 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13633
13634 .option acl_smtp_etrn main string&!! unset
13635 .cindex "ETRN" "ACL for"
13636 This option defines the ACL that is run when an SMTP ETRN command is
13637 received. See chapter &<<CHAPACL>>& for further details.
13638
13639 .option acl_smtp_expn main string&!! unset
13640 .cindex "EXPN" "ACL for"
13641 This option defines the ACL that is run when an SMTP EXPN command is
13642 received. See chapter &<<CHAPACL>>& for further details.
13643
13644 .option acl_smtp_helo main string&!! unset
13645 .cindex "EHLO" "ACL for"
13646 .cindex "HELO" "ACL for"
13647 This option defines the ACL that is run when an SMTP EHLO or HELO
13648 command is received. See chapter &<<CHAPACL>>& for further details.
13649
13650
13651 .option acl_smtp_mail main string&!! unset
13652 .cindex "MAIL" "ACL for"
13653 This option defines the ACL that is run when an SMTP MAIL command is
13654 received. See chapter &<<CHAPACL>>& for further details.
13655
13656 .option acl_smtp_mailauth main string&!! unset
13657 .cindex "AUTH" "on MAIL command"
13658 This option defines the ACL that is run when there is an AUTH parameter on
13659 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13660 &<<CHAPSMTPAUTH>>& for details of authentication.
13661
13662 .option acl_smtp_mime main string&!! unset
13663 .cindex "MIME content scanning" "ACL for"
13664 This option is available when Exim is built with the content-scanning
13665 extension. It defines the ACL that is run for each MIME part in a message. See
13666 section &<<SECTscanmimepart>>& for details.
13667
13668 .option acl_smtp_notquit main string&!! unset
13669 .cindex "not-QUIT, ACL for"
13670 This option defines the ACL that is run when an SMTP session
13671 ends without a QUIT command being received.
13672 See chapter &<<CHAPACL>>& for further details.
13673
13674 .option acl_smtp_predata main string&!! unset
13675 This option defines the ACL that is run when an SMTP DATA command is
13676 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13677 further details.
13678
13679 .option acl_smtp_quit main string&!! unset
13680 .cindex "QUIT, ACL for"
13681 This option defines the ACL that is run when an SMTP QUIT command is
13682 received. See chapter &<<CHAPACL>>& for further details.
13683
13684 .option acl_smtp_rcpt main string&!! unset
13685 .cindex "RCPT" "ACL for"
13686 This option defines the ACL that is run when an SMTP RCPT command is
13687 received. See chapter &<<CHAPACL>>& for further details.
13688
13689 .option acl_smtp_starttls main string&!! unset
13690 .cindex "STARTTLS, ACL for"
13691 This option defines the ACL that is run when an SMTP STARTTLS command is
13692 received. See chapter &<<CHAPACL>>& for further details.
13693
13694 .option acl_smtp_vrfy main string&!! unset
13695 .cindex "VRFY" "ACL for"
13696 This option defines the ACL that is run when an SMTP VRFY command is
13697 received. See chapter &<<CHAPACL>>& for further details.
13698
13699 .option admin_groups main "string list&!!" unset
13700 .cindex "admin user"
13701 This option is expanded just once, at the start of Exim's processing. If the
13702 current group or any of the supplementary groups of an Exim caller is in this
13703 colon-separated list, the caller has admin privileges. If all your system
13704 programmers are in a specific group, for example, you can give them all Exim
13705 admin privileges by putting that group in &%admin_groups%&. However, this does
13706 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13707 To permit this, you have to add individuals to the Exim group.
13708
13709 .option allow_domain_literals main boolean false
13710 .cindex "domain literal"
13711 If this option is set, the RFC 2822 domain literal format is permitted in
13712 email addresses. The option is not set by default, because the domain literal
13713 format is not normally required these days, and few people know about it. It
13714 has, however, been exploited by mail abusers.
13715
13716 Unfortunately, it seems that some DNS black list maintainers are using this
13717 format to report black listing to postmasters. If you want to accept messages
13718 addressed to your hosts by IP address, you need to set
13719 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13720 domains (defined in the named domain list &%local_domains%& in the default
13721 configuration). This &"magic string"& matches the domain literal form of all
13722 the local host's IP addresses.
13723
13724
13725 .option allow_mx_to_ip main boolean false
13726 .cindex "MX record" "pointing to IP address"
13727 It appears that more and more DNS zone administrators are breaking the rules
13728 and putting domain names that look like IP addresses on the right hand side of
13729 MX records. Exim follows the rules and rejects this, giving an error message
13730 that explains the mis-configuration. However, some other MTAs support this
13731 practice, so to avoid &"Why can't Exim do this?"& complaints,
13732 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13733 recommended, except when you have no other choice.
13734
13735 .option allow_utf8_domains main boolean false
13736 .cindex "domain" "UTF-8 characters in"
13737 .cindex "UTF-8" "in domain name"
13738 Lots of discussion is going on about internationalized domain names. One
13739 camp is strongly in favour of just using UTF-8 characters, and it seems
13740 that at least two other MTAs permit this. This option allows Exim users to
13741 experiment if they wish.
13742
13743 If it is set true, Exim's domain parsing function allows valid
13744 UTF-8 multicharacters to appear in domain name components, in addition to
13745 letters, digits, and hyphens. However, just setting this option is not
13746 enough; if you want to look up these domain names in the DNS, you must also
13747 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13748 suitable setting is:
13749 .code
13750 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13751   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13752 .endd
13753 Alternatively, you can just disable this feature by setting
13754 .code
13755 dns_check_names_pattern =
13756 .endd
13757 That is, set the option to an empty string so that no check is done.
13758
13759
13760 .option auth_advertise_hosts main "host list&!!" *
13761 .cindex "authentication" "advertising"
13762 .cindex "AUTH" "advertising"
13763 If any server authentication mechanisms are configured, Exim advertises them in
13764 response to an EHLO command only if the calling host matches this list.
13765 Otherwise, Exim does not advertise AUTH.
13766 Exim does not accept AUTH commands from clients to which it has not
13767 advertised the availability of AUTH. The advertising of individual
13768 authentication mechanisms can be controlled by the use of the
13769 &%server_advertise_condition%& generic authenticator option on the individual
13770 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13771
13772 Certain mail clients (for example, Netscape) require the user to provide a name
13773 and password for authentication if AUTH is advertised, even though it may
13774 not be needed (the host may accept messages from hosts on its local LAN without
13775 authentication, for example). The &%auth_advertise_hosts%& option can be used
13776 to make these clients more friendly by excluding them from the set of hosts to
13777 which Exim advertises AUTH.
13778
13779 .cindex "AUTH" "advertising when encrypted"
13780 If you want to advertise the availability of AUTH only when the connection
13781 is encrypted using TLS, you can make use of the fact that the value of this
13782 option is expanded, with a setting like this:
13783 .code
13784 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13785 .endd
13786 .vindex "&$tls_in_cipher$&"
13787 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13788 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13789 expansion is *, which matches all hosts.
13790
13791
13792 .option auto_thaw main time 0s
13793 .cindex "thawing messages"
13794 .cindex "unfreezing messages"
13795 If this option is set to a time greater than zero, a queue runner will try a
13796 new delivery attempt on any frozen message, other than a bounce message, if
13797 this much time has passed since it was frozen. This may result in the message
13798 being re-frozen if nothing has changed since the last attempt. It is a way of
13799 saying &"keep on trying, even though there are big problems"&.
13800
13801 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13802 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13803 thought to be very useful any more, and its use should probably be avoided.
13804
13805
13806 .option av_scanner main string "see below"
13807 This option is available if Exim is built with the content-scanning extension.
13808 It specifies which anti-virus scanner to use. The default value is:
13809 .code
13810 sophie:/var/run/sophie
13811 .endd
13812 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13813 before use. See section &<<SECTscanvirus>>& for further details.
13814
13815
13816 .option bi_command main string unset
13817 .oindex "&%-bi%&"
13818 This option supplies the name of a command that is run when Exim is called with
13819 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13820 just the command name, it is not a complete command line. If an argument is
13821 required, it must come from the &%-oA%& command line option.
13822
13823
13824 .option bounce_message_file main string unset
13825 .cindex "bounce message" "customizing"
13826 .cindex "customizing" "bounce message"
13827 This option defines a template file containing paragraphs of text to be used
13828 for constructing bounce messages.  Details of the file's contents are given in
13829 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13830
13831
13832 .option bounce_message_text main string unset
13833 When this option is set, its contents are included in the default bounce
13834 message immediately after &"This message was created automatically by mail
13835 delivery software."& It is not used if &%bounce_message_file%& is set.
13836
13837 .option bounce_return_body main boolean true
13838 .cindex "bounce message" "including body"
13839 This option controls whether the body of an incoming message is included in a
13840 bounce message when &%bounce_return_message%& is true. The default setting
13841 causes the entire message, both header and body, to be returned (subject to the
13842 value of &%bounce_return_size_limit%&). If this option is false, only the
13843 message header is included. In the case of a non-SMTP message containing an
13844 error that is detected during reception, only those header lines preceding the
13845 point at which the error was detected are returned.
13846 .cindex "bounce message" "including original"
13847
13848 .option bounce_return_message main boolean true
13849 If this option is set false, none of the original message is included in
13850 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13851 &%bounce_return_body%&.
13852
13853
13854 .option bounce_return_size_limit main integer 100K
13855 .cindex "size" "of bounce, limit"
13856 .cindex "bounce message" "size limit"
13857 .cindex "limit" "bounce message size"
13858 This option sets a limit in bytes on the size of messages that are returned to
13859 senders as part of bounce messages when &%bounce_return_message%& is true. The
13860 limit should be less than the value of the global &%message_size_limit%& and of
13861 any &%message_size_limit%& settings on transports, to allow for the bounce text
13862 that Exim generates. If this option is set to zero there is no limit.
13863
13864 When the body of any message that is to be included in a bounce message is
13865 greater than the limit, it is truncated, and a comment pointing this out is
13866 added at the top. The actual cutoff may be greater than the value given, owing
13867 to the use of buffering for transferring the message in chunks (typically 8K in
13868 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13869 messages.
13870
13871 .option bounce_sender_authentication main string unset
13872 .cindex "bounce message" "sender authentication"
13873 .cindex "authentication" "bounce message"
13874 .cindex "AUTH" "on bounce message"
13875 This option provides an authenticated sender address that is sent with any
13876 bounce messages generated by Exim that are sent over an authenticated SMTP
13877 connection. A typical setting might be:
13878 .code
13879 bounce_sender_authentication = mailer-daemon@my.domain.example
13880 .endd
13881 which would cause bounce messages to be sent using the SMTP command:
13882 .code
13883 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13884 .endd
13885 The value of &%bounce_sender_authentication%& must always be a complete email
13886 address.
13887
13888 .option callout_domain_negative_expire main time 3h
13889 .cindex "caching" "callout timeouts"
13890 .cindex "callout" "caching timeouts"
13891 This option specifies the expiry time for negative callout cache data for a
13892 domain. See section &<<SECTcallver>>& for details of callout verification, and
13893 section &<<SECTcallvercache>>& for details of the caching.
13894
13895
13896 .option callout_domain_positive_expire main time 7d
13897 This option specifies the expiry time for positive callout cache data for a
13898 domain. See section &<<SECTcallver>>& for details of callout verification, and
13899 section &<<SECTcallvercache>>& for details of the caching.
13900
13901
13902 .option callout_negative_expire main time 2h
13903 This option specifies the expiry time for negative callout cache data for an
13904 address. See section &<<SECTcallver>>& for details of callout verification, and
13905 section &<<SECTcallvercache>>& for details of the caching.
13906
13907
13908 .option callout_positive_expire main time 24h
13909 This option specifies the expiry time for positive callout cache data for an
13910 address. See section &<<SECTcallver>>& for details of callout verification, and
13911 section &<<SECTcallvercache>>& for details of the caching.
13912
13913
13914 .option callout_random_local_part main string&!! "see below"
13915 This option defines the &"random"& local part that can be used as part of
13916 callout verification. The default value is
13917 .code
13918 $primary_hostname-$tod_epoch-testing
13919 .endd
13920 See section &<<CALLaddparcall>>& for details of how this value is used.
13921
13922
13923 .option check_log_inodes main integer 0
13924 See &%check_spool_space%& below.
13925
13926
13927 .option check_log_space main integer 0
13928 See &%check_spool_space%& below.
13929
13930 .oindex "&%check_rfc2047_length%&"
13931 .cindex "RFC 2047" "disabling length check"
13932 .option check_rfc2047_length main boolean true
13933 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13934 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13935 word; strings to be encoded that exceed this length are supposed to use
13936 multiple encoded words. By default, Exim does not recognize encoded words that
13937 exceed the maximum length. However, it seems that some software, in violation
13938 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13939 set false, Exim recognizes encoded words of any length.
13940
13941
13942 .option check_spool_inodes main integer 0
13943 See &%check_spool_space%& below.
13944
13945
13946 .option check_spool_space main integer 0
13947 .cindex "checking disk space"
13948 .cindex "disk space, checking"
13949 .cindex "spool directory" "checking space"
13950 The four &%check_...%& options allow for checking of disk resources before a
13951 message is accepted.
13952
13953 .vindex "&$log_inodes$&"
13954 .vindex "&$log_space$&"
13955 .vindex "&$spool_inodes$&"
13956 .vindex "&$spool_space$&"
13957 When any of these options are set, they apply to all incoming messages. If you
13958 want to apply different checks to different kinds of message, you can do so by
13959 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13960 &$spool_space$& in an ACL with appropriate additional conditions.
13961
13962
13963 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13964 either value is greater than zero, for example:
13965 .code
13966 check_spool_space = 10M
13967 check_spool_inodes = 100
13968 .endd
13969 The spool partition is the one that contains the directory defined by
13970 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13971 transit.
13972
13973 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13974 files are written if either is greater than zero. These should be set only if
13975 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13976
13977 If there is less space or fewer inodes than requested, Exim refuses to accept
13978 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13979 error response to the MAIL command. If ESMTP is in use and there was a
13980 SIZE parameter on the MAIL command, its value is added to the
13981 &%check_spool_space%& value, and the check is performed even if
13982 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13983
13984 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13985 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13986
13987 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13988 failure a message is written to stderr and Exim exits with a non-zero code, as
13989 it obviously cannot send an error message of any kind.
13990
13991 .option daemon_smtp_ports main string &`smtp`&
13992 .cindex "port" "for daemon"
13993 .cindex "TCP/IP" "setting listening ports"
13994 This option specifies one or more default SMTP ports on which the Exim daemon
13995 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13996 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13997
13998 .option daemon_startup_retries main integer 9
13999 .cindex "daemon startup, retrying"
14000 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14001 the daemon at startup when it cannot immediately bind a listening socket
14002 (typically because the socket is already in use): &%daemon_startup_retries%&
14003 defines the number of retries after the first failure, and
14004 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14005
14006 .option daemon_startup_sleep main time 30s
14007 See &%daemon_startup_retries%&.
14008
14009 .option delay_warning main "time list" 24h
14010 .cindex "warning of delay"
14011 .cindex "delay warning, specifying"
14012 When a message is delayed, Exim sends a warning message to the sender at
14013 intervals specified by this option. The data is a colon-separated list of times
14014 after which to send warning messages. If the value of the option is an empty
14015 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14016 message has been on the queue for longer than the last time, the last interval
14017 between the times is used to compute subsequent warning times. For example,
14018 with
14019 .code
14020 delay_warning = 4h:8h:24h
14021 .endd
14022 the first message is sent after 4 hours, the second after 8 hours, and
14023 the third one after 24 hours. After that, messages are sent every 16 hours,
14024 because that is the interval between the last two times on the list. If you set
14025 just one time, it specifies the repeat interval. For example, with:
14026 .code
14027 delay_warning = 6h
14028 .endd
14029 messages are repeated every six hours. To stop warnings after a given time, set
14030 a very large time at the end of the list. For example:
14031 .code
14032 delay_warning = 2h:12h:99d
14033 .endd
14034 Note that the option is only evaluated at the time a delivery attempt fails,
14035 which depends on retry and queue-runner configuration.
14036 Typically retries will be configured more frequently than warning messages.
14037
14038 .option delay_warning_condition main string&!! "see below"
14039 .vindex "&$domain$&"
14040 The string is expanded at the time a warning message might be sent. If all the
14041 deferred addresses have the same domain, it is set in &$domain$& during the
14042 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14043 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14044 &"false"& (the comparison being done caselessly) then the warning message is
14045 not sent. The default is:
14046 .code
14047 delay_warning_condition = ${if or {\
14048   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14049   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14050   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14051   } {no}{yes}}
14052 .endd
14053 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14054 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14055 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14056 &"auto-replied"& in an &'Auto-Submitted:'& header.
14057
14058 .option deliver_drop_privilege main boolean false
14059 .cindex "unprivileged delivery"
14060 .cindex "delivery" "unprivileged"
14061 If this option is set true, Exim drops its root privilege at the start of a
14062 delivery process, and runs as the Exim user throughout. This severely restricts
14063 the kinds of local delivery that are possible, but is viable in certain types
14064 of configuration. There is a discussion about the use of root privilege in
14065 chapter &<<CHAPsecurity>>&.
14066
14067 .option deliver_queue_load_max main fixed-point unset
14068 .cindex "load average"
14069 .cindex "queue runner" "abandoning"
14070 When this option is set, a queue run is abandoned if the system load average
14071 becomes greater than the value of the option. The option has no effect on
14072 ancient operating systems on which Exim cannot determine the load average.
14073 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14074
14075
14076 .option delivery_date_remove main boolean true
14077 .cindex "&'Delivery-date:'& header line"
14078 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14079 message when it is delivered, in exactly the same way as &'Return-path:'& is
14080 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14081 should not be present in incoming messages, and this option causes them to be
14082 removed at the time the message is received, to avoid any problems that might
14083 occur when a delivered message is subsequently sent on to some other recipient.
14084
14085 .option disable_fsync main boolean false
14086 .cindex "&[fsync()]&, disabling"
14087 This option is available only if Exim was built with the compile-time option
14088 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14089 a runtime configuration generates an &"unknown option"& error. You should not
14090 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14091 really, really, really understand what you are doing. &'No pre-compiled
14092 distributions of Exim should ever make this option available.'&
14093
14094 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14095 updated files' data to be written to disc before continuing. Unexpected events
14096 such as crashes and power outages may cause data to be lost or scrambled.
14097 Here be Dragons. &*Beware.*&
14098
14099
14100 .option disable_ipv6 main boolean false
14101 .cindex "IPv6" "disabling"
14102 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14103 activities take place. AAAA records are never looked up, and any IPv6 addresses
14104 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14105 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14106 to handle IPv6 literal addresses.
14107
14108
14109 .option dns_again_means_nonexist main "domain list&!!" unset
14110 .cindex "DNS" "&""try again""& response; overriding"
14111 DNS lookups give a &"try again"& response for the DNS errors
14112 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14113 keep trying to deliver a message, or to give repeated temporary errors to
14114 incoming mail. Sometimes the effect is caused by a badly set up name server and
14115 may persist for a long time. If a domain which exhibits this problem matches
14116 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14117 This option should be used with care. You can make it apply to reverse lookups
14118 by a setting such as this:
14119 .code
14120 dns_again_means_nonexist = *.in-addr.arpa
14121 .endd
14122 This option applies to all DNS lookups that Exim does. It also applies when the
14123 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14124 since these are most likely to be caused by DNS lookup problems. The
14125 &(dnslookup)& router has some options of its own for controlling what happens
14126 when lookups for MX or SRV records give temporary errors. These more specific
14127 options are applied after this global option.
14128
14129 .option dns_check_names_pattern main string "see below"
14130 .cindex "DNS" "pre-check of name syntax"
14131 When this option is set to a non-empty string, it causes Exim to check domain
14132 names for characters that are not allowed in host names before handing them to
14133 the DNS resolver, because some resolvers give temporary errors for names that
14134 contain unusual characters. If a domain name contains any unwanted characters,
14135 a &"not found"& result is forced, and the resolver is not called. The check is
14136 done by matching the domain name against a regular expression, which is the
14137 value of this option. The default pattern is
14138 .code
14139 dns_check_names_pattern = \
14140   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14141 .endd
14142 which permits only letters, digits, slashes, and hyphens in components, but
14143 they must start and end with a letter or digit. Slashes are not, in fact,
14144 permitted in host names, but they are found in certain NS records (which can be
14145 accessed in Exim by using a &%dnsdb%& lookup). If you set
14146 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14147 empty string.
14148
14149 .option dns_csa_search_limit main integer 5
14150 This option controls the depth of parental searching for CSA SRV records in the
14151 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14152
14153 .option dns_csa_use_reverse main boolean true
14154 This option controls whether or not an IP address, given as a CSA domain, is
14155 reversed and looked up in the reverse DNS, as described in more detail in
14156 section &<<SECTverifyCSA>>&.
14157
14158
14159 .option dns_dnssec_ok main integer -1
14160 .cindex "DNS" "resolver options"
14161 .cindex "DNS" "DNSSEC"
14162 If this option is set to a non-negative number then Exim will initialise the
14163 DNS resolver library to either use or not use DNSSEC, overriding the system
14164 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14165
14166 If the resolver library does not support DNSSEC then this option has no effect.
14167
14168
14169 .option dns_ipv4_lookup main "domain list&!!" unset
14170 .cindex "IPv6" "DNS lookup for AAAA records"
14171 .cindex "DNS" "IPv6 lookup for AAAA records"
14172 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14173 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14174 (A records) when trying to find IP addresses for hosts, unless the host's
14175 domain matches this list.
14176
14177 This is a fudge to help with name servers that give big delays or otherwise do
14178 not work for the AAAA record type. In due course, when the world's name
14179 servers have all been upgraded, there should be no need for this option.
14180
14181
14182 .option dns_retrans main time 0s
14183 .cindex "DNS" "resolver options"
14184 .cindex timeout "dns lookup"
14185 .cindex "DNS" timeout
14186 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14187 retransmission and retry parameters for DNS lookups. Values of zero (the
14188 defaults) leave the system default settings unchanged. The first value is the
14189 time between retries, and the second is the number of retries. It isn't
14190 totally clear exactly how these settings affect the total time a DNS lookup may
14191 take. I haven't found any documentation about timeouts on DNS lookups; these
14192 parameter values are available in the external resolver interface structure,
14193 but nowhere does it seem to describe how they are used or what you might want
14194 to set in them.
14195 See also the &%slow_lookup_log%& option.
14196
14197
14198 .option dns_retry main integer 0
14199 See &%dns_retrans%& above.
14200
14201
14202 .option dns_use_edns0 main integer -1
14203 .cindex "DNS" "resolver options"
14204 .cindex "DNS" "EDNS0"
14205 If this option is set to a non-negative number then Exim will initialise the
14206 DNS resolver library to either use or not use EDNS0 extensions, overriding
14207 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14208 on.
14209
14210 If the resolver library does not support EDNS0 then this option has no effect.
14211
14212
14213 .option drop_cr main boolean false
14214 This is an obsolete option that is now a no-op. It used to affect the way Exim
14215 handled CR and LF characters in incoming messages. What happens now is
14216 described in section &<<SECTlineendings>>&.
14217
14218 .new
14219 .option dsn_advertise_hosts main "host list&!!" unset
14220 .cindex "bounce messages" "success"
14221 .cindex "DSN" "success"
14222 .cindex "Delivery Status Notification" "success"
14223 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14224 and accepted from, these hosts.
14225 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14226 and RET and ORCPT options on MAIL FROM commands.
14227 A NOTIFY=SUCCESS option requests success-DSN messages.
14228 A NOTIFY= option with no argument requests that no delay or failure DSNs
14229 are sent.
14230 .wen
14231
14232 .option dsn_from main "string&!!" "see below"
14233 .cindex "&'From:'& header line" "in bounces"
14234 .cindex "bounce messages" "&'From:'& line, specifying"
14235 This option can be used to vary the contents of &'From:'& header lines in
14236 bounces and other automatically generated messages (&"Delivery Status
14237 Notifications"& &-- hence the name of the option). The default setting is:
14238 .code
14239 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14240 .endd
14241 The value is expanded every time it is needed. If the expansion fails, a
14242 panic is logged, and the default value is used.
14243
14244 .option envelope_to_remove main boolean true
14245 .cindex "&'Envelope-to:'& header line"
14246 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14247 message when it is delivered, in exactly the same way as &'Return-path:'& is
14248 handled. &'Envelope-to:'& records the original recipient address from the
14249 messages's envelope that caused the delivery to happen. Such headers should not
14250 be present in incoming messages, and this option causes them to be removed at
14251 the time the message is received, to avoid any problems that might occur when a
14252 delivered message is subsequently sent on to some other recipient.
14253
14254
14255 .option errors_copy main "string list&!!" unset
14256 .cindex "bounce message" "copy to other address"
14257 .cindex "copy of bounce message"
14258 Setting this option causes Exim to send bcc copies of bounce messages that it
14259 generates to other addresses. &*Note*&: This does not apply to bounce messages
14260 coming from elsewhere. The value of the option is a colon-separated list of
14261 items. Each item consists of a pattern, terminated by white space, followed by
14262 a comma-separated list of email addresses. If a pattern contains spaces, it
14263 must be enclosed in double quotes.
14264
14265 Each pattern is processed in the same way as a single item in an address list
14266 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14267 the bounce message, the message is copied to the addresses on the list. The
14268 items are scanned in order, and once a matching one is found, no further items
14269 are examined. For example:
14270 .code
14271 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14272               rqps@mydomain   hostmaster@mydomain.example,\
14273                               postmaster@mydomain.example
14274 .endd
14275 .vindex "&$domain$&"
14276 .vindex "&$local_part$&"
14277 The address list is expanded before use. The expansion variables &$local_part$&
14278 and &$domain$& are set from the original recipient of the error message, and if
14279 there was any wildcard matching in the pattern, the expansion
14280 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14281 variables &$0$&, &$1$&, etc. are set in the normal way.
14282
14283
14284 .option errors_reply_to main string unset
14285 .cindex "bounce message" "&'Reply-to:'& in"
14286 By default, Exim's bounce and delivery warning messages contain the header line
14287 .display
14288 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14289 .endd
14290 .oindex &%quota_warn_message%&
14291 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14292 A warning message that is generated by the &%quota_warn_message%& option in an
14293 &(appendfile)& transport may contain its own &'From:'& header line that
14294 overrides the default.
14295
14296 Experience shows that people reply to bounce messages. If the
14297 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14298 and warning messages. For example:
14299 .code
14300 errors_reply_to = postmaster@my.domain.example
14301 .endd
14302 The value of the option is not expanded. It must specify a valid RFC 2822
14303 address. However, if a warning message that is generated by the
14304 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14305 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14306 not used.
14307
14308
14309 .option exim_group main string "compile-time configured"
14310 .cindex "gid (group id)" "Exim's own"
14311 .cindex "Exim group"
14312 This option changes the gid under which Exim runs when it gives up root
14313 privilege. The default value is compiled into the binary. The value of this
14314 option is used only when &%exim_user%& is also set. Unless it consists entirely
14315 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14316 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14317 security issues.
14318
14319
14320 .option exim_path main string "see below"
14321 .cindex "Exim binary, path name"
14322 This option specifies the path name of the Exim binary, which is used when Exim
14323 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14324 the directory configured at compile time by the BIN_DIRECTORY setting. It
14325 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14326 other place.
14327 &*Warning*&: Do not use a macro to define the value of this option, because
14328 you will break those Exim utilities that scan the configuration file to find
14329 where the binary is. (They then use the &%-bP%& option to extract option
14330 settings such as the value of &%spool_directory%&.)
14331
14332
14333 .option exim_user main string "compile-time configured"
14334 .cindex "uid (user id)" "Exim's own"
14335 .cindex "Exim user"
14336 This option changes the uid under which Exim runs when it gives up root
14337 privilege. The default value is compiled into the binary. Ownership of the run
14338 time configuration file and the use of the &%-C%& and &%-D%& command line
14339 options is checked against the values in the binary, not what is set here.
14340
14341 Unless it consists entirely of digits, the string is looked up using
14342 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14343 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14344 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14345
14346
14347 .option extra_local_interfaces main "string list" unset
14348 This option defines network interfaces that are to be considered local when
14349 routing, but which are not used for listening by the daemon. See section
14350 &<<SECTreclocipadd>>& for details.
14351
14352
14353 . Allow this long option name to split; give it unsplit as a fifth argument
14354 . for the automatic .oindex that is generated by .option.
14355
14356 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14357          extract_addresses_remove_arguments
14358 .oindex "&%-t%&"
14359 .cindex "command line" "addresses with &%-t%&"
14360 .cindex "Sendmail compatibility" "&%-t%& option"
14361 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14362 are present on the command line when the &%-t%& option is used to build an
14363 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14364 line addresses are removed from the recipients list. This is also how Smail
14365 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14366 command line addresses are added to those obtained from the header lines. When
14367 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14368 argument headers. If it is set false, Exim adds rather than removes argument
14369 addresses.
14370
14371
14372 .option finduser_retries main integer 0
14373 .cindex "NIS, retrying user lookups"
14374 On systems running NIS or other schemes in which user and group information is
14375 distributed from a remote system, there can be times when &[getpwnam()]& and
14376 related functions fail, even when given valid data, because things time out.
14377 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14378 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14379 many extra times to find a user or a group, waiting for one second between
14380 retries.
14381
14382 .cindex "&_/etc/passwd_&" "multiple reading of"
14383 You should not set this option greater than zero if your user information is in
14384 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14385 search the file multiple times for non-existent users, and also cause delay.
14386
14387
14388
14389 .option freeze_tell main "string list, comma separated" unset
14390 .cindex "freezing messages" "sending a message when freezing"
14391 On encountering certain errors, or when configured to do so in a system filter,
14392 ACL, or special router, Exim freezes a message. This means that no further
14393 delivery attempts take place until an administrator thaws the message, or the
14394 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14395 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14396 warning message whenever it freezes something, unless the message it is
14397 freezing is a locally-generated bounce message. (Without this exception there
14398 is the possibility of looping.) The warning message is sent to the addresses
14399 supplied as the comma-separated value of this option. If several of the
14400 message's addresses cause freezing, only a single message is sent. If the
14401 freezing was automatic, the reason(s) for freezing can be found in the message
14402 log. If you configure freezing in a filter or ACL, you must arrange for any
14403 logging that you require.
14404
14405
14406 .option gecos_name main string&!! unset
14407 .cindex "HP-UX"
14408 .cindex "&""gecos""& field, parsing"
14409 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14410 password file to hold other information in addition to users' real names. Exim
14411 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14412 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14413 of the field are used unchanged, except that, if an ampersand is encountered,
14414 it is replaced by the user's login name with the first character forced to
14415 upper case, since this is a convention that is observed on many systems.
14416
14417 When these options are set, &%gecos_pattern%& is treated as a regular
14418 expression that is to be applied to the field (again with && replaced by the
14419 login name), and if it matches, &%gecos_name%& is expanded and used as the
14420 user's name.
14421
14422 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14423 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14424 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14425 name terminates at the first comma, the following can be used:
14426 .code
14427 gecos_pattern = ([^,]*)
14428 gecos_name = $1
14429 .endd
14430
14431 .option gecos_pattern main string unset
14432 See &%gecos_name%& above.
14433
14434
14435 .option gnutls_compat_mode main boolean unset
14436 This option controls whether GnuTLS is used in compatibility mode in an Exim
14437 server. This reduces security slightly, but improves interworking with older
14438 implementations of TLS.
14439
14440
14441 option gnutls_allow_auto_pkcs11 main boolean unset
14442 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14443 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14444
14445 See
14446 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14447 for documentation.
14448
14449
14450
14451 .option headers_charset main string "see below"
14452 This option sets a default character set for translating from encoded MIME
14453 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14454 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14455 ultimate default is ISO-8859-1. For more details see the description of header
14456 insertions in section &<<SECTexpansionitems>>&.
14457
14458
14459
14460 .option header_maxsize main integer "see below"
14461 .cindex "header section" "maximum size of"
14462 .cindex "limit" "size of message header section"
14463 This option controls the overall maximum size of a message's header
14464 section. The default is the value of HEADER_MAXSIZE in
14465 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14466 sections are rejected.
14467
14468
14469 .option header_line_maxsize main integer 0
14470 .cindex "header lines" "maximum size of"
14471 .cindex "limit" "size of one header line"
14472 This option limits the length of any individual header line in a message, after
14473 all the continuations have been joined together. Messages with individual
14474 header lines that are longer than the limit are rejected. The default value of
14475 zero means &"no limit"&.
14476
14477
14478
14479
14480 .option helo_accept_junk_hosts main "host list&!!" unset
14481 .cindex "HELO" "accepting junk data"
14482 .cindex "EHLO" "accepting junk data"
14483 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14484 mail, and gives an error response for invalid data. Unfortunately, there are
14485 some SMTP clients that send syntactic junk. They can be accommodated by setting
14486 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14487 if you want to do semantic checking.
14488 See also &%helo_allow_chars%& for a way of extending the permitted character
14489 set.
14490
14491
14492 .option helo_allow_chars main string unset
14493 .cindex "HELO" "underscores in"
14494 .cindex "EHLO" "underscores in"
14495 .cindex "underscore in EHLO/HELO"
14496 This option can be set to a string of rogue characters that are permitted in
14497 all EHLO and HELO names in addition to the standard letters, digits,
14498 hyphens, and dots. If you really must allow underscores, you can set
14499 .code
14500 helo_allow_chars = _
14501 .endd
14502 Note that the value is one string, not a list.
14503
14504
14505 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14506 .cindex "HELO" "forcing reverse lookup"
14507 .cindex "EHLO" "forcing reverse lookup"
14508 If the domain given by a client in a HELO or EHLO command matches this
14509 list, a reverse lookup is done in order to establish the host's true name. The
14510 default forces a lookup if the client host gives the server's name or any of
14511 its IP addresses (in brackets), something that broken clients have been seen to
14512 do.
14513
14514
14515 .option helo_try_verify_hosts main "host list&!!" unset
14516 .cindex "HELO verifying" "optional"
14517 .cindex "EHLO" "verifying, optional"
14518 By default, Exim just checks the syntax of HELO and EHLO commands (see
14519 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14520 to do more extensive checking of the data supplied by these commands. The ACL
14521 condition &`verify = helo`& is provided to make this possible.
14522 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14523 to force the check to occur. From release 4.53 onwards, this is no longer
14524 necessary. If the check has not been done before &`verify = helo`& is
14525 encountered, it is done at that time. Consequently, this option is obsolete.
14526 Its specification is retained here for backwards compatibility.
14527
14528 When an EHLO or HELO command is received, if the calling host matches
14529 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14530 EHLO command either:
14531
14532 .ilist
14533 is an IP literal matching the calling address of the host, or
14534 .next
14535 .cindex "DNS" "reverse lookup"
14536 .cindex "reverse DNS lookup"
14537 matches the host name that Exim obtains by doing a reverse lookup of the
14538 calling host address, or
14539 .next
14540 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14541 available) yields the calling host address.
14542 .endlist
14543
14544 However, the EHLO or HELO command is not rejected if any of the checks
14545 fail. Processing continues, but the result of the check is remembered, and can
14546 be detected later in an ACL by the &`verify = helo`& condition.
14547
14548 .option helo_verify_hosts main "host list&!!" unset
14549 .cindex "HELO verifying" "mandatory"
14550 .cindex "EHLO" "verifying, mandatory"
14551 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14552 backwards compatibility. For hosts that match this option, Exim checks the host
14553 name given in the HELO or EHLO in the same way as for
14554 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14555 rejected with a 550 error, and entries are written to the main and reject logs.
14556 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14557 error.
14558
14559 .option hold_domains main "domain list&!!" unset
14560 .cindex "domain" "delaying delivery"
14561 .cindex "delivery" "delaying certain domains"
14562 This option allows mail for particular domains to be held on the queue
14563 manually. The option is overridden if a message delivery is forced with the
14564 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14565 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14566 item in &%hold_domains%&, no routing or delivery for that address is done, and
14567 it is deferred every time the message is looked at.
14568
14569 This option is intended as a temporary operational measure for delaying the
14570 delivery of mail while some problem is being sorted out, or some new
14571 configuration tested. If you just want to delay the processing of some
14572 domains until a queue run occurs, you should use &%queue_domains%& or
14573 &%queue_smtp_domains%&, not &%hold_domains%&.
14574
14575 A setting of &%hold_domains%& does not override Exim's code for removing
14576 messages from the queue if they have been there longer than the longest retry
14577 time in any retry rule. If you want to hold messages for longer than the normal
14578 retry times, insert a dummy retry rule with a long retry time.
14579
14580
14581 .option host_lookup main "host list&!!" unset
14582 .cindex "host name" "lookup, forcing"
14583 Exim does not look up the name of a calling host from its IP address unless it
14584 is required to compare against some host list, or the host matches
14585 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14586 option (which normally contains IP addresses rather than host names). The
14587 default configuration file contains
14588 .code
14589 host_lookup = *
14590 .endd
14591 which causes a lookup to happen for all hosts. If the expense of these lookups
14592 is felt to be too great, the setting can be changed or removed.
14593
14594 After a successful reverse lookup, Exim does a forward lookup on the name it
14595 has obtained, to verify that it yields the IP address that it started with. If
14596 this check fails, Exim behaves as if the name lookup failed.
14597
14598 .vindex "&$host_lookup_failed$&"
14599 .vindex "&$sender_host_name$&"
14600 After any kind of failure, the host name (in &$sender_host_name$&) remains
14601 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14602 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14603 &`verify = reverse_host_lookup`& in ACLs.
14604
14605
14606 .option host_lookup_order main "string list" &`bydns:byaddr`&
14607 This option specifies the order of different lookup methods when Exim is trying
14608 to find a host name from an IP address. The default is to do a DNS lookup
14609 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14610 if that fails. You can change the order of these lookups, or omit one entirely,
14611 if you want.
14612
14613 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14614 multiple PTR records in the DNS and the IP address is not listed in
14615 &_/etc/hosts_&. Different operating systems give different results in this
14616 case. That is why the default tries a DNS lookup first.
14617
14618
14619
14620 .option host_reject_connection main "host list&!!" unset
14621 .cindex "host" "rejecting connections from"
14622 If this option is set, incoming SMTP calls from the hosts listed are rejected
14623 as soon as the connection is made.
14624 This option is obsolete, and retained only for backward compatibility, because
14625 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14626 connections immediately.
14627
14628 The ability to give an immediate rejection (either by this option or using an
14629 ACL) is provided for use in unusual cases. Many hosts will just try again,
14630 sometimes without much delay. Normally, it is better to use an ACL to reject
14631 incoming messages at a later stage, such as after RCPT commands. See
14632 chapter &<<CHAPACL>>&.
14633
14634
14635 .option hosts_connection_nolog main "host list&!!" unset
14636 .cindex "host" "not logging connections from"
14637 This option defines a list of hosts for which connection logging does not
14638 happen, even though the &%smtp_connection%& log selector is set. For example,
14639 you might want not to log SMTP connections from local processes, or from
14640 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14641 the daemon; you should therefore strive to restrict its value to a short inline
14642 list of IP addresses and networks. To disable logging SMTP connections from
14643 local processes, you must create a host list with an empty item. For example:
14644 .code
14645 hosts_connection_nolog = :
14646 .endd
14647 If the &%smtp_connection%& log selector is not set, this option has no effect.
14648
14649
14650
14651 .option hosts_treat_as_local main "domain list&!!" unset
14652 .cindex "local host" "domains treated as"
14653 .cindex "host" "treated as local"
14654 If this option is set, any host names that match the domain list are treated as
14655 if they were the local host when Exim is scanning host lists obtained from MX
14656 records
14657 or other sources. Note that the value of this option is a domain list, not a
14658 host list, because it is always used to check host names, not IP addresses.
14659
14660 This option also applies when Exim is matching the special items
14661 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14662 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14663 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14664 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14665 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14666 interfaces and recognizing the local host.
14667
14668
14669 .option ibase_servers main "string list" unset
14670 .cindex "InterBase" "server list"
14671 This option provides a list of InterBase servers and associated connection data,
14672 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14673 The option is available only if Exim has been built with InterBase support.
14674
14675
14676
14677 .option ignore_bounce_errors_after main time 10w
14678 .cindex "bounce message" "discarding"
14679 .cindex "discarding bounce message"
14680 This option affects the processing of bounce messages that cannot be delivered,
14681 that is, those that suffer a permanent delivery failure. (Bounce messages that
14682 suffer temporary delivery failures are of course retried in the usual way.)
14683
14684 After a permanent delivery failure, bounce messages are frozen,
14685 because there is no sender to whom they can be returned. When a frozen bounce
14686 message has been on the queue for more than the given time, it is unfrozen at
14687 the next queue run, and a further delivery is attempted. If delivery fails
14688 again, the bounce message is discarded. This makes it possible to keep failed
14689 bounce messages around for a shorter time than the normal maximum retry time
14690 for frozen messages. For example,
14691 .code
14692 ignore_bounce_errors_after = 12h
14693 .endd
14694 retries failed bounce message deliveries after 12 hours, discarding any further
14695 failures. If the value of this option is set to a zero time period, bounce
14696 failures are discarded immediately. Setting a very long time (as in the default
14697 value) has the effect of disabling this option. For ways of automatically
14698 dealing with other kinds of frozen message, see &%auto_thaw%& and
14699 &%timeout_frozen_after%&.
14700
14701
14702 .option ignore_fromline_hosts main "host list&!!" unset
14703 .cindex "&""From""& line"
14704 .cindex "UUCP" "&""From""& line"
14705 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14706 the headers of a message. By default this is treated as the start of the
14707 message's body, which means that any following headers are not recognized as
14708 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14709 match those hosts that insist on sending it. If the sender is actually a local
14710 process rather than a remote host, and is using &%-bs%& to inject the messages,
14711 &%ignore_fromline_local%& must be set to achieve this effect.
14712
14713
14714 .option ignore_fromline_local main boolean false
14715 See &%ignore_fromline_hosts%& above.
14716
14717
14718 .option keep_malformed main time 4d
14719 This option specifies the length of time to keep messages whose spool files
14720 have been corrupted in some way. This should, of course, never happen. At the
14721 next attempt to deliver such a message, it gets removed. The incident is
14722 logged.
14723
14724
14725 .option ldap_ca_cert_dir main string unset
14726 .cindex "LDAP", "TLS CA certificate directory"
14727 This option indicates which directory contains CA certificates for verifying
14728 a TLS certificate presented by an LDAP server.
14729 While Exim does not provide a default value, your SSL library may.
14730 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14731 and constrained to be a directory.
14732
14733
14734 .option ldap_ca_cert_file main string unset
14735 .cindex "LDAP", "TLS CA certificate file"
14736 This option indicates which file contains CA certificates for verifying
14737 a TLS certificate presented by an LDAP server.
14738 While Exim does not provide a default value, your SSL library may.
14739 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14740 and constrained to be a file.
14741
14742
14743 .option ldap_cert_file main string unset
14744 .cindex "LDAP" "TLS client certificate file"
14745 This option indicates which file contains an TLS client certificate which
14746 Exim should present to the LDAP server during TLS negotiation.
14747 Should be used together with &%ldap_cert_key%&.
14748
14749
14750 .option ldap_cert_key main string unset
14751 .cindex "LDAP" "TLS client key file"
14752 This option indicates which file contains the secret/private key to use
14753 to prove identity to the LDAP server during TLS negotiation.
14754 Should be used together with &%ldap_cert_file%&, which contains the
14755 identity to be proven.
14756
14757
14758 .option ldap_cipher_suite main string unset
14759 .cindex "LDAP" "TLS cipher suite"
14760 This controls the TLS cipher-suite negotiation during TLS negotiation with
14761 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14762 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14763
14764
14765 .option ldap_default_servers main "string list" unset
14766 .cindex "LDAP" "default servers"
14767 This option provides a list of LDAP servers which are tried in turn when an
14768 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14769 details of LDAP queries. This option is available only when Exim has been built
14770 with LDAP support.
14771
14772
14773 .option ldap_require_cert main string unset.
14774 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14775 This should be one of the values "hard", "demand", "allow", "try" or "never".
14776 A value other than one of these is interpreted as "never".
14777 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14778 Although Exim does not set a default, the LDAP library probably defaults
14779 to hard/demand.
14780
14781
14782 .option ldap_start_tls main boolean false
14783 .cindex "LDAP" "whether or not to negotiate TLS"
14784 If set, Exim will attempt to negotiate TLS with the LDAP server when
14785 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14786 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14787 of SSL-on-connect.
14788 In the event of failure to negotiate TLS, the action taken is controlled
14789 by &%ldap_require_cert%&.
14790
14791
14792 .option ldap_version main integer unset
14793 .cindex "LDAP" "protocol version, forcing"
14794 This option can be used to force Exim to set a specific protocol version for
14795 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14796 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14797 the LDAP headers; otherwise it is 2. This option is available only when Exim
14798 has been built with LDAP support.
14799
14800
14801
14802 .option local_from_check main boolean true
14803 .cindex "&'Sender:'& header line" "disabling addition of"
14804 .cindex "&'From:'& header line" "disabling checking of"
14805 When a message is submitted locally (that is, not over a TCP/IP connection) by
14806 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14807 checks that the &'From:'& header line matches the login of the calling user and
14808 the domain specified by &%qualify_domain%&.
14809
14810 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14811 locally submitted message is automatically qualified by Exim, unless the
14812 &%-bnq%& command line option is used.
14813
14814 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14815 on the local part. If the &'From:'& header line does not match, Exim adds a
14816 &'Sender:'& header with an address constructed from the calling user's login
14817 and the default qualify domain.
14818
14819 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14820 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14821 &'Sender:'& header lines supplied by untrusted users, you must also set
14822 &%local_sender_retain%& to be true.
14823
14824 .cindex "envelope sender"
14825 These options affect only the header lines in the message. The envelope sender
14826 is still forced to be the login id at the qualify domain unless
14827 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14828
14829 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14830 request similar header line checking. See section &<<SECTthesenhea>>&, which
14831 has more details about &'Sender:'& processing.
14832
14833
14834
14835
14836 .option local_from_prefix main string unset
14837 When Exim checks the &'From:'& header line of locally submitted messages for
14838 matching the login id (see &%local_from_check%& above), it can be configured to
14839 ignore certain prefixes and suffixes in the local part of the address. This is
14840 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14841 appropriate lists, in the same form as the &%local_part_prefix%& and
14842 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14843 example, if
14844 .code
14845 local_from_prefix = *-
14846 .endd
14847 is set, a &'From:'& line containing
14848 .code
14849 From: anything-user@your.domain.example
14850 .endd
14851 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14852 matches the actual sender address that is constructed from the login name and
14853 qualify domain.
14854
14855
14856 .option local_from_suffix main string unset
14857 See &%local_from_prefix%& above.
14858
14859
14860 .option local_interfaces main "string list" "see below"
14861 This option controls which network interfaces are used by the daemon for
14862 listening; they are also used to identify the local host when routing. Chapter
14863 &<<CHAPinterfaces>>& contains a full description of this option and the related
14864 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14865 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14866 &%local_interfaces%& is
14867 .code
14868 local_interfaces = 0.0.0.0
14869 .endd
14870 when Exim is built without IPv6 support; otherwise it is
14871 .code
14872 local_interfaces = <; ::0 ; 0.0.0.0
14873 .endd
14874
14875 .option local_scan_timeout main time 5m
14876 .cindex "timeout" "for &[local_scan()]& function"
14877 .cindex "&[local_scan()]& function" "timeout"
14878 This timeout applies to the &[local_scan()]& function (see chapter
14879 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14880 the incoming message is rejected with a temporary error if it is an SMTP
14881 message. For a non-SMTP message, the message is dropped and Exim ends with a
14882 non-zero code. The incident is logged on the main and reject logs.
14883
14884
14885
14886 .option local_sender_retain main boolean false
14887 .cindex "&'Sender:'& header line" "retaining from local submission"
14888 When a message is submitted locally (that is, not over a TCP/IP connection) by
14889 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14890 do not want this to happen, you must set &%local_sender_retain%&, and you must
14891 also set &%local_from_check%& to be false (Exim will complain if you do not).
14892 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14893 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14894
14895
14896
14897
14898 .option localhost_number main string&!! unset
14899 .cindex "host" "locally unique number for"
14900 .cindex "message ids" "with multiple hosts"
14901 .vindex "&$localhost_number$&"
14902 Exim's message ids are normally unique only within the local host. If
14903 uniqueness among a set of hosts is required, each host must set a different
14904 value for the &%localhost_number%& option. The string is expanded immediately
14905 after reading the configuration file (so that a number can be computed from the
14906 host name, for example) and the result of the expansion must be a number in the
14907 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14908 systems). This is available in subsequent string expansions via the variable
14909 &$localhost_number$&. When &%localhost_number is set%&, the final two
14910 characters of the message id, instead of just being a fractional part of the
14911 time, are computed from the time and the local host number as described in
14912 section &<<SECTmessiden>>&.
14913
14914
14915
14916 .option log_file_path main "string list&!!" "set at compile time"
14917 .cindex "log" "file path for"
14918 This option sets the path which is used to determine the names of Exim's log
14919 files, or indicates that logging is to be to syslog, or both. It is expanded
14920 when Exim is entered, so it can, for example, contain a reference to the host
14921 name. If no specific path is set for the log files at compile or run time, they
14922 are written in a sub-directory called &_log_& in Exim's spool directory.
14923 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14924 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14925 used. If this string is fixed at your installation (contains no expansion
14926 variables) it is recommended that you do not set this option in the
14927 configuration file, but instead supply the path using LOG_FILE_PATH in
14928 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14929 early on &-- in particular, failure to read the configuration file.
14930
14931
14932 .option log_selector main string unset
14933 .cindex "log" "selectors"
14934 This option can be used to reduce or increase the number of things that Exim
14935 writes to its log files. Its argument is made up of names preceded by plus or
14936 minus characters. For example:
14937 .code
14938 log_selector = +arguments -retry_defer
14939 .endd
14940 A list of possible names and what they control is given in the chapter on
14941 logging, in section &<<SECTlogselector>>&.
14942
14943
14944 .option log_timezone main boolean false
14945 .cindex "log" "timezone for entries"
14946 .vindex "&$tod_log$&"
14947 .vindex "&$tod_zone$&"
14948 By default, the timestamps on log lines are in local time without the
14949 timezone. This means that if your timezone changes twice a year, the timestamps
14950 in log lines are ambiguous for an hour when the clocks go back. One way of
14951 avoiding this problem is to set the timezone to UTC. An alternative is to set
14952 &%log_timezone%& true. This turns on the addition of the timezone offset to
14953 timestamps in log lines. Turning on this option can add quite a lot to the size
14954 of log files because each line is extended by 6 characters. Note that the
14955 &$tod_log$& variable contains the log timestamp without the zone, but there is
14956 another variable called &$tod_zone$& that contains just the timezone offset.
14957
14958
14959 .option lookup_open_max main integer 25
14960 .cindex "too many open files"
14961 .cindex "open files, too many"
14962 .cindex "file" "too many open"
14963 .cindex "lookup" "maximum open files"
14964 .cindex "limit" "open files for lookups"
14965 This option limits the number of simultaneously open files for single-key
14966 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14967 Exim normally keeps these files open during routing, because often the same
14968 file is required several times. If the limit is reached, Exim closes the least
14969 recently used file. Note that if you are using the &'ndbm'& library, it
14970 actually opens two files for each logical DBM database, though it still counts
14971 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14972 open files"& errors with NDBM, you need to reduce the value of
14973 &%lookup_open_max%&.
14974
14975
14976 .option max_username_length main integer 0
14977 .cindex "length of login name"
14978 .cindex "user name" "maximum length"
14979 .cindex "limit" "user name length"
14980 Some operating systems are broken in that they truncate long arguments to
14981 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14982 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14983 an argument that is longer behaves as if &[getpwnam()]& failed.
14984
14985
14986 .option message_body_newlines main bool false
14987 .cindex "message body" "newlines in variables"
14988 .cindex "newline" "in message body variables"
14989 .vindex "&$message_body$&"
14990 .vindex "&$message_body_end$&"
14991 By default, newlines in the message body are replaced by spaces when setting
14992 the &$message_body$& and &$message_body_end$& expansion variables. If this
14993 option is set true, this no longer happens.
14994
14995
14996 .option message_body_visible main integer 500
14997 .cindex "body of message" "visible size"
14998 .cindex "message body" "visible size"
14999 .vindex "&$message_body$&"
15000 .vindex "&$message_body_end$&"
15001 This option specifies how much of a message's body is to be included in the
15002 &$message_body$& and &$message_body_end$& expansion variables.
15003
15004
15005 .option message_id_header_domain main string&!! unset
15006 .cindex "&'Message-ID:'& header line"
15007 If this option is set, the string is expanded and used as the right hand side
15008 (domain) of the &'Message-ID:'& header that Exim creates if a
15009 locally-originated incoming message does not have one. &"Locally-originated"&
15010 means &"not received over TCP/IP."&
15011 Otherwise, the primary host name is used.
15012 Only letters, digits, dot and hyphen are accepted; any other characters are
15013 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15014 empty string, the option is ignored.
15015
15016
15017 .option message_id_header_text main string&!! unset
15018 If this variable is set, the string is expanded and used to augment the text of
15019 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15020 message does not have one. The text of this header is required by RFC 2822 to
15021 take the form of an address. By default, Exim uses its internal message id as
15022 the local part, and the primary host name as the domain. If this option is set,
15023 it is expanded, and provided the expansion is not forced to fail, and does not
15024 yield an empty string, the result is inserted into the header immediately
15025 before the @, separated from the internal message id by a dot. Any characters
15026 that are illegal in an address are automatically converted into hyphens. This
15027 means that variables such as &$tod_log$& can be used, because the spaces and
15028 colons will become hyphens.
15029
15030
15031 .option message_logs main boolean true
15032 .cindex "message logs" "disabling"
15033 .cindex "log" "message log; disabling"
15034 If this option is turned off, per-message log files are not created in the
15035 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15036 Exim, by reducing the number of files involved in handling a message from a
15037 minimum of four (header spool file, body spool file, delivery journal, and
15038 per-message log) to three. The other major I/O activity is Exim's main log,
15039 which is not affected by this option.
15040
15041
15042 .option message_size_limit main string&!! 50M
15043 .cindex "message" "size limit"
15044 .cindex "limit" "message size"
15045 .cindex "size" "of message, limit"
15046 This option limits the maximum size of message that Exim will process. The
15047 value is expanded for each incoming connection so, for example, it can be made
15048 to depend on the IP address of the remote host for messages arriving via
15049 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15050 optionally followed by K or M.
15051
15052 &*Note*&: This limit cannot be made to depend on a message's sender or any
15053 other properties of an individual message, because it has to be advertised in
15054 the server's response to EHLO. String expansion failure causes a temporary
15055 error. A value of zero means no limit, but its use is not recommended. See also
15056 &%bounce_return_size_limit%&.
15057
15058 Incoming SMTP messages are failed with a 552 error if the limit is
15059 exceeded; locally-generated messages either get a stderr message or a delivery
15060 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15061 an oversized message is logged in both the main and the reject logs. See also
15062 the generic transport option &%message_size_limit%&, which limits the size of
15063 message that an individual transport can process.
15064
15065 If you use a virus-scanner and set this option to to a value larger than the
15066 maximum size that your virus-scanner is configured to support, you may get
15067 failures triggered by large mails.  The right size to configure for the
15068 virus-scanner depends upon what data is passed and the options in use but it's
15069 probably safest to just set it to a little larger than this value.  Eg, with a
15070 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15071 some problems may result.
15072
15073 A value of 0 will disable size limit checking; Exim will still advertise the
15074 SIZE extension in an EHLO response, but without a limit, so as to permit
15075 SMTP clients to still indicate the message size along with the MAIL verb.
15076
15077
15078 .option move_frozen_messages main boolean false
15079 .cindex "frozen messages" "moving"
15080 This option, which is available only if Exim has been built with the setting
15081 .code
15082 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15083 .endd
15084 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15085 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15086 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15087 standard utilities for handling such moved messages, and they do not show up in
15088 lists generated by &%-bp%& or by the Exim monitor.
15089
15090
15091 .option mua_wrapper main boolean false
15092 Setting this option true causes Exim to run in a very restrictive mode in which
15093 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15094 contains a full description of this facility.
15095
15096
15097
15098 .option mysql_servers main "string list" unset
15099 .cindex "MySQL" "server list"
15100 This option provides a list of MySQL servers and associated connection data, to
15101 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15102 option is available only if Exim has been built with MySQL support.
15103
15104
15105 .option never_users main "string list&!!" unset
15106 This option is expanded just once, at the start of Exim's processing. Local
15107 message deliveries are normally run in processes that are setuid to the
15108 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15109 It is usually desirable to prevent any deliveries from running as root, as a
15110 safety precaution.
15111
15112 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15113 list of users that must not be used for local deliveries. This list is fixed in
15114 the binary and cannot be overridden by the configuration file. By default, it
15115 contains just the single user name &"root"&. The &%never_users%& runtime option
15116 can be used to add more users to the fixed list.
15117
15118 If a message is to be delivered as one of the users on the fixed list or the
15119 &%never_users%& list, an error occurs, and delivery is deferred. A common
15120 example is
15121 .code
15122 never_users = root:daemon:bin
15123 .endd
15124 Including root is redundant if it is also on the fixed list, but it does no
15125 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15126 transport driver.
15127
15128
15129 .option openssl_options main "string list" "+no_sslv2"
15130 .cindex "OpenSSL "compatibility options"
15131 This option allows an administrator to adjust the SSL options applied
15132 by OpenSSL to connections.  It is given as a space-separated list of items,
15133 each one to be +added or -subtracted from the current value.
15134
15135 This option is only available if Exim is built against OpenSSL.  The values
15136 available for this option vary according to the age of your OpenSSL install.
15137 The &"all"& value controls a subset of flags which are available, typically
15138 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15139 list the values known on your system and Exim should support all the
15140 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15141 names lose the leading &"SSL_OP_"& and are lower-cased.
15142
15143 Note that adjusting the options can have severe impact upon the security of
15144 SSL as used by Exim.  It is possible to disable safety checks and shoot
15145 yourself in the foot in various unpleasant ways.  This option should not be
15146 adjusted lightly.  An unrecognised item will be detected at startup, by
15147 invoking Exim with the &%-bV%& flag.
15148
15149 The option affects Exim operating both as a server and as a client.
15150
15151 Historical note: prior to release 4.80, Exim defaulted this value to
15152 "+dont_insert_empty_fragments", which may still be needed for compatibility
15153 with some clients, but which lowers security by increasing exposure to
15154 some now infamous attacks.
15155
15156 Examples:
15157 .code
15158 # Make both old MS and old Eudora happy:
15159 openssl_options = -all +microsoft_big_sslv3_buffer \
15160                        +dont_insert_empty_fragments
15161
15162 # Disable older protocol versions:
15163 openssl_options = +no_sslv2 +no_sslv3
15164 .endd
15165
15166 Possible options may include:
15167 .ilist
15168 &`all`&
15169 .next
15170 &`allow_unsafe_legacy_renegotiation`&
15171 .next
15172 &`cipher_server_preference`&
15173 .next
15174 &`dont_insert_empty_fragments`&
15175 .next
15176 &`ephemeral_rsa`&
15177 .next
15178 &`legacy_server_connect`&
15179 .next
15180 &`microsoft_big_sslv3_buffer`&
15181 .next
15182 &`microsoft_sess_id_bug`&
15183 .next
15184 &`msie_sslv2_rsa_padding`&
15185 .next
15186 &`netscape_challenge_bug`&
15187 .next
15188 &`netscape_reuse_cipher_change_bug`&
15189 .next
15190 &`no_compression`&
15191 .next
15192 &`no_session_resumption_on_renegotiation`&
15193 .next
15194 &`no_sslv2`&
15195 .next
15196 &`no_sslv3`&
15197 .next
15198 &`no_ticket`&
15199 .next
15200 &`no_tlsv1`&
15201 .next
15202 &`no_tlsv1_1`&
15203 .next
15204 &`no_tlsv1_2`&
15205 .next
15206 &`safari_ecdhe_ecdsa_bug`&
15207 .next
15208 &`single_dh_use`&
15209 .next
15210 &`single_ecdh_use`&
15211 .next
15212 &`ssleay_080_client_dh_bug`&
15213 .next
15214 &`sslref2_reuse_cert_type_bug`&
15215 .next
15216 &`tls_block_padding_bug`&
15217 .next
15218 &`tls_d5_bug`&
15219 .next
15220 &`tls_rollback_bug`&
15221 .endlist
15222
15223 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15224 all clients connecting using the MacOS SecureTransport TLS facility prior
15225 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15226 to negotiate TLS then this option value might help, provided that your OpenSSL
15227 release is new enough to contain this work-around.  This may be a situation
15228 where you have to upgrade OpenSSL to get buggy clients working.
15229
15230
15231 .option oracle_servers main "string list" unset
15232 .cindex "Oracle" "server list"
15233 This option provides a list of Oracle servers and associated connection data,
15234 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15235 The option is available only if Exim has been built with Oracle support.
15236
15237
15238 .option percent_hack_domains main "domain list&!!" unset
15239 .cindex "&""percent hack""&"
15240 .cindex "source routing" "in email address"
15241 .cindex "address" "source-routed"
15242 The &"percent hack"& is the convention whereby a local part containing a
15243 percent sign is re-interpreted as a new email address, with the percent
15244 replaced by @. This is sometimes called &"source routing"&, though that term is
15245 also applied to RFC 2822 addresses that begin with an @ character. If this
15246 option is set, Exim implements the percent facility for those domains listed,
15247 but no others. This happens before an incoming SMTP address is tested against
15248 an ACL.
15249
15250 &*Warning*&: The &"percent hack"& has often been abused by people who are
15251 trying to get round relaying restrictions. For this reason, it is best avoided
15252 if at all possible. Unfortunately, a number of less security-conscious MTAs
15253 implement it unconditionally. If you are running Exim on a gateway host, and
15254 routing mail through to internal MTAs without processing the local parts, it is
15255 a good idea to reject recipient addresses with percent characters in their
15256 local parts. Exim's default configuration does this.
15257
15258
15259 .option perl_at_start main boolean false
15260 This option is available only when Exim is built with an embedded Perl
15261 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15262
15263
15264 .option perl_startup main string unset
15265 This option is available only when Exim is built with an embedded Perl
15266 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15267
15268
15269 .option pgsql_servers main "string list" unset
15270 .cindex "PostgreSQL lookup type" "server list"
15271 This option provides a list of PostgreSQL servers and associated connection
15272 data, to be used in conjunction with &(pgsql)& lookups (see section
15273 &<<SECID72>>&). The option is available only if Exim has been built with
15274 PostgreSQL support.
15275
15276
15277 .option pid_file_path main string&!! "set at compile time"
15278 .cindex "daemon" "pid file path"
15279 .cindex "pid file, path for"
15280 This option sets the name of the file to which the Exim daemon writes its
15281 process id. The string is expanded, so it can contain, for example, references
15282 to the host name:
15283 .code
15284 pid_file_path = /var/log/$primary_hostname/exim.pid
15285 .endd
15286 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15287 spool directory.
15288 The value set by the option can be overridden by the &%-oP%& command line
15289 option. A pid file is not written if a &"non-standard"& daemon is run by means
15290 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15291
15292
15293 .option pipelining_advertise_hosts main "host list&!!" *
15294 .cindex "PIPELINING" "suppressing advertising"
15295 This option can be used to suppress the advertisement of the SMTP
15296 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15297 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15298 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15299 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15300 that clients will use it; &"out of order"& commands that are &"expected"& do
15301 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15302
15303
15304 .option prdr_enable main boolean false
15305 .cindex "PRDR" "enabling on server"
15306 This option can be used to enable the Per-Recipient Data Response extension
15307 to SMTP, defined by Eric Hall.
15308 If the option is set, PRDR is advertised by Exim when operating as a server.
15309 If the client requests PRDR, and more than one recipient, for a message 
15310 an additional ACL is called for each recipient after the message content
15311 is recieved.  See section &<<SECTPRDRACL>>&.
15312
15313 .option preserve_message_logs main boolean false
15314 .cindex "message logs" "preserving"
15315 If this option is set, message log files are not deleted when messages are
15316 completed. Instead, they are moved to a sub-directory of the spool directory
15317 called &_msglog.OLD_&, where they remain available for statistical or debugging
15318 purposes. This is a dangerous option to set on systems with any appreciable
15319 volume of mail. Use with care!
15320
15321
15322 .option primary_hostname main string "see below"
15323 .cindex "name" "of local host"
15324 .cindex "host" "name of local"
15325 .cindex "local host" "name of"
15326 .vindex "&$primary_hostname$&"
15327 This specifies the name of the current host. It is used in the default EHLO or
15328 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15329 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15330 The value is also used by default in some SMTP response messages from an Exim
15331 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15332
15333 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15334 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15335 contains only one component, Exim passes it to &[gethostbyname()]& (or
15336 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15337 version. The variable &$primary_hostname$& contains the host name, whether set
15338 explicitly by this option, or defaulted.
15339
15340
15341 .option print_topbitchars main boolean false
15342 .cindex "printing characters"
15343 .cindex "8-bit characters"
15344 By default, Exim considers only those characters whose codes lie in the range
15345 32&--126 to be printing characters. In a number of circumstances (for example,
15346 when writing log entries) non-printing characters are converted into escape
15347 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15348 is set, code values of 128 and above are also considered to be printing
15349 characters.
15350
15351 This option also affects the header syntax checks performed by the
15352 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15353 the user's full name when constructing From: and Sender: addresses (as
15354 described in section &<<SECTconstr>>&). Setting this option can cause
15355 Exim to generate eight bit message headers that do not conform to the
15356 standards.
15357
15358
15359 .option process_log_path main string unset
15360 .cindex "process log path"
15361 .cindex "log" "process log"
15362 .cindex "&'exiwhat'&"
15363 This option sets the name of the file to which an Exim process writes its
15364 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15365 utility script. If this option is unset, the file called &_exim-process.info_&
15366 in Exim's spool directory is used. The ability to specify the name explicitly
15367 can be useful in environments where two different Exims are running, using
15368 different spool directories.
15369
15370
15371 .option prod_requires_admin main boolean true
15372 .oindex "&%-M%&"
15373 .oindex "&%-R%&"
15374 .oindex "&%-q%&"
15375 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15376 admin user unless &%prod_requires_admin%& is set false. See also
15377 &%queue_list_requires_admin%&.
15378
15379
15380 .option qualify_domain main string "see below"
15381 .cindex "domain" "for qualifying addresses"
15382 .cindex "address" "qualification"
15383 This option specifies the domain name that is added to any envelope sender
15384 addresses that do not have a domain qualification. It also applies to
15385 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15386 are accepted by default only for locally-generated messages. Qualification is
15387 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15388 locally-generated messages, unless the &%-bnq%& command line option is used.
15389
15390 Messages from external sources must always contain fully qualified addresses,
15391 unless the sending host matches &%sender_unqualified_hosts%& or
15392 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15393 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15394 necessary. Internally, Exim always works with fully qualified envelope
15395 addresses. If &%qualify_domain%& is not set, it defaults to the
15396 &%primary_hostname%& value.
15397
15398
15399 .option qualify_recipient main string "see below"
15400 This option allows you to specify a different domain for qualifying recipient
15401 addresses to the one that is used for senders. See &%qualify_domain%& above.
15402
15403
15404
15405 .option queue_domains main "domain list&!!" unset
15406 .cindex "domain" "specifying non-immediate delivery"
15407 .cindex "queueing incoming messages"
15408 .cindex "message" "queueing certain domains"
15409 This option lists domains for which immediate delivery is not required.
15410 A delivery process is started whenever a message is received, but only those
15411 domains that do not match are processed. All other deliveries wait until the
15412 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15413
15414
15415 .option queue_list_requires_admin main boolean true
15416 .oindex "&%-bp%&"
15417 The &%-bp%& command-line option, which lists the messages that are on the
15418 queue, requires the caller to be an admin user unless
15419 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15420
15421
15422 .option queue_only main boolean false
15423 .cindex "queueing incoming messages"
15424 .cindex "message" "queueing unconditionally"
15425 If &%queue_only%& is set, a delivery process is not automatically started
15426 whenever a message is received. Instead, the message waits on the queue for the
15427 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15428 delivered immediately when certain conditions (such as heavy load) occur.
15429
15430 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15431 and &%-odi%& command line options override &%queue_only%& unless
15432 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15433 &%queue_only_load%&, and &%smtp_accept_queue%&.
15434
15435
15436 .option queue_only_file main string unset
15437 .cindex "queueing incoming messages"
15438 .cindex "message" "queueing by file existence"
15439 This option can be set to a colon-separated list of absolute path names, each
15440 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15441 it tests for the existence of each listed path using a call to &[stat()]&. For
15442 each path that exists, the corresponding queueing option is set.
15443 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15444 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15445 .code
15446 queue_only_file = smtp/some/file
15447 .endd
15448 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15449 &_/some/file_& exists.
15450
15451
15452 .option queue_only_load main fixed-point unset
15453 .cindex "load average"
15454 .cindex "queueing incoming messages"
15455 .cindex "message" "queueing by load"
15456 If the system load average is higher than this value, incoming messages from
15457 all sources are queued, and no automatic deliveries are started. If this
15458 happens during local or remote SMTP input, all subsequent messages received on
15459 the same SMTP connection are queued by default, whatever happens to the load in
15460 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15461 false.
15462
15463 Deliveries will subsequently be performed by queue runner processes. This
15464 option has no effect on ancient operating systems on which Exim cannot
15465 determine the load average. See also &%deliver_queue_load_max%& and
15466 &%smtp_load_reserve%&.
15467
15468
15469 .option queue_only_load_latch main boolean true
15470 .cindex "load average" "re-evaluating per message"
15471 When this option is true (the default), once one message has been queued
15472 because the load average is higher than the value set by &%queue_only_load%&,
15473 all subsequent messages received on the same SMTP connection are also queued.
15474 This is a deliberate choice; even though the load average may fall below the
15475 threshold, it doesn't seem right to deliver later messages on the same
15476 connection when not delivering earlier ones. However, there are special
15477 circumstances such as very long-lived connections from scanning appliances
15478 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15479 should be set false. This causes the value of the load average to be
15480 re-evaluated for each message.
15481
15482
15483 .option queue_only_override main boolean true
15484 .cindex "queueing incoming messages"
15485 When this option is true, the &%-od%&&'x'& command line options override the
15486 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15487 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15488 to override; they are accepted, but ignored.
15489
15490
15491 .option queue_run_in_order main boolean false
15492 .cindex "queue runner" "processing messages in order"
15493 If this option is set, queue runs happen in order of message arrival instead of
15494 in an arbitrary order. For this to happen, a complete list of the entire queue
15495 must be set up before the deliveries start. When the queue is all held in a
15496 single directory (the default), a single list is created for both the ordered
15497 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15498 single list is not created when &%queue_run_in_order%& is false. In this case,
15499 the sub-directories are processed one at a time (in a random order), and this
15500 avoids setting up one huge list for the whole queue. Thus, setting
15501 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15502 when the queue is large, because of the extra work in setting up the single,
15503 large list. In most situations, &%queue_run_in_order%& should not be set.
15504
15505
15506
15507 .option queue_run_max main integer 5
15508 .cindex "queue runner" "maximum number of"
15509 This controls the maximum number of queue runner processes that an Exim daemon
15510 can run simultaneously. This does not mean that it starts them all at once,
15511 but rather that if the maximum number are still running when the time comes to
15512 start another one, it refrains from starting another one. This can happen with
15513 very large queues and/or very sluggish deliveries. This option does not,
15514 however, interlock with other processes, so additional queue runners can be
15515 started by other means, or by killing and restarting the daemon.
15516
15517 Setting this option to zero does not suppress queue runs; rather, it disables
15518 the limit, allowing any number of simultaneous queue runner processes to be
15519 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15520 the daemon's command line.
15521
15522 .option queue_smtp_domains main "domain list&!!" unset
15523 .cindex "queueing incoming messages"
15524 .cindex "message" "queueing remote deliveries"
15525 When this option is set, a delivery process is started whenever a message is
15526 received, routing is performed, and local deliveries take place.
15527 However, if any SMTP deliveries are required for domains that match
15528 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15529 message waits on the queue for the next queue run. Since routing of the message
15530 has taken place, Exim knows to which remote hosts it must be delivered, and so
15531 when the queue run happens, multiple messages for the same host are delivered
15532 over a single SMTP connection. The &%-odqs%& command line option causes all
15533 SMTP deliveries to be queued in this way, and is equivalent to setting
15534 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15535 &%queue_domains%&.
15536
15537
15538 .option receive_timeout main time 0s
15539 .cindex "timeout" "for non-SMTP input"
15540 This option sets the timeout for accepting a non-SMTP message, that is, the
15541 maximum time that Exim waits when reading a message on the standard input. If
15542 the value is zero, it will wait for ever. This setting is overridden by the
15543 &%-or%& command line option. The timeout for incoming SMTP messages is
15544 controlled by &%smtp_receive_timeout%&.
15545
15546 .option received_header_text main string&!! "see below"
15547 .cindex "customizing" "&'Received:'& header"
15548 .cindex "&'Received:'& header line" "customizing"
15549 This string defines the contents of the &'Received:'& message header that is
15550 added to each message, except for the timestamp, which is automatically added
15551 on at the end (preceded by a semicolon). The string is expanded each time it is
15552 used. If the expansion yields an empty string, no &'Received:'& header line is
15553 added to the message. Otherwise, the string should start with the text
15554 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15555 header lines. The default setting is:
15556
15557 .code
15558 received_header_text = Received: \
15559   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15560   {${if def:sender_ident \
15561   {from ${quote_local_part:$sender_ident} }}\
15562   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15563   by $primary_hostname \
15564   ${if def:received_protocol {with $received_protocol}} \
15565   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15566   (Exim $version_number)\n\t\
15567   ${if def:sender_address \
15568   {(envelope-from <$sender_address>)\n\t}}\
15569   id $message_exim_id\
15570   ${if def:received_for {\n\tfor $received_for}}
15571 .endd
15572
15573 The reference to the TLS cipher is omitted when Exim is built without TLS
15574 support. The use of conditional expansions ensures that this works for both
15575 locally generated messages and messages received from remote hosts, giving
15576 header lines such as the following:
15577 .code
15578 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15579 by marley.carol.example with esmtp (Exim 4.00)
15580 (envelope-from <bob@carol.example>)
15581 id 16IOWa-00019l-00
15582 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15583 Received: by scrooge.carol.example with local (Exim 4.00)
15584 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15585 .endd
15586 Until the body of the message has been received, the timestamp is the time when
15587 the message started to be received. Once the body has arrived, and all policy
15588 checks have taken place, the timestamp is updated to the time at which the
15589 message was accepted.
15590
15591
15592 .option received_headers_max main integer 30
15593 .cindex "loop" "prevention"
15594 .cindex "mail loop prevention"
15595 .cindex "&'Received:'& header line" "counting"
15596 When a message is to be delivered, the number of &'Received:'& headers is
15597 counted, and if it is greater than this parameter, a mail loop is assumed to
15598 have occurred, the delivery is abandoned, and an error message is generated.
15599 This applies to both local and remote deliveries.
15600
15601
15602 .option recipient_unqualified_hosts main "host list&!!" unset
15603 .cindex "unqualified addresses"
15604 .cindex "host" "unqualified addresses from"
15605 This option lists those hosts from which Exim is prepared to accept unqualified
15606 recipient addresses in message envelopes. The addresses are made fully
15607 qualified by the addition of the &%qualify_recipient%& value. This option also
15608 affects message header lines. Exim does not reject unqualified recipient
15609 addresses in headers, but it qualifies them only if the message came from a
15610 host that matches &%recipient_unqualified_hosts%&,
15611 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15612 option was not set.
15613
15614
15615 .option recipients_max main integer 0
15616 .cindex "limit" "number of recipients"
15617 .cindex "recipient" "maximum number"
15618 If this option is set greater than zero, it specifies the maximum number of
15619 original recipients for any message. Additional recipients that are generated
15620 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15621 all recipients over the limit; earlier recipients are delivered as normal.
15622 Non-SMTP messages with too many recipients are failed, and no deliveries are
15623 done.
15624
15625 .cindex "RCPT" "maximum number of incoming"
15626 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15627 RCPT commands in a single message.
15628
15629
15630 .option recipients_max_reject main boolean false
15631 If this option is set true, Exim rejects SMTP messages containing too many
15632 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15633 error to the eventual DATA command. Otherwise (the default) it gives a 452
15634 error to the surplus RCPT commands and accepts the message on behalf of the
15635 initial set of recipients. The remote server should then re-send the message
15636 for the remaining recipients at a later time.
15637
15638
15639 .option remote_max_parallel main integer 2
15640 .cindex "delivery" "parallelism for remote"
15641 This option controls parallel delivery of one message to a number of remote
15642 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15643 does all the remote deliveries for a message one by one. Otherwise, if a single
15644 message has to be delivered to more than one remote host, or if several copies
15645 have to be sent to the same remote host, up to &%remote_max_parallel%&
15646 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15647 deliveries are required, the maximum number of processes are started, and as
15648 each one finishes, another is begun. The order of starting processes is the
15649 same as if sequential delivery were being done, and can be controlled by the
15650 &%remote_sort_domains%& option. If parallel delivery takes place while running
15651 with debugging turned on, the debugging output from each delivery process is
15652 tagged with its process id.
15653
15654 This option controls only the maximum number of parallel deliveries for one
15655 message in one Exim delivery process. Because Exim has no central queue
15656 manager, there is no way of controlling the total number of simultaneous
15657 deliveries if the configuration allows a delivery attempt as soon as a message
15658 is received.
15659
15660 .cindex "number of deliveries"
15661 .cindex "delivery" "maximum number of"
15662 If you want to control the total number of deliveries on the system, you
15663 need to set the &%queue_only%& option. This ensures that all incoming messages
15664 are added to the queue without starting a delivery process. Then set up an Exim
15665 daemon to start queue runner processes at appropriate intervals (probably
15666 fairly often, for example, every minute), and limit the total number of queue
15667 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15668 delivers only one message at a time, the maximum number of deliveries that can
15669 then take place at once is &%queue_run_max%& multiplied by
15670 &%remote_max_parallel%&.
15671
15672 If it is purely remote deliveries you want to control, use
15673 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15674 doing the SMTP routing before queueing, so that several messages for the same
15675 host will eventually get delivered down the same connection.
15676
15677
15678 .option remote_sort_domains main "domain list&!!" unset
15679 .cindex "sorting remote deliveries"
15680 .cindex "delivery" "sorting remote"
15681 When there are a number of remote deliveries for a message, they are sorted by
15682 domain into the order given by this list. For example,
15683 .code
15684 remote_sort_domains = *.cam.ac.uk:*.uk
15685 .endd
15686 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15687 then to those in the &%uk%& domain, then to any others.
15688
15689
15690 .option retry_data_expire main time 7d
15691 .cindex "hints database" "data expiry"
15692 This option sets a &"use before"& time on retry information in Exim's hints
15693 database. Any older retry data is ignored. This means that, for example, once a
15694 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15695 past failures.
15696
15697
15698 .option retry_interval_max main time 24h
15699 .cindex "retry" "limit on interval"
15700 .cindex "limit" "on retry interval"
15701 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15702 intervals between delivery attempts for messages that cannot be delivered
15703 straight away. This option sets an overall limit to the length of time between
15704 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15705 the default value.
15706
15707
15708 .option return_path_remove main boolean true
15709 .cindex "&'Return-path:'& header line" "removing"
15710 RFC 2821, section 4.4, states that an SMTP server must insert a
15711 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15712 The &'Return-path:'& header preserves the sender address as received in the
15713 MAIL command. This description implies that this header should not be present
15714 in an incoming message. If &%return_path_remove%& is true, any existing
15715 &'Return-path:'& headers are removed from messages at the time they are
15716 received. Exim's transports have options for adding &'Return-path:'& headers at
15717 the time of delivery. They are normally used only for final local deliveries.
15718
15719
15720 .option return_size_limit main integer 100K
15721 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15722
15723
15724 .new
15725 .option rfc1413_hosts main "host list&!!" @[]
15726 .cindex "RFC 1413"
15727 .cindex "host" "for RFC 1413 calls"
15728 RFC 1413 identification calls are made to any client host which matches
15729 an item in the list.
15730 The default value specifies just this host, being any local interface
15731 for the system.
15732 .wen
15733
15734 .new
15735 .option rfc1413_query_timeout main time 0s
15736 .wen
15737 .cindex "RFC 1413" "query timeout"
15738 .cindex "timeout" "for RFC 1413 call"
15739 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15740 no RFC 1413 calls are ever made.
15741
15742
15743 .option sender_unqualified_hosts main "host list&!!" unset
15744 .cindex "unqualified addresses"
15745 .cindex "host" "unqualified addresses from"
15746 This option lists those hosts from which Exim is prepared to accept unqualified
15747 sender addresses. The addresses are made fully qualified by the addition of
15748 &%qualify_domain%&. This option also affects message header lines. Exim does
15749 not reject unqualified addresses in headers that contain sender addresses, but
15750 it qualifies them only if the message came from a host that matches
15751 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15752 using TCP/IP), and the &%-bnq%& option was not set.
15753
15754
15755 .option slow_lookup_log main integer 0
15756 .cindex "logging" "slow lookups"
15757 .cindex "dns" "logging slow lookups"
15758 This option controls logging of slow lookups.
15759 If the value is nonzero it is taken as a number of milliseconds
15760 and lookups taking longer than this are logged.
15761 Currently this applies only to DNS lookups.
15762
15763
15764
15765 .option smtp_accept_keepalive main boolean true
15766 .cindex "keepalive" "on incoming connection"
15767 This option controls the setting of the SO_KEEPALIVE option on incoming
15768 TCP/IP socket connections. When set, it causes the kernel to probe idle
15769 connections periodically, by sending packets with &"old"& sequence numbers. The
15770 other end of the connection should send an acknowledgment if the connection is
15771 still okay or a reset if the connection has been aborted. The reason for doing
15772 this is that it has the beneficial effect of freeing up certain types of
15773 connection that can get stuck when the remote host is disconnected without
15774 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15775 hours to detect unreachable hosts.
15776
15777
15778
15779 .option smtp_accept_max main integer 20
15780 .cindex "limit" "incoming SMTP connections"
15781 .cindex "SMTP" "incoming connection count"
15782 .cindex "inetd"
15783 This option specifies the maximum number of simultaneous incoming SMTP calls
15784 that Exim will accept. It applies only to the listening daemon; there is no
15785 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15786 value is set to zero, no limit is applied. However, it is required to be
15787 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15788 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15789
15790 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15791 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15792 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15793 and &%smtp_load_reserve%& are then checked before accepting the connection.
15794
15795
15796 .option smtp_accept_max_nonmail main integer 10
15797 .cindex "limit" "non-mail SMTP commands"
15798 .cindex "SMTP" "limiting non-mail commands"
15799 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15800 the connection if there are too many. This option defines &"too many"&. The
15801 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15802 client looping sending EHLO, for example. The check is applied only if the
15803 client host matches &%smtp_accept_max_nonmail_hosts%&.
15804
15805 When a new message is expected, one occurrence of RSET is not counted. This
15806 allows a client to send one RSET between messages (this is not necessary,
15807 but some clients do it). Exim also allows one uncounted occurrence of HELO
15808 or EHLO, and one occurrence of STARTTLS between messages. After
15809 starting up a TLS session, another EHLO is expected, and so it too is not
15810 counted. The first occurrence of AUTH in a connection, or immediately
15811 following STARTTLS is not counted. Otherwise, all commands other than
15812 MAIL, RCPT, DATA, and QUIT are counted.
15813
15814
15815 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15816 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15817 check by setting this option. The default value makes it apply to all hosts. By
15818 changing the value, you can exclude any badly-behaved hosts that you have to
15819 live with.
15820
15821
15822 . Allow this long option name to split; give it unsplit as a fifth argument
15823 . for the automatic .oindex that is generated by .option.
15824 . We insert " &~&~" which is both pretty nasty visually and results in
15825 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15826 . zero-width-space, which would be nicer visually and results in (at least)
15827 . html that Firefox will split on when it's forced to reflow (rather than
15828 . inserting a horizontal scrollbar).  However, the text is still not
15829 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15830 . the option name to split.
15831
15832 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15833          smtp_accept_max_per_connection
15834 .cindex "SMTP" "limiting incoming message count"
15835 .cindex "limit" "messages per SMTP connection"
15836 The value of this option limits the number of MAIL commands that Exim is
15837 prepared to accept over a single SMTP connection, whether or not each command
15838 results in the transfer of a message. After the limit is reached, a 421
15839 response is given to subsequent MAIL commands. This limit is a safety
15840 precaution against a client that goes mad (incidents of this type have been
15841 seen).
15842
15843
15844 .option smtp_accept_max_per_host main string&!! unset
15845 .cindex "limit" "SMTP connections from one host"
15846 .cindex "host" "limiting SMTP connections from"
15847 This option restricts the number of simultaneous IP connections from a single
15848 host (strictly, from a single IP address) to the Exim daemon. The option is
15849 expanded, to enable different limits to be applied to different hosts by
15850 reference to &$sender_host_address$&. Once the limit is reached, additional
15851 connection attempts from the same host are rejected with error code 421. This
15852 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15853 of zero imposes no limit. If this option is set greater than zero, it is
15854 required that &%smtp_accept_max%& be non-zero.
15855
15856 &*Warning*&: When setting this option you should not use any expansion
15857 constructions that take an appreciable amount of time. The expansion and test
15858 happen in the main daemon loop, in order to reject additional connections
15859 without forking additional processes (otherwise a denial-of-service attack
15860 could cause a vast number or processes to be created). While the daemon is
15861 doing this processing, it cannot accept any other incoming connections.
15862
15863
15864
15865 .option smtp_accept_queue main integer 0
15866 .cindex "SMTP" "incoming connection count"
15867 .cindex "queueing incoming messages"
15868 .cindex "message" "queueing by SMTP connection count"
15869 If the number of simultaneous incoming SMTP connections being handled via the
15870 listening daemon exceeds this value, messages received by SMTP are just placed
15871 on the queue; no delivery processes are started automatically. The count is
15872 fixed at the start of an SMTP connection. It cannot be updated in the
15873 subprocess that receives messages, and so the queueing or not queueing applies
15874 to all messages received in the same connection.
15875
15876 A value of zero implies no limit, and clearly any non-zero value is useful only
15877 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15878 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15879 various &%-od%&&'x'& command line options.
15880
15881
15882 . See the comment on smtp_accept_max_per_connection
15883
15884 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15885          smtp_accept_queue_per_connection
15886 .cindex "queueing incoming messages"
15887 .cindex "message" "queueing by message count"
15888 This option limits the number of delivery processes that Exim starts
15889 automatically when receiving messages via SMTP, whether via the daemon or by
15890 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15891 and the number of messages received in a single SMTP session exceeds this
15892 number, subsequent messages are placed on the queue, but no delivery processes
15893 are started. This helps to limit the number of Exim processes when a server
15894 restarts after downtime and there is a lot of mail waiting for it on other
15895 systems. On large systems, the default should probably be increased, and on
15896 dial-in client systems it should probably be set to zero (that is, disabled).
15897
15898
15899 .option smtp_accept_reserve main integer 0
15900 .cindex "SMTP" "incoming call count"
15901 .cindex "host" "reserved"
15902 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15903 number of SMTP connections that are reserved for connections from the hosts
15904 that are specified in &%smtp_reserve_hosts%&. The value set in
15905 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15906 restricted to this number of connections; the option specifies a minimum number
15907 of connection slots for them, not a maximum. It is a guarantee that this group
15908 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15909 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15910 individual host.
15911
15912 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15913 set to 5, once there are 45 active connections (from any hosts), new
15914 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15915 provided the other criteria for acceptance are met.
15916
15917
15918 .option smtp_active_hostname main string&!! unset
15919 .cindex "host" "name in SMTP responses"
15920 .cindex "SMTP" "host name in responses"
15921 .vindex "&$primary_hostname$&"
15922 This option is provided for multi-homed servers that want to masquerade as
15923 several different hosts. At the start of an incoming SMTP connection, its value
15924 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15925 responses. For example, it is used as domain name in the response to an
15926 incoming HELO or EHLO command.
15927
15928 .vindex "&$smtp_active_hostname$&"
15929 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15930 is saved with any messages that are received. It is therefore available for use
15931 in routers and transports when the message is later delivered.
15932
15933 If this option is unset, or if its expansion is forced to fail, or if the
15934 expansion results in an empty string, the value of &$primary_hostname$& is
15935 used. Other expansion failures cause a message to be written to the main and
15936 panic logs, and the SMTP command receives a temporary error. Typically, the
15937 value of &%smtp_active_hostname%& depends on the incoming interface address.
15938 For example:
15939 .code
15940 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15941   {cox.mydomain}{box.mydomain}}
15942 .endd
15943
15944 Although &$smtp_active_hostname$& is primarily concerned with incoming
15945 messages, it is also used as the default for HELO commands in callout
15946 verification if there is no remote transport from which to obtain a
15947 &%helo_data%& value.
15948
15949 .option smtp_banner main string&!! "see below"
15950 .cindex "SMTP" "welcome banner"
15951 .cindex "banner for SMTP"
15952 .cindex "welcome banner for SMTP"
15953 .cindex "customizing" "SMTP banner"
15954 This string, which is expanded every time it is used, is output as the initial
15955 positive response to an SMTP connection. The default setting is:
15956 .code
15957 smtp_banner = $smtp_active_hostname ESMTP Exim \
15958   $version_number $tod_full
15959 .endd
15960 Failure to expand the string causes a panic error. If you want to create a
15961 multiline response to the initial SMTP connection, use &"\n"& in the string at
15962 appropriate points, but not at the end. Note that the 220 code is not included
15963 in this string. Exim adds it automatically (several times in the case of a
15964 multiline response).
15965
15966
15967 .option smtp_check_spool_space main boolean true
15968 .cindex "checking disk space"
15969 .cindex "disk space, checking"
15970 .cindex "spool directory" "checking space"
15971 When this option is set, if an incoming SMTP session encounters the SIZE
15972 option on a MAIL command, it checks that there is enough space in the
15973 spool directory's partition to accept a message of that size, while still
15974 leaving free the amount specified by &%check_spool_space%& (even if that value
15975 is zero). If there isn't enough space, a temporary error code is returned.
15976
15977
15978 .option smtp_connect_backlog main integer 20
15979 .cindex "connection backlog"
15980 .cindex "SMTP" "connection backlog"
15981 .cindex "backlog of connections"
15982 This option specifies a maximum number of waiting SMTP connections. Exim passes
15983 this value to the TCP/IP system when it sets up its listener. Once this number
15984 of connections are waiting for the daemon's attention, subsequent connection
15985 attempts are refused at the TCP/IP level. At least, that is what the manuals
15986 say; in some circumstances such connection attempts have been observed to time
15987 out instead. For large systems it is probably a good idea to increase the
15988 value (to 50, say). It also gives some protection against denial-of-service
15989 attacks by SYN flooding.
15990
15991
15992 .option smtp_enforce_sync main boolean true
15993 .cindex "SMTP" "synchronization checking"
15994 .cindex "synchronization checking in SMTP"
15995 The SMTP protocol specification requires the client to wait for a response from
15996 the server at certain points in the dialogue. Without PIPELINING these
15997 synchronization points are after every command; with PIPELINING they are
15998 fewer, but they still exist.
15999
16000 Some spamming sites send out a complete set of SMTP commands without waiting
16001 for any response. Exim protects against this by rejecting a message if the
16002 client has sent further input when it should not have. The error response &"554
16003 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16004 for this error cannot be perfect because of transmission delays (unexpected
16005 input may be on its way but not yet received when Exim checks). However, it
16006 does detect many instances.
16007
16008 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16009 If you want to disable the check selectively (for example, only for certain
16010 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16011 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16012
16013
16014
16015 .option smtp_etrn_command main string&!! unset
16016 .cindex "ETRN" "command to be run"
16017 .vindex "&$domain$&"
16018 If this option is set, the given command is run whenever an SMTP ETRN
16019 command is received from a host that is permitted to issue such commands (see
16020 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16021 are independently expanded. The expansion variable &$domain$& is set to the
16022 argument of the ETRN command, and no syntax checking is done on it. For
16023 example:
16024 .code
16025 smtp_etrn_command = /etc/etrn_command $domain \
16026                     $sender_host_address
16027 .endd
16028 A new process is created to run the command, but Exim does not wait for it to
16029 complete. Consequently, its status cannot be checked. If the command cannot be
16030 run, a line is written to the panic log, but the ETRN caller still receives
16031 a 250 success response. Exim is normally running under its own uid when
16032 receiving SMTP, so it is not possible for it to change the uid before running
16033 the command.
16034
16035
16036 .option smtp_etrn_serialize main boolean true
16037 .cindex "ETRN" "serializing"
16038 When this option is set, it prevents the simultaneous execution of more than
16039 one identical command as a result of ETRN in an SMTP connection. See
16040 section &<<SECTETRN>>& for details.
16041
16042
16043 .option smtp_load_reserve main fixed-point unset
16044 .cindex "load average"
16045 If the system load average ever gets higher than this, incoming SMTP calls are
16046 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16047 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16048 the load is over the limit. The option has no effect on ancient operating
16049 systems on which Exim cannot determine the load average. See also
16050 &%deliver_queue_load_max%& and &%queue_only_load%&.
16051
16052
16053
16054 .option smtp_max_synprot_errors main integer 3
16055 .cindex "SMTP" "limiting syntax and protocol errors"
16056 .cindex "limit" "SMTP syntax and protocol errors"
16057 Exim rejects SMTP commands that contain syntax or protocol errors. In
16058 particular, a syntactically invalid email address, as in this command:
16059 .code
16060 RCPT TO:<abc xyz@a.b.c>
16061 .endd
16062 causes immediate rejection of the command, before any other tests are done.
16063 (The ACL cannot be run if there is no valid address to set up for it.) An
16064 example of a protocol error is receiving RCPT before MAIL. If there are
16065 too many syntax or protocol errors in one SMTP session, the connection is
16066 dropped. The limit is set by this option.
16067
16068 .cindex "PIPELINING" "expected errors"
16069 When the PIPELINING extension to SMTP is in use, some protocol errors are
16070 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16071 Exim assumes that PIPELINING will be used if it advertises it (see
16072 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16073 not count towards the limit.
16074
16075
16076
16077 .option smtp_max_unknown_commands main integer 3
16078 .cindex "SMTP" "limiting unknown commands"
16079 .cindex "limit" "unknown SMTP commands"
16080 If there are too many unrecognized commands in an incoming SMTP session, an
16081 Exim server drops the connection. This is a defence against some kinds of abuse
16082 that subvert web
16083 clients
16084 into making connections to SMTP ports; in these circumstances, a number of
16085 non-SMTP command lines are sent first.
16086
16087
16088
16089 .option smtp_ratelimit_hosts main "host list&!!" unset
16090 .cindex "SMTP" "rate limiting"
16091 .cindex "limit" "rate of message arrival"
16092 .cindex "RCPT" "rate limiting"
16093 Some sites find it helpful to be able to limit the rate at which certain hosts
16094 can send them messages, and the rate at which an individual message can specify
16095 recipients.
16096
16097 Exim has two rate-limiting facilities. This section describes the older
16098 facility, which can limit rates within a single connection. The newer
16099 &%ratelimit%& ACL condition can limit rates across all connections. See section
16100 &<<SECTratelimiting>>& for details of the newer facility.
16101
16102 When a host matches &%smtp_ratelimit_hosts%&, the values of
16103 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16104 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16105 respectively. Each option, if set, must contain a set of four comma-separated
16106 values:
16107
16108 .ilist
16109 A threshold, before which there is no rate limiting.
16110 .next
16111 An initial time delay. Unlike other times in Exim, numbers with decimal
16112 fractional parts are allowed here.
16113 .next
16114 A factor by which to increase the delay each time.
16115 .next
16116 A maximum value for the delay. This should normally be less than 5 minutes,
16117 because after that time, the client is liable to timeout the SMTP command.
16118 .endlist
16119
16120 For example, these settings have been used successfully at the site which
16121 first suggested this feature, for controlling mail from their customers:
16122 .code
16123 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16124 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16125 .endd
16126 The first setting specifies delays that are applied to MAIL commands after
16127 two have been received over a single connection. The initial delay is 0.5
16128 seconds, increasing by a factor of 1.05 each time. The second setting applies
16129 delays to RCPT commands when more than four occur in a single message.
16130
16131
16132 .option smtp_ratelimit_mail main string unset
16133 See &%smtp_ratelimit_hosts%& above.
16134
16135
16136 .option smtp_ratelimit_rcpt main string unset
16137 See &%smtp_ratelimit_hosts%& above.
16138
16139
16140 .option smtp_receive_timeout main time&!! 5m
16141 .cindex "timeout" "for SMTP input"
16142 .cindex "SMTP" "input timeout"
16143 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16144 input, including batch SMTP. If a line of input (either an SMTP command or a
16145 data line) is not received within this time, the SMTP connection is dropped and
16146 the message is abandoned.
16147 A line is written to the log containing one of the following messages:
16148 .code
16149 SMTP command timeout on connection from...
16150 SMTP data timeout on connection from...
16151 .endd
16152 The former means that Exim was expecting to read an SMTP command; the latter
16153 means that it was in the DATA phase, reading the contents of a message.
16154
16155 If the first character of the option is a &"$"& the option is
16156 expanded before use and may depend on
16157 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16158
16159
16160 .oindex "&%-os%&"
16161 The value set by this option can be overridden by the
16162 &%-os%& command-line option. A setting of zero time disables the timeout, but
16163 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16164 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16165 timeout is controlled by &%receive_timeout%& and &%-or%&.
16166
16167
16168 .option smtp_reserve_hosts main "host list&!!" unset
16169 This option defines hosts for which SMTP connections are reserved; see
16170 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16171
16172
16173 .option smtp_return_error_details main boolean false
16174 .cindex "SMTP" "details policy failures"
16175 .cindex "policy control" "rejection, returning details"
16176 In the default state, Exim uses bland messages such as
16177 &"Administrative prohibition"& when it rejects SMTP commands for policy
16178 reasons. Many sysadmins like this because it gives away little information
16179 to spammers. However, some other sysadmins who are applying strict checking
16180 policies want to give out much fuller information about failures. Setting
16181 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16182 example, instead of &"Administrative prohibition"&, it might give:
16183 .code
16184 550-Rejected after DATA: '>' missing at end of address:
16185 550 failing address in "From" header is: <user@dom.ain
16186 .endd
16187
16188 .option spamd_address main string "see below"
16189 This option is available when Exim is compiled with the content-scanning
16190 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16191 The default value is
16192 .code
16193 127.0.0.1 783
16194 .endd
16195 See section &<<SECTscanspamass>>& for more details.
16196
16197
16198
16199 .option split_spool_directory main boolean false
16200 .cindex "multiple spool directories"
16201 .cindex "spool directory" "split"
16202 .cindex "directories, multiple"
16203 If this option is set, it causes Exim to split its input directory into 62
16204 subdirectories, each with a single alphanumeric character as its name. The
16205 sixth character of the message id is used to allocate messages to
16206 subdirectories; this is the least significant base-62 digit of the time of
16207 arrival of the message.
16208
16209 Splitting up the spool in this way may provide better performance on systems
16210 where there are long mail queues, by reducing the number of files in any one
16211 directory. The msglog directory is also split up in a similar way to the input
16212 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16213 are still placed in the single directory &_msglog.OLD_&.
16214
16215 It is not necessary to take any special action for existing messages when
16216 changing &%split_spool_directory%&. Exim notices messages that are in the
16217 &"wrong"& place, and continues to process them. If the option is turned off
16218 after a period of being on, the subdirectories will eventually empty and be
16219 automatically deleted.
16220
16221 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16222 changes. Instead of creating a list of all messages in the queue, and then
16223 trying to deliver each one in turn, it constructs a list of those in one
16224 sub-directory and tries to deliver them, before moving on to the next
16225 sub-directory. The sub-directories are processed in a random order. This
16226 spreads out the scanning of the input directories, and uses less memory. It is
16227 particularly beneficial when there are lots of messages on the queue. However,
16228 if &%queue_run_in_order%& is set, none of this new processing happens. The
16229 entire queue has to be scanned and sorted before any deliveries can start.
16230
16231
16232 .option spool_directory main string&!! "set at compile time"
16233 .cindex "spool directory" "path to"
16234 This defines the directory in which Exim keeps its spool, that is, the messages
16235 it is waiting to deliver. The default value is taken from the compile-time
16236 configuration setting, if there is one. If not, this option must be set. The
16237 string is expanded, so it can contain, for example, a reference to
16238 &$primary_hostname$&.
16239
16240 If the spool directory name is fixed on your installation, it is recommended
16241 that you set it at build time rather than from this option, particularly if the
16242 log files are being written to the spool directory (see &%log_file_path%&).
16243 Otherwise log files cannot be used for errors that are detected early on, such
16244 as failures in the configuration file.
16245
16246 By using this option to override the compiled-in path, it is possible to run
16247 tests of Exim without using the standard spool.
16248
16249 .option sqlite_lock_timeout main time 5s
16250 .cindex "sqlite lookup type" "lock timeout"
16251 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16252 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16253
16254 .option strict_acl_vars main boolean false
16255 .cindex "&ACL;" "variables, handling unset"
16256 This option controls what happens if a syntactically valid but undefined ACL
16257 variable is referenced. If it is false (the default), an empty string
16258 is substituted; if it is true, an error is generated. See section
16259 &<<SECTaclvariables>>& for details of ACL variables.
16260
16261 .option strip_excess_angle_brackets main boolean false
16262 .cindex "angle brackets, excess"
16263 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16264 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16265 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16266 passed on to another MTA, the excess angle brackets are not passed on. If this
16267 option is not set, multiple pairs of angle brackets cause a syntax error.
16268
16269
16270 .option strip_trailing_dot main boolean false
16271 .cindex "trailing dot on domain"
16272 .cindex "dot" "trailing on domain"
16273 If this option is set, a trailing dot at the end of a domain in an address is
16274 ignored. If this is in the envelope and the message is passed on to another
16275 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16276 domain causes a syntax error.
16277 However, addresses in header lines are checked only when an ACL requests header
16278 syntax checking.
16279
16280
16281 .option syslog_duplication main boolean true
16282 .cindex "syslog" "duplicate log lines; suppressing"
16283 When Exim is logging to syslog, it writes the log lines for its three
16284 separate logs at different syslog priorities so that they can in principle
16285 be separated on the logging hosts. Some installations do not require this
16286 separation, and in those cases, the duplication of certain log lines is a
16287 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16288 particular log line is written to syslog. For lines that normally go to
16289 both the main log and the reject log, the reject log version (possibly
16290 containing message header lines) is written, at LOG_NOTICE priority.
16291 Lines that normally go to both the main and the panic log are written at
16292 the LOG_ALERT priority.
16293
16294
16295 .option syslog_facility main string unset
16296 .cindex "syslog" "facility; setting"
16297 This option sets the syslog &"facility"& name, used when Exim is logging to
16298 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16299 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16300 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16301 details of Exim's logging.
16302
16303
16304
16305 .option syslog_processname main string &`exim`&
16306 .cindex "syslog" "process name; setting"
16307 This option sets the syslog &"ident"& name, used when Exim is logging to
16308 syslog. The value must be no longer than 32 characters. See chapter
16309 &<<CHAPlog>>& for details of Exim's logging.
16310
16311
16312
16313 .option syslog_timestamp main boolean true
16314 .cindex "syslog" "timestamps"
16315 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16316 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16317 details of Exim's logging.
16318
16319
16320 .option system_filter main string&!! unset
16321 .cindex "filter" "system filter"
16322 .cindex "system filter" "specifying"
16323 .cindex "Sieve filter" "not available for system filter"
16324 This option specifies an Exim filter file that is applied to all messages at
16325 the start of each delivery attempt, before any routing is done. System filters
16326 must be Exim filters; they cannot be Sieve filters. If the system filter
16327 generates any deliveries to files or pipes, or any new mail messages, the
16328 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16329 which transports are to be used. Details of this facility are given in chapter
16330 &<<CHAPsystemfilter>>&.
16331
16332
16333 .option system_filter_directory_transport main string&!! unset
16334 .vindex "&$address_file$&"
16335 This sets the name of the transport driver that is to be used when the
16336 &%save%& command in a system message filter specifies a path ending in &"/"&,
16337 implying delivery of each message into a separate file in some directory.
16338 During the delivery, the variable &$address_file$& contains the path name.
16339
16340
16341 .option system_filter_file_transport main string&!! unset
16342 .cindex "file" "transport for system filter"
16343 This sets the name of the transport driver that is to be used when the &%save%&
16344 command in a system message filter specifies a path not ending in &"/"&. During
16345 the delivery, the variable &$address_file$& contains the path name.
16346
16347 .option system_filter_group main string unset
16348 .cindex "gid (group id)" "system filter"
16349 This option is used only when &%system_filter_user%& is also set. It sets the
16350 gid under which the system filter is run, overriding any gid that is associated
16351 with the user. The value may be numerical or symbolic.
16352
16353 .option system_filter_pipe_transport main string&!! unset
16354 .cindex "&(pipe)& transport" "for system filter"
16355 .vindex "&$address_pipe$&"
16356 This specifies the transport driver that is to be used when a &%pipe%& command
16357 is used in a system filter. During the delivery, the variable &$address_pipe$&
16358 contains the pipe command.
16359
16360
16361 .option system_filter_reply_transport main string&!! unset
16362 .cindex "&(autoreply)& transport" "for system filter"
16363 This specifies the transport driver that is to be used when a &%mail%& command
16364 is used in a system filter.
16365
16366
16367 .option system_filter_user main string unset
16368 .cindex "uid (user id)" "system filter"
16369 If this option is set to root, the system filter is run in the main Exim
16370 delivery process, as root.  Otherwise, the system filter runs in a separate
16371 process, as the given user, defaulting to the Exim run-time user.
16372 Unless the string consists entirely of digits, it
16373 is looked up in the password data. Failure to find the named user causes a
16374 configuration error. The gid is either taken from the password data, or
16375 specified by &%system_filter_group%&. When the uid is specified numerically,
16376 &%system_filter_group%& is required to be set.
16377
16378 If the system filter generates any pipe, file, or reply deliveries, the uid
16379 under which the filter is run is used when transporting them, unless a
16380 transport option overrides.
16381
16382
16383 .option tcp_nodelay main boolean true
16384 .cindex "daemon" "TCP_NODELAY on sockets"
16385 .cindex "Nagle algorithm"
16386 .cindex "TCP_NODELAY on listening sockets"
16387 If this option is set false, it stops the Exim daemon setting the
16388 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16389 turns off the &"Nagle algorithm"&, which is a way of improving network
16390 performance in interactive (character-by-character) situations. Turning it off
16391 should improve Exim's performance a bit, so that is what happens by default.
16392 However, it appears that some broken clients cannot cope, and time out. Hence
16393 this option. It affects only those sockets that are set up for listening by the
16394 daemon. Sockets created by the smtp transport for delivering mail always set
16395 TCP_NODELAY.
16396
16397
16398 .option timeout_frozen_after main time 0s
16399 .cindex "frozen messages" "timing out"
16400 .cindex "timeout" "frozen messages"
16401 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16402 message of any kind that has been on the queue for longer than the given time
16403 is automatically cancelled at the next queue run. If the frozen message is a
16404 bounce message, it is just discarded; otherwise, a bounce is sent to the
16405 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16406 If you want to timeout frozen bounce messages earlier than other kinds of
16407 frozen message, see &%ignore_bounce_errors_after%&.
16408
16409 &*Note:*& the default value of zero means no timeouts; with this setting,
16410 frozen messages remain on the queue forever (except for any frozen bounce
16411 messages that are released by &%ignore_bounce_errors_after%&).
16412
16413
16414 .option timezone main string unset
16415 .cindex "timezone, setting"
16416 The value of &%timezone%& is used to set the environment variable TZ while
16417 running Exim (if it is different on entry). This ensures that all timestamps
16418 created by Exim are in the required timezone. If you want all your timestamps
16419 to be in UTC (aka GMT) you should set
16420 .code
16421 timezone = UTC
16422 .endd
16423 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16424 or, if that is not set, from the value of the TZ environment variable when Exim
16425 is built. If &%timezone%& is set to the empty string, either at build or run
16426 time, any existing TZ variable is removed from the environment when Exim
16427 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16428 unfortunately not all, operating systems.
16429
16430
16431 .option tls_advertise_hosts main "host list&!!" unset
16432 .cindex "TLS" "advertising"
16433 .cindex "encryption" "on SMTP connection"
16434 .cindex "SMTP" "encrypted connection"
16435 When Exim is built with support for TLS encrypted connections, the availability
16436 of the STARTTLS command to set up an encrypted session is advertised in
16437 response to EHLO only to those client hosts that match this option. See
16438 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16439
16440
16441 .option tls_certificate main string&!! unset
16442 .cindex "TLS" "server certificate; location of"
16443 .cindex "certificate" "server, location of"
16444 The value of this option is expanded, and must then be the absolute path to a
16445 file which contains the server's certificates. The server's private key is also
16446 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16447 &<<CHAPTLS>>& for further details.
16448
16449 &*Note*&: The certificates defined by this option are used only when Exim is
16450 receiving incoming messages as a server. If you want to supply certificates for
16451 use when sending messages as a client, you must set the &%tls_certificate%&
16452 option in the relevant &(smtp)& transport.
16453
16454 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16455 if the OpenSSL build supports TLS extensions and the TLS client sends the
16456 Server Name Indication extension, then this option and others documented in
16457 &<<SECTtlssni>>& will be re-expanded.
16458
16459 .option tls_crl main string&!! unset
16460 .cindex "TLS" "server certificate revocation list"
16461 .cindex "certificate" "revocation list for server"
16462 This option specifies a certificate revocation list. The expanded value must
16463 be the name of a file that contains a CRL in PEM format.
16464
16465 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16466
16467
16468 .option tls_dh_max_bits main integer 2236
16469 .cindex "TLS" "D-H bit count"
16470 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16471 the chosen TLS library.  That value might prove to be too high for
16472 interoperability.  This option provides a maximum clamp on the value
16473 suggested, trading off security for interoperability.
16474
16475 The value must be at least 1024.
16476
16477 The value 2236 was chosen because, at time of adding the option, it was the
16478 hard-coded maximum value supported by the NSS cryptographic library, as used
16479 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16480
16481 If you prefer more security and are willing to break some clients, raise this
16482 number.
16483
16484 Note that the value passed to GnuTLS for *generating* a new prime may be a
16485 little less than this figure, because GnuTLS is inexact and may produce a
16486 larger prime than requested.
16487
16488
16489 .option tls_dhparam main string&!! unset
16490 .cindex "TLS" "D-H parameters for server"
16491 The value of this option is expanded and indicates the source of DH parameters
16492 to be used by Exim.
16493
16494 If it is a filename starting with a &`/`&, then it names a file from which DH
16495 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16496 PKCS#3 representation of the DH prime.  If the file does not exist, for
16497 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16498 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16499 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16500 and treated as though the &%tls_dhparam%& were set to "none".
16501
16502 If this option expands to the string "none", then no DH parameters will be
16503 loaded by Exim.
16504
16505 If this option expands to the string "historic" and Exim is using GnuTLS, then
16506 Exim will attempt to load a file from inside the spool directory.  If the file
16507 does not exist, Exim will attempt to create it.
16508 See section &<<SECTgnutlsparam>>& for further details.
16509
16510 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16511 a default DH prime; the default is the 2048 bit prime described in section
16512 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16513 in IKE is assigned number 23.
16514
16515 Otherwise, the option must expand to the name used by Exim for any of a number
16516 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16517 "ike" followed by the number used by IKE, of "default" which corresponds to
16518 "ike23".
16519
16520 The available primes are:
16521 &`ike1`&, &`ike2`&, &`ike5`&,
16522 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16523 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16524
16525 Some of these will be too small to be accepted by clients.
16526 Some may be too large to be accepted by clients.
16527
16528 The TLS protocol does not negotiate an acceptable size for this; clients tend
16529 to hard-drop connections if what is offered by the server is unacceptable,
16530 whether too large or too small, and there's no provision for the client to
16531 tell the server what these constraints are.  Thus, as a server operator, you
16532 need to make an educated guess as to what is most likely to work for your
16533 userbase.
16534
16535 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16536 is most likely to maximise interoperability.  The upper bound comes from
16537 applications using the Mozilla Network Security Services (NSS) library, which
16538 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16539 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16540 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16541 acceptable bound from 1024 to 2048.
16542
16543
16544 .option tls_ocsp_file main string&!! unset
16545 This option
16546 must if set expand to the absolute path to a file which contains a current
16547 status proof for the server's certificate, as obtained from the
16548 Certificate Authority.
16549
16550
16551 .option tls_on_connect_ports main "string list" unset
16552 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16553 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16554 set up without waiting for the client to issue a STARTTLS command. For
16555 further details, see section &<<SECTsupobssmt>>&.
16556
16557
16558
16559 .option tls_privatekey main string&!! unset
16560 .cindex "TLS" "server private key; location of"
16561 The value of this option is expanded, and must then be the absolute path to a
16562 file which contains the server's private key. If this option is unset, or if
16563 the expansion is forced to fail, or the result is an empty string, the private
16564 key is assumed to be in the same file as the server's certificates. See chapter
16565 &<<CHAPTLS>>& for further details.
16566
16567 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16568
16569
16570 .option tls_remember_esmtp main boolean false
16571 .cindex "TLS" "esmtp state; remembering"
16572 .cindex "TLS" "broken clients"
16573 If this option is set true, Exim violates the RFCs by remembering that it is in
16574 &"esmtp"& state after successfully negotiating a TLS session. This provides
16575 support for broken clients that fail to send a new EHLO after starting a
16576 TLS session.
16577
16578
16579 .option tls_require_ciphers main string&!! unset
16580 .cindex "TLS" "requiring specific ciphers"
16581 .cindex "cipher" "requiring specific"
16582 This option controls which ciphers can be used for incoming TLS connections.
16583 The &(smtp)& transport has an option of the same name for controlling outgoing
16584 connections. This option is expanded for each connection, so can be varied for
16585 different clients if required. The value of this option must be a list of
16586 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16587 in somewhat different ways. If GnuTLS is being used, the client controls the
16588 preference order of the available ciphers. Details are given in sections
16589 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16590
16591
16592 .option tls_try_verify_hosts main "host list&!!" unset
16593 .cindex "TLS" "client certificate verification"
16594 .cindex "certificate" "verification of client"
16595 See &%tls_verify_hosts%& below.
16596
16597
16598 .new
16599 .option tls_verify_certificates main string&!! system
16600 .cindex "TLS" "client certificate verification"
16601 .cindex "certificate" "verification of client"
16602 The value of this option is expanded, and must then be either the
16603 word "system"
16604 or the absolute path to
16605 a file or directory containing permitted certificates for clients that
16606 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16607
16608 The "system" value for the option will use a
16609 system default location compiled into the SSL library.
16610 This is not available for GnuTLS versions preceding 3.0.20,
16611 and will be taken as empty; an explicit location
16612 must be specified.
16613
16614 The use of a directory for the option value is not avilable for GnuTLS versions
16615 preceding 3.3.6 and a single file must be used.
16616
16617 With OpenSSL the certificates specified
16618 explicitly
16619 either by file or directory
16620 are added to those given by the system default location.
16621 .wen
16622
16623 These certificates should be for the certificate authorities trusted, rather
16624 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16625 the value is a file then the certificates are sent by Exim as a server to
16626 connecting clients, defining the list of accepted certificate authorities.
16627 Thus the values defined should be considered public data.  To avoid this,
16628 use the explicit directory version.
16629
16630 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16631
16632 A forced expansion failure or setting to an empty string is equivalent to
16633 being unset.
16634
16635
16636 .option tls_verify_hosts main "host list&!!" unset
16637 .cindex "TLS" "client certificate verification"
16638 .cindex "certificate" "verification of client"
16639 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16640 certificates from clients. The expected certificates are defined by
16641 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16642 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16643 &%tls_verify_certificates%& is not set.
16644
16645 Any client that matches &%tls_verify_hosts%& is constrained by
16646 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16647 present one of the listed certificates. If it does not, the connection is
16648 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16649 the host to use TLS. It can still send SMTP commands through unencrypted
16650 connections. Forcing a client to use TLS has to be done separately using an
16651 ACL to reject inappropriate commands when the connection is not encrypted.
16652
16653 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16654 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16655 certificate and checks it against &%tls_verify_certificates%&, but does not
16656 abort the connection if there is no certificate or if it does not match. This
16657 state can be detected in an ACL, which makes it possible to implement policies
16658 such as &"accept for relay only if a verified certificate has been received,
16659 but accept for local delivery if encrypted, even without a verified
16660 certificate"&.
16661
16662 Client hosts that match neither of these lists are not asked to present
16663 certificates.
16664
16665
16666 .option trusted_groups main "string list&!!" unset
16667 .cindex "trusted groups"
16668 .cindex "groups" "trusted"
16669 This option is expanded just once, at the start of Exim's processing. If this
16670 option is set, any process that is running in one of the listed groups, or
16671 which has one of them as a supplementary group, is trusted. The groups can be
16672 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16673 details of what trusted callers are permitted to do. If neither
16674 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16675 are trusted.
16676
16677 .option trusted_users main "string list&!!" unset
16678 .cindex "trusted users"
16679 .cindex "user" "trusted"
16680 This option is expanded just once, at the start of Exim's processing. If this
16681 option is set, any process that is running as one of the listed users is
16682 trusted. The users can be specified numerically or by name. See section
16683 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16684 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16685 Exim user are trusted.
16686
16687 .option unknown_login main string&!! unset
16688 .cindex "uid (user id)" "unknown caller"
16689 .vindex "&$caller_uid$&"
16690 This is a specialized feature for use in unusual configurations. By default, if
16691 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16692 gives up. The &%unknown_login%& option can be used to set a login name to be
16693 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16694 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16695 is used for the user's real name (gecos field), unless this has been set by the
16696 &%-F%& option.
16697
16698 .option unknown_username main string unset
16699 See &%unknown_login%&.
16700
16701 .option untrusted_set_sender main "address list&!!" unset
16702 .cindex "trusted users"
16703 .cindex "sender" "setting by untrusted user"
16704 .cindex "untrusted user setting sender"
16705 .cindex "user" "untrusted setting sender"
16706 .cindex "envelope sender"
16707 When an untrusted user submits a message to Exim using the standard input, Exim
16708 normally creates an envelope sender address from the user's login and the
16709 default qualification domain. Data from the &%-f%& option (for setting envelope
16710 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16711 is used) is ignored.
16712
16713 However, untrusted users are permitted to set an empty envelope sender address,
16714 to declare that a message should never generate any bounces. For example:
16715 .code
16716 exim -f '<>' user@domain.example
16717 .endd
16718 .vindex "&$sender_ident$&"
16719 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16720 other envelope sender addresses in a controlled way. When it is set, untrusted
16721 users are allowed to set envelope sender addresses that match any of the
16722 patterns in the list. Like all address lists, the string is expanded. The
16723 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16724 users to setting senders that start with their login ids
16725 followed by a hyphen
16726 by a setting like this:
16727 .code
16728 untrusted_set_sender = ^$sender_ident-
16729 .endd
16730 If you want to allow untrusted users to set envelope sender addresses without
16731 restriction, you can use
16732 .code
16733 untrusted_set_sender = *
16734 .endd
16735 The &%untrusted_set_sender%& option applies to all forms of local input, but
16736 only to the setting of the envelope sender. It does not permit untrusted users
16737 to use the other options which trusted user can use to override message
16738 parameters. Furthermore, it does not stop Exim from removing an existing
16739 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16740 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16741 overriding these actions. The handling of the &'Sender:'& header is also
16742 described in section &<<SECTthesenhea>>&.
16743
16744 The log line for a message's arrival shows the envelope sender following
16745 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16746 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16747 envelope sender address, the user's login is shown in parentheses after the
16748 sender address.
16749
16750
16751 .option uucp_from_pattern main string "see below"
16752 .cindex "&""From""& line"
16753 .cindex "UUCP" "&""From""& line"
16754 Some applications that pass messages to an MTA via a command line interface use
16755 an initial line starting with &"From&~"& to pass the envelope sender. In
16756 particular, this is used by UUCP software. Exim recognizes such a line by means
16757 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16758 matches, the sender address is constructed by expanding the contents of
16759 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16760 default pattern recognizes lines in the following two forms:
16761 .code
16762 From ph10 Fri Jan  5 12:35 GMT 1996
16763 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16764 .endd
16765 The pattern can be seen by running
16766 .code
16767 exim -bP uucp_from_pattern
16768 .endd
16769 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16770 year in the second case. The first word after &"From&~"& is matched in the
16771 regular expression by a parenthesized subpattern. The default value for
16772 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16773 (&"ph10"& in the example above) as the message's sender. See also
16774 &%ignore_fromline_hosts%&.
16775
16776
16777 .option uucp_from_sender main string&!! &`$1`&
16778 See &%uucp_from_pattern%& above.
16779
16780
16781 .option warn_message_file main string unset
16782 .cindex "warning of delay" "customizing the message"
16783 .cindex "customizing" "warning message"
16784 This option defines a template file containing paragraphs of text to be used
16785 for constructing the warning message which is sent by Exim when a message has
16786 been on the queue for a specified amount of time, as specified by
16787 &%delay_warning%&. Details of the file's contents are given in chapter
16788 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16789
16790
16791 .option write_rejectlog main boolean true
16792 .cindex "reject log" "disabling"
16793 If this option is set false, Exim no longer writes anything to the reject log.
16794 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16795 .ecindex IIDconfima
16796 .ecindex IIDmaiconf
16797
16798
16799
16800
16801 . ////////////////////////////////////////////////////////////////////////////
16802 . ////////////////////////////////////////////////////////////////////////////
16803
16804 .chapter "Generic options for routers" "CHAProutergeneric"
16805 .scindex IIDgenoprou1 "options" "generic; for routers"
16806 .scindex IIDgenoprou2 "generic options" "router"
16807 This chapter describes the generic options that apply to all routers.
16808 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16809
16810 For a general description of how a router operates, see sections
16811 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16812 which the preconditions are tested. The order of expansion of the options that
16813 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16814 &%headers_remove%&, &%transport%&.
16815
16816
16817
16818 .option address_data routers string&!! unset
16819 .cindex "router" "data attached to address"
16820 The string is expanded just before the router is run, that is, after all the
16821 precondition tests have succeeded. If the expansion is forced to fail, the
16822 router declines, the value of &%address_data%& remains unchanged, and the
16823 &%more%& option controls what happens next. Other expansion failures cause
16824 delivery of the address to be deferred.
16825
16826 .vindex "&$address_data$&"
16827 When the expansion succeeds, the value is retained with the address, and can be
16828 accessed using the variable &$address_data$& in the current router, subsequent
16829 routers, and the eventual transport.
16830
16831 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16832 that runs a user's filter file, the contents of &$address_data$& are accessible
16833 in the filter. This is not normally a problem, because such data is usually
16834 either not confidential or it &"belongs"& to the current user, but if you do
16835 put confidential data into &$address_data$& you need to remember this point.
16836
16837 Even if the router declines or passes, the value of &$address_data$& remains
16838 with the address, though it can be changed by another &%address_data%& setting
16839 on a subsequent router. If a router generates child addresses, the value of
16840 &$address_data$& propagates to them. This also applies to the special kind of
16841 &"child"& that is generated by a router with the &%unseen%& option.
16842
16843 The idea of &%address_data%& is that you can use it to look up a lot of data
16844 for the address once, and then pick out parts of the data later. For example,
16845 you could use a single LDAP lookup to return a string of the form
16846 .code
16847 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16848 .endd
16849 In the transport you could pick out the mailbox by a setting such as
16850 .code
16851 file = ${extract{mailbox}{$address_data}}
16852 .endd
16853 This makes the configuration file less messy, and also reduces the number of
16854 lookups (though Exim does cache lookups).
16855
16856 .vindex "&$sender_address_data$&"
16857 .vindex "&$address_data$&"
16858 The &%address_data%& facility is also useful as a means of passing information
16859 from one router to another, and from a router to a transport. In addition, if
16860 &$address_data$& is set by a router when verifying a recipient address from an
16861 ACL, it remains available for use in the rest of the ACL statement. After
16862 verifying a sender, the value is transferred to &$sender_address_data$&.
16863
16864
16865
16866 .option address_test routers&!? boolean true
16867 .oindex "&%-bt%&"
16868 .cindex "router" "skipping when address testing"
16869 If this option is set false, the router is skipped when routing is being tested
16870 by means of the &%-bt%& command line option. This can be a convenience when
16871 your first router sends messages to an external scanner, because it saves you
16872 having to set the &"already scanned"& indicator when testing real address
16873 routing.
16874
16875
16876
16877 .option cannot_route_message routers string&!! unset
16878 .cindex "router" "customizing &""cannot route""& message"
16879 .cindex "customizing" "&""cannot route""& message"
16880 This option specifies a text message that is used when an address cannot be
16881 routed because Exim has run out of routers. The default message is
16882 &"Unrouteable address"&. This option is useful only on routers that have
16883 &%more%& set false, or on the very last router in a configuration, because the
16884 value that is used is taken from the last router that is considered. This
16885 includes a router that is skipped because its preconditions are not met, as
16886 well as a router that declines. For example, using the default configuration,
16887 you could put:
16888 .code
16889 cannot_route_message = Remote domain not found in DNS
16890 .endd
16891 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16892 and
16893 .code
16894 cannot_route_message = Unknown local user
16895 .endd
16896 on the final router that checks for local users. If string expansion fails for
16897 this option, the default message is used. Unless the expansion failure was
16898 explicitly forced, a message about the failure is written to the main and panic
16899 logs, in addition to the normal message about the routing failure.
16900
16901
16902 .option caseful_local_part routers boolean false
16903 .cindex "case of local parts"
16904 .cindex "router" "case of local parts"
16905 By default, routers handle the local parts of addresses in a case-insensitive
16906 manner, though the actual case is preserved for transmission with the message.
16907 If you want the case of letters to be significant in a router, you must set
16908 this option true. For individual router options that contain address or local
16909 part lists (for example, &%local_parts%&), case-sensitive matching can be
16910 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16911 more details.
16912
16913 .vindex "&$local_part$&"
16914 .vindex "&$original_local_part$&"
16915 .vindex "&$parent_local_part$&"
16916 The value of the &$local_part$& variable is forced to lower case while a
16917 router is running unless &%caseful_local_part%& is set. When a router assigns
16918 an address to a transport, the value of &$local_part$& when the transport runs
16919 is the same as it was in the router. Similarly, when a router generates child
16920 addresses by aliasing or forwarding, the values of &$original_local_part$&
16921 and &$parent_local_part$& are those that were used by the redirecting router.
16922
16923 This option applies to the processing of an address by a router. When a
16924 recipient address is being processed in an ACL, there is a separate &%control%&
16925 modifier that can be used to specify case-sensitive processing within the ACL
16926 (see section &<<SECTcontrols>>&).
16927
16928
16929
16930 .option check_local_user routers&!? boolean false
16931 .cindex "local user, checking in router"
16932 .cindex "router" "checking for local user"
16933 .cindex "&_/etc/passwd_&"
16934 .vindex "&$home$&"
16935 When this option is true, Exim checks that the local part of the recipient
16936 address (with affixes removed if relevant) is the name of an account on the
16937 local system. The check is done by calling the &[getpwnam()]& function rather
16938 than trying to read &_/etc/passwd_& directly. This means that other methods of
16939 holding password data (such as NIS) are supported. If the local part is a local
16940 user, &$home$& is set from the password data, and can be tested in other
16941 preconditions that are evaluated after this one (the order of evaluation is
16942 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16943 overridden by &%router_home_directory%&. If the local part is not a local user,
16944 the router is skipped.
16945
16946 If you want to check that the local part is either the name of a local user
16947 or matches something else, you cannot combine &%check_local_user%& with a
16948 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16949 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16950 setting to achieve this. For example:
16951 .code
16952 local_parts = passwd;$local_part : lsearch;/etc/other/users
16953 .endd
16954 Note, however, that the side effects of &%check_local_user%& (such as setting
16955 up a home directory) do not occur when a &(passwd)& lookup is used in a
16956 &%local_parts%& (or any other) precondition.
16957
16958
16959
16960 .option condition routers&!? string&!! unset
16961 .cindex "router" "customized precondition"
16962 This option specifies a general precondition test that has to succeed for the
16963 router to be called. The &%condition%& option is the last precondition to be
16964 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16965 result is a forced failure, or an empty string, or one of the strings &"0"& or
16966 &"no"& or &"false"& (checked without regard to the case of the letters), the
16967 router is skipped, and the address is offered to the next one.
16968
16969 If the result is any other value, the router is run (as this is the last
16970 precondition to be evaluated, all the other preconditions must be true).
16971
16972 This option is unusual in that multiple &%condition%& options may be present.
16973 All &%condition%& options must succeed.
16974
16975 The &%condition%& option provides a means of applying custom conditions to the
16976 running of routers. Note that in the case of a simple conditional expansion,
16977 the default expansion values are exactly what is wanted. For example:
16978 .code
16979 condition = ${if >{$message_age}{600}}
16980 .endd
16981 Because of the default behaviour of the string expansion, this is equivalent to
16982 .code
16983 condition = ${if >{$message_age}{600}{true}{}}
16984 .endd
16985
16986 A multiple condition example, which succeeds:
16987 .code
16988 condition = ${if >{$message_age}{600}}
16989 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16990 condition = foobar
16991 .endd
16992
16993 If the expansion fails (other than forced failure) delivery is deferred. Some
16994 of the other precondition options are common special cases that could in fact
16995 be specified using &%condition%&.
16996
16997 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16998 are far older, and use one set of semantics.  ACLs are newer and when
16999 they were created, the ACL &%condition%& process was given far stricter
17000 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17001 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17002 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17003 Router rules processing behavior.
17004
17005 This is best illustrated in an example:
17006 .code
17007 # If used in an ACL condition will fail with a syntax error, but
17008 # in a router condition any extra characters are treated as a string
17009
17010 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17011 true {yes} {no}}
17012
17013 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17014  {yes} {no}}
17015 .endd
17016 In each example above, the &%if%& statement actually ends after
17017 &"{google.com}}"&.  Since no true or false braces were defined, the
17018 default &%if%& behavior is to return a boolean true or a null answer
17019 (which evaluates to false). The rest of the line is then treated as a
17020 string. So the first example resulted in the boolean answer &"true"&
17021 with the string &" {yes} {no}}"& appended to it. The second example
17022 resulted in the null output (indicating false) with the string
17023 &" {yes} {no}}"& appended to it.
17024
17025 In fact you can put excess forward braces in too.  In the router
17026 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17027 mean something, like after a &"$"& or when required as part of a
17028 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17029 string characters.
17030
17031 Thus, in a Router, the above expansion strings will both always evaluate
17032 true, as the result of expansion is a non-empty string which doesn't
17033 match an explicit false value.  This can be tricky to debug.  By
17034 contrast, in an ACL either of those strings will always result in an
17035 expansion error because the result doesn't look sufficiently boolean.
17036
17037
17038 .option debug_print routers string&!! unset
17039 .cindex "testing" "variables in drivers"
17040 If this option is set and debugging is enabled (see the &%-d%& command line
17041 option) or in address-testing mode (see the &%-bt%& command line option),
17042 the string is expanded and included in the debugging output.
17043 If expansion of the string fails, the error message is written to the debugging
17044 output, and Exim carries on processing.
17045 This option is provided to help with checking out the values of variables and
17046 so on when debugging router configurations. For example, if a &%condition%&
17047 option appears not to be working, &%debug_print%& can be used to output the
17048 variables it references. The output happens after checks for &%domains%&,
17049 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17050 are tested. A newline is added to the text if it does not end with one.
17051 The variable &$router_name$& contains the name of the router.
17052
17053
17054
17055 .option disable_logging routers boolean false
17056 If this option is set true, nothing is logged for any routing errors
17057 or for any deliveries caused by this router. You should not set this option
17058 unless you really, really know what you are doing. See also the generic
17059 transport option of the same name.
17060
17061 .option dnssec_request_domains routers "domain list&!!" unset
17062 .cindex "MX record" "security"
17063 .cindex "DNSSEC" "MX lookup"
17064 .cindex "security" "MX lookup"
17065 .cindex "DNS" "DNSSEC"
17066 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17067 the dnssec request bit set.
17068 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17069
17070 .option dnssec_require_domains routers "domain list&!!" unset
17071 .cindex "MX record" "security"
17072 .cindex "DNSSEC" "MX lookup"
17073 .cindex "security" "MX lookup"
17074 .cindex "DNS" "DNSSEC"
17075 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17076 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17077 (AD bit) set will be ignored and logged as a host-lookup failure.
17078 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17079
17080
17081 .option domains routers&!? "domain list&!!" unset
17082 .cindex "router" "restricting to specific domains"
17083 .vindex "&$domain_data$&"
17084 If this option is set, the router is skipped unless the current domain matches
17085 the list. If the match is achieved by means of a file lookup, the data that the
17086 lookup returned for the domain is placed in &$domain_data$& for use in string
17087 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17088 a list of the order in which preconditions are evaluated.
17089
17090
17091
17092 .option driver routers string unset
17093 This option must always be set. It specifies which of the available routers is
17094 to be used.
17095
17096
17097 .new
17098 .option dsn_lasthop routers boolean false
17099 .cindex "DSN" "success"
17100 .cindex "Delivery Status Notification" "success"
17101 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17102 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17103 instead send a success DSN as if the next hop does not support DSN.
17104 Not effective on redirect routers.
17105 .wen
17106
17107
17108
17109 .option errors_to routers string&!! unset
17110 .cindex "envelope sender"
17111 .cindex "router" "changing address for errors"
17112 If a router successfully handles an address, it may assign the address to a
17113 transport for delivery or it may generate child addresses. In both cases, if
17114 there is a delivery problem during later processing, the resulting bounce
17115 message is sent to the address that results from expanding this string,
17116 provided that the address verifies successfully. The &%errors_to%& option is
17117 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17118
17119 The &%errors_to%& setting associated with an address can be overridden if it
17120 subsequently passes through other routers that have their own &%errors_to%&
17121 settings, or if the message is delivered by a transport with a &%return_path%&
17122 setting.
17123
17124 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17125 the expansion fails to verify, the errors address associated with the incoming
17126 address is used. At top level, this is the envelope sender. A non-forced
17127 expansion failure causes delivery to be deferred.
17128
17129 If an address for which &%errors_to%& has been set ends up being delivered over
17130 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17131 any bounces that are generated by other MTAs on the delivery route are also
17132 sent there. You can set &%errors_to%& to the empty string by either of these
17133 settings:
17134 .code
17135 errors_to =
17136 errors_to = ""
17137 .endd
17138 An expansion item that yields an empty string has the same effect. If you do
17139 this, a locally detected delivery error for addresses processed by this router
17140 no longer gives rise to a bounce message; the error is discarded. If the
17141 address is delivered to a remote host, the return path is set to &`<>`&, unless
17142 overridden by the &%return_path%& option on the transport.
17143
17144 .vindex "&$address_data$&"
17145 If for some reason you want to discard local errors, but use a non-empty
17146 MAIL command for remote delivery, you can preserve the original return
17147 path in &$address_data$& in the router, and reinstate it in the transport by
17148 setting &%return_path%&.
17149
17150 The most common use of &%errors_to%& is to direct mailing list bounces to the
17151 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17152 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17153
17154
17155
17156 .option expn routers&!? boolean true
17157 .cindex "address" "testing"
17158 .cindex "testing" "addresses"
17159 .cindex "EXPN" "router skipping"
17160 .cindex "router" "skipping for EXPN"
17161 If this option is turned off, the router is skipped when testing an address
17162 as a result of processing an SMTP EXPN command. You might, for example,
17163 want to turn it off on a router for users' &_.forward_& files, while leaving it
17164 on for the system alias file.
17165 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17166 are evaluated.
17167
17168 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17169 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17170 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17171
17172
17173
17174 .option fail_verify routers boolean false
17175 .cindex "router" "forcing verification failure"
17176 Setting this option has the effect of setting both &%fail_verify_sender%& and
17177 &%fail_verify_recipient%& to the same value.
17178
17179
17180
17181 .option fail_verify_recipient routers boolean false
17182 If this option is true and an address is accepted by this router when
17183 verifying a recipient, verification fails.
17184
17185
17186
17187 .option fail_verify_sender routers boolean false
17188 If this option is true and an address is accepted by this router when
17189 verifying a sender, verification fails.
17190
17191
17192
17193 .option fallback_hosts routers "string list" unset
17194 .cindex "router" "fallback hosts"
17195 .cindex "fallback" "hosts specified on router"
17196 String expansion is not applied to this option. The argument must be a
17197 colon-separated list of host names or IP addresses. The list separator can be
17198 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17199 each name or address. In fact, the format of each item is exactly the same as
17200 defined for the list of hosts in a &(manualroute)& router (see section
17201 &<<SECTformatonehostitem>>&).
17202
17203 If a router queues an address for a remote transport, this host list is
17204 associated with the address, and used instead of the transport's fallback host
17205 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17206 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17207 transport for further details.
17208
17209
17210 .option group routers string&!! "see below"
17211 .cindex "gid (group id)" "local delivery"
17212 .cindex "local transports" "uid and gid"
17213 .cindex "transport" "local"
17214 .cindex "router" "setting group"
17215 When a router queues an address for a transport, and the transport does not
17216 specify a group, the group given here is used when running the delivery
17217 process.
17218 The group may be specified numerically or by name. If expansion fails, the
17219 error is logged and delivery is deferred.
17220 The default is unset, unless &%check_local_user%& is set, when the default
17221 is taken from the password information. See also &%initgroups%& and &%user%&
17222 and the discussion in chapter &<<CHAPenvironment>>&.
17223
17224
17225
17226 .option headers_add routers list&!! unset
17227 .cindex "header lines" "adding"
17228 .cindex "router" "adding header lines"
17229 This option specifies a list of text headers,
17230 .new
17231 newline-separated (by default, changeable in the usual way),
17232 .wen
17233 that is associated with any addresses that are accepted by the router.
17234 Each item is separately expanded, at routing time.  However, this
17235 option has no effect when an address is just being verified. The way in which
17236 the text is used to add header lines at transport time is described in section
17237 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17238 message is in the process of being transported. This means that references to
17239 header lines in string expansions in the transport's configuration do not
17240 &"see"& the added header lines.
17241
17242 The &%headers_add%& option is expanded after &%errors_to%&, but before
17243 &%headers_remove%& and &%transport%&. If an item is empty, or if
17244 an item expansion is forced to fail, the item has no effect. Other expansion
17245 failures are treated as configuration errors.
17246
17247 Unlike most options, &%headers_add%& can be specified multiple times
17248 for a router; all listed headers are added.
17249
17250 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17251 router that has the &%one_time%& option set.
17252
17253 .cindex "duplicate addresses"
17254 .oindex "&%unseen%&"
17255 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17256 additions are deleted when the address is passed on to subsequent routers.
17257 For a &%redirect%& router, if a generated address is the same as the incoming
17258 address, this can lead to duplicate addresses with different header
17259 modifications. Exim does not do duplicate deliveries (except, in certain
17260 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17261 which of the duplicates is discarded, so this ambiguous situation should be
17262 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17263
17264
17265
17266 .option headers_remove routers list&!! unset
17267 .cindex "header lines" "removing"
17268 .cindex "router" "removing header lines"
17269 This option specifies a list of text headers,
17270 .new
17271 colon-separated (by default, changeable in the usual way),
17272 .wen
17273 that is associated with any addresses that are accepted by the router.
17274 Each item is separately expanded, at routing time.  However, this
17275 option has no effect when an address is just being verified. The way in which
17276 the text is used to remove header lines at transport time is described in
17277 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17278 the message is in the process of being transported. This means that references
17279 to header lines in string expansions in the transport's configuration still
17280 &"see"& the original header lines.
17281
17282 The &%headers_remove%& option is expanded after &%errors_to%& and
17283 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17284 the item has no effect. Other expansion failures are treated as configuration
17285 errors.
17286
17287 Unlike most options, &%headers_remove%& can be specified multiple times
17288 for a router; all listed headers are removed.
17289
17290 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17291 router that has the &%one_time%& option set.
17292
17293 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17294 removal requests are deleted when the address is passed on to subsequent
17295 routers, and this can lead to problems with duplicates -- see the similar
17296 warning for &%headers_add%& above.
17297
17298
17299 .option ignore_target_hosts routers "host list&!!" unset
17300 .cindex "IP address" "discarding"
17301 .cindex "router" "discarding IP addresses"
17302 Although this option is a host list, it should normally contain IP address
17303 entries rather than names. If any host that is looked up by the router has an
17304 IP address that matches an item in this list, Exim behaves as if that IP
17305 address did not exist. This option allows you to cope with rogue DNS entries
17306 like
17307 .code
17308 remote.domain.example.  A  127.0.0.1
17309 .endd
17310 by setting
17311 .code
17312 ignore_target_hosts = 127.0.0.1
17313 .endd
17314 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17315 discarded in this way, the router declines. In a conventional configuration, an
17316 attempt to mail to such a domain would normally provoke the &"unrouteable
17317 domain"& error, and an attempt to verify an address in the domain would fail.
17318 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17319 router declines if presented with one of the listed addresses.
17320
17321 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17322 means of the first or the second of the following settings, respectively:
17323 .code
17324 ignore_target_hosts = 0.0.0.0/0
17325 ignore_target_hosts = <; 0::0/0
17326 .endd
17327 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17328 in the second line matches all IPv6 addresses.
17329
17330 This option may also be useful for ignoring link-local and site-local IPv6
17331 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17332 is expanded before use as a list, it is possible to make it dependent on the
17333 domain that is being routed.
17334
17335 .vindex "&$host_address$&"
17336 During its expansion, &$host_address$& is set to the IP address that is being
17337 checked.
17338
17339 .option initgroups routers boolean false
17340 .cindex "additional groups"
17341 .cindex "groups" "additional"
17342 .cindex "local transports" "uid and gid"
17343 .cindex "transport" "local"
17344 If the router queues an address for a transport, and this option is true, and
17345 the uid supplied by the router is not overridden by the transport, the
17346 &[initgroups()]& function is called when running the transport to ensure that
17347 any additional groups associated with the uid are set up. See also &%group%&
17348 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17349
17350
17351
17352 .option local_part_prefix routers&!? "string list" unset
17353 .cindex "router" "prefix for local part"
17354 .cindex "prefix" "for local part, used in router"
17355 If this option is set, the router is skipped unless the local part starts with
17356 one of the given strings, or &%local_part_prefix_optional%& is true. See
17357 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17358 evaluated.
17359
17360 The list is scanned from left to right, and the first prefix that matches is
17361 used. A limited form of wildcard is available; if the prefix begins with an
17362 asterisk, it matches the longest possible sequence of arbitrary characters at
17363 the start of the local part. An asterisk should therefore always be followed by
17364 some character that does not occur in normal local parts.
17365 .cindex "multiple mailboxes"
17366 .cindex "mailbox" "multiple"
17367 Wildcarding can be used to set up multiple user mailboxes, as described in
17368 section &<<SECTmulbox>>&.
17369
17370 .vindex "&$local_part$&"
17371 .vindex "&$local_part_prefix$&"
17372 During the testing of the &%local_parts%& option, and while the router is
17373 running, the prefix is removed from the local part, and is available in the
17374 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17375 the router accepts the address, this remains true during subsequent delivery by
17376 a transport. In particular, the local part that is transmitted in the RCPT
17377 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17378 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17379 the relevant transport.
17380
17381 When an address is being verified, &%local_part_prefix%& affects only the
17382 behaviour of the router. If the callout feature of verification is in use, this
17383 means that the full address, including the prefix, will be used during the
17384 callout.
17385
17386 The prefix facility is commonly used to handle local parts of the form
17387 &%owner-something%&. Another common use is to support local parts of the form
17388 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17389 to tell a user their forwarding is broken &-- by placing a router like this one
17390 immediately before the router that handles &_.forward_& files:
17391 .code
17392 real_localuser:
17393   driver = accept
17394   local_part_prefix = real-
17395   check_local_user
17396   transport = local_delivery
17397 .endd
17398 For security, it would probably be a good idea to restrict the use of this
17399 router to locally-generated messages, using a condition such as this:
17400 .code
17401   condition = ${if match {$sender_host_address}\
17402                          {\N^(|127\.0\.0\.1)$\N}}
17403 .endd
17404
17405 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17406 both conditions must be met if not optional. Care must be taken if wildcards
17407 are used in both a prefix and a suffix on the same router. Different
17408 separator characters must be used to avoid ambiguity.
17409
17410
17411 .option local_part_prefix_optional routers boolean false
17412 See &%local_part_prefix%& above.
17413
17414
17415
17416 .option local_part_suffix routers&!? "string list" unset
17417 .cindex "router" "suffix for local part"
17418 .cindex "suffix for local part" "used in router"
17419 This option operates in the same way as &%local_part_prefix%&, except that the
17420 local part must end (rather than start) with the given string, the
17421 &%local_part_suffix_optional%& option determines whether the suffix is
17422 mandatory, and the wildcard * character, if present, must be the last
17423 character of the suffix. This option facility is commonly used to handle local
17424 parts of the form &%something-request%& and multiple user mailboxes of the form
17425 &%username-foo%&.
17426
17427
17428 .option local_part_suffix_optional routers boolean false
17429 See &%local_part_suffix%& above.
17430
17431
17432
17433 .option local_parts routers&!? "local part list&!!" unset
17434 .cindex "router" "restricting to specific local parts"
17435 .cindex "local part" "checking in router"
17436 The router is run only if the local part of the address matches the list.
17437 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17438 are evaluated, and
17439 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17440 string is expanded, it is possible to make it depend on the domain, for
17441 example:
17442 .code
17443 local_parts = dbm;/usr/local/specials/$domain
17444 .endd
17445 .vindex "&$local_part_data$&"
17446 If the match is achieved by a lookup, the data that the lookup returned
17447 for the local part is placed in the variable &$local_part_data$& for use in
17448 expansions of the router's private options. You might use this option, for
17449 example, if you have a large number of local virtual domains, and you want to
17450 send all postmaster mail to the same place without having to set up an alias in
17451 each virtual domain:
17452 .code
17453 postmaster:
17454   driver = redirect
17455   local_parts = postmaster
17456   data = postmaster@real.domain.example
17457 .endd
17458
17459
17460 .option log_as_local routers boolean "see below"
17461 .cindex "log" "delivery line"
17462 .cindex "delivery" "log line format"
17463 Exim has two logging styles for delivery, the idea being to make local
17464 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17465 recipient address is given just as the local part, without a domain. The use of
17466 this style is controlled by this option. It defaults to true for the &(accept)&
17467 router, and false for all the others. This option applies only when a
17468 router assigns an address to a transport. It has no effect on routers that
17469 redirect addresses.
17470
17471
17472
17473 .option more routers boolean&!! true
17474 The result of string expansion for this option must be a valid boolean value,
17475 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17476 result causes an error, and delivery is deferred. If the expansion is forced to
17477 fail, the default value for the option (true) is used. Other failures cause
17478 delivery to be deferred.
17479
17480 If this option is set false, and the router declines to handle the address, no
17481 further routers are tried, routing fails, and the address is bounced.
17482 .oindex "&%self%&"
17483 However, if the router explicitly passes an address to the following router by
17484 means of the setting
17485 .code
17486 self = pass
17487 .endd
17488 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17489 does not affect the behaviour if one of the precondition tests fails. In that
17490 case, the address is always passed to the next router.
17491
17492 Note that &%address_data%& is not considered to be a precondition. If its
17493 expansion is forced to fail, the router declines, and the value of &%more%&
17494 controls what happens next.
17495
17496
17497 .option pass_on_timeout routers boolean false
17498 .cindex "timeout" "of router"
17499 .cindex "router" "timeout"
17500 If a router times out during a host lookup, it normally causes deferral of the
17501 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17502 router, overriding &%no_more%&. This may be helpful for systems that are
17503 intermittently connected to the Internet, or those that want to pass to a smart
17504 host any messages that cannot immediately be delivered.
17505
17506 There are occasional other temporary errors that can occur while doing DNS
17507 lookups. They are treated in the same way as a timeout, and this option
17508 applies to all of them.
17509
17510
17511
17512 .option pass_router routers string unset
17513 .cindex "router" "go to after &""pass""&"
17514 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17515 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17516 routing to continue, and overriding a false setting of &%more%&. When one of
17517 these routers returns &"pass"&, the address is normally handed on to the next
17518 router in sequence. This can be changed by setting &%pass_router%& to the name
17519 of another router. However (unlike &%redirect_router%&) the named router must
17520 be below the current router, to avoid loops. Note that this option applies only
17521 to the special case of &"pass"&. It does not apply when a router returns
17522 &"decline"& because it cannot handle an address.
17523
17524
17525
17526 .option redirect_router routers string unset
17527 .cindex "router" "start at after redirection"
17528 Sometimes an administrator knows that it is pointless to reprocess addresses
17529 generated from alias or forward files with the same router again. For
17530 example, if an alias file translates real names into login ids there is no
17531 point searching the alias file a second time, especially if it is a large file.
17532
17533 The &%redirect_router%& option can be set to the name of any router instance.
17534 It causes the routing of any generated addresses to start at the named router
17535 instead of at the first router. This option has no effect if the router in
17536 which it is set does not generate new addresses.
17537
17538
17539
17540 .option require_files routers&!? "string list&!!" unset
17541 .cindex "file" "requiring for router"
17542 .cindex "router" "requiring file existence"
17543 This option provides a general mechanism for predicating the running of a
17544 router on the existence or non-existence of certain files or directories.
17545 Before running a router, as one of its precondition tests, Exim works its way
17546 through the &%require_files%& list, expanding each item separately.
17547
17548 Because the list is split before expansion, any colons in expansion items must
17549 be doubled, or the facility for using a different list separator must be used.
17550 If any expansion is forced to fail, the item is ignored. Other expansion
17551 failures cause routing of the address to be deferred.
17552
17553 If any expanded string is empty, it is ignored. Otherwise, except as described
17554 below, each string must be a fully qualified file path, optionally preceded by
17555 &"!"&. The paths are passed to the &[stat()]& function to test for the
17556 existence of the files or directories. The router is skipped if any paths not
17557 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17558
17559 .cindex "NFS"
17560 If &[stat()]& cannot determine whether a file exists or not, delivery of
17561 the message is deferred. This can happen when NFS-mounted filesystems are
17562 unavailable.
17563
17564 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17565 options, so you cannot use it to check for the existence of a file in which to
17566 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17567 full list of the order in which preconditions are evaluated.) However, as
17568 these options are all expanded, you can use the &%exists%& expansion condition
17569 to make such tests. The &%require_files%& option is intended for checking files
17570 that the router may be going to use internally, or which are needed by a
17571 transport (for example &_.procmailrc_&).
17572
17573 During delivery, the &[stat()]& function is run as root, but there is a
17574 facility for some checking of the accessibility of a file by another user.
17575 This is not a proper permissions check, but just a &"rough"& check that
17576 operates as follows:
17577
17578 If an item in a &%require_files%& list does not contain any forward slash
17579 characters, it is taken to be the user (and optional group, separated by a
17580 comma) to be checked for subsequent files in the list. If no group is specified
17581 but the user is specified symbolically, the gid associated with the uid is
17582 used. For example:
17583 .code
17584 require_files = mail:/some/file
17585 require_files = $local_part:$home/.procmailrc
17586 .endd
17587 If a user or group name in a &%require_files%& list does not exist, the
17588 &%require_files%& condition fails.
17589
17590 Exim performs the check by scanning along the components of the file path, and
17591 checking the access for the given uid and gid. It checks for &"x"& access on
17592 directories, and &"r"& access on the final file. Note that this means that file
17593 access control lists, if the operating system has them, are ignored.
17594
17595 &*Warning 1*&: When the router is being run to verify addresses for an
17596 incoming SMTP message, Exim is not running as root, but under its own uid. This
17597 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17598 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17599 user is not permitted to read one of the directories on the file's path.
17600
17601 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17602 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17603 without root access. In this case, if a check for access by a particular user
17604 is requested, Exim creates a subprocess that runs as that user, and tries the
17605 check again in that process.
17606
17607 The default action for handling an unresolved EACCES is to consider it to
17608 be caused by a configuration error, and routing is deferred because the
17609 existence or non-existence of the file cannot be determined. However, in some
17610 circumstances it may be desirable to treat this condition as if the file did
17611 not exist. If the file name (or the exclamation mark that precedes the file
17612 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17613 as if the file did not exist. For example:
17614 .code
17615 require_files = +/some/file
17616 .endd
17617 If the router is not an essential part of verification (for example, it
17618 handles users' &_.forward_& files), another solution is to set the &%verify%&
17619 option false so that the router is skipped when verifying.
17620
17621
17622
17623 .option retry_use_local_part routers boolean "see below"
17624 .cindex "hints database" "retry keys"
17625 .cindex "local part" "in retry keys"
17626 When a delivery suffers a temporary routing failure, a retry record is created
17627 in Exim's hints database. For addresses whose routing depends only on the
17628 domain, the key for the retry record should not involve the local part, but for
17629 other addresses, both the domain and the local part should be included.
17630 Usually, remote routing is of the former kind, and local routing is of the
17631 latter kind.
17632
17633 This option controls whether the local part is used to form the key for retry
17634 hints for addresses that suffer temporary errors while being handled by this
17635 router. The default value is true for any router that has &%check_local_user%&
17636 set, and false otherwise. Note that this option does not apply to hints keys
17637 for transport delays; they are controlled by a generic transport option of the
17638 same name.
17639
17640 The setting of &%retry_use_local_part%& applies only to the router on which it
17641 appears. If the router generates child addresses, they are routed
17642 independently; this setting does not become attached to them.
17643
17644
17645
17646 .option router_home_directory routers string&!! unset
17647 .cindex "router" "home directory for"
17648 .cindex "home directory" "for router"
17649 .vindex "&$home$&"
17650 This option sets a home directory for use while the router is running. (Compare
17651 &%transport_home_directory%&, which sets a home directory for later
17652 transporting.) In particular, if used on a &(redirect)& router, this option
17653 sets a value for &$home$& while a filter is running. The value is expanded;
17654 forced expansion failure causes the option to be ignored &-- other failures
17655 cause the router to defer.
17656
17657 Expansion of &%router_home_directory%& happens immediately after the
17658 &%check_local_user%& test (if configured), before any further expansions take
17659 place.
17660 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17661 are evaluated.)
17662 While the router is running, &%router_home_directory%& overrides the value of
17663 &$home$& that came from &%check_local_user%&.
17664
17665 When a router accepts an address and assigns it to a local transport (including
17666 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17667 delivery), the home directory setting for the transport is taken from the first
17668 of these values that is set:
17669
17670 .ilist
17671 The &%home_directory%& option on the transport;
17672 .next
17673 The &%transport_home_directory%& option on the router;
17674 .next
17675 The password data if &%check_local_user%& is set on the router;
17676 .next
17677 The &%router_home_directory%& option on the router.
17678 .endlist
17679
17680 In other words, &%router_home_directory%& overrides the password data for the
17681 router, but not for the transport.
17682
17683
17684
17685 .option self routers string freeze
17686 .cindex "MX record" "pointing to local host"
17687 .cindex "local host" "MX pointing to"
17688 This option applies to those routers that use a recipient address to find a
17689 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17690 and &(manualroute)& routers.
17691 Certain configurations of the &(queryprogram)& router can also specify a list
17692 of remote hosts.
17693 Usually such routers are configured to send the message to a remote host via an
17694 &(smtp)& transport. The &%self%& option specifies what happens when the first
17695 host on the list turns out to be the local host.
17696 The way in which Exim checks for the local host is described in section
17697 &<<SECTreclocipadd>>&.
17698
17699 Normally this situation indicates either an error in Exim's configuration (for
17700 example, the router should be configured not to process this domain), or an
17701 error in the DNS (for example, the MX should not point to this host). For this
17702 reason, the default action is to log the incident, defer the address, and
17703 freeze the message. The following alternatives are provided for use in special
17704 cases:
17705
17706 .vlist
17707 .vitem &%defer%&
17708 Delivery of the message is tried again later, but the message is not frozen.
17709
17710 .vitem "&%reroute%&: <&'domain'&>"
17711 The domain is changed to the given domain, and the address is passed back to
17712 be reprocessed by the routers. No rewriting of headers takes place. This
17713 behaviour is essentially a redirection.
17714
17715 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17716 The domain is changed to the given domain, and the address is passed back to be
17717 reprocessed by the routers. Any headers that contain the original domain are
17718 rewritten.
17719
17720 .vitem &%pass%&
17721 .oindex "&%more%&"
17722 .vindex "&$self_hostname$&"
17723 The router passes the address to the next router, or to the router named in the
17724 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17725 subsequent routing and delivery, the variable &$self_hostname$& contains the
17726 name of the local host that the router encountered. This can be used to
17727 distinguish between different cases for hosts with multiple names. The
17728 combination
17729 .code
17730 self = pass
17731 no_more
17732 .endd
17733 ensures that only those addresses that routed to the local host are passed on.
17734 Without &%no_more%&, addresses that were declined for other reasons would also
17735 be passed to the next router.
17736
17737 .vitem &%fail%&
17738 Delivery fails and an error report is generated.
17739
17740 .vitem &%send%&
17741 .cindex "local host" "sending to"
17742 The anomaly is ignored and the address is queued for the transport. This
17743 setting should be used with extreme caution. For an &(smtp)& transport, it
17744 makes sense only in cases where the program that is listening on the SMTP port
17745 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17746 different configuration file that handles the domain in another way.
17747 .endlist
17748
17749
17750
17751 .option senders routers&!? "address list&!!" unset
17752 .cindex "router" "checking senders"
17753 If this option is set, the router is skipped unless the message's sender
17754 address matches something on the list.
17755 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17756 are evaluated.
17757
17758 There are issues concerning verification when the running of routers is
17759 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17760 setting, it sets the sender to the null string. When using the &%-bt%& option
17761 to check a configuration file, it is necessary also to use the &%-f%& option to
17762 set an appropriate sender. For incoming mail, the sender is unset when
17763 verifying the sender, but is available when verifying any recipients. If the
17764 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17765 matters.
17766
17767
17768 .option translate_ip_address routers string&!! unset
17769 .cindex "IP address" "translating"
17770 .cindex "packet radio"
17771 .cindex "router" "IP address translation"
17772 There exist some rare networking situations (for example, packet radio) where
17773 it is helpful to be able to translate IP addresses generated by normal routing
17774 mechanisms into other IP addresses, thus performing a kind of manual IP
17775 routing. This should be done only if the normal IP routing of the TCP/IP stack
17776 is inadequate or broken. Because this is an extremely uncommon requirement, the
17777 code to support this option is not included in the Exim binary unless
17778 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17779
17780 .vindex "&$host_address$&"
17781 The &%translate_ip_address%& string is expanded for every IP address generated
17782 by the router, with the generated address set in &$host_address$&. If the
17783 expansion is forced to fail, no action is taken.
17784 For any other expansion error, delivery of the message is deferred.
17785 If the result of the expansion is an IP address, that replaces the original
17786 address; otherwise the result is assumed to be a host name &-- this is looked
17787 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17788 produce one or more replacement IP addresses. For example, to subvert all IP
17789 addresses in some specific networks, this could be added to a router:
17790 .code
17791 translate_ip_address = \
17792   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17793     {$value}fail}}
17794 .endd
17795 The file would contain lines like
17796 .code
17797 10.2.3.128/26    some.host
17798 10.8.4.34/26     10.44.8.15
17799 .endd
17800 You should not make use of this facility unless you really understand what you
17801 are doing.
17802
17803
17804
17805 .option transport routers string&!! unset
17806 This option specifies the transport to be used when a router accepts an address
17807 and sets it up for delivery. A transport is never needed if a router is used
17808 only for verification. The value of the option is expanded at routing time,
17809 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17810 and result must be the name of one of the configured transports. If it is not,
17811 delivery is deferred.
17812
17813 The &%transport%& option is not used by the &(redirect)& router, but it does
17814 have some private options that set up transports for pipe and file deliveries
17815 (see chapter &<<CHAPredirect>>&).
17816
17817
17818
17819 .option transport_current_directory routers string&!! unset
17820 .cindex "current directory for local transport"
17821 This option associates a current directory with any address that is routed
17822 to a local transport. This can happen either because a transport is
17823 explicitly configured for the router, or because it generates a delivery to a
17824 file or a pipe. During the delivery process (that is, at transport time), this
17825 option string is expanded and is set as the current directory, unless
17826 overridden by a setting on the transport.
17827 If the expansion fails for any reason, including forced failure, an error is
17828 logged, and delivery is deferred.
17829 See chapter &<<CHAPenvironment>>& for details of the local delivery
17830 environment.
17831
17832
17833
17834
17835 .option transport_home_directory routers string&!! "see below"
17836 .cindex "home directory" "for local transport"
17837 This option associates a home directory with any address that is routed to a
17838 local transport. This can happen either because a transport is explicitly
17839 configured for the router, or because it generates a delivery to a file or a
17840 pipe. During the delivery process (that is, at transport time), the option
17841 string is expanded and is set as the home directory, unless overridden by a
17842 setting of &%home_directory%& on the transport.
17843 If the expansion fails for any reason, including forced failure, an error is
17844 logged, and delivery is deferred.
17845
17846 If the transport does not specify a home directory, and
17847 &%transport_home_directory%& is not set for the router, the home directory for
17848 the transport is taken from the password data if &%check_local_user%& is set for
17849 the router. Otherwise it is taken from &%router_home_directory%& if that option
17850 is set; if not, no home directory is set for the transport.
17851
17852 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17853 environment.
17854
17855
17856
17857
17858 .option unseen routers boolean&!! false
17859 .cindex "router" "carrying on after success"
17860 The result of string expansion for this option must be a valid boolean value,
17861 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17862 result causes an error, and delivery is deferred. If the expansion is forced to
17863 fail, the default value for the option (false) is used. Other failures cause
17864 delivery to be deferred.
17865
17866 When this option is set true, routing does not cease if the router accepts the
17867 address. Instead, a copy of the incoming address is passed to the next router,
17868 overriding a false setting of &%more%&. There is little point in setting
17869 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17870 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17871 sometimes true and sometimes false).
17872
17873 .cindex "copy of message (&%unseen%& option)"
17874 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17875 qualifier in filter files. It can be used to cause copies of messages to be
17876 delivered to some other destination, while also carrying out a normal delivery.
17877 In effect, the current address is made into a &"parent"& that has two children
17878 &-- one that is delivered as specified by this router, and a clone that goes on
17879 to be routed further. For this reason, &%unseen%& may not be combined with the
17880 &%one_time%& option in a &(redirect)& router.
17881
17882 &*Warning*&: Header lines added to the address (or specified for removal) by
17883 this router or by previous routers affect the &"unseen"& copy of the message
17884 only. The clone that continues to be processed by further routers starts with
17885 no added headers and none specified for removal. For a &%redirect%& router, if
17886 a generated address is the same as the incoming address, this can lead to
17887 duplicate addresses with different header modifications. Exim does not do
17888 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17889 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17890 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17891 &%redirect%& router may be of help.
17892
17893 Unlike the handling of header modifications, any data that was set by the
17894 &%address_data%& option in the current or previous routers &'is'& passed on to
17895 subsequent routers.
17896
17897
17898 .option user routers string&!! "see below"
17899 .cindex "uid (user id)" "local delivery"
17900 .cindex "local transports" "uid and gid"
17901 .cindex "transport" "local"
17902 .cindex "router" "user for filter processing"
17903 .cindex "filter" "user for processing"
17904 When a router queues an address for a transport, and the transport does not
17905 specify a user, the user given here is used when running the delivery process.
17906 The user may be specified numerically or by name. If expansion fails, the
17907 error is logged and delivery is deferred.
17908 This user is also used by the &(redirect)& router when running a filter file.
17909 The default is unset, except when &%check_local_user%& is set. In this case,
17910 the default is taken from the password information. If the user is specified as
17911 a name, and &%group%& is not set, the group associated with the user is used.
17912 See also &%initgroups%& and &%group%& and the discussion in chapter
17913 &<<CHAPenvironment>>&.
17914
17915
17916
17917 .option verify routers&!? boolean true
17918 Setting this option has the effect of setting &%verify_sender%& and
17919 &%verify_recipient%& to the same value.
17920
17921
17922 .option verify_only routers&!? boolean false
17923 .cindex "EXPN" "with &%verify_only%&"
17924 .oindex "&%-bv%&"
17925 .cindex "router" "used only when verifying"
17926 If this option is set, the router is used only when verifying an address,
17927 delivering in cutthrough mode or
17928 testing with the &%-bv%& option, not when actually doing a delivery, testing
17929 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17930 restricted to verifying only senders or recipients by means of
17931 &%verify_sender%& and &%verify_recipient%&.
17932
17933 &*Warning*&: When the router is being run to verify addresses for an incoming
17934 SMTP message, Exim is not running as root, but under its own uid. If the router
17935 accesses any files, you need to make sure that they are accessible to the Exim
17936 user or group.
17937
17938
17939 .option verify_recipient routers&!? boolean true
17940 If this option is false, the router is skipped when verifying recipient
17941 addresses,
17942 delivering in cutthrough mode
17943 or testing recipient verification using &%-bv%&.
17944 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17945 are evaluated.
17946 See also the &$verify_mode$& variable.
17947
17948
17949 .option verify_sender routers&!? boolean true
17950 If this option is false, the router is skipped when verifying sender addresses
17951 or testing sender verification using &%-bvs%&.
17952 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17953 are evaluated.
17954 See also the &$verify_mode$& variable.
17955 .ecindex IIDgenoprou1
17956 .ecindex IIDgenoprou2
17957
17958
17959
17960
17961
17962
17963 . ////////////////////////////////////////////////////////////////////////////
17964 . ////////////////////////////////////////////////////////////////////////////
17965
17966 .chapter "The accept router" "CHID4"
17967 .cindex "&(accept)& router"
17968 .cindex "routers" "&(accept)&"
17969 The &(accept)& router has no private options of its own. Unless it is being
17970 used purely for verification (see &%verify_only%&) a transport is required to
17971 be defined by the generic &%transport%& option. If the preconditions that are
17972 specified by generic options are met, the router accepts the address and queues
17973 it for the given transport. The most common use of this router is for setting
17974 up deliveries to local mailboxes. For example:
17975 .code
17976 localusers:
17977   driver = accept
17978   domains = mydomain.example
17979   check_local_user
17980   transport = local_delivery
17981 .endd
17982 The &%domains%& condition in this example checks the domain of the address, and
17983 &%check_local_user%& checks that the local part is the login of a local user.
17984 When both preconditions are met, the &(accept)& router runs, and queues the
17985 address for the &(local_delivery)& transport.
17986
17987
17988
17989
17990
17991
17992 . ////////////////////////////////////////////////////////////////////////////
17993 . ////////////////////////////////////////////////////////////////////////////
17994
17995 .chapter "The dnslookup router" "CHAPdnslookup"
17996 .scindex IIDdnsrou1 "&(dnslookup)& router"
17997 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17998 The &(dnslookup)& router looks up the hosts that handle mail for the
17999 recipient's domain in the DNS. A transport must always be set for this router,
18000 unless &%verify_only%& is set.
18001
18002 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18003 SRV records. If none are found, or if SRV support is not configured,
18004 MX records are looked up. If no MX records exist, address records are sought.
18005 However, &%mx_domains%& can be set to disable the direct use of address
18006 records.
18007
18008 MX records of equal priority are sorted by Exim into a random order. Exim then
18009 looks for address records for the host names obtained from MX or SRV records.
18010 When a host has more than one IP address, they are sorted into a random order,
18011 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18012 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18013 generic option, the router declines.
18014
18015 Unless they have the highest priority (lowest MX value), MX records that point
18016 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18017 are discarded, together with any other MX records of equal or lower priority.
18018
18019 .cindex "MX record" "pointing to local host"
18020 .cindex "local host" "MX pointing to"
18021 .oindex "&%self%&" "in &(dnslookup)& router"
18022 If the host pointed to by the highest priority MX record, or looked up as an
18023 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18024 happens is controlled by the generic &%self%& option.
18025
18026
18027 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18028 There have been problems with DNS servers when SRV records are looked up.
18029 Some mis-behaving servers return a DNS error or timeout when a non-existent
18030 SRV record is sought. Similar problems have in the past been reported for
18031 MX records. The global &%dns_again_means_nonexist%& option can help with this
18032 problem, but it is heavy-handed because it is a global option.
18033
18034 For this reason, there are two options, &%srv_fail_domains%& and
18035 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18036 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18037 an attempt to look up an SRV or MX record causes one of these results, and the
18038 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18039 such record"&. In the case of an SRV lookup, this means that the router
18040 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18041 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18042 case routing fails.
18043
18044
18045 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18046 .cindex "&(dnslookup)& router" "declines"
18047 There are a few cases where a &(dnslookup)& router will decline to accept
18048 an address; if such a router is expected to handle "all remaining non-local
18049 domains", then it is important to set &%no_more%&.
18050
18051 The router will defer rather than decline if the domain
18052 is found in the &%fail_defer_domains%& router option.
18053
18054 Reasons for a &(dnslookup)& router to decline currently include:
18055 .ilist
18056 The domain does not exist in DNS
18057 .next
18058 The domain exists but the MX record's host part is just "."; this is a common
18059 convention (borrowed from SRV) used to indicate that there is no such service
18060 for this domain and to not fall back to trying A/AAAA records.
18061 .next
18062 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18063 .next
18064 MX record points to a non-existent host.
18065 .next
18066 MX record points to an IP address and the main section option
18067 &%allow_mx_to_ip%& is not set.
18068 .next
18069 MX records exist and point to valid hosts, but all hosts resolve only to
18070 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18071 .next
18072 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18073 &%dns_check_names_pattern%& for handling one variant of this)
18074 .next
18075 &%check_secondary_mx%& is set on this router but the local host can
18076 not be found in the MX records (see below)
18077 .endlist
18078
18079
18080
18081
18082 .section "Private options for dnslookup" "SECID118"
18083 .cindex "options" "&(dnslookup)& router"
18084 The private options for the &(dnslookup)& router are as follows:
18085
18086 .option check_secondary_mx dnslookup boolean false
18087 .cindex "MX record" "checking for secondary"
18088 If this option is set, the router declines unless the local host is found in
18089 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18090 process domains for which the local host is a secondary mail exchanger
18091 differently to other domains. The way in which Exim decides whether a host is
18092 the local host is described in section &<<SECTreclocipadd>>&.
18093
18094
18095 .option check_srv dnslookup string&!! unset
18096 .cindex "SRV record" "enabling use of"
18097 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18098 addition to MX and address records. The support is disabled by default. To
18099 enable SRV support, set the &%check_srv%& option to the name of the service
18100 required. For example,
18101 .code
18102 check_srv = smtp
18103 .endd
18104 looks for SRV records that refer to the normal smtp service. The option is
18105 expanded, so the service name can vary from message to message or address
18106 to address. This might be helpful if SRV records are being used for a
18107 submission service. If the expansion is forced to fail, the &%check_srv%&
18108 option is ignored, and the router proceeds to look for MX records in the
18109 normal way.
18110
18111 When the expansion succeeds, the router searches first for SRV records for
18112 the given service (it assumes TCP protocol). A single SRV record with a
18113 host name that consists of just a single dot indicates &"no such service for
18114 this domain"&; if this is encountered, the router declines. If other kinds of
18115 SRV record are found, they are used to construct a host list for delivery
18116 according to the rules of RFC 2782. MX records are not sought in this case.
18117
18118 When no SRV records are found, MX records (and address records) are sought in
18119 the traditional way. In other words, SRV records take precedence over MX
18120 records, just as MX records take precedence over address records. Note that
18121 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18122 defined it. It is apparently believed that MX records are sufficient for email
18123 and that SRV records should not be used for this purpose. However, SRV records
18124 have an additional &"weight"& feature which some people might find useful when
18125 trying to split an SMTP load between hosts of different power.
18126
18127 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18128 when there is a DNS lookup error.
18129
18130
18131
18132
18133 .option fail_defer_domains dnslookup "domain list&!!" unset
18134 .cindex "MX record" "not found"
18135 DNS lookups for domains matching &%fail_defer_domains%&
18136 which find no matching record will cause the router to defer
18137 rather than the default behaviour of decline.
18138 This maybe be useful for queueing messages for a newly created
18139 domain while the DNS configuration is not ready.
18140 However, it will result in any message with mistyped domains
18141 also being queued.
18142
18143
18144 .option mx_domains dnslookup "domain list&!!" unset
18145 .cindex "MX record" "required to exist"
18146 .cindex "SRV record" "required to exist"
18147 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18148 record in order to be recognized. (The name of this option could be improved.)
18149 For example, if all the mail hosts in &'fict.example'& are known to have MX
18150 records, except for those in &'discworld.fict.example'&, you could use this
18151 setting:
18152 .code
18153 mx_domains = ! *.discworld.fict.example : *.fict.example
18154 .endd
18155 This specifies that messages addressed to a domain that matches the list but
18156 has no MX record should be bounced immediately instead of being routed using
18157 the address record.
18158
18159
18160 .option mx_fail_domains dnslookup "domain list&!!" unset
18161 If the DNS lookup for MX records for one of the domains in this list causes a
18162 DNS lookup error, Exim behaves as if no MX records were found. See section
18163 &<<SECTprowitdnsloo>>& for more discussion.
18164
18165
18166
18167
18168 .option qualify_single dnslookup boolean true
18169 .cindex "DNS" "resolver options"
18170 .cindex "DNS" "qualifying single-component names"
18171 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18172 lookups. Typically, but not standardly, this causes the resolver to qualify
18173 single-component names with the default domain. For example, on a machine
18174 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18175 &'thesaurus.ref.example'& inside the resolver. For details of what your
18176 resolver actually does, consult your man pages for &'resolver'& and
18177 &'resolv.conf'&.
18178
18179
18180
18181 .option rewrite_headers dnslookup boolean true
18182 .cindex "rewriting" "header lines"
18183 .cindex "header lines" "rewriting"
18184 If the domain name in the address that is being processed is not fully
18185 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18186 an address is specified as &'dormouse@teaparty'&, the domain might be
18187 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18188 occur as a result of setting the &%widen_domains%& option. If
18189 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18190 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18191 header lines of the message are rewritten with the full domain name.
18192
18193 This option should be turned off only when it is known that no message is
18194 ever going to be sent outside an environment where the abbreviation makes
18195 sense.
18196
18197 When an MX record is looked up in the DNS and matches a wildcard record, name
18198 servers normally return a record containing the name that has been looked up,
18199 making it impossible to detect whether a wildcard was present or not. However,
18200 some name servers have recently been seen to return the wildcard entry. If the
18201 name returned by a DNS lookup begins with an asterisk, it is not used for
18202 header rewriting.
18203
18204
18205 .option same_domain_copy_routing dnslookup boolean false
18206 .cindex "address" "copying routing"
18207 Addresses with the same domain are normally routed by the &(dnslookup)& router
18208 to the same list of hosts. However, this cannot be presumed, because the router
18209 options and preconditions may refer to the local part of the address. By
18210 default, therefore, Exim routes each address in a message independently. DNS
18211 servers run caches, so repeated DNS lookups are not normally expensive, and in
18212 any case, personal messages rarely have more than a few recipients.
18213
18214 If you are running mailing lists with large numbers of subscribers at the same
18215 domain, and you are using a &(dnslookup)& router which is independent of the
18216 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18217 lookups for identical domains in one message. In this case, when &(dnslookup)&
18218 routes an address to a remote transport, any other unrouted addresses in the
18219 message that have the same domain are automatically given the same routing
18220 without processing them independently,
18221 provided the following conditions are met:
18222
18223 .ilist
18224 No router that processed the address specified &%headers_add%& or
18225 &%headers_remove%&.
18226 .next
18227 The router did not change the address in any way, for example, by &"widening"&
18228 the domain.
18229 .endlist
18230
18231
18232
18233
18234 .option search_parents dnslookup boolean false
18235 .cindex "DNS" "resolver options"
18236 When this option is true, the resolver option RES_DNSRCH is set for DNS
18237 lookups. This is different from the &%qualify_single%& option in that it
18238 applies to domains containing dots. Typically, but not standardly, it causes
18239 the resolver to search for the name in the current domain and in parent
18240 domains. For example, on a machine in the &'fict.example'& domain, if looking
18241 up &'teaparty.wonderland'& failed, the resolver would try
18242 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18243 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18244
18245 Setting this option true can cause problems in domains that have a wildcard MX
18246 record, because any domain that does not have its own MX record matches the
18247 local wildcard.
18248
18249
18250
18251 .option srv_fail_domains dnslookup "domain list&!!" unset
18252 If the DNS lookup for SRV records for one of the domains in this list causes a
18253 DNS lookup error, Exim behaves as if no SRV records were found. See section
18254 &<<SECTprowitdnsloo>>& for more discussion.
18255
18256
18257
18258
18259 .option widen_domains dnslookup "string list" unset
18260 .cindex "domain" "partial; widening"
18261 If a DNS lookup fails and this option is set, each of its strings in turn is
18262 added onto the end of the domain, and the lookup is tried again. For example,
18263 if
18264 .code
18265 widen_domains = fict.example:ref.example
18266 .endd
18267 is set and a lookup of &'klingon.dictionary'& fails,
18268 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18269 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18270 and &%search_parents%& options can cause some widening to be undertaken inside
18271 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18272 when verifying, unless &%rewrite_headers%& is false (not the default).
18273
18274
18275 .section "Effect of qualify_single and search_parents" "SECID119"
18276 When a domain from an envelope recipient is changed by the resolver as a result
18277 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18278 corresponding address in the message's header lines unless &%rewrite_headers%&
18279 is set false. Exim then re-routes the address, using the full domain.
18280
18281 These two options affect only the DNS lookup that takes place inside the router
18282 for the domain of the address that is being routed. They do not affect lookups
18283 such as that implied by
18284 .code
18285 domains = @mx_any
18286 .endd
18287 that may happen while processing a router precondition before the router is
18288 entered. No widening ever takes place for these lookups.
18289 .ecindex IIDdnsrou1
18290 .ecindex IIDdnsrou2
18291
18292
18293
18294
18295
18296
18297
18298
18299
18300 . ////////////////////////////////////////////////////////////////////////////
18301 . ////////////////////////////////////////////////////////////////////////////
18302
18303 .chapter "The ipliteral router" "CHID5"
18304 .cindex "&(ipliteral)& router"
18305 .cindex "domain literal" "routing"
18306 .cindex "routers" "&(ipliteral)&"
18307 This router has no private options. Unless it is being used purely for
18308 verification (see &%verify_only%&) a transport is required to be defined by the
18309 generic &%transport%& option. The router accepts the address if its domain part
18310 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18311 router handles the address
18312 .code
18313 root@[192.168.1.1]
18314 .endd
18315 by setting up delivery to the host with that IP address. IPv4 domain literals
18316 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18317 are similar, but the address is preceded by &`ipv6:`&. For example:
18318 .code
18319 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18320 .endd
18321 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18322 grounds that sooner or later somebody will try it.
18323
18324 .oindex "&%self%&" "in &(ipliteral)& router"
18325 If the IP address matches something in &%ignore_target_hosts%&, the router
18326 declines. If an IP literal turns out to refer to the local host, the generic
18327 &%self%& option determines what happens.
18328
18329 The RFCs require support for domain literals; however, their use is
18330 controversial in today's Internet. If you want to use this router, you must
18331 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18332 Exim will not recognize the domain literal syntax in addresses.
18333
18334
18335
18336 . ////////////////////////////////////////////////////////////////////////////
18337 . ////////////////////////////////////////////////////////////////////////////
18338
18339 .chapter "The iplookup router" "CHID6"
18340 .cindex "&(iplookup)& router"
18341 .cindex "routers" "&(iplookup)&"
18342 The &(iplookup)& router was written to fulfil a specific requirement in
18343 Cambridge University (which in fact no longer exists). For this reason, it is
18344 not included in the binary of Exim by default. If you want to include it, you
18345 must set
18346 .code
18347 ROUTER_IPLOOKUP=yes
18348 .endd
18349 in your &_Local/Makefile_& configuration file.
18350
18351 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18352 connection to one or more specific hosts. The host can then return the same or
18353 a different address &-- in effect rewriting the recipient address in the
18354 message's envelope. The new address is then passed on to subsequent routers. If
18355 this process fails, the address can be passed on to other routers, or delivery
18356 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18357 must not be specified for it.
18358
18359 .cindex "options" "&(iplookup)& router"
18360 .option hosts iplookup string unset
18361 This option must be supplied. Its value is a colon-separated list of host
18362 names. The hosts are looked up using &[gethostbyname()]&
18363 (or &[getipnodebyname()]& when available)
18364 and are tried in order until one responds to the query. If none respond, what
18365 happens is controlled by &%optional%&.
18366
18367
18368 .option optional iplookup boolean false
18369 If &%optional%& is true, if no response is obtained from any host, the address
18370 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18371 delivery to the address is deferred.
18372
18373
18374 .option port iplookup integer 0
18375 .cindex "port" "&(iplookup)& router"
18376 This option must be supplied. It specifies the port number for the TCP or UDP
18377 call.
18378
18379
18380 .option protocol iplookup string udp
18381 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18382 protocols is to be used.
18383
18384
18385 .option query iplookup string&!! "see below"
18386 This defines the content of the query that is sent to the remote hosts. The
18387 default value is:
18388 .code
18389 $local_part@$domain $local_part@$domain
18390 .endd
18391 The repetition serves as a way of checking that a response is to the correct
18392 query in the default case (see &%response_pattern%& below).
18393
18394
18395 .option reroute iplookup string&!! unset
18396 If this option is not set, the rerouted address is precisely the byte string
18397 returned by the remote host, up to the first white space, if any. If set, the
18398 string is expanded to form the rerouted address. It can include parts matched
18399 in the response by &%response_pattern%& by means of numeric variables such as
18400 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18401 whether or not a pattern is in use. In all cases, the rerouted address must end
18402 up in the form &'local_part@domain'&.
18403
18404
18405 .option response_pattern iplookup string unset
18406 This option can be set to a regular expression that is applied to the string
18407 returned from the remote host. If the pattern does not match the response, the
18408 router declines. If &%response_pattern%& is not set, no checking of the
18409 response is done, unless the query was defaulted, in which case there is a
18410 check that the text returned after the first white space is the original
18411 address. This checks that the answer that has been received is in response to
18412 the correct question. For example, if the response is just a new domain, the
18413 following could be used:
18414 .code
18415 response_pattern = ^([^@]+)$
18416 reroute = $local_part@$1
18417 .endd
18418
18419 .option timeout iplookup time 5s
18420 This specifies the amount of time to wait for a response from the remote
18421 machine. The same timeout is used for the &[connect()]& function for a TCP
18422 call. It does not apply to UDP.
18423
18424
18425
18426
18427 . ////////////////////////////////////////////////////////////////////////////
18428 . ////////////////////////////////////////////////////////////////////////////
18429
18430 .chapter "The manualroute router" "CHID7"
18431 .scindex IIDmanrou1 "&(manualroute)& router"
18432 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18433 .cindex "domain" "manually routing"
18434 The &(manualroute)& router is so-called because it provides a way of manually
18435 routing an address according to its domain. It is mainly used when you want to
18436 route addresses to remote hosts according to your own rules, bypassing the
18437 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18438 route to local transports, a facility that may be useful if you want to save
18439 messages for dial-in hosts in local files.
18440
18441 The &(manualroute)& router compares a list of domain patterns with the domain
18442 it is trying to route. If there is no match, the router declines. Each pattern
18443 has associated with it a list of hosts and some other optional data, which may
18444 include a transport. The combination of a pattern and its data is called a
18445 &"routing rule"&. For patterns that do not have an associated transport, the
18446 generic &%transport%& option must specify a transport, unless the router is
18447 being used purely for verification (see &%verify_only%&).
18448
18449 .vindex "&$host$&"
18450 In the case of verification, matching the domain pattern is sufficient for the
18451 router to accept the address. When actually routing an address for delivery,
18452 an address that matches a domain pattern is queued for the associated
18453 transport. If the transport is not a local one, a host list must be associated
18454 with the pattern; IP addresses are looked up for the hosts, and these are
18455 passed to the transport along with the mail address. For local transports, a
18456 host list is optional. If it is present, it is passed in &$host$& as a single
18457 text string.
18458
18459 The list of routing rules can be provided as an inline string in
18460 &%route_list%&, or the data can be obtained by looking up the domain in a file
18461 or database by setting &%route_data%&. Only one of these settings may appear in
18462 any one instance of &(manualroute)&. The format of routing rules is described
18463 below, following the list of private options.
18464
18465
18466 .section "Private options for manualroute" "SECTprioptman"
18467
18468 .cindex "options" "&(manualroute)& router"
18469 The private options for the &(manualroute)& router are as follows:
18470
18471 .option host_all_ignored manualroute string defer
18472 See &%host_find_failed%&.
18473
18474 .option host_find_failed manualroute string freeze
18475 This option controls what happens when &(manualroute)& tries to find an IP
18476 address for a host, and the host does not exist. The option can be set to one
18477 of the following values:
18478 .code
18479 decline
18480 defer
18481 fail
18482 freeze
18483 ignore
18484 pass
18485 .endd
18486 The default (&"freeze"&) assumes that this state is a serious configuration
18487 error. The difference between &"pass"& and &"decline"& is that the former
18488 forces the address to be passed to the next router (or the router defined by
18489 &%pass_router%&),
18490 .oindex "&%more%&"
18491 overriding &%no_more%&, whereas the latter passes the address to the next
18492 router only if &%more%& is true.
18493
18494 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18495 cannot be found. If all the hosts in the list are ignored, the behaviour is
18496 controlled by the &%host_all_ignored%& option. This takes the same values
18497 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18498
18499 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18500 state; if a host lookup gets a temporary error, delivery is deferred unless the
18501 generic &%pass_on_timeout%& option is set.
18502
18503
18504 .option hosts_randomize manualroute boolean false
18505 .cindex "randomized host list"
18506 .cindex "host" "list of; randomized"
18507 If this option is set, the order of the items in a host list in a routing rule
18508 is randomized each time the list is used, unless an option in the routing rule
18509 overrides (see below). Randomizing the order of a host list can be used to do
18510 crude load sharing. However, if more than one mail address is routed by the
18511 same router to the same host list, the host lists are considered to be the same
18512 (even though they may be randomized into different orders) for the purpose of
18513 deciding whether to batch the deliveries into a single SMTP transaction.
18514
18515 When &%hosts_randomize%& is true, a host list may be split
18516 into groups whose order is separately randomized. This makes it possible to
18517 set up MX-like behaviour. The boundaries between groups are indicated by an
18518 item that is just &`+`& in the host list. For example:
18519 .code
18520 route_list = * host1:host2:host3:+:host4:host5
18521 .endd
18522 The order of the first three hosts and the order of the last two hosts is
18523 randomized for each use, but the first three always end up before the last two.
18524 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18525 randomized host list is passed to an &(smtp)& transport that also has
18526 &%hosts_randomize set%&, the list is not re-randomized.
18527
18528
18529 .option route_data manualroute string&!! unset
18530 If this option is set, it must expand to yield the data part of a routing rule.
18531 Typically, the expansion string includes a lookup based on the domain. For
18532 example:
18533 .code
18534 route_data = ${lookup{$domain}dbm{/etc/routes}}
18535 .endd
18536 If the expansion is forced to fail, or the result is an empty string, the
18537 router declines. Other kinds of expansion failure cause delivery to be
18538 deferred.
18539
18540
18541 .option route_list manualroute "string list" unset
18542 This string is a list of routing rules, in the form defined below. Note that,
18543 unlike most string lists, the items are separated by semicolons. This is so
18544 that they may contain colon-separated host lists.
18545
18546
18547 .option same_domain_copy_routing manualroute boolean false
18548 .cindex "address" "copying routing"
18549 Addresses with the same domain are normally routed by the &(manualroute)&
18550 router to the same list of hosts. However, this cannot be presumed, because the
18551 router options and preconditions may refer to the local part of the address. By
18552 default, therefore, Exim routes each address in a message independently. DNS
18553 servers run caches, so repeated DNS lookups are not normally expensive, and in
18554 any case, personal messages rarely have more than a few recipients.
18555
18556 If you are running mailing lists with large numbers of subscribers at the same
18557 domain, and you are using a &(manualroute)& router which is independent of the
18558 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18559 lookups for identical domains in one message. In this case, when
18560 &(manualroute)& routes an address to a remote transport, any other unrouted
18561 addresses in the message that have the same domain are automatically given the
18562 same routing without processing them independently. However, this is only done
18563 if &%headers_add%& and &%headers_remove%& are unset.
18564
18565
18566
18567
18568 .section "Routing rules in route_list" "SECID120"
18569 The value of &%route_list%& is a string consisting of a sequence of routing
18570 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18571 entered as two semicolons. Alternatively, the list separator can be changed as
18572 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18573 Empty rules are ignored. The format of each rule is
18574 .display
18575 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18576 .endd
18577 The following example contains two rules, each with a simple domain pattern and
18578 no options:
18579 .code
18580 route_list = \
18581   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18582   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18583 .endd
18584 The three parts of a rule are separated by white space. The pattern and the
18585 list of hosts can be enclosed in quotes if necessary, and if they are, the
18586 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18587 single domain pattern, which is the only mandatory item in the rule. The
18588 pattern is in the same format as one item in a domain list (see section
18589 &<<SECTdomainlist>>&),
18590 except that it may not be the name of an interpolated file.
18591 That is, it may be wildcarded, or a regular expression, or a file or database
18592 lookup (with semicolons doubled, because of the use of semicolon as a separator
18593 in a &%route_list%&).
18594
18595 The rules in &%route_list%& are searched in order until one of the patterns
18596 matches the domain that is being routed. The list of hosts and then options are
18597 then used as described below. If there is no match, the router declines. When
18598 &%route_list%& is set, &%route_data%& must not be set.
18599
18600
18601
18602 .section "Routing rules in route_data" "SECID121"
18603 The use of &%route_list%& is convenient when there are only a small number of
18604 routing rules. For larger numbers, it is easier to use a file or database to
18605 hold the routing information, and use the &%route_data%& option instead.
18606 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18607 Most commonly, &%route_data%& is set as a string that contains an
18608 expansion lookup. For example, suppose we place two routing rules in a file
18609 like this:
18610 .code
18611 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18612 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18613 .endd
18614 This data can be accessed by setting
18615 .code
18616 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18617 .endd
18618 Failure of the lookup results in an empty string, causing the router to
18619 decline. However, you do not have to use a lookup in &%route_data%&. The only
18620 requirement is that the result of expanding the string is a list of hosts,
18621 possibly followed by options, separated by white space. The list of hosts must
18622 be enclosed in quotes if it contains white space.
18623
18624
18625
18626
18627 .section "Format of the list of hosts" "SECID122"
18628 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18629 always separately expanded before use. If the expansion fails, the router
18630 declines. The result of the expansion must be a colon-separated list of names
18631 and/or IP addresses, optionally also including ports. The format of each item
18632 in the list is described in the next section. The list separator can be changed
18633 as described in section &<<SECTlistconstruct>>&.
18634
18635 If the list of hosts was obtained from a &%route_list%& item, the following
18636 variables are set during its expansion:
18637
18638 .ilist
18639 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18640 If the domain was matched against a regular expression, the numeric variables
18641 &$1$&, &$2$&, etc. may be set. For example:
18642 .code
18643 route_list = ^domain(\d+)   host-$1.text.example
18644 .endd
18645 .next
18646 &$0$& is always set to the entire domain.
18647 .next
18648 &$1$& is also set when partial matching is done in a file lookup.
18649
18650 .next
18651 .vindex "&$value$&"
18652 If the pattern that matched the domain was a lookup item, the data that was
18653 looked up is available in the expansion variable &$value$&. For example:
18654 .code
18655 route_list = lsearch;;/some/file.routes  $value
18656 .endd
18657 .endlist
18658
18659 Note the doubling of the semicolon in the pattern that is necessary because
18660 semicolon is the default route list separator.
18661
18662
18663
18664 .section "Format of one host item" "SECTformatonehostitem"
18665 Each item in the list of hosts is either a host name or an IP address,
18666 optionally with an attached port number. When no port is given, an IP address
18667 is not enclosed in brackets. When a port is specified, it overrides the port
18668 specification on the transport. The port is separated from the name or address
18669 by a colon. This leads to some complications:
18670
18671 .ilist
18672 Because colon is the default separator for the list of hosts, either
18673 the colon that specifies a port must be doubled, or the list separator must
18674 be changed. The following two examples have the same effect:
18675 .code
18676 route_list = * "host1.tld::1225 : host2.tld::1226"
18677 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18678 .endd
18679 .next
18680 When IPv6 addresses are involved, it gets worse, because they contain
18681 colons of their own. To make this case easier, it is permitted to
18682 enclose an IP address (either v4 or v6) in square brackets if a port
18683 number follows. For example:
18684 .code
18685 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18686 .endd
18687 .endlist
18688
18689 .section "How the list of hosts is used" "SECThostshowused"
18690 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18691 the hosts is tried, in the order specified, when carrying out the SMTP
18692 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18693 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18694 transport.
18695
18696 Hosts may be listed by name or by IP address. An unadorned name in the list of
18697 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18698 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18699 records in the DNS. For example:
18700 .code
18701 route_list = *  x.y.z:p.q.r/MX:e.f.g
18702 .endd
18703 If this feature is used with a port specifier, the port must come last. For
18704 example:
18705 .code
18706 route_list = *  dom1.tld/mx::1225
18707 .endd
18708 If the &%hosts_randomize%& option is set, the order of the items in the list is
18709 randomized before any lookups are done. Exim then scans the list; for any name
18710 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18711 be an interface on the local host and the item is not the first in the list,
18712 Exim discards it and any subsequent items. If it is the first item, what
18713 happens is controlled by the
18714 .oindex "&%self%&" "in &(manualroute)& router"
18715 &%self%& option of the router.
18716
18717 A name on the list that is followed by &`/MX`& is replaced with the list of
18718 hosts obtained by looking up MX records for the name. This is always a DNS
18719 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18720 below) are not relevant here. The order of these hosts is determined by the
18721 preference values in the MX records, according to the usual rules. Because
18722 randomizing happens before the MX lookup, it does not affect the order that is
18723 defined by MX preferences.
18724
18725 If the local host is present in the sublist obtained from MX records, but is
18726 not the most preferred host in that list, it and any equally or less
18727 preferred hosts are removed before the sublist is inserted into the main list.
18728
18729 If the local host is the most preferred host in the MX list, what happens
18730 depends on where in the original list of hosts the &`/MX`& item appears. If it
18731 is not the first item (that is, there are previous hosts in the main list),
18732 Exim discards this name and any subsequent items in the main list.
18733
18734 If the MX item is first in the list of hosts, and the local host is the
18735 most preferred host, what happens is controlled by the &%self%& option of the
18736 router.
18737
18738 DNS failures when lookup up the MX records are treated in the same way as DNS
18739 failures when looking up IP addresses: &%pass_on_timeout%& and
18740 &%host_find_failed%& are used when relevant.
18741
18742 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18743 whether obtained from an MX lookup or not.
18744
18745
18746
18747 .section "How the options are used" "SECThowoptused"
18748 The options are a sequence of words; in practice no more than three are ever
18749 present. One of the words can be the name of a transport; this overrides the
18750 &%transport%& option on the router for this particular routing rule only. The
18751 other words (if present) control randomization of the list of hosts on a
18752 per-rule basis, and how the IP addresses of the hosts are to be found when
18753 routing to a remote transport. These options are as follows:
18754
18755 .ilist
18756 &%randomize%&: randomize the order of the hosts in this list, overriding the
18757 setting of &%hosts_randomize%& for this routing rule only.
18758 .next
18759 &%no_randomize%&: do not randomize the order of the hosts in this list,
18760 overriding the setting of &%hosts_randomize%& for this routing rule only.
18761 .next
18762 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18763 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18764 also look in &_/etc/hosts_& or other sources of information.
18765 .next
18766 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18767 no address records are found. If there is a temporary DNS error (such as a
18768 timeout), delivery is deferred.
18769 .endlist
18770
18771 For example:
18772 .code
18773 route_list = domain1  host1:host2:host3  randomize bydns;\
18774              domain2  host4:host5
18775 .endd
18776 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18777 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18778 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18779 or &[gethostbyname()]&, and the result of the lookup is the result of that
18780 call.
18781
18782 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18783 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18784 instead of TRY_AGAIN. That is why the default action is to try a DNS
18785 lookup first. Only if that gives a definite &"no such host"& is the local
18786 function called.
18787
18788
18789
18790 If no IP address for a host can be found, what happens is controlled by the
18791 &%host_find_failed%& option.
18792
18793 .vindex "&$host$&"
18794 When an address is routed to a local transport, IP addresses are not looked up.
18795 The host list is passed to the transport in the &$host$& variable.
18796
18797
18798
18799 .section "Manualroute examples" "SECID123"
18800 In some of the examples that follow, the presence of the &%remote_smtp%&
18801 transport, as defined in the default configuration file, is assumed:
18802
18803 .ilist
18804 .cindex "smart host" "example router"
18805 The &(manualroute)& router can be used to forward all external mail to a
18806 &'smart host'&. If you have set up, in the main part of the configuration, a
18807 named domain list that contains your local domains, for example:
18808 .code
18809 domainlist local_domains = my.domain.example
18810 .endd
18811 You can arrange for all other domains to be routed to a smart host by making
18812 your first router something like this:
18813 .code
18814 smart_route:
18815   driver = manualroute
18816   domains = !+local_domains
18817   transport = remote_smtp
18818   route_list = * smarthost.ref.example
18819 .endd
18820 This causes all non-local addresses to be sent to the single host
18821 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18822 they are tried in order
18823 (but you can use &%hosts_randomize%& to vary the order each time).
18824 Another way of configuring the same thing is this:
18825 .code
18826 smart_route:
18827   driver = manualroute
18828   transport = remote_smtp
18829   route_list = !+local_domains  smarthost.ref.example
18830 .endd
18831 There is no difference in behaviour between these two routers as they stand.
18832 However, they behave differently if &%no_more%& is added to them. In the first
18833 example, the router is skipped if the domain does not match the &%domains%&
18834 precondition; the following router is always tried. If the router runs, it
18835 always matches the domain and so can never decline. Therefore, &%no_more%&
18836 would have no effect. In the second case, the router is never skipped; it
18837 always runs. However, if it doesn't match the domain, it declines. In this case
18838 &%no_more%& would prevent subsequent routers from running.
18839
18840 .next
18841 .cindex "mail hub example"
18842 A &'mail hub'& is a host which receives mail for a number of domains via MX
18843 records in the DNS and delivers it via its own private routing mechanism. Often
18844 the final destinations are behind a firewall, with the mail hub being the one
18845 machine that can connect to machines both inside and outside the firewall. The
18846 &(manualroute)& router is usually used on a mail hub to route incoming messages
18847 to the correct hosts. For a small number of domains, the routing can be inline,
18848 using the &%route_list%& option, but for a larger number a file or database
18849 lookup is easier to manage.
18850
18851 If the domain names are in fact the names of the machines to which the mail is
18852 to be sent by the mail hub, the configuration can be quite simple. For
18853 example:
18854 .code
18855 hub_route:
18856   driver = manualroute
18857   transport = remote_smtp
18858   route_list = *.rhodes.tvs.example  $domain
18859 .endd
18860 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18861 whose names are the same as the mail domains. A similar approach can be taken
18862 if the host name can be obtained from the domain name by a string manipulation
18863 that the expansion facilities can handle. Otherwise, a lookup based on the
18864 domain can be used to find the host:
18865 .code
18866 through_firewall:
18867   driver = manualroute
18868   transport = remote_smtp
18869   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18870 .endd
18871 The result of the lookup must be the name or IP address of the host (or
18872 hosts) to which the address is to be routed. If the lookup fails, the route
18873 data is empty, causing the router to decline. The address then passes to the
18874 next router.
18875
18876 .next
18877 .cindex "batched SMTP output example"
18878 .cindex "SMTP" "batched outgoing; example"
18879 You can use &(manualroute)& to deliver messages to pipes or files in batched
18880 SMTP format for onward transportation by some other means. This is one way of
18881 storing mail for a dial-up host when it is not connected. The route list entry
18882 can be as simple as a single domain name in a configuration like this:
18883 .code
18884 save_in_file:
18885   driver = manualroute
18886   transport = batchsmtp_appendfile
18887   route_list = saved.domain.example
18888 .endd
18889 though often a pattern is used to pick up more than one domain. If there are
18890 several domains or groups of domains with different transport requirements,
18891 different transports can be listed in the routing information:
18892 .code
18893 save_in_file:
18894   driver = manualroute
18895   route_list = \
18896     *.saved.domain1.example  $domain  batch_appendfile; \
18897     *.saved.domain2.example  \
18898       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18899       batch_pipe
18900 .endd
18901 .vindex "&$domain$&"
18902 .vindex "&$host$&"
18903 The first of these just passes the domain in the &$host$& variable, which
18904 doesn't achieve much (since it is also in &$domain$&), but the second does a
18905 file lookup to find a value to pass, causing the router to decline to handle
18906 the address if the lookup fails.
18907
18908 .next
18909 .cindex "UUCP" "example of router for"
18910 Routing mail directly to UUCP software is a specific case of the use of
18911 &(manualroute)& in a gateway to another mail environment. This is an example of
18912 one way it can be done:
18913 .code
18914 # Transport
18915 uucp:
18916   driver = pipe
18917   user = nobody
18918   command = /usr/local/bin/uux -r - \
18919     ${substr_-5:$host}!rmail ${local_part}
18920   return_fail_output = true
18921
18922 # Router
18923 uucphost:
18924   transport = uucp
18925   driver = manualroute
18926   route_data = \
18927     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18928 .endd
18929 The file &_/usr/local/exim/uucphosts_& contains entries like
18930 .code
18931 darksite.ethereal.example:           darksite.UUCP
18932 .endd
18933 It can be set up more simply without adding and removing &".UUCP"& but this way
18934 makes clear the distinction between the domain name
18935 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18936 .endlist
18937 .ecindex IIDmanrou1
18938 .ecindex IIDmanrou2
18939
18940
18941
18942
18943
18944
18945
18946
18947 . ////////////////////////////////////////////////////////////////////////////
18948 . ////////////////////////////////////////////////////////////////////////////
18949
18950 .chapter "The queryprogram router" "CHAPdriverlast"
18951 .scindex IIDquerou1 "&(queryprogram)& router"
18952 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18953 .cindex "routing" "by external program"
18954 The &(queryprogram)& router routes an address by running an external command
18955 and acting on its output. This is an expensive way to route, and is intended
18956 mainly for use in lightly-loaded systems, or for performing experiments.
18957 However, if it is possible to use the precondition options (&%domains%&,
18958 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18959 be used in special cases, even on a busy host. There are the following private
18960 options:
18961 .cindex "options" "&(queryprogram)& router"
18962
18963 .option command queryprogram string&!! unset
18964 This option must be set. It specifies the command that is to be run. The
18965 command is split up into a command name and arguments, and then each is
18966 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18967 &<<CHAPpipetransport>>&).
18968
18969
18970 .option command_group queryprogram string unset
18971 .cindex "gid (group id)" "in &(queryprogram)& router"
18972 This option specifies a gid to be set when running the command while routing an
18973 address for deliver. It must be set if &%command_user%& specifies a numerical
18974 uid. If it begins with a digit, it is interpreted as the numerical value of the
18975 gid. Otherwise it is looked up using &[getgrnam()]&.
18976
18977
18978 .option command_user queryprogram string unset
18979 .cindex "uid (user id)" "for &(queryprogram)&"
18980 This option must be set. It specifies the uid which is set when running the
18981 command while routing an address for delivery. If the value begins with a digit,
18982 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18983 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18984 not set, a value for the gid also.
18985
18986 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18987 root, which it does during a normal delivery in a conventional configuration.
18988 However, when an address is being verified during message reception, Exim is
18989 usually running as the Exim user, not as root. If the &(queryprogram)& router
18990 is called from a non-root process, Exim cannot change uid or gid before running
18991 the command. In this circumstance the command runs under the current uid and
18992 gid.
18993
18994
18995 .option current_directory queryprogram string /
18996 This option specifies an absolute path which is made the current directory
18997 before running the command.
18998
18999
19000 .option timeout queryprogram time 1h
19001 If the command does not complete within the timeout period, its process group
19002 is killed and the message is frozen. A value of zero time specifies no
19003 timeout.
19004
19005
19006 The standard output of the command is connected to a pipe, which is read when
19007 the command terminates. It should consist of a single line of output,
19008 containing up to five fields, separated by white space. The maximum length of
19009 the line is 1023 characters. Longer lines are silently truncated. The first
19010 field is one of the following words (case-insensitive):
19011
19012 .ilist
19013 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19014 below).
19015 .next
19016 &'Decline'&: the router declines; pass the address to the next router, unless
19017 &%no_more%& is set.
19018 .next
19019 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19020 subsequent text on the line is an error message. If the router is run as part
19021 of address verification during an incoming SMTP message, the message is
19022 included in the SMTP response.
19023 .next
19024 &'Defer'&: routing could not be completed at this time; try again later. Any
19025 subsequent text on the line is an error message which is logged. It is not
19026 included in any SMTP response.
19027 .next
19028 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19029 .next
19030 &'Pass'&: pass the address to the next router (or the router specified by
19031 &%pass_router%&), overriding &%no_more%&.
19032 .next
19033 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19034 new addresses, which are routed independently, starting with the first router,
19035 or the router specified by &%redirect_router%&, if set.
19036 .endlist
19037
19038 When the first word is &'accept'&, the remainder of the line consists of a
19039 number of keyed data values, as follows (split into two lines here, to fit on
19040 the page):
19041 .code
19042 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19043 LOOKUP=byname|bydns DATA=<text>
19044 .endd
19045 The data items can be given in any order, and all are optional. If no transport
19046 is included, the transport specified by the generic &%transport%& option is
19047 used. The list of hosts and the lookup type are needed only if the transport is
19048 an &(smtp)& transport that does not itself supply a list of hosts.
19049
19050 The format of the list of hosts is the same as for the &(manualroute)& router.
19051 As well as host names and IP addresses with optional port numbers, as described
19052 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19053 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19054 (see section &<<SECThostshowused>>&).
19055
19056 If the lookup type is not specified, Exim behaves as follows when trying to
19057 find an IP address for each host: First, a DNS lookup is done. If this yields
19058 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19059 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19060 result of the lookup is the result of that call.
19061
19062 .vindex "&$address_data$&"
19063 If the DATA field is set, its value is placed in the &$address_data$&
19064 variable. For example, this return line
19065 .code
19066 accept hosts=x1.y.example:x2.y.example data="rule1"
19067 .endd
19068 routes the address to the default transport, passing a list of two hosts. When
19069 the transport runs, the string &"rule1"& is in &$address_data$&.
19070 .ecindex IIDquerou1
19071 .ecindex IIDquerou2
19072
19073
19074
19075
19076 . ////////////////////////////////////////////////////////////////////////////
19077 . ////////////////////////////////////////////////////////////////////////////
19078
19079 .chapter "The redirect router" "CHAPredirect"
19080 .scindex IIDredrou1 "&(redirect)& router"
19081 .scindex IIDredrou2 "routers" "&(redirect)&"
19082 .cindex "alias file" "in a &(redirect)& router"
19083 .cindex "address redirection" "&(redirect)& router"
19084 The &(redirect)& router handles several kinds of address redirection. Its most
19085 common uses are for resolving local part aliases from a central alias file
19086 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19087 files, but it has many other potential uses. The incoming address can be
19088 redirected in several different ways:
19089
19090 .ilist
19091 It can be replaced by one or more new addresses which are themselves routed
19092 independently.
19093 .next
19094 It can be routed to be delivered to a given file or directory.
19095 .next
19096 It can be routed to be delivered to a specified pipe command.
19097 .next
19098 It can cause an automatic reply to be generated.
19099 .next
19100 It can be forced to fail, optionally with a custom error message.
19101 .next
19102 It can be temporarily deferred, optionally with a custom message.
19103 .next
19104 It can be discarded.
19105 .endlist
19106
19107 The generic &%transport%& option must not be set for &(redirect)& routers.
19108 However, there are some private options which define transports for delivery to
19109 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19110 &%pipe_transport%& and &%reply_transport%& descriptions below.
19111
19112 .new
19113 If success DSNs have been requested
19114 .cindex "DSN" "success"
19115 .cindex "Delivery Status Notification" "success"
19116 redirection triggers one and the DSN options are not passed any further.
19117 .wen
19118
19119
19120
19121 .section "Redirection data" "SECID124"
19122 The router operates by interpreting a text string which it obtains either by
19123 expanding the contents of the &%data%& option, or by reading the entire
19124 contents of a file whose name is given in the &%file%& option. These two
19125 options are mutually exclusive. The first is commonly used for handling system
19126 aliases, in a configuration like this:
19127 .code
19128 system_aliases:
19129   driver = redirect
19130   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19131 .endd
19132 If the lookup fails, the expanded string in this example is empty. When the
19133 expansion of &%data%& results in an empty string, the router declines. A forced
19134 expansion failure also causes the router to decline; other expansion failures
19135 cause delivery to be deferred.
19136
19137 A configuration using &%file%& is commonly used for handling users'
19138 &_.forward_& files, like this:
19139 .code
19140 userforward:
19141   driver = redirect
19142   check_local_user
19143   file = $home/.forward
19144   no_verify
19145 .endd
19146 If the file does not exist, or causes no action to be taken (for example, it is
19147 empty or consists only of comments), the router declines. &*Warning*&: This
19148 is not the case when the file contains syntactically valid items that happen to
19149 yield empty addresses, for example, items containing only RFC 2822 address
19150 comments.
19151
19152
19153
19154 .section "Forward files and address verification" "SECID125"
19155 .cindex "address redirection" "while verifying"
19156 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19157 &_.forward_& files, as in the example above. There are two reasons for this:
19158
19159 .ilist
19160 When Exim is receiving an incoming SMTP message from a remote host, it is
19161 running under the Exim uid, not as root. Exim is unable to change uid to read
19162 the file as the user, and it may not be able to read it as the Exim user. So in
19163 practice the router may not be able to operate.
19164 .next
19165 However, even when the router can operate, the existence of a &_.forward_& file
19166 is unimportant when verifying an address. What should be checked is whether the
19167 local part is a valid user name or not. Cutting out the redirection processing
19168 saves some resources.
19169 .endlist
19170
19171
19172
19173
19174
19175
19176 .section "Interpreting redirection data" "SECID126"
19177 .cindex "Sieve filter" "specifying in redirection data"
19178 .cindex "filter" "specifying in redirection data"
19179 The contents of the data string, whether obtained from &%data%& or &%file%&,
19180 can be interpreted in two different ways:
19181
19182 .ilist
19183 If the &%allow_filter%& option is set true, and the data begins with the text
19184 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19185 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19186 respectively. Details of the syntax and semantics of filter files are described
19187 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19188 document is intended for use by end users.
19189 .next
19190 Otherwise, the data must be a comma-separated list of redirection items, as
19191 described in the next section.
19192 .endlist
19193
19194 When a message is redirected to a file (a &"mail folder"&), the file name given
19195 in a non-filter redirection list must always be an absolute path. A filter may
19196 generate a relative path &-- how this is handled depends on the transport's
19197 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19198 for the &(appendfile)& transport.
19199
19200
19201
19202 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19203 .cindex "address redirection" "non-filter list items"
19204 When the redirection data is not an Exim or Sieve filter, for example, if it
19205 comes from a conventional alias or forward file, it consists of a list of
19206 addresses, file names, pipe commands, or certain special items (see section
19207 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19208 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19209 depending on their default values. The items in the list are separated by
19210 commas or newlines.
19211 If a comma is required in an item, the entire item must be enclosed in double
19212 quotes.
19213
19214 Lines starting with a # character are comments, and are ignored, and # may
19215 also appear following a comma, in which case everything between the # and the
19216 next newline character is ignored.
19217
19218 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19219 double quotes are retained because some forms of mail address require their use
19220 (but never to enclose the entire address). In the following description,
19221 &"item"& refers to what remains after any surrounding double quotes have been
19222 removed.
19223
19224 .vindex "&$local_part$&"
19225 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19226 and the expansion contains a reference to &$local_part$&, you should make use
19227 of the &%quote_local_part%& expansion operator, in case the local part contains
19228 special characters. For example, to redirect all mail for the domain
19229 &'obsolete.example'&, retaining the existing local part, you could use this
19230 setting:
19231 .code
19232 data = ${quote_local_part:$local_part}@newdomain.example
19233 .endd
19234
19235
19236 .section "Redirecting to a local mailbox" "SECTredlocmai"
19237 .cindex "routing" "loops in"
19238 .cindex "loop" "while routing, avoidance of"
19239 .cindex "address redirection" "to local mailbox"
19240 A redirection item may safely be the same as the address currently under
19241 consideration. This does not cause a routing loop, because a router is
19242 automatically skipped if any ancestor of the address that is being processed
19243 is the same as the current address and was processed by the current router.
19244 Such an address is therefore passed to the following routers, so it is handled
19245 as if there were no redirection. When making this loop-avoidance test, the
19246 complete local part, including any prefix or suffix, is used.
19247
19248 .cindex "address redirection" "local part without domain"
19249 Specifying the same local part without a domain is a common usage in personal
19250 filter files when the user wants to have messages delivered to the local
19251 mailbox and also forwarded elsewhere. For example, the user whose login is
19252 &'cleo'& might have a &_.forward_& file containing this:
19253 .code
19254 cleo, cleopatra@egypt.example
19255 .endd
19256 .cindex "backslash in alias file"
19257 .cindex "alias file" "backslash in"
19258 For compatibility with other MTAs, such unqualified local parts may be
19259 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19260 it does make a difference if more than one domain is being handled
19261 synonymously.
19262
19263 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19264 2822 address that does not include a domain, the item is qualified using the
19265 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19266 addresses are qualified using the value in &%qualify_recipient%&, but you can
19267 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19268
19269 Care must be taken if there are alias names for local users.
19270 Consider an MTA handling a single local domain where the system alias file
19271 contains:
19272 .code
19273 Sam.Reman: spqr
19274 .endd
19275 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19276 messages in the local mailbox, and also forward copies elsewhere. He creates
19277 this forward file:
19278 .code
19279 Sam.Reman, spqr@reme.elsewhere.example
19280 .endd
19281 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19282 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19283 second time round, because it has previously routed it,
19284 and the following routers presumably cannot handle the alias. The forward file
19285 should really contain
19286 .code
19287 spqr, spqr@reme.elsewhere.example
19288 .endd
19289 but because this is such a common error, the &%check_ancestor%& option (see
19290 below) exists to provide a way to get round it. This is normally set on a
19291 &(redirect)& router that is handling users' &_.forward_& files.
19292
19293
19294
19295 .section "Special items in redirection lists" "SECTspecitredli"
19296 In addition to addresses, the following types of item may appear in redirection
19297 lists (that is, in non-filter redirection data):
19298
19299 .ilist
19300 .cindex "pipe" "in redirection list"
19301 .cindex "address redirection" "to pipe"
19302 An item is treated as a pipe command if it begins with &"|"& and does not parse
19303 as a valid RFC 2822 address that includes a domain. A transport for running the
19304 command must be specified by the &%pipe_transport%& option.
19305 Normally, either the router or the transport specifies a user and a group under
19306 which to run the delivery. The default is to use the Exim user and group.
19307
19308 Single or double quotes can be used for enclosing the individual arguments of
19309 the pipe command; no interpretation of escapes is done for single quotes. If
19310 the command contains a comma character, it is necessary to put the whole item
19311 in double quotes, for example:
19312 .code
19313 "|/some/command ready,steady,go"
19314 .endd
19315 since items in redirection lists are terminated by commas. Do not, however,
19316 quote just the command. An item such as
19317 .code
19318 |"/some/command ready,steady,go"
19319 .endd
19320 is interpreted as a pipe with a rather strange command name, and no arguments.
19321
19322 Note that the above example assumes that the text comes from a lookup source
19323 of some sort, so that the quotes are part of the data.  If composing a
19324 redirect router with a &%data%& option directly specifying this command, the
19325 quotes will be used by the configuration parser to define the extent of one
19326 string, but will not be passed down into the redirect router itself.  There
19327 are two main approaches to get around this: escape quotes to be part of the
19328 data itself, or avoid using this mechanism and instead create a custom
19329 transport with the &%command%& option set and reference that transport from
19330 an &%accept%& router.
19331
19332 .next
19333 .cindex "file" "in redirection list"
19334 .cindex "address redirection" "to file"
19335 An item is interpreted as a path name if it begins with &"/"& and does not
19336 parse as a valid RFC 2822 address that includes a domain. For example,
19337 .code
19338 /home/world/minbari
19339 .endd
19340 is treated as a file name, but
19341 .code
19342 /s=molari/o=babylon/@x400gate.way
19343 .endd
19344 is treated as an address. For a file name, a transport must be specified using
19345 the &%file_transport%& option. However, if the generated path name ends with a
19346 forward slash character, it is interpreted as a directory name rather than a
19347 file name, and &%directory_transport%& is used instead.
19348
19349 Normally, either the router or the transport specifies a user and a group under
19350 which to run the delivery. The default is to use the Exim user and group.
19351
19352 .cindex "&_/dev/null_&"
19353 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19354 bypassed at a high level, and the log entry shows &"**bypassed**"&
19355 instead of a transport name. In this case the user and group are not used.
19356
19357 .next
19358 .cindex "included address list"
19359 .cindex "address redirection" "included external list"
19360 If an item is of the form
19361 .code
19362 :include:<path name>
19363 .endd
19364 a list of further items is taken from the given file and included at that
19365 point. &*Note*&: Such a file can not be a filter file; it is just an
19366 out-of-line addition to the list. The items in the included list are separated
19367 by commas or newlines and are not subject to expansion. If this is the first
19368 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19369 the alias name. This example is incorrect:
19370 .code
19371 list1    :include:/opt/lists/list1
19372 .endd
19373 It must be given as
19374 .code
19375 list1:   :include:/opt/lists/list1
19376 .endd
19377 .next
19378 .cindex "address redirection" "to black hole"
19379 Sometimes you want to throw away mail to a particular local part. Making the
19380 &%data%& option expand to an empty string does not work, because that causes
19381 the router to decline. Instead, the alias item
19382 .cindex "black hole"
19383 .cindex "abandoning mail"
19384 &':blackhole:'& can be used. It does what its name implies. No delivery is
19385 done, and no error message is generated. This has the same effect as specifing
19386 &_/dev/null_& as a destination, but it can be independently disabled.
19387
19388 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19389 delivery is done for the original local part, even if other redirection items
19390 are present. If you are generating a multi-item list (for example, by reading a
19391 database) and need the ability to provide a no-op item, you must use
19392 &_/dev/null_&.
19393
19394 .next
19395 .cindex "delivery" "forcing failure"
19396 .cindex "delivery" "forcing deferral"
19397 .cindex "failing delivery" "forcing"
19398 .cindex "deferred delivery, forcing"
19399 .cindex "customizing" "failure message"
19400 An attempt to deliver a particular address can be deferred or forced to fail by
19401 redirection items of the form
19402 .code
19403 :defer:
19404 :fail:
19405 .endd
19406 respectively. When a redirection list contains such an item, it applies
19407 to the entire redirection; any other items in the list are ignored. Any
19408 text following &':fail:'& or &':defer:'& is placed in the error text
19409 associated with the failure. For example, an alias file might contain:
19410 .code
19411 X.Employee:  :fail: Gone away, no forwarding address
19412 .endd
19413 In the case of an address that is being verified from an ACL or as the subject
19414 of a
19415 .cindex "VRFY" "error text, display of"
19416 VRFY command, the text is included in the SMTP error response by
19417 default.
19418 .cindex "EXPN" "error text, display of"
19419 The text is not included in the response to an EXPN command. In non-SMTP cases
19420 the text is included in the error message that Exim generates.
19421
19422 .cindex "SMTP" "error codes"
19423 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19424 &':fail:'&. However, if the message starts with three digits followed by a
19425 space, optionally followed by an extended code of the form &'n.n.n'&, also
19426 followed by a space, and the very first digit is the same as the default error
19427 code, the code from the message is used instead. If the very first digit is
19428 incorrect, a panic error is logged, and the default code is used. You can
19429 suppress the use of the supplied code in a redirect router by setting the
19430 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19431 ignored.
19432
19433 .vindex "&$acl_verify_message$&"
19434 In an ACL, an explicitly provided message overrides the default, but the
19435 default message is available in the variable &$acl_verify_message$& and can
19436 therefore be included in a custom message if this is desired.
19437
19438 Normally the error text is the rest of the redirection list &-- a comma does
19439 not terminate it &-- but a newline does act as a terminator. Newlines are not
19440 normally present in alias expansions. In &(lsearch)& lookups they are removed
19441 as part of the continuation process, but they may exist in other kinds of
19442 lookup and in &':include:'& files.
19443
19444 During routing for message delivery (as opposed to verification), a redirection
19445 containing &':fail:'& causes an immediate failure of the incoming address,
19446 whereas &':defer:'& causes the message to remain on the queue so that a
19447 subsequent delivery attempt can happen at a later time. If an address is
19448 deferred for too long, it will ultimately fail, because the normal retry
19449 rules still apply.
19450
19451 .next
19452 .cindex "alias file" "exception to default"
19453 Sometimes it is useful to use a single-key search type with a default (see
19454 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19455 for exceptions to the default. These can be handled by aliasing them to
19456 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19457 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19458 results in an empty redirection list has the same effect.
19459 .endlist
19460
19461
19462 .section "Duplicate addresses" "SECTdupaddr"
19463 .cindex "duplicate addresses"
19464 .cindex "address duplicate, discarding"
19465 .cindex "pipe" "duplicated"
19466 Exim removes duplicate addresses from the list to which it is delivering, so as
19467 to deliver just one copy to each address. This does not apply to deliveries
19468 routed to pipes by different immediate parent addresses, but an indirect
19469 aliasing scheme of the type
19470 .code
19471 pipe:       |/some/command $local_part
19472 localpart1: pipe
19473 localpart2: pipe
19474 .endd
19475 does not work with a message that is addressed to both local parts, because
19476 when the second is aliased to the intermediate local part &"pipe"& it gets
19477 discarded as being the same as a previously handled address. However, a scheme
19478 such as
19479 .code
19480 localpart1: |/some/command $local_part
19481 localpart2: |/some/command $local_part
19482 .endd
19483 does result in two different pipe deliveries, because the immediate parents of
19484 the pipes are distinct.
19485
19486
19487
19488 .section "Repeated redirection expansion" "SECID128"
19489 .cindex "repeated redirection expansion"
19490 .cindex "address redirection" "repeated for each delivery attempt"
19491 When a message cannot be delivered to all of its recipients immediately,
19492 leading to two or more delivery attempts, redirection expansion is carried out
19493 afresh each time for those addresses whose children were not all previously
19494 delivered. If redirection is being used as a mailing list, this can lead to new
19495 members of the list receiving copies of old messages. The &%one_time%& option
19496 can be used to avoid this.
19497
19498
19499 .section "Errors in redirection lists" "SECID129"
19500 .cindex "address redirection" "errors"
19501 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19502 error is skipped, and an entry is written to the main log. This may be useful
19503 for mailing lists that are automatically managed. Otherwise, if an error is
19504 detected while generating the list of new addresses, the original address is
19505 deferred. See also &%syntax_errors_to%&.
19506
19507
19508
19509 .section "Private options for the redirect router" "SECID130"
19510
19511 .cindex "options" "&(redirect)& router"
19512 The private options for the &(redirect)& router are as follows:
19513
19514
19515 .option allow_defer redirect boolean false
19516 Setting this option allows the use of &':defer:'& in non-filter redirection
19517 data, or the &%defer%& command in an Exim filter file.
19518
19519
19520 .option allow_fail redirect boolean false
19521 .cindex "failing delivery" "from filter"
19522 If this option is true, the &':fail:'& item can be used in a redirection list,
19523 and the &%fail%& command may be used in an Exim filter file.
19524
19525
19526 .option allow_filter redirect boolean false
19527 .cindex "filter" "enabling use of"
19528 .cindex "Sieve filter" "enabling use of"
19529 Setting this option allows Exim to interpret redirection data that starts with
19530 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19531 are some features of Exim filter files that some administrators may wish to
19532 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19533
19534 It is also possible to lock out Exim filters or Sieve filters while allowing
19535 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19536
19537
19538 The filter is run using the uid and gid set by the generic &%user%& and
19539 &%group%& options. These take their defaults from the password data if
19540 &%check_local_user%& is set, so in the normal case of users' personal filter
19541 files, the filter is run as the relevant user. When &%allow_filter%& is set
19542 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19543
19544
19545
19546 .option allow_freeze redirect boolean false
19547 .cindex "freezing messages" "allowing in filter"
19548 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19549 This command is more normally encountered in system filters, and is disabled by
19550 default for redirection filters because it isn't something you usually want to
19551 let ordinary users do.
19552
19553
19554
19555 .option check_ancestor redirect boolean false
19556 This option is concerned with handling generated addresses that are the same
19557 as some address in the list of redirection ancestors of the current address.
19558 Although it is turned off by default in the code, it is set in the default
19559 configuration file for handling users' &_.forward_& files. It is recommended
19560 for this use of the &(redirect)& router.
19561
19562 When &%check_ancestor%& is set, if a generated address (including the domain)
19563 is the same as any ancestor of the current address, it is replaced by a copy of
19564 the current address. This helps in the case where local part A is aliased to B,
19565 and B has a &_.forward_& file pointing back to A. For example, within a single
19566 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19567 &_&~jb/.forward_& contains:
19568 .code
19569 \Joe.Bloggs, <other item(s)>
19570 .endd
19571 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19572 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19573 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19574 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19575 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19576 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19577 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19578 original address. See also the &%repeat_use%& option below.
19579
19580
19581 .option check_group redirect boolean "see below"
19582 When the &%file%& option is used, the group owner of the file is checked only
19583 when this option is set. The permitted groups are those listed in the
19584 &%owngroups%& option, together with the user's default group if
19585 &%check_local_user%& is set. If the file has the wrong group, routing is
19586 deferred. The default setting for this option is true if &%check_local_user%&
19587 is set and the &%modemask%& option permits the group write bit, or if the
19588 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19589
19590
19591
19592 .option check_owner redirect boolean "see below"
19593 When the &%file%& option is used, the owner of the file is checked only when
19594 this option is set. If &%check_local_user%& is set, the local user is
19595 permitted; otherwise the owner must be one of those listed in the &%owners%&
19596 option. The default value for this option is true if &%check_local_user%& or
19597 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19598
19599
19600 .option data redirect string&!! unset
19601 This option is mutually exclusive with &%file%&. One or other of them must be
19602 set, but not both. The contents of &%data%& are expanded, and then used as the
19603 list of forwarding items, or as a set of filtering instructions. If the
19604 expansion is forced to fail, or the result is an empty string or a string that
19605 has no effect (consists entirely of comments), the router declines.
19606
19607 When filtering instructions are used, the string must begin with &"#Exim
19608 filter"&, and all comments in the string, including this initial one, must be
19609 terminated with newline characters. For example:
19610 .code
19611 data = #Exim filter\n\
19612        if $h_to: contains Exim then save $home/mail/exim endif
19613 .endd
19614 If you are reading the data from a database where newlines cannot be included,
19615 you can use the &${sg}$& expansion item to turn the escape string of your
19616 choice into a newline.
19617
19618
19619 .option directory_transport redirect string&!! unset
19620 A &(redirect)& router sets up a direct delivery to a directory when a path name
19621 ending with a slash is specified as a new &"address"&. The transport used is
19622 specified by this option, which, after expansion, must be the name of a
19623 configured transport. This should normally be an &(appendfile)& transport.
19624
19625
19626 .option file redirect string&!! unset
19627 This option specifies the name of a file that contains the redirection data. It
19628 is mutually exclusive with the &%data%& option. The string is expanded before
19629 use; if the expansion is forced to fail, the router declines. Other expansion
19630 failures cause delivery to be deferred. The result of a successful expansion
19631 must be an absolute path. The entire file is read and used as the redirection
19632 data. If the data is an empty string or a string that has no effect (consists
19633 entirely of comments), the router declines.
19634
19635 .cindex "NFS" "checking for file existence"
19636 If the attempt to open the file fails with a &"does not exist"& error, Exim
19637 runs a check on the containing directory,
19638 unless &%ignore_enotdir%& is true (see below).
19639 If the directory does not appear to exist, delivery is deferred. This can
19640 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19641 is a mount problem. If the containing directory does exist, but the file does
19642 not, the router declines.
19643
19644
19645 .option file_transport redirect string&!! unset
19646 .vindex "&$address_file$&"
19647 A &(redirect)& router sets up a direct delivery to a file when a path name not
19648 ending in a slash is specified as a new &"address"&. The transport used is
19649 specified by this option, which, after expansion, must be the name of a
19650 configured transport. This should normally be an &(appendfile)& transport. When
19651 it is running, the file name is in &$address_file$&.
19652
19653
19654 .option filter_prepend_home redirect boolean true
19655 When this option is true, if a &(save)& command in an Exim filter specifies a
19656 relative path, and &$home$& is defined, it is automatically prepended to the
19657 relative path. If this option is set false, this action does not happen. The
19658 relative path is then passed to the transport unmodified.
19659
19660
19661 .option forbid_blackhole redirect boolean false
19662 If this option is true, the &':blackhole:'& item may not appear in a
19663 redirection list.
19664
19665
19666 .option forbid_exim_filter redirect boolean false
19667 If this option is set true, only Sieve filters are permitted when
19668 &%allow_filter%& is true.
19669
19670
19671
19672
19673 .option forbid_file redirect boolean false
19674 .cindex "delivery" "to file; forbidding"
19675 .cindex "Sieve filter" "forbidding delivery to a file"
19676 .cindex "Sieve filter" "&""keep""& facility; disabling"
19677 If this option is true, this router may not generate a new address that
19678 specifies delivery to a local file or directory, either from a filter or from a
19679 conventional forward file. This option is forced to be true if &%one_time%& is
19680 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19681 locks out the Sieve's &"keep"& facility.
19682
19683
19684 .option forbid_filter_dlfunc redirect boolean false
19685 .cindex "filter" "locking out certain features"
19686 If this option is true, string expansions in Exim filters are not allowed to
19687 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19688 functions.
19689
19690 .option forbid_filter_existstest redirect boolean false
19691 .cindex "expansion" "statting a file"
19692 If this option is true, string expansions in Exim filters are not allowed to
19693 make use of the &%exists%& condition or the &%stat%& expansion item.
19694
19695 .option forbid_filter_logwrite redirect boolean false
19696 If this option is true, use of the logging facility in Exim filters is not
19697 permitted. Logging is in any case available only if the filter is being run
19698 under some unprivileged uid (which is normally the case for ordinary users'
19699 &_.forward_& files).
19700
19701
19702 .option forbid_filter_lookup redirect boolean false
19703 If this option is true, string expansions in Exim filter files are not allowed
19704 to make use of &%lookup%& items.
19705
19706
19707 .option forbid_filter_perl redirect boolean false
19708 This option has an effect only if Exim is built with embedded Perl support. If
19709 it is true, string expansions in Exim filter files are not allowed to make use
19710 of the embedded Perl support.
19711
19712
19713 .option forbid_filter_readfile redirect boolean false
19714 If this option is true, string expansions in Exim filter files are not allowed
19715 to make use of &%readfile%& items.
19716
19717
19718 .option forbid_filter_readsocket redirect boolean false
19719 If this option is true, string expansions in Exim filter files are not allowed
19720 to make use of &%readsocket%& items.
19721
19722
19723 .option forbid_filter_reply redirect boolean false
19724 If this option is true, this router may not generate an automatic reply
19725 message. Automatic replies can be generated only from Exim or Sieve filter
19726 files, not from traditional forward files. This option is forced to be true if
19727 &%one_time%& is set.
19728
19729
19730 .option forbid_filter_run redirect boolean false
19731 If this option is true, string expansions in Exim filter files are not allowed
19732 to make use of &%run%& items.
19733
19734
19735 .option forbid_include redirect boolean false
19736 If this option is true, items of the form
19737 .code
19738 :include:<path name>
19739 .endd
19740 are not permitted in non-filter redirection lists.
19741
19742
19743 .option forbid_pipe redirect boolean false
19744 .cindex "delivery" "to pipe; forbidding"
19745 If this option is true, this router may not generate a new address which
19746 specifies delivery to a pipe, either from an Exim filter or from a conventional
19747 forward file. This option is forced to be true if &%one_time%& is set.
19748
19749
19750 .option forbid_sieve_filter redirect boolean false
19751 If this option is set true, only Exim filters are permitted when
19752 &%allow_filter%& is true.
19753
19754
19755 .cindex "SMTP" "error codes"
19756 .option forbid_smtp_code redirect boolean false
19757 If this option is set true, any SMTP error codes that are present at the start
19758 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19759 the default codes (451 and 550, respectively) are always used.
19760
19761
19762
19763
19764 .option hide_child_in_errmsg redirect boolean false
19765 .cindex "bounce message" "redirection details; suppressing"
19766 If this option is true, it prevents Exim from quoting a child address if it
19767 generates a bounce or delay message for it. Instead it says &"an address
19768 generated from <&'the top level address'&>"&. Of course, this applies only to
19769 bounces generated locally. If a message is forwarded to another host, &'its'&
19770 bounce may well quote the generated address.
19771
19772
19773 .option ignore_eacces redirect boolean false
19774 .cindex "EACCES"
19775 If this option is set and an attempt to open a redirection file yields the
19776 EACCES error (permission denied), the &(redirect)& router behaves as if the
19777 file did not exist.
19778
19779
19780 .option ignore_enotdir redirect boolean false
19781 .cindex "ENOTDIR"
19782 If this option is set and an attempt to open a redirection file yields the
19783 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19784 router behaves as if the file did not exist.
19785
19786 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19787 router that has the &%file%& option set discovers that the file does not exist
19788 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19789 against unmounted NFS directories. If the parent can not be statted, delivery
19790 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19791 is set, because that option tells Exim to ignore &"something on the path is not
19792 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19793 that some operating systems give ENOENT where others give ENOTDIR.
19794
19795
19796
19797 .option include_directory redirect string unset
19798 If this option is set, the path names of any &':include:'& items in a
19799 redirection list must start with this directory.
19800
19801
19802 .option modemask redirect "octal integer" 022
19803 This specifies mode bits which must not be set for a file specified by the
19804 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19805
19806
19807 .option one_time redirect boolean false
19808 .cindex "one-time aliasing/forwarding expansion"
19809 .cindex "alias file" "one-time expansion"
19810 .cindex "forward file" "one-time expansion"
19811 .cindex "mailing lists" "one-time expansion"
19812 .cindex "address redirection" "one-time expansion"
19813 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19814 files each time it tries to deliver a message causes a problem when one or more
19815 of the generated addresses fails be delivered at the first attempt. The problem
19816 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19817 but of what happens when the redirection list changes during the time that the
19818 message is on Exim's queue. This is particularly true in the case of mailing
19819 lists, where new subscribers might receive copies of messages that were posted
19820 before they subscribed.
19821
19822 If &%one_time%& is set and any addresses generated by the router fail to
19823 deliver at the first attempt, the failing addresses are added to the message as
19824 &"top level"& addresses, and the parent address that generated them is marked
19825 &"delivered"&. Thus, redirection does not happen again at the next delivery
19826 attempt.
19827
19828 &*Warning 1*&: Any header line addition or removal that is specified by this
19829 router would be lost if delivery did not succeed at the first attempt. For this
19830 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19831 permitted when &%one_time%& is set.
19832
19833 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19834 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19835 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19836
19837 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19838 &%one_time%&.
19839
19840 The original top-level address is remembered with each of the generated
19841 addresses, and is output in any log messages. However, any intermediate parent
19842 addresses are not recorded. This makes a difference to the log only if
19843 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19844 typically be used for mailing lists, where there is normally just one level of
19845 expansion.
19846
19847
19848 .option owners redirect "string list" unset
19849 .cindex "ownership" "alias file"
19850 .cindex "ownership" "forward file"
19851 .cindex "alias file" "ownership"
19852 .cindex "forward file" "ownership"
19853 This specifies a list of permitted owners for the file specified by &%file%&.
19854 This list is in addition to the local user when &%check_local_user%& is set.
19855 See &%check_owner%& above.
19856
19857
19858 .option owngroups redirect "string list" unset
19859 This specifies a list of permitted groups for the file specified by &%file%&.
19860 The list is in addition to the local user's primary group when
19861 &%check_local_user%& is set. See &%check_group%& above.
19862
19863
19864 .option pipe_transport redirect string&!! unset
19865 .vindex "&$address_pipe$&"
19866 A &(redirect)& router sets up a direct delivery to a pipe when a string
19867 starting with a vertical bar character is specified as a new &"address"&. The
19868 transport used is specified by this option, which, after expansion, must be the
19869 name of a configured transport. This should normally be a &(pipe)& transport.
19870 When the transport is run, the pipe command is in &$address_pipe$&.
19871
19872
19873 .option qualify_domain redirect string&!! unset
19874 .vindex "&$qualify_recipient$&"
19875 If this option is set, and an unqualified address (one without a domain) is
19876 generated, and that address would normally be qualified by the global setting
19877 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19878 expanding this string. If the expansion fails, the router declines. If you want
19879 to revert to the default, you can have the expansion generate
19880 &$qualify_recipient$&.
19881
19882 This option applies to all unqualified addresses generated by Exim filters,
19883 but for traditional &_.forward_& files, it applies only to addresses that are
19884 not preceded by a backslash. Sieve filters cannot generate unqualified
19885 addresses.
19886
19887 .option qualify_preserve_domain redirect boolean false
19888 .cindex "domain" "in redirection; preserving"
19889 .cindex "preserving domain in redirection"
19890 .cindex "address redirection" "domain; preserving"
19891 If this option is set, the router's local &%qualify_domain%& option must not be
19892 set (a configuration error occurs if it is). If an unqualified address (one
19893 without a domain) is generated, it is qualified with the domain of the parent
19894 address (the immediately preceding ancestor) instead of the global
19895 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19896 this applies whether or not the address is preceded by a backslash.
19897
19898
19899 .option repeat_use redirect boolean true
19900 If this option is set false, the router is skipped for a child address that has
19901 any ancestor that was routed by this router. This test happens before any of
19902 the other preconditions are tested. Exim's default anti-looping rules skip
19903 only when the ancestor is the same as the current address. See also
19904 &%check_ancestor%& above and the generic &%redirect_router%& option.
19905
19906
19907 .option reply_transport redirect string&!! unset
19908 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19909 &%vacation%& command is used in a filter file. The transport used is specified
19910 by this option, which, after expansion, must be the name of a configured
19911 transport. This should normally be an &(autoreply)& transport. Other transports
19912 are unlikely to do anything sensible or useful.
19913
19914
19915 .option rewrite redirect boolean true
19916 .cindex "address redirection" "disabling rewriting"
19917 If this option is set false, addresses generated by the router are not
19918 subject to address rewriting. Otherwise, they are treated like new addresses
19919 and are rewritten according to the global rewriting rules.
19920
19921
19922 .option sieve_subaddress redirect string&!! unset
19923 The value of this option is passed to a Sieve filter to specify the
19924 :subaddress part of an address.
19925
19926 .option sieve_useraddress redirect string&!! unset
19927 The value of this option is passed to a Sieve filter to specify the :user part
19928 of an address. However, if it is unset, the entire original local part
19929 (including any prefix or suffix) is used for :user.
19930
19931
19932 .option sieve_vacation_directory redirect string&!! unset
19933 .cindex "Sieve filter" "vacation directory"
19934 To enable the &"vacation"& extension for Sieve filters, you must set
19935 &%sieve_vacation_directory%& to the directory where vacation databases are held
19936 (do not put anything else in that directory), and ensure that the
19937 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19938 needs their own directory; Exim will create it if necessary.
19939
19940
19941
19942 .option skip_syntax_errors redirect boolean false
19943 .cindex "forward file" "broken"
19944 .cindex "address redirection" "broken files"
19945 .cindex "alias file" "broken"
19946 .cindex "broken alias or forward files"
19947 .cindex "ignoring faulty addresses"
19948 .cindex "skipping faulty addresses"
19949 .cindex "error" "skipping bad syntax"
19950 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19951 non-filter redirection data are skipped, and each failing address is logged. If
19952 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19953 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19954 are expanded and placed at the head of the error message generated by
19955 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19956 be the same address as the generic &%errors_to%& option. The
19957 &%skip_syntax_errors%& option is often used when handling mailing lists.
19958
19959 If all the addresses in a redirection list are skipped because of syntax
19960 errors, the router declines to handle the original address, and it is passed to
19961 the following routers.
19962
19963 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19964 error in the filter causes filtering to be abandoned without any action being
19965 taken. The incident is logged, and the router declines to handle the address,
19966 so it is passed to the following routers.
19967
19968 .cindex "Sieve filter" "syntax errors in"
19969 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19970 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19971 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19972
19973 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19974 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19975 option, used with an address that does not get redirected, can be used to
19976 notify users of these errors, by means of a router like this:
19977 .code
19978 userforward:
19979   driver = redirect
19980   allow_filter
19981   check_local_user
19982   file = $home/.forward
19983   file_transport = address_file
19984   pipe_transport = address_pipe
19985   reply_transport = address_reply
19986   no_verify
19987   skip_syntax_errors
19988   syntax_errors_to = real-$local_part@$domain
19989   syntax_errors_text = \
19990    This is an automatically generated message. An error has\n\
19991    been found in your .forward file. Details of the error are\n\
19992    reported below. While this error persists, you will receive\n\
19993    a copy of this message for every message that is addressed\n\
19994    to you. If your .forward file is a filter file, or if it is\n\
19995    a non-filter file containing no valid forwarding addresses,\n\
19996    a copy of each incoming message will be put in your normal\n\
19997    mailbox. If a non-filter file contains at least one valid\n\
19998    forwarding address, forwarding to the valid addresses will\n\
19999    happen, and those will be the only deliveries that occur.
20000 .endd
20001 You also need a router to ensure that local addresses that are prefixed by
20002 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20003 put this immediately before the &(userforward)& router:
20004 .code
20005 real_localuser:
20006   driver = accept
20007   check_local_user
20008   local_part_prefix = real-
20009   transport = local_delivery
20010 .endd
20011 For security, it would probably be a good idea to restrict the use of this
20012 router to locally-generated messages, using a condition such as this:
20013 .code
20014   condition = ${if match {$sender_host_address}\
20015                          {\N^(|127\.0\.0\.1)$\N}}
20016 .endd
20017
20018
20019 .option syntax_errors_text redirect string&!! unset
20020 See &%skip_syntax_errors%& above.
20021
20022
20023 .option syntax_errors_to redirect string unset
20024 See &%skip_syntax_errors%& above.
20025 .ecindex IIDredrou1
20026 .ecindex IIDredrou2
20027
20028
20029
20030
20031
20032
20033 . ////////////////////////////////////////////////////////////////////////////
20034 . ////////////////////////////////////////////////////////////////////////////
20035
20036 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20037          "Environment for local transports"
20038 .scindex IIDenvlotra1 "local transports" "environment for"
20039 .scindex IIDenvlotra2 "environment for local transports"
20040 .scindex IIDenvlotra3 "transport" "local; environment for"
20041 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20042 transport can be thought of as similar to a pipe.) Exim always runs transports
20043 in subprocesses, under specified uids and gids. Typical deliveries to local
20044 mailboxes run under the uid and gid of the local user.
20045
20046 Exim also sets a specific current directory while running the transport; for
20047 some transports a home directory setting is also relevant. The &(pipe)&
20048 transport is the only one that sets up environment variables; see section
20049 &<<SECTpipeenv>>& for details.
20050
20051 The values used for the uid, gid, and the directories may come from several
20052 different places. In many cases, the router that handles the address associates
20053 settings with that address as a result of its &%check_local_user%&, &%group%&,
20054 or &%user%& options. However, values may also be given in the transport's own
20055 configuration, and these override anything that comes from the router.
20056
20057
20058
20059 .section "Concurrent deliveries" "SECID131"
20060 .cindex "concurrent deliveries"
20061 .cindex "simultaneous deliveries"
20062 If two different messages for the same local recipient arrive more or less
20063 simultaneously, the two delivery processes are likely to run concurrently. When
20064 the &(appendfile)& transport is used to write to a file, Exim applies locking
20065 rules to stop concurrent processes from writing to the same file at the same
20066 time.
20067
20068 However, when you use a &(pipe)& transport, it is up to you to arrange any
20069 locking that is needed. Here is a silly example:
20070 .code
20071 my_transport:
20072   driver = pipe
20073   command = /bin/sh -c 'cat >>/some/file'
20074 .endd
20075 This is supposed to write the message at the end of the file. However, if two
20076 messages arrive at the same time, the file will be scrambled. You can use the
20077 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20078 file using the same algorithm that Exim itself uses.
20079
20080
20081
20082
20083 .section "Uids and gids" "SECTenvuidgid"
20084 .cindex "local transports" "uid and gid"
20085 .cindex "transport" "local; uid and gid"
20086 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20087 overrides any group that the router set in the address, even if &%user%& is not
20088 set for the transport. This makes it possible, for example, to run local mail
20089 delivery under the uid of the recipient (set by the router), but in a special
20090 group (set by the transport). For example:
20091 .code
20092 # Routers ...
20093 # User/group are set by check_local_user in this router
20094 local_users:
20095   driver = accept
20096   check_local_user
20097   transport = group_delivery
20098
20099 # Transports ...
20100 # This transport overrides the group
20101 group_delivery:
20102   driver = appendfile
20103   file = /var/spool/mail/$local_part
20104   group = mail
20105 .endd
20106 If &%user%& is set for a transport, its value overrides what is set in the
20107 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20108 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20109 set.
20110
20111 .oindex "&%initgroups%&"
20112 When the uid is taken from the transport's configuration, the &[initgroups()]&
20113 function is called for the groups associated with that uid if the
20114 &%initgroups%& option is set for the transport. When the uid is not specified
20115 by the transport, but is associated with the address by a router, the option
20116 for calling &[initgroups()]& is taken from the router configuration.
20117
20118 .cindex "&(pipe)& transport" "uid for"
20119 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20120 is set and &%user%& is not set, the uid of the process that called Exim to
20121 receive the message is used, and if &%group%& is not set, the corresponding
20122 original gid is also used.
20123
20124 This is the detailed preference order for obtaining a gid; the first of the
20125 following that is set is used:
20126
20127 .ilist
20128 A &%group%& setting of the transport;
20129 .next
20130 A &%group%& setting of the router;
20131 .next
20132 A gid associated with a user setting of the router, either as a result of
20133 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20134 .next
20135 The group associated with a non-numeric &%user%& setting of the transport;
20136 .next
20137 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20138 the uid is the creator's uid;
20139 .next
20140 The Exim gid if the Exim uid is being used as a default.
20141 .endlist
20142
20143 If, for example, the user is specified numerically on the router and there are
20144 no group settings, no gid is available. In this situation, an error occurs.
20145 This is different for the uid, for which there always is an ultimate default.
20146 The first of the following that is set is used:
20147
20148 .ilist
20149 A &%user%& setting of the transport;
20150 .next
20151 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20152 .next
20153 A &%user%& setting of the router;
20154 .next
20155 A &%check_local_user%& setting of the router;
20156 .next
20157 The Exim uid.
20158 .endlist
20159
20160 Of course, an error will still occur if the uid that is chosen is on the
20161 &%never_users%& list.
20162
20163
20164
20165
20166
20167 .section "Current and home directories" "SECID132"
20168 .cindex "current directory for local transport"
20169 .cindex "home directory" "for local transport"
20170 .cindex "transport" "local; home directory for"
20171 .cindex "transport" "local; current directory for"
20172 Routers may set current and home directories for local transports by means of
20173 the &%transport_current_directory%& and &%transport_home_directory%& options.
20174 However, if the transport's &%current_directory%& or &%home_directory%& options
20175 are set, they override the router's values. In detail, the home directory
20176 for a local transport is taken from the first of these values that is set:
20177
20178 .ilist
20179 The &%home_directory%& option on the transport;
20180 .next
20181 The &%transport_home_directory%& option on the router;
20182 .next
20183 The password data if &%check_local_user%& is set on the router;
20184 .next
20185 The &%router_home_directory%& option on the router.
20186 .endlist
20187
20188 The current directory is taken from the first of these values that is set:
20189
20190 .ilist
20191 The &%current_directory%& option on the transport;
20192 .next
20193 The &%transport_current_directory%& option on the router.
20194 .endlist
20195
20196
20197 If neither the router nor the transport sets a current directory, Exim uses the
20198 value of the home directory, if it is set. Otherwise it sets the current
20199 directory to &_/_& before running a local transport.
20200
20201
20202
20203 .section "Expansion variables derived from the address" "SECID133"
20204 .vindex "&$domain$&"
20205 .vindex "&$local_part$&"
20206 .vindex "&$original_domain$&"
20207 Normally a local delivery is handling a single address, and in that case the
20208 variables such as &$domain$& and &$local_part$& are set during local
20209 deliveries. However, in some circumstances more than one address may be handled
20210 at once (for example, while writing batch SMTP for onward transmission by some
20211 other means). In this case, the variables associated with the local part are
20212 never set, &$domain$& is set only if all the addresses have the same domain,
20213 and &$original_domain$& is never set.
20214 .ecindex IIDenvlotra1
20215 .ecindex IIDenvlotra2
20216 .ecindex IIDenvlotra3
20217
20218
20219
20220
20221
20222
20223
20224 . ////////////////////////////////////////////////////////////////////////////
20225 . ////////////////////////////////////////////////////////////////////////////
20226
20227 .chapter "Generic options for transports" "CHAPtransportgeneric"
20228 .scindex IIDgenoptra1 "generic options" "transport"
20229 .scindex IIDgenoptra2 "options" "generic; for transports"
20230 .scindex IIDgenoptra3 "transport" "generic options for"
20231 The following generic options apply to all transports:
20232
20233
20234 .option body_only transports boolean false
20235 .cindex "transport" "body only"
20236 .cindex "message" "transporting body only"
20237 .cindex "body of message" "transporting"
20238 If this option is set, the message's headers are not transported. It is
20239 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20240 or &(pipe)& transports, the settings of &%message_prefix%& and
20241 &%message_suffix%& should be checked, because this option does not
20242 automatically suppress them.
20243
20244
20245 .option current_directory transports string&!! unset
20246 .cindex "transport" "current directory for"
20247 This specifies the current directory that is to be set while running the
20248 transport, overriding any value that may have been set by the router.
20249 If the expansion fails for any reason, including forced failure, an error is
20250 logged, and delivery is deferred.
20251
20252
20253 .option disable_logging transports boolean false
20254 If this option is set true, nothing is logged for any
20255 deliveries by the transport or for any
20256 transport errors. You should not set this option unless you really, really know
20257 what you are doing.
20258
20259
20260 .option debug_print transports string&!! unset
20261 .cindex "testing" "variables in drivers"
20262 If this option is set and debugging is enabled (see the &%-d%& command line
20263 option), the string is expanded and included in the debugging output when the
20264 transport is run.
20265 If expansion of the string fails, the error message is written to the debugging
20266 output, and Exim carries on processing.
20267 This facility is provided to help with checking out the values of variables and
20268 so on when debugging driver configurations. For example, if a &%headers_add%&
20269 option is not working properly, &%debug_print%& could be used to output the
20270 variables it references. A newline is added to the text if it does not end with
20271 one.
20272 The variables &$transport_name$& and &$router_name$& contain the name of the
20273 transport and the router that called it.
20274
20275 .option delivery_date_add transports boolean false
20276 .cindex "&'Delivery-date:'& header line"
20277 If this option is true, a &'Delivery-date:'& header is added to the message.
20278 This gives the actual time the delivery was made. As this is not a standard
20279 header, Exim has a configuration option (&%delivery_date_remove%&) which
20280 requests its removal from incoming messages, so that delivered messages can
20281 safely be resent to other recipients.
20282
20283
20284 .option driver transports string unset
20285 This specifies which of the available transport drivers is to be used.
20286 There is no default, and this option must be set for every transport.
20287
20288
20289 .option envelope_to_add transports boolean false
20290 .cindex "&'Envelope-to:'& header line"
20291 If this option is true, an &'Envelope-to:'& header is added to the message.
20292 This gives the original address(es) in the incoming envelope that caused this
20293 delivery to happen. More than one address may be present if the transport is
20294 configured to handle several addresses at once, or if more than one original
20295 address was redirected to the same final address. As this is not a standard
20296 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20297 its removal from incoming messages, so that delivered messages can safely be
20298 resent to other recipients.
20299
20300
20301 .option group transports string&!! "Exim group"
20302 .cindex "transport" "group; specifying"
20303 This option specifies a gid for running the transport process, overriding any
20304 value that the router supplies, and also overriding any value associated with
20305 &%user%& (see below).
20306
20307
20308 .option headers_add transports list&!! unset
20309 .cindex "header lines" "adding in transport"
20310 .cindex "transport" "header lines; adding"
20311 This option specifies a list of text headers,
20312 .new
20313 newline-separated (by default, changeable in the usual way),
20314 .wen
20315 which are (separately) expanded and added to the header
20316 portion of a message as it is transported, as described in section
20317 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20318 routers. If the result of the expansion is an empty string, or if the expansion
20319 is forced to fail, no action is taken. Other expansion failures are treated as
20320 errors and cause the delivery to be deferred.
20321
20322 Unlike most options, &%headers_add%& can be specified multiple times
20323 for a transport; all listed headers are added.
20324
20325
20326 .option headers_only transports boolean false
20327 .cindex "transport" "header lines only"
20328 .cindex "message" "transporting headers only"
20329 .cindex "header lines" "transporting"
20330 If this option is set, the message's body is not transported. It is mutually
20331 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20332 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20333 checked, since this option does not automatically suppress them.
20334
20335
20336 .option headers_remove transports list&!! unset
20337 .cindex "header lines" "removing"
20338 .cindex "transport" "header lines; removing"
20339 This option specifies a list of header names,
20340 .new
20341 colon-separated (by default, changeable in the usual way);
20342 .wen
20343 these headers are omitted from the message as it is transported, as described
20344 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20345 routers.
20346 Each list item is separately expanded.
20347 If the result of the expansion is an empty string, or if the expansion
20348 is forced to fail, no action is taken. Other expansion failures are treated as
20349 errors and cause the delivery to be deferred.
20350
20351 Unlike most options, &%headers_remove%& can be specified multiple times
20352 for a router; all listed headers are removed.
20353
20354
20355
20356 .option headers_rewrite transports string unset
20357 .cindex "transport" "header lines; rewriting"
20358 .cindex "rewriting" "at transport time"
20359 This option allows addresses in header lines to be rewritten at transport time,
20360 that is, as the message is being copied to its destination. The contents of the
20361 option are a colon-separated list of rewriting rules. Each rule is in exactly
20362 the same form as one of the general rewriting rules that are applied when a
20363 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20364 example,
20365 .code
20366 headers_rewrite = a@b c@d f : \
20367                   x@y w@z
20368 .endd
20369 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20370 &'w@z'& in all address-bearing header lines. The rules are applied to the
20371 header lines just before they are written out at transport time, so they affect
20372 only those copies of the message that pass through the transport. However, only
20373 the message's original header lines, and any that were added by a system
20374 filter, are rewritten. If a router or transport adds header lines, they are not
20375 affected by this option. These rewriting rules are &'not'& applied to the
20376 envelope. You can change the return path using &%return_path%&, but you cannot
20377 change envelope recipients at this time.
20378
20379
20380 .option home_directory transports string&!! unset
20381 .cindex "transport" "home directory for"
20382 .vindex "&$home$&"
20383 This option specifies a home directory setting for a local transport,
20384 overriding any value that may be set by the router. The home directory is
20385 placed in &$home$& while expanding the transport's private options. It is also
20386 used as the current directory if no current directory is set by the
20387 &%current_directory%& option on the transport or the
20388 &%transport_current_directory%& option on the router. If the expansion fails
20389 for any reason, including forced failure, an error is logged, and delivery is
20390 deferred.
20391
20392
20393 .option initgroups transports boolean false
20394 .cindex "additional groups"
20395 .cindex "groups" "additional"
20396 .cindex "transport" "group; additional"
20397 If this option is true and the uid for the delivery process is provided by the
20398 transport, the &[initgroups()]& function is called when running the transport
20399 to ensure that any additional groups associated with the uid are set up.
20400
20401
20402 .option message_size_limit transports string&!! 0
20403 .cindex "limit" "message size per transport"
20404 .cindex "size" "of message, limit"
20405 .cindex "transport" "message size; limiting"
20406 This option controls the size of messages passed through the transport. It is
20407 expanded before use; the result of the expansion must be a sequence of decimal
20408 digits, optionally followed by K or M. If the expansion fails for any reason,
20409 including forced failure, or if the result is not of the required form,
20410 delivery is deferred. If the value is greater than zero and the size of a
20411 message exceeds this limit, the address is failed. If there is any chance that
20412 the resulting bounce message could be routed to the same transport, you should
20413 ensure that &%return_size_limit%& is less than the transport's
20414 &%message_size_limit%&, as otherwise the bounce message will fail to get
20415 delivered.
20416
20417
20418
20419 .option rcpt_include_affixes transports boolean false
20420 .cindex "prefix" "for local part, including in envelope"
20421 .cindex "suffix for local part" "including in envelope"
20422 .cindex "local part" "prefix"
20423 .cindex "local part" "suffix"
20424 When this option is false (the default), and an address that has had any
20425 affixes (prefixes or suffixes) removed from the local part is delivered by any
20426 form of SMTP or LMTP, the affixes are not included. For example, if a router
20427 that contains
20428 .code
20429 local_part_prefix = *-
20430 .endd
20431 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20432 is delivered with
20433 .code
20434 RCPT TO:<xyz@some.domain>
20435 .endd
20436 This is also the case when an ACL-time callout is being used to verify a
20437 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20438 whole local part is included in the RCPT command. This option applies to BSMTP
20439 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20440 &(lmtp)& and &(smtp)& transports.
20441
20442
20443 .option retry_use_local_part transports boolean "see below"
20444 .cindex "hints database" "retry keys"
20445 When a delivery suffers a temporary failure, a retry record is created
20446 in Exim's hints database. For remote deliveries, the key for the retry record
20447 is based on the name and/or IP address of the failing remote host. For local
20448 deliveries, the key is normally the entire address, including both the local
20449 part and the domain. This is suitable for most common cases of local delivery
20450 temporary failure &-- for example, exceeding a mailbox quota should delay only
20451 deliveries to that mailbox, not to the whole domain.
20452
20453 However, in some special cases you may want to treat a temporary local delivery
20454 as a failure associated with the domain, and not with a particular local part.
20455 (For example, if you are storing all mail for some domain in files.) You can do
20456 this by setting &%retry_use_local_part%& false.
20457
20458 For all the local transports, its default value is true. For remote transports,
20459 the default value is false for tidiness, but changing the value has no effect
20460 on a remote transport in the current implementation.
20461
20462
20463 .option return_path transports string&!! unset
20464 .cindex "envelope sender"
20465 .cindex "transport" "return path; changing"
20466 .cindex "return path" "changing in transport"
20467 If this option is set, the string is expanded at transport time and replaces
20468 the existing return path (envelope sender) value in the copy of the message
20469 that is being delivered. An empty return path is permitted. This feature is
20470 designed for remote deliveries, where the value of this option is used in the
20471 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20472 only effect is to change the address that is placed in the &'Return-path:'&
20473 header line, if one is added to the message (see the next option).
20474
20475 &*Note:*& A changed return path is not logged unless you add
20476 &%return_path_on_delivery%& to the log selector.
20477
20478 .vindex "&$return_path$&"
20479 The expansion can refer to the existing value via &$return_path$&. This is
20480 either the message's envelope sender, or an address set by the
20481 &%errors_to%& option on a router. If the expansion is forced to fail, no
20482 replacement occurs; if it fails for another reason, delivery is deferred. This
20483 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20484 section &<<SECTverp>>&.
20485
20486 &*Note*&: If a delivery error is detected locally, including the case when a
20487 remote server rejects a message at SMTP time, the bounce message is not sent to
20488 the value of this option. It is sent to the previously set errors address.
20489 This defaults to the incoming sender address, but can be changed by setting
20490 &%errors_to%& in a router.
20491
20492
20493
20494 .option return_path_add transports boolean false
20495 .cindex "&'Return-path:'& header line"
20496 If this option is true, a &'Return-path:'& header is added to the message.
20497 Although the return path is normally available in the prefix line of BSD
20498 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20499 have easy access to it.
20500
20501 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20502 the delivery SMTP server makes the final delivery"&. This implies that this
20503 header should not be present in incoming messages. Exim has a configuration
20504 option, &%return_path_remove%&, which requests removal of this header from
20505 incoming messages, so that delivered messages can safely be resent to other
20506 recipients.
20507
20508
20509 .option shadow_condition transports string&!! unset
20510 See &%shadow_transport%& below.
20511
20512
20513 .option shadow_transport transports string unset
20514 .cindex "shadow transport"
20515 .cindex "transport" "shadow"
20516 A local transport may set the &%shadow_transport%& option to the name of
20517 another local transport. Shadow remote transports are not supported.
20518
20519 Whenever a delivery to the main transport succeeds, and either
20520 &%shadow_condition%& is unset, or its expansion does not result in the empty
20521 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20522 passed to the shadow transport, with the same delivery address or addresses. If
20523 expansion fails, no action is taken except that non-forced expansion failures
20524 cause a log line to be written.
20525
20526 The result of the shadow transport is discarded and does not affect the
20527 subsequent processing of the message. Only a single level of shadowing is
20528 provided; the &%shadow_transport%& option is ignored on any transport when it
20529 is running as a shadow. Options concerned with output from pipes are also
20530 ignored. The log line for the successful delivery has an item added on the end,
20531 of the form
20532 .code
20533 ST=<shadow transport name>
20534 .endd
20535 If the shadow transport did not succeed, the error message is put in
20536 parentheses afterwards. Shadow transports can be used for a number of different
20537 purposes, including keeping more detailed log information than Exim normally
20538 provides, and implementing automatic acknowledgment policies based on message
20539 headers that some sites insist on.
20540
20541
20542 .option transport_filter transports string&!! unset
20543 .cindex "transport" "filter"
20544 .cindex "filter" "transport filter"
20545 This option sets up a filtering (in the Unix shell sense) process for messages
20546 at transport time. It should not be confused with mail filtering as set up by
20547 individual users or via a system filter.
20548
20549 When the message is about to be written out, the command specified by
20550 &%transport_filter%& is started up in a separate, parallel process, and
20551 the entire message, including the header lines, is passed to it on its standard
20552 input (this in fact is done from a third process, to avoid deadlock). The
20553 command must be specified as an absolute path.
20554
20555 The lines of the message that are written to the transport filter are
20556 terminated by newline (&"\n"&). The message is passed to the filter before any
20557 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20558 lines beginning with a dot, and also before any processing implied by the
20559 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20560 &(pipe)& transports.
20561
20562 The standard error for the filter process is set to the same destination as its
20563 standard output; this is read and written to the message's ultimate
20564 destination. The process that writes the message to the filter, the
20565 filter itself, and the original process that reads the result and delivers it
20566 are all run in parallel, like a shell pipeline.
20567
20568 The filter can perform any transformations it likes, but of course should take
20569 care not to break RFC 2822 syntax. Exim does not check the result, except to
20570 test for a final newline when SMTP is in use. All messages transmitted over
20571 SMTP must end with a newline, so Exim supplies one if it is missing.
20572
20573 .cindex "content scanning" "per user"
20574 A transport filter can be used to provide content-scanning on a per-user basis
20575 at delivery time if the only required effect of the scan is to modify the
20576 message. For example, a content scan could insert a new header line containing
20577 a spam score. This could be interpreted by a filter in the user's MUA. It is
20578 not possible to discard a message at this stage.
20579
20580 .cindex "SMTP" "SIZE"
20581 A problem might arise if the filter increases the size of a message that is
20582 being sent down an SMTP connection. If the receiving SMTP server has indicated
20583 support for the SIZE parameter, Exim will have sent the size of the message
20584 at the start of the SMTP session. If what is actually sent is substantially
20585 more, the server might reject the message. This can be worked round by setting
20586 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20587 additions to the message, or to disable the use of SIZE altogether.
20588
20589 .vindex "&$pipe_addresses$&"
20590 The value of the &%transport_filter%& option is the command string for starting
20591 the filter, which is run directly from Exim, not under a shell. The string is
20592 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20593 Exim breaks it up into arguments and then expands each argument separately (see
20594 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20595 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20596 of arguments, one for each address that applies to this delivery. (This isn't
20597 an ideal name for this feature here, but as it was already implemented for the
20598 &(pipe)& transport, it seemed sensible not to change it.)
20599
20600 .vindex "&$host$&"
20601 .vindex "&$host_address$&"
20602 The expansion variables &$host$& and &$host_address$& are available when the
20603 transport is a remote one. They contain the name and IP address of the host to
20604 which the message is being sent. For example:
20605 .code
20606 transport_filter = /some/directory/transport-filter.pl \
20607   $host $host_address $sender_address $pipe_addresses
20608 .endd
20609
20610 Two problems arise if you want to use more complicated expansion items to
20611 generate transport filter commands, both of which due to the fact that the
20612 command is split up &'before'& expansion.
20613 .ilist
20614 If an expansion item contains white space, you must quote it, so that it is all
20615 part of the same command item. If the entire option setting is one such
20616 expansion item, you have to take care what kind of quoting you use. For
20617 example:
20618 .code
20619 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20620 .endd
20621 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20622 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20623 stripped by Exim when it read the option's value. When the value is used, if
20624 the single quotes were missing, the line would be split into two items,
20625 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20626 Exim tried to expand the first one.
20627 .next
20628 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20629 expansion cannot generate multiple arguments, or a command name followed by
20630 arguments. Consider this example:
20631 .code
20632 transport_filter = ${lookup{$host}lsearch{/a/file}\
20633                     {$value}{/bin/cat}}
20634 .endd
20635 The result of the lookup is interpreted as the name of the command, even
20636 if it contains white space. The simplest way round this is to use a shell:
20637 .code
20638 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20639                                {$value}{/bin/cat}}
20640 .endd
20641 .endlist
20642
20643 The filter process is run under the same uid and gid as the normal delivery.
20644 For remote deliveries this is the Exim uid/gid by default. The command should
20645 normally yield a zero return code. Transport filters are not supposed to fail.
20646 A non-zero code is taken to mean that the transport filter encountered some
20647 serious problem. Delivery of the message is deferred; the message remains on
20648 the queue and is tried again later. It is not possible to cause a message to be
20649 bounced from a transport filter.
20650
20651 If a transport filter is set on an autoreply transport, the original message is
20652 passed through the filter as it is being copied into the newly generated
20653 message, which happens if the &%return_message%& option is set.
20654
20655
20656 .option transport_filter_timeout transports time 5m
20657 .cindex "transport" "filter, timeout"
20658 When Exim is reading the output of a transport filter, it applies a timeout
20659 that can be set by this option. Exceeding the timeout is normally treated as a
20660 temporary delivery failure. However, if a transport filter is used with a
20661 &(pipe)& transport, a timeout in the transport filter is treated in the same
20662 way as a timeout in the pipe command itself. By default, a timeout is a hard
20663 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20664 becomes a temporary error.
20665
20666
20667 .option user transports string&!! "Exim user"
20668 .cindex "uid (user id)" "local delivery"
20669 .cindex "transport" "user, specifying"
20670 This option specifies the user under whose uid the delivery process is to be
20671 run, overriding any uid that may have been set by the router. If the user is
20672 given as a name, the uid is looked up from the password data, and the
20673 associated group is taken as the value of the gid to be used if the &%group%&
20674 option is not set.
20675
20676 For deliveries that use local transports, a user and group are normally
20677 specified explicitly or implicitly (for example, as a result of
20678 &%check_local_user%&) by the router or transport.
20679
20680 .cindex "hints database" "access by remote transport"
20681 For remote transports, you should leave this option unset unless you really are
20682 sure you know what you are doing. When a remote transport is running, it needs
20683 to be able to access Exim's hints databases, because each host may have its own
20684 retry data.
20685 .ecindex IIDgenoptra1
20686 .ecindex IIDgenoptra2
20687 .ecindex IIDgenoptra3
20688
20689
20690
20691
20692
20693
20694 . ////////////////////////////////////////////////////////////////////////////
20695 . ////////////////////////////////////////////////////////////////////////////
20696
20697 .chapter "Address batching in local transports" "CHAPbatching" &&&
20698          "Address batching"
20699 .cindex "transport" "local; address batching in"
20700 The only remote transport (&(smtp)&) is normally configured to handle more than
20701 one address at a time, so that when several addresses are routed to the same
20702 remote host, just one copy of the message is sent. Local transports, however,
20703 normally handle one address at a time. That is, a separate instance of the
20704 transport is run for each address that is routed to the transport. A separate
20705 copy of the message is delivered each time.
20706
20707 .cindex "batched local delivery"
20708 .oindex "&%batch_max%&"
20709 .oindex "&%batch_id%&"
20710 In special cases, it may be desirable to handle several addresses at once in a
20711 local transport, for example:
20712
20713 .ilist
20714 In an &(appendfile)& transport, when storing messages in files for later
20715 delivery by some other means, a single copy of the message with multiple
20716 recipients saves space.
20717 .next
20718 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20719 a single copy saves time, and is the normal way LMTP is expected to work.
20720 .next
20721 In a &(pipe)& transport, when passing the message
20722 to a scanner program or
20723 to some other delivery mechanism such as UUCP, multiple recipients may be
20724 acceptable.
20725 .endlist
20726
20727 These three local transports all have the same options for controlling multiple
20728 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20729 repeating the information for each transport, these options are described here.
20730
20731 The &%batch_max%& option specifies the maximum number of addresses that can be
20732 delivered together in a single run of the transport. Its default value is one
20733 (no batching). When more than one address is routed to a transport that has a
20734 &%batch_max%& value greater than one, the addresses are delivered in a batch
20735 (that is, in a single run of the transport with multiple recipients), subject
20736 to certain conditions:
20737
20738 .ilist
20739 .vindex "&$local_part$&"
20740 If any of the transport's options contain a reference to &$local_part$&, no
20741 batching is possible.
20742 .next
20743 .vindex "&$domain$&"
20744 If any of the transport's options contain a reference to &$domain$&, only
20745 addresses with the same domain are batched.
20746 .next
20747 .cindex "customizing" "batching condition"
20748 If &%batch_id%& is set, it is expanded for each address, and only those
20749 addresses with the same expanded value are batched. This allows you to specify
20750 customized batching conditions. Failure of the expansion for any reason,
20751 including forced failure, disables batching, but it does not stop the delivery
20752 from taking place.
20753 .next
20754 Batched addresses must also have the same errors address (where to send
20755 delivery errors), the same header additions and removals, the same user and
20756 group for the transport, and if a host list is present, the first host must
20757 be the same.
20758 .endlist
20759
20760 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20761 both when the file or pipe command is specified in the transport, and when it
20762 is specified by a &(redirect)& router, but all the batched addresses must of
20763 course be routed to the same file or pipe command. These two transports have an
20764 option called &%use_bsmtp%&, which causes them to deliver the message in
20765 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20766 &%check_string%& and &%escape_string%& options are forced to the values
20767 .code
20768 check_string = "."
20769 escape_string = ".."
20770 .endd
20771 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20772 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20773 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20774
20775 .cindex "&'Envelope-to:'& header line"
20776 If the generic &%envelope_to_add%& option is set for a batching transport, the
20777 &'Envelope-to:'& header that is added to the message contains all the addresses
20778 that are being processed together. If you are using a batching &(appendfile)&
20779 transport without &%use_bsmtp%&, the only way to preserve the recipient
20780 addresses is to set the &%envelope_to_add%& option.
20781
20782 .cindex "&(pipe)& transport" "with multiple addresses"
20783 .vindex "&$pipe_addresses$&"
20784 If you are using a &(pipe)& transport without BSMTP, and setting the
20785 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20786 the command. This is not a true variable; it is a bit of magic that causes each
20787 of the recipient addresses to be inserted into the command as a separate
20788 argument. This provides a way of accessing all the addresses that are being
20789 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20790 are specified by a &(redirect)& router.
20791
20792
20793
20794
20795 . ////////////////////////////////////////////////////////////////////////////
20796 . ////////////////////////////////////////////////////////////////////////////
20797
20798 .chapter "The appendfile transport" "CHAPappendfile"
20799 .scindex IIDapptra1 "&(appendfile)& transport"
20800 .scindex IIDapptra2 "transports" "&(appendfile)&"
20801 .cindex "directory creation"
20802 .cindex "creating directories"
20803 The &(appendfile)& transport delivers a message by appending it to an existing
20804 file, or by creating an entirely new file in a specified directory. Single
20805 files to which messages are appended can be in the traditional Unix mailbox
20806 format, or optionally in the MBX format supported by the Pine MUA and
20807 University of Washington IMAP daemon, &'inter alia'&. When each message is
20808 being delivered as a separate file, &"maildir"& format can optionally be used
20809 to give added protection against failures that happen part-way through the
20810 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20811 supported. For all file formats, Exim attempts to create as many levels of
20812 directory as necessary, provided that &%create_directory%& is set.
20813
20814 The code for the optional formats is not included in the Exim binary by
20815 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20816 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20817 included.
20818
20819 .cindex "quota" "system"
20820 Exim recognizes system quota errors, and generates an appropriate message. Exim
20821 also supports its own quota control within the transport, for use when the
20822 system facility is unavailable or cannot be used for some reason.
20823
20824 If there is an error while appending to a file (for example, quota exceeded or
20825 partition filled), Exim attempts to reset the file's length and last
20826 modification time back to what they were before. If there is an error while
20827 creating an entirely new file, the new file is removed.
20828
20829 Before appending to a file, a number of security checks are made, and the
20830 file is locked. A detailed description is given below, after the list of
20831 private options.
20832
20833 The &(appendfile)& transport is most commonly used for local deliveries to
20834 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20835 putting messages into files for remote delivery by some means other than Exim.
20836 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20837 option).
20838
20839
20840
20841 .section "The file and directory options" "SECTfildiropt"
20842 The &%file%& option specifies a single file, to which the message is appended;
20843 the &%directory%& option specifies a directory, in which a new file containing
20844 the message is created. Only one of these two options can be set, and for
20845 normal deliveries to mailboxes, one of them &'must'& be set.
20846
20847 .vindex "&$address_file$&"
20848 .vindex "&$local_part$&"
20849 However, &(appendfile)& is also used for delivering messages to files or
20850 directories whose names (or parts of names) are obtained from alias,
20851 forwarding, or filtering operations (for example, a &%save%& command in a
20852 user's Exim filter). When such a transport is running, &$local_part$& contains
20853 the local part that was aliased or forwarded, and &$address_file$& contains the
20854 name (or partial name) of the file or directory generated by the redirection
20855 operation. There are two cases:
20856
20857 .ilist
20858 If neither &%file%& nor &%directory%& is set, the redirection operation
20859 must specify an absolute path (one that begins with &`/`&). This is the most
20860 common case when users with local accounts use filtering to sort mail into
20861 different folders. See for example, the &(address_file)& transport in the
20862 default configuration. If the path ends with a slash, it is assumed to be the
20863 name of a directory. A delivery to a directory can also be forced by setting
20864 &%maildir_format%& or &%mailstore_format%&.
20865 .next
20866 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20867 used to determine the file or directory name for the delivery. Normally, the
20868 contents of &$address_file$& are used in some way in the string expansion.
20869 .endlist
20870
20871
20872 .cindex "Sieve filter" "configuring &(appendfile)&"
20873 .cindex "Sieve filter" "relative mailbox path handling"
20874 As an example of the second case, consider an environment where users do not
20875 have home directories. They may be permitted to use Exim filter commands of the
20876 form:
20877 .code
20878 save folder23
20879 .endd
20880 or Sieve filter commands of the form:
20881 .code
20882 require "fileinto";
20883 fileinto "folder23";
20884 .endd
20885 In this situation, the expansion of &%file%& or &%directory%& in the transport
20886 must transform the relative path into an appropriate absolute file name. In the
20887 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20888 is used as a result of a &"keep"& action in the filter. This example shows one
20889 way of handling this requirement:
20890 .code
20891 file = ${if eq{$address_file}{inbox} \
20892             {/var/mail/$local_part} \
20893             {${if eq{${substr_0_1:$address_file}}{/} \
20894                   {$address_file} \
20895                   {$home/mail/$address_file} \
20896             }} \
20897        }
20898 .endd
20899 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20900 location, absolute paths are used without change, and other folders are in the
20901 &_mail_& directory within the home directory.
20902
20903 &*Note 1*&: While processing an Exim filter, a relative path such as
20904 &_folder23_& is turned into an absolute path if a home directory is known to
20905 the router. In particular, this is the case if &%check_local_user%& is set. If
20906 you want to prevent this happening at routing time, you can set
20907 &%router_home_directory%& empty. This forces the router to pass the relative
20908 path to the transport.
20909
20910 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20911 the &%file%& or &%directory%& option is still used if it is set.
20912
20913
20914
20915
20916 .section "Private options for appendfile" "SECID134"
20917 .cindex "options" "&(appendfile)& transport"
20918
20919
20920
20921 .option allow_fifo appendfile boolean false
20922 .cindex "fifo (named pipe)"
20923 .cindex "named pipe (fifo)"
20924 .cindex "pipe" "named (fifo)"
20925 Setting this option permits delivery to named pipes (FIFOs) as well as to
20926 regular files. If no process is reading the named pipe at delivery time, the
20927 delivery is deferred.
20928
20929
20930 .option allow_symlink appendfile boolean false
20931 .cindex "symbolic link" "to mailbox"
20932 .cindex "mailbox" "symbolic link"
20933 By default, &(appendfile)& will not deliver if the path name for the file is
20934 that of a symbolic link. Setting this option relaxes that constraint, but there
20935 are security issues involved in the use of symbolic links. Be sure you know
20936 what you are doing if you set this. Details of exactly what this option affects
20937 are included in the discussion which follows this list of options.
20938
20939
20940 .option batch_id appendfile string&!! unset
20941 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20942 However, batching is automatically disabled for &(appendfile)& deliveries that
20943 happen as a result of forwarding or aliasing or other redirection directly to a
20944 file.
20945
20946
20947 .option batch_max appendfile integer 1
20948 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20949
20950
20951 .option check_group appendfile boolean false
20952 When this option is set, the group owner of the file defined by the &%file%&
20953 option is checked to see that it is the same as the group under which the
20954 delivery process is running. The default setting is false because the default
20955 file mode is 0600, which means that the group is irrelevant.
20956
20957
20958 .option check_owner appendfile boolean true
20959 When this option is set, the owner of the file defined by the &%file%& option
20960 is checked to ensure that it is the same as the user under which the delivery
20961 process is running.
20962
20963
20964 .option check_string appendfile string "see below"
20965 .cindex "&""From""& line"
20966 As &(appendfile)& writes the message, the start of each line is tested for
20967 matching &%check_string%&, and if it does, the initial matching characters are
20968 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20969 a literal string, not a regular expression, and the case of any letters it
20970 contains is significant.
20971
20972 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20973 are forced to &"."& and &".."& respectively, and any settings in the
20974 configuration are ignored. Otherwise, they default to &"From&~"& and
20975 &">From&~"& when the &%file%& option is set, and unset when any of the
20976 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20977
20978 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20979 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20980 &"From&~"& indicates the start of a new message. All four options need changing
20981 if another format is used. For example, to deliver to mailboxes in MMDF format:
20982 .cindex "MMDF format mailbox"
20983 .cindex "mailbox" "MMDF format"
20984 .code
20985 check_string = "\1\1\1\1\n"
20986 escape_string = "\1\1\1\1 \n"
20987 message_prefix = "\1\1\1\1\n"
20988 message_suffix = "\1\1\1\1\n"
20989 .endd
20990 .option create_directory appendfile boolean true
20991 .cindex "directory creation"
20992 When this option is true, Exim attempts to create any missing superior
20993 directories for the file that it is about to write. A created directory's mode
20994 is given by the &%directory_mode%& option.
20995
20996 The group ownership of a newly created directory is highly dependent on the
20997 operating system (and possibly the file system) that is being used. For
20998 example, in Solaris, if the parent directory has the setgid bit set, its group
20999 is propagated to the child; if not, the currently set group is used. However,
21000 in FreeBSD, the parent's group is always used.
21001
21002
21003
21004 .option create_file appendfile string anywhere
21005 This option constrains the location of files and directories that are created
21006 by this transport. It applies to files defined by the &%file%& option and
21007 directories defined by the &%directory%& option. In the case of maildir
21008 delivery, it applies to the top level directory, not the maildir directories
21009 beneath.
21010
21011 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21012 &"belowhome"&. In the second and third cases, a home directory must have been
21013 set for the transport. This option is not useful when an explicit file name is
21014 given for normal mailbox deliveries. It is intended for the case when file
21015 names are generated from users' &_.forward_& files. These are usually handled
21016 by an &(appendfile)& transport called &%address_file%&. See also
21017 &%file_must_exist%&.
21018
21019
21020 .option directory appendfile string&!! unset
21021 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21022 or &%directory%& must be set, unless the delivery is the direct result of a
21023 redirection (see section &<<SECTfildiropt>>&).
21024
21025 When &%directory%& is set, the string is expanded, and the message is delivered
21026 into a new file or files in or below the given directory, instead of being
21027 appended to a single mailbox file. A number of different formats are provided
21028 (see &%maildir_format%& and &%mailstore_format%&), and see section
21029 &<<SECTopdir>>& for further details of this form of delivery.
21030
21031
21032 .option directory_file appendfile string&!! "see below"
21033 .cindex "base62"
21034 .vindex "&$inode$&"
21035 When &%directory%& is set, but neither &%maildir_format%& nor
21036 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21037 whose name is obtained by expanding this string. The default value is:
21038 .code
21039 q${base62:$tod_epoch}-$inode
21040 .endd
21041 This generates a unique name from the current time, in base 62 form, and the
21042 inode of the file. The variable &$inode$& is available only when expanding this
21043 option.
21044
21045
21046 .option directory_mode appendfile "octal integer" 0700
21047 If &(appendfile)& creates any directories as a result of the
21048 &%create_directory%& option, their mode is specified by this option.
21049
21050
21051 .option escape_string appendfile string "see description"
21052 See &%check_string%& above.
21053
21054
21055 .option file appendfile string&!! unset
21056 This option is mutually exclusive with the &%directory%& option, but one of
21057 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21058 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21059 specifies a single file, to which the message is appended. One or more of
21060 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21061 &%file%&.
21062
21063 .cindex "NFS" "lock file"
21064 .cindex "locking files"
21065 .cindex "lock files"
21066 If you are using more than one host to deliver over NFS into the same
21067 mailboxes, you should always use lock files.
21068
21069 The string value is expanded for each delivery, and must yield an absolute
21070 path. The most common settings of this option are variations on one of these
21071 examples:
21072 .code
21073 file = /var/spool/mail/$local_part
21074 file = /home/$local_part/inbox
21075 file = $home/inbox
21076 .endd
21077 .cindex "&""sticky""& bit"
21078 In the first example, all deliveries are done into the same directory. If Exim
21079 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21080 create a file in the directory, so the &"sticky"& bit must be turned on for
21081 deliveries to be possible, or alternatively the &%group%& option can be used to
21082 run the delivery under a group id which has write access to the directory.
21083
21084
21085
21086 .option file_format appendfile string unset
21087 .cindex "file" "mailbox; checking existing format"
21088 This option requests the transport to check the format of an existing file
21089 before adding to it. The check consists of matching a specific string at the
21090 start of the file. The value of the option consists of an even number of
21091 colon-separated strings. The first of each pair is the test string, and the
21092 second is the name of a transport. If the transport associated with a matched
21093 string is not the current transport, control is passed over to the other
21094 transport. For example, suppose the standard &(local_delivery)& transport has
21095 this added to it:
21096 .code
21097 file_format = "From       : local_delivery :\
21098                \1\1\1\1\n : local_mmdf_delivery"
21099 .endd
21100 Mailboxes that begin with &"From"& are still handled by this transport, but if
21101 a mailbox begins with four binary ones followed by a newline, control is passed
21102 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21103 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21104 is assumed to match the current transport. If the start of a mailbox doesn't
21105 match any string, or if the transport named for a given string is not defined,
21106 delivery is deferred.
21107
21108
21109 .option file_must_exist appendfile boolean false
21110 If this option is true, the file specified by the &%file%& option must exist.
21111 A temporary error occurs if it does not, causing delivery to be deferred.
21112 If this option is false, the file is created if it does not exist.
21113
21114
21115 .option lock_fcntl_timeout appendfile time 0s
21116 .cindex "timeout" "mailbox locking"
21117 .cindex "mailbox" "locking, blocking and non-blocking"
21118 .cindex "locking files"
21119 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21120 when locking an open mailbox file. If the call fails, the delivery process
21121 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21122 Non-blocking calls are used so that the file is not kept open during the wait
21123 for the lock; the reason for this is to make it as safe as possible for
21124 deliveries over NFS in the case when processes might be accessing an NFS
21125 mailbox without using a lock file. This should not be done, but
21126 misunderstandings and hence misconfigurations are not unknown.
21127
21128 On a busy system, however, the performance of a non-blocking lock approach is
21129 not as good as using a blocking lock with a timeout. In this case, the waiting
21130 is done inside the system call, and Exim's delivery process acquires the lock
21131 and can proceed as soon as the previous lock holder releases it.
21132
21133 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21134 timeout, are used. There may still be some retrying: the maximum number of
21135 retries is
21136 .code
21137 (lock_retries * lock_interval) / lock_fcntl_timeout
21138 .endd
21139 rounded up to the next whole number. In other words, the total time during
21140 which &(appendfile)& is trying to get a lock is roughly the same, unless
21141 &%lock_fcntl_timeout%& is set very large.
21142
21143 You should consider setting this option if you are getting a lot of delayed
21144 local deliveries because of errors of the form
21145 .code
21146 failed to lock mailbox /some/file (fcntl)
21147 .endd
21148
21149 .option lock_flock_timeout appendfile time 0s
21150 This timeout applies to file locking when using &[flock()]& (see
21151 &%use_flock%&); the timeout operates in a similar manner to
21152 &%lock_fcntl_timeout%&.
21153
21154
21155 .option lock_interval appendfile time 3s
21156 This specifies the time to wait between attempts to lock the file. See below
21157 for details of locking.
21158
21159
21160 .option lock_retries appendfile integer 10
21161 This specifies the maximum number of attempts to lock the file. A value of zero
21162 is treated as 1. See below for details of locking.
21163
21164
21165 .option lockfile_mode appendfile "octal integer" 0600
21166 This specifies the mode of the created lock file, when a lock file is being
21167 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21168
21169
21170 .option lockfile_timeout appendfile time 30m
21171 .cindex "timeout" "mailbox locking"
21172 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21173 exists and is older than this value, it is assumed to have been left behind by
21174 accident, and Exim attempts to remove it.
21175
21176
21177 .option mailbox_filecount appendfile string&!! unset
21178 .cindex "mailbox" "specifying size of"
21179 .cindex "size" "of mailbox"
21180 If this option is set, it is expanded, and the result is taken as the current
21181 number of files in the mailbox. It must be a decimal number, optionally
21182 followed by K or M. This provides a way of obtaining this information from an
21183 external source that maintains the data.
21184
21185
21186 .option mailbox_size appendfile string&!! unset
21187 .cindex "mailbox" "specifying size of"
21188 .cindex "size" "of mailbox"
21189 If this option is set, it is expanded, and the result is taken as the current
21190 size the mailbox. It must be a decimal number, optionally followed by K or M.
21191 This provides a way of obtaining this information from an external source that
21192 maintains the data. This is likely to be helpful for maildir deliveries where
21193 it is computationally expensive to compute the size of a mailbox.
21194
21195
21196
21197 .option maildir_format appendfile boolean false
21198 .cindex "maildir format" "specifying"
21199 If this option is set with the &%directory%& option, the delivery is into a new
21200 file, in the &"maildir"& format that is used by other mail software. When the
21201 transport is activated directly from a &(redirect)& router (for example, the
21202 &(address_file)& transport in the default configuration), setting
21203 &%maildir_format%& causes the path received from the router to be treated as a
21204 directory, whether or not it ends with &`/`&. This option is available only if
21205 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21206 &<<SECTmaildirdelivery>>& below for further details.
21207
21208
21209 .option maildir_quota_directory_regex appendfile string "See below"
21210 .cindex "maildir format" "quota; directories included in"
21211 .cindex "quota" "maildir; directories included in"
21212 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21213 a regular expression for specifying directories, relative to the quota
21214 directory (see &%quota_directory%&), that should be included in the quota
21215 calculation. The default value is:
21216 .code
21217 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21218 .endd
21219 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21220 (directories whose names begin with a dot). If you want to exclude the
21221 &_Trash_&
21222 folder from the count (as some sites do), you need to change this setting to
21223 .code
21224 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21225 .endd
21226 This uses a negative lookahead in the regular expression to exclude the
21227 directory whose name is &_.Trash_&. When a directory is excluded from quota
21228 calculations, quota processing is bypassed for any messages that are delivered
21229 directly into that directory.
21230
21231
21232 .option maildir_retries appendfile integer 10
21233 This option specifies the number of times to retry when writing a file in
21234 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21235
21236
21237 .option maildir_tag appendfile string&!! unset
21238 This option applies only to deliveries in maildir format, and is described in
21239 section &<<SECTmaildirdelivery>>& below.
21240
21241
21242 .option maildir_use_size_file appendfile&!! boolean false
21243 .cindex "maildir format" "&_maildirsize_& file"
21244 The result of string expansion for this option must be a valid boolean value.
21245 If it is true, it enables support for &_maildirsize_& files. Exim
21246 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21247 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21248 value is zero. See &%maildir_quota_directory_regex%& above and section
21249 &<<SECTmaildirdelivery>>& below for further details.
21250
21251 .option maildirfolder_create_regex appendfile string unset
21252 .cindex "maildir format" "&_maildirfolder_& file"
21253 .cindex "&_maildirfolder_&, creating"
21254 The value of this option is a regular expression. If it is unset, it has no
21255 effect. Otherwise, before a maildir delivery takes place, the pattern is
21256 matched against the name of the maildir directory, that is, the directory
21257 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21258 delivery. If there is a match, Exim checks for the existence of a file called
21259 &_maildirfolder_& in the directory, and creates it if it does not exist.
21260 See section &<<SECTmaildirdelivery>>& for more details.
21261
21262
21263 .option mailstore_format appendfile boolean false
21264 .cindex "mailstore format" "specifying"
21265 If this option is set with the &%directory%& option, the delivery is into two
21266 new files in  &"mailstore"& format. The option is available only if
21267 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21268 below for further details.
21269
21270
21271 .option mailstore_prefix appendfile string&!! unset
21272 This option applies only to deliveries in mailstore format, and is described in
21273 section &<<SECTopdir>>& below.
21274
21275
21276 .option mailstore_suffix appendfile string&!! unset
21277 This option applies only to deliveries in mailstore format, and is described in
21278 section &<<SECTopdir>>& below.
21279
21280
21281 .option mbx_format appendfile boolean false
21282 .cindex "locking files"
21283 .cindex "file" "locking"
21284 .cindex "file" "MBX format"
21285 .cindex "MBX format, specifying"
21286 This option is available only if Exim has been compiled with SUPPORT_MBX
21287 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21288 the message is appended to the mailbox file in MBX format instead of
21289 traditional Unix format. This format is supported by Pine4 and its associated
21290 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21291
21292 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21293 automatically changed by the use of &%mbx_format%&. They should normally be set
21294 empty when using MBX format, so this option almost always appears in this
21295 combination:
21296 .code
21297 mbx_format = true
21298 message_prefix =
21299 message_suffix =
21300 .endd
21301 If none of the locking options are mentioned in the configuration,
21302 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21303 is possible to specify the other kinds of locking with &%mbx_format%&, but
21304 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21305 interworks with &'c-client'&, providing for shared access to the mailbox. It
21306 should not be used if any program that does not use this form of locking is
21307 going to access the mailbox, nor should it be used if the mailbox file is NFS
21308 mounted, because it works only when the mailbox is accessed from a single host.
21309
21310 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21311 the standard version of &'c-client'&, because as long as it has a mailbox open
21312 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21313 append messages to it.
21314
21315
21316 .option message_prefix appendfile string&!! "see below"
21317 .cindex "&""From""& line"
21318 The string specified here is expanded and output at the start of every message.
21319 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21320 in which case it is:
21321 .code
21322 message_prefix = "From ${if def:return_path{$return_path}\
21323   {MAILER-DAEMON}} $tod_bsdinbox\n"
21324 .endd
21325 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21326 &`\n`& to &`\r\n`& in &%message_prefix%&.
21327
21328 .option message_suffix appendfile string&!! "see below"
21329 The string specified here is expanded and output at the end of every message.
21330 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21331 in which case it is a single newline character. The suffix can be suppressed by
21332 setting
21333 .code
21334 message_suffix =
21335 .endd
21336 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21337 &`\n`& to &`\r\n`& in &%message_suffix%&.
21338
21339 .option mode appendfile "octal integer" 0600
21340 If the output file is created, it is given this mode. If it already exists and
21341 has wider permissions, they are reduced to this mode. If it has narrower
21342 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21343 if the delivery is the result of a &%save%& command in a filter file specifying
21344 a particular mode, the mode of the output file is always forced to take that
21345 value, and this option is ignored.
21346
21347
21348 .option mode_fail_narrower appendfile boolean true
21349 This option applies in the case when an existing mailbox file has a narrower
21350 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21351 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21352 continues with the delivery attempt, using the existing mode of the file.
21353
21354
21355 .option notify_comsat appendfile boolean false
21356 If this option is true, the &'comsat'& daemon is notified after every
21357 successful delivery to a user mailbox. This is the daemon that notifies logged
21358 on users about incoming mail.
21359
21360
21361 .option quota appendfile string&!! unset
21362 .cindex "quota" "imposed by Exim"
21363 This option imposes a limit on the size of the file to which Exim is appending,
21364 or to the total space used in the directory tree when the &%directory%& option
21365 is set. In the latter case, computation of the space used is expensive, because
21366 all the files in the directory (and any sub-directories) have to be
21367 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21368 &%maildir_use_size_file%& for ways to avoid this in environments where users
21369 have no shell access to their mailboxes).
21370
21371 As there is no interlock against two simultaneous deliveries into a
21372 multi-file mailbox, it is possible for the quota to be overrun in this case.
21373 For single-file mailboxes, of course, an interlock is a necessity.
21374
21375 A file's size is taken as its &'used'& value. Because of blocking effects, this
21376 may be a lot less than the actual amount of disk space allocated to the file.
21377 If the sizes of a number of files are being added up, the rounding effect can
21378 become quite noticeable, especially on systems that have large block sizes.
21379 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21380 the obvious value which users understand most easily.
21381
21382 The value of the option is expanded, and must then be a numerical value
21383 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21384 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21385 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21386 be handled.
21387
21388 &*Note*&: A value of zero is interpreted as &"no quota"&.
21389
21390 The expansion happens while Exim is running as root, before it changes uid for
21391 the delivery. This means that files that are inaccessible to the end user can
21392 be used to hold quota values that are looked up in the expansion. When delivery
21393 fails because this quota is exceeded, the handling of the error is as for
21394 system quota failures.
21395
21396 By default, Exim's quota checking mimics system quotas, and restricts the
21397 mailbox to the specified maximum size, though the value is not accurate to the
21398 last byte, owing to separator lines and additional headers that may get added
21399 during message delivery. When a mailbox is nearly full, large messages may get
21400 refused even though small ones are accepted, because the size of the current
21401 message is added to the quota when the check is made. This behaviour can be
21402 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21403 for exceeding the quota does not include the current message. Thus, deliveries
21404 continue until the quota has been exceeded; thereafter, no further messages are
21405 delivered. See also &%quota_warn_threshold%&.
21406
21407
21408 .option quota_directory appendfile string&!! unset
21409 This option defines the directory to check for quota purposes when delivering
21410 into individual files. The default is the delivery directory, or, if a file
21411 called &_maildirfolder_& exists in a maildir directory, the parent of the
21412 delivery directory.
21413
21414
21415 .option quota_filecount appendfile string&!! 0
21416 This option applies when the &%directory%& option is set. It limits the total
21417 number of files in the directory (compare the inode limit in system quotas). It
21418 can only be used if &%quota%& is also set. The value is expanded; an expansion
21419 failure causes delivery to be deferred. A value of zero is interpreted as
21420 &"no quota"&.
21421
21422
21423 .option quota_is_inclusive appendfile boolean true
21424 See &%quota%& above.
21425
21426
21427 .option quota_size_regex appendfile string unset
21428 This option applies when one of the delivery modes that writes a separate file
21429 for each message is being used. When Exim wants to find the size of one of
21430 these files in order to test the quota, it first checks &%quota_size_regex%&.
21431 If this is set to a regular expression that matches the file name, and it
21432 captures one string, that string is interpreted as a representation of the
21433 file's size. The value of &%quota_size_regex%& is not expanded.
21434
21435 This feature is useful only when users have no shell access to their mailboxes
21436 &-- otherwise they could defeat the quota simply by renaming the files. This
21437 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21438 the file length to the file name. For example:
21439 .code
21440 maildir_tag = ,S=$message_size
21441 quota_size_regex = ,S=(\d+)
21442 .endd
21443 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21444 number of lines in the message.
21445
21446 The regular expression should not assume that the length is at the end of the
21447 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21448 sometimes add other information onto the ends of message file names.
21449
21450 Section &<<SECID136>>& contains further information.
21451
21452
21453 .option quota_warn_message appendfile string&!! "see below"
21454 See below for the use of this option. If it is not set when
21455 &%quota_warn_threshold%& is set, it defaults to
21456 .code
21457 quota_warn_message = "\
21458   To: $local_part@$domain\n\
21459   Subject: Your mailbox\n\n\
21460   This message is automatically created \
21461   by mail delivery software.\n\n\
21462   The size of your mailbox has exceeded \
21463   a warning threshold that is\n\
21464   set by the system administrator.\n"
21465 .endd
21466
21467
21468 .option quota_warn_threshold appendfile string&!! 0
21469 .cindex "quota" "warning threshold"
21470 .cindex "mailbox" "size warning"
21471 .cindex "size" "of mailbox"
21472 This option is expanded in the same way as &%quota%& (see above). If the
21473 resulting value is greater than zero, and delivery of the message causes the
21474 size of the file or total space in the directory tree to cross the given
21475 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21476 may be specified as a percentage of it by following the value with a percent
21477 sign. For example:
21478 .code
21479 quota = 10M
21480 quota_warn_threshold = 75%
21481 .endd
21482 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21483 percent sign is ignored.
21484
21485 The warning message itself is specified by the &%quota_warn_message%& option,
21486 and it must start with a &'To:'& header line containing the recipient(s) of the
21487 warning message. These do not necessarily have to include the recipient(s) of
21488 the original message. A &'Subject:'& line should also normally be supplied. You
21489 can include any other header lines that you want. If you do not include a
21490 &'From:'& line, the default is:
21491 .code
21492 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21493 .endd
21494 .oindex &%errors_reply_to%&
21495 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21496 option.
21497
21498 The &%quota%& option does not have to be set in order to use this option; they
21499 are independent of one another except when the threshold is specified as a
21500 percentage.
21501
21502
21503 .option use_bsmtp appendfile boolean false
21504 .cindex "envelope sender"
21505 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21506 format, with the envelope sender and recipient(s) included as SMTP commands. If
21507 you want to include a leading HELO command with such messages, you can do
21508 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21509 for details of batch SMTP.
21510
21511
21512 .option use_crlf appendfile boolean false
21513 .cindex "carriage return"
21514 .cindex "linefeed"
21515 This option causes lines to be terminated with the two-character CRLF sequence
21516 (carriage return, linefeed) instead of just a linefeed character. In the case
21517 of batched SMTP, the byte sequence written to the file is then an exact image
21518 of what would be sent down a real SMTP connection.
21519
21520 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21521 (which are used to supply the traditional &"From&~"& and blank line separators
21522 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21523 carriage return characters if these are needed. In cases where these options
21524 have non-empty defaults, the values end with a single linefeed, so they must be
21525 changed to end with &`\r\n`& if &%use_crlf%& is set.
21526
21527
21528 .option use_fcntl_lock appendfile boolean "see below"
21529 This option controls the use of the &[fcntl()]& function to lock a file for
21530 exclusive use when a message is being appended. It is set by default unless
21531 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21532 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21533 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21534
21535
21536 .option use_flock_lock appendfile boolean false
21537 This option is provided to support the use of &[flock()]& for file locking, for
21538 the few situations where it is needed. Most modern operating systems support
21539 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21540 each other. Exim uses &[fcntl()]& locking by default.
21541
21542 This option is required only if you are using an operating system where
21543 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21544 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21545 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21546
21547 .cindex "Solaris" "&[flock()]& support"
21548 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21549 have it (and some, I think, provide a not quite right version built on top of
21550 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21551 the ability to use it, and any attempt to do so will cause a configuration
21552 error.
21553
21554 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21555 is just being mapped onto &[fcntl()]& by the OS).
21556
21557
21558 .option use_lockfile appendfile boolean "see below"
21559 If this option is turned off, Exim does not attempt to create a lock file when
21560 appending to a mailbox file. In this situation, the only locking is by
21561 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21562 sure that every MUA that is ever going to look at your users' mailboxes uses
21563 &[fcntl()]& rather than a lock file, and even then only when you are not
21564 delivering over NFS from more than one host.
21565
21566 .cindex "NFS" "lock file"
21567 In order to append to an NFS file safely from more than one host, it is
21568 necessary to take out a lock &'before'& opening the file, and the lock file
21569 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21570 file corruption.
21571
21572 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21573 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21574 except when &%mbx_format%& is set.
21575
21576
21577 .option use_mbx_lock appendfile boolean "see below"
21578 This option is available only if Exim has been compiled with SUPPORT_MBX
21579 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21580 locking rules be used. It is set by default if &%mbx_format%& is set and none
21581 of the locking options are mentioned in the configuration. The locking rules
21582 are the same as are used by the &'c-client'& library that underlies Pine and
21583 the IMAP4 and POP daemons that come with it (see the discussion below). The
21584 rules allow for shared access to the mailbox. However, this kind of locking
21585 does not work when the mailbox is NFS mounted.
21586
21587 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21588 &%use_flock_lock%& to control what kind of locking is used in implementing the
21589 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21590 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21591
21592
21593
21594
21595 .section "Operational details for appending" "SECTopappend"
21596 .cindex "appending to a file"
21597 .cindex "file" "appending"
21598 Before appending to a file, the following preparations are made:
21599
21600 .ilist
21601 If the name of the file is &_/dev/null_&, no action is taken, and a success
21602 return is given.
21603
21604 .next
21605 .cindex "directory creation"
21606 If any directories on the file's path are missing, Exim creates them if the
21607 &%create_directory%& option is set. A created directory's mode is given by the
21608 &%directory_mode%& option.
21609
21610 .next
21611 If &%file_format%& is set, the format of an existing file is checked. If this
21612 indicates that a different transport should be used, control is passed to that
21613 transport.
21614
21615 .next
21616 .cindex "file" "locking"
21617 .cindex "locking files"
21618 .cindex "NFS" "lock file"
21619 If &%use_lockfile%& is set, a lock file is built in a way that will work
21620 reliably over NFS, as follows:
21621
21622 .olist
21623 Create a &"hitching post"& file whose name is that of the lock file with the
21624 current time, primary host name, and process id added, by opening for writing
21625 as a new file. If this fails with an access error, delivery is deferred.
21626 .next
21627 Close the hitching post file, and hard link it to the lock file name.
21628 .next
21629 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21630 Unlink the hitching post name.
21631 .next
21632 Otherwise, use &[stat()]& to get information about the hitching post file, and
21633 then unlink hitching post name. If the number of links is exactly two, creation
21634 of the lock file succeeded but something (for example, an NFS server crash and
21635 restart) caused this fact not to be communicated to the &[link()]& call.
21636 .next
21637 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21638 up to &%lock_retries%& times. However, since any program that writes to a
21639 mailbox should complete its task very quickly, it is reasonable to time out old
21640 lock files that are normally the result of user agent and system crashes. If an
21641 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21642 it before trying again.
21643 .endlist olist
21644
21645 .next
21646 A call is made to &[lstat()]& to discover whether the main file exists, and if
21647 so, what its characteristics are. If &[lstat()]& fails for any reason other
21648 than non-existence, delivery is deferred.
21649
21650 .next
21651 .cindex "symbolic link" "to mailbox"
21652 .cindex "mailbox" "symbolic link"
21653 If the file does exist and is a symbolic link, delivery is deferred, unless the
21654 &%allow_symlink%& option is set, in which case the ownership of the link is
21655 checked, and then &[stat()]& is called to find out about the real file, which
21656 is then subjected to the checks below. The check on the top-level link
21657 ownership prevents one user creating a link for another's mailbox in a sticky
21658 directory, though allowing symbolic links in this case is definitely not a good
21659 idea. If there is a chain of symbolic links, the intermediate ones are not
21660 checked.
21661
21662 .next
21663 If the file already exists but is not a regular file, or if the file's owner
21664 and group (if the group is being checked &-- see &%check_group%& above) are
21665 different from the user and group under which the delivery is running,
21666 delivery is deferred.
21667
21668 .next
21669 If the file's permissions are more generous than specified, they are reduced.
21670 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21671 is set false, in which case the delivery is tried using the existing
21672 permissions.
21673
21674 .next
21675 The file's inode number is saved, and the file is then opened for appending.
21676 If this fails because the file has vanished, &(appendfile)& behaves as if it
21677 hadn't existed (see below). For any other failures, delivery is deferred.
21678
21679 .next
21680 If the file is opened successfully, check that the inode number hasn't
21681 changed, that it is still a regular file, and that the owner and permissions
21682 have not changed. If anything is wrong, defer delivery and freeze the message.
21683
21684 .next
21685 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21686 option is set. Otherwise, check that the file is being created in a permitted
21687 directory if the &%create_file%& option is set (deferring on failure), and then
21688 open for writing as a new file, with the O_EXCL and O_CREAT options,
21689 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21690 set). In this case, which can happen if the link points to a non-existent file,
21691 the file is opened for writing using O_CREAT but not O_EXCL, because
21692 that prevents link following.
21693
21694 .next
21695 .cindex "loop" "while file testing"
21696 If opening fails because the file exists, obey the tests given above for
21697 existing files. However, to avoid looping in a situation where the file is
21698 being continuously created and destroyed, the exists/not-exists loop is broken
21699 after 10 repetitions, and the message is then frozen.
21700
21701 .next
21702 If opening fails with any other error, defer delivery.
21703
21704 .next
21705 .cindex "file" "locking"
21706 .cindex "locking files"
21707 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21708 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21709 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21710 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21711 file, and an exclusive lock on the file whose name is
21712 .code
21713 /tmp/.<device-number>.<inode-number>
21714 .endd
21715 using the device and inode numbers of the open mailbox file, in accordance with
21716 the MBX locking rules. This file is created with a mode that is specified by
21717 the &%lockfile_mode%& option.
21718
21719 If Exim fails to lock the file, there are two possible courses of action,
21720 depending on the value of the locking timeout. This is obtained from
21721 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21722
21723 If the timeout value is zero, the file is closed, Exim waits for
21724 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21725 to lock it again. This happens up to &%lock_retries%& times, after which the
21726 delivery is deferred.
21727
21728 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21729 &[flock()]& are used (with the given timeout), so there has already been some
21730 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21731 immediately. It retries up to
21732 .code
21733 (lock_retries * lock_interval) / <timeout>
21734 .endd
21735 times (rounded up).
21736 .endlist
21737
21738 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21739 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21740
21741
21742 .section "Operational details for delivery to a new file" "SECTopdir"
21743 .cindex "delivery" "to single file"
21744 .cindex "&""From""& line"
21745 When the &%directory%& option is set instead of &%file%&, each message is
21746 delivered into a newly-created file or set of files. When &(appendfile)& is
21747 activated directly from a &(redirect)& router, neither &%file%& nor
21748 &%directory%& is normally set, because the path for delivery is supplied by the
21749 router. (See for example, the &(address_file)& transport in the default
21750 configuration.) In this case, delivery is to a new file if either the path name
21751 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21752
21753 No locking is required while writing the message to a new file, so the various
21754 locking options of the transport are ignored. The &"From"& line that by default
21755 separates messages in a single file is not normally needed, nor is the escaping
21756 of message lines that start with &"From"&, and there is no need to ensure a
21757 newline at the end of each message. Consequently, the default values for
21758 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21759 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21760
21761 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21762 the files in the delivery directory by default. However, you can specify a
21763 different directory by setting &%quota_directory%&. Also, for maildir
21764 deliveries (see below) the &_maildirfolder_& convention is honoured.
21765
21766
21767 .cindex "maildir format"
21768 .cindex "mailstore format"
21769 There are three different ways in which delivery to individual files can be
21770 done, controlled by the settings of the &%maildir_format%& and
21771 &%mailstore_format%& options. Note that code to support maildir or mailstore
21772 formats is not included in the binary unless SUPPORT_MAILDIR or
21773 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21774
21775 .cindex "directory creation"
21776 In all three cases an attempt is made to create the directory and any necessary
21777 sub-directories if they do not exist, provided that the &%create_directory%&
21778 option is set (the default). The location of a created directory can be
21779 constrained by setting &%create_file%&. A created directory's mode is given by
21780 the &%directory_mode%& option. If creation fails, or if the
21781 &%create_directory%& option is not set when creation is required, delivery is
21782 deferred.
21783
21784
21785
21786 .section "Maildir delivery" "SECTmaildirdelivery"
21787 .cindex "maildir format" "description of"
21788 If the &%maildir_format%& option is true, Exim delivers each message by writing
21789 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21790 directory that is defined by the &%directory%& option (the &"delivery
21791 directory"&). If the delivery is successful, the file is renamed into the
21792 &_new_& subdirectory.
21793
21794 In the file name, <&'stime'&> is the current time of day in seconds, and
21795 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21796 Exim checks that the time-of-day clock has moved on by at least one microsecond
21797 before terminating the delivery process. This guarantees uniqueness for the
21798 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21799 opening it. If any response other than ENOENT (does not exist) is given,
21800 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21801
21802 Before Exim carries out a maildir delivery, it ensures that subdirectories
21803 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21804 do not exist, Exim tries to create them and any superior directories in their
21805 path, subject to the &%create_directory%& and &%create_file%& options. If the
21806 &%maildirfolder_create_regex%& option is set, and the regular expression it
21807 contains matches the delivery directory, Exim also ensures that a file called
21808 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21809 &_maildirfolder_& file cannot be created, delivery is deferred.
21810
21811 These features make it possible to use Exim to create all the necessary files
21812 and directories in a maildir mailbox, including subdirectories for maildir++
21813 folders. Consider this example:
21814 .code
21815 maildir_format = true
21816 directory = /var/mail/$local_part\
21817            ${if eq{$local_part_suffix}{}{}\
21818            {/.${substr_1:$local_part_suffix}}}
21819 maildirfolder_create_regex = /\.[^/]+$
21820 .endd
21821 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21822 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21823 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21824 not match this name, so Exim will not look for or create the file
21825 &_/var/mail/pimbo/maildirfolder_&, though it will create
21826 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21827
21828 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21829 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21830 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21831 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21832 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21833
21834 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21835 not inadvertently match the toplevel maildir directory, because a
21836 &_maildirfolder_& file at top level would completely break quota calculations.
21837
21838 .cindex "quota" "in maildir delivery"
21839 .cindex "maildir++"
21840 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21841 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21842 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21843 Exim assumes the directory is a maildir++ folder directory, which is one level
21844 down from the user's top level mailbox directory. This causes it to start at
21845 the parent directory instead of the current directory when calculating the
21846 amount of space used.
21847
21848 One problem with delivering into a multi-file mailbox is that it is
21849 computationally expensive to compute the size of the mailbox for quota
21850 checking. Various approaches have been taken to reduce the amount of work
21851 needed. The next two sections describe two of them. A third alternative is to
21852 use some external process for maintaining the size data, and use the expansion
21853 of the &%mailbox_size%& option as a way of importing it into Exim.
21854
21855
21856
21857
21858 .section "Using tags to record message sizes" "SECID135"
21859 If &%maildir_tag%& is set, the string is expanded for each delivery.
21860 When the maildir file is renamed into the &_new_& sub-directory, the
21861 tag is added to its name. However, if adding the tag takes the length of the
21862 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21863 the tag is dropped and the maildir file is created with no tag.
21864
21865
21866 .vindex "&$message_size$&"
21867 Tags can be used to encode the size of files in their names; see
21868 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21869 happens after the message has been written. The value of the &$message_size$&
21870 variable is set to the number of bytes actually written. If the expansion is
21871 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21872 be deferred. The expanded tag may contain any printing characters except &"/"&.
21873 Non-printing characters in the string are ignored; if the resulting string is
21874 empty, it is ignored. If it starts with an alphanumeric character, a leading
21875 colon is inserted; this default has not proven to be the path that popular
21876 maildir implementations have chosen (but changing it in Exim would break
21877 backwards compatibility).
21878
21879 For one common implementation, you might set:
21880 .code
21881 maildir_tag = ,S=${message_size}
21882 .endd
21883 but you should check the documentation of the other software to be sure.
21884
21885 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21886 as this allows Exim to extract the size from your tag, instead of having to
21887 &[stat()]& each message file.
21888
21889
21890 .section "Using a maildirsize file" "SECID136"
21891 .cindex "quota" "in maildir delivery"
21892 .cindex "maildir format" "&_maildirsize_& file"
21893 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21894 storing quota and message size information in a file called &_maildirsize_&
21895 within the toplevel maildir directory. If this file does not exist, Exim
21896 creates it, setting the quota from the &%quota%& option of the transport. If
21897 the maildir directory itself does not exist, it is created before any attempt
21898 to write a &_maildirsize_& file.
21899
21900 The &_maildirsize_& file is used to hold information about the sizes of
21901 messages in the maildir, thus speeding up quota calculations. The quota value
21902 in the file is just a cache; if the quota is changed in the transport, the new
21903 value overrides the cached value when the next message is delivered. The cache
21904 is maintained for the benefit of other programs that access the maildir and
21905 need to know the quota.
21906
21907 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21908 file is maintained (with a zero quota setting), but no quota is imposed.
21909
21910 A regular expression is available for controlling which directories in the
21911 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21912 See the description of the &%maildir_quota_directory_regex%& option above for
21913 details.
21914
21915
21916 .section "Mailstore delivery" "SECID137"
21917 .cindex "mailstore format" "description of"
21918 If the &%mailstore_format%& option is true, each message is written as two
21919 files in the given directory. A unique base name is constructed from the
21920 message id and the current delivery process, and the files that are written use
21921 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21922 contains the message's envelope, and the &_.msg_& file contains the message
21923 itself. The base name is placed in the variable &$mailstore_basename$&.
21924
21925 During delivery, the envelope is first written to a file with the suffix
21926 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21927 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21928 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21929 file before accessing either of them. An alternative approach is to wait for
21930 the absence of a &_.tmp_& file.
21931
21932 The envelope file starts with any text defined by the &%mailstore_prefix%&
21933 option, expanded and terminated by a newline if there isn't one. Then follows
21934 the sender address on one line, then all the recipient addresses, one per line.
21935 There can be more than one recipient only if the &%batch_max%& option is set
21936 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21937 appended to the file, followed by a newline if it does not end with one.
21938
21939 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21940 failure, it is ignored. Other expansion errors are treated as serious
21941 configuration errors, and delivery is deferred. The variable
21942 &$mailstore_basename$& is available for use during these expansions.
21943
21944
21945 .section "Non-special new file delivery" "SECID138"
21946 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21947 file is created directly in the named directory. For example, when delivering
21948 messages into files in batched SMTP format for later delivery to some host (see
21949 section &<<SECTbatchSMTP>>&), a setting such as
21950 .code
21951 directory = /var/bsmtp/$host
21952 .endd
21953 might be used. A message is written to a file with a temporary name, which is
21954 then renamed when the delivery is complete. The final name is obtained by
21955 expanding the contents of the &%directory_file%& option.
21956 .ecindex IIDapptra1
21957 .ecindex IIDapptra2
21958
21959
21960
21961
21962
21963
21964 . ////////////////////////////////////////////////////////////////////////////
21965 . ////////////////////////////////////////////////////////////////////////////
21966
21967 .chapter "The autoreply transport" "CHID8"
21968 .scindex IIDauttra1 "transports" "&(autoreply)&"
21969 .scindex IIDauttra2 "&(autoreply)& transport"
21970 The &(autoreply)& transport is not a true transport in that it does not cause
21971 the message to be transmitted. Instead, it generates a new mail message as an
21972 automatic reply to the incoming message. &'References:'& and
21973 &'Auto-Submitted:'& header lines are included. These are constructed according
21974 to the rules in RFCs 2822 and 3834, respectively.
21975
21976 If the router that passes the message to this transport does not have the
21977 &%unseen%& option set, the original message (for the current recipient) is not
21978 delivered anywhere. However, when the &%unseen%& option is set on the router
21979 that passes the message to this transport, routing of the address continues, so
21980 another router can set up a normal message delivery.
21981
21982
21983 The &(autoreply)& transport is usually run as the result of mail filtering, a
21984 &"vacation"& message being the standard example. However, it can also be run
21985 directly from a router like any other transport. To reduce the possibility of
21986 message cascades, messages created by the &(autoreply)& transport always have
21987 empty envelope sender addresses, like bounce messages.
21988
21989 The parameters of the message to be sent can be specified in the configuration
21990 by options described below. However, these are used only when the address
21991 passed to the transport does not contain its own reply information. When the
21992 transport is run as a consequence of a
21993 &%mail%&
21994 or &%vacation%& command in a filter file, the parameters of the message are
21995 supplied by the filter, and passed with the address. The transport's options
21996 that define the message are then ignored (so they are not usually set in this
21997 case). The message is specified entirely by the filter or by the transport; it
21998 is never built from a mixture of options. However, the &%file_optional%&,
21999 &%mode%&, and &%return_message%& options apply in all cases.
22000
22001 &(Autoreply)& is implemented as a local transport. When used as a result of a
22002 command in a user's filter file, &(autoreply)& normally runs under the uid and
22003 gid of the user, and with appropriate current and home directories (see chapter
22004 &<<CHAPenvironment>>&).
22005
22006 There is a subtle difference between routing a message to a &(pipe)& transport
22007 that generates some text to be returned to the sender, and routing it to an
22008 &(autoreply)& transport. This difference is noticeable only if more than one
22009 address from the same message is so handled. In the case of a pipe, the
22010 separate outputs from the different addresses are gathered up and returned to
22011 the sender in a single message, whereas if &(autoreply)& is used, a separate
22012 message is generated for each address that is passed to it.
22013
22014 Non-printing characters are not permitted in the header lines generated for the
22015 message that &(autoreply)& creates, with the exception of newlines that are
22016 immediately followed by white space. If any non-printing characters are found,
22017 the transport defers.
22018 Whether characters with the top bit set count as printing characters or not is
22019 controlled by the &%print_topbitchars%& global option.
22020
22021 If any of the generic options for manipulating headers (for example,
22022 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22023 of the original message that is included in the generated message when
22024 &%return_message%& is set. They do not apply to the generated message itself.
22025
22026 .vindex "&$sender_address$&"
22027 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22028 the message, indicating that there were no recipients, it does not treat this
22029 as an error. This means that autoreplies sent to &$sender_address$& when this
22030 is empty (because the incoming message is a bounce message) do not cause
22031 problems. They are just discarded.
22032
22033
22034
22035 .section "Private options for autoreply" "SECID139"
22036 .cindex "options" "&(autoreply)& transport"
22037
22038 .option bcc autoreply string&!! unset
22039 This specifies the addresses that are to receive &"blind carbon copies"& of the
22040 message when the message is specified by the transport.
22041
22042
22043 .option cc autoreply string&!! unset
22044 This specifies recipients of the message and the contents of the &'Cc:'& header
22045 when the message is specified by the transport.
22046
22047
22048 .option file autoreply string&!! unset
22049 The contents of the file are sent as the body of the message when the message
22050 is specified by the transport. If both &%file%& and &%text%& are set, the text
22051 string comes first.
22052
22053
22054 .option file_expand autoreply boolean false
22055 If this is set, the contents of the file named by the &%file%& option are
22056 subjected to string expansion as they are added to the message.
22057
22058
22059 .option file_optional autoreply boolean false
22060 If this option is true, no error is generated if the file named by the &%file%&
22061 option or passed with the address does not exist or cannot be read.
22062
22063
22064 .option from autoreply string&!! unset
22065 This specifies the contents of the &'From:'& header when the message is
22066 specified by the transport.
22067
22068
22069 .option headers autoreply string&!! unset
22070 This specifies additional RFC 2822 headers that are to be added to the message
22071 when the message is specified by the transport. Several can be given by using
22072 &"\n"& to separate them. There is no check on the format.
22073
22074
22075 .option log autoreply string&!! unset
22076 This option names a file in which a record of every message sent is logged when
22077 the message is specified by the transport.
22078
22079
22080 .option mode autoreply "octal integer" 0600
22081 If either the log file or the &"once"& file has to be created, this mode is
22082 used.
22083
22084
22085 .option never_mail autoreply "address list&!!" unset
22086 If any run of the transport creates a message with a recipient that matches any
22087 item in the list, that recipient is quietly discarded. If all recipients are
22088 discarded, no message is created. This applies both when the recipients are
22089 generated by a filter and when they are specified in the transport.
22090
22091
22092
22093 .option once autoreply string&!! unset
22094 This option names a file or DBM database in which a record of each &'To:'&
22095 recipient is kept when the message is specified by the transport. &*Note*&:
22096 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22097
22098 If &%once%& is unset, or is set to an empty string, the message is always sent.
22099 By default, if &%once%& is set to a non-empty file name, the message
22100 is not sent if a potential recipient is already listed in the database.
22101 However, if the &%once_repeat%& option specifies a time greater than zero, the
22102 message is sent if that much time has elapsed since a message was last sent to
22103 this recipient. A setting of zero time for &%once_repeat%& (the default)
22104 prevents a message from being sent a second time &-- in this case, zero means
22105 infinity.
22106
22107 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22108 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22109 greater than zero, it changes the way Exim implements the &%once%& option.
22110 Instead of using a DBM file to record every recipient it sends to, it uses a
22111 regular file, whose size will never get larger than the given value.
22112
22113 In the file, Exim keeps a linear list of recipient addresses and the times at
22114 which they were sent messages. If the file is full when a new address needs to
22115 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22116 means that a given recipient may receive multiple messages, but at
22117 unpredictable intervals that depend on the rate of turnover of addresses in the
22118 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22119
22120
22121 .option once_file_size autoreply integer 0
22122 See &%once%& above.
22123
22124
22125 .option once_repeat autoreply time&!! 0s
22126 See &%once%& above.
22127 After expansion, the value of this option must be a valid time value.
22128
22129
22130 .option reply_to autoreply string&!! unset
22131 This specifies the contents of the &'Reply-To:'& header when the message is
22132 specified by the transport.
22133
22134
22135 .option return_message autoreply boolean false
22136 If this is set, a copy of the original message is returned with the new
22137 message, subject to the maximum size set in the &%return_size_limit%& global
22138 configuration option.
22139
22140
22141 .option subject autoreply string&!! unset
22142 This specifies the contents of the &'Subject:'& header when the message is
22143 specified by the transport. It is tempting to quote the original subject in
22144 automatic responses. For example:
22145 .code
22146 subject = Re: $h_subject:
22147 .endd
22148 There is a danger in doing this, however. It may allow a third party to
22149 subscribe your users to an opt-in mailing list, provided that the list accepts
22150 bounce messages as subscription confirmations. Well-managed lists require a
22151 non-bounce message to confirm a subscription, so the danger is relatively
22152 small.
22153
22154
22155
22156 .option text autoreply string&!! unset
22157 This specifies a single string to be used as the body of the message when the
22158 message is specified by the transport. If both &%text%& and &%file%& are set,
22159 the text comes first.
22160
22161
22162 .option to autoreply string&!! unset
22163 This specifies recipients of the message and the contents of the &'To:'& header
22164 when the message is specified by the transport.
22165 .ecindex IIDauttra1
22166 .ecindex IIDauttra2
22167
22168
22169
22170
22171 . ////////////////////////////////////////////////////////////////////////////
22172 . ////////////////////////////////////////////////////////////////////////////
22173
22174 .chapter "The lmtp transport" "CHAPLMTP"
22175 .cindex "transports" "&(lmtp)&"
22176 .cindex "&(lmtp)& transport"
22177 .cindex "LMTP" "over a pipe"
22178 .cindex "LMTP" "over a socket"
22179 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22180 specified command
22181 or by interacting with a Unix domain socket.
22182 This transport is something of a cross between the &(pipe)& and &(smtp)&
22183 transports. Exim also has support for using LMTP over TCP/IP; this is
22184 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22185 to be of minority interest, the default build-time configure in &_src/EDITME_&
22186 has it commented out. You need to ensure that
22187 .code
22188 TRANSPORT_LMTP=yes
22189 .endd
22190 .cindex "options" "&(lmtp)& transport"
22191 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22192 included in the Exim binary. The private options of the &(lmtp)& transport are
22193 as follows:
22194
22195 .option batch_id lmtp string&!! unset
22196 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22197
22198
22199 .option batch_max lmtp integer 1
22200 This limits the number of addresses that can be handled in a single delivery.
22201 Most LMTP servers can handle several addresses at once, so it is normally a
22202 good idea to increase this value. See the description of local delivery
22203 batching in chapter &<<CHAPbatching>>&.
22204
22205
22206 .option command lmtp string&!! unset
22207 This option must be set if &%socket%& is not set. The string is a command which
22208 is run in a separate process. It is split up into a command name and list of
22209 arguments, each of which is separately expanded (so expansion cannot change the
22210 number of arguments). The command is run directly, not via a shell. The message
22211 is passed to the new process using the standard input and output to operate the
22212 LMTP protocol.
22213
22214 .option ignore_quota lmtp boolean false
22215 .cindex "LMTP" "ignoring quota errors"
22216 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22217 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22218 in its response to the LHLO command.
22219
22220 .option socket lmtp string&!! unset
22221 This option must be set if &%command%& is not set. The result of expansion must
22222 be the name of a Unix domain socket. The transport connects to the socket and
22223 delivers the message to it using the LMTP protocol.
22224
22225
22226 .option timeout lmtp time 5m
22227 The transport is aborted if the created process or Unix domain socket does not
22228 respond to LMTP commands or message input within this timeout. Delivery
22229 is deferred, and will be tried again later. Here is an example of a typical
22230 LMTP transport:
22231 .code
22232 lmtp:
22233   driver = lmtp
22234   command = /some/local/lmtp/delivery/program
22235   batch_max = 20
22236   user = exim
22237 .endd
22238 This delivers up to 20 addresses at a time, in a mixture of domains if
22239 necessary, running as the user &'exim'&.
22240
22241
22242
22243 . ////////////////////////////////////////////////////////////////////////////
22244 . ////////////////////////////////////////////////////////////////////////////
22245
22246 .chapter "The pipe transport" "CHAPpipetransport"
22247 .scindex IIDpiptra1 "transports" "&(pipe)&"
22248 .scindex IIDpiptra2 "&(pipe)& transport"
22249 The &(pipe)& transport is used to deliver messages via a pipe to a command
22250 running in another process. One example is the use of &(pipe)& as a
22251 pseudo-remote transport for passing messages to some other delivery mechanism
22252 (such as UUCP). Another is the use by individual users to automatically process
22253 their incoming messages. The &(pipe)& transport can be used in one of the
22254 following ways:
22255
22256 .ilist
22257 .vindex "&$local_part$&"
22258 A router routes one address to a transport in the normal way, and the
22259 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22260 contains the local part of the address (as usual), and the command that is run
22261 is specified by the &%command%& option on the transport.
22262 .next
22263 .vindex "&$pipe_addresses$&"
22264 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22265 transport can handle more than one address in a single run. In this case, when
22266 more than one address is routed to the transport, &$local_part$& is not set
22267 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22268 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22269 that are routed to the transport.
22270 .next
22271 .vindex "&$address_pipe$&"
22272 A router redirects an address directly to a pipe command (for example, from an
22273 alias or forward file). In this case, &$address_pipe$& contains the text of the
22274 pipe command, and the &%command%& option on the transport is ignored unless
22275 &%force_command%& is set. If only one address is being transported
22276 (&%batch_max%& is not greater than one, or only one address was redirected to
22277 this pipe command), &$local_part$& contains the local part that was redirected.
22278 .endlist
22279
22280
22281 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22282 deliver messages over pipes using the LMTP interactive protocol. This is
22283 implemented by the &(lmtp)& transport.
22284
22285 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22286 &_.forward_& file, the command runs under the uid and gid of that user. In
22287 other cases, the uid and gid have to be specified explicitly, either on the
22288 transport or on the router that handles the address. Current and &"home"&
22289 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22290 details of the local delivery environment and chapter &<<CHAPbatching>>&
22291 for a discussion of local delivery batching.
22292
22293
22294 .section "Concurrent delivery" "SECID140"
22295 If two messages arrive at almost the same time, and both are routed to a pipe
22296 delivery, the two pipe transports may be run concurrently. You must ensure that
22297 any pipe commands you set up are robust against this happening. If the commands
22298 write to a file, the &%exim_lock%& utility might be of use.
22299
22300
22301
22302
22303 .section "Returned status and data" "SECID141"
22304 .cindex "&(pipe)& transport" "returned data"
22305 If the command exits with a non-zero return code, the delivery is deemed to
22306 have failed, unless either the &%ignore_status%& option is set (in which case
22307 the return code is treated as zero), or the return code is one of those listed
22308 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22309 later"&. In this case, delivery is deferred. Details of a permanent failure are
22310 logged, but are not included in the bounce message, which merely contains
22311 &"local delivery failed"&.
22312
22313 If the command exits on a signal and the &%freeze_signal%& option is set then
22314 the message will be frozen in the queue. If that option is not set, a bounce
22315 will be sent as normal.
22316
22317 If the return code is greater than 128 and the command being run is a shell
22318 script, it normally means that the script was terminated by a signal whose
22319 value is the return code minus 128. The &%freeze_signal%& option does not
22320 apply in this case.
22321
22322 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22323 return code is set to 127. This is the value that a shell returns if it is
22324 asked to run a non-existent command. The wording for the log line suggests that
22325 a non-existent command may be the problem.
22326
22327 The &%return_output%& option can affect the result of a pipe delivery. If it is
22328 set and the command produces any output on its standard output or standard
22329 error streams, the command is considered to have failed, even if it gave a zero
22330 return code or if &%ignore_status%& is set. The output from the command is
22331 included as part of the bounce message. The &%return_fail_output%& option is
22332 similar, except that output is returned only when the command exits with a
22333 failure return code, that is, a value other than zero or a code that matches
22334 &%temp_errors%&.
22335
22336
22337
22338 .section "How the command is run" "SECThowcommandrun"
22339 .cindex "&(pipe)& transport" "path for command"
22340 The command line is (by default) broken down into a command name and arguments
22341 by the &(pipe)& transport itself. The &%allow_commands%& and
22342 &%restrict_to_path%& options can be used to restrict the commands that may be
22343 run.
22344
22345 .cindex "quoting" "in pipe command"
22346 Unquoted arguments are delimited by white space. If an argument appears in
22347 double quotes, backslash is interpreted as an escape character in the usual
22348 way. If an argument appears in single quotes, no escaping is done.
22349
22350 String expansion is applied to the command line except when it comes from a
22351 traditional &_.forward_& file (commands from a filter file are expanded). The
22352 expansion is applied to each argument in turn rather than to the whole line.
22353 For this reason, any string expansion item that contains white space must be
22354 quoted so as to be contained within a single argument. A setting such as
22355 .code
22356 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22357 .endd
22358 will not work, because the expansion item gets split between several
22359 arguments. You have to write
22360 .code
22361 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22362 .endd
22363 to ensure that it is all in one argument. The expansion is done in this way,
22364 argument by argument, so that the number of arguments cannot be changed as a
22365 result of expansion, and quotes or backslashes in inserted variables do not
22366 interact with external quoting. However, this leads to problems if you want to
22367 generate multiple arguments (or the command name plus arguments) from a single
22368 expansion. In this situation, the simplest solution is to use a shell. For
22369 example:
22370 .code
22371 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22372 .endd
22373
22374 .cindex "transport" "filter"
22375 .cindex "filter" "transport filter"
22376 .vindex "&$pipe_addresses$&"
22377 Special handling takes place when an argument consists of precisely the text
22378 &`$pipe_addresses`&. This is not a general expansion variable; the only
22379 place this string is recognized is when it appears as an argument for a pipe or
22380 transport filter command. It causes each address that is being handled to be
22381 inserted in the argument list at that point &'as a separate argument'&. This
22382 avoids any problems with spaces or shell metacharacters, and is of use when a
22383 &(pipe)& transport is handling groups of addresses in a batch.
22384
22385 If &%force_command%& is enabled on the transport, Special handling takes place
22386 for an argument that consists of precisely the text &`$address_pipe`&.  It
22387 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22388 argument is inserted in the argument list at that point
22389 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22390 the only item in the argument; in fact, if it were then &%force_command%&
22391 should behave as a no-op.  Rather, it should be used to adjust the command
22392 run while preserving the argument vector separation.
22393
22394 After splitting up into arguments and expansion, the resulting command is run
22395 in a subprocess directly from the transport, &'not'& under a shell. The
22396 message that is being delivered is supplied on the standard input, and the
22397 standard output and standard error are both connected to a single pipe that is
22398 read by Exim. The &%max_output%& option controls how much output the command
22399 may produce, and the &%return_output%& and &%return_fail_output%& options
22400 control what is done with it.
22401
22402 Not running the command under a shell (by default) lessens the security risks
22403 in cases when a command from a user's filter file is built out of data that was
22404 taken from an incoming message. If a shell is required, it can of course be
22405 explicitly specified as the command to be run. However, there are circumstances
22406 where existing commands (for example, in &_.forward_& files) expect to be run
22407 under a shell and cannot easily be modified. To allow for these cases, there is
22408 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22409 works. Instead of breaking up the command line as just described, it expands it
22410 as a single string and passes the result to &_/bin/sh_&. The
22411 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22412 with &%use_shell%&, and the whole mechanism is inherently less secure.
22413
22414
22415
22416 .section "Environment variables" "SECTpipeenv"
22417 .cindex "&(pipe)& transport" "environment for command"
22418 .cindex "environment for pipe transport"
22419 The environment variables listed below are set up when the command is invoked.
22420 This list is a compromise for maximum compatibility with other MTAs. Note that
22421 the &%environment%& option can be used to add additional variables to this
22422 environment.
22423 .display
22424 &`DOMAIN            `&   the domain of the address
22425 &`HOME              `&   the home directory, if set
22426 &`HOST              `&   the host name when called from a router (see below)
22427 &`LOCAL_PART        `&   see below
22428 &`LOCAL_PART_PREFIX `&   see below
22429 &`LOCAL_PART_SUFFIX `&   see below
22430 &`LOGNAME           `&   see below
22431 &`MESSAGE_ID        `&   Exim's local ID for the message
22432 &`PATH              `&   as specified by the &%path%& option below
22433 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22434 &`RECIPIENT         `&   the complete recipient address
22435 &`SENDER            `&   the sender of the message (empty if a bounce)
22436 &`SHELL             `&   &`/bin/sh`&
22437 &`TZ                `&   the value of the &%timezone%& option, if set
22438 &`USER              `&   see below
22439 .endd
22440 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22441 router, LOCAL_PART is set to the local part of the address. When it is
22442 called as a result of a forward or alias expansion, LOCAL_PART is set to
22443 the local part of the address that was expanded. In both cases, any affixes are
22444 removed from the local part, and made available in LOCAL_PART_PREFIX and
22445 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22446 same value as LOCAL_PART for compatibility with other MTAs.
22447
22448 .cindex "HOST"
22449 HOST is set only when a &(pipe)& transport is called from a router that
22450 associates hosts with an address, typically when using &(pipe)& as a
22451 pseudo-remote transport. HOST is set to the first host name specified by
22452 the router.
22453
22454 .cindex "HOME"
22455 If the transport's generic &%home_directory%& option is set, its value is used
22456 for the HOME environment variable. Otherwise, a home directory may be set
22457 by the router's &%transport_home_directory%& option, which defaults to the
22458 user's home directory if &%check_local_user%& is set.
22459
22460
22461 .section "Private options for pipe" "SECID142"
22462 .cindex "options" "&(pipe)& transport"
22463
22464
22465
22466 .option allow_commands pipe "string list&!!" unset
22467 .cindex "&(pipe)& transport" "permitted commands"
22468 The string is expanded, and is then interpreted as a colon-separated list of
22469 permitted commands. If &%restrict_to_path%& is not set, the only commands
22470 permitted are those in the &%allow_commands%& list. They need not be absolute
22471 paths; the &%path%& option is still used for relative paths. If
22472 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22473 in the &%allow_commands%& list, or a name without any slashes that is found on
22474 the path. In other words, if neither &%allow_commands%& nor
22475 &%restrict_to_path%& is set, there is no restriction on the command, but
22476 otherwise only commands that are permitted by one or the other are allowed. For
22477 example, if
22478 .code
22479 allow_commands = /usr/bin/vacation
22480 .endd
22481 and &%restrict_to_path%& is not set, the only permitted command is
22482 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22483 &%use_shell%& is set.
22484
22485
22486 .option batch_id pipe string&!! unset
22487 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22488
22489
22490 .option batch_max pipe integer 1
22491 This limits the number of addresses that can be handled in a single delivery.
22492 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22493
22494
22495 .option check_string pipe string unset
22496 As &(pipe)& writes the message, the start of each line is tested for matching
22497 &%check_string%&, and if it does, the initial matching characters are replaced
22498 by the contents of &%escape_string%&, provided both are set. The value of
22499 &%check_string%& is a literal string, not a regular expression, and the case of
22500 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22501 of &%check_string%& and &%escape_string%& are forced to values that implement
22502 the SMTP escaping protocol. Any settings made in the configuration file are
22503 ignored.
22504
22505
22506 .option command pipe string&!! unset
22507 This option need not be set when &(pipe)& is being used to deliver to pipes
22508 obtained directly from address redirections. In other cases, the option must be
22509 set, to provide a command to be run. It need not yield an absolute path (see
22510 the &%path%& option below). The command is split up into separate arguments by
22511 Exim, and each argument is separately expanded, as described in section
22512 &<<SECThowcommandrun>>& above.
22513
22514
22515 .option environment pipe string&!! unset
22516 .cindex "&(pipe)& transport" "environment for command"
22517 .cindex "environment for &(pipe)& transport"
22518 This option is used to add additional variables to the environment in which the
22519 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22520 a string which is expanded, and then interpreted as a colon-separated list of
22521 environment settings of the form <&'name'&>=<&'value'&>.
22522
22523
22524 .option escape_string pipe string unset
22525 See &%check_string%& above.
22526
22527
22528 .option freeze_exec_fail pipe boolean false
22529 .cindex "exec failure"
22530 .cindex "failure of exec"
22531 .cindex "&(pipe)& transport" "failure of exec"
22532 Failure to exec the command in a pipe transport is by default treated like
22533 any other failure while running the command. However, if &%freeze_exec_fail%&
22534 is set, failure to exec is treated specially, and causes the message to be
22535 frozen, whatever the setting of &%ignore_status%&.
22536
22537
22538 .option freeze_signal pipe boolean false
22539 .cindex "signal exit"
22540 .cindex "&(pipe)& transport", "signal exit"
22541 Normally if the process run by a command in a pipe transport exits on a signal,
22542 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22543 frozen in Exim's queue instead.
22544
22545
22546 .option force_command pipe boolean false
22547 .cindex "force command"
22548 .cindex "&(pipe)& transport", "force command"
22549 Normally when a router redirects an address directly to a pipe command
22550 the &%command%& option on the transport is ignored.  If &%force_command%&
22551 is set, the &%command%& option will used. This is especially
22552 useful for forcing a wrapper or additional argument to be added to the
22553 command. For example:
22554 .code
22555 command = /usr/bin/remote_exec myhost -- $address_pipe
22556 force_command
22557 .endd
22558
22559 Note that &$address_pipe$& is handled specially in &%command%& when
22560 &%force_command%& is set, expanding out to the original argument vector as
22561 separate items, similarly to a Unix shell &`"$@"`& construct.
22562
22563 .option ignore_status pipe boolean false
22564 If this option is true, the status returned by the subprocess that is set up to
22565 run the command is ignored, and Exim behaves as if zero had been returned.
22566 Otherwise, a non-zero status or termination by signal causes an error return
22567 from the transport unless the status value is one of those listed in
22568 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22569
22570 &*Note*&: This option does not apply to timeouts, which do not return a status.
22571 See the &%timeout_defer%& option for how timeouts are handled.
22572
22573 .option log_defer_output pipe boolean false
22574 .cindex "&(pipe)& transport" "logging output"
22575 If this option is set, and the status returned by the command is
22576 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22577 and any output was produced, the first line of it is written to the main log.
22578
22579
22580 .option log_fail_output pipe boolean false
22581 If this option is set, and the command returns any output, and also ends with a
22582 return code that is neither zero nor one of the return codes listed in
22583 &%temp_errors%& (that is, the delivery failed), the first line of output is
22584 written to the main log. This option and &%log_output%& are mutually exclusive.
22585 Only one of them may be set.
22586
22587
22588
22589 .option log_output pipe boolean false
22590 If this option is set and the command returns any output, the first line of
22591 output is written to the main log, whatever the return code. This option and
22592 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22593
22594
22595
22596 .option max_output pipe integer 20K
22597 This specifies the maximum amount of output that the command may produce on its
22598 standard output and standard error file combined. If the limit is exceeded, the
22599 process running the command is killed. This is intended as a safety measure to
22600 catch runaway processes. The limit is applied independently of the settings of
22601 the options that control what is done with such output (for example,
22602 &%return_output%&). Because of buffering effects, the amount of output may
22603 exceed the limit by a small amount before Exim notices.
22604
22605
22606 .option message_prefix pipe string&!! "see below"
22607 The string specified here is expanded and output at the start of every message.
22608 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22609 .code
22610 message_prefix = \
22611   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22612   ${tod_bsdinbox}\n
22613 .endd
22614 .cindex "Cyrus"
22615 .cindex "&%tmail%&"
22616 .cindex "&""From""& line"
22617 This is required by the commonly used &_/usr/bin/vacation_& program.
22618 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22619 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22620 setting
22621 .code
22622 message_prefix =
22623 .endd
22624 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22625 &`\n`& to &`\r\n`& in &%message_prefix%&.
22626
22627
22628 .option message_suffix pipe string&!! "see below"
22629 The string specified here is expanded and output at the end of every message.
22630 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22631 The suffix can be suppressed by setting
22632 .code
22633 message_suffix =
22634 .endd
22635 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22636 &`\n`& to &`\r\n`& in &%message_suffix%&.
22637
22638
22639 .option path pipe string "see below"
22640 This option specifies the string that is set up in the PATH environment
22641 variable of the subprocess. The default is:
22642 .code
22643 /bin:/usr/bin
22644 .endd
22645 If the &%command%& option does not yield an absolute path name, the command is
22646 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22647 apply to a command specified as a transport filter.
22648
22649
22650 .option permit_coredump pipe boolean false
22651 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22652 a core-dump of a pipe command, enable this command.  This enables core-dumps
22653 during delivery and affects both the Exim binary and the pipe command run.
22654 It is recommended that this option remain off unless and until you have a need
22655 for it and that this only be enabled when needed, as the risk of excessive
22656 resource consumption can be quite high.  Note also that Exim is typically
22657 installed as a setuid binary and most operating systems will inhibit coredumps
22658 of these by default, so further OS-specific action may be required.
22659
22660
22661 .option pipe_as_creator pipe boolean false
22662 .cindex "uid (user id)" "local delivery"
22663 If the generic &%user%& option is not set and this option is true, the delivery
22664 process is run under the uid that was in force when Exim was originally called
22665 to accept the message. If the group id is not otherwise set (via the generic
22666 &%group%& option), the gid that was in force when Exim was originally called to
22667 accept the message is used.
22668
22669
22670 .option restrict_to_path pipe boolean false
22671 When this option is set, any command name not listed in &%allow_commands%& must
22672 contain no slashes. The command is searched for only in the directories listed
22673 in the &%path%& option. This option is intended for use in the case when a pipe
22674 command has been generated from a user's &_.forward_& file. This is usually
22675 handled by a &(pipe)& transport called &%address_pipe%&.
22676
22677
22678 .option return_fail_output pipe boolean false
22679 If this option is true, and the command produced any output and ended with a
22680 return code other than zero or one of the codes listed in &%temp_errors%& (that
22681 is, the delivery failed), the output is returned in the bounce message.
22682 However, if the message has a null sender (that is, it is itself a bounce
22683 message), output from the command is discarded. This option and
22684 &%return_output%& are mutually exclusive. Only one of them may be set.
22685
22686
22687
22688 .option return_output pipe boolean false
22689 If this option is true, and the command produced any output, the delivery is
22690 deemed to have failed whatever the return code from the command, and the output
22691 is returned in the bounce message. Otherwise, the output is just discarded.
22692 However, if the message has a null sender (that is, it is a bounce message),
22693 output from the command is always discarded, whatever the setting of this
22694 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22695 of them may be set.
22696
22697
22698
22699 .option temp_errors pipe "string list" "see below"
22700 .cindex "&(pipe)& transport" "temporary failure"
22701 This option contains either a colon-separated list of numbers, or a single
22702 asterisk. If &%ignore_status%& is false
22703 and &%return_output%& is not set,
22704 and the command exits with a non-zero return code, the failure is treated as
22705 temporary and the delivery is deferred if the return code matches one of the
22706 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22707 codes are treated as permanent errors. The default setting contains the codes
22708 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22709 compiled on a system that does not define these macros, it assumes values of 75
22710 and 73, respectively.
22711
22712
22713 .option timeout pipe time 1h
22714 If the command fails to complete within this time, it is killed. This normally
22715 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22716 specifies no timeout. In order to ensure that any subprocesses created by the
22717 command are also killed, Exim makes the initial process a process group leader,
22718 and kills the whole process group on a timeout. However, this can be defeated
22719 if one of the processes starts a new process group.
22720
22721 .option timeout_defer pipe boolean false
22722 A timeout in a &(pipe)& transport, either in the command that the transport
22723 runs, or in a transport filter that is associated with it, is by default
22724 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22725 is set true, both kinds of timeout become temporary errors, causing the
22726 delivery to be deferred.
22727
22728 .option umask pipe "octal integer" 022
22729 This specifies the umask setting for the subprocess that runs the command.
22730
22731
22732 .option use_bsmtp pipe boolean false
22733 .cindex "envelope sender"
22734 If this option is set true, the &(pipe)& transport writes messages in &"batch
22735 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22736 commands. If you want to include a leading HELO command with such messages,
22737 you can do so by setting the &%message_prefix%& option. See section
22738 &<<SECTbatchSMTP>>& for details of batch SMTP.
22739
22740 .option use_classresources pipe boolean false
22741 .cindex "class resources (BSD)"
22742 This option is available only when Exim is running on FreeBSD, NetBSD, or
22743 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22744 resource limits when a &(pipe)& transport is run to perform a delivery. The
22745 limits for the uid under which the pipe is to run are obtained from the login
22746 class database.
22747
22748
22749 .option use_crlf pipe boolean false
22750 .cindex "carriage return"
22751 .cindex "linefeed"
22752 This option causes lines to be terminated with the two-character CRLF sequence
22753 (carriage return, linefeed) instead of just a linefeed character. In the case
22754 of batched SMTP, the byte sequence written to the pipe is then an exact image
22755 of what would be sent down a real SMTP connection.
22756
22757 The contents of the &%message_prefix%& and &%message_suffix%& options are
22758 written verbatim, so must contain their own carriage return characters if these
22759 are needed. When &%use_bsmtp%& is not set, the default values for both
22760 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22761 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22762
22763
22764 .option use_shell pipe boolean false
22765 .vindex "&$pipe_addresses$&"
22766 If this option is set, it causes the command to be passed to &_/bin/sh_&
22767 instead of being run directly from the transport, as described in section
22768 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22769 where the command is expected to be run under a shell and cannot easily be
22770 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22771 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22772 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22773 its &%-c%& option.
22774
22775
22776
22777 .section "Using an external local delivery agent" "SECID143"
22778 .cindex "local delivery" "using an external agent"
22779 .cindex "&'procmail'&"
22780 .cindex "external local delivery"
22781 .cindex "delivery" "&'procmail'&"
22782 .cindex "delivery" "by external agent"
22783 The &(pipe)& transport can be used to pass all messages that require local
22784 delivery to a separate local delivery agent such as &%procmail%&. When doing
22785 this, care must be taken to ensure that the pipe is run under an appropriate
22786 uid and gid. In some configurations one wants this to be a uid that is trusted
22787 by the delivery agent to supply the correct sender of the message. It may be
22788 necessary to recompile or reconfigure the delivery agent so that it trusts an
22789 appropriate user. The following is an example transport and router
22790 configuration for &%procmail%&:
22791 .code
22792 # transport
22793 procmail_pipe:
22794   driver = pipe
22795   command = /usr/local/bin/procmail -d $local_part
22796   return_path_add
22797   delivery_date_add
22798   envelope_to_add
22799   check_string = "From "
22800   escape_string = ">From "
22801   umask = 077
22802   user = $local_part
22803   group = mail
22804
22805 # router
22806 procmail:
22807   driver = accept
22808   check_local_user
22809   transport = procmail_pipe
22810 .endd
22811 In this example, the pipe is run as the local user, but with the group set to
22812 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22813 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22814 user to supply a correct sender address. If you do not specify either a
22815 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22816 home directory is the user's home directory by default.
22817
22818 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22819 .code
22820 IFS=" "
22821 .endd
22822 as shown in some &%procmail%& documentation, because Exim does not by default
22823 use a shell to run pipe commands.
22824
22825 .cindex "Cyrus"
22826 The next example shows a transport and a router for a system where local
22827 deliveries are handled by the Cyrus IMAP server.
22828 .code
22829 # transport
22830 local_delivery_cyrus:
22831   driver = pipe
22832   command = /usr/cyrus/bin/deliver \
22833             -m ${substr_1:$local_part_suffix} -- $local_part
22834   user = cyrus
22835   group = mail
22836   return_output
22837   log_output
22838   message_prefix =
22839   message_suffix =
22840
22841 # router
22842 local_user_cyrus:
22843   driver = accept
22844   check_local_user
22845   local_part_suffix = .*
22846   transport = local_delivery_cyrus
22847 .endd
22848 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22849 &%return_output%& to cause any text written by Cyrus to be returned to the
22850 sender.
22851 .ecindex IIDpiptra1
22852 .ecindex IIDpiptra2
22853
22854
22855 . ////////////////////////////////////////////////////////////////////////////
22856 . ////////////////////////////////////////////////////////////////////////////
22857
22858 .chapter "The smtp transport" "CHAPsmtptrans"
22859 .scindex IIDsmttra1 "transports" "&(smtp)&"
22860 .scindex IIDsmttra2 "&(smtp)& transport"
22861 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22862 or LMTP protocol. The list of hosts to try can either be taken from the address
22863 that is being processed (having been set up by the router), or specified
22864 explicitly for the transport. Timeout and retry processing (see chapter
22865 &<<CHAPretry>>&) is applied to each IP address independently.
22866
22867
22868 .section "Multiple messages on a single connection" "SECID144"
22869 The sending of multiple messages over a single TCP/IP connection can arise in
22870 two ways:
22871
22872 .ilist
22873 If a message contains more than &%max_rcpt%& (see below) addresses that are
22874 routed to the same host, more than one copy of the message has to be sent to
22875 that host. In this situation, multiple copies may be sent in a single run of
22876 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22877 does when it has too many addresses to send in one message also depends on the
22878 value of the global &%remote_max_parallel%& option. Details are given in
22879 section &<<SECToutSMTPTCP>>&.)
22880 .next
22881 .cindex "hints database" "remembering routing"
22882 When a message has been successfully delivered over a TCP/IP connection, Exim
22883 looks in its hints database to see if there are any other messages awaiting a
22884 connection to the same host. If there are, a new delivery process is started
22885 for one of them, and the current TCP/IP connection is passed on to it. The new
22886 process may in turn send multiple copies and possibly create yet another
22887 process.
22888 .endlist
22889
22890
22891 For each copy sent over the same TCP/IP connection, a sequence counter is
22892 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22893 no further messages are sent over that connection.
22894
22895
22896
22897 .section "Use of the $host and $host_address variables" "SECID145"
22898 .vindex "&$host$&"
22899 .vindex "&$host_address$&"
22900 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22901 &$host_address$& are the name and IP address of the first host on the host list
22902 passed by the router. However, when the transport is about to connect to a
22903 specific host, and while it is connected to that host, &$host$& and
22904 &$host_address$& are set to the values for that host. These are the values
22905 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22906 &%serialize_hosts%&, and the various TLS options are expanded.
22907
22908
22909 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22910 .vindex &$tls_bits$&
22911 .vindex &$tls_cipher$&
22912 .vindex &$tls_peerdn$&
22913 .vindex &$tls_sni$&
22914 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22915 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22916 are the values that were set when the message was received.
22917 These are the values that are used for options that are expanded before any
22918 SMTP connections are made. Just before each connection is made, these four
22919 variables are emptied. If TLS is subsequently started, they are set to the
22920 appropriate values for the outgoing connection, and these are the values that
22921 are in force when any authenticators are run and when the
22922 &%authenticated_sender%& option is expanded.
22923
22924 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22925 and will be removed in a future release.
22926
22927
22928 .section "Private options for smtp" "SECID146"
22929 .cindex "options" "&(smtp)& transport"
22930 The private options of the &(smtp)& transport are as follows:
22931
22932
22933 .option address_retry_include_sender smtp boolean true
22934 .cindex "4&'xx'& responses" "retrying after"
22935 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22936 is the combination of sender and recipient that is delayed in subsequent queue
22937 runs until the retry time is reached. You can delay the recipient without
22938 reference to the sender (which is what earlier versions of Exim did), by
22939 setting &%address_retry_include_sender%& false. However, this can lead to
22940 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22941
22942 .option allow_localhost smtp boolean false
22943 .cindex "local host" "sending to"
22944 .cindex "fallback" "hosts specified on transport"
22945 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22946 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22947 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22948 the delivery anyway. This should be used only in special cases when the
22949 configuration ensures that no looping will result (for example, a differently
22950 configured Exim is listening on the port to which the message is sent).
22951
22952
22953 .option authenticated_sender smtp string&!! unset
22954 .cindex "Cyrus"
22955 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22956 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22957 overriding any existing authenticated sender value. If the string expansion is
22958 forced to fail, the option is ignored. Other expansion failures cause delivery
22959 to be deferred. If the result of expansion is an empty string, that is also
22960 ignored.
22961
22962 The expansion happens after the outgoing connection has been made and TLS
22963 started, if required. This means that the &$host$&, &$host_address$&,
22964 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22965 particular connection.
22966
22967 If the SMTP session is not authenticated, the expansion of
22968 &%authenticated_sender%& still happens (and can cause the delivery to be
22969 deferred if it fails), but no AUTH= item is added to MAIL commands
22970 unless &%authenticated_sender_force%& is true.
22971
22972 This option allows you to use the &(smtp)& transport in LMTP mode to
22973 deliver mail to Cyrus IMAP and provide the proper local part as the
22974 &"authenticated sender"&, via a setting such as:
22975 .code
22976 authenticated_sender = $local_part
22977 .endd
22978 This removes the need for IMAP subfolders to be assigned special ACLs to
22979 allow direct delivery to those subfolders.
22980
22981 Because of expected uses such as that just described for Cyrus (when no
22982 domain is involved), there is no checking on the syntax of the provided
22983 value.
22984
22985
22986 .option authenticated_sender_force smtp boolean false
22987 If this option is set true, the &%authenticated_sender%& option's value
22988 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22989 authenticated as a client.
22990
22991
22992 .option command_timeout smtp time 5m
22993 This sets a timeout for receiving a response to an SMTP command that has been
22994 sent out. It is also used when waiting for the initial banner line from the
22995 remote host. Its value must not be zero.
22996
22997
22998 .option connect_timeout smtp time 5m
22999 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23000 to a remote host. A setting of zero allows the system timeout (typically
23001 several minutes) to act. To have any effect, the value of this option must be
23002 less than the system timeout. However, it has been observed that on some
23003 systems there is no system timeout, which is why the default value for this
23004 option is 5 minutes, a value recommended by RFC 1123.
23005
23006
23007 .option connection_max_messages smtp integer 500
23008 .cindex "SMTP" "passed connection"
23009 .cindex "SMTP" "multiple deliveries"
23010 .cindex "multiple SMTP deliveries"
23011 This controls the maximum number of separate message deliveries that are sent
23012 over a single TCP/IP connection. If the value is zero, there is no limit.
23013 For testing purposes, this value can be overridden by the &%-oB%& command line
23014 option.
23015
23016
23017 .option data_timeout smtp time 5m
23018 This sets a timeout for the transmission of each block in the data portion of
23019 the message. As a result, the overall timeout for a message depends on the size
23020 of the message. Its value must not be zero. See also &%final_timeout%&.
23021
23022
23023 .option delay_after_cutoff smtp boolean true
23024 This option controls what happens when all remote IP addresses for a given
23025 domain have been inaccessible for so long that they have passed their retry
23026 cutoff times.
23027
23028 In the default state, if the next retry time has not been reached for any of
23029 them, the address is bounced without trying any deliveries. In other words,
23030 Exim delays retrying an IP address after the final cutoff time until a new
23031 retry time is reached, and can therefore bounce an address without ever trying
23032 a delivery, when machines have been down for a long time. Some people are
23033 unhappy at this prospect, so...
23034
23035 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23036 addresses are past their final cutoff time, Exim tries to deliver to those
23037 IP addresses that have not been tried since the message arrived. If there are
23038 none, of if they all fail, the address is bounced. In other words, it does not
23039 delay when a new message arrives, but immediately tries those expired IP
23040 addresses that haven't been tried since the message arrived. If there is a
23041 continuous stream of messages for the dead hosts, unsetting
23042 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23043 to them.
23044
23045
23046 .option dns_qualify_single smtp boolean true
23047 If the &%hosts%& or &%fallback_hosts%& option is being used,
23048 and the &%gethostbyname%& option is false,
23049 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23050 in chapter &<<CHAPdnslookup>>& for more details.
23051
23052
23053 .option dns_search_parents smtp boolean false
23054 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23055 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23056 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23057 details.
23058
23059
23060 .option dnssec_request_domains smtp "domain list&!!" unset
23061 .cindex "MX record" "security"
23062 .cindex "DNSSEC" "MX lookup"
23063 .cindex "security" "MX lookup"
23064 .cindex "DNS" "DNSSEC"
23065 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23066 the dnssec request bit set.
23067 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23068
23069
23070
23071 .option dnssec_require_domains smtp "domain list&!!" unset
23072 .cindex "MX record" "security"
23073 .cindex "DNSSEC" "MX lookup"
23074 .cindex "security" "MX lookup"
23075 .cindex "DNS" "DNSSEC"
23076 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23077 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23078 (AD bit) set wil be ignored and logged as a host-lookup failure.
23079 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23080
23081
23082
23083 .option dscp smtp string&!! unset
23084 .cindex "DCSP" "outbound"
23085 This option causes the DSCP value associated with a socket to be set to one
23086 of a number of fixed strings or to numeric value.
23087 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23088 Common values include &`throughput`&, &`mincost`&, and on newer systems
23089 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23090
23091 The outbound packets from Exim will be marked with this value in the header
23092 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23093 that these values will have any effect, not be stripped by networking
23094 equipment, or do much of anything without cooperation with your Network
23095 Engineer and those of all network operators between the source and destination.
23096
23097
23098 .option fallback_hosts smtp "string list" unset
23099 .cindex "fallback" "hosts specified on transport"
23100 String expansion is not applied to this option. The argument must be a
23101 colon-separated list of host names or IP addresses, optionally also including
23102 port numbers, though the separator can be changed, as described in section
23103 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23104 item in a &%route_list%& setting for the &(manualroute)& router, as described
23105 in section &<<SECTformatonehostitem>>&.
23106
23107 Fallback hosts can also be specified on routers, which associate them with the
23108 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23109 &%fallback_hosts%& specified on the transport is used only if the address does
23110 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23111 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23112 However, &%hosts_randomize%& does apply to fallback host lists.
23113
23114 If Exim is unable to deliver to any of the hosts for a particular address, and
23115 the errors are not permanent rejections, the address is put on a separate
23116 transport queue with its host list replaced by the fallback hosts, unless the
23117 address was routed via MX records and the current host was in the original MX
23118 list. In that situation, the fallback host list is not used.
23119
23120 Once normal deliveries are complete, the fallback queue is delivered by
23121 re-running the same transports with the new host lists. If several failing
23122 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23123 copy of the message is sent.
23124
23125 The resolution of the host names on the fallback list is controlled by the
23126 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23127 both to cases when the host list comes with the address and when it is taken
23128 from &%hosts%&. This option provides a &"use a smart host only if delivery
23129 fails"& facility.
23130
23131
23132 .option final_timeout smtp time 10m
23133 This is the timeout that applies while waiting for the response to the final
23134 line containing just &"."& that terminates a message. Its value must not be
23135 zero.
23136
23137 .option gethostbyname smtp boolean false
23138 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23139 being used, names are looked up using &[gethostbyname()]&
23140 (or &[getipnodebyname()]& when available)
23141 instead of using the DNS. Of course, that function may in fact use the DNS, but
23142 it may also consult other sources of information such as &_/etc/hosts_&.
23143
23144 .option gnutls_compat_mode smtp boolean unset
23145 This option controls whether GnuTLS is used in compatibility mode in an Exim
23146 server. This reduces security slightly, but improves interworking with older
23147 implementations of TLS.
23148
23149 .option helo_data smtp string&!! "see below"
23150 .cindex "HELO" "argument, setting"
23151 .cindex "EHLO" "argument, setting"
23152 .cindex "LHLO argument setting"
23153 The value of this option is expanded after a connection to a another host has
23154 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23155 command that starts the outgoing SMTP or LMTP session. The default value of the
23156 option is:
23157 .code
23158 $primary_hostname
23159 .endd
23160 During the expansion, the variables &$host$& and &$host_address$& are set to
23161 the identity of the remote host, and the variables &$sending_ip_address$& and
23162 &$sending_port$& are set to the local IP address and port number that are being
23163 used. These variables can be used to generate different values for different
23164 servers or different local IP addresses. For example, if you want the string
23165 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23166 interface address, you could use this:
23167 .code
23168 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23169   {$primary_hostname}}
23170 .endd
23171 The use of &%helo_data%& applies both to sending messages and when doing
23172 callouts.
23173
23174 .option hosts smtp "string list&!!" unset
23175 Hosts are associated with an address by a router such as &(dnslookup)&, which
23176 finds the hosts by looking up the address domain in the DNS, or by
23177 &(manualroute)&, which has lists of hosts in its configuration. However,
23178 email addresses can be passed to the &(smtp)& transport by any router, and not
23179 all of them can provide an associated list of hosts.
23180
23181 The &%hosts%& option specifies a list of hosts to be used if the address being
23182 processed does not have any hosts associated with it. The hosts specified by
23183 &%hosts%& are also used, whether or not the address has its own hosts, if
23184 &%hosts_override%& is set.
23185
23186 The string is first expanded, before being interpreted as a colon-separated
23187 list of host names or IP addresses, possibly including port numbers. The
23188 separator may be changed to something other than colon, as described in section
23189 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23190 item in a &%route_list%& setting for the &(manualroute)& router, as described
23191 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23192 of the &(manualroute)& router is not available here.
23193
23194 If the expansion fails, delivery is deferred. Unless the failure was caused by
23195 the inability to complete a lookup, the error is logged to the panic log as
23196 well as the main log. Host names are looked up either by searching directly for
23197 address records in the DNS or by calling &[gethostbyname()]& (or
23198 &[getipnodebyname()]& when available), depending on the setting of the
23199 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23200 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23201 address are used.
23202
23203 During delivery, the hosts are tried in order, subject to their retry status,
23204 unless &%hosts_randomize%& is set.
23205
23206
23207 .option hosts_avoid_esmtp smtp "host list&!!" unset
23208 .cindex "ESMTP, avoiding use of"
23209 .cindex "HELO" "forcing use of"
23210 .cindex "EHLO" "avoiding use of"
23211 .cindex "PIPELINING" "avoiding the use of"
23212 This option is for use with broken hosts that announce ESMTP facilities (for
23213 example, PIPELINING) and then fail to implement them properly. When a host
23214 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23215 start of the SMTP session. This means that it cannot use any of the ESMTP
23216 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23217
23218
23219 .option hosts_avoid_pipelining smtp "host list&!!" unset
23220 .cindex "PIPELINING" "avoiding the use of"
23221 Exim will not use the SMTP PIPELINING extension when delivering to any host
23222 that matches this list, even if the server host advertises PIPELINING support.
23223
23224
23225 .option hosts_avoid_tls smtp "host list&!!" unset
23226 .cindex "TLS" "avoiding for certain hosts"
23227 Exim will not try to start a TLS session when delivering to any host that
23228 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23229
23230 .new
23231 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23232 .cindex "TLS" "avoiding for certain hosts"
23233 Exim will not try to start a TLS session for a verify callout,
23234 or when delivering in cutthrough mode,
23235 to any host that matches this list.
23236 .wen
23237
23238
23239 .option hosts_max_try smtp integer 5
23240 .cindex "host" "maximum number to try"
23241 .cindex "limit" "number of hosts tried"
23242 .cindex "limit" "number of MX tried"
23243 .cindex "MX record" "maximum tried"
23244 This option limits the number of IP addresses that are tried for any one
23245 delivery in cases where there are temporary delivery errors. Section
23246 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23247
23248
23249 .option hosts_max_try_hardlimit smtp integer 50
23250 This is an additional check on the maximum number of IP addresses that Exim
23251 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23252 why it exists.
23253
23254
23255
23256 .option hosts_nopass_tls smtp "host list&!!" unset
23257 .cindex "TLS" "passing connection"
23258 .cindex "multiple SMTP deliveries"
23259 .cindex "TLS" "multiple message deliveries"
23260 For any host that matches this list, a connection on which a TLS session has
23261 been started will not be passed to a new delivery process for sending another
23262 message on the same connection. See section &<<SECTmulmessam>>& for an
23263 explanation of when this might be needed.
23264
23265
23266 .option hosts_override smtp boolean false
23267 If this option is set and the &%hosts%& option is also set, any hosts that are
23268 attached to the address are ignored, and instead the hosts specified by the
23269 &%hosts%& option are always used. This option does not apply to
23270 &%fallback_hosts%&.
23271
23272
23273 .option hosts_randomize smtp boolean false
23274 .cindex "randomized host list"
23275 .cindex "host" "list of; randomized"
23276 .cindex "fallback" "randomized hosts"
23277 If this option is set, and either the list of hosts is taken from the
23278 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23279 were not obtained from MX records (this includes fallback hosts from the
23280 router), and were not randomized by the router, the order of trying the hosts
23281 is randomized each time the transport runs. Randomizing the order of a host
23282 list can be used to do crude load sharing.
23283
23284 When &%hosts_randomize%& is true, a host list may be split into groups whose
23285 order is separately randomized. This makes it possible to set up MX-like
23286 behaviour. The boundaries between groups are indicated by an item that is just
23287 &`+`& in the host list. For example:
23288 .code
23289 hosts = host1:host2:host3:+:host4:host5
23290 .endd
23291 The order of the first three hosts and the order of the last two hosts is
23292 randomized for each use, but the first three always end up before the last two.
23293 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23294
23295 .option hosts_require_auth smtp "host list&!!" unset
23296 .cindex "authentication" "required by client"
23297 This option provides a list of servers for which authentication must succeed
23298 before Exim will try to transfer a message. If authentication fails for
23299 servers which are not in this list, Exim tries to send unauthenticated. If
23300 authentication fails for one of these servers, delivery is deferred. This
23301 temporary error is detectable in the retry rules, so it can be turned into a
23302 hard failure if required. See also &%hosts_try_auth%&, and chapter
23303 &<<CHAPSMTPAUTH>>& for details of authentication.
23304
23305
23306 .option hosts_request_ocsp smtp "host list&!!" *
23307 .cindex "TLS" "requiring for certain servers"
23308 Exim will request a Certificate Status on a
23309 TLS session for any host that matches this list.
23310 &%tls_verify_certificates%& should also be set for the transport.
23311
23312 .option hosts_require_ocsp smtp "host list&!!" unset
23313 .cindex "TLS" "requiring for certain servers"
23314 Exim will request, and check for a valid Certificate Status being given, on a
23315 TLS session for any host that matches this list.
23316 &%tls_verify_certificates%& should also be set for the transport.
23317
23318 .option hosts_require_tls smtp "host list&!!" unset
23319 .cindex "TLS" "requiring for certain servers"
23320 Exim will insist on using a TLS session when delivering to any host that
23321 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23322 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23323 incoming messages, use an appropriate ACL.
23324
23325 .option hosts_try_auth smtp "host list&!!" unset
23326 .cindex "authentication" "optional in client"
23327 This option provides a list of servers to which, provided they announce
23328 authentication support, Exim will attempt to authenticate as a client when it
23329 connects. If authentication fails, Exim will try to transfer the message
23330 unauthenticated. See also &%hosts_require_auth%&, and chapter
23331 &<<CHAPSMTPAUTH>>& for details of authentication.
23332
23333 .new
23334 .option hosts_try_prdr smtp "host list&!!" *
23335 .cindex "PRDR" "enabling, optional in client"
23336 This option provides a list of servers to which, provided they announce
23337 PRDR support, Exim will attempt to negotiate PRDR
23338 for multi-recipient messages.
23339 The option can usually be left as default.
23340 .wen
23341
23342 .option interface smtp "string list&!!" unset
23343 .cindex "bind IP address"
23344 .cindex "IP address" "binding"
23345 .vindex "&$host$&"
23346 .vindex "&$host_address$&"
23347 This option specifies which interface to bind to when making an outgoing SMTP
23348 call. The value is an IP address, not an interface name such as
23349 &`eth0`&. Do not confuse this with the interface address that was used when a
23350 message was received, which is in &$received_ip_address$&, formerly known as
23351 &$interface_address$&. The name was changed to minimize confusion with the
23352 outgoing interface address. There is no variable that contains an outgoing
23353 interface address because, unless it is set by this option, its value is
23354 unknown.
23355
23356 During the expansion of the &%interface%& option the variables &$host$& and
23357 &$host_address$& refer to the host to which a connection is about to be made
23358 during the expansion of the string. Forced expansion failure, or an empty
23359 string result causes the option to be ignored. Otherwise, after expansion, the
23360 string must be a list of IP addresses, colon-separated by default, but the
23361 separator can be changed in the usual way. For example:
23362 .code
23363 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23364 .endd
23365 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23366 connection. If none of them are the correct type, the option is ignored. If
23367 &%interface%& is not set, or is ignored, the system's IP functions choose which
23368 interface to use if the host has more than one.
23369
23370
23371 .option keepalive smtp boolean true
23372 .cindex "keepalive" "on outgoing connection"
23373 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23374 connections. When set, it causes the kernel to probe idle connections
23375 periodically, by sending packets with &"old"& sequence numbers. The other end
23376 of the connection should send a acknowledgment if the connection is still okay
23377 or a reset if the connection has been aborted. The reason for doing this is
23378 that it has the beneficial effect of freeing up certain types of connection
23379 that can get stuck when the remote host is disconnected without tidying up the
23380 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23381 unreachable hosts.
23382
23383
23384 .option lmtp_ignore_quota smtp boolean false
23385 .cindex "LMTP" "ignoring quota errors"
23386 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23387 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23388 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23389
23390 .option max_rcpt smtp integer 100
23391 .cindex "RCPT" "maximum number of outgoing"
23392 This option limits the number of RCPT commands that are sent in a single
23393 SMTP message transaction. Each set of addresses is treated independently, and
23394 so can cause parallel connections to the same host if &%remote_max_parallel%&
23395 permits this.
23396
23397
23398 .option multi_domain smtp boolean&!! true
23399 .vindex "&$domain$&"
23400 When this option is set, the &(smtp)& transport can handle a number of
23401 addresses containing a mixture of different domains provided they all resolve
23402 to the same list of hosts. Turning the option off restricts the transport to
23403 handling only one domain at a time. This is useful if you want to use
23404 &$domain$& in an expansion for the transport, because it is set only when there
23405 is a single domain involved in a remote delivery.
23406
23407 .new
23408 It is expanded per-address and can depend on any of
23409 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23410 &$host$&, &$host_address$& and &$host_port$&.
23411 .wen
23412
23413 .option port smtp string&!! "see below"
23414 .cindex "port" "sending TCP/IP"
23415 .cindex "TCP/IP" "setting outgoing port"
23416 This option specifies the TCP/IP port on the server to which Exim connects.
23417 &*Note:*& Do not confuse this with the port that was used when a message was
23418 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23419 The name was changed to minimize confusion with the outgoing port. There is no
23420 variable that contains an outgoing port.
23421
23422 If the value of this option begins with a digit it is taken as a port number;
23423 otherwise it is looked up using &[getservbyname()]&. The default value is
23424 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23425 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23426 is deferred.
23427
23428
23429
23430 .option protocol smtp string smtp
23431 .cindex "LMTP" "over TCP/IP"
23432 .cindex "ssmtp protocol" "outbound"
23433 .cindex "TLS" "SSL-on-connect outbound"
23434 .vindex "&$port$&"
23435 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23436 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23437 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23438 deliveries into closed message stores. Exim also has support for running LMTP
23439 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23440
23441 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23442 changes to &"smtps"&, and the transport initiates TLS immediately after
23443 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23444 The Internet standards bodies strongly discourage use of this mode.
23445
23446
23447 .option retry_include_ip_address smtp boolean&!! true
23448 Exim normally includes both the host name and the IP address in the key it
23449 constructs for indexing retry data after a temporary delivery failure. This
23450 means that when one of several IP addresses for a host is failing, it gets
23451 tried periodically (controlled by the retry rules), but use of the other IP
23452 addresses is not affected.
23453
23454 However, in some dialup environments hosts are assigned a different IP address
23455 each time they connect. In this situation the use of the IP address as part of
23456 the retry key leads to undesirable behaviour. Setting this option false causes
23457 Exim to use only the host name.
23458 .new
23459 Since it is expanded it can be made to depend on the host or domain.
23460 .wen
23461
23462
23463 .option serialize_hosts smtp "host list&!!" unset
23464 .cindex "serializing connections"
23465 .cindex "host" "serializing connections"
23466 Because Exim operates in a distributed manner, if several messages for the same
23467 host arrive at around the same time, more than one simultaneous connection to
23468 the remote host can occur. This is not usually a problem except when there is a
23469 slow link between the hosts. In that situation it may be helpful to restrict
23470 Exim to one connection at a time. This can be done by setting
23471 &%serialize_hosts%& to match the relevant hosts.
23472
23473 .cindex "hints database" "serializing deliveries to a host"
23474 Exim implements serialization by means of a hints database in which a record is
23475 written whenever a process connects to one of the restricted hosts. The record
23476 is deleted when the connection is completed. Obviously there is scope for
23477 records to get left lying around if there is a system or program crash. To
23478 guard against this, Exim ignores any records that are more than six hours old.
23479
23480 If you set up this kind of serialization, you should also arrange to delete the
23481 relevant hints database whenever your system reboots. The names of the files
23482 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23483 may be one or two files, depending on the type of DBM in use. The same files
23484 are used for ETRN serialization.
23485
23486
23487 .option size_addition smtp integer 1024
23488 .cindex "SMTP" "SIZE"
23489 .cindex "message" "size issue for transport filter"
23490 .cindex "size" "of message"
23491 .cindex "transport" "filter"
23492 .cindex "filter" "transport filter"
23493 If a remote SMTP server indicates that it supports the SIZE option of the
23494 MAIL command, Exim uses this to pass over the message size at the start of
23495 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23496 sends, to allow for headers and other text that may be added during delivery by
23497 configuration options or in a transport filter. It may be necessary to increase
23498 this if a lot of text is added to messages.
23499
23500 Alternatively, if the value of &%size_addition%& is set negative, it disables
23501 the use of the SIZE option altogether.
23502
23503
23504 .option tls_certificate smtp string&!! unset
23505 .cindex "TLS" "client certificate, location of"
23506 .cindex "certificate" "client, location of"
23507 .vindex "&$host$&"
23508 .vindex "&$host_address$&"
23509 The value of this option must be the absolute path to a file which contains the
23510 client's certificate, for possible use when sending a message over an encrypted
23511 connection. The values of &$host$& and &$host_address$& are set to the name and
23512 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23513 details of TLS.
23514
23515 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23516 certificate when sending messages as a client. The global option of the same
23517 name specifies the certificate for Exim as a server; it is not automatically
23518 assumed that the same certificate should be used when Exim is operating as a
23519 client.
23520
23521
23522 .option tls_crl smtp string&!! unset
23523 .cindex "TLS" "client certificate revocation list"
23524 .cindex "certificate" "revocation list for client"
23525 This option specifies a certificate revocation list. The expanded value must
23526 be the name of a file that contains a CRL in PEM format.
23527
23528
23529 .option tls_dh_min_bits smtp integer 1024
23530 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23531 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23532 key agreement is negotiated, the server will provide a large prime number
23533 for use.  This option establishes the minimum acceptable size of that number.
23534 If the parameter offered by the server is too small, then the TLS handshake
23535 will fail.
23536
23537 Only supported when using GnuTLS.
23538
23539
23540 .option tls_privatekey smtp string&!! unset
23541 .cindex "TLS" "client private key, location of"
23542 .vindex "&$host$&"
23543 .vindex "&$host_address$&"
23544 The value of this option must be the absolute path to a file which contains the
23545 client's private key. This is used when sending a message over an encrypted
23546 connection using a client certificate. The values of &$host$& and
23547 &$host_address$& are set to the name and address of the server during the
23548 expansion. If this option is unset, or the expansion is forced to fail, or the
23549 result is an empty string, the private key is assumed to be in the same file as
23550 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23551
23552
23553 .option tls_require_ciphers smtp string&!! unset
23554 .cindex "TLS" "requiring specific ciphers"
23555 .cindex "cipher" "requiring specific"
23556 .vindex "&$host$&"
23557 .vindex "&$host_address$&"
23558 The value of this option must be a list of permitted cipher suites, for use
23559 when setting up an outgoing encrypted connection. (There is a global option of
23560 the same name for controlling incoming connections.) The values of &$host$& and
23561 &$host_address$& are set to the name and address of the server during the
23562 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23563 is used in different ways by OpenSSL and GnuTLS (see sections
23564 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23565 ciphers is a preference order.
23566
23567
23568
23569 .option tls_sni smtp string&!! unset
23570 .cindex "TLS" "Server Name Indication"
23571 .vindex "&$tls_sni$&"
23572 If this option is set then it sets the $tls_out_sni variable and causes any
23573 TLS session to pass this value as the Server Name Indication extension to
23574 the remote side, which can be used by the remote side to select an appropriate
23575 certificate and private key for the session.
23576
23577 See &<<SECTtlssni>>& for more information.
23578
23579 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23580 TLS extensions.
23581
23582
23583
23584
23585 .option tls_tempfail_tryclear smtp boolean true
23586 .cindex "4&'xx'& responses" "to STARTTLS"
23587 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23588 setting up a TLS session, this option determines whether or not Exim should try
23589 to deliver the message unencrypted. If it is set false, delivery to the
23590 current host is deferred; if there are other hosts, they are tried. If this
23591 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23592 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23593 TLS negotiation fails, Exim closes the current connection (because it is in an
23594 unknown state), opens a new one to the same host, and then tries the delivery
23595 in clear.
23596
23597
23598 .new
23599 .option tls_try_verify_hosts smtp "host list&!!" *
23600 .wen
23601 .cindex "TLS" "server certificate verification"
23602 .cindex "certificate" "verification of server"
23603 This option gives a list of hosts for which, on encrypted connections,
23604 certificate verification will be tried but need not succeed.
23605 The &%tls_verify_certificates%& option must also be set.
23606 Note that unless the host is in this list
23607 TLS connections will be denied to hosts using self-signed certificates
23608 when &%tls_verify_certificates%& is matched.
23609 The &$tls_out_certificate_verified$& variable is set when
23610 certificate verification succeeds.
23611
23612
23613 .new
23614 .option tls_verify_cert_hostnames smtp "host list&!!" *
23615 .cindex "TLS" "server certificate hostname verification"
23616 .cindex "certificate" "verification of server"
23617 This option give a list of hosts for which,
23618 while verifying the server certificate,
23619 checks will be included on the host name
23620 (note that this will generally be the result of a DNS MX lookup)
23621 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23622 limited to being the initial component of a 3-or-more component FQDN.
23623
23624 There is no equivalent checking on client certificates.
23625 .wen
23626
23627
23628 .new
23629 .option tls_verify_certificates smtp string&!! system
23630 .cindex "TLS" "server certificate verification"
23631 .cindex "certificate" "verification of server"
23632 .vindex "&$host$&"
23633 .vindex "&$host_address$&"
23634 The value of this option must be either the
23635 word "system"
23636 or the absolute path to
23637 a file or directory containing permitted certificates for servers,
23638 for use when setting up an encrypted connection.
23639
23640 The "system" value for the option will use a location compiled into the SSL library.
23641 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23642 is taken as empty and an explicit location
23643 must be specified.
23644
23645 The use of a directory for the option value is not avilable for GnuTLS versions
23646 preceding 3.3.6 and a single file must be used.
23647 .wen
23648
23649 With OpenSSL the certificates specified
23650 explicitly
23651 either by file or directory
23652 are added to those given by the system default location.
23653
23654 The values of &$host$& and
23655 &$host_address$& are set to the name and address of the server during the
23656 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23657
23658 For back-compatability,
23659 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23660 (a single-colon empty list counts as being set)
23661 and certificate verification fails the TLS connection is closed.
23662
23663
23664 .option tls_verify_hosts smtp "host list&!!" unset
23665 .cindex "TLS" "server certificate verification"
23666 .cindex "certificate" "verification of server"
23667 This option gives a list of hosts for which. on encrypted connections,
23668 certificate verification must succeed.
23669 The &%tls_verify_certificates%& option must also be set.
23670 If both this option and &%tls_try_verify_hosts%& are unset
23671 operation is as if this option selected all hosts.
23672
23673
23674
23675
23676 .section "How the limits for the number of hosts to try are used" &&&
23677          "SECTvalhosmax"
23678 .cindex "host" "maximum number to try"
23679 .cindex "limit" "hosts; maximum number tried"
23680 There are two options that are concerned with the number of hosts that are
23681 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23682 &%hosts_max_try_hardlimit%&.
23683
23684
23685 The &%hosts_max_try%& option limits the number of hosts that are tried
23686 for a single delivery. However, despite the term &"host"& in its name, the
23687 option actually applies to each IP address independently. In other words, a
23688 multihomed host is treated as several independent hosts, just as it is for
23689 retrying.
23690
23691 Many of the larger ISPs have multiple MX records which often point to
23692 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23693 created as a result of routing one of these domains.
23694
23695 Trying every single IP address on such a long list does not seem sensible; if
23696 several at the top of the list fail, it is reasonable to assume there is some
23697 problem that is likely to affect all of them. Roughly speaking, the value of
23698 &%hosts_max_try%& is the maximum number that are tried before deferring the
23699 delivery. However, the logic cannot be quite that simple.
23700
23701 Firstly, IP addresses that are skipped because their retry times have not
23702 arrived do not count, and in addition, addresses that are past their retry
23703 limits are also not counted, even when they are tried. This means that when
23704 some IP addresses are past their retry limits, more than the value of
23705 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23706 that all IP addresses are considered before timing out an email address (but
23707 see below for an exception).
23708
23709 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23710 list to see if there is a subsequent host with a different (higher valued) MX.
23711 If there is, that host is considered next, and the current IP address is used
23712 but not counted. This behaviour helps in the case of a domain with a retry rule
23713 that hardly ever delays any hosts, as is now explained:
23714
23715 Consider the case of a long list of hosts with one MX value, and a few with a
23716 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23717 hosts at the top of the list are tried at first. With the default retry rule,
23718 which specifies increasing retry times, the higher MX hosts are eventually
23719 tried when those at the top of the list are skipped because they have not
23720 reached their retry times.
23721
23722 However, it is common practice to put a fixed short retry time on domains for
23723 large ISPs, on the grounds that their servers are rarely down for very long.
23724 Unfortunately, these are exactly the domains that tend to resolve to long lists
23725 of hosts. The short retry time means that the lowest MX hosts are tried every
23726 time. The attempts may be in a different order because of random sorting, but
23727 without the special MX check, the higher MX hosts would never be tried until
23728 all the lower MX hosts had timed out (which might be several days), because
23729 there are always some lower MX hosts that have reached their retry times. With
23730 the special check, Exim considers at least one IP address from each MX value at
23731 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23732 reached.
23733
23734 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23735 particular, Exim normally eventually tries all the IP addresses before timing
23736 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23737 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23738 been set up with hundreds of IP addresses for some domains. It can
23739 take a very long time indeed for an address to time out in these cases.
23740
23741 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23742 Exim never tries more than this number of IP addresses; if it hits this limit
23743 and they are all timed out, the email address is bounced, even though not all
23744 possible IP addresses have been tried.
23745 .ecindex IIDsmttra1
23746 .ecindex IIDsmttra2
23747
23748
23749
23750
23751
23752 . ////////////////////////////////////////////////////////////////////////////
23753 . ////////////////////////////////////////////////////////////////////////////
23754
23755 .chapter "Address rewriting" "CHAPrewrite"
23756 .scindex IIDaddrew "rewriting" "addresses"
23757 There are some circumstances in which Exim automatically rewrites domains in
23758 addresses. The two most common are when an address is given without a domain
23759 (referred to as an &"unqualified address"&) or when an address contains an
23760 abbreviated domain that is expanded by DNS lookup.
23761
23762 Unqualified envelope addresses are accepted only for locally submitted
23763 messages, or for messages that are received from hosts matching
23764 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23765 appropriate. Unqualified addresses in header lines are qualified if they are in
23766 locally submitted messages, or messages from hosts that are permitted to send
23767 unqualified envelope addresses. Otherwise, unqualified addresses in header
23768 lines are neither qualified nor rewritten.
23769
23770 One situation in which Exim does &'not'& automatically rewrite a domain is
23771 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23772 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23773 do this. The new RFCs do not contain this suggestion.
23774
23775
23776 .section "Explicitly configured address rewriting" "SECID147"
23777 This chapter describes the rewriting rules that can be used in the
23778 main rewrite section of the configuration file, and also in the generic
23779 &%headers_rewrite%& option that can be set on any transport.
23780
23781 Some people believe that configured address rewriting is a Mortal Sin.
23782 Others believe that life is not possible without it. Exim provides the
23783 facility; you do not have to use it.
23784
23785 The main rewriting rules that appear in the &"rewrite"& section of the
23786 configuration file are applied to addresses in incoming messages, both envelope
23787 addresses and addresses in header lines. Each rule specifies the types of
23788 address to which it applies.
23789
23790 Whether or not addresses in header lines are rewritten depends on the origin of
23791 the headers and the type of rewriting. Global rewriting, that is, rewriting
23792 rules from the rewrite section of the configuration file, is applied only to
23793 those headers that were received with the message. Header lines that are added
23794 by ACLs or by a system filter or by individual routers or transports (which
23795 are specific to individual recipient addresses) are not rewritten by the global
23796 rules.
23797
23798 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23799 applies all headers except those added by routers and transports. That is, as
23800 well as the headers that were received with the message, it also applies to
23801 headers that were added by an ACL or a system filter.
23802
23803
23804 In general, rewriting addresses from your own system or domain has some
23805 legitimacy. Rewriting other addresses should be done only with great care and
23806 in special circumstances. The author of Exim believes that rewriting should be
23807 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23808 Although it can sometimes be used as a routing tool, this is very strongly
23809 discouraged.
23810
23811 There are two commonly encountered circumstances where rewriting is used, as
23812 illustrated by these examples:
23813
23814 .ilist
23815 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23816 exchange mail with each other behind a firewall, but there is only a single
23817 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23818 &'hitch.fict.example'& when sending mail off-site.
23819 .next
23820 A host rewrites the local parts of its own users so that, for example,
23821 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23822 .endlist
23823
23824
23825
23826 .section "When does rewriting happen?" "SECID148"
23827 .cindex "rewriting" "timing of"
23828 .cindex "&ACL;" "rewriting addresses in"
23829 Configured address rewriting can take place at several different stages of a
23830 message's processing.
23831
23832 .vindex "&$sender_address$&"
23833 At the start of an ACL for MAIL, the sender address may have been rewritten
23834 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23835 ordinary rewrite rules have yet been applied. If, however, the sender address
23836 is verified in the ACL, it is rewritten before verification, and remains
23837 rewritten thereafter. The subsequent value of &$sender_address$& is the
23838 rewritten address. This also applies if sender verification happens in a
23839 RCPT ACL. Otherwise, when the sender address is not verified, it is
23840 rewritten as soon as a message's header lines have been received.
23841
23842 .vindex "&$domain$&"
23843 .vindex "&$local_part$&"
23844 Similarly, at the start of an ACL for RCPT, the current recipient's address
23845 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23846 rewrite rules have yet been applied to it. However, the behaviour is different
23847 from the sender address when a recipient is verified. The address is rewritten
23848 for the verification, but the rewriting is not remembered at this stage. The
23849 value of &$local_part$& and &$domain$& after verification are always the same
23850 as they were before (that is, they contain the unrewritten &-- except for
23851 SMTP-time rewriting &-- address).
23852
23853 As soon as a message's header lines have been received, all the envelope
23854 recipient addresses are permanently rewritten, and rewriting is also applied to
23855 the addresses in the header lines (if configured). This happens before adding
23856 any header lines that were specified in MAIL or RCPT ACLs, and
23857 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23858 before the DATA ACL and &[local_scan()]& functions are run.
23859
23860 When an address is being routed, either for delivery or for verification,
23861 rewriting is applied immediately to child addresses that are generated by
23862 redirection, unless &%no_rewrite%& is set on the router.
23863
23864 .cindex "envelope sender" "rewriting at transport time"
23865 .cindex "rewriting" "at transport time"
23866 .cindex "header lines" "rewriting at transport time"
23867 At transport time, additional rewriting of addresses in header lines can be
23868 specified by setting the generic &%headers_rewrite%& option on a transport.
23869 This option contains rules that are identical in form to those in the rewrite
23870 section of the configuration file. They are applied to the original message
23871 header lines and any that were added by ACLs or a system filter. They are not
23872 applied to header lines that are added by routers or the transport.
23873
23874 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23875 transport option. However, it is not possible to rewrite envelope recipients at
23876 transport time.
23877
23878
23879
23880
23881 .section "Testing the rewriting rules that apply on input" "SECID149"
23882 .cindex "rewriting" "testing"
23883 .cindex "testing" "rewriting"
23884 Exim's input rewriting configuration appears in a part of the run time
23885 configuration file headed by &"begin rewrite"&. It can be tested by the
23886 &%-brw%& command line option. This takes an address (which can be a full RFC
23887 2822 address) as its argument. The output is a list of how the address would be
23888 transformed by the rewriting rules for each of the different places it might
23889 appear in an incoming message, that is, for each different header and for the
23890 envelope sender and recipient fields. For example,
23891 .code
23892 exim -brw ph10@exim.workshop.example
23893 .endd
23894 might produce the output
23895 .code
23896 sender: Philip.Hazel@exim.workshop.example
23897 from: Philip.Hazel@exim.workshop.example
23898 to: ph10@exim.workshop.example
23899 cc: ph10@exim.workshop.example
23900 bcc: ph10@exim.workshop.example
23901 reply-to: Philip.Hazel@exim.workshop.example
23902 env-from: Philip.Hazel@exim.workshop.example
23903 env-to: ph10@exim.workshop.example
23904 .endd
23905 which shows that rewriting has been set up for that address when used in any of
23906 the source fields, but not when it appears as a recipient address. At the
23907 present time, there is no equivalent way of testing rewriting rules that are
23908 set for a particular transport.
23909
23910
23911 .section "Rewriting rules" "SECID150"
23912 .cindex "rewriting" "rules"
23913 The rewrite section of the configuration file consists of lines of rewriting
23914 rules in the form
23915 .display
23916 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23917 .endd
23918 Rewriting rules that are specified for the &%headers_rewrite%& generic
23919 transport option are given as a colon-separated list. Each item in the list
23920 takes the same form as a line in the main rewriting configuration (except that
23921 any colons must be doubled, of course).
23922
23923 The formats of source patterns and replacement strings are described below.
23924 Each is terminated by white space, unless enclosed in double quotes, in which
23925 case normal quoting conventions apply inside the quotes. The flags are single
23926 characters which may appear in any order. Spaces and tabs between them are
23927 ignored.
23928
23929 For each address that could potentially be rewritten, the rules are scanned in
23930 order, and replacements for the address from earlier rules can themselves be
23931 replaced by later rules (but see the &"q"& and &"R"& flags).
23932
23933 The order in which addresses are rewritten is undefined, may change between
23934 releases, and must not be relied on, with one exception: when a message is
23935 received, the envelope sender is always rewritten first, before any header
23936 lines are rewritten. For example, the replacement string for a rewrite of an
23937 address in &'To:'& must not assume that the message's address in &'From:'& has
23938 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23939 that the envelope sender has already been rewritten.
23940
23941 .vindex "&$domain$&"
23942 .vindex "&$local_part$&"
23943 The variables &$local_part$& and &$domain$& can be used in the replacement
23944 string to refer to the address that is being rewritten. Note that lookup-driven
23945 rewriting can be done by a rule of the form
23946 .code
23947 *@*   ${lookup ...
23948 .endd
23949 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23950 refer to the address that is being rewritten.
23951
23952
23953 .section "Rewriting patterns" "SECID151"
23954 .cindex "rewriting" "patterns"
23955 .cindex "address list" "in a rewriting pattern"
23956 The source pattern in a rewriting rule is any item which may appear in an
23957 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23958 single-item address list, which means that it is expanded before being tested
23959 against the address. As always, if you use a regular expression as a pattern,
23960 you must take care to escape dollar and backslash characters, or use the &`\N`&
23961 facility to suppress string expansion within the regular expression.
23962
23963 Domains in patterns should be given in lower case. Local parts in patterns are
23964 case-sensitive. If you want to do case-insensitive matching of local parts, you
23965 can use a regular expression that starts with &`^(?i)`&.
23966
23967 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23968 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23969 depending on the type of match which occurred. These can be used in the
23970 replacement string to insert portions of the incoming address. &$0$& always
23971 refers to the complete incoming address. When a regular expression is used, the
23972 numerical variables are set from its capturing subexpressions. For other types
23973 of pattern they are set as follows:
23974
23975 .ilist
23976 If a local part or domain starts with an asterisk, the numerical variables
23977 refer to the character strings matched by asterisks, with &$1$& associated with
23978 the first asterisk, and &$2$& with the second, if present. For example, if the
23979 pattern
23980 .code
23981 *queen@*.fict.example
23982 .endd
23983 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23984 .code
23985 $0 = hearts-queen@wonderland.fict.example
23986 $1 = hearts-
23987 $2 = wonderland
23988 .endd
23989 Note that if the local part does not start with an asterisk, but the domain
23990 does, it is &$1$& that contains the wild part of the domain.
23991
23992 .next
23993 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23994 of the domain are placed in the next available numerical variables. Suppose,
23995 for example, that the address &'foo@bar.baz.example'& is processed by a
23996 rewriting rule of the form
23997 .display
23998 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23999 .endd
24000 and the key in the file that matches the domain is &`*.baz.example`&. Then
24001 .code
24002 $1 = foo
24003 $2 = bar
24004 $3 = baz.example
24005 .endd
24006 If the address &'foo@baz.example'& is looked up, this matches the same
24007 wildcard file entry, and in this case &$2$& is set to the empty string, but
24008 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24009 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24010 whole domain. For non-partial domain lookups, no numerical variables are set.
24011 .endlist
24012
24013
24014 .section "Rewriting replacements" "SECID152"
24015 .cindex "rewriting" "replacements"
24016 If the replacement string for a rule is a single asterisk, addresses that
24017 match the pattern and the flags are &'not'& rewritten, and no subsequent
24018 rewriting rules are scanned. For example,
24019 .code
24020 hatta@lookingglass.fict.example  *  f
24021 .endd
24022 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24023 &'From:'& headers.
24024
24025 .vindex "&$domain$&"
24026 .vindex "&$local_part$&"
24027 If the replacement string is not a single asterisk, it is expanded, and must
24028 yield a fully qualified address. Within the expansion, the variables
24029 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24030 Any letters they contain retain their original case &-- they are not lower
24031 cased. The numerical variables are set up according to the type of pattern that
24032 matched the address, as described above. If the expansion is forced to fail by
24033 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24034 current rule is abandoned, but subsequent rules may take effect. Any other
24035 expansion failure causes the entire rewriting operation to be abandoned, and an
24036 entry written to the panic log.
24037
24038
24039
24040 .section "Rewriting flags" "SECID153"
24041 There are three different kinds of flag that may appear on rewriting rules:
24042
24043 .ilist
24044 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24045 c, f, h, r, s, t.
24046 .next
24047 A flag that specifies rewriting at SMTP time: S.
24048 .next
24049 Flags that control the rewriting process: Q, q, R, w.
24050 .endlist
24051
24052 For rules that are part of the &%headers_rewrite%& generic transport option,
24053 E, F, T, and S are not permitted.
24054
24055
24056
24057 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24058          "SECID154"
24059 .cindex "rewriting" "flags"
24060 If none of the following flag letters, nor the &"S"& flag (see section
24061 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24062 and to both the sender and recipient fields of the envelope, whereas a
24063 transport-time rewriting rule just applies to all headers. Otherwise, the
24064 rewriting rule is skipped unless the relevant addresses are being processed.
24065 .display
24066 &`E`&       rewrite all envelope fields
24067 &`F`&       rewrite the envelope From field
24068 &`T`&       rewrite the envelope To field
24069 &`b`&       rewrite the &'Bcc:'& header
24070 &`c`&       rewrite the &'Cc:'& header
24071 &`f`&       rewrite the &'From:'& header
24072 &`h`&       rewrite all headers
24073 &`r`&       rewrite the &'Reply-To:'& header
24074 &`s`&       rewrite the &'Sender:'& header
24075 &`t`&       rewrite the &'To:'& header
24076 .endd
24077 "All headers" means all of the headers listed above that can be selected
24078 individually, plus their &'Resent-'& versions. It does not include
24079 other headers such as &'Subject:'& etc.
24080
24081 You should be particularly careful about rewriting &'Sender:'& headers, and
24082 restrict this to special known cases in your own domains.
24083
24084
24085 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24086 .cindex "SMTP" "rewriting malformed addresses"
24087 .cindex "RCPT" "rewriting argument of"
24088 .cindex "MAIL" "rewriting argument of"
24089 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24090 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24091 before any other processing; even before syntax checking. The pattern is
24092 required to be a regular expression, and it is matched against the whole of the
24093 data for the command, including any surrounding angle brackets.
24094
24095 .vindex "&$domain$&"
24096 .vindex "&$local_part$&"
24097 This form of rewrite rule allows for the handling of addresses that are not
24098 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24099 input). Because the input is not required to be a syntactically valid address,
24100 the variables &$local_part$& and &$domain$& are not available during the
24101 expansion of the replacement string. The result of rewriting replaces the
24102 original address in the MAIL or RCPT command.
24103
24104
24105 .section "Flags controlling the rewriting process" "SECID155"
24106 There are four flags which control the way the rewriting process works. These
24107 take effect only when a rule is invoked, that is, when the address is of the
24108 correct type (matches the flags) and matches the pattern:
24109
24110 .ilist
24111 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24112 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24113 absence of &"Q"& the rewritten address must always include a domain.
24114 .next
24115 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24116 even if no rewriting actually takes place because of a &"fail"& in the
24117 expansion. The &"q"& flag is not effective if the address is of the wrong type
24118 (does not match the flags) or does not match the pattern.
24119 .next
24120 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24121 address, up to ten times. It can be combined with the &"q"& flag, to stop
24122 rewriting once it fails to match (after at least one successful rewrite).
24123 .next
24124 .cindex "rewriting" "whole addresses"
24125 When an address in a header is rewritten, the rewriting normally applies only
24126 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24127 left unchanged. For example, rewriting might change
24128 .code
24129 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24130 .endd
24131 into
24132 .code
24133 From: Ford Prefect <prefectf@hitch.fict.example>
24134 .endd
24135 .cindex "RFC 2047"
24136 Sometimes there is a need to replace the whole address item, and this can be
24137 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24138 causes an address in a header line to be rewritten, the entire address is
24139 replaced, not just the working part. The replacement must be a complete RFC
24140 2822 address, including the angle brackets if necessary. If text outside angle
24141 brackets contains a character whose value is greater than 126 or less than 32
24142 (except for tab), the text is encoded according to RFC 2047. The character set
24143 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24144
24145 When the &"w"& flag is set on a rule that causes an envelope address to be
24146 rewritten, all but the working part of the replacement address is discarded.
24147 .endlist
24148
24149
24150 .section "Rewriting examples" "SECID156"
24151 Here is an example of the two common rewriting paradigms:
24152 .code
24153 *@*.hitch.fict.example  $1@hitch.fict.example
24154 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24155                      {$value}fail}@hitch.fict.example bctfrF
24156 .endd
24157 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24158 the string expansion to fail if the lookup does not succeed. In this context it
24159 has the effect of leaving the original address unchanged, but Exim goes on to
24160 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24161 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24162 explicitly, which would cause the rewritten address to be the same as before,
24163 at the cost of a small bit of processing. Not supplying either of these is an
24164 error, since the rewritten address would then contain no local part.
24165
24166 The first example above replaces the domain with a superior, more general
24167 domain. This may not be desirable for certain local parts. If the rule
24168 .code
24169 root@*.hitch.fict.example  *
24170 .endd
24171 were inserted before the first rule, rewriting would be suppressed for the
24172 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24173
24174 Rewriting can be made conditional on a number of tests, by making use of
24175 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24176 messages that originate outside the local host:
24177 .code
24178 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24179                          {$1@hitch.fict.example}fail}"
24180 .endd
24181 The replacement string is quoted in this example because it contains white
24182 space.
24183
24184 .cindex "rewriting" "bang paths"
24185 .cindex "bang paths" "rewriting"
24186 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24187 an address it treats it as an unqualified local part which it qualifies with
24188 the local qualification domain (if the source of the message is local or if the
24189 remote host is permitted to send unqualified addresses). Rewriting can
24190 sometimes be used to handle simple bang paths with a fixed number of
24191 components. For example, the rule
24192 .code
24193 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24194 .endd
24195 rewrites a two-component bang path &'host.name!user'& as the domain address
24196 &'user@host.name'&. However, there is a security implication in using this as
24197 a global rewriting rule for envelope addresses. It can provide a backdoor
24198 method for using your system as a relay, because the incoming addresses appear
24199 to be local. If the bang path addresses are received via SMTP, it is safer to
24200 use the &"S"& flag to rewrite them as they are received, so that relay checking
24201 can be done on the rewritten addresses.
24202 .ecindex IIDaddrew
24203
24204
24205
24206
24207
24208 . ////////////////////////////////////////////////////////////////////////////
24209 . ////////////////////////////////////////////////////////////////////////////
24210
24211 .chapter "Retry configuration" "CHAPretry"
24212 .scindex IIDretconf1 "retry" "configuration, description of"
24213 .scindex IIDregconf2 "configuration file" "retry section"
24214 The &"retry"& section of the runtime configuration file contains a list of
24215 retry rules that control how often Exim tries to deliver messages that cannot
24216 be delivered at the first attempt. If there are no retry rules (the section is
24217 empty or not present), there are no retries. In this situation, temporary
24218 errors are treated as permanent. The default configuration contains a single,
24219 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24220 line option can be used to test which retry rule will be used for a given
24221 address, domain and error.
24222
24223 The most common cause of retries is temporary failure to deliver to a remote
24224 host because the host is down, or inaccessible because of a network problem.
24225 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24226 address) basis, not on a per-message basis. Thus, if one message has recently
24227 been delayed, delivery of a new message to the same host is not immediately
24228 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24229 log selector is set, the message
24230 .cindex "retry" "time not reached"
24231 &"retry time not reached"& is written to the main log whenever a delivery is
24232 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24233 the handling of errors during remote deliveries.
24234
24235 Retry processing applies to routing as well as to delivering, except as covered
24236 in the next paragraph. The retry rules do not distinguish between these
24237 actions. It is not possible, for example, to specify different behaviour for
24238 failures to route the domain &'snark.fict.example'& and failures to deliver to
24239 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24240 added complication, so did not implement it. However, although they share the
24241 same retry rule, the actual retry times for routing and transporting a given
24242 domain are maintained independently.
24243
24244 When a delivery is not part of a queue run (typically an immediate delivery on
24245 receipt of a message), the routers are always run, and local deliveries are
24246 always attempted, even if retry times are set for them. This makes for better
24247 behaviour if one particular message is causing problems (for example, causing
24248 quota overflow, or provoking an error in a filter file). If such a delivery
24249 suffers a temporary failure, the retry data is updated as normal, and
24250 subsequent delivery attempts from queue runs occur only when the retry time for
24251 the local address is reached.
24252
24253 .section "Changing retry rules" "SECID157"
24254 If you change the retry rules in your configuration, you should consider
24255 whether or not to delete the retry data that is stored in Exim's spool area in
24256 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24257 always safe; that is why they are called &"hints"&.
24258
24259 The hints retry data contains suggested retry times based on the previous
24260 rules. In the case of a long-running problem with a remote host, it might
24261 record the fact that the host has timed out. If your new rules increase the
24262 timeout time for such a host, you should definitely remove the old retry data
24263 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24264 messages that it should now be retaining.
24265
24266
24267
24268 .section "Format of retry rules" "SECID158"
24269 .cindex "retry" "rules"
24270 Each retry rule occupies one line and consists of three or four parts,
24271 separated by white space: a pattern, an error name, an optional list of sender
24272 addresses, and a list of retry parameters. The pattern and sender lists must be
24273 enclosed in double quotes if they contain white space. The rules are searched
24274 in order until one is found where the pattern, error name, and sender list (if
24275 present) match the failing host or address, the error that occurred, and the
24276 message's sender, respectively.
24277
24278
24279 The pattern is any single item that may appear in an address list (see section
24280 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24281 which means that it is expanded before being tested against the address that
24282 has been delayed. A negated address list item is permitted. Address
24283 list processing treats a plain domain name as if it were preceded by &"*@"&,
24284 which makes it possible for many retry rules to start with just a domain. For
24285 example,
24286 .code
24287 lookingglass.fict.example        *  F,24h,30m;
24288 .endd
24289 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24290 whereas
24291 .code
24292 alice@lookingglass.fict.example  *  F,24h,30m;
24293 .endd
24294 applies only to temporary failures involving the local part &%alice%&.
24295 In practice, almost all rules start with a domain name pattern without a local
24296 part.
24297
24298 .cindex "regular expressions" "in retry rules"
24299 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24300 must match a complete address, not just a domain, because that is how regular
24301 expressions work in address lists.
24302 .display
24303 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24304 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24305 .endd
24306
24307
24308 .section "Choosing which retry rule to use for address errors" "SECID159"
24309 When Exim is looking for a retry rule after a routing attempt has failed (for
24310 example, after a DNS timeout), each line in the retry configuration is tested
24311 against the complete address only if &%retry_use_local_part%& is set for the
24312 router. Otherwise, only the domain is used, except when matching against a
24313 regular expression, when the local part of the address is replaced with &"*"&.
24314 A domain on its own can match a domain pattern, or a pattern that starts with
24315 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24316 &%check_local_user%& is true, and false for other routers.
24317
24318 Similarly, when Exim is looking for a retry rule after a local delivery has
24319 failed (for example, after a mailbox full error), each line in the retry
24320 configuration is tested against the complete address only if
24321 &%retry_use_local_part%& is set for the transport (it defaults true for all
24322 local transports).
24323
24324 .cindex "4&'xx'& responses" "retry rules for"
24325 However, when Exim is looking for a retry rule after a remote delivery attempt
24326 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24327 whole address is always used as the key when searching the retry rules. The
24328 rule that is found is used to create a retry time for the combination of the
24329 failing address and the message's sender. It is the combination of sender and
24330 recipient that is delayed in subsequent queue runs until its retry time is
24331 reached. You can delay the recipient without regard to the sender by setting
24332 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24333 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24334 commands.
24335
24336
24337
24338 .section "Choosing which retry rule to use for host and message errors" &&&
24339          "SECID160"
24340 For a temporary error that is not related to an individual address (for
24341 example, a connection timeout), each line in the retry configuration is checked
24342 twice. First, the name of the remote host is used as a domain name (preceded by
24343 &"*@"& when matching a regular expression). If this does not match the line,
24344 the domain from the email address is tried in a similar fashion. For example,
24345 suppose the MX records for &'a.b.c.example'& are
24346 .code
24347 a.b.c.example  MX  5  x.y.z.example
24348                MX  6  p.q.r.example
24349                MX  7  m.n.o.example
24350 .endd
24351 and the retry rules are
24352 .code
24353 p.q.r.example    *      F,24h,30m;
24354 a.b.c.example    *      F,4d,45m;
24355 .endd
24356 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24357 first rule matches neither the host nor the domain, so Exim looks at the second
24358 rule. This does not match the host, but it does match the domain, so it is used
24359 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24360 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24361 first retry rule is used, because it matches the host.
24362
24363 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24364 first rule to determine retry times, but for all the other hosts for the domain
24365 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24366 routing to &'a.b.c.example'& suffers a temporary failure.
24367
24368 &*Note*&: The host name is used when matching the patterns, not its IP address.
24369 However, if a message is routed directly to an IP address without the use of a
24370 host name, for example, if a &(manualroute)& router contains a setting such as:
24371 .code
24372 route_list = *.a.example  192.168.34.23
24373 .endd
24374 then the &"host name"& that is used when searching for a retry rule is the
24375 textual form of the IP address.
24376
24377 .section "Retry rules for specific errors" "SECID161"
24378 .cindex "retry" "specific errors; specifying"
24379 The second field in a retry rule is the name of a particular error, or an
24380 asterisk, which matches any error. The errors that can be tested for are:
24381
24382 .vlist
24383 .vitem &%auth_failed%&
24384 Authentication failed when trying to send to a host in the
24385 &%hosts_require_auth%& list in an &(smtp)& transport.
24386
24387 .vitem &%data_4xx%&
24388 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24389 after the command, or after sending the message's data.
24390
24391 .vitem &%mail_4xx%&
24392 A 4&'xx'& error was received for an outgoing MAIL command.
24393
24394 .vitem &%rcpt_4xx%&
24395 A 4&'xx'& error was received for an outgoing RCPT command.
24396 .endlist
24397
24398 For the three 4&'xx'& errors, either the first or both of the x's can be given
24399 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24400 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24401 and have retries every ten minutes with a one-hour timeout, you could set up a
24402 retry rule of this form:
24403 .code
24404 the.domain.name  rcpt_452   F,1h,10m
24405 .endd
24406 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24407 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24408
24409 .vlist
24410 .vitem &%lost_connection%&
24411 A server unexpectedly closed the SMTP connection. There may, of course,
24412 legitimate reasons for this (host died, network died), but if it repeats a lot
24413 for the same host, it indicates something odd.
24414
24415 .vitem &%lookup%&
24416 A DNS lookup for a host failed.
24417 Note that a &%dnslookup%& router will need to have matched
24418 its &%fail_defer_domains%& option for this retry type to be usable.
24419 Also note that a &%manualroute%& router will probably need
24420 its &%host_find_failed%& option set to &%defer%&.
24421
24422 .vitem &%refused_MX%&
24423 A connection to a host obtained from an MX record was refused.
24424
24425 .vitem &%refused_A%&
24426 A connection to a host not obtained from an MX record was refused.
24427
24428 .vitem &%refused%&
24429 A connection was refused.
24430
24431 .vitem &%timeout_connect_MX%&
24432 A connection attempt to a host obtained from an MX record timed out.
24433
24434 .vitem &%timeout_connect_A%&
24435 A connection attempt to a host not obtained from an MX record timed out.
24436
24437 .vitem &%timeout_connect%&
24438 A connection attempt timed out.
24439
24440 .vitem &%timeout_MX%&
24441 There was a timeout while connecting or during an SMTP session with a host
24442 obtained from an MX record.
24443
24444 .vitem &%timeout_A%&
24445 There was a timeout while connecting or during an SMTP session with a host not
24446 obtained from an MX record.
24447
24448 .vitem &%timeout%&
24449 There was a timeout while connecting or during an SMTP session.
24450
24451 .vitem &%tls_required%&
24452 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24453 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24454 to STARTTLS, or there was a problem setting up the TLS connection.
24455
24456 .vitem &%quota%&
24457 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24458 transport.
24459
24460 .vitem &%quota_%&<&'time'&>
24461 .cindex "quota" "error testing in retry rule"
24462 .cindex "retry" "quota error testing"
24463 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24464 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24465 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24466 for four days.
24467 .endlist
24468
24469 .cindex "mailbox" "time of last read"
24470 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24471 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24472 it should be based on the last time that the user accessed the mailbox.
24473 However, it is not always possible to determine this. Exim uses the following
24474 heuristic rules:
24475
24476 .ilist
24477 If the mailbox is a single file, the time of last access (the &"atime"&) is
24478 used. As no new messages are being delivered (because the mailbox is over
24479 quota), Exim does not access the file, so this is the time of last user access.
24480 .next
24481 .cindex "maildir format" "time of last read"
24482 For a maildir delivery, the time of last modification of the &_new_&
24483 subdirectory is used. As the mailbox is over quota, no new files are created in
24484 the &_new_& subdirectory, because no new messages are being delivered. Any
24485 change to the &_new_& subdirectory is therefore assumed to be the result of an
24486 MUA moving a new message to the &_cur_& directory when it is first read. The
24487 time that is used is therefore the last time that the user read a new message.
24488 .next
24489 For other kinds of multi-file mailbox, the time of last access cannot be
24490 obtained, so a retry rule that uses this type of error field is never matched.
24491 .endlist
24492
24493 The quota errors apply both to system-enforced quotas and to Exim's own quota
24494 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24495 when a local delivery is deferred because a partition is full (the ENOSPC
24496 error).
24497
24498
24499
24500 .section "Retry rules for specified senders" "SECID162"
24501 .cindex "retry" "rules; sender-specific"
24502 You can specify retry rules that apply only when the failing message has a
24503 specific sender. In particular, this can be used to define retry rules that
24504 apply only to bounce messages. The third item in a retry rule can be of this
24505 form:
24506 .display
24507 &`senders=`&<&'address list'&>
24508 .endd
24509 The retry timings themselves are then the fourth item. For example:
24510 .code
24511 *   rcpt_4xx   senders=:   F,1h,30m
24512 .endd
24513 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24514 host. If the address list contains white space, it must be enclosed in quotes.
24515 For example:
24516 .code
24517 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24518 .endd
24519 &*Warning*&: This facility can be unhelpful if it is used for host errors
24520 (which do not depend on the recipient). The reason is that the sender is used
24521 only to match the retry rule. Once the rule has been found for a host error,
24522 its contents are used to set a retry time for the host, and this will apply to
24523 all messages, not just those with specific senders.
24524
24525 When testing retry rules using &%-brt%&, you can supply a sender using the
24526 &%-f%& command line option, like this:
24527 .code
24528 exim -f "" -brt user@dom.ain
24529 .endd
24530 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24531 list is never matched.
24532
24533
24534
24535
24536
24537 .section "Retry parameters" "SECID163"
24538 .cindex "retry" "parameters in rules"
24539 The third (or fourth, if a senders list is present) field in a retry rule is a
24540 sequence of retry parameter sets, separated by semicolons. Each set consists of
24541 .display
24542 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24543 .endd
24544 The letter identifies the algorithm for computing a new retry time; the cutoff
24545 time is the time beyond which this algorithm no longer applies, and the
24546 arguments vary the algorithm's action. The cutoff time is measured from the
24547 time that the first failure for the domain (combined with the local part if
24548 relevant) was detected, not from the time the message was received.
24549
24550 .cindex "retry" "algorithms"
24551 .cindex "retry" "fixed intervals"
24552 .cindex "retry" "increasing intervals"
24553 .cindex "retry" "random intervals"
24554 The available algorithms are:
24555
24556 .ilist
24557 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24558 the interval.
24559 .next
24560 &'G'&: retry at geometrically increasing intervals. The first argument
24561 specifies a starting value for the interval, and the second a multiplier, which
24562 is used to increase the size of the interval at each retry.
24563 .next
24564 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24565 retry, the previous interval is multiplied by the factor in order to get a
24566 maximum for the next interval. The minimum interval is the first argument of
24567 the parameter, and an actual interval is chosen randomly between them. Such a
24568 rule has been found to be helpful in cluster configurations when all the
24569 members of the cluster restart at once, and may therefore synchronize their
24570 queue processing times.
24571 .endlist
24572
24573 When computing the next retry time, the algorithm definitions are scanned in
24574 order until one whose cutoff time has not yet passed is reached. This is then
24575 used to compute a new retry time that is later than the current time. In the
24576 case of fixed interval retries, this simply means adding the interval to the
24577 current time. For geometrically increasing intervals, retry intervals are
24578 computed from the rule's parameters until one that is greater than the previous
24579 interval is found. The main configuration variable
24580 .cindex "limit" "retry interval"
24581 .cindex "retry" "interval, maximum"
24582 .oindex "&%retry_interval_max%&"
24583 &%retry_interval_max%& limits the maximum interval between retries. It
24584 cannot be set greater than &`24h`&, which is its default value.
24585
24586 A single remote domain may have a number of hosts associated with it, and each
24587 host may have more than one IP address. Retry algorithms are selected on the
24588 basis of the domain name, but are applied to each IP address independently. If,
24589 for example, a host has two IP addresses and one is unusable, Exim will
24590 generate retry times for it and will not try to use it until its next retry
24591 time comes. Thus the good IP address is likely to be tried first most of the
24592 time.
24593
24594 .cindex "hints database" "use for retrying"
24595 Retry times are hints rather than promises. Exim does not make any attempt to
24596 run deliveries exactly at the computed times. Instead, a queue runner process
24597 starts delivery processes for delayed messages periodically, and these attempt
24598 new deliveries only for those addresses that have passed their next retry time.
24599 If a new message arrives for a deferred address, an immediate delivery attempt
24600 occurs only if the address has passed its retry time. In the absence of new
24601 messages, the minimum time between retries is the interval between queue runner
24602 processes. There is not much point in setting retry times of five minutes if
24603 your queue runners happen only once an hour, unless there are a significant
24604 number of incoming messages (which might be the case on a system that is
24605 sending everything to a smart host, for example).
24606
24607 The data in the retry hints database can be inspected by using the
24608 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24609 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24610 &'exinext'& utility script can be used to find out what the next retry times
24611 are for the hosts associated with a particular mail domain, and also for local
24612 deliveries that have been deferred.
24613
24614
24615 .section "Retry rule examples" "SECID164"
24616 Here are some example retry rules:
24617 .code
24618 alice@wonderland.fict.example quota_5d  F,7d,3h
24619 wonderland.fict.example       quota_5d
24620 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24621 lookingglass.fict.example     *         F,24h,30m;
24622 *                 refused_A   F,2h,20m;
24623 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24624 .endd
24625 The first rule sets up special handling for mail to
24626 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24627 mailbox has not been read for at least 5 days. Retries continue every three
24628 hours for 7 days. The second rule handles over-quota errors for all other local
24629 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24630 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24631 fail are bounced immediately if the mailbox has not been read for at least 5
24632 days.
24633
24634 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24635 happen every 15 minutes for an hour, then with geometrically increasing
24636 intervals until two days have passed since a delivery first failed. After the
24637 first hour there is a delay of one hour, then two hours, then four hours, and
24638 so on (this is a rather extreme example).
24639
24640 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24641 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24642 all other domains, with special action for connection refusal from hosts that
24643 were not obtained from an MX record.
24644
24645 The final rule in a retry configuration should always have asterisks in the
24646 first two fields so as to provide a general catch-all for any addresses that do
24647 not have their own special handling. This example tries every 15 minutes for 2
24648 hours, then with intervals starting at one hour and increasing by a factor of
24649 1.5 up to 16 hours, then every 8 hours up to 5 days.
24650
24651
24652
24653 .section "Timeout of retry data" "SECID165"
24654 .cindex "timeout" "of retry data"
24655 .oindex "&%retry_data_expire%&"
24656 .cindex "hints database" "data expiry"
24657 .cindex "retry" "timeout of data"
24658 Exim timestamps the data that it writes to its retry hints database. When it
24659 consults the data during a delivery it ignores any that is older than the value
24660 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24661 been tried for 7 days, Exim will try to deliver to it immediately a message
24662 arrives, and if that fails, it will calculate a retry time as if it were
24663 failing for the first time.
24664
24665 This improves the behaviour for messages routed to rarely-used hosts such as MX
24666 backups. If such a host was down at one time, and happens to be down again when
24667 Exim tries a month later, using the old retry data would imply that it had been
24668 down all the time, which is not a justified assumption.
24669
24670 If a host really is permanently dead, this behaviour causes a burst of retries
24671 every now and again, but only if messages routed to it are rare. If there is a
24672 message at least once every 7 days the retry data never expires.
24673
24674
24675
24676
24677 .section "Long-term failures" "SECID166"
24678 .cindex "delivery failure, long-term"
24679 .cindex "retry" "after long-term failure"
24680 Special processing happens when an email address has been failing for so long
24681 that the cutoff time for the last algorithm is reached. For example, using the
24682 default retry rule:
24683 .code
24684 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24685 .endd
24686 the cutoff time is four days. Reaching the retry cutoff is independent of how
24687 long any specific message has been failing; it is the length of continuous
24688 failure for the recipient address that counts.
24689
24690 When the cutoff time is reached for a local delivery, or for all the IP
24691 addresses associated with a remote delivery, a subsequent delivery failure
24692 causes Exim to give up on the address, and a bounce message is generated.
24693 In order to cater for new messages that use the failing address, a next retry
24694 time is still computed from the final algorithm, and is used as follows:
24695
24696 For local deliveries, one delivery attempt is always made for any subsequent
24697 messages. If this delivery fails, the address fails immediately. The
24698 post-cutoff retry time is not used.
24699
24700 If the delivery is remote, there are two possibilities, controlled by the
24701 .oindex "&%delay_after_cutoff%&"
24702 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24703 default. Until the post-cutoff retry time for one of the IP addresses is
24704 reached, the failing email address is bounced immediately, without a delivery
24705 attempt taking place. After that time, one new delivery attempt is made to
24706 those IP addresses that are past their retry times, and if that still fails,
24707 the address is bounced and new retry times are computed.
24708
24709 In other words, when all the hosts for a given email address have been failing
24710 for a long time, Exim bounces rather then defers until one of the hosts' retry
24711 times is reached. Then it tries once, and bounces if that attempt fails. This
24712 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24713 to a broken destination, but if the host does recover, Exim will eventually
24714 notice.
24715
24716 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24717 addresses are past their final cutoff time, Exim tries to deliver to those IP
24718 addresses that have not been tried since the message arrived. If there are
24719 no suitable IP addresses, or if they all fail, the address is bounced. In other
24720 words, it does not delay when a new message arrives, but tries the expired
24721 addresses immediately, unless they have been tried since the message arrived.
24722 If there is a continuous stream of messages for the failing domains, setting
24723 &%delay_after_cutoff%& false means that there will be many more attempts to
24724 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24725 true.
24726
24727 .section "Deliveries that work intermittently" "SECID167"
24728 .cindex "retry" "intermittently working deliveries"
24729 Some additional logic is needed to cope with cases where a host is
24730 intermittently available, or when a message has some attribute that prevents
24731 its delivery when others to the same address get through. In this situation,
24732 because some messages are successfully delivered, the &"retry clock"& for the
24733 host or address keeps getting reset by the successful deliveries, and so
24734 failing messages remain on the queue for ever because the cutoff time is never
24735 reached.
24736
24737 Two exceptional actions are applied to prevent this happening. The first
24738 applies to errors that are related to a message rather than a remote host.
24739 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24740 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24741 commands, and quota failures. For this type of error, if a message's arrival
24742 time is earlier than the &"first failed"& time for the error, the earlier time
24743 is used when scanning the retry rules to decide when to try next and when to
24744 time out the address.
24745
24746 The exceptional second action applies in all cases. If a message has been on
24747 the queue for longer than the cutoff time of any applicable retry rule for a
24748 given address, a delivery is attempted for that address, even if it is not yet
24749 time, and if this delivery fails, the address is timed out. A new retry time is
24750 not computed in this case, so that other messages for the same address are
24751 considered immediately.
24752 .ecindex IIDretconf1
24753 .ecindex IIDregconf2
24754
24755
24756
24757
24758
24759
24760 . ////////////////////////////////////////////////////////////////////////////
24761 . ////////////////////////////////////////////////////////////////////////////
24762
24763 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24764 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24765 .scindex IIDauthconf2 "authentication"
24766 The &"authenticators"& section of Exim's run time configuration is concerned
24767 with SMTP authentication. This facility is an extension to the SMTP protocol,
24768 described in RFC 2554, which allows a client SMTP host to authenticate itself
24769 to a server. This is a common way for a server to recognize clients that are
24770 permitted to use it as a relay. SMTP authentication is not of relevance to the
24771 transfer of mail between servers that have no managerial connection with each
24772 other.
24773
24774 .cindex "AUTH" "description of"
24775 Very briefly, the way SMTP authentication works is as follows:
24776
24777 .ilist
24778 The server advertises a number of authentication &'mechanisms'& in response to
24779 the client's EHLO command.
24780 .next
24781 The client issues an AUTH command, naming a specific mechanism. The command
24782 may, optionally, contain some authentication data.
24783 .next
24784 The server may issue one or more &'challenges'&, to which the client must send
24785 appropriate responses. In simple authentication mechanisms, the challenges are
24786 just prompts for user names and passwords. The server does not have to issue
24787 any challenges &-- in some mechanisms the relevant data may all be transmitted
24788 with the AUTH command.
24789 .next
24790 The server either accepts or denies authentication.
24791 .next
24792 If authentication succeeds, the client may optionally make use of the AUTH
24793 option on the MAIL command to pass an authenticated sender in subsequent
24794 mail transactions. Authentication lasts for the remainder of the SMTP
24795 connection.
24796 .next
24797 If authentication fails, the client may give up, or it may try a different
24798 authentication mechanism, or it may try transferring mail over the
24799 unauthenticated connection.
24800 .endlist
24801
24802 If you are setting up a client, and want to know which authentication
24803 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24804 SMTP port) on the server, and issue an EHLO command. The response to this
24805 includes the list of supported mechanisms. For example:
24806 .display
24807 &`$ `&&*&`telnet server.example 25`&*&
24808 &`Trying 192.168.34.25...`&
24809 &`Connected to server.example.`&
24810 &`Escape character is &#x0027;^]&#x0027;.`&
24811 &`220 server.example ESMTP Exim 4.20 ...`&
24812 &*&`ehlo client.example`&*&
24813 &`250-server.example Hello client.example [10.8.4.5]`&
24814 &`250-SIZE 52428800`&
24815 &`250-PIPELINING`&
24816 &`250-AUTH PLAIN`&
24817 &`250 HELP`&
24818 .endd
24819 The second-last line of this example output shows that the server supports
24820 authentication using the PLAIN mechanism. In Exim, the different authentication
24821 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24822 routers and transports, which authenticators are included in the binary is
24823 controlled by build-time definitions. The following are currently available,
24824 included by setting
24825 .code
24826 AUTH_CRAM_MD5=yes
24827 AUTH_CYRUS_SASL=yes
24828 AUTH_DOVECOT=yes
24829 AUTH_GSASL=yes
24830 AUTH_HEIMDAL_GSSAPI=yes
24831 AUTH_PLAINTEXT=yes
24832 AUTH_SPA=yes
24833 .endd
24834 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24835 authentication mechanism (RFC 2195), and the second provides an interface to
24836 the Cyrus SASL authentication library.
24837 The third is an interface to Dovecot's authentication system, delegating the
24838 work via a socket interface.
24839 The fourth provides an interface to the GNU SASL authentication library, which
24840 provides mechanisms but typically not data sources.
24841 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24842 supporting setting a server keytab.
24843 The sixth can be configured to support
24844 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24845 not formally documented, but used by several MUAs. The seventh authenticator
24846 supports Microsoft's &'Secure Password Authentication'& mechanism.
24847
24848 The authenticators are configured using the same syntax as other drivers (see
24849 section &<<SECTfordricon>>&). If no authenticators are required, no
24850 authentication section need be present in the configuration file. Each
24851 authenticator can in principle have both server and client functions. When Exim
24852 is receiving SMTP mail, it is acting as a server; when it is sending out
24853 messages over SMTP, it is acting as a client. Authenticator configuration
24854 options are provided for use in both these circumstances.
24855
24856 To make it clear which options apply to which situation, the prefixes
24857 &%server_%& and &%client_%& are used on option names that are specific to
24858 either the server or the client function, respectively. Server and client
24859 functions are disabled if none of their options are set. If an authenticator is
24860 to be used for both server and client functions, a single definition, using
24861 both sets of options, is required. For example:
24862 .code
24863 cram:
24864   driver = cram_md5
24865   public_name = CRAM-MD5
24866   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24867   client_name = ph10
24868   client_secret = secret2
24869 .endd
24870 The &%server_%& option is used when Exim is acting as a server, and the
24871 &%client_%& options when it is acting as a client.
24872
24873 Descriptions of the individual authenticators are given in subsequent chapters.
24874 The remainder of this chapter covers the generic options for the
24875 authenticators, followed by general discussion of the way authentication works
24876 in Exim.
24877
24878 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24879 per-mechanism basis.  Please read carefully to determine which variables hold
24880 account labels such as usercodes and which hold passwords or other
24881 authenticating data.
24882
24883 Note that some mechanisms support two different identifiers for accounts: the
24884 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24885 and &'authz'& are commonly encountered.  The American spelling is standard here.
24886 Conceptually, authentication data such as passwords are tied to the identifier
24887 used to authenticate; servers may have rules to permit one user to act as a
24888 second user, so that after login the session is treated as though that second
24889 user had logged in.  That second user is the &'authorization id'&.  A robust
24890 configuration might confirm that the &'authz'& field is empty or matches the
24891 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24892 as verified data, the &'authz'& as an unverified request which the server might
24893 choose to honour.
24894
24895 A &'realm'& is a text string, typically a domain name, presented by a server
24896 to a client to help it select an account and credentials to use.  In some
24897 mechanisms, the client and server provably agree on the realm, but clients
24898 typically can not treat the realm as secure data to be blindly trusted.
24899
24900
24901
24902 .section "Generic options for authenticators" "SECID168"
24903 .cindex "authentication" "generic options"
24904 .cindex "options" "generic; for authenticators"
24905
24906 .option client_condition authenticators string&!! unset
24907 When Exim is authenticating as a client, it skips any authenticator whose
24908 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24909 used, for example, to skip plain text authenticators when the connection is not
24910 encrypted by a setting such as:
24911 .code
24912 client_condition = ${if !eq{$tls_out_cipher}{}}
24913 .endd
24914
24915
24916 .option client_set_id authenticators string&!! unset
24917 When client authentication succeeds, this condition is expanded; the
24918 result is used in the log lines for outbound messasges.
24919 Typically it will be the user name used for authentication.
24920
24921
24922 .option driver authenticators string unset
24923 This option must always be set. It specifies which of the available
24924 authenticators is to be used.
24925
24926
24927 .option public_name authenticators string unset
24928 This option specifies the name of the authentication mechanism that the driver
24929 implements, and by which it is known to the outside world. These names should
24930 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24931 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24932 defaults to the driver's instance name.
24933
24934
24935 .option server_advertise_condition authenticators string&!! unset
24936 When a server is about to advertise an authentication mechanism, the condition
24937 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24938 mechanism is not advertised.
24939 If the expansion fails, the mechanism is not advertised. If the failure was not
24940 forced, and was not caused by a lookup defer, the incident is logged.
24941 See section &<<SECTauthexiser>>& below for further discussion.
24942
24943
24944 .option server_condition authenticators string&!! unset
24945 This option must be set for a &%plaintext%& server authenticator, where it
24946 is used directly to control authentication. See section &<<SECTplainserver>>&
24947 for details.
24948
24949 For the &(gsasl)& authenticator, this option is required for various
24950 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24951
24952 For the other authenticators, &%server_condition%& can be used as an additional
24953 authentication or authorization mechanism that is applied after the other
24954 authenticator conditions succeed. If it is set, it is expanded when the
24955 authenticator would otherwise return a success code. If the expansion is forced
24956 to fail, authentication fails. Any other expansion failure causes a temporary
24957 error code to be returned. If the result of a successful expansion is an empty
24958 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24959 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24960 other result, a temporary error code is returned, with the expanded string as
24961 the error text.
24962
24963
24964 .option server_debug_print authenticators string&!! unset
24965 If this option is set and authentication debugging is enabled (see the &%-d%&
24966 command line option), the string is expanded and included in the debugging
24967 output when the authenticator is run as a server. This can help with checking
24968 out the values of variables.
24969 If expansion of the string fails, the error message is written to the debugging
24970 output, and Exim carries on processing.
24971
24972
24973 .option server_set_id authenticators string&!! unset
24974 .vindex "&$authenticated_id$&"
24975 When an Exim server successfully authenticates a client, this string is
24976 expanded using data from the authentication, and preserved for any incoming
24977 messages in the variable &$authenticated_id$&. It is also included in the log
24978 lines for incoming messages. For example, a user/password authenticator
24979 configuration might preserve the user name that was used to authenticate, and
24980 refer to it subsequently during delivery of the message.
24981 If expansion fails, the option is ignored.
24982
24983
24984 .option server_mail_auth_condition authenticators string&!! unset
24985 This option allows a server to discard authenticated sender addresses supplied
24986 as part of MAIL commands in SMTP connections that are authenticated by the
24987 driver on which &%server_mail_auth_condition%& is set. The option is not used
24988 as part of the authentication process; instead its (unexpanded) value is
24989 remembered for later use.
24990 How it is used is described in the following section.
24991
24992
24993
24994
24995
24996 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24997 .cindex "authentication" "sender; authenticated"
24998 .cindex "AUTH" "on MAIL command"
24999 When a client supplied an AUTH= item on a MAIL command, Exim applies
25000 the following checks before accepting it as the authenticated sender of the
25001 message:
25002
25003 .ilist
25004 If the connection is not using extended SMTP (that is, HELO was used rather
25005 than EHLO), the use of AUTH= is a syntax error.
25006 .next
25007 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25008 .next
25009 .vindex "&$authenticated_sender$&"
25010 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25011 running, the value of &$authenticated_sender$& is set to the value obtained
25012 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25013 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25014 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25015 given for the MAIL command.
25016 .next
25017 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25018 is accepted and placed in &$authenticated_sender$& only if the client has
25019 authenticated.
25020 .next
25021 If the AUTH= value was accepted by either of the two previous rules, and
25022 the client has authenticated, and the authenticator has a setting for the
25023 &%server_mail_auth_condition%&, the condition is checked at this point. The
25024 valued that was saved from the authenticator is expanded. If the expansion
25025 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25026 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25027 the value of &$authenticated_sender$& is retained and passed on with the
25028 message.
25029 .endlist
25030
25031
25032 When &$authenticated_sender$& is set for a message, it is passed on to other
25033 hosts to which Exim authenticates as a client. Do not confuse this value with
25034 &$authenticated_id$&, which is a string obtained from the authentication
25035 process, and which is not usually a complete email address.
25036
25037 .vindex "&$sender_address$&"
25038 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25039 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25040 therefore make use of &$authenticated_sender$&. The converse is not true: the
25041 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25042 ACL is run.
25043
25044
25045
25046 .section "Authentication on an Exim server" "SECTauthexiser"
25047 .cindex "authentication" "on an Exim server"
25048 When Exim receives an EHLO command, it advertises the public names of those
25049 authenticators that are configured as servers, subject to the following
25050 conditions:
25051
25052 .ilist
25053 The client host must match &%auth_advertise_hosts%& (default *).
25054 .next
25055 It the &%server_advertise_condition%& option is set, its expansion must not
25056 yield the empty string, &"0"&, &"no"&, or &"false"&.
25057 .endlist
25058
25059 The order in which the authenticators are defined controls the order in which
25060 the mechanisms are advertised.
25061
25062 Some mail clients (for example, some versions of Netscape) require the user to
25063 provide a name and password for authentication whenever AUTH is advertised,
25064 even though authentication may not in fact be needed (for example, Exim may be
25065 set up to allow unconditional relaying from the client by an IP address check).
25066 You can make such clients more friendly by not advertising AUTH to them.
25067 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25068 that runs for RCPT) to relay without authentication, you should set
25069 .code
25070 auth_advertise_hosts = ! 10.9.8.0/24
25071 .endd
25072 so that no authentication mechanisms are advertised to them.
25073
25074 The &%server_advertise_condition%& controls the advertisement of individual
25075 authentication mechanisms. For example, it can be used to restrict the
25076 advertisement of a particular mechanism to encrypted connections, by a setting
25077 such as:
25078 .code
25079 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25080 .endd
25081 .vindex "&$tls_in_cipher$&"
25082 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25083 yields &"yes"&, which allows the advertisement to happen.
25084
25085 When an Exim server receives an AUTH command from a client, it rejects it
25086 immediately if AUTH was not advertised in response to an earlier EHLO
25087 command. This is the case if
25088
25089 .ilist
25090 The client host does not match &%auth_advertise_hosts%&; or
25091 .next
25092 No authenticators are configured with server options; or
25093 .next
25094 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25095 server authenticators.
25096 .endlist
25097
25098
25099 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25100 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25101 AUTH is accepted from any client host.
25102
25103 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25104 server authentication mechanism that was advertised in response to EHLO and
25105 that matches the one named in the AUTH command. If it finds one, it runs
25106 the appropriate authentication protocol, and authentication either succeeds or
25107 fails. If there is no matching advertised mechanism, the AUTH command is
25108 rejected with a 504 error.
25109
25110 .vindex "&$received_protocol$&"
25111 .vindex "&$sender_host_authenticated$&"
25112 When a message is received from an authenticated host, the value of
25113 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25114 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25115 public name) of the authenticator driver that successfully authenticated the
25116 client from which the message was received. This variable is empty if there was
25117 no successful authentication.
25118
25119
25120
25121
25122 .section "Testing server authentication" "SECID169"
25123 .cindex "authentication" "testing a server"
25124 .cindex "AUTH" "testing a server"
25125 .cindex "base64 encoding" "creating authentication test data"
25126 Exim's &%-bh%& option can be useful for testing server authentication
25127 configurations. The data for the AUTH command has to be sent using base64
25128 encoding. A quick way to produce such data for testing is the following Perl
25129 script:
25130 .code
25131 use MIME::Base64;
25132 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25133 .endd
25134 .cindex "binary zero" "in authentication data"
25135 This interprets its argument as a Perl string, and then encodes it. The
25136 interpretation as a Perl string allows binary zeros, which are required for
25137 some kinds of authentication, to be included in the data. For example, a
25138 command line to run this script on such data might be
25139 .code
25140 encode '\0user\0password'
25141 .endd
25142 Note the use of single quotes to prevent the shell interpreting the
25143 backslashes, so that they can be interpreted by Perl to specify characters
25144 whose code value is zero.
25145
25146 &*Warning 1*&: If either of the user or password strings starts with an octal
25147 digit, you must use three zeros instead of one after the leading backslash. If
25148 you do not, the octal digit that starts your string will be incorrectly
25149 interpreted as part of the code for the first character.
25150
25151 &*Warning 2*&: If there are characters in the strings that Perl interprets
25152 specially, you must use a Perl escape to prevent them being misinterpreted. For
25153 example, a command such as
25154 .code
25155 encode '\0user@domain.com\0pas$$word'
25156 .endd
25157 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25158
25159 If you have the &%mimencode%& command installed, another way to do produce
25160 base64-encoded strings is to run the command
25161 .code
25162 echo -e -n `\0user\0password' | mimencode
25163 .endd
25164 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25165 in the argument, and the &%-n%& option specifies no newline at the end of its
25166 output. However, not all versions of &%echo%& recognize these options, so you
25167 should check your version before relying on this suggestion.
25168
25169
25170
25171 .section "Authentication by an Exim client" "SECID170"
25172 .cindex "authentication" "on an Exim client"
25173 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25174 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25175 announces support for authentication, and the host matches an entry in either
25176 of these options, Exim (as a client) tries to authenticate as follows:
25177
25178 .ilist
25179 For each authenticator that is configured as a client, in the order in which
25180 they are defined in the configuration, it searches the authentication
25181 mechanisms announced by the server for one whose name matches the public name
25182 of the authenticator.
25183 .next
25184 .vindex "&$host$&"
25185 .vindex "&$host_address$&"
25186 When it finds one that matches, it runs the authenticator's client code. The
25187 variables &$host$& and &$host_address$& are available for any string expansions
25188 that the client might do. They are set to the server's name and IP address. If
25189 any expansion is forced to fail, the authentication attempt is abandoned, and
25190 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25191 delivery to be deferred.
25192 .next
25193 If the result of the authentication attempt is a temporary error or a timeout,
25194 Exim abandons trying to send the message to the host for the moment. It will
25195 try again later. If there are any backup hosts available, they are tried in the
25196 usual way.
25197 .next
25198 If the response to authentication is a permanent error (5&'xx'& code), Exim
25199 carries on searching the list of authenticators and tries another one if
25200 possible. If all authentication attempts give permanent errors, or if there are
25201 no attempts because no mechanisms match (or option expansions force failure),
25202 what happens depends on whether the host matches &%hosts_require_auth%& or
25203 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25204 delivery is deferred. The error can be detected in the retry rules, and thereby
25205 turned into a permanent error if you wish. In the second case, Exim tries to
25206 deliver the message unauthenticated.
25207 .endlist
25208
25209 .cindex "AUTH" "on MAIL command"
25210 When Exim has authenticated itself to a remote server, it adds the AUTH
25211 parameter to the MAIL commands it sends, if it has an authenticated sender for
25212 the message. If the message came from a remote host, the authenticated sender
25213 is the one that was receiving on an incoming MAIL command, provided that the
25214 incoming connection was authenticated and the &%server_mail_auth%& condition
25215 allowed the authenticated sender to be retained. If a local process calls Exim
25216 to send a message, the sender address that is built from the login name and
25217 &%qualify_domain%& is treated as authenticated. However, if the
25218 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25219 the authenticated sender that was received with the message.
25220 .ecindex IIDauthconf1
25221 .ecindex IIDauthconf2
25222
25223
25224
25225
25226
25227
25228 . ////////////////////////////////////////////////////////////////////////////
25229 . ////////////////////////////////////////////////////////////////////////////
25230
25231 .chapter "The plaintext authenticator" "CHAPplaintext"
25232 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25233 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25234 The &(plaintext)& authenticator can be configured to support the PLAIN and
25235 LOGIN authentication mechanisms, both of which transfer authentication data as
25236 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25237 security risk; you are strongly advised to insist on the use of SMTP encryption
25238 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25239 use unencrypted plain text, you should not use the same passwords for SMTP
25240 connections as you do for login accounts.
25241
25242 .section "Plaintext options" "SECID171"
25243 .cindex "options" "&(plaintext)& authenticator (server)"
25244 When configured as a server, &(plaintext)& uses the following options:
25245
25246 .option server_condition authenticators string&!! unset
25247 This is actually a global authentication option, but it must be set in order to
25248 configure the &(plaintext)& driver as a server. Its use is described below.
25249
25250 .option server_prompts plaintext string&!! unset
25251 The contents of this option, after expansion, must be a colon-separated list of
25252 prompt strings. If expansion fails, a temporary authentication rejection is
25253 given.
25254
25255 .section "Using plaintext in a server" "SECTplainserver"
25256 .cindex "AUTH" "in &(plaintext)& authenticator"
25257 .cindex "binary zero" "in &(plaintext)& authenticator"
25258 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25259         "in &(plaintext)& authenticator"
25260 .vindex "&$auth1$&, &$auth2$&, etc"
25261 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25262
25263 When running as a server, &(plaintext)& performs the authentication test by
25264 expanding a string. The data sent by the client with the AUTH command, or in
25265 response to subsequent prompts, is base64 encoded, and so may contain any byte
25266 values when decoded. If any data is supplied with the command, it is treated as
25267 a list of strings, separated by NULs (binary zeros), the first three of which
25268 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25269 (neither LOGIN nor PLAIN uses more than three strings).
25270
25271 For compatibility with previous releases of Exim, the values are also placed in
25272 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25273 variables for this purpose is now deprecated, as it can lead to confusion in
25274 string expansions that also use them for other things.
25275
25276 If there are more strings in &%server_prompts%& than the number of strings
25277 supplied with the AUTH command, the remaining prompts are used to obtain more
25278 data. Each response from the client may be a list of NUL-separated strings.
25279
25280 .vindex "&$authenticated_id$&"
25281 Once a sufficient number of data strings have been received,
25282 &%server_condition%& is expanded. If the expansion is forced to fail,
25283 authentication fails. Any other expansion failure causes a temporary error code
25284 to be returned. If the result of a successful expansion is an empty string,
25285 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25286 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25287 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25288 For any other result, a temporary error code is returned, with the expanded
25289 string as the error text
25290
25291 &*Warning*&: If you use a lookup in the expansion to find the user's
25292 password, be sure to make the authentication fail if the user is unknown.
25293 There are good and bad examples at the end of the next section.
25294
25295
25296
25297 .section "The PLAIN authentication mechanism" "SECID172"
25298 .cindex "PLAIN authentication mechanism"
25299 .cindex "authentication" "PLAIN mechanism"
25300 .cindex "binary zero" "in &(plaintext)& authenticator"
25301 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25302 sent as one item of data (that is, one combined string containing two NUL
25303 separators). The data is sent either as part of the AUTH command, or
25304 subsequently in response to an empty prompt from the server.
25305
25306 The second and third strings are a user name and a corresponding password.
25307 Using a single fixed user name and password as an example, this could be
25308 configured as follows:
25309 .code
25310 fixed_plain:
25311   driver = plaintext
25312   public_name = PLAIN
25313   server_prompts = :
25314   server_condition = \
25315     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25316   server_set_id = $auth2
25317 .endd
25318 Note that the default result strings from &%if%& (&"true"& or an empty string)
25319 are exactly what we want here, so they need not be specified. Obviously, if the
25320 password contains expansion-significant characters such as dollar, backslash,
25321 or closing brace, they have to be escaped.
25322
25323 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25324 the end of a string list are ignored). If all the data comes as part of the
25325 AUTH command, as is commonly the case, the prompt is not used. This
25326 authenticator is advertised in the response to EHLO as
25327 .code
25328 250-AUTH PLAIN
25329 .endd
25330 and a client host can authenticate itself by sending the command
25331 .code
25332 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25333 .endd
25334 As this contains three strings (more than the number of prompts), no further
25335 data is required from the client. Alternatively, the client may just send
25336 .code
25337 AUTH PLAIN
25338 .endd
25339 to initiate authentication, in which case the server replies with an empty
25340 prompt. The client must respond with the combined data string.
25341
25342 The data string is base64 encoded, as required by the RFC. This example,
25343 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25344 represents a zero byte. This is split up into three strings, the first of which
25345 is empty. The &%server_condition%& option in the authenticator checks that the
25346 second two are &`username`& and &`mysecret`& respectively.
25347
25348 Having just one fixed user name and password, as in this example, is not very
25349 realistic, though for a small organization with only a handful of
25350 authenticating clients it could make sense.
25351
25352 A more sophisticated instance of this authenticator could use the user name in
25353 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25354 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25355 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25356 This is an incorrect example:
25357 .code
25358 server_condition = \
25359   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25360 .endd
25361 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25362 which it then compares to the supplied password (&$auth3$&). Why is this example
25363 incorrect? It works fine for existing users, but consider what happens if a
25364 non-existent user name is given. The lookup fails, but as no success/failure
25365 strings are given for the lookup, it yields an empty string. Thus, to defeat
25366 the authentication, all a client has to do is to supply a non-existent user
25367 name and an empty password. The correct way of writing this test is:
25368 .code
25369 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25370   {${if eq{$value}{$auth3}}} {false}}
25371 .endd
25372 In this case, if the lookup succeeds, the result is checked; if the lookup
25373 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25374 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25375 always fails if its second argument is empty. However, the second way of
25376 writing the test makes the logic clearer.
25377
25378
25379 .section "The LOGIN authentication mechanism" "SECID173"
25380 .cindex "LOGIN authentication mechanism"
25381 .cindex "authentication" "LOGIN mechanism"
25382 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25383 in a number of programs. No data is sent with the AUTH command. Instead, a
25384 user name and password are supplied separately, in response to prompts. The
25385 plaintext authenticator can be configured to support this as in this example:
25386 .code
25387 fixed_login:
25388   driver = plaintext
25389   public_name = LOGIN
25390   server_prompts = User Name : Password
25391   server_condition = \
25392     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25393   server_set_id = $auth1
25394 .endd
25395 Because of the way plaintext operates, this authenticator accepts data supplied
25396 with the AUTH command (in contravention of the specification of LOGIN), but
25397 if the client does not supply it (as is the case for LOGIN clients), the prompt
25398 strings are used to obtain two data items.
25399
25400 Some clients are very particular about the precise text of the prompts. For
25401 example, Outlook Express is reported to recognize only &"Username:"& and
25402 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25403 strings. It uses the &%ldapauth%& expansion condition to check the user
25404 name and password by binding to an LDAP server:
25405 .code
25406 login:
25407   driver = plaintext
25408   public_name = LOGIN
25409   server_prompts = Username:: : Password::
25410   server_condition = ${if and{{ \
25411     !eq{}{$auth1} }{ \
25412     ldapauth{\
25413       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25414       pass=${quote:$auth2} \
25415       ldap://ldap.example.org/} }} }
25416   server_set_id = uid=$auth1,ou=people,o=example.org
25417 .endd
25418 We have to check that the username is not empty before using it, because LDAP
25419 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25420 operator to correctly quote the DN for authentication. However, the basic
25421 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25422 correct one to use for the password, because quoting is needed only to make
25423 the password conform to the Exim syntax. At the LDAP level, the password is an
25424 uninterpreted string.
25425
25426
25427 .section "Support for different kinds of authentication" "SECID174"
25428 A number of string expansion features are provided for the purpose of
25429 interfacing to different ways of user authentication. These include checking
25430 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25431 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25432 &<<SECTexpcond>>&.
25433
25434
25435
25436
25437 .section "Using plaintext in a client" "SECID175"
25438 .cindex "options" "&(plaintext)& authenticator (client)"
25439 The &(plaintext)& authenticator has two client options:
25440
25441 .option client_ignore_invalid_base64 plaintext boolean false
25442 If the client receives a server prompt that is not a valid base64 string,
25443 authentication is abandoned by default. However, if this option is set true,
25444 the error in the challenge is ignored and the client sends the response as
25445 usual.
25446
25447 .option client_send plaintext string&!! unset
25448 The string is a colon-separated list of authentication data strings. Each
25449 string is independently expanded before being sent to the server. The first
25450 string is sent with the AUTH command; any more strings are sent in response
25451 to prompts from the server. Before each string is expanded, the value of the
25452 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25453 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25454 way. Thus, the prompt that is received in response to sending the first string
25455 (with the AUTH command) can be used in the expansion of the second string, and
25456 so on. If an invalid base64 string is received when
25457 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25458 &$auth$&<&'n'&> variable.
25459
25460 &*Note*&: You cannot use expansion to create multiple strings, because
25461 splitting takes priority and happens first.
25462
25463 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25464 the data, further processing is applied to each string before it is sent. If
25465 there are any single circumflex characters in the string, they are converted to
25466 NULs. Should an actual circumflex be required as data, it must be doubled in
25467 the string.
25468
25469 This is an example of a client configuration that implements the PLAIN
25470 authentication mechanism with a fixed user name and password:
25471 .code
25472 fixed_plain:
25473   driver = plaintext
25474   public_name = PLAIN
25475   client_send = ^username^mysecret
25476 .endd
25477 The lack of colons means that the entire text is sent with the AUTH
25478 command, with the circumflex characters converted to NULs. A similar example
25479 that uses the LOGIN mechanism is:
25480 .code
25481 fixed_login:
25482   driver = plaintext
25483   public_name = LOGIN
25484   client_send = : username : mysecret
25485 .endd
25486 The initial colon means that the first string is empty, so no data is sent with
25487 the AUTH command itself. The remaining strings are sent in response to
25488 prompts.
25489 .ecindex IIDplaiauth1
25490 .ecindex IIDplaiauth2
25491
25492
25493
25494
25495 . ////////////////////////////////////////////////////////////////////////////
25496 . ////////////////////////////////////////////////////////////////////////////
25497
25498 .chapter "The cram_md5 authenticator" "CHID9"
25499 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25500 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25501 .cindex "CRAM-MD5 authentication mechanism"
25502 .cindex "authentication" "CRAM-MD5 mechanism"
25503 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25504 sends a challenge string to the client, and the response consists of a user
25505 name and the CRAM-MD5 digest of the challenge string combined with a secret
25506 string (password) which is known to both server and client. Thus, the secret
25507 is not sent over the network as plain text, which makes this authenticator more
25508 secure than &(plaintext)&. However, the downside is that the secret has to be
25509 available in plain text at either end.
25510
25511
25512 .section "Using cram_md5 as a server" "SECID176"
25513 .cindex "options" "&(cram_md5)& authenticator (server)"
25514 This authenticator has one server option, which must be set to configure the
25515 authenticator as a server:
25516
25517 .option server_secret cram_md5 string&!! unset
25518 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25519 When the server receives the client's response, the user name is placed in
25520 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25521 obtain the password for that user. The server then computes the CRAM-MD5 digest
25522 that the client should have sent, and checks that it received the correct
25523 string. If the expansion of &%server_secret%& is forced to fail, authentication
25524 fails. If the expansion fails for some other reason, a temporary error code is
25525 returned to the client.
25526
25527 For compatibility with previous releases of Exim, the user name is also placed
25528 in &$1$&. However, the use of this variables for this purpose is now
25529 deprecated, as it can lead to confusion in string expansions that also use
25530 numeric variables for other things.
25531
25532 For example, the following authenticator checks that the user name given by the
25533 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25534 user name, authentication fails.
25535 .code
25536 fixed_cram:
25537   driver = cram_md5
25538   public_name = CRAM-MD5
25539   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25540   server_set_id = $auth1
25541 .endd
25542 .vindex "&$authenticated_id$&"
25543 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25544 name in &$authenticated_id$&. A more typical configuration might look up the
25545 secret string in a file, using the user name as the key. For example:
25546 .code
25547 lookup_cram:
25548   driver = cram_md5
25549   public_name = CRAM-MD5
25550   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25551                   {$value}fail}
25552   server_set_id = $auth1
25553 .endd
25554 Note that this expansion explicitly forces failure if the lookup fails
25555 because &$auth1$& contains an unknown user name.
25556
25557 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25558 using the relevant libraries, you need to know the realm to specify in the
25559 lookup and then ask for the &"userPassword"& attribute for that user in that
25560 realm, with:
25561 .code
25562 cyrusless_crammd5:
25563   driver = cram_md5
25564   public_name = CRAM-MD5
25565   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25566                   dbmjz{/etc/sasldb2}}
25567   server_set_id = $auth1
25568 .endd
25569
25570 .section "Using cram_md5 as a client" "SECID177"
25571 .cindex "options" "&(cram_md5)& authenticator (client)"
25572 When used as a client, the &(cram_md5)& authenticator has two options:
25573
25574
25575
25576 .option client_name cram_md5 string&!! "the primary host name"
25577 This string is expanded, and the result used as the user name data when
25578 computing the response to the server's challenge.
25579
25580
25581 .option client_secret cram_md5 string&!! unset
25582 This option must be set for the authenticator to work as a client. Its value is
25583 expanded and the result used as the secret string when computing the response.
25584
25585
25586 .vindex "&$host$&"
25587 .vindex "&$host_address$&"
25588 Different user names and secrets can be used for different servers by referring
25589 to &$host$& or &$host_address$& in the options. Forced failure of either
25590 expansion string is treated as an indication that this authenticator is not
25591 prepared to handle this case. Exim moves on to the next configured client
25592 authenticator. Any other expansion failure causes Exim to give up trying to
25593 send the message to the current server.
25594
25595 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25596 strings, is:
25597 .code
25598 fixed_cram:
25599   driver = cram_md5
25600   public_name = CRAM-MD5
25601   client_name = ph10
25602   client_secret = secret
25603 .endd
25604 .ecindex IIDcramauth1
25605 .ecindex IIDcramauth2
25606
25607
25608
25609 . ////////////////////////////////////////////////////////////////////////////
25610 . ////////////////////////////////////////////////////////////////////////////
25611
25612 .chapter "The cyrus_sasl authenticator" "CHID10"
25613 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25614 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25615 .cindex "Cyrus" "SASL library"
25616 .cindex "Kerberos"
25617 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25618 Digital Ltd (&url(http://www.aldigital.co.uk)).
25619
25620 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25621 library implementation of the RFC 2222 (&"Simple Authentication and Security
25622 Layer"&). This library supports a number of authentication mechanisms,
25623 including PLAIN and LOGIN, but also several others that Exim does not support
25624 directly. In particular, there is support for Kerberos authentication.
25625
25626 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25627 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25628 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25629 name of the driver to determine which mechanism to support.
25630
25631 Where access to some kind of secret file is required, for example in GSSAPI
25632 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25633 user, and that the Cyrus SASL library has no way of escalating privileges
25634 by default. You may also find you need to set environment variables,
25635 depending on the driver you are using.
25636
25637 The application name provided by Exim is &"exim"&, so various SASL options may
25638 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25639 Kerberos, note that because of limitations in the GSSAPI interface,
25640 changing the server keytab might need to be communicated down to the Kerberos
25641 layer independently. The mechanism for doing so is dependent upon the Kerberos
25642 implementation.
25643
25644 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25645 may be set to point to an alternative keytab file. Exim will pass this
25646 variable through from its own inherited environment when started as root or the
25647 Exim user. The keytab file needs to be readable by the Exim user.
25648 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25649 environment variable.  In practice, for those releases, the Cyrus authenticator
25650 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25651 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25652
25653
25654 .section "Using cyrus_sasl as a server" "SECID178"
25655 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25656 (on a successful authentication) into &$auth1$&. For compatibility with
25657 previous releases of Exim, the username is also placed in &$1$&. However, the
25658 use of this variable for this purpose is now deprecated, as it can lead to
25659 confusion in string expansions that also use numeric variables for other
25660 things.
25661
25662
25663 .option server_hostname cyrus_sasl string&!! "see below"
25664 This option selects the hostname that is used when communicating with the
25665 library. The default value is &`$primary_hostname`&. It is up to the underlying
25666 SASL plug-in what it does with this data.
25667
25668
25669 .option server_mech cyrus_sasl string "see below"
25670 This option selects the authentication mechanism this driver should use. The
25671 default is the value of the generic &%public_name%& option. This option allows
25672 you to use a different underlying mechanism from the advertised name. For
25673 example:
25674 .code
25675 sasl:
25676   driver = cyrus_sasl
25677   public_name = X-ANYTHING
25678   server_mech = CRAM-MD5
25679   server_set_id = $auth1
25680 .endd
25681
25682 .option server_realm cyrus_sasl string&!! unset
25683 This specifies the SASL realm that the server claims to be in.
25684
25685
25686 .option server_service cyrus_sasl string &`smtp`&
25687 This is the SASL service that the server claims to implement.
25688
25689
25690 For straightforward cases, you do not need to set any of the authenticator's
25691 private options. All you need to do is to specify an appropriate mechanism as
25692 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25693 PLAIN, you could have two authenticators as follows:
25694 .code
25695 sasl_cram_md5:
25696   driver = cyrus_sasl
25697   public_name = CRAM-MD5
25698   server_set_id = $auth1
25699
25700 sasl_plain:
25701   driver = cyrus_sasl
25702   public_name = PLAIN
25703   server_set_id = $auth2
25704 .endd
25705 Cyrus SASL does implement the LOGIN authentication method, even though it is
25706 not a standard method. It is disabled by default in the source distribution,
25707 but it is present in many binary distributions.
25708 .ecindex IIDcyrauth1
25709 .ecindex IIDcyrauth2
25710
25711
25712
25713
25714 . ////////////////////////////////////////////////////////////////////////////
25715 . ////////////////////////////////////////////////////////////////////////////
25716 .chapter "The dovecot authenticator" "CHAPdovecot"
25717 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25718 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25719 This authenticator is an interface to the authentication facility of the
25720 Dovecot POP/IMAP server, which can support a number of authentication methods.
25721 Note that Dovecot must be configured to use auth-client not auth-userdb.
25722 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25723 to use the same mechanisms for SMTP authentication. This is a server
25724 authenticator only. There is only one option:
25725
25726 .option server_socket dovecot string unset
25727
25728 This option must specify the socket that is the interface to Dovecot
25729 authentication. The &%public_name%& option must specify an authentication
25730 mechanism that Dovecot is configured to support. You can have several
25731 authenticators for different mechanisms. For example:
25732 .code
25733 dovecot_plain:
25734   driver = dovecot
25735   public_name = PLAIN
25736   server_socket = /var/run/dovecot/auth-client
25737   server_set_id = $auth1
25738
25739 dovecot_ntlm:
25740   driver = dovecot
25741   public_name = NTLM
25742   server_socket = /var/run/dovecot/auth-client
25743   server_set_id = $auth1
25744 .endd
25745 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25746 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25747 option is passed in the Dovecot authentication command. If, for a TLS
25748 connection, a client certificate has been verified, the &"valid-client-cert"&
25749 option is passed. When authentication succeeds, the identity of the user
25750 who authenticated is placed in &$auth1$&.
25751 .ecindex IIDdcotauth1
25752 .ecindex IIDdcotauth2
25753
25754
25755 . ////////////////////////////////////////////////////////////////////////////
25756 . ////////////////////////////////////////////////////////////////////////////
25757 .chapter "The gsasl authenticator" "CHAPgsasl"
25758 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25759 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25760 .cindex "authentication" "GNU SASL"
25761 .cindex "authentication" "SASL"
25762 .cindex "authentication" "EXTERNAL"
25763 .cindex "authentication" "ANONYMOUS"
25764 .cindex "authentication" "PLAIN"
25765 .cindex "authentication" "LOGIN"
25766 .cindex "authentication" "DIGEST-MD5"
25767 .cindex "authentication" "CRAM-MD5"
25768 .cindex "authentication" "SCRAM-SHA-1"
25769 The &(gsasl)& authenticator provides server integration for the GNU SASL
25770 library and the mechanisms it provides.  This is new as of the 4.80 release
25771 and there are a few areas where the library does not let Exim smoothly
25772 scale to handle future authentication mechanisms, so no guarantee can be
25773 made that any particular new authentication mechanism will be supported
25774 without code changes in Exim.
25775
25776
25777 .option server_channelbinding gsasl boolean false
25778 Some authentication mechanisms are able to use external context at both ends
25779 of the session to bind the authentication to that context, and fail the
25780 authentication process if that context differs.  Specifically, some TLS
25781 ciphersuites can provide identifying information about the cryptographic
25782 context.
25783
25784 This means that certificate identity and verification becomes a non-issue,
25785 as a man-in-the-middle attack will cause the correct client and server to
25786 see different identifiers and authentication will fail.
25787
25788 This is currently only supported when using the GnuTLS library.  This is
25789 only usable by mechanisms which support "channel binding"; at time of
25790 writing, that's the SCRAM family.
25791
25792 This defaults off to ensure smooth upgrade across Exim releases, in case
25793 this option causes some clients to start failing.  Some future release
25794 of Exim may switch the default to be true.
25795
25796
25797 .option server_hostname gsasl string&!! "see below"
25798 This option selects the hostname that is used when communicating with the
25799 library. The default value is &`$primary_hostname`&.
25800 Some mechanisms will use this data.
25801
25802
25803 .option server_mech gsasl string "see below"
25804 This option selects the authentication mechanism this driver should use. The
25805 default is the value of the generic &%public_name%& option. This option allows
25806 you to use a different underlying mechanism from the advertised name. For
25807 example:
25808 .code
25809 sasl:
25810   driver = gsasl
25811   public_name = X-ANYTHING
25812   server_mech = CRAM-MD5
25813   server_set_id = $auth1
25814 .endd
25815
25816
25817 .option server_password gsasl string&!! unset
25818 Various mechanisms need access to the cleartext password on the server, so
25819 that proof-of-possession can be demonstrated on the wire, without sending
25820 the password itself.
25821
25822 The data available for lookup varies per mechanism.
25823 In all cases, &$auth1$& is set to the &'authentication id'&.
25824 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25825 if available, else the empty string.
25826 The &$auth3$& variable will always be the &'realm'& if available,
25827 else the empty string.
25828
25829 A forced failure will cause authentication to defer.
25830
25831 If using this option, it may make sense to set the &%server_condition%&
25832 option to be simply "true".
25833
25834
25835 .option server_realm gsasl string&!! unset
25836 This specifies the SASL realm that the server claims to be in.
25837 Some mechanisms will use this data.
25838
25839
25840 .option server_scram_iter gsasl string&!! unset
25841 This option provides data for the SCRAM family of mechanisms.
25842 &$auth1$& is not available at evaluation time.
25843 (This may change, as we receive feedback on use)
25844
25845
25846 .option server_scram_salt gsasl string&!! unset
25847 This option provides data for the SCRAM family of mechanisms.
25848 &$auth1$& is not available at evaluation time.
25849 (This may change, as we receive feedback on use)
25850
25851
25852 .option server_service gsasl string &`smtp`&
25853 This is the SASL service that the server claims to implement.
25854 Some mechanisms will use this data.
25855
25856
25857 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25858 .vindex "&$auth1$&, &$auth2$&, etc"
25859 These may be set when evaluating specific options, as detailed above.
25860 They will also be set when evaluating &%server_condition%&.
25861
25862 Unless otherwise stated below, the &(gsasl)& integration will use the following
25863 meanings for these variables:
25864
25865 .ilist
25866 .vindex "&$auth1$&"
25867 &$auth1$&: the &'authentication id'&
25868 .next
25869 .vindex "&$auth2$&"
25870 &$auth2$&: the &'authorization id'&
25871 .next
25872 .vindex "&$auth3$&"
25873 &$auth3$&: the &'realm'&
25874 .endlist
25875
25876 On a per-mechanism basis:
25877
25878 .ilist
25879 .cindex "authentication" "EXTERNAL"
25880 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25881 the &%server_condition%& option must be present.
25882 .next
25883 .cindex "authentication" "ANONYMOUS"
25884 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25885 the &%server_condition%& option must be present.
25886 .next
25887 .cindex "authentication" "GSSAPI"
25888 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25889 &$auth2$& will be set to the &'authorization id'&,
25890 the &%server_condition%& option must be present.
25891 .endlist
25892
25893 An &'anonymous token'& is something passed along as an unauthenticated
25894 identifier; this is analogous to FTP anonymous authentication passing an
25895 email address, or software-identifier@, as the "password".
25896
25897
25898 An example showing the password having the realm specified in the callback
25899 and demonstrating a Cyrus SASL to GSASL migration approach is:
25900 .code
25901 gsasl_cyrusless_crammd5:
25902   driver = gsasl
25903   public_name = CRAM-MD5
25904   server_realm = imap.example.org
25905   server_password = ${lookup{$auth1:$auth3:userPassword}\
25906                     dbmjz{/etc/sasldb2}{$value}fail}
25907   server_set_id = ${quote:$auth1}
25908   server_condition = yes
25909 .endd
25910
25911
25912 . ////////////////////////////////////////////////////////////////////////////
25913 . ////////////////////////////////////////////////////////////////////////////
25914
25915 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25916 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25917 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25918 .cindex "authentication" "GSSAPI"
25919 .cindex "authentication" "Kerberos"
25920 The &(heimdal_gssapi)& authenticator provides server integration for the
25921 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25922 reliably.
25923
25924 .option server_hostname heimdal_gssapi string&!! "see below"
25925 This option selects the hostname that is used, with &%server_service%&,
25926 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25927 identifier.  The default value is &`$primary_hostname`&.
25928
25929 .option server_keytab heimdal_gssapi string&!! unset
25930 If set, then Heimdal will not use the system default keytab (typically
25931 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25932 The value should be a pathname, with no &"file:"& prefix.
25933
25934 .option server_service heimdal_gssapi string&!! "smtp"
25935 This option specifies the service identifier used, in conjunction with
25936 &%server_hostname%&, for building the identifer for finding credentials
25937 from the keytab.
25938
25939
25940 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25941 Beware that these variables will typically include a realm, thus will appear
25942 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25943 not verified, so a malicious client can set it to anything.
25944
25945 The &$auth1$& field should be safely trustable as a value from the Key
25946 Distribution Center.  Note that these are not quite email addresses.
25947 Each identifier is for a role, and so the left-hand-side may include a
25948 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25949
25950 .vindex "&$auth1$&, &$auth2$&, etc"
25951 .ilist
25952 .vindex "&$auth1$&"
25953 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25954 .next
25955 .vindex "&$auth2$&"
25956 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25957 authentication.  If that was empty, this will also be set to the
25958 GSS Display Name.
25959 .endlist
25960
25961
25962 . ////////////////////////////////////////////////////////////////////////////
25963 . ////////////////////////////////////////////////////////////////////////////
25964
25965 .chapter "The spa authenticator" "CHAPspa"
25966 .scindex IIDspaauth1 "&(spa)& authenticator"
25967 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25968 .cindex "authentication" "Microsoft Secure Password"
25969 .cindex "authentication" "NTLM"
25970 .cindex "Microsoft Secure Password Authentication"
25971 .cindex "NTLM authentication"
25972 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25973 Password Authentication'& mechanism,
25974 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25975 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25976 taken from the Samba project (&url(http://www.samba.org)). The code for the
25977 server side was subsequently contributed by Tom Kistner. The mechanism works as
25978 follows:
25979
25980 .ilist
25981 After the AUTH command has been accepted, the client sends an SPA
25982 authentication request based on the user name and optional domain.
25983 .next
25984 The server sends back a challenge.
25985 .next
25986 The client builds a challenge response which makes use of the user's password
25987 and sends it to the server, which then accepts or rejects it.
25988 .endlist
25989
25990 Encryption is used to protect the password in transit.
25991
25992
25993
25994 .section "Using spa as a server" "SECID179"
25995 .cindex "options" "&(spa)& authenticator (server)"
25996 The &(spa)& authenticator has just one server option:
25997
25998 .option server_password spa string&!! unset
25999 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26000 This option is expanded, and the result must be the cleartext password for the
26001 authenticating user, whose name is at this point in &$auth1$&. For
26002 compatibility with previous releases of Exim, the user name is also placed in
26003 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26004 it can lead to confusion in string expansions that also use numeric variables
26005 for other things. For example:
26006 .code
26007 spa:
26008   driver = spa
26009   public_name = NTLM
26010   server_password = \
26011     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26012 .endd
26013 If the expansion is forced to fail, authentication fails. Any other expansion
26014 failure causes a temporary error code to be returned.
26015
26016
26017
26018
26019
26020 .section "Using spa as a client" "SECID180"
26021 .cindex "options" "&(spa)& authenticator (client)"
26022 The &(spa)& authenticator has the following client options:
26023
26024
26025
26026 .option client_domain spa string&!! unset
26027 This option specifies an optional domain for the authentication.
26028
26029
26030 .option client_password spa string&!! unset
26031 This option specifies the user's password, and must be set.
26032
26033
26034 .option client_username spa string&!! unset
26035 This option specifies the user name, and must be set. Here is an example of a
26036 configuration of this authenticator for use with the mail servers at
26037 &'msn.com'&:
26038 .code
26039 msn:
26040   driver = spa
26041   public_name = MSN
26042   client_username = msn/msn_username
26043   client_password = msn_plaintext_password
26044   client_domain = DOMAIN_OR_UNSET
26045 .endd
26046 .ecindex IIDspaauth1
26047 .ecindex IIDspaauth2
26048
26049
26050
26051
26052
26053 . ////////////////////////////////////////////////////////////////////////////
26054 . ////////////////////////////////////////////////////////////////////////////
26055
26056 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26057          "Encrypted SMTP connections"
26058 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26059 .scindex IIDencsmtp2 "SMTP" "encryption"
26060 .cindex "TLS" "on SMTP connection"
26061 .cindex "OpenSSL"
26062 .cindex "GnuTLS"
26063 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26064 Sockets Layer), is implemented by making use of the OpenSSL library or the
26065 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26066 cryptographic code in the Exim distribution itself for implementing TLS. In
26067 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26068 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26069 You also need to understand the basic concepts of encryption at a managerial
26070 level, and in particular, the way that public keys, private keys, and
26071 certificates are used.
26072
26073 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26074 connection is established, the client issues a STARTTLS command. If the
26075 server accepts this, the client and the server negotiate an encryption
26076 mechanism. If the negotiation succeeds, the data that subsequently passes
26077 between them is encrypted.
26078
26079 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26080 and if so, what cipher suite is in use, whether the client supplied a
26081 certificate, and whether or not that certificate was verified. This makes it
26082 possible for an Exim server to deny or accept certain commands based on the
26083 encryption state.
26084
26085 &*Warning*&: Certain types of firewall and certain anti-virus products can
26086 disrupt TLS connections. You need to turn off SMTP scanning for these products
26087 in order to get TLS to work.
26088
26089
26090
26091 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26092          "SECID284"
26093 .cindex "ssmtp protocol"
26094 .cindex "smtps protocol"
26095 .cindex "SMTP" "ssmtp protocol"
26096 .cindex "SMTP" "smtps protocol"
26097 Early implementations of encrypted SMTP used a different TCP port from normal
26098 SMTP, and expected an encryption negotiation to start immediately, instead of
26099 waiting for a STARTTLS command from the client using the standard SMTP
26100 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26101 allocated for this purpose.
26102
26103 This approach was abandoned when encrypted SMTP was standardized, but there are
26104 still some legacy clients that use it. Exim supports these clients by means of
26105 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26106 numbers; the most common use is expected to be:
26107 .code
26108 tls_on_connect_ports = 465
26109 .endd
26110 The port numbers specified by this option apply to all SMTP connections, both
26111 via the daemon and via &'inetd'&. You still need to specify all the ports that
26112 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26113 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26114 an extra port &-- rather, it specifies different behaviour on a port that is
26115 defined elsewhere.
26116
26117 There is also a &%-tls-on-connect%& command line option. This overrides
26118 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26119
26120
26121
26122
26123
26124
26125 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26126 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26127 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26128 followed later, when the first versions of GnuTLS were released. To build Exim
26129 to use GnuTLS, you need to set
26130 .code
26131 USE_GNUTLS=yes
26132 .endd
26133 in Local/Makefile, in addition to
26134 .code
26135 SUPPORT_TLS=yes
26136 .endd
26137 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26138 include files and libraries for GnuTLS can be found.
26139
26140 There are some differences in usage when using GnuTLS instead of OpenSSL:
26141
26142 .ilist
26143 The &%tls_verify_certificates%& option
26144 cannot be the path of a directory
26145 for GnuTLS versions before 3.3.6
26146 (for later versions, or OpenSSL, it can be either).
26147 .next
26148 The default value for &%tls_dhparam%& differs for historical reasons.
26149 .next
26150 .vindex "&$tls_in_peerdn$&"
26151 .vindex "&$tls_out_peerdn$&"
26152 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26153 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26154 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26155 .next
26156 OpenSSL identifies cipher suites using hyphens as separators, for example:
26157 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26158 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26159 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26160 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26161 to handle its own older variants) when processing lists of cipher suites in the
26162 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26163 option).
26164 .next
26165 The &%tls_require_ciphers%& options operate differently, as described in the
26166 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26167 .next
26168 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26169 When using OpenSSL, this option is ignored.
26170 (If an API is found to let OpenSSL be configured in this way,
26171 let the Exim Maintainers know and we'll likely use it).
26172 .next
26173 Some other recently added features may only be available in one or the other.
26174 This should be documented with the feature.  If the documentation does not
26175 explicitly state that the feature is infeasible in the other TLS
26176 implementation, then patches are welcome.
26177 .endlist
26178
26179
26180 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26181 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26182 an explicit path; if the latter, then the text about generation still applies,
26183 but not the chosen filename.
26184 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26185 See the documentation of &%tls_dhparam%& for more information.
26186
26187 GnuTLS uses D-H parameters that may take a substantial amount of time
26188 to compute. It is unreasonable to re-compute them for every TLS session.
26189 Therefore, Exim keeps this data in a file in its spool directory, called
26190 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26191 of bits requested.
26192 The file is owned by the Exim user and is readable only by
26193 its owner. Every Exim process that start up GnuTLS reads the D-H
26194 parameters from this file. If the file does not exist, the first Exim process
26195 that needs it computes the data and writes it to a temporary file which is
26196 renamed once it is complete. It does not matter if several Exim processes do
26197 this simultaneously (apart from wasting a few resources). Once a file is in
26198 place, new Exim processes immediately start using it.
26199
26200 For maximum security, the parameters that are stored in this file should be
26201 recalculated periodically, the frequency depending on your paranoia level.
26202 If you are avoiding using the fixed D-H primes published in RFCs, then you
26203 are concerned about some advanced attacks and will wish to do this; if you do
26204 not regenerate then you might as well stick to the standard primes.
26205
26206 Arranging this is easy in principle; just delete the file when you want new
26207 values to be computed. However, there may be a problem. The calculation of new
26208 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26209 If the system is not very active, &_/dev/random_& may delay returning data
26210 until enough randomness (entropy) is available. This may cause Exim to hang for
26211 a substantial amount of time, causing timeouts on incoming connections.
26212
26213 The solution is to generate the parameters externally to Exim. They are stored
26214 in &_gnutls-params-N_& in PEM format, which means that they can be
26215 generated externally using the &(certtool)& command that is part of GnuTLS.
26216
26217 To replace the parameters with new ones, instead of deleting the file
26218 and letting Exim re-create it, you can generate new parameters using
26219 &(certtool)& and, when this has been done, replace Exim's cache file by
26220 renaming. The relevant commands are something like this:
26221 .code
26222 # ls
26223 [ look for file; assume gnutls-params-2236 is the most recent ]
26224 # rm -f new-params
26225 # touch new-params
26226 # chown exim:exim new-params
26227 # chmod 0600 new-params
26228 # certtool --generate-dh-params --bits 2236 >>new-params
26229 # openssl dhparam -noout -text -in new-params | head
26230 [ check the first line, make sure it's not more than 2236;
26231   if it is, then go back to the start ("rm") and repeat
26232   until the size generated is at most the size requested ]
26233 # chmod 0400 new-params
26234 # mv new-params gnutls-params-2236
26235 .endd
26236 If Exim never has to generate the parameters itself, the possibility of
26237 stalling is removed.
26238
26239 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26240 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26241 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26242 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26243 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26244 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26245 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26246 which applies to all D-H usage, client or server.  If the value returned by
26247 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26248 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26249 limit, which is still much higher than Exim historically used.
26250
26251 The filename and bits used will change as the GnuTLS maintainers change the
26252 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26253 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26254 2432 bits, while NSS is limited to 2236 bits.
26255
26256 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26257 increase the chance of the generated prime actually being within acceptable
26258 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26259 procedure above.  There is no sane procedure available to Exim to double-check
26260 the size of the generated prime, so it might still be too large.
26261
26262
26263 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26264 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26265 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26266 There is a function in the OpenSSL library that can be passed a list of cipher
26267 suites before the cipher negotiation takes place. This specifies which ciphers
26268 are acceptable. The list is colon separated and may contain names like
26269 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26270 directly to this function call.
26271 Many systems will install the OpenSSL manual-pages, so you may have
26272 &'ciphers(1)'& available to you.
26273 The following quotation from the OpenSSL
26274 documentation specifies what forms of item are allowed in the cipher string:
26275
26276 .ilist
26277 It can consist of a single cipher suite such as RC4-SHA.
26278 .next
26279 It can represent a list of cipher suites containing a certain algorithm,
26280 or cipher suites of a certain type. For example SHA1 represents all
26281 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26282 SSL v3 algorithms.
26283 .next
26284 Lists of cipher suites can be combined in a single cipher string using
26285 the + character. This is used as a logical and operation. For example
26286 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26287 algorithms.
26288 .endlist
26289
26290 Each cipher string can be optionally preceded by one of the characters &`!`&,
26291 &`-`& or &`+`&.
26292 .ilist
26293 If &`!`& is used, the ciphers are permanently deleted from the list. The
26294 ciphers deleted can never reappear in the list even if they are explicitly
26295 stated.
26296 .next
26297 If &`-`& is used, the ciphers are deleted from the list, but some or all
26298 of the ciphers can be added again by later options.
26299 .next
26300 If &`+`& is used, the ciphers are moved to the end of the list. This
26301 option does not add any new ciphers; it just moves matching existing ones.
26302 .endlist
26303
26304 If none of these characters is present, the string is interpreted as
26305 a list of ciphers to be appended to the current preference list. If the list
26306 includes any ciphers already present they will be ignored: that is, they will
26307 not be moved to the end of the list.
26308 .endlist
26309
26310 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26311 string:
26312 .code
26313 # note single-quotes to get ! past any shell history expansion
26314 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26315 .endd
26316
26317 This example will let the library defaults be permitted on the MX port, where
26318 there's probably no identity verification anyway, but ups the ante on the
26319 submission ports where the administrator might have some influence on the
26320 choice of clients used:
26321 .code
26322 # OpenSSL variant; see man ciphers(1)
26323 tls_require_ciphers = ${if =={$received_port}{25}\
26324                            {DEFAULT}\
26325                            {HIGH:!MD5:!SHA1}}
26326 .endd
26327
26328
26329
26330 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26331          "SECTreqciphgnu"
26332 .cindex "GnuTLS" "specifying parameters for"
26333 .cindex "TLS" "specifying ciphers (GnuTLS)"
26334 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26335 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26336 .cindex "TLS" "specifying protocols (GnuTLS)"
26337 .cindex "TLS" "specifying priority string (GnuTLS)"
26338 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26339 The GnuTLS library allows the caller to provide a "priority string", documented
26340 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26341 ciphersuite specification in OpenSSL.
26342
26343 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26344 and controls both protocols and ciphers.
26345
26346 The &%tls_require_ciphers%& option is available both as an global option,
26347 controlling how Exim behaves as a server, and also as an option of the
26348 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26349 the value is string expanded.  The resulting string is not an Exim list and
26350 the string is given to the GnuTLS library, so that Exim does not need to be
26351 aware of future feature enhancements of GnuTLS.
26352
26353 Documentation of the strings accepted may be found in the GnuTLS manual, under
26354 "Priority strings".  This is online as
26355 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26356 but beware that this relates to GnuTLS 3, which may be newer than the version
26357 installed on your system.  If you are using GnuTLS 3,
26358 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26359 on that site can be used to test a given string.
26360
26361 For example:
26362 .code
26363 # Disable older versions of protocols
26364 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26365 .endd
26366
26367 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26368 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26369 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26370
26371 This example will let the library defaults be permitted on the MX port, where
26372 there's probably no identity verification anyway, and lowers security further
26373 by increasing compatibility; but this ups the ante on the submission ports
26374 where the administrator might have some influence on the choice of clients
26375 used:
26376 .code
26377 # GnuTLS variant
26378 tls_require_ciphers = ${if =={$received_port}{25}\
26379                            {NORMAL:%COMPAT}\
26380                            {SECURE128}}
26381 .endd
26382
26383
26384 .section "Configuring an Exim server to use TLS" "SECID182"
26385 .cindex "TLS" "configuring an Exim server"
26386 When Exim has been built with TLS support, it advertises the availability of
26387 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26388 but not to any others. The default value of this option is unset, which means
26389 that STARTTLS is not advertised at all. This default is chosen because you
26390 need to set some other options in order to make TLS available, and also it is
26391 sensible for systems that want to use TLS only as a client.
26392
26393 If a client issues a STARTTLS command and there is some configuration
26394 problem in the server, the command is rejected with a 454 error. If the client
26395 persists in trying to issue SMTP commands, all except QUIT are rejected
26396 with the error
26397 .code
26398 554 Security failure
26399 .endd
26400 If a STARTTLS command is issued within an existing TLS session, it is
26401 rejected with a 554 error code.
26402
26403 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26404 match some hosts. You can, of course, set it to * to match all hosts.
26405 However, this is not all you need to do. TLS sessions to a server won't work
26406 without some further configuration at the server end.
26407
26408 It is rumoured that all existing clients that support TLS/SSL use RSA
26409 encryption. To make this work you need to set, in the server,
26410 .code
26411 tls_certificate = /some/file/name
26412 tls_privatekey = /some/file/name
26413 .endd
26414 These options are, in fact, expanded strings, so you can make them depend on
26415 the identity of the client that is connected if you wish. The first file
26416 contains the server's X509 certificate, and the second contains the private key
26417 that goes with it. These files need to be
26418 PEM format and readable by the Exim user, and must
26419 always be given as full path names.
26420 The key must not be password-protected.
26421 They can be the same file if both the
26422 certificate and the key are contained within it. If &%tls_privatekey%& is not
26423 set, or if its expansion is forced to fail or results in an empty string, this
26424 is assumed to be the case. The certificate file may also contain intermediate
26425 certificates that need to be sent to the client to enable it to authenticate
26426 the server's certificate.
26427
26428 If you do not understand about certificates and keys, please try to find a
26429 source of this background information, which is not Exim-specific. (There are a
26430 few comments below in section &<<SECTcerandall>>&.)
26431
26432 &*Note*&: These options do not apply when Exim is operating as a client &--
26433 they apply only in the case of a server. If you need to use a certificate in an
26434 Exim client, you must set the options of the same names in an &(smtp)&
26435 transport.
26436
26437 With just these options, an Exim server will be able to use TLS. It does not
26438 require the client to have a certificate (but see below for how to insist on
26439 this). There is one other option that may be needed in other situations. If
26440 .code
26441 tls_dhparam = /some/file/name
26442 .endd
26443 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26444 with the parameters contained in the file.
26445 Set this to &`none`& to disable use of DH entirely, by making no prime
26446 available:
26447 .code
26448 tls_dhparam = none
26449 .endd
26450 This may also be set to a string identifying a standard prime to be used for
26451 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26452 used is &`ike23`&.  There are a few standard primes available, see the
26453 documentation for &%tls_dhparam%& for the complete list.
26454
26455 See the command
26456 .code
26457 openssl dhparam
26458 .endd
26459 for a way of generating file data.
26460
26461 The strings supplied for these three options are expanded every time a client
26462 host connects. It is therefore possible to use different certificates and keys
26463 for different hosts, if you so wish, by making use of the client's IP address
26464 in &$sender_host_address$& to control the expansion. If a string expansion is
26465 forced to fail, Exim behaves as if the option is not set.
26466
26467 .cindex "cipher" "logging"
26468 .cindex "log" "TLS cipher"
26469 .vindex "&$tls_in_cipher$&"
26470 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26471 an incoming TLS connection. It is included in the &'Received:'& header of an
26472 incoming message (by default &-- you can, of course, change this), and it is
26473 also included in the log line that records a message's arrival, keyed by
26474 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26475 condition can be used to test for specific cipher suites in ACLs.
26476
26477 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26478 can check the name of the cipher suite and vary their actions accordingly. The
26479 cipher suite names vary, depending on which TLS library is being used. For
26480 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26481 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26482 documentation for more details.
26483
26484 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26485 (again depending on the &%tls_cipher%& log selector).
26486
26487
26488 .section "Requesting and verifying client certificates" "SECID183"
26489 .cindex "certificate" "verification of client"
26490 .cindex "TLS" "client certificate verification"
26491 If you want an Exim server to request a certificate when negotiating a TLS
26492 session with a client, you must set either &%tls_verify_hosts%& or
26493 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26494 apply to all TLS connections. For any host that matches one of these options,
26495 Exim requests a certificate as part of the setup of the TLS session. The
26496 contents of the certificate are verified by comparing it with a list of
26497 expected certificates.
26498 .new
26499 These may be the system default set (depending on library version),
26500 .wen
26501 an explicit file or,
26502 depending on library version, a directory, identified by
26503 &%tls_verify_certificates%&.
26504
26505 A file can contain multiple certificates, concatenated end to end. If a
26506 directory is used
26507 (OpenSSL only),
26508 each certificate must be in a separate file, with a name (or a symbolic link)
26509 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26510 certificate. You can compute the relevant hash by running the command
26511 .code
26512 openssl x509 -hash -noout -in /cert/file
26513 .endd
26514 where &_/cert/file_& contains a single certificate.
26515
26516 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26517 what happens if the client does not supply a certificate, or if the certificate
26518 does not match any of the certificates in the collection named by
26519 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26520 attempt to set up a TLS session is aborted, and the incoming connection is
26521 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26522 session continues. ACLs that run for subsequent SMTP commands can detect the
26523 fact that no certificate was verified, and vary their actions accordingly. For
26524 example, you can insist on a certificate before accepting a message for
26525 relaying, but not when the message is destined for local delivery.
26526
26527 .vindex "&$tls_in_peerdn$&"
26528 When a client supplies a certificate (whether it verifies or not), the value of
26529 the Distinguished Name of the certificate is made available in the variable
26530 &$tls_in_peerdn$& during subsequent processing of the message.
26531
26532 .cindex "log" "distinguished name"
26533 Because it is often a long text string, it is not included in the log line or
26534 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26535 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26536 &%received_header_text%& to change the &'Received:'& header. When no
26537 certificate is supplied, &$tls_in_peerdn$& is empty.
26538
26539
26540 .section "Revoked certificates" "SECID184"
26541 .cindex "TLS" "revoked certificates"
26542 .cindex "revocation list"
26543 .cindex "certificate" "revocation list"
26544 .cindex "OCSP" "stapling"
26545 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26546 certificates are revoked. If you have such a list, you can pass it to an Exim
26547 server using the global option called &%tls_crl%& and to an Exim client using
26548 an identically named option for the &(smtp)& transport. In each case, the value
26549 of the option is expanded and must then be the name of a file that contains a
26550 CRL in PEM format.
26551 The downside is that clients have to periodically re-download a potentially huge
26552 file from every certificate authority they know of.
26553
26554 The way with most moving parts at query time is Online Certificate
26555 Status Protocol (OCSP), where the client verifies the certificate
26556 against an OCSP server run by the CA.  This lets the CA track all
26557 usage of the certs.  It requires running software with access to the
26558 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26559 is based on HTTP and can be proxied accordingly.
26560
26561 The only widespread OCSP server implementation (known to this writer)
26562 comes as part of OpenSSL and aborts on an invalid request, such as
26563 connecting to the port and then disconnecting.  This requires
26564 re-entering the passphrase each time some random client does this.
26565
26566 The third way is OCSP Stapling; in this, the server using a certificate
26567 issued by the CA periodically requests an OCSP proof of validity from
26568 the OCSP server, then serves it up inline as part of the TLS
26569 negotiation.   This approach adds no extra round trips, does not let the
26570 CA track users, scales well with number of certs issued by the CA and is
26571 resilient to temporary OCSP server failures, as long as the server
26572 starts retrying to fetch an OCSP proof some time before its current
26573 proof expires.  The downside is that it requires server support.
26574
26575 Unless Exim is built with the support disabled,
26576 or with GnuTLS earlier than version 3.1.3,
26577 support for OCSP stapling is included.
26578
26579 There is a global option called &%tls_ocsp_file%&.
26580 The file specified therein is expected to be in DER format, and contain
26581 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26582 option will be re-expanded for SNI, if the &%tls_certificate%& option
26583 contains &`tls_in_sni`&, as per other TLS options.
26584
26585 Exim does not at this time implement any support for fetching a new OCSP
26586 proof.  The burden is on the administrator to handle this, outside of
26587 Exim.  The file specified should be replaced atomically, so that the
26588 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26589 on each connection, so a new file will be handled transparently on the
26590 next connection.
26591
26592 When built with OpenSSL Exim will check for a valid next update timestamp
26593 in the OCSP proof; if not present, or if the proof has expired, it will be
26594 ignored.
26595
26596 For the client to be able to verify the stapled OCSP the server must
26597 also supply, in its stapled information, any intermediate
26598 certificates for the chain leading to the OCSP proof from the signer
26599 of the server certificate.  There may be zero or one such. These
26600 intermediate certificates should be added to the server OCSP stapling
26601 file named by &%tls_ocsp_file%&.
26602
26603 Note that the proof only covers the terminal server certificate,
26604 not any of the chain from CA to it.
26605
26606 There is no current way to staple a proof for a client certificate.
26607
26608 .code
26609   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26610   OCSP server is supplied.  The server URL may be included in the
26611   server certificate, if the CA is helpful.
26612
26613   One failure mode seen was the OCSP Signer cert expiring before the end
26614   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26615   noted this as invalid overall, but the re-fetch script did not.
26616 .endd
26617
26618
26619
26620
26621 .section "Configuring an Exim client to use TLS" "SECID185"
26622 .cindex "cipher" "logging"
26623 .cindex "log" "TLS cipher"
26624 .cindex "log" "distinguished name"
26625 .cindex "TLS" "configuring an Exim client"
26626 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26627 deliveries as well as to incoming, the latter one causing logging of the
26628 server certificate's DN. The remaining client configuration for TLS is all
26629 within the &(smtp)& transport.
26630
26631 It is not necessary to set any options to have TLS work in the &(smtp)&
26632 transport. If Exim is built with TLS support, and TLS is advertised by a
26633 server, the &(smtp)& transport always tries to start a TLS session. However,
26634 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26635 transport) to a list of server hosts for which TLS should not be used.
26636
26637 If you do not want Exim to attempt to send messages unencrypted when an attempt
26638 to set up an encrypted connection fails in any way, you can set
26639 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26640 those hosts, delivery is always deferred if an encrypted connection cannot be
26641 set up. If there are any other hosts for the address, they are tried in the
26642 usual way.
26643
26644 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26645 the message unencrypted. It always does this if the response to STARTTLS is
26646 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26647 session after a success response code, what happens is controlled by the
26648 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26649 delivery to this host is deferred, and other hosts (if available) are tried. If
26650 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26651 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26652 negotiation fails, Exim closes the current connection (because it is in an
26653 unknown state), opens a new one to the same host, and then tries the delivery
26654 unencrypted.
26655
26656 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26657 transport provide the client with a certificate, which is passed to the server
26658 if it requests it. If the server is Exim, it will request a certificate only if
26659 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26660
26661 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26662 specifies a collection of expected server certificates.
26663 .new
26664 These may be the system default set (depending on library version),
26665 .wen
26666 a file or,
26667 depnding on liibrary version, a directory,
26668 must name a file or,
26669 for OpenSSL only (not GnuTLS), a directory.
26670 The client verifies the server's certificate
26671 against this collection, taking into account any revoked certificates that are
26672 in the list defined by &%tls_crl%&.
26673 Failure to verify fails the TLS connection unless either of the
26674 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26675
26676 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26677 certificate verification to the listed servers.  Verification either must
26678 or need not succeed respectively.
26679
26680 The &(smtp)& transport has two OCSP-related options:
26681 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26682 is requested and required for the connection to proceed.  The default
26683 value is empty.
26684 &%hosts_request_ocsp%&; a host-list for which (additionally)
26685 a Certificate Status is requested (but not necessarily verified).  The default
26686 value is "*" meaning that requests are made unless configured
26687 otherwise.
26688
26689 The host(s) should also be in &%hosts_require_tls%&, and
26690 &%tls_verify_certificates%& configured for the transport,
26691 for OCSP to be relevant.
26692
26693 If
26694 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26695 list of permitted cipher suites. If either of these checks fails, delivery to
26696 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26697 alternative hosts, if any.
26698
26699  &*Note*&:
26700 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26701 is operating as a client. Exim does not assume that a server certificate (set
26702 by the global options of the same name) should also be used when operating as a
26703 client.
26704
26705 .vindex "&$host$&"
26706 .vindex "&$host_address$&"
26707 All the TLS options in the &(smtp)& transport are expanded before use, with
26708 &$host$& and &$host_address$& containing the name and address of the server to
26709 which the client is connected. Forced failure of an expansion causes Exim to
26710 behave as if the relevant option were unset.
26711
26712 .vindex &$tls_out_bits$&
26713 .vindex &$tls_out_cipher$&
26714 .vindex &$tls_out_peerdn$&
26715 .vindex &$tls_out_sni$&
26716 Before an SMTP connection is established, the
26717 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26718 variables are emptied. (Until the first connection, they contain the values
26719 that were set when the message was received.) If STARTTLS is subsequently
26720 successfully obeyed, these variables are set to the relevant values for the
26721 outgoing connection.
26722
26723
26724
26725 .section "Use of TLS Server Name Indication" "SECTtlssni"
26726 .cindex "TLS" "Server Name Indication"
26727 .vindex "&$tls_in_sni$&"
26728 .oindex "&%tls_in_sni%&"
26729 With TLS1.0 or above, there is an extension mechanism by which extra
26730 information can be included at various points in the protocol.  One of these
26731 extensions, documented in RFC 6066 (and before that RFC 4366) is
26732 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26733 client in the initial handshake, so that the server can examine the servername
26734 within and possibly choose to use different certificates and keys (and more)
26735 for this session.
26736
26737 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26738 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26739 address.
26740
26741 With SMTP to MX, there are the same problems here as in choosing the identity
26742 against which to validate a certificate: you can't rely on insecure DNS to
26743 provide the identity which you then cryptographically verify.  So this will
26744 be of limited use in that environment.
26745
26746 With SMTP to Submission, there is a well-defined hostname which clients are
26747 connecting to and can validate certificates against.  Thus clients &*can*&
26748 choose to include this information in the TLS negotiation.  If this becomes
26749 wide-spread, then hosters can choose to present different certificates to
26750 different clients.  Or even negotiate different cipher suites.
26751
26752 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26753 if not empty, will be sent on a TLS session as part of the handshake.  There's
26754 nothing more to it.  Choosing a sensible value not derived insecurely is the
26755 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26756 for the lifetime of the client connection (including during authentication).
26757
26758 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26759 received from a client.
26760 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26761
26762 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26763 option (prior to expansion) then the following options will be re-expanded
26764 during TLS session handshake, to permit alternative values to be chosen:
26765
26766 .ilist
26767 .vindex "&%tls_certificate%&"
26768 &%tls_certificate%&
26769 .next
26770 .vindex "&%tls_crl%&"
26771 &%tls_crl%&
26772 .next
26773 .vindex "&%tls_privatekey%&"
26774 &%tls_privatekey%&
26775 .next
26776 .vindex "&%tls_verify_certificates%&"
26777 &%tls_verify_certificates%&
26778 .next
26779 .vindex "&%tls_ocsp_file%&"
26780 &%tls_ocsp_file%&
26781 .endlist
26782
26783 Great care should be taken to deal with matters of case, various injection
26784 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26785 can always be referenced; it is important to remember that &$tls_sni$& is
26786 arbitrary unverified data provided prior to authentication.
26787
26788 The Exim developers are proceeding cautiously and so far no other TLS options
26789 are re-expanded.
26790
26791 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26792 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26793 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26794 see &`-servername`& in the output, then OpenSSL has support.
26795
26796 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26797 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26798 built, then you have SNI support).
26799
26800
26801
26802 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26803          "SECTmulmessam"
26804 .cindex "multiple SMTP deliveries with TLS"
26805 .cindex "TLS" "multiple message deliveries"
26806 Exim sends multiple messages down the same TCP/IP connection by starting up
26807 an entirely new delivery process for each message, passing the socket from
26808 one process to the next. This implementation does not fit well with the use
26809 of TLS, because there is quite a lot of state information associated with a TLS
26810 connection, not just a socket identification. Passing all the state information
26811 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26812 session before passing the socket to a new process. The new process may then
26813 try to start a new TLS session, and if successful, may try to re-authenticate
26814 if AUTH is in use, before sending the next message.
26815
26816 The RFC is not clear as to whether or not an SMTP session continues in clear
26817 after TLS has been shut down, or whether TLS may be restarted again later, as
26818 just described. However, if the server is Exim, this shutdown and
26819 reinitialization works. It is not known which (if any) other servers operate
26820 successfully if the client closes a TLS session and continues with unencrypted
26821 SMTP, but there are certainly some that do not work. For such servers, Exim
26822 should not pass the socket to another process, because the failure of the
26823 subsequent attempt to use it would cause Exim to record a temporary host error,
26824 and delay other deliveries to that host.
26825
26826 To test for this case, Exim sends an EHLO command to the server after
26827 closing down the TLS session. If this fails in any way, the connection is
26828 closed instead of being passed to a new delivery process, but no retry
26829 information is recorded.
26830
26831 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26832 &(smtp)& transport to match those hosts for which Exim should not pass
26833 connections to new processes if TLS has been used.
26834
26835
26836
26837
26838 .section "Certificates and all that" "SECTcerandall"
26839 .cindex "certificate" "references to discussion"
26840 In order to understand fully how TLS works, you need to know about
26841 certificates, certificate signing, and certificate authorities. This is not the
26842 place to give a tutorial, especially as I do not know very much about it
26843 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26844 to Apache, currently at
26845 .display
26846 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26847 .endd
26848 Other parts of the &'modssl'& documentation are also helpful, and have
26849 links to further files.
26850 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26851 0-201-61598-3), contains both introductory and more in-depth descriptions.
26852 Some sample programs taken from the book are available from
26853 .display
26854 &url(http://www.rtfm.com/openssl-examples/)
26855 .endd
26856
26857
26858 .section "Certificate chains" "SECID186"
26859 The file named by &%tls_certificate%& may contain more than one
26860 certificate. This is useful in the case where the certificate that is being
26861 sent is validated by an intermediate certificate which the other end does
26862 not have. Multiple certificates must be in the correct order in the file.
26863 First the host's certificate itself, then the first intermediate
26864 certificate to validate the issuer of the host certificate, then the next
26865 intermediate certificate to validate the issuer of the first intermediate
26866 certificate, and so on, until finally (optionally) the root certificate.
26867 The root certificate must already be trusted by the recipient for
26868 validation to succeed, of course, but if it's not preinstalled, sending the
26869 root certificate along with the rest makes it available for the user to
26870 install if the receiving end is a client MUA that can interact with a user.
26871
26872 Note that certificates using MD5 are unlikely to work on today's Internet;
26873 even if your libraries allow loading them for use in Exim when acting as a
26874 server, increasingly clients will not accept such certificates.  The error
26875 diagnostics in such a case can be frustratingly vague.
26876
26877
26878
26879 .section "Self-signed certificates" "SECID187"
26880 .cindex "certificate" "self-signed"
26881 You can create a self-signed certificate using the &'req'& command provided
26882 with OpenSSL, like this:
26883 . ==== Do not shorten the duration here without reading and considering
26884 . ==== the text below.  Please leave it at 9999 days.
26885 .code
26886 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26887             -days 9999 -nodes
26888 .endd
26889 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26890 delimited and so can be identified independently. The &%-days%& option
26891 specifies a period for which the certificate is valid. The &%-nodes%& option is
26892 important: if you do not set it, the key is encrypted with a passphrase
26893 that you are prompted for, and any use that is made of the key causes more
26894 prompting for the passphrase. This is not helpful if you are going to use
26895 this certificate and key in an MTA, where prompting is not possible.
26896
26897 . ==== I expect to still be working 26 years from now.  The less technical
26898 . ==== debt I create, in terms of storing up trouble for my later years, the
26899 . ==== happier I will be then.  We really have reached the point where we
26900 . ==== should start, at the very least, provoking thought and making folks
26901 . ==== pause before proceeding, instead of leaving all the fixes until two
26902 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26903 . ==== -pdp, 2012
26904 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26905 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26906 the above command might produce a date in the past.  Think carefully about
26907 the lifetime of the systems you're deploying, and either reduce the duration
26908 of the certificate or reconsider your platform deployment.  (At time of
26909 writing, reducing the duration is the most likely choice, but the inexorable
26910 progression of time takes us steadily towards an era where this will not
26911 be a sensible resolution).
26912
26913 A self-signed certificate made in this way is sufficient for testing, and
26914 may be adequate for all your requirements if you are mainly interested in
26915 encrypting transfers, and not in secure identification.
26916
26917 However, many clients require that the certificate presented by the server be a
26918 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26919 certificate. In this situation, the self-signed certificate described above
26920 must be installed on the client host as a trusted root &'certification
26921 authority'& (CA), and the certificate used by Exim must be a user certificate
26922 signed with that self-signed certificate.
26923
26924 For information on creating self-signed CA certificates and using them to sign
26925 user certificates, see the &'General implementation overview'& chapter of the
26926 Open-source PKI book, available online at
26927 &url(http://ospkibook.sourceforge.net/).
26928 .ecindex IIDencsmtp1
26929 .ecindex IIDencsmtp2
26930
26931
26932
26933 . ////////////////////////////////////////////////////////////////////////////
26934 . ////////////////////////////////////////////////////////////////////////////
26935
26936 .chapter "Access control lists" "CHAPACL"
26937 .scindex IIDacl "&ACL;" "description"
26938 .cindex "control of incoming mail"
26939 .cindex "message" "controlling incoming"
26940 .cindex "policy control" "access control lists"
26941 Access Control Lists (ACLs) are defined in a separate section of the run time
26942 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26943 name, terminated by a colon. Here is a complete ACL section that contains just
26944 one very small ACL:
26945 .code
26946 begin acl
26947 small_acl:
26948   accept   hosts = one.host.only
26949 .endd
26950 You can have as many lists as you like in the ACL section, and the order in
26951 which they appear does not matter. The lists are self-terminating.
26952
26953 The majority of ACLs are used to control Exim's behaviour when it receives
26954 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26955 when a local process submits a message using SMTP by specifying the &%-bs%&
26956 option. The most common use is for controlling which recipients are accepted
26957 in incoming messages. In addition, you can define an ACL that is used to check
26958 local non-SMTP messages. The default configuration file contains an example of
26959 a realistic ACL for checking RCPT commands. This is discussed in chapter
26960 &<<CHAPdefconfil>>&.
26961
26962
26963 .section "Testing ACLs" "SECID188"
26964 The &%-bh%& command line option provides a way of testing your ACL
26965 configuration locally by running a fake SMTP session with which you interact.
26966 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26967 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26968
26969
26970
26971 .section "Specifying when ACLs are used" "SECID189"
26972 .cindex "&ACL;" "options for specifying"
26973 In order to cause an ACL to be used, you have to name it in one of the relevant
26974 options in the main part of the configuration. These options are:
26975 .cindex "AUTH" "ACL for"
26976 .cindex "DATA" "ACLs for"
26977 .cindex "ETRN" "ACL for"
26978 .cindex "EXPN" "ACL for"
26979 .cindex "HELO" "ACL for"
26980 .cindex "EHLO" "ACL for"
26981 .cindex "MAIL" "ACL for"
26982 .cindex "QUIT, ACL for"
26983 .cindex "RCPT" "ACL for"
26984 .cindex "STARTTLS, ACL for"
26985 .cindex "VRFY" "ACL for"
26986 .cindex "SMTP" "connection, ACL for"
26987 .cindex "non-SMTP messages" "ACLs for"
26988 .cindex "MIME content scanning" "ACL for"
26989 .cindex "PRDR" "ACL for"
26990
26991 .table2 140pt
26992 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26993 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26994 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26995 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26996 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26997 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26998 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26999 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27000 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27001 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27002 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27003 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27004 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27005 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27006 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27007 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27008 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27009 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27010 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27011 .endtable
27012
27013 For example, if you set
27014 .code
27015 acl_smtp_rcpt = small_acl
27016 .endd
27017 the little ACL defined above is used whenever Exim receives a RCPT command
27018 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27019 done when RCPT commands arrive. A rejection of RCPT should cause the
27020 sending MTA to give up on the recipient address contained in the RCPT
27021 command, whereas rejection at other times may cause the client MTA to keep on
27022 trying to deliver the message. It is therefore recommended that you do as much
27023 testing as possible at RCPT time.
27024
27025
27026 .section "The non-SMTP ACLs" "SECID190"
27027 .cindex "non-SMTP messages" "ACLs for"
27028 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27029 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27030 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27031 the state of the SMTP connection such as encryption and authentication) are not
27032 relevant and are forbidden in these ACLs. However, the sender and recipients
27033 are known, so the &%senders%& and &%sender_domains%& conditions and the
27034 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27035 &$authenticated_sender$& are also available. You can specify added header lines
27036 in any of these ACLs.
27037
27038 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27039 non-SMTP message, before any of the message has been read. (This is the
27040 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27041 batched SMTP input, it runs after the DATA command has been reached. The
27042 result of this ACL is ignored; it cannot be used to reject a message. If you
27043 really need to, you could set a value in an ACL variable here and reject based
27044 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27045 controls, and in particular, it can be used to set
27046 .code
27047 control = suppress_local_fixups
27048 .endd
27049 This cannot be used in the other non-SMTP ACLs because by the time they are
27050 run, it is too late.
27051
27052 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27053 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27054
27055 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27056 kind of rejection is treated as permanent, because there is no way of sending a
27057 temporary error for these kinds of message.
27058
27059
27060 .section "The SMTP connect ACL" "SECID191"
27061 .cindex "SMTP" "connection, ACL for"
27062 .oindex &%smtp_banner%&
27063 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27064 session, after the test specified by &%host_reject_connection%& (which is now
27065 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27066 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27067 the message override the banner message that is otherwise specified by the
27068 &%smtp_banner%& option.
27069
27070
27071 .section "The EHLO/HELO ACL" "SECID192"
27072 .cindex "EHLO" "ACL for"
27073 .cindex "HELO" "ACL for"
27074 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27075 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27076 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27077 Note that a client may issue more than one EHLO or HELO command in an SMTP
27078 session, and indeed is required to issue a new EHLO or HELO after successfully
27079 setting up encryption following a STARTTLS command.
27080
27081 If the command is accepted by an &%accept%& verb that has a &%message%&
27082 modifier, the message may not contain more than one line (it will be truncated
27083 at the first newline and a panic logged if it does). Such a message cannot
27084 affect the EHLO options that are listed on the second and subsequent lines of
27085 an EHLO response.
27086
27087
27088 .section "The DATA ACLs" "SECID193"
27089 .cindex "DATA" "ACLs for"
27090 Two ACLs are associated with the DATA command, because it is two-stage
27091 command, with two responses being sent to the client.
27092 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27093 is obeyed. This gives you control after all the RCPT commands, but before
27094 the message itself is received. It offers the opportunity to give a negative
27095 response to the DATA command before the data is transmitted. Header lines
27096 added by MAIL or RCPT ACLs are not visible at this time, but any that
27097 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27098
27099 You cannot test the contents of the message, for example, to verify addresses
27100 in the headers, at RCPT time or when the DATA command is received. Such
27101 tests have to appear in the ACL that is run after the message itself has been
27102 received, before the final response to the DATA command is sent. This is
27103 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27104 associated with the DATA command.
27105
27106 For both of these ACLs, it is not possible to reject individual recipients. An
27107 error response rejects the entire message. Unfortunately, it is known that some
27108 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27109 before or after the data) correctly &-- they keep the message on their queues
27110 and try again later, but that is their problem, though it does waste some of
27111 your resources.
27112
27113 The &%acl_smtp_data%& ACL is run after
27114 the &%acl_smtp_data_prdr%&,
27115 the &%acl_smtp_dkim%&
27116 and the &%acl_smtp_mime%& ACLs.
27117
27118 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27119 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27120 enabled (which is the default).
27121
27122 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27123 received, and is executed for each DKIM signature found in a message.  If not
27124 otherwise specified, the default action is to accept.
27125
27126 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27127
27128 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27129
27130
27131 .section "The SMTP MIME ACL" "SECID194"
27132 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27133 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27134
27135 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27136
27137
27138 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27139 .cindex "PRDR" "ACL for"
27140 .oindex "&%prdr_enable%&"
27141 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27142 with PRDR support enabled (which is the default).
27143 It becomes active only when the PRDR feature is negotiated between
27144 client and server for a message, and more than one recipient
27145 has been accepted.
27146
27147 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27148 has been recieved, and is executed once for each recipient of the message
27149 with &$local_part$& and &$domain$& valid.
27150 The test may accept, defer or deny for inividual recipients.
27151 The &%acl_smtp_data%& will still be called after this ACL and
27152 can reject the message overall, even if this ACL has accepted it
27153 for some or all recipients.
27154
27155 PRDR may be used to support per-user content filtering.  Without it
27156 one must defer any recipient after the first that has a different
27157 content-filter configuration.  With PRDR, the RCPT-time check
27158 for this can be disabled when the MAIL-time $smtp_command included
27159 "PRDR".  Any required difference in behaviour of the main DATA-time
27160 ACL should however depend on the PRDR-time ACL having run, as Exim
27161 will avoid doing so in some situations (eg.  single-recipient mails).
27162
27163 See also the &%prdr_enable%& global option
27164 and the &%hosts_try_prdr%& smtp transport option.
27165
27166 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27167 If the ACL is not defined, processing completes as if
27168 the feature was not requested by the client.
27169
27170 .section "The QUIT ACL" "SECTQUITACL"
27171 .cindex "QUIT, ACL for"
27172 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27173 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27174 does not in fact control any access. For this reason, it may only accept
27175 or warn as its final result.
27176
27177 This ACL can be used for tasks such as custom logging at the end of an SMTP
27178 session. For example, you can use ACL variables in other ACLs to count
27179 messages, recipients, etc., and log the totals at QUIT time using one or
27180 more &%logwrite%& modifiers on a &%warn%& verb.
27181
27182 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27183 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27184
27185 You do not need to have a final &%accept%&, but if you do, you can use a
27186 &%message%& modifier to specify custom text that is sent as part of the 221
27187 response to QUIT.
27188
27189 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27190 failure (for example, failure to open a log file, or when Exim is bombing out
27191 because it has detected an unrecoverable error), all SMTP commands from the
27192 client are given temporary error responses until QUIT is received or the
27193 connection is closed. In these special cases, the QUIT ACL does not run.
27194
27195
27196 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27197 .vindex &$acl_smtp_notquit$&
27198 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27199 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27200 trouble, such as being unable to write to its log files, this ACL is not run,
27201 because it might try to do things (such as write to log files) that make the
27202 situation even worse.
27203
27204 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27205 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27206 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27207 and &%warn%&.
27208
27209 .vindex &$smtp_notquit_reason$&
27210 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27211 to a string that indicates the reason for the termination of the SMTP
27212 connection. The possible values are:
27213 .table2
27214 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27215 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27216 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27217 .irow &`connection-lost`&          "The SMTP connection has been lost"
27218 .irow &`data-timeout`&             "Timeout while reading message data"
27219 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27220 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27221 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27222 .irow &`synchronization-error`&    "SMTP synchronization error"
27223 .irow &`tls-failed`&               "TLS failed to start"
27224 .endtable
27225 In most cases when an SMTP connection is closed without having received QUIT,
27226 Exim sends an SMTP response message before actually closing the connection.
27227 With the exception of the &`acl-drop`& case, the default message can be
27228 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27229 &%drop%& verb in another ACL, it is the message from the other ACL that is
27230 used.
27231
27232
27233 .section "Finding an ACL to use" "SECID195"
27234 .cindex "&ACL;" "finding which to use"
27235 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27236 you can use different ACLs in different circumstances. For example,
27237 .code
27238 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27239                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27240 .endd
27241 In the default configuration file there are some example settings for
27242 providing an RFC 4409 message submission service on port 587 and a
27243 non-standard &"smtps"& service on port 465. You can use a string
27244 expansion like this to choose an ACL for MUAs on these ports which is
27245 more appropriate for this purpose than the default ACL on port 25.
27246
27247 The expanded string does not have to be the name of an ACL in the
27248 configuration file; there are other possibilities. Having expanded the
27249 string, Exim searches for an ACL as follows:
27250
27251 .ilist
27252 If the string begins with a slash, Exim uses it as a file name, and reads its
27253 contents as an ACL. The lines are processed in the same way as lines in the
27254 Exim configuration file. In particular, continuation lines are supported, blank
27255 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27256 If the file does not exist or cannot be read, an error occurs (typically
27257 causing a temporary failure of whatever caused the ACL to be run). For example:
27258 .code
27259 acl_smtp_data = /etc/acls/\
27260   ${lookup{$sender_host_address}lsearch\
27261   {/etc/acllist}{$value}{default}}
27262 .endd
27263 This looks up an ACL file to use on the basis of the host's IP address, falling
27264 back to a default if the lookup fails. If an ACL is successfully read from a
27265 file, it is retained in memory for the duration of the Exim process, so that it
27266 can be re-used without having to re-read the file.
27267 .next
27268 If the string does not start with a slash, and does not contain any spaces,
27269 Exim searches the ACL section of the configuration for an ACL whose name
27270 matches the string.
27271 .next
27272 If no named ACL is found, or if the string contains spaces, Exim parses
27273 the string as an inline ACL. This can save typing in cases where you just
27274 want to have something like
27275 .code
27276 acl_smtp_vrfy = accept
27277 .endd
27278 in order to allow free use of the VRFY command. Such a string may contain
27279 newlines; it is processed in the same way as an ACL that is read from a file.
27280 .endlist
27281
27282
27283
27284
27285 .section "ACL return codes" "SECID196"
27286 .cindex "&ACL;" "return codes"
27287 Except for the QUIT ACL, which does not affect the SMTP return code (see
27288 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27289 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27290 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27291 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27292 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27293 This also causes a 4&'xx'& return code.
27294
27295 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27296 &"deny"&, because there is no mechanism for passing temporary errors to the
27297 submitters of non-SMTP messages.
27298
27299
27300 ACLs that are relevant to message reception may also return &"discard"&. This
27301 has the effect of &"accept"&, but causes either the entire message or an
27302 individual recipient address to be discarded. In other words, it is a
27303 blackholing facility. Use it with care.
27304
27305 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27306 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27307 RCPT ACL is to discard just the one recipient address. If there are no
27308 recipients left when the message's data is received, the DATA ACL is not
27309 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27310 remaining recipients. The &"discard"& return is not permitted for the
27311 &%acl_smtp_predata%& ACL.
27312
27313
27314 .cindex "&[local_scan()]& function" "when all recipients discarded"
27315 The &[local_scan()]& function is always run, even if there are no remaining
27316 recipients; it may create new recipients.
27317
27318
27319
27320 .section "Unset ACL options" "SECID197"
27321 .cindex "&ACL;" "unset options"
27322 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27323 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27324 not defined at all. For any defined ACL, the default action when control
27325 reaches the end of the ACL statements is &"deny"&.
27326
27327 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27328 these two are ACLs that are used only for their side effects. They cannot be
27329 used to accept or reject anything.
27330
27331 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27332 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27333 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27334 when the ACL is not defined is &"accept"&.
27335
27336 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27337 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27338 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27339 messages over an SMTP connection. For an example, see the ACL in the default
27340 configuration file.
27341
27342
27343
27344
27345 .section "Data for message ACLs" "SECID198"
27346 .cindex "&ACL;" "data for message ACL"
27347 .vindex &$domain$&
27348 .vindex &$local_part$&
27349 .vindex &$sender_address$&
27350 .vindex &$sender_host_address$&
27351 .vindex &$smtp_command$&
27352 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27353 that contain information about the host and the message's sender (for example,
27354 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27355 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27356 &$local_part$& are set from the argument address. The entire SMTP command
27357 is available in &$smtp_command$&.
27358
27359 When an ACL for the AUTH parameter of MAIL is running, the variables that
27360 contain information about the host are set, but &$sender_address$& is not yet
27361 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27362 how it is used.
27363
27364 .vindex "&$message_size$&"
27365 The &$message_size$& variable is set to the value of the SIZE parameter on
27366 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27367 that parameter is not given. The value is updated to the true message size by
27368 the time the final DATA ACL is run (after the message data has been
27369 received).
27370
27371 .vindex "&$rcpt_count$&"
27372 .vindex "&$recipients_count$&"
27373 The &$rcpt_count$& variable increases by one for each RCPT command received.
27374 The &$recipients_count$& variable increases by one each time a RCPT command is
27375 accepted, so while an ACL for RCPT is being processed, it contains the number
27376 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27377 &$rcpt_count$& contains the total number of RCPT commands, and
27378 &$recipients_count$& contains the total number of accepted recipients.
27379
27380
27381
27382
27383
27384 .section "Data for non-message ACLs" "SECTdatfornon"
27385 .cindex "&ACL;" "data for non-message ACL"
27386 .vindex &$smtp_command_argument$&
27387 .vindex &$smtp_command$&
27388 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27389 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27390 and the entire SMTP command is available in &$smtp_command$&.
27391 These variables can be tested using a &%condition%& condition. For example,
27392 here is an ACL for use with AUTH, which insists that either the session is
27393 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27394 does not permit authentication methods that use cleartext passwords on
27395 unencrypted connections.
27396 .code
27397 acl_check_auth:
27398   accept encrypted = *
27399   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27400                      {CRAM-MD5}}
27401   deny   message   = TLS encryption or CRAM-MD5 required
27402 .endd
27403 (Another way of applying this restriction is to arrange for the authenticators
27404 that use cleartext passwords not to be advertised when the connection is not
27405 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27406 option to do this.)
27407
27408
27409
27410 .section "Format of an ACL" "SECID199"
27411 .cindex "&ACL;" "format of"
27412 .cindex "&ACL;" "verbs, definition of"
27413 An individual ACL consists of a number of statements. Each statement starts
27414 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27415 Modifiers can change the way the verb operates, define error and log messages,
27416 set variables, insert delays, and vary the processing of accepted messages.
27417
27418 If all the conditions are met, the verb is obeyed. The same condition may be
27419 used (with different arguments) more than once in the same statement. This
27420 provides a means of specifying an &"and"& conjunction between conditions. For
27421 example:
27422 .code
27423 deny  dnslists = list1.example
27424 dnslists = list2.example
27425 .endd
27426 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27427 the conditions and modifiers when it reaches a condition that fails. What
27428 happens then depends on the verb (and in one case, on a special modifier). Not
27429 all the conditions make sense at every testing point. For example, you cannot
27430 test a sender address in the ACL that is run for a VRFY command.
27431
27432
27433 .section "ACL verbs" "SECID200"
27434 The ACL verbs are as follows:
27435
27436 .ilist
27437 .cindex "&%accept%& ACL verb"
27438 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27439 of the conditions are not met, what happens depends on whether &%endpass%&
27440 appears among the conditions (for syntax see below). If the failing condition
27441 is before &%endpass%&, control is passed to the next ACL statement; if it is
27442 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27443 check a RCPT command:
27444 .code
27445 accept domains = +local_domains
27446 endpass
27447 verify = recipient
27448 .endd
27449 If the recipient domain does not match the &%domains%& condition, control
27450 passes to the next statement. If it does match, the recipient is verified, and
27451 the command is accepted if verification succeeds. However, if verification
27452 fails, the ACL yields &"deny"&, because the failing condition is after
27453 &%endpass%&.
27454
27455 The &%endpass%& feature has turned out to be confusing to many people, so its
27456 use is not recommended nowadays. It is always possible to rewrite an ACL so
27457 that &%endpass%& is not needed, and it is no longer used in the default
27458 configuration.
27459
27460 .cindex "&%message%& ACL modifier" "with &%accept%&"
27461 If a &%message%& modifier appears on an &%accept%& statement, its action
27462 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27463 (when an &%accept%& verb either accepts or passes control to the next
27464 statement), &%message%& can be used to vary the message that is sent when an
27465 SMTP command is accepted. For example, in a RCPT ACL you could have:
27466 .display
27467 &`accept  `&<&'some conditions'&>
27468 &`        message = OK, I will allow you through today`&
27469 .endd
27470 You can specify an SMTP response code, optionally followed by an &"extended
27471 response code"& at the start of the message, but the first digit must be the
27472 same as would be sent by default, which is 2 for an &%accept%& verb.
27473
27474 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27475 an error message that is used when access is denied. This behaviour is retained
27476 for backward compatibility, but current &"best practice"& is to avoid the use
27477 of &%endpass%&.
27478
27479
27480 .next
27481 .cindex "&%defer%& ACL verb"
27482 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27483 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27484 &%defer%& is the same as &%deny%&, because there is no way of sending a
27485 temporary error. For a RCPT command, &%defer%& is much the same as using a
27486 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27487 be used in any ACL, and even for a recipient it might be a simpler approach.
27488
27489
27490 .next
27491 .cindex "&%deny%& ACL verb"
27492 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27493 the conditions are not met, control is passed to the next ACL statement. For
27494 example,
27495 .code
27496 deny dnslists = blackholes.mail-abuse.org
27497 .endd
27498 rejects commands from hosts that are on a DNS black list.
27499
27500
27501 .next
27502 .cindex "&%discard%& ACL verb"
27503 &%discard%&: This verb behaves like &%accept%&, except that it returns
27504 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27505 that are concerned with receiving messages. When all the conditions are true,
27506 the sending entity receives a &"success"& response. However, &%discard%& causes
27507 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27508 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27509 message's recipients are discarded. Recipients that are discarded before DATA
27510 do not appear in the log line when the &%received_recipients%& log selector is set.
27511
27512 If the &%log_message%& modifier is set when &%discard%& operates,
27513 its contents are added to the line that is automatically written to the log.
27514 The &%message%& modifier operates exactly as it does for &%accept%&.
27515
27516
27517 .next
27518 .cindex "&%drop%& ACL verb"
27519 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27520 forcibly closed after the 5&'xx'& error message has been sent. For example:
27521 .code
27522 drop   message   = I don't take more than 20 RCPTs
27523        condition = ${if > {$rcpt_count}{20}}
27524 .endd
27525 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27526 The connection is always dropped after sending a 550 response.
27527
27528 .next
27529 .cindex "&%require%& ACL verb"
27530 &%require%&: If all the conditions are met, control is passed to the next ACL
27531 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27532 example, when checking a RCPT command,
27533 .code
27534 require message = Sender did not verify
27535         verify  = sender
27536 .endd
27537 passes control to subsequent statements only if the message's sender can be
27538 verified. Otherwise, it rejects the command. Note the positioning of the
27539 &%message%& modifier, before the &%verify%& condition. The reason for this is
27540 discussed in section &<<SECTcondmodproc>>&.
27541
27542 .next
27543 .cindex "&%warn%& ACL verb"
27544 &%warn%&: If all the conditions are true, a line specified by the
27545 &%log_message%& modifier is written to Exim's main log. Control always passes
27546 to the next ACL statement. If any condition is false, the log line is not
27547 written. If an identical log line is requested several times in the same
27548 message, only one copy is actually written to the log. If you want to force
27549 duplicates to be written, use the &%logwrite%& modifier instead.
27550
27551 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27552 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27553 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27554 first failing condition. There is more about adding header lines in section
27555 &<<SECTaddheadacl>>&.
27556
27557 If any condition on a &%warn%& statement cannot be completed (that is, there is
27558 some sort of defer), the log line specified by &%log_message%& is not written.
27559 This does not include the case of a forced failure from a lookup, which
27560 is considered to be a successful completion. After a defer, no further
27561 conditions or modifiers in the &%warn%& statement are processed. The incident
27562 is logged, and the ACL continues to be processed, from the next statement
27563 onwards.
27564
27565
27566 .vindex "&$acl_verify_message$&"
27567 When one of the &%warn%& conditions is an address verification that fails, the
27568 text of the verification failure message is in &$acl_verify_message$&. If you
27569 want this logged, you must set it up explicitly. For example:
27570 .code
27571 warn   !verify = sender
27572        log_message = sender verify failed: $acl_verify_message
27573 .endd
27574 .endlist
27575
27576 At the end of each ACL there is an implicit unconditional &%deny%&.
27577
27578 As you can see from the examples above, the conditions and modifiers are
27579 written one to a line, with the first one on the same line as the verb, and
27580 subsequent ones on following lines. If you have a very long condition, you can
27581 continue it onto several physical lines by the usual backslash continuation
27582 mechanism. It is conventional to align the conditions vertically.
27583
27584
27585
27586 .section "ACL variables" "SECTaclvariables"
27587 .cindex "&ACL;" "variables"
27588 There are some special variables that can be set during ACL processing. They
27589 can be used to pass information between different ACLs, different invocations
27590 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27591 transports, and filters that are used to deliver a message. The names of these
27592 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27593 an underscore, but the remainder of the name can be any sequence of
27594 alphanumeric characters and underscores that you choose. There is no limit on
27595 the number of ACL variables. The two sets act as follows:
27596 .ilist
27597 The values of those variables whose names begin with &$acl_c$& persist
27598 throughout an SMTP connection. They are never reset. Thus, a value that is set
27599 while receiving one message is still available when receiving the next message
27600 on the same SMTP connection.
27601 .next
27602 The values of those variables whose names begin with &$acl_m$& persist only
27603 while a message is being received. They are reset afterwards. They are also
27604 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27605 .endlist
27606
27607 When a message is accepted, the current values of all the ACL variables are
27608 preserved with the message and are subsequently made available at delivery
27609 time. The ACL variables are set by a modifier called &%set%&. For example:
27610 .code
27611 accept hosts = whatever
27612        set acl_m4 = some value
27613 accept authenticated = *
27614        set acl_c_auth = yes
27615 .endd
27616 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27617 be set. If you want to set a variable without taking any action, you can use a
27618 &%warn%& verb without any other modifiers or conditions.
27619
27620 .oindex &%strict_acl_vars%&
27621 What happens if a syntactically valid but undefined ACL variable is
27622 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27623 false (the default), an empty string is substituted; if it is true, an
27624 error is generated.
27625
27626 Versions of Exim before 4.64 have a limited set of numbered variables, but
27627 their names are compatible, so there is no problem with upgrading.
27628
27629
27630 .section "Condition and modifier processing" "SECTcondmodproc"
27631 .cindex "&ACL;" "conditions; processing"
27632 .cindex "&ACL;" "modifiers; processing"
27633 An exclamation mark preceding a condition negates its result. For example:
27634 .code
27635 deny   domains = *.dom.example
27636       !verify  = recipient
27637 .endd
27638 causes the ACL to return &"deny"& if the recipient domain ends in
27639 &'dom.example'& and the recipient address cannot be verified. Sometimes
27640 negation can be used on the right-hand side of a condition. For example, these
27641 two statements are equivalent:
27642 .code
27643 deny  hosts = !192.168.3.4
27644 deny !hosts =  192.168.3.4
27645 .endd
27646 However, for many conditions (&%verify%& being a good example), only left-hand
27647 side negation of the whole condition is possible.
27648
27649 The arguments of conditions and modifiers are expanded. A forced failure
27650 of an expansion causes a condition to be ignored, that is, it behaves as if the
27651 condition is true. Consider these two statements:
27652 .code
27653 accept  senders = ${lookup{$host_name}lsearch\
27654                   {/some/file}{$value}fail}
27655 accept  senders = ${lookup{$host_name}lsearch\
27656                   {/some/file}{$value}{}}
27657 .endd
27658 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27659 the returned list is searched, but if the lookup fails the behaviour is
27660 different in the two cases. The &%fail%& in the first statement causes the
27661 condition to be ignored, leaving no further conditions. The &%accept%& verb
27662 therefore succeeds. The second statement, however, generates an empty list when
27663 the lookup fails. No sender can match an empty list, so the condition fails,
27664 and therefore the &%accept%& also fails.
27665
27666 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27667 specify actions that are taken as the conditions for a statement are checked;
27668 others specify text for messages that are used when access is denied or a
27669 warning is generated. The &%control%& modifier affects the way an incoming
27670 message is handled.
27671
27672 The positioning of the modifiers in an ACL statement is important, because the
27673 processing of a verb ceases as soon as its outcome is known. Only those
27674 modifiers that have already been encountered will take effect. For example,
27675 consider this use of the &%message%& modifier:
27676 .code
27677 require message = Can't verify sender
27678         verify  = sender
27679         message = Can't verify recipient
27680         verify  = recipient
27681         message = This message cannot be used
27682 .endd
27683 If sender verification fails, Exim knows that the result of the statement is
27684 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27685 so its text is used as the error message. If sender verification succeeds, but
27686 recipient verification fails, the second message is used. If recipient
27687 verification succeeds, the third message becomes &"current"&, but is never used
27688 because there are no more conditions to cause failure.
27689
27690 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27691 modifier that is used, because all the conditions must be true for rejection to
27692 happen. Specifying more than one &%message%& modifier does not make sense, and
27693 the message can even be specified after all the conditions. For example:
27694 .code
27695 deny   hosts = ...
27696       !senders = *@my.domain.example
27697        message = Invalid sender from client host
27698 .endd
27699 The &"deny"& result does not happen until the end of the statement is reached,
27700 by which time Exim has set up the message.
27701
27702
27703
27704 .section "ACL modifiers" "SECTACLmodi"
27705 .cindex "&ACL;" "modifiers; list of"
27706 The ACL modifiers are as follows:
27707
27708 .vlist
27709 .vitem &*add_header*&&~=&~<&'text'&>
27710 This modifier specifies one or more header lines that are to be added to an
27711 incoming message, assuming, of course, that the message is ultimately
27712 accepted. For details, see section &<<SECTaddheadacl>>&.
27713
27714 .vitem &*continue*&&~=&~<&'text'&>
27715 .cindex "&%continue%& ACL modifier"
27716 .cindex "database" "updating in ACL"
27717 This modifier does nothing of itself, and processing of the ACL always
27718 continues with the next condition or modifier. The value of &%continue%& is in
27719 the side effects of expanding its argument. Typically this could be used to
27720 update a database. It is really just a syntactic tidiness, to avoid having to
27721 write rather ugly lines like this:
27722 .display
27723 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27724 .endd
27725 Instead, all you need is
27726 .display
27727 &`continue = `&<&'some expansion'&>
27728 .endd
27729
27730 .vitem &*control*&&~=&~<&'text'&>
27731 .cindex "&%control%& ACL modifier"
27732 This modifier affects the subsequent processing of the SMTP connection or of an
27733 incoming message that is accepted. The effect of the first type of control
27734 lasts for the duration of the connection, whereas the effect of the second type
27735 lasts only until the current message has been received. The message-specific
27736 controls always apply to the whole message, not to individual recipients,
27737 even if the &%control%& modifier appears in a RCPT ACL.
27738
27739 As there are now quite a few controls that can be applied, they are described
27740 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27741 in several different ways. For example:
27742
27743 . ==== As this is a nested list, any displays it contains must be indented
27744 . ==== as otherwise they are too far to the left. That comment applies only
27745 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27746 . ==== way.
27747
27748 .ilist
27749 It can be at the end of an &%accept%& statement:
27750 .code
27751     accept  ...some conditions
27752             control = queue_only
27753 .endd
27754 In this case, the control is applied when this statement yields &"accept"&, in
27755 other words, when the conditions are all true.
27756
27757 .next
27758 It can be in the middle of an &%accept%& statement:
27759 .code
27760     accept  ...some conditions...
27761             control = queue_only
27762             ...some more conditions...
27763 .endd
27764 If the first set of conditions are true, the control is applied, even if the
27765 statement does not accept because one of the second set of conditions is false.
27766 In this case, some subsequent statement must yield &"accept"& for the control
27767 to be relevant.
27768
27769 .next
27770 It can be used with &%warn%& to apply the control, leaving the
27771 decision about accepting or denying to a subsequent verb. For
27772 example:
27773 .code
27774     warn    ...some conditions...
27775             control = freeze
27776     accept  ...
27777 .endd
27778 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27779 &%logwrite%&, so it does not add anything to the message and does not write a
27780 log entry.
27781
27782 .next
27783 If you want to apply a control unconditionally, you can use it with a
27784 &%require%& verb. For example:
27785 .code
27786     require  control = no_multiline_responses
27787 .endd
27788 .endlist
27789
27790 .vitem &*delay*&&~=&~<&'time'&>
27791 .cindex "&%delay%& ACL modifier"
27792 .oindex "&%-bh%&"
27793 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27794 the time interval before proceeding. However, when testing Exim using the
27795 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27796 output instead). The time is given in the usual Exim notation, and the delay
27797 happens as soon as the modifier is processed. In an SMTP session, pending
27798 output is flushed before the delay is imposed.
27799
27800 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27801 example:
27802 .code
27803 deny    ...some conditions...
27804         delay = 30s
27805 .endd
27806 The delay happens if all the conditions are true, before the statement returns
27807 &"deny"&. Compare this with:
27808 .code
27809 deny    delay = 30s
27810         ...some conditions...
27811 .endd
27812 which waits for 30s before processing the conditions. The &%delay%& modifier
27813 can also be used with &%warn%& and together with &%control%&:
27814 .code
27815 warn    ...some conditions...
27816         delay = 2m
27817         control = freeze
27818 accept  ...
27819 .endd
27820
27821 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27822 responses to several commands are no longer buffered and sent in one packet (as
27823 they would normally be) because all output is flushed before imposing the
27824 delay. This optimization is disabled so that a number of small delays do not
27825 appear to the client as one large aggregated delay that might provoke an
27826 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27827 using a &%control%& modifier to set &%no_delay_flush%&.
27828
27829
27830 .vitem &*endpass*&
27831 .cindex "&%endpass%& ACL modifier"
27832 This modifier, which has no argument, is recognized only in &%accept%& and
27833 &%discard%& statements. It marks the boundary between the conditions whose
27834 failure causes control to pass to the next statement, and the conditions whose
27835 failure causes the ACL to return &"deny"&. This concept has proved to be
27836 confusing to some people, so the use of &%endpass%& is no longer recommended as
27837 &"best practice"&. See the description of &%accept%& above for more details.
27838
27839
27840 .vitem &*log_message*&&~=&~<&'text'&>
27841 .cindex "&%log_message%& ACL modifier"
27842 This modifier sets up a message that is used as part of the log message if the
27843 ACL denies access or a &%warn%& statement's conditions are true. For example:
27844 .code
27845 require log_message = wrong cipher suite $tls_in_cipher
27846         encrypted   = DES-CBC3-SHA
27847 .endd
27848 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27849 example:
27850 .display
27851 &`discard `&<&'some conditions'&>
27852 &`        log_message = Discarded $local_part@$domain because...`&
27853 .endd
27854 When access is denied, &%log_message%& adds to any underlying error message
27855 that may exist because of a condition failure. For example, while verifying a
27856 recipient address, a &':fail:'& redirection might have already set up a
27857 message.
27858
27859 The message may be defined before the conditions to which it applies, because
27860 the string expansion does not happen until Exim decides that access is to be
27861 denied. This means that any variables that are set by the condition are
27862 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27863 variables are set after a DNS black list lookup succeeds. If the expansion of
27864 &%log_message%& fails, or if the result is an empty string, the modifier is
27865 ignored.
27866
27867 .vindex "&$acl_verify_message$&"
27868 If you want to use a &%warn%& statement to log the result of an address
27869 verification, you can use &$acl_verify_message$& to include the verification
27870 error message.
27871
27872 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27873 the start of the logged message. If the same warning log message is requested
27874 more than once while receiving  a single email message, only one copy is
27875 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27876 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27877 is logged for a successful &%warn%& statement.
27878
27879 If &%log_message%& is not present and there is no underlying error message (for
27880 example, from the failure of address verification), but &%message%& is present,
27881 the &%message%& text is used for logging rejections. However, if any text for
27882 logging contains newlines, only the first line is logged. In the absence of
27883 both &%log_message%& and &%message%&, a default built-in message is used for
27884 logging rejections.
27885
27886
27887 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27888 .cindex "&%log_reject_target%& ACL modifier"
27889 .cindex "logging in ACL" "specifying which log"
27890 This modifier makes it possible to specify which logs are used for messages
27891 about ACL rejections. Its argument is a colon-separated list of words that can
27892 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27893 may be empty, in which case a rejection is not logged at all. For example, this
27894 ACL fragment writes no logging information when access is denied:
27895 .display
27896 &`deny `&<&'some conditions'&>
27897 &`     log_reject_target =`&
27898 .endd
27899 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27900 permanent and temporary rejections. Its effect lasts for the rest of the
27901 current ACL.
27902
27903
27904 .vitem &*logwrite*&&~=&~<&'text'&>
27905 .cindex "&%logwrite%& ACL modifier"
27906 .cindex "logging in ACL" "immediate"
27907 This modifier writes a message to a log file as soon as it is encountered when
27908 processing an ACL. (Compare &%log_message%&, which, except in the case of
27909 &%warn%& and &%discard%&, is used only if the ACL statement denies
27910 access.) The &%logwrite%& modifier can be used to log special incidents in
27911 ACLs. For example:
27912 .display
27913 &`accept `&<&'some special conditions'&>
27914 &`       control  = freeze`&
27915 &`       logwrite = froze message because ...`&
27916 .endd
27917 By default, the message is written to the main log. However, it may begin
27918 with a colon, followed by a comma-separated list of log names, and then
27919 another colon, to specify exactly which logs are to be written. For
27920 example:
27921 .code
27922 logwrite = :main,reject: text for main and reject logs
27923 logwrite = :panic: text for panic log only
27924 .endd
27925
27926
27927 .vitem &*message*&&~=&~<&'text'&>
27928 .cindex "&%message%& ACL modifier"
27929 This modifier sets up a text string that is expanded and used as a response
27930 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27931 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27932 there is some complication if &%endpass%& is involved; see the description of
27933 &%accept%& for details.)
27934
27935 The expansion of the message happens at the time Exim decides that the ACL is
27936 to end, not at the time it processes &%message%&. If the expansion fails, or
27937 generates an empty string, the modifier is ignored. Here is an example where
27938 &%message%& must be specified first, because the ACL ends with a rejection if
27939 the &%hosts%& condition fails:
27940 .code
27941 require  message = Host not recognized
27942          hosts = 10.0.0.0/8
27943 .endd
27944 (Once a condition has failed, no further conditions or modifiers are
27945 processed.)
27946
27947 .cindex "SMTP" "error codes"
27948 .oindex "&%smtp_banner%&
27949 For ACLs that are triggered by SMTP commands, the message is returned as part
27950 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27951 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27952 is accepted. In the case of the connect ACL, accepting with a message modifier
27953 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27954 accept message may not contain more than one line (otherwise it will be
27955 truncated at the first newline and a panic logged), and it cannot affect the
27956 EHLO options.
27957
27958 When SMTP is involved, the message may begin with an overriding response code,
27959 consisting of three digits optionally followed by an &"extended response code"&
27960 of the form &'n.n.n'&, each code being followed by a space. For example:
27961 .code
27962 deny  message = 599 1.2.3 Host not welcome
27963       hosts = 192.168.34.0/24
27964 .endd
27965 The first digit of the supplied response code must be the same as would be sent
27966 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27967 access, but for the predata ACL, note that the default success code is 354, not
27968 2&'xx'&.
27969
27970 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27971 the message modifier cannot override the 221 response code.
27972
27973 The text in a &%message%& modifier is literal; any quotes are taken as
27974 literals, but because the string is expanded, backslash escapes are processed
27975 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27976 response.
27977
27978 .vindex "&$acl_verify_message$&"
27979 For ACLs that are called by an &%acl =%& ACL condition, the message is
27980 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27981
27982 If &%message%& is used on a statement that verifies an address, the message
27983 specified overrides any message that is generated by the verification process.
27984 However, the original message is available in the variable
27985 &$acl_verify_message$&, so you can incorporate it into your message if you
27986 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27987 routers to be passed back as part of the SMTP response, you should either not
27988 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27989
27990 For compatibility with previous releases of Exim, a &%message%& modifier that
27991 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27992 modifier, but this usage is now deprecated. However, &%message%& acts only when
27993 all the conditions are true, wherever it appears in an ACL command, whereas
27994 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27995 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27996 effect.
27997
27998
27999 .vitem &*remove_header*&&~=&~<&'text'&>
28000 This modifier specifies one or more header names in a colon-separated list
28001  that are to be removed from an incoming message, assuming, of course, that
28002 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28003
28004
28005 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28006 .cindex "&%set%& ACL modifier"
28007 This modifier puts a value into one of the ACL variables (see section
28008 &<<SECTaclvariables>>&).
28009
28010
28011 .vitem &*udpsend*&&~=&~<&'parameters'&>
28012 This modifier sends a UDP packet, for purposes such as statistics
28013 collection or behaviour monitoring. The parameters are expanded, and
28014 the result of the expansion must be a colon-separated list consisting
28015 of a destination server, port number, and the packet contents. The
28016 server can be specified as a host name or IPv4 or IPv6 address. The
28017 separator can be changed with the usual angle bracket syntax. For
28018 example, you might want to collect information on which hosts connect
28019 when:
28020 .code
28021 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28022              $tod_zulu $sender_host_address
28023 .endd
28024 .endlist
28025
28026
28027
28028
28029 .section "Use of the control modifier" "SECTcontrols"
28030 .cindex "&%control%& ACL modifier"
28031 The &%control%& modifier supports the following settings:
28032
28033 .vlist
28034 .vitem &*control&~=&~allow_auth_unadvertised*&
28035 This modifier allows a client host to use the SMTP AUTH command even when it
28036 has not been advertised in response to EHLO. Furthermore, because there are
28037 apparently some really broken clients that do this, Exim will accept AUTH after
28038 HELO (rather than EHLO) when this control is set. It should be used only if you
28039 really need it, and you should limit its use to those broken clients that do
28040 not work without it. For example:
28041 .code
28042 warn hosts   = 192.168.34.25
28043      control = allow_auth_unadvertised
28044 .endd
28045 Normally, when an Exim server receives an AUTH command, it checks the name of
28046 the authentication mechanism that is given in the command to ensure that it
28047 matches an advertised mechanism. When this control is set, the check that a
28048 mechanism has been advertised is bypassed. Any configured mechanism can be used
28049 by the client. This control is permitted only in the connection and HELO ACLs.
28050
28051
28052 .vitem &*control&~=&~caseful_local_part*& &&&
28053        &*control&~=&~caselower_local_part*&
28054 .cindex "&ACL;" "case of local part in"
28055 .cindex "case of local parts"
28056 .vindex "&$local_part$&"
28057 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28058 (that is, during RCPT processing). By default, the contents of &$local_part$&
28059 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28060 any uppercase letters in the original local part are restored in &$local_part$&
28061 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28062 is encountered.
28063
28064 These controls affect only the current recipient. Moreover, they apply only to
28065 local part handling that takes place directly in the ACL (for example, as a key
28066 in lookups). If a test to verify the recipient is obeyed, the case-related
28067 handling of the local part during the verification is controlled by the router
28068 configuration (see the &%caseful_local_part%& generic router option).
28069
28070 This facility could be used, for example, to add a spam score to local parts
28071 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28072 spam score:
28073 .code
28074 warn  control = caseful_local_part
28075       set acl_m4 = ${eval:\
28076                      $acl_m4 + \
28077                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28078                     }
28079       control = caselower_local_part
28080 .endd
28081 Notice that we put back the lower cased version afterwards, assuming that
28082 is what is wanted for subsequent tests.
28083
28084
28085 .vitem &*control&~=&~cutthrough_delivery*&
28086 .cindex "&ACL;" "cutthrough routing"
28087 .cindex "cutthrough" "requesting"
28088 This option requests delivery be attempted while the item is being received.
28089
28090 The option is usable in the RCPT ACL.
28091 If enabled for a message recieved via smtp and routed to an smtp transport,
28092 and only one transport, interface, destination host and port combination
28093 is used for all recipients of the message,
28094 then the delivery connection is made while the receiving connection is open
28095 and data is copied from one to the other.
28096
28097 An attempt to set this option for any recipient but the first
28098 for a mail will be quietly ignored.
28099 If a recipient-verify callout connection is subsequently
28100 requested in the same ACL it is held open and used for
28101 any subsequent receipients and the data,
28102 otherwise one is made after the initial RCPT ACL completes.
28103
28104 Note that routers are used in verify mode,
28105 and cannot depend on content of received headers.
28106 Note also that headers cannot be
28107 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28108 Headers may be modified by routers (subject to the above) and transports.
28109
28110 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28111 of outgoing messages is done, because it sends data to the ultimate destination
28112 before the entire message has been received from the source.
28113 It is not supported for messages recieved with the SMTP PRDR option in use.
28114
28115 Should the ultimate destination system positively accept or reject the mail,
28116 a corresponding indication is given to the source system and nothing is queued.
28117 If there is a temporary error the item is queued for later delivery in the
28118 usual fashion. If the item is successfully delivered in cutthrough mode
28119 the delivery log lines are tagged with ">>" rather than "=>" and appear
28120 before the acceptance "<=" line.
28121
28122 Delivery in this mode avoids the generation of a bounce mail to a
28123 (possibly faked)
28124 sender when the destination system is doing content-scan based rejection.
28125
28126
28127 .vitem &*control&~=&~debug/*&<&'options'&>
28128 .cindex "&ACL;" "enabling debug logging"
28129 .cindex "debugging" "enabling from an ACL"
28130 This control turns on debug logging, almost as though Exim had been invoked
28131 with &`-d`&, with the output going to a new logfile, by default called
28132 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28133 may access any variables already defined.  The logging may be adjusted with
28134 the &'opts'& option, which takes the same values as the &`-d`& command-line
28135 option.  Some examples (which depend on variables that don't exist in all
28136 contexts):
28137 .code
28138       control = debug
28139       control = debug/tag=.$sender_host_address
28140       control = debug/opts=+expand+acl
28141       control = debug/tag=.$message_exim_id/opts=+expand
28142 .endd
28143
28144
28145 .vitem &*control&~=&~dkim_disable_verify*&
28146 .cindex "disable DKIM verify"
28147 .cindex "DKIM" "disable verify"
28148 This control turns off DKIM verification processing entirely.  For details on
28149 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28150
28151
28152 .vitem &*control&~=&~dscp/*&<&'value'&>
28153 .cindex "&ACL;" "setting DSCP value"
28154 .cindex "DSCP" "inbound"
28155 This option causes the DSCP value associated with the socket for the inbound
28156 connection to be adjusted to a given value, given as one of a number of fixed
28157 strings or to numeric value.
28158 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28159 Common values include &`throughput`&, &`mincost`&, and on newer systems
28160 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28161
28162 The outbound packets from Exim will be marked with this value in the header
28163 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28164 that these values will have any effect, not be stripped by networking
28165 equipment, or do much of anything without cooperation with your Network
28166 Engineer and those of all network operators between the source and destination.
28167
28168
28169 .vitem &*control&~=&~enforce_sync*& &&&
28170        &*control&~=&~no_enforce_sync*&
28171 .cindex "SMTP" "synchronization checking"
28172 .cindex "synchronization checking in SMTP"
28173 These controls make it possible to be selective about when SMTP synchronization
28174 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28175 state of the switch (it is true by default). See the description of this option
28176 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28177
28178 The effect of these two controls lasts for the remainder of the SMTP
28179 connection. They can appear in any ACL except the one for the non-SMTP
28180 messages. The most straightforward place to put them is in the ACL defined by
28181 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28182 before the first synchronization check. The expected use is to turn off the
28183 synchronization checks for badly-behaved hosts that you nevertheless need to
28184 work with.
28185
28186
28187 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28188 .cindex "fake defer"
28189 .cindex "defer, fake"
28190 This control works in exactly the same way as &%fakereject%& (described below)
28191 except that it causes an SMTP 450 response after the message data instead of a
28192 550 response. You must take care when using &%fakedefer%& because it causes the
28193 messages to be duplicated when the sender retries. Therefore, you should not
28194 use &%fakedefer%& if the message is to be delivered normally.
28195
28196 .vitem &*control&~=&~fakereject/*&<&'message'&>
28197 .cindex "fake rejection"
28198 .cindex "rejection, fake"
28199 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28200 words, only when an SMTP message is being received. If Exim accepts the
28201 message, instead the final 250 response, a 550 rejection message is sent.
28202 However, Exim proceeds to deliver the message as normal. The control applies
28203 only to the current message, not to any subsequent ones that may be received in
28204 the same SMTP connection.
28205
28206 The text for the 550 response is taken from the &%control%& modifier. If no
28207 message is supplied, the following is used:
28208 .code
28209 550-Your message has been rejected but is being
28210 550-kept for evaluation.
28211 550-If it was a legitimate message, it may still be
28212 550 delivered to the target recipient(s).
28213 .endd
28214 This facility should be used with extreme caution.
28215
28216 .vitem &*control&~=&~freeze*&
28217 .cindex "frozen messages" "forcing in ACL"
28218 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28219 other words, only when a message is being received. If the message is accepted,
28220 it is placed on Exim's queue and frozen. The control applies only to the
28221 current message, not to any subsequent ones that may be received in the same
28222 SMTP connection.
28223
28224 This modifier can optionally be followed by &`/no_tell`&. If the global option
28225 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28226 is told about the freezing), provided all the &*control=freeze*& modifiers that
28227 are obeyed for the current message have the &`/no_tell`& option.
28228
28229 .vitem &*control&~=&~no_delay_flush*&
28230 .cindex "SMTP" "output flushing, disabling for delay"
28231 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28232 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28233 use. This control, as long as it is encountered before the &%delay%& modifier,
28234 disables such output flushing.
28235
28236 .vitem &*control&~=&~no_callout_flush*&
28237 .cindex "SMTP" "output flushing, disabling for callout"
28238 Exim normally flushes SMTP output before performing a callout in an ACL, to
28239 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28240 use. This control, as long as it is encountered before the &%verify%& condition
28241 that causes the callout, disables such output flushing.
28242
28243 .vitem &*control&~=&~no_mbox_unspool*&
28244 This control is available when Exim is compiled with the content scanning
28245 extension. Content scanning may require a copy of the current message, or parts
28246 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28247 or spam scanner. Normally, such copies are deleted when they are no longer
28248 needed. If this control is set, the copies are not deleted. The control applies
28249 only to the current message, not to any subsequent ones that may be received in
28250 the same SMTP connection. It is provided for debugging purposes and is unlikely
28251 to be useful in production.
28252
28253 .vitem &*control&~=&~no_multiline_responses*&
28254 .cindex "multiline responses, suppressing"
28255 This control is permitted for any ACL except the one for non-SMTP messages.
28256 It seems that there are broken clients in use that cannot handle multiline
28257 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28258
28259 If this control is set, multiline SMTP responses from ACL rejections are
28260 suppressed. One way of doing this would have been to put out these responses as
28261 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28262 (&"use multiline responses for more"& it says &-- ha!), and some of the
28263 responses might get close to that. So this facility, which is after all only a
28264 sop to broken clients, is implemented by doing two very easy things:
28265
28266 .ilist
28267 Extra information that is normally output as part of a rejection caused by
28268 sender verification failure is omitted. Only the final line (typically &"sender
28269 verification failed"&) is sent.
28270 .next
28271 If a &%message%& modifier supplies a multiline response, only the first
28272 line is output.
28273 .endlist
28274
28275 The setting of the switch can, of course, be made conditional on the
28276 calling host. Its effect lasts until the end of the SMTP connection.
28277
28278 .vitem &*control&~=&~no_pipelining*&
28279 .cindex "PIPELINING" "suppressing advertising"
28280 This control turns off the advertising of the PIPELINING extension to SMTP in
28281 the current session. To be useful, it must be obeyed before Exim sends its
28282 response to an EHLO command. Therefore, it should normally appear in an ACL
28283 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28284 &%pipelining_advertise_hosts%&.
28285
28286 .vitem &*control&~=&~queue_only*&
28287 .oindex "&%queue_only%&"
28288 .cindex "queueing incoming messages"
28289 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28290 other words, only when a message is being received. If the message is accepted,
28291 it is placed on Exim's queue and left there for delivery by a subsequent queue
28292 runner. No immediate delivery process is started. In other words, it has the
28293 effect as the &%queue_only%& global option. However, the control applies only
28294 to the current message, not to any subsequent ones that may be received in the
28295 same SMTP connection.
28296
28297 .vitem &*control&~=&~submission/*&<&'options'&>
28298 .cindex "message" "submission"
28299 .cindex "submission mode"
28300 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28301 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28302 the current message is a submission from a local MUA. In this case, Exim
28303 operates in &"submission mode"&, and applies certain fixups to the message if
28304 necessary. For example, it adds a &'Date:'& header line if one is not present.
28305 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28306 late (the message has already been created).
28307
28308 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28309 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28310 submission mode; the available options for this control are described there.
28311 The control applies only to the current message, not to any subsequent ones
28312 that may be received in the same SMTP connection.
28313
28314 .vitem &*control&~=&~suppress_local_fixups*&
28315 .cindex "submission fixups, suppressing"
28316 This control applies to locally submitted (non TCP/IP) messages, and is the
28317 complement of &`control = submission`&. It disables the fixups that are
28318 normally applied to locally-submitted messages. Specifically:
28319
28320 .ilist
28321 Any &'Sender:'& header line is left alone (in this respect, it is a
28322 dynamic version of &%local_sender_retain%&).
28323 .next
28324 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28325 .next
28326 There is no check that &'From:'& corresponds to the actual sender.
28327 .endlist ilist
28328
28329 This control may be useful when a remotely-originated message is accepted,
28330 passed to some scanning program, and then re-submitted for delivery. It can be
28331 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28332 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28333 data is read.
28334
28335 &*Note:*& This control applies only to the current message, not to any others
28336 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28337 .endlist vlist
28338
28339
28340 .section "Summary of message fixup control" "SECTsummesfix"
28341 All four possibilities for message fixups can be specified:
28342
28343 .ilist
28344 Locally submitted, fixups applied: the default.
28345 .next
28346 Locally submitted, no fixups applied: use
28347 &`control = suppress_local_fixups`&.
28348 .next
28349 Remotely submitted, no fixups applied: the default.
28350 .next
28351 Remotely submitted, fixups applied: use &`control = submission`&.
28352 .endlist
28353
28354
28355
28356 .section "Adding header lines in ACLs" "SECTaddheadacl"
28357 .cindex "header lines" "adding in an ACL"
28358 .cindex "header lines" "position of added lines"
28359 .cindex "&%add_header%& ACL modifier"
28360 The &%add_header%& modifier can be used to add one or more extra header lines
28361 to an incoming message, as in this example:
28362 .code
28363 warn dnslists = sbl.spamhaus.org : \
28364                 dialup.mail-abuse.org
28365      add_header = X-blacklisted-at: $dnslist_domain
28366 .endd
28367 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28368 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28369 receiving a message). The message must ultimately be accepted for
28370 &%add_header%& to have any significant effect. You can use &%add_header%& with
28371 any ACL verb, including &%deny%& (though this is potentially useful only in a
28372 RCPT ACL).
28373
28374 Headers will not be added to the message if the modifier is used in
28375 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28376
28377 Leading and trailing newlines are removed from
28378 the data for the &%add_header%& modifier; if it then
28379 contains one or more newlines that
28380 are not followed by a space or a tab, it is assumed to contain multiple header
28381 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28382 front of any line that is not a valid header line.
28383
28384 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28385 They are added to the message before processing the DATA and MIME ACLs.
28386 However, if an identical header line is requested more than once, only one copy
28387 is actually added to the message. Further header lines may be accumulated
28388 during the DATA and MIME ACLs, after which they are added to the message, again
28389 with duplicates suppressed. Thus, it is possible to add two identical header
28390 lines to an SMTP message, but only if one is added before DATA and one after.
28391 In the case of non-SMTP messages, new headers are accumulated during the
28392 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28393 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28394 are included in the entry that is written to the reject log.
28395
28396 .cindex "header lines" "added; visibility of"
28397 Header lines are not visible in string expansions
28398 of message headers
28399 until they are added to the
28400 message. It follows that header lines defined in the MAIL, RCPT, and predata
28401 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28402 header lines that are added by the DATA or MIME ACLs are not visible in those
28403 ACLs. Because of this restriction, you cannot use header lines as a way of
28404 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28405 this, you can use ACL variables, as described in section
28406 &<<SECTaclvariables>>&.
28407
28408 The list of headers yet to be added is given by the &%$headers_added%& variable.
28409
28410 The &%add_header%& modifier acts immediately as it is encountered during the
28411 processing of an ACL. Notice the difference between these two cases:
28412 .display
28413 &`accept add_header = ADDED: some text`&
28414 &`       `&<&'some condition'&>
28415
28416 &`accept `&<&'some condition'&>
28417 &`       add_header = ADDED: some text`&
28418 .endd
28419 In the first case, the header line is always added, whether or not the
28420 condition is true. In the second case, the header line is added only if the
28421 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28422 ACL statement. All those that are encountered before a condition fails are
28423 honoured.
28424
28425 .cindex "&%warn%& ACL verb"
28426 For compatibility with previous versions of Exim, a &%message%& modifier for a
28427 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28428 effect only if all the conditions are true, even if it appears before some of
28429 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28430 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28431 are present on a &%warn%& verb, both are processed according to their
28432 specifications.
28433
28434 By default, new header lines are added to a message at the end of the existing
28435 header lines. However, you can specify that any particular header line should
28436 be added right at the start (before all the &'Received:'& lines), immediately
28437 after the first block of &'Received:'& lines, or immediately before any line
28438 that is not a &'Received:'& or &'Resent-something:'& header.
28439
28440 This is done by specifying &":at_start:"&, &":after_received:"&, or
28441 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28442 header line, respectively. (Header text cannot start with a colon, as there has
28443 to be a header name first.) For example:
28444 .code
28445 warn add_header = \
28446        :after_received:X-My-Header: something or other...
28447 .endd
28448 If more than one header line is supplied in a single &%add_header%& modifier,
28449 each one is treated independently and can therefore be placed differently. If
28450 you add more than one line at the start, or after the Received: block, they end
28451 up in reverse order.
28452
28453 &*Warning*&: This facility currently applies only to header lines that are
28454 added in an ACL. It does NOT work for header lines that are added in a
28455 system filter or in a router or transport.
28456
28457
28458
28459 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28460 .cindex "header lines" "removing in an ACL"
28461 .cindex "header lines" "position of removed lines"
28462 .cindex "&%remove_header%& ACL modifier"
28463 The &%remove_header%& modifier can be used to remove one or more header lines
28464 from an incoming message, as in this example:
28465 .code
28466 warn   message        = Remove internal headers
28467        remove_header  = x-route-mail1 : x-route-mail2
28468 .endd
28469 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28470 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28471 receiving a message). The message must ultimately be accepted for
28472 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28473 with any ACL verb, including &%deny%&, though this is really not useful for
28474 any verb that doesn't result in a delivered message.
28475
28476 Headers will not be removed to the message if the modifier is used in
28477 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28478
28479 More than one header can be removed at the same time by using a colon separated
28480 list of header names. The header matching is case insensitive. Wildcards are
28481 not permitted, nor is list expansion performed, so you cannot use hostlists to
28482 create a list of headers, however both connection and message variable expansion
28483 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28484 .code
28485 warn   hosts           = +internal_hosts
28486        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28487 warn   message         = Remove internal headers
28488        remove_header   = $acl_c_ihdrs
28489 .endd
28490 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28491 They are removed from the message before processing the DATA and MIME ACLs.
28492 There is no harm in attempting to remove the same header twice nor is removing
28493 a non-existent header. Further header lines to be removed may be accumulated
28494 during the DATA and MIME ACLs, after which they are removed from the message,
28495 if present. In the case of non-SMTP messages, headers to be removed are
28496 accumulated during the non-SMTP ACLs, and are removed from the message after
28497 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28498 ACL, there really is no effect because there is no logging of what headers
28499 would have been removed.
28500
28501 .cindex "header lines" "removed; visibility of"
28502 Header lines are not visible in string expansions until the DATA phase when it
28503 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28504 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28505 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28506 this restriction, you cannot use header lines as a way of controlling data
28507 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28508 you should instead use ACL variables, as described in section
28509 &<<SECTaclvariables>>&.
28510
28511 The &%remove_header%& modifier acts immediately as it is encountered during the
28512 processing of an ACL. Notice the difference between these two cases:
28513 .display
28514 &`accept remove_header = X-Internal`&
28515 &`       `&<&'some condition'&>
28516
28517 &`accept `&<&'some condition'&>
28518 &`       remove_header = X-Internal`&
28519 .endd
28520 In the first case, the header line is always removed, whether or not the
28521 condition is true. In the second case, the header line is removed only if the
28522 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28523 same ACL statement. All those that are encountered before a condition fails
28524 are honoured.
28525
28526 &*Warning*&: This facility currently applies only to header lines that are
28527 present during ACL processing. It does NOT remove header lines that are added
28528 in a system filter or in a router or transport.
28529
28530
28531
28532
28533 .section "ACL conditions" "SECTaclconditions"
28534 .cindex "&ACL;" "conditions; list of"
28535 Some of the conditions listed in this section are available only when Exim is
28536 compiled with the content-scanning extension. They are included here briefly
28537 for completeness. More detailed descriptions can be found in the discussion on
28538 content scanning in chapter &<<CHAPexiscan>>&.
28539
28540 Not all conditions are relevant in all circumstances. For example, testing
28541 senders and recipients does not make sense in an ACL that is being run as the
28542 result of the arrival of an ETRN command, and checks on message headers can be
28543 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28544 can use the same condition (with different parameters) more than once in the
28545 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28546 The conditions are as follows:
28547
28548
28549 .vlist
28550 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28551 .cindex "&ACL;" "nested"
28552 .cindex "&ACL;" "indirect"
28553 .cindex "&ACL;" "arguments"
28554 .cindex "&%acl%& ACL condition"
28555 The possible values of the argument are the same as for the
28556 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28557 &"accept"& the condition is true; if it returns &"deny"& the condition is
28558 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28559 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28560 condition false. This means that further processing of the &%warn%& verb
28561 ceases, but processing of the ACL continues.
28562
28563 If the argument is a named ACL, up to nine space-separated optional values
28564 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28565 and $acl_narg is set to the count of values.
28566 Previous values of these variables are restored after the call returns.
28567 The name and values are expanded separately.
28568 Note that spaces in complex expansions which are used as arguments
28569 will act as argument separators.
28570
28571 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28572 the connection is dropped. If it returns &"discard"&, the verb must be
28573 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28574 conditions are tested.
28575
28576 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28577 loops. This condition allows you to use different ACLs in different
28578 circumstances. For example, different ACLs can be used to handle RCPT commands
28579 for different local users or different local domains.
28580
28581 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28582 .cindex "&%authenticated%& ACL condition"
28583 .cindex "authentication" "ACL checking"
28584 .cindex "&ACL;" "testing for authentication"
28585 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28586 the name of the authenticator is tested against the list. To test for
28587 authentication by any authenticator, you can set
28588 .code
28589 authenticated = *
28590 .endd
28591
28592 .vitem &*condition&~=&~*&<&'string'&>
28593 .cindex "&%condition%& ACL condition"
28594 .cindex "customizing" "ACL condition"
28595 .cindex "&ACL;" "customized test"
28596 .cindex "&ACL;" "testing, customized"
28597 This feature allows you to make up custom conditions. If the result of
28598 expanding the string is an empty string, the number zero, or one of the strings
28599 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28600 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28601 any other value, some error is assumed to have occurred, and the ACL returns
28602 &"defer"&. However, if the expansion is forced to fail, the condition is
28603 ignored. The effect is to treat it as true, whether it is positive or
28604 negative.
28605
28606 .vitem &*decode&~=&~*&<&'location'&>
28607 .cindex "&%decode%& ACL condition"
28608 This condition is available only when Exim is compiled with the
28609 content-scanning extension, and it is allowed only in the ACL defined by
28610 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28611 If all goes well, the condition is true. It is false only if there are
28612 problems such as a syntax error or a memory shortage. For more details, see
28613 chapter &<<CHAPexiscan>>&.
28614
28615 .vitem &*demime&~=&~*&<&'extension&~list'&>
28616 .cindex "&%demime%& ACL condition"
28617 This condition is available only when Exim is compiled with the
28618 content-scanning extension. Its use is described in section
28619 &<<SECTdemimecond>>&.
28620
28621 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28622 .cindex "&%dnslists%& ACL condition"
28623 .cindex "DNS list" "in ACL"
28624 .cindex "black list (DNS)"
28625 .cindex "&ACL;" "testing a DNS list"
28626 This condition checks for entries in DNS black lists. These are also known as
28627 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28628 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28629 different variants of this condition to describe briefly here. See sections
28630 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28631
28632 .vitem &*domains&~=&~*&<&'domain&~list'&>
28633 .cindex "&%domains%& ACL condition"
28634 .cindex "domain" "ACL checking"
28635 .cindex "&ACL;" "testing a recipient domain"
28636 .vindex "&$domain_data$&"
28637 This condition is relevant only after a RCPT command. It checks that the domain
28638 of the recipient address is in the domain list. If percent-hack processing is
28639 enabled, it is done before this test is done. If the check succeeds with a
28640 lookup, the result of the lookup is placed in &$domain_data$& until the next
28641 &%domains%& test.
28642
28643 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28644 use &%domains%& in a DATA ACL.
28645
28646
28647 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28648 .cindex "&%encrypted%& ACL condition"
28649 .cindex "encryption" "checking in an ACL"
28650 .cindex "&ACL;" "testing for encryption"
28651 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28652 name of the cipher suite in use is tested against the list. To test for
28653 encryption without testing for any specific cipher suite(s), set
28654 .code
28655 encrypted = *
28656 .endd
28657
28658
28659 .vitem &*hosts&~=&~*&<&'host&~list'&>
28660 .cindex "&%hosts%& ACL condition"
28661 .cindex "host" "ACL checking"
28662 .cindex "&ACL;" "testing the client host"
28663 This condition tests that the calling host matches the host list. If you have
28664 name lookups or wildcarded host names and IP addresses in the same host list,
28665 you should normally put the IP addresses first. For example, you could have:
28666 .code
28667 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28668 .endd
28669 The lookup in this example uses the host name for its key. This is implied by
28670 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28671 and it wouldn't matter which way round you had these two items.)
28672
28673 The reason for the problem with host names lies in the left-to-right way that
28674 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28675 but when it reaches an item that requires a host name, it fails if it cannot
28676 find a host name to compare with the pattern. If the above list is given in the
28677 opposite order, the &%accept%& statement fails for a host whose name cannot be
28678 found, even if its IP address is 10.9.8.7.
28679
28680 If you really do want to do the name check first, and still recognize the IP
28681 address even if the name lookup fails, you can rewrite the ACL like this:
28682 .code
28683 accept hosts = dbm;/etc/friendly/hosts
28684 accept hosts = 10.9.8.7
28685 .endd
28686 The default action on failing to find the host name is to assume that the host
28687 is not in the list, so the first &%accept%& statement fails. The second
28688 statement can then check the IP address.
28689
28690 .vindex "&$host_data$&"
28691 If a &%hosts%& condition is satisfied by means of a lookup, the result
28692 of the lookup is made available in the &$host_data$& variable. This
28693 allows you, for example, to set up a statement like this:
28694 .code
28695 deny  hosts = net-lsearch;/some/file
28696 message = $host_data
28697 .endd
28698 which gives a custom error message for each denied host.
28699
28700 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28701 .cindex "&%local_parts%& ACL condition"
28702 .cindex "local part" "ACL checking"
28703 .cindex "&ACL;" "testing a local part"
28704 .vindex "&$local_part_data$&"
28705 This condition is relevant only after a RCPT command. It checks that the local
28706 part of the recipient address is in the list. If percent-hack processing is
28707 enabled, it is done before this test. If the check succeeds with a lookup, the
28708 result of the lookup is placed in &$local_part_data$&, which remains set until
28709 the next &%local_parts%& test.
28710
28711 .vitem &*malware&~=&~*&<&'option'&>
28712 .cindex "&%malware%& ACL condition"
28713 .cindex "&ACL;" "virus scanning"
28714 .cindex "&ACL;" "scanning for viruses"
28715 This condition is available only when Exim is compiled with the
28716 content-scanning extension. It causes the incoming message to be scanned for
28717 viruses. For details, see chapter &<<CHAPexiscan>>&.
28718
28719 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28720 .cindex "&%mime_regex%& ACL condition"
28721 .cindex "&ACL;" "testing by regex matching"
28722 This condition is available only when Exim is compiled with the
28723 content-scanning extension, and it is allowed only in the ACL defined by
28724 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28725 with any of the regular expressions. For details, see chapter
28726 &<<CHAPexiscan>>&.
28727
28728 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28729 .cindex "rate limiting"
28730 This condition can be used to limit the rate at which a user or host submits
28731 messages. Details are given in section &<<SECTratelimiting>>&.
28732
28733 .vitem &*recipients&~=&~*&<&'address&~list'&>
28734 .cindex "&%recipients%& ACL condition"
28735 .cindex "recipient" "ACL checking"
28736 .cindex "&ACL;" "testing a recipient"
28737 This condition is relevant only after a RCPT command. It checks the entire
28738 recipient address against a list of recipients.
28739
28740 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28741 .cindex "&%regex%& ACL condition"
28742 .cindex "&ACL;" "testing by regex matching"
28743 This condition is available only when Exim is compiled with the
28744 content-scanning extension, and is available only in the DATA, MIME, and
28745 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28746 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28747
28748 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28749 .cindex "&%sender_domains%& ACL condition"
28750 .cindex "sender" "ACL checking"
28751 .cindex "&ACL;" "testing a sender domain"
28752 .vindex "&$domain$&"
28753 .vindex "&$sender_address_domain$&"
28754 This condition tests the domain of the sender of the message against the given
28755 domain list. &*Note*&: The domain of the sender address is in
28756 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28757 of this condition. This is an exception to the general rule for testing domain
28758 lists. It is done this way so that, if this condition is used in an ACL for a
28759 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28760 influence the sender checking.
28761
28762 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28763 relaying, because sender addresses are easily, and commonly, forged.
28764
28765 .vitem &*senders&~=&~*&<&'address&~list'&>
28766 .cindex "&%senders%& ACL condition"
28767 .cindex "sender" "ACL checking"
28768 .cindex "&ACL;" "testing a sender"
28769 This condition tests the sender of the message against the given list. To test
28770 for a bounce message, which has an empty sender, set
28771 .code
28772 senders = :
28773 .endd
28774 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28775 relaying, because sender addresses are easily, and commonly, forged.
28776
28777 .vitem &*spam&~=&~*&<&'username'&>
28778 .cindex "&%spam%& ACL condition"
28779 .cindex "&ACL;" "scanning for spam"
28780 This condition is available only when Exim is compiled with the
28781 content-scanning extension. It causes the incoming message to be scanned by
28782 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28783
28784 .vitem &*verify&~=&~certificate*&
28785 .cindex "&%verify%& ACL condition"
28786 .cindex "TLS" "client certificate verification"
28787 .cindex "certificate" "verification of client"
28788 .cindex "&ACL;" "certificate verification"
28789 .cindex "&ACL;" "testing a TLS certificate"
28790 This condition is true in an SMTP session if the session is encrypted, and a
28791 certificate was received from the client, and the certificate was verified. The
28792 server requests a certificate only if the client matches &%tls_verify_hosts%&
28793 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28794
28795 .vitem &*verify&~=&~csa*&
28796 .cindex "CSA verification"
28797 This condition checks whether the sending host (the client) is authorized to
28798 send email. Details of how this works are given in section
28799 &<<SECTverifyCSA>>&.
28800
28801 .vitem &*verify&~=&~header_names_ascii*&
28802 .cindex "&%verify%& ACL condition"
28803 .cindex "&ACL;" "verifying header names only ASCII"
28804 .cindex "header lines" "verifying header names only ASCII"
28805 .cindex "verifying" "header names only ASCII"
28806 This condition is relevant only in an ACL that is run after a message has been
28807 received, that is, in an ACL specified by &%acl_smtp_data%& or
28808 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28809 there are no non-ASCII characters, also excluding control characters.  The
28810 allowable characters are decimal ASCII values 33 through 126.
28811
28812 Exim itself will handle headers with non-ASCII characters, but it can cause
28813 problems for downstream applications, so this option will allow their
28814 detection and rejection in the DATA ACL's.
28815
28816 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28817 .cindex "&%verify%& ACL condition"
28818 .cindex "&ACL;" "verifying sender in the header"
28819 .cindex "header lines" "verifying the sender in"
28820 .cindex "sender" "verifying in header"
28821 .cindex "verifying" "sender in header"
28822 This condition is relevant only in an ACL that is run after a message has been
28823 received, that is, in an ACL specified by &%acl_smtp_data%& or
28824 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28825 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28826 is loosely thought of as a &"sender"& address (hence the name of the test).
28827 However, an address that appears in one of these headers need not be an address
28828 that accepts bounce messages; only sender addresses in envelopes are required
28829 to accept bounces. Therefore, if you use the callout option on this check, you
28830 might want to arrange for a non-empty address in the MAIL command.
28831
28832 Details of address verification and the options are given later, starting at
28833 section &<<SECTaddressverification>>& (callouts are described in section
28834 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28835 condition to restrict it to bounce messages only:
28836 .code
28837 deny    senders = :
28838         message = A valid sender header is required for bounces
28839        !verify  = header_sender
28840 .endd
28841
28842 .vitem &*verify&~=&~header_syntax*&
28843 .cindex "&%verify%& ACL condition"
28844 .cindex "&ACL;" "verifying header syntax"
28845 .cindex "header lines" "verifying syntax"
28846 .cindex "verifying" "header syntax"
28847 This condition is relevant only in an ACL that is run after a message has been
28848 received, that is, in an ACL specified by &%acl_smtp_data%& or
28849 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28850 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28851 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28852 permitted only in locally generated messages and from hosts that match
28853 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28854 appropriate.
28855
28856 Note that this condition is a syntax check only. However, a common spamming
28857 ploy used to be to send syntactically invalid headers such as
28858 .code
28859 To: @
28860 .endd
28861 and this condition can be used to reject such messages, though they are not as
28862 common as they used to be.
28863
28864 .vitem &*verify&~=&~helo*&
28865 .cindex "&%verify%& ACL condition"
28866 .cindex "&ACL;" "verifying HELO/EHLO"
28867 .cindex "HELO" "verifying"
28868 .cindex "EHLO" "verifying"
28869 .cindex "verifying" "EHLO"
28870 .cindex "verifying" "HELO"
28871 This condition is true if a HELO or EHLO command has been received from the
28872 client host, and its contents have been verified. If there has been no previous
28873 attempt to verify the HELO/EHLO contents, it is carried out when this
28874 condition is encountered. See the description of the &%helo_verify_hosts%& and
28875 &%helo_try_verify_hosts%& options for details of how to request verification
28876 independently of this condition.
28877
28878 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28879 option), this condition is always true.
28880
28881
28882 .vitem &*verify&~=&~not_blind*&
28883 .cindex "verifying" "not blind"
28884 .cindex "bcc recipients, verifying none"
28885 This condition checks that there are no blind (bcc) recipients in the message.
28886 Every envelope recipient must appear either in a &'To:'& header line or in a
28887 &'Cc:'& header line for this condition to be true. Local parts are checked
28888 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28889 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28890 used only in a DATA or non-SMTP ACL.
28891
28892 There are, of course, many legitimate messages that make use of blind (bcc)
28893 recipients. This check should not be used on its own for blocking messages.
28894
28895
28896 .vitem &*verify&~=&~recipient/*&<&'options'&>
28897 .cindex "&%verify%& ACL condition"
28898 .cindex "&ACL;" "verifying recipient"
28899 .cindex "recipient" "verifying"
28900 .cindex "verifying" "recipient"
28901 .vindex "&$address_data$&"
28902 This condition is relevant only after a RCPT command. It verifies the current
28903 recipient. Details of address verification are given later, starting at section
28904 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28905 of &$address_data$& is the last value that was set while routing the address.
28906 This applies even if the verification fails. When an address that is being
28907 verified is redirected to a single address, verification continues with the new
28908 address, and in that case, the subsequent value of &$address_data$& is the
28909 value for the child address.
28910
28911 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
28912 .cindex "&%verify%& ACL condition"
28913 .cindex "&ACL;" "verifying host reverse lookup"
28914 .cindex "host" "verifying reverse lookup"
28915 This condition ensures that a verified host name has been looked up from the IP
28916 address of the client host. (This may have happened already if the host name
28917 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28918 Verification ensures that the host name obtained from a reverse DNS lookup, or
28919 one of its aliases, does, when it is itself looked up in the DNS, yield the
28920 original IP address.
28921
28922 There is one possible option, &`defer_ok`&.  If this is present and a
28923 DNS operation returns a temporary error, the verify condition succeeds.
28924
28925 If this condition is used for a locally generated message (that is, when there
28926 is no client host involved), it always succeeds.
28927
28928 .vitem &*verify&~=&~sender/*&<&'options'&>
28929 .cindex "&%verify%& ACL condition"
28930 .cindex "&ACL;" "verifying sender"
28931 .cindex "sender" "verifying"
28932 .cindex "verifying" "sender"
28933 This condition is relevant only after a MAIL or RCPT command, or after a
28934 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28935 the message's sender is empty (that is, this is a bounce message), the
28936 condition is true. Otherwise, the sender address is verified.
28937
28938 .vindex "&$address_data$&"
28939 .vindex "&$sender_address_data$&"
28940 If there is data in the &$address_data$& variable at the end of routing, its
28941 value is placed in &$sender_address_data$& at the end of verification. This
28942 value can be used in subsequent conditions and modifiers in the same ACL
28943 statement. It does not persist after the end of the current statement. If you
28944 want to preserve the value for longer, you can save it in an ACL variable.
28945
28946 Details of verification are given later, starting at section
28947 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28948 to avoid doing it more than once per message.
28949
28950 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28951 .cindex "&%verify%& ACL condition"
28952 This is a variation of the previous option, in which a modified address is
28953 verified as a sender.
28954 .endlist
28955
28956
28957
28958 .section "Using DNS lists" "SECTmorednslists"
28959 .cindex "DNS list" "in ACL"
28960 .cindex "black list (DNS)"
28961 .cindex "&ACL;" "testing a DNS list"
28962 In its simplest form, the &%dnslists%& condition tests whether the calling host
28963 is on at least one of a number of DNS lists by looking up the inverted IP
28964 address in one or more DNS domains. (Note that DNS list domains are not mail
28965 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28966 special options instead.) For example, if the calling host's IP
28967 address is 192.168.62.43, and the ACL statement is
28968 .code
28969 deny dnslists = blackholes.mail-abuse.org : \
28970                 dialups.mail-abuse.org
28971 .endd
28972 the following records are looked up:
28973 .code
28974 43.62.168.192.blackholes.mail-abuse.org
28975 43.62.168.192.dialups.mail-abuse.org
28976 .endd
28977 As soon as Exim finds an existing DNS record, processing of the list stops.
28978 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28979 to test that a host is on more than one list (an &"and"& conjunction), you can
28980 use two separate conditions:
28981 .code
28982 deny dnslists = blackholes.mail-abuse.org
28983      dnslists = dialups.mail-abuse.org
28984 .endd
28985 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28986 behaves as if the host does not match the list item, that is, as if the DNS
28987 record does not exist. If there are further items in the DNS list, they are
28988 processed.
28989
28990 This is usually the required action when &%dnslists%& is used with &%deny%&
28991 (which is the most common usage), because it prevents a DNS failure from
28992 blocking mail. However, you can change this behaviour by putting one of the
28993 following special items in the list:
28994 .display
28995 &`+include_unknown `&   behave as if the item is on the list
28996 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28997 &`+defer_unknown   `&   give a temporary error
28998 .endd
28999 .cindex "&`+include_unknown`&"
29000 .cindex "&`+exclude_unknown`&"
29001 .cindex "&`+defer_unknown`&"
29002 Each of these applies to any subsequent items on the list. For example:
29003 .code
29004 deny dnslists = +defer_unknown : foo.bar.example
29005 .endd
29006 Testing the list of domains stops as soon as a match is found. If you want to
29007 warn for one list and block for another, you can use two different statements:
29008 .code
29009 deny  dnslists = blackholes.mail-abuse.org
29010 warn  message  = X-Warn: sending host is on dialups list
29011       dnslists = dialups.mail-abuse.org
29012 .endd
29013 DNS list lookups are cached by Exim for the duration of the SMTP session,
29014 so a lookup based on the IP address is done at most once for any incoming
29015 connection. Exim does not share information between multiple incoming
29016 connections (but your local name server cache should be active).
29017
29018
29019
29020 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29021 .cindex "DNS list" "keyed by explicit IP address"
29022 By default, the IP address that is used in a DNS list lookup is the IP address
29023 of the calling host. However, you can specify another IP address by listing it
29024 after the domain name, introduced by a slash. For example:
29025 .code
29026 deny dnslists = black.list.tld/192.168.1.2
29027 .endd
29028 This feature is not very helpful with explicit IP addresses; it is intended for
29029 use with IP addresses that are looked up, for example, the IP addresses of the
29030 MX hosts or nameservers of an email sender address. For an example, see section
29031 &<<SECTmulkeyfor>>& below.
29032
29033
29034
29035
29036 .section "DNS lists keyed on domain names" "SECID202"
29037 .cindex "DNS list" "keyed by domain name"
29038 There are some lists that are keyed on domain names rather than inverted IP
29039 addresses (see for example the &'domain based zones'& link at
29040 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29041 with these lists. You can change the name that is looked up in a DNS list by
29042 listing it after the domain name, introduced by a slash. For example,
29043 .code
29044 deny  message  = Sender's domain is listed at $dnslist_domain
29045       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29046 .endd
29047 This particular example is useful only in ACLs that are obeyed after the
29048 RCPT or DATA commands, when a sender address is available. If (for
29049 example) the message's sender is &'user@tld.example'& the name that is looked
29050 up by this example is
29051 .code
29052 tld.example.dsn.rfc-ignorant.org
29053 .endd
29054 A single &%dnslists%& condition can contain entries for both names and IP
29055 addresses. For example:
29056 .code
29057 deny dnslists = sbl.spamhaus.org : \
29058                 dsn.rfc-ignorant.org/$sender_address_domain
29059 .endd
29060 The first item checks the sending host's IP address; the second checks a domain
29061 name. The whole condition is true if either of the DNS lookups succeeds.
29062
29063
29064
29065
29066 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29067 .cindex "DNS list" "multiple keys for"
29068 The syntax described above for looking up explicitly-defined values (either
29069 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29070 name for the DNS list, what follows the slash can in fact be a list of items.
29071 As with all lists in Exim, the default separator is a colon. However, because
29072 this is a sublist within the list of DNS blacklist domains, it is necessary
29073 either to double the separators like this:
29074 .code
29075 dnslists = black.list.tld/name.1::name.2
29076 .endd
29077 or to change the separator character, like this:
29078 .code
29079 dnslists = black.list.tld/<;name.1;name.2
29080 .endd
29081 If an item in the list is an IP address, it is inverted before the DNS
29082 blacklist domain is appended. If it is not an IP address, no inversion
29083 occurs. Consider this condition:
29084 .code
29085 dnslists = black.list.tld/<;192.168.1.2;a.domain
29086 .endd
29087 The DNS lookups that occur are:
29088 .code
29089 2.1.168.192.black.list.tld
29090 a.domain.black.list.tld
29091 .endd
29092 Once a DNS record has been found (that matches a specific IP return
29093 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29094 are done. If there is a temporary DNS error, the rest of the sublist of domains
29095 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29096 only if no other DNS lookup in this sublist succeeds. In other words, a
29097 successful lookup for any of the items in the sublist overrides a temporary
29098 error for a previous item.
29099
29100 The ability to supply a list of items after the slash is in some sense just a
29101 syntactic convenience. These two examples have the same effect:
29102 .code
29103 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29104 dnslists = black.list.tld/a.domain::b.domain
29105 .endd
29106 However, when the data for the list is obtained from a lookup, the second form
29107 is usually much more convenient. Consider this example:
29108 .code
29109 deny message  = The mail servers for the domain \
29110                 $sender_address_domain \
29111                 are listed at $dnslist_domain ($dnslist_value); \
29112                 see $dnslist_text.
29113      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29114                                    ${lookup dnsdb {>|mxh=\
29115                                    $sender_address_domain} }} }
29116 .endd
29117 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29118 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29119 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29120 of expanding the condition might be something like this:
29121 .code
29122 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29123 .endd
29124 Thus, this example checks whether or not the IP addresses of the sender
29125 domain's mail servers are on the Spamhaus black list.
29126
29127 The key that was used for a successful DNS list lookup is put into the variable
29128 &$dnslist_matched$& (see section &<<SECID204>>&).
29129
29130
29131
29132
29133 .section "Data returned by DNS lists" "SECID203"
29134 .cindex "DNS list" "data returned from"
29135 DNS lists are constructed using address records in the DNS. The original RBL
29136 just used the address 127.0.0.1 on the right hand side of each record, but the
29137 RBL+ list and some other lists use a number of values with different meanings.
29138 The values used on the RBL+ list are:
29139 .display
29140 127.1.0.1  RBL
29141 127.1.0.2  DUL
29142 127.1.0.3  DUL and RBL
29143 127.1.0.4  RSS
29144 127.1.0.5  RSS and RBL
29145 127.1.0.6  RSS and DUL
29146 127.1.0.7  RSS and DUL and RBL
29147 .endd
29148 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29149 different values. Some DNS lists may return more than one address record;
29150 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29151
29152
29153 .section "Variables set from DNS lists" "SECID204"
29154 .cindex "expansion" "variables, set from DNS list"
29155 .cindex "DNS list" "variables set from"
29156 .vindex "&$dnslist_domain$&"
29157 .vindex "&$dnslist_matched$&"
29158 .vindex "&$dnslist_text$&"
29159 .vindex "&$dnslist_value$&"
29160 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29161 the name of the overall domain that matched (for example,
29162 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29163 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29164 the DNS record. When the key is an IP address, it is not reversed in
29165 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29166 cases, for example:
29167 .code
29168 deny dnslists = spamhaus.example
29169 .endd
29170 the key is also available in another variable (in this case,
29171 &$sender_host_address$&). In more complicated cases, however, this is not true.
29172 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29173 might generate a dnslists lookup like this:
29174 .code
29175 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29176 .endd
29177 If this condition succeeds, the value in &$dnslist_matched$& might be
29178 &`192.168.6.7`& (for example).
29179
29180 If more than one address record is returned by the DNS lookup, all the IP
29181 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29182 The variable &$dnslist_text$& contains the contents of any associated TXT
29183 record. For lists such as RBL+ the TXT record for a merged entry is often not
29184 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29185 information.
29186
29187 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29188 &-- although these appear before the condition in the ACL, they are not
29189 expanded until after it has failed. For example:
29190 .code
29191 deny    hosts = !+local_networks
29192         message = $sender_host_address is listed \
29193                   at $dnslist_domain
29194         dnslists = rbl-plus.mail-abuse.example
29195 .endd
29196
29197
29198
29199 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29200 .cindex "DNS list" "matching specific returned data"
29201 You can add an equals sign and an IP address after a &%dnslists%& domain name
29202 in order to restrict its action to DNS records with a matching right hand side.
29203 For example,
29204 .code
29205 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29206 .endd
29207 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29208 any address record is considered to be a match. For the moment, we assume
29209 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29210 describes how multiple records are handled.
29211
29212 More than one IP address may be given for checking, using a comma as a
29213 separator. These are alternatives &-- if any one of them matches, the
29214 &%dnslists%& condition is true. For example:
29215 .code
29216 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29217 .endd
29218 If you want to specify a constraining address list and also specify names or IP
29219 addresses to be looked up, the constraining address list must be specified
29220 first. For example:
29221 .code
29222 deny dnslists = dsn.rfc-ignorant.org\
29223                 =127.0.0.2/$sender_address_domain
29224 .endd
29225
29226 If the character &`&&`& is used instead of &`=`&, the comparison for each
29227 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29228 In other words, the listed addresses are used as bit masks. The comparison is
29229 true if all the bits in the mask are present in the address that is being
29230 tested. For example:
29231 .code
29232 dnslists = a.b.c&0.0.0.3
29233 .endd
29234 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29235 want to test whether one bit or another bit is present (as opposed to both
29236 being present), you must use multiple values. For example:
29237 .code
29238 dnslists = a.b.c&0.0.0.1,0.0.0.2
29239 .endd
29240 matches if the final component of the address is an odd number or two times
29241 an odd number.
29242
29243
29244
29245 .section "Negated DNS matching conditions" "SECID205"
29246 You can supply a negative list of IP addresses as part of a &%dnslists%&
29247 condition. Whereas
29248 .code
29249 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29250 .endd
29251 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29252 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29253 .code
29254 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29255 .endd
29256 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29257 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29258 words, the result of the test is inverted if an exclamation mark appears before
29259 the &`=`& (or the &`&&`&) sign.
29260
29261 &*Note*&: This kind of negation is not the same as negation in a domain,
29262 host, or address list (which is why the syntax is different).
29263
29264 If you are using just one list, the negation syntax does not gain you much. The
29265 previous example is precisely equivalent to
29266 .code
29267 deny  dnslists = a.b.c
29268      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29269 .endd
29270 However, if you are using multiple lists, the negation syntax is clearer.
29271 Consider this example:
29272 .code
29273 deny  dnslists = sbl.spamhaus.org : \
29274                  list.dsbl.org : \
29275                  dnsbl.njabl.org!=127.0.0.3 : \
29276                  relays.ordb.org
29277 .endd
29278 Using only positive lists, this would have to be:
29279 .code
29280 deny  dnslists = sbl.spamhaus.org : \
29281                  list.dsbl.org
29282 deny  dnslists = dnsbl.njabl.org
29283      !dnslists = dnsbl.njabl.org=127.0.0.3
29284 deny  dnslists = relays.ordb.org
29285 .endd
29286 which is less clear, and harder to maintain.
29287
29288
29289
29290
29291 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29292 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29293 thereby providing more than one IP address. When an item in a &%dnslists%& list
29294 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29295 the match to specific results from the DNS lookup, there are two ways in which
29296 the checking can be handled. For example, consider the condition:
29297 .code
29298 dnslists = a.b.c=127.0.0.1
29299 .endd
29300 What happens if the DNS lookup for the incoming IP address yields both
29301 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29302 condition true because at least one given value was found, or is it false
29303 because at least one of the found values was not listed? And how does this
29304 affect negated conditions? Both possibilities are provided for with the help of
29305 additional separators &`==`& and &`=&&`&.
29306
29307 .ilist
29308 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29309 IP addresses matches one of the listed addresses. For the example above, the
29310 condition is true because 127.0.0.1 matches.
29311 .next
29312 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29313 looked up IP addresses matches one of the listed addresses. If the condition is
29314 changed to:
29315 .code
29316 dnslists = a.b.c==127.0.0.1
29317 .endd
29318 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29319 false because 127.0.0.2 is not listed. You would need to have:
29320 .code
29321 dnslists = a.b.c==127.0.0.1,127.0.0.2
29322 .endd
29323 for the condition to be true.
29324 .endlist
29325
29326 When &`!`& is used to negate IP address matching, it inverts the result, giving
29327 the precise opposite of the behaviour above. Thus:
29328 .ilist
29329 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29330 addresses matches one of the listed addresses. Consider:
29331 .code
29332 dnslists = a.b.c!&0.0.0.1
29333 .endd
29334 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29335 false because 127.0.0.1 matches.
29336 .next
29337 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29338 looked up IP address that does not match. Consider:
29339 .code
29340 dnslists = a.b.c!=&0.0.0.1
29341 .endd
29342 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29343 true, because 127.0.0.2 does not match. You would need to have:
29344 .code
29345 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29346 .endd
29347 for the condition to be false.
29348 .endlist
29349 When the DNS lookup yields only a single IP address, there is no difference
29350 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29351
29352
29353
29354
29355 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29356 .cindex "DNS list" "information from merged"
29357 When the facility for restricting the matching IP values in a DNS list is used,
29358 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29359 the true reason for rejection. This happens when lists are merged and the IP
29360 address in the A record is used to distinguish them; unfortunately there is
29361 only one TXT record. One way round this is not to use merged lists, but that
29362 can be inefficient because it requires multiple DNS lookups where one would do
29363 in the vast majority of cases when the host of interest is not on any of the
29364 lists.
29365
29366 A less inefficient way of solving this problem is available. If
29367 two domain names, comma-separated, are given, the second is used first to
29368 do an initial check, making use of any IP value restrictions that are set.
29369 If there is a match, the first domain is used, without any IP value
29370 restrictions, to get the TXT record. As a byproduct of this, there is also
29371 a check that the IP being tested is indeed on the first list. The first
29372 domain is the one that is put in &$dnslist_domain$&. For example:
29373 .code
29374 reject message  = \
29375          rejected because $sender_host_address is blacklisted \
29376          at $dnslist_domain\n$dnslist_text
29377        dnslists = \
29378          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29379          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29380 .endd
29381 For the first blacklist item, this starts by doing a lookup in
29382 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29383 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29384 value, and as long as something is found, it looks for the corresponding TXT
29385 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29386 The second blacklist item is processed similarly.
29387
29388 If you are interested in more than one merged list, the same list must be
29389 given several times, but because the results of the DNS lookups are cached,
29390 the DNS calls themselves are not repeated. For example:
29391 .code
29392 reject dnslists = \
29393          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29394          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29395          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29396          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29397 .endd
29398 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29399 values matches (or if no record is found), this is the only lookup that is
29400 done. Only if there is a match is one of the more specific lists consulted.
29401
29402
29403
29404 .section "DNS lists and IPv6" "SECTmorednslistslast"
29405 .cindex "IPv6" "DNS black lists"
29406 .cindex "DNS list" "IPv6 usage"
29407 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29408 nibble by nibble. For example, if the calling host's IP address is
29409 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29410 .code
29411 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29412   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29413 .endd
29414 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29415 lists contain wildcard records, intended for IPv4, that interact badly with
29416 IPv6. For example, the DNS entry
29417 .code
29418 *.3.some.list.example.    A    127.0.0.1
29419 .endd
29420 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29421 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29422
29423 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29424 &%condition%& condition, as in this example:
29425 .code
29426 deny   condition = ${if isip4{$sender_host_address}}
29427        dnslists  = some.list.example
29428 .endd
29429
29430 If an explicit key is being used for a DNS lookup and it may be an IPv6
29431 address you should specify alternate list separators for both the outer
29432 (DNS list name) list and inner (lookup keys) list:
29433 .code
29434        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29435 .endd
29436
29437 .section "Rate limiting incoming messages" "SECTratelimiting"
29438 .cindex "rate limiting" "client sending"
29439 .cindex "limiting client sending rates"
29440 .oindex "&%smtp_ratelimit_*%&"
29441 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29442 which clients can send email. This is more powerful than the
29443 &%smtp_ratelimit_*%& options, because those options control the rate of
29444 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29445 works across all connections (concurrent and sequential) from the same client
29446 host. The syntax of the &%ratelimit%& condition is:
29447 .display
29448 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29449 .endd
29450 If the average client sending rate is less than &'m'& messages per time
29451 period &'p'& then the condition is false; otherwise it is true.
29452
29453 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29454 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29455 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29456 of &'p'&.
29457
29458 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29459 time interval, for example, &`8h`& for eight hours. A larger time constant
29460 means that it takes Exim longer to forget a client's past behaviour. The
29461 parameter &'m'& is the maximum number of messages that a client is permitted to
29462 send in each time interval. It also specifies the number of messages permitted
29463 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29464 constant, you can allow a client to send more messages in a burst without
29465 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29466 both small, messages must be sent at an even rate.
29467
29468 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29469 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29470 when deploying the &%ratelimit%& ACL condition. The script prints usage
29471 instructions when it is run with no arguments.
29472
29473 The key is used to look up the data for calculating the client's average
29474 sending rate. This data is stored in Exim's spool directory, alongside the
29475 retry and other hints databases. The default key is &$sender_host_address$&,
29476 which means Exim computes the sending rate of each client host IP address.
29477 By changing the key you can change how Exim identifies clients for the purpose
29478 of ratelimiting. For example, to limit the sending rate of each authenticated
29479 user, independent of the computer they are sending from, set the key to
29480 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29481 example, &$authenticated_id$& is only meaningful if the client has
29482 authenticated (which you can check with the &%authenticated%& ACL condition).
29483
29484 The lookup key does not have to identify clients: If you want to limit the
29485 rate at which a recipient receives messages, you can use the key
29486 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29487 ACL.
29488
29489 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29490 specifies what Exim measures the rate of, for example messages or recipients
29491 or bytes. You can adjust the measurement using the &%unique=%& and/or
29492 &%count=%& options. You can also control when Exim updates the recorded rate
29493 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29494 separated by a slash, like the other parameters. They may appear in any order.
29495
29496 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29497 any options that alter the meaning of the stored data. The limit &'m'& is not
29498 stored, so you can alter the configured maximum rate and Exim will still
29499 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29500 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29501 behaviour. The lookup key is not affected by changes to the update mode and
29502 the &%count=%& option.
29503
29504
29505 .section "Ratelimit options for what is being measured" "ratoptmea"
29506 .cindex "rate limiting" "per_* options"
29507 The &%per_conn%& option limits the client's connection rate. It is not
29508 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29509 &%acl_not_smtp_start%& ACLs.
29510
29511 The &%per_mail%& option limits the client's rate of sending messages. This is
29512 the default if none of the &%per_*%& options is specified. It can be used in
29513 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29514 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29515
29516 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29517 the same ACLs as the &%per_mail%& option, though it is best to use this option
29518 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29519 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29520 in its MAIL command, which may be inaccurate or completely missing. You can
29521 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29522 in kilobytes, megabytes, or gigabytes, respectively.
29523
29524 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29525 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29526 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29527 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29528 ACLs the rate is updated with the total recipient count in one go. Note that
29529 in either case the rate limiting engine will see a message with many
29530 recipients as a large high-speed burst.
29531
29532 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29533 number of different recipients that the client has sent messages to in the
29534 last time period. That is, if the client repeatedly sends messages to the same
29535 recipient, its measured rate is not increased. This option can only be used in
29536 &%acl_smtp_rcpt%&.
29537
29538 The &%per_cmd%& option causes Exim to recompute the rate every time the
29539 condition is processed. This can be used to limit the rate of any SMTP
29540 command. If it is used in multiple ACLs it can limit the aggregate rate of
29541 multiple different commands.
29542
29543 The &%count=%& option can be used to alter how much Exim adds to the client's
29544 measured rate. For example, the &%per_byte%& option is equivalent to
29545 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29546 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29547 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29548
29549 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29550
29551
29552 .section "Ratelimit update modes" "ratoptupd"
29553 .cindex "rate limiting" "reading data without updating"
29554 You can specify one of three options with the &%ratelimit%& condition to
29555 control when its database is updated. This section describes the &%readonly%&
29556 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29557
29558 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29559 previously-computed rate to check against the limit.
29560
29561 For example, you can test the client's sending rate and deny it access (when
29562 it is too fast) in the connect ACL. If the client passes this check then it
29563 can go on to send a message, in which case its recorded rate will be updated
29564 in the MAIL ACL. Subsequent connections from the same client will check this
29565 new rate.
29566 .code
29567 acl_check_connect:
29568  deny ratelimit = 100 / 5m / readonly
29569     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29570                   (max $sender_rate_limit)
29571 # ...
29572 acl_check_mail:
29573  warn ratelimit = 100 / 5m / strict
29574     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29575                   (max $sender_rate_limit)
29576 .endd
29577
29578 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29579 processing a message then it may increase the client's measured rate more than
29580 it should. For example, this will happen if you check the &%per_rcpt%& option
29581 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29582 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29583 multiple update problems by using the &%readonly%& option on later ratelimit
29584 checks.
29585
29586 The &%per_*%& options described above do not make sense in some ACLs. If you
29587 use a &%per_*%& option in an ACL where it is not normally permitted then the
29588 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29589 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29590 next section) so you must specify the &%readonly%& option explicitly.
29591
29592
29593 .section "Ratelimit options for handling fast clients" "ratoptfast"
29594 .cindex "rate limiting" "strict and leaky modes"
29595 If a client's average rate is greater than the maximum, the rate limiting
29596 engine can react in two possible ways, depending on the presence of the
29597 &%strict%& or &%leaky%& update modes. This is independent of the other
29598 counter-measures (such as rejecting the message) that may be specified by the
29599 rest of the ACL.
29600
29601 The &%leaky%& (default) option means that the client's recorded rate is not
29602 updated if it is above the limit. The effect of this is that Exim measures the
29603 client's average rate of successfully sent email, which cannot be greater than
29604 the maximum allowed. If the client is over the limit it may suffer some
29605 counter-measures (as specified in the ACL), but it will still be able to send
29606 email at the configured maximum rate, whatever the rate of its attempts. This
29607 is generally the better choice if you have clients that retry automatically.
29608 For example, it does not prevent a sender with an over-aggressive retry rate
29609 from getting any email through.
29610
29611 The &%strict%& option means that the client's recorded rate is always
29612 updated. The effect of this is that Exim measures the client's average rate
29613 of attempts to send email, which can be much higher than the maximum it is
29614 actually allowed. If the client is over the limit it may be subjected to
29615 counter-measures by the ACL. It must slow down and allow sufficient time to
29616 pass that its computed rate falls below the maximum before it can send email
29617 again. The time (the number of smoothing periods) it must wait and not
29618 attempt to send mail can be calculated with this formula:
29619 .code
29620         ln(peakrate/maxrate)
29621 .endd
29622
29623
29624 .section "Limiting the rate of different events" "ratoptuniq"
29625 .cindex "rate limiting" "counting unique events"
29626 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29627 rate of different events. For example, the &%per_addr%& option uses this
29628 mechanism to count the number of different recipients that the client has
29629 sent messages to in the last time period; it is equivalent to
29630 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29631 measure the rate that a client uses different sender addresses with the
29632 options &`per_mail/unique=$sender_address`&.
29633
29634 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29635 has seen for that key. The whole set is thrown away when it is older than the
29636 rate smoothing period &'p'&, so each different event is counted at most once
29637 per period. In the &%leaky%& update mode, an event that causes the client to
29638 go over the limit is not added to the set, in the same way that the client's
29639 recorded rate is not updated in the same situation.
29640
29641 When you combine the &%unique=%& and &%readonly%& options, the specific
29642 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29643 rate.
29644
29645 The &%unique=%& mechanism needs more space in the ratelimit database than the
29646 other &%ratelimit%& options in order to store the event set. The number of
29647 unique values is potentially as large as the rate limit, so the extra space
29648 required increases with larger limits.
29649
29650 The uniqueification is not perfect: there is a small probability that Exim
29651 will think a new event has happened before. If the sender's rate is less than
29652 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29653 the measured rate can go above the limit, in which case Exim may under-count
29654 events by a significant margin. Fortunately, if the rate is high enough (2.7
29655 times the limit) that the false positive rate goes above 9%, then Exim will
29656 throw away the over-full event set before the measured rate falls below the
29657 limit. Therefore the only harm should be that exceptionally high sending rates
29658 are logged incorrectly; any countermeasures you configure will be as effective
29659 as intended.
29660
29661
29662 .section "Using rate limiting" "useratlim"
29663 Exim's other ACL facilities are used to define what counter-measures are taken
29664 when the rate limit is exceeded. This might be anything from logging a warning
29665 (for example, while measuring existing sending rates in order to define
29666 policy), through time delays to slow down fast senders, up to rejecting the
29667 message. For example:
29668 .code
29669 # Log all senders' rates
29670 warn ratelimit = 0 / 1h / strict
29671      log_message = Sender rate $sender_rate / $sender_rate_period
29672
29673 # Slow down fast senders; note the need to truncate $sender_rate
29674 # at the decimal point.
29675 warn ratelimit = 100 / 1h / per_rcpt / strict
29676      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29677                    $sender_rate_limit }s
29678
29679 # Keep authenticated users under control
29680 deny authenticated = *
29681      ratelimit = 100 / 1d / strict / $authenticated_id
29682
29683 # System-wide rate limit
29684 defer message = Sorry, too busy. Try again later.
29685      ratelimit = 10 / 1s / $primary_hostname
29686
29687 # Restrict incoming rate from each host, with a default
29688 # set using a macro and special cases looked up in a table.
29689 defer message = Sender rate exceeds $sender_rate_limit \
29690                messages per $sender_rate_period
29691      ratelimit = ${lookup {$sender_host_address} \
29692                    cdb {DB/ratelimits.cdb} \
29693                    {$value} {RATELIMIT} }
29694 .endd
29695 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29696 especially with the &%per_rcpt%& option, you may suffer from a performance
29697 bottleneck caused by locking on the ratelimit hints database. Apart from
29698 making your ACLs less complicated, you can reduce the problem by using a
29699 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29700 this means that Exim will lose its hints data after a reboot (including retry
29701 hints, the callout cache, and ratelimit data).
29702
29703
29704
29705 .section "Address verification" "SECTaddressverification"
29706 .cindex "verifying address" "options for"
29707 .cindex "policy control" "address verification"
29708 Several of the &%verify%& conditions described in section
29709 &<<SECTaclconditions>>& cause addresses to be verified. Section
29710 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29711 The verification conditions can be followed by options that modify the
29712 verification process. The options are separated from the keyword and from each
29713 other by slashes, and some of them contain parameters. For example:
29714 .code
29715 verify = sender/callout
29716 verify = recipient/defer_ok/callout=10s,defer_ok
29717 .endd
29718 The first stage of address verification, which always happens, is to run the
29719 address through the routers, in &"verify mode"&. Routers can detect the
29720 difference between verification and routing for delivery, and their actions can
29721 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29722 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29723 The available options are as follows:
29724
29725 .ilist
29726 If the &%callout%& option is specified, successful routing to one or more
29727 remote hosts is followed by a &"callout"& to those hosts as an additional
29728 check. Callouts and their sub-options are discussed in the next section.
29729 .next
29730 If there is a defer error while doing verification routing, the ACL
29731 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29732 options, the condition is forced to be true instead. Note that this is a main
29733 verification option as well as a suboption for callouts.
29734 .next
29735 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29736 discusses the reporting of sender address verification failures.
29737 .next
29738 The &%success_on_redirect%& option causes verification always to succeed
29739 immediately after a successful redirection. By default, if a redirection
29740 generates just one address, that address is also verified. See further
29741 discussion in section &<<SECTredirwhilveri>>&.
29742 .endlist
29743
29744 .cindex "verifying address" "differentiating failures"
29745 .vindex "&$recipient_verify_failure$&"
29746 .vindex "&$sender_verify_failure$&"
29747 .vindex "&$acl_verify_message$&"
29748 After an address verification failure, &$acl_verify_message$& contains the
29749 error message that is associated with the failure. It can be preserved by
29750 coding like this:
29751 .code
29752 warn  !verify = sender
29753        set acl_m0 = $acl_verify_message
29754 .endd
29755 If you are writing your own custom rejection message or log message when
29756 denying access, you can use this variable to include information about the
29757 verification failure.
29758
29759 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29760 appropriate) contains one of the following words:
29761
29762 .ilist
29763 &%qualify%&: The address was unqualified (no domain), and the message
29764 was neither local nor came from an exempted host.
29765 .next
29766 &%route%&: Routing failed.
29767 .next
29768 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29769 occurred at or before the MAIL command (that is, on initial
29770 connection, HELO, or MAIL).
29771 .next
29772 &%recipient%&: The RCPT command in a callout was rejected.
29773 .next
29774 &%postmaster%&: The postmaster check in a callout was rejected.
29775 .endlist
29776
29777 The main use of these variables is expected to be to distinguish between
29778 rejections of MAIL and rejections of RCPT in callouts.
29779
29780
29781
29782
29783 .section "Callout verification" "SECTcallver"
29784 .cindex "verifying address" "by callout"
29785 .cindex "callout" "verification"
29786 .cindex "SMTP" "callout verification"
29787 For non-local addresses, routing verifies the domain, but is unable to do any
29788 checking of the local part. There are situations where some means of verifying
29789 the local part is desirable. One way this can be done is to make an SMTP
29790 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29791 a subsequent host for a recipient address, to see if the host accepts the
29792 address. We use the term &'callout'& to cover both cases. Note that for a
29793 sender address, the callback is not to the client host that is trying to
29794 deliver the message, but to one of the hosts that accepts incoming mail for the
29795 sender's domain.
29796
29797 Exim does not do callouts by default. If you want them to happen, you must
29798 request them by setting appropriate options on the &%verify%& condition, as
29799 described below. This facility should be used with care, because it can add a
29800 lot of resource usage to the cost of verifying an address. However, Exim does
29801 cache the results of callouts, which helps to reduce the cost. Details of
29802 caching are in section &<<SECTcallvercache>>&.
29803
29804 Recipient callouts are usually used only between hosts that are controlled by
29805 the same administration. For example, a corporate gateway host could use
29806 callouts to check for valid recipients on an internal mailserver. A successful
29807 callout does not guarantee that a real delivery to the address would succeed;
29808 on the other hand, a failing callout does guarantee that a delivery would fail.
29809
29810 If the &%callout%& option is present on a condition that verifies an address, a
29811 second stage of verification occurs if the address is successfully routed to
29812 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29813 &(manualroute)& router, where the router specifies the hosts. However, if a
29814 router that does not set up hosts routes to an &(smtp)& transport with a
29815 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29816 &%hosts_override%& set, its hosts are always used, whether or not the router
29817 supplies a host list.
29818 Callouts are only supported on &(smtp)& transports.
29819
29820 The port that is used is taken from the transport, if it is specified and is a
29821 remote transport. (For routers that do verification only, no transport need be
29822 specified.) Otherwise, the default SMTP port is used. If a remote transport
29823 specifies an outgoing interface, this is used; otherwise the interface is not
29824 specified. Likewise, the text that is used for the HELO command is taken from
29825 the transport's &%helo_data%& option; if there is no transport, the value of
29826 &$smtp_active_hostname$& is used.
29827
29828 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29829 test whether a bounce message could be delivered to the sender address. The
29830 following SMTP commands are sent:
29831 .display
29832 &`HELO `&<&'local host name'&>
29833 &`MAIL FROM:<>`&
29834 &`RCPT TO:`&<&'the address to be tested'&>
29835 &`QUIT`&
29836 .endd
29837 LHLO is used instead of HELO if the transport's &%protocol%& option is
29838 set to &"lmtp"&.
29839
29840 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29841 settings.
29842
29843 A recipient callout check is similar. By default, it also uses an empty address
29844 for the sender. This default is chosen because most hosts do not make use of
29845 the sender address when verifying a recipient. Using the same address means
29846 that a single cache entry can be used for each recipient. Some sites, however,
29847 do make use of the sender address when verifying. These are catered for by the
29848 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29849
29850 If the response to the RCPT command is a 2&'xx'& code, the verification
29851 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29852 Exim tries the next host, if any. If there is a problem with all the remote
29853 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29854 &%callout%& option is given, in which case the condition is forced to succeed.
29855
29856 .cindex "SMTP" "output flushing, disabling for callout"
29857 A callout may take a little time. For this reason, Exim normally flushes SMTP
29858 output before performing a callout in an ACL, to avoid unexpected timeouts in
29859 clients when the SMTP PIPELINING extension is in use. The flushing can be
29860 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29861
29862
29863
29864
29865 .section "Additional parameters for callouts" "CALLaddparcall"
29866 .cindex "callout" "additional parameters for"
29867 The &%callout%& option can be followed by an equals sign and a number of
29868 optional parameters, separated by commas. For example:
29869 .code
29870 verify = recipient/callout=10s,defer_ok
29871 .endd
29872 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29873 separate verify options, is retained for backwards compatibility, but is now
29874 deprecated. The additional parameters for &%callout%& are as follows:
29875
29876
29877 .vlist
29878 .vitem <&'a&~time&~interval'&>
29879 .cindex "callout" "timeout, specifying"
29880 This specifies the timeout that applies for the callout attempt to each host.
29881 For example:
29882 .code
29883 verify = sender/callout=5s
29884 .endd
29885 The default is 30 seconds. The timeout is used for each response from the
29886 remote host. It is also used for the initial connection, unless overridden by
29887 the &%connect%& parameter.
29888
29889
29890 .vitem &*connect&~=&~*&<&'time&~interval'&>
29891 .cindex "callout" "connection timeout, specifying"
29892 This parameter makes it possible to set a different (usually smaller) timeout
29893 for making the SMTP connection. For example:
29894 .code
29895 verify = sender/callout=5s,connect=1s
29896 .endd
29897 If not specified, this timeout defaults to the general timeout value.
29898
29899 .vitem &*defer_ok*&
29900 .cindex "callout" "defer, action on"
29901 When this parameter is present, failure to contact any host, or any other kind
29902 of temporary error, is treated as success by the ACL. However, the cache is not
29903 updated in this circumstance.
29904
29905 .vitem &*fullpostmaster*&
29906 .cindex "callout" "full postmaster check"
29907 This operates like the &%postmaster%& option (see below), but if the check for
29908 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29909 accordance with the specification in RFC 2821. The RFC states that the
29910 unqualified address &'postmaster'& should be accepted.
29911
29912
29913 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29914 .cindex "callout" "sender when verifying header"
29915 When verifying addresses in header lines using the &%header_sender%&
29916 verification option, Exim behaves by default as if the addresses are envelope
29917 sender addresses from a message. Callout verification therefore tests to see
29918 whether a bounce message could be delivered, by using an empty address in the
29919 MAIL command. However, it is arguable that these addresses might never be used
29920 as envelope senders, and could therefore justifiably reject bounce messages
29921 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29922 address to use in the MAIL command. For example:
29923 .code
29924 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29925 .endd
29926 This parameter is available only for the &%header_sender%& verification option.
29927
29928
29929 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29930 .cindex "callout" "overall timeout, specifying"
29931 This parameter sets an overall timeout for performing a callout verification.
29932 For example:
29933 .code
29934 verify = sender/callout=5s,maxwait=30s
29935 .endd
29936 This timeout defaults to four times the callout timeout for individual SMTP
29937 commands. The overall timeout applies when there is more than one host that can
29938 be tried. The timeout is checked before trying the next host. This prevents
29939 very long delays if there are a large number of hosts and all are timing out
29940 (for example, when network connections are timing out).
29941
29942
29943 .vitem &*no_cache*&
29944 .cindex "callout" "cache, suppressing"
29945 .cindex "caching callout, suppressing"
29946 When this parameter is given, the callout cache is neither read nor updated.
29947
29948 .vitem &*postmaster*&
29949 .cindex "callout" "postmaster; checking"
29950 When this parameter is set, a successful callout check is followed by a similar
29951 check for the local part &'postmaster'& at the same domain. If this address is
29952 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29953 the postmaster check is recorded in a cache record; if it is a failure, this is
29954 used to fail subsequent callouts for the domain without a connection being
29955 made, until the cache record expires.
29956
29957 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29958 The postmaster check uses an empty sender in the MAIL command by default.
29959 You can use this parameter to do a postmaster check using a different address.
29960 For example:
29961 .code
29962 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29963 .endd
29964 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29965 one overrides. The &%postmaster%& parameter is equivalent to this example:
29966 .code
29967 require  verify = sender/callout=postmaster_mailfrom=
29968 .endd
29969 &*Warning*&: The caching arrangements for postmaster checking do not take
29970 account of the sender address. It is assumed that either the empty address or
29971 a fixed non-empty address will be used. All that Exim remembers is that the
29972 postmaster check for the domain succeeded or failed.
29973
29974
29975 .vitem &*random*&
29976 .cindex "callout" "&""random""& check"
29977 When this parameter is set, before doing the normal callout check, Exim does a
29978 check for a &"random"& local part at the same domain. The local part is not
29979 really random &-- it is defined by the expansion of the option
29980 &%callout_random_local_part%&, which defaults to
29981 .code
29982 $primary_hostname-$tod_epoch-testing
29983 .endd
29984 The idea here is to try to determine whether the remote host accepts all local
29985 parts without checking. If it does, there is no point in doing callouts for
29986 specific local parts. If the &"random"& check succeeds, the result is saved in
29987 a cache record, and used to force the current and subsequent callout checks to
29988 succeed without a connection being made, until the cache record expires.
29989
29990 .vitem &*use_postmaster*&
29991 .cindex "callout" "sender for recipient check"
29992 This parameter applies to recipient callouts only. For example:
29993 .code
29994 deny  !verify = recipient/callout=use_postmaster
29995 .endd
29996 .vindex "&$qualify_domain$&"
29997 It causes a non-empty postmaster address to be used in the MAIL command when
29998 performing the callout for the recipient, and also for a &"random"& check if
29999 that is configured. The local part of the address is &`postmaster`& and the
30000 domain is the contents of &$qualify_domain$&.
30001
30002 .vitem &*use_sender*&
30003 This option applies to recipient callouts only. For example:
30004 .code
30005 require  verify = recipient/callout=use_sender
30006 .endd
30007 It causes the message's actual sender address to be used in the MAIL
30008 command when performing the callout, instead of an empty address. There is no
30009 need to use this option unless you know that the called hosts make use of the
30010 sender when checking recipients. If used indiscriminately, it reduces the
30011 usefulness of callout caching.
30012 .endlist
30013
30014 If you use any of the parameters that set a non-empty sender for the MAIL
30015 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30016 &%use_sender%&), you should think about possible loops. Recipient checking is
30017 usually done between two hosts that are under the same management, and the host
30018 that receives the callouts is not normally configured to do callouts itself.
30019 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30020 these circumstances.
30021
30022 However, if you use a non-empty sender address for a callout to an arbitrary
30023 host, there is the likelihood that the remote host will itself initiate a
30024 callout check back to your host. As it is checking what appears to be a message
30025 sender, it is likely to use an empty address in MAIL, thus avoiding a
30026 callout loop. However, to be on the safe side it would be best to set up your
30027 own ACLs so that they do not do sender verification checks when the recipient
30028 is the address you use for header sender or postmaster callout checking.
30029
30030 Another issue to think about when using non-empty senders for callouts is
30031 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30032 by the sender/recipient combination; thus, for any given recipient, many more
30033 actual callouts are performed than when an empty sender or postmaster is used.
30034
30035
30036
30037
30038 .section "Callout caching" "SECTcallvercache"
30039 .cindex "hints database" "callout cache"
30040 .cindex "callout" "cache, description of"
30041 .cindex "caching" "callout"
30042 Exim caches the results of callouts in order to reduce the amount of resources
30043 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30044 option. A hints database called &"callout"& is used for the cache. Two
30045 different record types are used: one records the result of a callout check for
30046 a specific address, and the other records information that applies to the
30047 entire domain (for example, that it accepts the local part &'postmaster'&).
30048
30049 When an original callout fails, a detailed SMTP error message is given about
30050 the failure. However, for subsequent failures use the cache data, this message
30051 is not available.
30052
30053 The expiry times for negative and positive address cache records are
30054 independent, and can be set by the global options &%callout_negative_expire%&
30055 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30056
30057 If a host gives a negative response to an SMTP connection, or rejects any
30058 commands up to and including
30059 .code
30060 MAIL FROM:<>
30061 .endd
30062 (but not including the MAIL command with a non-empty address),
30063 any callout attempt is bound to fail. Exim remembers such failures in a
30064 domain cache record, which it uses to fail callouts for the domain without
30065 making new connections, until the domain record times out. There are two
30066 separate expiry times for domain cache records:
30067 &%callout_domain_negative_expire%& (default 3h) and
30068 &%callout_domain_positive_expire%& (default 7d).
30069
30070 Domain records expire when the negative expiry time is reached if callouts
30071 cannot be made for the domain, or if the postmaster check failed.
30072 Otherwise, they expire when the positive expiry time is reached. This
30073 ensures that, for example, a host that stops accepting &"random"& local parts
30074 will eventually be noticed.
30075
30076 The callout caching mechanism is based on the domain of the address that is
30077 being tested. If the domain routes to several hosts, it is assumed that their
30078 behaviour will be the same.
30079
30080
30081
30082 .section "Sender address verification reporting" "SECTsenaddver"
30083 .cindex "verifying" "suppressing error details"
30084 See section &<<SECTaddressverification>>& for a general discussion of
30085 verification. When sender verification fails in an ACL, the details of the
30086 failure are given as additional output lines before the 550 response to the
30087 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30088 you might see:
30089 .code
30090 MAIL FROM:<xyz@abc.example>
30091 250 OK
30092 RCPT TO:<pqr@def.example>
30093 550-Verification failed for <xyz@abc.example>
30094 550-Called:   192.168.34.43
30095 550-Sent:     RCPT TO:<xyz@abc.example>
30096 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30097 550 Sender verification failed
30098 .endd
30099 If more than one RCPT command fails in the same way, the details are given
30100 only for the first of them. However, some administrators do not want to send
30101 out this much information. You can suppress the details by adding
30102 &`/no_details`& to the ACL statement that requests sender verification. For
30103 example:
30104 .code
30105 verify = sender/no_details
30106 .endd
30107
30108 .section "Redirection while verifying" "SECTredirwhilveri"
30109 .cindex "verifying" "redirection while"
30110 .cindex "address redirection" "while verifying"
30111 A dilemma arises when a local address is redirected by aliasing or forwarding
30112 during verification: should the generated addresses themselves be verified,
30113 or should the successful expansion of the original address be enough to verify
30114 it? By default, Exim takes the following pragmatic approach:
30115
30116 .ilist
30117 When an incoming address is redirected to just one child address, verification
30118 continues with the child address, and if that fails to verify, the original
30119 verification also fails.
30120 .next
30121 When an incoming address is redirected to more than one child address,
30122 verification does not continue. A success result is returned.
30123 .endlist
30124
30125 This seems the most reasonable behaviour for the common use of aliasing as a
30126 way of redirecting different local parts to the same mailbox. It means, for
30127 example, that a pair of alias entries of the form
30128 .code
30129 A.Wol:   aw123
30130 aw123:   :fail: Gone away, no forwarding address
30131 .endd
30132 work as expected, with both local parts causing verification failure. When a
30133 redirection generates more than one address, the behaviour is more like a
30134 mailing list, where the existence of the alias itself is sufficient for
30135 verification to succeed.
30136
30137 It is possible, however, to change the default behaviour so that all successful
30138 redirections count as successful verifications, however many new addresses are
30139 generated. This is specified by the &%success_on_redirect%& verification
30140 option. For example:
30141 .code
30142 require verify = recipient/success_on_redirect/callout=10s
30143 .endd
30144 In this example, verification succeeds if a router generates a new address, and
30145 the callout does not occur, because no address was routed to a remote host.
30146
30147 When verification is being tested via the &%-bv%& option, the treatment of
30148 redirections is as just described, unless the &%-v%& or any debugging option is
30149 also specified. In that case, full verification is done for every generated
30150 address and a report is output for each of them.
30151
30152
30153
30154 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30155 .cindex "CSA" "verifying"
30156 Client SMTP Authorization is a system that allows a site to advertise
30157 which machines are and are not permitted to send email. This is done by placing
30158 special SRV records in the DNS; these are looked up using the client's HELO
30159 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30160 Authorization checks in Exim are performed by the ACL condition:
30161 .code
30162 verify = csa
30163 .endd
30164 This fails if the client is not authorized. If there is a DNS problem, or if no
30165 valid CSA SRV record is found, or if the client is authorized, the condition
30166 succeeds. These three cases can be distinguished using the expansion variable
30167 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30168 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30169 be likely to cause problems for legitimate email.
30170
30171 The error messages produced by the CSA code include slightly more
30172 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30173 looking up the CSA SRV record, or problems looking up the CSA target
30174 address record. There are four reasons for &$csa_status$& being &"fail"&:
30175
30176 .ilist
30177 The client's host name is explicitly not authorized.
30178 .next
30179 The client's IP address does not match any of the CSA target IP addresses.
30180 .next
30181 The client's host name is authorized but it has no valid target IP addresses
30182 (for example, the target's addresses are IPv6 and the client is using IPv4).
30183 .next
30184 The client's host name has no CSA SRV record but a parent domain has asserted
30185 that all subdomains must be explicitly authorized.
30186 .endlist
30187
30188 The &%csa%& verification condition can take an argument which is the domain to
30189 use for the DNS query. The default is:
30190 .code
30191 verify = csa/$sender_helo_name
30192 .endd
30193 This implementation includes an extension to CSA. If the query domain
30194 is an address literal such as [192.0.2.95], or if it is a bare IP
30195 address, Exim searches for CSA SRV records in the reverse DNS as if
30196 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30197 meaningful to say:
30198 .code
30199 verify = csa/$sender_host_address
30200 .endd
30201 In fact, this is the check that Exim performs if the client does not say HELO.
30202 This extension can be turned off by setting the main configuration option
30203 &%dns_csa_use_reverse%& to be false.
30204
30205 If a CSA SRV record is not found for the domain itself, a search
30206 is performed through its parent domains for a record which might be
30207 making assertions about subdomains. The maximum depth of this search is limited
30208 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30209 default. Exim does not look for CSA SRV records in a top level domain, so the
30210 default settings handle HELO domains as long as seven
30211 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30212 of legitimate HELO domains.
30213
30214 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30215 direct SRV lookups, this is not sufficient because of the extra parent domain
30216 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30217 addresses into lookups in the reverse DNS space. The result of a successful
30218 lookup such as:
30219 .code
30220 ${lookup dnsdb {csa=$sender_helo_name}}
30221 .endd
30222 has two space-separated fields: an authorization code and a target host name.
30223 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30224 authorization required but absent, or &"?"& for unknown.
30225
30226
30227
30228
30229 .section "Bounce address tag validation" "SECTverifyPRVS"
30230 .cindex "BATV, verifying"
30231 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30232 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30233 Genuine incoming bounce messages should therefore always be addressed to
30234 recipients that have a valid tag. This scheme is a way of detecting unwanted
30235 bounce messages caused by sender address forgeries (often called &"collateral
30236 spam"&), because the recipients of such messages do not include valid tags.
30237
30238 There are two expansion items to help with the implementation of the BATV
30239 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30240 the original envelope sender address by using a simple key to add a hash of the
30241 address and some time-based randomizing information. The &%prvs%& expansion
30242 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30243 The syntax of these expansion items is described in section
30244 &<<SECTexpansionitems>>&.
30245
30246 As an example, suppose the secret per-address keys are stored in an MySQL
30247 database. A query to look up the key for an address could be defined as a macro
30248 like this:
30249 .code
30250 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30251                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30252                 }{$value}}
30253 .endd
30254 Suppose also that the senders who make use of BATV are defined by an address
30255 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30256 use this:
30257 .code
30258 # Bounces: drop unsigned addresses for BATV senders
30259 deny message = This address does not send an unsigned reverse path
30260      senders = :
30261      recipients = +batv_senders
30262
30263 # Bounces: In case of prvs-signed address, check signature.
30264 deny message = Invalid reverse path signature.
30265      senders = :
30266      condition  = ${prvscheck {$local_part@$domain}\
30267                   {PRVSCHECK_SQL}{1}}
30268      !condition = $prvscheck_result
30269 .endd
30270 The first statement rejects recipients for bounce messages that are addressed
30271 to plain BATV sender addresses, because it is known that BATV senders do not
30272 send out messages with plain sender addresses. The second statement rejects
30273 recipients that are prvs-signed, but with invalid signatures (either because
30274 the key is wrong, or the signature has timed out).
30275
30276 A non-prvs-signed address is not rejected by the second statement, because the
30277 &%prvscheck%& expansion yields an empty string if its first argument is not a
30278 prvs-signed address, thus causing the &%condition%& condition to be false. If
30279 the first argument is a syntactically valid prvs-signed address, the yield is
30280 the third string (in this case &"1"&), whether or not the cryptographic and
30281 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30282 of the checks (empty for failure, &"1"& for success).
30283
30284 There is one more issue you must consider when implementing prvs-signing:
30285 you have to ensure that the routers accept prvs-signed addresses and
30286 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30287 router to remove the signature with a configuration along these lines:
30288 .code
30289 batv_redirect:
30290   driver = redirect
30291   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30292 .endd
30293 This works because, if the third argument of &%prvscheck%& is empty, the result
30294 of the expansion of a prvs-signed address is the decoded value of the original
30295 address. This router should probably be the first of your routers that handles
30296 local addresses.
30297
30298 To create BATV-signed addresses in the first place, a transport of this form
30299 can be used:
30300 .code
30301 external_smtp_batv:
30302   driver = smtp
30303   return_path = ${prvs {$return_path} \
30304                        {${lookup mysql{SELECT \
30305                        secret FROM batv_prvs WHERE \
30306                        sender='${quote_mysql:$sender_address}'} \
30307                        {$value}fail}}}
30308 .endd
30309 If no key can be found for the existing return path, no signing takes place.
30310
30311
30312
30313 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30314 .cindex "&ACL;" "relay control"
30315 .cindex "relaying" "control by ACL"
30316 .cindex "policy control" "relay control"
30317 An MTA is said to &'relay'& a message if it receives it from some host and
30318 delivers it directly to another host as a result of a remote address contained
30319 within it. Redirecting a local address via an alias or forward file and then
30320 passing the message on to another host is not relaying,
30321 .cindex "&""percent hack""&"
30322 but a redirection as a result of the &"percent hack"& is.
30323
30324 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30325 A host which is acting as a gateway or an MX backup is concerned with incoming
30326 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30327 a host which is acting as a smart host for a number of clients is concerned
30328 with outgoing relaying from those clients to the Internet at large. Often the
30329 same host is fulfilling both functions,
30330 . ///
30331 . as illustrated in the diagram below,
30332 . ///
30333 but in principle these two kinds of relaying are entirely independent. What is
30334 not wanted is the transmission of mail from arbitrary remote hosts through your
30335 system to arbitrary domains.
30336
30337
30338 You can implement relay control by means of suitable statements in the ACL that
30339 runs for each RCPT command. For convenience, it is often easiest to use
30340 Exim's named list facility to define the domains and hosts involved. For
30341 example, suppose you want to do the following:
30342
30343 .ilist
30344 Deliver a number of domains to mailboxes on the local host (or process them
30345 locally in some other way). Let's say these are &'my.dom1.example'& and
30346 &'my.dom2.example'&.
30347 .next
30348 Relay mail for a number of other domains for which you are the secondary MX.
30349 These might be &'friend1.example'& and &'friend2.example'&.
30350 .next
30351 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30352 Suppose your LAN is 192.168.45.0/24.
30353 .endlist
30354
30355
30356 In the main part of the configuration, you put the following definitions:
30357 .code
30358 domainlist local_domains    = my.dom1.example : my.dom2.example
30359 domainlist relay_to_domains = friend1.example : friend2.example
30360 hostlist   relay_from_hosts = 192.168.45.0/24
30361 .endd
30362 Now you can use these definitions in the ACL that is run for every RCPT
30363 command:
30364 .code
30365 acl_check_rcpt:
30366   accept domains = +local_domains : +relay_to_domains
30367   accept hosts   = +relay_from_hosts
30368 .endd
30369 The first statement accepts any RCPT command that contains an address in
30370 the local or relay domains. For any other domain, control passes to the second
30371 statement, which accepts the command only if it comes from one of the relay
30372 hosts. In practice, you will probably want to make your ACL more sophisticated
30373 than this, for example, by including sender and recipient verification. The
30374 default configuration includes a more comprehensive example, which is described
30375 in chapter &<<CHAPdefconfil>>&.
30376
30377
30378
30379 .section "Checking a relay configuration" "SECTcheralcon"
30380 .cindex "relaying" "checking control of"
30381 You can check the relay characteristics of your configuration in the same way
30382 that you can test any ACL behaviour for an incoming SMTP connection, by using
30383 the &%-bh%& option to run a fake SMTP session with which you interact.
30384
30385 For specifically testing for unwanted relaying, the host
30386 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30387 host from the host on which Exim is running, using the normal telnet port, you
30388 will see a normal telnet connection message and then quite a long delay. Be
30389 patient. The remote host is making an SMTP connection back to your host, and
30390 trying a number of common probes to test for open relay vulnerability. The
30391 results of the tests will eventually appear on your terminal.
30392 .ecindex IIDacl
30393
30394
30395
30396 . ////////////////////////////////////////////////////////////////////////////
30397 . ////////////////////////////////////////////////////////////////////////////
30398
30399 .chapter "Content scanning at ACL time" "CHAPexiscan"
30400 .scindex IIDcosca "content scanning" "at ACL time"
30401 The extension of Exim to include content scanning at ACL time, formerly known
30402 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30403 was integrated into the main source for Exim release 4.50, and Tom continues to
30404 maintain it. Most of the wording of this chapter is taken from Tom's
30405 specification.
30406
30407 It is also possible to scan the content of messages at other times. The
30408 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30409 scanning after all the ACLs have run. A transport filter can be used to scan
30410 messages at delivery time (see the &%transport_filter%& option, described in
30411 chapter &<<CHAPtransportgeneric>>&).
30412
30413 If you want to include the ACL-time content-scanning features when you compile
30414 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30415 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30416
30417 .ilist
30418 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30419 for all MIME parts for SMTP and non-SMTP messages, respectively.
30420 .next
30421 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30422 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30423 run at the end of message reception (the &%acl_smtp_data%& ACL).
30424 .next
30425 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30426 of messages, or parts of messages, for debugging purposes.
30427 .next
30428 Additional expansion variables that are set in the new ACL and by the new
30429 conditions.
30430 .next
30431 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30432 .endlist
30433
30434 There is another content-scanning configuration option for &_Local/Makefile_&,
30435 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30436 condition is compiled, in addition to all the other content-scanning features.
30437
30438 Content-scanning is continually evolving, and new features are still being
30439 added. While such features are still unstable and liable to incompatible
30440 changes, they are made available in Exim by setting options whose names begin
30441 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30442 this manual. You can find out about them by reading the file called
30443 &_doc/experimental.txt_&.
30444
30445 All the content-scanning facilities work on a MBOX copy of the message that is
30446 temporarily created in a file called:
30447 .display
30448 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30449 .endd
30450 The &_.eml_& extension is a friendly hint to virus scanners that they can
30451 expect an MBOX-like structure inside that file. The file is created when the
30452 first content scanning facility is called. Subsequent calls to content
30453 scanning conditions open the same file again. The directory is recursively
30454 removed when the &%acl_smtp_data%& ACL has finished running, unless
30455 .code
30456 control = no_mbox_unspool
30457 .endd
30458 has been encountered. When the MIME ACL decodes files, they are put into the
30459 same directory by default.
30460
30461
30462
30463 .section "Scanning for viruses" "SECTscanvirus"
30464 .cindex "virus scanning"
30465 .cindex "content scanning" "for viruses"
30466 .cindex "content scanning" "the &%malware%& condition"
30467 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30468 It supports a &"generic"& interface to scanners called via the shell, and
30469 specialized interfaces for &"daemon"& type virus scanners, which are resident
30470 in memory and thus are much faster.
30471
30472 .new
30473 A timeout of 2 minutes is applied to a scanner call (by default);
30474 if it expires then a defer action is taken.
30475 .wen
30476
30477 .oindex "&%av_scanner%&"
30478 You can set the &%av_scanner%& option in the main part of the configuration
30479 to specify which scanner to use, together with any additional options that
30480 are needed. The basic syntax is as follows:
30481 .display
30482 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30483 .endd
30484 If you do not set &%av_scanner%&, it defaults to
30485 .code
30486 av_scanner = sophie:/var/run/sophie
30487 .endd
30488 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30489 before use.
30490 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30491 The following scanner types are supported in this release:
30492
30493 .vlist
30494 .new
30495 .vitem &%avast%&
30496 .cindex "virus scanners" "avast"
30497 This is the scanner daemon of Avast. It has been tested with Avast Core
30498 Security (currenty at version 1.1.7).
30499 You can get a trial version at &url(http://www.avast.com) or for Linux
30500 at &url(http://www.avast.com/linux-server-antivirus).
30501 This scanner type takes one option,
30502 which can be either a full path to a UNIX socket,
30503 or host and port specifiers separated by white space.
30504 The host may be a name or an IP address; the port is either a
30505 single number or a pair of numbers with a dash between.
30506 Any further options are given, on separate lines,
30507 to the daemon as options before the main scan command.
30508 For example:
30509 .code
30510 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30511 av_scanner = avast:192.168.2.22 5036
30512 .endd
30513 If you omit the argument, the default path
30514 &_/var/run/avast/scan.sock_&
30515 is used.
30516 If you use a remote host,
30517 you need to make Exim's spool directory available to it,
30518 as the scanner is passed a file path, not file contents.
30519 For information about available commands and their options you may use 
30520 .code
30521 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30522     FLAGS
30523     SENSITIVITY
30524     PACK
30525 .endd
30526 .wen
30527
30528
30529 .vitem &%aveserver%&
30530 .cindex "virus scanners" "Kaspersky"
30531 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30532 at &url(http://www.kaspersky.com). This scanner type takes one option,
30533 which is the path to the daemon's UNIX socket. The default is shown in this
30534 example:
30535 .code
30536 av_scanner = aveserver:/var/run/aveserver
30537 .endd
30538
30539
30540 .vitem &%clamd%&
30541 .cindex "virus scanners" "clamd"
30542 This daemon-type scanner is GPL and free. You can get it at
30543 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30544 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30545 in the MIME ACL. This is no longer believed to be necessary.
30546
30547 The options are a list of server specifiers, which may be
30548 a UNIX socket specification,
30549 a TCP socket specification,
30550 or a (global) option.
30551
30552 A socket specification consists of a space-separated list.
30553 For a Unix socket the first element is a full path for the socket,
30554 for a TCP socket the first element is the IP address
30555 and the second a port number,
30556 Any further elements are per-server (non-global) options.
30557 These per-server options are supported:
30558 .code
30559 retry=<timespec>        Retry on connect fail
30560 .endd
30561
30562 The &`retry`& option specifies a time after which a single retry for
30563 a failed connect is made.  The default is to not retry.
30564
30565 If a Unix socket file is specified, only one server is supported.
30566
30567 Examples:
30568 .code
30569 av_scanner = clamd:/opt/clamd/socket
30570 av_scanner = clamd:192.0.2.3 1234
30571 av_scanner = clamd:192.0.2.3 1234:local
30572 av_scanner = clamd:192.0.2.3 1234 retry=10s
30573 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30574 .endd
30575 If the value of av_scanner points to a UNIX socket file or contains the
30576 &`local`&
30577 option, then the ClamAV interface will pass a filename containing the data
30578 to be scanned, which will should normally result in less I/O happening and be
30579 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30580 Exim does not assume that there is a common filesystem with the remote host.
30581 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30582 you be running a version of ClamAV prior to 0.95.
30583
30584 The final example shows that multiple TCP targets can be specified.  Exim will
30585 randomly use one for each incoming email (i.e. it load balances them).  Note
30586 that only TCP targets may be used if specifying a list of scanners; a UNIX
30587 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30588 unavailable, Exim will try the remaining one(s) until it finds one that works.
30589 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30590 not keep track of scanner state between multiple messages, and the scanner
30591 selection is random, so the message will get logged in the mainlog for each
30592 email that the down scanner gets chosen first (message wrapped to be readable):
30593 .code
30594 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30595    clamd: connection to localhost, port 3310 failed
30596    (Connection refused)
30597 .endd
30598
30599 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30600 contributing the code for this scanner.
30601
30602 .vitem &%cmdline%&
30603 .cindex "virus scanners" "command line interface"
30604 This is the keyword for the generic command line scanner interface. It can be
30605 used to attach virus scanners that are invoked from the shell. This scanner
30606 type takes 3 mandatory options:
30607
30608 .olist
30609 The full path and name of the scanner binary, with all command line options,
30610 and a placeholder (&`%s`&) for the directory to scan.
30611
30612 .next
30613 A regular expression to match against the STDOUT and STDERR output of the
30614 virus scanner. If the expression matches, a virus was found. You must make
30615 absolutely sure that this expression matches on &"virus found"&. This is called
30616 the &"trigger"& expression.
30617
30618 .next
30619 Another regular expression, containing exactly one pair of parentheses, to
30620 match the name of the virus found in the scanners output. This is called the
30621 &"name"& expression.
30622 .endlist olist
30623
30624 For example, Sophos Sweep reports a virus on a line like this:
30625 .code
30626 Virus 'W32/Magistr-B' found in file ./those.bat
30627 .endd
30628 For the trigger expression, we can match the phrase &"found in file"&. For the
30629 name expression, we want to extract the W32/Magistr-B string, so we can match
30630 for the single quotes left and right of it. Altogether, this makes the
30631 configuration setting:
30632 .code
30633 av_scanner = cmdline:\
30634              /path/to/sweep -ss -all -rec -archive %s:\
30635              found in file:'(.+)'
30636 .endd
30637 .vitem &%drweb%&
30638 .cindex "virus scanners" "DrWeb"
30639 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30640 takes one option,
30641 either a full path to a UNIX socket,
30642 or host and port specifiers separated by white space.
30643 The host may be a name or an IP address; the port is either a
30644 single number or a pair of numbers with a dash between.
30645 For example:
30646 .code
30647 av_scanner = drweb:/var/run/drwebd.sock
30648 av_scanner = drweb:192.168.2.20 31337
30649 .endd
30650 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30651 is used. Thanks to Alex Miller for contributing the code for this scanner.
30652
30653 .vitem &%f-protd%&
30654 .cindex "virus scanners" "f-protd"
30655 The f-protd scanner is accessed via HTTP over TCP.
30656 One argument is taken, being a space-separated hostname and port number
30657 (or port-range).
30658 For example:
30659 .code
30660 av_scanner = f-protd:localhost 10200-10204
30661 .endd
30662 If you omit the argument, the default values show above are used.
30663
30664 .vitem &%fsecure%&
30665 .cindex "virus scanners" "F-Secure"
30666 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30667 argument which is the path to a UNIX socket. For example:
30668 .code
30669 av_scanner = fsecure:/path/to/.fsav
30670 .endd
30671 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30672 Thelmen for contributing the code for this scanner.
30673
30674 .vitem &%kavdaemon%&
30675 .cindex "virus scanners" "Kaspersky"
30676 This is the scanner daemon of Kaspersky Version 4. This version of the
30677 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30678 scanner type takes one option, which is the path to the daemon's UNIX socket.
30679 For example:
30680 .code
30681 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30682 .endd
30683 The default path is &_/var/run/AvpCtl_&.
30684
30685 .vitem &%mksd%&
30686 .cindex "virus scanners" "mksd"
30687 This is a daemon type scanner that is aimed mainly at Polish users, though some
30688 parts of documentation are now available in English. You can get it at
30689 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30690 the maximum number of processes used simultaneously to scan the attachments,
30691 provided that the demime facility is employed and also provided that mksd has
30692 been run with at least the same number of child processes. For example:
30693 .code
30694 av_scanner = mksd:2
30695 .endd
30696 You can safely omit this option (the default value is 1).
30697
30698 .vitem &%sock%&
30699 .cindex "virus scanners" "simple socket-connected"
30700 This is a general-purpose way of talking to simple scanner daemons
30701 running on the local machine.
30702 There are four options:
30703 an address (which may be an IP addres and port, or the path of a Unix socket),
30704 a commandline to send (may include a single %s which will be replaced with
30705 the path to the mail file to be scanned),
30706 an RE to trigger on from the returned data,
30707 an RE to extract malware_name from the returned data.
30708 For example:
30709 .code
30710 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30711 .endd
30712 Default for the socket specifier is &_/tmp/malware.sock_&.
30713 Default for the commandline is &_%s\n_&.
30714 Both regular-expressions are required.
30715
30716 .vitem &%sophie%&
30717 .cindex "virus scanners" "Sophos and Sophie"
30718 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30719 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30720 for this scanner type is the path to the UNIX socket that Sophie uses for
30721 client communication. For example:
30722 .code
30723 av_scanner = sophie:/tmp/sophie
30724 .endd
30725 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30726 the option.
30727 .endlist
30728
30729 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30730 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30731 ACL.
30732
30733 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30734 makes it possible to use different scanners. See further below for an example.
30735 The &%malware%& condition caches its results, so when you use it multiple times
30736 for the same message, the actual scanning process is only carried out once.
30737 However, using expandable items in &%av_scanner%& disables this caching, in
30738 which case each use of the &%malware%& condition causes a new scan of the
30739 message.
30740
30741 The &%malware%& condition takes a right-hand argument that is expanded before
30742 .new
30743 use and taken as a list, slash-separated by default.
30744 .wen
30745 The first element can then be one of
30746
30747 .ilist
30748 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30749 The condition succeeds if a virus was found, and fail otherwise. This is the
30750 recommended usage.
30751 .next
30752 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30753 the condition fails immediately.
30754 .next
30755 A regular expression, in which case the message is scanned for viruses. The
30756 condition succeeds if a virus is found and its name matches the regular
30757 expression. This allows you to take special actions on certain types of virus.
30758 .new
30759 Note that &"/"& characters in the RE must be doubled due to the list-processing,
30760 unless the separator is changed (in the usual way).
30761 .wen
30762 .endlist
30763
30764 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
30765 messages even if there is a problem with the virus scanner.
30766 Otherwise, such a problem causes the ACL to defer.
30767
30768 .new
30769 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
30770 specify a non-default timeout.  The default is two minutes.
30771 For example:
30772 .code
30773 malware = * / defer_ok / tmo=10s
30774 .endd
30775 A timeout causes the ACL to defer.
30776 .wen
30777
30778 .vindex "&$malware_name$&"
30779 When a virus is found, the condition sets up an expansion variable called
30780 &$malware_name$& that contains the name of the virus. You can use it in a
30781 &%message%& modifier that specifies the error returned to the sender, and/or in
30782 logging data.
30783
30784 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30785 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30786 &%malware%& condition.
30787
30788 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30789 imposed by your anti-virus scanner.
30790
30791 Here is a very simple scanning example:
30792 .code
30793 deny message = This message contains malware ($malware_name)
30794      demime = *
30795      malware = *
30796 .endd
30797 The next example accepts messages when there is a problem with the scanner:
30798 .code
30799 deny message = This message contains malware ($malware_name)
30800      demime = *
30801      malware = */defer_ok
30802 .endd
30803 The next example shows how to use an ACL variable to scan with both sophie and
30804 aveserver. It assumes you have set:
30805 .code
30806 av_scanner = $acl_m0
30807 .endd
30808 in the main Exim configuration.
30809 .code
30810 deny message = This message contains malware ($malware_name)
30811      set acl_m0 = sophie
30812      malware = *
30813
30814 deny message = This message contains malware ($malware_name)
30815      set acl_m0 = aveserver
30816      malware = *
30817 .endd
30818
30819
30820 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
30821 .cindex "content scanning" "for spam"
30822 .cindex "spam scanning"
30823 .cindex "SpamAssassin"
30824 .cindex "Rspamd"
30825 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30826 score and a report for the message.
30827 .new
30828 Support is also provided for Rspamd.
30829
30830 For more information about installation and configuration of SpamAssassin or 
30831 Rspamd refer to their respective websites at
30832 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
30833 .wen
30834
30835 SpamAssassin can be installed with CPAN by running:
30836 .code
30837 perl -MCPAN -e 'install Mail::SpamAssassin'
30838 .endd
30839 SpamAssassin has its own set of configuration files. Please review its
30840 documentation to see how you can tweak it. The default installation should work
30841 nicely, however.
30842
30843 .oindex "&%spamd_address%&"
30844 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you 
30845 intend to use an instance running on the local host you do not need to set
30846 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
30847 you must set the &%spamd_address%& option in the global part of the Exim
30848 configuration as follows (example):
30849 .code
30850 spamd_address = 192.168.99.45 387
30851 .endd
30852
30853 .new
30854 To use Rspamd (which by default listens on all local addresses
30855 on TCP port 11333)
30856 you should add &%variant=rspamd%& after the address/port pair, for example:
30857 .code
30858 spamd_address = 127.0.0.1 11333 variant=rspamd
30859 .endd
30860 .wen
30861
30862 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
30863 sockets. If you want to us these, supply &%spamd_address%& with an absolute
30864 file name instead of an address/port pair:
30865 .code
30866 spamd_address = /var/run/spamd_socket
30867 .endd
30868 You can have multiple &%spamd%& servers to improve scalability. These can
30869 reside on other hardware reachable over the network. To specify multiple
30870 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30871 option, separated with colons (the separator can be changed in the usual way):
30872 .code
30873 spamd_address = 192.168.2.10 783 : \
30874                 192.168.2.11 783 : \
30875                 192.168.2.12 783
30876 .endd
30877 Up to 32 &%spamd%& servers are supported.
30878 When a server fails to respond to the connection attempt, all other
30879 servers are tried until one succeeds. If no server responds, the &%spam%&
30880 condition defers.
30881
30882 .new
30883 Unix and TCP socket specifications may be mixed in any order.
30884 Each element of the list is a list itself, space-separated by default
30885 and changeable in the usual way.
30886
30887 For TCP socket specifications a host name or IP (v4 or v6, but
30888 subject to list-separator quoting rules) address can be used,
30889 and the port can be one or a dash-separated pair.
30890 In the latter case, the range is tried in strict order.
30891
30892 Elements after the first for Unix sockets, or second for TCP socket,
30893 are options.
30894 The supported option are:
30895 .code
30896 pri=<priority>      Selection priority
30897 weight=<value>      Selection bias
30898 time=<start>-<end>  Use only between these times of day
30899 retry=<timespec>    Retry on connect fail
30900 tmo=<timespec>      Connection time limit
30901 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
30902 .endd
30903
30904 The &`pri`& option specifies a priority for the server within the list,
30905 higher values being tried first.
30906 The deafult priority is 1.
30907
30908 The &`weight`& option specifies a selection bias.
30909 Within a priority set
30910 servers are queried in a random fashion, weighted by this value.
30911 The default value for selection bias is 1.
30912
30913 Time specifications for the &`time`& option are <hour>.<minute>.<second>
30914 in the local time zone; each element being one or more digits.
30915 Either the seconds or both minutes and seconds, plus the leading &`.`&
30916 characters, may be omitted and will be taken as zero.
30917
30918 Timeout specifications for the &`retry`& and &`tmo`& options
30919 are the usual Exim time interval standard, eg. &`20s`& or &`1m`&.
30920
30921 The &`tmo`& option specifies an overall timeout for communication.
30922 The default value is two minutes.
30923
30924 The &`retry`& option specifies a time after which a single retry for
30925 a failed connect is made.
30926 The default is to not retry.
30927 .wen
30928
30929 The &%spamd_address%& variable is expanded before use if it starts with
30930 a dollar sign. In this case, the expansion may return a string that is
30931 used as the list so that multiple spamd servers can be the result of an
30932 expansion.
30933
30934 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30935 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30936 .code
30937 deny message = This message was classified as SPAM
30938      spam = joe
30939 .endd
30940 The right-hand side of the &%spam%& condition specifies a name. This is
30941 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30942 to scan using a specific profile, but rather use the SpamAssassin system-wide
30943 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30944 .new
30945 Rspamd does not use this setting. However, you must put something on the
30946 right-hand side.
30947 .wen
30948
30949 The name allows you to use per-domain or per-user antispam profiles in
30950 principle, but this is not straightforward in practice, because a message may
30951 have multiple recipients, not necessarily all in the same domain. Because the
30952 &%spam%& condition has to be called from a DATA ACL in order to be able to
30953 read the contents of the message, the variables &$local_part$& and &$domain$&
30954 are not set.
30955 Careful enforcement of single-recipient messages
30956 (eg. by responding with defer in the recipient ACL for all recipients
30957 after the first),
30958 or the use of PRDR,
30959 .cindex "PRDR" "use for per-user SpamAssassin profiles"
30960 are needed to use this feature.
30961
30962 The right-hand side of the &%spam%& condition is expanded before being used, so
30963 you can put lookups or conditions there. When the right-hand side evaluates to
30964 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30965
30966
30967 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30968 large ones may cause significant performance degradation. As most spam messages
30969 are quite small, it is recommended that you do not scan the big ones. For
30970 example:
30971 .code
30972 deny message = This message was classified as SPAM
30973      condition = ${if < {$message_size}{10K}}
30974      spam = nobody
30975 .endd
30976
30977 The &%spam%& condition returns true if the threshold specified in the user's
30978 SpamAssassin profile has been matched or exceeded. If you want to use the
30979 &%spam%& condition for its side effects (see the variables below), you can make
30980 it always return &"true"& by appending &`:true`& to the username.
30981
30982 .cindex "spam scanning" "returned variables"
30983 When the &%spam%& condition is run, it sets up a number of expansion
30984 variables. These variables are saved with the received message, thus they are
30985 available for use at delivery time.
30986
30987 .vlist
30988 .vitem &$spam_score$&
30989 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30990 for inclusion in log or reject messages.
30991
30992 .vitem &$spam_score_int$&
30993 The spam score of the message, multiplied by ten, as an integer value. For
30994 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30995 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30996 The integer value is useful for numeric comparisons in conditions.
30997
30998 .vitem &$spam_bar$&
30999 A string consisting of a number of &"+"& or &"-"& characters, representing the
31000 integer part of the spam score value. A spam score of 4.4 would have a
31001 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31002 headers, since MUAs can match on such strings.
31003
31004 .vitem &$spam_report$&
31005 A multiline text table, containing the full SpamAssassin report for the
31006 message. Useful for inclusion in headers or reject messages.
31007
31008 .new
31009 .vitem &$spam_action$&
31010 For SpamAssassin either 'reject' or 'no action' depending on the
31011 spam score versus threshold.
31012 For Rspamd, the recommended action.
31013 .wen
31014
31015 .endlist
31016
31017 The &%spam%& condition caches its results unless expansion in
31018 spamd_address was used. If you call it again with the same user name, it
31019 does not scan again, but rather returns the same values as before.
31020
31021 The &%spam%& condition returns DEFER if there is any error while running
31022 the message through SpamAssassin or if the expansion of spamd_address
31023 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31024 statement block), append &`/defer_ok`& to the right-hand side of the
31025 spam condition, like this:
31026 .code
31027 deny message = This message was classified as SPAM
31028      spam    = joe/defer_ok
31029 .endd
31030 This causes messages to be accepted even if there is a problem with &%spamd%&.
31031
31032 Here is a longer, commented example of the use of the &%spam%&
31033 condition:
31034 .code
31035 # put headers in all messages (no matter if spam or not)
31036 warn  spam = nobody:true
31037       add_header = X-Spam-Score: $spam_score ($spam_bar)
31038       add_header = X-Spam-Report: $spam_report
31039
31040 # add second subject line with *SPAM* marker when message
31041 # is over threshold
31042 warn  spam = nobody
31043       add_header = Subject: *SPAM* $h_Subject:
31044
31045 # reject spam at high scores (> 12)
31046 deny  message = This message scored $spam_score spam points.
31047       spam = nobody:true
31048       condition = ${if >{$spam_score_int}{120}{1}{0}}
31049 .endd
31050
31051
31052
31053 .section "Scanning MIME parts" "SECTscanmimepart"
31054 .cindex "content scanning" "MIME parts"
31055 .cindex "MIME content scanning"
31056 .oindex "&%acl_smtp_mime%&"
31057 .oindex "&%acl_not_smtp_mime%&"
31058 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31059 each MIME part of an SMTP message, including multipart types, in the sequence
31060 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31061 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31062 options may both refer to the same ACL if you want the same processing in both
31063 cases.
31064
31065 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31066 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31067 the case of a non-SMTP message. However, a MIME ACL is called only if the
31068 message contains a &'Content-Type:'& header line. When a call to a MIME
31069 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31070 result code is sent to the client. In the case of an SMTP message, the
31071 &%acl_smtp_data%& ACL is not called when this happens.
31072
31073 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31074 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31075 condition to match against the raw MIME part. You can also use the
31076 &%mime_regex%& condition to match against the decoded MIME part (see section
31077 &<<SECTscanregex>>&).
31078
31079 At the start of a MIME ACL, a number of variables are set from the header
31080 information for the relevant MIME part. These are described below. The contents
31081 of the MIME part are not by default decoded into a disk file except for MIME
31082 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31083 part into a disk file, you can use the &%decode%& condition. The general
31084 syntax is:
31085 .display
31086 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31087 .endd
31088 The right hand side is expanded before use. After expansion,
31089 the value can be:
31090
31091 .olist
31092 &"0"& or &"false"&, in which case no decoding is done.
31093 .next
31094 The string &"default"&. In that case, the file is put in the temporary
31095 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31096 a sequential file name consisting of the message id and a sequence number. The
31097 full path and name is available in &$mime_decoded_filename$& after decoding.
31098 .next
31099 A full path name starting with a slash. If the full name is an existing
31100 directory, it is used as a replacement for the default directory. The filename
31101 is then sequentially assigned. If the path does not exist, it is used as
31102 the full path and file name.
31103 .next
31104 If the string does not start with a slash, it is used as the
31105 filename, and the default path is then used.
31106 .endlist
31107 The &%decode%& condition normally succeeds. It is only false for syntax
31108 errors or unusual circumstances such as memory shortages. You can easily decode
31109 a file with its original, proposed filename using
31110 .code
31111 decode = $mime_filename
31112 .endd
31113 However, you should keep in mind that &$mime_filename$& might contain
31114 anything. If you place files outside of the default path, they are not
31115 automatically unlinked.
31116
31117 For RFC822 attachments (these are messages attached to messages, with a
31118 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31119 as for the primary message, only that the &$mime_is_rfc822$& expansion
31120 variable is set (see below). Attached messages are always decoded to disk
31121 before being checked, and the files are unlinked once the check is done.
31122
31123 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31124 used to match regular expressions against raw and decoded MIME parts,
31125 respectively. They are described in section &<<SECTscanregex>>&.
31126
31127 .cindex "MIME content scanning" "returned variables"
31128 The following list describes all expansion variables that are
31129 available in the MIME ACL:
31130
31131 .vlist
31132 .vitem &$mime_boundary$&
31133 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31134 have a boundary string, which is stored in this variable. If the current part
31135 has no boundary parameter in the &'Content-Type:'& header, this variable
31136 contains the empty string.
31137
31138 .vitem &$mime_charset$&
31139 This variable contains the character set identifier, if one was found in the
31140 &'Content-Type:'& header. Examples for charset identifiers are:
31141 .code
31142 us-ascii
31143 gb2312 (Chinese)
31144 iso-8859-1
31145 .endd
31146 Please note that this value is not normalized, so you should do matches
31147 case-insensitively.
31148
31149 .vitem &$mime_content_description$&
31150 This variable contains the normalized content of the &'Content-Description:'&
31151 header. It can contain a human-readable description of the parts content. Some
31152 implementations repeat the filename for attachments here, but they are usually
31153 only used for display purposes.
31154
31155 .vitem &$mime_content_disposition$&
31156 This variable contains the normalized content of the &'Content-Disposition:'&
31157 header. You can expect strings like &"attachment"& or &"inline"& here.
31158
31159 .vitem &$mime_content_id$&
31160 This variable contains the normalized content of the &'Content-ID:'& header.
31161 This is a unique ID that can be used to reference a part from another part.
31162
31163 .vitem &$mime_content_size$&
31164 This variable is set only after the &%decode%& modifier (see above) has been
31165 successfully run. It contains the size of the decoded part in kilobytes. The
31166 size is always rounded up to full kilobytes, so only a completely empty part
31167 has a &$mime_content_size$& of zero.
31168
31169 .vitem &$mime_content_transfer_encoding$&
31170 This variable contains the normalized content of the
31171 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31172 type. Typical values are &"base64"& and &"quoted-printable"&.
31173
31174 .vitem &$mime_content_type$&
31175 If the MIME part has a &'Content-Type:'& header, this variable contains its
31176 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31177 are some examples of popular MIME types, as they may appear in this variable:
31178 .code
31179 text/plain
31180 text/html
31181 application/octet-stream
31182 image/jpeg
31183 audio/midi
31184 .endd
31185 If the MIME part has no &'Content-Type:'& header, this variable contains the
31186 empty string.
31187
31188 .vitem &$mime_decoded_filename$&
31189 This variable is set only after the &%decode%& modifier (see above) has been
31190 successfully run. It contains the full path and file name of the file
31191 containing the decoded data.
31192 .endlist
31193
31194 .cindex "RFC 2047"
31195 .vlist
31196 .vitem &$mime_filename$&
31197 This is perhaps the most important of the MIME variables. It contains a
31198 proposed filename for an attachment, if one was found in either the
31199 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31200 RFC2047 or RFC2231 decoded, but no additional sanity checks are done.
31201  If no filename was
31202 found, this variable contains the empty string.
31203
31204 .vitem &$mime_is_coverletter$&
31205 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31206 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31207 content in the cover letter, while not restricting attachments at all.
31208
31209 The variable contains 1 (true) for a MIME part believed to be part of the
31210 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31211 follows:
31212
31213 .olist
31214 The outermost MIME part of a message is always a cover letter.
31215
31216 .next
31217 If a multipart/alternative or multipart/related MIME part is a cover letter,
31218 so are all MIME subparts within that multipart.
31219
31220 .next
31221 If any other multipart is a cover letter, the first subpart is a cover letter,
31222 and the rest are attachments.
31223
31224 .next
31225 All parts contained within an attachment multipart are attachments.
31226 .endlist olist
31227
31228 As an example, the following will ban &"HTML mail"& (including that sent with
31229 alternative plain text), while allowing HTML files to be attached. HTML
31230 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31231 .code
31232 deny message = HTML mail is not accepted here
31233 !condition = $mime_is_rfc822
31234 condition = $mime_is_coverletter
31235 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31236 .endd
31237 .vitem &$mime_is_multipart$&
31238 This variable has the value 1 (true) when the current part has the main type
31239 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31240 Since multipart entities only serve as containers for other parts, you may not
31241 want to carry out specific actions on them.
31242
31243 .vitem &$mime_is_rfc822$&
31244 This variable has the value 1 (true) if the current part is not a part of the
31245 checked message itself, but part of an attached message. Attached message
31246 decoding is fully recursive.
31247
31248 .vitem &$mime_part_count$&
31249 This variable is a counter that is raised for each processed MIME part. It
31250 starts at zero for the very first part (which is usually a multipart). The
31251 counter is per-message, so it is reset when processing RFC822 attachments (see
31252 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31253 complete, so you can use it in the DATA ACL to determine the number of MIME
31254 parts of a message. For non-MIME messages, this variable contains the value -1.
31255 .endlist
31256
31257
31258
31259 .section "Scanning with regular expressions" "SECTscanregex"
31260 .cindex "content scanning" "with regular expressions"
31261 .cindex "regular expressions" "content scanning with"
31262 You can specify your own custom regular expression matches on the full body of
31263 the message, or on individual MIME parts.
31264
31265 The &%regex%& condition takes one or more regular expressions as arguments and
31266 matches them against the full message (when called in the DATA ACL) or a raw
31267 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31268 linewise, with a maximum line length of 32K characters. That means you cannot
31269 have multiline matches with the &%regex%& condition.
31270
31271 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31272 to 32K of decoded content (the whole content at once, not linewise). If the
31273 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31274 is decoded automatically when &%mime_regex%& is executed (using default path
31275 and filename values). If the decoded data is larger than  32K, only the first
31276 32K characters are checked.
31277
31278 The regular expressions are passed as a colon-separated list. To include a
31279 literal colon, you must double it. Since the whole right-hand side string is
31280 expanded before being used, you must also escape dollar signs and backslashes
31281 with more backslashes, or use the &`\N`& facility to disable expansion.
31282 Here is a simple example that contains two regular expressions:
31283 .code
31284 deny message = contains blacklisted regex ($regex_match_string)
31285      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31286 .endd
31287 The conditions returns true if any one of the regular expressions matches. The
31288 &$regex_match_string$& expansion variable is then set up and contains the
31289 matching regular expression.
31290
31291 &*Warning*&: With large messages, these conditions can be fairly
31292 CPU-intensive.
31293
31294
31295
31296
31297 .section "The demime condition" "SECTdemimecond"
31298 .cindex "content scanning" "MIME checking"
31299 .cindex "MIME content scanning"
31300 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31301 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31302 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31303 ACL functionality, but provides no additional facilities. Please note that this
31304 condition is deprecated and kept only for backward compatibility. You must set
31305 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31306 use the &%demime%& condition.
31307
31308 The &%demime%& condition unpacks MIME containers in the message. It detects
31309 errors in MIME containers and can match file extensions found in the message
31310 against a list. Using this facility produces files containing the unpacked MIME
31311 parts of the message in the temporary scan directory. If you do antivirus
31312 scanning, it is recommended that you use the &%demime%& condition before the
31313 antivirus (&%malware%&) condition.
31314
31315 On the right-hand side of the &%demime%& condition you can pass a
31316 colon-separated list of file extensions that it should match against. For
31317 example:
31318 .code
31319 deny message = Found blacklisted file attachment
31320      demime  = vbs:com:bat:pif:prf:lnk
31321 .endd
31322 If one of the file extensions is found, the condition is true, otherwise it is
31323 false. If there is a temporary error while demimeing (for example, &"disk
31324 full"&), the condition defers, and the message is temporarily rejected (unless
31325 the condition is on a &%warn%& verb).
31326
31327 The right-hand side is expanded before being treated as a list, so you can have
31328 conditions and lookups there. If it expands to an empty string, &"false"&, or
31329 zero (&"0"&), no demimeing is done and the condition is false.
31330
31331 The &%demime%& condition set the following variables:
31332
31333 .vlist
31334 .vitem &$demime_errorlevel$&
31335 .vindex "&$demime_errorlevel$&"
31336 When an error is detected in a MIME container, this variable contains the
31337 severity of the error, as an integer number. The higher the value, the more
31338 severe the error (the current maximum value is 3). If this variable is unset or
31339 zero, no error occurred.
31340
31341 .vitem &$demime_reason$&
31342 .vindex "&$demime_reason$&"
31343 When &$demime_errorlevel$& is greater than zero, this variable contains a
31344 human-readable text string describing the MIME error that occurred.
31345 .endlist
31346
31347 .vlist
31348 .vitem &$found_extension$&
31349 .vindex "&$found_extension$&"
31350 When the &%demime%& condition is true, this variable contains the file
31351 extension it found.
31352 .endlist
31353
31354 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31355 the &%demime%& condition, and are not changed on subsequent calls.
31356
31357 If you do not want to check for file extensions, but rather use the &%demime%&
31358 condition for unpacking or error checking purposes, pass &"*"& as the
31359 right-hand side value. Here is a more elaborate example of how to use this
31360 facility:
31361 .code
31362 # Reject messages with serious MIME container errors
31363 deny  message = Found MIME error ($demime_reason).
31364       demime = *
31365       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31366
31367 # Reject known virus spreading file extensions.
31368 # Accepting these is pretty much braindead.
31369 deny  message = contains $found_extension file (blacklisted).
31370       demime  = com:vbs:bat:pif:scr
31371
31372 # Freeze .exe and .doc files. Postmaster can
31373 # examine them and eventually thaw them.
31374 deny  log_message = Another $found_extension file.
31375       demime = exe:doc
31376       control = freeze
31377 .endd
31378 .ecindex IIDcosca
31379
31380
31381
31382
31383 . ////////////////////////////////////////////////////////////////////////////
31384 . ////////////////////////////////////////////////////////////////////////////
31385
31386 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31387          "Local scan function"
31388 .scindex IIDlosca "&[local_scan()]& function" "description of"
31389 .cindex "customizing" "input scan using C function"
31390 .cindex "policy control" "by local scan function"
31391 In these days of email worms, viruses, and ever-increasing spam, some sites
31392 want to apply a lot of checking to messages before accepting them.
31393
31394 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31395 passing messages to external virus and spam scanning software. You can also do
31396 a certain amount in Exim itself through string expansions and the &%condition%&
31397 condition in the ACL that runs after the SMTP DATA command or the ACL for
31398 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31399
31400 To allow for further customization to a site's own requirements, there is the
31401 possibility of linking Exim with a private message scanning function, written
31402 in C. If you want to run code that is written in something other than C, you
31403 can of course use a little C stub to call it.
31404
31405 The local scan function is run once for every incoming message, at the point
31406 when Exim is just about to accept the message.
31407 It can therefore be used to control non-SMTP messages from local processes as
31408 well as messages arriving via SMTP.
31409
31410 Exim applies a timeout to calls of the local scan function, and there is an
31411 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31412 Zero means &"no timeout"&.
31413 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31414 before calling the local scan function, so that the most common types of crash
31415 are caught. If the timeout is exceeded or one of those signals is caught, the
31416 incoming message is rejected with a temporary error if it is an SMTP message.
31417 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31418 code. The incident is logged on the main and reject logs.
31419
31420
31421
31422 .section "Building Exim to use a local scan function" "SECID207"
31423 .cindex "&[local_scan()]& function" "building Exim to use"
31424 To make use of the local scan function feature, you must tell Exim where your
31425 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31426 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31427 directory, so you might set
31428 .code
31429 LOCAL_SCAN_SOURCE=Local/local_scan.c
31430 .endd
31431 for example. The function must be called &[local_scan()]&. It is called by
31432 Exim after it has received a message, when the success return code is about to
31433 be sent. This is after all the ACLs have been run. The return code from your
31434 function controls whether the message is actually accepted or not. There is a
31435 commented template function (that just accepts the message) in the file
31436 _src/local_scan.c_.
31437
31438 If you want to make use of Exim's run time configuration file to set options
31439 for your &[local_scan()]& function, you must also set
31440 .code
31441 LOCAL_SCAN_HAS_OPTIONS=yes
31442 .endd
31443 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31444
31445
31446
31447
31448 .section "API for local_scan()" "SECTapiforloc"
31449 .cindex "&[local_scan()]& function" "API description"
31450 You must include this line near the start of your code:
31451 .code
31452 #include "local_scan.h"
31453 .endd
31454 This header file defines a number of variables and other values, and the
31455 prototype for the function itself. Exim is coded to use unsigned char values
31456 almost exclusively, and one of the things this header defines is a shorthand
31457 for &`unsigned char`& called &`uschar`&.
31458 It also contains the following macro definitions, to simplify casting character
31459 strings and pointers to character strings:
31460 .code
31461 #define CS   (char *)
31462 #define CCS  (const char *)
31463 #define CSS  (char **)
31464 #define US   (unsigned char *)
31465 #define CUS  (const unsigned char *)
31466 #define USS  (unsigned char **)
31467 .endd
31468 The function prototype for &[local_scan()]& is:
31469 .code
31470 extern int local_scan(int fd, uschar **return_text);
31471 .endd
31472 The arguments are as follows:
31473
31474 .ilist
31475 &%fd%& is a file descriptor for the file that contains the body of the message
31476 (the -D file). The file is open for reading and writing, but updating it is not
31477 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31478
31479 The descriptor is positioned at character 19 of the file, which is the first
31480 character of the body itself, because the first 19 characters are the message
31481 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31482 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31483 case this changes in some future version.
31484 .next
31485 &%return_text%& is an address which you can use to return a pointer to a text
31486 string at the end of the function. The value it points to on entry is NULL.
31487 .endlist
31488
31489 The function must return an &%int%& value which is one of the following macros:
31490
31491 .vlist
31492 .vitem &`LOCAL_SCAN_ACCEPT`&
31493 .vindex "&$local_scan_data$&"
31494 The message is accepted. If you pass back a string of text, it is saved with
31495 the message, and made available in the variable &$local_scan_data$&. No
31496 newlines are permitted (if there are any, they are turned into spaces) and the
31497 maximum length of text is 1000 characters.
31498
31499 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31500 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31501 queued without immediate delivery, and is frozen.
31502
31503 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31504 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31505 queued without immediate delivery.
31506
31507 .vitem &`LOCAL_SCAN_REJECT`&
31508 The message is rejected; the returned text is used as an error message which is
31509 passed back to the sender and which is also logged. Newlines are permitted &--
31510 they cause a multiline response for SMTP rejections, but are converted to
31511 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31512 used.
31513
31514 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31515 The message is temporarily rejected; the returned text is used as an error
31516 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31517 problem"& is used.
31518
31519 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31520 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31521 message is not written to the reject log. It has the effect of unsetting the
31522 &%rejected_header%& log selector for just this rejection. If
31523 &%rejected_header%& is already unset (see the discussion of the
31524 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31525 same as LOCAL_SCAN_REJECT.
31526
31527 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31528 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31529 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31530 .endlist
31531
31532 If the message is not being received by interactive SMTP, rejections are
31533 reported by writing to &%stderr%& or by sending an email, as configured by the
31534 &%-oe%& command line options.
31535
31536
31537
31538 .section "Configuration options for local_scan()" "SECTconoptloc"
31539 .cindex "&[local_scan()]& function" "configuration options"
31540 It is possible to have option settings in the main configuration file
31541 that set values in static variables in the &[local_scan()]& module. If you
31542 want to do this, you must have the line
31543 .code
31544 LOCAL_SCAN_HAS_OPTIONS=yes
31545 .endd
31546 in your &_Local/Makefile_& when you build Exim. (This line is in
31547 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31548 file, you must define static variables to hold the option values, and a table
31549 to define them.
31550
31551 The table must be a vector called &%local_scan_options%&, of type
31552 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31553 and a pointer to the variable that holds the value. The entries must appear in
31554 alphabetical order. Following &%local_scan_options%& you must also define a
31555 variable called &%local_scan_options_count%& that contains the number of
31556 entries in the table. Here is a short example, showing two kinds of option:
31557 .code
31558 static int my_integer_option = 42;
31559 static uschar *my_string_option = US"a default string";
31560
31561 optionlist local_scan_options[] = {
31562   { "my_integer", opt_int,       &my_integer_option },
31563   { "my_string",  opt_stringptr, &my_string_option }
31564 };
31565
31566 int local_scan_options_count =
31567   sizeof(local_scan_options)/sizeof(optionlist);
31568 .endd
31569 The values of the variables can now be changed from Exim's runtime
31570 configuration file by including a local scan section as in this example:
31571 .code
31572 begin local_scan
31573 my_integer = 99
31574 my_string = some string of text...
31575 .endd
31576 The available types of option data are as follows:
31577
31578 .vlist
31579 .vitem &*opt_bool*&
31580 This specifies a boolean (true/false) option. The address should point to a
31581 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31582 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31583 whether such a variable has been set at all, you can initialize it to
31584 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31585 values.)
31586
31587 .vitem &*opt_fixed*&
31588 This specifies a fixed point number, such as is used for load averages.
31589 The address should point to a variable of type &`int`&. The value is stored
31590 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31591
31592 .vitem &*opt_int*&
31593 This specifies an integer; the address should point to a variable of type
31594 &`int`&. The value may be specified in any of the integer formats accepted by
31595 Exim.
31596
31597 .vitem &*opt_mkint*&
31598 This is the same as &%opt_int%&, except that when such a value is output in a
31599 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31600 printed with the suffix K or M.
31601
31602 .vitem &*opt_octint*&
31603 This also specifies an integer, but the value is always interpreted as an
31604 octal integer, whether or not it starts with the digit zero, and it is
31605 always output in octal.
31606
31607 .vitem &*opt_stringptr*&
31608 This specifies a string value; the address must be a pointer to a
31609 variable that points to a string (for example, of type &`uschar *`&).
31610
31611 .vitem &*opt_time*&
31612 This specifies a time interval value. The address must point to a variable of
31613 type &`int`&. The value that is placed there is a number of seconds.
31614 .endlist
31615
31616 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31617 out the values of all the &[local_scan()]& options.
31618
31619
31620
31621 .section "Available Exim variables" "SECID208"
31622 .cindex "&[local_scan()]& function" "available Exim variables"
31623 The header &_local_scan.h_& gives you access to a number of C variables. These
31624 are the only ones that are guaranteed to be maintained from release to release.
31625 Note, however, that you can obtain the value of any Exim expansion variable,
31626 including &$recipients$&, by calling &'expand_string()'&. The exported
31627 C variables are as follows:
31628
31629 .vlist
31630 .vitem &*int&~body_linecount*&
31631 This variable contains the number of lines in the message's body.
31632
31633 .vitem &*int&~body_zerocount*&
31634 This variable contains the number of binary zero bytes in the message's body.
31635
31636 .vitem &*unsigned&~int&~debug_selector*&
31637 This variable is set to zero when no debugging is taking place. Otherwise, it
31638 is a bitmap of debugging selectors. Two bits are identified for use in
31639 &[local_scan()]&; they are defined as macros:
31640
31641 .ilist
31642 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31643 testing option that is not privileged &-- any caller may set it. All the
31644 other selector bits can be set only by admin users.
31645
31646 .next
31647 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31648 by the &`+local_scan`& debug selector. It is not included in the default set
31649 of debugging bits.
31650 .endlist ilist
31651
31652 Thus, to write to the debugging output only when &`+local_scan`& has been
31653 selected, you should use code like this:
31654 .code
31655 if ((debug_selector & D_local_scan) != 0)
31656   debug_printf("xxx", ...);
31657 .endd
31658 .vitem &*uschar&~*expand_string_message*&
31659 After a failing call to &'expand_string()'& (returned value NULL), the
31660 variable &%expand_string_message%& contains the error message, zero-terminated.
31661
31662 .vitem &*header_line&~*header_list*&
31663 A pointer to a chain of header lines. The &%header_line%& structure is
31664 discussed below.
31665
31666 .vitem &*header_line&~*header_last*&
31667 A pointer to the last of the header lines.
31668
31669 .vitem &*uschar&~*headers_charset*&
31670 The value of the &%headers_charset%& configuration option.
31671
31672 .vitem &*BOOL&~host_checking*&
31673 This variable is TRUE during a host checking session that is initiated by the
31674 &%-bh%& command line option.
31675
31676 .vitem &*uschar&~*interface_address*&
31677 The IP address of the interface that received the message, as a string. This
31678 is NULL for locally submitted messages.
31679
31680 .vitem &*int&~interface_port*&
31681 The port on which this message was received. When testing with the &%-bh%&
31682 command line option, the value of this variable is -1 unless a port has been
31683 specified via the &%-oMi%& option.
31684
31685 .vitem &*uschar&~*message_id*&
31686 This variable contains Exim's message id for the incoming message (the value of
31687 &$message_exim_id$&) as a zero-terminated string.
31688
31689 .vitem &*uschar&~*received_protocol*&
31690 The name of the protocol by which the message was received.
31691
31692 .vitem &*int&~recipients_count*&
31693 The number of accepted recipients.
31694
31695 .vitem &*recipient_item&~*recipients_list*&
31696 .cindex "recipient" "adding in local scan"
31697 .cindex "recipient" "removing in local scan"
31698 The list of accepted recipients, held in a vector of length
31699 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31700 can add additional recipients by calling &'receive_add_recipient()'& (see
31701 below). You can delete recipients by removing them from the vector and
31702 adjusting the value in &%recipients_count%&. In particular, by setting
31703 &%recipients_count%& to zero you remove all recipients. If you then return the
31704 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31705 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31706 and then call &'receive_add_recipient()'& as often as needed.
31707
31708 .vitem &*uschar&~*sender_address*&
31709 The envelope sender address. For bounce messages this is the empty string.
31710
31711 .vitem &*uschar&~*sender_host_address*&
31712 The IP address of the sending host, as a string. This is NULL for
31713 locally-submitted messages.
31714
31715 .vitem &*uschar&~*sender_host_authenticated*&
31716 The name of the authentication mechanism that was used, or NULL if the message
31717 was not received over an authenticated SMTP connection.
31718
31719 .vitem &*uschar&~*sender_host_name*&
31720 The name of the sending host, if known.
31721
31722 .vitem &*int&~sender_host_port*&
31723 The port on the sending host.
31724
31725 .vitem &*BOOL&~smtp_input*&
31726 This variable is TRUE for all SMTP input, including BSMTP.
31727
31728 .vitem &*BOOL&~smtp_batched_input*&
31729 This variable is TRUE for BSMTP input.
31730
31731 .vitem &*int&~store_pool*&
31732 The contents of this variable control which pool of memory is used for new
31733 requests. See section &<<SECTmemhanloc>>& for details.
31734 .endlist
31735
31736
31737 .section "Structure of header lines" "SECID209"
31738 The &%header_line%& structure contains the members listed below.
31739 You can add additional header lines by calling the &'header_add()'& function
31740 (see below). You can cause header lines to be ignored (deleted) by setting
31741 their type to *.
31742
31743
31744 .vlist
31745 .vitem &*struct&~header_line&~*next*&
31746 A pointer to the next header line, or NULL for the last line.
31747
31748 .vitem &*int&~type*&
31749 A code identifying certain headers that Exim recognizes. The codes are printing
31750 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31751 Notice in particular that any header line whose type is * is not transmitted
31752 with the message. This flagging is used for header lines that have been
31753 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31754 lines.) Effectively, * means &"deleted"&.
31755
31756 .vitem &*int&~slen*&
31757 The number of characters in the header line, including the terminating and any
31758 internal newlines.
31759
31760 .vitem &*uschar&~*text*&
31761 A pointer to the text of the header. It always ends with a newline, followed by
31762 a zero byte. Internal newlines are preserved.
31763 .endlist
31764
31765
31766
31767 .section "Structure of recipient items" "SECID210"
31768 The &%recipient_item%& structure contains these members:
31769
31770 .vlist
31771 .vitem &*uschar&~*address*&
31772 This is a pointer to the recipient address as it was received.
31773
31774 .vitem &*int&~pno*&
31775 This is used in later Exim processing when top level addresses are created by
31776 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31777 and must always contain -1 at this stage.
31778
31779 .vitem &*uschar&~*errors_to*&
31780 If this value is not NULL, bounce messages caused by failing to deliver to the
31781 recipient are sent to the address it contains. In other words, it overrides the
31782 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31783 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31784 an unqualified address, Exim qualifies it using the domain from
31785 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31786 is NULL for all recipients.
31787 .endlist
31788
31789
31790
31791 .section "Available Exim functions" "SECID211"
31792 .cindex "&[local_scan()]& function" "available Exim functions"
31793 The header &_local_scan.h_& gives you access to a number of Exim functions.
31794 These are the only ones that are guaranteed to be maintained from release to
31795 release:
31796
31797 .vlist
31798 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31799        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31800
31801 This function creates a child process that runs the command specified by
31802 &%argv%&. The environment for the process is specified by &%envp%&, which can
31803 be NULL if no environment variables are to be passed. A new umask is supplied
31804 for the process in &%newumask%&.
31805
31806 Pipes to the standard input and output of the new process are set up
31807 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31808 standard error is cloned to the standard output. If there are any file
31809 descriptors &"in the way"& in the new process, they are closed. If the final
31810 argument is TRUE, the new process is made into a process group leader.
31811
31812 The function returns the pid of the new process, or -1 if things go wrong.
31813
31814 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31815 This function waits for a child process to terminate, or for a timeout (in
31816 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31817 return value is as follows:
31818
31819 .ilist
31820 >= 0
31821
31822 The process terminated by a normal exit and the value is the process
31823 ending status.
31824
31825 .next
31826 < 0 and > &--256
31827
31828 The process was terminated by a signal and the value is the negation of the
31829 signal number.
31830
31831 .next
31832 &--256
31833
31834 The process timed out.
31835 .next
31836 &--257
31837
31838 The was some other error in wait(); &%errno%& is still set.
31839 .endlist
31840
31841 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31842 This function provide you with a means of submitting a new message to
31843 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31844 want, but this packages it all up for you.) The function creates a pipe,
31845 forks a subprocess that is running
31846 .code
31847 exim -t -oem -oi -f <>
31848 .endd
31849 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31850 that is connected to the standard input. The yield of the function is the PID
31851 of the subprocess. You can then write a message to the file descriptor, with
31852 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31853
31854 When you have finished, call &'child_close()'& to wait for the process to
31855 finish and to collect its ending status. A timeout value of zero is usually
31856 fine in this circumstance. Unless you have made a mistake with the recipient
31857 addresses, you should get a return code of zero.
31858
31859
31860 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31861        *sender_authentication)*&
31862 This function is a more sophisticated version of &'child_open()'&. The command
31863 that it runs is:
31864 .display
31865 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31866 .endd
31867 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31868
31869
31870 .vitem &*void&~debug_printf(char&~*,&~...)*&
31871 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31872 output is written to the standard error stream. If no debugging is selected,
31873 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31874 conditional on the &`local_scan`& debug selector by coding like this:
31875 .code
31876 if ((debug_selector & D_local_scan) != 0)
31877   debug_printf("xxx", ...);
31878 .endd
31879
31880 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31881 This is an interface to Exim's string expansion code. The return value is the
31882 expanded string, or NULL if there was an expansion failure.
31883 The C variable &%expand_string_message%& contains an error message after an
31884 expansion failure. If expansion does not change the string, the return value is
31885 the pointer to the input string. Otherwise, the return value points to a new
31886 block of memory that was obtained by a call to &'store_get()'&. See section
31887 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31888
31889 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31890 This function allows you to an add additional header line at the end of the
31891 existing ones. The first argument is the type, and should normally be a space
31892 character. The second argument is a format string and any number of
31893 substitution arguments as for &[sprintf()]&. You may include internal newlines
31894 if you want, and you must ensure that the string ends with a newline.
31895
31896 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31897         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31898 This function adds a new header line at a specified point in the header
31899 chain. The header itself is specified as for &'header_add()'&.
31900
31901 If &%name%& is NULL, the new header is added at the end of the chain if
31902 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31903 NULL, the header lines are searched for the first non-deleted header that
31904 matches the name. If one is found, the new header is added before it if
31905 &%after%& is false. If &%after%& is true, the new header is added after the
31906 found header and any adjacent subsequent ones with the same name (even if
31907 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31908 option controls where the header is added. If it is true, addition is at the
31909 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31910 headers, or at the top if there are no &'Received:'& headers, you could use
31911 .code
31912 header_add_at_position(TRUE, US"Received", TRUE,
31913   ' ', "X-xxx: ...");
31914 .endd
31915 Normally, there is always at least one non-deleted &'Received:'& header, but
31916 there may not be if &%received_header_text%& expands to an empty string.
31917
31918
31919 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31920 This function removes header lines. If &%occurrence%& is zero or negative, all
31921 occurrences of the header are removed. If occurrence is greater than zero, that
31922 particular instance of the header is removed. If no header(s) can be found that
31923 match the specification, the function does nothing.
31924
31925
31926 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31927         int&~length,&~BOOL&~notdel)*&"
31928 This function tests whether the given header has the given name. It is not just
31929 a string comparison, because white space is permitted between the name and the
31930 colon. If the &%notdel%& argument is true, a false return is forced for all
31931 &"deleted"& headers; otherwise they are not treated specially. For example:
31932 .code
31933 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31934 .endd
31935 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31936 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31937 This function base64-encodes a string, which is passed by address and length.
31938 The text may contain bytes of any value, including zero. The result is passed
31939 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31940 zero-terminated.
31941
31942 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31943 This function decodes a base64-encoded string. Its arguments are a
31944 zero-terminated base64-encoded string and the address of a variable that is set
31945 to point to the result, which is in dynamic memory. The length of the decoded
31946 string is the yield of the function. If the input is invalid base64 data, the
31947 yield is -1. A zero byte is added to the end of the output string to make it
31948 easy to interpret as a C string (assuming it contains no zeros of its own). The
31949 added zero byte is not included in the returned count.
31950
31951 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31952 This function checks for a match in a domain list. Domains are always
31953 matched caselessly. The return value is one of the following:
31954 .display
31955 &`OK     `& match succeeded
31956 &`FAIL   `& match failed
31957 &`DEFER  `& match deferred
31958 .endd
31959 DEFER is usually caused by some kind of lookup defer, such as the
31960 inability to contact a database.
31961
31962 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31963         BOOL&~caseless)*&"
31964 This function checks for a match in a local part list. The third argument
31965 controls case-sensitivity. The return values are as for
31966 &'lss_match_domain()'&.
31967
31968 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31969         BOOL&~caseless)*&"
31970 This function checks for a match in an address list. The third argument
31971 controls the case-sensitivity of the local part match. The domain is always
31972 matched caselessly. The return values are as for &'lss_match_domain()'&.
31973
31974 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31975         uschar&~*list)*&"
31976 This function checks for a match in a host list. The most common usage is
31977 expected to be
31978 .code
31979 lss_match_host(sender_host_name, sender_host_address, ...)
31980 .endd
31981 .vindex "&$sender_host_address$&"
31982 An empty address field matches an empty item in the host list. If the host name
31983 is NULL, the name corresponding to &$sender_host_address$& is automatically
31984 looked up if a host name is required to match an item in the list. The return
31985 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31986 returns ERROR in the case when it had to look up a host name, but the lookup
31987 failed.
31988
31989 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31990         *format,&~...)*&"
31991 This function writes to Exim's log files. The first argument should be zero (it
31992 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31993 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31994 them. It specifies to which log or logs the message is written. The remaining
31995 arguments are a format and relevant insertion arguments. The string should not
31996 contain any newlines, not even at the end.
31997
31998
31999 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32000 This function adds an additional recipient to the message. The first argument
32001 is the recipient address. If it is unqualified (has no domain), it is qualified
32002 with the &%qualify_recipient%& domain. The second argument must always be -1.
32003
32004 This function does not allow you to specify a private &%errors_to%& address (as
32005 described with the structure of &%recipient_item%& above), because it pre-dates
32006 the addition of that field to the structure. However, it is easy to add such a
32007 value afterwards. For example:
32008 .code
32009  receive_add_recipient(US"monitor@mydom.example", -1);
32010  recipients_list[recipients_count-1].errors_to =
32011    US"postmaster@mydom.example";
32012 .endd
32013
32014 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32015 This is a convenience function to remove a named recipient from the list of
32016 recipients. It returns true if a recipient was removed, and false if no
32017 matching recipient could be found. The argument must be a complete email
32018 address.
32019 .endlist
32020
32021
32022 .cindex "RFC 2047"
32023 .vlist
32024 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32025   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32026 This function decodes strings that are encoded according to RFC 2047. Typically
32027 these are the contents of header lines. First, each &"encoded word"& is decoded
32028 from the Q or B encoding into a byte-string. Then, if provided with the name of
32029 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32030 made  to translate the result to the named character set. If this fails, the
32031 binary string is returned with an error message.
32032
32033 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32034 maximum MIME word length is enforced. The third argument is the target
32035 encoding, or NULL if no translation is wanted.
32036
32037 .cindex "binary zero" "in RFC 2047 decoding"
32038 .cindex "RFC 2047" "binary zero in"
32039 If a binary zero is encountered in the decoded string, it is replaced by the
32040 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32041 not be 0 because header lines are handled as zero-terminated strings.
32042
32043 The function returns the result of processing the string, zero-terminated; if
32044 &%lenptr%& is not NULL, the length of the result is set in the variable to
32045 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32046
32047 If an error is encountered, the function returns NULL and uses the &%error%&
32048 argument to return an error message. The variable pointed to by &%error%& is
32049 set to NULL if there is no error; it may be set non-NULL even when the function
32050 returns a non-NULL value if decoding was successful, but there was a problem
32051 with translation.
32052
32053
32054 .vitem &*int&~smtp_fflush(void)*&
32055 This function is used in conjunction with &'smtp_printf()'&, as described
32056 below.
32057
32058 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32059 The arguments of this function are like &[printf()]&; it writes to the SMTP
32060 output stream. You should use this function only when there is an SMTP output
32061 stream, that is, when the incoming message is being received via interactive
32062 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32063 is FALSE. If you want to test for an incoming message from another host (as
32064 opposed to a local process that used the &%-bs%& command line option), you can
32065 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32066 is involved.
32067
32068 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32069 output function, so it can be used for all forms of SMTP connection.
32070
32071 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32072 must start with an appropriate response code: 550 if you are going to return
32073 LOCAL_SCAN_REJECT, 451 if you are going to return
32074 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32075 initial lines of a multi-line response, the code must be followed by a hyphen
32076 to indicate that the line is not the final response line. You must also ensure
32077 that the lines you write terminate with CRLF. For example:
32078 .code
32079 smtp_printf("550-this is some extra info\r\n");
32080 return LOCAL_SCAN_REJECT;
32081 .endd
32082 Note that you can also create multi-line responses by including newlines in
32083 the data returned via the &%return_text%& argument. The added value of using
32084 &'smtp_printf()'& is that, for instance, you could introduce delays between
32085 multiple output lines.
32086
32087 The &'smtp_printf()'& function does not return any error indication, because it
32088 does not automatically flush pending output, and therefore does not test
32089 the state of the stream. (In the main code of Exim, flushing and error
32090 detection is done when Exim is ready for the next SMTP input command.) If
32091 you want to flush the output and check for an error (for example, the
32092 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32093 arguments. It flushes the output stream, and returns a non-zero value if there
32094 is an error.
32095
32096 .vitem &*void&~*store_get(int)*&
32097 This function accesses Exim's internal store (memory) manager. It gets a new
32098 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32099 runs out of memory. See the next section for a discussion of memory handling.
32100
32101 .vitem &*void&~*store_get_perm(int)*&
32102 This function is like &'store_get()'&, but it always gets memory from the
32103 permanent pool. See the next section for a discussion of memory handling.
32104
32105 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32106 See below.
32107
32108 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32109 See below.
32110
32111 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32112 These three functions create strings using Exim's dynamic memory facilities.
32113 The first makes a copy of an entire string. The second copies up to a maximum
32114 number of characters, indicated by the second argument. The third uses a format
32115 and insertion arguments to create a new string. In each case, the result is a
32116 pointer to a new string in the current memory pool. See the next section for
32117 more discussion.
32118 .endlist
32119
32120
32121
32122 .section "More about Exim's memory handling" "SECTmemhanloc"
32123 .cindex "&[local_scan()]& function" "memory handling"
32124 No function is provided for freeing memory, because that is never needed.
32125 The dynamic memory that Exim uses when receiving a message is automatically
32126 recycled if another message is received by the same process (this applies only
32127 to incoming SMTP connections &-- other input methods can supply only one
32128 message at a time). After receiving the last message, a reception process
32129 terminates.
32130
32131 Because it is recycled, the normal dynamic memory cannot be used for holding
32132 data that must be preserved over a number of incoming messages on the same SMTP
32133 connection. However, Exim in fact uses two pools of dynamic memory; the second
32134 one is not recycled, and can be used for this purpose.
32135
32136 If you want to allocate memory that remains available for subsequent messages
32137 in the same SMTP connection, you should set
32138 .code
32139 store_pool = POOL_PERM
32140 .endd
32141 before calling the function that does the allocation. There is no need to
32142 restore the value if you do not need to; however, if you do want to revert to
32143 the normal pool, you can either restore the previous value of &%store_pool%& or
32144 set it explicitly to POOL_MAIN.
32145
32146 The pool setting applies to all functions that get dynamic memory, including
32147 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32148 There is also a convenience function called &'store_get_perm()'& that gets a
32149 block of memory from the permanent pool while preserving the value of
32150 &%store_pool%&.
32151 .ecindex IIDlosca
32152
32153
32154
32155
32156 . ////////////////////////////////////////////////////////////////////////////
32157 . ////////////////////////////////////////////////////////////////////////////
32158
32159 .chapter "System-wide message filtering" "CHAPsystemfilter"
32160 .scindex IIDsysfil1 "filter" "system filter"
32161 .scindex IIDsysfil2 "filtering all mail"
32162 .scindex IIDsysfil3 "system filter"
32163 The previous chapters (on ACLs and the local scan function) describe checks
32164 that can be applied to messages before they are accepted by a host. There is
32165 also a mechanism for checking messages once they have been received, but before
32166 they are delivered. This is called the &'system filter'&.
32167
32168 The system filter operates in a similar manner to users' filter files, but it
32169 is run just once per message (however many recipients the message has).
32170 It should not normally be used as a substitute for routing, because &%deliver%&
32171 commands in a system router provide new envelope recipient addresses.
32172 The system filter must be an Exim filter. It cannot be a Sieve filter.
32173
32174 The system filter is run at the start of a delivery attempt, before any routing
32175 is done. If a message fails to be completely delivered at the first attempt,
32176 the system filter is run again at the start of every retry.
32177 If you want your filter to do something only once per message, you can make use
32178 of the &%first_delivery%& condition in an &%if%& command in the filter to
32179 prevent it happening on retries.
32180
32181 .vindex "&$domain$&"
32182 .vindex "&$local_part$&"
32183 &*Warning*&: Because the system filter runs just once, variables that are
32184 specific to individual recipient addresses, such as &$local_part$& and
32185 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32186 you want to run a centrally-specified filter for each recipient address
32187 independently, you can do so by setting up a suitable &(redirect)& router, as
32188 described in section &<<SECTperaddfil>>& below.
32189
32190
32191 .section "Specifying a system filter" "SECID212"
32192 .cindex "uid (user id)" "system filter"
32193 .cindex "gid (group id)" "system filter"
32194 The name of the file that contains the system filter must be specified by
32195 setting &%system_filter%&. If you want the filter to run under a uid and gid
32196 other than root, you must also set &%system_filter_user%& and
32197 &%system_filter_group%& as appropriate. For example:
32198 .code
32199 system_filter = /etc/mail/exim.filter
32200 system_filter_user = exim
32201 .endd
32202 If a system filter generates any deliveries directly to files or pipes (via the
32203 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32204 specified by setting &%system_filter_file_transport%& and
32205 &%system_filter_pipe_transport%&, respectively. Similarly,
32206 &%system_filter_reply_transport%& must be set to handle any messages generated
32207 by the &%reply%& command.
32208
32209
32210 .section "Testing a system filter" "SECID213"
32211 You can run simple tests of a system filter in the same way as for a user
32212 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32213 are permitted only in system filters are recognized.
32214
32215 If you want to test the combined effect of a system filter and a user filter,
32216 you can use both &%-bF%& and &%-bf%& on the same command line.
32217
32218
32219
32220 .section "Contents of a system filter" "SECID214"
32221 The language used to specify system filters is the same as for users' filter
32222 files. It is described in the separate end-user document &'Exim's interface to
32223 mail filtering'&. However, there are some additional features that are
32224 available only in system filters; these are described in subsequent sections.
32225 If they are encountered in a user's filter file or when testing with &%-bf%&,
32226 they cause errors.
32227
32228 .cindex "frozen messages" "manual thaw; testing in filter"
32229 There are two special conditions which, though available in users' filter
32230 files, are designed for use in system filters. The condition &%first_delivery%&
32231 is true only for the first attempt at delivering a message, and
32232 &%manually_thawed%& is true only if the message has been frozen, and
32233 subsequently thawed by an admin user. An explicit forced delivery counts as a
32234 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32235
32236 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32237 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32238 succeed, it will not be tried again.
32239 If you want Exim to retry an unseen delivery until it succeeds, you should
32240 arrange to set it up every time the filter runs.
32241
32242 When a system filter finishes running, the values of the variables &$n0$& &--
32243 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32244 users' filter files. Thus a system filter can, for example, set up &"scores"&
32245 to which users' filter files can refer.
32246
32247
32248
32249 .section "Additional variable for system filters" "SECID215"
32250 .vindex "&$recipients$&"
32251 The expansion variable &$recipients$&, containing a list of all the recipients
32252 of the message (separated by commas and white space), is available in system
32253 filters. It is not available in users' filters for privacy reasons.
32254
32255
32256
32257 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32258 .cindex "freezing messages"
32259 .cindex "message" "freezing"
32260 .cindex "message" "forced failure"
32261 .cindex "&%fail%&" "in system filter"
32262 .cindex "&%freeze%& in system filter"
32263 .cindex "&%defer%& in system filter"
32264 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32265 always available in system filters, but are not normally enabled in users'
32266 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32267 for the &(redirect)& router.) These commands can optionally be followed by the
32268 word &%text%& and a string containing an error message, for example:
32269 .code
32270 fail text "this message looks like spam to me"
32271 .endd
32272 The keyword &%text%& is optional if the next character is a double quote.
32273
32274 The &%defer%& command defers delivery of the original recipients of the
32275 message. The &%fail%& command causes all the original recipients to be failed,
32276 and a bounce message to be created. The &%freeze%& command suspends all
32277 delivery attempts for the original recipients. In all cases, any new deliveries
32278 that are specified by the filter are attempted as normal after the filter has
32279 run.
32280
32281 The &%freeze%& command is ignored if the message has been manually unfrozen and
32282 not manually frozen since. This means that automatic freezing by a system
32283 filter can be used as a way of checking out suspicious messages. If a message
32284 is found to be all right, manually unfreezing it allows it to be delivered.
32285
32286 .cindex "log" "&%fail%& command log line"
32287 .cindex "&%fail%&" "log line; reducing"
32288 The text given with a fail command is used as part of the bounce message as
32289 well as being written to the log. If the message is quite long, this can fill
32290 up a lot of log space when such failures are common. To reduce the size of the
32291 log message, Exim interprets the text in a special way if it starts with the
32292 two characters &`<<`& and contains &`>>`& later. The text between these two
32293 strings is written to the log, and the rest of the text is used in the bounce
32294 message. For example:
32295 .code
32296 fail "<<filter test 1>>Your message is rejected \
32297      because it contains attachments that we are \
32298      not prepared to receive."
32299 .endd
32300
32301 .cindex "loop" "caused by &%fail%&"
32302 Take great care with the &%fail%& command when basing the decision to fail on
32303 the contents of the message, because the bounce message will of course include
32304 the contents of the original message and will therefore trigger the &%fail%&
32305 command again (causing a mail loop) unless steps are taken to prevent this.
32306 Testing the &%error_message%& condition is one way to prevent this. You could
32307 use, for example
32308 .code
32309 if $message_body contains "this is spam" and not error_message
32310 then fail text "spam is not wanted here" endif
32311 .endd
32312 though of course that might let through unwanted bounce messages. The
32313 alternative is clever checking of the body and/or headers to detect bounces
32314 generated by the filter.
32315
32316 The interpretation of a system filter file ceases after a
32317 &%defer%&,
32318 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32319 set up earlier in the filter file are honoured, so you can use a sequence such
32320 as
32321 .code
32322 mail ...
32323 freeze
32324 .endd
32325 to send a specified message when the system filter is freezing (or deferring or
32326 failing) a message. The normal deliveries for the message do not, of course,
32327 take place.
32328
32329
32330
32331 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32332 .cindex "header lines" "adding; in system filter"
32333 .cindex "header lines" "removing; in system filter"
32334 .cindex "filter" "header lines; adding/removing"
32335 Two filter commands that are available only in system filters are:
32336 .code
32337 headers add <string>
32338 headers remove <string>
32339 .endd
32340 The argument for the &%headers add%& is a string that is expanded and then
32341 added to the end of the message's headers. It is the responsibility of the
32342 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32343 space is ignored, and if the string is otherwise empty, or if the expansion is
32344 forced to fail, the command has no effect.
32345
32346 You can use &"\n"& within the string, followed by white space, to specify
32347 continued header lines. More than one header may be added in one command by
32348 including &"\n"& within the string without any following white space. For
32349 example:
32350 .code
32351 headers add "X-header-1: ....\n  \
32352              continuation of X-header-1 ...\n\
32353              X-header-2: ...."
32354 .endd
32355 Note that the header line continuation white space after the first newline must
32356 be placed before the backslash that continues the input string, because white
32357 space after input continuations is ignored.
32358
32359 The argument for &%headers remove%& is a colon-separated list of header names.
32360 This command applies only to those headers that are stored with the message;
32361 those that are added at delivery time (such as &'Envelope-To:'& and
32362 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32363 header with the same name, they are all removed.
32364
32365 The &%headers%& command in a system filter makes an immediate change to the set
32366 of header lines that was received with the message (with possible additions
32367 from ACL processing). Subsequent commands in the system filter operate on the
32368 modified set, which also forms the basis for subsequent message delivery.
32369 Unless further modified during routing or transporting, this set of headers is
32370 used for all recipients of the message.
32371
32372 During routing and transporting, the variables that refer to the contents of
32373 header lines refer only to those lines that are in this set. Thus, header lines
32374 that are added by a system filter are visible to users' filter files and to all
32375 routers and transports. This contrasts with the manipulation of header lines by
32376 routers and transports, which is not immediate, but which instead is saved up
32377 until the message is actually being written (see section
32378 &<<SECTheadersaddrem>>&).
32379
32380 If the message is not delivered at the first attempt, header lines that were
32381 added by the system filter are stored with the message, and so are still
32382 present at the next delivery attempt. Header lines that were removed are still
32383 present, but marked &"deleted"& so that they are not transported with the
32384 message. For this reason, it is usual to make the &%headers%& command
32385 conditional on &%first_delivery%& so that the set of header lines is not
32386 modified more than once.
32387
32388 Because header modification in a system filter acts immediately, you have to
32389 use an indirect approach if you want to modify the contents of a header line.
32390 For example:
32391 .code
32392 headers add "Old-Subject: $h_subject:"
32393 headers remove "Subject"
32394 headers add "Subject: new subject (was: $h_old-subject:)"
32395 headers remove "Old-Subject"
32396 .endd
32397
32398
32399
32400 .section "Setting an errors address in a system filter" "SECID217"
32401 .cindex "envelope sender"
32402 In a system filter, if a &%deliver%& command is followed by
32403 .code
32404 errors_to <some address>
32405 .endd
32406 in order to change the envelope sender (and hence the error reporting) for that
32407 delivery, any address may be specified. (In a user filter, only the current
32408 user's address can be set.) For example, if some mail is being monitored, you
32409 might use
32410 .code
32411 unseen deliver monitor@spying.example errors_to root@local.example
32412 .endd
32413 to take a copy which would not be sent back to the normal error reporting
32414 address if its delivery failed.
32415
32416
32417
32418 .section "Per-address filtering" "SECTperaddfil"
32419 .vindex "&$domain$&"
32420 .vindex "&$local_part$&"
32421 In contrast to the system filter, which is run just once per message for each
32422 delivery attempt, it is also possible to set up a system-wide filtering
32423 operation that runs once for each recipient address. In this case, variables
32424 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32425 filter file could be made dependent on them. This is an example of a router
32426 which implements such a filter:
32427 .code
32428 central_filter:
32429   check_local_user
32430   driver = redirect
32431   domains = +local_domains
32432   file = /central/filters/$local_part
32433   no_verify
32434   allow_filter
32435   allow_freeze
32436 .endd
32437 The filter is run in a separate process under its own uid. Therefore, either
32438 &%check_local_user%& must be set (as above), in which case the filter is run as
32439 the local user, or the &%user%& option must be used to specify which user to
32440 use. If both are set, &%user%& overrides.
32441
32442 Care should be taken to ensure that none of the commands in the filter file
32443 specify a significant delivery if the message is to go on to be delivered to
32444 its intended recipient. The router will not then claim to have dealt with the
32445 address, so it will be passed on to subsequent routers to be delivered in the
32446 normal way.
32447 .ecindex IIDsysfil1
32448 .ecindex IIDsysfil2
32449 .ecindex IIDsysfil3
32450
32451
32452
32453
32454
32455
32456 . ////////////////////////////////////////////////////////////////////////////
32457 . ////////////////////////////////////////////////////////////////////////////
32458
32459 .chapter "Message processing" "CHAPmsgproc"
32460 .scindex IIDmesproc "message" "general processing"
32461 Exim performs various transformations on the sender and recipient addresses of
32462 all messages that it handles, and also on the messages' header lines. Some of
32463 these are optional and configurable, while others always take place. All of
32464 this processing, except rewriting as a result of routing, and the addition or
32465 removal of header lines while delivering, happens when a message is received,
32466 before it is placed on Exim's queue.
32467
32468 Some of the automatic processing takes place by default only for
32469 &"locally-originated"& messages. This adjective is used to describe messages
32470 that are not received over TCP/IP, but instead are passed to an Exim process on
32471 its standard input. This includes the interactive &"local SMTP"& case that is
32472 set up by the &%-bs%& command line option.
32473
32474 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32475 or ::1) are not considered to be locally-originated. Exim does not treat the
32476 loopback interface specially in any way.
32477
32478 If you want the loopback interface to be treated specially, you must ensure
32479 that there are appropriate entries in your ACLs.
32480
32481
32482
32483
32484 .section "Submission mode for non-local messages" "SECTsubmodnon"
32485 .cindex "message" "submission"
32486 .cindex "submission mode"
32487 Processing that happens automatically for locally-originated messages (unless
32488 &%suppress_local_fixups%& is set) can also be requested for messages that are
32489 received over TCP/IP. The term &"submission mode"& is used to describe this
32490 state. Submission mode is set by the modifier
32491 .code
32492 control = submission
32493 .endd
32494 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32495 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32496 a local submission, and is normally used when the source of the message is
32497 known to be an MUA running on a client host (as opposed to an MTA). For
32498 example, to set submission mode for messages originating on the IPv4 loopback
32499 interface, you could include the following in the MAIL ACL:
32500 .code
32501 warn  hosts = 127.0.0.1
32502       control = submission
32503 .endd
32504 .cindex "&%sender_retain%& submission option"
32505 There are some options that can be used when setting submission mode. A slash
32506 is used to separate options. For example:
32507 .code
32508 control = submission/sender_retain
32509 .endd
32510 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32511 true and &%local_from_check%& false for the current incoming message. The first
32512 of these allows an existing &'Sender:'& header in the message to remain, and
32513 the second suppresses the check to ensure that &'From:'& matches the
32514 authenticated sender. With this setting, Exim still fixes up messages by adding
32515 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32516 attempt to check sender authenticity in header lines.
32517
32518 When &%sender_retain%& is not set, a submission mode setting may specify a
32519 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32520 example:
32521 .code
32522 control = submission/domain=some.domain
32523 .endd
32524 The domain may be empty. How this value is used is described in sections
32525 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32526 that allows you to specify the user's full name for inclusion in a created
32527 &'Sender:'& or &'From:'& header line. For example:
32528 .code
32529 accept authenticated = *
32530        control = submission/domain=wonderland.example/\
32531                             name=${lookup {$authenticated_id} \
32532                                    lsearch {/etc/exim/namelist}}
32533 .endd
32534 Because the name may contain any characters, including slashes, the &%name%&
32535 option must be given last. The remainder of the string is used as the name. For
32536 the example above, if &_/etc/exim/namelist_& contains:
32537 .code
32538 bigegg:  Humpty Dumpty
32539 .endd
32540 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32541 line would be:
32542 .code
32543 Sender: Humpty Dumpty <bigegg@wonderland.example>
32544 .endd
32545 .cindex "return path" "in submission mode"
32546 By default, submission mode forces the return path to the same address as is
32547 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32548 specified, the return path is also left unchanged.
32549
32550 &*Note*&: The changes caused by submission mode take effect after the predata
32551 ACL. This means that any sender checks performed before the fix-ups use the
32552 untrusted sender address specified by the user, not the trusted sender address
32553 specified by submission mode. Although this might be slightly unexpected, it
32554 does mean that you can configure ACL checks to spot that a user is trying to
32555 spoof another's address.
32556
32557 .section "Line endings" "SECTlineendings"
32558 .cindex "line endings"
32559 .cindex "carriage return"
32560 .cindex "linefeed"
32561 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32562 linefeed) is the line ending for messages transmitted over the Internet using
32563 SMTP over TCP/IP. However, within individual operating systems, different
32564 conventions are used. For example, Unix-like systems use just LF, but others
32565 use CRLF or just CR.
32566
32567 Exim was designed for Unix-like systems, and internally, it stores messages
32568 using the system's convention of a single LF as a line terminator. When
32569 receiving a message, all line endings are translated to this standard format.
32570 Originally, it was thought that programs that passed messages directly to an
32571 MTA within an operating system would use that system's convention. Experience
32572 has shown that this is not the case; for example, there are Unix applications
32573 that use CRLF in this circumstance. For this reason, and for compatibility with
32574 other MTAs, the way Exim handles line endings for all messages is now as
32575 follows:
32576
32577 .ilist
32578 LF not preceded by CR is treated as a line ending.
32579 .next
32580 CR is treated as a line ending; if it is immediately followed by LF, the LF
32581 is ignored.
32582 .next
32583 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32584 nor a local message in the state where a line containing only a dot is a
32585 terminator.
32586 .next
32587 If a bare CR is encountered within a header line, an extra space is added after
32588 the line terminator so as not to end the header line. The reasoning behind this
32589 is that bare CRs in header lines are most likely either to be mistakes, or
32590 people trying to play silly games.
32591 .next
32592 If the first header line received in a message ends with CRLF, a subsequent
32593 bare LF in a header line is treated in the same way as a bare CR in a header
32594 line.
32595 .endlist
32596
32597
32598
32599
32600
32601 .section "Unqualified addresses" "SECID218"
32602 .cindex "unqualified addresses"
32603 .cindex "address" "qualification"
32604 By default, Exim expects every envelope address it receives from an external
32605 host to be fully qualified. Unqualified addresses cause negative responses to
32606 SMTP commands. However, because SMTP is used as a means of transporting
32607 messages from MUAs running on personal workstations, there is sometimes a
32608 requirement to accept unqualified addresses from specific hosts or IP networks.
32609
32610 Exim has two options that separately control which hosts may send unqualified
32611 sender or recipient addresses in SMTP commands, namely
32612 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32613 cases, if an unqualified address is accepted, it is qualified by adding the
32614 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32615
32616 .oindex "&%qualify_domain%&"
32617 .oindex "&%qualify_recipient%&"
32618 Unqualified addresses in header lines are automatically qualified for messages
32619 that are locally originated, unless the &%-bnq%& option is given on the command
32620 line. For messages received over SMTP, unqualified addresses in header lines
32621 are qualified only if unqualified addresses are permitted in SMTP commands. In
32622 other words, such qualification is also controlled by
32623 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32624
32625
32626
32627
32628 .section "The UUCP From line" "SECID219"
32629 .cindex "&""From""& line"
32630 .cindex "UUCP" "&""From""& line"
32631 .cindex "sender" "address"
32632 .oindex "&%uucp_from_pattern%&"
32633 .oindex "&%uucp_from_sender%&"
32634 .cindex "envelope sender"
32635 .cindex "Sendmail compatibility" "&""From""& line"
32636 Messages that have come from UUCP (and some other applications) often begin
32637 with a line containing the envelope sender and a timestamp, following the word
32638 &"From"&. Examples of two common formats are:
32639 .code
32640 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32641 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32642 .endd
32643 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32644 Exim recognizes such lines at the start of messages that are submitted to it
32645 via the command line (that is, on the standard input). It does not recognize
32646 such lines in incoming SMTP messages, unless the sending host matches
32647 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32648 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32649 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32650 default value matches the two common cases shown above and puts the address
32651 that follows &"From"& into &$1$&.
32652
32653 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32654 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32655 a trusted user, the message's sender address is constructed by expanding the
32656 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32657 then parsed as an RFC 2822 address. If there is no domain, the local part is
32658 qualified with &%qualify_domain%& unless it is the empty string. However, if
32659 the command line &%-f%& option is used, it overrides the &"From"& line.
32660
32661 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32662 sender address is not changed. This is also the case for incoming SMTP messages
32663 that are permitted to contain &"From"& lines.
32664
32665 Only one &"From"& line is recognized. If there is more than one, the second is
32666 treated as a data line that starts the body of the message, as it is not valid
32667 as a header line. This also happens if a &"From"& line is present in an
32668 incoming SMTP message from a source that is not permitted to send them.
32669
32670
32671
32672 .section "Resent- header lines" "SECID220"
32673 .cindex "&%Resent-%& header lines"
32674 RFC 2822 makes provision for sets of header lines starting with the string
32675 &`Resent-`& to be added to a message when it is resent by the original
32676 recipient to somebody else. These headers are &'Resent-Date:'&,
32677 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32678 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32679
32680 .blockquote
32681 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32682 processing of replies or other such automatic actions on messages.'&
32683 .endblockquote
32684
32685 This leaves things a bit vague as far as other processing actions such as
32686 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32687 follows:
32688
32689 .ilist
32690 A &'Resent-From:'& line that just contains the login id of the submitting user
32691 is automatically rewritten in the same way as &'From:'& (see below).
32692 .next
32693 If there's a rewriting rule for a particular header line, it is also applied to
32694 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32695 &'From:'& also rewrites &'Resent-From:'&.
32696 .next
32697 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32698 also removed.
32699 .next
32700 For a locally-submitted message,
32701 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32702 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32703 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32704 included in log lines in this case.
32705 .next
32706 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32707 &%Resent-%& header lines are present.
32708 .endlist
32709
32710
32711
32712
32713 .section "The Auto-Submitted: header line" "SECID221"
32714 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32715 includes the header line:
32716 .code
32717 Auto-Submitted: auto-replied
32718 .endd
32719
32720 .section "The Bcc: header line" "SECID222"
32721 .cindex "&'Bcc:'& header line"
32722 If Exim is called with the &%-t%& option, to take recipient addresses from a
32723 message's header, it removes any &'Bcc:'& header line that may exist (after
32724 extracting its addresses). If &%-t%& is not present on the command line, any
32725 existing &'Bcc:'& is not removed.
32726
32727
32728 .section "The Date: header line" "SECID223"
32729 .cindex "&'Date:'& header line"
32730 If a locally-generated or submission-mode message has no &'Date:'& header line,
32731 Exim adds one, using the current date and time, unless the
32732 &%suppress_local_fixups%& control has been specified.
32733
32734 .section "The Delivery-date: header line" "SECID224"
32735 .cindex "&'Delivery-date:'& header line"
32736 .oindex "&%delivery_date_remove%&"
32737 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32738 set. Exim can be configured to add them to the final delivery of messages. (See
32739 the generic &%delivery_date_add%& transport option.) They should not be present
32740 in messages in transit. If the &%delivery_date_remove%& configuration option is
32741 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32742 messages.
32743
32744
32745 .section "The Envelope-to: header line" "SECID225"
32746 .cindex "&'Envelope-to:'& header line"
32747 .oindex "&%envelope_to_remove%&"
32748 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32749 Exim can be configured to add them to the final delivery of messages. (See the
32750 generic &%envelope_to_add%& transport option.) They should not be present in
32751 messages in transit. If the &%envelope_to_remove%& configuration option is set
32752 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32753 messages.
32754
32755
32756 .section "The From: header line" "SECTthefrohea"
32757 .cindex "&'From:'& header line"
32758 .cindex "Sendmail compatibility" "&""From""& line"
32759 .cindex "message" "submission"
32760 .cindex "submission mode"
32761 If a submission-mode message does not contain a &'From:'& header line, Exim
32762 adds one if either of the following conditions is true:
32763
32764 .ilist
32765 The envelope sender address is not empty (that is, this is not a bounce
32766 message). The added header line copies the envelope sender address.
32767 .next
32768 .vindex "&$authenticated_id$&"
32769 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32770 .olist
32771 .vindex "&$qualify_domain$&"
32772 If no domain is specified by the submission control, the local part is
32773 &$authenticated_id$& and the domain is &$qualify_domain$&.
32774 .next
32775 If a non-empty domain is specified by the submission control, the local
32776 part is &$authenticated_id$&, and the domain is the specified domain.
32777 .next
32778 If an empty domain is specified by the submission control,
32779 &$authenticated_id$& is assumed to be the complete address.
32780 .endlist
32781 .endlist
32782
32783 A non-empty envelope sender takes precedence.
32784
32785 If a locally-generated incoming message does not contain a &'From:'& header
32786 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32787 containing the sender's address. The calling user's login name and full name
32788 are used to construct the address, as described in section &<<SECTconstr>>&.
32789 They are obtained from the password data by calling &[getpwuid()]& (but see the
32790 &%unknown_login%& configuration option). The address is qualified with
32791 &%qualify_domain%&.
32792
32793 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32794 &'From:'& header line containing just the unqualified login name of the calling
32795 user, this is replaced by an address containing the user's login name and full
32796 name as described in section &<<SECTconstr>>&.
32797
32798
32799 .section "The Message-ID: header line" "SECID226"
32800 .cindex "&'Message-ID:'& header line"
32801 .cindex "message" "submission"
32802 .oindex "&%message_id_header_text%&"
32803 If a locally-generated or submission-mode incoming message does not contain a
32804 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32805 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32806 to the message. If there are any &'Resent-:'& headers in the message, it
32807 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32808 message id, preceded by the letter E to ensure it starts with a letter, and
32809 followed by @ and the primary host name. Additional information can be included
32810 in this header line by setting the &%message_id_header_text%& and/or
32811 &%message_id_header_domain%& options.
32812
32813
32814 .section "The Received: header line" "SECID227"
32815 .cindex "&'Received:'& header line"
32816 A &'Received:'& header line is added at the start of every message. The
32817 contents are defined by the &%received_header_text%& configuration option, and
32818 Exim automatically adds a semicolon and a timestamp to the configured string.
32819
32820 The &'Received:'& header is generated as soon as the message's header lines
32821 have been received. At this stage, the timestamp in the &'Received:'& header
32822 line is the time that the message started to be received. This is the value
32823 that is seen by the DATA ACL and by the &[local_scan()]& function.
32824
32825 Once a message is accepted, the timestamp in the &'Received:'& header line is
32826 changed to the time of acceptance, which is (apart from a small delay while the
32827 -H spool file is written) the earliest time at which delivery could start.
32828
32829
32830 .section "The References: header line" "SECID228"
32831 .cindex "&'References:'& header line"
32832 Messages created by the &(autoreply)& transport include a &'References:'&
32833 header line. This is constructed according to the rules that are described in
32834 section 3.64 of RFC 2822 (which states that replies should contain such a
32835 header line), and section 3.14 of RFC 3834 (which states that automatic
32836 responses are not different in this respect). However, because some mail
32837 processing software does not cope well with very long header lines, no more
32838 than 12 message IDs are copied from the &'References:'& header line in the
32839 incoming message. If there are more than 12, the first one and then the final
32840 11 are copied, before adding the message ID of the incoming message.
32841
32842
32843
32844 .section "The Return-path: header line" "SECID229"
32845 .cindex "&'Return-path:'& header line"
32846 .oindex "&%return_path_remove%&"
32847 &'Return-path:'& header lines are defined as something an MTA may insert when
32848 it does the final delivery of messages. (See the generic &%return_path_add%&
32849 transport option.) Therefore, they should not be present in messages in
32850 transit. If the &%return_path_remove%& configuration option is set (the
32851 default), Exim removes &'Return-path:'& header lines from incoming messages.
32852
32853
32854
32855 .section "The Sender: header line" "SECTthesenhea"
32856 .cindex "&'Sender:'& header line"
32857 .cindex "message" "submission"
32858 For a locally-originated message from an untrusted user, Exim may remove an
32859 existing &'Sender:'& header line, and it may add a new one. You can modify
32860 these actions by setting the &%local_sender_retain%& option true, the
32861 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32862 control setting.
32863
32864 When a local message is received from an untrusted user and
32865 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32866 control has not been set, a check is made to see if the address given in the
32867 &'From:'& header line is the correct (local) sender of the message. The address
32868 that is expected has the login name as the local part and the value of
32869 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32870 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32871 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32872 line is added to the message.
32873
32874 If you set &%local_from_check%& false, this checking does not occur. However,
32875 the removal of an existing &'Sender:'& line still happens, unless you also set
32876 &%local_sender_retain%& to be true. It is not possible to set both of these
32877 options true at the same time.
32878
32879 .cindex "submission mode"
32880 By default, no processing of &'Sender:'& header lines is done for messages
32881 received over TCP/IP or for messages submitted by trusted users. However, when
32882 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32883 not specified on the submission control, the following processing takes place:
32884
32885 .vindex "&$authenticated_id$&"
32886 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32887 authenticated, and &$authenticated_id$& is not empty, a sender address is
32888 created as follows:
32889
32890 .ilist
32891 .vindex "&$qualify_domain$&"
32892 If no domain is specified by the submission control, the local part is
32893 &$authenticated_id$& and the domain is &$qualify_domain$&.
32894 .next
32895 If a non-empty domain is specified by the submission control, the local part
32896 is &$authenticated_id$&, and the domain is the specified domain.
32897 .next
32898 If an empty domain is specified by the submission control,
32899 &$authenticated_id$& is assumed to be the complete address.
32900 .endlist
32901
32902 This address is compared with the address in the &'From:'& header line. If they
32903 are different, a &'Sender:'& header line containing the created address is
32904 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32905 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32906
32907 .cindex "return path" "created from &'Sender:'&"
32908 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32909 the message (the envelope sender address) is changed to be the same address,
32910 except in the case of submission mode when &%sender_retain%& is specified.
32911
32912
32913
32914 .section "Adding and removing header lines in routers and transports" &&&
32915          "SECTheadersaddrem"
32916 .cindex "header lines" "adding; in router or transport"
32917 .cindex "header lines" "removing; in router or transport"
32918 When a message is delivered, the addition and removal of header lines can be
32919 specified in a system filter, or on any of the routers and transports that
32920 process the message. Section &<<SECTaddremheasys>>& contains details about
32921 modifying headers in a system filter. Header lines can also be added in an ACL
32922 as a message is received (see section &<<SECTaddheadacl>>&).
32923
32924 In contrast to what happens in a system filter, header modifications that are
32925 specified on routers and transports apply only to the particular recipient
32926 addresses that are being processed by those routers and transports. These
32927 changes do not actually take place until a copy of the message is being
32928 transported. Therefore, they do not affect the basic set of header lines, and
32929 they do not affect the values of the variables that refer to header lines.
32930
32931 &*Note*&: In particular, this means that any expansions in the configuration of
32932 the transport cannot refer to the modified header lines, because such
32933 expansions all occur before the message is actually transported.
32934
32935 For both routers and transports, the argument of a &%headers_add%&
32936 option must be in the form of one or more RFC 2822 header lines, separated by
32937 newlines (coded as &"\n"&). For example:
32938 .code
32939 headers_add = X-added-header: added by $primary_hostname\n\
32940               X-added-second: another added header line
32941 .endd
32942 Exim does not check the syntax of these added header lines.
32943
32944 Multiple &%headers_add%& options for a single router or transport can be
32945 specified; the values will append to a single list of header lines.
32946 Each header-line is separately expanded.
32947
32948 The argument of a &%headers_remove%& option must consist of a colon-separated
32949 list of header names. This is confusing, because header names themselves are
32950 often terminated by colons. In this case, the colons are the list separators,
32951 not part of the names. For example:
32952 .code
32953 headers_remove = return-receipt-to:acknowledge-to
32954 .endd
32955
32956 Multiple &%headers_remove%& options for a single router or transport can be
32957 specified; the arguments will append to a single header-names list.
32958 Each item is separately expanded.
32959 Note that colons in complex expansions which are used to
32960 form all or part of a &%headers_remove%& list
32961 will act as list separators.
32962
32963 When &%headers_add%& or &%headers_remove%& is specified on a router,
32964 items are expanded at routing time,
32965 and then associated with all addresses that are
32966 accepted by that router, and also with any new addresses that it generates. If
32967 an address passes through several routers as a result of aliasing or
32968 forwarding, the changes are cumulative.
32969
32970 .oindex "&%unseen%&"
32971 However, this does not apply to multiple routers that result from the use of
32972 the &%unseen%& option. Any header modifications that were specified by the
32973 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32974
32975 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32976 settings cannot be delivered together in a batch, so a transport is always
32977 dealing with a set of addresses that have the same header-processing
32978 requirements.
32979
32980 The transport starts by writing the original set of header lines that arrived
32981 with the message, possibly modified by the system filter. As it writes out
32982 these lines, it consults the list of header names that were attached to the
32983 recipient address(es) by &%headers_remove%& options in routers, and it also
32984 consults the transport's own &%headers_remove%& option. Header lines whose
32985 names are on either of these lists are not written out. If there are multiple
32986 instances of any listed header, they are all skipped.
32987
32988 After the remaining original header lines have been written, new header
32989 lines that were specified by routers' &%headers_add%& options are written, in
32990 the order in which they were attached to the address. These are followed by any
32991 header lines specified by the transport's &%headers_add%& option.
32992
32993 This way of handling header line modifications in routers and transports has
32994 the following consequences:
32995
32996 .ilist
32997 The original set of header lines, possibly modified by the system filter,
32998 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32999 to it, at all times.
33000 .next
33001 Header lines that are added by a router's
33002 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33003 expansion syntax in subsequent routers or the transport.
33004 .next
33005 Conversely, header lines that are specified for removal by &%headers_remove%&
33006 in a router remain visible to subsequent routers and the transport.
33007 .next
33008 Headers added to an address by &%headers_add%& in a router cannot be removed by
33009 a later router or by a transport.
33010 .next
33011 An added header can refer to the contents of an original header that is to be
33012 removed, even it has the same name as the added header. For example:
33013 .code
33014 headers_remove = subject
33015 headers_add = Subject: new subject (was: $h_subject:)
33016 .endd
33017 .endlist
33018
33019 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33020 for a &(redirect)& router that has the &%one_time%& option set.
33021
33022
33023
33024
33025
33026 .section "Constructed addresses" "SECTconstr"
33027 .cindex "address" "constructed"
33028 .cindex "constructed address"
33029 When Exim constructs a sender address for a locally-generated message, it uses
33030 the form
33031 .display
33032 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33033 .endd
33034 For example:
33035 .code
33036 Zaphod Beeblebrox <zaphod@end.univ.example>
33037 .endd
33038 The user name is obtained from the &%-F%& command line option if set, or
33039 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33040 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33041 ampersand character, this is replaced by the login name with the first letter
33042 upper cased, as is conventional in a number of operating systems. See the
33043 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33044 The &%unknown_username%& option can be used to specify user names in cases when
33045 there is no password file entry.
33046
33047 .cindex "RFC 2047"
33048 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33049 parts of it if necessary. In addition, if it contains any non-printing
33050 characters, it is encoded as described in RFC 2047, which defines a way of
33051 including non-ASCII characters in header lines. The value of the
33052 &%headers_charset%& option specifies the name of the encoding that is used (the
33053 characters are assumed to be in this encoding). The setting of
33054 &%print_topbitchars%& controls whether characters with the top bit set (that
33055 is, with codes greater than 127) count as printing characters or not.
33056
33057
33058
33059 .section "Case of local parts" "SECID230"
33060 .cindex "case of local parts"
33061 .cindex "local part" "case of"
33062 RFC 2822 states that the case of letters in the local parts of addresses cannot
33063 be assumed to be non-significant. Exim preserves the case of local parts of
33064 addresses, but by default it uses a lower-cased form when it is routing,
33065 because on most Unix systems, usernames are in lower case and case-insensitive
33066 routing is required. However, any particular router can be made to use the
33067 original case for local parts by setting the &%caseful_local_part%& generic
33068 router option.
33069
33070 .cindex "mixed-case login names"
33071 If you must have mixed-case user names on your system, the best way to proceed,
33072 assuming you want case-independent handling of incoming email, is to set up
33073 your first router to convert incoming local parts in your domains to the
33074 correct case by means of a file lookup. For example:
33075 .code
33076 correct_case:
33077   driver = redirect
33078   domains = +local_domains
33079   data = ${lookup{$local_part}cdb\
33080               {/etc/usercased.cdb}{$value}fail}\
33081               @$domain
33082 .endd
33083 For this router, the local part is forced to lower case by the default action
33084 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33085 up a new local part in the correct case. If you then set &%caseful_local_part%&
33086 on any subsequent routers which process your domains, they will operate on
33087 local parts with the correct case in a case-sensitive manner.
33088
33089
33090
33091 .section "Dots in local parts" "SECID231"
33092 .cindex "dot" "in local part"
33093 .cindex "local part" "dots in"
33094 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33095 part may not begin or end with a dot, nor have two consecutive dots in the
33096 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33097 empty components for compatibility.
33098
33099
33100
33101 .section "Rewriting addresses" "SECID232"
33102 .cindex "rewriting" "addresses"
33103 Rewriting of sender and recipient addresses, and addresses in headers, can
33104 happen automatically, or as the result of configuration options, as described
33105 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33106 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33107
33108 Automatic rewriting includes qualification, as mentioned above. The other case
33109 in which it can happen is when an incomplete non-local domain is given. The
33110 routing process may cause this to be expanded into the full domain name. For
33111 example, a header such as
33112 .code
33113 To: hare@teaparty
33114 .endd
33115 might get rewritten as
33116 .code
33117 To: hare@teaparty.wonderland.fict.example
33118 .endd
33119 Rewriting as a result of routing is the one kind of message processing that
33120 does not happen at input time, as it cannot be done until the address has
33121 been routed.
33122
33123 Strictly, one should not do &'any'& deliveries of a message until all its
33124 addresses have been routed, in case any of the headers get changed as a
33125 result of routing. However, doing this in practice would hold up many
33126 deliveries for unreasonable amounts of time, just because one address could not
33127 immediately be routed. Exim therefore does not delay other deliveries when
33128 routing of one or more addresses is deferred.
33129 .ecindex IIDmesproc
33130
33131
33132
33133 . ////////////////////////////////////////////////////////////////////////////
33134 . ////////////////////////////////////////////////////////////////////////////
33135
33136 .chapter "SMTP processing" "CHAPSMTP"
33137 .scindex IIDsmtpproc1 "SMTP" "processing details"
33138 .scindex IIDsmtpproc2 "LMTP" "processing details"
33139 Exim supports a number of different ways of using the SMTP protocol, and its
33140 LMTP variant, which is an interactive protocol for transferring messages into a
33141 closed mail store application. This chapter contains details of how SMTP is
33142 processed. For incoming mail, the following are available:
33143
33144 .ilist
33145 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33146 .next
33147 SMTP over the standard input and output (the &%-bs%& option);
33148 .next
33149 Batched SMTP on the standard input (the &%-bS%& option).
33150 .endlist
33151
33152 For mail delivery, the following are available:
33153
33154 .ilist
33155 SMTP over TCP/IP (the &(smtp)& transport);
33156 .next
33157 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33158 &"lmtp"&);
33159 .next
33160 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33161 transport);
33162 .next
33163 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33164 the &%use_bsmtp%& option set).
33165 .endlist
33166
33167 &'Batched SMTP'& is the name for a process in which batches of messages are
33168 stored in or read from files (or pipes), in a format in which SMTP commands are
33169 used to contain the envelope information.
33170
33171
33172
33173 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33174 .cindex "SMTP" "outgoing over TCP/IP"
33175 .cindex "outgoing SMTP over TCP/IP"
33176 .cindex "LMTP" "over TCP/IP"
33177 .cindex "outgoing LMTP over TCP/IP"
33178 .cindex "EHLO"
33179 .cindex "HELO"
33180 .cindex "SIZE option on MAIL command"
33181 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33182 The &%protocol%& option selects which protocol is to be used, but the actual
33183 processing is the same in both cases.
33184
33185 If, in response to its EHLO command, Exim is told that the SIZE
33186 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33187 command. The value of <&'n'&> is the message size plus the value of the
33188 &%size_addition%& option (default 1024) to allow for additions to the message
33189 such as per-transport header lines, or changes made in a
33190 .cindex "transport" "filter"
33191 .cindex "filter" "transport filter"
33192 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33193 suppressed.
33194
33195 If the remote server advertises support for PIPELINING, Exim uses the
33196 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33197 required for the transaction.
33198
33199 If the remote server advertises support for the STARTTLS command, and Exim
33200 was built to support TLS encryption, it tries to start a TLS session unless the
33201 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33202 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33203 is called for verification.
33204
33205 If the remote server advertises support for the AUTH command, Exim scans
33206 the authenticators configuration for any suitable client settings, as described
33207 in chapter &<<CHAPSMTPAUTH>>&.
33208
33209 .cindex "carriage return"
33210 .cindex "linefeed"
33211 Responses from the remote host are supposed to be terminated by CR followed by
33212 LF. However, there are known to be hosts that do not send CR characters, so in
33213 order to be able to interwork with such hosts, Exim treats LF on its own as a
33214 line terminator.
33215
33216 If a message contains a number of different addresses, all those with the same
33217 characteristics (for example, the same envelope sender) that resolve to the
33218 same set of hosts, in the same order, are sent in a single SMTP transaction,
33219 even if they are for different domains, unless there are more than the setting
33220 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33221 they are split into groups containing no more than &%max_rcpt%&s addresses
33222 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33223 in parallel sessions. The order of hosts with identical MX values is not
33224 significant when checking whether addresses can be batched in this way.
33225
33226 When the &(smtp)& transport suffers a temporary failure that is not
33227 message-related, Exim updates its transport-specific database, which contains
33228 records indexed by host name that remember which messages are waiting for each
33229 particular host. It also updates the retry database with new retry times.
33230
33231 .cindex "hints database" "retry keys"
33232 Exim's retry hints are based on host name plus IP address, so if one address of
33233 a multi-homed host is broken, it will soon be skipped most of the time.
33234 See the next section for more detail about error handling.
33235
33236 .cindex "SMTP" "passed connection"
33237 .cindex "SMTP" "batching over TCP/IP"
33238 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33239 looks in the hints database for the transport to see if there are any queued
33240 messages waiting for the host to which it is connected. If it finds one, it
33241 creates a new Exim process using the &%-MC%& option (which can only be used by
33242 a process running as root or the Exim user) and passes the TCP/IP socket to it
33243 so that it can deliver another message using the same socket. The new process
33244 does only those deliveries that are routed to the connected host, and may in
33245 turn pass the socket on to a third process, and so on.
33246
33247 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33248 limit the number of messages sent down a single TCP/IP connection.
33249
33250 .cindex "asterisk" "after IP address"
33251 The second and subsequent messages delivered down an existing connection are
33252 identified in the main log by the addition of an asterisk after the closing
33253 square bracket of the IP address.
33254
33255
33256
33257
33258 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33259 .cindex "error" "in outgoing SMTP"
33260 .cindex "SMTP" "errors in outgoing"
33261 .cindex "host" "error"
33262 Three different kinds of error are recognized for outgoing SMTP: host errors,
33263 message errors, and recipient errors.
33264
33265 .vlist
33266 .vitem "&*Host errors*&"
33267 A host error is not associated with a particular message or with a
33268 particular recipient of a message. The host errors are:
33269
33270 .ilist
33271 Connection refused or timed out,
33272 .next
33273 Any error response code on connection,
33274 .next
33275 Any error response code to EHLO or HELO,
33276 .next
33277 Loss of connection at any time, except after &"."&,
33278 .next
33279 I/O errors at any time,
33280 .next
33281 Timeouts during the session, other than in response to MAIL, RCPT or
33282 the &"."& at the end of the data.
33283 .endlist ilist
33284
33285 For a host error, a permanent error response on connection, or in response to
33286 EHLO, causes all addresses routed to the host to be failed. Any other host
33287 error causes all addresses to be deferred, and retry data to be created for the
33288 host. It is not tried again, for any message, until its retry time arrives. If
33289 the current set of addresses are not all delivered in this run (to some
33290 alternative host), the message is added to the list of those waiting for this
33291 host, so if it is still undelivered when a subsequent successful delivery is
33292 made to the host, it will be sent down the same SMTP connection.
33293
33294 .vitem "&*Message errors*&"
33295 .cindex "message" "error"
33296 A message error is associated with a particular message when sent to a
33297 particular host, but not with a particular recipient of the message. The
33298 message errors are:
33299
33300 .ilist
33301 Any error response code to MAIL, DATA, or the &"."& that terminates
33302 the data,
33303 .next
33304 Timeout after MAIL,
33305 .next
33306 Timeout or loss of connection after the &"."& that terminates the data. A
33307 timeout after the DATA command itself is treated as a host error, as is loss of
33308 connection at any other time.
33309 .endlist ilist
33310
33311 For a message error, a permanent error response (5&'xx'&) causes all addresses
33312 to be failed, and a delivery error report to be returned to the sender. A
33313 temporary error response (4&'xx'&), or one of the timeouts, causes all
33314 addresses to be deferred. Retry data is not created for the host, but instead,
33315 a retry record for the combination of host plus message id is created. The
33316 message is not added to the list of those waiting for this host. This ensures
33317 that the failing message will not be sent to this host again until the retry
33318 time arrives. However, other messages that are routed to the host are not
33319 affected, so if it is some property of the message that is causing the error,
33320 it will not stop the delivery of other mail.
33321
33322 If the remote host specified support for the SIZE parameter in its response
33323 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33324 over-large message will cause a message error because the error arrives as a
33325 response to MAIL.
33326
33327 .vitem "&*Recipient errors*&"
33328 .cindex "recipient" "error"
33329 A recipient error is associated with a particular recipient of a message. The
33330 recipient errors are:
33331
33332 .ilist
33333 Any error response to RCPT,
33334 .next
33335 Timeout after RCPT.
33336 .endlist
33337
33338 For a recipient error, a permanent error response (5&'xx'&) causes the
33339 recipient address to be failed, and a bounce message to be returned to the
33340 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33341 address to be deferred, and routing retry data to be created for it. This is
33342 used to delay processing of the address in subsequent queue runs, until its
33343 routing retry time arrives. This applies to all messages, but because it
33344 operates only in queue runs, one attempt will be made to deliver a new message
33345 to the failing address before the delay starts to operate. This ensures that,
33346 if the failure is really related to the message rather than the recipient
33347 (&"message too big for this recipient"& is a possible example), other messages
33348 have a chance of getting delivered. If a delivery to the address does succeed,
33349 the retry information gets cleared, so all stuck messages get tried again, and
33350 the retry clock is reset.
33351
33352 The message is not added to the list of those waiting for this host. Use of the
33353 host for other messages is unaffected, and except in the case of a timeout,
33354 other recipients are processed independently, and may be successfully delivered
33355 in the current SMTP session. After a timeout it is of course impossible to
33356 proceed with the session, so all addresses get deferred. However, those other
33357 than the one that failed do not suffer any subsequent retry delays. Therefore,
33358 if one recipient is causing trouble, the others have a chance of getting
33359 through when a subsequent delivery attempt occurs before the failing
33360 recipient's retry time.
33361 .endlist
33362
33363 In all cases, if there are other hosts (or IP addresses) available for the
33364 current set of addresses (for example, from multiple MX records), they are
33365 tried in this run for any undelivered addresses, subject of course to their
33366 own retry data. In other words, recipient error retry data does not take effect
33367 until the next delivery attempt.
33368
33369 Some hosts have been observed to give temporary error responses to every
33370 MAIL command at certain times (&"insufficient space"& has been seen). It
33371 would be nice if such circumstances could be recognized, and defer data for the
33372 host itself created, but this is not possible within the current Exim design.
33373 What actually happens is that retry data for every (host, message) combination
33374 is created.
33375
33376 The reason that timeouts after MAIL and RCPT are treated specially is that
33377 these can sometimes arise as a result of the remote host's verification
33378 procedures. Exim makes this assumption, and treats them as if a temporary error
33379 response had been received. A timeout after &"."& is treated specially because
33380 it is known that some broken implementations fail to recognize the end of the
33381 message if the last character of the last line is a binary zero. Thus, it is
33382 helpful to treat this case as a message error.
33383
33384 Timeouts at other times are treated as host errors, assuming a problem with the
33385 host, or the connection to it. If a timeout after MAIL, RCPT,
33386 or &"."& is really a connection problem, the assumption is that at the next try
33387 the timeout is likely to occur at some other point in the dialogue, causing it
33388 then to be treated as a host error.
33389
33390 There is experimental evidence that some MTAs drop the connection after the
33391 terminating &"."& if they do not like the contents of the message for some
33392 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33393 should be given. That is why Exim treats this case as a message rather than a
33394 host error, in order not to delay other messages to the same host.
33395
33396
33397
33398
33399 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33400 .cindex "SMTP" "incoming over TCP/IP"
33401 .cindex "incoming SMTP over TCP/IP"
33402 .cindex "inetd"
33403 .cindex "daemon"
33404 Incoming SMTP messages can be accepted in one of two ways: by running a
33405 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33406 &_/etc/inetd.conf_& should be like this:
33407 .code
33408 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33409 .endd
33410 Exim distinguishes between this case and the case of a locally running user
33411 agent using the &%-bs%& option by checking whether or not the standard input is
33412 a socket. When it is, either the port must be privileged (less than 1024), or
33413 the caller must be root or the Exim user. If any other user passes a socket
33414 with an unprivileged port number, Exim prints a message on the standard error
33415 stream and exits with an error code.
33416
33417 By default, Exim does not make a log entry when a remote host connects or
33418 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33419 unexpected. It can be made to write such log entries by setting the
33420 &%smtp_connection%& log selector.
33421
33422 .cindex "carriage return"
33423 .cindex "linefeed"
33424 Commands from the remote host are supposed to be terminated by CR followed by
33425 LF. However, there are known to be hosts that do not send CR characters. In
33426 order to be able to interwork with such hosts, Exim treats LF on its own as a
33427 line terminator.
33428 Furthermore, because common code is used for receiving messages from all
33429 sources, a CR on its own is also interpreted as a line terminator. However, the
33430 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33431
33432 .cindex "EHLO" "invalid data"
33433 .cindex "HELO" "invalid data"
33434 One area that sometimes gives rise to problems concerns the EHLO or
33435 HELO commands. Some clients send syntactically invalid versions of these
33436 commands, which Exim rejects by default. (This is nothing to do with verifying
33437 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33438 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33439 match the broken hosts that send invalid commands.
33440
33441 .cindex "SIZE option on MAIL command"
33442 .cindex "MAIL" "SIZE option"
33443 The amount of disk space available is checked whenever SIZE is received on
33444 a MAIL command, independently of whether &%message_size_limit%& or
33445 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33446 false. A temporary error is given if there is not enough space. If
33447 &%check_spool_space%& is set, the check is for that amount of space plus the
33448 value given with SIZE, that is, it checks that the addition of the incoming
33449 message will not reduce the space below the threshold.
33450
33451 When a message is successfully received, Exim includes the local message id in
33452 its response to the final &"."& that terminates the data. If the remote host
33453 logs this text it can help with tracing what has happened to a message.
33454
33455 The Exim daemon can limit the number of simultaneous incoming connections it is
33456 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33457 number of simultaneous incoming connections from a single remote host (see the
33458 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33459 rejected using the SMTP temporary error code 421.
33460
33461 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33462 subprocess has finished, as this can get lost at busy times. Instead, it looks
33463 for completed subprocesses every time it wakes up. Provided there are other
33464 things happening (new incoming calls, starts of queue runs), completed
33465 processes will be noticed and tidied away. On very quiet systems you may
33466 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33467 it will be noticed when the daemon next wakes up.
33468
33469 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33470 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33471 high system load &-- for details see the &%smtp_accept_reserve%&,
33472 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33473 applies in both the daemon and &'inetd'& cases.
33474
33475 Exim normally starts a delivery process for each message received, though this
33476 can be varied by means of the &%-odq%& command line option and the
33477 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33478 number of simultaneously running delivery processes started in this way from
33479 SMTP input can be limited by the &%smtp_accept_queue%& and
33480 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33481 subsequently received messages are just put on the input queue without starting
33482 a delivery process.
33483
33484 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33485 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33486 started up from the &'inetd'& daemon, because in that case each connection is
33487 handled by an entirely independent Exim process. Control by load average is,
33488 however, available with &'inetd'&.
33489
33490 Exim can be configured to verify addresses in incoming SMTP commands as they
33491 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33492 to rewrite addresses at this time &-- before any syntax checking is done. See
33493 section &<<SECTrewriteS>>&.
33494
33495 Exim can also be configured to limit the rate at which a client host submits
33496 MAIL and RCPT commands in a single SMTP session. See the
33497 &%smtp_ratelimit_hosts%& option.
33498
33499
33500
33501 .section "Unrecognized SMTP commands" "SECID234"
33502 .cindex "SMTP" "unrecognized commands"
33503 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33504 commands during a single SMTP connection, it drops the connection after sending
33505 the error response to the last command. The default value for
33506 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33507 abuse that subvert web servers into making connections to SMTP ports; in these
33508 circumstances, a number of non-SMTP lines are sent first.
33509
33510
33511 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33512 .cindex "SMTP" "syntax errors"
33513 .cindex "SMTP" "protocol errors"
33514 A syntax error is detected if an SMTP command is recognized, but there is
33515 something syntactically wrong with its data, for example, a malformed email
33516 address in a RCPT command. Protocol errors include invalid command
33517 sequencing such as RCPT before MAIL. If Exim receives more than
33518 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33519 drops the connection after sending the error response to the last command. The
33520 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33521 broken clients that loop sending bad commands (yes, it has been seen).
33522
33523
33524
33525 .section "Use of non-mail SMTP commands" "SECID236"
33526 .cindex "SMTP" "non-mail commands"
33527 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33528 DATA. Exim counts such commands, and drops the connection if there are too
33529 many of them in a single SMTP session. This action catches some
33530 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33531 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33532 defines what &"too many"& means. Its default value is 10.
33533
33534 When a new message is expected, one occurrence of RSET is not counted. This
33535 allows a client to send one RSET between messages (this is not necessary,
33536 but some clients do it). Exim also allows one uncounted occurrence of HELO
33537 or EHLO, and one occurrence of STARTTLS between messages. After
33538 starting up a TLS session, another EHLO is expected, and so it too is not
33539 counted.
33540
33541 The first occurrence of AUTH in a connection, or immediately following
33542 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33543 RCPT, DATA, and QUIT are counted.
33544
33545 You can control which hosts are subject to the limit set by
33546 &%smtp_accept_max_nonmail%& by setting
33547 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33548 the limit apply to all hosts. This option means that you can exclude any
33549 specific badly-behaved hosts that you have to live with.
33550
33551
33552
33553
33554 .section "The VRFY and EXPN commands" "SECID237"
33555 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33556 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33557 appropriate) in order to decide whether the command should be accepted or not.
33558 If no ACL is defined, the command is rejected.
33559
33560 .cindex "VRFY" "processing"
33561 When VRFY is accepted, it runs exactly the same code as when Exim is
33562 called with the &%-bv%& option.
33563
33564 .cindex "EXPN" "processing"
33565 When EXPN is accepted, a single-level expansion of the address is done.
33566 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33567 than a verification (the &%-bv%& option). If an unqualified local part is given
33568 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33569 of VRFY and EXPN commands are logged on the main and reject logs, and
33570 VRFY verification failures are logged on the main log for consistency with
33571 RCPT failures.
33572
33573
33574
33575 .section "The ETRN command" "SECTETRN"
33576 .cindex "ETRN" "processing"
33577 RFC 1985 describes an SMTP command called ETRN that is designed to
33578 overcome the security problems of the TURN command (which has fallen into
33579 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33580 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33581 should be accepted or not. If no ACL is defined, the command is rejected.
33582
33583 The ETRN command is concerned with &"releasing"& messages that are awaiting
33584 delivery to certain hosts. As Exim does not organize its message queue by host,
33585 the only form of ETRN that is supported by default is the one where the
33586 text starts with the &"#"& prefix, in which case the remainder of the text is
33587 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33588 the &%-R%& option to happen, with the remainder of the ETRN text as its
33589 argument. For example,
33590 .code
33591 ETRN #brigadoon
33592 .endd
33593 runs the command
33594 .code
33595 exim -R brigadoon
33596 .endd
33597 which causes a delivery attempt on all messages with undelivered addresses
33598 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33599 default), Exim prevents the simultaneous execution of more than one queue run
33600 for the same argument string as a result of an ETRN command. This stops
33601 a misbehaving client from starting more than one queue runner at once.
33602
33603 .cindex "hints database" "ETRN serialization"
33604 Exim implements the serialization by means of a hints database in which a
33605 record is written whenever a process is started by ETRN, and deleted when
33606 the process completes. However, Exim does not keep the SMTP session waiting for
33607 the ETRN process to complete. Once ETRN is accepted, the client is sent
33608 a &"success"& return code. Obviously there is scope for hints records to get
33609 left lying around if there is a system or program crash. To guard against this,
33610 Exim ignores any records that are more than six hours old.
33611
33612 .oindex "&%smtp_etrn_command%&"
33613 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33614 used. This specifies a command that is run whenever ETRN is received,
33615 whatever the form of its argument. For
33616 example:
33617 .code
33618 smtp_etrn_command = /etc/etrn_command $domain \
33619                     $sender_host_address
33620 .endd
33621 .vindex "&$domain$&"
33622 The string is split up into arguments which are independently expanded. The
33623 expansion variable &$domain$& is set to the argument of the ETRN command,
33624 and no syntax checking is done on the contents of this argument. Exim does not
33625 wait for the command to complete, so its status code is not checked. Exim runs
33626 under its own uid and gid when receiving incoming SMTP, so it is not possible
33627 for it to change them before running the command.
33628
33629
33630
33631 .section "Incoming local SMTP" "SECID238"
33632 .cindex "SMTP" "local incoming"
33633 Some user agents use SMTP to pass messages to their local MTA using the
33634 standard input and output, as opposed to passing the envelope on the command
33635 line and writing the message to the standard input. This is supported by the
33636 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33637 messages over TCP/IP (including the use of ACLs), except that the envelope
33638 sender given in a MAIL command is ignored unless the caller is trusted. In
33639 an ACL you can detect this form of SMTP input by testing for an empty host
33640 identification. It is common to have this as the first line in the ACL that
33641 runs for RCPT commands:
33642 .code
33643 accept hosts = :
33644 .endd
33645 This accepts SMTP messages from local processes without doing any other tests.
33646
33647
33648
33649 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33650 .cindex "SMTP" "batched outgoing"
33651 .cindex "batched SMTP output"
33652 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33653 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33654 be output in BSMTP format. No SMTP responses are possible for this form of
33655 delivery. All it is doing is using SMTP commands as a way of transmitting the
33656 envelope along with the message.
33657
33658 The message is written to the file or pipe preceded by the SMTP commands
33659 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33660 the message that start with a dot have an extra dot added. The SMTP command
33661 HELO is not normally used. If it is required, the &%message_prefix%& option
33662 can be used to specify it.
33663
33664 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33665 one recipient address at a time by default. However, you can arrange for them
33666 to handle several addresses at once by setting the &%batch_max%& option. When
33667 this is done for BSMTP, messages may contain multiple RCPT commands. See
33668 chapter &<<CHAPbatching>>& for more details.
33669
33670 .vindex "&$host$&"
33671 When one or more addresses are routed to a BSMTP transport by a router that
33672 sets up a host list, the name of the first host on the list is available to the
33673 transport in the variable &$host$&. Here is an example of such a transport and
33674 router:
33675 .code
33676 begin routers
33677 route_append:
33678   driver = manualroute
33679   transport = smtp_appendfile
33680   route_list = domain.example  batch.host.example
33681
33682 begin transports
33683 smtp_appendfile:
33684   driver = appendfile
33685   directory = /var/bsmtp/$host
33686   batch_max = 1000
33687   use_bsmtp
33688   user = exim
33689 .endd
33690 This causes messages addressed to &'domain.example'& to be written in BSMTP
33691 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33692 message (unless there are more than 1000 recipients).
33693
33694
33695
33696 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33697 .cindex "SMTP" "batched incoming"
33698 .cindex "batched SMTP input"
33699 The &%-bS%& command line option causes Exim to accept one or more messages by
33700 reading SMTP on the standard input, but to generate no responses. If the caller
33701 is trusted, the senders in the MAIL commands are believed; otherwise the
33702 sender is always the caller of Exim. Unqualified senders and receivers are not
33703 rejected (there seems little point) but instead just get qualified. HELO
33704 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33705 as NOOP; QUIT quits.
33706
33707 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33708 ACL is run in the same way as for non-SMTP local input.
33709
33710 If an error is detected while reading a message, including a missing &"."& at
33711 the end, Exim gives up immediately. It writes details of the error to the
33712 standard output in a stylized way that the calling program should be able to
33713 make some use of automatically, for example:
33714 .code
33715 554 Unexpected end of file
33716 Transaction started in line 10
33717 Error detected in line 14
33718 .endd
33719 It writes a more verbose version, for human consumption, to the standard error
33720 file, for example:
33721 .code
33722 An error was detected while processing a file of BSMTP input.
33723 The error message was:
33724
33725 501 '>' missing at end of address
33726
33727 The SMTP transaction started in line 10.
33728 The error was detected in line 12.
33729 The SMTP command at fault was:
33730
33731 rcpt to:<malformed@in.com.plete
33732
33733 1 previous message was successfully processed.
33734 The rest of the batch was abandoned.
33735 .endd
33736 The return code from Exim is zero only if there were no errors. It is 1 if some
33737 messages were accepted before an error was detected, and 2 if no messages were
33738 accepted.
33739 .ecindex IIDsmtpproc1
33740 .ecindex IIDsmtpproc2
33741
33742
33743
33744 . ////////////////////////////////////////////////////////////////////////////
33745 . ////////////////////////////////////////////////////////////////////////////
33746
33747 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33748          "Customizing messages"
33749 When a message fails to be delivered, or remains on the queue for more than a
33750 configured amount of time, Exim sends a message to the original sender, or
33751 to an alternative configured address. The text of these messages is built into
33752 the code of Exim, but it is possible to change it, either by adding a single
33753 string, or by replacing each of the paragraphs by text supplied in a file.
33754
33755 The &'From:'& and &'To:'& header lines are automatically generated; you can
33756 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33757 option. Exim also adds the line
33758 .code
33759 Auto-Submitted: auto-generated
33760 .endd
33761 to all warning and bounce messages,
33762
33763
33764 .section "Customizing bounce messages" "SECID239"
33765 .cindex "customizing" "bounce message"
33766 .cindex "bounce message" "customizing"
33767 If &%bounce_message_text%& is set, its contents are included in the default
33768 message immediately after &"This message was created automatically by mail
33769 delivery software."& The string is not expanded. It is not used if
33770 &%bounce_message_file%& is set.
33771
33772 When &%bounce_message_file%& is set, it must point to a template file for
33773 constructing error messages. The file consists of a series of text items,
33774 separated by lines consisting of exactly four asterisks. If the file cannot be
33775 opened, default text is used and a message is written to the main and panic
33776 logs. If any text item in the file is empty, default text is used for that
33777 item.
33778
33779 .vindex "&$bounce_recipient$&"
33780 .vindex "&$bounce_return_size_limit$&"
33781 Each item of text that is read from the file is expanded, and there are two
33782 expansion variables which can be of use here: &$bounce_recipient$& is set to
33783 the recipient of an error message while it is being created, and
33784 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33785 option, rounded to a whole number.
33786
33787 The items must appear in the file in the following order:
33788
33789 .ilist
33790 The first item is included in the headers, and should include at least a
33791 &'Subject:'& header. Exim does not check the syntax of these headers.
33792 .next
33793 The second item forms the start of the error message. After it, Exim lists the
33794 failing addresses with their error messages.
33795 .next
33796 The third item is used to introduce any text from pipe transports that is to be
33797 returned to the sender. It is omitted if there is no such text.
33798 .next
33799 .new
33800 The fourth, fifth and sixth items will be ignored and may be empty.
33801 The fields exist for back-compatibility
33802 .wen
33803 .endlist
33804
33805 The default state (&%bounce_message_file%& unset) is equivalent to the
33806 following file, in which the sixth item is empty. The &'Subject:'& and some
33807 other lines have been split in order to fit them on the page:
33808 .code
33809 Subject: Mail delivery failed
33810   ${if eq{$sender_address}{$bounce_recipient}
33811   {: returning message to sender}}
33812 ****
33813 This message was created automatically by mail delivery software.
33814
33815 A message ${if eq{$sender_address}{$bounce_recipient}
33816   {that you sent }{sent by
33817
33818 <$sender_address>
33819
33820 }}could not be delivered to all of its recipients.
33821 This is a permanent error. The following address(es) failed:
33822 ****
33823 The following text was generated during the delivery attempt(s):
33824 ****
33825 ------ This is a copy of the message, including all the headers.
33826   ------
33827 ****
33828 ------ The body of the message is $message_size characters long;
33829   only the first
33830 ------ $bounce_return_size_limit or so are included here.
33831 ****
33832 .endd
33833 .section "Customizing warning messages" "SECTcustwarn"
33834 .cindex "customizing" "warning message"
33835 .cindex "warning of delay" "customizing the message"
33836 The option &%warn_message_file%& can be pointed at a template file for use when
33837 warnings about message delays are created. In this case there are only three
33838 text sections:
33839
33840 .ilist
33841 The first item is included in the headers, and should include at least a
33842 &'Subject:'& header. Exim does not check the syntax of these headers.
33843 .next
33844 The second item forms the start of the warning message. After it, Exim lists
33845 the delayed addresses.
33846 .next
33847 The third item then ends the message.
33848 .endlist
33849
33850 The default state is equivalent to the following file, except that some lines
33851 have been split here, in order to fit them on the page:
33852 .code
33853 Subject: Warning: message $message_exim_id delayed
33854   $warn_message_delay
33855 ****
33856 This message was created automatically by mail delivery software.
33857
33858 A message ${if eq{$sender_address}{$warn_message_recipients}
33859 {that you sent }{sent by
33860
33861 <$sender_address>
33862
33863 }}has not been delivered to all of its recipients after
33864 more than $warn_message_delay on the queue on $primary_hostname.
33865
33866 The message identifier is:     $message_exim_id
33867 The subject of the message is: $h_subject
33868 The date of the message is:    $h_date
33869
33870 The following address(es) have not yet been delivered:
33871 ****
33872 No action is required on your part. Delivery attempts will
33873 continue for some time, and this warning may be repeated at
33874 intervals if the message remains undelivered. Eventually the
33875 mail delivery software will give up, and when that happens,
33876 the message will be returned to you.
33877 .endd
33878 .vindex "&$warn_message_delay$&"
33879 .vindex "&$warn_message_recipients$&"
33880 However, in the default state the subject and date lines are omitted if no
33881 appropriate headers exist. During the expansion of this file,
33882 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33883 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33884 of recipients for the warning message. There may be more than one if there are
33885 multiple addresses with different &%errors_to%& settings on the routers that
33886 handled them.
33887
33888
33889
33890
33891 . ////////////////////////////////////////////////////////////////////////////
33892 . ////////////////////////////////////////////////////////////////////////////
33893
33894 .chapter "Some common configuration settings" "CHAPcomconreq"
33895 This chapter discusses some configuration settings that seem to be fairly
33896 common. More examples and discussion can be found in the Exim book.
33897
33898
33899
33900 .section "Sending mail to a smart host" "SECID240"
33901 .cindex "smart host" "example router"
33902 If you want to send all mail for non-local domains to a &"smart host"&, you
33903 should replace the default &(dnslookup)& router with a router which does the
33904 routing explicitly:
33905 .code
33906 send_to_smart_host:
33907   driver = manualroute
33908   route_list = !+local_domains smart.host.name
33909   transport = remote_smtp
33910 .endd
33911 You can use the smart host's IP address instead of the name if you wish.
33912 If you are using Exim only to submit messages to a smart host, and not for
33913 receiving incoming messages, you can arrange for it to do the submission
33914 synchronously by setting the &%mua_wrapper%& option (see chapter
33915 &<<CHAPnonqueueing>>&).
33916
33917
33918
33919
33920 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33921 .cindex "mailing lists"
33922 Exim can be used to run simple mailing lists, but for large and/or complicated
33923 requirements, the use of additional specialized mailing list software such as
33924 Majordomo or Mailman is recommended.
33925
33926 The &(redirect)& router can be used to handle mailing lists where each list
33927 is maintained in a separate file, which can therefore be managed by an
33928 independent manager. The &%domains%& router option can be used to run these
33929 lists in a separate domain from normal mail. For example:
33930 .code
33931 lists:
33932   driver = redirect
33933   domains = lists.example
33934   file = /usr/lists/$local_part
33935   forbid_pipe
33936   forbid_file
33937   errors_to = $local_part-request@lists.example
33938   no_more
33939 .endd
33940 This router is skipped for domains other than &'lists.example'&. For addresses
33941 in that domain, it looks for a file that matches the local part. If there is no
33942 such file, the router declines, but because &%no_more%& is set, no subsequent
33943 routers are tried, and so the whole delivery fails.
33944
33945 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33946 expanded into a file name or a pipe delivery, which is usually inappropriate in
33947 a mailing list.
33948
33949 .oindex "&%errors_to%&"
33950 The &%errors_to%& option specifies that any delivery errors caused by addresses
33951 taken from a mailing list are to be sent to the given address rather than the
33952 original sender of the message. However, before acting on this, Exim verifies
33953 the error address, and ignores it if verification fails.
33954
33955 For example, using the configuration above, mail sent to
33956 &'dicts@lists.example'& is passed on to those addresses contained in
33957 &_/usr/lists/dicts_&, with error reports directed to
33958 &'dicts-request@lists.example'&, provided that this address can be verified.
33959 There could be a file called &_/usr/lists/dicts-request_& containing
33960 the address(es) of this particular list's manager(s), but other approaches,
33961 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33962 or &%local_part_suffix%& options) to handle addresses of the form
33963 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33964
33965
33966
33967 .section "Syntax errors in mailing lists" "SECID241"
33968 .cindex "mailing lists" "syntax errors in"
33969 If an entry in redirection data contains a syntax error, Exim normally defers
33970 delivery of the original address. That means that a syntax error in a mailing
33971 list holds up all deliveries to the list. This may not be appropriate when a
33972 list is being maintained automatically from data supplied by users, and the
33973 addresses are not rigorously checked.
33974
33975 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33976 entries that fail to parse, noting the incident in the log. If in addition
33977 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33978 whenever a broken address is skipped. It is usually appropriate to set
33979 &%syntax_errors_to%& to the same address as &%errors_to%&.
33980
33981
33982
33983 .section "Re-expansion of mailing lists" "SECID242"
33984 .cindex "mailing lists" "re-expansion of"
33985 Exim remembers every individual address to which a message has been delivered,
33986 in order to avoid duplication, but it normally stores only the original
33987 recipient addresses with a message. If all the deliveries to a mailing list
33988 cannot be done at the first attempt, the mailing list is re-expanded when the
33989 delivery is next tried. This means that alterations to the list are taken into
33990 account at each delivery attempt, so addresses that have been added to
33991 the list since the message arrived will therefore receive a copy of the
33992 message, even though it pre-dates their subscription.
33993
33994 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33995 on the &(redirect)& router. If this is done, any addresses generated by the
33996 router that fail to deliver at the first attempt are added to the message as
33997 &"top level"& addresses, and the parent address that generated them is marked
33998 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33999 subsequent delivery attempts. The disadvantage of this is that if any of the
34000 failing addresses are incorrect, correcting them in the file has no effect on
34001 pre-existing messages.
34002
34003 The original top-level address is remembered with each of the generated
34004 addresses, and is output in any log messages. However, any intermediate parent
34005 addresses are not recorded. This makes a difference to the log only if the
34006 &%all_parents%& selector is set, but for mailing lists there is normally only
34007 one level of expansion anyway.
34008
34009
34010
34011 .section "Closed mailing lists" "SECID243"
34012 .cindex "mailing lists" "closed"
34013 The examples so far have assumed open mailing lists, to which anybody may
34014 send mail. It is also possible to set up closed lists, where mail is accepted
34015 from specified senders only. This is done by making use of the generic
34016 &%senders%& option to restrict the router that handles the list.
34017
34018 The following example uses the same file as a list of recipients and as a list
34019 of permitted senders. It requires three routers:
34020 .code
34021 lists_request:
34022   driver = redirect
34023   domains = lists.example
34024   local_part_suffix = -request
34025   file = /usr/lists/$local_part$local_part_suffix
34026   no_more
34027
34028 lists_post:
34029   driver = redirect
34030   domains = lists.example
34031   senders = ${if exists {/usr/lists/$local_part}\
34032              {lsearch;/usr/lists/$local_part}{*}}
34033   file = /usr/lists/$local_part
34034   forbid_pipe
34035   forbid_file
34036   errors_to = $local_part-request@lists.example
34037   no_more
34038
34039 lists_closed:
34040   driver = redirect
34041   domains = lists.example
34042   allow_fail
34043   data = :fail: $local_part@lists.example is a closed mailing list
34044 .endd
34045 All three routers have the same &%domains%& setting, so for any other domains,
34046 they are all skipped. The first router runs only if the local part ends in
34047 &%-request%&. It handles messages to the list manager(s) by means of an open
34048 mailing list.
34049
34050 The second router runs only if the &%senders%& precondition is satisfied. It
34051 checks for the existence of a list that corresponds to the local part, and then
34052 checks that the sender is on the list by means of a linear search. It is
34053 necessary to check for the existence of the file before trying to search it,
34054 because otherwise Exim thinks there is a configuration error. If the file does
34055 not exist, the expansion of &%senders%& is *, which matches all senders. This
34056 means that the router runs, but because there is no list, declines, and
34057 &%no_more%& ensures that no further routers are run. The address fails with an
34058 &"unrouteable address"& error.
34059
34060 The third router runs only if the second router is skipped, which happens when
34061 a mailing list exists, but the sender is not on it. This router forcibly fails
34062 the address, giving a suitable error message.
34063
34064
34065
34066
34067 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34068 .cindex "VERP"
34069 .cindex "Variable Envelope Return Paths"
34070 .cindex "envelope sender"
34071 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34072 are a way of helping mailing list administrators discover which subscription
34073 address is the cause of a particular delivery failure. The idea is to encode
34074 the original recipient address in the outgoing envelope sender address, so that
34075 if the message is forwarded by another host and then subsequently bounces, the
34076 original recipient can be extracted from the recipient address of the bounce.
34077
34078 .oindex &%errors_to%&
34079 .oindex &%return_path%&
34080 Envelope sender addresses can be modified by Exim using two different
34081 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34082 list examples), or the &%return_path%& option on a transport. The second of
34083 these is effective only if the message is successfully delivered to another
34084 host; it is not used for errors detected on the local host (see the description
34085 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34086 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34087 .code
34088 verp_smtp:
34089   driver = smtp
34090   max_rcpt = 1
34091   return_path = \
34092     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34093       {$1-request+$local_part=$domain@your.dom.example}fail}
34094 .endd
34095 This has the effect of rewriting the return path (envelope sender) on outgoing
34096 SMTP messages, if the local part of the original return path ends in
34097 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34098 local part and domain of the recipient into the return path. Suppose, for
34099 example, that a message whose return path has been set to
34100 &'somelist-request@your.dom.example'& is sent to
34101 &'subscriber@other.dom.example'&. In the transport, the return path is
34102 rewritten as
34103 .code
34104 somelist-request+subscriber=other.dom.example@your.dom.example
34105 .endd
34106 .vindex "&$local_part$&"
34107 For this to work, you must tell Exim to send multiple copies of messages that
34108 have more than one recipient, so that each copy has just one recipient. This is
34109 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34110 might be sent to several different recipients in the same domain, in which case
34111 &$local_part$& is not available in the transport, because it is not unique.
34112
34113 Unless your host is doing nothing but mailing list deliveries, you should
34114 probably use a separate transport for the VERP deliveries, so as not to use
34115 extra resources in making one-per-recipient copies for other deliveries. This
34116 can easily be done by expanding the &%transport%& option in the router:
34117 .code
34118 dnslookup:
34119   driver = dnslookup
34120   domains = ! +local_domains
34121   transport = \
34122     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34123       {verp_smtp}{remote_smtp}}
34124   no_more
34125 .endd
34126 If you want to change the return path using &%errors_to%& in a router instead
34127 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34128 routers that handle mailing list addresses. This will ensure that all delivery
34129 errors, including those detected on the local host, are sent to the VERP
34130 address.
34131
34132 On a host that does no local deliveries and has no manual routing, only the
34133 &(dnslookup)& router needs to be changed. A special transport is not needed for
34134 SMTP deliveries. Every mailing list recipient has its own return path value,
34135 and so Exim must hand them to the transport one at a time. Here is an example
34136 of a &(dnslookup)& router that implements VERP:
34137 .code
34138 verp_dnslookup:
34139   driver = dnslookup
34140   domains = ! +local_domains
34141   transport = remote_smtp
34142   errors_to = \
34143     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34144      {$1-request+$local_part=$domain@your.dom.example}fail}
34145   no_more
34146 .endd
34147 Before you start sending out messages with VERPed return paths, you must also
34148 configure Exim to accept the bounce messages that come back to those paths.
34149 Typically this is done by setting a &%local_part_suffix%& option for a
34150 router, and using this to route the messages to wherever you want to handle
34151 them.
34152
34153 The overhead incurred in using VERP depends very much on the size of the
34154 message, the number of recipient addresses that resolve to the same remote
34155 host, and the speed of the connection over which the message is being sent. If
34156 a lot of addresses resolve to the same host and the connection is slow, sending
34157 a separate copy of the message for each address may take substantially longer
34158 than sending a single copy with many recipients (for which VERP cannot be
34159 used).
34160
34161
34162
34163
34164
34165
34166 .section "Virtual domains" "SECTvirtualdomains"
34167 .cindex "virtual domains"
34168 .cindex "domain" "virtual"
34169 The phrase &'virtual domain'& is unfortunately used with two rather different
34170 meanings:
34171
34172 .ilist
34173 A domain for which there are no real mailboxes; all valid local parts are
34174 aliases for other email addresses. Common examples are organizational
34175 top-level domains and &"vanity"& domains.
34176 .next
34177 One of a number of independent domains that are all handled by the same host,
34178 with mailboxes on that host, but where the mailbox owners do not necessarily
34179 have login accounts on that host.
34180 .endlist
34181
34182 The first usage is probably more common, and does seem more &"virtual"& than
34183 the second. This kind of domain can be handled in Exim with a straightforward
34184 aliasing router. One approach is to create a separate alias file for each
34185 virtual domain. Exim can test for the existence of the alias file to determine
34186 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34187 to a router of this form:
34188 .code
34189 virtual:
34190   driver = redirect
34191   domains = dsearch;/etc/mail/virtual
34192   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34193   no_more
34194 .endd
34195 The &%domains%& option specifies that the router is to be skipped, unless there
34196 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34197 domain that is being processed. When the router runs, it looks up the local
34198 part in the file to find a new address (or list of addresses). The &%no_more%&
34199 setting ensures that if the lookup fails (leading to &%data%& being an empty
34200 string), Exim gives up on the address without trying any subsequent routers.
34201
34202 This one router can handle all the virtual domains because the alias file names
34203 follow a fixed pattern. Permissions can be arranged so that appropriate people
34204 can edit the different alias files. A successful aliasing operation results in
34205 a new envelope recipient address, which is then routed from scratch.
34206
34207 The other kind of &"virtual"& domain can also be handled in a straightforward
34208 way. One approach is to create a file for each domain containing a list of
34209 valid local parts, and use it in a router like this:
34210 .code
34211 my_domains:
34212   driver = accept
34213   domains = dsearch;/etc/mail/domains
34214   local_parts = lsearch;/etc/mail/domains/$domain
34215   transport = my_mailboxes
34216 .endd
34217 The address is accepted if there is a file for the domain, and the local part
34218 can be found in the file. The &%domains%& option is used to check for the
34219 file's existence because &%domains%& is tested before the &%local_parts%&
34220 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34221 because that option is tested after &%local_parts%&. The transport is as
34222 follows:
34223 .code
34224 my_mailboxes:
34225   driver = appendfile
34226   file = /var/mail/$domain/$local_part
34227   user = mail
34228 .endd
34229 This uses a directory of mailboxes for each domain. The &%user%& setting is
34230 required, to specify which uid is to be used for writing to the mailboxes.
34231
34232 The configuration shown here is just one example of how you might support this
34233 requirement. There are many other ways this kind of configuration can be set
34234 up, for example, by using a database instead of separate files to hold all the
34235 information about the domains.
34236
34237
34238
34239 .section "Multiple user mailboxes" "SECTmulbox"
34240 .cindex "multiple mailboxes"
34241 .cindex "mailbox" "multiple"
34242 .cindex "local part" "prefix"
34243 .cindex "local part" "suffix"
34244 Heavy email users often want to operate with multiple mailboxes, into which
34245 incoming mail is automatically sorted. A popular way of handling this is to
34246 allow users to use multiple sender addresses, so that replies can easily be
34247 identified. Users are permitted to add prefixes or suffixes to their local
34248 parts for this purpose. The wildcard facility of the generic router options
34249 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34250 example, consider this router:
34251 .code
34252 userforward:
34253   driver = redirect
34254   check_local_user
34255   file = $home/.forward
34256   local_part_suffix = -*
34257   local_part_suffix_optional
34258   allow_filter
34259 .endd
34260 .vindex "&$local_part_suffix$&"
34261 It runs a user's &_.forward_& file for all local parts of the form
34262 &'username-*'&. Within the filter file the user can distinguish different
34263 cases by testing the variable &$local_part_suffix$&. For example:
34264 .code
34265 if $local_part_suffix contains -special then
34266 save /home/$local_part/Mail/special
34267 endif
34268 .endd
34269 If the filter file does not exist, or does not deal with such addresses, they
34270 fall through to subsequent routers, and, assuming no subsequent use of the
34271 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34272 control over which suffixes are valid.
34273
34274 Alternatively, a suffix can be used to trigger the use of a different
34275 &_.forward_& file &-- which is the way a similar facility is implemented in
34276 another MTA:
34277 .code
34278 userforward:
34279   driver = redirect
34280   check_local_user
34281   file = $home/.forward$local_part_suffix
34282   local_part_suffix = -*
34283   local_part_suffix_optional
34284   allow_filter
34285 .endd
34286 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34287 example, &_.forward-special_& is used. Once again, if the appropriate file
34288 does not exist, or does not deal with the address, it is passed on to
34289 subsequent routers, which could, if required, look for an unqualified
34290 &_.forward_& file to use as a default.
34291
34292
34293
34294 .section "Simplified vacation processing" "SECID244"
34295 .cindex "vacation processing"
34296 The traditional way of running the &'vacation'& program is for a user to set up
34297 a pipe command in a &_.forward_& file
34298 (see section &<<SECTspecitredli>>& for syntax details).
34299 This is prone to error by inexperienced users. There are two features of Exim
34300 that can be used to make this process simpler for users:
34301
34302 .ilist
34303 A local part prefix such as &"vacation-"& can be specified on a router which
34304 can cause the message to be delivered directly to the &'vacation'& program, or
34305 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34306 &_.forward_& file are then much simpler. For example:
34307 .code
34308 spqr, vacation-spqr
34309 .endd
34310 .next
34311 The &%require_files%& generic router option can be used to trigger a
34312 vacation delivery by checking for the existence of a certain file in the
34313 user's home directory. The &%unseen%& generic option should also be used, to
34314 ensure that the original delivery also proceeds. In this case, all the user has
34315 to do is to create a file called, say, &_.vacation_&, containing a vacation
34316 message.
34317 .endlist
34318
34319 Another advantage of both these methods is that they both work even when the
34320 use of arbitrary pipes by users is locked out.
34321
34322
34323
34324 .section "Taking copies of mail" "SECID245"
34325 .cindex "message" "copying every"
34326 Some installations have policies that require archive copies of all messages to
34327 be made. A single copy of each message can easily be taken by an appropriate
34328 command in a system filter, which could, for example, use a different file for
34329 each day's messages.
34330
34331 There is also a shadow transport mechanism that can be used to take copies of
34332 messages that are successfully delivered by local transports, one copy per
34333 delivery. This could be used, &'inter alia'&, to implement automatic
34334 notification of delivery by sites that insist on doing such things.
34335
34336
34337
34338 .section "Intermittently connected hosts" "SECID246"
34339 .cindex "intermittently connected hosts"
34340 It has become quite common (because it is cheaper) for hosts to connect to the
34341 Internet periodically rather than remain connected all the time. The normal
34342 arrangement is that mail for such hosts accumulates on a system that is
34343 permanently connected.
34344
34345 Exim was designed for use on permanently connected hosts, and so it is not
34346 particularly well-suited to use in an intermittently connected environment.
34347 Nevertheless there are some features that can be used.
34348
34349
34350 .section "Exim on the upstream server host" "SECID247"
34351 It is tempting to arrange for incoming mail for the intermittently connected
34352 host to remain on Exim's queue until the client connects. However, this
34353 approach does not scale very well. Two different kinds of waiting message are
34354 being mixed up in the same queue &-- those that cannot be delivered because of
34355 some temporary problem, and those that are waiting for their destination host
34356 to connect. This makes it hard to manage the queue, as well as wasting
34357 resources, because each queue runner scans the entire queue.
34358
34359 A better approach is to separate off those messages that are waiting for an
34360 intermittently connected host. This can be done by delivering these messages
34361 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34362 format, from where they are transmitted by other software when their
34363 destination connects. This makes it easy to collect all the mail for one host
34364 in a single directory, and to apply local timeout rules on a per-message basis
34365 if required.
34366
34367 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34368 you are doing this, you should configure Exim with a long retry period for the
34369 intermittent host. For example:
34370 .code
34371 cheshire.wonderland.fict.example    *   F,5d,24h
34372 .endd
34373 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34374 which messages it has queued up for that host. Once the intermittent host comes
34375 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34376 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34377 causes all the queued up messages to be delivered, often down a single SMTP
34378 connection. While the host remains connected, any new messages get delivered
34379 immediately.
34380
34381 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34382 issued with a different IP address each time it connects, Exim's retry
34383 mechanisms on the holding host get confused, because the IP address is normally
34384 used as part of the key string for holding retry information. This can be
34385 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34386 Since this has disadvantages for permanently connected hosts, it is best to
34387 arrange a separate transport for the intermittently connected ones.
34388
34389
34390
34391 .section "Exim on the intermittently connected client host" "SECID248"
34392 The value of &%smtp_accept_queue_per_connection%& should probably be
34393 increased, or even set to zero (that is, disabled) on the intermittently
34394 connected host, so that all incoming messages down a single connection get
34395 delivered immediately.
34396
34397 .cindex "SMTP" "passed connection"
34398 .cindex "SMTP" "multiple deliveries"
34399 .cindex "multiple SMTP deliveries"
34400 Mail waiting to be sent from an intermittently connected host will probably
34401 not have been routed, because without a connection DNS lookups are not
34402 possible. This means that if a normal queue run is done at connection time,
34403 each message is likely to be sent in a separate SMTP session. This can be
34404 avoided by starting the queue run with a command line option beginning with
34405 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34406 first pass, routing is done but no deliveries take place. The second pass is a
34407 normal queue run; since all the messages have been previously routed, those
34408 destined for the same host are likely to get sent as multiple deliveries in a
34409 single SMTP connection.
34410
34411
34412
34413 . ////////////////////////////////////////////////////////////////////////////
34414 . ////////////////////////////////////////////////////////////////////////////
34415
34416 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34417          "Exim as a non-queueing client"
34418 .cindex "client, non-queueing"
34419 .cindex "smart host" "suppressing queueing"
34420 On a personal computer, it is a common requirement for all
34421 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34422 configured to operate that way, for all the popular operating systems.
34423 However, there are some MUAs for Unix-like systems that cannot be so
34424 configured: they submit messages using the command line interface of
34425 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34426 messages this way.
34427
34428 If the personal computer runs continuously, there is no problem, because it can
34429 run a conventional MTA that handles delivery to the smart host, and deal with
34430 any delays via its queueing mechanism. However, if the computer does not run
34431 continuously or runs different operating systems at different times, queueing
34432 email is not desirable.
34433
34434 There is therefore a requirement for something that can provide the
34435 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34436 any queueing or retrying facilities. Furthermore, the delivery to the smart
34437 host should be synchronous, so that if it fails, the sending MUA is immediately
34438 informed. In other words, we want something that extends an MUA that submits
34439 to a local MTA via the command line so that it behaves like one that submits
34440 to a remote smart host using TCP/SMTP.
34441
34442 There are a number of applications (for example, there is one called &'ssmtp'&)
34443 that do this job. However, people have found them to be lacking in various
34444 ways. For instance, you might want to allow aliasing and forwarding to be done
34445 before sending a message to the smart host.
34446
34447 Exim already had the necessary infrastructure for doing this job. Just a few
34448 tweaks were needed to make it behave as required, though it is somewhat of an
34449 overkill to use a fully-featured MTA for this purpose.
34450
34451 .oindex "&%mua_wrapper%&"
34452 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34453 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34454 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34455 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34456 compatible router and transport configuration. Typically there will be just one
34457 router and one transport, sending everything to a smart host.
34458
34459 When run in MUA wrapping mode, the behaviour of Exim changes in the
34460 following ways:
34461
34462 .ilist
34463 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34464 In other words, the only way to submit messages is via the command line.
34465 .next
34466 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34467 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34468 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34469 does not finish until the delivery attempt is complete. If the delivery is
34470 successful, a zero return code is given.
34471 .next
34472 Address redirection is permitted, but the final routing for all addresses must
34473 be to the same remote transport, and to the same list of hosts. Furthermore,
34474 the return address (envelope sender) must be the same for all recipients, as
34475 must any added or deleted header lines. In other words, it must be possible to
34476 deliver the message in a single SMTP transaction, however many recipients there
34477 are.
34478 .next
34479 If these conditions are not met, or if routing any address results in a
34480 failure or defer status, or if Exim is unable to deliver all the recipients
34481 successfully to one of the smart hosts, delivery of the entire message fails.
34482 .next
34483 Because no queueing is allowed, all failures are treated as permanent; there
34484 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34485 smart host. Furthermore, because only a single yes/no response can be given to
34486 the caller, it is not possible to deliver to some recipients and not others. If
34487 there is an error (temporary or permanent) for any recipient, all are failed.
34488 .next
34489 If more than one smart host is listed, Exim will try another host after a
34490 connection failure or a timeout, in the normal way. However, if this kind of
34491 failure happens for all the hosts, the delivery fails.
34492 .next
34493 When delivery fails, an error message is written to the standard error stream
34494 (as well as to Exim's log), and Exim exits to the caller with a return code
34495 value 1. The message is expunged from Exim's spool files. No bounce messages
34496 are ever generated.
34497 .next
34498 No retry data is maintained, and any retry rules are ignored.
34499 .next
34500 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34501 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34502 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34503 .endlist
34504
34505 The overall effect is that Exim makes a single synchronous attempt to deliver
34506 the message, failing if there is any kind of problem. Because no local
34507 deliveries are done and no daemon can be run, Exim does not need root
34508 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34509 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34510 the advantages and disadvantages of running without root privilege.
34511
34512
34513
34514
34515 . ////////////////////////////////////////////////////////////////////////////
34516 . ////////////////////////////////////////////////////////////////////////////
34517
34518 .chapter "Log files" "CHAPlog"
34519 .scindex IIDloggen "log" "general description"
34520 .cindex "log" "types of"
34521 Exim writes three different logs, referred to as the main log, the reject log,
34522 and the panic log:
34523
34524 .ilist
34525 .cindex "main log"
34526 The main log records the arrival of each message and each delivery in a single
34527 line in each case. The format is as compact as possible, in an attempt to keep
34528 down the size of log files. Two-character flag sequences make it easy to pick
34529 out these lines. A number of other events are recorded in the main log. Some of
34530 them are optional, in which case the &%log_selector%& option controls whether
34531 they are included or not. A Perl script called &'eximstats'&, which does simple
34532 analysis of main log files, is provided in the Exim distribution (see section
34533 &<<SECTmailstat>>&).
34534 .next
34535 .cindex "reject log"
34536 The reject log records information from messages that are rejected as a result
34537 of a configuration option (that is, for policy reasons).
34538 The first line of each rejection is a copy of the line that is also written to
34539 the main log. Then, if the message's header has been read at the time the log
34540 is written, its contents are written to this log. Only the original header
34541 lines are available; header lines added by ACLs are not logged. You can use the
34542 reject log to check that your policy controls are working correctly; on a busy
34543 host this may be easier than scanning the main log for rejection messages. You
34544 can suppress the writing of the reject log by setting &%write_rejectlog%&
34545 false.
34546 .next
34547 .cindex "panic log"
34548 .cindex "system log"
34549 When certain serious errors occur, Exim writes entries to its panic log. If the
34550 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34551 are usually written to the main log as well, but can get lost amid the mass of
34552 other entries. The panic log should be empty under normal circumstances. It is
34553 therefore a good idea to check it (or to have a &'cron'& script check it)
34554 regularly, in order to become aware of any problems. When Exim cannot open its
34555 panic log, it tries as a last resort to write to the system log (syslog). This
34556 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34557 message itself is written at priority LOG_CRIT.
34558 .endlist
34559
34560 Every log line starts with a timestamp, in the format shown in the following
34561 example. Note that many of the examples shown in this chapter are line-wrapped.
34562 In the log file, this would be all on one line:
34563 .code
34564 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34565   by QUIT
34566 .endd
34567 By default, the timestamps are in the local timezone. There are two
34568 ways of changing this:
34569
34570 .ilist
34571 You can set the &%timezone%& option to a different time zone; in particular, if
34572 you set
34573 .code
34574 timezone = UTC
34575 .endd
34576 the timestamps will be in UTC (aka GMT).
34577 .next
34578 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34579 example:
34580 .code
34581 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34582 .endd
34583 .endlist
34584
34585 .cindex "log" "process ids in"
34586 .cindex "pid (process id)" "in log lines"
34587 Exim does not include its process id in log lines by default, but you can
34588 request that it does so by specifying the &`pid`& log selector (see section
34589 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34590 brackets, immediately after the time and date.
34591
34592
34593
34594
34595 .section "Where the logs are written" "SECTwhelogwri"
34596 .cindex "log" "destination"
34597 .cindex "log" "to file"
34598 .cindex "log" "to syslog"
34599 .cindex "syslog"
34600 The logs may be written to local files, or to syslog, or both. However, it
34601 should be noted that many syslog implementations use UDP as a transport, and
34602 are therefore unreliable in the sense that messages are not guaranteed to
34603 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34604 It has also been reported that on large log files (tens of megabytes) you may
34605 need to tweak syslog to prevent it syncing the file with each write &-- on
34606 Linux this has been seen to make syslog take 90% plus of CPU time.
34607
34608 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34609 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34610 configuration. This latter string is expanded, so it can contain, for example,
34611 references to the host name:
34612 .code
34613 log_file_path = /var/log/$primary_hostname/exim_%slog
34614 .endd
34615 It is generally advisable, however, to set the string in &_Local/Makefile_&
34616 rather than at run time, because then the setting is available right from the
34617 start of Exim's execution. Otherwise, if there's something it wants to log
34618 before it has read the configuration file (for example, an error in the
34619 configuration file) it will not use the path you want, and may not be able to
34620 log at all.
34621
34622 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34623 list, currently limited to at most two items. This is one option where the
34624 facility for changing a list separator may not be used. The list must always be
34625 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34626 otherwise the item must either be an absolute path, containing &`%s`& at the
34627 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34628 implying the use of a default path.
34629
34630 When Exim encounters an empty item in the list, it searches the list defined by
34631 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34632 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34633 mean &"use the path specified at build time"&. It no such item exists, log
34634 files are written in the &_log_& subdirectory of the spool directory. This is
34635 equivalent to the setting:
34636 .code
34637 log_file_path = $spool_directory/log/%slog
34638 .endd
34639 If you do not specify anything at build time or run time, that is where the
34640 logs are written.
34641
34642 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34643 are in use &-- see section &<<SECTdatlogfil>>& below.
34644
34645 Here are some examples of possible settings:
34646 .display
34647 &`LOG_FILE_PATH=syslog                    `& syslog only
34648 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34649 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34650 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34651 .endd
34652 If there are more than two paths in the list, the first is used and a panic
34653 error is logged.
34654
34655
34656
34657 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34658 .cindex "log" "cycling local files"
34659 .cindex "cycling logs"
34660 .cindex "&'exicyclog'&"
34661 .cindex "log" "local files; writing to"
34662 Some operating systems provide centralized and standardized methods for cycling
34663 log files. For those that do not, a utility script called &'exicyclog'& is
34664 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34665 main and reject logs each time it is called. The maximum number of old logs to
34666 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34667
34668 An Exim delivery process opens the main log when it first needs to write to it,
34669 and it keeps the file open in case subsequent entries are required &-- for
34670 example, if a number of different deliveries are being done for the same
34671 message. However, remote SMTP deliveries can take a long time, and this means
34672 that the file may be kept open long after it is renamed if &'exicyclog'& or
34673 something similar is being used to rename log files on a regular basis. To
34674 ensure that a switch of log files is noticed as soon as possible, Exim calls
34675 &[stat()]& on the main log's name before reusing an open file, and if the file
34676 does not exist, or its inode has changed, the old file is closed and Exim
34677 tries to open the main log from scratch. Thus, an old log file may remain open
34678 for quite some time, but no Exim processes should write to it once it has been
34679 renamed.
34680
34681
34682
34683 .section "Datestamped log files" "SECTdatlogfil"
34684 .cindex "log" "datestamped files"
34685 Instead of cycling the main and reject log files by renaming them
34686 periodically, some sites like to use files whose names contain a datestamp,
34687 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34688 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34689 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34690 point where the datestamp is required. For example:
34691 .code
34692 log_file_path = /var/spool/exim/log/%slog-%D
34693 log_file_path = /var/log/exim-%s-%D.log
34694 log_file_path = /var/spool/exim/log/%D-%slog
34695 log_file_path = /var/log/exim/%s.%M
34696 .endd
34697 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34698 examples of names generated by the above examples:
34699 .code
34700 /var/spool/exim/log/mainlog-20021225
34701 /var/log/exim-reject-20021225.log
34702 /var/spool/exim/log/20021225-mainlog
34703 /var/log/exim/main.200212
34704 .endd
34705 When this form of log file is specified, Exim automatically switches to new
34706 files at midnight. It does not make any attempt to compress old logs; you
34707 will need to write your own script if you require this. You should not
34708 run &'exicyclog'& with this form of logging.
34709
34710 The location of the panic log is also determined by &%log_file_path%&, but it
34711 is not datestamped, because rotation of the panic log does not make sense.
34712 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34713 the string. In addition, if it immediately follows a slash, a following
34714 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34715 character is removed. Thus, the four examples above would give these panic
34716 log names:
34717 .code
34718 /var/spool/exim/log/paniclog
34719 /var/log/exim-panic.log
34720 /var/spool/exim/log/paniclog
34721 /var/log/exim/panic
34722 .endd
34723
34724
34725 .section "Logging to syslog" "SECID249"
34726 .cindex "log" "syslog; writing to"
34727 The use of syslog does not change what Exim logs or the format of its messages,
34728 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34729 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34730 that, the same strings are written to syslog as to log files. The syslog
34731 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34732 by default, but you can change these by setting the &%syslog_facility%& and
34733 &%syslog_processname%& options, respectively. If Exim was compiled with
34734 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34735 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34736 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34737 the time and host name to each line.
34738 The three log streams are mapped onto syslog priorities as follows:
34739
34740 .ilist
34741 &'mainlog'& is mapped to LOG_INFO
34742 .next
34743 &'rejectlog'& is mapped to LOG_NOTICE
34744 .next
34745 &'paniclog'& is mapped to LOG_ALERT
34746 .endlist
34747
34748 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34749 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34750 these are routed by syslog to the same place. You can suppress this duplication
34751 by setting &%syslog_duplication%& false.
34752
34753 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34754 entries contain multiple lines when headers are included. To cope with both
34755 these cases, entries written to syslog are split into separate &[syslog()]&
34756 calls at each internal newline, and also after a maximum of
34757 870 data characters. (This allows for a total syslog line length of 1024, when
34758 additions such as timestamps are added.) If you are running a syslog
34759 replacement that can handle lines longer than the 1024 characters allowed by
34760 RFC 3164, you should set
34761 .code
34762 SYSLOG_LONG_LINES=yes
34763 .endd
34764 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34765 lines, but it still splits at internal newlines in &'reject'& log entries.
34766
34767 To make it easy to re-assemble split lines later, each component of a split
34768 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34769 where <&'n'&> is the component number and <&'m'&> is the total number of
34770 components in the entry. The / delimiter is used when the line was split
34771 because it was too long; if it was split because of an internal newline, the \
34772 delimiter is used. For example, supposing the length limit to be 50 instead of
34773 870, the following would be the result of a typical rejection message to
34774 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34775 name, and pid as added by syslog:
34776 .code
34777 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34778 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34779 [3/5]  when scanning for sender: missing or malformed lo
34780 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34781 [5/5] mple>)
34782 .endd
34783 The same error might cause the following lines to be written to &"rejectlog"&
34784 (LOG_NOTICE):
34785 .code
34786 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34787 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34788 [3/18] er when scanning for sender: missing or malformed
34789 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34790 [5\18] .example>)
34791 [6\18] Recipients: ph10@some.domain.cam.example
34792 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34793 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34794 [9\18]        id 16RdAL-0006pc-00
34795 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34796 [11\18] 09:43 +0100
34797 [12\18] F From: <>
34798 [13\18]   Subject: this is a test header
34799 [18\18]   X-something: this is another header
34800 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34801 [16\18] le>
34802 [17\18] B Bcc:
34803 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34804 .endd
34805 Log lines that are neither too long nor contain newlines are written to syslog
34806 without modification.
34807
34808 If only syslog is being used, the Exim monitor is unable to provide a log tail
34809 display, unless syslog is routing &'mainlog'& to a file on the local host and
34810 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34811 where it is.
34812
34813
34814
34815 .section "Log line flags" "SECID250"
34816 One line is written to the main log for each message received, and for each
34817 successful, unsuccessful, and delayed delivery. These lines can readily be
34818 picked out by the distinctive two-character flags that immediately follow the
34819 timestamp. The flags are:
34820 .display
34821 &`<=`&     message arrival
34822 &`=>`&     normal message delivery
34823 &`->`&     additional address in same delivery
34824 &`>>`&     cutthrough message delivery
34825 &`*>`&     delivery suppressed by &%-N%&
34826 &`**`&     delivery failed; address bounced
34827 &`==`&     delivery deferred; temporary problem
34828 .endd
34829
34830
34831 .section "Logging message reception" "SECID251"
34832 .cindex "log" "reception line"
34833 The format of the single-line entry in the main log that is written for every
34834 message received is shown in the basic example below, which is split over
34835 several lines in order to fit it on the page:
34836 .code
34837 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34838   H=mailer.fict.example [192.168.123.123] U=exim
34839   P=smtp S=5678 id=<incoming message id>
34840 .endd
34841 The address immediately following &"<="& is the envelope sender address. A
34842 bounce message is shown with the sender address &"<>"&, and if it is locally
34843 generated, this is followed by an item of the form
34844 .code
34845 R=<message id>
34846 .endd
34847 which is a reference to the message that caused the bounce to be sent.
34848
34849 .cindex "HELO"
34850 .cindex "EHLO"
34851 For messages from other hosts, the H and U fields identify the remote host and
34852 record the RFC 1413 identity of the user that sent the message, if one was
34853 received. The number given in square brackets is the IP address of the sending
34854 host. If there is a single, unparenthesized  host name in the H field, as
34855 above, it has been verified to correspond to the IP address (see the
34856 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34857 by the remote host in the SMTP HELO or EHLO command, and has not been
34858 verified. If verification yields a different name to that given for HELO or
34859 EHLO, the verified name appears first, followed by the HELO or EHLO
34860 name in parentheses.
34861
34862 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34863 without brackets, in the HELO or EHLO command, leading to entries in
34864 the log containing text like these examples:
34865 .code
34866 H=(10.21.32.43) [192.168.8.34]
34867 H=([10.21.32.43]) [192.168.8.34]
34868 .endd
34869 This can be confusing. Only the final address in square brackets can be relied
34870 on.
34871
34872 For locally generated messages (that is, messages not received over TCP/IP),
34873 the H field is omitted, and the U field contains the login name of the caller
34874 of Exim.
34875
34876 .cindex "authentication" "logging"
34877 .cindex "AUTH" "logging"
34878 For all messages, the P field specifies the protocol used to receive the
34879 message. This is the value that is stored in &$received_protocol$&. In the case
34880 of incoming SMTP messages, the value indicates whether or not any SMTP
34881 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34882 session was encrypted, there is an additional X field that records the cipher
34883 suite that was used.
34884
34885 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34886 hosts that have authenticated themselves using the SMTP AUTH command. The first
34887 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34888 there is an additional item A= followed by the name of the authenticator that
34889 was used. If an authenticated identification was set up by the authenticator's
34890 &%server_set_id%& option, this is logged too, separated by a colon from the
34891 authenticator name.
34892
34893 .cindex "size" "of message"
34894 The id field records the existing message id, if present. The size of the
34895 received message is given by the S field. When the message is delivered,
34896 headers may be removed or added, so that the size of delivered copies of the
34897 message may not correspond with this value (and indeed may be different to each
34898 other).
34899
34900 The &%log_selector%& option can be used to request the logging of additional
34901 data when a message is received. See section &<<SECTlogselector>>& below.
34902
34903
34904
34905 .section "Logging deliveries" "SECID252"
34906 .cindex "log" "delivery line"
34907 The format of the single-line entry in the main log that is written for every
34908 delivery is shown in one of the examples below, for local and remote
34909 deliveries, respectively. Each example has been split into two lines in order
34910 to fit it on the page:
34911 .code
34912 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34913   <marv@hitch.fict.example> R=localuser T=local_delivery
34914 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34915   monk@holistic.fict.example R=dnslookup T=remote_smtp
34916   H=holistic.fict.example [192.168.234.234]
34917 .endd
34918 For ordinary local deliveries, the original address is given in angle brackets
34919 after the final delivery address, which might be a pipe or a file. If
34920 intermediate address(es) exist between the original and the final address, the
34921 last of these is given in parentheses after the final address. The R and T
34922 fields record the router and transport that were used to process the address.
34923
34924 If SMTP AUTH was used for the delivery there is an additional item A=
34925 followed by the name of the authenticator that was used.
34926 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34927 option, this is logged too, separated by a colon from the authenticator name.
34928
34929 If a shadow transport was run after a successful local delivery, the log line
34930 for the successful delivery has an item added on the end, of the form
34931 .display
34932 &`ST=<`&&'shadow transport name'&&`>`&
34933 .endd
34934 If the shadow transport did not succeed, the error message is put in
34935 parentheses afterwards.
34936
34937 .cindex "asterisk" "after IP address"
34938 When more than one address is included in a single delivery (for example, two
34939 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34940 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34941 down a single SMTP connection, an asterisk follows the IP address in the log
34942 lines for the second and subsequent messages.
34943
34944 .cindex "delivery" "cutthrough; logging"
34945 .cindex "cutthrough" "logging"
34946 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34947 line precedes the reception line, since cutthrough waits for a possible
34948 rejection from the destination in case it can reject the sourced item.
34949
34950 The generation of a reply message by a filter file gets logged as a
34951 &"delivery"& to the addressee, preceded by &">"&.
34952
34953 The &%log_selector%& option can be used to request the logging of additional
34954 data when a message is delivered. See section &<<SECTlogselector>>& below.
34955
34956
34957 .section "Discarded deliveries" "SECID253"
34958 .cindex "discarded messages"
34959 .cindex "message" "discarded"
34960 .cindex "delivery" "discarded; logging"
34961 When a message is discarded as a result of the command &"seen finish"& being
34962 obeyed in a filter file which generates no deliveries, a log entry of the form
34963 .code
34964 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34965   <low.club@bridge.example> R=userforward
34966 .endd
34967 is written, to record why no deliveries are logged. When a message is discarded
34968 because it is aliased to &":blackhole:"& the log line is like this:
34969 .code
34970 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34971   <hole@nowhere.example> R=blackhole_router
34972 .endd
34973
34974
34975 .section "Deferred deliveries" "SECID254"
34976 When a delivery is deferred, a line of the following form is logged:
34977 .code
34978 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34979   R=dnslookup T=smtp defer (146): Connection refused
34980 .endd
34981 In the case of remote deliveries, the error is the one that was given for the
34982 last IP address that was tried. Details of individual SMTP failures are also
34983 written to the log, so the above line would be preceded by something like
34984 .code
34985 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34986   mail1.endrest.example [192.168.239.239]: Connection refused
34987 .endd
34988 When a deferred address is skipped because its retry time has not been reached,
34989 a message is written to the log, but this can be suppressed by setting an
34990 appropriate value in &%log_selector%&.
34991
34992
34993
34994 .section "Delivery failures" "SECID255"
34995 .cindex "delivery" "failure; logging"
34996 If a delivery fails because an address cannot be routed, a line of the
34997 following form is logged:
34998 .code
34999 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35000   <jim@trek99.example>: unknown mail domain
35001 .endd
35002 If a delivery fails at transport time, the router and transport are shown, and
35003 the response from the remote host is included, as in this example:
35004 .code
35005 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35006   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35007   after pipelined RCPT TO:<ace400@pb.example>: host
35008   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35009   <ace400@pb.example>...Addressee unknown
35010 .endd
35011 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35012 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35013 disabling PIPELINING. The log lines for all forms of delivery failure are
35014 flagged with &`**`&.
35015
35016
35017
35018 .section "Fake deliveries" "SECID256"
35019 .cindex "delivery" "fake; logging"
35020 If a delivery does not actually take place because the &%-N%& option has been
35021 used to suppress it, a normal delivery line is written to the log, except that
35022 &"=>"& is replaced by &"*>"&.
35023
35024
35025
35026 .section "Completion" "SECID257"
35027 A line of the form
35028 .code
35029 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35030 .endd
35031 is written to the main log when a message is about to be removed from the spool
35032 at the end of its processing.
35033
35034
35035
35036
35037 .section "Summary of Fields in Log Lines" "SECID258"
35038 .cindex "log" "summary of fields"
35039 A summary of the field identifiers that are used in log lines is shown in
35040 the following table:
35041 .display
35042 &`A   `&        authenticator name (and optional id and sender)
35043 &`C   `&        SMTP confirmation on delivery
35044 &`    `&        command list for &"no mail in SMTP session"&
35045 &`CV  `&        certificate verification status
35046 &`D   `&        duration of &"no mail in SMTP session"&
35047 &`DN  `&        distinguished name from peer certificate
35048 &`DT  `&        on &`=>`& lines: time taken for a delivery
35049 &`F   `&        sender address (on delivery lines)
35050 &`H   `&        host name and IP address
35051 &`I   `&        local interface used
35052 &`id  `&        message id for incoming message
35053 &`P   `&        on &`<=`& lines: protocol used
35054 &`    `&        on &`=>`& and &`**`& lines: return path
35055 &`QT  `&        on &`=>`& lines: time spent on queue so far
35056 &`    `&        on &"Completed"& lines: time spent on queue
35057 &`R   `&        on &`<=`& lines: reference for local bounce
35058 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
35059 &`S   `&        size of message
35060 &`SNI `&        server name indication from TLS client hello
35061 &`ST  `&        shadow transport name
35062 &`T   `&        on &`<=`& lines: message subject (topic)
35063 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35064 &`U   `&        local user or RFC 1413 identity
35065 &`X   `&        TLS cipher suite
35066 .endd
35067
35068
35069 .section "Other log entries" "SECID259"
35070 Various other types of log entry are written from time to time. Most should be
35071 self-explanatory. Among the more common are:
35072
35073 .ilist
35074 .cindex "retry" "time not reached"
35075 &'retry time not reached'&&~&~An address previously suffered a temporary error
35076 during routing or local delivery, and the time to retry has not yet arrived.
35077 This message is not written to an individual message log file unless it happens
35078 during the first delivery attempt.
35079 .next
35080 &'retry time not reached for any host'&&~&~An address previously suffered
35081 temporary errors during remote delivery, and the retry time has not yet arrived
35082 for any of the hosts to which it is routed.
35083 .next
35084 .cindex "spool directory" "file locked"
35085 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35086 some other Exim process is already working on the message. This can be quite
35087 common if queue running processes are started at frequent intervals. The
35088 &'exiwhat'& utility script can be used to find out what Exim processes are
35089 doing.
35090 .next
35091 .cindex "error" "ignored"
35092 &'error ignored'&&~&~There are several circumstances that give rise to this
35093 message:
35094 .olist
35095 Exim failed to deliver a bounce message whose age was greater than
35096 &%ignore_bounce_errors_after%&. The bounce was discarded.
35097 .next
35098 A filter file set up a delivery using the &"noerror"& option, and the delivery
35099 failed. The delivery was discarded.
35100 .next
35101 A delivery set up by a router configured with
35102 . ==== As this is a nested list, any displays it contains must be indented
35103 . ==== as otherwise they are too far to the left.
35104 .code
35105     errors_to = <>
35106 .endd
35107 failed. The delivery was discarded.
35108 .endlist olist
35109 .endlist ilist
35110
35111
35112
35113
35114
35115 .section "Reducing or increasing what is logged" "SECTlogselector"
35116 .cindex "log" "selectors"
35117 By setting the &%log_selector%& global option, you can disable some of Exim's
35118 default logging, or you can request additional logging. The value of
35119 &%log_selector%& is made up of names preceded by plus or minus characters. For
35120 example:
35121 .code
35122 log_selector = +arguments -retry_defer
35123 .endd
35124 The list of optional log items is in the following table, with the default
35125 selection marked by asterisks:
35126 .display
35127 &` 8bitmime                   `&  received 8BITMIME status
35128 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35129 &` address_rewrite            `&  address rewriting
35130 &` all_parents                `&  all parents in => lines
35131 &` arguments                  `&  command line arguments
35132 &`*connection_reject          `&  connection rejections
35133 &`*delay_delivery             `&  immediate delivery delayed
35134 &` deliver_time               `&  time taken to perform delivery
35135 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35136 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35137 &`*etrn                       `&  ETRN commands
35138 &`*host_lookup_failed         `&  as it says
35139 &` ident_timeout              `&  timeout for ident connection
35140 &` incoming_interface         `&  local interface on <= and => lines
35141 &` incoming_port              `&  remote port on <= lines
35142 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35143 &` outgoing_port              `&  add remote port to => lines
35144 &`*queue_run                  `&  start and end queue runs
35145 &` queue_time                 `&  time on queue for one recipient
35146 &` queue_time_overall         `&  time on queue for whole message
35147 &` pid                        `&  Exim process id
35148 &` received_recipients        `&  recipients on <= lines
35149 &` received_sender            `&  sender on <= lines
35150 &`*rejected_header            `&  header contents on reject log
35151 &`*retry_defer                `&  &"retry time not reached"&
35152 &` return_path_on_delivery    `&  put return path on => and ** lines
35153 &` sender_on_delivery         `&  add sender to => lines
35154 &`*sender_verify_fail         `&  sender verification failures
35155 &`*size_reject                `&  rejection because too big
35156 &`*skip_delivery              `&  delivery skipped in a queue run
35157 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35158 &` smtp_connection            `&  SMTP connections
35159 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35160 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35161 &` smtp_no_mail               `&  session with no MAIL commands
35162 &` smtp_protocol_error        `&  SMTP protocol errors
35163 &` smtp_syntax_error          `&  SMTP syntax errors
35164 &` subject                    `&  contents of &'Subject:'& on <= lines
35165 .new
35166 &`*tls_certificate_verified   `&  certificate verification status
35167 .wen
35168 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35169 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35170 &` tls_sni                    `&  TLS SNI on <= lines
35171 &` unknown_in_list            `&  DNS lookup failed in list match
35172
35173 &` all                        `&  all of the above
35174 .endd
35175 More details on each of these items follows:
35176
35177 .ilist
35178 .cindex "8BITMIME"
35179 .cindex "log" "8BITMIME"
35180 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35181 which may help in tracking down interoperability issues with ancient MTAs
35182 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35183 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35184 &`7BIT`& and &`8BITMIME`& respectively.
35185 .next
35186 .cindex "&%warn%& ACL verb" "log when skipping"
35187 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35188 its conditions cannot be evaluated, a log line to this effect is written if
35189 this log selector is set.
35190 .next
35191 .cindex "log" "rewriting"
35192 .cindex "rewriting" "logging"
35193 &%address_rewrite%&: This applies both to global rewrites and per-transport
35194 rewrites, but not to rewrites in filters run as an unprivileged user (because
35195 such users cannot access the log).
35196 .next
35197 .cindex "log" "full parentage"
35198 &%all_parents%&: Normally only the original and final addresses are logged on
35199 delivery lines; with this selector, intermediate parents are given in
35200 parentheses between them.
35201 .next
35202 .cindex "log" "Exim arguments"
35203 .cindex "Exim arguments, logging"
35204 &%arguments%&: This causes Exim to write the arguments with which it was called
35205 to the main log, preceded by the current working directory. This is a debugging
35206 feature, added to make it easier to find out how certain MUAs call
35207 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35208 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35209 that are empty or that contain white space are quoted. Non-printing characters
35210 are shown as escape sequences. This facility cannot log unrecognized arguments,
35211 because the arguments are checked before the configuration file is read. The
35212 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35213 between the caller and Exim.
35214 .next
35215 .cindex "log" "connection rejections"
35216 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35217 connection is rejected, for whatever reason.
35218 .next
35219 .cindex "log" "delayed delivery"
35220 .cindex "delayed delivery, logging"
35221 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35222 started for an incoming message because the load is too high or too many
35223 messages were received on one connection. Logging does not occur if no delivery
35224 process is started because &%queue_only%& is set or &%-odq%& was used.
35225 .next
35226 .cindex "log" "delivery duration"
35227 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35228 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35229 .next
35230 .cindex "log" "message size on delivery"
35231 .cindex "size" "of message"
35232 &%delivery_size%&: For each delivery, the size of message delivered is added to
35233 the &"=>"& line, tagged with S=.
35234 .next
35235 .cindex "log" "dnslist defer"
35236 .cindex "DNS list" "logging defer"
35237 .cindex "black list (DNS)"
35238 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35239 DNS black list suffers a temporary error.
35240 .next
35241 .cindex "log" "ETRN commands"
35242 .cindex "ETRN" "logging"
35243 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35244 is run to determine whether or not it is actually accepted. An invalid ETRN
35245 command, or one received within a message transaction is not logged by this
35246 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35247 .next
35248 .cindex "log" "host lookup failure"
35249 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35250 any addresses, or when a lookup of an IP address fails to find a host name, a
35251 log line is written. This logging does not apply to direct DNS lookups when
35252 routing email addresses, but it does apply to &"byname"& lookups.
35253 .next
35254 .cindex "log" "ident timeout"
35255 .cindex "RFC 1413" "logging timeout"
35256 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35257 client's ident port times out.
35258 .next
35259 .cindex "log" "incoming interface"
35260 .cindex "log" "local interface"
35261 .cindex "log" "local address and port"
35262 .cindex "TCP/IP" "logging local address and port"
35263 .cindex "interface" "logging"
35264 &%incoming_interface%&: The interface on which a message was received is added
35265 to the &"<="& line as an IP address in square brackets, tagged by I= and
35266 followed by a colon and the port number. The local interface and port are also
35267 added to other SMTP log lines, for example &"SMTP connection from"& and to
35268 rejection lines
35269 and (despite the name) the local interface is added to &"=>"& lines..
35270 .next
35271 .cindex "log" "incoming remote port"
35272 .cindex "port" "logging remote"
35273 .cindex "TCP/IP" "logging incoming remote port"
35274 .vindex "&$sender_fullhost$&"
35275 .vindex "&$sender_rcvhost$&"
35276 &%incoming_port%&: The remote port number from which a message was received is
35277 added to log entries and &'Received:'& header lines, following the IP address
35278 in square brackets, and separated from it by a colon. This is implemented by
35279 changing the value that is put in the &$sender_fullhost$& and
35280 &$sender_rcvhost$& variables. Recording the remote port number has become more
35281 important with the widening use of NAT (see RFC 2505).
35282 .next
35283 .cindex "log" "dropped connection"
35284 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35285 connection is unexpectedly dropped.
35286 .next
35287 .cindex "log" "outgoing remote port"
35288 .cindex "port" "logging outgoint remote"
35289 .cindex "TCP/IP" "logging ougtoing remote port"
35290 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35291 containing => tags) following the IP address. This option is not included in
35292 the default setting, because for most ordinary configurations, the remote port
35293 number is always 25 (the SMTP port).
35294 .next
35295 .cindex "log" "process ids in"
35296 .cindex "pid (process id)" "in log lines"
35297 &%pid%&: The current process id is added to every log line, in square brackets,
35298 immediately after the time and date.
35299 .next
35300 .cindex "log" "queue run"
35301 .cindex "queue runner" "logging"
35302 &%queue_run%&: The start and end of every queue run are logged.
35303 .next
35304 .cindex "log" "queue time"
35305 &%queue_time%&: The amount of time the message has been in the queue on the
35306 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35307 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35308 includes reception time as well as the delivery time for the current address.
35309 This means that it may be longer than the difference between the arrival and
35310 delivery log line times, because the arrival log line is not written until the
35311 message has been successfully received.
35312 .next
35313 &%queue_time_overall%&: The amount of time the message has been in the queue on
35314 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35315 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35316 message, so it includes reception time as well as the total delivery time.
35317 .next
35318 .cindex "log" "recipients"
35319 &%received_recipients%&: The recipients of a message are listed in the main log
35320 as soon as the message is received. The list appears at the end of the log line
35321 that is written when a message is received, preceded by the word &"for"&. The
35322 addresses are listed after they have been qualified, but before any rewriting
35323 has taken place.
35324 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35325 in the list.
35326 .next
35327 .cindex "log" "sender reception"
35328 &%received_sender%&: The unrewritten original sender of a message is added to
35329 the end of the log line that records the message's arrival, after the word
35330 &"from"& (before the recipients if &%received_recipients%& is also set).
35331 .next
35332 .cindex "log" "header lines for rejection"
35333 &%rejected_header%&: If a message's header has been received at the time a
35334 rejection is written to the reject log, the complete header is added to the
35335 log. Header logging can be turned off individually for messages that are
35336 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35337 .next
35338 .cindex "log" "retry defer"
35339 &%retry_defer%&: A log line is written if a delivery is deferred because a
35340 retry time has not yet been reached. However, this &"retry time not reached"&
35341 message is always omitted from individual message logs after the first delivery
35342 attempt.
35343 .next
35344 .cindex "log" "return path"
35345 &%return_path_on_delivery%&: The return path that is being transmitted with
35346 the message is included in delivery and bounce lines, using the tag P=.
35347 This is omitted if no delivery actually happens, for example, if routing fails,
35348 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35349 .next
35350 .cindex "log" "sender on delivery"
35351 &%sender_on_delivery%&: The message's sender address is added to every delivery
35352 and bounce line, tagged by F= (for &"from"&).
35353 This is the original sender that was received with the message; it is not
35354 necessarily the same as the outgoing return path.
35355 .next
35356 .cindex "log" "sender verify failure"
35357 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35358 gives details of a sender verification failure is not written. Log lines for
35359 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35360 detail is lost.
35361 .next
35362 .cindex "log" "size rejection"
35363 &%size_reject%&: A log line is written whenever a message is rejected because
35364 it is too big.
35365 .next
35366 .cindex "log" "frozen messages; skipped"
35367 .cindex "frozen messages" "logging skipping"
35368 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35369 queue run because it is frozen or because another process is already delivering
35370 it.
35371 .cindex "&""spool file is locked""&"
35372 The message that is written is &"spool file is locked"&.
35373 .next
35374 .cindex "log" "smtp confirmation"
35375 .cindex "SMTP" "logging confirmation"
35376 .cindex "LMTP" "logging confirmation"
35377 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35378 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35379 A number of MTAs (including Exim) return an identifying string in this
35380 response.
35381 .next
35382 .cindex "log" "SMTP connections"
35383 .cindex "SMTP" "logging connections"
35384 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35385 established or closed, unless the connection is from a host that matches
35386 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35387 only when the closure is unexpected.) This applies to connections from local
35388 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35389 dropped in the middle of a message, a log line is always written, whether or
35390 not this selector is set, but otherwise nothing is written at the start and end
35391 of connections unless this selector is enabled.
35392
35393 For TCP/IP connections to an Exim daemon, the current number of connections is
35394 included in the log message for each new connection, but note that the count is
35395 reset if the daemon is restarted.
35396 Also, because connections are closed (and the closure is logged) in
35397 subprocesses, the count may not include connections that have been closed but
35398 whose termination the daemon has not yet noticed. Thus, while it is possible to
35399 match up the opening and closing of connections in the log, the value of the
35400 logged counts may not be entirely accurate.
35401 .next
35402 .cindex "log" "SMTP transaction; incomplete"
35403 .cindex "SMTP" "logging incomplete transactions"
35404 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35405 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35406 and the message sender plus any accepted recipients are included in the log
35407 line. This can provide evidence of dictionary attacks.
35408 .next
35409 .cindex "log" "non-MAIL SMTP sessions"
35410 .cindex "MAIL" "logging session without"
35411 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35412 connection terminates without having issued a MAIL command. This includes both
35413 the case when the connection is dropped, and the case when QUIT is used. It
35414 does not include cases where the connection is rejected right at the start (by
35415 an ACL, or because there are too many connections, or whatever). These cases
35416 already have their own log lines.
35417
35418 The log line that is written contains the identity of the client in the usual
35419 way, followed by D= and a time, which records the duration of the connection.
35420 If the connection was authenticated, this fact is logged exactly as it is for
35421 an incoming message, with an A= item. If the connection was encrypted, CV=,
35422 DN=, and X= items may appear as they do for an incoming message, controlled by
35423 the same logging options.
35424
35425 Finally, if any SMTP commands were issued during the connection, a C= item
35426 is added to the line, listing the commands that were used. For example,
35427 .code
35428 C=EHLO,QUIT
35429 .endd
35430 shows that the client issued QUIT straight after EHLO. If there were fewer
35431 than 20 commands, they are all listed. If there were more than 20 commands,
35432 the last 20 are listed, preceded by &"..."&. However, with the default
35433 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35434 have been aborted before 20 non-mail commands are processed.
35435 .next
35436 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35437 colon-separated, is appended to the A= item for a message arrival or delivery
35438 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35439 was accepted or used.
35440 .next
35441 .cindex "log" "SMTP protocol error"
35442 .cindex "SMTP" "logging protocol error"
35443 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35444 encountered. Exim does not have perfect detection of all protocol errors
35445 because of transmission delays and the use of pipelining. If PIPELINING has
35446 been advertised to a client, an Exim server assumes that the client will use
35447 it, and therefore it does not count &"expected"& errors (for example, RCPT
35448 received after rejecting MAIL) as protocol errors.
35449 .next
35450 .cindex "SMTP" "logging syntax errors"
35451 .cindex "SMTP" "syntax errors; logging"
35452 .cindex "SMTP" "unknown command; logging"
35453 .cindex "log" "unknown SMTP command"
35454 .cindex "log" "SMTP syntax error"
35455 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35456 encountered. An unrecognized command is treated as a syntax error. For an
35457 external connection, the host identity is given; for an internal connection
35458 using &%-bs%& the sender identification (normally the calling user) is given.
35459 .next
35460 .cindex "log" "subject"
35461 .cindex "subject, logging"
35462 &%subject%&: The subject of the message is added to the arrival log line,
35463 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35464 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35465 specifies whether characters with values greater than 127 should be logged
35466 unchanged, or whether they should be rendered as escape sequences.
35467 .next
35468 .cindex "log" "certificate verification"
35469 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35470 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35471 verified, and &`CV=no`& if not.
35472 .next
35473 .cindex "log" "TLS cipher"
35474 .cindex "TLS" "logging cipher"
35475 &%tls_cipher%&: When a message is sent or received over an encrypted
35476 connection, the cipher suite used is added to the log line, preceded by X=.
35477 .next
35478 .cindex "log" "TLS peer DN"
35479 .cindex "TLS" "logging peer DN"
35480 &%tls_peerdn%&: When a message is sent or received over an encrypted
35481 connection, and a certificate is supplied by the remote host, the peer DN is
35482 added to the log line, preceded by DN=.
35483 .next
35484 .cindex "log" "TLS SNI"
35485 .cindex "TLS" "logging SNI"
35486 &%tls_sni%&: When a message is received over an encrypted connection, and
35487 the remote host provided the Server Name Indication extension, the SNI is
35488 added to the log line, preceded by SNI=.
35489 .next
35490 .cindex "log" "DNS failure in list"
35491 &%unknown_in_list%&: This setting causes a log entry to be written when the
35492 result of a list match is failure because a DNS lookup failed.
35493 .endlist
35494
35495
35496 .section "Message log" "SECID260"
35497 .cindex "message" "log file for"
35498 .cindex "log" "message log; description of"
35499 .cindex "&_msglog_& directory"
35500 .oindex "&%preserve_message_logs%&"
35501 In addition to the general log files, Exim writes a log file for each message
35502 that it handles. The names of these per-message logs are the message ids, and
35503 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35504 message log contains copies of the log lines that apply to the message. This
35505 makes it easier to inspect the status of an individual message without having
35506 to search the main log. A message log is deleted when processing of the message
35507 is complete, unless &%preserve_message_logs%& is set, but this should be used
35508 only with great care because they can fill up your disk very quickly.
35509
35510 On a heavily loaded system, it may be desirable to disable the use of
35511 per-message logs, in order to reduce disk I/O. This can be done by setting the
35512 &%message_logs%& option false.
35513 .ecindex IIDloggen
35514
35515
35516
35517
35518 . ////////////////////////////////////////////////////////////////////////////
35519 . ////////////////////////////////////////////////////////////////////////////
35520
35521 .chapter "Exim utilities" "CHAPutils"
35522 .scindex IIDutils "utilities"
35523 A number of utility scripts and programs are supplied with Exim and are
35524 described in this chapter. There is also the Exim Monitor, which is covered in
35525 the next chapter. The utilities described here are:
35526
35527 .itable none 0 0 3  7* left  15* left  40* left
35528 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35529   "list what Exim processes are doing"
35530 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35531 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35532 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35533 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35534                                                 various criteria"
35535 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35536 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35537   "extract statistics from the log"
35538 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35539   "check address acceptance from given IP"
35540 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35541 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35542 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35543 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35544 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35545 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35546 .endtable
35547
35548 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35549 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35550 &url(http://duncanthrax.net/exilog/) for details.
35551
35552
35553
35554
35555 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35556 .cindex "&'exiwhat'&"
35557 .cindex "process, querying"
35558 .cindex "SIGUSR1"
35559 On operating systems that can restart a system call after receiving a signal
35560 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35561 a line describing what it is doing to the file &_exim-process.info_& in the
35562 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35563 processes it can find, having first emptied the file. It then waits for one
35564 second to allow the Exim processes to react before displaying the results. In
35565 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35566 send the signal to the Exim processes, so it is normally run as root.
35567
35568 &*Warning*&: This is not an efficient process. It is intended for occasional
35569 use by system administrators. It is not sensible, for example, to set up a
35570 script that sends SIGUSR1 signals to Exim processes at short intervals.
35571
35572
35573 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35574 varies in different operating systems. Not only are different options used,
35575 but the format of the output is different. For this reason, there are some
35576 system configuration options that configure exactly how &'exiwhat'& works. If
35577 it doesn't seem to be working for you, check the following compile-time
35578 options:
35579 .display
35580 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35581 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35582 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35583 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35584 .endd
35585 An example of typical output from &'exiwhat'& is
35586 .code
35587 164 daemon: -q1h, listening on port 25
35588 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35589 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35590   [10.19.42.42] (editor@ref.example)
35591 10592 handling incoming call from [192.168.243.242]
35592 10628 accepting a local non-SMTP message
35593 .endd
35594 The first number in the output line is the process number. The third line has
35595 been split here, in order to fit it on the page.
35596
35597
35598
35599 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35600 .cindex "&'exiqgrep'&"
35601 .cindex "queue" "grepping"
35602 This utility is a Perl script contributed by Matt Hubbard. It runs
35603 .code
35604 exim -bpu
35605 .endd
35606 or (in case &*-a*& switch is specified)
35607 .code
35608 exim -bp
35609 .endd
35610 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35611 contain alternate exim configuration the queue management might be using.
35612
35613 to obtain a queue listing, and then greps the output to select messages 
35614 that match given criteria. The following selection options are available:
35615
35616 .vlist
35617 .vitem &*-f*&&~<&'regex'&>
35618 Match the sender address using a case-insensitive search. The field that is
35619 tested is enclosed in angle brackets, so you can test for bounce messages with
35620 .code
35621 exiqgrep -f '^<>$'
35622 .endd
35623 .vitem &*-r*&&~<&'regex'&>
35624 Match a recipient address using a case-insensitve search. The field that is
35625 tested is not enclosed in angle brackets.
35626
35627 .vitem &*-s*&&~<&'regex'&>
35628 Match against the size field.
35629
35630 .vitem &*-y*&&~<&'seconds'&>
35631 Match messages that are younger than the given time.
35632
35633 .vitem &*-o*&&~<&'seconds'&>
35634 Match messages that are older than the given time.
35635
35636 .vitem &*-z*&
35637 Match only frozen messages.
35638
35639 .vitem &*-x*&
35640 Match only non-frozen messages.
35641 .endlist
35642
35643 The following options control the format of the output:
35644
35645 .vlist
35646 .vitem &*-c*&
35647 Display only the count of matching messages.
35648
35649 .vitem &*-l*&
35650 Long format &-- display the full message information as output by Exim. This is
35651 the default.
35652
35653 .vitem &*-i*&
35654 Display message ids only.
35655
35656 .vitem &*-b*&
35657 Brief format &-- one line per message.
35658
35659 .vitem &*-R*&
35660 Display messages in reverse order.
35661
35662 .vitem &*-a*&
35663 Include delivered recipients in queue listing.
35664 .endlist
35665
35666 There is one more option, &%-h%&, which outputs a list of options.
35667
35668
35669
35670 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35671 .cindex "&'exiqsumm'&"
35672 .cindex "queue" "summary"
35673 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35674 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35675 running a command such as
35676 .code
35677 exim -bp | exiqsumm
35678 .endd
35679 The output consists of one line for each domain that has messages waiting for
35680 it, as in the following example:
35681 .code
35682 3   2322   74m   66m  msn.com.example
35683 .endd
35684 Each line lists the number of pending deliveries for a domain, their total
35685 volume, and the length of time that the oldest and the newest messages have
35686 been waiting. Note that the number of pending deliveries is greater than the
35687 number of messages when messages have more than one recipient.
35688
35689 A summary line is output at the end. By default the output is sorted on the
35690 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35691 the output to be sorted by oldest message and by count of messages,
35692 respectively. There are also three options that split the messages for each
35693 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35694 separates frozen messages, and &%-s%& separates messages according to their
35695 sender.
35696
35697 The output of &'exim -bp'& contains the original addresses in the message, so
35698 this also applies to the output from &'exiqsumm'&. No domains from addresses
35699 generated by aliasing or forwarding are included (unless the &%one_time%&
35700 option of the &(redirect)& router has been used to convert them into &"top
35701 level"& addresses).
35702
35703
35704
35705
35706 .section "Extracting specific information from the log (exigrep)" &&&
35707          "SECTextspeinf"
35708 .cindex "&'exigrep'&"
35709 .cindex "log" "extracts; grepping for"
35710 The &'exigrep'& utility is a Perl script that searches one or more main log
35711 files for entries that match a given pattern. When it finds a match, it
35712 extracts all the log entries for the relevant message, not just those that
35713 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35714 given message, or all mail for a given user, or for a given host, for example.
35715 The input files can be in Exim log format or syslog format.
35716 If a matching log line is not associated with a specific message, it is
35717 included in &'exigrep'&'s output without any additional lines. The usage is:
35718 .display
35719 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35720 .endd
35721 If no log file names are given on the command line, the standard input is read.
35722
35723 The &%-t%& argument specifies a number of seconds. It adds an additional
35724 condition for message selection. Messages that are complete are shown only if
35725 they spent more than <&'n'&> seconds on the queue.
35726
35727 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35728 makes it case-sensitive. This may give a performance improvement when searching
35729 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35730 option; with &%-I%& they do not. In both cases it is possible to change the
35731 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35732
35733 The &%-l%& option means &"literal"&, that is, treat all characters in the
35734 pattern as standing for themselves. Otherwise the pattern must be a Perl
35735 regular expression.
35736
35737 The &%-v%& option inverts the matching condition. That is, a line is selected
35738 if it does &'not'& match the pattern.
35739
35740 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35741 that are generated as a result/response to a message that &'exigrep'& matched
35742 normally.
35743
35744 Example of &%-M%&:
35745 user_a sends a message to user_b, which generates a bounce back to user_b. If
35746 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35747 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35748 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35749 when searching for &"user_a"& will show both messages since the bounce is
35750 &"related"& to or a &"result"& of the first message that was found by the
35751 search term.
35752
35753 If the location of a &'zcat'& command is known from the definition of
35754 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35755 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35756 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
35757 autodetection of some well known compression extensions.
35758
35759
35760 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35761 .cindex "&'exipick'&"
35762 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35763 lists messages from the queue according to a variety of criteria. For details
35764 of &'exipick'&'s facilities, visit the web page at
35765 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35766 the &%--help%& option.
35767
35768
35769 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35770 .cindex "log" "cycling local files"
35771 .cindex "cycling logs"
35772 .cindex "&'exicyclog'&"
35773 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35774 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35775 you are using log files with datestamps in their names (see section
35776 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35777 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35778 There are two command line options for &'exicyclog'&:
35779 .ilist
35780 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35781 default that is set when Exim is built. The default default is 10.
35782 .next
35783 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35784 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35785 overriding the script's default, which is to find the setting from Exim's
35786 configuration.
35787 .endlist
35788
35789 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35790 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35791 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35792 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35793 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35794 logs are handled similarly.
35795
35796 If the limit is greater than 99, the script uses 3-digit numbers such as
35797 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35798 to one that is greater, or &'vice versa'&, you will have to fix the names of
35799 any existing log files.
35800
35801 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35802 the end are deleted. All files with numbers greater than 01 are compressed,
35803 using a compression command which is configured by the COMPRESS_COMMAND
35804 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35805 root &%crontab%& entry of the form
35806 .code
35807 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35808 .endd
35809 assuming you have used the name &"exim"& for the Exim user. You can run
35810 &'exicyclog'& as root if you wish, but there is no need.
35811
35812
35813
35814 .section "Mail statistics (eximstats)" "SECTmailstat"
35815 .cindex "statistics"
35816 .cindex "&'eximstats'&"
35817 A Perl script called &'eximstats'& is provided for extracting statistical
35818 information from log files. The output is either plain text, or HTML.
35819 Exim log files are also supported by the &'Lire'& system produced by the
35820 LogReport Foundation &url(http://www.logreport.org).
35821
35822 The &'eximstats'& script has been hacked about quite a bit over time. The
35823 latest version is the result of some extensive revision by Steve Campbell. A
35824 lot of information is given by default, but there are options for suppressing
35825 various parts of it. Following any options, the arguments to the script are a
35826 list of files, which should be main log files. For example:
35827 .code
35828 eximstats -nr /var/spool/exim/log/mainlog.01
35829 .endd
35830 By default, &'eximstats'& extracts information about the number and volume of
35831 messages received from or delivered to various hosts. The information is sorted
35832 both by message count and by volume, and the top fifty hosts in each category
35833 are listed on the standard output. Similar information, based on email
35834 addresses or domains instead of hosts can be requested by means of various
35835 options. For messages delivered and received locally, similar statistics are
35836 also produced per user.
35837
35838 The output also includes total counts and statistics about delivery errors, and
35839 histograms showing the number of messages received and deliveries made in each
35840 hour of the day. A delivery with more than one address in its envelope (for
35841 example, an SMTP transaction with more than one RCPT command) is counted
35842 as a single delivery by &'eximstats'&.
35843
35844 Though normally more deliveries than receipts are reported (as messages may
35845 have multiple recipients), it is possible for &'eximstats'& to report more
35846 messages received than delivered, even though the queue is empty at the start
35847 and end of the period in question. If an incoming message contains no valid
35848 recipients, no deliveries are recorded for it. A bounce message is handled as
35849 an entirely separate message.
35850
35851 &'eximstats'& always outputs a grand total summary giving the volume and number
35852 of messages received and deliveries made, and the number of hosts involved in
35853 each case. It also outputs the number of messages that were delayed (that is,
35854 not completely delivered at the first attempt), and the number that had at
35855 least one address that failed.
35856
35857 The remainder of the output is in sections that can be independently disabled
35858 or modified by various options. It consists of a summary of deliveries by
35859 transport, histograms of messages received and delivered per time interval
35860 (default per hour), information about the time messages spent on the queue,
35861 a list of relayed messages, lists of the top fifty sending hosts, local
35862 senders, destination hosts, and destination local users by count and by volume,
35863 and a list of delivery errors that occurred.
35864
35865 The relay information lists messages that were actually relayed, that is, they
35866 came from a remote host and were directly delivered to some other remote host,
35867 without being processed (for example, for aliasing or forwarding) locally.
35868
35869 There are quite a few options for &'eximstats'& to control exactly what it
35870 outputs. These are documented in the Perl script itself, and can be extracted
35871 by running the command &(perldoc)& on the script. For example:
35872 .code
35873 perldoc /usr/exim/bin/eximstats
35874 .endd
35875
35876 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35877 .cindex "&'exim_checkaccess'&"
35878 .cindex "policy control" "checking access"
35879 .cindex "checking access"
35880 The &%-bh%& command line argument allows you to run a fake SMTP session with
35881 debugging output, in order to check what Exim is doing when it is applying
35882 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35883 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35884 sometimes you just want to answer the question &"Does this address have
35885 access?"& without bothering with any further details.
35886
35887 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35888 two arguments, an IP address and an email address:
35889 .code
35890 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35891 .endd
35892 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35893 given email address would be accepted in a RCPT command in a TCP/IP
35894 connection from the host with the given IP address. The output of the utility
35895 is either the word &"accepted"&, or the SMTP error response, for example:
35896 .code
35897 Rejected:
35898 550 Relay not permitted
35899 .endd
35900 When running this test, the utility uses &`<>`& as the envelope sender address
35901 for the MAIL command, but you can change this by providing additional
35902 options. These are passed directly to the Exim command. For example, to specify
35903 that the test is to be run with the sender address &'himself@there.example'&
35904 you can use:
35905 .code
35906 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35907                  -f himself@there.example
35908 .endd
35909 Note that these additional Exim command line items must be given after the two
35910 mandatory arguments.
35911
35912 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35913 while running its checks. You can run checks that include callouts by using
35914 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35915
35916
35917
35918 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35919 .cindex "DBM" "building dbm files"
35920 .cindex "building DBM files"
35921 .cindex "&'exim_dbmbuild'&"
35922 .cindex "lower casing"
35923 .cindex "binary zero" "in lookup key"
35924 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35925 the format used by the &(lsearch)& lookup (see section
35926 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35927 names as keys and the remainder of the information as data. The lower-casing
35928 can be prevented by calling the program with the &%-nolc%& option.
35929
35930 A terminating zero is included as part of the key string. This is expected by
35931 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35932 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35933 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35934 files.
35935
35936 The program requires two arguments: the name of the input file (which can be a
35937 single hyphen to indicate the standard input), and the name of the output file.
35938 It creates the output under a temporary name, and then renames it if all went
35939 well.
35940
35941 .cindex "USE_DB"
35942 If the native DB interface is in use (USE_DB is set in a compile-time
35943 configuration file &-- this is common in free versions of Unix) the two file
35944 names must be different, because in this mode the Berkeley DB functions create
35945 a single output file using exactly the name given. For example,
35946 .code
35947 exim_dbmbuild /etc/aliases /etc/aliases.db
35948 .endd
35949 reads the system alias file and creates a DBM version of it in
35950 &_/etc/aliases.db_&.
35951
35952 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35953 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35954 environment, the suffixes are added to the second argument of
35955 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35956 when the Berkeley functions are used in compatibility mode (though this is not
35957 recommended), because in that case it adds a &_.db_& suffix to the file name.
35958
35959 If a duplicate key is encountered, the program outputs a warning, and when it
35960 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35961 option is used. By default, only the first of a set of duplicates is used &--
35962 this makes it compatible with &(lsearch)& lookups. There is an option
35963 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35964 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35965 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35966 return code is 2.
35967
35968
35969
35970
35971 .section "Finding individual retry times (exinext)" "SECTfinindret"
35972 .cindex "retry" "times"
35973 .cindex "&'exinext'&"
35974 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35975 fish specific information out of the retry database. Given a mail domain (or a
35976 complete address), it looks up the hosts for that domain, and outputs any retry
35977 information for the hosts or for the domain. At present, the retry information
35978 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35979 output. For example:
35980 .code
35981 $ exinext piglet@milne.fict.example
35982 kanga.milne.example:192.168.8.1 error 146: Connection refused
35983   first failed: 21-Feb-1996 14:57:34
35984   last tried:   21-Feb-1996 14:57:34
35985   next try at:  21-Feb-1996 15:02:34
35986 roo.milne.example:192.168.8.3 error 146: Connection refused
35987   first failed: 20-Jan-1996 13:12:08
35988   last tried:   21-Feb-1996 11:42:03
35989   next try at:  21-Feb-1996 19:42:03
35990   past final cutoff time
35991 .endd
35992 You can also give &'exinext'& a local part, without a domain, and it
35993 will give any retry information for that local part in your default domain.
35994 A message id can be used to obtain retry information pertaining to a specific
35995 message. This exists only when an attempt to deliver a message to a remote host
35996 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35997 &'exinext'& is not particularly efficient, but then it is not expected to be
35998 run very often.
35999
36000 The &'exinext'& utility calls Exim to find out information such as the location
36001 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36002 passed on to the &'exim'& commands. The first specifies an alternate Exim
36003 configuration file, and the second sets macros for use within the configuration
36004 file. These features are mainly to help in testing, but might also be useful in
36005 environments where more than one configuration file is in use.
36006
36007
36008
36009 .section "Hints database maintenance" "SECThindatmai"
36010 .cindex "hints database" "maintenance"
36011 .cindex "maintaining Exim's hints database"
36012 Three utility programs are provided for maintaining the DBM files that Exim
36013 uses to contain its delivery hint information. Each program requires two
36014 arguments. The first specifies the name of Exim's spool directory, and the
36015 second is the name of the database it is to operate on. These are as follows:
36016
36017 .ilist
36018 &'retry'&: the database of retry information
36019 .next
36020 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36021 for remote hosts
36022 .next
36023 &'callout'&: the callout cache
36024 .next
36025 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36026 .next
36027 &'misc'&: other hints data
36028 .endlist
36029
36030 The &'misc'& database is used for
36031
36032 .ilist
36033 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36034 .next
36035 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36036 &(smtp)& transport)
36037 .endlist
36038
36039
36040
36041 .section "exim_dumpdb" "SECID261"
36042 .cindex "&'exim_dumpdb'&"
36043 The entire contents of a database are written to the standard output by the
36044 &'exim_dumpdb'& program, which has no options or arguments other than the
36045 spool and database names. For example, to dump the retry database:
36046 .code
36047 exim_dumpdb /var/spool/exim retry
36048 .endd
36049 Two lines of output are produced for each entry:
36050 .code
36051 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36052 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36053 .endd
36054 The first item on the first line is the key of the record. It starts with one
36055 of the letters R, or T, depending on whether it refers to a routing or
36056 transport retry. For a local delivery, the next part is the local address; for
36057 a remote delivery it is the name of the remote host, followed by its failing IP
36058 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36059 transport). If the remote port is not the standard one (port 25), it is added
36060 to the IP address. Then there follows an error code, an additional error code,
36061 and a textual description of the error.
36062
36063 The three times on the second line are the time of first failure, the time of
36064 the last delivery attempt, and the computed time for the next attempt. The line
36065 ends with an asterisk if the cutoff time for the last retry rule has been
36066 exceeded.
36067
36068 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36069 consists of a host name followed by a list of ids for messages that are or were
36070 waiting to be delivered to that host. If there are a very large number for any
36071 one host, continuation records, with a sequence number added to the host name,
36072 may be seen. The data in these records is often out of date, because a message
36073 may be routed to several alternative hosts, and Exim makes no effort to keep
36074 cross-references.
36075
36076
36077
36078 .section "exim_tidydb" "SECID262"
36079 .cindex "&'exim_tidydb'&"
36080 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36081 database. If run with no options, it removes all records that are more than 30
36082 days old. The age is calculated from the date and time that the record was last
36083 updated. Note that, in the case of the retry database, it is &'not'& the time
36084 since the first delivery failure. Information about a host that has been down
36085 for more than 30 days will remain in the database, provided that the record is
36086 updated sufficiently often.
36087
36088 The cutoff date can be altered by means of the &%-t%& option, which must be
36089 followed by a time. For example, to remove all records older than a week from
36090 the retry database:
36091 .code
36092 exim_tidydb -t 7d /var/spool/exim retry
36093 .endd
36094 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36095 message ids. In the former these appear as data in records keyed by host &--
36096 they were messages that were waiting for that host &-- and in the latter they
36097 are the keys for retry information for messages that have suffered certain
36098 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36099 message ids in database records are those of messages that are still on the
36100 queue. Message ids for messages that no longer exist are removed from
36101 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36102 For the &'retry'& database, records whose keys are non-existent message ids are
36103 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36104 whenever it removes information from the database.
36105
36106 Certain records are automatically removed by Exim when they are no longer
36107 needed, but others are not. For example, if all the MX hosts for a domain are
36108 down, a retry record is created for each one. If the primary MX host comes back
36109 first, its record is removed when Exim successfully delivers to it, but the
36110 records for the others remain because Exim has not tried to use those hosts.
36111
36112 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36113 hints databases. You should do this at a quiet time of day, because it requires
36114 a database to be locked (and therefore inaccessible to Exim) while it does its
36115 work. Removing records from a DBM file does not normally make the file smaller,
36116 but all the common DBM libraries are able to re-use the space that is released.
36117 After an initial phase of increasing in size, the databases normally reach a
36118 point at which they no longer get any bigger, as long as they are regularly
36119 tidied.
36120
36121 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36122 databases is likely to keep on increasing.
36123
36124
36125
36126
36127 .section "exim_fixdb" "SECID263"
36128 .cindex "&'exim_fixdb'&"
36129 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36130 Its main use is for testing Exim, but it might also be occasionally useful for
36131 getting round problems in a live system. It has no options, and its interface
36132 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36133 key of a database record can then be entered, and the data for that record is
36134 displayed.
36135
36136 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36137 except the &'retry'& database, that is the only operation that can be carried
36138 out. For the &'retry'& database, each field is output preceded by a number, and
36139 data for individual fields can be changed by typing the field number followed
36140 by new data, for example:
36141 .code
36142 > 4 951102:1000
36143 .endd
36144 resets the time of the next delivery attempt. Time values are given as a
36145 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36146 used as optional separators.
36147
36148
36149
36150
36151 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36152 .cindex "mailbox" "maintenance"
36153 .cindex "&'exim_lock'&"
36154 .cindex "locking mailboxes"
36155 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36156 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36157 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36158 a user agent while investigating a problem. The utility requires the name of
36159 the file as its first argument. If the locking is successful, the second
36160 argument is run as a command (using C's &[system()]& function); if there is no
36161 second argument, the value of the SHELL environment variable is used; if this
36162 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36163 is unlocked and the utility ends. The following options are available:
36164
36165 .vlist
36166 .vitem &%-fcntl%&
36167 Use &[fcntl()]& locking on the open mailbox.
36168
36169 .vitem &%-flock%&
36170 Use &[flock()]& locking on the open mailbox, provided the operating system
36171 supports it.
36172
36173 .vitem &%-interval%&
36174 This must be followed by a number, which is a number of seconds; it sets the
36175 interval to sleep between retries (default 3).
36176
36177 .vitem &%-lockfile%&
36178 Create a lock file before opening the mailbox.
36179
36180 .vitem &%-mbx%&
36181 Lock the mailbox using MBX rules.
36182
36183 .vitem &%-q%&
36184 Suppress verification output.
36185
36186 .vitem &%-retries%&
36187 This must be followed by a number; it sets the number of times to try to get
36188 the lock (default 10).
36189
36190 .vitem &%-restore_time%&
36191 This option causes &%exim_lock%& to restore the modified and read times to the
36192 locked file before exiting. This allows you to access a locked mailbox (for
36193 example, to take a backup copy) without disturbing the times that the user
36194 subsequently sees.
36195
36196 .vitem &%-timeout%&
36197 This must be followed by a number, which is a number of seconds; it sets a
36198 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36199 default), a non-blocking call is used.
36200
36201 .vitem &%-v%&
36202 Generate verbose output.
36203 .endlist
36204
36205 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36206 default is to create a lock file and also to use &[fcntl()]& locking on the
36207 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36208 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36209 requires that the directory containing the file be writeable. Locking by lock
36210 file does not last for ever; Exim assumes that a lock file is expired if it is
36211 more than 30 minutes old.
36212
36213 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36214 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36215 to be taken out on the open mailbox, and an exclusive lock on the file
36216 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36217 number of the mailbox file. When the locking is released, if an exclusive lock
36218 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36219
36220 The default output contains verification of the locking that takes place. The
36221 &%-v%& option causes some additional information to be given. The &%-q%& option
36222 suppresses all output except error messages.
36223
36224 A command such as
36225 .code
36226 exim_lock /var/spool/mail/spqr
36227 .endd
36228 runs an interactive shell while the file is locked, whereas
36229 .display
36230 &`exim_lock -q /var/spool/mail/spqr <<End`&
36231 <&'some commands'&>
36232 &`End`&
36233 .endd
36234 runs a specific non-interactive sequence of commands while the file is locked,
36235 suppressing all verification output. A single command can be run by a command
36236 such as
36237 .code
36238 exim_lock -q /var/spool/mail/spqr \
36239   "cp /var/spool/mail/spqr /some/where"
36240 .endd
36241 Note that if a command is supplied, it must be entirely contained within the
36242 second argument &-- hence the quotes.
36243 .ecindex IIDutils
36244
36245
36246 . ////////////////////////////////////////////////////////////////////////////
36247 . ////////////////////////////////////////////////////////////////////////////
36248
36249 .chapter "The Exim monitor" "CHAPeximon"
36250 .scindex IIDeximon "Exim monitor" "description"
36251 .cindex "X-windows"
36252 .cindex "&'eximon'&"
36253 .cindex "Local/eximon.conf"
36254 .cindex "&_exim_monitor/EDITME_&"
36255 The Exim monitor is an application which displays in an X window information
36256 about the state of Exim's queue and what Exim is doing. An admin user can
36257 perform certain operations on messages from this GUI interface; however all
36258 such facilities are also available from the command line, and indeed, the
36259 monitor itself makes use of the command line to perform any actions requested.
36260
36261
36262
36263 .section "Running the monitor" "SECID264"
36264 The monitor is started by running the script called &'eximon'&. This is a shell
36265 script that sets up a number of environment variables, and then runs the
36266 binary called &_eximon.bin_&. The default appearance of the monitor window can
36267 be changed by editing the &_Local/eximon.conf_& file created by editing
36268 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36269 parameters are for.
36270
36271 The parameters that get built into the &'eximon'& script can be overridden for
36272 a particular invocation by setting up environment variables of the same names,
36273 preceded by &`EXIMON_`&. For example, a shell command such as
36274 .code
36275 EXIMON_LOG_DEPTH=400 eximon
36276 .endd
36277 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36278 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36279 overrides the Exim log file configuration. This makes it possible to have
36280 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36281 syslog messages are routed to a file on the local host.
36282
36283 X resources can be used to change the appearance of the window in the normal
36284 way. For example, a resource setting of the form
36285 .code
36286 Eximon*background: gray94
36287 .endd
36288 changes the colour of the background to light grey rather than white. The
36289 stripcharts are drawn with both the data lines and the reference lines in
36290 black. This means that the reference lines are not visible when on top of the
36291 data. However, their colour can be changed by setting a resource called
36292 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36293 For example, if your X server is running Unix, you could set up lighter
36294 reference lines in the stripcharts by obeying
36295 .code
36296 xrdb -merge <<End
36297 Eximon*highlight: gray
36298 End
36299 .endd
36300 .cindex "admin user"
36301 In order to see the contents of messages on the queue, and to operate on them,
36302 &'eximon'& must either be run as root or by an admin user.
36303
36304 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36305 contain X11 resource parameters interpreted by the X11 library.  In addition,
36306 if the first parameter starts with the string "gdb" then it is removed and the
36307 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36308 versioned variants of gdb can be invoked).
36309
36310 The monitor's window is divided into three parts. The first contains one or
36311 more stripcharts and two action buttons, the second contains a &"tail"& of the
36312 main log file, and the third is a display of the queue of messages awaiting
36313 delivery, with two more action buttons. The following sections describe these
36314 different parts of the display.
36315
36316
36317
36318
36319 .section "The stripcharts" "SECID265"
36320 .cindex "stripchart"
36321 The first stripchart is always a count of messages on the queue. Its name can
36322 be configured by setting QUEUE_STRIPCHART_NAME in the
36323 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36324 configuration script by regular expression matches on log file entries, making
36325 it possible to display, for example, counts of messages delivered to certain
36326 hosts or using certain transports. The supplied defaults display counts of
36327 received and delivered messages, and of local and SMTP deliveries. The default
36328 period between stripchart updates is one minute; this can be adjusted by a
36329 parameter in the &_Local/eximon.conf_& file.
36330
36331 The stripchart displays rescale themselves automatically as the value they are
36332 displaying changes. There are always 10 horizontal lines in each chart; the
36333 title string indicates the value of each division when it is greater than one.
36334 For example, &"x2"& means that each division represents a value of 2.
36335
36336 It is also possible to have a stripchart which shows the percentage fullness of
36337 a particular disk partition, which is useful when local deliveries are confined
36338 to a single partition.
36339
36340 .cindex "&%statvfs%& function"
36341 This relies on the availability of the &[statvfs()]& function or equivalent in
36342 the operating system. Most, but not all versions of Unix that support Exim have
36343 this. For this particular stripchart, the top of the chart always represents
36344 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36345 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36346 &_Local/eximon.conf_& file.
36347
36348
36349
36350
36351 .section "Main action buttons" "SECID266"
36352 .cindex "size" "of monitor window"
36353 .cindex "Exim monitor" "window size"
36354 .cindex "window size"
36355 Below the stripcharts there is an action button for quitting the monitor. Next
36356 to this is another button marked &"Size"&. They are placed here so that
36357 shrinking the window to its default minimum size leaves just the queue count
36358 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36359 the window to expand to its maximum size, unless it is already at the maximum,
36360 in which case it is reduced to its minimum.
36361
36362 When expanding to the maximum, if the window cannot be fully seen where it
36363 currently is, it is moved back to where it was the last time it was at full
36364 size. When it is expanding from its minimum size, the old position is
36365 remembered, and next time it is reduced to the minimum it is moved back there.
36366
36367 The idea is that you can keep a reduced window just showing one or two
36368 stripcharts at a convenient place on your screen, easily expand it to show
36369 the full window when required, and just as easily put it back to what it was.
36370 The idea is copied from what the &'twm'& window manager does for its
36371 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36372 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36373
36374 Normally, the monitor starts up with the window at its full size, but it can be
36375 built so that it starts up with the window at its smallest size, by setting
36376 START_SMALL=yes in &_Local/eximon.conf_&.
36377
36378
36379
36380 .section "The log display" "SECID267"
36381 .cindex "log" "tail of; in monitor"
36382 The second section of the window is an area in which a display of the tail of
36383 the main log is maintained.
36384 To save space on the screen, the timestamp on each log line is shortened by
36385 removing the date and, if &%log_timezone%& is set, the timezone.
36386 The log tail is not available when the only destination for logging data is
36387 syslog, unless the syslog lines are routed to a local file whose name is passed
36388 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36389
36390 The log sub-window has a scroll bar at its lefthand side which can be used to
36391 move back to look at earlier text, and the up and down arrow keys also have a
36392 scrolling effect. The amount of log that is kept depends on the setting of
36393 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36394 to use. When this is full, the earlier 50% of data is discarded &-- this is
36395 much more efficient than throwing it away line by line. The sub-window also has
36396 a horizontal scroll bar for accessing the ends of long log lines. This is the
36397 only means of horizontal scrolling; the right and left arrow keys are not
36398 available. Text can be cut from this part of the window using the mouse in the
36399 normal way. The size of this subwindow is controlled by parameters in the
36400 configuration file &_Local/eximon.conf_&.
36401
36402 Searches of the text in the log window can be carried out by means of the ^R
36403 and ^S keystrokes, which default to a reverse and a forward search,
36404 respectively. The search covers only the text that is displayed in the window.
36405 It cannot go further back up the log.
36406
36407 The point from which the search starts is indicated by a caret marker. This is
36408 normally at the end of the text in the window, but can be positioned explicitly
36409 by pointing and clicking with the left mouse button, and is moved automatically
36410 by a successful search. If new text arrives in the window when it is scrolled
36411 back, the caret remains where it is, but if the window is not scrolled back,
36412 the caret is moved to the end of the new text.
36413
36414 Pressing ^R or ^S pops up a window into which the search text can be typed.
36415 There are buttons for selecting forward or reverse searching, for carrying out
36416 the search, and for cancelling. If the &"Search"& button is pressed, the search
36417 happens and the window remains so that further searches can be done. If the
36418 &"Return"& key is pressed, a single search is done and the window is closed. If
36419 ^C is typed the search is cancelled.
36420
36421 The searching facility is implemented using the facilities of the Athena text
36422 widget. By default this pops up a window containing both &"search"& and
36423 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36424 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36425 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36426 provided version of &%TextPop%& when the remaining parts of the text widget
36427 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36428 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36429 on these systems, at the expense of having unwanted items in the search popup
36430 window.
36431
36432
36433
36434 .section "The queue display" "SECID268"
36435 .cindex "queue" "display in monitor"
36436 The bottom section of the monitor window contains a list of all messages that
36437 are on the queue, which includes those currently being received or delivered,
36438 as well as those awaiting delivery. The size of this subwindow is controlled by
36439 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36440 at which it is updated is controlled by another parameter in the same file &--
36441 the default is 5 minutes, since queue scans can be quite expensive. However,
36442 there is an &"Update"& action button just above the display which can be used
36443 to force an update of the queue display at any time.
36444
36445 When a host is down for some time, a lot of pending mail can build up for it,
36446 and this can make it hard to deal with other messages on the queue. To help
36447 with this situation there is a button next to &"Update"& called &"Hide"&. If
36448 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36449 type anything in here and press &"Return"&, the text is added to a chain of
36450 such texts, and if every undelivered address in a message matches at least one
36451 of the texts, the message is not displayed.
36452
36453 If there is an address that does not match any of the texts, all the addresses
36454 are displayed as normal. The matching happens on the ends of addresses so, for
36455 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36456 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36457 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36458 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36459 a hide request is automatically cancelled after one hour.
36460
36461 While the dialogue box is displayed, you can't press any buttons or do anything
36462 else to the monitor window. For this reason, if you want to cut text from the
36463 queue display to use in the dialogue box, you have to do the cutting before
36464 pressing the &"Hide"& button.
36465
36466 The queue display contains, for each unhidden queued message, the length of
36467 time it has been on the queue, the size of the message, the message id, the
36468 message sender, and the first undelivered recipient, all on one line. If it is
36469 a bounce message, the sender is shown as &"<>"&. If there is more than one
36470 recipient to which the message has not yet been delivered, subsequent ones are
36471 listed on additional lines, up to a maximum configured number, following which
36472 an ellipsis is displayed. Recipients that have already received the message are
36473 not shown.
36474
36475 .cindex "frozen messages" "display"
36476 If a message is frozen, an asterisk is displayed at the left-hand side.
36477
36478 The queue display has a vertical scroll bar, and can also be scrolled by means
36479 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36480 The text searching facilities, as described above for the log window, are also
36481 available, but the caret is always moved to the end of the text when the queue
36482 display is updated.
36483
36484
36485
36486 .section "The queue menu" "SECID269"
36487 .cindex "queue" "menu in monitor"
36488 If the &%shift%& key is held down and the left button is clicked when the mouse
36489 pointer is over the text for any message, an action menu pops up, and the first
36490 line of the queue display for the message is highlighted. This does not affect
36491 any selected text.
36492
36493 If you want to use some other event for popping up the menu, you can set the
36494 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36495 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36496 value set in this parameter is a standard X event description. For example, to
36497 run eximon using &%ctrl%& rather than &%shift%& you could use
36498 .code
36499 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36500 .endd
36501 The title of the menu is the message id, and it contains entries which act as
36502 follows:
36503
36504 .ilist
36505 &'message log'&: The contents of the message log for the message are displayed
36506 in a new text window.
36507 .next
36508 &'headers'&: Information from the spool file that contains the envelope
36509 information and headers is displayed in a new text window. See chapter
36510 &<<CHAPspool>>& for a description of the format of spool files.
36511 .next
36512 &'body'&: The contents of the spool file containing the body of the message are
36513 displayed in a new text window. There is a default limit of 20,000 bytes to the
36514 amount of data displayed. This can be changed by setting the BODY_MAX
36515 option at compile time, or the EXIMON_BODY_MAX option at run time.
36516 .next
36517 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36518 delivery of the message. This causes an automatic thaw if the message is
36519 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36520 a new text window. The delivery is run in a separate process, to avoid holding
36521 up the monitor while the delivery proceeds.
36522 .next
36523 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36524 that the message be frozen.
36525 .next
36526 .cindex "thawing messages"
36527 .cindex "unfreezing messages"
36528 .cindex "frozen messages" "thawing"
36529 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36530 that the message be thawed.
36531 .next
36532 .cindex "delivery" "forcing failure"
36533 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36534 that Exim gives up trying to deliver the message. A bounce message is generated
36535 for any remaining undelivered addresses.
36536 .next
36537 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36538 that the message be deleted from the system without generating a bounce
36539 message.
36540 .next
36541 &'add recipient'&: A dialog box is displayed into which a recipient address can
36542 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36543 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36544 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36545 causes a call to Exim to be made using the &%-Mar%& option to request that an
36546 additional recipient be added to the message, unless the entry box is empty, in
36547 which case no action is taken.
36548 .next
36549 &'mark delivered'&: A dialog box is displayed into which a recipient address
36550 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36551 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36552 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36553 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36554 recipient address as already delivered, unless the entry box is empty, in which
36555 case no action is taken.
36556 .next
36557 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36558 mark all recipient addresses as already delivered.
36559 .next
36560 &'edit sender'&: A dialog box is displayed initialized with the current
36561 sender's address. Pressing RETURN causes a call to Exim to be made using the
36562 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36563 in which case no action is taken. If you want to set an empty sender (as in
36564 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36565 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36566 the address is qualified with that domain.
36567 .endlist
36568
36569 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36570 other cases when a call to Exim is made, if there is any output from Exim (in
36571 particular, if the command fails) a window containing the command and the
36572 output is displayed. Otherwise, the results of the action are normally apparent
36573 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36574 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36575 if no output is generated.
36576
36577 The queue display is automatically updated for actions such as freezing and
36578 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36579 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36580 force an update of the display after one of these actions.
36581
36582 In any text window that is displayed as result of a menu action, the normal
36583 cut-and-paste facility is available, and searching can be carried out using ^R
36584 and ^S, as described above for the log tail window.
36585 .ecindex IIDeximon
36586
36587
36588
36589
36590
36591 . ////////////////////////////////////////////////////////////////////////////
36592 . ////////////////////////////////////////////////////////////////////////////
36593
36594 .chapter "Security considerations" "CHAPsecurity"
36595 .scindex IIDsecurcon "security" "discussion of"
36596 This chapter discusses a number of issues concerned with security, some of
36597 which are also covered in other parts of this manual.
36598
36599 For reasons that this author does not understand, some people have promoted
36600 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36601 existence of this chapter in the documentation. However, the intent of the
36602 chapter is simply to describe the way Exim works in relation to certain
36603 security concerns, not to make any specific claims about the effectiveness of
36604 its security as compared with other MTAs.
36605
36606 What follows is a description of the way Exim is supposed to be. Best efforts
36607 have been made to try to ensure that the code agrees with the theory, but an
36608 absence of bugs can never be guaranteed. Any that are reported will get fixed
36609 as soon as possible.
36610
36611
36612 .section "Building a more &""hardened""& Exim" "SECID286"
36613 .cindex "security" "build-time features"
36614 There are a number of build-time options that can be set in &_Local/Makefile_&
36615 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36616 Exim administrator who does not have the root password, or by someone who has
36617 penetrated the Exim (but not the root) account. These options are as follows:
36618
36619 .ilist
36620 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36621 start of any file names used with the &%-C%& option. When it is set, these file
36622 names are also not allowed to contain the sequence &"/../"&. (However, if the
36623 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36624 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36625 default setting for &%ALT_CONFIG_PREFIX%&.
36626
36627 If the permitted configuration files are confined to a directory to
36628 which only root has access, this guards against someone who has broken
36629 into the Exim account from running a privileged Exim with an arbitrary
36630 configuration file, and using it to break into other accounts.
36631 .next
36632
36633 If a non-trusted configuration file (i.e. not the default configuration file
36634 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36635 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36636 the next item), then root privilege is retained only if the caller of Exim is
36637 root. This locks out the possibility of testing a configuration using &%-C%&
36638 right through message reception and delivery, even if the caller is root. The
36639 reception works, but by that time, Exim is running as the Exim user, so when
36640 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36641 privilege to be lost. However, root can test reception and delivery using two
36642 separate commands.
36643
36644 .next
36645 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36646 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36647 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36648 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36649 the restrictive side.  Requiring build-time selection of safe macros is onerous
36650 but this option is intended solely as a transition mechanism to permit
36651 previously-working configurations to continue to work after release 4.73.
36652 .next
36653 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36654 is disabled.
36655 .next
36656 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36657 never to be used for any deliveries. This is like the &%never_users%& runtime
36658 option, but it cannot be overridden; the runtime option adds additional users
36659 to the list. The default setting is &"root"&; this prevents a non-root user who
36660 is permitted to modify the runtime file from using Exim as a way to get root.
36661 .endlist
36662
36663
36664
36665 .section "Root privilege" "SECID270"
36666 .cindex "setuid"
36667 .cindex "root privilege"
36668 The Exim binary is normally setuid to root, which means that it gains root
36669 privilege (runs as root) when it starts execution. In some special cases (for
36670 example, when the daemon is not in use and there are no local deliveries), it
36671 may be possible to run Exim setuid to some user other than root. This is
36672 discussed in the next section. However, in most installations, root privilege
36673 is required for two things:
36674
36675 .ilist
36676 To set up a socket connected to the standard SMTP port (25) when initialising
36677 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36678 not required.
36679 .next
36680 To be able to change uid and gid in order to read users' &_.forward_& files and
36681 perform local deliveries as the receiving user or as specified in the
36682 configuration.
36683 .endlist
36684
36685 It is not necessary to be root to do any of the other things Exim does, such as
36686 receiving messages and delivering them externally over SMTP, and it is
36687 obviously more secure if Exim does not run as root except when necessary.
36688 For this reason, a user and group for Exim to use must be defined in
36689 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36690 group"&. Their values can be changed by the run time configuration, though this
36691 is not recommended. Often a user called &'exim'& is used, but some sites use
36692 &'mail'& or another user name altogether.
36693
36694 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36695 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36696 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36697
36698 After a new Exim process has interpreted its command line options, it changes
36699 uid and gid in the following cases:
36700
36701 .ilist
36702 .oindex "&%-C%&"
36703 .oindex "&%-D%&"
36704 If the &%-C%& option is used to specify an alternate configuration file, or if
36705 the &%-D%& option is used to define macro values for the configuration, and the
36706 calling process is not running as root, the uid and gid are changed to those of
36707 the calling process.
36708 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36709 option may not be used at all.
36710 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36711 can be supplied if the calling process is running as root, the Exim run-time
36712 user or CONFIGURE_OWNER, if defined.
36713 .next
36714 .oindex "&%-be%&"
36715 .oindex "&%-bf%&"
36716 .oindex "&%-bF%&"
36717 If the expansion test option (&%-be%&) or one of the filter testing options
36718 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36719 calling process.
36720 .next
36721 If the process is not a daemon process or a queue runner process or a delivery
36722 process or a process for testing address routing (started with &%-bt%&), the
36723 uid and gid are changed to the Exim user and group. This means that Exim always
36724 runs under its own uid and gid when receiving messages. This also applies when
36725 testing address verification
36726 .oindex "&%-bv%&"
36727 .oindex "&%-bh%&"
36728 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36729 option).
36730 .next
36731 For a daemon, queue runner, delivery, or address testing process, the uid
36732 remains as root at this stage, but the gid is changed to the Exim group.
36733 .endlist
36734
36735 The processes that initially retain root privilege behave as follows:
36736
36737 .ilist
36738 A daemon process changes the gid to the Exim group and the uid to the Exim
36739 user after setting up one or more listening sockets. The &[initgroups()]&
36740 function is called, so that if the Exim user is in any additional groups, they
36741 will be used during message reception.
36742 .next
36743 A queue runner process retains root privilege throughout its execution. Its
36744 job is to fork a controlled sequence of delivery processes.
36745 .next
36746 A delivery process retains root privilege throughout most of its execution,
36747 but any actual deliveries (that is, the transports themselves) are run in
36748 subprocesses which always change to a non-root uid and gid. For local
36749 deliveries this is typically the uid and gid of the owner of the mailbox; for
36750 remote deliveries, the Exim uid and gid are used. Once all the delivery
36751 subprocesses have been run, a delivery process changes to the Exim uid and gid
36752 while doing post-delivery tidying up such as updating the retry database and
36753 generating bounce and warning messages.
36754
36755 While the recipient addresses in a message are being routed, the delivery
36756 process runs as root. However, if a user's filter file has to be processed,
36757 this is done in a subprocess that runs under the individual user's uid and
36758 gid. A system filter is run as root unless &%system_filter_user%& is set.
36759 .next
36760 A process that is testing addresses (the &%-bt%& option) runs as root so that
36761 the routing is done in the same environment as a message delivery.
36762 .endlist
36763
36764
36765
36766
36767 .section "Running Exim without privilege" "SECTrunexiwitpri"
36768 .cindex "privilege, running without"
36769 .cindex "unprivileged running"
36770 .cindex "root privilege" "running without"
36771 Some installations like to run Exim in an unprivileged state for more of its
36772 operation, for added security. Support for this mode of operation is provided
36773 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36774 gid are changed to the Exim user and group at the start of a delivery process
36775 (and also queue runner and address testing processes). This means that address
36776 routing is no longer run as root, and the deliveries themselves cannot change
36777 to any other uid.
36778
36779 .cindex SIGHUP
36780 .cindex "daemon" "restarting"
36781 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36782 that the daemon can still be started in the usual way, and it can respond
36783 correctly to SIGHUP because the re-invocation regains root privilege.
36784
36785 An alternative approach is to make Exim setuid to the Exim user and also setgid
36786 to the Exim group. If you do this, the daemon must be started from a root
36787 process. (Calling Exim from a root process makes it behave in the way it does
36788 when it is setuid root.) However, the daemon cannot restart itself after a
36789 SIGHUP signal because it cannot regain privilege.
36790
36791 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36792 stops Exim from trying to re-invoke itself to do a delivery after a message has
36793 been received. Such a re-invocation is a waste of resources because it has no
36794 effect.
36795
36796 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36797 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36798 to the Exim user seems a clean approach, but there is one complication:
36799
36800 In this style of operation, Exim is running with the real uid and gid set to
36801 those of the calling process, and the effective uid/gid set to Exim's values.
36802 Ideally, any association with the calling process' uid/gid should be dropped,
36803 that is, the real uid/gid should be reset to the effective values so as to
36804 discard any privileges that the caller may have. While some operating systems
36805 have a function that permits this action for a non-root effective uid, quite a
36806 number of them do not. Because of this lack of standardization, Exim does not
36807 address this problem at this time.
36808
36809 For this reason, the recommended approach for &"mostly unprivileged"& running
36810 is to keep the Exim binary setuid to root, and to set
36811 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36812 be used in the most straightforward way.
36813
36814 If you configure Exim not to run delivery processes as root, there are a
36815 number of restrictions on what you can do:
36816
36817 .ilist
36818 You can deliver only as the Exim user/group. You should  explicitly use the
36819 &%user%& and &%group%& options to override routers or local transports that
36820 normally deliver as the recipient. This makes sure that configurations that
36821 work in this mode function the same way in normal mode. Any implicit or
36822 explicit specification of another user causes an error.
36823 .next
36824 Use of &_.forward_& files is severely restricted, such that it is usually
36825 not worthwhile to include them in the configuration.
36826 .next
36827 Users who wish to use &_.forward_& would have to make their home directory and
36828 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36829 and their equivalents in Exim filters, cannot be used. While they could be
36830 enabled in the Exim user's name, that would be insecure and not very useful.
36831 .next
36832 Unless the local user mailboxes are all owned by the Exim user (possible in
36833 some POP3 or IMAP-only environments):
36834
36835 .olist
36836 They must be owned by the Exim group and be writeable by that group. This
36837 implies you must set &%mode%& in the appendfile configuration, as well as the
36838 mode of the mailbox files themselves.
36839 .next
36840 You must set &%no_check_owner%&, since most or all of the files will not be
36841 owned by the Exim user.
36842 .next
36843 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36844 on a newly created mailbox when unprivileged. This also implies that new
36845 mailboxes need to be created manually.
36846 .endlist olist
36847 .endlist ilist
36848
36849
36850 These restrictions severely restrict what can be done in local deliveries.
36851 However, there are no restrictions on remote deliveries. If you are running a
36852 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36853 gives more security at essentially no cost.
36854
36855 If you are using the &%mua_wrapper%& facility (see chapter
36856 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36857
36858
36859
36860
36861 .section "Delivering to local files" "SECID271"
36862 Full details of the checks applied by &(appendfile)& before it writes to a file
36863 are given in chapter &<<CHAPappendfile>>&.
36864
36865
36866
36867 .section "Running local commands" "SECTsecconslocalcmds"
36868 .cindex "security" "local commands"
36869 .cindex "security" "command injection attacks"
36870 There are a number of ways in which an administrator can configure Exim to run
36871 commands based upon received, untrustworthy, data. Further, in some
36872 configurations a user who can control a &_.forward_& file can also arrange to
36873 run commands. Configuration to check includes, but is not limited to:
36874
36875 .ilist
36876 Use of &%use_shell%& in the pipe transport: various forms of shell command
36877 injection may be possible with this option present. It is dangerous and should
36878 be used only with considerable caution. Consider constraints which whitelist
36879 allowed characters in a variable which is to be used in a pipe transport that
36880 has &%use_shell%& enabled.
36881 .next
36882 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36883 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36884 &_.forward_& files in a redirect router. If Exim is running on a central mail
36885 hub to which ordinary users do not have shell access, but home directories are
36886 NFS mounted (for instance) then administrators should review the list of these
36887 forbid options available, and should bear in mind that the options that may
36888 need forbidding can change as new features are added between releases.
36889 .next
36890 The &%${run...}%& expansion item does not use a shell by default, but
36891 administrators can configure use of &_/bin/sh_& as part of the command.
36892 Such invocations should be viewed with prejudicial suspicion.
36893 .next
36894 Administrators who use embedded Perl are advised to explore how Perl's
36895 taint checking might apply to their usage.
36896 .next
36897 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36898 administrators are well advised to view its use with suspicion, in case (for
36899 instance) it allows a local-part to contain embedded Exim directives.
36900 .next
36901 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36902 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36903 each can reference arbitrary lists and files, rather than just being a list
36904 of opaque strings.
36905 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36906 real-world security vulnerabilities caused by its use with untrustworthy data
36907 injected in, for SQL injection attacks.
36908 Consider the use of the &%inlisti%& expansion condition instead.
36909 .endlist
36910
36911
36912
36913
36914 .section "Trust in configuration data" "SECTsecconfdata"
36915 .cindex "security" "data sources"
36916 .cindex "security" "regular expressions"
36917 .cindex "regular expressions" "security"
36918 .cindex "PCRE" "security"
36919 If configuration data for Exim can come from untrustworthy sources, there
36920 are some issues to be aware of:
36921
36922 .ilist
36923 Use of &%${expand...}%& may provide a path for shell injection attacks.
36924 .next
36925 Letting untrusted data provide a regular expression is unwise.
36926 .next
36927 Using &%${match...}%& to apply a fixed regular expression against untrusted
36928 data may result in pathological behaviour within PCRE.  Be aware of what
36929 "backtracking" means and consider options for being more strict with a regular
36930 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36931 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36932 possessive quantifiers or just not using regular expressions against untrusted
36933 data.
36934 .next
36935 It can be important to correctly use &%${quote:...}%&,
36936 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36937 items to ensure that data is correctly constructed.
36938 .next
36939 Some lookups might return multiple results, even though normal usage is only
36940 expected to yield one result.
36941 .endlist
36942
36943
36944
36945
36946 .section "IPv4 source routing" "SECID272"
36947 .cindex "source routing" "in IP packets"
36948 .cindex "IP source routing"
36949 Many operating systems suppress IP source-routed packets in the kernel, but
36950 some cannot be made to do this, so Exim does its own check. It logs incoming
36951 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36952 IPv6. No special checking is currently done.
36953
36954
36955
36956 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36957 Support for these SMTP commands is disabled by default. If required, they can
36958 be enabled by defining suitable ACLs.
36959
36960
36961
36962
36963 .section "Privileged users" "SECID274"
36964 .cindex "trusted users"
36965 .cindex "admin user"
36966 .cindex "privileged user"
36967 .cindex "user" "trusted"
36968 .cindex "user" "admin"
36969 Exim recognizes two sets of users with special privileges. Trusted users are
36970 able to submit new messages to Exim locally, but supply their own sender
36971 addresses and information about a sending host. For other users submitting
36972 local messages, Exim sets up the sender address from the uid, and doesn't
36973 permit a remote host to be specified.
36974
36975 .oindex "&%-f%&"
36976 However, an untrusted user is permitted to use the &%-f%& command line option
36977 in the special form &%-f <>%& to indicate that a delivery failure for the
36978 message should not cause an error report. This affects the message's envelope,
36979 but it does not affect the &'Sender:'& header. Untrusted users may also be
36980 permitted to use specific forms of address with the &%-f%& option by setting
36981 the &%untrusted_set_sender%& option.
36982
36983 Trusted users are used to run processes that receive mail messages from some
36984 other mail domain and pass them on to Exim for delivery either locally, or over
36985 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36986 as any user listed in the &%trusted_users%& configuration option, or under any
36987 group listed in the &%trusted_groups%& option.
36988
36989 Admin users are permitted to do things to the messages on Exim's queue. They
36990 can freeze or thaw messages, cause them to be returned to their senders, remove
36991 them entirely, or modify them in various ways. In addition, admin users can run
36992 the Exim monitor and see all the information it is capable of providing, which
36993 includes the contents of files on the spool.
36994
36995 .oindex "&%-M%&"
36996 .oindex "&%-q%&"
36997 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36998 delivery of messages on its queue is restricted to admin users. This
36999 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37000 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37001 queue is also restricted to admin users. This restriction can be relaxed by
37002 setting &%no_queue_list_requires_admin%&.
37003
37004 Exim recognizes an admin user if the calling process is running as root or as
37005 the Exim user or if any of the groups associated with the calling process is
37006 the Exim group. It is not necessary actually to be running under the Exim
37007 group. However, if admin users who are not root or the Exim user are to access
37008 the contents of files on the spool via the Exim monitor (which runs
37009 unprivileged), Exim must be built to allow group read access to its spool
37010 files.
37011
37012
37013
37014 .section "Spool files" "SECID275"
37015 .cindex "spool directory" "files"
37016 Exim's spool directory and everything it contains is owned by the Exim user and
37017 set to the Exim group. The mode for spool files is defined in the
37018 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37019 any user who is a member of the Exim group can access these files.
37020
37021
37022
37023 .section "Use of argv[0]" "SECID276"
37024 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37025 of specific strings, Exim assumes certain options. For example, calling Exim
37026 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37027 to calling it with the option &%-bS%&. There are no security implications in
37028 this.
37029
37030
37031
37032 .section "Use of %f formatting" "SECID277"
37033 The only use made of &"%f"& by Exim is in formatting load average values. These
37034 are actually stored in integer variables as 1000 times the load average.
37035 Consequently, their range is limited and so therefore is the length of the
37036 converted output.
37037
37038
37039
37040 .section "Embedded Exim path" "SECID278"
37041 Exim uses its own path name, which is embedded in the code, only when it needs
37042 to re-exec in order to regain root privilege. Therefore, it is not root when it
37043 does so. If some bug allowed the path to get overwritten, it would lead to an
37044 arbitrary program's being run as exim, not as root.
37045
37046
37047
37048 .section "Dynamic module directory" "SECTdynmoddir"
37049 Any dynamically loadable modules must be installed into the directory
37050 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37051 loading it.
37052
37053
37054 .section "Use of sprintf()" "SECID279"
37055 .cindex "&[sprintf()]&"
37056 A large number of occurrences of &"sprintf"& in the code are actually calls to
37057 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37058 The intermediate formatting is done into a large fixed buffer by a function
37059 that runs through the format string itself, and checks the length of each
37060 conversion before performing it, thus preventing buffer overruns.
37061
37062 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37063 the output buffer is known to be sufficiently long to contain the converted
37064 string.
37065
37066
37067
37068 .section "Use of debug_printf() and log_write()" "SECID280"
37069 Arbitrary strings are passed to both these functions, but they do their
37070 formatting by calling the function &'string_vformat()'&, which runs through
37071 the format string itself, and checks the length of each conversion.
37072
37073
37074
37075 .section "Use of strcat() and strcpy()" "SECID281"
37076 These are used only in cases where the output buffer is known to be large
37077 enough to hold the result.
37078 .ecindex IIDsecurcon
37079
37080
37081
37082
37083 . ////////////////////////////////////////////////////////////////////////////
37084 . ////////////////////////////////////////////////////////////////////////////
37085
37086 .chapter "Format of spool files" "CHAPspool"
37087 .scindex IIDforspo1 "format" "spool files"
37088 .scindex IIDforspo2 "spool directory" "format of files"
37089 .scindex IIDforspo3 "spool files" "format of"
37090 .cindex "spool files" "editing"
37091 A message on Exim's queue consists of two files, whose names are the message id
37092 followed by -D and -H, respectively. The data portion of the message is kept in
37093 the -D file on its own. The message's envelope, status, and headers are all
37094 kept in the -H file, whose format is described in this chapter. Each of these
37095 two files contains the final component of its own name as its first line. This
37096 is insurance against disk crashes where the directory is lost but the files
37097 themselves are recoverable.
37098
37099 Some people are tempted into editing -D files in order to modify messages. You
37100 need to be extremely careful if you do this; it is not recommended and you are
37101 on your own if you do it. Here are some of the pitfalls:
37102
37103 .ilist
37104 You must ensure that Exim does not try to deliver the message while you are
37105 fiddling with it. The safest way is to take out a write lock on the -D file,
37106 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37107 place, the lock will be retained. If you write a new file and rename it, the
37108 lock will be lost at the instant of rename.
37109 .next
37110 .vindex "&$body_linecount$&"
37111 If you change the number of lines in the file, the value of
37112 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37113 present, this value is not used by Exim, but there is no guarantee that this
37114 will always be the case.
37115 .next
37116 If the message is in MIME format, you must take care not to break it.
37117 .next
37118 If the message is cryptographically signed, any change will invalidate the
37119 signature.
37120 .endlist
37121 All in all, modifying -D files is fraught with danger.
37122
37123 Files whose names end with -J may also be seen in the &_input_& directory (or
37124 its subdirectories when &%split_spool_directory%& is set). These are journal
37125 files, used to record addresses to which the message has been delivered during
37126 the course of a delivery attempt. If there are still undelivered recipients at
37127 the end, the -H file is updated, and the -J file is deleted. If, however, there
37128 is some kind of crash (for example, a power outage) before this happens, the -J
37129 file remains in existence. When Exim next processes the message, it notices the
37130 -J file and uses it to update the -H file before starting the next delivery
37131 attempt.
37132
37133 .section "Format of the -H file" "SECID282"
37134 .cindex "uid (user id)" "in spool file"
37135 .cindex "gid (group id)" "in spool file"
37136 The second line of the -H file contains the login name for the uid of the
37137 process that called Exim to read the message, followed by the numerical uid and
37138 gid. For a locally generated message, this is normally the user who sent the
37139 message. For a message received over TCP/IP via the daemon, it is
37140 normally the Exim user.
37141
37142 The third line of the file contains the address of the message's sender as
37143 transmitted in the envelope, contained in angle brackets. The sender address is
37144 empty for bounce messages. For incoming SMTP mail, the sender address is given
37145 in the MAIL command. For locally generated mail, the sender address is
37146 created by Exim from the login name of the current user and the configured
37147 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37148 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37149 &"<>"& or an address that matches &%untrusted_set_senders%&.
37150
37151 The fourth line contains two numbers. The first is the time that the message
37152 was received, in the conventional Unix form &-- the number of seconds since the
37153 start of the epoch. The second number is a count of the number of messages
37154 warning of delayed delivery that have been sent to the sender.
37155
37156 There follow a number of lines starting with a hyphen. These can appear in any
37157 order, and are omitted when not relevant:
37158
37159 .vlist
37160 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37161 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37162 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37163 recognized, to provide backward compatibility. In the old format, a line of
37164 this form is present for every ACL variable that is not empty. The number
37165 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37166 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37167 the data string for the variable. The string itself starts at the beginning of
37168 the next line, and is followed by a newline character. It may contain internal
37169 newlines.
37170
37171 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37172 A line of this form is present for every ACL connection variable that is
37173 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37174 The length is the length of the data string for the variable. The string itself
37175 starts at the beginning of the next line, and is followed by a newline
37176 character. It may contain internal newlines.
37177
37178 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37179 A line of this form is present for every ACL message variable that is defined.
37180 Note that there is a space between &%-aclm%& and the rest of the name. The
37181 length is the length of the data string for the variable. The string itself
37182 starts at the beginning of the next line, and is followed by a newline
37183 character. It may contain internal newlines.
37184
37185 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37186 This is present if, when the message was received over SMTP, the value of
37187 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37188
37189 .vitem &%-allow_unqualified_recipient%&
37190 This is present if unqualified recipient addresses are permitted in header
37191 lines (to stop such addresses from being qualified if rewriting occurs at
37192 transport time). Local messages that were input using &%-bnq%& and remote
37193 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37194
37195 .vitem &%-allow_unqualified_sender%&
37196 This is present if unqualified sender addresses are permitted in header lines
37197 (to stop such addresses from being qualified if rewriting occurs at transport
37198 time). Local messages that were input using &%-bnq%& and remote messages from
37199 hosts that match &%sender_unqualified_hosts%& set this flag.
37200
37201 .vitem "&%-auth_id%&&~<&'text'&>"
37202 The id information for a message received on an authenticated SMTP connection
37203 &-- the value of the &$authenticated_id$& variable.
37204
37205 .vitem "&%-auth_sender%&&~<&'address'&>"
37206 The address of an authenticated sender &-- the value of the
37207 &$authenticated_sender$& variable.
37208
37209 .vitem "&%-body_linecount%&&~<&'number'&>"
37210 This records the number of lines in the body of the message, and is always
37211 present.
37212
37213 .vitem "&%-body_zerocount%&&~<&'number'&>"
37214 This records the number of binary zero bytes in the body of the message, and is
37215 present if the number is greater than zero.
37216
37217 .vitem &%-deliver_firsttime%&
37218 This is written when a new message is first added to the spool. When the spool
37219 file is updated after a deferral, it is omitted.
37220
37221 .vitem "&%-frozen%&&~<&'time'&>"
37222 .cindex "frozen messages" "spool data"
37223 The message is frozen, and the freezing happened at <&'time'&>.
37224
37225 .vitem "&%-helo_name%&&~<&'text'&>"
37226 This records the host name as specified by a remote host in a HELO or EHLO
37227 command.
37228
37229 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37230 This records the IP address of the host from which the message was received and
37231 the remote port number that was used. It is omitted for locally generated
37232 messages.
37233
37234 .vitem "&%-host_auth%&&~<&'text'&>"
37235 If the message was received on an authenticated SMTP connection, this records
37236 the name of the authenticator &-- the value of the
37237 &$sender_host_authenticated$& variable.
37238
37239 .vitem &%-host_lookup_failed%&
37240 This is present if an attempt to look up the sending host's name from its IP
37241 address failed. It corresponds to the &$host_lookup_failed$& variable.
37242
37243 .vitem "&%-host_name%&&~<&'text'&>"
37244 .cindex "reverse DNS lookup"
37245 .cindex "DNS" "reverse lookup"
37246 This records the name of the remote host from which the message was received,
37247 if the host name was looked up from the IP address when the message was being
37248 received. It is not present if no reverse lookup was done.
37249
37250 .vitem "&%-ident%&&~<&'text'&>"
37251 For locally submitted messages, this records the login of the originating user,
37252 unless it was a trusted user and the &%-oMt%& option was used to specify an
37253 ident value. For messages received over TCP/IP, this records the ident string
37254 supplied by the remote host, if any.
37255
37256 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37257 This records the IP address of the local interface and the port number through
37258 which a message was received from a remote host. It is omitted for locally
37259 generated messages.
37260
37261 .vitem &%-local%&
37262 The message is from a local sender.
37263
37264 .vitem &%-localerror%&
37265 The message is a locally-generated bounce message.
37266
37267 .vitem "&%-local_scan%&&~<&'string'&>"
37268 This records the data string that was returned by the &[local_scan()]& function
37269 when the message was received &-- the value of the &$local_scan_data$&
37270 variable. It is omitted if no data was returned.
37271
37272 .vitem &%-manual_thaw%&
37273 The message was frozen but has been thawed manually, that is, by an explicit
37274 Exim command rather than via the auto-thaw process.
37275
37276 .vitem &%-N%&
37277 A testing delivery process was started using the &%-N%& option to suppress any
37278 actual deliveries, but delivery was deferred. At any further delivery attempts,
37279 &%-N%& is assumed.
37280
37281 .vitem &%-received_protocol%&
37282 This records the value of the &$received_protocol$& variable, which contains
37283 the name of the protocol by which the message was received.
37284
37285 .vitem &%-sender_set_untrusted%&
37286 The envelope sender of this message was set by an untrusted local caller (used
37287 to ensure that the caller is displayed in queue listings).
37288
37289 .vitem "&%-spam_score_int%&&~<&'number'&>"
37290 If a message was scanned by SpamAssassin, this is present. It records the value
37291 of &$spam_score_int$&.
37292
37293 .vitem &%-tls_certificate_verified%&
37294 A TLS certificate was received from the client that sent this message, and the
37295 certificate was verified by the server.
37296
37297 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37298 When the message was received over an encrypted connection, this records the
37299 name of the cipher suite that was used.
37300
37301 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37302 When the message was received over an encrypted connection, and a certificate
37303 was received from the client, this records the Distinguished Name from that
37304 certificate.
37305 .endlist
37306
37307 Following the options there is a list of those addresses to which the message
37308 is not to be delivered. This set of addresses is initialized from the command
37309 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37310 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37311 the address is added to this set. The addresses are kept internally as a
37312 balanced binary tree, and it is a representation of that tree which is written
37313 to the spool file. If an address is expanded via an alias or forward file, the
37314 original address is added to the tree when deliveries to all its child
37315 addresses are complete.
37316
37317 If the tree is empty, there is a single line in the spool file containing just
37318 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37319 Y or N, followed by an address. The address is the value for the node of the
37320 tree, and the letters indicate whether the node has a left branch and/or a
37321 right branch attached to it, respectively. If branches exist, they immediately
37322 follow. Here is an example of a three-node tree:
37323 .code
37324 YY darcy@austen.fict.example
37325 NN alice@wonderland.fict.example
37326 NN editor@thesaurus.ref.example
37327 .endd
37328 After the non-recipients tree, there is a list of the message's recipients.
37329 This is a simple list, preceded by a count. It includes all the original
37330 recipients of the message, including those to whom the message has already been
37331 delivered. In the simplest case, the list contains one address per line. For
37332 example:
37333 .code
37334 4
37335 editor@thesaurus.ref.example
37336 darcy@austen.fict.example
37337 rdo@foundation
37338 alice@wonderland.fict.example
37339 .endd
37340 However, when a child address has been added to the top-level addresses as a
37341 result of the use of the &%one_time%& option on a &(redirect)& router, each
37342 line is of the following form:
37343 .display
37344 <&'top-level address'&> <&'errors_to address'&> &&&
37345   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37346 .endd
37347 The 01 flag bit indicates the presence of the three other fields that follow
37348 the top-level address. Other bits may be used in future to support additional
37349 fields. The <&'parent number'&> is the offset in the recipients list of the
37350 original parent of the &"one time"& address. The first two fields are the
37351 envelope sender that is associated with this address and its length. If the
37352 length is zero, there is no special envelope sender (there are then two space
37353 characters in the line). A non-empty field can arise from a &(redirect)& router
37354 that has an &%errors_to%& setting.
37355
37356
37357 A blank line separates the envelope and status information from the headers
37358 which follow. A header may occupy several lines of the file, and to save effort
37359 when reading it in, each header is preceded by a number and an identifying
37360 character. The number is the number of characters in the header, including any
37361 embedded newlines and the terminating newline. The character is one of the
37362 following:
37363
37364 .table2 50pt
37365 .row <&'blank'&>         "header in which Exim has no special interest"
37366 .row &`B`&               "&'Bcc:'& header"
37367 .row &`C`&               "&'Cc:'& header"
37368 .row &`F`&               "&'From:'& header"
37369 .row &`I`&               "&'Message-id:'& header"
37370 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37371 .row &`R`&               "&'Reply-To:'& header"
37372 .row &`S`&               "&'Sender:'& header"
37373 .row &`T`&               "&'To:'& header"
37374 .row &`*`&               "replaced or deleted header"
37375 .endtable
37376
37377 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37378 purposes. They are not transmitted when the message is delivered. Here is a
37379 typical set of headers:
37380 .code
37381 111P Received: by hobbit.fict.example with local (Exim 4.00)
37382 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37383 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37384 038* X-rewrote-sender: bb@hobbit.fict.example
37385 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37386 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37387 099* To: alice@wonderland.fict.example, rdo@foundation,
37388 darcy@austen.fict.example, editor@thesaurus.ref.example
37389 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37390 darcy@austen.fict.example, editor@thesaurus.ref.example
37391 038  Date: Fri, 11 May 2001 10:28:59 +0100
37392 .endd
37393 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37394 &'To:'& header have been rewritten, the last one because routing expanded the
37395 unqualified domain &'foundation'&.
37396 .ecindex IIDforspo1
37397 .ecindex IIDforspo2
37398 .ecindex IIDforspo3
37399
37400 . ////////////////////////////////////////////////////////////////////////////
37401 . ////////////////////////////////////////////////////////////////////////////
37402
37403 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37404          "DKIM Support"
37405 .cindex "DKIM"
37406
37407 DKIM is a mechanism by which messages sent by some entity can be provably
37408 linked to a domain which that entity controls.  It permits reputation to
37409 be tracked on a per-domain basis, rather than merely upon source IP address.
37410 DKIM is documented in RFC 4871.
37411
37412 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37413 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37414
37415 Exim's DKIM implementation allows to
37416 .olist
37417 Sign outgoing messages: This function is implemented in the SMTP transport.
37418 It can co-exist with all other Exim features
37419 (including transport filters)
37420 except cutthrough delivery.
37421 .next
37422 Verify signatures in incoming messages: This is implemented by an additional
37423 ACL (acl_smtp_dkim), which can be called several times per message, with
37424 different signature contexts.
37425 .endlist
37426
37427 In typical Exim style, the verification implementation does not include any
37428 default "policy". Instead it enables you to build your own policy using
37429 Exim's standard controls.
37430
37431 Please note that verification of DKIM signatures in incoming mail is turned
37432 on by default for logging purposes. For each signature in incoming email,
37433 exim will log a line displaying the most important signature details, and the
37434 signature status. Here is an example (with line-breaks added for clarity):
37435 .code
37436 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37437     d=facebookmail.com s=q1-2009b
37438     c=relaxed/relaxed a=rsa-sha1
37439     i=@facebookmail.com t=1252484542 [verification succeeded]
37440 .endd
37441 You might want to turn off DKIM verification processing entirely for internal
37442 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37443 control modifier. This should typically be done in the RCPT ACL, at points
37444 where you accept mail from relay sources (internal hosts or authenticated
37445 senders).
37446
37447
37448 .section "Signing outgoing messages" "SECID513"
37449 .cindex "DKIM" "signing"
37450
37451 Signing is implemented by setting private options on the SMTP transport.
37452 These options take (expandable) strings as arguments.
37453
37454 .option dkim_domain smtp string&!! unset
37455 MANDATORY:
37456 The domain you want to sign with. The result of this expanded
37457 option is put into the &%$dkim_domain%& expansion variable.
37458
37459 .option dkim_selector smtp string&!! unset
37460 MANDATORY:
37461 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37462 variable to look up a matching selector. The result is put in the expansion
37463 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37464 option along with &%$dkim_domain%&.
37465
37466 .option dkim_private_key smtp string&!! unset
37467 MANDATORY:
37468 This sets the private key to use. You can use the &%$dkim_domain%& and
37469 &%$dkim_selector%& expansion variables to determine the private key to use.
37470 The result can either
37471 .ilist
37472 be a valid RSA private key in ASCII armor, including line breaks.
37473 .next
37474 start with a slash, in which case it is treated as a file that contains
37475 the private key.
37476 .next
37477 be "0", "false" or the empty string, in which case the message will not
37478 be signed. This case will not result in an error, even if &%dkim_strict%&
37479 is set.
37480 .endlist
37481
37482 .option dkim_canon smtp string&!! unset
37483 OPTIONAL:
37484 This option sets the canonicalization method used when signing a message.
37485 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37486 The option defaults to "relaxed" when unset. Note: the current implementation
37487 only supports using the same canonicalization method for both headers and body.
37488
37489 .option dkim_strict smtp string&!! unset
37490 OPTIONAL:
37491 This  option  defines  how  Exim  behaves  when  signing a message that
37492 should be signed fails for some reason.  When the expansion evaluates to
37493 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37494 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37495 variables here.
37496
37497 .option dkim_sign_headers smtp string&!! unset
37498 OPTIONAL:
37499 When set, this option must expand to (or be specified as) a colon-separated
37500 list of header names. Headers with these names will be included in the message
37501 signature. When unspecified, the header names recommended in RFC4871 will be
37502 used.
37503
37504
37505 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37506 .cindex "DKIM" "verification"
37507
37508 Verification of DKIM signatures in incoming email is implemented via the
37509 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37510 syntactically(!) correct signature in the incoming message.
37511 A missing ACL definition defaults to accept.
37512 If any ACL call does not acccept, the message is not accepted.
37513 If a cutthrough delivery was in progress for the message it is
37514 summarily dropped (having wasted the transmission effort).
37515
37516 To evaluate the signature in the ACL a large number of expansion variables
37517 containing the signature status and its details are set up during the
37518 runtime of the ACL.
37519
37520 Calling the ACL only for existing signatures is not sufficient to build
37521 more advanced policies. For that reason, the global option
37522 &%dkim_verify_signers%&, and a global expansion variable
37523 &%$dkim_signers%& exist.
37524
37525 The global option &%dkim_verify_signers%& can be set to a colon-separated
37526 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37527 called. It is expanded when the message has been received. At this point,
37528 the expansion variable &%$dkim_signers%& already contains a colon-separated
37529 list of signer domains and identities for the message. When
37530 &%dkim_verify_signers%& is not specified in the main configuration,
37531 it defaults as:
37532 .code
37533 dkim_verify_signers = $dkim_signers
37534 .endd
37535 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37536 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37537 call the ACL for known domains or identities. This would be achieved as follows:
37538 .code
37539 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37540 .endd
37541 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37542 and "ebay.com", plus all domains and identities that have signatures in the message.
37543 You can also be more creative in constructing your policy. For example:
37544 .code
37545 dkim_verify_signers = $sender_address_domain:$dkim_signers
37546 .endd
37547
37548 If a domain or identity is listed several times in the (expanded) value of
37549 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37550
37551
37552 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37553 available (from most to least important):
37554
37555
37556 .vlist
37557 .vitem &%$dkim_cur_signer%&
37558 The signer that is being evaluated in this ACL run. This can be a domain or
37559 an identity. This is one of the list items from the expanded main option
37560 &%dkim_verify_signers%& (see above).
37561 .vitem &%$dkim_verify_status%&
37562 A string describing the general status of the signature. One of
37563 .ilist
37564 &%none%&: There is no signature in the message for the current domain or
37565 identity (as reflected by &%$dkim_cur_signer%&).
37566 .next
37567 &%invalid%&: The signature could not be verified due to a processing error.
37568 More detail is available in &%$dkim_verify_reason%&.
37569 .next
37570 &%fail%&: Verification of the signature failed.  More detail is
37571 available in &%$dkim_verify_reason%&.
37572 .next
37573 &%pass%&: The signature passed verification. It is valid.
37574 .endlist
37575 .vitem &%$dkim_verify_reason%&
37576 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37577 "fail" or "invalid". One of
37578 .ilist
37579 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37580 key for the domain could not be retrieved. This may be a temporary problem.
37581 .next
37582 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37583 record for the domain is syntactically invalid.
37584 .next
37585 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37586 body hash does not match the one specified in the signature header. This
37587 means that the message body was modified in transit.
37588 .next
37589 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37590 could not be verified. This may mean that headers were modified,
37591 re-written or otherwise changed in a way which is incompatible with
37592 DKIM verification. It may of course also mean that the signature is forged.
37593 .endlist
37594 .vitem &%$dkim_domain%&
37595 The signing domain. IMPORTANT: This variable is only populated if there is
37596 an actual signature in the message for the current domain or identity (as
37597 reflected by &%$dkim_cur_signer%&).
37598 .vitem &%$dkim_identity%&
37599 The signing identity, if present. IMPORTANT: This variable is only populated
37600 if there is an actual signature in the message for the current domain or
37601 identity (as reflected by &%$dkim_cur_signer%&).
37602 .vitem &%$dkim_selector%&
37603 The key record selector string.
37604 .vitem &%$dkim_algo%&
37605 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37606 .vitem &%$dkim_canon_body%&
37607 The body canonicalization method. One of 'relaxed' or 'simple'.
37608 .vitem &%dkim_canon_headers%&
37609 The header canonicalization method. One of 'relaxed' or 'simple'.
37610 .vitem &%$dkim_copiedheaders%&
37611 A transcript of headers and their values which are included in the signature
37612 (copied from the 'z=' tag of the signature).
37613 .vitem &%$dkim_bodylength%&
37614 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37615 limit was set by the signer, "9999999999999" is returned. This makes sure
37616 that this variable always expands to an integer value.
37617 .vitem &%$dkim_created%&
37618 UNIX timestamp reflecting the date and time when the signature was created.
37619 When this was not specified by the signer, "0" is returned.
37620 .vitem &%$dkim_expires%&
37621 UNIX timestamp reflecting the date and time when the signer wants the
37622 signature to be treated as "expired". When this was not specified by the
37623 signer, "9999999999999" is returned. This makes it possible to do useful
37624 integer size comparisons against this value.
37625 .vitem &%$dkim_headernames%&
37626 A colon-separated list of names of headers included in the signature.
37627 .vitem &%$dkim_key_testing%&
37628 "1" if the key record has the "testing" flag set, "0" if not.
37629 .vitem &%$dkim_key_nosubdomains%&
37630 "1" if the key record forbids subdomaining, "0" otherwise.
37631 .vitem &%$dkim_key_srvtype%&
37632 Service type (tag s=) from the key record. Defaults to "*" if not specified
37633 in the key record.
37634 .vitem &%$dkim_key_granularity%&
37635 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37636 in the key record.
37637 .vitem &%$dkim_key_notes%&
37638 Notes from the key record (tag n=).
37639 .endlist
37640
37641 In addition, two ACL conditions are provided:
37642
37643 .vlist
37644 .vitem &%dkim_signers%&
37645 ACL condition that checks a colon-separated list of domains or identities
37646 for a match against the domain or identity that the ACL is currently verifying
37647 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37648 verb to a group of domains or identities. For example:
37649
37650 .code
37651 # Warn when Mail purportedly from GMail has no signature at all
37652 warn log_message = GMail sender without DKIM signature
37653      sender_domains = gmail.com
37654      dkim_signers = gmail.com
37655      dkim_status = none
37656 .endd
37657
37658 .vitem &%dkim_status%&
37659 ACL condition that checks a colon-separated list of possible DKIM verification
37660 results against the actual result of verification. This is typically used
37661 to restrict an ACL verb to a list of verification outcomes, for example:
37662
37663 .code
37664 deny message = Mail from Paypal with invalid/missing signature
37665      sender_domains = paypal.com:paypal.de
37666      dkim_signers = paypal.com:paypal.de
37667      dkim_status = none:invalid:fail
37668 .endd
37669
37670 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37671 see the documentation of the &%$dkim_verify_status%& expansion variable above
37672 for more information of what they mean.
37673 .endlist
37674
37675 . ////////////////////////////////////////////////////////////////////////////
37676 . ////////////////////////////////////////////////////////////////////////////
37677
37678 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37679          "Adding drivers or lookups"
37680 .cindex "adding drivers"
37681 .cindex "new drivers, adding"
37682 .cindex "drivers" "adding new"
37683 The following actions have to be taken in order to add a new router, transport,
37684 authenticator, or lookup type to Exim:
37685
37686 .olist
37687 Choose a name for the driver or lookup type that does not conflict with any
37688 existing name; I will use &"newdriver"& in what follows.
37689 .next
37690 Add to &_src/EDITME_& the line:
37691 .display
37692 <&'type'&>&`_NEWDRIVER=yes`&
37693 .endd
37694 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37695 code is not to be included in the binary by default, comment this line out. You
37696 should also add any relevant comments about the driver or lookup type.
37697 .next
37698 Add to &_src/config.h.defaults_& the line:
37699 .code
37700 #define <type>_NEWDRIVER
37701 .endd
37702 .next
37703 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37704 and create a table entry as is done for all the other drivers and lookup types.
37705 .next
37706 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37707 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37708 Add your &`NEWDRIVER`& to that list.
37709 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37710 simple form that most lookups have.
37711 .next
37712 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37713 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37714 driver or lookup type and add it to the definition of OBJ.
37715 .next
37716 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37717 &_src_&.
37718 .next
37719 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37720 as for other drivers and lookups.
37721 .endlist
37722
37723 Then all you need to do is write the code! A good way to start is to make a
37724 proforma by copying an existing module of the same type, globally changing all
37725 occurrences of the name, and cutting out most of the code. Note that any
37726 options you create must be listed in alphabetical order, because the tables are
37727 searched using a binary chop procedure.
37728
37729 There is a &_README_& file in each of the sub-directories of &_src_& describing
37730 the interface that is expected.
37731
37732
37733
37734
37735 . ////////////////////////////////////////////////////////////////////////////
37736 . ////////////////////////////////////////////////////////////////////////////
37737
37738 . /////////////////////////////////////////////////////////////////////////////
37739 . These lines are processing instructions for the Simple DocBook Processor that
37740 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37741 . PDFs than using xmlto and fop. They will be ignored by all other XML
37742 . processors.
37743 . /////////////////////////////////////////////////////////////////////////////
37744
37745 .literal xml
37746 <?sdop
37747   format="newpage"
37748   foot_right_recto="&chaptertitle;"
37749   foot_right_verso="&chaptertitle;"
37750 ?>
37751 .literal off
37752
37753 .makeindex "Options index"   "option"
37754 .makeindex "Variables index" "variable"
37755 .makeindex "Concept index"   "concept"
37756
37757
37758 . /////////////////////////////////////////////////////////////////////////////
37759 . /////////////////////////////////////////////////////////////////////////////