smtp input
[users/heiko/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, SPF, SRV, TLSA and TXT,
6882 and, when Exim is compiled with IPv6 support, AAAA.
6883 If no type is given, TXT is assumed. When the type is PTR,
6884 the data can be an IP address, written as normal; inversion and the addition of
6885 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6886 .code
6887 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6888 .endd
6889 If the data for a PTR record is not a syntactically valid IP address, it is not
6890 altered and nothing is added.
6891
6892 For any record type, if multiple records are found, the data is returned as a
6893 concatenation, with newline as the default separator. The order, of course,
6894 depends on the DNS resolver. You can specify a different separator character
6895 between multiple records by putting a right angle-bracket followed immediately
6896 by the new separator at the start of the query. For example:
6897 .code
6898 ${lookup dnsdb{>: a=host1.example}}
6899 .endd
6900 It is permitted to specify a space as the separator character. Further
6901 white space is ignored.
6902
6903 .cindex "MX record" "in &(dnsdb)& lookup"
6904 .cindex "SRV record" "in &(dnsdb)& lookup"
6905 For an MX lookup, both the preference value and the host name are returned for
6906 each record, separated by a space. For an SRV lookup, the priority, weight,
6907 port, and host name are returned for each record, separated by spaces.
6908 An alternate field separator can be specified using a comma after the main
6909 separator character, followed immediately by the field separator.
6910
6911 .cindex "TXT record" "in &(dnsdb)& lookup"
6912 .cindex "SPF record" "in &(dnsdb)& lookup"
6913 For TXT records with multiple items of data, only the first item is returned,
6914 unless a separator for them is specified using a comma after the separator
6915 character followed immediately by the TXT record item separator. To concatenate
6916 items without a separator, use a semicolon instead. For SPF records the
6917 default behaviour is to concatenate multiple items without using a separator.
6918 .code
6919 ${lookup dnsdb{>\n,: txt=a.b.example}}
6920 ${lookup dnsdb{>\n; txt=a.b.example}}
6921 ${lookup dnsdb{spf=example.org}}
6922 .endd
6923 It is permitted to specify a space as the separator character. Further
6924 white space is ignored.
6925
6926 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6927 .cindex "dnsdb modifiers"
6928 .cindex "modifiers" "dnsdb"
6929 .cindex "options" "dnsdb"
6930 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6931 each followed by a comma,
6932 that may appear before the record type.
6933
6934 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6935 temporary DNS error for any of them, the behaviour is controlled by
6936 a defer-option modifier.
6937 The possible keywords are
6938 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6939 With &"strict"& behaviour, any temporary DNS error causes the
6940 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6941 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6942 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6943 error causes the whole lookup to defer only if none of the other lookups
6944 succeed. The default is &"lax"&, so the following lookups are equivalent:
6945 .code
6946 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6947 ${lookup dnsdb{a=one.host.com:two.host.com}}
6948 .endd
6949 Thus, in the default case, as long as at least one of the DNS lookups
6950 yields some data, the lookup succeeds.
6951
6952 .cindex "DNSSEC" "dns lookup"
6953 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6954 The possible keywords are
6955 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6956 With &"strict"& or &"lax"& DNSSEC information is requested
6957 with the lookup.
6958 With &"strict"& a response from the DNS resolver that
6959 is not labelled as authenticated data
6960 is treated as equivalent to a temporary DNS error.
6961 The default is &"never"&.
6962
6963 See also the &$lookup_dnssec_authenticated$& variable.
6964
6965
6966 .section "Pseudo dnsdb record types" "SECID66"
6967 .cindex "MX record" "in &(dnsdb)& lookup"
6968 By default, both the preference value and the host name are returned for
6969 each MX record, separated by a space. If you want only host names, you can use
6970 the pseudo-type MXH:
6971 .code
6972 ${lookup dnsdb{mxh=a.b.example}}
6973 .endd
6974 In this case, the preference values are omitted, and just the host names are
6975 returned.
6976
6977 .cindex "name server for enclosing domain"
6978 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6979 records on the given domain, but if none are found, it removes the first
6980 component of the domain name, and tries again. This process continues until NS
6981 records are found or there are no more components left (or there is a DNS
6982 error). In other words, it may return the name servers for a top-level domain,
6983 but it never returns the root name servers. If there are no NS records for the
6984 top-level domain, the lookup fails. Consider these examples:
6985 .code
6986 ${lookup dnsdb{zns=xxx.quercite.com}}
6987 ${lookup dnsdb{zns=xxx.edu}}
6988 .endd
6989 Assuming that in each case there are no NS records for the full domain name,
6990 the first returns the name servers for &%quercite.com%&, and the second returns
6991 the name servers for &%edu%&.
6992
6993 You should be careful about how you use this lookup because, unless the
6994 top-level domain does not exist, the lookup always returns some host names. The
6995 sort of use to which this might be put is for seeing if the name servers for a
6996 given domain are on a blacklist. You can probably assume that the name servers
6997 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6998 such a list.
6999
7000 .cindex "CSA" "in &(dnsdb)& lookup"
7001 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7002 records according to the CSA rules, which are described in section
7003 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7004 not sufficient because of the extra parent domain search behaviour of CSA. The
7005 result of a successful lookup such as:
7006 .code
7007 ${lookup dnsdb {csa=$sender_helo_name}}
7008 .endd
7009 has two space-separated fields: an authorization code and a target host name.
7010 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7011 authorization required but absent, or &"?"& for unknown.
7012
7013 .cindex "A+" "in &(dnsdb)& lookup"
7014 The pseudo-type A+ performs an AAAA
7015 and then an A lookup.  All results are returned; defer processing
7016 (see below) is handled separately for each lookup.  Example:
7017 .code
7018 ${lookup dnsdb {>; a+=$sender_helo_name}}
7019 .endd
7020
7021
7022 .section "Multiple dnsdb lookups" "SECID67"
7023 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7024 However, you can specify a list of domains or IP addresses in a single
7025 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7026 the default separator, but with the ability to change this. For example:
7027 .code
7028 ${lookup dnsdb{one.domain.com:two.domain.com}}
7029 ${lookup dnsdb{a=one.host.com:two.host.com}}
7030 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7031 .endd
7032 In order to retain backwards compatibility, there is one special case: if
7033 the lookup type is PTR and no change of separator is specified, Exim looks
7034 to see if the rest of the string is precisely one IPv6 address. In this
7035 case, it does not treat it as a list.
7036
7037 The data from each lookup is concatenated, with newline separators by default,
7038 in the same way that multiple DNS records for a single item are handled. A
7039 different separator can be specified, as described above.
7040
7041
7042
7043
7044 .section "More about LDAP" "SECTldap"
7045 .cindex "LDAP" "lookup, more about"
7046 .cindex "lookup" "LDAP"
7047 .cindex "Solaris" "LDAP"
7048 The original LDAP implementation came from the University of Michigan; this has
7049 become &"Open LDAP"&, and there are now two different releases. Another
7050 implementation comes from Netscape, and Solaris 7 and subsequent releases
7051 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7052 the lookup function level, their error handling is different. For this reason
7053 it is necessary to set a compile-time variable when building Exim with LDAP, to
7054 indicate which LDAP library is in use. One of the following should appear in
7055 your &_Local/Makefile_&:
7056 .code
7057 LDAP_LIB_TYPE=UMICHIGAN
7058 LDAP_LIB_TYPE=OPENLDAP1
7059 LDAP_LIB_TYPE=OPENLDAP2
7060 LDAP_LIB_TYPE=NETSCAPE
7061 LDAP_LIB_TYPE=SOLARIS
7062 .endd
7063 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7064 same interface as the University of Michigan version.
7065
7066 There are three LDAP lookup types in Exim. These behave slightly differently in
7067 the way they handle the results of a query:
7068
7069 .ilist
7070 &(ldap)& requires the result to contain just one entry; if there are more, it
7071 gives an error.
7072 .next
7073 &(ldapdn)& also requires the result to contain just one entry, but it is the
7074 Distinguished Name that is returned rather than any attribute values.
7075 .next
7076 &(ldapm)& permits the result to contain more than one entry; the attributes
7077 from all of them are returned.
7078 .endlist
7079
7080
7081 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7082 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7083 the data returned by a successful lookup is described in the next section.
7084 First we explain how LDAP queries are coded.
7085
7086
7087 .section "Format of LDAP queries" "SECTforldaque"
7088 .cindex "LDAP" "query format"
7089 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7090 the configuration of a &(redirect)& router one might have this setting:
7091 .code
7092 data = ${lookup ldap \
7093   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7094   c=UK?mailbox?base?}}
7095 .endd
7096 .cindex "LDAP" "with TLS"
7097 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7098 secure (encrypted) LDAP connections. The second of these ensures that an
7099 encrypted TLS connection is used.
7100
7101 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7102 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7103 See the &%ldap_start_tls%& option.
7104
7105 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7106 controlled. Every part of the TLS configuration can be configured by settings in
7107 &_exim.conf_&. Depending on the version of the client libraries installed on
7108 your system, some of the initialization may have required setting options in
7109 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7110 certificates. This revealed a nuance where the current UID that exim was
7111 running as could affect which config files it read. With Exim 4.83, these
7112 methods become optional, only taking effect if not specifically set in
7113 &_exim.conf_&.
7114
7115
7116 .section "LDAP quoting" "SECID68"
7117 .cindex "LDAP" "quoting"
7118 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7119 and the second because the LDAP query is represented as a URL. Furthermore,
7120 within an LDAP query, two different kinds of quoting are required. For this
7121 reason, there are two different LDAP-specific quoting operators.
7122
7123 The &%quote_ldap%& operator is designed for use on strings that are part of
7124 filter specifications. Conceptually, it first does the following conversions on
7125 the string:
7126 .code
7127 *   =>   \2A
7128 (   =>   \28
7129 )   =>   \29
7130 \   =>   \5C
7131 .endd
7132 in accordance with RFC 2254. The resulting string is then quoted according
7133 to the rules for URLs, that is, all non-alphanumeric characters except
7134 .code
7135 ! $ ' - . _ ( ) * +
7136 .endd
7137 are converted to their hex values, preceded by a percent sign. For example:
7138 .code
7139 ${quote_ldap: a(bc)*, a<yz>; }
7140 .endd
7141 yields
7142 .code
7143 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7144 .endd
7145 Removing the URL quoting, this is (with a leading and a trailing space):
7146 .code
7147 a\28bc\29\2A, a<yz>;
7148 .endd
7149 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7150 base DN specifications in queries. Conceptually, it first converts the string
7151 by inserting a backslash in front of any of the following characters:
7152 .code
7153 , + " \ < > ;
7154 .endd
7155 It also inserts a backslash before any leading spaces or # characters, and
7156 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7157 is then quoted according to the rules for URLs. For example:
7158 .code
7159 ${quote_ldap_dn: a(bc)*, a<yz>; }
7160 .endd
7161 yields
7162 .code
7163 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7164 .endd
7165 Removing the URL quoting, this is (with a trailing space):
7166 .code
7167 \ a(bc)*\, a\<yz\>\;\
7168 .endd
7169 There are some further comments about quoting in the section on LDAP
7170 authentication below.
7171
7172
7173 .section "LDAP connections" "SECID69"
7174 .cindex "LDAP" "connections"
7175 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7176 is in use, via a Unix domain socket. The example given above does not specify
7177 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7178 by starting it with
7179 .code
7180 ldap://<hostname>:<port>/...
7181 .endd
7182 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7183 used. When no server is specified in a query, a list of default servers is
7184 taken from the &%ldap_default_servers%& configuration option. This supplies a
7185 colon-separated list of servers which are tried in turn until one successfully
7186 handles a query, or there is a serious error. Successful handling either
7187 returns the requested data, or indicates that it does not exist. Serious errors
7188 are syntactical, or multiple values when only a single value is expected.
7189 Errors which cause the next server to be tried are connection failures, bind
7190 failures, and timeouts.
7191
7192 For each server name in the list, a port number can be given. The standard way
7193 of specifying a host and port is to use a colon separator (RFC 1738). Because
7194 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7195 doubled. For example
7196 .code
7197 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7198 .endd
7199 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7200 to the LDAP library with no server name, and the library's default (normally
7201 the local host) is used.
7202
7203 If you are using the OpenLDAP library, you can connect to an LDAP server using
7204 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7205 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7206 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7207 not available.
7208
7209 For this type of connection, instead of a host name for the server, a pathname
7210 for the socket is required, and the port number is not relevant. The pathname
7211 can be specified either as an item in &%ldap_default_servers%&, or inline in
7212 the query. In the former case, you can have settings such as
7213 .code
7214 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7215 .endd
7216 When the pathname is given in the query, you have to escape the slashes as
7217 &`%2F`& to fit in with the LDAP URL syntax. For example:
7218 .code
7219 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7220 .endd
7221 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7222 a pathname, it uses the Unix domain socket code, even if the query actually
7223 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7224 socket connection. This behaviour means that you can use a setting of
7225 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7226 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7227 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7228 backup host.
7229
7230 If an explicit &`ldapi`& type is given in a query when a host name is
7231 specified, an error is diagnosed. However, if there are more items in
7232 &%ldap_default_servers%&, they are tried. In other words:
7233
7234 .ilist
7235 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7236 interface.
7237 .next
7238 Using &`ldapi`& with a host name causes an error.
7239 .endlist
7240
7241
7242 Using &`ldapi`& with no host or path in the query, and no setting of
7243 &%ldap_default_servers%&, does whatever the library does by default.
7244
7245
7246
7247 .section "LDAP authentication and control information" "SECID70"
7248 .cindex "LDAP" "authentication"
7249 The LDAP URL syntax provides no way of passing authentication and other control
7250 information to the server. To make this possible, the URL in an LDAP query may
7251 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7252 spaces. If a value contains spaces it must be enclosed in double quotes, and
7253 when double quotes are used, backslash is interpreted in the usual way inside
7254 them. The following names are recognized:
7255 .display
7256 &`DEREFERENCE`&  set the dereferencing parameter
7257 &`NETTIME    `&  set a timeout for a network operation
7258 &`USER       `&  set the DN, for authenticating the LDAP bind
7259 &`PASS       `&  set the password, likewise
7260 &`REFERRALS  `&  set the referrals parameter
7261 &`SERVERS    `&  set alternate server list for this query only
7262 &`SIZE       `&  set the limit for the number of entries returned
7263 &`TIME       `&  set the maximum waiting time for a query
7264 .endd
7265 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7266 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7267 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7268 library from trying to follow referrals issued by the LDAP server.
7269
7270 The name CONNECT is an obsolete name for NETTIME, retained for
7271 backwards compatibility. This timeout (specified as a number of seconds) is
7272 enforced from the client end for operations that can be carried out over a
7273 network. Specifically, it applies to network connections and calls to the
7274 &'ldap_result()'& function. If the value is greater than zero, it is used if
7275 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7276 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7277 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7278 Netscape SDK; for OpenLDAP no action is taken.
7279
7280 The TIME parameter (also a number of seconds) is passed to the server to
7281 set a server-side limit on the time taken to complete a search.
7282
7283 The SERVERS parameter allows you to specify an alternate list of ldap servers
7284 to use for an individual lookup.  The global ldap_servers option provides a
7285 default list of ldap servers, and a single lookup can specify a single ldap
7286 server to use.  But when you need to do a lookup with a list of servers that is
7287 different than the default list (maybe different order, maybe a completely
7288 different set of servers), the SERVERS parameter allows you to specify this
7289 alternate list (colon-separated).
7290
7291 Here is an example of an LDAP query in an Exim lookup that uses some of these
7292 values. This is a single line, folded to fit on the page:
7293 .code
7294 ${lookup ldap
7295   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7296   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7297   {$value}fail}
7298 .endd
7299 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7300 any of the auxiliary data. Exim configuration settings that include lookups
7301 which contain password information should be preceded by &"hide"& to prevent
7302 non-admin users from using the &%-bP%& option to see their values.
7303
7304 The auxiliary data items may be given in any order. The default is no
7305 connection timeout (the system timeout is used), no user or password, no limit
7306 on the number of entries returned, and no time limit on queries.
7307
7308 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7309 removes any URL quoting that it may contain before passing it LDAP. Apparently
7310 some libraries do this for themselves, but some do not. Removing the URL
7311 quoting has two advantages:
7312
7313 .ilist
7314 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7315 DNs as with DNs inside actual queries.
7316 .next
7317 It permits spaces inside USER= DNs.
7318 .endlist
7319
7320 For example, a setting such as
7321 .code
7322 USER=cn=${quote_ldap_dn:$1}
7323 .endd
7324 should work even if &$1$& contains spaces.
7325
7326 Expanded data for the PASS= value should be quoted using the &%quote%&
7327 expansion operator, rather than the LDAP quote operators. The only reason this
7328 field needs quoting is to ensure that it conforms to the Exim syntax, which
7329 does not allow unquoted spaces. For example:
7330 .code
7331 PASS=${quote:$3}
7332 .endd
7333 The LDAP authentication mechanism can be used to check passwords as part of
7334 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7335 &<<CHAPexpand>>&.
7336
7337
7338
7339 .section "Format of data returned by LDAP" "SECID71"
7340 .cindex "LDAP" "returned data formats"
7341 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7342 as a sequence of values, for example
7343 .code
7344 cn=manager, o=University of Cambridge, c=UK
7345 .endd
7346 The &(ldap)& lookup type generates an error if more than one entry matches the
7347 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7348 the result between the data from different entries. It is possible for multiple
7349 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7350 you know that whatever values are returned all came from a single entry in the
7351 directory.
7352
7353 In the common case where you specify a single attribute in your LDAP query, the
7354 result is not quoted, and does not contain the attribute name. If the attribute
7355 has multiple values, they are separated by commas.
7356
7357 If you specify multiple attributes, the result contains space-separated, quoted
7358 strings, each preceded by the attribute name and an equals sign. Within the
7359 quotes, the quote character, backslash, and newline are escaped with
7360 backslashes, and commas are used to separate multiple values for the attribute.
7361 Any commas in attribute values are doubled
7362 (permitting treatment of the values as a comma-separated list).
7363 Apart from the escaping, the string within quotes takes the same form as the
7364 output when a single attribute is requested. Specifying no attributes is the
7365 same as specifying all of an entry's attributes.
7366
7367 Here are some examples of the output format. The first line of each pair is an
7368 LDAP query, and the second is the data that is returned. The attribute called
7369 &%attr1%& has two values, one of them with an embedded comma, whereas
7370 &%attr2%& has only one value:
7371 .code
7372 ldap:///o=base?attr1?sub?(uid=fred)
7373 value1.1,value1,,2
7374
7375 ldap:///o=base?attr2?sub?(uid=fred)
7376 value two
7377
7378 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7379 attr1="value1.1,value1,,2" attr2="value two"
7380
7381 ldap:///o=base??sub?(uid=fred)
7382 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7383 .endd
7384 You can
7385 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7386 results of LDAP lookups.
7387 The &%extract%& operator in string expansions can be used to pick out
7388 individual fields from data that consists of &'key'&=&'value'& pairs.
7389 The &%listextract%& operator should be used to pick out individual values
7390 of attributes, even when only a single value is expected.
7391 The doubling of embedded commas allows you to use the returned data as a
7392 comma separated list (using the "<," syntax for changing the input list separator).
7393
7394
7395
7396
7397 .section "More about NIS+" "SECTnisplus"
7398 .cindex "NIS+ lookup type"
7399 .cindex "lookup" "NIS+"
7400 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7401 and field name. If this is given, the result of a successful query is the
7402 contents of the named field; otherwise the result consists of a concatenation
7403 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7404 values containing spaces are quoted. For example, the query
7405 .code
7406 [name=mg1456],passwd.org_dir
7407 .endd
7408 might return the string
7409 .code
7410 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7411 home=/home/mg1456 shell=/bin/bash shadow=""
7412 .endd
7413 (split over two lines here to fit on the page), whereas
7414 .code
7415 [name=mg1456],passwd.org_dir:gcos
7416 .endd
7417 would just return
7418 .code
7419 Martin Guerre
7420 .endd
7421 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7422 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7423 operator is to double any quote characters within the text.
7424
7425
7426
7427 .section "SQL lookups" "SECTsql"
7428 .cindex "SQL lookup types"
7429 .cindex "MySQL" "lookup type"
7430 .cindex "PostgreSQL lookup type"
7431 .cindex "lookup" "MySQL"
7432 .cindex "lookup" "PostgreSQL"
7433 .cindex "Oracle" "lookup type"
7434 .cindex "lookup" "Oracle"
7435 .cindex "InterBase lookup type"
7436 .cindex "lookup" "InterBase"
7437 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7438 databases. Queries for these databases contain SQL statements, so an example
7439 might be
7440 .code
7441 ${lookup mysql{select mailbox from users where id='userx'}\
7442   {$value}fail}
7443 .endd
7444 If the result of the query contains more than one field, the data for each
7445 field in the row is returned, preceded by its name, so the result of
7446 .code
7447 ${lookup pgsql{select home,name from users where id='userx'}\
7448   {$value}}
7449 .endd
7450 might be
7451 .code
7452 home=/home/userx name="Mister X"
7453 .endd
7454 Empty values and values containing spaces are double quoted, with embedded
7455 quotes escaped by a backslash. If the result of the query contains just one
7456 field, the value is passed back verbatim, without a field name, for example:
7457 .code
7458 Mister X
7459 .endd
7460 If the result of the query yields more than one row, it is all concatenated,
7461 with a newline between the data for each row.
7462
7463
7464 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7465 .cindex "MySQL" "lookup type"
7466 .cindex "PostgreSQL lookup type"
7467 .cindex "lookup" "MySQL"
7468 .cindex "lookup" "PostgreSQL"
7469 .cindex "Oracle" "lookup type"
7470 .cindex "lookup" "Oracle"
7471 .cindex "InterBase lookup type"
7472 .cindex "lookup" "InterBase"
7473 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7474 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7475 option (as appropriate) must be set to a colon-separated list of server
7476 information.
7477 (For MySQL and PostgreSQL only, the global option need not be set if all
7478 queries contain their own server information &-- see section
7479 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7480 items: host name, database name, user name, and password. In the case of
7481 Oracle, the host name field is used for the &"service name"&, and the database
7482 name field is not used and should be empty. For example:
7483 .code
7484 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7485 .endd
7486 Because password data is sensitive, you should always precede the setting with
7487 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7488 option. Here is an example where two MySQL servers are listed:
7489 .code
7490 hide mysql_servers = localhost/users/root/secret:\
7491                      otherhost/users/root/othersecret
7492 .endd
7493 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7494 because this is a colon-separated list, the colon has to be doubled. For each
7495 query, these parameter groups are tried in order until a connection is made and
7496 a query is successfully processed. The result of a query may be that no data is
7497 found, but that is still a successful query. In other words, the list of
7498 servers provides a backup facility, not a list of different places to look.
7499
7500 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7501 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7502 respectively, and the characters single-quote, double-quote, and backslash
7503 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7504 addition, escapes the percent and underscore characters. This cannot be done
7505 for MySQL because these escapes are not recognized in contexts where these
7506 characters are not special.
7507
7508 .section "Specifying the server in the query" "SECTspeserque"
7509 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7510 it is possible to specify a list of servers with an individual query. This is
7511 done by starting the query with
7512 .display
7513 &`servers=`&&'server1:server2:server3:...'&&`;`&
7514 .endd
7515 Each item in the list may take one of two forms:
7516 .olist
7517 If it contains no slashes it is assumed to be just a host name. The appropriate
7518 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7519 of the same name, and the remaining parameters (database, user, password) are
7520 taken from there.
7521 .next
7522 If it contains any slashes, it is taken as a complete parameter set.
7523 .endlist
7524 The list of servers is used in exactly the same way as the global list.
7525 Once a connection to a server has happened and a query has been
7526 successfully executed, processing of the lookup ceases.
7527
7528 This feature is intended for use in master/slave situations where updates
7529 are occurring and you want to update the master rather than a slave. If the
7530 master is in the list as a backup for reading, you might have a global setting
7531 like this:
7532 .code
7533 mysql_servers = slave1/db/name/pw:\
7534                 slave2/db/name/pw:\
7535                 master/db/name/pw
7536 .endd
7537 In an updating lookup, you could then write:
7538 .code
7539 ${lookup mysql{servers=master; UPDATE ...} }
7540 .endd
7541 That query would then be sent only to the master server. If, on the other hand,
7542 the master is not to be used for reading, and so is not present in the global
7543 option, you can still update it by a query of this form:
7544 .code
7545 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7546 .endd
7547
7548
7549 .section "Special MySQL features" "SECID73"
7550 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7551 causes a connection to the server on the local host by means of a Unix domain
7552 socket. An alternate socket can be specified in parentheses. The full syntax of
7553 each item in &%mysql_servers%& is:
7554 .display
7555 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7556   <&'user'&>/<&'password'&>
7557 .endd
7558 Any of the three sub-parts of the first field can be omitted. For normal use on
7559 the local host it can be left blank or set to just &"localhost"&.
7560
7561 No database need be supplied &-- but if it is absent here, it must be given in
7562 the queries.
7563
7564 If a MySQL query is issued that does not request any data (an insert, update,
7565 or delete command), the result of the lookup is the number of rows affected.
7566
7567 &*Warning*&: This can be misleading. If an update does not actually change
7568 anything (for example, setting a field to the value it already has), the result
7569 is zero because no rows are affected.
7570
7571
7572 .section "Special PostgreSQL features" "SECID74"
7573 PostgreSQL lookups can also use Unix domain socket connections to the database.
7574 This is usually faster and costs less CPU time than a TCP/IP connection.
7575 However it can be used only if the mail server runs on the same machine as the
7576 database server. A configuration line for PostgreSQL via Unix domain sockets
7577 looks like this:
7578 .code
7579 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7580 .endd
7581 In other words, instead of supplying a host name, a path to the socket is
7582 given. The path name is enclosed in parentheses so that its slashes aren't
7583 visually confused with the delimiters for the other server parameters.
7584
7585 If a PostgreSQL query is issued that does not request any data (an insert,
7586 update, or delete command), the result of the lookup is the number of rows
7587 affected.
7588
7589 .section "More about SQLite" "SECTsqlite"
7590 .cindex "lookup" "SQLite"
7591 .cindex "sqlite lookup type"
7592 SQLite is different to the other SQL lookups because a file name is required in
7593 addition to the SQL query. An SQLite database is a single file, and there is no
7594 daemon as in the other SQL databases. The interface to Exim requires the name
7595 of the file, as an absolute path, to be given at the start of the query. It is
7596 separated from the query by white space. This means that the path name cannot
7597 contain white space. Here is a lookup expansion example:
7598 .code
7599 ${lookup sqlite {/some/thing/sqlitedb \
7600   select name from aliases where id='userx';}}
7601 .endd
7602 In a list, the syntax is similar. For example:
7603 .code
7604 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7605    select * from relays where ip='$sender_host_address';
7606 .endd
7607 The only character affected by the &%quote_sqlite%& operator is a single
7608 quote, which it doubles.
7609
7610 The SQLite library handles multiple simultaneous accesses to the database
7611 internally. Multiple readers are permitted, but only one process can
7612 update at once. Attempts to access the database while it is being updated
7613 are rejected after a timeout period, during which the SQLite library
7614 waits for the lock to be released. In Exim, the default timeout is set
7615 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7616 option.
7617 .ecindex IIDfidalo1
7618 .ecindex IIDfidalo2
7619
7620
7621 . ////////////////////////////////////////////////////////////////////////////
7622 . ////////////////////////////////////////////////////////////////////////////
7623
7624 .chapter "Domain, host, address, and local part lists" &&&
7625          "CHAPdomhosaddlists" &&&
7626          "Domain, host, and address lists"
7627 .scindex IIDdohoadli "lists of domains; hosts; etc."
7628 A number of Exim configuration options contain lists of domains, hosts,
7629 email addresses, or local parts. For example, the &%hold_domains%& option
7630 contains a list of domains whose delivery is currently suspended. These lists
7631 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7632 arguments to expansion conditions such as &%match_domain%&.
7633
7634 Each item in one of these lists is a pattern to be matched against a domain,
7635 host, email address, or local part, respectively. In the sections below, the
7636 different types of pattern for each case are described, but first we cover some
7637 general facilities that apply to all four kinds of list.
7638
7639
7640
7641 .section "Expansion of lists" "SECID75"
7642 .cindex "expansion" "of lists"
7643 Each list is expanded as a single string before it is used. The result of
7644 expansion must be a list, possibly containing empty items, which is split up
7645 into separate items for matching. By default, colon is the separator character,
7646 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7647 &<<SECTempitelis>>& for details of the list syntax; the second of these
7648 discusses the way to specify empty list items.
7649
7650
7651 If the string expansion is forced to fail, Exim behaves as if the item it is
7652 testing (domain, host, address, or local part) is not in the list. Other
7653 expansion failures cause temporary errors.
7654
7655 If an item in a list is a regular expression, backslashes, dollars and possibly
7656 other special characters in the expression must be protected against
7657 misinterpretation by the string expander. The easiest way to do this is to use
7658 the &`\N`& expansion feature to indicate that the contents of the regular
7659 expression should not be expanded. For example, in an ACL you might have:
7660 .code
7661 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7662                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7663 .endd
7664 The first item is a regular expression that is protected from expansion by
7665 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7666 senders based on the receiving domain.
7667
7668
7669
7670
7671 .section "Negated items in lists" "SECID76"
7672 .cindex "list" "negation"
7673 .cindex "negation" "in lists"
7674 Items in a list may be positive or negative. Negative items are indicated by a
7675 leading exclamation mark, which may be followed by optional white space. A list
7676 defines a set of items (domains, etc). When Exim processes one of these lists,
7677 it is trying to find out whether a domain, host, address, or local part
7678 (respectively) is in the set that is defined by the list. It works like this:
7679
7680 The list is scanned from left to right. If a positive item is matched, the
7681 subject that is being checked is in the set; if a negative item is matched, the
7682 subject is not in the set. If the end of the list is reached without the
7683 subject having matched any of the patterns, it is in the set if the last item
7684 was a negative one, but not if it was a positive one. For example, the list in
7685 .code
7686 domainlist relay_to_domains = !a.b.c : *.b.c
7687 .endd
7688 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7689 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7690 list is positive. However, if the setting were
7691 .code
7692 domainlist relay_to_domains = !a.b.c
7693 .endd
7694 then all domains other than &'a.b.c'& would match because the last item in the
7695 list is negative. In other words, a list that ends with a negative item behaves
7696 as if it had an extra item &`:*`& on the end.
7697
7698 Another way of thinking about positive and negative items in lists is to read
7699 the connector as &"or"& after a positive item and as &"and"& after a negative
7700 item.
7701
7702
7703
7704 .section "File names in lists" "SECTfilnamlis"
7705 .cindex "list" "file name in"
7706 If an item in a domain, host, address, or local part list is an absolute file
7707 name (beginning with a slash character), each line of the file is read and
7708 processed as if it were an independent item in the list, except that further
7709 file names are not allowed,
7710 and no expansion of the data from the file takes place.
7711 Empty lines in the file are ignored, and the file may also contain comment
7712 lines:
7713
7714 .ilist
7715 For domain and host lists, if a # character appears anywhere in a line of the
7716 file, it and all following characters are ignored.
7717 .next
7718 Because local parts may legitimately contain # characters, a comment in an
7719 address list or local part list file is recognized only if # is preceded by
7720 white space or the start of the line. For example:
7721 .code
7722 not#comment@x.y.z   # but this is a comment
7723 .endd
7724 .endlist
7725
7726 Putting a file name in a list has the same effect as inserting each line of the
7727 file as an item in the list (blank lines and comments excepted). However, there
7728 is one important difference: the file is read each time the list is processed,
7729 so if its contents vary over time, Exim's behaviour changes.
7730
7731 If a file name is preceded by an exclamation mark, the sense of any match
7732 within the file is inverted. For example, if
7733 .code
7734 hold_domains = !/etc/nohold-domains
7735 .endd
7736 and the file contains the lines
7737 .code
7738 !a.b.c
7739 *.b.c
7740 .endd
7741 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7742 any domain matching &`*.b.c`& is not.
7743
7744
7745
7746 .section "An lsearch file is not an out-of-line list" "SECID77"
7747 As will be described in the sections that follow, lookups can be used in lists
7748 to provide indexed methods of checking list membership. There has been some
7749 confusion about the way &(lsearch)& lookups work in lists. Because
7750 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7751 sometimes thought that it is allowed to contain wild cards and other kinds of
7752 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7753 always fixed strings, just as for any other single-key lookup type.
7754
7755 If you want to use a file to contain wild-card patterns that form part of a
7756 list, just give the file name on its own, without a search type, as described
7757 in the previous section. You could also use the &(wildlsearch)& or
7758 &(nwildlsearch)&, but there is no advantage in doing this.
7759
7760
7761
7762
7763 .section "Named lists" "SECTnamedlists"
7764 .cindex "named lists"
7765 .cindex "list" "named"
7766 A list of domains, hosts, email addresses, or local parts can be given a name
7767 which is then used to refer to the list elsewhere in the configuration. This is
7768 particularly convenient if the same list is required in several different
7769 places. It also allows lists to be given meaningful names, which can improve
7770 the readability of the configuration. For example, it is conventional to define
7771 a domain list called &'local_domains'& for all the domains that are handled
7772 locally on a host, using a configuration line such as
7773 .code
7774 domainlist local_domains = localhost:my.dom.example
7775 .endd
7776 Named lists are referenced by giving their name preceded by a plus sign, so,
7777 for example, a router that is intended to handle local domains would be
7778 configured with the line
7779 .code
7780 domains = +local_domains
7781 .endd
7782 The first router in a configuration is often one that handles all domains
7783 except the local ones, using a configuration with a negated item like this:
7784 .code
7785 dnslookup:
7786   driver = dnslookup
7787   domains = ! +local_domains
7788   transport = remote_smtp
7789   no_more
7790 .endd
7791 The four kinds of named list are created by configuration lines starting with
7792 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7793 respectively. Then there follows the name that you are defining, followed by an
7794 equals sign and the list itself. For example:
7795 .code
7796 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7797 addresslist bad_senders = cdb;/etc/badsenders
7798 .endd
7799 A named list may refer to other named lists:
7800 .code
7801 domainlist  dom1 = first.example : second.example
7802 domainlist  dom2 = +dom1 : third.example
7803 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7804 .endd
7805 &*Warning*&: If the last item in a referenced list is a negative one, the
7806 effect may not be what you intended, because the negation does not propagate
7807 out to the higher level. For example, consider:
7808 .code
7809 domainlist  dom1 = !a.b
7810 domainlist  dom2 = +dom1 : *.b
7811 .endd
7812 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7813 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7814 means it matches the second list as well. The effect is not the same as
7815 .code
7816 domainlist  dom2 = !a.b : *.b
7817 .endd
7818 where &'x.y'& does not match. It's best to avoid negation altogether in
7819 referenced lists if you can.
7820
7821 Named lists may have a performance advantage. When Exim is routing an
7822 address or checking an incoming message, it caches the result of tests on named
7823 lists. So, if you have a setting such as
7824 .code
7825 domains = +local_domains
7826 .endd
7827 on several of your routers
7828 or in several ACL statements,
7829 the actual test is done only for the first one. However, the caching works only
7830 if there are no expansions within the list itself or any sublists that it
7831 references. In other words, caching happens only for lists that are known to be
7832 the same each time they are referenced.
7833
7834 By default, there may be up to 16 named lists of each type. This limit can be
7835 extended by changing a compile-time variable. The use of domain and host lists
7836 is recommended for concepts such as local domains, relay domains, and relay
7837 hosts. The default configuration is set up like this.
7838
7839
7840
7841 .section "Named lists compared with macros" "SECID78"
7842 .cindex "list" "named compared with macro"
7843 .cindex "macro" "compared with named list"
7844 At first sight, named lists might seem to be no different from macros in the
7845 configuration file. However, macros are just textual substitutions. If you
7846 write
7847 .code
7848 ALIST = host1 : host2
7849 auth_advertise_hosts = !ALIST
7850 .endd
7851 it probably won't do what you want, because that is exactly the same as
7852 .code
7853 auth_advertise_hosts = !host1 : host2
7854 .endd
7855 Notice that the second host name is not negated. However, if you use a host
7856 list, and write
7857 .code
7858 hostlist alist = host1 : host2
7859 auth_advertise_hosts = ! +alist
7860 .endd
7861 the negation applies to the whole list, and so that is equivalent to
7862 .code
7863 auth_advertise_hosts = !host1 : !host2
7864 .endd
7865
7866
7867 .section "Named list caching" "SECID79"
7868 .cindex "list" "caching of named"
7869 .cindex "caching" "named lists"
7870 While processing a message, Exim caches the result of checking a named list if
7871 it is sure that the list is the same each time. In practice, this means that
7872 the cache operates only if the list contains no $ characters, which guarantees
7873 that it will not change when it is expanded. Sometimes, however, you may have
7874 an expanded list that you know will be the same each time within a given
7875 message. For example:
7876 .code
7877 domainlist special_domains = \
7878            ${lookup{$sender_host_address}cdb{/some/file}}
7879 .endd
7880 This provides a list of domains that depends only on the sending host's IP
7881 address. If this domain list is referenced a number of times (for example,
7882 in several ACL lines, or in several routers) the result of the check is not
7883 cached by default, because Exim does not know that it is going to be the
7884 same list each time.
7885
7886 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7887 cache the result anyway. For example:
7888 .code
7889 domainlist_cache special_domains = ${lookup{...
7890 .endd
7891 If you do this, you should be absolutely sure that caching is going to do
7892 the right thing in all cases. When in doubt, leave it out.
7893
7894
7895
7896 .section "Domain lists" "SECTdomainlist"
7897 .cindex "domain list" "patterns for"
7898 .cindex "list" "domain list"
7899 Domain lists contain patterns that are to be matched against a mail domain.
7900 The following types of item may appear in domain lists:
7901
7902 .ilist
7903 .cindex "primary host name"
7904 .cindex "host name" "matched in domain list"
7905 .oindex "&%primary_hostname%&"
7906 .cindex "domain list" "matching primary host name"
7907 .cindex "@ in a domain list"
7908 If a pattern consists of a single @ character, it matches the local host name,
7909 as set by the &%primary_hostname%& option (or defaulted). This makes it
7910 possible to use the same configuration file on several different hosts that
7911 differ only in their names.
7912 .next
7913 .cindex "@[] in a domain list"
7914 .cindex "domain list" "matching local IP interfaces"
7915 .cindex "domain literal"
7916 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7917 in square brackets (as in an email address that contains a domain literal), but
7918 only if that IP address is recognized as local for email routing purposes. The
7919 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7920 control which of a host's several IP addresses are treated as local.
7921 In today's Internet, the use of domain literals is controversial.
7922 .next
7923 .cindex "@mx_any"
7924 .cindex "@mx_primary"
7925 .cindex "@mx_secondary"
7926 .cindex "domain list" "matching MX pointers to local host"
7927 If a pattern consists of the string &`@mx_any`& it matches any domain that
7928 has an MX record pointing to the local host or to any host that is listed in
7929 .oindex "&%hosts_treat_as_local%&"
7930 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7931 are similar, except that the first matches only when a primary MX target is the
7932 local host, and the second only when no primary MX target is the local host,
7933 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7934 preference value &-- there may of course be more than one of them.
7935
7936 The MX lookup that takes place when matching a pattern of this type is
7937 performed with the resolver options for widening names turned off. Thus, for
7938 example, a single-component domain will &'not'& be expanded by adding the
7939 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7940 options of the &(dnslookup)& router for a discussion of domain widening.
7941
7942 Sometimes you may want to ignore certain IP addresses when using one of these
7943 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7944 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7945 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7946 on a router). For example:
7947 .code
7948 domains = @mx_any/ignore=127.0.0.1
7949 .endd
7950 This example matches any domain that has an MX record pointing to one of
7951 the local host's IP addresses other than 127.0.0.1.
7952
7953 The list of IP addresses is in fact processed by the same code that processes
7954 host lists, so it may contain CIDR-coded network specifications and it may also
7955 contain negative items.
7956
7957 Because the list of IP addresses is a sublist within a domain list, you have to
7958 be careful about delimiters if there is more than one address. Like any other
7959 list, the default delimiter can be changed. Thus, you might have:
7960 .code
7961 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7962           an.other.domain : ...
7963 .endd
7964 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7965 involved, it is easiest to change the delimiter for the main list as well:
7966 .code
7967 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7968           an.other.domain ? ...
7969 .endd
7970 .next
7971 .cindex "asterisk" "in domain list"
7972 .cindex "domain list" "asterisk in"
7973 .cindex "domain list" "matching &""ends with""&"
7974 If a pattern starts with an asterisk, the remaining characters of the pattern
7975 are compared with the terminating characters of the domain. The use of &"*"& in
7976 domain lists differs from its use in partial matching lookups. In a domain
7977 list, the character following the asterisk need not be a dot, whereas partial
7978 matching works only in terms of dot-separated components. For example, a domain
7979 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7980 &'cipher.key.ex'&.
7981
7982 .next
7983 .cindex "regular expressions" "in domain list"
7984 .cindex "domain list" "matching regular expression"
7985 If a pattern starts with a circumflex character, it is treated as a regular
7986 expression, and matched against the domain using a regular expression matching
7987 function. The circumflex is treated as part of the regular expression.
7988 Email domains are case-independent, so this regular expression match is by
7989 default case-independent, but you can make it case-dependent by starting it
7990 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7991 are given in chapter &<<CHAPregexp>>&.
7992
7993 &*Warning*&: Because domain lists are expanded before being processed, you
7994 must escape any backslash and dollar characters in the regular expression, or
7995 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7996 it is not to be expanded (unless you really do want to build a regular
7997 expression by expansion, of course).
7998 .next
7999 .cindex "lookup" "in domain list"
8000 .cindex "domain list" "matching by lookup"
8001 If a pattern starts with the name of a single-key lookup type followed by a
8002 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8003 must be a file name in a suitable format for the lookup type. For example, for
8004 &"cdb;"& it must be an absolute path:
8005 .code
8006 domains = cdb;/etc/mail/local_domains.cdb
8007 .endd
8008 The appropriate type of lookup is done on the file using the domain name as the
8009 key. In most cases, the data that is looked up is not used; Exim is interested
8010 only in whether or not the key is present in the file. However, when a lookup
8011 is used for the &%domains%& option on a router
8012 or a &%domains%& condition in an ACL statement, the data is preserved in the
8013 &$domain_data$& variable and can be referred to in other router options or
8014 other statements in the same ACL.
8015
8016 .next
8017 Any of the single-key lookup type names may be preceded by
8018 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8019 .code
8020 domains = partial-dbm;/partial/domains
8021 .endd
8022 This causes partial matching logic to be invoked; a description of how this
8023 works is given in section &<<SECTpartiallookup>>&.
8024
8025 .next
8026 .cindex "asterisk" "in lookup type"
8027 Any of the single-key lookup types may be followed by an asterisk. This causes
8028 a default lookup for a key consisting of a single asterisk to be done if the
8029 original lookup fails. This is not a useful feature when using a domain list to
8030 select particular domains (because any domain would match), but it might have
8031 value if the result of the lookup is being used via the &$domain_data$&
8032 expansion variable.
8033 .next
8034 If the pattern starts with the name of a query-style lookup type followed by a
8035 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8036 pattern must be an appropriate query for the lookup type, as described in
8037 chapter &<<CHAPfdlookup>>&. For example:
8038 .code
8039 hold_domains = mysql;select domain from holdlist \
8040   where domain = '${quote_mysql:$domain}';
8041 .endd
8042 In most cases, the data that is looked up is not used (so for an SQL query, for
8043 example, it doesn't matter what field you select). Exim is interested only in
8044 whether or not the query succeeds. However, when a lookup is used for the
8045 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8046 variable and can be referred to in other options.
8047 .next
8048 .cindex "domain list" "matching literal domain name"
8049 If none of the above cases apply, a caseless textual comparison is made
8050 between the pattern and the domain.
8051 .endlist
8052
8053 Here is an example that uses several different kinds of pattern:
8054 .code
8055 domainlist funny_domains = \
8056   @ : \
8057   lib.unseen.edu : \
8058   *.foundation.fict.example : \
8059   \N^[1-2]\d{3}\.fict\.example$\N : \
8060   partial-dbm;/opt/data/penguin/book : \
8061   nis;domains.byname : \
8062   nisplus;[name=$domain,status=local],domains.org_dir
8063 .endd
8064 There are obvious processing trade-offs among the various matching modes. Using
8065 an asterisk is faster than a regular expression, and listing a few names
8066 explicitly probably is too. The use of a file or database lookup is expensive,
8067 but may be the only option if hundreds of names are required. Because the
8068 patterns are tested in order, it makes sense to put the most commonly matched
8069 patterns earlier.
8070
8071
8072
8073 .section "Host lists" "SECThostlist"
8074 .cindex "host list" "patterns in"
8075 .cindex "list" "host list"
8076 Host lists are used to control what remote hosts are allowed to do. For
8077 example, some hosts may be allowed to use the local host as a relay, and some
8078 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8079 two different ways, by name or by IP address. In a host list, some types of
8080 pattern are matched to a host name, and some are matched to an IP address.
8081 You need to be particularly careful with this when single-key lookups are
8082 involved, to ensure that the right value is being used as the key.
8083
8084
8085 .section "Special host list patterns" "SECID80"
8086 .cindex "empty item in hosts list"
8087 .cindex "host list" "empty string in"
8088 If a host list item is the empty string, it matches only when no remote host is
8089 involved. This is the case when a message is being received from a local
8090 process using SMTP on the standard input, that is, when a TCP/IP connection is
8091 not used.
8092
8093 .cindex "asterisk" "in host list"
8094 The special pattern &"*"& in a host list matches any host or no host. Neither
8095 the IP address nor the name is actually inspected.
8096
8097
8098
8099 .section "Host list patterns that match by IP address" "SECThoslispatip"
8100 .cindex "host list" "matching IP addresses"
8101 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8102 the incoming address actually appears in the IPv6 host as
8103 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8104 list, it is converted into a traditional IPv4 address first. (Not all operating
8105 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8106 concerns.)
8107
8108 The following types of pattern in a host list check the remote host by
8109 inspecting its IP address:
8110
8111 .ilist
8112 If the pattern is a plain domain name (not a regular expression, not starting
8113 with *, not a lookup of any kind), Exim calls the operating system function
8114 to find the associated IP address(es). Exim uses the newer
8115 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8116 This typically causes a forward DNS lookup of the name. The result is compared
8117 with the IP address of the subject host.
8118
8119 If there is a temporary problem (such as a DNS timeout) with the host name
8120 lookup, a temporary error occurs. For example, if the list is being used in an
8121 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8122 temporary SMTP error code. If no IP address can be found for the host name,
8123 what happens is described in section &<<SECTbehipnot>>& below.
8124
8125 .next
8126 .cindex "@ in a host list"
8127 If the pattern is &"@"&, the primary host name is substituted and used as a
8128 domain name, as just described.
8129
8130 .next
8131 If the pattern is an IP address, it is matched against the IP address of the
8132 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8133 IPv6 addresses can be given in colon-separated format, but the colons have to
8134 be doubled so as not to be taken as item separators when the default list
8135 separator is used. IPv6 addresses are recognized even when Exim is compiled
8136 without IPv6 support. This means that if they appear in a host list on an
8137 IPv4-only host, Exim will not treat them as host names. They are just addresses
8138 that can never match a client host.
8139
8140 .next
8141 .cindex "@[] in a host list"
8142 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8143 the local host. For example, if the local host is an IPv4 host with one
8144 interface address 10.45.23.56, these two ACL statements have the same effect:
8145 .code
8146 accept hosts = 127.0.0.1 : 10.45.23.56
8147 accept hosts = @[]
8148 .endd
8149 .next
8150 .cindex "CIDR notation"
8151 If the pattern is an IP address followed by a slash and a mask length (for
8152 example 10.11.42.0/24), it is matched against the IP address of the subject
8153 host under the given mask. This allows, an entire network of hosts to be
8154 included (or excluded) by a single item. The mask uses CIDR notation; it
8155 specifies the number of address bits that must match, starting from the most
8156 significant end of the address.
8157
8158 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8159 of a range of addresses. It is the number of bits in the network portion of the
8160 address. The above example specifies a 24-bit netmask, so it matches all 256
8161 addresses in the 10.11.42.0 network. An item such as
8162 .code
8163 192.168.23.236/31
8164 .endd
8165 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8166 32 for an IPv4 address is the same as no mask at all; just a single address
8167 matches.
8168
8169 Here is another example which shows an IPv4 and an IPv6 network:
8170 .code
8171 recipient_unqualified_hosts = 192.168.0.0/16: \
8172                               3ffe::ffff::836f::::/48
8173 .endd
8174 The doubling of list separator characters applies only when these items
8175 appear inline in a host list. It is not required when indirecting via a file.
8176 For example:
8177 .code
8178 recipient_unqualified_hosts = /opt/exim/unqualnets
8179 .endd
8180 could make use of a file containing
8181 .code
8182 172.16.0.0/12
8183 3ffe:ffff:836f::/48
8184 .endd
8185 to have exactly the same effect as the previous example. When listing IPv6
8186 addresses inline, it is usually more convenient to use the facility for
8187 changing separator characters. This list contains the same two networks:
8188 .code
8189 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8190                                  3ffe:ffff:836f::/48
8191 .endd
8192 The separator is changed to semicolon by the leading &"<;"& at the start of the
8193 list.
8194 .endlist
8195
8196
8197
8198 .section "Host list patterns for single-key lookups by host address" &&&
8199          "SECThoslispatsikey"
8200 .cindex "host list" "lookup of IP address"
8201 When a host is to be identified by a single-key lookup of its complete IP
8202 address, the pattern takes this form:
8203 .display
8204 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8205 .endd
8206 For example:
8207 .code
8208 hosts_lookup = net-cdb;/hosts-by-ip.db
8209 .endd
8210 The text form of the IP address of the subject host is used as the lookup key.
8211 IPv6 addresses are converted to an unabbreviated form, using lower case
8212 letters, with dots as separators because colon is the key terminator in
8213 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8214 quoting the keys, but this is a facility that was added later.] The data
8215 returned by the lookup is not used.
8216
8217 .cindex "IP address" "masking"
8218 .cindex "host list" "masked IP address"
8219 Single-key lookups can also be performed using masked IP addresses, using
8220 patterns of this form:
8221 .display
8222 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8223 .endd
8224 For example:
8225 .code
8226 net24-dbm;/networks.db
8227 .endd
8228 The IP address of the subject host is masked using <&'number'&> as the mask
8229 length. A textual string is constructed from the masked value, followed by the
8230 mask, and this is used as the lookup key. For example, if the host's IP address
8231 is 192.168.34.6, the key that is looked up for the above example is
8232 &"192.168.34.0/24"&.
8233
8234 When an IPv6 address is converted to a string, dots are normally used instead
8235 of colons, so that keys in &(lsearch)& files need not contain colons (which
8236 terminate &(lsearch)& keys). This was implemented some time before the ability
8237 to quote keys was made available in &(lsearch)& files. However, the more
8238 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8239 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8240 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8241 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8242 addresses are always used.
8243
8244 Ideally, it would be nice to tidy up this anomalous situation by changing to
8245 colons in all cases, given that quoting is now available for &(lsearch)&.
8246 However, this would be an incompatible change that might break some existing
8247 configurations.
8248
8249 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8250 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8251 the former case the key strings include the mask value, whereas in the latter
8252 case the IP address is used on its own.
8253
8254
8255
8256 .section "Host list patterns that match by host name" "SECThoslispatnam"
8257 .cindex "host" "lookup failures"
8258 .cindex "unknown host name"
8259 .cindex "host list" "matching host name"
8260 There are several types of pattern that require Exim to know the name of the
8261 remote host. These are either wildcard patterns or lookups by name. (If a
8262 complete hostname is given without any wildcarding, it is used to find an IP
8263 address to match against, as described in section &<<SECThoslispatip>>&
8264 above.)
8265
8266 If the remote host name is not already known when Exim encounters one of these
8267 patterns, it has to be found from the IP address.
8268 Although many sites on the Internet are conscientious about maintaining reverse
8269 DNS data for their hosts, there are also many that do not do this.
8270 Consequently, a name cannot always be found, and this may lead to unwanted
8271 effects. Take care when configuring host lists with wildcarded name patterns.
8272 Consider what will happen if a name cannot be found.
8273
8274 Because of the problems of determining host names from IP addresses, matching
8275 against host names is not as common as matching against IP addresses.
8276
8277 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8278 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8279 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8280 are done can be changed by setting the &%host_lookup_order%& option. For
8281 security, once Exim has found one or more names, it looks up the IP addresses
8282 for these names and compares them with the IP address that it started with.
8283 Only those names whose IP addresses match are accepted. Any other names are
8284 discarded. If no names are left, Exim behaves as if the host name cannot be
8285 found. In the most common case there is only one name and one IP address.
8286
8287 There are some options that control what happens if a host name cannot be
8288 found. These are described in section &<<SECTbehipnot>>& below.
8289
8290 .cindex "host" "alias for"
8291 .cindex "alias for host"
8292 As a result of aliasing, hosts may have more than one name. When processing any
8293 of the following types of pattern, all the host's names are checked:
8294
8295 .ilist
8296 .cindex "asterisk" "in host list"
8297 If a pattern starts with &"*"& the remainder of the item must match the end of
8298 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8299 &'.b.c'&. This special simple form is provided because this is a very common
8300 requirement. Other kinds of wildcarding require the use of a regular
8301 expression.
8302 .next
8303 .cindex "regular expressions" "in host list"
8304 .cindex "host list" "regular expression in"
8305 If the item starts with &"^"& it is taken to be a regular expression which is
8306 matched against the host name. Host names are case-independent, so this regular
8307 expression match is by default case-independent, but you can make it
8308 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8309 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8310 example,
8311 .code
8312 ^(a|b)\.c\.d$
8313 .endd
8314 is a regular expression that matches either of the two hosts &'a.c.d'& or
8315 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8316 that backslash and dollar characters are not misinterpreted as part of the
8317 string expansion. The simplest way to do this is to use &`\N`& to mark that
8318 part of the string as non-expandable. For example:
8319 .code
8320 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8321 .endd
8322 &*Warning*&: If you want to match a complete host name, you must include the
8323 &`$`& terminating metacharacter in the regular expression, as in the above
8324 example. Without it, a match at the start of the host name is all that is
8325 required.
8326 .endlist
8327
8328
8329
8330
8331 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8332 .cindex "host" "lookup failures, permanent"
8333 While processing a host list, Exim may need to look up an IP address from a
8334 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8335 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8336 behaviour when it fails to find the information it is seeking is the same.
8337
8338 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8339 apply to temporary DNS errors, whose handling is described in the next section.
8340
8341 .cindex "&`+include_unknown`&"
8342 .cindex "&`+ignore_unknown`&"
8343 Exim parses a host list from left to right. If it encounters a permanent
8344 lookup failure in any item in the host list before it has found a match,
8345 Exim treats it as a failure and the default behavior is as if the host
8346 does not match the list. This may not always be what you want to happen.
8347 To change Exim's behaviour, the special items &`+include_unknown`& or
8348 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8349 not recognized in an indirected file).
8350
8351 .ilist
8352 If any item that follows &`+include_unknown`& requires information that
8353 cannot found, Exim behaves as if the host does match the list. For example,
8354 .code
8355 host_reject_connection = +include_unknown:*.enemy.ex
8356 .endd
8357 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8358 any hosts whose name it cannot find.
8359
8360 .next
8361 If any item that follows &`+ignore_unknown`& requires information that cannot
8362 be found, Exim ignores that item and proceeds to the rest of the list. For
8363 example:
8364 .code
8365 accept hosts = +ignore_unknown : friend.example : \
8366                192.168.4.5
8367 .endd
8368 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8369 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8370 name can be found for 192.168.4.5, it is rejected.
8371 .endlist
8372
8373 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8374 list. The effect of each one lasts until the next, or until the end of the
8375 list.
8376
8377 .section "Mixing wildcarded host names and addresses in host lists" &&&
8378          "SECTmixwilhos"
8379 .cindex "host list" "mixing names and addresses in"
8380
8381 This section explains the host/ip processing logic with the same concepts
8382 as the previous section, but specifically addresses what happens when a
8383 wildcarded hostname is one of the items in the hostlist.
8384
8385 .ilist
8386 If you have name lookups or wildcarded host names and
8387 IP addresses in the same host list, you should normally put the IP
8388 addresses first. For example, in an ACL you could have:
8389 .code
8390 accept hosts = 10.9.8.7 : *.friend.example
8391 .endd
8392 The reason you normally would order it this way lies in the
8393 left-to-right way that Exim processes lists.  It can test IP addresses
8394 without doing any DNS lookups, but when it reaches an item that requires
8395 a host name, it fails if it cannot find a host name to compare with the
8396 pattern. If the above list is given in the opposite order, the
8397 &%accept%& statement fails for a host whose name cannot be found, even
8398 if its IP address is 10.9.8.7.
8399
8400 .next
8401 If you really do want to do the name check first, and still recognize the IP
8402 address, you can rewrite the ACL like this:
8403 .code
8404 accept hosts = *.friend.example
8405 accept hosts = 10.9.8.7
8406 .endd
8407 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8408 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8409 &`+ignore_unknown`&, which was discussed in depth in the first example in
8410 this section.
8411 .endlist
8412
8413
8414 .section "Temporary DNS errors when looking up host information" &&&
8415          "SECTtemdnserr"
8416 .cindex "host" "lookup failures, temporary"
8417 .cindex "&`+include_defer`&"
8418 .cindex "&`+ignore_defer`&"
8419 A temporary DNS lookup failure normally causes a defer action (except when
8420 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8421 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8422 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8423 section. These options should be used with care, probably only in non-critical
8424 host lists such as whitelists.
8425
8426
8427
8428 .section "Host list patterns for single-key lookups by host name" &&&
8429          "SECThoslispatnamsk"
8430 .cindex "unknown host name"
8431 .cindex "host list" "matching host name"
8432 If a pattern is of the form
8433 .display
8434 <&'single-key-search-type'&>;<&'search-data'&>
8435 .endd
8436 for example
8437 .code
8438 dbm;/host/accept/list
8439 .endd
8440 a single-key lookup is performed, using the host name as its key. If the
8441 lookup succeeds, the host matches the item. The actual data that is looked up
8442 is not used.
8443
8444 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8445 keys in the file, not IP addresses. If you want to do lookups based on IP
8446 addresses, you must precede the search type with &"net-"& (see section
8447 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8448 two items in the same list, one doing an address lookup and one doing a name
8449 lookup, both using the same file.
8450
8451
8452
8453 .section "Host list patterns for query-style lookups" "SECID81"
8454 If a pattern is of the form
8455 .display
8456 <&'query-style-search-type'&>;<&'query'&>
8457 .endd
8458 the query is obeyed, and if it succeeds, the host matches the item. The actual
8459 data that is looked up is not used. The variables &$sender_host_address$& and
8460 &$sender_host_name$& can be used in the query. For example:
8461 .code
8462 hosts_lookup = pgsql;\
8463   select ip from hostlist where ip='$sender_host_address'
8464 .endd
8465 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8466 can use the &%sg%& expansion item to change this if you need to. If you want to
8467 use masked IP addresses in database queries, you can use the &%mask%& expansion
8468 operator.
8469
8470 If the query contains a reference to &$sender_host_name$&, Exim automatically
8471 looks up the host name if it has not already done so. (See section
8472 &<<SECThoslispatnam>>& for comments on finding host names.)
8473
8474 Historical note: prior to release 4.30, Exim would always attempt to find a
8475 host name before running the query, unless the search type was preceded by
8476 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8477 still recognized for query-style lookups, but its presence or absence has no
8478 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8479 See section &<<SECThoslispatsikey>>&.)
8480
8481
8482
8483
8484
8485 .section "Address lists" "SECTaddresslist"
8486 .cindex "list" "address list"
8487 .cindex "address list" "empty item"
8488 .cindex "address list" "patterns"
8489 Address lists contain patterns that are matched against mail addresses. There
8490 is one special case to be considered: the sender address of a bounce message is
8491 always empty. You can test for this by providing an empty item in an address
8492 list. For example, you can set up a router to process bounce messages by
8493 using this option setting:
8494 .code
8495 senders = :
8496 .endd
8497 The presence of the colon creates an empty item. If you do not provide any
8498 data, the list is empty and matches nothing. The empty sender can also be
8499 detected by a regular expression that matches an empty string,
8500 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8501
8502 Non-empty items in an address list can be straightforward email addresses. For
8503 example:
8504 .code
8505 senders = jbc@askone.example : hs@anacreon.example
8506 .endd
8507 A certain amount of wildcarding is permitted. If a pattern contains an @
8508 character, but is not a regular expression and does not begin with a
8509 semicolon-terminated lookup type (described below), the local part of the
8510 subject address is compared with the local part of the pattern, which may start
8511 with an asterisk. If the local parts match, the domain is checked in exactly
8512 the same way as for a pattern in a domain list. For example, the domain can be
8513 wildcarded, refer to a named list, or be a lookup:
8514 .code
8515 deny senders = *@*.spamming.site:\
8516                *@+hostile_domains:\
8517                bozo@partial-lsearch;/list/of/dodgy/sites:\
8518                *@dbm;/bad/domains.db
8519 .endd
8520 .cindex "local part" "starting with !"
8521 .cindex "address list" "local part starting with !"
8522 If a local part that begins with an exclamation mark is required, it has to be
8523 specified using a regular expression, because otherwise the exclamation mark is
8524 treated as a sign of negation, as is standard in lists.
8525
8526 If a non-empty pattern that is not a regular expression or a lookup does not
8527 contain an @ character, it is matched against the domain part of the subject
8528 address. The only two formats that are recognized this way are a literal
8529 domain, or a domain pattern that starts with *. In both these cases, the effect
8530 is the same as if &`*@`& preceded the pattern. For example:
8531 .code
8532 deny senders = enemy.domain : *.enemy.domain
8533 .endd
8534
8535 The following kinds of more complicated address list pattern can match any
8536 address, including the empty address that is characteristic of bounce message
8537 senders:
8538
8539 .ilist
8540 .cindex "regular expressions" "in address list"
8541 .cindex "address list" "regular expression in"
8542 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8543 done against the complete address, with the pattern as the regular expression.
8544 You must take care that backslash and dollar characters are not misinterpreted
8545 as part of the string expansion. The simplest way to do this is to use &`\N`&
8546 to mark that part of the string as non-expandable. For example:
8547 .code
8548 deny senders = \N^.*this.*@example\.com$\N : \
8549                \N^\d{8}.+@spamhaus.example$\N : ...
8550 .endd
8551 The &`\N`& sequences are removed by the expansion, so these items do indeed
8552 start with &"^"& by the time they are being interpreted as address patterns.
8553
8554 .next
8555 .cindex "address list" "lookup for complete address"
8556 Complete addresses can be looked up by using a pattern that starts with a
8557 lookup type terminated by a semicolon, followed by the data for the lookup. For
8558 example:
8559 .code
8560 deny senders = cdb;/etc/blocked.senders : \
8561   mysql;select address from blocked where \
8562   address='${quote_mysql:$sender_address}'
8563 .endd
8564 Both query-style and single-key lookup types can be used. For a single-key
8565 lookup type, Exim uses the complete address as the key. However, empty keys are
8566 not supported for single-key lookups, so a match against the empty address
8567 always fails. This restriction does not apply to query-style lookups.
8568
8569 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8570 cannot be used, and is ignored if specified, with an entry being written to the
8571 panic log.
8572 .cindex "*@ with single-key lookup"
8573 However, you can configure lookup defaults, as described in section
8574 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8575 default. For example, with this lookup:
8576 .code
8577 accept senders = lsearch*@;/some/file
8578 .endd
8579 the file could contains lines like this:
8580 .code
8581 user1@domain1.example
8582 *@domain2.example
8583 .endd
8584 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8585 that are tried is:
8586 .code
8587 nimrod@jaeger.example
8588 *@jaeger.example
8589 *
8590 .endd
8591 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8592 would mean that every address matches, thus rendering the test useless.
8593
8594 &*Warning 2*&: Do not confuse these two kinds of item:
8595 .code
8596 deny recipients = dbm*@;/some/file
8597 deny recipients = *@dbm;/some/file
8598 .endd
8599 The first does a whole address lookup, with defaulting, as just described,
8600 because it starts with a lookup type. The second matches the local part and
8601 domain independently, as described in a bullet point below.
8602 .endlist
8603
8604
8605 The following kinds of address list pattern can match only non-empty addresses.
8606 If the subject address is empty, a match against any of these pattern types
8607 always fails.
8608
8609
8610 .ilist
8611 .cindex "@@ with single-key lookup"
8612 .cindex "address list" "@@ lookup type"
8613 .cindex "address list" "split local part and domain"
8614 If a pattern starts with &"@@"& followed by a single-key lookup item
8615 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8616 split into a local part and a domain. The domain is looked up in the file. If
8617 it is not found, there is no match. If it is found, the data that is looked up
8618 from the file is treated as a colon-separated list of local part patterns, each
8619 of which is matched against the subject local part in turn.
8620
8621 .cindex "asterisk" "in address list"
8622 The lookup may be a partial one, and/or one involving a search for a default
8623 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8624 patterns that are looked up can be regular expressions or begin with &"*"&, or
8625 even be further lookups. They may also be independently negated. For example,
8626 with
8627 .code
8628 deny senders = @@dbm;/etc/reject-by-domain
8629 .endd
8630 the data from which the DBM file is built could contain lines like
8631 .code
8632 baddomain.com:  !postmaster : *
8633 .endd
8634 to reject all senders except &%postmaster%& from that domain.
8635
8636 .cindex "local part" "starting with !"
8637 If a local part that actually begins with an exclamation mark is required, it
8638 has to be specified using a regular expression. In &(lsearch)& files, an entry
8639 may be split over several lines by indenting the second and subsequent lines,
8640 but the separating colon must still be included at line breaks. White space
8641 surrounding the colons is ignored. For example:
8642 .code
8643 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8644   spammer3 : spammer4
8645 .endd
8646 As in all colon-separated lists in Exim, a colon can be included in an item by
8647 doubling.
8648
8649 If the last item in the list starts with a right angle-bracket, the remainder
8650 of the item is taken as a new key to look up in order to obtain a continuation
8651 list of local parts. The new key can be any sequence of characters. Thus one
8652 might have entries like
8653 .code
8654 aol.com: spammer1 : spammer 2 : >*
8655 xyz.com: spammer3 : >*
8656 *:       ^\d{8}$
8657 .endd
8658 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8659 local parts for all domains, in addition to the specific local parts listed for
8660 each domain. Of course, using this feature costs another lookup each time a
8661 chain is followed, but the effort needed to maintain the data is reduced.
8662
8663 .cindex "loop" "in lookups"
8664 It is possible to construct loops using this facility, and in order to catch
8665 them, the chains may be no more than fifty items long.
8666
8667 .next
8668 The @@<&'lookup'&> style of item can also be used with a query-style
8669 lookup, but in this case, the chaining facility is not available. The lookup
8670 can only return a single list of local parts.
8671 .endlist
8672
8673 &*Warning*&: There is an important difference between the address list items
8674 in these two examples:
8675 .code
8676 senders = +my_list
8677 senders = *@+my_list
8678 .endd
8679 In the first one, &`my_list`& is a named address list, whereas in the second
8680 example it is a named domain list.
8681
8682
8683
8684
8685 .section "Case of letters in address lists" "SECTcasletadd"
8686 .cindex "case of local parts"
8687 .cindex "address list" "case forcing"
8688 .cindex "case forcing in address lists"
8689 Domains in email addresses are always handled caselessly, but for local parts
8690 case may be significant on some systems (see &%caseful_local_part%& for how
8691 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8692 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8693 blocking lists should be done in a case-independent manner. Since most address
8694 lists in Exim are used for this kind of control, Exim attempts to do this by
8695 default.
8696
8697 The domain portion of an address is always lowercased before matching it to an
8698 address list. The local part is lowercased by default, and any string
8699 comparisons that take place are done caselessly. This means that the data in
8700 the address list itself, in files included as plain file names, and in any file
8701 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8702 keys in files that are looked up by a search type other than &(lsearch)& (which
8703 works caselessly) must be in lower case, because these lookups are not
8704 case-independent.
8705
8706 .cindex "&`+caseful`&"
8707 To allow for the possibility of caseful address list matching, if an item in
8708 an address list is the string &"+caseful"&, the original case of the local
8709 part is restored for any comparisons that follow, and string comparisons are no
8710 longer case-independent. This does not affect the domain, which remains in
8711 lower case. However, although independent matches on the domain alone are still
8712 performed caselessly, regular expressions that match against an entire address
8713 become case-sensitive after &"+caseful"& has been seen.
8714
8715
8716
8717 .section "Local part lists" "SECTlocparlis"
8718 .cindex "list" "local part list"
8719 .cindex "local part" "list"
8720 Case-sensitivity in local part lists is handled in the same way as for address
8721 lists, as just described. The &"+caseful"& item can be used if required. In a
8722 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8723 set false, the subject is lowercased and the matching is initially
8724 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8725 matching in the local part list, but not elsewhere in the router. If
8726 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8727 option is case-sensitive from the start.
8728
8729 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8730 comments are handled in the same way as address lists &-- they are recognized
8731 only if the # is preceded by white space or the start of the line.
8732 Otherwise, local part lists are matched in the same way as domain lists, except
8733 that the special items that refer to the local host (&`@`&, &`@[]`&,
8734 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8735 Refer to section &<<SECTdomainlist>>& for details of the other available item
8736 types.
8737 .ecindex IIDdohoadli
8738
8739
8740
8741
8742 . ////////////////////////////////////////////////////////////////////////////
8743 . ////////////////////////////////////////////////////////////////////////////
8744
8745 .chapter "String expansions" "CHAPexpand"
8746 .scindex IIDstrexp "expansion" "of strings"
8747 Many strings in Exim's run time configuration are expanded before use. Some of
8748 them are expanded every time they are used; others are expanded only once.
8749
8750 When a string is being expanded it is copied verbatim from left to right except
8751 when a dollar or backslash character is encountered. A dollar specifies the
8752 start of a portion of the string that is interpreted and replaced as described
8753 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8754 escape character, as described in the following section.
8755
8756 Whether a string is expanded depends upon the context.  Usually this is solely
8757 dependent upon the option for which a value is sought; in this documentation,
8758 options for which string expansion is performed are marked with &dagger; after
8759 the data type.  ACL rules always expand strings.  A couple of expansion
8760 conditions do not expand some of the brace-delimited branches, for security
8761 reasons.
8762
8763
8764
8765 .section "Literal text in expanded strings" "SECTlittext"
8766 .cindex "expansion" "including literal text"
8767 An uninterpreted dollar can be included in an expanded string by putting a
8768 backslash in front of it. A backslash can be used to prevent any special
8769 character being treated specially in an expansion, including backslash itself.
8770 If the string appears in quotes in the configuration file, two backslashes are
8771 required because the quotes themselves cause interpretation of backslashes when
8772 the string is read in (see section &<<SECTstrings>>&).
8773
8774 .cindex "expansion" "non-expandable substrings"
8775 A portion of the string can specified as non-expandable by placing it between
8776 two occurrences of &`\N`&. This is particularly useful for protecting regular
8777 expressions, which often contain backslashes and dollar signs. For example:
8778 .code
8779 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8780 .endd
8781 On encountering the first &`\N`&, the expander copies subsequent characters
8782 without interpretation until it reaches the next &`\N`& or the end of the
8783 string.
8784
8785
8786
8787 .section "Character escape sequences in expanded strings" "SECID82"
8788 .cindex "expansion" "escape sequences"
8789 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8790 expanded string is recognized as an escape sequence for the character newline,
8791 carriage return, or tab, respectively. A backslash followed by up to three
8792 octal digits is recognized as an octal encoding for a single character, and a
8793 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8794 encoding.
8795
8796 These escape sequences are also recognized in quoted strings when they are read
8797 in. Their interpretation in expansions as well is useful for unquoted strings,
8798 and for other cases such as looked-up strings that are then expanded.
8799
8800
8801 .section "Testing string expansions" "SECID83"
8802 .cindex "expansion" "testing"
8803 .cindex "testing" "string expansion"
8804 .oindex "&%-be%&"
8805 Many expansions can be tested by calling Exim with the &%-be%& option. This
8806 takes the command arguments, or lines from the standard input if there are no
8807 arguments, runs them through the string expansion code, and writes the results
8808 to the standard output. Variables based on configuration values are set up, but
8809 since no message is being processed, variables such as &$local_part$& have no
8810 value. Nevertheless the &%-be%& option can be useful for checking out file and
8811 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8812 and &%nhash%&.
8813
8814 Exim gives up its root privilege when it is called with the &%-be%& option, and
8815 instead runs under the uid and gid it was called with, to prevent users from
8816 using &%-be%& for reading files to which they do not have access.
8817
8818 .oindex "&%-bem%&"
8819 If you want to test expansions that include variables whose values are taken
8820 from a message, there are two other options that can be used. The &%-bem%&
8821 option is like &%-be%& except that it is followed by a file name. The file is
8822 read as a message before doing the test expansions. For example:
8823 .code
8824 exim -bem /tmp/test.message '$h_subject:'
8825 .endd
8826 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8827 Exim message identifier. For example:
8828 .code
8829 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8830 .endd
8831 This loads the message from Exim's spool before doing the test expansions, and
8832 is therefore restricted to admin users.
8833
8834
8835 .section "Forced expansion failure" "SECTforexpfai"
8836 .cindex "expansion" "forced failure"
8837 A number of expansions that are described in the following section have
8838 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8839 (which are sometimes called &"curly brackets"&). Which of the two strings is
8840 used depends on some condition that is evaluated as part of the expansion. If,
8841 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8842 the entire string expansion fails in a way that can be detected by the code
8843 that requested the expansion. This is called &"forced expansion failure"&, and
8844 its consequences depend on the circumstances. In some cases it is no different
8845 from any other expansion failure, but in others a different action may be
8846 taken. Such variations are mentioned in the documentation of the option that is
8847 being expanded.
8848
8849
8850
8851
8852 .section "Expansion items" "SECTexpansionitems"
8853 The following items are recognized in expanded strings. White space may be used
8854 between sub-items that are keywords or substrings enclosed in braces inside an
8855 outer set of braces, to improve readability. &*Warning*&: Within braces,
8856 white space is significant.
8857
8858 .vlist
8859 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8860 .cindex "expansion" "variables"
8861 Substitute the contents of the named variable, for example:
8862 .code
8863 $local_part
8864 ${domain}
8865 .endd
8866 The second form can be used to separate the name from subsequent alphanumeric
8867 characters. This form (using braces) is available only for variables; it does
8868 &'not'& apply to message headers. The names of the variables are given in
8869 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8870 given, the expansion fails.
8871
8872 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8873 .cindex "expansion" "operators"
8874 The string is first itself expanded, and then the operation specified by
8875 <&'op'&> is applied to it. For example:
8876 .code
8877 ${lc:$local_part}
8878 .endd
8879 The string starts with the first character after the colon, which may be
8880 leading white space. A list of operators is given in section &<<SECTexpop>>&
8881 below. The operator notation is used for simple expansion items that have just
8882 one argument, because it reduces the number of braces and therefore makes the
8883 string easier to understand.
8884
8885 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8886 This item inserts &"basic"& header lines. It is described with the &%header%&
8887 expansion item below.
8888
8889
8890 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8891 .cindex "expansion" "calling an acl"
8892 .cindex "&%acl%&" "call from expansion"
8893 The name and zero to nine argument strings are first expanded separately.  The expanded
8894 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8895 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8896 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8897 and may use the variables; if another acl expansion is used the values
8898 are restored after it returns.  If the ACL sets
8899 a value using a "message =" modifier and returns accept or deny, the value becomes
8900 the result of the expansion.
8901 If no message is set and the ACL returns accept or deny
8902 the expansion result is an empty string.
8903 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8904
8905
8906 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8907        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8908 .cindex "expansion" "extracting cerificate fields"
8909 .cindex "&%certextract%&" "certificate fields"
8910 .cindex "certificate" "extracting fields"
8911 The <&'certificate'&> must be a variable of type certificate.
8912 The field name is expanded and used to retrive the relevant field from
8913 the certificate.  Supported fields are:
8914 .display
8915 &`version        `&
8916 &`serial_number  `&
8917 &`subject        `& RFC4514 DN
8918 &`issuer         `& RFC4514 DN
8919 &`notbefore      `& time
8920 &`notafter       `& time
8921 &`sig_algorithm  `&
8922 &`signature      `&
8923 &`subj_altname   `& tagged list
8924 &`ocsp_uri       `& list
8925 &`crl_uri        `& list
8926 .endd
8927 If the field is found,
8928 <&'string2'&> is expanded, and replaces the whole item;
8929 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8930 variable &$value$& contains the value that has been extracted. Afterwards, it
8931 is restored to any previous value it might have had.
8932
8933 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8934 key is not found. If {<&'string2'&>} is also omitted, the value that was
8935 extracted is used.
8936
8937 Some field names take optional modifiers, appended and separated by commas.
8938
8939 The field selectors marked as "RFC4514" above
8940 output a Distinguished Name string which is
8941 not quite
8942 parseable by Exim as a comma-separated tagged list
8943 (the exceptions being elements containin commas).
8944 RDN elements of a single type may be selected by
8945 a modifier of the type label; if so the expansion
8946 result is a list (newline-separated by default).
8947 The separator may be changed by another modifer of
8948 a right angle-bracket followed immediately by the new separator.
8949 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8950
8951 The field selectors marked as "time" above
8952 take an optional modifier of "int"
8953 for which the result is the number of seconds since epoch.
8954 Otherwise the result is a human-readable string
8955 in the timezone selected by the main "timezone" option.
8956
8957 The field selectors marked as "list" above return a list,
8958 newline-separated by default,
8959 (embedded separator characters in elements are doubled).
8960 The separator may be changed by a modifier of
8961 a right angle-bracket followed immediately by the new separator.
8962
8963 The field selectors marked as "tagged" above
8964 prefix each list element with a type string and an equals sign.
8965 Elements of only one type may be selected by a modifier
8966 which is one of "dns", "uri" or "mail";
8967 if so the elenment tags are omitted.
8968
8969 If not otherwise noted field values are presented in human-readable form.
8970
8971 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8972        {*&<&'arg'&>&*}...}*&"
8973 .cindex &%dlfunc%&
8974 This expansion dynamically loads and then calls a locally-written C function.
8975 This functionality is available only if Exim is compiled with
8976 .code
8977 EXPAND_DLFUNC=yes
8978 .endd
8979 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8980 object so that it doesn't reload the same object file in the same Exim process
8981 (but of course Exim does start new processes frequently).
8982
8983 There may be from zero to eight arguments to the function. When compiling
8984 a local function that is to be called in this way, &_local_scan.h_& should be
8985 included. The Exim variables and functions that are defined by that API
8986 are also available for dynamically loaded functions. The function itself
8987 must have the following type:
8988 .code
8989 int dlfunction(uschar **yield, int argc, uschar *argv[])
8990 .endd
8991 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8992 function should return one of the following values:
8993
8994 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8995 into the expanded string that is being built.
8996
8997 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8998 from &'yield'&, if it is set.
8999
9000 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9001 taken from &'yield'& if it is set.
9002
9003 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9004
9005 When compiling a function that is to be used in this way with gcc,
9006 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9007 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9008
9009 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9010        {*&<&'string3'&>&*}}*&"
9011 .cindex "expansion" "extracting substrings by key"
9012 .cindex "&%extract%&" "substrings by key"
9013 The key and <&'string1'&> are first expanded separately. Leading and trailing
9014 white space is removed from the key (but not from any of the strings). The key
9015 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9016 form:
9017 .display
9018 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9019 .endd
9020 .vindex "&$value$&"
9021 where the equals signs and spaces (but not both) are optional. If any of the
9022 values contain white space, they must be enclosed in double quotes, and any
9023 values that are enclosed in double quotes are subject to escape processing as
9024 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9025 for the value that corresponds to the key. The search is case-insensitive. If
9026 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9027 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9028 variable &$value$& contains the value that has been extracted. Afterwards, it
9029 is restored to any previous value it might have had.
9030
9031 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9032 key is not found. If {<&'string2'&>} is also omitted, the value that was
9033 extracted is used. Thus, for example, these two expansions are identical, and
9034 yield &"2001"&:
9035 .code
9036 ${extract{gid}{uid=1984 gid=2001}}
9037 ${extract{gid}{uid=1984 gid=2001}{$value}}
9038 .endd
9039 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9040 appear, for example:
9041 .code
9042 ${extract{Z}{A=... B=...}{$value} fail }
9043 .endd
9044 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9045 {<&'string2'&>} must be present for &"fail"& to be recognized.
9046
9047
9048 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9049         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9050 .cindex "expansion" "extracting substrings by number"
9051 .cindex "&%extract%&" "substrings by number"
9052 The <&'number'&> argument must consist entirely of decimal digits,
9053 apart from leading and trailing white space, which is ignored.
9054 This is what distinguishes this form of &%extract%& from the previous kind. It
9055 behaves in the same way, except that, instead of extracting a named field, it
9056 extracts from <&'string1'&> the field whose number is given as the first
9057 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9058 <&'string3'&> as before.
9059
9060 The fields in the string are separated by any one of the characters in the
9061 separator string. These may include space or tab characters.
9062 The first field is numbered one. If the number is negative, the fields are
9063 counted from the end of the string, with the rightmost one numbered -1. If the
9064 number given is zero, the entire string is returned. If the modulus of the
9065 number is greater than the number of fields in the string, the result is the
9066 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9067 provided. For example:
9068 .code
9069 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9070 .endd
9071 yields &"42"&, and
9072 .code
9073 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9074 .endd
9075 yields &"99"&. Two successive separators mean that the field between them is
9076 empty (for example, the fifth field above).
9077
9078
9079 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9080 .cindex "list" "selecting by condition"
9081 .cindex "expansion" "selecting from list by condition"
9082 .vindex "&$item$&"
9083 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9084 default, but the separator can be changed in the usual way. For each item
9085 in this list, its value is place in &$item$&, and then the condition is
9086 evaluated. If the condition is true, &$item$& is added to the output as an
9087 item in a new list; if the condition is false, the item is discarded. The
9088 separator used for the output list is the same as the one used for the
9089 input, but a separator setting is not included in the output. For example:
9090 .code
9091 ${filter{a:b:c}{!eq{$item}{b}}
9092 .endd
9093 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9094 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9095
9096
9097 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9098 .cindex "hash function" "textual"
9099 .cindex "expansion" "textual hash"
9100 This is a textual hashing function, and was the first to be implemented in
9101 early versions of Exim. In current releases, there are other hashing functions
9102 (numeric, MD5, and SHA-1), which are described below.
9103
9104 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9105 <&'n'&>. If you are using fixed values for these numbers, that is, if
9106 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9107 use the simpler operator notation that avoids some of the braces:
9108 .code
9109 ${hash_<n>_<m>:<string>}
9110 .endd
9111 The second number is optional (in both notations). If <&'n'&> is greater than
9112 or equal to the length of the string, the expansion item returns the string.
9113 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9114 function to the string. The new string consists of characters taken from the
9115 first <&'m'&> characters of the string
9116 .code
9117 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9118 .endd
9119 If <&'m'&> is not present the value 26 is used, so that only lower case
9120 letters appear. For example:
9121 .display
9122 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9123 &`$hash{5}{monty}}           `&   yields  &`monty`&
9124 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9125 .endd
9126
9127 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9128         &*$h_*&<&'header&~name'&>&*:*&" &&&
9129        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9130         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9131        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9132         &*$rh_*&<&'header&~name'&>&*:*&"
9133 .cindex "expansion" "header insertion"
9134 .vindex "&$header_$&"
9135 .vindex "&$bheader_$&"
9136 .vindex "&$rheader_$&"
9137 .cindex "header lines" "in expansion strings"
9138 .cindex "header lines" "character sets"
9139 .cindex "header lines" "decoding"
9140 Substitute the contents of the named message header line, for example
9141 .code
9142 $header_reply-to:
9143 .endd
9144 The newline that terminates a header line is not included in the expansion, but
9145 internal newlines (caused by splitting the header line over several physical
9146 lines) may be present.
9147
9148 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9149 the data in the header line is interpreted.
9150
9151 .ilist
9152 .cindex "white space" "in header lines"
9153 &%rheader%& gives the original &"raw"& content of the header line, with no
9154 processing at all, and without the removal of leading and trailing white space.
9155
9156 .next
9157 .cindex "base64 encoding" "in header lines"
9158 &%bheader%& removes leading and trailing white space, and then decodes base64
9159 or quoted-printable MIME &"words"& within the header text, but does no
9160 character set translation. If decoding of what looks superficially like a MIME
9161 &"word"& fails, the raw string is returned. If decoding
9162 .cindex "binary zero" "in header line"
9163 produces a binary zero character, it is replaced by a question mark &-- this is
9164 what Exim does for binary zeros that are actually received in header lines.
9165
9166 .next
9167 &%header%& tries to translate the string as decoded by &%bheader%& to a
9168 standard character set. This is an attempt to produce the same string as would
9169 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9170 returned. Translation is attempted only on operating systems that support the
9171 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9172 a system Makefile or in &_Local/Makefile_&.
9173 .endlist ilist
9174
9175 In a filter file, the target character set for &%header%& can be specified by a
9176 command of the following form:
9177 .code
9178 headers charset "UTF-8"
9179 .endd
9180 This command affects all references to &$h_$& (or &$header_$&) expansions in
9181 subsequently obeyed filter commands. In the absence of this command, the target
9182 character set in a filter is taken from the setting of the &%headers_charset%&
9183 option in the runtime configuration. The value of this option defaults to the
9184 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9185 ISO-8859-1.
9186
9187 Header names follow the syntax of RFC 2822, which states that they may contain
9188 any printing characters except space and colon. Consequently, curly brackets
9189 &'do not'& terminate header names, and should not be used to enclose them as
9190 if they were variables. Attempting to do so causes a syntax error.
9191
9192 Only header lines that are common to all copies of a message are visible to
9193 this mechanism. These are the original header lines that are received with the
9194 message, and any that are added by an ACL statement or by a system
9195 filter. Header lines that are added to a particular copy of a message by a
9196 router or transport are not accessible.
9197
9198 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9199 before the DATA ACL, because the header structure is not set up until the
9200 message is received. Header lines that are added in a RCPT ACL (for example)
9201 are saved until the message's incoming header lines are available, at which
9202 point they are added. When a DATA ACL is running, however, header lines added
9203 by earlier ACLs are visible.
9204
9205 Upper case and lower case letters are synonymous in header names. If the
9206 following character is white space, the terminating colon may be omitted, but
9207 this is not recommended, because you may then forget it when it is needed. When
9208 white space terminates the header name, it is included in the expanded string.
9209 If the message does not contain the given header, the expansion item is
9210 replaced by an empty string. (See the &%def%& condition in section
9211 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9212
9213 If there is more than one header with the same name, they are all concatenated
9214 to form the substitution string, up to a maximum length of 64K. Unless
9215 &%rheader%& is being used, leading and trailing white space is removed from
9216 each header before concatenation, and a completely empty header is ignored. A
9217 newline character is then inserted between non-empty headers, but there is no
9218 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9219 those headers that contain lists of addresses, a comma is also inserted at the
9220 junctions between headers. This does not happen for the &%rheader%& expansion.
9221
9222
9223 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9224 .cindex "expansion" "hmac hashing"
9225 .cindex &%hmac%&
9226 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9227 shared secret and some text into a message authentication code, as specified in
9228 RFC 2104. This differs from &`${md5:secret_text...}`& or
9229 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9230 cryptographic hash, allowing for authentication that is not possible with MD5
9231 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9232 present. For example:
9233 .code
9234 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9235 .endd
9236 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9237 produces:
9238 .code
9239 dd97e3ba5d1a61b5006108f8c8252953
9240 .endd
9241 As an example of how this might be used, you might put in the main part of
9242 an Exim configuration:
9243 .code
9244 SPAMSCAN_SECRET=cohgheeLei2thahw
9245 .endd
9246 In a router or a transport you could then have:
9247 .code
9248 headers_add = \
9249   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9250   ${hmac{md5}{SPAMSCAN_SECRET}\
9251   {${primary_hostname},${message_exim_id},$h_message-id:}}
9252 .endd
9253 Then given a message, you can check where it was scanned by looking at the
9254 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9255 this header line is authentic by recomputing the authentication code from the
9256 host name, message ID and the &'Message-id:'& header line. This can be done
9257 using Exim's &%-be%& option, or by other means, for example by using the
9258 &'hmac_md5_hex()'& function in Perl.
9259
9260
9261 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9262 .cindex "expansion" "conditional"
9263 .cindex "&%if%&, expansion item"
9264 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9265 item; otherwise <&'string2'&> is used. The available conditions are described
9266 in section &<<SECTexpcond>>& below. For example:
9267 .code
9268 ${if eq {$local_part}{postmaster} {yes}{no} }
9269 .endd
9270 The second string need not be present; if it is not and the condition is not
9271 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9272 be present instead of the second string (without any curly brackets). In this
9273 case, the expansion is forced to fail if the condition is not true (see section
9274 &<<SECTforexpfai>>&).
9275
9276 If both strings are omitted, the result is the string &`true`& if the condition
9277 is true, and the empty string if the condition is false. This makes it less
9278 cumbersome to write custom ACL and router conditions. For example, instead of
9279 .code
9280 condition = ${if >{$acl_m4}{3}{true}{false}}
9281 .endd
9282 you can use
9283 .code
9284 condition = ${if >{$acl_m4}{3}}
9285 .endd
9286
9287 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9288 .cindex "expansion" "string truncation"
9289 .cindex "&%length%& expansion item"
9290 The &%length%& item is used to extract the initial portion of a string. Both
9291 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9292 you are using a fixed value for the number, that is, if <&'string1'&> does not
9293 change when expanded, you can use the simpler operator notation that avoids
9294 some of the braces:
9295 .code
9296 ${length_<n>:<string>}
9297 .endd
9298 The result of this item is either the first <&'n'&> characters or the whole
9299 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9300 &%strlen%&, which gives the length of a string.
9301
9302
9303 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9304         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9305 .cindex "expansion" "extracting list elements by number"
9306 .cindex "&%listextract%&" "extract list elements by number"
9307 .cindex "list" "extracting elements by number"
9308 The <&'number'&> argument must consist entirely of decimal digits,
9309 apart from an optional leading minus,
9310 and leading and trailing white space (which is ignored).
9311
9312 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9313 default, but the separator can be changed in the usual way.
9314
9315 The first field of the list is numbered one.
9316 If the number is negative, the fields are
9317 counted from the end of the list, with the rightmost one numbered -1.
9318 The numbered element of the list is extracted and placed in &$value$&,
9319 then <&'string2'&> is expanded as the result.
9320
9321 If the modulus of the
9322 number is zero or greater than the number of fields in the string,
9323 the result is the expansion of <&'string3'&>.
9324
9325 For example:
9326 .code
9327 ${listextract{2}{x:42:99}}
9328 .endd
9329 yields &"42"&, and
9330 .code
9331 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9332 .endd
9333 yields &"result: 99"&.
9334
9335 If {<&'string3'&>} is omitted, an empty string is used for string3.
9336 If {<&'string2'&>} is also omitted, the value that was
9337 extracted is used.
9338 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9339
9340
9341 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9342         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9343 This is the first of one of two different types of lookup item, which are both
9344 described in the next item.
9345
9346 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9347         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9348 .cindex "expansion" "lookup in"
9349 .cindex "file" "lookups"
9350 .cindex "lookup" "in expanded string"
9351 The two forms of lookup item specify data lookups in files and databases, as
9352 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9353 lookups, and the second is used for query-style lookups. The <&'key'&>,
9354 <&'file'&>, and <&'query'&> strings are expanded before use.
9355
9356 If there is any white space in a lookup item which is part of a filter command,
9357 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9358 other place where white space is significant, the lookup item must be enclosed
9359 in double quotes. The use of data lookups in users' filter files may be locked
9360 out by the system administrator.
9361
9362 .vindex "&$value$&"
9363 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9364 During its expansion, the variable &$value$& contains the data returned by the
9365 lookup. Afterwards it reverts to the value it had previously (at the outer
9366 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9367 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9368 string on failure. If <&'string2'&> is provided, it can itself be a nested
9369 lookup, thus providing a mechanism for looking up a default value when the
9370 original lookup fails.
9371
9372 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9373 data for the outer lookup while the parameters of the second lookup are
9374 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9375 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9376 appear, and in this case, if the lookup fails, the entire expansion is forced
9377 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9378 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9379 successful lookup, and nothing in the case of failure.
9380
9381 For single-key lookups, the string &"partial"& is permitted to precede the
9382 search type in order to do partial matching, and * or *@ may follow a search
9383 type to request default lookups if the key does not match (see sections
9384 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9385
9386 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9387 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9388 and non-wild parts of the key during the expansion of the replacement text.
9389 They return to their previous values at the end of the lookup item.
9390
9391 This example looks up the postmaster alias in the conventional alias file:
9392 .code
9393 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9394 .endd
9395 This example uses NIS+ to look up the full name of the user corresponding to
9396 the local part of an address, forcing the expansion to fail if it is not found:
9397 .code
9398 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9399   {$value}fail}
9400 .endd
9401
9402
9403 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9404 .cindex "expansion" "list creation"
9405 .vindex "&$item$&"
9406 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9407 default, but the separator can be changed in the usual way. For each item
9408 in this list, its value is place in &$item$&, and then <&'string2'&> is
9409 expanded and added to the output as an item in a new list. The separator used
9410 for the output list is the same as the one used for the input, but a separator
9411 setting is not included in the output. For example:
9412 .code
9413 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9414 .endd
9415 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9416 value of &$item$& is restored to what it was before. See also the &*filter*&
9417 and &*reduce*& expansion items.
9418
9419 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9420 .cindex "expansion" "numeric hash"
9421 .cindex "hash function" "numeric"
9422 The three strings are expanded; the first two must yield numbers. Call them
9423 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9424 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9425 can use the simpler operator notation that avoids some of the braces:
9426 .code
9427 ${nhash_<n>_<m>:<string>}
9428 .endd
9429 The second number is optional (in both notations). If there is only one number,
9430 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9431 processed by a div/mod hash function that returns two numbers, separated by a
9432 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9433 example,
9434 .code
9435 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9436 .endd
9437 returns the string &"6/33"&.
9438
9439
9440
9441 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9442 .cindex "Perl" "use in expanded string"
9443 .cindex "expansion" "calling Perl from"
9444 This item is available only if Exim has been built to include an embedded Perl
9445 interpreter. The subroutine name and the arguments are first separately
9446 expanded, and then the Perl subroutine is called with those arguments. No
9447 additional arguments need be given; the maximum number permitted, including the
9448 name of the subroutine, is nine.
9449
9450 The return value of the subroutine is inserted into the expanded string, unless
9451 the return value is &%undef%&. In that case, the expansion fails in the same
9452 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9453 Whatever you return is evaluated in a scalar context. For example, if you
9454 return the name of a Perl vector, the return value is the size of the vector,
9455 not its contents.
9456
9457 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9458 with the error message that was passed to &%die%&. More details of the embedded
9459 Perl facility are given in chapter &<<CHAPperl>>&.
9460
9461 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9462 out the use of this expansion item in filter files.
9463
9464
9465 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9466 .cindex "&%prvs%& expansion item"
9467 The first argument is a complete email address and the second is secret
9468 keystring. The third argument, specifying a key number, is optional. If absent,
9469 it defaults to 0. The result of the expansion is a prvs-signed email address,
9470 to be typically used with the &%return_path%& option on an &(smtp)& transport
9471 as part of a bounce address tag validation (BATV) scheme. For more discussion
9472 and an example, see section &<<SECTverifyPRVS>>&.
9473
9474 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9475         {*&<&'string'&>&*}}*&"
9476 .cindex "&%prvscheck%& expansion item"
9477 This expansion item is the complement of the &%prvs%& item. It is used for
9478 checking prvs-signed addresses. If the expansion of the first argument does not
9479 yield a syntactically valid prvs-signed address, the whole item expands to the
9480 empty string. When the first argument does expand to a syntactically valid
9481 prvs-signed address, the second argument is expanded, with the prvs-decoded
9482 version of the address and the key number extracted from the address in the
9483 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9484
9485 These two variables can be used in the expansion of the second argument to
9486 retrieve the secret. The validity of the prvs-signed address is then checked
9487 against the secret. The result is stored in the variable &$prvscheck_result$&,
9488 which is empty for failure or &"1"& for success.
9489
9490 The third argument is optional; if it is missing, it defaults to an empty
9491 string. This argument is now expanded. If the result is an empty string, the
9492 result of the expansion is the decoded version of the address. This is the case
9493 whether or not the signature was valid. Otherwise, the result of the expansion
9494 is the expansion of the third argument.
9495
9496 All three variables can be used in the expansion of the third argument.
9497 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9498 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9499
9500 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9501 .cindex "expansion" "inserting an entire file"
9502 .cindex "file" "inserting into expansion"
9503 .cindex "&%readfile%& expansion item"
9504 The file name and end-of-line string are first expanded separately. The file is
9505 then read, and its contents replace the entire item. All newline characters in
9506 the file are replaced by the end-of-line string if it is present. Otherwise,
9507 newlines are left in the string.
9508 String expansion is not applied to the contents of the file. If you want this,
9509 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9510 the string expansion fails.
9511
9512 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9513 locks out the use of this expansion item in filter files.
9514
9515
9516
9517 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9518         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9519 .cindex "expansion" "inserting from a socket"
9520 .cindex "socket, use of in expansion"
9521 .cindex "&%readsocket%& expansion item"
9522 This item inserts data from a Unix domain or TCP socket into the expanded
9523 string. The minimal way of using it uses just two arguments, as in these
9524 examples:
9525 .code
9526 ${readsocket{/socket/name}{request string}}
9527 ${readsocket{inet:some.host:1234}{request string}}
9528 .endd
9529 For a Unix domain socket, the first substring must be the path to the socket.
9530 For an Internet socket, the first substring must contain &`inet:`& followed by
9531 a host name or IP address, followed by a colon and a port, which can be a
9532 number or the name of a TCP port in &_/etc/services_&. An IP address may
9533 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9534 example:
9535 .code
9536 ${readsocket{inet:[::1]:1234}{request string}}
9537 .endd
9538 Only a single host name may be given, but if looking it up yields more than
9539 one IP address, they are each tried in turn until a connection is made. For
9540 both kinds of socket, Exim makes a connection, writes the request string
9541 (unless it is an empty string) and reads from the socket until an end-of-file
9542 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9543 extend what can be done. Firstly, you can vary the timeout. For example:
9544 .code
9545 ${readsocket{/socket/name}{request string}{3s}}
9546 .endd
9547 A fourth argument allows you to change any newlines that are in the data
9548 that is read, in the same way as for &%readfile%& (see above). This example
9549 turns them into spaces:
9550 .code
9551 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9552 .endd
9553 As with all expansions, the substrings are expanded before the processing
9554 happens. Errors in these sub-expansions cause the expansion to fail. In
9555 addition, the following errors can occur:
9556
9557 .ilist
9558 Failure to create a socket file descriptor;
9559 .next
9560 Failure to connect the socket;
9561 .next
9562 Failure to write the request string;
9563 .next
9564 Timeout on reading from the socket.
9565 .endlist
9566
9567 By default, any of these errors causes the expansion to fail. However, if
9568 you supply a fifth substring, it is expanded and used when any of the above
9569 errors occurs. For example:
9570 .code
9571 ${readsocket{/socket/name}{request string}{3s}{\n}\
9572   {socket failure}}
9573 .endd
9574 You can test for the existence of a Unix domain socket by wrapping this
9575 expansion in &`${if exists`&, but there is a race condition between that test
9576 and the actual opening of the socket, so it is safer to use the fifth argument
9577 if you want to be absolutely sure of avoiding an expansion error for a
9578 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9579
9580 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9581 locks out the use of this expansion item in filter files.
9582
9583
9584 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9585 .cindex "expansion" "reducing a list to a scalar"
9586 .cindex "list" "reducing to a scalar"
9587 .vindex "&$value$&"
9588 .vindex "&$item$&"
9589 This operation reduces a list to a single, scalar string. After expansion,
9590 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9591 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9592 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9593 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9594 them. The result of that expansion is assigned to &$value$& before the next
9595 iteration. When the end of the list is reached, the final value of &$value$& is
9596 added to the expansion output. The &*reduce*& expansion item can be used in a
9597 number of ways. For example, to add up a list of numbers:
9598 .code
9599 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9600 .endd
9601 The result of that expansion would be &`6`&. The maximum of a list of numbers
9602 can be found:
9603 .code
9604 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9605 .endd
9606 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9607 restored to what they were before. See also the &*filter*& and &*map*&
9608 expansion items.
9609
9610 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9611 This item inserts &"raw"& header lines. It is described with the &%header%&
9612 expansion item above.
9613
9614 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9615         {*&<&'string2'&>&*}}*&"
9616 .cindex "expansion" "running a command"
9617 .cindex "&%run%& expansion item"
9618 The command and its arguments are first expanded as one string. The string is
9619 split apart into individual arguments by spaces, and then the command is run
9620 in a separate process, but under the same uid and gid.  As in other command
9621 executions from Exim, a shell is not used by default. If the command requires
9622 a shell, you must explicitly code it.
9623
9624 Since the arguments are split by spaces, when there is a variable expansion
9625 which has an empty result, it will cause the situation that the argument will
9626 simply be omitted when the program is actually executed by Exim. If the
9627 script/program requires a specific number of arguments and the expanded
9628 variable could possibly result in this empty expansion, the variable must be
9629 quoted. This is more difficult if the expanded variable itself could result
9630 in a string containing quotes, because it would interfere with the quotes
9631 around the command arguments. A possible guard against this is to wrap the
9632 variable in the &%sg%& operator to change any quote marks to some other
9633 character.
9634
9635 The standard input for the command exists, but is empty. The standard output
9636 and standard error are set to the same file descriptor.
9637 .cindex "return code" "from &%run%& expansion"
9638 .vindex "&$value$&"
9639 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9640 and replaces the entire item; during this expansion, the standard output/error
9641 from the command is in the variable &$value$&. If the command fails,
9642 <&'string2'&>, if present, is expanded and used. Once again, during the
9643 expansion, the standard output/error from the command is in the variable
9644 &$value$&.
9645
9646 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9647 can be the word &"fail"& (not in braces) to force expansion failure if the
9648 command does not succeed. If both strings are omitted, the result is contents
9649 of the standard output/error on success, and nothing on failure.
9650
9651 .vindex "&$run_in_acl$&"
9652 The standard output/error of the command is put in the variable &$value$&.
9653 In this ACL example, the output of a command is logged for the admin to
9654 troubleshoot:
9655 .code
9656 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9657       log_message  = Output of id: $value
9658 .endd
9659 If the command requires shell idioms, such as the > redirect operator, the
9660 shell must be invoked directly, such as with:
9661 .code
9662 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9663 .endd
9664
9665 .vindex "&$runrc$&"
9666 The return code from the command is put in the variable &$runrc$&, and this
9667 remains set afterwards, so in a filter file you can do things like this:
9668 .code
9669 if "${run{x y z}{}}$runrc" is 1 then ...
9670   elif $runrc is 2 then ...
9671   ...
9672 endif
9673 .endd
9674 If execution of the command fails (for example, the command does not exist),
9675 the return code is 127 &-- the same code that shells use for non-existent
9676 commands.
9677
9678 &*Warning*&: In a router or transport, you cannot assume the order in which
9679 option values are expanded, except for those preconditions whose order of
9680 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9681 by the expansion of one option, and use it in another.
9682
9683 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9684 out the use of this expansion item in filter files.
9685
9686
9687 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9688 .cindex "expansion" "string substitution"
9689 .cindex "&%sg%& expansion item"
9690 This item works like Perl's substitution operator (s) with the global (/g)
9691 option; hence its name. However, unlike the Perl equivalent, Exim does not
9692 modify the subject string; instead it returns the modified string for insertion
9693 into the overall expansion. The item takes three arguments: the subject string,
9694 a regular expression, and a substitution string. For example:
9695 .code
9696 ${sg{abcdefabcdef}{abc}{xyz}}
9697 .endd
9698 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9699 if any $ or \ characters are required in the regular expression or in the
9700 substitution string, they have to be escaped. For example:
9701 .code
9702 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9703 .endd
9704 yields &"defabc"&, and
9705 .code
9706 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9707 .endd
9708 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9709 the regular expression from string expansion.
9710
9711
9712
9713 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9714 .cindex sorting a list
9715 .cindex list sorting
9716 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9717 default, but the separator can be changed in the usual way.
9718 The <&'comparator'&> argument is interpreted as the operator
9719 of a two-argument expansion condition.
9720 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9721 The comparison should return true when applied to two values
9722 if the first value should sort before the second value.
9723 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9724 the element being placed in &$item$&,
9725 to give values for comparison.
9726
9727 The item result is a sorted list,
9728 with the original list separator,
9729 of the list elements (in full) of the original.
9730
9731 Examples:
9732 .code
9733 ${sort{3:2:1:4}{<}{$item}}
9734 .endd
9735 sorts a list of numbers, and
9736 .code
9737 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9738 .endd
9739 will sort an MX lookup into priority order.
9740
9741
9742 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9743 .cindex "&%substr%& expansion item"
9744 .cindex "substring extraction"
9745 .cindex "expansion" "substring extraction"
9746 The three strings are expanded; the first two must yield numbers. Call them
9747 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9748 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9749 can use the simpler operator notation that avoids some of the braces:
9750 .code
9751 ${substr_<n>_<m>:<string>}
9752 .endd
9753 The second number is optional (in both notations).
9754 If it is absent in the simpler format, the preceding underscore must also be
9755 omitted.
9756
9757 The &%substr%& item can be used to extract more general substrings than
9758 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9759 length required. For example
9760 .code
9761 ${substr{3}{2}{$local_part}}
9762 .endd
9763 If the starting offset is greater than the string length the result is the
9764 null string; if the length plus starting offset is greater than the string
9765 length, the result is the right-hand part of the string, starting from the
9766 given offset. The first character in the string has offset zero.
9767
9768 The &%substr%& expansion item can take negative offset values to count
9769 from the right-hand end of its operand. The last character is offset -1, the
9770 second-last is offset -2, and so on. Thus, for example,
9771 .code
9772 ${substr{-5}{2}{1234567}}
9773 .endd
9774 yields &"34"&. If the absolute value of a negative offset is greater than the
9775 length of the string, the substring starts at the beginning of the string, and
9776 the length is reduced by the amount of overshoot. Thus, for example,
9777 .code
9778 ${substr{-5}{2}{12}}
9779 .endd
9780 yields an empty string, but
9781 .code
9782 ${substr{-3}{2}{12}}
9783 .endd
9784 yields &"1"&.
9785
9786 When the second number is omitted from &%substr%&, the remainder of the string
9787 is taken if the offset is positive. If it is negative, all characters in the
9788 string preceding the offset point are taken. For example, an offset of -1 and
9789 no length, as in these semantically identical examples:
9790 .code
9791 ${substr_-1:abcde}
9792 ${substr{-1}{abcde}}
9793 .endd
9794 yields all but the last character of the string, that is, &"abcd"&.
9795
9796
9797
9798 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9799         {*&<&'replacements'&>&*}}*&"
9800 .cindex "expansion" "character translation"
9801 .cindex "&%tr%& expansion item"
9802 This item does single-character translation on its subject string. The second
9803 argument is a list of characters to be translated in the subject string. Each
9804 matching character is replaced by the corresponding character from the
9805 replacement list. For example
9806 .code
9807 ${tr{abcdea}{ac}{13}}
9808 .endd
9809 yields &`1b3de1`&. If there are duplicates in the second character string, the
9810 last occurrence is used. If the third string is shorter than the second, its
9811 last character is replicated. However, if it is empty, no translation takes
9812 place.
9813 .endlist
9814
9815
9816
9817 .section "Expansion operators" "SECTexpop"
9818 .cindex "expansion" "operators"
9819 For expansion items that perform transformations on a single argument string,
9820 the &"operator"& notation is used because it is simpler and uses fewer braces.
9821 The substring is first expanded before the operation is applied to it. The
9822 following operations can be performed:
9823
9824 .vlist
9825 .vitem &*${address:*&<&'string'&>&*}*&
9826 .cindex "expansion" "RFC 2822 address handling"
9827 .cindex "&%address%& expansion item"
9828 The string is interpreted as an RFC 2822 address, as it might appear in a
9829 header line, and the effective address is extracted from it. If the string does
9830 not parse successfully, the result is empty.
9831
9832
9833 .vitem &*${addresses:*&<&'string'&>&*}*&
9834 .cindex "expansion" "RFC 2822 address handling"
9835 .cindex "&%addresses%& expansion item"
9836 The string (after expansion) is interpreted as a list of addresses in RFC
9837 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9838 operative address (&'local-part@domain'&) is extracted from each item, and the
9839 result of the expansion is a colon-separated list, with appropriate
9840 doubling of colons should any happen to be present in the email addresses.
9841 Syntactically invalid RFC2822 address items are omitted from the output.
9842
9843 It is possible to specify a character other than colon for the output
9844 separator by starting the string with > followed by the new separator
9845 character. For example:
9846 .code
9847 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9848 .endd
9849 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9850 expansion item, which extracts the working address from a single RFC2822
9851 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9852 processing lists.
9853
9854 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9855 a strict interpretation of header line formatting.  Exim parses the bare,
9856 unquoted portion of an email address and if it finds a comma, treats it as an
9857 email address seperator. For the example header line:
9858 .code
9859 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9860 .endd
9861 The first example below demonstrates that Q-encoded email addresses are parsed
9862 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9863 It does not see the comma because it's still encoded as "=2C".  The second
9864 example below is passed the contents of &`$header_from:`&, meaning it gets
9865 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9866 The third example shows that the presence of a comma is skipped when it is
9867 quoted.
9868 .code
9869 # exim -be '${addresses:From: \
9870 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9871 user@example.com
9872 # exim -be '${addresses:From: Last, First <user@example.com>}'
9873 Last:user@example.com
9874 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9875 user@example.com
9876 .endd
9877
9878 .vitem &*${base62:*&<&'digits'&>&*}*&
9879 .cindex "&%base62%& expansion item"
9880 .cindex "expansion" "conversion to base 62"
9881 The string must consist entirely of decimal digits. The number is converted to
9882 base 62 and output as a string of six characters, including leading zeros. In
9883 the few operating environments where Exim uses base 36 instead of base 62 for
9884 its message identifiers (because those systems do not have case-sensitive file
9885 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9886 be absolutely clear: this is &'not'& base64 encoding.
9887
9888 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9889 .cindex "&%base62d%& expansion item"
9890 .cindex "expansion" "conversion to base 62"
9891 The string must consist entirely of base-62 digits, or, in operating
9892 environments where Exim uses base 36 instead of base 62 for its message
9893 identifiers, base-36 digits. The number is converted to decimal and output as a
9894 string.
9895
9896
9897 .vitem &*${domain:*&<&'string'&>&*}*&
9898 .cindex "domain" "extraction"
9899 .cindex "expansion" "domain extraction"
9900 The string is interpreted as an RFC 2822 address and the domain is extracted
9901 from it. If the string does not parse successfully, the result is empty.
9902
9903
9904 .vitem &*${escape:*&<&'string'&>&*}*&
9905 .cindex "expansion" "escaping non-printing characters"
9906 .cindex "&%escape%& expansion item"
9907 If the string contains any non-printing characters, they are converted to
9908 escape sequences starting with a backslash. Whether characters with the most
9909 significant bit set (so-called &"8-bit characters"&) count as printing or not
9910 is controlled by the &%print_topbitchars%& option.
9911
9912
9913 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9914 .cindex "expansion" "expression evaluation"
9915 .cindex "expansion" "arithmetic expression"
9916 .cindex "&%eval%& expansion item"
9917 These items supports simple arithmetic and bitwise logical operations in
9918 expansion strings. The string (after expansion) must be a conventional
9919 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9920 logical operators, and parentheses. All operations are carried out using
9921 integer arithmetic. The operator priorities are as follows (the same as in the
9922 C programming language):
9923 .table2 70pt 300pt
9924 .irow &'highest:'& "not (~), negate (-)"
9925 .irow ""   "multiply (*), divide (/), remainder (%)"
9926 .irow ""   "plus (+), minus (-)"
9927 .irow ""   "shift-left (<<), shift-right (>>)"
9928 .irow ""   "and (&&)"
9929 .irow ""   "xor (^)"
9930 .irow &'lowest:'&  "or (|)"
9931 .endtable
9932 Binary operators with the same priority are evaluated from left to right. White
9933 space is permitted before or after operators.
9934
9935 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9936 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9937 decimal, even if they start with a leading zero; hexadecimal numbers are not
9938 permitted. This can be useful when processing numbers extracted from dates or
9939 times, which often do have leading zeros.
9940
9941 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9942 or 1024*1024*1024,
9943 respectively. Negative numbers are supported. The result of the computation is
9944 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9945
9946 .display
9947 &`${eval:1+1}            `&  yields 2
9948 &`${eval:1+2*3}          `&  yields 7
9949 &`${eval:(1+2)*3}        `&  yields 9
9950 &`${eval:2+42%5}         `&  yields 4
9951 &`${eval:0xc&amp;5}          `&  yields 4
9952 &`${eval:0xc|5}          `&  yields 13
9953 &`${eval:0xc^5}          `&  yields 9
9954 &`${eval:0xc>>1}         `&  yields 6
9955 &`${eval:0xc<<1}         `&  yields 24
9956 &`${eval:~255&amp;0x1234}    `&  yields 4608
9957 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9958 .endd
9959
9960 As a more realistic example, in an ACL you might have
9961 .code
9962 deny   message = Too many bad recipients
9963        condition =                    \
9964          ${if and {                   \
9965            {>{$rcpt_count}{10}}       \
9966            {                          \
9967            <                          \
9968              {$recipients_count}      \
9969              {${eval:$rcpt_count/2}}  \
9970            }                          \
9971          }{yes}{no}}
9972 .endd
9973 The condition is true if there have been more than 10 RCPT commands and
9974 fewer than half of them have resulted in a valid recipient.
9975
9976
9977 .vitem &*${expand:*&<&'string'&>&*}*&
9978 .cindex "expansion" "re-expansion of substring"
9979 The &%expand%& operator causes a string to be expanded for a second time. For
9980 example,
9981 .code
9982 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9983 .endd
9984 first looks up a string in a file while expanding the operand for &%expand%&,
9985 and then re-expands what it has found.
9986
9987
9988 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9989 .cindex "Unicode"
9990 .cindex "UTF-8" "conversion from"
9991 .cindex "expansion" "UTF-8 conversion"
9992 .cindex "&%from_utf8%& expansion item"
9993 The world is slowly moving towards Unicode, although there are no standards for
9994 email yet. However, other applications (including some databases) are starting
9995 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9996 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9997 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9998 the result is an undefined sequence of bytes.
9999
10000 Unicode code points with values less than 256 are compatible with ASCII and
10001 ISO-8859-1 (also known as Latin-1).
10002 For example, character 169 is the copyright symbol in both cases, though the
10003 way it is encoded is different. In UTF-8, more than one byte is needed for
10004 characters with code values greater than 127, whereas ISO-8859-1 is a
10005 single-byte encoding (but thereby limited to 256 characters). This makes
10006 translation from UTF-8 to ISO-8859-1 straightforward.
10007
10008
10009 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10010 .cindex "hash function" "textual"
10011 .cindex "expansion" "textual hash"
10012 The &%hash%& operator is a simpler interface to the hashing function that can
10013 be used when the two parameters are fixed numbers (as opposed to strings that
10014 change when expanded). The effect is the same as
10015 .code
10016 ${hash{<n>}{<m>}{<string>}}
10017 .endd
10018 See the description of the general &%hash%& item above for details. The
10019 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10020
10021
10022
10023 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10024 .cindex "base64 encoding" "conversion from hex"
10025 .cindex "expansion" "hex to base64"
10026 .cindex "&%hex2b64%& expansion item"
10027 This operator converts a hex string into one that is base64 encoded. This can
10028 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10029
10030
10031
10032 .vitem &*${hexquote:*&<&'string'&>&*}*&
10033 .cindex "quoting" "hex-encoded unprintable characters"
10034 .cindex "&%hexquote%& expansion item"
10035 This operator converts non-printable characters in a string into a hex
10036 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10037 as is, and other byte values are converted to &`\xNN`&, for example a
10038 byte value 127 is converted to &`\x7f`&.
10039
10040
10041 .vitem &*${lc:*&<&'string'&>&*}*&
10042 .cindex "case forcing in strings"
10043 .cindex "string" "case forcing"
10044 .cindex "lower casing"
10045 .cindex "expansion" "case forcing"
10046 .cindex "&%lc%& expansion item"
10047 This forces the letters in the string into lower-case, for example:
10048 .code
10049 ${lc:$local_part}
10050 .endd
10051
10052 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10053 .cindex "expansion" "string truncation"
10054 .cindex "&%length%& expansion item"
10055 The &%length%& operator is a simpler interface to the &%length%& function that
10056 can be used when the parameter is a fixed number (as opposed to a string that
10057 changes when expanded). The effect is the same as
10058 .code
10059 ${length{<number>}{<string>}}
10060 .endd
10061 See the description of the general &%length%& item above for details. Note that
10062 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10063 when &%length%& is used as an operator.
10064
10065
10066 .vitem &*${listcount:*&<&'string'&>&*}*&
10067 .cindex "expansion" "list item count"
10068 .cindex "list" "item count"
10069 .cindex "list" "count of items"
10070 .cindex "&%listcount%& expansion item"
10071 The string is interpreted as a list and the number of items is returned.
10072
10073
10074 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10075 .cindex "expansion" "named list"
10076 .cindex "&%listnamed%& expansion item"
10077 The name is interpreted as a named list and the content of the list is returned,
10078 expanding any referenced lists, re-quoting as needed for colon-separation.
10079 If the optional type is given it must be one of "a", "d", "h" or "l"
10080 and selects address-, domain-, host- or localpart- lists to search among respectively.
10081 Otherwise all types are searched in an undefined order and the first
10082 matching list is returned.
10083
10084
10085 .vitem &*${local_part:*&<&'string'&>&*}*&
10086 .cindex "expansion" "local part extraction"
10087 .cindex "&%local_part%& expansion item"
10088 The string is interpreted as an RFC 2822 address and the local part is
10089 extracted from it. If the string does not parse successfully, the result is
10090 empty.
10091
10092
10093 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10094 .cindex "masked IP address"
10095 .cindex "IP address" "masking"
10096 .cindex "CIDR notation"
10097 .cindex "expansion" "IP address masking"
10098 .cindex "&%mask%& expansion item"
10099 If the form of the string to be operated on is not an IP address followed by a
10100 slash and an integer (that is, a network address in CIDR notation), the
10101 expansion fails. Otherwise, this operator converts the IP address to binary,
10102 masks off the least significant bits according to the bit count, and converts
10103 the result back to text, with mask appended. For example,
10104 .code
10105 ${mask:10.111.131.206/28}
10106 .endd
10107 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10108 be mostly used for looking up masked addresses in files, the result for an IPv6
10109 address uses dots to separate components instead of colons, because colon
10110 terminates a key string in lsearch files. So, for example,
10111 .code
10112 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10113 .endd
10114 returns the string
10115 .code
10116 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10117 .endd
10118 Letters in IPv6 addresses are always output in lower case.
10119
10120
10121 .vitem &*${md5:*&<&'string'&>&*}*&
10122 .cindex "MD5 hash"
10123 .cindex "expansion" "MD5 hash"
10124 .cindex "certificate fingerprint"
10125 .cindex "&%md5%& expansion item"
10126 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10127 as a 32-digit hexadecimal number, in which any letters are in lower case.
10128
10129
10130 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10131 .cindex "expansion" "numeric hash"
10132 .cindex "hash function" "numeric"
10133 The &%nhash%& operator is a simpler interface to the numeric hashing function
10134 that can be used when the two parameters are fixed numbers (as opposed to
10135 strings that change when expanded). The effect is the same as
10136 .code
10137 ${nhash{<n>}{<m>}{<string>}}
10138 .endd
10139 See the description of the general &%nhash%& item above for details.
10140
10141
10142 .vitem &*${quote:*&<&'string'&>&*}*&
10143 .cindex "quoting" "in string expansions"
10144 .cindex "expansion" "quoting"
10145 .cindex "&%quote%& expansion item"
10146 The &%quote%& operator puts its argument into double quotes if it
10147 is an empty string or
10148 contains anything other than letters, digits, underscores, dots, and hyphens.
10149 Any occurrences of double quotes and backslashes are escaped with a backslash.
10150 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10151 respectively For example,
10152 .code
10153 ${quote:ab"*"cd}
10154 .endd
10155 becomes
10156 .code
10157 "ab\"*\"cd"
10158 .endd
10159 The place where this is useful is when the argument is a substitution from a
10160 variable or a message header.
10161
10162 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10163 .cindex "&%quote_local_part%& expansion item"
10164 This operator is like &%quote%&, except that it quotes the string only if
10165 required to do so by the rules of RFC 2822 for quoting local parts. For
10166 example, a plus sign would not cause quoting (but it would for &%quote%&).
10167 If you are creating a new email address from the contents of &$local_part$&
10168 (or any other unknown data), you should always use this operator.
10169
10170
10171 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10172 .cindex "quoting" "lookup-specific"
10173 This operator applies lookup-specific quoting rules to the string. Each
10174 query-style lookup type has its own quoting rules which are described with
10175 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10176 .code
10177 ${quote_ldap:two * two}
10178 .endd
10179 returns
10180 .code
10181 two%20%5C2A%20two
10182 .endd
10183 For single-key lookup types, no quoting is ever necessary and this operator
10184 yields an unchanged string.
10185
10186
10187 .vitem &*${randint:*&<&'n'&>&*}*&
10188 .cindex "random number"
10189 This operator returns a somewhat random number which is less than the
10190 supplied number and is at least 0.  The quality of this randomness depends
10191 on how Exim was built; the values are not suitable for keying material.
10192 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10193 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10194 for versions of GnuTLS with that function.
10195 Otherwise, the implementation may be arc4random(), random() seeded by
10196 srandomdev() or srandom(), or a custom implementation even weaker than
10197 random().
10198
10199
10200 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10201 .cindex "expansion" "IP address"
10202 This operator reverses an IP address; for IPv4 addresses, the result is in
10203 dotted-quad decimal form, while for IPv6 addreses the result is in
10204 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10205 for DNS.  For example,
10206 .code
10207 ${reverse_ip:192.0.2.4}
10208 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10209 .endd
10210 returns
10211 .code
10212 4.2.0.192
10213 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
10214 .endd
10215
10216
10217 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10218 .cindex "expansion" "RFC 2047"
10219 .cindex "RFC 2047" "expansion operator"
10220 .cindex "&%rfc2047%& expansion item"
10221 This operator encodes text according to the rules of RFC 2047. This is an
10222 encoding that is used in header lines to encode non-ASCII characters. It is
10223 assumed that the input string is in the encoding specified by the
10224 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10225 contains only characters in the range 33&--126, and no instances of the
10226 characters
10227 .code
10228 ? = ( ) < > @ , ; : \ " . [ ] _
10229 .endd
10230 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10231 string, using as many &"encoded words"& as necessary to encode all the
10232 characters.
10233
10234
10235 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10236 .cindex "expansion" "RFC 2047"
10237 .cindex "RFC 2047" "decoding"
10238 .cindex "&%rfc2047d%& expansion item"
10239 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10240 bytes are replaced by question marks. Characters are converted into the
10241 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10242 not recognized unless &%check_rfc2047_length%& is set false.
10243
10244 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10245 access a header line, RFC 2047 decoding is done automatically. You do not need
10246 to use this operator as well.
10247
10248
10249
10250 .vitem &*${rxquote:*&<&'string'&>&*}*&
10251 .cindex "quoting" "in regular expressions"
10252 .cindex "regular expressions" "quoting"
10253 .cindex "&%rxquote%& expansion item"
10254 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10255 characters in its argument. This is useful when substituting the values of
10256 variables or headers inside regular expressions.
10257
10258
10259 .vitem &*${sha1:*&<&'string'&>&*}*&
10260 .cindex "SHA-1 hash"
10261 .cindex "expansion" "SHA-1 hashing"
10262 .cindex "certificate fingerprint"
10263 .cindex "&%sha2%& expansion item"
10264 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10265 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10266
10267
10268 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10269 .cindex "SHA-256 hash"
10270 .cindex "certificate fingerprint"
10271 .cindex "expansion" "SHA-256 hashing"
10272 .cindex "&%sha256%& expansion item"
10273 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10274 certificate,
10275 and returns
10276 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10277 Only arguments which are a single variable of certificate type are supported.
10278
10279
10280 .vitem &*${stat:*&<&'string'&>&*}*&
10281 .cindex "expansion" "statting a file"
10282 .cindex "file" "extracting characteristics"
10283 .cindex "&%stat%& expansion item"
10284 The string, after expansion, must be a file path. A call to the &[stat()]&
10285 function is made for this path. If &[stat()]& fails, an error occurs and the
10286 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10287 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10288 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10289 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10290 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10291 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10292 can extract individual fields using the &%extract%& expansion item.
10293
10294 The use of the &%stat%& expansion in users' filter files can be locked out by
10295 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10296 systems for files larger than 2GB.
10297
10298 .vitem &*${str2b64:*&<&'string'&>&*}*&
10299 .cindex "expansion" "base64 encoding"
10300 .cindex "base64 encoding" "in string expansion"
10301 .cindex "&%str2b64%& expansion item"
10302 This operator converts a string into one that is base64 encoded.
10303
10304
10305
10306 .vitem &*${strlen:*&<&'string'&>&*}*&
10307 .cindex "expansion" "string length"
10308 .cindex "string" "length in expansion"
10309 .cindex "&%strlen%& expansion item"
10310 The item is replace by the length of the expanded string, expressed as a
10311 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10312
10313
10314 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10315 .cindex "&%substr%& expansion item"
10316 .cindex "substring extraction"
10317 .cindex "expansion" "substring expansion"
10318 The &%substr%& operator is a simpler interface to the &%substr%& function that
10319 can be used when the two parameters are fixed numbers (as opposed to strings
10320 that change when expanded). The effect is the same as
10321 .code
10322 ${substr{<start>}{<length>}{<string>}}
10323 .endd
10324 See the description of the general &%substr%& item above for details. The
10325 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10326
10327 .vitem &*${time_eval:*&<&'string'&>&*}*&
10328 .cindex "&%time_eval%& expansion item"
10329 .cindex "time interval" "decoding"
10330 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10331 seconds.
10332
10333 .vitem &*${time_interval:*&<&'string'&>&*}*&
10334 .cindex "&%time_interval%& expansion item"
10335 .cindex "time interval" "formatting"
10336 The argument (after sub-expansion) must be a sequence of decimal digits that
10337 represents an interval of time as a number of seconds. It is converted into a
10338 number of larger units and output in Exim's normal time format, for example,
10339 &`1w3d4h2m6s`&.
10340
10341 .vitem &*${uc:*&<&'string'&>&*}*&
10342 .cindex "case forcing in strings"
10343 .cindex "string" "case forcing"
10344 .cindex "upper casing"
10345 .cindex "expansion" "case forcing"
10346 .cindex "&%uc%& expansion item"
10347 This forces the letters in the string into upper-case.
10348
10349 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10350 .cindex "correction of invalid utf-8 sequences in strings"
10351 .cindex "utf-8" "utf-8 sequences"
10352 .cindex "incorrect utf-8"
10353 .cindex "expansion" "utf-8 forcing"
10354 .cindex "&%utf8clean%& expansion item"
10355 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10356 .endlist
10357
10358
10359
10360
10361
10362
10363 .section "Expansion conditions" "SECTexpcond"
10364 .scindex IIDexpcond "expansion" "conditions"
10365 The following conditions are available for testing by the &%${if%& construct
10366 while expanding strings:
10367
10368 .vlist
10369 .vitem &*!*&<&'condition'&>
10370 .cindex "expansion" "negating a condition"
10371 .cindex "negation" "in expansion condition"
10372 Preceding any condition with an exclamation mark negates the result of the
10373 condition.
10374
10375 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10376 .cindex "numeric comparison"
10377 .cindex "expansion" "numeric comparison"
10378 There are a number of symbolic operators for doing numeric comparisons. They
10379 are:
10380 .display
10381 &`=   `&   equal
10382 &`==  `&   equal
10383 &`>   `&   greater
10384 &`>=  `&   greater or equal
10385 &`<   `&   less
10386 &`<=  `&   less or equal
10387 .endd
10388 For example:
10389 .code
10390 ${if >{$message_size}{10M} ...
10391 .endd
10392 Note that the general negation operator provides for inequality testing. The
10393 two strings must take the form of optionally signed decimal integers,
10394 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10395 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10396 As a special case, the numerical value of an empty string is taken as
10397 zero.
10398
10399 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10400 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10401 10M, not if 10M is larger than &$message_size$&.
10402
10403
10404 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10405         {*&<&'arg2'&>&*}...}*&
10406 .cindex "expansion" "calling an acl"
10407 .cindex "&%acl%&" "expansion condition"
10408 The name and zero to nine argument strings are first expanded separately.  The expanded
10409 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10410 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10411 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10412 and may use the variables; if another acl expansion is used the values
10413 are restored after it returns.  If the ACL sets
10414 a value using a "message =" modifier the variable $value becomes
10415 the result of the expansion, otherwise it is empty.
10416 If the ACL returns accept the condition is true; if deny, false.
10417 If the ACL returns defer the result is a forced-fail.
10418
10419 .vitem &*bool&~{*&<&'string'&>&*}*&
10420 .cindex "expansion" "boolean parsing"
10421 .cindex "&%bool%& expansion condition"
10422 This condition turns a string holding a true or false representation into
10423 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10424 (case-insensitively); also integer numbers map to true if non-zero,
10425 false if zero.
10426 An empty string is treated as false.
10427 Leading and trailing whitespace is ignored;
10428 thus a string consisting only of whitespace is false.
10429 All other string values will result in expansion failure.
10430
10431 When combined with ACL variables, this expansion condition will let you
10432 make decisions in one place and act on those decisions in another place.
10433 For example:
10434 .code
10435 ${if bool{$acl_m_privileged_sender} ...
10436 .endd
10437
10438
10439 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10440 .cindex "expansion" "boolean parsing"
10441 .cindex "&%bool_lax%& expansion condition"
10442 Like &%bool%&, this condition turns a string into a boolean state.  But
10443 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10444 loose definition that the Router &%condition%& option uses.  The empty string
10445 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10446 true.  Leading and trailing whitespace is ignored.
10447
10448 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10449
10450 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10451 .cindex "expansion" "encrypted comparison"
10452 .cindex "encrypted strings, comparing"
10453 .cindex "&%crypteq%& expansion condition"
10454 This condition is included in the Exim binary if it is built to support any
10455 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10456 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10457 included in the binary.
10458
10459 The &%crypteq%& condition has two arguments. The first is encrypted and
10460 compared against the second, which is already encrypted. The second string may
10461 be in the LDAP form for storing encrypted strings, which starts with the
10462 encryption type in curly brackets, followed by the data. If the second string
10463 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10464 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10465 Typically this will be a field from a password file. An example of an encrypted
10466 string in LDAP form is:
10467 .code
10468 {md5}CY9rzUYh03PK3k6DJie09g==
10469 .endd
10470 If such a string appears directly in an expansion, the curly brackets have to
10471 be quoted, because they are part of the expansion syntax. For example:
10472 .code
10473 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10474 .endd
10475 The following encryption types (whose names are matched case-independently) are
10476 supported:
10477
10478 .ilist
10479 .cindex "MD5 hash"
10480 .cindex "base64 encoding" "in encrypted password"
10481 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10482 printable characters to compare with the remainder of the second string. If the
10483 length of the comparison string is 24, Exim assumes that it is base64 encoded
10484 (as in the above example). If the length is 32, Exim assumes that it is a
10485 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10486 comparison fails.
10487
10488 .next
10489 .cindex "SHA-1 hash"
10490 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10491 printable characters to compare with the remainder of the second string. If the
10492 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10493 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10494 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10495
10496 .next
10497 .cindex "&[crypt()]&"
10498 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10499 only the first eight characters of the password. However, in modern operating
10500 systems this is no longer true, and in many cases the entire password is used,
10501 whatever its length.
10502
10503 .next
10504 .cindex "&[crypt16()]&"
10505 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10506 use up to 16 characters of the password in some operating systems. Again, in
10507 modern operating systems, more characters may be used.
10508 .endlist
10509 Exim has its own version of &[crypt16()]&, which is just a double call to
10510 &[crypt()]&. For operating systems that have their own version, setting
10511 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10512 operating system version instead of its own. This option is set by default in
10513 the OS-dependent &_Makefile_& for those operating systems that are known to
10514 support &[crypt16()]&.
10515
10516 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10517 it was not using the same algorithm as some operating systems' versions. It
10518 turns out that as well as &[crypt16()]& there is a function called
10519 &[bigcrypt()]& in some operating systems. This may or may not use the same
10520 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10521
10522 However, since there is now a move away from the traditional &[crypt()]&
10523 functions towards using SHA1 and other algorithms, tidying up this area of
10524 Exim is seen as very low priority.
10525
10526 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10527 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10528 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10529 default is &`{crypt}`&. Whatever the default, you can always use either
10530 function by specifying it explicitly in curly brackets.
10531
10532 .vitem &*def:*&<&'variable&~name'&>
10533 .cindex "expansion" "checking for empty variable"
10534 .cindex "&%def%& expansion condition"
10535 The &%def%& condition must be followed by the name of one of the expansion
10536 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10537 variable does not contain the empty string. For example:
10538 .code
10539 ${if def:sender_ident {from $sender_ident}}
10540 .endd
10541 Note that the variable name is given without a leading &%$%& character. If the
10542 variable does not exist, the expansion fails.
10543
10544 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10545         &~&*def:h_*&<&'header&~name'&>&*:*&"
10546 .cindex "expansion" "checking header line existence"
10547 This condition is true if a message is being processed and the named header
10548 exists in the message. For example,
10549 .code
10550 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10551 .endd
10552 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10553 the header name must be terminated by a colon if white space does not follow.
10554
10555 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10556        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10557 .cindex "string" "comparison"
10558 .cindex "expansion" "string comparison"
10559 .cindex "&%eq%& expansion condition"
10560 .cindex "&%eqi%& expansion condition"
10561 The two substrings are first expanded. The condition is true if the two
10562 resulting strings are identical. For &%eq%& the comparison includes the case of
10563 letters, whereas for &%eqi%& the comparison is case-independent.
10564
10565 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10566 .cindex "expansion" "file existence test"
10567 .cindex "file" "existence test"
10568 .cindex "&%exists%&, expansion condition"
10569 The substring is first expanded and then interpreted as an absolute path. The
10570 condition is true if the named file (or directory) exists. The existence test
10571 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10572 users' filter files may be locked out by the system administrator.
10573
10574 .vitem &*first_delivery*&
10575 .cindex "delivery" "first"
10576 .cindex "first delivery"
10577 .cindex "expansion" "first delivery test"
10578 .cindex "&%first_delivery%& expansion condition"
10579 This condition, which has no data, is true during a message's first delivery
10580 attempt. It is false during any subsequent delivery attempts.
10581
10582
10583 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10584        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10585 .cindex "list" "iterative conditions"
10586 .cindex "expansion" "&*forall*& condition"
10587 .cindex "expansion" "&*forany*& condition"
10588 .vindex "&$item$&"
10589 These conditions iterate over a list. The first argument is expanded to form
10590 the list. By default, the list separator is a colon, but it can be changed by
10591 the normal method. The second argument is interpreted as a condition that is to
10592 be applied to each item in the list in turn. During the interpretation of the
10593 condition, the current list item is placed in a variable called &$item$&.
10594 .ilist
10595 For &*forany*&, interpretation stops if the condition is true for any item, and
10596 the result of the whole condition is true. If the condition is false for all
10597 items in the list, the overall condition is false.
10598 .next
10599 For &*forall*&, interpretation stops if the condition is false for any item,
10600 and the result of the whole condition is false. If the condition is true for
10601 all items in the list, the overall condition is true.
10602 .endlist
10603 Note that negation of &*forany*& means that the condition must be false for all
10604 items for the overall condition to succeed, and negation of &*forall*& means
10605 that the condition must be false for at least one item. In this example, the
10606 list separator is changed to a comma:
10607 .code
10608 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10609 .endd
10610 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10611 being processed, to enable these expansion items to be nested.
10612
10613 To scan a named list, expand it with the &*listnamed*& operator.
10614
10615
10616 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10617        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10618 .cindex "string" "comparison"
10619 .cindex "expansion" "string comparison"
10620 .cindex "&%ge%& expansion condition"
10621 .cindex "&%gei%& expansion condition"
10622 The two substrings are first expanded. The condition is true if the first
10623 string is lexically greater than or equal to the second string. For &%ge%& the
10624 comparison includes the case of letters, whereas for &%gei%& the comparison is
10625 case-independent.
10626
10627 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10628        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10629 .cindex "string" "comparison"
10630 .cindex "expansion" "string comparison"
10631 .cindex "&%gt%& expansion condition"
10632 .cindex "&%gti%& expansion condition"
10633 The two substrings are first expanded. The condition is true if the first
10634 string is lexically greater than the second string. For &%gt%& the comparison
10635 includes the case of letters, whereas for &%gti%& the comparison is
10636 case-independent.
10637
10638 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10639        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10640 .cindex "string" "comparison"
10641 .cindex "list" "iterative conditions"
10642 Both strings are expanded; the second string is treated as a list of simple
10643 strings; if the first string is a member of the second, then the condition
10644 is true.
10645
10646 These are simpler to use versions of the more powerful &*forany*& condition.
10647 Examples, and the &*forany*& equivalents:
10648 .code
10649 ${if inlist{needle}{foo:needle:bar}}
10650   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10651 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10652   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10653 .endd
10654
10655 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10656        &*isip4&~{*&<&'string'&>&*}*& &&&
10657        &*isip6&~{*&<&'string'&>&*}*&
10658 .cindex "IP address" "testing string format"
10659 .cindex "string" "testing for IP address"
10660 .cindex "&%isip%& expansion condition"
10661 .cindex "&%isip4%& expansion condition"
10662 .cindex "&%isip6%& expansion condition"
10663 The substring is first expanded, and then tested to see if it has the form of
10664 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10665 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10666
10667 For an IPv4 address, the test is for four dot-separated components, each of
10668 which consists of from one to three digits. For an IPv6 address, up to eight
10669 colon-separated components are permitted, each containing from one to four
10670 hexadecimal digits. There may be fewer than eight components if an empty
10671 component (adjacent colons) is present. Only one empty component is permitted.
10672
10673 &*Note*&: The checks are just on the form of the address; actual numerical
10674 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10675 check. The main use of these tests is to distinguish between IP addresses and
10676 host names, or between IPv4 and IPv6 addresses. For example, you could use
10677 .code
10678 ${if isip4{$sender_host_address}...
10679 .endd
10680 to test which IP version an incoming SMTP connection is using.
10681
10682 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10683 .cindex "LDAP" "use for authentication"
10684 .cindex "expansion" "LDAP authentication test"
10685 .cindex "&%ldapauth%& expansion condition"
10686 This condition supports user authentication using LDAP. See section
10687 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10688 queries. For this use, the query must contain a user name and password. The
10689 query itself is not used, and can be empty. The condition is true if the
10690 password is not empty, and the user name and password are accepted by the LDAP
10691 server. An empty password is rejected without calling LDAP because LDAP binds
10692 with an empty password are considered anonymous regardless of the username, and
10693 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10694 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10695 this can be used.
10696
10697
10698 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10699        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10700 .cindex "string" "comparison"
10701 .cindex "expansion" "string comparison"
10702 .cindex "&%le%& expansion condition"
10703 .cindex "&%lei%& expansion condition"
10704 The two substrings are first expanded. The condition is true if the first
10705 string is lexically less than or equal to the second string. For &%le%& the
10706 comparison includes the case of letters, whereas for &%lei%& the comparison is
10707 case-independent.
10708
10709 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10710        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10711 .cindex "string" "comparison"
10712 .cindex "expansion" "string comparison"
10713 .cindex "&%lt%& expansion condition"
10714 .cindex "&%lti%& expansion condition"
10715 The two substrings are first expanded. The condition is true if the first
10716 string is lexically less than the second string. For &%lt%& the comparison
10717 includes the case of letters, whereas for &%lti%& the comparison is
10718 case-independent.
10719
10720
10721 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10722 .cindex "expansion" "regular expression comparison"
10723 .cindex "regular expressions" "match in expanded string"
10724 .cindex "&%match%& expansion condition"
10725 The two substrings are first expanded. The second is then treated as a regular
10726 expression and applied to the first. Because of the pre-expansion, if the
10727 regular expression contains dollar, or backslash characters, they must be
10728 escaped. Care must also be taken if the regular expression contains braces
10729 (curly brackets). A closing brace must be escaped so that it is not taken as a
10730 premature termination of <&'string2'&>. The easiest approach is to use the
10731 &`\N`& feature to disable expansion of the regular expression.
10732 For example,
10733 .code
10734 ${if match {$local_part}{\N^\d{3}\N} ...
10735 .endd
10736 If the whole expansion string is in double quotes, further escaping of
10737 backslashes is also required.
10738
10739 The condition is true if the regular expression match succeeds.
10740 The regular expression is not required to begin with a circumflex
10741 metacharacter, but if there is no circumflex, the expression is not anchored,
10742 and it may match anywhere in the subject, not just at the start. If you want
10743 the pattern to match at the end of the subject, you must include the &`$`&
10744 metacharacter at an appropriate point.
10745
10746 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10747 At the start of an &%if%& expansion the values of the numeric variable
10748 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10749 succeeds causes them to be reset to the substrings of that condition and they
10750 will have these values during the expansion of the success string. At the end
10751 of the &%if%& expansion, the previous values are restored. After testing a
10752 combination of conditions using &%or%&, the subsequent values of the numeric
10753 variables are those of the condition that succeeded.
10754
10755 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10756 .cindex "&%match_address%& expansion condition"
10757 See &*match_local_part*&.
10758
10759 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10760 .cindex "&%match_domain%& expansion condition"
10761 See &*match_local_part*&.
10762
10763 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10764 .cindex "&%match_ip%& expansion condition"
10765 This condition matches an IP address to a list of IP address patterns. It must
10766 be followed by two argument strings. The first (after expansion) must be an IP
10767 address or an empty string. The second (not expanded) is a restricted host
10768 list that can match only an IP address, not a host name. For example:
10769 .code
10770 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10771 .endd
10772 The specific types of host list item that are permitted in the list are:
10773
10774 .ilist
10775 An IP address, optionally with a CIDR mask.
10776 .next
10777 A single asterisk, which matches any IP address.
10778 .next
10779 An empty item, which matches only if the IP address is empty. This could be
10780 useful for testing for a locally submitted message or one from specific hosts
10781 in a single test such as
10782 . ==== As this is a nested list, any displays it contains must be indented
10783 . ==== as otherwise they are too far to the left. This comment applies to
10784 . ==== the use of xmlto plus fop. There's no problem when formatting with
10785 . ==== sdop, with or without the extra indent.
10786 .code
10787   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10788 .endd
10789 where the first item in the list is the empty string.
10790 .next
10791 The item @[] matches any of the local host's interface addresses.
10792 .next
10793 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10794 even if &`net-`& is not specified. There is never any attempt to turn the IP
10795 address into a host name. The most common type of linear search for
10796 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10797 masks. For example:
10798 .code
10799   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10800 .endd
10801 It is of course possible to use other kinds of lookup, and in such a case, you
10802 do need to specify the &`net-`& prefix if you want to specify a specific
10803 address mask, for example:
10804 .code
10805   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10806 .endd
10807 However, unless you are combining a &%match_ip%& condition with others, it is
10808 just as easy to use the fact that a lookup is itself a condition, and write:
10809 .code
10810   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10811 .endd
10812 .endlist ilist
10813
10814 Note that <&'string2'&> is not itself subject to string expansion, unless
10815 Exim was built with the EXPAND_LISTMATCH_RHS option.
10816
10817 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10818
10819 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10820 .cindex "domain list" "in expansion condition"
10821 .cindex "address list" "in expansion condition"
10822 .cindex "local part" "list, in expansion condition"
10823 .cindex "&%match_local_part%& expansion condition"
10824 This condition, together with &%match_address%& and &%match_domain%&, make it
10825 possible to test domain, address, and local part lists within expansions. Each
10826 condition requires two arguments: an item and a list to match. A trivial
10827 example is:
10828 .code
10829 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10830 .endd
10831 In each case, the second argument may contain any of the allowable items for a
10832 list of the appropriate type. Also, because the second argument (after
10833 expansion) is a standard form of list, it is possible to refer to a named list.
10834 Thus, you can use conditions like this:
10835 .code
10836 ${if match_domain{$domain}{+local_domains}{...
10837 .endd
10838 .cindex "&`+caseful`&"
10839 For address lists, the matching starts off caselessly, but the &`+caseful`&
10840 item can be used, as in all address lists, to cause subsequent items to
10841 have their local parts matched casefully. Domains are always matched
10842 caselessly.
10843
10844 Note that <&'string2'&> is not itself subject to string expansion, unless
10845 Exim was built with the EXPAND_LISTMATCH_RHS option.
10846
10847 &*Note*&: Host lists are &'not'& supported in this way. This is because
10848 hosts have two identities: a name and an IP address, and it is not clear
10849 how to specify cleanly how such a test would work. However, IP addresses can be
10850 matched using &%match_ip%&.
10851
10852 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10853 .cindex "PAM authentication"
10854 .cindex "AUTH" "with PAM"
10855 .cindex "Solaris" "PAM support"
10856 .cindex "expansion" "PAM authentication test"
10857 .cindex "&%pam%& expansion condition"
10858 &'Pluggable Authentication Modules'&
10859 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10860 available in the latest releases of Solaris and in some GNU/Linux
10861 distributions. The Exim support, which is intended for use in conjunction with
10862 the SMTP AUTH command, is available only if Exim is compiled with
10863 .code
10864 SUPPORT_PAM=yes
10865 .endd
10866 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10867 in some releases of GNU/Linux &%-ldl%& is also needed.
10868
10869 The argument string is first expanded, and the result must be a
10870 colon-separated list of strings. Leading and trailing white space is ignored.
10871 The PAM module is initialized with the service name &"exim"& and the user name
10872 taken from the first item in the colon-separated data string (<&'string1'&>).
10873 The remaining items in the data string are passed over in response to requests
10874 from the authentication function. In the simple case there will only be one
10875 request, for a password, so the data consists of just two strings.
10876
10877 There can be problems if any of the strings are permitted to contain colon
10878 characters. In the usual way, these have to be doubled to avoid being taken as
10879 separators. If the data is being inserted from a variable, the &%sg%& expansion
10880 item can be used to double any existing colons. For example, the configuration
10881 of a LOGIN authenticator might contain this setting:
10882 .code
10883 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10884 .endd
10885 For a PLAIN authenticator you could use:
10886 .code
10887 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10888 .endd
10889 In some operating systems, PAM authentication can be done only from a process
10890 running as root. Since Exim is running as the Exim user when receiving
10891 messages, this means that PAM cannot be used directly in those systems.
10892 A patched version of the &'pam_unix'& module that comes with the
10893 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10894 The patched module allows one special uid/gid combination, in addition to root,
10895 to authenticate. If you build the patched module to allow the Exim user and
10896 group, PAM can then be used from an Exim authenticator.
10897
10898
10899 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10900 .cindex "&'pwcheck'& daemon"
10901 .cindex "Cyrus"
10902 .cindex "expansion" "&'pwcheck'& authentication test"
10903 .cindex "&%pwcheck%& expansion condition"
10904 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10905 This is one way of making it possible for passwords to be checked by a process
10906 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10907 deprecated. Its replacement is &'saslauthd'& (see below).
10908
10909 The pwcheck support is not included in Exim by default. You need to specify
10910 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10911 building Exim. For example:
10912 .code
10913 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10914 .endd
10915 You do not need to install the full Cyrus software suite in order to use
10916 the pwcheck daemon. You can compile and install just the daemon alone
10917 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10918 access to the &_/var/pwcheck_& directory.
10919
10920 The &%pwcheck%& condition takes one argument, which must be the user name and
10921 password, separated by a colon. For example, in a LOGIN authenticator
10922 configuration, you might have this:
10923 .code
10924 server_condition = ${if pwcheck{$auth1:$auth2}}
10925 .endd
10926 Again, for a PLAIN authenticator configuration, this would be:
10927 .code
10928 server_condition = ${if pwcheck{$auth2:$auth3}}
10929 .endd
10930 .vitem &*queue_running*&
10931 .cindex "queue runner" "detecting when delivering from"
10932 .cindex "expansion" "queue runner test"
10933 .cindex "&%queue_running%& expansion condition"
10934 This condition, which has no data, is true during delivery attempts that are
10935 initiated by queue runner processes, and false otherwise.
10936
10937
10938 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10939 .cindex "Radius"
10940 .cindex "expansion" "Radius authentication"
10941 .cindex "&%radius%& expansion condition"
10942 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10943 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10944 the Radius client configuration file in order to build Exim with Radius
10945 support.
10946
10947 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10948 library, using the original API. If you are using release 0.4.0 or later of
10949 this library, you need to set
10950 .code
10951 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10952 .endd
10953 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10954 &%libradius%& library that comes with FreeBSD. To do this, set
10955 .code
10956 RADIUS_LIB_TYPE=RADLIB
10957 .endd
10958 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10959 You may also have to supply a suitable setting in EXTRALIBS so that the
10960 Radius library can be found when Exim is linked.
10961
10962 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10963 Radius client library, which calls the Radius server. The condition is true if
10964 the authentication is successful. For example:
10965 .code
10966 server_condition = ${if radius{<arguments>}}
10967 .endd
10968
10969
10970 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10971         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10972 .cindex "&'saslauthd'& daemon"
10973 .cindex "Cyrus"
10974 .cindex "expansion" "&'saslauthd'& authentication test"
10975 .cindex "&%saslauthd%& expansion condition"
10976 This condition supports user authentication using the Cyrus &'saslauthd'&
10977 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10978 Using this daemon is one way of making it possible for passwords to be checked
10979 by a process that is not running as root.
10980
10981 The saslauthd support is not included in Exim by default. You need to specify
10982 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10983 building Exim. For example:
10984 .code
10985 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10986 .endd
10987 You do not need to install the full Cyrus software suite in order to use
10988 the saslauthd daemon. You can compile and install just the daemon alone
10989 from the Cyrus SASL library.
10990
10991 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10992 two are mandatory. For example:
10993 .code
10994 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10995 .endd
10996 The service and the realm are optional (which is why the arguments are enclosed
10997 in their own set of braces). For details of the meaning of the service and
10998 realm, and how to run the daemon, consult the Cyrus documentation.
10999 .endlist vlist
11000
11001
11002
11003 .section "Combining expansion conditions" "SECID84"
11004 .cindex "expansion" "combining conditions"
11005 Several conditions can be tested at once by combining them using the &%and%&
11006 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11007 conditions on their own, and precede their lists of sub-conditions. Each
11008 sub-condition must be enclosed in braces within the overall braces that contain
11009 the list. No repetition of &%if%& is used.
11010
11011
11012 .vlist
11013 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11014 .cindex "&""or""& expansion condition"
11015 .cindex "expansion" "&""or""& of conditions"
11016 The sub-conditions are evaluated from left to right. The condition is true if
11017 any one of the sub-conditions is true.
11018 For example,
11019 .code
11020 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11021 .endd
11022 When a true sub-condition is found, the following ones are parsed but not
11023 evaluated. If there are several &"match"& sub-conditions the values of the
11024 numeric variables afterwards are taken from the first one that succeeds.
11025
11026 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11027 .cindex "&""and""& expansion condition"
11028 .cindex "expansion" "&""and""& of conditions"
11029 The sub-conditions are evaluated from left to right. The condition is true if
11030 all of the sub-conditions are true. If there are several &"match"&
11031 sub-conditions, the values of the numeric variables afterwards are taken from
11032 the last one. When a false sub-condition is found, the following ones are
11033 parsed but not evaluated.
11034 .endlist
11035 .ecindex IIDexpcond
11036
11037
11038
11039
11040 .section "Expansion variables" "SECTexpvar"
11041 .cindex "expansion" "variables, list of"
11042 This section contains an alphabetical list of all the expansion variables. Some
11043 of them are available only when Exim is compiled with specific options such as
11044 support for TLS or the content scanning extension.
11045
11046 .vlist
11047 .vitem "&$0$&, &$1$&, etc"
11048 .cindex "numerical variables (&$1$& &$2$& etc)"
11049 When a &%match%& expansion condition succeeds, these variables contain the
11050 captured substrings identified by the regular expression during subsequent
11051 processing of the success string of the containing &%if%& expansion item.
11052 However, they do not retain their values afterwards; in fact, their previous
11053 values are restored at the end of processing an &%if%& item. The numerical
11054 variables may also be set externally by some other matching process which
11055 precedes the expansion of the string. For example, the commands available in
11056 Exim filter files include an &%if%& command with its own regular expression
11057 matching condition.
11058
11059 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11060 Within an acl condition, expansion condition or expansion item
11061 any arguments are copied to these variables,
11062 any unused variables being made empty.
11063
11064 .vitem "&$acl_c...$&"
11065 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11066 can be given any name that starts with &$acl_c$& and is at least six characters
11067 long, but the sixth character must be either a digit or an underscore. For
11068 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11069 variables persist throughout the lifetime of an SMTP connection. They can be
11070 used to pass information between ACLs and between different invocations of the
11071 same ACL. When a message is received, the values of these variables are saved
11072 with the message, and can be accessed by filters, routers, and transports
11073 during subsequent delivery.
11074
11075 .vitem "&$acl_m...$&"
11076 These variables are like the &$acl_c...$& variables, except that their values
11077 are reset after a message has been received. Thus, if several messages are
11078 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11079 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11080 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11081 message is received, the values of these variables are saved with the message,
11082 and can be accessed by filters, routers, and transports during subsequent
11083 delivery.
11084
11085 .vitem &$acl_narg$&
11086 Within an acl condition, expansion condition or expansion item
11087 this variable has the number of arguments.
11088
11089 .vitem &$acl_verify_message$&
11090 .vindex "&$acl_verify_message$&"
11091 After an address verification has failed, this variable contains the failure
11092 message. It retains its value for use in subsequent modifiers. The message can
11093 be preserved by coding like this:
11094 .code
11095 warn !verify = sender
11096      set acl_m0 = $acl_verify_message
11097 .endd
11098 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11099 &%log_message%& modifiers, to include information about the verification
11100 failure.
11101
11102 .vitem &$address_data$&
11103 .vindex "&$address_data$&"
11104 This variable is set by means of the &%address_data%& option in routers. The
11105 value then remains with the address while it is processed by subsequent routers
11106 and eventually a transport. If the transport is handling multiple addresses,
11107 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11108 for more details. &*Note*&: The contents of &$address_data$& are visible in
11109 user filter files.
11110
11111 If &$address_data$& is set when the routers are called from an ACL to verify
11112 a recipient address, the final value is still in the variable for subsequent
11113 conditions and modifiers of the ACL statement. If routing the address caused it
11114 to be redirected to just one address, the child address is also routed as part
11115 of the verification, and in this case the final value of &$address_data$& is
11116 from the child's routing.
11117
11118 If &$address_data$& is set when the routers are called from an ACL to verify a
11119 sender address, the final value is also preserved, but this time in
11120 &$sender_address_data$&, to distinguish it from data from a recipient
11121 address.
11122
11123 In both cases (recipient and sender verification), the value does not persist
11124 after the end of the current ACL statement. If you want to preserve
11125 these values for longer, you can save them in ACL variables.
11126
11127 .vitem &$address_file$&
11128 .vindex "&$address_file$&"
11129 When, as a result of aliasing, forwarding, or filtering, a message is directed
11130 to a specific file, this variable holds the name of the file when the transport
11131 is running. At other times, the variable is empty. For example, using the
11132 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11133 .code
11134 /home/r2d2/savemail
11135 .endd
11136 then when the &(address_file)& transport is running, &$address_file$&
11137 contains the text string &`/home/r2d2/savemail`&.
11138 .cindex "Sieve filter" "value of &$address_file$&"
11139 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11140 then up to the transport configuration to generate an appropriate absolute path
11141 to the relevant file.
11142
11143 .vitem &$address_pipe$&
11144 .vindex "&$address_pipe$&"
11145 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11146 this variable holds the pipe command when the transport is running.
11147
11148 .vitem "&$auth1$& &-- &$auth3$&"
11149 .vindex "&$auth1$&, &$auth2$&, etc"
11150 These variables are used in SMTP authenticators (see chapters
11151 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11152
11153 .vitem &$authenticated_id$&
11154 .cindex "authentication" "id"
11155 .vindex "&$authenticated_id$&"
11156 When a server successfully authenticates a client it may be configured to
11157 preserve some of the authentication information in the variable
11158 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11159 user/password authenticator configuration might preserve the user name for use
11160 in the routers. Note that this is not the same information that is saved in
11161 &$sender_host_authenticated$&.
11162 When a message is submitted locally (that is, not over a TCP connection)
11163 the value of &$authenticated_id$& is normally the login name of the calling
11164 process. However, a trusted user can override this by means of the &%-oMai%&
11165 command line option.
11166
11167 .vitem &$authenticated_fail_id$&
11168 .cindex "authentication" "fail" "id"
11169 .vindex "&$authenticated_fail_id$&"
11170 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11171 will contain the failed authentication id. If more than one authentication
11172 id is attempted, it will contain only the last one. The variable is
11173 available for processing in the ACL's, generally the quit or notquit ACL.
11174 A message to a local recipient could still be accepted without requiring
11175 authentication, which means this variable could also be visible in all of
11176 the ACL's as well.
11177
11178
11179 .vitem &$authenticated_sender$&
11180 .cindex "sender" "authenticated"
11181 .cindex "authentication" "sender"
11182 .cindex "AUTH" "on MAIL command"
11183 .vindex "&$authenticated_sender$&"
11184 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11185 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11186 described in section &<<SECTauthparamail>>&. Unless the data is the string
11187 &"<>"&, it is set as the authenticated sender of the message, and the value is
11188 available during delivery in the &$authenticated_sender$& variable. If the
11189 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11190
11191 .vindex "&$qualify_domain$&"
11192 When a message is submitted locally (that is, not over a TCP connection), the
11193 value of &$authenticated_sender$& is an address constructed from the login
11194 name of the calling process and &$qualify_domain$&, except that a trusted user
11195 can override this by means of the &%-oMas%& command line option.
11196
11197
11198 .vitem &$authentication_failed$&
11199 .cindex "authentication" "failure"
11200 .vindex "&$authentication_failed$&"
11201 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11202 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11203 possible to distinguish between &"did not try to authenticate"&
11204 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11205 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11206 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11207 negative response to an AUTH command, including (for example) an attempt to use
11208 an undefined mechanism.
11209
11210 .vitem &$av_failed$&
11211 .cindex "content scanning" "AV scanner failure"
11212 This variable is available when Exim is compiled with the content-scanning
11213 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11214 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11215 the ACL malware condition.
11216
11217 .vitem &$body_linecount$&
11218 .cindex "message body" "line count"
11219 .cindex "body of message" "line count"
11220 .vindex "&$body_linecount$&"
11221 When a message is being received or delivered, this variable contains the
11222 number of lines in the message's body. See also &$message_linecount$&.
11223
11224 .vitem &$body_zerocount$&
11225 .cindex "message body" "binary zero count"
11226 .cindex "body of message" "binary zero count"
11227 .cindex "binary zero" "in message body"
11228 .vindex "&$body_zerocount$&"
11229 When a message is being received or delivered, this variable contains the
11230 number of binary zero bytes (ASCII NULs) in the message's body.
11231
11232 .vitem &$bounce_recipient$&
11233 .vindex "&$bounce_recipient$&"
11234 This is set to the recipient address of a bounce message while Exim is creating
11235 it. It is useful if a customized bounce message text file is in use (see
11236 chapter &<<CHAPemsgcust>>&).
11237
11238 .vitem &$bounce_return_size_limit$&
11239 .vindex "&$bounce_return_size_limit$&"
11240 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11241 up to a multiple of 1000. It is useful when a customized error message text
11242 file is in use (see chapter &<<CHAPemsgcust>>&).
11243
11244 .vitem &$caller_gid$&
11245 .cindex "gid (group id)" "caller"
11246 .vindex "&$caller_gid$&"
11247 The real group id under which the process that called Exim was running. This is
11248 not the same as the group id of the originator of a message (see
11249 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11250 incarnation normally contains the Exim gid.
11251
11252 .vitem &$caller_uid$&
11253 .cindex "uid (user id)" "caller"
11254 .vindex "&$caller_uid$&"
11255 The real user id under which the process that called Exim was running. This is
11256 not the same as the user id of the originator of a message (see
11257 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11258 incarnation normally contains the Exim uid.
11259
11260 .vitem &$compile_date$&
11261 .vindex "&$compile_date$&"
11262 The date on which the Exim binary was compiled.
11263
11264 .vitem &$compile_number$&
11265 .vindex "&$compile_number$&"
11266 The building process for Exim keeps a count of the number
11267 of times it has been compiled. This serves to distinguish different
11268 compilations of the same version of the program.
11269
11270 .new
11271 .vitem &$config_dir$&
11272 .vindex "&$config_dir$&"
11273 The directory name of the main configuration file. That is, the content of
11274 &$config_file$& with the last component stripped. The value does not
11275 contain the trailing slash. If &$config_file$& does not contain a slash,
11276 &$config_dir$& is ".".
11277
11278 .vitem &$config_file$&
11279 .vindex "&$config_file$&"
11280 The name of the main configuration file Exim is using.
11281 .wen
11282
11283 .vitem &$demime_errorlevel$&
11284 .vindex "&$demime_errorlevel$&"
11285 This variable is available when Exim is compiled with
11286 the content-scanning extension and the obsolete &%demime%& condition. For
11287 details, see section &<<SECTdemimecond>>&.
11288
11289 .vitem &$demime_reason$&
11290 .vindex "&$demime_reason$&"
11291 This variable is available when Exim is compiled with the
11292 content-scanning extension and the obsolete &%demime%& condition. For details,
11293 see section &<<SECTdemimecond>>&.
11294
11295 .vitem &$dnslist_domain$& &&&
11296        &$dnslist_matched$& &&&
11297        &$dnslist_text$& &&&
11298        &$dnslist_value$&
11299 .vindex "&$dnslist_domain$&"
11300 .vindex "&$dnslist_matched$&"
11301 .vindex "&$dnslist_text$&"
11302 .vindex "&$dnslist_value$&"
11303 .cindex "black list (DNS)"
11304 When a DNS (black) list lookup succeeds, these variables are set to contain
11305 the following data from the lookup: the list's domain name, the key that was
11306 looked up, the contents of any associated TXT record, and the value from the
11307 main A record. See section &<<SECID204>>& for more details.
11308
11309 .vitem &$domain$&
11310 .vindex "&$domain$&"
11311 When an address is being routed, or delivered on its own, this variable
11312 contains the domain. Uppercase letters in the domain are converted into lower
11313 case for &$domain$&.
11314
11315 Global address rewriting happens when a message is received, so the value of
11316 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11317 is set during user filtering, but not during system filtering, because a
11318 message may have many recipients and the system filter is called just once.
11319
11320 When more than one address is being delivered at once (for example, several
11321 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11322 have the same domain. Transports can be restricted to handling only one domain
11323 at a time if the value of &$domain$& is required at transport time &-- this is
11324 the default for local transports. For further details of the environment in
11325 which local transports are run, see chapter &<<CHAPenvironment>>&.
11326
11327 .oindex "&%delay_warning_condition%&"
11328 At the end of a delivery, if all deferred addresses have the same domain, it is
11329 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11330
11331 The &$domain$& variable is also used in some other circumstances:
11332
11333 .ilist
11334 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11335 the recipient address. The domain of the &'sender'& address is in
11336 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11337 normally set during the running of the MAIL ACL. However, if the sender address
11338 is verified with a callout during the MAIL ACL, the sender domain is placed in
11339 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11340 the &(smtp)& transport.
11341
11342 .next
11343 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11344 &$domain$& contains the domain portion of the address that is being rewritten;
11345 it can be used in the expansion of the replacement address, for example, to
11346 rewrite domains by file lookup.
11347
11348 .next
11349 With one important exception, whenever a domain list is being scanned,
11350 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11351 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11352 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11353 that, in a RCPT ACL, the sender domain list can be dependent on the
11354 recipient domain (which is what is in &$domain$& at this time).
11355
11356 .next
11357 .cindex "ETRN" "value of &$domain$&"
11358 .oindex "&%smtp_etrn_command%&"
11359 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11360 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11361 .endlist
11362
11363
11364 .vitem &$domain_data$&
11365 .vindex "&$domain_data$&"
11366 When the &%domains%& option on a router matches a domain by
11367 means of a lookup, the data read by the lookup is available during the running
11368 of the router as &$domain_data$&. In addition, if the driver routes the
11369 address to a transport, the value is available in that transport. If the
11370 transport is handling multiple addresses, the value from the first address is
11371 used.
11372
11373 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11374 domain by means of a lookup. The data read by the lookup is available during
11375 the rest of the ACL statement. In all other situations, this variable expands
11376 to nothing.
11377
11378 .vitem &$exim_gid$&
11379 .vindex "&$exim_gid$&"
11380 This variable contains the numerical value of the Exim group id.
11381
11382 .vitem &$exim_path$&
11383 .vindex "&$exim_path$&"
11384 This variable contains the path to the Exim binary.
11385
11386 .vitem &$exim_uid$&
11387 .vindex "&$exim_uid$&"
11388 This variable contains the numerical value of the Exim user id.
11389
11390 .new
11391 .vitem &$exim_version$&
11392 .vindex "&$exim_uid$&"
11393 This variable contains the version string of the Exim build.
11394 The first character is a major version number, currently 4.
11395 Then after a dot, the next group of digits is a minor version number.
11396 There may be other characters following the minor version.
11397 .wen
11398
11399 .vitem &$found_extension$&
11400 .vindex "&$found_extension$&"
11401 This variable is available when Exim is compiled with the
11402 content-scanning extension and the obsolete &%demime%& condition. For details,
11403 see section &<<SECTdemimecond>>&.
11404
11405 .vitem &$header_$&<&'name'&>
11406 This is not strictly an expansion variable. It is expansion syntax for
11407 inserting the message header line with the given name. Note that the name must
11408 be terminated by colon or white space, because it may contain a wide variety of
11409 characters. Note also that braces must &'not'& be used.
11410
11411 .vitem &$headers_added$&
11412 .vindex "&$headers_added$&"
11413 Within an ACL this variable contains the headers added so far by
11414 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11415 The headers are a newline-separated list.
11416
11417 .vitem &$home$&
11418 .vindex "&$home$&"
11419 When the &%check_local_user%& option is set for a router, the user's home
11420 directory is placed in &$home$& when the check succeeds. In particular, this
11421 means it is set during the running of users' filter files. A router may also
11422 explicitly set a home directory for use by a transport; this can be overridden
11423 by a setting on the transport itself.
11424
11425 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11426 of the environment variable HOME.
11427
11428 .vitem &$host$&
11429 .vindex "&$host$&"
11430 If a router assigns an address to a transport (any transport), and passes a
11431 list of hosts with the address, the value of &$host$& when the transport starts
11432 to run is the name of the first host on the list. Note that this applies both
11433 to local and remote transports.
11434
11435 .cindex "transport" "filter"
11436 .cindex "filter" "transport filter"
11437 For the &(smtp)& transport, if there is more than one host, the value of
11438 &$host$& changes as the transport works its way through the list. In
11439 particular, when the &(smtp)& transport is expanding its options for encryption
11440 using TLS, or for specifying a transport filter (see chapter
11441 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11442 is connected.
11443
11444 When used in the client part of an authenticator configuration (see chapter
11445 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11446 client is connected.
11447
11448
11449 .vitem &$host_address$&
11450 .vindex "&$host_address$&"
11451 This variable is set to the remote host's IP address whenever &$host$& is set
11452 for a remote connection. It is also set to the IP address that is being checked
11453 when the &%ignore_target_hosts%& option is being processed.
11454
11455 .vitem &$host_data$&
11456 .vindex "&$host_data$&"
11457 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11458 result of the lookup is made available in the &$host_data$& variable. This
11459 allows you, for example, to do things like this:
11460 .code
11461 deny  hosts = net-lsearch;/some/file
11462 message = $host_data
11463 .endd
11464 .vitem &$host_lookup_deferred$&
11465 .cindex "host name" "lookup, failure of"
11466 .vindex "&$host_lookup_deferred$&"
11467 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11468 message comes from a remote host and there is an attempt to look up the host's
11469 name from its IP address, and the attempt is not successful, one of these
11470 variables is set to &"1"&.
11471
11472 .ilist
11473 If the lookup receives a definite negative response (for example, a DNS lookup
11474 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11475
11476 .next
11477 If there is any kind of problem during the lookup, such that Exim cannot
11478 tell whether or not the host name is defined (for example, a timeout for a DNS
11479 lookup), &$host_lookup_deferred$& is set to &"1"&.
11480 .endlist ilist
11481
11482 Looking up a host's name from its IP address consists of more than just a
11483 single reverse lookup. Exim checks that a forward lookup of at least one of the
11484 names it receives from a reverse lookup yields the original IP address. If this
11485 is not the case, Exim does not accept the looked up name(s), and
11486 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11487 IP address (for example, the existence of a PTR record in the DNS) is not
11488 sufficient on its own for the success of a host name lookup. If the reverse
11489 lookup succeeds, but there is a lookup problem such as a timeout when checking
11490 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11491 &"1"&. See also &$sender_host_name$&.
11492
11493 .vitem &$host_lookup_failed$&
11494 .vindex "&$host_lookup_failed$&"
11495 See &$host_lookup_deferred$&.
11496
11497 .vitem &$host_port$&
11498 .vindex "&$host_port$&"
11499 This variable is set to the remote host's TCP port whenever &$host$& is set
11500 for an outbound connection.
11501
11502
11503 .vitem &$inode$&
11504 .vindex "&$inode$&"
11505 The only time this variable is set is while expanding the &%directory_file%&
11506 option in the &(appendfile)& transport. The variable contains the inode number
11507 of the temporary file which is about to be renamed. It can be used to construct
11508 a unique name for the file.
11509
11510 .vitem &$interface_address$&
11511 .vindex "&$interface_address$&"
11512 This is an obsolete name for &$received_ip_address$&.
11513
11514 .vitem &$interface_port$&
11515 .vindex "&$interface_port$&"
11516 This is an obsolete name for &$received_port$&.
11517
11518 .vitem &$item$&
11519 .vindex "&$item$&"
11520 This variable is used during the expansion of &*forall*& and &*forany*&
11521 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11522 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11523 empty.
11524
11525 .vitem &$ldap_dn$&
11526 .vindex "&$ldap_dn$&"
11527 This variable, which is available only when Exim is compiled with LDAP support,
11528 contains the DN from the last entry in the most recently successful LDAP
11529 lookup.
11530
11531 .vitem &$load_average$&
11532 .vindex "&$load_average$&"
11533 This variable contains the system load average, multiplied by 1000 so that it
11534 is an integer. For example, if the load average is 0.21, the value of the
11535 variable is 210. The value is recomputed every time the variable is referenced.
11536
11537 .vitem &$local_part$&
11538 .vindex "&$local_part$&"
11539 When an address is being routed, or delivered on its own, this
11540 variable contains the local part. When a number of addresses are being
11541 delivered together (for example, multiple RCPT commands in an SMTP
11542 session), &$local_part$& is not set.
11543
11544 Global address rewriting happens when a message is received, so the value of
11545 &$local_part$& during routing and delivery is the value after rewriting.
11546 &$local_part$& is set during user filtering, but not during system filtering,
11547 because a message may have many recipients and the system filter is called just
11548 once.
11549
11550 .vindex "&$local_part_prefix$&"
11551 .vindex "&$local_part_suffix$&"
11552 If a local part prefix or suffix has been recognized, it is not included in the
11553 value of &$local_part$& during routing and subsequent delivery. The values of
11554 any prefix or suffix are in &$local_part_prefix$& and
11555 &$local_part_suffix$&, respectively.
11556
11557 When a message is being delivered to a file, pipe, or autoreply transport as a
11558 result of aliasing or forwarding, &$local_part$& is set to the local part of
11559 the parent address, not to the file name or command (see &$address_file$& and
11560 &$address_pipe$&).
11561
11562 When an ACL is running for a RCPT command, &$local_part$& contains the
11563 local part of the recipient address.
11564
11565 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11566 &$local_part$& contains the local part of the address that is being rewritten;
11567 it can be used in the expansion of the replacement address, for example.
11568
11569 In all cases, all quoting is removed from the local part. For example, for both
11570 the addresses
11571 .code
11572 "abc:xyz"@test.example
11573 abc\:xyz@test.example
11574 .endd
11575 the value of &$local_part$& is
11576 .code
11577 abc:xyz
11578 .endd
11579 If you use &$local_part$& to create another address, you should always wrap it
11580 inside a quoting operator. For example, in a &(redirect)& router you could
11581 have:
11582 .code
11583 data = ${quote_local_part:$local_part}@new.domain.example
11584 .endd
11585 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11586 to process local parts in a case-dependent manner in a router, you can set the
11587 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11588
11589 .vitem &$local_part_data$&
11590 .vindex "&$local_part_data$&"
11591 When the &%local_parts%& option on a router matches a local part by means of a
11592 lookup, the data read by the lookup is available during the running of the
11593 router as &$local_part_data$&. In addition, if the driver routes the address
11594 to a transport, the value is available in that transport. If the transport is
11595 handling multiple addresses, the value from the first address is used.
11596
11597 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11598 matches a local part by means of a lookup. The data read by the lookup is
11599 available during the rest of the ACL statement. In all other situations, this
11600 variable expands to nothing.
11601
11602 .vitem &$local_part_prefix$&
11603 .vindex "&$local_part_prefix$&"
11604 When an address is being routed or delivered, and a
11605 specific prefix for the local part was recognized, it is available in this
11606 variable, having been removed from &$local_part$&.
11607
11608 .vitem &$local_part_suffix$&
11609 .vindex "&$local_part_suffix$&"
11610 When an address is being routed or delivered, and a
11611 specific suffix for the local part was recognized, it is available in this
11612 variable, having been removed from &$local_part$&.
11613
11614 .vitem &$local_scan_data$&
11615 .vindex "&$local_scan_data$&"
11616 This variable contains the text returned by the &[local_scan()]& function when
11617 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11618
11619 .vitem &$local_user_gid$&
11620 .vindex "&$local_user_gid$&"
11621 See &$local_user_uid$&.
11622
11623 .vitem &$local_user_uid$&
11624 .vindex "&$local_user_uid$&"
11625 This variable and &$local_user_gid$& are set to the uid and gid after the
11626 &%check_local_user%& router precondition succeeds. This means that their values
11627 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11628 and &%condition%&), for the &%address_data%& expansion, and for any
11629 router-specific expansions. At all other times, the values in these variables
11630 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11631
11632 .vitem &$localhost_number$&
11633 .vindex "&$localhost_number$&"
11634 This contains the expanded value of the
11635 &%localhost_number%& option. The expansion happens after the main options have
11636 been read.
11637
11638 .vitem &$log_inodes$&
11639 .vindex "&$log_inodes$&"
11640 The number of free inodes in the disk partition where Exim's
11641 log files are being written. The value is recalculated whenever the variable is
11642 referenced. If the relevant file system does not have the concept of inodes,
11643 the value of is -1. See also the &%check_log_inodes%& option.
11644
11645 .vitem &$log_space$&
11646 .vindex "&$log_space$&"
11647 The amount of free space (as a number of kilobytes) in the disk
11648 partition where Exim's log files are being written. The value is recalculated
11649 whenever the variable is referenced. If the operating system does not have the
11650 ability to find the amount of free space (only true for experimental systems),
11651 the space value is -1. See also the &%check_log_space%& option.
11652
11653
11654 .vitem &$lookup_dnssec_authenticated$&
11655 .vindex "&$lookup_dnssec_authenticated$&"
11656 This variable is set after a DNS lookup done by
11657 a dnsdb lookup expansion, dnslookup router or smtp transport.
11658 It will be empty if &(DNSSEC)& was not requested,
11659 &"no"& if the result was not labelled as authenticated data
11660 and &"yes"& if it was.
11661
11662 .vitem &$mailstore_basename$&
11663 .vindex "&$mailstore_basename$&"
11664 This variable is set only when doing deliveries in &"mailstore"& format in the
11665 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11666 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11667 contains the basename of the files that are being written, that is, the name
11668 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11669 variable is empty.
11670
11671 .vitem &$malware_name$&
11672 .vindex "&$malware_name$&"
11673 This variable is available when Exim is compiled with the
11674 content-scanning extension. It is set to the name of the virus that was found
11675 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11676
11677 .vitem &$max_received_linelength$&
11678 .vindex "&$max_received_linelength$&"
11679 .cindex "maximum" "line length"
11680 .cindex "line length" "maximum"
11681 This variable contains the number of bytes in the longest line that was
11682 received as part of the message, not counting the line termination
11683 character(s).
11684
11685 .vitem &$message_age$&
11686 .cindex "message" "age of"
11687 .vindex "&$message_age$&"
11688 This variable is set at the start of a delivery attempt to contain the number
11689 of seconds since the message was received. It does not change during a single
11690 delivery attempt.
11691
11692 .vitem &$message_body$&
11693 .cindex "body of message" "expansion variable"
11694 .cindex "message body" "in expansion"
11695 .cindex "binary zero" "in message body"
11696 .vindex "&$message_body$&"
11697 .oindex "&%message_body_visible%&"
11698 This variable contains the initial portion of a message's body while it is
11699 being delivered, and is intended mainly for use in filter files. The maximum
11700 number of characters of the body that are put into the variable is set by the
11701 &%message_body_visible%& configuration option; the default is 500.
11702
11703 .oindex "&%message_body_newlines%&"
11704 By default, newlines are converted into spaces in &$message_body$&, to make it
11705 easier to search for phrases that might be split over a line break. However,
11706 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11707 zeros are always converted into spaces.
11708
11709 .vitem &$message_body_end$&
11710 .cindex "body of message" "expansion variable"
11711 .cindex "message body" "in expansion"
11712 .vindex "&$message_body_end$&"
11713 This variable contains the final portion of a message's
11714 body while it is being delivered. The format and maximum size are as for
11715 &$message_body$&.
11716
11717 .vitem &$message_body_size$&
11718 .cindex "body of message" "size"
11719 .cindex "message body" "size"
11720 .vindex "&$message_body_size$&"
11721 When a message is being delivered, this variable contains the size of the body
11722 in bytes. The count starts from the character after the blank line that
11723 separates the body from the header. Newlines are included in the count. See
11724 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11725
11726 .vitem &$message_exim_id$&
11727 .vindex "&$message_exim_id$&"
11728 When a message is being received or delivered, this variable contains the
11729 unique message id that is generated and used by Exim to identify the message.
11730 An id is not created for a message until after its header has been successfully
11731 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11732 line; it is the local id that Exim assigns to the message, for example:
11733 &`1BXTIK-0001yO-VA`&.
11734
11735 .vitem &$message_headers$&
11736 .vindex &$message_headers$&
11737 This variable contains a concatenation of all the header lines when a message
11738 is being processed, except for lines added by routers or transports. The header
11739 lines are separated by newline characters. Their contents are decoded in the
11740 same way as a header line that is inserted by &%bheader%&.
11741
11742 .vitem &$message_headers_raw$&
11743 .vindex &$message_headers_raw$&
11744 This variable is like &$message_headers$& except that no processing of the
11745 contents of header lines is done.
11746
11747 .vitem &$message_id$&
11748 This is an old name for &$message_exim_id$&. It is now deprecated.
11749
11750 .vitem &$message_linecount$&
11751 .vindex "&$message_linecount$&"
11752 This variable contains the total number of lines in the header and body of the
11753 message. Compare &$body_linecount$&, which is the count for the body only.
11754 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11755 number of lines received. Before delivery happens (that is, before filters,
11756 routers, and transports run) the count is increased to include the
11757 &'Received:'& header line that Exim standardly adds, and also any other header
11758 lines that are added by ACLs. The blank line that separates the message header
11759 from the body is not counted.
11760
11761 As with the special case of &$message_size$&, during the expansion of the
11762 appendfile transport's maildir_tag option in maildir format, the value of
11763 &$message_linecount$& is the precise size of the number of newlines in the
11764 file that has been written (minus one for the blank line between the
11765 header and the body).
11766
11767 Here is an example of the use of this variable in a DATA ACL:
11768 .code
11769 deny message   = Too many lines in message header
11770      condition = \
11771       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11772 .endd
11773 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11774 message has not yet been received.
11775
11776 .vitem &$message_size$&
11777 .cindex "size" "of message"
11778 .cindex "message" "size"
11779 .vindex "&$message_size$&"
11780 When a message is being processed, this variable contains its size in bytes. In
11781 most cases, the size includes those headers that were received with the
11782 message, but not those (such as &'Envelope-to:'&) that are added to individual
11783 deliveries as they are written. However, there is one special case: during the
11784 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11785 doing a delivery in maildir format, the value of &$message_size$& is the
11786 precise size of the file that has been written. See also
11787 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11788
11789 .cindex "RCPT" "value of &$message_size$&"
11790 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11791 contains the size supplied on the MAIL command, or -1 if no size was given. The
11792 value may not, of course, be truthful.
11793
11794 .vitem &$mime_$&&'xxx'&
11795 A number of variables whose names start with &$mime$& are
11796 available when Exim is compiled with the content-scanning extension. For
11797 details, see section &<<SECTscanmimepart>>&.
11798
11799 .vitem "&$n0$& &-- &$n9$&"
11800 These variables are counters that can be incremented by means
11801 of the &%add%& command in filter files.
11802
11803 .vitem &$original_domain$&
11804 .vindex "&$domain$&"
11805 .vindex "&$original_domain$&"
11806 When a top-level address is being processed for delivery, this contains the
11807 same value as &$domain$&. However, if a &"child"& address (for example,
11808 generated by an alias, forward, or filter file) is being processed, this
11809 variable contains the domain of the original address (lower cased). This
11810 differs from &$parent_domain$& only when there is more than one level of
11811 aliasing or forwarding. When more than one address is being delivered in a
11812 single transport run, &$original_domain$& is not set.
11813
11814 If a new address is created by means of a &%deliver%& command in a system
11815 filter, it is set up with an artificial &"parent"& address. This has the local
11816 part &'system-filter'& and the default qualify domain.
11817
11818 .vitem &$original_local_part$&
11819 .vindex "&$local_part$&"
11820 .vindex "&$original_local_part$&"
11821 When a top-level address is being processed for delivery, this contains the
11822 same value as &$local_part$&, unless a prefix or suffix was removed from the
11823 local part, because &$original_local_part$& always contains the full local
11824 part. When a &"child"& address (for example, generated by an alias, forward, or
11825 filter file) is being processed, this variable contains the full local part of
11826 the original address.
11827
11828 If the router that did the redirection processed the local part
11829 case-insensitively, the value in &$original_local_part$& is in lower case.
11830 This variable differs from &$parent_local_part$& only when there is more than
11831 one level of aliasing or forwarding. When more than one address is being
11832 delivered in a single transport run, &$original_local_part$& is not set.
11833
11834 If a new address is created by means of a &%deliver%& command in a system
11835 filter, it is set up with an artificial &"parent"& address. This has the local
11836 part &'system-filter'& and the default qualify domain.
11837
11838 .vitem &$originator_gid$&
11839 .cindex "gid (group id)" "of originating user"
11840 .cindex "sender" "gid"
11841 .vindex "&$caller_gid$&"
11842 .vindex "&$originator_gid$&"
11843 This variable contains the value of &$caller_gid$& that was set when the
11844 message was received. For messages received via the command line, this is the
11845 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11846 normally the gid of the Exim user.
11847
11848 .vitem &$originator_uid$&
11849 .cindex "uid (user id)" "of originating user"
11850 .cindex "sender" "uid"
11851 .vindex "&$caller_uid$&"
11852 .vindex "&$originaltor_uid$&"
11853 The value of &$caller_uid$& that was set when the message was received. For
11854 messages received via the command line, this is the uid of the sending user.
11855 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11856 user.
11857
11858 .vitem &$parent_domain$&
11859 .vindex "&$parent_domain$&"
11860 This variable is similar to &$original_domain$& (see
11861 above), except that it refers to the immediately preceding parent address.
11862
11863 .vitem &$parent_local_part$&
11864 .vindex "&$parent_local_part$&"
11865 This variable is similar to &$original_local_part$&
11866 (see above), except that it refers to the immediately preceding parent address.
11867
11868 .vitem &$pid$&
11869 .cindex "pid (process id)" "of current process"
11870 .vindex "&$pid$&"
11871 This variable contains the current process id.
11872
11873 .vitem &$pipe_addresses$&
11874 .cindex "filter" "transport filter"
11875 .cindex "transport" "filter"
11876 .vindex "&$pipe_addresses$&"
11877 This is not an expansion variable, but is mentioned here because the string
11878 &`$pipe_addresses`& is handled specially in the command specification for the
11879 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11880 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11881 It cannot be used in general expansion strings, and provokes an &"unknown
11882 variable"& error if encountered.
11883
11884 .vitem &$primary_hostname$&
11885 .vindex "&$primary_hostname$&"
11886 This variable contains the value set by &%primary_hostname%& in the
11887 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11888 a single-component name, Exim calls &[gethostbyname()]& (or
11889 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11890 qualified host name. See also &$smtp_active_hostname$&.
11891
11892
11893 .vitem &$prvscheck_address$&
11894 This variable is used in conjunction with the &%prvscheck%& expansion item,
11895 which is described in sections &<<SECTexpansionitems>>& and
11896 &<<SECTverifyPRVS>>&.
11897
11898 .vitem &$prvscheck_keynum$&
11899 This variable is used in conjunction with the &%prvscheck%& expansion item,
11900 which is described in sections &<<SECTexpansionitems>>& and
11901 &<<SECTverifyPRVS>>&.
11902
11903 .vitem &$prvscheck_result$&
11904 This variable is used in conjunction with the &%prvscheck%& expansion item,
11905 which is described in sections &<<SECTexpansionitems>>& and
11906 &<<SECTverifyPRVS>>&.
11907
11908 .vitem &$qualify_domain$&
11909 .vindex "&$qualify_domain$&"
11910 The value set for the &%qualify_domain%& option in the configuration file.
11911
11912 .vitem &$qualify_recipient$&
11913 .vindex "&$qualify_recipient$&"
11914 The value set for the &%qualify_recipient%& option in the configuration file,
11915 or if not set, the value of &$qualify_domain$&.
11916
11917 .vitem &$rcpt_count$&
11918 .vindex "&$rcpt_count$&"
11919 When a message is being received by SMTP, this variable contains the number of
11920 RCPT commands received for the current message. If this variable is used in a
11921 RCPT ACL, its value includes the current command.
11922
11923 .vitem &$rcpt_defer_count$&
11924 .vindex "&$rcpt_defer_count$&"
11925 .cindex "4&'xx'& responses" "count of"
11926 When a message is being received by SMTP, this variable contains the number of
11927 RCPT commands in the current message that have previously been rejected with a
11928 temporary (4&'xx'&) response.
11929
11930 .vitem &$rcpt_fail_count$&
11931 .vindex "&$rcpt_fail_count$&"
11932 When a message is being received by SMTP, this variable contains the number of
11933 RCPT commands in the current message that have previously been rejected with a
11934 permanent (5&'xx'&) response.
11935
11936 .vitem &$received_count$&
11937 .vindex "&$received_count$&"
11938 This variable contains the number of &'Received:'& header lines in the message,
11939 including the one added by Exim (so its value is always greater than zero). It
11940 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11941 delivering.
11942
11943 .vitem &$received_for$&
11944 .vindex "&$received_for$&"
11945 If there is only a single recipient address in an incoming message, this
11946 variable contains that address when the &'Received:'& header line is being
11947 built. The value is copied after recipient rewriting has happened, but before
11948 the &[local_scan()]& function is run.
11949
11950 .vitem &$received_ip_address$&
11951 .vindex "&$received_ip_address$&"
11952 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11953 variable is set to the address of the local IP interface, and &$received_port$&
11954 is set to the local port number. (The remote IP address and port are in
11955 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11956 the port value is -1 unless it has been set using the &%-oMi%& command line
11957 option.
11958
11959 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11960 could be used, for example, to make the file name for a TLS certificate depend
11961 on which interface and/or port is being used for the incoming connection. The
11962 values of &$received_ip_address$& and &$received_port$& are saved with any
11963 messages that are received, thus making these variables available at delivery
11964 time.
11965 For outbound connections see &$sending_ip_address$&.
11966
11967 .vitem &$received_port$&
11968 .vindex "&$received_port$&"
11969 See &$received_ip_address$&.
11970
11971 .vitem &$received_protocol$&
11972 .vindex "&$received_protocol$&"
11973 When a message is being processed, this variable contains the name of the
11974 protocol by which it was received. Most of the names used by Exim are defined
11975 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11976 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11977 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11978 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11979 connection and the client was successfully authenticated.
11980
11981 Exim uses the protocol name &"smtps"& for the case when encryption is
11982 automatically set up on connection without the use of STARTTLS (see
11983 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11984 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11985 where the client initially uses EHLO, sets up an encrypted connection using
11986 STARTTLS, and then uses HELO afterwards.
11987
11988 The &%-oMr%& option provides a way of specifying a custom protocol name for
11989 messages that are injected locally by trusted callers. This is commonly used to
11990 identify messages that are being re-injected after some kind of scanning.
11991
11992 .vitem &$received_time$&
11993 .vindex "&$received_time$&"
11994 This variable contains the date and time when the current message was received,
11995 as a number of seconds since the start of the Unix epoch.
11996
11997 .vitem &$recipient_data$&
11998 .vindex "&$recipient_data$&"
11999 This variable is set after an indexing lookup success in an ACL &%recipients%&
12000 condition. It contains the data from the lookup, and the value remains set
12001 until the next &%recipients%& test. Thus, you can do things like this:
12002 .display
12003 &`require recipients  = cdb*@;/some/file`&
12004 &`deny    `&&'some further test involving'& &`$recipient_data`&
12005 .endd
12006 &*Warning*&: This variable is set only when a lookup is used as an indexing
12007 method in the address list, using the semicolon syntax as in the example above.
12008 The variable is not set for a lookup that is used as part of the string
12009 expansion that all such lists undergo before being interpreted.
12010
12011 .vitem &$recipient_verify_failure$&
12012 .vindex "&$recipient_verify_failure$&"
12013 In an ACL, when a recipient verification fails, this variable contains
12014 information about the failure. It is set to one of the following words:
12015
12016 .ilist
12017 &"qualify"&: The address was unqualified (no domain), and the message
12018 was neither local nor came from an exempted host.
12019
12020 .next
12021 &"route"&: Routing failed.
12022
12023 .next
12024 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12025 or before the MAIL command (that is, on initial connection, HELO, or
12026 MAIL).
12027
12028 .next
12029 &"recipient"&: The RCPT command in a callout was rejected.
12030 .next
12031
12032 &"postmaster"&: The postmaster check in a callout was rejected.
12033 .endlist
12034
12035 The main use of this variable is expected to be to distinguish between
12036 rejections of MAIL and rejections of RCPT.
12037
12038 .vitem &$recipients$&
12039 .vindex "&$recipients$&"
12040 This variable contains a list of envelope recipients for a message. A comma and
12041 a space separate the addresses in the replacement text. However, the variable
12042 is not generally available, to prevent exposure of Bcc recipients in
12043 unprivileged users' filter files. You can use &$recipients$& only in these
12044 cases:
12045
12046 .olist
12047 In a system filter file.
12048 .next
12049 In the ACLs associated with the DATA command and with non-SMTP messages, that
12050 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12051 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12052 &%acl_not_smtp_mime%&.
12053 .next
12054 From within a &[local_scan()]& function.
12055 .endlist
12056
12057
12058 .vitem &$recipients_count$&
12059 .vindex "&$recipients_count$&"
12060 When a message is being processed, this variable contains the number of
12061 envelope recipients that came with the message. Duplicates are not excluded
12062 from the count. While a message is being received over SMTP, the number
12063 increases for each accepted recipient. It can be referenced in an ACL.
12064
12065
12066 .vitem &$regex_match_string$&
12067 .vindex "&$regex_match_string$&"
12068 This variable is set to contain the matching regular expression after a
12069 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12070
12071
12072 .vitem &$reply_address$&
12073 .vindex "&$reply_address$&"
12074 When a message is being processed, this variable contains the contents of the
12075 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12076 contents of the &'From:'& header line. Apart from the removal of leading
12077 white space, the value is not processed in any way. In particular, no RFC 2047
12078 decoding or character code translation takes place.
12079
12080 .vitem &$return_path$&
12081 .vindex "&$return_path$&"
12082 When a message is being delivered, this variable contains the return path &--
12083 the sender field that will be sent as part of the envelope. It is not enclosed
12084 in <> characters. At the start of routing an address, &$return_path$& has the
12085 same value as &$sender_address$&, but if, for example, an incoming message to a
12086 mailing list has been expanded by a router which specifies a different address
12087 for bounce messages, &$return_path$& subsequently contains the new bounce
12088 address, whereas &$sender_address$& always contains the original sender address
12089 that was received with the message. In other words, &$sender_address$& contains
12090 the incoming envelope sender, and &$return_path$& contains the outgoing
12091 envelope sender.
12092
12093 .vitem &$return_size_limit$&
12094 .vindex "&$return_size_limit$&"
12095 This is an obsolete name for &$bounce_return_size_limit$&.
12096
12097 .vitem &$router_name$&
12098 .cindex "router" "name"
12099 .cindex "name" "of router"
12100 .vindex "&$router_name$&"
12101 During the running of a router this variable contains its name.
12102
12103 .vitem &$runrc$&
12104 .cindex "return code" "from &%run%& expansion"
12105 .vindex "&$runrc$&"
12106 This variable contains the return code from a command that is run by the
12107 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12108 assume the order in which option values are expanded, except for those
12109 preconditions whose order of testing is documented. Therefore, you cannot
12110 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12111 another.
12112
12113 .vitem &$self_hostname$&
12114 .oindex "&%self%&" "value of host name"
12115 .vindex "&$self_hostname$&"
12116 When an address is routed to a supposedly remote host that turns out to be the
12117 local host, what happens is controlled by the &%self%& generic router option.
12118 One of its values causes the address to be passed to another router. When this
12119 happens, &$self_hostname$& is set to the name of the local host that the
12120 original router encountered. In other circumstances its contents are null.
12121
12122 .vitem &$sender_address$&
12123 .vindex "&$sender_address$&"
12124 When a message is being processed, this variable contains the sender's address
12125 that was received in the message's envelope. The case of letters in the address
12126 is retained, in both the local part and the domain. For bounce messages, the
12127 value of this variable is the empty string. See also &$return_path$&.
12128
12129 .vitem &$sender_address_data$&
12130 .vindex "&$address_data$&"
12131 .vindex "&$sender_address_data$&"
12132 If &$address_data$& is set when the routers are called from an ACL to verify a
12133 sender address, the final value is preserved in &$sender_address_data$&, to
12134 distinguish it from data from a recipient address. The value does not persist
12135 after the end of the current ACL statement. If you want to preserve it for
12136 longer, you can save it in an ACL variable.
12137
12138 .vitem &$sender_address_domain$&
12139 .vindex "&$sender_address_domain$&"
12140 The domain portion of &$sender_address$&.
12141
12142 .vitem &$sender_address_local_part$&
12143 .vindex "&$sender_address_local_part$&"
12144 The local part portion of &$sender_address$&.
12145
12146 .vitem &$sender_data$&
12147 .vindex "&$sender_data$&"
12148 This variable is set after a lookup success in an ACL &%senders%& condition or
12149 in a router &%senders%& option. It contains the data from the lookup, and the
12150 value remains set until the next &%senders%& test. Thus, you can do things like
12151 this:
12152 .display
12153 &`require senders      = cdb*@;/some/file`&
12154 &`deny    `&&'some further test involving'& &`$sender_data`&
12155 .endd
12156 &*Warning*&: This variable is set only when a lookup is used as an indexing
12157 method in the address list, using the semicolon syntax as in the example above.
12158 The variable is not set for a lookup that is used as part of the string
12159 expansion that all such lists undergo before being interpreted.
12160
12161 .vitem &$sender_fullhost$&
12162 .vindex "&$sender_fullhost$&"
12163 When a message is received from a remote host, this variable contains the host
12164 name and IP address in a single string. It ends with the IP address in square
12165 brackets, followed by a colon and a port number if the logging of ports is
12166 enabled. The format of the rest of the string depends on whether the host
12167 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12168 looking up its IP address. (Looking up the IP address can be forced by the
12169 &%host_lookup%& option, independent of verification.) A plain host name at the
12170 start of the string is a verified host name; if this is not present,
12171 verification either failed or was not requested. A host name in parentheses is
12172 the argument of a HELO or EHLO command. This is omitted if it is identical to
12173 the verified host name or to the host's IP address in square brackets.
12174
12175 .vitem &$sender_helo_name$&
12176 .vindex "&$sender_helo_name$&"
12177 When a message is received from a remote host that has issued a HELO or EHLO
12178 command, the argument of that command is placed in this variable. It is also
12179 set if HELO or EHLO is used when a message is received using SMTP locally via
12180 the &%-bs%& or &%-bS%& options.
12181
12182 .vitem &$sender_host_address$&
12183 .vindex "&$sender_host_address$&"
12184 When a message is received from a remote host using SMTP,
12185 this variable contains that
12186 host's IP address. For locally non-SMTP submitted messages, it is empty.
12187
12188 .vitem &$sender_host_authenticated$&
12189 .vindex "&$sender_host_authenticated$&"
12190 This variable contains the name (not the public name) of the authenticator
12191 driver that successfully authenticated the client from which the message was
12192 received. It is empty if there was no successful authentication. See also
12193 &$authenticated_id$&.
12194
12195 .vitem &$sender_host_dnssec$&
12196 .vindex "&$sender_host_dnssec$&"
12197 If an attempt to populate &$sender_host_name$& has been made
12198 (by reference, &%hosts_lookup%& or
12199 otherwise) then this boolean will have been set true if, and only if, the
12200 resolver library states that the reverse DNS was authenticated data.  At all
12201 other times, this variable is false.
12202
12203 It is likely that you will need to coerce DNSSEC support on in the resolver
12204 library, by setting:
12205 .code
12206 dns_dnssec_ok = 1
12207 .endd
12208
12209 Exim does not perform DNSSEC validation itself, instead leaving that to a
12210 validating resolver (eg, unbound, or bind with suitable configuration).
12211
12212 Exim does not (currently) check to see if the forward DNS was also secured
12213 with DNSSEC, only the reverse DNS.
12214
12215 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12216 mechanism in the list, then this variable will be false.
12217
12218
12219 .vitem &$sender_host_name$&
12220 .vindex "&$sender_host_name$&"
12221 When a message is received from a remote host, this variable contains the
12222 host's name as obtained by looking up its IP address. For messages received by
12223 other means, this variable is empty.
12224
12225 .vindex "&$host_lookup_failed$&"
12226 If the host name has not previously been looked up, a reference to
12227 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12228 A looked up name is accepted only if it leads back to the original IP address
12229 via a forward lookup. If either the reverse or the forward lookup fails to find
12230 any data, or if the forward lookup does not yield the original IP address,
12231 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12232
12233 .vindex "&$host_lookup_deferred$&"
12234 However, if either of the lookups cannot be completed (for example, there is a
12235 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12236 &$host_lookup_failed$& remains set to &"0"&.
12237
12238 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12239 host name again if there is a subsequent reference to &$sender_host_name$&
12240 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12241 is set to &"1"&.
12242
12243 Exim does not automatically look up every calling host's name. If you want
12244 maximum efficiency, you should arrange your configuration so that it avoids
12245 these lookups altogether. The lookup happens only if one or more of the
12246 following are true:
12247
12248 .ilist
12249 A string containing &$sender_host_name$& is expanded.
12250 .next
12251 The calling host matches the list in &%host_lookup%&. In the default
12252 configuration, this option is set to *, so it must be changed if lookups are
12253 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12254 .next
12255 Exim needs the host name in order to test an item in a host list. The items
12256 that require this are described in sections &<<SECThoslispatnam>>& and
12257 &<<SECThoslispatnamsk>>&.
12258 .next
12259 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12260 In this case, the host name is required to compare with the name quoted in any
12261 EHLO or HELO commands that the client issues.
12262 .next
12263 The remote host issues a EHLO or HELO command that quotes one of the
12264 domains in &%helo_lookup_domains%&. The default value of this option is
12265 . ==== As this is a nested list, any displays it contains must be indented
12266 . ==== as otherwise they are too far to the left.
12267 .code
12268   helo_lookup_domains = @ : @[]
12269 .endd
12270 which causes a lookup if a remote host (incorrectly) gives the server's name or
12271 IP address in an EHLO or HELO command.
12272 .endlist
12273
12274
12275 .vitem &$sender_host_port$&
12276 .vindex "&$sender_host_port$&"
12277 When a message is received from a remote host, this variable contains the port
12278 number that was used on the remote host.
12279
12280 .vitem &$sender_ident$&
12281 .vindex "&$sender_ident$&"
12282 When a message is received from a remote host, this variable contains the
12283 identification received in response to an RFC 1413 request. When a message has
12284 been received locally, this variable contains the login name of the user that
12285 called Exim.
12286
12287 .vitem &$sender_rate_$&&'xxx'&
12288 A number of variables whose names begin &$sender_rate_$& are set as part of the
12289 &%ratelimit%& ACL condition. Details are given in section
12290 &<<SECTratelimiting>>&.
12291
12292 .vitem &$sender_rcvhost$&
12293 .cindex "DNS" "reverse lookup"
12294 .cindex "reverse DNS lookup"
12295 .vindex "&$sender_rcvhost$&"
12296 This is provided specifically for use in &'Received:'& headers. It starts with
12297 either the verified host name (as obtained from a reverse DNS lookup) or, if
12298 there is no verified host name, the IP address in square brackets. After that
12299 there may be text in parentheses. When the first item is a verified host name,
12300 the first thing in the parentheses is the IP address in square brackets,
12301 followed by a colon and a port number if port logging is enabled. When the
12302 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12303 the parentheses.
12304
12305 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12306 was used and its argument was not identical to the real host name or IP
12307 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12308 all three items are present in the parentheses, a newline and tab are inserted
12309 into the string, to improve the formatting of the &'Received:'& header.
12310
12311 .vitem &$sender_verify_failure$&
12312 .vindex "&$sender_verify_failure$&"
12313 In an ACL, when a sender verification fails, this variable contains information
12314 about the failure. The details are the same as for
12315 &$recipient_verify_failure$&.
12316
12317 .vitem &$sending_ip_address$&
12318 .vindex "&$sending_ip_address$&"
12319 This variable is set whenever an outgoing SMTP connection to another host has
12320 been set up. It contains the IP address of the local interface that is being
12321 used. This is useful if a host that has more than one IP address wants to take
12322 on different personalities depending on which one is being used. For incoming
12323 connections, see &$received_ip_address$&.
12324
12325 .vitem &$sending_port$&
12326 .vindex "&$sending_port$&"
12327 This variable is set whenever an outgoing SMTP connection to another host has
12328 been set up. It contains the local port that is being used. For incoming
12329 connections, see &$received_port$&.
12330
12331 .vitem &$smtp_active_hostname$&
12332 .vindex "&$smtp_active_hostname$&"
12333 During an incoming SMTP session, this variable contains the value of the active
12334 host name, as specified by the &%smtp_active_hostname%& option. The value of
12335 &$smtp_active_hostname$& is saved with any message that is received, so its
12336 value can be consulted during routing and delivery.
12337
12338 .vitem &$smtp_command$&
12339 .vindex "&$smtp_command$&"
12340 During the processing of an incoming SMTP command, this variable contains the
12341 entire command. This makes it possible to distinguish between HELO and EHLO in
12342 the HELO ACL, and also to distinguish between commands such as these:
12343 .code
12344 MAIL FROM:<>
12345 MAIL FROM: <>
12346 .endd
12347 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12348 command, the address in &$smtp_command$& is the original address before any
12349 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12350 the address after SMTP-time rewriting.
12351
12352 .vitem &$smtp_command_argument$&
12353 .cindex "SMTP" "command, argument for"
12354 .vindex "&$smtp_command_argument$&"
12355 While an ACL is running to check an SMTP command, this variable contains the
12356 argument, that is, the text that follows the command name, with leading white
12357 space removed. Following the introduction of &$smtp_command$&, this variable is
12358 somewhat redundant, but is retained for backwards compatibility.
12359
12360 .vitem &$smtp_count_at_connection_start$&
12361 .vindex "&$smtp_count_at_connection_start$&"
12362 This variable is set greater than zero only in processes spawned by the Exim
12363 daemon for handling incoming SMTP connections. The name is deliberately long,
12364 in order to emphasize what the contents are. When the daemon accepts a new
12365 connection, it increments this variable. A copy of the variable is passed to
12366 the child process that handles the connection, but its value is fixed, and
12367 never changes. It is only an approximation of how many incoming connections
12368 there actually are, because many other connections may come and go while a
12369 single connection is being processed. When a child process terminates, the
12370 daemon decrements its copy of the variable.
12371
12372 .vitem "&$sn0$& &-- &$sn9$&"
12373 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12374 that were current at the end of the system filter file. This allows a system
12375 filter file to set values that can be tested in users' filter files. For
12376 example, a system filter could set a value indicating how likely it is that a
12377 message is junk mail.
12378
12379 .vitem &$spam_$&&'xxx'&
12380 A number of variables whose names start with &$spam$& are available when Exim
12381 is compiled with the content-scanning extension. For details, see section
12382 &<<SECTscanspamass>>&.
12383
12384
12385 .vitem &$spool_directory$&
12386 .vindex "&$spool_directory$&"
12387 The name of Exim's spool directory.
12388
12389 .vitem &$spool_inodes$&
12390 .vindex "&$spool_inodes$&"
12391 The number of free inodes in the disk partition where Exim's spool files are
12392 being written. The value is recalculated whenever the variable is referenced.
12393 If the relevant file system does not have the concept of inodes, the value of
12394 is -1. See also the &%check_spool_inodes%& option.
12395
12396 .vitem &$spool_space$&
12397 .vindex "&$spool_space$&"
12398 The amount of free space (as a number of kilobytes) in the disk partition where
12399 Exim's spool files are being written. The value is recalculated whenever the
12400 variable is referenced. If the operating system does not have the ability to
12401 find the amount of free space (only true for experimental systems), the space
12402 value is -1. For example, to check in an ACL that there is at least 50
12403 megabytes free on the spool, you could write:
12404 .code
12405 condition = ${if > {$spool_space}{50000}}
12406 .endd
12407 See also the &%check_spool_space%& option.
12408
12409
12410 .vitem &$thisaddress$&
12411 .vindex "&$thisaddress$&"
12412 This variable is set only during the processing of the &%foranyaddress%&
12413 command in a filter file. Its use is explained in the description of that
12414 command, which can be found in the separate document entitled &'Exim's
12415 interfaces to mail filtering'&.
12416
12417 .vitem &$tls_in_bits$&
12418 .vindex "&$tls_in_bits$&"
12419 Contains an approximation of the TLS cipher's bit-strength
12420 on the inbound connection; the meaning of
12421 this depends upon the TLS implementation used.
12422 If TLS has not been negotiated, the value will be 0.
12423 The value of this is automatically fed into the Cyrus SASL authenticator
12424 when acting as a server, to specify the "external SSF" (a SASL term).
12425
12426 The deprecated &$tls_bits$& variable refers to the inbound side
12427 except when used in the context of an outbound SMTP delivery, when it refers to
12428 the outbound.
12429
12430 .vitem &$tls_out_bits$&
12431 .vindex "&$tls_out_bits$&"
12432 Contains an approximation of the TLS cipher's bit-strength
12433 on an outbound SMTP connection; the meaning of
12434 this depends upon the TLS implementation used.
12435 If TLS has not been negotiated, the value will be 0.
12436
12437 .vitem &$tls_in_ourcert$&
12438 .vindex "&$tls_in_ourcert$&"
12439 This variable refers to the certificate presented to the peer of an
12440 inbound connection when the message was received.
12441 It is only useful as the argument of a
12442 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12443 or a &%def%& condition.
12444
12445 .vitem &$tls_in_peercert$&
12446 .vindex "&$tls_in_peercert$&"
12447 This variable refers to the certificate presented by the peer of an
12448 inbound connection when the message was received.
12449 It is only useful as the argument of a
12450 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12451 or a &%def%& condition.
12452 If certificate verification fails it may refer to a failing chain element
12453 which is not the leaf.
12454
12455 .vitem &$tls_out_ourcert$&
12456 .vindex "&$tls_out_ourcert$&"
12457 This variable refers to the certificate presented to the peer of an
12458 outbound connection.  It is only useful as the argument of a
12459 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12460 or a &%def%& condition.
12461
12462 .vitem &$tls_out_peercert$&
12463 .vindex "&$tls_out_peercert$&"
12464 This variable refers to the certificate presented by the peer of an
12465 outbound connection.  It is only useful as the argument of a
12466 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12467 or a &%def%& condition.
12468 If certificate verification fails it may refer to a failing chain element
12469 which is not the leaf.
12470
12471 .vitem &$tls_in_certificate_verified$&
12472 .vindex "&$tls_in_certificate_verified$&"
12473 This variable is set to &"1"& if a TLS certificate was verified when the
12474 message was received, and &"0"& otherwise.
12475
12476 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12477 except when used in the context of an outbound SMTP delivery, when it refers to
12478 the outbound.
12479
12480 .vitem &$tls_out_certificate_verified$&
12481 .vindex "&$tls_out_certificate_verified$&"
12482 This variable is set to &"1"& if a TLS certificate was verified when an
12483 outbound SMTP connection was made,
12484 and &"0"& otherwise.
12485
12486 .vitem &$tls_in_cipher$&
12487 .vindex "&$tls_in_cipher$&"
12488 .vindex "&$tls_cipher$&"
12489 When a message is received from a remote host over an encrypted SMTP
12490 connection, this variable is set to the cipher suite that was negotiated, for
12491 example DES-CBC3-SHA. In other circumstances, in particular, for message
12492 received over unencrypted connections, the variable is empty. Testing
12493 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12494 non-encrypted connections during ACL processing.
12495
12496 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12497 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12498 becomes the same as &$tls_out_cipher$&.
12499
12500 .vitem &$tls_out_cipher$&
12501 .vindex "&$tls_out_cipher$&"
12502 This variable is
12503 cleared before any outgoing SMTP connection is made,
12504 and then set to the outgoing cipher suite if one is negotiated. See chapter
12505 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12506 details of the &(smtp)& transport.
12507
12508 .vitem &$tls_in_ocsp$&
12509 .vindex "&$tls_in_ocsp$&"
12510 When a message is received from a remote client connection
12511 the result of any OCSP request from the client is encoded in this variable:
12512 .code
12513 0 OCSP proof was not requested (default value)
12514 1 No response to request
12515 2 Response not verified
12516 3 Verification failed
12517 4 Verification succeeded
12518 .endd
12519
12520 .vitem &$tls_out_ocsp$&
12521 .vindex "&$tls_out_ocsp$&"
12522 When a message is sent to a remote host connection
12523 the result of any OCSP request made is encoded in this variable.
12524 See &$tls_in_ocsp$& for values.
12525
12526 .vitem &$tls_in_peerdn$&
12527 .vindex "&$tls_in_peerdn$&"
12528 .vindex "&$tls_peerdn$&"
12529 When a message is received from a remote host over an encrypted SMTP
12530 connection, and Exim is configured to request a certificate from the client,
12531 the value of the Distinguished Name of the certificate is made available in the
12532 &$tls_in_peerdn$& during subsequent processing.
12533 If certificate verification fails it may refer to a failing chain element
12534 which is not the leaf.
12535
12536 The deprecated &$tls_peerdn$& variable refers to the inbound side
12537 except when used in the context of an outbound SMTP delivery, when it refers to
12538 the outbound.
12539
12540 .vitem &$tls_out_peerdn$&
12541 .vindex "&$tls_out_peerdn$&"
12542 When a message is being delivered to a remote host over an encrypted SMTP
12543 connection, and Exim is configured to request a certificate from the server,
12544 the value of the Distinguished Name of the certificate is made available in the
12545 &$tls_out_peerdn$& during subsequent processing.
12546 If certificate verification fails it may refer to a failing chain element
12547 which is not the leaf.
12548
12549 .vitem &$tls_in_sni$&
12550 .vindex "&$tls_in_sni$&"
12551 .vindex "&$tls_sni$&"
12552 .cindex "TLS" "Server Name Indication"
12553 When a TLS session is being established, if the client sends the Server
12554 Name Indication extension, the value will be placed in this variable.
12555 If the variable appears in &%tls_certificate%& then this option and
12556 some others, described in &<<SECTtlssni>>&,
12557 will be re-expanded early in the TLS session, to permit
12558 a different certificate to be presented (and optionally a different key to be
12559 used) to the client, based upon the value of the SNI extension.
12560
12561 The deprecated &$tls_sni$& variable refers to the inbound side
12562 except when used in the context of an outbound SMTP delivery, when it refers to
12563 the outbound.
12564
12565 .vitem &$tls_out_sni$&
12566 .vindex "&$tls_out_sni$&"
12567 .cindex "TLS" "Server Name Indication"
12568 During outbound
12569 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12570 the transport.
12571
12572 .vitem &$tod_bsdinbox$&
12573 .vindex "&$tod_bsdinbox$&"
12574 The time of day and the date, in the format required for BSD-style mailbox
12575 files, for example: Thu Oct 17 17:14:09 1995.
12576
12577 .vitem &$tod_epoch$&
12578 .vindex "&$tod_epoch$&"
12579 The time and date as a number of seconds since the start of the Unix epoch.
12580
12581 .vitem &$tod_epoch_l$&
12582 .vindex "&$tod_epoch_l$&"
12583 The time and date as a number of microseconds since the start of the Unix epoch.
12584
12585 .vitem &$tod_full$&
12586 .vindex "&$tod_full$&"
12587 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12588 +0100. The timezone is always given as a numerical offset from UTC, with
12589 positive values used for timezones that are ahead (east) of UTC, and negative
12590 values for those that are behind (west).
12591
12592 .vitem &$tod_log$&
12593 .vindex "&$tod_log$&"
12594 The time and date in the format used for writing Exim's log files, for example:
12595 1995-10-12 15:32:29, but without a timezone.
12596
12597 .vitem &$tod_logfile$&
12598 .vindex "&$tod_logfile$&"
12599 This variable contains the date in the format yyyymmdd. This is the format that
12600 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12601 flag.
12602
12603 .vitem &$tod_zone$&
12604 .vindex "&$tod_zone$&"
12605 This variable contains the numerical value of the local timezone, for example:
12606 -0500.
12607
12608 .vitem &$tod_zulu$&
12609 .vindex "&$tod_zulu$&"
12610 This variable contains the UTC date and time in &"Zulu"& format, as specified
12611 by ISO 8601, for example: 20030221154023Z.
12612
12613 .vitem &$transport_name$&
12614 .cindex "transport" "name"
12615 .cindex "name" "of transport"
12616 .vindex "&$transport_name$&"
12617 During the running of a transport, this variable contains its name.
12618
12619 .vitem &$value$&
12620 .vindex "&$value$&"
12621 This variable contains the result of an expansion lookup, extraction operation,
12622 or external command, as described above. It is also used during a
12623 &*reduce*& expansion.
12624
12625 .vitem &$verify_mode$&
12626 .vindex "&$verify_mode$&"
12627 While a router or transport is being run in verify mode
12628 or for cutthrough delivery,
12629 contains "S" for sender-verification or "R" for recipient-verification.
12630 Otherwise, empty.
12631
12632 .vitem &$version_number$&
12633 .vindex "&$version_number$&"
12634 The version number of Exim.
12635
12636 .vitem &$warn_message_delay$&
12637 .vindex "&$warn_message_delay$&"
12638 This variable is set only during the creation of a message warning about a
12639 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12640
12641 .vitem &$warn_message_recipients$&
12642 .vindex "&$warn_message_recipients$&"
12643 This variable is set only during the creation of a message warning about a
12644 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12645 .endlist
12646 .ecindex IIDstrexp
12647
12648
12649
12650 . ////////////////////////////////////////////////////////////////////////////
12651 . ////////////////////////////////////////////////////////////////////////////
12652
12653 .chapter "Embedded Perl" "CHAPperl"
12654 .scindex IIDperl "Perl" "calling from Exim"
12655 Exim can be built to include an embedded Perl interpreter. When this is done,
12656 Perl subroutines can be called as part of the string expansion process. To make
12657 use of the Perl support, you need version 5.004 or later of Perl installed on
12658 your system. To include the embedded interpreter in the Exim binary, include
12659 the line
12660 .code
12661 EXIM_PERL = perl.o
12662 .endd
12663 in your &_Local/Makefile_& and then build Exim in the normal way.
12664
12665
12666 .section "Setting up so Perl can be used" "SECID85"
12667 .oindex "&%perl_startup%&"
12668 Access to Perl subroutines is via a global configuration option called
12669 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12670 no &%perl_startup%& option in the Exim configuration file then no Perl
12671 interpreter is started and there is almost no overhead for Exim (since none of
12672 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12673 option then the associated value is taken to be Perl code which is executed in
12674 a newly created Perl interpreter.
12675
12676 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12677 need backslashes before any characters to escape special meanings. The option
12678 should usually be something like
12679 .code
12680 perl_startup = do '/etc/exim.pl'
12681 .endd
12682 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12683 use from Exim. Exim can be configured either to start up a Perl interpreter as
12684 soon as it is entered, or to wait until the first time it is needed. Starting
12685 the interpreter at the beginning ensures that it is done while Exim still has
12686 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12687 fact used in a particular run. Also, note that this does not mean that Exim is
12688 necessarily running as root when Perl is called at a later time. By default,
12689 the interpreter is started only when it is needed, but this can be changed in
12690 two ways:
12691
12692 .ilist
12693 .oindex "&%perl_at_start%&"
12694 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12695 a startup when Exim is entered.
12696 .next
12697 The command line option &%-ps%& also requests a startup when Exim is entered,
12698 overriding the setting of &%perl_at_start%&.
12699 .endlist
12700
12701 There is also a command line option &%-pd%& (for delay) which suppresses the
12702 initial startup, even if &%perl_at_start%& is set.
12703
12704
12705 .section "Calling Perl subroutines" "SECID86"
12706 When the configuration file includes a &%perl_startup%& option you can make use
12707 of the string expansion item to call the Perl subroutines that are defined
12708 by the &%perl_startup%& code. The operator is used in any of the following
12709 forms:
12710 .code
12711 ${perl{foo}}
12712 ${perl{foo}{argument}}
12713 ${perl{foo}{argument1}{argument2} ... }
12714 .endd
12715 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12716 arguments may be passed. Passing more than this results in an expansion failure
12717 with an error message of the form
12718 .code
12719 Too many arguments passed to Perl subroutine "foo" (max is 8)
12720 .endd
12721 The return value of the Perl subroutine is evaluated in a scalar context before
12722 it is passed back to Exim to be inserted into the expanded string. If the
12723 return value is &'undef'&, the expansion is forced to fail in the same way as
12724 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12725 by obeying Perl's &%die%& function, the expansion fails with the error message
12726 that was passed to &%die%&.
12727
12728
12729 .section "Calling Exim functions from Perl" "SECID87"
12730 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12731 is available to call back into Exim's string expansion function. For example,
12732 the Perl code
12733 .code
12734 my $lp = Exim::expand_string('$local_part');
12735 .endd
12736 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12737 Note those are single quotes and not double quotes to protect against
12738 &$local_part$& being interpolated as a Perl variable.
12739
12740 If the string expansion is forced to fail by a &"fail"& item, the result of
12741 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12742 expansion string, the Perl call from the original expansion string fails with
12743 an appropriate error message, in the same way as if &%die%& were used.
12744
12745 .cindex "debugging" "from embedded Perl"
12746 .cindex "log" "writing from embedded Perl"
12747 Two other Exim functions are available for use from within Perl code.
12748 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12749 debugging is enabled. If you want a newline at the end, you must supply it.
12750 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12751 timestamp. In this case, you should not supply a terminating newline.
12752
12753
12754 .section "Use of standard output and error by Perl" "SECID88"
12755 .cindex "Perl" "standard output and error"
12756 You should not write to the standard error or output streams from within your
12757 Perl code, as it is not defined how these are set up. In versions of Exim
12758 before 4.50, it is possible for the standard output or error to refer to the
12759 SMTP connection during message reception via the daemon. Writing to this stream
12760 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12761 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12762 avoided, but the output is lost.
12763
12764 .cindex "Perl" "use of &%warn%&"
12765 The Perl &%warn%& statement writes to the standard error stream by default.
12766 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12767 you have no control. When Exim starts up the Perl interpreter, it arranges for
12768 output from the &%warn%& statement to be written to the Exim main log. You can
12769 change this by including appropriate Perl magic somewhere in your Perl code.
12770 For example, to discard &%warn%& output completely, you need this:
12771 .code
12772 $SIG{__WARN__} = sub { };
12773 .endd
12774 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12775 example, the code for the subroutine is empty, so it does nothing, but you can
12776 include any Perl code that you like. The text of the &%warn%& message is passed
12777 as the first subroutine argument.
12778 .ecindex IIDperl
12779
12780
12781 . ////////////////////////////////////////////////////////////////////////////
12782 . ////////////////////////////////////////////////////////////////////////////
12783
12784 .chapter "Starting the daemon and the use of network interfaces" &&&
12785          "CHAPinterfaces" &&&
12786          "Starting the daemon"
12787 .cindex "daemon" "starting"
12788 .cindex "interface" "listening"
12789 .cindex "network interface"
12790 .cindex "interface" "network"
12791 .cindex "IP address" "for listening"
12792 .cindex "daemon" "listening IP addresses"
12793 .cindex "TCP/IP" "setting listening interfaces"
12794 .cindex "TCP/IP" "setting listening ports"
12795 A host that is connected to a TCP/IP network may have one or more physical
12796 hardware network interfaces. Each of these interfaces may be configured as one
12797 or more &"logical"& interfaces, which are the entities that a program actually
12798 works with. Each of these logical interfaces is associated with an IP address.
12799 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12800 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12801 knowledge about the host's interfaces for use in three different circumstances:
12802
12803 .olist
12804 When a listening daemon is started, Exim needs to know which interfaces
12805 and ports to listen on.
12806 .next
12807 When Exim is routing an address, it needs to know which IP addresses
12808 are associated with local interfaces. This is required for the correct
12809 processing of MX lists by removing the local host and others with the
12810 same or higher priority values. Also, Exim needs to detect cases
12811 when an address is routed to an IP address that in fact belongs to the
12812 local host. Unless the &%self%& router option or the &%allow_localhost%&
12813 option of the smtp transport is set (as appropriate), this is treated
12814 as an error situation.
12815 .next
12816 When Exim connects to a remote host, it may need to know which interface to use
12817 for the outgoing connection.
12818 .endlist
12819
12820
12821 Exim's default behaviour is likely to be appropriate in the vast majority
12822 of cases. If your host has only one interface, and you want all its IP
12823 addresses to be treated in the same way, and you are using only the
12824 standard SMTP port, you should not need to take any special action. The
12825 rest of this chapter does not apply to you.
12826
12827 In a more complicated situation you may want to listen only on certain
12828 interfaces, or on different ports, and for this reason there are a number of
12829 options that can be used to influence Exim's behaviour. The rest of this
12830 chapter describes how they operate.
12831
12832 When a message is received over TCP/IP, the interface and port that were
12833 actually used are set in &$received_ip_address$& and &$received_port$&.
12834
12835
12836
12837 .section "Starting a listening daemon" "SECID89"
12838 When a listening daemon is started (by means of the &%-bd%& command line
12839 option), the interfaces and ports on which it listens are controlled by the
12840 following options:
12841
12842 .ilist
12843 &%daemon_smtp_ports%& contains a list of default ports
12844 or service names.
12845 (For backward compatibility, this option can also be specified in the singular.)
12846 .next
12847 &%local_interfaces%& contains list of interface IP addresses on which to
12848 listen. Each item may optionally also specify a port.
12849 .endlist
12850
12851 The default list separator in both cases is a colon, but this can be changed as
12852 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12853 it is usually best to change the separator to avoid having to double all the
12854 colons. For example:
12855 .code
12856 local_interfaces = <; 127.0.0.1 ; \
12857                       192.168.23.65 ; \
12858                       ::1 ; \
12859                       3ffe:ffff:836f::fe86:a061
12860 .endd
12861 There are two different formats for specifying a port along with an IP address
12862 in &%local_interfaces%&:
12863
12864 .olist
12865 The port is added onto the address with a dot separator. For example, to listen
12866 on port 1234 on two different IP addresses:
12867 .code
12868 local_interfaces = <; 192.168.23.65.1234 ; \
12869                       3ffe:ffff:836f::fe86:a061.1234
12870 .endd
12871 .next
12872 The IP address is enclosed in square brackets, and the port is added
12873 with a colon separator, for example:
12874 .code
12875 local_interfaces = <; [192.168.23.65]:1234 ; \
12876                       [3ffe:ffff:836f::fe86:a061]:1234
12877 .endd
12878 .endlist
12879
12880 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12881 default setting contains just one port:
12882 .code
12883 daemon_smtp_ports = smtp
12884 .endd
12885 If more than one port is listed, each interface that does not have its own port
12886 specified listens on all of them. Ports that are listed in
12887 &%daemon_smtp_ports%& can be identified either by name (defined in
12888 &_/etc/services_&) or by number. However, when ports are given with individual
12889 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12890
12891
12892
12893 .section "Special IP listening addresses" "SECID90"
12894 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12895 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12896 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12897 instead of setting up separate listening sockets for each interface. The
12898 default value of &%local_interfaces%& is
12899 .code
12900 local_interfaces = 0.0.0.0
12901 .endd
12902 when Exim is built without IPv6 support; otherwise it is:
12903 .code
12904 local_interfaces = <; ::0 ; 0.0.0.0
12905 .endd
12906 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12907
12908
12909
12910 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12911 The &%-oX%& command line option can be used to override the values of
12912 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12913 instance. Another way of doing this would be to use macros and the &%-D%&
12914 option. However, &%-oX%& can be used by any admin user, whereas modification of
12915 the runtime configuration by &%-D%& is allowed only when the caller is root or
12916 exim.
12917
12918 The value of &%-oX%& is a list of items. The default colon separator can be
12919 changed in the usual way if required. If there are any items that do not
12920 contain dots or colons (that is, are not IP addresses), the value of
12921 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12922 items that do contain dots or colons, the value of &%local_interfaces%& is
12923 replaced by those items. Thus, for example,
12924 .code
12925 -oX 1225
12926 .endd
12927 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12928 whereas
12929 .code
12930 -oX 192.168.34.5.1125
12931 .endd
12932 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12933 (However, since &%local_interfaces%& now contains no items without ports, the
12934 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12935
12936
12937
12938 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12939 .cindex "ssmtp protocol"
12940 .cindex "smtps protocol"
12941 .cindex "SMTP" "ssmtp protocol"
12942 .cindex "SMTP" "smtps protocol"
12943 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12944 before the STARTTLS command was standardized for SMTP. Some legacy clients
12945 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12946 list of port numbers or service names,
12947 connections to those ports must use SSMTP. The most
12948 common use of this option is expected to be
12949 .code
12950 tls_on_connect_ports = 465
12951 .endd
12952 because 465 is the usual port number used by the legacy clients. There is also
12953 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12954 this way when a daemon is started.
12955
12956 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12957 daemon to listen on those ports. You must still specify them in
12958 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12959 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12960 connections via the daemon.)
12961
12962
12963
12964
12965 .section "IPv6 address scopes" "SECID92"
12966 .cindex "IPv6" "address scopes"
12967 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12968 can, in principle, have the same link-local IPv6 address on different
12969 interfaces. Thus, additional information is needed, over and above the IP
12970 address, to distinguish individual interfaces. A convention of using a
12971 percent sign followed by something (often the interface name) has been
12972 adopted in some cases, leading to addresses like this:
12973 .code
12974 fe80::202:b3ff:fe03:45c1%eth0
12975 .endd
12976 To accommodate this usage, a percent sign followed by an arbitrary string is
12977 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12978 to convert a textual IPv6 address for actual use. This function recognizes the
12979 percent convention in operating systems that support it, and it processes the
12980 address appropriately. Unfortunately, some older libraries have problems with
12981 &[getaddrinfo()]&. If
12982 .code
12983 IPV6_USE_INET_PTON=yes
12984 .endd
12985 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12986 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12987 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12988 function.) Of course, this means that the additional functionality of
12989 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12990
12991 .section "Disabling IPv6" "SECID93"
12992 .cindex "IPv6" "disabling"
12993 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12994 run on a host whose kernel does not support IPv6. The binary will fall back to
12995 using IPv4, but it may waste resources looking up AAAA records, and trying to
12996 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12997 .oindex "&%disable_ipv6%&"
12998 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12999 activities take place. AAAA records are never looked up, and any IPv6 addresses
13000 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13001 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13002 to handle IPv6 literal addresses.
13003
13004 On the other hand, when IPv6 is in use, there may be times when you want to
13005 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13006 option to globally suppress the lookup of AAAA records for specified domains,
13007 and you can use the &%ignore_target_hosts%& generic router option to ignore
13008 IPv6 addresses in an individual router.
13009
13010
13011
13012 .section "Examples of starting a listening daemon" "SECID94"
13013 The default case in an IPv6 environment is
13014 .code
13015 daemon_smtp_ports = smtp
13016 local_interfaces = <; ::0 ; 0.0.0.0
13017 .endd
13018 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13019 Either one or two sockets may be used, depending on the characteristics of
13020 the TCP/IP stack. (This is complicated and messy; for more information,
13021 read the comments in the &_daemon.c_& source file.)
13022
13023 To specify listening on ports 25 and 26 on all interfaces:
13024 .code
13025 daemon_smtp_ports = 25 : 26
13026 .endd
13027 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13028 .code
13029 local_interfaces = <; ::0.25     ; ::0.26 \
13030                       0.0.0.0.25 ; 0.0.0.0.26
13031 .endd
13032 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13033 IPv4 loopback address only:
13034 .code
13035 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13036 .endd
13037 To specify listening on the default port on specific interfaces only:
13038 .code
13039 local_interfaces = 10.0.0.67 : 192.168.34.67
13040 .endd
13041 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13042
13043
13044
13045 .section "Recognizing the local host" "SECTreclocipadd"
13046 The &%local_interfaces%& option is also used when Exim needs to determine
13047 whether or not an IP address refers to the local host. That is, the IP
13048 addresses of all the interfaces on which a daemon is listening are always
13049 treated as local.
13050
13051 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13052 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13053 available interfaces from the operating system, and extracts the relevant
13054 (that is, IPv4 or IPv6) addresses to use for checking.
13055
13056 Some systems set up large numbers of virtual interfaces in order to provide
13057 many virtual web servers. In this situation, you may want to listen for
13058 email on only a few of the available interfaces, but nevertheless treat all
13059 interfaces as local when routing. You can do this by setting
13060 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13061 &"all"& wildcard values. These addresses are recognized as local, but are not
13062 used for listening. Consider this example:
13063 .code
13064 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13065                       192.168.53.235 ; \
13066                       3ffe:2101:12:1:a00:20ff:fe86:a061
13067
13068 extra_local_interfaces = <; ::0 ; 0.0.0.0
13069 .endd
13070 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13071 address, but all available interface addresses are treated as local when
13072 Exim is routing.
13073
13074 In some environments the local host name may be in an MX list, but with an IP
13075 address that is not assigned to any local interface. In other cases it may be
13076 desirable to treat other host names as if they referred to the local host. Both
13077 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13078 This contains host names rather than IP addresses. When a host is referenced
13079 during routing, either via an MX record or directly, it is treated as the local
13080 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13081 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13082
13083
13084
13085 .section "Delivering to a remote host" "SECID95"
13086 Delivery to a remote host is handled by the smtp transport. By default, it
13087 allows the system's TCP/IP functions to choose which interface to use (if
13088 there is more than one) when connecting to a remote host. However, the
13089 &%interface%& option can be set to specify which interface is used. See the
13090 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13091 details.
13092
13093
13094
13095
13096 . ////////////////////////////////////////////////////////////////////////////
13097 . ////////////////////////////////////////////////////////////////////////////
13098
13099 .chapter "Main configuration" "CHAPmainconfig"
13100 .scindex IIDconfima "configuration file" "main section"
13101 .scindex IIDmaiconf "main configuration"
13102 The first part of the run time configuration file contains three types of item:
13103
13104 .ilist
13105 Macro definitions: These lines start with an upper case letter. See section
13106 &<<SECTmacrodefs>>& for details of macro processing.
13107 .next
13108 Named list definitions: These lines start with one of the words &"domainlist"&,
13109 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13110 section &<<SECTnamedlists>>&.
13111 .next
13112 Main configuration settings: Each setting occupies one line of the file
13113 (with possible continuations). If any setting is preceded by the word
13114 &"hide"&, the &%-bP%& command line option displays its value to admin users
13115 only. See section &<<SECTcos>>& for a description of the syntax of these option
13116 settings.
13117 .endlist
13118
13119 This chapter specifies all the main configuration options, along with their
13120 types and default values. For ease of finding a particular option, they appear
13121 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13122 are now so many options, they are first listed briefly in functional groups, as
13123 an aid to finding the name of the option you are looking for. Some options are
13124 listed in more than one group.
13125
13126 .section "Miscellaneous" "SECID96"
13127 .table2
13128 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13129 .row &%disable_ipv6%&                "do no IPv6 processing"
13130 .row &%keep_malformed%&              "for broken files &-- should not happen"
13131 .row &%localhost_number%&            "for unique message ids in clusters"
13132 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13133 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13134 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13135 .row &%print_topbitchars%&           "top-bit characters are printing"
13136 .row &%timezone%&                    "force time zone"
13137 .endtable
13138
13139
13140 .section "Exim parameters" "SECID97"
13141 .table2
13142 .row &%exim_group%&                  "override compiled-in value"
13143 .row &%exim_path%&                   "override compiled-in value"
13144 .row &%exim_user%&                   "override compiled-in value"
13145 .row &%primary_hostname%&            "default from &[uname()]&"
13146 .row &%split_spool_directory%&       "use multiple directories"
13147 .row &%spool_directory%&             "override compiled-in value"
13148 .endtable
13149
13150
13151
13152 .section "Privilege controls" "SECID98"
13153 .table2
13154 .row &%admin_groups%&                "groups that are Exim admin users"
13155 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13156 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13157 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13158 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13159 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13160 .row &%never_users%&                 "do not run deliveries as these"
13161 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13162 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13163 .row &%trusted_groups%&              "groups that are trusted"
13164 .row &%trusted_users%&               "users that are trusted"
13165 .endtable
13166
13167
13168
13169 .section "Logging" "SECID99"
13170 .table2
13171 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13172 .row &%log_file_path%&               "override compiled-in value"
13173 .row &%log_selector%&                "set/unset optional logging"
13174 .row &%log_timezone%&                "add timezone to log lines"
13175 .row &%message_logs%&                "create per-message logs"
13176 .row &%preserve_message_logs%&       "after message completion"
13177 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13178 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13179 .row &%syslog_facility%&             "set syslog &""facility""& field"
13180 .row &%syslog_processname%&          "set syslog &""ident""& field"
13181 .row &%syslog_timestamp%&            "timestamp syslog lines"
13182 .row &%write_rejectlog%&             "control use of message log"
13183 .endtable
13184
13185
13186
13187 .section "Frozen messages" "SECID100"
13188 .table2
13189 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13190 .row &%freeze_tell%&                 "send message when freezing"
13191 .row &%move_frozen_messages%&        "to another directory"
13192 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13193 .endtable
13194
13195
13196
13197 .section "Data lookups" "SECID101"
13198 .table2
13199 .row &%ibase_servers%&               "InterBase servers"
13200 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13201 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13202 .row &%ldap_cert_file%&              "client cert file for LDAP"
13203 .row &%ldap_cert_key%&               "client key file for LDAP"
13204 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13205 .row &%ldap_default_servers%&        "used if no server in query"
13206 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13207 .row &%ldap_start_tls%&              "require TLS within LDAP"
13208 .row &%ldap_version%&                "set protocol version"
13209 .row &%lookup_open_max%&             "lookup files held open"
13210 .row &%mysql_servers%&               "default MySQL servers"
13211 .row &%oracle_servers%&              "Oracle servers"
13212 .row &%pgsql_servers%&               "default PostgreSQL servers"
13213 .row &%sqlite_lock_timeout%&         "as it says"
13214 .endtable
13215
13216
13217
13218 .section "Message ids" "SECID102"
13219 .table2
13220 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13221 .row &%message_id_header_text%&      "ditto"
13222 .endtable
13223
13224
13225
13226 .section "Embedded Perl Startup" "SECID103"
13227 .table2
13228 .row &%perl_at_start%&               "always start the interpreter"
13229 .row &%perl_startup%&                "code to obey when starting Perl"
13230 .endtable
13231
13232
13233
13234 .section "Daemon" "SECID104"
13235 .table2
13236 .row &%daemon_smtp_ports%&           "default ports"
13237 .row &%daemon_startup_retries%&      "number of times to retry"
13238 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13239 .row &%extra_local_interfaces%&      "not necessarily listened on"
13240 .row &%local_interfaces%&            "on which to listen, with optional ports"
13241 .row &%pid_file_path%&               "override compiled-in value"
13242 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13243 .endtable
13244
13245
13246
13247 .section "Resource control" "SECID105"
13248 .table2
13249 .row &%check_log_inodes%&            "before accepting a message"
13250 .row &%check_log_space%&             "before accepting a message"
13251 .row &%check_spool_inodes%&          "before accepting a message"
13252 .row &%check_spool_space%&           "before accepting a message"
13253 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13254 .row &%queue_only_load%&             "queue incoming if load high"
13255 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13256 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13257 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13258 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13259 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13260 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13261 .row &%smtp_accept_max_per_connection%& "messages per connection"
13262 .row &%smtp_accept_max_per_host%&    "connections from one host"
13263 .row &%smtp_accept_queue%&           "queue mail if more connections"
13264 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13265                                            connection"
13266 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13267 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13268 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13269 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13270 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13271 .endtable
13272
13273
13274
13275 .section "Policy controls" "SECID106"
13276 .table2
13277 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13278 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13279 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13280 .row &%acl_smtp_auth%&               "ACL for AUTH"
13281 .row &%acl_smtp_connect%&            "ACL for connection"
13282 .row &%acl_smtp_data%&               "ACL for DATA"
13283 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13284 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13285 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13286 .row &%acl_smtp_expn%&               "ACL for EXPN"
13287 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13288 .row &%acl_smtp_mail%&               "ACL for MAIL"
13289 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13290 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13291 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13292 .row &%acl_smtp_predata%&            "ACL for start of data"
13293 .row &%acl_smtp_quit%&               "ACL for QUIT"
13294 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13295 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13296 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13297 .row &%av_scanner%&                  "specify virus scanner"
13298 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13299                                       words""&"
13300 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13301 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13302 .row &%header_maxsize%&              "total size of message header"
13303 .row &%header_line_maxsize%&         "individual header line limit"
13304 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13305 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13306 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13307 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13308 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13309 .row &%host_lookup%&                 "host name looked up for these hosts"
13310 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13311 .row &%host_reject_connection%&      "reject connection from these hosts"
13312 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13313 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13314 .row &%message_size_limit%&          "for all messages"
13315 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13316 .row &%spamd_address%&               "set interface to SpamAssassin"
13317 .row &%strict_acl_vars%&             "object to unset ACL variables"
13318 .endtable
13319
13320
13321
13322 .section "Callout cache" "SECID107"
13323 .table2
13324 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13325                                          item"
13326 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13327                                          item"
13328 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13329 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13330 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13331 .endtable
13332
13333
13334
13335 .section "TLS" "SECID108"
13336 .table2
13337 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13338 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13339 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13340 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13341 .row &%tls_certificate%&             "location of server certificate"
13342 .row &%tls_crl%&                     "certificate revocation list"
13343 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13344 .row &%tls_dhparam%&                 "DH parameters for server"
13345 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13346 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13347 .row &%tls_privatekey%&              "location of server private key"
13348 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13349 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13350 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13351 .row &%tls_verify_certificates%&     "expected client certificates"
13352 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13353 .endtable
13354
13355
13356
13357 .section "Local user handling" "SECID109"
13358 .table2
13359 .row &%finduser_retries%&            "useful in NIS environments"
13360 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13361 .row &%gecos_pattern%&               "ditto"
13362 .row &%max_username_length%&         "for systems that truncate"
13363 .row &%unknown_login%&               "used when no login name found"
13364 .row &%unknown_username%&            "ditto"
13365 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13366 .row &%uucp_from_sender%&            "ditto"
13367 .endtable
13368
13369
13370
13371 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13372 .table2
13373 .row &%header_maxsize%&              "total size of message header"
13374 .row &%header_line_maxsize%&         "individual header line limit"
13375 .row &%message_size_limit%&          "applies to all messages"
13376 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13377 .row &%received_header_text%&        "expanded to make &'Received:'&"
13378 .row &%received_headers_max%&        "for mail loop detection"
13379 .row &%recipients_max%&              "limit per message"
13380 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13381 .endtable
13382
13383
13384
13385
13386 .section "Non-SMTP incoming messages" "SECID111"
13387 .table2
13388 .row &%receive_timeout%&             "for non-SMTP messages"
13389 .endtable
13390
13391
13392
13393
13394
13395 .section "Incoming SMTP messages" "SECID112"
13396 See also the &'Policy controls'& section above.
13397
13398 .table2
13399 .row &%host_lookup%&                 "host name looked up for these hosts"
13400 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13401 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13402 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13403 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13404 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13405 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13406 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13407 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13408 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13409 .row &%smtp_accept_max_per_connection%& "messages per connection"
13410 .row &%smtp_accept_max_per_host%&    "connections from one host"
13411 .row &%smtp_accept_queue%&           "queue mail if more connections"
13412 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13413                                            connection"
13414 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13415 .row &%smtp_active_hostname%&        "host name to use in messages"
13416 .row &%smtp_banner%&                 "text for welcome banner"
13417 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13418 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13419 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13420 .row &%smtp_etrn_command%&           "what to run for ETRN"
13421 .row &%smtp_etrn_serialize%&         "only one at once"
13422 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13423 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13424 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13425 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13426 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13427 .row &%smtp_receive_timeout%&        "per command or data line"
13428 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13429 .row &%smtp_return_error_details%&   "give detail on rejections"
13430 .endtable
13431
13432
13433
13434 .section "SMTP extensions" "SECID113"
13435 .table2
13436 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13437 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13438 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13439 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13440 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13441 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13442 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13443 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13444 .endtable
13445
13446
13447
13448 .section "Processing messages" "SECID114"
13449 .table2
13450 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13451 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13452 .row &%allow_utf8_domains%&          "in addresses"
13453 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13454                                       words""&"
13455 .row &%delivery_date_remove%&        "from incoming messages"
13456 .row &%envelope_to_remove%&          "from incoming messages"
13457 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13458 .row &%headers_charset%&             "default for translations"
13459 .row &%qualify_domain%&              "default for senders"
13460 .row &%qualify_recipient%&           "default for recipients"
13461 .row &%return_path_remove%&          "from incoming messages"
13462 .row &%strip_excess_angle_brackets%& "in addresses"
13463 .row &%strip_trailing_dot%&          "at end of addresses"
13464 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13465 .endtable
13466
13467
13468
13469 .section "System filter" "SECID115"
13470 .table2
13471 .row &%system_filter%&               "locate system filter"
13472 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13473                                             directory"
13474 .row &%system_filter_file_transport%& "transport for delivery to a file"
13475 .row &%system_filter_group%&         "group for filter running"
13476 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13477 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13478 .row &%system_filter_user%&          "user for filter running"
13479 .endtable
13480
13481
13482
13483 .section "Routing and delivery" "SECID116"
13484 .table2
13485 .row &%disable_ipv6%&                "do no IPv6 processing"
13486 .row &%dns_again_means_nonexist%&    "for broken domains"
13487 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13488 .row &%dns_dnssec_ok%&               "parameter for resolver"
13489 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13490 .row &%dns_retrans%&                 "parameter for resolver"
13491 .row &%dns_retry%&                   "parameter for resolver"
13492 .row &%dns_use_edns0%&               "parameter for resolver"
13493 .row &%hold_domains%&                "hold delivery for these domains"
13494 .row &%local_interfaces%&            "for routing checks"
13495 .row &%queue_domains%&               "no immediate delivery for these"
13496 .row &%queue_only%&                  "no immediate delivery at all"
13497 .row &%queue_only_file%&             "no immediate delivery if file exists"
13498 .row &%queue_only_load%&             "no immediate delivery if load is high"
13499 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13500 .row &%queue_only_override%&         "allow command line to override"
13501 .row &%queue_run_in_order%&          "order of arrival"
13502 .row &%queue_run_max%&               "of simultaneous queue runners"
13503 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13504 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13505 .row &%remote_sort_domains%&         "order of remote deliveries"
13506 .row &%retry_data_expire%&           "timeout for retry data"
13507 .row &%retry_interval_max%&          "safety net for retry rules"
13508 .endtable
13509
13510
13511
13512 .section "Bounce and warning messages" "SECID117"
13513 .table2
13514 .row &%bounce_message_file%&         "content of bounce"
13515 .row &%bounce_message_text%&         "content of bounce"
13516 .row &%bounce_return_body%&          "include body if returning message"
13517 .row &%bounce_return_message%&       "include original message in bounce"
13518 .row &%bounce_return_size_limit%&    "limit on returned message"
13519 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13520 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13521 .row &%errors_copy%&                 "copy bounce messages"
13522 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13523 .row &%delay_warning%&               "time schedule"
13524 .row &%delay_warning_condition%&     "condition for warning messages"
13525 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13526 .row &%smtp_return_error_details%&   "give detail on rejections"
13527 .row &%warn_message_file%&           "content of warning message"
13528 .endtable
13529
13530
13531
13532 .section "Alphabetical list of main options" "SECTalomo"
13533 Those options that undergo string expansion before use are marked with
13534 &dagger;.
13535
13536 .option accept_8bitmime main boolean true
13537 .cindex "8BITMIME"
13538 .cindex "8-bit characters"
13539 .cindex "log" "selectors"
13540 .cindex "log" "8BITMIME"
13541 This option causes Exim to send 8BITMIME in its response to an SMTP
13542 EHLO command, and to accept the BODY= parameter on MAIL commands.
13543 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13544 takes no steps to do anything special with messages received by this route.
13545
13546 Historically Exim kept this option off by default, but the maintainers
13547 feel that in today's Internet, this causes more problems than it solves.
13548 It now defaults to true.
13549 A more detailed analysis of the issues is provided by Dan Bernstein:
13550 .display
13551 &url(http://cr.yp.to/smtp/8bitmime.html)
13552 .endd
13553
13554 To log received 8BITMIME status use
13555 .code
13556 log_selector = +8bitmime
13557 .endd
13558
13559 .option acl_not_smtp main string&!! unset
13560 .cindex "&ACL;" "for non-SMTP messages"
13561 .cindex "non-SMTP messages" "ACLs for"
13562 This option defines the ACL that is run when a non-SMTP message has been
13563 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13564 further details.
13565
13566 .option acl_not_smtp_mime main string&!! unset
13567 This option defines the ACL that is run for individual MIME parts of non-SMTP
13568 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13569 SMTP messages.
13570
13571 .option acl_not_smtp_start main string&!! unset
13572 .cindex "&ACL;" "at start of non-SMTP message"
13573 .cindex "non-SMTP messages" "ACLs for"
13574 This option defines the ACL that is run before Exim starts reading a
13575 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13576
13577 .option acl_smtp_auth main string&!! unset
13578 .cindex "&ACL;" "setting up for SMTP commands"
13579 .cindex "AUTH" "ACL for"
13580 This option defines the ACL that is run when an SMTP AUTH command is
13581 received. See chapter &<<CHAPACL>>& for further details.
13582
13583 .option acl_smtp_connect main string&!! unset
13584 .cindex "&ACL;" "on SMTP connection"
13585 This option defines the ACL that is run when an SMTP connection is received.
13586 See chapter &<<CHAPACL>>& for further details.
13587
13588 .option acl_smtp_data main string&!! unset
13589 .cindex "DATA" "ACL for"
13590 This option defines the ACL that is run after an SMTP DATA command has been
13591 processed and the message itself has been received, but before the final
13592 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13593
13594 .new
13595 .option acl_smtp_data_prdr main string&!! accept
13596 .cindex "PRDR" "ACL for"
13597 .cindex "DATA" "PRDR ACL for"
13598 .cindex "&ACL;" "PRDR-related"
13599 .cindex "&ACL;" "per-user data processing"
13600 .wen
13601 This option defines the ACL that,
13602 if the PRDR feature has been negotiated,
13603 is run for each recipient after an SMTP DATA command has been
13604 processed and the message itself has been received, but before the
13605 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13606
13607 .option acl_smtp_etrn main string&!! unset
13608 .cindex "ETRN" "ACL for"
13609 This option defines the ACL that is run when an SMTP ETRN command is
13610 received. See chapter &<<CHAPACL>>& for further details.
13611
13612 .option acl_smtp_expn main string&!! unset
13613 .cindex "EXPN" "ACL for"
13614 This option defines the ACL that is run when an SMTP EXPN command is
13615 received. See chapter &<<CHAPACL>>& for further details.
13616
13617 .option acl_smtp_helo main string&!! unset
13618 .cindex "EHLO" "ACL for"
13619 .cindex "HELO" "ACL for"
13620 This option defines the ACL that is run when an SMTP EHLO or HELO
13621 command is received. See chapter &<<CHAPACL>>& for further details.
13622
13623
13624 .option acl_smtp_mail main string&!! unset
13625 .cindex "MAIL" "ACL for"
13626 This option defines the ACL that is run when an SMTP MAIL command is
13627 received. See chapter &<<CHAPACL>>& for further details.
13628
13629 .option acl_smtp_mailauth main string&!! unset
13630 .cindex "AUTH" "on MAIL command"
13631 This option defines the ACL that is run when there is an AUTH parameter on
13632 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13633 &<<CHAPSMTPAUTH>>& for details of authentication.
13634
13635 .option acl_smtp_mime main string&!! unset
13636 .cindex "MIME content scanning" "ACL for"
13637 This option is available when Exim is built with the content-scanning
13638 extension. It defines the ACL that is run for each MIME part in a message. See
13639 section &<<SECTscanmimepart>>& for details.
13640
13641 .option acl_smtp_notquit main string&!! unset
13642 .cindex "not-QUIT, ACL for"
13643 This option defines the ACL that is run when an SMTP session
13644 ends without a QUIT command being received.
13645 See chapter &<<CHAPACL>>& for further details.
13646
13647 .option acl_smtp_predata main string&!! unset
13648 This option defines the ACL that is run when an SMTP DATA command is
13649 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13650 further details.
13651
13652 .option acl_smtp_quit main string&!! unset
13653 .cindex "QUIT, ACL for"
13654 This option defines the ACL that is run when an SMTP QUIT command is
13655 received. See chapter &<<CHAPACL>>& for further details.
13656
13657 .option acl_smtp_rcpt main string&!! unset
13658 .cindex "RCPT" "ACL for"
13659 This option defines the ACL that is run when an SMTP RCPT command is
13660 received. See chapter &<<CHAPACL>>& for further details.
13661
13662 .option acl_smtp_starttls main string&!! unset
13663 .cindex "STARTTLS, ACL for"
13664 This option defines the ACL that is run when an SMTP STARTTLS command is
13665 received. See chapter &<<CHAPACL>>& for further details.
13666
13667 .option acl_smtp_vrfy main string&!! unset
13668 .cindex "VRFY" "ACL for"
13669 This option defines the ACL that is run when an SMTP VRFY command is
13670 received. See chapter &<<CHAPACL>>& for further details.
13671
13672 .option admin_groups main "string list&!!" unset
13673 .cindex "admin user"
13674 This option is expanded just once, at the start of Exim's processing. If the
13675 current group or any of the supplementary groups of an Exim caller is in this
13676 colon-separated list, the caller has admin privileges. If all your system
13677 programmers are in a specific group, for example, you can give them all Exim
13678 admin privileges by putting that group in &%admin_groups%&. However, this does
13679 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13680 To permit this, you have to add individuals to the Exim group.
13681
13682 .option allow_domain_literals main boolean false
13683 .cindex "domain literal"
13684 If this option is set, the RFC 2822 domain literal format is permitted in
13685 email addresses. The option is not set by default, because the domain literal
13686 format is not normally required these days, and few people know about it. It
13687 has, however, been exploited by mail abusers.
13688
13689 Unfortunately, it seems that some DNS black list maintainers are using this
13690 format to report black listing to postmasters. If you want to accept messages
13691 addressed to your hosts by IP address, you need to set
13692 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13693 domains (defined in the named domain list &%local_domains%& in the default
13694 configuration). This &"magic string"& matches the domain literal form of all
13695 the local host's IP addresses.
13696
13697
13698 .option allow_mx_to_ip main boolean false
13699 .cindex "MX record" "pointing to IP address"
13700 It appears that more and more DNS zone administrators are breaking the rules
13701 and putting domain names that look like IP addresses on the right hand side of
13702 MX records. Exim follows the rules and rejects this, giving an error message
13703 that explains the mis-configuration. However, some other MTAs support this
13704 practice, so to avoid &"Why can't Exim do this?"& complaints,
13705 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13706 recommended, except when you have no other choice.
13707
13708 .option allow_utf8_domains main boolean false
13709 .cindex "domain" "UTF-8 characters in"
13710 .cindex "UTF-8" "in domain name"
13711 Lots of discussion is going on about internationalized domain names. One
13712 camp is strongly in favour of just using UTF-8 characters, and it seems
13713 that at least two other MTAs permit this. This option allows Exim users to
13714 experiment if they wish.
13715
13716 If it is set true, Exim's domain parsing function allows valid
13717 UTF-8 multicharacters to appear in domain name components, in addition to
13718 letters, digits, and hyphens. However, just setting this option is not
13719 enough; if you want to look up these domain names in the DNS, you must also
13720 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13721 suitable setting is:
13722 .code
13723 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13724   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13725 .endd
13726 Alternatively, you can just disable this feature by setting
13727 .code
13728 dns_check_names_pattern =
13729 .endd
13730 That is, set the option to an empty string so that no check is done.
13731
13732
13733 .option auth_advertise_hosts main "host list&!!" *
13734 .cindex "authentication" "advertising"
13735 .cindex "AUTH" "advertising"
13736 If any server authentication mechanisms are configured, Exim advertises them in
13737 response to an EHLO command only if the calling host matches this list.
13738 Otherwise, Exim does not advertise AUTH.
13739 Exim does not accept AUTH commands from clients to which it has not
13740 advertised the availability of AUTH. The advertising of individual
13741 authentication mechanisms can be controlled by the use of the
13742 &%server_advertise_condition%& generic authenticator option on the individual
13743 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13744
13745 Certain mail clients (for example, Netscape) require the user to provide a name
13746 and password for authentication if AUTH is advertised, even though it may
13747 not be needed (the host may accept messages from hosts on its local LAN without
13748 authentication, for example). The &%auth_advertise_hosts%& option can be used
13749 to make these clients more friendly by excluding them from the set of hosts to
13750 which Exim advertises AUTH.
13751
13752 .cindex "AUTH" "advertising when encrypted"
13753 If you want to advertise the availability of AUTH only when the connection
13754 is encrypted using TLS, you can make use of the fact that the value of this
13755 option is expanded, with a setting like this:
13756 .code
13757 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13758 .endd
13759 .vindex "&$tls_in_cipher$&"
13760 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13761 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13762 expansion is *, which matches all hosts.
13763
13764
13765 .option auto_thaw main time 0s
13766 .cindex "thawing messages"
13767 .cindex "unfreezing messages"
13768 If this option is set to a time greater than zero, a queue runner will try a
13769 new delivery attempt on any frozen message, other than a bounce message, if
13770 this much time has passed since it was frozen. This may result in the message
13771 being re-frozen if nothing has changed since the last attempt. It is a way of
13772 saying &"keep on trying, even though there are big problems"&.
13773
13774 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13775 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13776 thought to be very useful any more, and its use should probably be avoided.
13777
13778
13779 .option av_scanner main string "see below"
13780 This option is available if Exim is built with the content-scanning extension.
13781 It specifies which anti-virus scanner to use. The default value is:
13782 .code
13783 sophie:/var/run/sophie
13784 .endd
13785 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13786 before use. See section &<<SECTscanvirus>>& for further details.
13787
13788
13789 .option bi_command main string unset
13790 .oindex "&%-bi%&"
13791 This option supplies the name of a command that is run when Exim is called with
13792 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13793 just the command name, it is not a complete command line. If an argument is
13794 required, it must come from the &%-oA%& command line option.
13795
13796
13797 .option bounce_message_file main string unset
13798 .cindex "bounce message" "customizing"
13799 .cindex "customizing" "bounce message"
13800 This option defines a template file containing paragraphs of text to be used
13801 for constructing bounce messages.  Details of the file's contents are given in
13802 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13803
13804
13805 .option bounce_message_text main string unset
13806 When this option is set, its contents are included in the default bounce
13807 message immediately after &"This message was created automatically by mail
13808 delivery software."& It is not used if &%bounce_message_file%& is set.
13809
13810 .option bounce_return_body main boolean true
13811 .cindex "bounce message" "including body"
13812 This option controls whether the body of an incoming message is included in a
13813 bounce message when &%bounce_return_message%& is true. The default setting
13814 causes the entire message, both header and body, to be returned (subject to the
13815 value of &%bounce_return_size_limit%&). If this option is false, only the
13816 message header is included. In the case of a non-SMTP message containing an
13817 error that is detected during reception, only those header lines preceding the
13818 point at which the error was detected are returned.
13819 .cindex "bounce message" "including original"
13820
13821 .option bounce_return_message main boolean true
13822 If this option is set false, none of the original message is included in
13823 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13824 &%bounce_return_body%&.
13825
13826
13827 .option bounce_return_size_limit main integer 100K
13828 .cindex "size" "of bounce, limit"
13829 .cindex "bounce message" "size limit"
13830 .cindex "limit" "bounce message size"
13831 This option sets a limit in bytes on the size of messages that are returned to
13832 senders as part of bounce messages when &%bounce_return_message%& is true. The
13833 limit should be less than the value of the global &%message_size_limit%& and of
13834 any &%message_size_limit%& settings on transports, to allow for the bounce text
13835 that Exim generates. If this option is set to zero there is no limit.
13836
13837 When the body of any message that is to be included in a bounce message is
13838 greater than the limit, it is truncated, and a comment pointing this out is
13839 added at the top. The actual cutoff may be greater than the value given, owing
13840 to the use of buffering for transferring the message in chunks (typically 8K in
13841 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13842 messages.
13843
13844 .option bounce_sender_authentication main string unset
13845 .cindex "bounce message" "sender authentication"
13846 .cindex "authentication" "bounce message"
13847 .cindex "AUTH" "on bounce message"
13848 This option provides an authenticated sender address that is sent with any
13849 bounce messages generated by Exim that are sent over an authenticated SMTP
13850 connection. A typical setting might be:
13851 .code
13852 bounce_sender_authentication = mailer-daemon@my.domain.example
13853 .endd
13854 which would cause bounce messages to be sent using the SMTP command:
13855 .code
13856 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13857 .endd
13858 The value of &%bounce_sender_authentication%& must always be a complete email
13859 address.
13860
13861 .option callout_domain_negative_expire main time 3h
13862 .cindex "caching" "callout timeouts"
13863 .cindex "callout" "caching timeouts"
13864 This option specifies the expiry time for negative callout cache data for a
13865 domain. See section &<<SECTcallver>>& for details of callout verification, and
13866 section &<<SECTcallvercache>>& for details of the caching.
13867
13868
13869 .option callout_domain_positive_expire main time 7d
13870 This option specifies the expiry time for positive callout cache data for a
13871 domain. See section &<<SECTcallver>>& for details of callout verification, and
13872 section &<<SECTcallvercache>>& for details of the caching.
13873
13874
13875 .option callout_negative_expire main time 2h
13876 This option specifies the expiry time for negative callout cache data for an
13877 address. See section &<<SECTcallver>>& for details of callout verification, and
13878 section &<<SECTcallvercache>>& for details of the caching.
13879
13880
13881 .option callout_positive_expire main time 24h
13882 This option specifies the expiry time for positive callout cache data for an
13883 address. See section &<<SECTcallver>>& for details of callout verification, and
13884 section &<<SECTcallvercache>>& for details of the caching.
13885
13886
13887 .option callout_random_local_part main string&!! "see below"
13888 This option defines the &"random"& local part that can be used as part of
13889 callout verification. The default value is
13890 .code
13891 $primary_hostname-$tod_epoch-testing
13892 .endd
13893 See section &<<CALLaddparcall>>& for details of how this value is used.
13894
13895
13896 .option check_log_inodes main integer 0
13897 See &%check_spool_space%& below.
13898
13899
13900 .option check_log_space main integer 0
13901 See &%check_spool_space%& below.
13902
13903 .oindex "&%check_rfc2047_length%&"
13904 .cindex "RFC 2047" "disabling length check"
13905 .option check_rfc2047_length main boolean true
13906 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13907 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13908 word; strings to be encoded that exceed this length are supposed to use
13909 multiple encoded words. By default, Exim does not recognize encoded words that
13910 exceed the maximum length. However, it seems that some software, in violation
13911 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13912 set false, Exim recognizes encoded words of any length.
13913
13914
13915 .option check_spool_inodes main integer 0
13916 See &%check_spool_space%& below.
13917
13918
13919 .option check_spool_space main integer 0
13920 .cindex "checking disk space"
13921 .cindex "disk space, checking"
13922 .cindex "spool directory" "checking space"
13923 The four &%check_...%& options allow for checking of disk resources before a
13924 message is accepted.
13925
13926 .vindex "&$log_inodes$&"
13927 .vindex "&$log_space$&"
13928 .vindex "&$spool_inodes$&"
13929 .vindex "&$spool_space$&"
13930 When any of these options are set, they apply to all incoming messages. If you
13931 want to apply different checks to different kinds of message, you can do so by
13932 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13933 &$spool_space$& in an ACL with appropriate additional conditions.
13934
13935
13936 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13937 either value is greater than zero, for example:
13938 .code
13939 check_spool_space = 10M
13940 check_spool_inodes = 100
13941 .endd
13942 The spool partition is the one that contains the directory defined by
13943 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13944 transit.
13945
13946 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13947 files are written if either is greater than zero. These should be set only if
13948 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13949
13950 If there is less space or fewer inodes than requested, Exim refuses to accept
13951 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13952 error response to the MAIL command. If ESMTP is in use and there was a
13953 SIZE parameter on the MAIL command, its value is added to the
13954 &%check_spool_space%& value, and the check is performed even if
13955 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13956
13957 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13958 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13959
13960 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13961 failure a message is written to stderr and Exim exits with a non-zero code, as
13962 it obviously cannot send an error message of any kind.
13963
13964 .option daemon_smtp_ports main string &`smtp`&
13965 .cindex "port" "for daemon"
13966 .cindex "TCP/IP" "setting listening ports"
13967 This option specifies one or more default SMTP ports on which the Exim daemon
13968 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13969 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13970
13971 .option daemon_startup_retries main integer 9
13972 .cindex "daemon startup, retrying"
13973 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13974 the daemon at startup when it cannot immediately bind a listening socket
13975 (typically because the socket is already in use): &%daemon_startup_retries%&
13976 defines the number of retries after the first failure, and
13977 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13978
13979 .option daemon_startup_sleep main time 30s
13980 See &%daemon_startup_retries%&.
13981
13982 .option delay_warning main "time list" 24h
13983 .cindex "warning of delay"
13984 .cindex "delay warning, specifying"
13985 When a message is delayed, Exim sends a warning message to the sender at
13986 intervals specified by this option. The data is a colon-separated list of times
13987 after which to send warning messages. If the value of the option is an empty
13988 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13989 message has been on the queue for longer than the last time, the last interval
13990 between the times is used to compute subsequent warning times. For example,
13991 with
13992 .code
13993 delay_warning = 4h:8h:24h
13994 .endd
13995 the first message is sent after 4 hours, the second after 8 hours, and
13996 the third one after 24 hours. After that, messages are sent every 16 hours,
13997 because that is the interval between the last two times on the list. If you set
13998 just one time, it specifies the repeat interval. For example, with:
13999 .code
14000 delay_warning = 6h
14001 .endd
14002 messages are repeated every six hours. To stop warnings after a given time, set
14003 a very large time at the end of the list. For example:
14004 .code
14005 delay_warning = 2h:12h:99d
14006 .endd
14007 Note that the option is only evaluated at the time a delivery attempt fails,
14008 which depends on retry and queue-runner configuration.
14009 Typically retries will be configured more frequently than warning messages.
14010
14011 .option delay_warning_condition main string&!! "see below"
14012 .vindex "&$domain$&"
14013 The string is expanded at the time a warning message might be sent. If all the
14014 deferred addresses have the same domain, it is set in &$domain$& during the
14015 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14016 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14017 &"false"& (the comparison being done caselessly) then the warning message is
14018 not sent. The default is:
14019 .code
14020 delay_warning_condition = ${if or {\
14021   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14022   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14023   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14024   } {no}{yes}}
14025 .endd
14026 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14027 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14028 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14029 &"auto-replied"& in an &'Auto-Submitted:'& header.
14030
14031 .option deliver_drop_privilege main boolean false
14032 .cindex "unprivileged delivery"
14033 .cindex "delivery" "unprivileged"
14034 If this option is set true, Exim drops its root privilege at the start of a
14035 delivery process, and runs as the Exim user throughout. This severely restricts
14036 the kinds of local delivery that are possible, but is viable in certain types
14037 of configuration. There is a discussion about the use of root privilege in
14038 chapter &<<CHAPsecurity>>&.
14039
14040 .option deliver_queue_load_max main fixed-point unset
14041 .cindex "load average"
14042 .cindex "queue runner" "abandoning"
14043 When this option is set, a queue run is abandoned if the system load average
14044 becomes greater than the value of the option. The option has no effect on
14045 ancient operating systems on which Exim cannot determine the load average.
14046 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14047
14048
14049 .option delivery_date_remove main boolean true
14050 .cindex "&'Delivery-date:'& header line"
14051 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14052 message when it is delivered, in exactly the same way as &'Return-path:'& is
14053 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14054 should not be present in incoming messages, and this option causes them to be
14055 removed at the time the message is received, to avoid any problems that might
14056 occur when a delivered message is subsequently sent on to some other recipient.
14057
14058 .option disable_fsync main boolean false
14059 .cindex "&[fsync()]&, disabling"
14060 This option is available only if Exim was built with the compile-time option
14061 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14062 a runtime configuration generates an &"unknown option"& error. You should not
14063 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14064 really, really, really understand what you are doing. &'No pre-compiled
14065 distributions of Exim should ever make this option available.'&
14066
14067 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14068 updated files' data to be written to disc before continuing. Unexpected events
14069 such as crashes and power outages may cause data to be lost or scrambled.
14070 Here be Dragons. &*Beware.*&
14071
14072
14073 .option disable_ipv6 main boolean false
14074 .cindex "IPv6" "disabling"
14075 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14076 activities take place. AAAA records are never looked up, and any IPv6 addresses
14077 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14078 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14079 to handle IPv6 literal addresses.
14080
14081
14082 .option dns_again_means_nonexist main "domain list&!!" unset
14083 .cindex "DNS" "&""try again""& response; overriding"
14084 DNS lookups give a &"try again"& response for the DNS errors
14085 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14086 keep trying to deliver a message, or to give repeated temporary errors to
14087 incoming mail. Sometimes the effect is caused by a badly set up name server and
14088 may persist for a long time. If a domain which exhibits this problem matches
14089 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14090 This option should be used with care. You can make it apply to reverse lookups
14091 by a setting such as this:
14092 .code
14093 dns_again_means_nonexist = *.in-addr.arpa
14094 .endd
14095 This option applies to all DNS lookups that Exim does. It also applies when the
14096 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14097 since these are most likely to be caused by DNS lookup problems. The
14098 &(dnslookup)& router has some options of its own for controlling what happens
14099 when lookups for MX or SRV records give temporary errors. These more specific
14100 options are applied after this global option.
14101
14102 .option dns_check_names_pattern main string "see below"
14103 .cindex "DNS" "pre-check of name syntax"
14104 When this option is set to a non-empty string, it causes Exim to check domain
14105 names for characters that are not allowed in host names before handing them to
14106 the DNS resolver, because some resolvers give temporary errors for names that
14107 contain unusual characters. If a domain name contains any unwanted characters,
14108 a &"not found"& result is forced, and the resolver is not called. The check is
14109 done by matching the domain name against a regular expression, which is the
14110 value of this option. The default pattern is
14111 .code
14112 dns_check_names_pattern = \
14113   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14114 .endd
14115 which permits only letters, digits, slashes, and hyphens in components, but
14116 they must start and end with a letter or digit. Slashes are not, in fact,
14117 permitted in host names, but they are found in certain NS records (which can be
14118 accessed in Exim by using a &%dnsdb%& lookup). If you set
14119 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14120 empty string.
14121
14122 .option dns_csa_search_limit main integer 5
14123 This option controls the depth of parental searching for CSA SRV records in the
14124 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14125
14126 .option dns_csa_use_reverse main boolean true
14127 This option controls whether or not an IP address, given as a CSA domain, is
14128 reversed and looked up in the reverse DNS, as described in more detail in
14129 section &<<SECTverifyCSA>>&.
14130
14131
14132 .option dns_dnssec_ok main integer -1
14133 .cindex "DNS" "resolver options"
14134 .cindex "DNS" "DNSSEC"
14135 If this option is set to a non-negative number then Exim will initialise the
14136 DNS resolver library to either use or not use DNSSEC, overriding the system
14137 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14138
14139 If the resolver library does not support DNSSEC then this option has no effect.
14140
14141
14142 .option dns_ipv4_lookup main "domain list&!!" unset
14143 .cindex "IPv6" "DNS lookup for AAAA records"
14144 .cindex "DNS" "IPv6 lookup for AAAA records"
14145 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14146 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14147 (A records) when trying to find IP addresses for hosts, unless the host's
14148 domain matches this list.
14149
14150 This is a fudge to help with name servers that give big delays or otherwise do
14151 not work for the AAAA record type. In due course, when the world's name
14152 servers have all been upgraded, there should be no need for this option.
14153
14154
14155 .option dns_retrans main time 0s
14156 .cindex "DNS" "resolver options"
14157 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14158 retransmission and retry parameters for DNS lookups. Values of zero (the
14159 defaults) leave the system default settings unchanged. The first value is the
14160 time between retries, and the second is the number of retries. It isn't
14161 totally clear exactly how these settings affect the total time a DNS lookup may
14162 take. I haven't found any documentation about timeouts on DNS lookups; these
14163 parameter values are available in the external resolver interface structure,
14164 but nowhere does it seem to describe how they are used or what you might want
14165 to set in them.
14166
14167
14168 .option dns_retry main integer 0
14169 See &%dns_retrans%& above.
14170
14171
14172 .option dns_use_edns0 main integer -1
14173 .cindex "DNS" "resolver options"
14174 .cindex "DNS" "EDNS0"
14175 If this option is set to a non-negative number then Exim will initialise the
14176 DNS resolver library to either use or not use EDNS0 extensions, overriding
14177 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14178 on.
14179
14180 If the resolver library does not support EDNS0 then this option has no effect.
14181
14182
14183 .option drop_cr main boolean false
14184 This is an obsolete option that is now a no-op. It used to affect the way Exim
14185 handled CR and LF characters in incoming messages. What happens now is
14186 described in section &<<SECTlineendings>>&.
14187
14188 .new
14189 .option dsn_advertise_hosts main "host list&!!" unset
14190 .cindex "bounce messages" "success"
14191 .cindex "DSN" "success"
14192 .cindex "Delivery Status Notification" "success"
14193 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14194 and accepted from, these hosts.
14195 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14196 and RET and ORCPT options on MAIL FROM commands.
14197 A NOTIFY=SUCCESS option requests success-DSN messages.
14198 A NOTIFY= option with no argument requests that no delay or failure DSNs
14199 are sent.
14200 .wen
14201
14202 .option dsn_from main "string&!!" "see below"
14203 .cindex "&'From:'& header line" "in bounces"
14204 .cindex "bounce messages" "&'From:'& line, specifying"
14205 This option can be used to vary the contents of &'From:'& header lines in
14206 bounces and other automatically generated messages (&"Delivery Status
14207 Notifications"& &-- hence the name of the option). The default setting is:
14208 .code
14209 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14210 .endd
14211 The value is expanded every time it is needed. If the expansion fails, a
14212 panic is logged, and the default value is used.
14213
14214 .option envelope_to_remove main boolean true
14215 .cindex "&'Envelope-to:'& header line"
14216 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14217 message when it is delivered, in exactly the same way as &'Return-path:'& is
14218 handled. &'Envelope-to:'& records the original recipient address from the
14219 messages's envelope that caused the delivery to happen. Such headers should not
14220 be present in incoming messages, and this option causes them to be removed at
14221 the time the message is received, to avoid any problems that might occur when a
14222 delivered message is subsequently sent on to some other recipient.
14223
14224
14225 .option errors_copy main "string list&!!" unset
14226 .cindex "bounce message" "copy to other address"
14227 .cindex "copy of bounce message"
14228 Setting this option causes Exim to send bcc copies of bounce messages that it
14229 generates to other addresses. &*Note*&: This does not apply to bounce messages
14230 coming from elsewhere. The value of the option is a colon-separated list of
14231 items. Each item consists of a pattern, terminated by white space, followed by
14232 a comma-separated list of email addresses. If a pattern contains spaces, it
14233 must be enclosed in double quotes.
14234
14235 Each pattern is processed in the same way as a single item in an address list
14236 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14237 the bounce message, the message is copied to the addresses on the list. The
14238 items are scanned in order, and once a matching one is found, no further items
14239 are examined. For example:
14240 .code
14241 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14242               rqps@mydomain   hostmaster@mydomain.example,\
14243                               postmaster@mydomain.example
14244 .endd
14245 .vindex "&$domain$&"
14246 .vindex "&$local_part$&"
14247 The address list is expanded before use. The expansion variables &$local_part$&
14248 and &$domain$& are set from the original recipient of the error message, and if
14249 there was any wildcard matching in the pattern, the expansion
14250 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14251 variables &$0$&, &$1$&, etc. are set in the normal way.
14252
14253
14254 .option errors_reply_to main string unset
14255 .cindex "bounce message" "&'Reply-to:'& in"
14256 By default, Exim's bounce and delivery warning messages contain the header line
14257 .display
14258 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14259 .endd
14260 .oindex &%quota_warn_message%&
14261 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14262 A warning message that is generated by the &%quota_warn_message%& option in an
14263 &(appendfile)& transport may contain its own &'From:'& header line that
14264 overrides the default.
14265
14266 Experience shows that people reply to bounce messages. If the
14267 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14268 and warning messages. For example:
14269 .code
14270 errors_reply_to = postmaster@my.domain.example
14271 .endd
14272 The value of the option is not expanded. It must specify a valid RFC 2822
14273 address. However, if a warning message that is generated by the
14274 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14275 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14276 not used.
14277
14278
14279 .option exim_group main string "compile-time configured"
14280 .cindex "gid (group id)" "Exim's own"
14281 .cindex "Exim group"
14282 This option changes the gid under which Exim runs when it gives up root
14283 privilege. The default value is compiled into the binary. The value of this
14284 option is used only when &%exim_user%& is also set. Unless it consists entirely
14285 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14286 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14287 security issues.
14288
14289
14290 .option exim_path main string "see below"
14291 .cindex "Exim binary, path name"
14292 This option specifies the path name of the Exim binary, which is used when Exim
14293 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14294 the directory configured at compile time by the BIN_DIRECTORY setting. It
14295 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14296 other place.
14297 &*Warning*&: Do not use a macro to define the value of this option, because
14298 you will break those Exim utilities that scan the configuration file to find
14299 where the binary is. (They then use the &%-bP%& option to extract option
14300 settings such as the value of &%spool_directory%&.)
14301
14302
14303 .option exim_user main string "compile-time configured"
14304 .cindex "uid (user id)" "Exim's own"
14305 .cindex "Exim user"
14306 This option changes the uid under which Exim runs when it gives up root
14307 privilege. The default value is compiled into the binary. Ownership of the run
14308 time configuration file and the use of the &%-C%& and &%-D%& command line
14309 options is checked against the values in the binary, not what is set here.
14310
14311 Unless it consists entirely of digits, the string is looked up using
14312 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14313 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14314 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14315
14316
14317 .option extra_local_interfaces main "string list" unset
14318 This option defines network interfaces that are to be considered local when
14319 routing, but which are not used for listening by the daemon. See section
14320 &<<SECTreclocipadd>>& for details.
14321
14322
14323 . Allow this long option name to split; give it unsplit as a fifth argument
14324 . for the automatic .oindex that is generated by .option.
14325
14326 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14327          extract_addresses_remove_arguments
14328 .oindex "&%-t%&"
14329 .cindex "command line" "addresses with &%-t%&"
14330 .cindex "Sendmail compatibility" "&%-t%& option"
14331 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14332 are present on the command line when the &%-t%& option is used to build an
14333 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14334 line addresses are removed from the recipients list. This is also how Smail
14335 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14336 command line addresses are added to those obtained from the header lines. When
14337 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14338 argument headers. If it is set false, Exim adds rather than removes argument
14339 addresses.
14340
14341
14342 .option finduser_retries main integer 0
14343 .cindex "NIS, retrying user lookups"
14344 On systems running NIS or other schemes in which user and group information is
14345 distributed from a remote system, there can be times when &[getpwnam()]& and
14346 related functions fail, even when given valid data, because things time out.
14347 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14348 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14349 many extra times to find a user or a group, waiting for one second between
14350 retries.
14351
14352 .cindex "&_/etc/passwd_&" "multiple reading of"
14353 You should not set this option greater than zero if your user information is in
14354 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14355 search the file multiple times for non-existent users, and also cause delay.
14356
14357
14358
14359 .option freeze_tell main "string list, comma separated" unset
14360 .cindex "freezing messages" "sending a message when freezing"
14361 On encountering certain errors, or when configured to do so in a system filter,
14362 ACL, or special router, Exim freezes a message. This means that no further
14363 delivery attempts take place until an administrator thaws the message, or the
14364 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14365 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14366 warning message whenever it freezes something, unless the message it is
14367 freezing is a locally-generated bounce message. (Without this exception there
14368 is the possibility of looping.) The warning message is sent to the addresses
14369 supplied as the comma-separated value of this option. If several of the
14370 message's addresses cause freezing, only a single message is sent. If the
14371 freezing was automatic, the reason(s) for freezing can be found in the message
14372 log. If you configure freezing in a filter or ACL, you must arrange for any
14373 logging that you require.
14374
14375
14376 .option gecos_name main string&!! unset
14377 .cindex "HP-UX"
14378 .cindex "&""gecos""& field, parsing"
14379 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14380 password file to hold other information in addition to users' real names. Exim
14381 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14382 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14383 of the field are used unchanged, except that, if an ampersand is encountered,
14384 it is replaced by the user's login name with the first character forced to
14385 upper case, since this is a convention that is observed on many systems.
14386
14387 When these options are set, &%gecos_pattern%& is treated as a regular
14388 expression that is to be applied to the field (again with && replaced by the
14389 login name), and if it matches, &%gecos_name%& is expanded and used as the
14390 user's name.
14391
14392 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14393 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14394 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14395 name terminates at the first comma, the following can be used:
14396 .code
14397 gecos_pattern = ([^,]*)
14398 gecos_name = $1
14399 .endd
14400
14401 .option gecos_pattern main string unset
14402 See &%gecos_name%& above.
14403
14404
14405 .option gnutls_compat_mode main boolean unset
14406 This option controls whether GnuTLS is used in compatibility mode in an Exim
14407 server. This reduces security slightly, but improves interworking with older
14408 implementations of TLS.
14409
14410
14411 option gnutls_allow_auto_pkcs11 main boolean unset
14412 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14413 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14414
14415 See
14416 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14417 for documentation.
14418
14419
14420
14421 .option headers_charset main string "see below"
14422 This option sets a default character set for translating from encoded MIME
14423 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14424 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14425 ultimate default is ISO-8859-1. For more details see the description of header
14426 insertions in section &<<SECTexpansionitems>>&.
14427
14428
14429
14430 .option header_maxsize main integer "see below"
14431 .cindex "header section" "maximum size of"
14432 .cindex "limit" "size of message header section"
14433 This option controls the overall maximum size of a message's header
14434 section. The default is the value of HEADER_MAXSIZE in
14435 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14436 sections are rejected.
14437
14438
14439 .option header_line_maxsize main integer 0
14440 .cindex "header lines" "maximum size of"
14441 .cindex "limit" "size of one header line"
14442 This option limits the length of any individual header line in a message, after
14443 all the continuations have been joined together. Messages with individual
14444 header lines that are longer than the limit are rejected. The default value of
14445 zero means &"no limit"&.
14446
14447
14448
14449
14450 .option helo_accept_junk_hosts main "host list&!!" unset
14451 .cindex "HELO" "accepting junk data"
14452 .cindex "EHLO" "accepting junk data"
14453 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14454 mail, and gives an error response for invalid data. Unfortunately, there are
14455 some SMTP clients that send syntactic junk. They can be accommodated by setting
14456 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14457 if you want to do semantic checking.
14458 See also &%helo_allow_chars%& for a way of extending the permitted character
14459 set.
14460
14461
14462 .option helo_allow_chars main string unset
14463 .cindex "HELO" "underscores in"
14464 .cindex "EHLO" "underscores in"
14465 .cindex "underscore in EHLO/HELO"
14466 This option can be set to a string of rogue characters that are permitted in
14467 all EHLO and HELO names in addition to the standard letters, digits,
14468 hyphens, and dots. If you really must allow underscores, you can set
14469 .code
14470 helo_allow_chars = _
14471 .endd
14472 Note that the value is one string, not a list.
14473
14474
14475 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14476 .cindex "HELO" "forcing reverse lookup"
14477 .cindex "EHLO" "forcing reverse lookup"
14478 If the domain given by a client in a HELO or EHLO command matches this
14479 list, a reverse lookup is done in order to establish the host's true name. The
14480 default forces a lookup if the client host gives the server's name or any of
14481 its IP addresses (in brackets), something that broken clients have been seen to
14482 do.
14483
14484
14485 .option helo_try_verify_hosts main "host list&!!" unset
14486 .cindex "HELO verifying" "optional"
14487 .cindex "EHLO" "verifying, optional"
14488 By default, Exim just checks the syntax of HELO and EHLO commands (see
14489 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14490 to do more extensive checking of the data supplied by these commands. The ACL
14491 condition &`verify = helo`& is provided to make this possible.
14492 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14493 to force the check to occur. From release 4.53 onwards, this is no longer
14494 necessary. If the check has not been done before &`verify = helo`& is
14495 encountered, it is done at that time. Consequently, this option is obsolete.
14496 Its specification is retained here for backwards compatibility.
14497
14498 When an EHLO or HELO command is received, if the calling host matches
14499 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14500 EHLO command either:
14501
14502 .ilist
14503 is an IP literal matching the calling address of the host, or
14504 .next
14505 .cindex "DNS" "reverse lookup"
14506 .cindex "reverse DNS lookup"
14507 matches the host name that Exim obtains by doing a reverse lookup of the
14508 calling host address, or
14509 .next
14510 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14511 available) yields the calling host address.
14512 .endlist
14513
14514 However, the EHLO or HELO command is not rejected if any of the checks
14515 fail. Processing continues, but the result of the check is remembered, and can
14516 be detected later in an ACL by the &`verify = helo`& condition.
14517
14518 .option helo_verify_hosts main "host list&!!" unset
14519 .cindex "HELO verifying" "mandatory"
14520 .cindex "EHLO" "verifying, mandatory"
14521 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14522 backwards compatibility. For hosts that match this option, Exim checks the host
14523 name given in the HELO or EHLO in the same way as for
14524 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14525 rejected with a 550 error, and entries are written to the main and reject logs.
14526 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14527 error.
14528
14529 .option hold_domains main "domain list&!!" unset
14530 .cindex "domain" "delaying delivery"
14531 .cindex "delivery" "delaying certain domains"
14532 This option allows mail for particular domains to be held on the queue
14533 manually. The option is overridden if a message delivery is forced with the
14534 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14535 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14536 item in &%hold_domains%&, no routing or delivery for that address is done, and
14537 it is deferred every time the message is looked at.
14538
14539 This option is intended as a temporary operational measure for delaying the
14540 delivery of mail while some problem is being sorted out, or some new
14541 configuration tested. If you just want to delay the processing of some
14542 domains until a queue run occurs, you should use &%queue_domains%& or
14543 &%queue_smtp_domains%&, not &%hold_domains%&.
14544
14545 A setting of &%hold_domains%& does not override Exim's code for removing
14546 messages from the queue if they have been there longer than the longest retry
14547 time in any retry rule. If you want to hold messages for longer than the normal
14548 retry times, insert a dummy retry rule with a long retry time.
14549
14550
14551 .option host_lookup main "host list&!!" unset
14552 .cindex "host name" "lookup, forcing"
14553 Exim does not look up the name of a calling host from its IP address unless it
14554 is required to compare against some host list, or the host matches
14555 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14556 option (which normally contains IP addresses rather than host names). The
14557 default configuration file contains
14558 .code
14559 host_lookup = *
14560 .endd
14561 which causes a lookup to happen for all hosts. If the expense of these lookups
14562 is felt to be too great, the setting can be changed or removed.
14563
14564 After a successful reverse lookup, Exim does a forward lookup on the name it
14565 has obtained, to verify that it yields the IP address that it started with. If
14566 this check fails, Exim behaves as if the name lookup failed.
14567
14568 .vindex "&$host_lookup_failed$&"
14569 .vindex "&$sender_host_name$&"
14570 After any kind of failure, the host name (in &$sender_host_name$&) remains
14571 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14572 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14573 &`verify = reverse_host_lookup`& in ACLs.
14574
14575
14576 .option host_lookup_order main "string list" &`bydns:byaddr`&
14577 This option specifies the order of different lookup methods when Exim is trying
14578 to find a host name from an IP address. The default is to do a DNS lookup
14579 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14580 if that fails. You can change the order of these lookups, or omit one entirely,
14581 if you want.
14582
14583 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14584 multiple PTR records in the DNS and the IP address is not listed in
14585 &_/etc/hosts_&. Different operating systems give different results in this
14586 case. That is why the default tries a DNS lookup first.
14587
14588
14589
14590 .option host_reject_connection main "host list&!!" unset
14591 .cindex "host" "rejecting connections from"
14592 If this option is set, incoming SMTP calls from the hosts listed are rejected
14593 as soon as the connection is made.
14594 This option is obsolete, and retained only for backward compatibility, because
14595 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14596 connections immediately.
14597
14598 The ability to give an immediate rejection (either by this option or using an
14599 ACL) is provided for use in unusual cases. Many hosts will just try again,
14600 sometimes without much delay. Normally, it is better to use an ACL to reject
14601 incoming messages at a later stage, such as after RCPT commands. See
14602 chapter &<<CHAPACL>>&.
14603
14604
14605 .option hosts_connection_nolog main "host list&!!" unset
14606 .cindex "host" "not logging connections from"
14607 This option defines a list of hosts for which connection logging does not
14608 happen, even though the &%smtp_connection%& log selector is set. For example,
14609 you might want not to log SMTP connections from local processes, or from
14610 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14611 the daemon; you should therefore strive to restrict its value to a short inline
14612 list of IP addresses and networks. To disable logging SMTP connections from
14613 local processes, you must create a host list with an empty item. For example:
14614 .code
14615 hosts_connection_nolog = :
14616 .endd
14617 If the &%smtp_connection%& log selector is not set, this option has no effect.
14618
14619
14620
14621 .option hosts_treat_as_local main "domain list&!!" unset
14622 .cindex "local host" "domains treated as"
14623 .cindex "host" "treated as local"
14624 If this option is set, any host names that match the domain list are treated as
14625 if they were the local host when Exim is scanning host lists obtained from MX
14626 records
14627 or other sources. Note that the value of this option is a domain list, not a
14628 host list, because it is always used to check host names, not IP addresses.
14629
14630 This option also applies when Exim is matching the special items
14631 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14632 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14633 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14634 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14635 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14636 interfaces and recognizing the local host.
14637
14638
14639 .option ibase_servers main "string list" unset
14640 .cindex "InterBase" "server list"
14641 This option provides a list of InterBase servers and associated connection data,
14642 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14643 The option is available only if Exim has been built with InterBase support.
14644
14645
14646
14647 .option ignore_bounce_errors_after main time 10w
14648 .cindex "bounce message" "discarding"
14649 .cindex "discarding bounce message"
14650 This option affects the processing of bounce messages that cannot be delivered,
14651 that is, those that suffer a permanent delivery failure. (Bounce messages that
14652 suffer temporary delivery failures are of course retried in the usual way.)
14653
14654 After a permanent delivery failure, bounce messages are frozen,
14655 because there is no sender to whom they can be returned. When a frozen bounce
14656 message has been on the queue for more than the given time, it is unfrozen at
14657 the next queue run, and a further delivery is attempted. If delivery fails
14658 again, the bounce message is discarded. This makes it possible to keep failed
14659 bounce messages around for a shorter time than the normal maximum retry time
14660 for frozen messages. For example,
14661 .code
14662 ignore_bounce_errors_after = 12h
14663 .endd
14664 retries failed bounce message deliveries after 12 hours, discarding any further
14665 failures. If the value of this option is set to a zero time period, bounce
14666 failures are discarded immediately. Setting a very long time (as in the default
14667 value) has the effect of disabling this option. For ways of automatically
14668 dealing with other kinds of frozen message, see &%auto_thaw%& and
14669 &%timeout_frozen_after%&.
14670
14671
14672 .option ignore_fromline_hosts main "host list&!!" unset
14673 .cindex "&""From""& line"
14674 .cindex "UUCP" "&""From""& line"
14675 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14676 the headers of a message. By default this is treated as the start of the
14677 message's body, which means that any following headers are not recognized as
14678 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14679 match those hosts that insist on sending it. If the sender is actually a local
14680 process rather than a remote host, and is using &%-bs%& to inject the messages,
14681 &%ignore_fromline_local%& must be set to achieve this effect.
14682
14683
14684 .option ignore_fromline_local main boolean false
14685 See &%ignore_fromline_hosts%& above.
14686
14687
14688 .option keep_malformed main time 4d
14689 This option specifies the length of time to keep messages whose spool files
14690 have been corrupted in some way. This should, of course, never happen. At the
14691 next attempt to deliver such a message, it gets removed. The incident is
14692 logged.
14693
14694
14695 .option ldap_ca_cert_dir main string unset
14696 .cindex "LDAP", "TLS CA certificate directory"
14697 This option indicates which directory contains CA certificates for verifying
14698 a TLS certificate presented by an LDAP server.
14699 While Exim does not provide a default value, your SSL library may.
14700 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14701 and constrained to be a directory.
14702
14703
14704 .option ldap_ca_cert_file main string unset
14705 .cindex "LDAP", "TLS CA certificate file"
14706 This option indicates which file contains CA certificates for verifying
14707 a TLS certificate presented by an LDAP server.
14708 While Exim does not provide a default value, your SSL library may.
14709 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14710 and constrained to be a file.
14711
14712
14713 .option ldap_cert_file main string unset
14714 .cindex "LDAP" "TLS client certificate file"
14715 This option indicates which file contains an TLS client certificate which
14716 Exim should present to the LDAP server during TLS negotiation.
14717 Should be used together with &%ldap_cert_key%&.
14718
14719
14720 .option ldap_cert_key main string unset
14721 .cindex "LDAP" "TLS client key file"
14722 This option indicates which file contains the secret/private key to use
14723 to prove identity to the LDAP server during TLS negotiation.
14724 Should be used together with &%ldap_cert_file%&, which contains the
14725 identity to be proven.
14726
14727
14728 .option ldap_cipher_suite main string unset
14729 .cindex "LDAP" "TLS cipher suite"
14730 This controls the TLS cipher-suite negotiation during TLS negotiation with
14731 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14732 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14733
14734
14735 .option ldap_default_servers main "string list" unset
14736 .cindex "LDAP" "default servers"
14737 This option provides a list of LDAP servers which are tried in turn when an
14738 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14739 details of LDAP queries. This option is available only when Exim has been built
14740 with LDAP support.
14741
14742
14743 .option ldap_require_cert main string unset.
14744 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14745 This should be one of the values "hard", "demand", "allow", "try" or "never".
14746 A value other than one of these is interpreted as "never".
14747 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14748 Although Exim does not set a default, the LDAP library probably defaults
14749 to hard/demand.
14750
14751
14752 .option ldap_start_tls main boolean false
14753 .cindex "LDAP" "whether or not to negotiate TLS"
14754 If set, Exim will attempt to negotiate TLS with the LDAP server when
14755 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14756 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14757 of SSL-on-connect.
14758 In the event of failure to negotiate TLS, the action taken is controlled
14759 by &%ldap_require_cert%&.
14760
14761
14762 .option ldap_version main integer unset
14763 .cindex "LDAP" "protocol version, forcing"
14764 This option can be used to force Exim to set a specific protocol version for
14765 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14766 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14767 the LDAP headers; otherwise it is 2. This option is available only when Exim
14768 has been built with LDAP support.
14769
14770
14771
14772 .option local_from_check main boolean true
14773 .cindex "&'Sender:'& header line" "disabling addition of"
14774 .cindex "&'From:'& header line" "disabling checking of"
14775 When a message is submitted locally (that is, not over a TCP/IP connection) by
14776 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14777 checks that the &'From:'& header line matches the login of the calling user and
14778 the domain specified by &%qualify_domain%&.
14779
14780 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14781 locally submitted message is automatically qualified by Exim, unless the
14782 &%-bnq%& command line option is used.
14783
14784 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14785 on the local part. If the &'From:'& header line does not match, Exim adds a
14786 &'Sender:'& header with an address constructed from the calling user's login
14787 and the default qualify domain.
14788
14789 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14790 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14791 &'Sender:'& header lines supplied by untrusted users, you must also set
14792 &%local_sender_retain%& to be true.
14793
14794 .cindex "envelope sender"
14795 These options affect only the header lines in the message. The envelope sender
14796 is still forced to be the login id at the qualify domain unless
14797 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14798
14799 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14800 request similar header line checking. See section &<<SECTthesenhea>>&, which
14801 has more details about &'Sender:'& processing.
14802
14803
14804
14805
14806 .option local_from_prefix main string unset
14807 When Exim checks the &'From:'& header line of locally submitted messages for
14808 matching the login id (see &%local_from_check%& above), it can be configured to
14809 ignore certain prefixes and suffixes in the local part of the address. This is
14810 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14811 appropriate lists, in the same form as the &%local_part_prefix%& and
14812 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14813 example, if
14814 .code
14815 local_from_prefix = *-
14816 .endd
14817 is set, a &'From:'& line containing
14818 .code
14819 From: anything-user@your.domain.example
14820 .endd
14821 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14822 matches the actual sender address that is constructed from the login name and
14823 qualify domain.
14824
14825
14826 .option local_from_suffix main string unset
14827 See &%local_from_prefix%& above.
14828
14829
14830 .option local_interfaces main "string list" "see below"
14831 This option controls which network interfaces are used by the daemon for
14832 listening; they are also used to identify the local host when routing. Chapter
14833 &<<CHAPinterfaces>>& contains a full description of this option and the related
14834 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14835 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14836 &%local_interfaces%& is
14837 .code
14838 local_interfaces = 0.0.0.0
14839 .endd
14840 when Exim is built without IPv6 support; otherwise it is
14841 .code
14842 local_interfaces = <; ::0 ; 0.0.0.0
14843 .endd
14844
14845 .option local_scan_timeout main time 5m
14846 .cindex "timeout" "for &[local_scan()]& function"
14847 .cindex "&[local_scan()]& function" "timeout"
14848 This timeout applies to the &[local_scan()]& function (see chapter
14849 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14850 the incoming message is rejected with a temporary error if it is an SMTP
14851 message. For a non-SMTP message, the message is dropped and Exim ends with a
14852 non-zero code. The incident is logged on the main and reject logs.
14853
14854
14855
14856 .option local_sender_retain main boolean false
14857 .cindex "&'Sender:'& header line" "retaining from local submission"
14858 When a message is submitted locally (that is, not over a TCP/IP connection) by
14859 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14860 do not want this to happen, you must set &%local_sender_retain%&, and you must
14861 also set &%local_from_check%& to be false (Exim will complain if you do not).
14862 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14863 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14864
14865
14866
14867
14868 .option localhost_number main string&!! unset
14869 .cindex "host" "locally unique number for"
14870 .cindex "message ids" "with multiple hosts"
14871 .vindex "&$localhost_number$&"
14872 Exim's message ids are normally unique only within the local host. If
14873 uniqueness among a set of hosts is required, each host must set a different
14874 value for the &%localhost_number%& option. The string is expanded immediately
14875 after reading the configuration file (so that a number can be computed from the
14876 host name, for example) and the result of the expansion must be a number in the
14877 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14878 systems). This is available in subsequent string expansions via the variable
14879 &$localhost_number$&. When &%localhost_number is set%&, the final two
14880 characters of the message id, instead of just being a fractional part of the
14881 time, are computed from the time and the local host number as described in
14882 section &<<SECTmessiden>>&.
14883
14884
14885
14886 .option log_file_path main "string list&!!" "set at compile time"
14887 .cindex "log" "file path for"
14888 This option sets the path which is used to determine the names of Exim's log
14889 files, or indicates that logging is to be to syslog, or both. It is expanded
14890 when Exim is entered, so it can, for example, contain a reference to the host
14891 name. If no specific path is set for the log files at compile or run time, they
14892 are written in a sub-directory called &_log_& in Exim's spool directory.
14893 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14894 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14895 used. If this string is fixed at your installation (contains no expansion
14896 variables) it is recommended that you do not set this option in the
14897 configuration file, but instead supply the path using LOG_FILE_PATH in
14898 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14899 early on &-- in particular, failure to read the configuration file.
14900
14901
14902 .option log_selector main string unset
14903 .cindex "log" "selectors"
14904 This option can be used to reduce or increase the number of things that Exim
14905 writes to its log files. Its argument is made up of names preceded by plus or
14906 minus characters. For example:
14907 .code
14908 log_selector = +arguments -retry_defer
14909 .endd
14910 A list of possible names and what they control is given in the chapter on
14911 logging, in section &<<SECTlogselector>>&.
14912
14913
14914 .option log_timezone main boolean false
14915 .cindex "log" "timezone for entries"
14916 .vindex "&$tod_log$&"
14917 .vindex "&$tod_zone$&"
14918 By default, the timestamps on log lines are in local time without the
14919 timezone. This means that if your timezone changes twice a year, the timestamps
14920 in log lines are ambiguous for an hour when the clocks go back. One way of
14921 avoiding this problem is to set the timezone to UTC. An alternative is to set
14922 &%log_timezone%& true. This turns on the addition of the timezone offset to
14923 timestamps in log lines. Turning on this option can add quite a lot to the size
14924 of log files because each line is extended by 6 characters. Note that the
14925 &$tod_log$& variable contains the log timestamp without the zone, but there is
14926 another variable called &$tod_zone$& that contains just the timezone offset.
14927
14928
14929 .option lookup_open_max main integer 25
14930 .cindex "too many open files"
14931 .cindex "open files, too many"
14932 .cindex "file" "too many open"
14933 .cindex "lookup" "maximum open files"
14934 .cindex "limit" "open files for lookups"
14935 This option limits the number of simultaneously open files for single-key
14936 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14937 Exim normally keeps these files open during routing, because often the same
14938 file is required several times. If the limit is reached, Exim closes the least
14939 recently used file. Note that if you are using the &'ndbm'& library, it
14940 actually opens two files for each logical DBM database, though it still counts
14941 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14942 open files"& errors with NDBM, you need to reduce the value of
14943 &%lookup_open_max%&.
14944
14945
14946 .option max_username_length main integer 0
14947 .cindex "length of login name"
14948 .cindex "user name" "maximum length"
14949 .cindex "limit" "user name length"
14950 Some operating systems are broken in that they truncate long arguments to
14951 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14952 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14953 an argument that is longer behaves as if &[getpwnam()]& failed.
14954
14955
14956 .option message_body_newlines main bool false
14957 .cindex "message body" "newlines in variables"
14958 .cindex "newline" "in message body variables"
14959 .vindex "&$message_body$&"
14960 .vindex "&$message_body_end$&"
14961 By default, newlines in the message body are replaced by spaces when setting
14962 the &$message_body$& and &$message_body_end$& expansion variables. If this
14963 option is set true, this no longer happens.
14964
14965
14966 .option message_body_visible main integer 500
14967 .cindex "body of message" "visible size"
14968 .cindex "message body" "visible size"
14969 .vindex "&$message_body$&"
14970 .vindex "&$message_body_end$&"
14971 This option specifies how much of a message's body is to be included in the
14972 &$message_body$& and &$message_body_end$& expansion variables.
14973
14974
14975 .option message_id_header_domain main string&!! unset
14976 .cindex "&'Message-ID:'& header line"
14977 If this option is set, the string is expanded and used as the right hand side
14978 (domain) of the &'Message-ID:'& header that Exim creates if a
14979 locally-originated incoming message does not have one. &"Locally-originated"&
14980 means &"not received over TCP/IP."&
14981 Otherwise, the primary host name is used.
14982 Only letters, digits, dot and hyphen are accepted; any other characters are
14983 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14984 empty string, the option is ignored.
14985
14986
14987 .option message_id_header_text main string&!! unset
14988 If this variable is set, the string is expanded and used to augment the text of
14989 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14990 message does not have one. The text of this header is required by RFC 2822 to
14991 take the form of an address. By default, Exim uses its internal message id as
14992 the local part, and the primary host name as the domain. If this option is set,
14993 it is expanded, and provided the expansion is not forced to fail, and does not
14994 yield an empty string, the result is inserted into the header immediately
14995 before the @, separated from the internal message id by a dot. Any characters
14996 that are illegal in an address are automatically converted into hyphens. This
14997 means that variables such as &$tod_log$& can be used, because the spaces and
14998 colons will become hyphens.
14999
15000
15001 .option message_logs main boolean true
15002 .cindex "message logs" "disabling"
15003 .cindex "log" "message log; disabling"
15004 If this option is turned off, per-message log files are not created in the
15005 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15006 Exim, by reducing the number of files involved in handling a message from a
15007 minimum of four (header spool file, body spool file, delivery journal, and
15008 per-message log) to three. The other major I/O activity is Exim's main log,
15009 which is not affected by this option.
15010
15011
15012 .option message_size_limit main string&!! 50M
15013 .cindex "message" "size limit"
15014 .cindex "limit" "message size"
15015 .cindex "size" "of message, limit"
15016 This option limits the maximum size of message that Exim will process. The
15017 value is expanded for each incoming connection so, for example, it can be made
15018 to depend on the IP address of the remote host for messages arriving via
15019 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15020 optionally followed by K or M.
15021
15022 &*Note*&: This limit cannot be made to depend on a message's sender or any
15023 other properties of an individual message, because it has to be advertised in
15024 the server's response to EHLO. String expansion failure causes a temporary
15025 error. A value of zero means no limit, but its use is not recommended. See also
15026 &%bounce_return_size_limit%&.
15027
15028 Incoming SMTP messages are failed with a 552 error if the limit is
15029 exceeded; locally-generated messages either get a stderr message or a delivery
15030 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15031 an oversized message is logged in both the main and the reject logs. See also
15032 the generic transport option &%message_size_limit%&, which limits the size of
15033 message that an individual transport can process.
15034
15035 If you use a virus-scanner and set this option to to a value larger than the
15036 maximum size that your virus-scanner is configured to support, you may get
15037 failures triggered by large mails.  The right size to configure for the
15038 virus-scanner depends upon what data is passed and the options in use but it's
15039 probably safest to just set it to a little larger than this value.  Eg, with a
15040 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15041 some problems may result.
15042
15043 A value of 0 will disable size limit checking; Exim will still advertise the
15044 SIZE extension in an EHLO response, but without a limit, so as to permit
15045 SMTP clients to still indicate the message size along with the MAIL verb.
15046
15047
15048 .option move_frozen_messages main boolean false
15049 .cindex "frozen messages" "moving"
15050 This option, which is available only if Exim has been built with the setting
15051 .code
15052 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15053 .endd
15054 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15055 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15056 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15057 standard utilities for handling such moved messages, and they do not show up in
15058 lists generated by &%-bp%& or by the Exim monitor.
15059
15060
15061 .option mua_wrapper main boolean false
15062 Setting this option true causes Exim to run in a very restrictive mode in which
15063 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15064 contains a full description of this facility.
15065
15066
15067
15068 .option mysql_servers main "string list" unset
15069 .cindex "MySQL" "server list"
15070 This option provides a list of MySQL servers and associated connection data, to
15071 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15072 option is available only if Exim has been built with MySQL support.
15073
15074
15075 .option never_users main "string list&!!" unset
15076 This option is expanded just once, at the start of Exim's processing. Local
15077 message deliveries are normally run in processes that are setuid to the
15078 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15079 It is usually desirable to prevent any deliveries from running as root, as a
15080 safety precaution.
15081
15082 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15083 list of users that must not be used for local deliveries. This list is fixed in
15084 the binary and cannot be overridden by the configuration file. By default, it
15085 contains just the single user name &"root"&. The &%never_users%& runtime option
15086 can be used to add more users to the fixed list.
15087
15088 If a message is to be delivered as one of the users on the fixed list or the
15089 &%never_users%& list, an error occurs, and delivery is deferred. A common
15090 example is
15091 .code
15092 never_users = root:daemon:bin
15093 .endd
15094 Including root is redundant if it is also on the fixed list, but it does no
15095 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15096 transport driver.
15097
15098
15099 .option openssl_options main "string list" "+no_sslv2"
15100 .cindex "OpenSSL "compatibility options"
15101 This option allows an administrator to adjust the SSL options applied
15102 by OpenSSL to connections.  It is given as a space-separated list of items,
15103 each one to be +added or -subtracted from the current value.
15104
15105 This option is only available if Exim is built against OpenSSL.  The values
15106 available for this option vary according to the age of your OpenSSL install.
15107 The &"all"& value controls a subset of flags which are available, typically
15108 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15109 list the values known on your system and Exim should support all the
15110 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15111 names lose the leading &"SSL_OP_"& and are lower-cased.
15112
15113 Note that adjusting the options can have severe impact upon the security of
15114 SSL as used by Exim.  It is possible to disable safety checks and shoot
15115 yourself in the foot in various unpleasant ways.  This option should not be
15116 adjusted lightly.  An unrecognised item will be detected at startup, by
15117 invoking Exim with the &%-bV%& flag.
15118
15119 The option affects Exim operating both as a server and as a client.
15120
15121 Historical note: prior to release 4.80, Exim defaulted this value to
15122 "+dont_insert_empty_fragments", which may still be needed for compatibility
15123 with some clients, but which lowers security by increasing exposure to
15124 some now infamous attacks.
15125
15126 Examples:
15127 .code
15128 # Make both old MS and old Eudora happy:
15129 openssl_options = -all +microsoft_big_sslv3_buffer \
15130                        +dont_insert_empty_fragments
15131
15132 # Disable older protocol versions:
15133 openssl_options = +no_sslv2 +no_sslv3
15134 .endd
15135
15136 Possible options may include:
15137 .ilist
15138 &`all`&
15139 .next
15140 &`allow_unsafe_legacy_renegotiation`&
15141 .next
15142 &`cipher_server_preference`&
15143 .next
15144 &`dont_insert_empty_fragments`&
15145 .next
15146 &`ephemeral_rsa`&
15147 .next
15148 &`legacy_server_connect`&
15149 .next
15150 &`microsoft_big_sslv3_buffer`&
15151 .next
15152 &`microsoft_sess_id_bug`&
15153 .next
15154 &`msie_sslv2_rsa_padding`&
15155 .next
15156 &`netscape_challenge_bug`&
15157 .next
15158 &`netscape_reuse_cipher_change_bug`&
15159 .next
15160 &`no_compression`&
15161 .next
15162 &`no_session_resumption_on_renegotiation`&
15163 .next
15164 &`no_sslv2`&
15165 .next
15166 &`no_sslv3`&
15167 .next
15168 &`no_ticket`&
15169 .next
15170 &`no_tlsv1`&
15171 .next
15172 &`no_tlsv1_1`&
15173 .next
15174 &`no_tlsv1_2`&
15175 .next
15176 &`safari_ecdhe_ecdsa_bug`&
15177 .next
15178 &`single_dh_use`&
15179 .next
15180 &`single_ecdh_use`&
15181 .next
15182 &`ssleay_080_client_dh_bug`&
15183 .next
15184 &`sslref2_reuse_cert_type_bug`&
15185 .next
15186 &`tls_block_padding_bug`&
15187 .next
15188 &`tls_d5_bug`&
15189 .next
15190 &`tls_rollback_bug`&
15191 .endlist
15192
15193 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15194 all clients connecting using the MacOS SecureTransport TLS facility prior
15195 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15196 to negotiate TLS then this option value might help, provided that your OpenSSL
15197 release is new enough to contain this work-around.  This may be a situation
15198 where you have to upgrade OpenSSL to get buggy clients working.
15199
15200
15201 .option oracle_servers main "string list" unset
15202 .cindex "Oracle" "server list"
15203 This option provides a list of Oracle servers and associated connection data,
15204 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15205 The option is available only if Exim has been built with Oracle support.
15206
15207
15208 .option percent_hack_domains main "domain list&!!" unset
15209 .cindex "&""percent hack""&"
15210 .cindex "source routing" "in email address"
15211 .cindex "address" "source-routed"
15212 The &"percent hack"& is the convention whereby a local part containing a
15213 percent sign is re-interpreted as a new email address, with the percent
15214 replaced by @. This is sometimes called &"source routing"&, though that term is
15215 also applied to RFC 2822 addresses that begin with an @ character. If this
15216 option is set, Exim implements the percent facility for those domains listed,
15217 but no others. This happens before an incoming SMTP address is tested against
15218 an ACL.
15219
15220 &*Warning*&: The &"percent hack"& has often been abused by people who are
15221 trying to get round relaying restrictions. For this reason, it is best avoided
15222 if at all possible. Unfortunately, a number of less security-conscious MTAs
15223 implement it unconditionally. If you are running Exim on a gateway host, and
15224 routing mail through to internal MTAs without processing the local parts, it is
15225 a good idea to reject recipient addresses with percent characters in their
15226 local parts. Exim's default configuration does this.
15227
15228
15229 .option perl_at_start main boolean false
15230 This option is available only when Exim is built with an embedded Perl
15231 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15232
15233
15234 .option perl_startup main string unset
15235 This option is available only when Exim is built with an embedded Perl
15236 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15237
15238
15239 .option pgsql_servers main "string list" unset
15240 .cindex "PostgreSQL lookup type" "server list"
15241 This option provides a list of PostgreSQL servers and associated connection
15242 data, to be used in conjunction with &(pgsql)& lookups (see section
15243 &<<SECID72>>&). The option is available only if Exim has been built with
15244 PostgreSQL support.
15245
15246
15247 .option pid_file_path main string&!! "set at compile time"
15248 .cindex "daemon" "pid file path"
15249 .cindex "pid file, path for"
15250 This option sets the name of the file to which the Exim daemon writes its
15251 process id. The string is expanded, so it can contain, for example, references
15252 to the host name:
15253 .code
15254 pid_file_path = /var/log/$primary_hostname/exim.pid
15255 .endd
15256 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15257 spool directory.
15258 The value set by the option can be overridden by the &%-oP%& command line
15259 option. A pid file is not written if a &"non-standard"& daemon is run by means
15260 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15261
15262
15263 .option pipelining_advertise_hosts main "host list&!!" *
15264 .cindex "PIPELINING" "suppressing advertising"
15265 This option can be used to suppress the advertisement of the SMTP
15266 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15267 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15268 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15269 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15270 that clients will use it; &"out of order"& commands that are &"expected"& do
15271 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15272
15273
15274 .option prdr_enable main boolean false
15275 .cindex "PRDR" "enabling on server"
15276 This option can be used to enable the Per-Recipient Data Response extension
15277 to SMTP, defined by Eric Hall.
15278 If the option is set, PRDR is advertised by Exim when operating as a server.
15279 If the client requests PRDR, and more than one recipient, for a message 
15280 an additional ACL is called for each recipient after the message content
15281 is recieved.  See section &<<SECTPRDRACL>>&.
15282
15283 .option preserve_message_logs main boolean false
15284 .cindex "message logs" "preserving"
15285 If this option is set, message log files are not deleted when messages are
15286 completed. Instead, they are moved to a sub-directory of the spool directory
15287 called &_msglog.OLD_&, where they remain available for statistical or debugging
15288 purposes. This is a dangerous option to set on systems with any appreciable
15289 volume of mail. Use with care!
15290
15291
15292 .option primary_hostname main string "see below"
15293 .cindex "name" "of local host"
15294 .cindex "host" "name of local"
15295 .cindex "local host" "name of"
15296 .vindex "&$primary_hostname$&"
15297 This specifies the name of the current host. It is used in the default EHLO or
15298 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15299 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15300 The value is also used by default in some SMTP response messages from an Exim
15301 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15302
15303 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15304 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15305 contains only one component, Exim passes it to &[gethostbyname()]& (or
15306 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15307 version. The variable &$primary_hostname$& contains the host name, whether set
15308 explicitly by this option, or defaulted.
15309
15310
15311 .option print_topbitchars main boolean false
15312 .cindex "printing characters"
15313 .cindex "8-bit characters"
15314 By default, Exim considers only those characters whose codes lie in the range
15315 32&--126 to be printing characters. In a number of circumstances (for example,
15316 when writing log entries) non-printing characters are converted into escape
15317 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15318 is set, code values of 128 and above are also considered to be printing
15319 characters.
15320
15321 This option also affects the header syntax checks performed by the
15322 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15323 the user's full name when constructing From: and Sender: addresses (as
15324 described in section &<<SECTconstr>>&). Setting this option can cause
15325 Exim to generate eight bit message headers that do not conform to the
15326 standards.
15327
15328
15329 .option process_log_path main string unset
15330 .cindex "process log path"
15331 .cindex "log" "process log"
15332 .cindex "&'exiwhat'&"
15333 This option sets the name of the file to which an Exim process writes its
15334 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15335 utility script. If this option is unset, the file called &_exim-process.info_&
15336 in Exim's spool directory is used. The ability to specify the name explicitly
15337 can be useful in environments where two different Exims are running, using
15338 different spool directories.
15339
15340
15341 .option prod_requires_admin main boolean true
15342 .oindex "&%-M%&"
15343 .oindex "&%-R%&"
15344 .oindex "&%-q%&"
15345 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15346 admin user unless &%prod_requires_admin%& is set false. See also
15347 &%queue_list_requires_admin%&.
15348
15349
15350 .option qualify_domain main string "see below"
15351 .cindex "domain" "for qualifying addresses"
15352 .cindex "address" "qualification"
15353 This option specifies the domain name that is added to any envelope sender
15354 addresses that do not have a domain qualification. It also applies to
15355 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15356 are accepted by default only for locally-generated messages. Qualification is
15357 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15358 locally-generated messages, unless the &%-bnq%& command line option is used.
15359
15360 Messages from external sources must always contain fully qualified addresses,
15361 unless the sending host matches &%sender_unqualified_hosts%& or
15362 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15363 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15364 necessary. Internally, Exim always works with fully qualified envelope
15365 addresses. If &%qualify_domain%& is not set, it defaults to the
15366 &%primary_hostname%& value.
15367
15368
15369 .option qualify_recipient main string "see below"
15370 This option allows you to specify a different domain for qualifying recipient
15371 addresses to the one that is used for senders. See &%qualify_domain%& above.
15372
15373
15374
15375 .option queue_domains main "domain list&!!" unset
15376 .cindex "domain" "specifying non-immediate delivery"
15377 .cindex "queueing incoming messages"
15378 .cindex "message" "queueing certain domains"
15379 This option lists domains for which immediate delivery is not required.
15380 A delivery process is started whenever a message is received, but only those
15381 domains that do not match are processed. All other deliveries wait until the
15382 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15383
15384
15385 .option queue_list_requires_admin main boolean true
15386 .oindex "&%-bp%&"
15387 The &%-bp%& command-line option, which lists the messages that are on the
15388 queue, requires the caller to be an admin user unless
15389 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15390
15391
15392 .option queue_only main boolean false
15393 .cindex "queueing incoming messages"
15394 .cindex "message" "queueing unconditionally"
15395 If &%queue_only%& is set, a delivery process is not automatically started
15396 whenever a message is received. Instead, the message waits on the queue for the
15397 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15398 delivered immediately when certain conditions (such as heavy load) occur.
15399
15400 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15401 and &%-odi%& command line options override &%queue_only%& unless
15402 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15403 &%queue_only_load%&, and &%smtp_accept_queue%&.
15404
15405
15406 .option queue_only_file main string unset
15407 .cindex "queueing incoming messages"
15408 .cindex "message" "queueing by file existence"
15409 This option can be set to a colon-separated list of absolute path names, each
15410 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15411 it tests for the existence of each listed path using a call to &[stat()]&. For
15412 each path that exists, the corresponding queueing option is set.
15413 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15414 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15415 .code
15416 queue_only_file = smtp/some/file
15417 .endd
15418 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15419 &_/some/file_& exists.
15420
15421
15422 .option queue_only_load main fixed-point unset
15423 .cindex "load average"
15424 .cindex "queueing incoming messages"
15425 .cindex "message" "queueing by load"
15426 If the system load average is higher than this value, incoming messages from
15427 all sources are queued, and no automatic deliveries are started. If this
15428 happens during local or remote SMTP input, all subsequent messages received on
15429 the same SMTP connection are queued by default, whatever happens to the load in
15430 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15431 false.
15432
15433 Deliveries will subsequently be performed by queue runner processes. This
15434 option has no effect on ancient operating systems on which Exim cannot
15435 determine the load average. See also &%deliver_queue_load_max%& and
15436 &%smtp_load_reserve%&.
15437
15438
15439 .option queue_only_load_latch main boolean true
15440 .cindex "load average" "re-evaluating per message"
15441 When this option is true (the default), once one message has been queued
15442 because the load average is higher than the value set by &%queue_only_load%&,
15443 all subsequent messages received on the same SMTP connection are also queued.
15444 This is a deliberate choice; even though the load average may fall below the
15445 threshold, it doesn't seem right to deliver later messages on the same
15446 connection when not delivering earlier ones. However, there are special
15447 circumstances such as very long-lived connections from scanning appliances
15448 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15449 should be set false. This causes the value of the load average to be
15450 re-evaluated for each message.
15451
15452
15453 .option queue_only_override main boolean true
15454 .cindex "queueing incoming messages"
15455 When this option is true, the &%-od%&&'x'& command line options override the
15456 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15457 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15458 to override; they are accepted, but ignored.
15459
15460
15461 .option queue_run_in_order main boolean false
15462 .cindex "queue runner" "processing messages in order"
15463 If this option is set, queue runs happen in order of message arrival instead of
15464 in an arbitrary order. For this to happen, a complete list of the entire queue
15465 must be set up before the deliveries start. When the queue is all held in a
15466 single directory (the default), a single list is created for both the ordered
15467 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15468 single list is not created when &%queue_run_in_order%& is false. In this case,
15469 the sub-directories are processed one at a time (in a random order), and this
15470 avoids setting up one huge list for the whole queue. Thus, setting
15471 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15472 when the queue is large, because of the extra work in setting up the single,
15473 large list. In most situations, &%queue_run_in_order%& should not be set.
15474
15475
15476
15477 .option queue_run_max main integer 5
15478 .cindex "queue runner" "maximum number of"
15479 This controls the maximum number of queue runner processes that an Exim daemon
15480 can run simultaneously. This does not mean that it starts them all at once,
15481 but rather that if the maximum number are still running when the time comes to
15482 start another one, it refrains from starting another one. This can happen with
15483 very large queues and/or very sluggish deliveries. This option does not,
15484 however, interlock with other processes, so additional queue runners can be
15485 started by other means, or by killing and restarting the daemon.
15486
15487 Setting this option to zero does not suppress queue runs; rather, it disables
15488 the limit, allowing any number of simultaneous queue runner processes to be
15489 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15490 the daemon's command line.
15491
15492 .option queue_smtp_domains main "domain list&!!" unset
15493 .cindex "queueing incoming messages"
15494 .cindex "message" "queueing remote deliveries"
15495 When this option is set, a delivery process is started whenever a message is
15496 received, routing is performed, and local deliveries take place.
15497 However, if any SMTP deliveries are required for domains that match
15498 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15499 message waits on the queue for the next queue run. Since routing of the message
15500 has taken place, Exim knows to which remote hosts it must be delivered, and so
15501 when the queue run happens, multiple messages for the same host are delivered
15502 over a single SMTP connection. The &%-odqs%& command line option causes all
15503 SMTP deliveries to be queued in this way, and is equivalent to setting
15504 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15505 &%queue_domains%&.
15506
15507
15508 .option receive_timeout main time 0s
15509 .cindex "timeout" "for non-SMTP input"
15510 This option sets the timeout for accepting a non-SMTP message, that is, the
15511 maximum time that Exim waits when reading a message on the standard input. If
15512 the value is zero, it will wait for ever. This setting is overridden by the
15513 &%-or%& command line option. The timeout for incoming SMTP messages is
15514 controlled by &%smtp_receive_timeout%&.
15515
15516 .option received_header_text main string&!! "see below"
15517 .cindex "customizing" "&'Received:'& header"
15518 .cindex "&'Received:'& header line" "customizing"
15519 This string defines the contents of the &'Received:'& message header that is
15520 added to each message, except for the timestamp, which is automatically added
15521 on at the end (preceded by a semicolon). The string is expanded each time it is
15522 used. If the expansion yields an empty string, no &'Received:'& header line is
15523 added to the message. Otherwise, the string should start with the text
15524 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15525 header lines. The default setting is:
15526
15527 .code
15528 received_header_text = Received: \
15529   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15530   {${if def:sender_ident \
15531   {from ${quote_local_part:$sender_ident} }}\
15532   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15533   by $primary_hostname \
15534   ${if def:received_protocol {with $received_protocol}} \
15535   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15536   (Exim $version_number)\n\t\
15537   ${if def:sender_address \
15538   {(envelope-from <$sender_address>)\n\t}}\
15539   id $message_exim_id\
15540   ${if def:received_for {\n\tfor $received_for}}
15541 .endd
15542
15543 The reference to the TLS cipher is omitted when Exim is built without TLS
15544 support. The use of conditional expansions ensures that this works for both
15545 locally generated messages and messages received from remote hosts, giving
15546 header lines such as the following:
15547 .code
15548 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15549 by marley.carol.example with esmtp (Exim 4.00)
15550 (envelope-from <bob@carol.example>)
15551 id 16IOWa-00019l-00
15552 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15553 Received: by scrooge.carol.example with local (Exim 4.00)
15554 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15555 .endd
15556 Until the body of the message has been received, the timestamp is the time when
15557 the message started to be received. Once the body has arrived, and all policy
15558 checks have taken place, the timestamp is updated to the time at which the
15559 message was accepted.
15560
15561
15562 .option received_headers_max main integer 30
15563 .cindex "loop" "prevention"
15564 .cindex "mail loop prevention"
15565 .cindex "&'Received:'& header line" "counting"
15566 When a message is to be delivered, the number of &'Received:'& headers is
15567 counted, and if it is greater than this parameter, a mail loop is assumed to
15568 have occurred, the delivery is abandoned, and an error message is generated.
15569 This applies to both local and remote deliveries.
15570
15571
15572 .option recipient_unqualified_hosts main "host list&!!" unset
15573 .cindex "unqualified addresses"
15574 .cindex "host" "unqualified addresses from"
15575 This option lists those hosts from which Exim is prepared to accept unqualified
15576 recipient addresses in message envelopes. The addresses are made fully
15577 qualified by the addition of the &%qualify_recipient%& value. This option also
15578 affects message header lines. Exim does not reject unqualified recipient
15579 addresses in headers, but it qualifies them only if the message came from a
15580 host that matches &%recipient_unqualified_hosts%&,
15581 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15582 option was not set.
15583
15584
15585 .option recipients_max main integer 0
15586 .cindex "limit" "number of recipients"
15587 .cindex "recipient" "maximum number"
15588 If this option is set greater than zero, it specifies the maximum number of
15589 original recipients for any message. Additional recipients that are generated
15590 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15591 all recipients over the limit; earlier recipients are delivered as normal.
15592 Non-SMTP messages with too many recipients are failed, and no deliveries are
15593 done.
15594
15595 .cindex "RCPT" "maximum number of incoming"
15596 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15597 RCPT commands in a single message.
15598
15599
15600 .option recipients_max_reject main boolean false
15601 If this option is set true, Exim rejects SMTP messages containing too many
15602 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15603 error to the eventual DATA command. Otherwise (the default) it gives a 452
15604 error to the surplus RCPT commands and accepts the message on behalf of the
15605 initial set of recipients. The remote server should then re-send the message
15606 for the remaining recipients at a later time.
15607
15608
15609 .option remote_max_parallel main integer 2
15610 .cindex "delivery" "parallelism for remote"
15611 This option controls parallel delivery of one message to a number of remote
15612 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15613 does all the remote deliveries for a message one by one. Otherwise, if a single
15614 message has to be delivered to more than one remote host, or if several copies
15615 have to be sent to the same remote host, up to &%remote_max_parallel%&
15616 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15617 deliveries are required, the maximum number of processes are started, and as
15618 each one finishes, another is begun. The order of starting processes is the
15619 same as if sequential delivery were being done, and can be controlled by the
15620 &%remote_sort_domains%& option. If parallel delivery takes place while running
15621 with debugging turned on, the debugging output from each delivery process is
15622 tagged with its process id.
15623
15624 This option controls only the maximum number of parallel deliveries for one
15625 message in one Exim delivery process. Because Exim has no central queue
15626 manager, there is no way of controlling the total number of simultaneous
15627 deliveries if the configuration allows a delivery attempt as soon as a message
15628 is received.
15629
15630 .cindex "number of deliveries"
15631 .cindex "delivery" "maximum number of"
15632 If you want to control the total number of deliveries on the system, you
15633 need to set the &%queue_only%& option. This ensures that all incoming messages
15634 are added to the queue without starting a delivery process. Then set up an Exim
15635 daemon to start queue runner processes at appropriate intervals (probably
15636 fairly often, for example, every minute), and limit the total number of queue
15637 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15638 delivers only one message at a time, the maximum number of deliveries that can
15639 then take place at once is &%queue_run_max%& multiplied by
15640 &%remote_max_parallel%&.
15641
15642 If it is purely remote deliveries you want to control, use
15643 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15644 doing the SMTP routing before queueing, so that several messages for the same
15645 host will eventually get delivered down the same connection.
15646
15647
15648 .option remote_sort_domains main "domain list&!!" unset
15649 .cindex "sorting remote deliveries"
15650 .cindex "delivery" "sorting remote"
15651 When there are a number of remote deliveries for a message, they are sorted by
15652 domain into the order given by this list. For example,
15653 .code
15654 remote_sort_domains = *.cam.ac.uk:*.uk
15655 .endd
15656 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15657 then to those in the &%uk%& domain, then to any others.
15658
15659
15660 .option retry_data_expire main time 7d
15661 .cindex "hints database" "data expiry"
15662 This option sets a &"use before"& time on retry information in Exim's hints
15663 database. Any older retry data is ignored. This means that, for example, once a
15664 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15665 past failures.
15666
15667
15668 .option retry_interval_max main time 24h
15669 .cindex "retry" "limit on interval"
15670 .cindex "limit" "on retry interval"
15671 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15672 intervals between delivery attempts for messages that cannot be delivered
15673 straight away. This option sets an overall limit to the length of time between
15674 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15675 the default value.
15676
15677
15678 .option return_path_remove main boolean true
15679 .cindex "&'Return-path:'& header line" "removing"
15680 RFC 2821, section 4.4, states that an SMTP server must insert a
15681 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15682 The &'Return-path:'& header preserves the sender address as received in the
15683 MAIL command. This description implies that this header should not be present
15684 in an incoming message. If &%return_path_remove%& is true, any existing
15685 &'Return-path:'& headers are removed from messages at the time they are
15686 received. Exim's transports have options for adding &'Return-path:'& headers at
15687 the time of delivery. They are normally used only for final local deliveries.
15688
15689
15690 .option return_size_limit main integer 100K
15691 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15692
15693
15694 .new
15695 .option rfc1413_hosts main "host list&!!" @[]
15696 .cindex "RFC 1413"
15697 .cindex "host" "for RFC 1413 calls"
15698 RFC 1413 identification calls are made to any client host which matches
15699 an item in the list.
15700 The default value specifies just this host, being any local interface
15701 for the system.
15702 .wen
15703
15704 .new
15705 .option rfc1413_query_timeout main time 0s
15706 .wen
15707 .cindex "RFC 1413" "query timeout"
15708 .cindex "timeout" "for RFC 1413 call"
15709 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15710 no RFC 1413 calls are ever made.
15711
15712
15713 .option sender_unqualified_hosts main "host list&!!" unset
15714 .cindex "unqualified addresses"
15715 .cindex "host" "unqualified addresses from"
15716 This option lists those hosts from which Exim is prepared to accept unqualified
15717 sender addresses. The addresses are made fully qualified by the addition of
15718 &%qualify_domain%&. This option also affects message header lines. Exim does
15719 not reject unqualified addresses in headers that contain sender addresses, but
15720 it qualifies them only if the message came from a host that matches
15721 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15722 using TCP/IP), and the &%-bnq%& option was not set.
15723
15724
15725 .option smtp_accept_keepalive main boolean true
15726 .cindex "keepalive" "on incoming connection"
15727 This option controls the setting of the SO_KEEPALIVE option on incoming
15728 TCP/IP socket connections. When set, it causes the kernel to probe idle
15729 connections periodically, by sending packets with &"old"& sequence numbers. The
15730 other end of the connection should send an acknowledgment if the connection is
15731 still okay or a reset if the connection has been aborted. The reason for doing
15732 this is that it has the beneficial effect of freeing up certain types of
15733 connection that can get stuck when the remote host is disconnected without
15734 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15735 hours to detect unreachable hosts.
15736
15737
15738
15739 .option smtp_accept_max main integer 20
15740 .cindex "limit" "incoming SMTP connections"
15741 .cindex "SMTP" "incoming connection count"
15742 .cindex "inetd"
15743 This option specifies the maximum number of simultaneous incoming SMTP calls
15744 that Exim will accept. It applies only to the listening daemon; there is no
15745 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15746 value is set to zero, no limit is applied. However, it is required to be
15747 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15748 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15749
15750 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15751 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15752 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15753 and &%smtp_load_reserve%& are then checked before accepting the connection.
15754
15755
15756 .option smtp_accept_max_nonmail main integer 10
15757 .cindex "limit" "non-mail SMTP commands"
15758 .cindex "SMTP" "limiting non-mail commands"
15759 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15760 the connection if there are too many. This option defines &"too many"&. The
15761 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15762 client looping sending EHLO, for example. The check is applied only if the
15763 client host matches &%smtp_accept_max_nonmail_hosts%&.
15764
15765 When a new message is expected, one occurrence of RSET is not counted. This
15766 allows a client to send one RSET between messages (this is not necessary,
15767 but some clients do it). Exim also allows one uncounted occurrence of HELO
15768 or EHLO, and one occurrence of STARTTLS between messages. After
15769 starting up a TLS session, another EHLO is expected, and so it too is not
15770 counted. The first occurrence of AUTH in a connection, or immediately
15771 following STARTTLS is not counted. Otherwise, all commands other than
15772 MAIL, RCPT, DATA, and QUIT are counted.
15773
15774
15775 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15776 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15777 check by setting this option. The default value makes it apply to all hosts. By
15778 changing the value, you can exclude any badly-behaved hosts that you have to
15779 live with.
15780
15781
15782 . Allow this long option name to split; give it unsplit as a fifth argument
15783 . for the automatic .oindex that is generated by .option.
15784 . We insert " &~&~" which is both pretty nasty visually and results in
15785 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15786 . zero-width-space, which would be nicer visually and results in (at least)
15787 . html that Firefox will split on when it's forced to reflow (rather than
15788 . inserting a horizontal scrollbar).  However, the text is still not
15789 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15790 . the option name to split.
15791
15792 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15793          smtp_accept_max_per_connection
15794 .cindex "SMTP" "limiting incoming message count"
15795 .cindex "limit" "messages per SMTP connection"
15796 The value of this option limits the number of MAIL commands that Exim is
15797 prepared to accept over a single SMTP connection, whether or not each command
15798 results in the transfer of a message. After the limit is reached, a 421
15799 response is given to subsequent MAIL commands. This limit is a safety
15800 precaution against a client that goes mad (incidents of this type have been
15801 seen).
15802
15803
15804 .option smtp_accept_max_per_host main string&!! unset
15805 .cindex "limit" "SMTP connections from one host"
15806 .cindex "host" "limiting SMTP connections from"
15807 This option restricts the number of simultaneous IP connections from a single
15808 host (strictly, from a single IP address) to the Exim daemon. The option is
15809 expanded, to enable different limits to be applied to different hosts by
15810 reference to &$sender_host_address$&. Once the limit is reached, additional
15811 connection attempts from the same host are rejected with error code 421. This
15812 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15813 of zero imposes no limit. If this option is set greater than zero, it is
15814 required that &%smtp_accept_max%& be non-zero.
15815
15816 &*Warning*&: When setting this option you should not use any expansion
15817 constructions that take an appreciable amount of time. The expansion and test
15818 happen in the main daemon loop, in order to reject additional connections
15819 without forking additional processes (otherwise a denial-of-service attack
15820 could cause a vast number or processes to be created). While the daemon is
15821 doing this processing, it cannot accept any other incoming connections.
15822
15823
15824
15825 .option smtp_accept_queue main integer 0
15826 .cindex "SMTP" "incoming connection count"
15827 .cindex "queueing incoming messages"
15828 .cindex "message" "queueing by SMTP connection count"
15829 If the number of simultaneous incoming SMTP connections being handled via the
15830 listening daemon exceeds this value, messages received by SMTP are just placed
15831 on the queue; no delivery processes are started automatically. The count is
15832 fixed at the start of an SMTP connection. It cannot be updated in the
15833 subprocess that receives messages, and so the queueing or not queueing applies
15834 to all messages received in the same connection.
15835
15836 A value of zero implies no limit, and clearly any non-zero value is useful only
15837 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15838 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15839 various &%-od%&&'x'& command line options.
15840
15841
15842 . See the comment on smtp_accept_max_per_connection
15843
15844 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15845          smtp_accept_queue_per_connection
15846 .cindex "queueing incoming messages"
15847 .cindex "message" "queueing by message count"
15848 This option limits the number of delivery processes that Exim starts
15849 automatically when receiving messages via SMTP, whether via the daemon or by
15850 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15851 and the number of messages received in a single SMTP session exceeds this
15852 number, subsequent messages are placed on the queue, but no delivery processes
15853 are started. This helps to limit the number of Exim processes when a server
15854 restarts after downtime and there is a lot of mail waiting for it on other
15855 systems. On large systems, the default should probably be increased, and on
15856 dial-in client systems it should probably be set to zero (that is, disabled).
15857
15858
15859 .option smtp_accept_reserve main integer 0
15860 .cindex "SMTP" "incoming call count"
15861 .cindex "host" "reserved"
15862 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15863 number of SMTP connections that are reserved for connections from the hosts
15864 that are specified in &%smtp_reserve_hosts%&. The value set in
15865 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15866 restricted to this number of connections; the option specifies a minimum number
15867 of connection slots for them, not a maximum. It is a guarantee that this group
15868 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15869 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15870 individual host.
15871
15872 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15873 set to 5, once there are 45 active connections (from any hosts), new
15874 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15875 provided the other criteria for acceptance are met.
15876
15877
15878 .option smtp_active_hostname main string&!! unset
15879 .cindex "host" "name in SMTP responses"
15880 .cindex "SMTP" "host name in responses"
15881 .vindex "&$primary_hostname$&"
15882 This option is provided for multi-homed servers that want to masquerade as
15883 several different hosts. At the start of an incoming SMTP connection, its value
15884 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15885 responses. For example, it is used as domain name in the response to an
15886 incoming HELO or EHLO command.
15887
15888 .vindex "&$smtp_active_hostname$&"
15889 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15890 is saved with any messages that are received. It is therefore available for use
15891 in routers and transports when the message is later delivered.
15892
15893 If this option is unset, or if its expansion is forced to fail, or if the
15894 expansion results in an empty string, the value of &$primary_hostname$& is
15895 used. Other expansion failures cause a message to be written to the main and
15896 panic logs, and the SMTP command receives a temporary error. Typically, the
15897 value of &%smtp_active_hostname%& depends on the incoming interface address.
15898 For example:
15899 .code
15900 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15901   {cox.mydomain}{box.mydomain}}
15902 .endd
15903
15904 Although &$smtp_active_hostname$& is primarily concerned with incoming
15905 messages, it is also used as the default for HELO commands in callout
15906 verification if there is no remote transport from which to obtain a
15907 &%helo_data%& value.
15908
15909 .option smtp_banner main string&!! "see below"
15910 .cindex "SMTP" "welcome banner"
15911 .cindex "banner for SMTP"
15912 .cindex "welcome banner for SMTP"
15913 .cindex "customizing" "SMTP banner"
15914 This string, which is expanded every time it is used, is output as the initial
15915 positive response to an SMTP connection. The default setting is:
15916 .code
15917 smtp_banner = $smtp_active_hostname ESMTP Exim \
15918   $version_number $tod_full
15919 .endd
15920 Failure to expand the string causes a panic error. If you want to create a
15921 multiline response to the initial SMTP connection, use &"\n"& in the string at
15922 appropriate points, but not at the end. Note that the 220 code is not included
15923 in this string. Exim adds it automatically (several times in the case of a
15924 multiline response).
15925
15926
15927 .option smtp_check_spool_space main boolean true
15928 .cindex "checking disk space"
15929 .cindex "disk space, checking"
15930 .cindex "spool directory" "checking space"
15931 When this option is set, if an incoming SMTP session encounters the SIZE
15932 option on a MAIL command, it checks that there is enough space in the
15933 spool directory's partition to accept a message of that size, while still
15934 leaving free the amount specified by &%check_spool_space%& (even if that value
15935 is zero). If there isn't enough space, a temporary error code is returned.
15936
15937
15938 .option smtp_connect_backlog main integer 20
15939 .cindex "connection backlog"
15940 .cindex "SMTP" "connection backlog"
15941 .cindex "backlog of connections"
15942 This option specifies a maximum number of waiting SMTP connections. Exim passes
15943 this value to the TCP/IP system when it sets up its listener. Once this number
15944 of connections are waiting for the daemon's attention, subsequent connection
15945 attempts are refused at the TCP/IP level. At least, that is what the manuals
15946 say; in some circumstances such connection attempts have been observed to time
15947 out instead. For large systems it is probably a good idea to increase the
15948 value (to 50, say). It also gives some protection against denial-of-service
15949 attacks by SYN flooding.
15950
15951
15952 .option smtp_enforce_sync main boolean true
15953 .cindex "SMTP" "synchronization checking"
15954 .cindex "synchronization checking in SMTP"
15955 The SMTP protocol specification requires the client to wait for a response from
15956 the server at certain points in the dialogue. Without PIPELINING these
15957 synchronization points are after every command; with PIPELINING they are
15958 fewer, but they still exist.
15959
15960 Some spamming sites send out a complete set of SMTP commands without waiting
15961 for any response. Exim protects against this by rejecting a message if the
15962 client has sent further input when it should not have. The error response &"554
15963 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15964 for this error cannot be perfect because of transmission delays (unexpected
15965 input may be on its way but not yet received when Exim checks). However, it
15966 does detect many instances.
15967
15968 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15969 If you want to disable the check selectively (for example, only for certain
15970 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15971 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15972
15973
15974
15975 .option smtp_etrn_command main string&!! unset
15976 .cindex "ETRN" "command to be run"
15977 .vindex "&$domain$&"
15978 If this option is set, the given command is run whenever an SMTP ETRN
15979 command is received from a host that is permitted to issue such commands (see
15980 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15981 are independently expanded. The expansion variable &$domain$& is set to the
15982 argument of the ETRN command, and no syntax checking is done on it. For
15983 example:
15984 .code
15985 smtp_etrn_command = /etc/etrn_command $domain \
15986                     $sender_host_address
15987 .endd
15988 A new process is created to run the command, but Exim does not wait for it to
15989 complete. Consequently, its status cannot be checked. If the command cannot be
15990 run, a line is written to the panic log, but the ETRN caller still receives
15991 a 250 success response. Exim is normally running under its own uid when
15992 receiving SMTP, so it is not possible for it to change the uid before running
15993 the command.
15994
15995
15996 .option smtp_etrn_serialize main boolean true
15997 .cindex "ETRN" "serializing"
15998 When this option is set, it prevents the simultaneous execution of more than
15999 one identical command as a result of ETRN in an SMTP connection. See
16000 section &<<SECTETRN>>& for details.
16001
16002
16003 .option smtp_load_reserve main fixed-point unset
16004 .cindex "load average"
16005 If the system load average ever gets higher than this, incoming SMTP calls are
16006 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16007 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16008 the load is over the limit. The option has no effect on ancient operating
16009 systems on which Exim cannot determine the load average. See also
16010 &%deliver_queue_load_max%& and &%queue_only_load%&.
16011
16012
16013
16014 .option smtp_max_synprot_errors main integer 3
16015 .cindex "SMTP" "limiting syntax and protocol errors"
16016 .cindex "limit" "SMTP syntax and protocol errors"
16017 Exim rejects SMTP commands that contain syntax or protocol errors. In
16018 particular, a syntactically invalid email address, as in this command:
16019 .code
16020 RCPT TO:<abc xyz@a.b.c>
16021 .endd
16022 causes immediate rejection of the command, before any other tests are done.
16023 (The ACL cannot be run if there is no valid address to set up for it.) An
16024 example of a protocol error is receiving RCPT before MAIL. If there are
16025 too many syntax or protocol errors in one SMTP session, the connection is
16026 dropped. The limit is set by this option.
16027
16028 .cindex "PIPELINING" "expected errors"
16029 When the PIPELINING extension to SMTP is in use, some protocol errors are
16030 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16031 Exim assumes that PIPELINING will be used if it advertises it (see
16032 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16033 not count towards the limit.
16034
16035
16036
16037 .option smtp_max_unknown_commands main integer 3
16038 .cindex "SMTP" "limiting unknown commands"
16039 .cindex "limit" "unknown SMTP commands"
16040 If there are too many unrecognized commands in an incoming SMTP session, an
16041 Exim server drops the connection. This is a defence against some kinds of abuse
16042 that subvert web
16043 clients
16044 into making connections to SMTP ports; in these circumstances, a number of
16045 non-SMTP command lines are sent first.
16046
16047
16048
16049 .option smtp_ratelimit_hosts main "host list&!!" unset
16050 .cindex "SMTP" "rate limiting"
16051 .cindex "limit" "rate of message arrival"
16052 .cindex "RCPT" "rate limiting"
16053 Some sites find it helpful to be able to limit the rate at which certain hosts
16054 can send them messages, and the rate at which an individual message can specify
16055 recipients.
16056
16057 Exim has two rate-limiting facilities. This section describes the older
16058 facility, which can limit rates within a single connection. The newer
16059 &%ratelimit%& ACL condition can limit rates across all connections. See section
16060 &<<SECTratelimiting>>& for details of the newer facility.
16061
16062 When a host matches &%smtp_ratelimit_hosts%&, the values of
16063 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16064 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16065 respectively. Each option, if set, must contain a set of four comma-separated
16066 values:
16067
16068 .ilist
16069 A threshold, before which there is no rate limiting.
16070 .next
16071 An initial time delay. Unlike other times in Exim, numbers with decimal
16072 fractional parts are allowed here.
16073 .next
16074 A factor by which to increase the delay each time.
16075 .next
16076 A maximum value for the delay. This should normally be less than 5 minutes,
16077 because after that time, the client is liable to timeout the SMTP command.
16078 .endlist
16079
16080 For example, these settings have been used successfully at the site which
16081 first suggested this feature, for controlling mail from their customers:
16082 .code
16083 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16084 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16085 .endd
16086 The first setting specifies delays that are applied to MAIL commands after
16087 two have been received over a single connection. The initial delay is 0.5
16088 seconds, increasing by a factor of 1.05 each time. The second setting applies
16089 delays to RCPT commands when more than four occur in a single message.
16090
16091
16092 .option smtp_ratelimit_mail main string unset
16093 See &%smtp_ratelimit_hosts%& above.
16094
16095
16096 .option smtp_ratelimit_rcpt main string unset
16097 See &%smtp_ratelimit_hosts%& above.
16098
16099
16100 .option smtp_receive_timeout main time&!! 5m
16101 .cindex "timeout" "for SMTP input"
16102 .cindex "SMTP" "input timeout"
16103 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16104 input, including batch SMTP. If a line of input (either an SMTP command or a
16105 data line) is not received within this time, the SMTP connection is dropped and
16106 the message is abandoned.
16107 A line is written to the log containing one of the following messages:
16108 .code
16109 SMTP command timeout on connection from...
16110 SMTP data timeout on connection from...
16111 .endd
16112 The former means that Exim was expecting to read an SMTP command; the latter
16113 means that it was in the DATA phase, reading the contents of a message.
16114
16115 If the first character of the option is a &"$"& the option is
16116 expanded before use and may depend on
16117 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16118
16119
16120 .oindex "&%-os%&"
16121 The value set by this option can be overridden by the
16122 &%-os%& command-line option. A setting of zero time disables the timeout, but
16123 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16124 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16125 timeout is controlled by &%receive_timeout%& and &%-or%&.
16126
16127
16128 .option smtp_reserve_hosts main "host list&!!" unset
16129 This option defines hosts for which SMTP connections are reserved; see
16130 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16131
16132
16133 .option smtp_return_error_details main boolean false
16134 .cindex "SMTP" "details policy failures"
16135 .cindex "policy control" "rejection, returning details"
16136 In the default state, Exim uses bland messages such as
16137 &"Administrative prohibition"& when it rejects SMTP commands for policy
16138 reasons. Many sysadmins like this because it gives away little information
16139 to spammers. However, some other sysadmins who are applying strict checking
16140 policies want to give out much fuller information about failures. Setting
16141 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16142 example, instead of &"Administrative prohibition"&, it might give:
16143 .code
16144 550-Rejected after DATA: '>' missing at end of address:
16145 550 failing address in "From" header is: <user@dom.ain
16146 .endd
16147
16148 .option spamd_address main string "see below"
16149 This option is available when Exim is compiled with the content-scanning
16150 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16151 The default value is
16152 .code
16153 127.0.0.1 783
16154 .endd
16155 See section &<<SECTscanspamass>>& for more details.
16156
16157
16158
16159 .option split_spool_directory main boolean false
16160 .cindex "multiple spool directories"
16161 .cindex "spool directory" "split"
16162 .cindex "directories, multiple"
16163 If this option is set, it causes Exim to split its input directory into 62
16164 subdirectories, each with a single alphanumeric character as its name. The
16165 sixth character of the message id is used to allocate messages to
16166 subdirectories; this is the least significant base-62 digit of the time of
16167 arrival of the message.
16168
16169 Splitting up the spool in this way may provide better performance on systems
16170 where there are long mail queues, by reducing the number of files in any one
16171 directory. The msglog directory is also split up in a similar way to the input
16172 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16173 are still placed in the single directory &_msglog.OLD_&.
16174
16175 It is not necessary to take any special action for existing messages when
16176 changing &%split_spool_directory%&. Exim notices messages that are in the
16177 &"wrong"& place, and continues to process them. If the option is turned off
16178 after a period of being on, the subdirectories will eventually empty and be
16179 automatically deleted.
16180
16181 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16182 changes. Instead of creating a list of all messages in the queue, and then
16183 trying to deliver each one in turn, it constructs a list of those in one
16184 sub-directory and tries to deliver them, before moving on to the next
16185 sub-directory. The sub-directories are processed in a random order. This
16186 spreads out the scanning of the input directories, and uses less memory. It is
16187 particularly beneficial when there are lots of messages on the queue. However,
16188 if &%queue_run_in_order%& is set, none of this new processing happens. The
16189 entire queue has to be scanned and sorted before any deliveries can start.
16190
16191
16192 .option spool_directory main string&!! "set at compile time"
16193 .cindex "spool directory" "path to"
16194 This defines the directory in which Exim keeps its spool, that is, the messages
16195 it is waiting to deliver. The default value is taken from the compile-time
16196 configuration setting, if there is one. If not, this option must be set. The
16197 string is expanded, so it can contain, for example, a reference to
16198 &$primary_hostname$&.
16199
16200 If the spool directory name is fixed on your installation, it is recommended
16201 that you set it at build time rather than from this option, particularly if the
16202 log files are being written to the spool directory (see &%log_file_path%&).
16203 Otherwise log files cannot be used for errors that are detected early on, such
16204 as failures in the configuration file.
16205
16206 By using this option to override the compiled-in path, it is possible to run
16207 tests of Exim without using the standard spool.
16208
16209 .option sqlite_lock_timeout main time 5s
16210 .cindex "sqlite lookup type" "lock timeout"
16211 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16212 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16213
16214 .option strict_acl_vars main boolean false
16215 .cindex "&ACL;" "variables, handling unset"
16216 This option controls what happens if a syntactically valid but undefined ACL
16217 variable is referenced. If it is false (the default), an empty string
16218 is substituted; if it is true, an error is generated. See section
16219 &<<SECTaclvariables>>& for details of ACL variables.
16220
16221 .option strip_excess_angle_brackets main boolean false
16222 .cindex "angle brackets, excess"
16223 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16224 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16225 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16226 passed on to another MTA, the excess angle brackets are not passed on. If this
16227 option is not set, multiple pairs of angle brackets cause a syntax error.
16228
16229
16230 .option strip_trailing_dot main boolean false
16231 .cindex "trailing dot on domain"
16232 .cindex "dot" "trailing on domain"
16233 If this option is set, a trailing dot at the end of a domain in an address is
16234 ignored. If this is in the envelope and the message is passed on to another
16235 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16236 domain causes a syntax error.
16237 However, addresses in header lines are checked only when an ACL requests header
16238 syntax checking.
16239
16240
16241 .option syslog_duplication main boolean true
16242 .cindex "syslog" "duplicate log lines; suppressing"
16243 When Exim is logging to syslog, it writes the log lines for its three
16244 separate logs at different syslog priorities so that they can in principle
16245 be separated on the logging hosts. Some installations do not require this
16246 separation, and in those cases, the duplication of certain log lines is a
16247 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16248 particular log line is written to syslog. For lines that normally go to
16249 both the main log and the reject log, the reject log version (possibly
16250 containing message header lines) is written, at LOG_NOTICE priority.
16251 Lines that normally go to both the main and the panic log are written at
16252 the LOG_ALERT priority.
16253
16254
16255 .option syslog_facility main string unset
16256 .cindex "syslog" "facility; setting"
16257 This option sets the syslog &"facility"& name, used when Exim is logging to
16258 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16259 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16260 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16261 details of Exim's logging.
16262
16263
16264
16265 .option syslog_processname main string &`exim`&
16266 .cindex "syslog" "process name; setting"
16267 This option sets the syslog &"ident"& name, used when Exim is logging to
16268 syslog. The value must be no longer than 32 characters. See chapter
16269 &<<CHAPlog>>& for details of Exim's logging.
16270
16271
16272
16273 .option syslog_timestamp main boolean true
16274 .cindex "syslog" "timestamps"
16275 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16276 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16277 details of Exim's logging.
16278
16279
16280 .option system_filter main string&!! unset
16281 .cindex "filter" "system filter"
16282 .cindex "system filter" "specifying"
16283 .cindex "Sieve filter" "not available for system filter"
16284 This option specifies an Exim filter file that is applied to all messages at
16285 the start of each delivery attempt, before any routing is done. System filters
16286 must be Exim filters; they cannot be Sieve filters. If the system filter
16287 generates any deliveries to files or pipes, or any new mail messages, the
16288 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16289 which transports are to be used. Details of this facility are given in chapter
16290 &<<CHAPsystemfilter>>&.
16291
16292
16293 .option system_filter_directory_transport main string&!! unset
16294 .vindex "&$address_file$&"
16295 This sets the name of the transport driver that is to be used when the
16296 &%save%& command in a system message filter specifies a path ending in &"/"&,
16297 implying delivery of each message into a separate file in some directory.
16298 During the delivery, the variable &$address_file$& contains the path name.
16299
16300
16301 .option system_filter_file_transport main string&!! unset
16302 .cindex "file" "transport for system filter"
16303 This sets the name of the transport driver that is to be used when the &%save%&
16304 command in a system message filter specifies a path not ending in &"/"&. During
16305 the delivery, the variable &$address_file$& contains the path name.
16306
16307 .option system_filter_group main string unset
16308 .cindex "gid (group id)" "system filter"
16309 This option is used only when &%system_filter_user%& is also set. It sets the
16310 gid under which the system filter is run, overriding any gid that is associated
16311 with the user. The value may be numerical or symbolic.
16312
16313 .option system_filter_pipe_transport main string&!! unset
16314 .cindex "&(pipe)& transport" "for system filter"
16315 .vindex "&$address_pipe$&"
16316 This specifies the transport driver that is to be used when a &%pipe%& command
16317 is used in a system filter. During the delivery, the variable &$address_pipe$&
16318 contains the pipe command.
16319
16320
16321 .option system_filter_reply_transport main string&!! unset
16322 .cindex "&(autoreply)& transport" "for system filter"
16323 This specifies the transport driver that is to be used when a &%mail%& command
16324 is used in a system filter.
16325
16326
16327 .option system_filter_user main string unset
16328 .cindex "uid (user id)" "system filter"
16329 If this option is set to root, the system filter is run in the main Exim
16330 delivery process, as root.  Otherwise, the system filter runs in a separate
16331 process, as the given user, defaulting to the Exim run-time user.
16332 Unless the string consists entirely of digits, it
16333 is looked up in the password data. Failure to find the named user causes a
16334 configuration error. The gid is either taken from the password data, or
16335 specified by &%system_filter_group%&. When the uid is specified numerically,
16336 &%system_filter_group%& is required to be set.
16337
16338 If the system filter generates any pipe, file, or reply deliveries, the uid
16339 under which the filter is run is used when transporting them, unless a
16340 transport option overrides.
16341
16342
16343 .option tcp_nodelay main boolean true
16344 .cindex "daemon" "TCP_NODELAY on sockets"
16345 .cindex "Nagle algorithm"
16346 .cindex "TCP_NODELAY on listening sockets"
16347 If this option is set false, it stops the Exim daemon setting the
16348 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16349 turns off the &"Nagle algorithm"&, which is a way of improving network
16350 performance in interactive (character-by-character) situations. Turning it off
16351 should improve Exim's performance a bit, so that is what happens by default.
16352 However, it appears that some broken clients cannot cope, and time out. Hence
16353 this option. It affects only those sockets that are set up for listening by the
16354 daemon. Sockets created by the smtp transport for delivering mail always set
16355 TCP_NODELAY.
16356
16357
16358 .option timeout_frozen_after main time 0s
16359 .cindex "frozen messages" "timing out"
16360 .cindex "timeout" "frozen messages"
16361 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16362 message of any kind that has been on the queue for longer than the given time
16363 is automatically cancelled at the next queue run. If the frozen message is a
16364 bounce message, it is just discarded; otherwise, a bounce is sent to the
16365 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16366 If you want to timeout frozen bounce messages earlier than other kinds of
16367 frozen message, see &%ignore_bounce_errors_after%&.
16368
16369 &*Note:*& the default value of zero means no timeouts; with this setting,
16370 frozen messages remain on the queue forever (except for any frozen bounce
16371 messages that are released by &%ignore_bounce_errors_after%&).
16372
16373
16374 .option timezone main string unset
16375 .cindex "timezone, setting"
16376 The value of &%timezone%& is used to set the environment variable TZ while
16377 running Exim (if it is different on entry). This ensures that all timestamps
16378 created by Exim are in the required timezone. If you want all your timestamps
16379 to be in UTC (aka GMT) you should set
16380 .code
16381 timezone = UTC
16382 .endd
16383 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16384 or, if that is not set, from the value of the TZ environment variable when Exim
16385 is built. If &%timezone%& is set to the empty string, either at build or run
16386 time, any existing TZ variable is removed from the environment when Exim
16387 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16388 unfortunately not all, operating systems.
16389
16390
16391 .option tls_advertise_hosts main "host list&!!" unset
16392 .cindex "TLS" "advertising"
16393 .cindex "encryption" "on SMTP connection"
16394 .cindex "SMTP" "encrypted connection"
16395 When Exim is built with support for TLS encrypted connections, the availability
16396 of the STARTTLS command to set up an encrypted session is advertised in
16397 response to EHLO only to those client hosts that match this option. See
16398 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16399
16400
16401 .option tls_certificate main string&!! unset
16402 .cindex "TLS" "server certificate; location of"
16403 .cindex "certificate" "server, location of"
16404 The value of this option is expanded, and must then be the absolute path to a
16405 file which contains the server's certificates. The server's private key is also
16406 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16407 &<<CHAPTLS>>& for further details.
16408
16409 &*Note*&: The certificates defined by this option are used only when Exim is
16410 receiving incoming messages as a server. If you want to supply certificates for
16411 use when sending messages as a client, you must set the &%tls_certificate%&
16412 option in the relevant &(smtp)& transport.
16413
16414 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16415 if the OpenSSL build supports TLS extensions and the TLS client sends the
16416 Server Name Indication extension, then this option and others documented in
16417 &<<SECTtlssni>>& will be re-expanded.
16418
16419 .option tls_crl main string&!! unset
16420 .cindex "TLS" "server certificate revocation list"
16421 .cindex "certificate" "revocation list for server"
16422 This option specifies a certificate revocation list. The expanded value must
16423 be the name of a file that contains a CRL in PEM format.
16424
16425 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16426
16427
16428 .option tls_dh_max_bits main integer 2236
16429 .cindex "TLS" "D-H bit count"
16430 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16431 the chosen TLS library.  That value might prove to be too high for
16432 interoperability.  This option provides a maximum clamp on the value
16433 suggested, trading off security for interoperability.
16434
16435 The value must be at least 1024.
16436
16437 The value 2236 was chosen because, at time of adding the option, it was the
16438 hard-coded maximum value supported by the NSS cryptographic library, as used
16439 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16440
16441 If you prefer more security and are willing to break some clients, raise this
16442 number.
16443
16444 Note that the value passed to GnuTLS for *generating* a new prime may be a
16445 little less than this figure, because GnuTLS is inexact and may produce a
16446 larger prime than requested.
16447
16448
16449 .option tls_dhparam main string&!! unset
16450 .cindex "TLS" "D-H parameters for server"
16451 The value of this option is expanded and indicates the source of DH parameters
16452 to be used by Exim.
16453
16454 If it is a filename starting with a &`/`&, then it names a file from which DH
16455 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16456 PKCS#3 representation of the DH prime.  If the file does not exist, for
16457 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16458 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16459 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16460 and treated as though the &%tls_dhparam%& were set to "none".
16461
16462 If this option expands to the string "none", then no DH parameters will be
16463 loaded by Exim.
16464
16465 If this option expands to the string "historic" and Exim is using GnuTLS, then
16466 Exim will attempt to load a file from inside the spool directory.  If the file
16467 does not exist, Exim will attempt to create it.
16468 See section &<<SECTgnutlsparam>>& for further details.
16469
16470 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16471 a default DH prime; the default is the 2048 bit prime described in section
16472 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16473 in IKE is assigned number 23.
16474
16475 Otherwise, the option must expand to the name used by Exim for any of a number
16476 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16477 "ike" followed by the number used by IKE, of "default" which corresponds to
16478 "ike23".
16479
16480 The available primes are:
16481 &`ike1`&, &`ike2`&, &`ike5`&,
16482 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16483 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16484
16485 Some of these will be too small to be accepted by clients.
16486 Some may be too large to be accepted by clients.
16487
16488 The TLS protocol does not negotiate an acceptable size for this; clients tend
16489 to hard-drop connections if what is offered by the server is unacceptable,
16490 whether too large or too small, and there's no provision for the client to
16491 tell the server what these constraints are.  Thus, as a server operator, you
16492 need to make an educated guess as to what is most likely to work for your
16493 userbase.
16494
16495 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16496 is most likely to maximise interoperability.  The upper bound comes from
16497 applications using the Mozilla Network Security Services (NSS) library, which
16498 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16499 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16500 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16501 acceptable bound from 1024 to 2048.
16502
16503
16504 .option tls_ocsp_file main string&!! unset
16505 This option
16506 must if set expand to the absolute path to a file which contains a current
16507 status proof for the server's certificate, as obtained from the
16508 Certificate Authority.
16509
16510
16511 .option tls_on_connect_ports main "string list" unset
16512 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16513 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16514 set up without waiting for the client to issue a STARTTLS command. For
16515 further details, see section &<<SECTsupobssmt>>&.
16516
16517
16518
16519 .option tls_privatekey main string&!! unset
16520 .cindex "TLS" "server private key; location of"
16521 The value of this option is expanded, and must then be the absolute path to a
16522 file which contains the server's private key. If this option is unset, or if
16523 the expansion is forced to fail, or the result is an empty string, the private
16524 key is assumed to be in the same file as the server's certificates. See chapter
16525 &<<CHAPTLS>>& for further details.
16526
16527 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16528
16529
16530 .option tls_remember_esmtp main boolean false
16531 .cindex "TLS" "esmtp state; remembering"
16532 .cindex "TLS" "broken clients"
16533 If this option is set true, Exim violates the RFCs by remembering that it is in
16534 &"esmtp"& state after successfully negotiating a TLS session. This provides
16535 support for broken clients that fail to send a new EHLO after starting a
16536 TLS session.
16537
16538
16539 .option tls_require_ciphers main string&!! unset
16540 .cindex "TLS" "requiring specific ciphers"
16541 .cindex "cipher" "requiring specific"
16542 This option controls which ciphers can be used for incoming TLS connections.
16543 The &(smtp)& transport has an option of the same name for controlling outgoing
16544 connections. This option is expanded for each connection, so can be varied for
16545 different clients if required. The value of this option must be a list of
16546 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16547 in somewhat different ways. If GnuTLS is being used, the client controls the
16548 preference order of the available ciphers. Details are given in sections
16549 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16550
16551
16552 .option tls_try_verify_hosts main "host list&!!" unset
16553 .cindex "TLS" "client certificate verification"
16554 .cindex "certificate" "verification of client"
16555 See &%tls_verify_hosts%& below.
16556
16557
16558 .new
16559 .option tls_verify_certificates main string&!! system
16560 .cindex "TLS" "client certificate verification"
16561 .cindex "certificate" "verification of client"
16562 The value of this option is expanded, and must then be either the
16563 word "system"
16564 or the absolute path to
16565 a file or directory containing permitted certificates for clients that
16566 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16567
16568 The "system" value for the option will use a
16569 system default location compiled into the SSL library.
16570 This is not available for GnuTLS versions preceding 3.0.20,
16571 and will be taken as empty; an explicit location
16572 must be specified.
16573
16574 The use of a directory for the option value is not avilable for GnuTLS versions
16575 preceding 3.3.6 and a single file must be used.
16576
16577 With OpenSSL the certificates specified
16578 explicitly
16579 either by file or directory
16580 are added to those given by the system default location.
16581 .wen
16582
16583 These certificates should be for the certificate authorities trusted, rather
16584 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16585 the value is a file then the certificates are sent by Exim as a server to
16586 connecting clients, defining the list of accepted certificate authorities.
16587 Thus the values defined should be considered public data.  To avoid this,
16588 use the explicit directory version.
16589
16590 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16591
16592 A forced expansion failure or setting to an empty string is equivalent to
16593 being unset.
16594
16595
16596 .option tls_verify_hosts main "host list&!!" unset
16597 .cindex "TLS" "client certificate verification"
16598 .cindex "certificate" "verification of client"
16599 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16600 certificates from clients. The expected certificates are defined by
16601 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16602 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16603 &%tls_verify_certificates%& is not set.
16604
16605 Any client that matches &%tls_verify_hosts%& is constrained by
16606 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16607 present one of the listed certificates. If it does not, the connection is
16608 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16609 the host to use TLS. It can still send SMTP commands through unencrypted
16610 connections. Forcing a client to use TLS has to be done separately using an
16611 ACL to reject inappropriate commands when the connection is not encrypted.
16612
16613 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16614 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16615 certificate and checks it against &%tls_verify_certificates%&, but does not
16616 abort the connection if there is no certificate or if it does not match. This
16617 state can be detected in an ACL, which makes it possible to implement policies
16618 such as &"accept for relay only if a verified certificate has been received,
16619 but accept for local delivery if encrypted, even without a verified
16620 certificate"&.
16621
16622 Client hosts that match neither of these lists are not asked to present
16623 certificates.
16624
16625
16626 .option trusted_groups main "string list&!!" unset
16627 .cindex "trusted groups"
16628 .cindex "groups" "trusted"
16629 This option is expanded just once, at the start of Exim's processing. If this
16630 option is set, any process that is running in one of the listed groups, or
16631 which has one of them as a supplementary group, is trusted. The groups can be
16632 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16633 details of what trusted callers are permitted to do. If neither
16634 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16635 are trusted.
16636
16637 .option trusted_users main "string list&!!" unset
16638 .cindex "trusted users"
16639 .cindex "user" "trusted"
16640 This option is expanded just once, at the start of Exim's processing. If this
16641 option is set, any process that is running as one of the listed users is
16642 trusted. The users can be specified numerically or by name. See section
16643 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16644 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16645 Exim user are trusted.
16646
16647 .option unknown_login main string&!! unset
16648 .cindex "uid (user id)" "unknown caller"
16649 .vindex "&$caller_uid$&"
16650 This is a specialized feature for use in unusual configurations. By default, if
16651 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16652 gives up. The &%unknown_login%& option can be used to set a login name to be
16653 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16654 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16655 is used for the user's real name (gecos field), unless this has been set by the
16656 &%-F%& option.
16657
16658 .option unknown_username main string unset
16659 See &%unknown_login%&.
16660
16661 .option untrusted_set_sender main "address list&!!" unset
16662 .cindex "trusted users"
16663 .cindex "sender" "setting by untrusted user"
16664 .cindex "untrusted user setting sender"
16665 .cindex "user" "untrusted setting sender"
16666 .cindex "envelope sender"
16667 When an untrusted user submits a message to Exim using the standard input, Exim
16668 normally creates an envelope sender address from the user's login and the
16669 default qualification domain. Data from the &%-f%& option (for setting envelope
16670 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16671 is used) is ignored.
16672
16673 However, untrusted users are permitted to set an empty envelope sender address,
16674 to declare that a message should never generate any bounces. For example:
16675 .code
16676 exim -f '<>' user@domain.example
16677 .endd
16678 .vindex "&$sender_ident$&"
16679 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16680 other envelope sender addresses in a controlled way. When it is set, untrusted
16681 users are allowed to set envelope sender addresses that match any of the
16682 patterns in the list. Like all address lists, the string is expanded. The
16683 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16684 users to setting senders that start with their login ids
16685 followed by a hyphen
16686 by a setting like this:
16687 .code
16688 untrusted_set_sender = ^$sender_ident-
16689 .endd
16690 If you want to allow untrusted users to set envelope sender addresses without
16691 restriction, you can use
16692 .code
16693 untrusted_set_sender = *
16694 .endd
16695 The &%untrusted_set_sender%& option applies to all forms of local input, but
16696 only to the setting of the envelope sender. It does not permit untrusted users
16697 to use the other options which trusted user can use to override message
16698 parameters. Furthermore, it does not stop Exim from removing an existing
16699 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16700 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16701 overriding these actions. The handling of the &'Sender:'& header is also
16702 described in section &<<SECTthesenhea>>&.
16703
16704 The log line for a message's arrival shows the envelope sender following
16705 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16706 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16707 envelope sender address, the user's login is shown in parentheses after the
16708 sender address.
16709
16710
16711 .option uucp_from_pattern main string "see below"
16712 .cindex "&""From""& line"
16713 .cindex "UUCP" "&""From""& line"
16714 Some applications that pass messages to an MTA via a command line interface use
16715 an initial line starting with &"From&~"& to pass the envelope sender. In
16716 particular, this is used by UUCP software. Exim recognizes such a line by means
16717 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16718 matches, the sender address is constructed by expanding the contents of
16719 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16720 default pattern recognizes lines in the following two forms:
16721 .code
16722 From ph10 Fri Jan  5 12:35 GMT 1996
16723 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16724 .endd
16725 The pattern can be seen by running
16726 .code
16727 exim -bP uucp_from_pattern
16728 .endd
16729 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16730 year in the second case. The first word after &"From&~"& is matched in the
16731 regular expression by a parenthesized subpattern. The default value for
16732 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16733 (&"ph10"& in the example above) as the message's sender. See also
16734 &%ignore_fromline_hosts%&.
16735
16736
16737 .option uucp_from_sender main string&!! &`$1`&
16738 See &%uucp_from_pattern%& above.
16739
16740
16741 .option warn_message_file main string unset
16742 .cindex "warning of delay" "customizing the message"
16743 .cindex "customizing" "warning message"
16744 This option defines a template file containing paragraphs of text to be used
16745 for constructing the warning message which is sent by Exim when a message has
16746 been on the queue for a specified amount of time, as specified by
16747 &%delay_warning%&. Details of the file's contents are given in chapter
16748 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16749
16750
16751 .option write_rejectlog main boolean true
16752 .cindex "reject log" "disabling"
16753 If this option is set false, Exim no longer writes anything to the reject log.
16754 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16755 .ecindex IIDconfima
16756 .ecindex IIDmaiconf
16757
16758
16759
16760
16761 . ////////////////////////////////////////////////////////////////////////////
16762 . ////////////////////////////////////////////////////////////////////////////
16763
16764 .chapter "Generic options for routers" "CHAProutergeneric"
16765 .scindex IIDgenoprou1 "options" "generic; for routers"
16766 .scindex IIDgenoprou2 "generic options" "router"
16767 This chapter describes the generic options that apply to all routers.
16768 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16769
16770 For a general description of how a router operates, see sections
16771 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16772 which the preconditions are tested. The order of expansion of the options that
16773 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16774 &%headers_remove%&, &%transport%&.
16775
16776
16777
16778 .option address_data routers string&!! unset
16779 .cindex "router" "data attached to address"
16780 The string is expanded just before the router is run, that is, after all the
16781 precondition tests have succeeded. If the expansion is forced to fail, the
16782 router declines, the value of &%address_data%& remains unchanged, and the
16783 &%more%& option controls what happens next. Other expansion failures cause
16784 delivery of the address to be deferred.
16785
16786 .vindex "&$address_data$&"
16787 When the expansion succeeds, the value is retained with the address, and can be
16788 accessed using the variable &$address_data$& in the current router, subsequent
16789 routers, and the eventual transport.
16790
16791 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16792 that runs a user's filter file, the contents of &$address_data$& are accessible
16793 in the filter. This is not normally a problem, because such data is usually
16794 either not confidential or it &"belongs"& to the current user, but if you do
16795 put confidential data into &$address_data$& you need to remember this point.
16796
16797 Even if the router declines or passes, the value of &$address_data$& remains
16798 with the address, though it can be changed by another &%address_data%& setting
16799 on a subsequent router. If a router generates child addresses, the value of
16800 &$address_data$& propagates to them. This also applies to the special kind of
16801 &"child"& that is generated by a router with the &%unseen%& option.
16802
16803 The idea of &%address_data%& is that you can use it to look up a lot of data
16804 for the address once, and then pick out parts of the data later. For example,
16805 you could use a single LDAP lookup to return a string of the form
16806 .code
16807 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16808 .endd
16809 In the transport you could pick out the mailbox by a setting such as
16810 .code
16811 file = ${extract{mailbox}{$address_data}}
16812 .endd
16813 This makes the configuration file less messy, and also reduces the number of
16814 lookups (though Exim does cache lookups).
16815
16816 .vindex "&$sender_address_data$&"
16817 .vindex "&$address_data$&"
16818 The &%address_data%& facility is also useful as a means of passing information
16819 from one router to another, and from a router to a transport. In addition, if
16820 &$address_data$& is set by a router when verifying a recipient address from an
16821 ACL, it remains available for use in the rest of the ACL statement. After
16822 verifying a sender, the value is transferred to &$sender_address_data$&.
16823
16824
16825
16826 .option address_test routers&!? boolean true
16827 .oindex "&%-bt%&"
16828 .cindex "router" "skipping when address testing"
16829 If this option is set false, the router is skipped when routing is being tested
16830 by means of the &%-bt%& command line option. This can be a convenience when
16831 your first router sends messages to an external scanner, because it saves you
16832 having to set the &"already scanned"& indicator when testing real address
16833 routing.
16834
16835
16836
16837 .option cannot_route_message routers string&!! unset
16838 .cindex "router" "customizing &""cannot route""& message"
16839 .cindex "customizing" "&""cannot route""& message"
16840 This option specifies a text message that is used when an address cannot be
16841 routed because Exim has run out of routers. The default message is
16842 &"Unrouteable address"&. This option is useful only on routers that have
16843 &%more%& set false, or on the very last router in a configuration, because the
16844 value that is used is taken from the last router that is considered. This
16845 includes a router that is skipped because its preconditions are not met, as
16846 well as a router that declines. For example, using the default configuration,
16847 you could put:
16848 .code
16849 cannot_route_message = Remote domain not found in DNS
16850 .endd
16851 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16852 and
16853 .code
16854 cannot_route_message = Unknown local user
16855 .endd
16856 on the final router that checks for local users. If string expansion fails for
16857 this option, the default message is used. Unless the expansion failure was
16858 explicitly forced, a message about the failure is written to the main and panic
16859 logs, in addition to the normal message about the routing failure.
16860
16861
16862 .option caseful_local_part routers boolean false
16863 .cindex "case of local parts"
16864 .cindex "router" "case of local parts"
16865 By default, routers handle the local parts of addresses in a case-insensitive
16866 manner, though the actual case is preserved for transmission with the message.
16867 If you want the case of letters to be significant in a router, you must set
16868 this option true. For individual router options that contain address or local
16869 part lists (for example, &%local_parts%&), case-sensitive matching can be
16870 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16871 more details.
16872
16873 .vindex "&$local_part$&"
16874 .vindex "&$original_local_part$&"
16875 .vindex "&$parent_local_part$&"
16876 The value of the &$local_part$& variable is forced to lower case while a
16877 router is running unless &%caseful_local_part%& is set. When a router assigns
16878 an address to a transport, the value of &$local_part$& when the transport runs
16879 is the same as it was in the router. Similarly, when a router generates child
16880 addresses by aliasing or forwarding, the values of &$original_local_part$&
16881 and &$parent_local_part$& are those that were used by the redirecting router.
16882
16883 This option applies to the processing of an address by a router. When a
16884 recipient address is being processed in an ACL, there is a separate &%control%&
16885 modifier that can be used to specify case-sensitive processing within the ACL
16886 (see section &<<SECTcontrols>>&).
16887
16888
16889
16890 .option check_local_user routers&!? boolean false
16891 .cindex "local user, checking in router"
16892 .cindex "router" "checking for local user"
16893 .cindex "&_/etc/passwd_&"
16894 .vindex "&$home$&"
16895 When this option is true, Exim checks that the local part of the recipient
16896 address (with affixes removed if relevant) is the name of an account on the
16897 local system. The check is done by calling the &[getpwnam()]& function rather
16898 than trying to read &_/etc/passwd_& directly. This means that other methods of
16899 holding password data (such as NIS) are supported. If the local part is a local
16900 user, &$home$& is set from the password data, and can be tested in other
16901 preconditions that are evaluated after this one (the order of evaluation is
16902 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16903 overridden by &%router_home_directory%&. If the local part is not a local user,
16904 the router is skipped.
16905
16906 If you want to check that the local part is either the name of a local user
16907 or matches something else, you cannot combine &%check_local_user%& with a
16908 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16909 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16910 setting to achieve this. For example:
16911 .code
16912 local_parts = passwd;$local_part : lsearch;/etc/other/users
16913 .endd
16914 Note, however, that the side effects of &%check_local_user%& (such as setting
16915 up a home directory) do not occur when a &(passwd)& lookup is used in a
16916 &%local_parts%& (or any other) precondition.
16917
16918
16919
16920 .option condition routers&!? string&!! unset
16921 .cindex "router" "customized precondition"
16922 This option specifies a general precondition test that has to succeed for the
16923 router to be called. The &%condition%& option is the last precondition to be
16924 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16925 result is a forced failure, or an empty string, or one of the strings &"0"& or
16926 &"no"& or &"false"& (checked without regard to the case of the letters), the
16927 router is skipped, and the address is offered to the next one.
16928
16929 If the result is any other value, the router is run (as this is the last
16930 precondition to be evaluated, all the other preconditions must be true).
16931
16932 This option is unusual in that multiple &%condition%& options may be present.
16933 All &%condition%& options must succeed.
16934
16935 The &%condition%& option provides a means of applying custom conditions to the
16936 running of routers. Note that in the case of a simple conditional expansion,
16937 the default expansion values are exactly what is wanted. For example:
16938 .code
16939 condition = ${if >{$message_age}{600}}
16940 .endd
16941 Because of the default behaviour of the string expansion, this is equivalent to
16942 .code
16943 condition = ${if >{$message_age}{600}{true}{}}
16944 .endd
16945
16946 A multiple condition example, which succeeds:
16947 .code
16948 condition = ${if >{$message_age}{600}}
16949 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16950 condition = foobar
16951 .endd
16952
16953 If the expansion fails (other than forced failure) delivery is deferred. Some
16954 of the other precondition options are common special cases that could in fact
16955 be specified using &%condition%&.
16956
16957 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16958 are far older, and use one set of semantics.  ACLs are newer and when
16959 they were created, the ACL &%condition%& process was given far stricter
16960 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
16961 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
16962 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
16963 Router rules processing behavior.
16964
16965 This is best illustrated in an example:
16966 .code
16967 # If used in an ACL condition will fail with a syntax error, but
16968 # in a router condition any extra characters are treated as a string
16969
16970 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16971 true {yes} {no}}
16972
16973 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16974  {yes} {no}}
16975 .endd
16976 In each example above, the &%if%& statement actually ends after
16977 &"{google.com}}"&.  Since no true or false braces were defined, the
16978 default &%if%& behavior is to return a boolean true or a null answer
16979 (which evaluates to false). The rest of the line is then treated as a
16980 string. So the first example resulted in the boolean answer &"true"&
16981 with the string &" {yes} {no}}"& appended to it. The second example
16982 resulted in the null output (indicating false) with the string
16983 &" {yes} {no}}"& appended to it.
16984
16985 In fact you can put excess forward braces in too.  In the router
16986 &%condition%&, Exim's parser only looks for &"{"& symbols when they
16987 mean something, like after a &"$"& or when required as part of a
16988 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16989 string characters.
16990
16991 Thus, in a Router, the above expansion strings will both always evaluate
16992 true, as the result of expansion is a non-empty string which doesn't
16993 match an explicit false value.  This can be tricky to debug.  By
16994 contrast, in an ACL either of those strings will always result in an
16995 expansion error because the result doesn't look sufficiently boolean.
16996
16997
16998 .option debug_print routers string&!! unset
16999 .cindex "testing" "variables in drivers"
17000 If this option is set and debugging is enabled (see the &%-d%& command line
17001 option) or in address-testing mode (see the &%-bt%& command line option),
17002 the string is expanded and included in the debugging output.
17003 If expansion of the string fails, the error message is written to the debugging
17004 output, and Exim carries on processing.
17005 This option is provided to help with checking out the values of variables and
17006 so on when debugging router configurations. For example, if a &%condition%&
17007 option appears not to be working, &%debug_print%& can be used to output the
17008 variables it references. The output happens after checks for &%domains%&,
17009 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17010 are tested. A newline is added to the text if it does not end with one.
17011 The variable &$router_name$& contains the name of the router.
17012
17013
17014
17015 .option disable_logging routers boolean false
17016 If this option is set true, nothing is logged for any routing errors
17017 or for any deliveries caused by this router. You should not set this option
17018 unless you really, really know what you are doing. See also the generic
17019 transport option of the same name.
17020
17021
17022 .option domains routers&!? "domain list&!!" unset
17023 .cindex "router" "restricting to specific domains"
17024 .vindex "&$domain_data$&"
17025 If this option is set, the router is skipped unless the current domain matches
17026 the list. If the match is achieved by means of a file lookup, the data that the
17027 lookup returned for the domain is placed in &$domain_data$& for use in string
17028 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17029 a list of the order in which preconditions are evaluated.
17030
17031
17032
17033 .option driver routers string unset
17034 This option must always be set. It specifies which of the available routers is
17035 to be used.
17036
17037
17038 .new
17039 .option dsn_lasthop routers boolean false
17040 .cindex "DSN" "success"
17041 .cindex "Delivery Status Notification" "success"
17042 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17043 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17044 instead send a success DSN as if the next hop does not support DSN.
17045 Not effective on redirect routers.
17046 .wen
17047
17048
17049
17050 .option errors_to routers string&!! unset
17051 .cindex "envelope sender"
17052 .cindex "router" "changing address for errors"
17053 If a router successfully handles an address, it may assign the address to a
17054 transport for delivery or it may generate child addresses. In both cases, if
17055 there is a delivery problem during later processing, the resulting bounce
17056 message is sent to the address that results from expanding this string,
17057 provided that the address verifies successfully. The &%errors_to%& option is
17058 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17059
17060 The &%errors_to%& setting associated with an address can be overridden if it
17061 subsequently passes through other routers that have their own &%errors_to%&
17062 settings, or if the message is delivered by a transport with a &%return_path%&
17063 setting.
17064
17065 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17066 the expansion fails to verify, the errors address associated with the incoming
17067 address is used. At top level, this is the envelope sender. A non-forced
17068 expansion failure causes delivery to be deferred.
17069
17070 If an address for which &%errors_to%& has been set ends up being delivered over
17071 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17072 any bounces that are generated by other MTAs on the delivery route are also
17073 sent there. You can set &%errors_to%& to the empty string by either of these
17074 settings:
17075 .code
17076 errors_to =
17077 errors_to = ""
17078 .endd
17079 An expansion item that yields an empty string has the same effect. If you do
17080 this, a locally detected delivery error for addresses processed by this router
17081 no longer gives rise to a bounce message; the error is discarded. If the
17082 address is delivered to a remote host, the return path is set to &`<>`&, unless
17083 overridden by the &%return_path%& option on the transport.
17084
17085 .vindex "&$address_data$&"
17086 If for some reason you want to discard local errors, but use a non-empty
17087 MAIL command for remote delivery, you can preserve the original return
17088 path in &$address_data$& in the router, and reinstate it in the transport by
17089 setting &%return_path%&.
17090
17091 The most common use of &%errors_to%& is to direct mailing list bounces to the
17092 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17093 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17094
17095
17096
17097 .option expn routers&!? boolean true
17098 .cindex "address" "testing"
17099 .cindex "testing" "addresses"
17100 .cindex "EXPN" "router skipping"
17101 .cindex "router" "skipping for EXPN"
17102 If this option is turned off, the router is skipped when testing an address
17103 as a result of processing an SMTP EXPN command. You might, for example,
17104 want to turn it off on a router for users' &_.forward_& files, while leaving it
17105 on for the system alias file.
17106 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17107 are evaluated.
17108
17109 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17110 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17111 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17112
17113
17114
17115 .option fail_verify routers boolean false
17116 .cindex "router" "forcing verification failure"
17117 Setting this option has the effect of setting both &%fail_verify_sender%& and
17118 &%fail_verify_recipient%& to the same value.
17119
17120
17121
17122 .option fail_verify_recipient routers boolean false
17123 If this option is true and an address is accepted by this router when
17124 verifying a recipient, verification fails.
17125
17126
17127
17128 .option fail_verify_sender routers boolean false
17129 If this option is true and an address is accepted by this router when
17130 verifying a sender, verification fails.
17131
17132
17133
17134 .option fallback_hosts routers "string list" unset
17135 .cindex "router" "fallback hosts"
17136 .cindex "fallback" "hosts specified on router"
17137 String expansion is not applied to this option. The argument must be a
17138 colon-separated list of host names or IP addresses. The list separator can be
17139 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17140 each name or address. In fact, the format of each item is exactly the same as
17141 defined for the list of hosts in a &(manualroute)& router (see section
17142 &<<SECTformatonehostitem>>&).
17143
17144 If a router queues an address for a remote transport, this host list is
17145 associated with the address, and used instead of the transport's fallback host
17146 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17147 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17148 transport for further details.
17149
17150
17151 .option group routers string&!! "see below"
17152 .cindex "gid (group id)" "local delivery"
17153 .cindex "local transports" "uid and gid"
17154 .cindex "transport" "local"
17155 .cindex "router" "setting group"
17156 When a router queues an address for a transport, and the transport does not
17157 specify a group, the group given here is used when running the delivery
17158 process.
17159 The group may be specified numerically or by name. If expansion fails, the
17160 error is logged and delivery is deferred.
17161 The default is unset, unless &%check_local_user%& is set, when the default
17162 is taken from the password information. See also &%initgroups%& and &%user%&
17163 and the discussion in chapter &<<CHAPenvironment>>&.
17164
17165
17166
17167 .option headers_add routers list&!! unset
17168 .cindex "header lines" "adding"
17169 .cindex "router" "adding header lines"
17170 This option specifies a list of text headers,
17171 .new
17172 newline-separated (by default, changeable in the usual way),
17173 .wen
17174 that is associated with any addresses that are accepted by the router.
17175 Each item is separately expanded, at routing time.  However, this
17176 option has no effect when an address is just being verified. The way in which
17177 the text is used to add header lines at transport time is described in section
17178 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17179 message is in the process of being transported. This means that references to
17180 header lines in string expansions in the transport's configuration do not
17181 &"see"& the added header lines.
17182
17183 The &%headers_add%& option is expanded after &%errors_to%&, but before
17184 &%headers_remove%& and &%transport%&. If an item is empty, or if
17185 an item expansion is forced to fail, the item has no effect. Other expansion
17186 failures are treated as configuration errors.
17187
17188 Unlike most options, &%headers_add%& can be specified multiple times
17189 for a router; all listed headers are added.
17190
17191 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17192 router that has the &%one_time%& option set.
17193
17194 .cindex "duplicate addresses"
17195 .oindex "&%unseen%&"
17196 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17197 additions are deleted when the address is passed on to subsequent routers.
17198 For a &%redirect%& router, if a generated address is the same as the incoming
17199 address, this can lead to duplicate addresses with different header
17200 modifications. Exim does not do duplicate deliveries (except, in certain
17201 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17202 which of the duplicates is discarded, so this ambiguous situation should be
17203 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17204
17205
17206
17207 .option headers_remove routers list&!! unset
17208 .cindex "header lines" "removing"
17209 .cindex "router" "removing header lines"
17210 This option specifies a list of text headers,
17211 .new
17212 colon-separated (by default, changeable in the usual way),
17213 .wen
17214 that is associated with any addresses that are accepted by the router.
17215 Each item is separately expanded, at routing time.  However, this
17216 option has no effect when an address is just being verified. The way in which
17217 the text is used to remove header lines at transport time is described in
17218 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17219 the message is in the process of being transported. This means that references
17220 to header lines in string expansions in the transport's configuration still
17221 &"see"& the original header lines.
17222
17223 The &%headers_remove%& option is expanded after &%errors_to%& and
17224 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17225 the item has no effect. Other expansion failures are treated as configuration
17226 errors.
17227
17228 Unlike most options, &%headers_remove%& can be specified multiple times
17229 for a router; all listed headers are removed.
17230
17231 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17232 router that has the &%one_time%& option set.
17233
17234 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17235 removal requests are deleted when the address is passed on to subsequent
17236 routers, and this can lead to problems with duplicates -- see the similar
17237 warning for &%headers_add%& above.
17238
17239
17240 .option ignore_target_hosts routers "host list&!!" unset
17241 .cindex "IP address" "discarding"
17242 .cindex "router" "discarding IP addresses"
17243 Although this option is a host list, it should normally contain IP address
17244 entries rather than names. If any host that is looked up by the router has an
17245 IP address that matches an item in this list, Exim behaves as if that IP
17246 address did not exist. This option allows you to cope with rogue DNS entries
17247 like
17248 .code
17249 remote.domain.example.  A  127.0.0.1
17250 .endd
17251 by setting
17252 .code
17253 ignore_target_hosts = 127.0.0.1
17254 .endd
17255 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17256 discarded in this way, the router declines. In a conventional configuration, an
17257 attempt to mail to such a domain would normally provoke the &"unrouteable
17258 domain"& error, and an attempt to verify an address in the domain would fail.
17259 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17260 router declines if presented with one of the listed addresses.
17261
17262 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17263 means of the first or the second of the following settings, respectively:
17264 .code
17265 ignore_target_hosts = 0.0.0.0/0
17266 ignore_target_hosts = <; 0::0/0
17267 .endd
17268 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17269 in the second line matches all IPv6 addresses.
17270
17271 This option may also be useful for ignoring link-local and site-local IPv6
17272 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17273 is expanded before use as a list, it is possible to make it dependent on the
17274 domain that is being routed.
17275
17276 .vindex "&$host_address$&"
17277 During its expansion, &$host_address$& is set to the IP address that is being
17278 checked.
17279
17280 .option initgroups routers boolean false
17281 .cindex "additional groups"
17282 .cindex "groups" "additional"
17283 .cindex "local transports" "uid and gid"
17284 .cindex "transport" "local"
17285 If the router queues an address for a transport, and this option is true, and
17286 the uid supplied by the router is not overridden by the transport, the
17287 &[initgroups()]& function is called when running the transport to ensure that
17288 any additional groups associated with the uid are set up. See also &%group%&
17289 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17290
17291
17292
17293 .option local_part_prefix routers&!? "string list" unset
17294 .cindex "router" "prefix for local part"
17295 .cindex "prefix" "for local part, used in router"
17296 If this option is set, the router is skipped unless the local part starts with
17297 one of the given strings, or &%local_part_prefix_optional%& is true. See
17298 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17299 evaluated.
17300
17301 The list is scanned from left to right, and the first prefix that matches is
17302 used. A limited form of wildcard is available; if the prefix begins with an
17303 asterisk, it matches the longest possible sequence of arbitrary characters at
17304 the start of the local part. An asterisk should therefore always be followed by
17305 some character that does not occur in normal local parts.
17306 .cindex "multiple mailboxes"
17307 .cindex "mailbox" "multiple"
17308 Wildcarding can be used to set up multiple user mailboxes, as described in
17309 section &<<SECTmulbox>>&.
17310
17311 .vindex "&$local_part$&"
17312 .vindex "&$local_part_prefix$&"
17313 During the testing of the &%local_parts%& option, and while the router is
17314 running, the prefix is removed from the local part, and is available in the
17315 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17316 the router accepts the address, this remains true during subsequent delivery by
17317 a transport. In particular, the local part that is transmitted in the RCPT
17318 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17319 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17320 the relevant transport.
17321
17322 When an address is being verified, &%local_part_prefix%& affects only the
17323 behaviour of the router. If the callout feature of verification is in use, this
17324 means that the full address, including the prefix, will be used during the
17325 callout.
17326
17327 The prefix facility is commonly used to handle local parts of the form
17328 &%owner-something%&. Another common use is to support local parts of the form
17329 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17330 to tell a user their forwarding is broken &-- by placing a router like this one
17331 immediately before the router that handles &_.forward_& files:
17332 .code
17333 real_localuser:
17334   driver = accept
17335   local_part_prefix = real-
17336   check_local_user
17337   transport = local_delivery
17338 .endd
17339 For security, it would probably be a good idea to restrict the use of this
17340 router to locally-generated messages, using a condition such as this:
17341 .code
17342   condition = ${if match {$sender_host_address}\
17343                          {\N^(|127\.0\.0\.1)$\N}}
17344 .endd
17345
17346 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17347 both conditions must be met if not optional. Care must be taken if wildcards
17348 are used in both a prefix and a suffix on the same router. Different
17349 separator characters must be used to avoid ambiguity.
17350
17351
17352 .option local_part_prefix_optional routers boolean false
17353 See &%local_part_prefix%& above.
17354
17355
17356
17357 .option local_part_suffix routers&!? "string list" unset
17358 .cindex "router" "suffix for local part"
17359 .cindex "suffix for local part" "used in router"
17360 This option operates in the same way as &%local_part_prefix%&, except that the
17361 local part must end (rather than start) with the given string, the
17362 &%local_part_suffix_optional%& option determines whether the suffix is
17363 mandatory, and the wildcard * character, if present, must be the last
17364 character of the suffix. This option facility is commonly used to handle local
17365 parts of the form &%something-request%& and multiple user mailboxes of the form
17366 &%username-foo%&.
17367
17368
17369 .option local_part_suffix_optional routers boolean false
17370 See &%local_part_suffix%& above.
17371
17372
17373
17374 .option local_parts routers&!? "local part list&!!" unset
17375 .cindex "router" "restricting to specific local parts"
17376 .cindex "local part" "checking in router"
17377 The router is run only if the local part of the address matches the list.
17378 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17379 are evaluated, and
17380 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17381 string is expanded, it is possible to make it depend on the domain, for
17382 example:
17383 .code
17384 local_parts = dbm;/usr/local/specials/$domain
17385 .endd
17386 .vindex "&$local_part_data$&"
17387 If the match is achieved by a lookup, the data that the lookup returned
17388 for the local part is placed in the variable &$local_part_data$& for use in
17389 expansions of the router's private options. You might use this option, for
17390 example, if you have a large number of local virtual domains, and you want to
17391 send all postmaster mail to the same place without having to set up an alias in
17392 each virtual domain:
17393 .code
17394 postmaster:
17395   driver = redirect
17396   local_parts = postmaster
17397   data = postmaster@real.domain.example
17398 .endd
17399
17400
17401 .option log_as_local routers boolean "see below"
17402 .cindex "log" "delivery line"
17403 .cindex "delivery" "log line format"
17404 Exim has two logging styles for delivery, the idea being to make local
17405 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17406 recipient address is given just as the local part, without a domain. The use of
17407 this style is controlled by this option. It defaults to true for the &(accept)&
17408 router, and false for all the others. This option applies only when a
17409 router assigns an address to a transport. It has no effect on routers that
17410 redirect addresses.
17411
17412
17413
17414 .option more routers boolean&!! true
17415 The result of string expansion for this option must be a valid boolean value,
17416 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17417 result causes an error, and delivery is deferred. If the expansion is forced to
17418 fail, the default value for the option (true) is used. Other failures cause
17419 delivery to be deferred.
17420
17421 If this option is set false, and the router declines to handle the address, no
17422 further routers are tried, routing fails, and the address is bounced.
17423 .oindex "&%self%&"
17424 However, if the router explicitly passes an address to the following router by
17425 means of the setting
17426 .code
17427 self = pass
17428 .endd
17429 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17430 does not affect the behaviour if one of the precondition tests fails. In that
17431 case, the address is always passed to the next router.
17432
17433 Note that &%address_data%& is not considered to be a precondition. If its
17434 expansion is forced to fail, the router declines, and the value of &%more%&
17435 controls what happens next.
17436
17437
17438 .option pass_on_timeout routers boolean false
17439 .cindex "timeout" "of router"
17440 .cindex "router" "timeout"
17441 If a router times out during a host lookup, it normally causes deferral of the
17442 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17443 router, overriding &%no_more%&. This may be helpful for systems that are
17444 intermittently connected to the Internet, or those that want to pass to a smart
17445 host any messages that cannot immediately be delivered.
17446
17447 There are occasional other temporary errors that can occur while doing DNS
17448 lookups. They are treated in the same way as a timeout, and this option
17449 applies to all of them.
17450
17451
17452
17453 .option pass_router routers string unset
17454 .cindex "router" "go to after &""pass""&"
17455 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17456 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17457 routing to continue, and overriding a false setting of &%more%&. When one of
17458 these routers returns &"pass"&, the address is normally handed on to the next
17459 router in sequence. This can be changed by setting &%pass_router%& to the name
17460 of another router. However (unlike &%redirect_router%&) the named router must
17461 be below the current router, to avoid loops. Note that this option applies only
17462 to the special case of &"pass"&. It does not apply when a router returns
17463 &"decline"& because it cannot handle an address.
17464
17465
17466
17467 .option redirect_router routers string unset
17468 .cindex "router" "start at after redirection"
17469 Sometimes an administrator knows that it is pointless to reprocess addresses
17470 generated from alias or forward files with the same router again. For
17471 example, if an alias file translates real names into login ids there is no
17472 point searching the alias file a second time, especially if it is a large file.
17473
17474 The &%redirect_router%& option can be set to the name of any router instance.
17475 It causes the routing of any generated addresses to start at the named router
17476 instead of at the first router. This option has no effect if the router in
17477 which it is set does not generate new addresses.
17478
17479
17480
17481 .option require_files routers&!? "string list&!!" unset
17482 .cindex "file" "requiring for router"
17483 .cindex "router" "requiring file existence"
17484 This option provides a general mechanism for predicating the running of a
17485 router on the existence or non-existence of certain files or directories.
17486 Before running a router, as one of its precondition tests, Exim works its way
17487 through the &%require_files%& list, expanding each item separately.
17488
17489 Because the list is split before expansion, any colons in expansion items must
17490 be doubled, or the facility for using a different list separator must be used.
17491 If any expansion is forced to fail, the item is ignored. Other expansion
17492 failures cause routing of the address to be deferred.
17493
17494 If any expanded string is empty, it is ignored. Otherwise, except as described
17495 below, each string must be a fully qualified file path, optionally preceded by
17496 &"!"&. The paths are passed to the &[stat()]& function to test for the
17497 existence of the files or directories. The router is skipped if any paths not
17498 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17499
17500 .cindex "NFS"
17501 If &[stat()]& cannot determine whether a file exists or not, delivery of
17502 the message is deferred. This can happen when NFS-mounted filesystems are
17503 unavailable.
17504
17505 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17506 options, so you cannot use it to check for the existence of a file in which to
17507 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17508 full list of the order in which preconditions are evaluated.) However, as
17509 these options are all expanded, you can use the &%exists%& expansion condition
17510 to make such tests. The &%require_files%& option is intended for checking files
17511 that the router may be going to use internally, or which are needed by a
17512 transport (for example &_.procmailrc_&).
17513
17514 During delivery, the &[stat()]& function is run as root, but there is a
17515 facility for some checking of the accessibility of a file by another user.
17516 This is not a proper permissions check, but just a &"rough"& check that
17517 operates as follows:
17518
17519 If an item in a &%require_files%& list does not contain any forward slash
17520 characters, it is taken to be the user (and optional group, separated by a
17521 comma) to be checked for subsequent files in the list. If no group is specified
17522 but the user is specified symbolically, the gid associated with the uid is
17523 used. For example:
17524 .code
17525 require_files = mail:/some/file
17526 require_files = $local_part:$home/.procmailrc
17527 .endd
17528 If a user or group name in a &%require_files%& list does not exist, the
17529 &%require_files%& condition fails.
17530
17531 Exim performs the check by scanning along the components of the file path, and
17532 checking the access for the given uid and gid. It checks for &"x"& access on
17533 directories, and &"r"& access on the final file. Note that this means that file
17534 access control lists, if the operating system has them, are ignored.
17535
17536 &*Warning 1*&: When the router is being run to verify addresses for an
17537 incoming SMTP message, Exim is not running as root, but under its own uid. This
17538 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17539 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17540 user is not permitted to read one of the directories on the file's path.
17541
17542 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17543 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17544 without root access. In this case, if a check for access by a particular user
17545 is requested, Exim creates a subprocess that runs as that user, and tries the
17546 check again in that process.
17547
17548 The default action for handling an unresolved EACCES is to consider it to
17549 be caused by a configuration error, and routing is deferred because the
17550 existence or non-existence of the file cannot be determined. However, in some
17551 circumstances it may be desirable to treat this condition as if the file did
17552 not exist. If the file name (or the exclamation mark that precedes the file
17553 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17554 as if the file did not exist. For example:
17555 .code
17556 require_files = +/some/file
17557 .endd
17558 If the router is not an essential part of verification (for example, it
17559 handles users' &_.forward_& files), another solution is to set the &%verify%&
17560 option false so that the router is skipped when verifying.
17561
17562
17563
17564 .option retry_use_local_part routers boolean "see below"
17565 .cindex "hints database" "retry keys"
17566 .cindex "local part" "in retry keys"
17567 When a delivery suffers a temporary routing failure, a retry record is created
17568 in Exim's hints database. For addresses whose routing depends only on the
17569 domain, the key for the retry record should not involve the local part, but for
17570 other addresses, both the domain and the local part should be included.
17571 Usually, remote routing is of the former kind, and local routing is of the
17572 latter kind.
17573
17574 This option controls whether the local part is used to form the key for retry
17575 hints for addresses that suffer temporary errors while being handled by this
17576 router. The default value is true for any router that has &%check_local_user%&
17577 set, and false otherwise. Note that this option does not apply to hints keys
17578 for transport delays; they are controlled by a generic transport option of the
17579 same name.
17580
17581 The setting of &%retry_use_local_part%& applies only to the router on which it
17582 appears. If the router generates child addresses, they are routed
17583 independently; this setting does not become attached to them.
17584
17585
17586
17587 .option router_home_directory routers string&!! unset
17588 .cindex "router" "home directory for"
17589 .cindex "home directory" "for router"
17590 .vindex "&$home$&"
17591 This option sets a home directory for use while the router is running. (Compare
17592 &%transport_home_directory%&, which sets a home directory for later
17593 transporting.) In particular, if used on a &(redirect)& router, this option
17594 sets a value for &$home$& while a filter is running. The value is expanded;
17595 forced expansion failure causes the option to be ignored &-- other failures
17596 cause the router to defer.
17597
17598 Expansion of &%router_home_directory%& happens immediately after the
17599 &%check_local_user%& test (if configured), before any further expansions take
17600 place.
17601 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17602 are evaluated.)
17603 While the router is running, &%router_home_directory%& overrides the value of
17604 &$home$& that came from &%check_local_user%&.
17605
17606 When a router accepts an address and assigns it to a local transport (including
17607 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17608 delivery), the home directory setting for the transport is taken from the first
17609 of these values that is set:
17610
17611 .ilist
17612 The &%home_directory%& option on the transport;
17613 .next
17614 The &%transport_home_directory%& option on the router;
17615 .next
17616 The password data if &%check_local_user%& is set on the router;
17617 .next
17618 The &%router_home_directory%& option on the router.
17619 .endlist
17620
17621 In other words, &%router_home_directory%& overrides the password data for the
17622 router, but not for the transport.
17623
17624
17625
17626 .option self routers string freeze
17627 .cindex "MX record" "pointing to local host"
17628 .cindex "local host" "MX pointing to"
17629 This option applies to those routers that use a recipient address to find a
17630 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17631 and &(manualroute)& routers.
17632 Certain configurations of the &(queryprogram)& router can also specify a list
17633 of remote hosts.
17634 Usually such routers are configured to send the message to a remote host via an
17635 &(smtp)& transport. The &%self%& option specifies what happens when the first
17636 host on the list turns out to be the local host.
17637 The way in which Exim checks for the local host is described in section
17638 &<<SECTreclocipadd>>&.
17639
17640 Normally this situation indicates either an error in Exim's configuration (for
17641 example, the router should be configured not to process this domain), or an
17642 error in the DNS (for example, the MX should not point to this host). For this
17643 reason, the default action is to log the incident, defer the address, and
17644 freeze the message. The following alternatives are provided for use in special
17645 cases:
17646
17647 .vlist
17648 .vitem &%defer%&
17649 Delivery of the message is tried again later, but the message is not frozen.
17650
17651 .vitem "&%reroute%&: <&'domain'&>"
17652 The domain is changed to the given domain, and the address is passed back to
17653 be reprocessed by the routers. No rewriting of headers takes place. This
17654 behaviour is essentially a redirection.
17655
17656 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17657 The domain is changed to the given domain, and the address is passed back to be
17658 reprocessed by the routers. Any headers that contain the original domain are
17659 rewritten.
17660
17661 .vitem &%pass%&
17662 .oindex "&%more%&"
17663 .vindex "&$self_hostname$&"
17664 The router passes the address to the next router, or to the router named in the
17665 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17666 subsequent routing and delivery, the variable &$self_hostname$& contains the
17667 name of the local host that the router encountered. This can be used to
17668 distinguish between different cases for hosts with multiple names. The
17669 combination
17670 .code
17671 self = pass
17672 no_more
17673 .endd
17674 ensures that only those addresses that routed to the local host are passed on.
17675 Without &%no_more%&, addresses that were declined for other reasons would also
17676 be passed to the next router.
17677
17678 .vitem &%fail%&
17679 Delivery fails and an error report is generated.
17680
17681 .vitem &%send%&
17682 .cindex "local host" "sending to"
17683 The anomaly is ignored and the address is queued for the transport. This
17684 setting should be used with extreme caution. For an &(smtp)& transport, it
17685 makes sense only in cases where the program that is listening on the SMTP port
17686 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17687 different configuration file that handles the domain in another way.
17688 .endlist
17689
17690
17691
17692 .option senders routers&!? "address list&!!" unset
17693 .cindex "router" "checking senders"
17694 If this option is set, the router is skipped unless the message's sender
17695 address matches something on the list.
17696 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17697 are evaluated.
17698
17699 There are issues concerning verification when the running of routers is
17700 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17701 setting, it sets the sender to the null string. When using the &%-bt%& option
17702 to check a configuration file, it is necessary also to use the &%-f%& option to
17703 set an appropriate sender. For incoming mail, the sender is unset when
17704 verifying the sender, but is available when verifying any recipients. If the
17705 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17706 matters.
17707
17708
17709 .option translate_ip_address routers string&!! unset
17710 .cindex "IP address" "translating"
17711 .cindex "packet radio"
17712 .cindex "router" "IP address translation"
17713 There exist some rare networking situations (for example, packet radio) where
17714 it is helpful to be able to translate IP addresses generated by normal routing
17715 mechanisms into other IP addresses, thus performing a kind of manual IP
17716 routing. This should be done only if the normal IP routing of the TCP/IP stack
17717 is inadequate or broken. Because this is an extremely uncommon requirement, the
17718 code to support this option is not included in the Exim binary unless
17719 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17720
17721 .vindex "&$host_address$&"
17722 The &%translate_ip_address%& string is expanded for every IP address generated
17723 by the router, with the generated address set in &$host_address$&. If the
17724 expansion is forced to fail, no action is taken.
17725 For any other expansion error, delivery of the message is deferred.
17726 If the result of the expansion is an IP address, that replaces the original
17727 address; otherwise the result is assumed to be a host name &-- this is looked
17728 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17729 produce one or more replacement IP addresses. For example, to subvert all IP
17730 addresses in some specific networks, this could be added to a router:
17731 .code
17732 translate_ip_address = \
17733   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17734     {$value}fail}}
17735 .endd
17736 The file would contain lines like
17737 .code
17738 10.2.3.128/26    some.host
17739 10.8.4.34/26     10.44.8.15
17740 .endd
17741 You should not make use of this facility unless you really understand what you
17742 are doing.
17743
17744
17745
17746 .option transport routers string&!! unset
17747 This option specifies the transport to be used when a router accepts an address
17748 and sets it up for delivery. A transport is never needed if a router is used
17749 only for verification. The value of the option is expanded at routing time,
17750 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17751 and result must be the name of one of the configured transports. If it is not,
17752 delivery is deferred.
17753
17754 The &%transport%& option is not used by the &(redirect)& router, but it does
17755 have some private options that set up transports for pipe and file deliveries
17756 (see chapter &<<CHAPredirect>>&).
17757
17758
17759
17760 .option transport_current_directory routers string&!! unset
17761 .cindex "current directory for local transport"
17762 This option associates a current directory with any address that is routed
17763 to a local transport. This can happen either because a transport is
17764 explicitly configured for the router, or because it generates a delivery to a
17765 file or a pipe. During the delivery process (that is, at transport time), this
17766 option string is expanded and is set as the current directory, unless
17767 overridden by a setting on the transport.
17768 If the expansion fails for any reason, including forced failure, an error is
17769 logged, and delivery is deferred.
17770 See chapter &<<CHAPenvironment>>& for details of the local delivery
17771 environment.
17772
17773
17774
17775
17776 .option transport_home_directory routers string&!! "see below"
17777 .cindex "home directory" "for local transport"
17778 This option associates a home directory with any address that is routed to a
17779 local transport. This can happen either because a transport is explicitly
17780 configured for the router, or because it generates a delivery to a file or a
17781 pipe. During the delivery process (that is, at transport time), the option
17782 string is expanded and is set as the home directory, unless overridden by a
17783 setting of &%home_directory%& on the transport.
17784 If the expansion fails for any reason, including forced failure, an error is
17785 logged, and delivery is deferred.
17786
17787 If the transport does not specify a home directory, and
17788 &%transport_home_directory%& is not set for the router, the home directory for
17789 the transport is taken from the password data if &%check_local_user%& is set for
17790 the router. Otherwise it is taken from &%router_home_directory%& if that option
17791 is set; if not, no home directory is set for the transport.
17792
17793 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17794 environment.
17795
17796
17797
17798
17799 .option unseen routers boolean&!! false
17800 .cindex "router" "carrying on after success"
17801 The result of string expansion for this option must be a valid boolean value,
17802 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17803 result causes an error, and delivery is deferred. If the expansion is forced to
17804 fail, the default value for the option (false) is used. Other failures cause
17805 delivery to be deferred.
17806
17807 When this option is set true, routing does not cease if the router accepts the
17808 address. Instead, a copy of the incoming address is passed to the next router,
17809 overriding a false setting of &%more%&. There is little point in setting
17810 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17811 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17812 sometimes true and sometimes false).
17813
17814 .cindex "copy of message (&%unseen%& option)"
17815 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17816 qualifier in filter files. It can be used to cause copies of messages to be
17817 delivered to some other destination, while also carrying out a normal delivery.
17818 In effect, the current address is made into a &"parent"& that has two children
17819 &-- one that is delivered as specified by this router, and a clone that goes on
17820 to be routed further. For this reason, &%unseen%& may not be combined with the
17821 &%one_time%& option in a &(redirect)& router.
17822
17823 &*Warning*&: Header lines added to the address (or specified for removal) by
17824 this router or by previous routers affect the &"unseen"& copy of the message
17825 only. The clone that continues to be processed by further routers starts with
17826 no added headers and none specified for removal. For a &%redirect%& router, if
17827 a generated address is the same as the incoming address, this can lead to
17828 duplicate addresses with different header modifications. Exim does not do
17829 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17830 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17831 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17832 &%redirect%& router may be of help.
17833
17834 Unlike the handling of header modifications, any data that was set by the
17835 &%address_data%& option in the current or previous routers &'is'& passed on to
17836 subsequent routers.
17837
17838
17839 .option user routers string&!! "see below"
17840 .cindex "uid (user id)" "local delivery"
17841 .cindex "local transports" "uid and gid"
17842 .cindex "transport" "local"
17843 .cindex "router" "user for filter processing"
17844 .cindex "filter" "user for processing"
17845 When a router queues an address for a transport, and the transport does not
17846 specify a user, the user given here is used when running the delivery process.
17847 The user may be specified numerically or by name. If expansion fails, the
17848 error is logged and delivery is deferred.
17849 This user is also used by the &(redirect)& router when running a filter file.
17850 The default is unset, except when &%check_local_user%& is set. In this case,
17851 the default is taken from the password information. If the user is specified as
17852 a name, and &%group%& is not set, the group associated with the user is used.
17853 See also &%initgroups%& and &%group%& and the discussion in chapter
17854 &<<CHAPenvironment>>&.
17855
17856
17857
17858 .option verify routers&!? boolean true
17859 Setting this option has the effect of setting &%verify_sender%& and
17860 &%verify_recipient%& to the same value.
17861
17862
17863 .option verify_only routers&!? boolean false
17864 .cindex "EXPN" "with &%verify_only%&"
17865 .oindex "&%-bv%&"
17866 .cindex "router" "used only when verifying"
17867 If this option is set, the router is used only when verifying an address,
17868 delivering in cutthrough mode or
17869 testing with the &%-bv%& option, not when actually doing a delivery, testing
17870 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17871 restricted to verifying only senders or recipients by means of
17872 &%verify_sender%& and &%verify_recipient%&.
17873
17874 &*Warning*&: When the router is being run to verify addresses for an incoming
17875 SMTP message, Exim is not running as root, but under its own uid. If the router
17876 accesses any files, you need to make sure that they are accessible to the Exim
17877 user or group.
17878
17879
17880 .option verify_recipient routers&!? boolean true
17881 If this option is false, the router is skipped when verifying recipient
17882 addresses,
17883 delivering in cutthrough mode
17884 or testing recipient verification using &%-bv%&.
17885 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17886 are evaluated.
17887 See also the &$verify_mode$& variable.
17888
17889
17890 .option verify_sender routers&!? boolean true
17891 If this option is false, the router is skipped when verifying sender addresses
17892 or testing sender verification using &%-bvs%&.
17893 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17894 are evaluated.
17895 See also the &$verify_mode$& variable.
17896 .ecindex IIDgenoprou1
17897 .ecindex IIDgenoprou2
17898
17899
17900
17901
17902
17903
17904 . ////////////////////////////////////////////////////////////////////////////
17905 . ////////////////////////////////////////////////////////////////////////////
17906
17907 .chapter "The accept router" "CHID4"
17908 .cindex "&(accept)& router"
17909 .cindex "routers" "&(accept)&"
17910 The &(accept)& router has no private options of its own. Unless it is being
17911 used purely for verification (see &%verify_only%&) a transport is required to
17912 be defined by the generic &%transport%& option. If the preconditions that are
17913 specified by generic options are met, the router accepts the address and queues
17914 it for the given transport. The most common use of this router is for setting
17915 up deliveries to local mailboxes. For example:
17916 .code
17917 localusers:
17918   driver = accept
17919   domains = mydomain.example
17920   check_local_user
17921   transport = local_delivery
17922 .endd
17923 The &%domains%& condition in this example checks the domain of the address, and
17924 &%check_local_user%& checks that the local part is the login of a local user.
17925 When both preconditions are met, the &(accept)& router runs, and queues the
17926 address for the &(local_delivery)& transport.
17927
17928
17929
17930
17931
17932
17933 . ////////////////////////////////////////////////////////////////////////////
17934 . ////////////////////////////////////////////////////////////////////////////
17935
17936 .chapter "The dnslookup router" "CHAPdnslookup"
17937 .scindex IIDdnsrou1 "&(dnslookup)& router"
17938 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17939 The &(dnslookup)& router looks up the hosts that handle mail for the
17940 recipient's domain in the DNS. A transport must always be set for this router,
17941 unless &%verify_only%& is set.
17942
17943 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17944 SRV records. If none are found, or if SRV support is not configured,
17945 MX records are looked up. If no MX records exist, address records are sought.
17946 However, &%mx_domains%& can be set to disable the direct use of address
17947 records.
17948
17949 MX records of equal priority are sorted by Exim into a random order. Exim then
17950 looks for address records for the host names obtained from MX or SRV records.
17951 When a host has more than one IP address, they are sorted into a random order,
17952 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17953 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17954 generic option, the router declines.
17955
17956 Unless they have the highest priority (lowest MX value), MX records that point
17957 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17958 are discarded, together with any other MX records of equal or lower priority.
17959
17960 .cindex "MX record" "pointing to local host"
17961 .cindex "local host" "MX pointing to"
17962 .oindex "&%self%&" "in &(dnslookup)& router"
17963 If the host pointed to by the highest priority MX record, or looked up as an
17964 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17965 happens is controlled by the generic &%self%& option.
17966
17967
17968 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17969 There have been problems with DNS servers when SRV records are looked up.
17970 Some mis-behaving servers return a DNS error or timeout when a non-existent
17971 SRV record is sought. Similar problems have in the past been reported for
17972 MX records. The global &%dns_again_means_nonexist%& option can help with this
17973 problem, but it is heavy-handed because it is a global option.
17974
17975 For this reason, there are two options, &%srv_fail_domains%& and
17976 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17977 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17978 an attempt to look up an SRV or MX record causes one of these results, and the
17979 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17980 such record"&. In the case of an SRV lookup, this means that the router
17981 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17982 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17983 case routing fails.
17984
17985
17986 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17987 .cindex "&(dnslookup)& router" "declines"
17988 There are a few cases where a &(dnslookup)& router will decline to accept
17989 an address; if such a router is expected to handle "all remaining non-local
17990 domains", then it is important to set &%no_more%&.
17991
17992 The router will defer rather than decline if the domain
17993 is found in the &%fail_defer_domains%& router option.
17994
17995 Reasons for a &(dnslookup)& router to decline currently include:
17996 .ilist
17997 The domain does not exist in DNS
17998 .next
17999 The domain exists but the MX record's host part is just "."; this is a common
18000 convention (borrowed from SRV) used to indicate that there is no such service
18001 for this domain and to not fall back to trying A/AAAA records.
18002 .next
18003 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18004 .next
18005 MX record points to a non-existent host.
18006 .next
18007 MX record points to an IP address and the main section option
18008 &%allow_mx_to_ip%& is not set.
18009 .next
18010 MX records exist and point to valid hosts, but all hosts resolve only to
18011 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18012 .next
18013 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18014 &%dns_check_names_pattern%& for handling one variant of this)
18015 .next
18016 &%check_secondary_mx%& is set on this router but the local host can
18017 not be found in the MX records (see below)
18018 .endlist
18019
18020
18021
18022
18023 .section "Private options for dnslookup" "SECID118"
18024 .cindex "options" "&(dnslookup)& router"
18025 The private options for the &(dnslookup)& router are as follows:
18026
18027 .option check_secondary_mx dnslookup boolean false
18028 .cindex "MX record" "checking for secondary"
18029 If this option is set, the router declines unless the local host is found in
18030 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18031 process domains for which the local host is a secondary mail exchanger
18032 differently to other domains. The way in which Exim decides whether a host is
18033 the local host is described in section &<<SECTreclocipadd>>&.
18034
18035
18036 .option check_srv dnslookup string&!! unset
18037 .cindex "SRV record" "enabling use of"
18038 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18039 addition to MX and address records. The support is disabled by default. To
18040 enable SRV support, set the &%check_srv%& option to the name of the service
18041 required. For example,
18042 .code
18043 check_srv = smtp
18044 .endd
18045 looks for SRV records that refer to the normal smtp service. The option is
18046 expanded, so the service name can vary from message to message or address
18047 to address. This might be helpful if SRV records are being used for a
18048 submission service. If the expansion is forced to fail, the &%check_srv%&
18049 option is ignored, and the router proceeds to look for MX records in the
18050 normal way.
18051
18052 When the expansion succeeds, the router searches first for SRV records for
18053 the given service (it assumes TCP protocol). A single SRV record with a
18054 host name that consists of just a single dot indicates &"no such service for
18055 this domain"&; if this is encountered, the router declines. If other kinds of
18056 SRV record are found, they are used to construct a host list for delivery
18057 according to the rules of RFC 2782. MX records are not sought in this case.
18058
18059 When no SRV records are found, MX records (and address records) are sought in
18060 the traditional way. In other words, SRV records take precedence over MX
18061 records, just as MX records take precedence over address records. Note that
18062 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18063 defined it. It is apparently believed that MX records are sufficient for email
18064 and that SRV records should not be used for this purpose. However, SRV records
18065 have an additional &"weight"& feature which some people might find useful when
18066 trying to split an SMTP load between hosts of different power.
18067
18068 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18069 when there is a DNS lookup error.
18070
18071
18072
18073 .option dnssec_request_domains dnslookup "domain list&!!" unset
18074 .cindex "MX record" "security"
18075 .cindex "DNSSEC" "MX lookup"
18076 .cindex "security" "MX lookup"
18077 .cindex "DNS" "DNSSEC"
18078 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18079 the dnssec request bit set.
18080 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18081
18082
18083
18084 .option dnssec_require_domains dnslookup "domain list&!!" unset
18085 .cindex "MX record" "security"
18086 .cindex "DNSSEC" "MX lookup"
18087 .cindex "security" "MX lookup"
18088 .cindex "DNS" "DNSSEC"
18089 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18090 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18091 (AD bit) set wil be ignored and logged as a host-lookup failure.
18092 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18093
18094
18095
18096 .option fail_defer_domains dnslookup "domain list&!!" unset
18097 .cindex "MX record" "not found"
18098 DNS lookups for domains matching &%fail_defer_domains%&
18099 which find no matching record will cause the router to defer
18100 rather than the default behaviour of decline.
18101 This maybe be useful for queueing messages for a newly created
18102 domain while the DNS configuration is not ready.
18103 However, it will result in any message with mistyped domains
18104 also being queued.
18105
18106
18107 .option mx_domains dnslookup "domain list&!!" unset
18108 .cindex "MX record" "required to exist"
18109 .cindex "SRV record" "required to exist"
18110 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18111 record in order to be recognized. (The name of this option could be improved.)
18112 For example, if all the mail hosts in &'fict.example'& are known to have MX
18113 records, except for those in &'discworld.fict.example'&, you could use this
18114 setting:
18115 .code
18116 mx_domains = ! *.discworld.fict.example : *.fict.example
18117 .endd
18118 This specifies that messages addressed to a domain that matches the list but
18119 has no MX record should be bounced immediately instead of being routed using
18120 the address record.
18121
18122
18123 .option mx_fail_domains dnslookup "domain list&!!" unset
18124 If the DNS lookup for MX records for one of the domains in this list causes a
18125 DNS lookup error, Exim behaves as if no MX records were found. See section
18126 &<<SECTprowitdnsloo>>& for more discussion.
18127
18128
18129
18130
18131 .option qualify_single dnslookup boolean true
18132 .cindex "DNS" "resolver options"
18133 .cindex "DNS" "qualifying single-component names"
18134 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18135 lookups. Typically, but not standardly, this causes the resolver to qualify
18136 single-component names with the default domain. For example, on a machine
18137 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18138 &'thesaurus.ref.example'& inside the resolver. For details of what your
18139 resolver actually does, consult your man pages for &'resolver'& and
18140 &'resolv.conf'&.
18141
18142
18143
18144 .option rewrite_headers dnslookup boolean true
18145 .cindex "rewriting" "header lines"
18146 .cindex "header lines" "rewriting"
18147 If the domain name in the address that is being processed is not fully
18148 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18149 an address is specified as &'dormouse@teaparty'&, the domain might be
18150 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18151 occur as a result of setting the &%widen_domains%& option. If
18152 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18153 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18154 header lines of the message are rewritten with the full domain name.
18155
18156 This option should be turned off only when it is known that no message is
18157 ever going to be sent outside an environment where the abbreviation makes
18158 sense.
18159
18160 When an MX record is looked up in the DNS and matches a wildcard record, name
18161 servers normally return a record containing the name that has been looked up,
18162 making it impossible to detect whether a wildcard was present or not. However,
18163 some name servers have recently been seen to return the wildcard entry. If the
18164 name returned by a DNS lookup begins with an asterisk, it is not used for
18165 header rewriting.
18166
18167
18168 .option same_domain_copy_routing dnslookup boolean false
18169 .cindex "address" "copying routing"
18170 Addresses with the same domain are normally routed by the &(dnslookup)& router
18171 to the same list of hosts. However, this cannot be presumed, because the router
18172 options and preconditions may refer to the local part of the address. By
18173 default, therefore, Exim routes each address in a message independently. DNS
18174 servers run caches, so repeated DNS lookups are not normally expensive, and in
18175 any case, personal messages rarely have more than a few recipients.
18176
18177 If you are running mailing lists with large numbers of subscribers at the same
18178 domain, and you are using a &(dnslookup)& router which is independent of the
18179 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18180 lookups for identical domains in one message. In this case, when &(dnslookup)&
18181 routes an address to a remote transport, any other unrouted addresses in the
18182 message that have the same domain are automatically given the same routing
18183 without processing them independently,
18184 provided the following conditions are met:
18185
18186 .ilist
18187 No router that processed the address specified &%headers_add%& or
18188 &%headers_remove%&.
18189 .next
18190 The router did not change the address in any way, for example, by &"widening"&
18191 the domain.
18192 .endlist
18193
18194
18195
18196
18197 .option search_parents dnslookup boolean false
18198 .cindex "DNS" "resolver options"
18199 When this option is true, the resolver option RES_DNSRCH is set for DNS
18200 lookups. This is different from the &%qualify_single%& option in that it
18201 applies to domains containing dots. Typically, but not standardly, it causes
18202 the resolver to search for the name in the current domain and in parent
18203 domains. For example, on a machine in the &'fict.example'& domain, if looking
18204 up &'teaparty.wonderland'& failed, the resolver would try
18205 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18206 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18207
18208 Setting this option true can cause problems in domains that have a wildcard MX
18209 record, because any domain that does not have its own MX record matches the
18210 local wildcard.
18211
18212
18213
18214 .option srv_fail_domains dnslookup "domain list&!!" unset
18215 If the DNS lookup for SRV records for one of the domains in this list causes a
18216 DNS lookup error, Exim behaves as if no SRV records were found. See section
18217 &<<SECTprowitdnsloo>>& for more discussion.
18218
18219
18220
18221
18222 .option widen_domains dnslookup "string list" unset
18223 .cindex "domain" "partial; widening"
18224 If a DNS lookup fails and this option is set, each of its strings in turn is
18225 added onto the end of the domain, and the lookup is tried again. For example,
18226 if
18227 .code
18228 widen_domains = fict.example:ref.example
18229 .endd
18230 is set and a lookup of &'klingon.dictionary'& fails,
18231 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18232 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18233 and &%search_parents%& options can cause some widening to be undertaken inside
18234 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18235 when verifying, unless &%rewrite_headers%& is false (not the default).
18236
18237
18238 .section "Effect of qualify_single and search_parents" "SECID119"
18239 When a domain from an envelope recipient is changed by the resolver as a result
18240 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18241 corresponding address in the message's header lines unless &%rewrite_headers%&
18242 is set false. Exim then re-routes the address, using the full domain.
18243
18244 These two options affect only the DNS lookup that takes place inside the router
18245 for the domain of the address that is being routed. They do not affect lookups
18246 such as that implied by
18247 .code
18248 domains = @mx_any
18249 .endd
18250 that may happen while processing a router precondition before the router is
18251 entered. No widening ever takes place for these lookups.
18252 .ecindex IIDdnsrou1
18253 .ecindex IIDdnsrou2
18254
18255
18256
18257
18258
18259
18260
18261
18262
18263 . ////////////////////////////////////////////////////////////////////////////
18264 . ////////////////////////////////////////////////////////////////////////////
18265
18266 .chapter "The ipliteral router" "CHID5"
18267 .cindex "&(ipliteral)& router"
18268 .cindex "domain literal" "routing"
18269 .cindex "routers" "&(ipliteral)&"
18270 This router has no private options. Unless it is being used purely for
18271 verification (see &%verify_only%&) a transport is required to be defined by the
18272 generic &%transport%& option. The router accepts the address if its domain part
18273 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18274 router handles the address
18275 .code
18276 root@[192.168.1.1]
18277 .endd
18278 by setting up delivery to the host with that IP address. IPv4 domain literals
18279 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18280 are similar, but the address is preceded by &`ipv6:`&. For example:
18281 .code
18282 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18283 .endd
18284 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18285 grounds that sooner or later somebody will try it.
18286
18287 .oindex "&%self%&" "in &(ipliteral)& router"
18288 If the IP address matches something in &%ignore_target_hosts%&, the router
18289 declines. If an IP literal turns out to refer to the local host, the generic
18290 &%self%& option determines what happens.
18291
18292 The RFCs require support for domain literals; however, their use is
18293 controversial in today's Internet. If you want to use this router, you must
18294 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18295 Exim will not recognize the domain literal syntax in addresses.
18296
18297
18298
18299 . ////////////////////////////////////////////////////////////////////////////
18300 . ////////////////////////////////////////////////////////////////////////////
18301
18302 .chapter "The iplookup router" "CHID6"
18303 .cindex "&(iplookup)& router"
18304 .cindex "routers" "&(iplookup)&"
18305 The &(iplookup)& router was written to fulfil a specific requirement in
18306 Cambridge University (which in fact no longer exists). For this reason, it is
18307 not included in the binary of Exim by default. If you want to include it, you
18308 must set
18309 .code
18310 ROUTER_IPLOOKUP=yes
18311 .endd
18312 in your &_Local/Makefile_& configuration file.
18313
18314 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18315 connection to one or more specific hosts. The host can then return the same or
18316 a different address &-- in effect rewriting the recipient address in the
18317 message's envelope. The new address is then passed on to subsequent routers. If
18318 this process fails, the address can be passed on to other routers, or delivery
18319 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18320 must not be specified for it.
18321
18322 .cindex "options" "&(iplookup)& router"
18323 .option hosts iplookup string unset
18324 This option must be supplied. Its value is a colon-separated list of host
18325 names. The hosts are looked up using &[gethostbyname()]&
18326 (or &[getipnodebyname()]& when available)
18327 and are tried in order until one responds to the query. If none respond, what
18328 happens is controlled by &%optional%&.
18329
18330
18331 .option optional iplookup boolean false
18332 If &%optional%& is true, if no response is obtained from any host, the address
18333 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18334 delivery to the address is deferred.
18335
18336
18337 .option port iplookup integer 0
18338 .cindex "port" "&(iplookup)& router"
18339 This option must be supplied. It specifies the port number for the TCP or UDP
18340 call.
18341
18342
18343 .option protocol iplookup string udp
18344 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18345 protocols is to be used.
18346
18347
18348 .option query iplookup string&!! "see below"
18349 This defines the content of the query that is sent to the remote hosts. The
18350 default value is:
18351 .code
18352 $local_part@$domain $local_part@$domain
18353 .endd
18354 The repetition serves as a way of checking that a response is to the correct
18355 query in the default case (see &%response_pattern%& below).
18356
18357
18358 .option reroute iplookup string&!! unset
18359 If this option is not set, the rerouted address is precisely the byte string
18360 returned by the remote host, up to the first white space, if any. If set, the
18361 string is expanded to form the rerouted address. It can include parts matched
18362 in the response by &%response_pattern%& by means of numeric variables such as
18363 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18364 whether or not a pattern is in use. In all cases, the rerouted address must end
18365 up in the form &'local_part@domain'&.
18366
18367
18368 .option response_pattern iplookup string unset
18369 This option can be set to a regular expression that is applied to the string
18370 returned from the remote host. If the pattern does not match the response, the
18371 router declines. If &%response_pattern%& is not set, no checking of the
18372 response is done, unless the query was defaulted, in which case there is a
18373 check that the text returned after the first white space is the original
18374 address. This checks that the answer that has been received is in response to
18375 the correct question. For example, if the response is just a new domain, the
18376 following could be used:
18377 .code
18378 response_pattern = ^([^@]+)$
18379 reroute = $local_part@$1
18380 .endd
18381
18382 .option timeout iplookup time 5s
18383 This specifies the amount of time to wait for a response from the remote
18384 machine. The same timeout is used for the &[connect()]& function for a TCP
18385 call. It does not apply to UDP.
18386
18387
18388
18389
18390 . ////////////////////////////////////////////////////////////////////////////
18391 . ////////////////////////////////////////////////////////////////////////////
18392
18393 .chapter "The manualroute router" "CHID7"
18394 .scindex IIDmanrou1 "&(manualroute)& router"
18395 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18396 .cindex "domain" "manually routing"
18397 The &(manualroute)& router is so-called because it provides a way of manually
18398 routing an address according to its domain. It is mainly used when you want to
18399 route addresses to remote hosts according to your own rules, bypassing the
18400 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18401 route to local transports, a facility that may be useful if you want to save
18402 messages for dial-in hosts in local files.
18403
18404 The &(manualroute)& router compares a list of domain patterns with the domain
18405 it is trying to route. If there is no match, the router declines. Each pattern
18406 has associated with it a list of hosts and some other optional data, which may
18407 include a transport. The combination of a pattern and its data is called a
18408 &"routing rule"&. For patterns that do not have an associated transport, the
18409 generic &%transport%& option must specify a transport, unless the router is
18410 being used purely for verification (see &%verify_only%&).
18411
18412 .vindex "&$host$&"
18413 In the case of verification, matching the domain pattern is sufficient for the
18414 router to accept the address. When actually routing an address for delivery,
18415 an address that matches a domain pattern is queued for the associated
18416 transport. If the transport is not a local one, a host list must be associated
18417 with the pattern; IP addresses are looked up for the hosts, and these are
18418 passed to the transport along with the mail address. For local transports, a
18419 host list is optional. If it is present, it is passed in &$host$& as a single
18420 text string.
18421
18422 The list of routing rules can be provided as an inline string in
18423 &%route_list%&, or the data can be obtained by looking up the domain in a file
18424 or database by setting &%route_data%&. Only one of these settings may appear in
18425 any one instance of &(manualroute)&. The format of routing rules is described
18426 below, following the list of private options.
18427
18428
18429 .section "Private options for manualroute" "SECTprioptman"
18430
18431 .cindex "options" "&(manualroute)& router"
18432 The private options for the &(manualroute)& router are as follows:
18433
18434 .option host_all_ignored manualroute string defer
18435 See &%host_find_failed%&.
18436
18437 .option host_find_failed manualroute string freeze
18438 This option controls what happens when &(manualroute)& tries to find an IP
18439 address for a host, and the host does not exist. The option can be set to one
18440 of the following values:
18441 .code
18442 decline
18443 defer
18444 fail
18445 freeze
18446 ignore
18447 pass
18448 .endd
18449 The default (&"freeze"&) assumes that this state is a serious configuration
18450 error. The difference between &"pass"& and &"decline"& is that the former
18451 forces the address to be passed to the next router (or the router defined by
18452 &%pass_router%&),
18453 .oindex "&%more%&"
18454 overriding &%no_more%&, whereas the latter passes the address to the next
18455 router only if &%more%& is true.
18456
18457 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18458 cannot be found. If all the hosts in the list are ignored, the behaviour is
18459 controlled by the &%host_all_ignored%& option. This takes the same values
18460 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18461
18462 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18463 state; if a host lookup gets a temporary error, delivery is deferred unless the
18464 generic &%pass_on_timeout%& option is set.
18465
18466
18467 .option hosts_randomize manualroute boolean false
18468 .cindex "randomized host list"
18469 .cindex "host" "list of; randomized"
18470 If this option is set, the order of the items in a host list in a routing rule
18471 is randomized each time the list is used, unless an option in the routing rule
18472 overrides (see below). Randomizing the order of a host list can be used to do
18473 crude load sharing. However, if more than one mail address is routed by the
18474 same router to the same host list, the host lists are considered to be the same
18475 (even though they may be randomized into different orders) for the purpose of
18476 deciding whether to batch the deliveries into a single SMTP transaction.
18477
18478 When &%hosts_randomize%& is true, a host list may be split
18479 into groups whose order is separately randomized. This makes it possible to
18480 set up MX-like behaviour. The boundaries between groups are indicated by an
18481 item that is just &`+`& in the host list. For example:
18482 .code
18483 route_list = * host1:host2:host3:+:host4:host5
18484 .endd
18485 The order of the first three hosts and the order of the last two hosts is
18486 randomized for each use, but the first three always end up before the last two.
18487 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18488 randomized host list is passed to an &(smtp)& transport that also has
18489 &%hosts_randomize set%&, the list is not re-randomized.
18490
18491
18492 .option route_data manualroute string&!! unset
18493 If this option is set, it must expand to yield the data part of a routing rule.
18494 Typically, the expansion string includes a lookup based on the domain. For
18495 example:
18496 .code
18497 route_data = ${lookup{$domain}dbm{/etc/routes}}
18498 .endd
18499 If the expansion is forced to fail, or the result is an empty string, the
18500 router declines. Other kinds of expansion failure cause delivery to be
18501 deferred.
18502
18503
18504 .option route_list manualroute "string list" unset
18505 This string is a list of routing rules, in the form defined below. Note that,
18506 unlike most string lists, the items are separated by semicolons. This is so
18507 that they may contain colon-separated host lists.
18508
18509
18510 .option same_domain_copy_routing manualroute boolean false
18511 .cindex "address" "copying routing"
18512 Addresses with the same domain are normally routed by the &(manualroute)&
18513 router to the same list of hosts. However, this cannot be presumed, because the
18514 router options and preconditions may refer to the local part of the address. By
18515 default, therefore, Exim routes each address in a message independently. DNS
18516 servers run caches, so repeated DNS lookups are not normally expensive, and in
18517 any case, personal messages rarely have more than a few recipients.
18518
18519 If you are running mailing lists with large numbers of subscribers at the same
18520 domain, and you are using a &(manualroute)& router which is independent of the
18521 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18522 lookups for identical domains in one message. In this case, when
18523 &(manualroute)& routes an address to a remote transport, any other unrouted
18524 addresses in the message that have the same domain are automatically given the
18525 same routing without processing them independently. However, this is only done
18526 if &%headers_add%& and &%headers_remove%& are unset.
18527
18528
18529
18530
18531 .section "Routing rules in route_list" "SECID120"
18532 The value of &%route_list%& is a string consisting of a sequence of routing
18533 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18534 entered as two semicolons. Alternatively, the list separator can be changed as
18535 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18536 Empty rules are ignored. The format of each rule is
18537 .display
18538 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18539 .endd
18540 The following example contains two rules, each with a simple domain pattern and
18541 no options:
18542 .code
18543 route_list = \
18544   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18545   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18546 .endd
18547 The three parts of a rule are separated by white space. The pattern and the
18548 list of hosts can be enclosed in quotes if necessary, and if they are, the
18549 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18550 single domain pattern, which is the only mandatory item in the rule. The
18551 pattern is in the same format as one item in a domain list (see section
18552 &<<SECTdomainlist>>&),
18553 except that it may not be the name of an interpolated file.
18554 That is, it may be wildcarded, or a regular expression, or a file or database
18555 lookup (with semicolons doubled, because of the use of semicolon as a separator
18556 in a &%route_list%&).
18557
18558 The rules in &%route_list%& are searched in order until one of the patterns
18559 matches the domain that is being routed. The list of hosts and then options are
18560 then used as described below. If there is no match, the router declines. When
18561 &%route_list%& is set, &%route_data%& must not be set.
18562
18563
18564
18565 .section "Routing rules in route_data" "SECID121"
18566 The use of &%route_list%& is convenient when there are only a small number of
18567 routing rules. For larger numbers, it is easier to use a file or database to
18568 hold the routing information, and use the &%route_data%& option instead.
18569 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18570 Most commonly, &%route_data%& is set as a string that contains an
18571 expansion lookup. For example, suppose we place two routing rules in a file
18572 like this:
18573 .code
18574 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18575 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18576 .endd
18577 This data can be accessed by setting
18578 .code
18579 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18580 .endd
18581 Failure of the lookup results in an empty string, causing the router to
18582 decline. However, you do not have to use a lookup in &%route_data%&. The only
18583 requirement is that the result of expanding the string is a list of hosts,
18584 possibly followed by options, separated by white space. The list of hosts must
18585 be enclosed in quotes if it contains white space.
18586
18587
18588
18589
18590 .section "Format of the list of hosts" "SECID122"
18591 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18592 always separately expanded before use. If the expansion fails, the router
18593 declines. The result of the expansion must be a colon-separated list of names
18594 and/or IP addresses, optionally also including ports. The format of each item
18595 in the list is described in the next section. The list separator can be changed
18596 as described in section &<<SECTlistconstruct>>&.
18597
18598 If the list of hosts was obtained from a &%route_list%& item, the following
18599 variables are set during its expansion:
18600
18601 .ilist
18602 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18603 If the domain was matched against a regular expression, the numeric variables
18604 &$1$&, &$2$&, etc. may be set. For example:
18605 .code
18606 route_list = ^domain(\d+)   host-$1.text.example
18607 .endd
18608 .next
18609 &$0$& is always set to the entire domain.
18610 .next
18611 &$1$& is also set when partial matching is done in a file lookup.
18612
18613 .next
18614 .vindex "&$value$&"
18615 If the pattern that matched the domain was a lookup item, the data that was
18616 looked up is available in the expansion variable &$value$&. For example:
18617 .code
18618 route_list = lsearch;;/some/file.routes  $value
18619 .endd
18620 .endlist
18621
18622 Note the doubling of the semicolon in the pattern that is necessary because
18623 semicolon is the default route list separator.
18624
18625
18626
18627 .section "Format of one host item" "SECTformatonehostitem"
18628 Each item in the list of hosts is either a host name or an IP address,
18629 optionally with an attached port number. When no port is given, an IP address
18630 is not enclosed in brackets. When a port is specified, it overrides the port
18631 specification on the transport. The port is separated from the name or address
18632 by a colon. This leads to some complications:
18633
18634 .ilist
18635 Because colon is the default separator for the list of hosts, either
18636 the colon that specifies a port must be doubled, or the list separator must
18637 be changed. The following two examples have the same effect:
18638 .code
18639 route_list = * "host1.tld::1225 : host2.tld::1226"
18640 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18641 .endd
18642 .next
18643 When IPv6 addresses are involved, it gets worse, because they contain
18644 colons of their own. To make this case easier, it is permitted to
18645 enclose an IP address (either v4 or v6) in square brackets if a port
18646 number follows. For example:
18647 .code
18648 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18649 .endd
18650 .endlist
18651
18652 .section "How the list of hosts is used" "SECThostshowused"
18653 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18654 the hosts is tried, in the order specified, when carrying out the SMTP
18655 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18656 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18657 transport.
18658
18659 Hosts may be listed by name or by IP address. An unadorned name in the list of
18660 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18661 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18662 records in the DNS. For example:
18663 .code
18664 route_list = *  x.y.z:p.q.r/MX:e.f.g
18665 .endd
18666 If this feature is used with a port specifier, the port must come last. For
18667 example:
18668 .code
18669 route_list = *  dom1.tld/mx::1225
18670 .endd
18671 If the &%hosts_randomize%& option is set, the order of the items in the list is
18672 randomized before any lookups are done. Exim then scans the list; for any name
18673 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18674 be an interface on the local host and the item is not the first in the list,
18675 Exim discards it and any subsequent items. If it is the first item, what
18676 happens is controlled by the
18677 .oindex "&%self%&" "in &(manualroute)& router"
18678 &%self%& option of the router.
18679
18680 A name on the list that is followed by &`/MX`& is replaced with the list of
18681 hosts obtained by looking up MX records for the name. This is always a DNS
18682 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18683 below) are not relevant here. The order of these hosts is determined by the
18684 preference values in the MX records, according to the usual rules. Because
18685 randomizing happens before the MX lookup, it does not affect the order that is
18686 defined by MX preferences.
18687
18688 If the local host is present in the sublist obtained from MX records, but is
18689 not the most preferred host in that list, it and any equally or less
18690 preferred hosts are removed before the sublist is inserted into the main list.
18691
18692 If the local host is the most preferred host in the MX list, what happens
18693 depends on where in the original list of hosts the &`/MX`& item appears. If it
18694 is not the first item (that is, there are previous hosts in the main list),
18695 Exim discards this name and any subsequent items in the main list.
18696
18697 If the MX item is first in the list of hosts, and the local host is the
18698 most preferred host, what happens is controlled by the &%self%& option of the
18699 router.
18700
18701 DNS failures when lookup up the MX records are treated in the same way as DNS
18702 failures when looking up IP addresses: &%pass_on_timeout%& and
18703 &%host_find_failed%& are used when relevant.
18704
18705 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18706 whether obtained from an MX lookup or not.
18707
18708
18709
18710 .section "How the options are used" "SECThowoptused"
18711 The options are a sequence of words; in practice no more than three are ever
18712 present. One of the words can be the name of a transport; this overrides the
18713 &%transport%& option on the router for this particular routing rule only. The
18714 other words (if present) control randomization of the list of hosts on a
18715 per-rule basis, and how the IP addresses of the hosts are to be found when
18716 routing to a remote transport. These options are as follows:
18717
18718 .ilist
18719 &%randomize%&: randomize the order of the hosts in this list, overriding the
18720 setting of &%hosts_randomize%& for this routing rule only.
18721 .next
18722 &%no_randomize%&: do not randomize the order of the hosts in this list,
18723 overriding the setting of &%hosts_randomize%& for this routing rule only.
18724 .next
18725 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18726 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18727 also look in &_/etc/hosts_& or other sources of information.
18728 .next
18729 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18730 no address records are found. If there is a temporary DNS error (such as a
18731 timeout), delivery is deferred.
18732 .endlist
18733
18734 For example:
18735 .code
18736 route_list = domain1  host1:host2:host3  randomize bydns;\
18737              domain2  host4:host5
18738 .endd
18739 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18740 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18741 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18742 or &[gethostbyname()]&, and the result of the lookup is the result of that
18743 call.
18744
18745 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18746 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18747 instead of TRY_AGAIN. That is why the default action is to try a DNS
18748 lookup first. Only if that gives a definite &"no such host"& is the local
18749 function called.
18750
18751
18752
18753 If no IP address for a host can be found, what happens is controlled by the
18754 &%host_find_failed%& option.
18755
18756 .vindex "&$host$&"
18757 When an address is routed to a local transport, IP addresses are not looked up.
18758 The host list is passed to the transport in the &$host$& variable.
18759
18760
18761
18762 .section "Manualroute examples" "SECID123"
18763 In some of the examples that follow, the presence of the &%remote_smtp%&
18764 transport, as defined in the default configuration file, is assumed:
18765
18766 .ilist
18767 .cindex "smart host" "example router"
18768 The &(manualroute)& router can be used to forward all external mail to a
18769 &'smart host'&. If you have set up, in the main part of the configuration, a
18770 named domain list that contains your local domains, for example:
18771 .code
18772 domainlist local_domains = my.domain.example
18773 .endd
18774 You can arrange for all other domains to be routed to a smart host by making
18775 your first router something like this:
18776 .code
18777 smart_route:
18778   driver = manualroute
18779   domains = !+local_domains
18780   transport = remote_smtp
18781   route_list = * smarthost.ref.example
18782 .endd
18783 This causes all non-local addresses to be sent to the single host
18784 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18785 they are tried in order
18786 (but you can use &%hosts_randomize%& to vary the order each time).
18787 Another way of configuring the same thing is this:
18788 .code
18789 smart_route:
18790   driver = manualroute
18791   transport = remote_smtp
18792   route_list = !+local_domains  smarthost.ref.example
18793 .endd
18794 There is no difference in behaviour between these two routers as they stand.
18795 However, they behave differently if &%no_more%& is added to them. In the first
18796 example, the router is skipped if the domain does not match the &%domains%&
18797 precondition; the following router is always tried. If the router runs, it
18798 always matches the domain and so can never decline. Therefore, &%no_more%&
18799 would have no effect. In the second case, the router is never skipped; it
18800 always runs. However, if it doesn't match the domain, it declines. In this case
18801 &%no_more%& would prevent subsequent routers from running.
18802
18803 .next
18804 .cindex "mail hub example"
18805 A &'mail hub'& is a host which receives mail for a number of domains via MX
18806 records in the DNS and delivers it via its own private routing mechanism. Often
18807 the final destinations are behind a firewall, with the mail hub being the one
18808 machine that can connect to machines both inside and outside the firewall. The
18809 &(manualroute)& router is usually used on a mail hub to route incoming messages
18810 to the correct hosts. For a small number of domains, the routing can be inline,
18811 using the &%route_list%& option, but for a larger number a file or database
18812 lookup is easier to manage.
18813
18814 If the domain names are in fact the names of the machines to which the mail is
18815 to be sent by the mail hub, the configuration can be quite simple. For
18816 example:
18817 .code
18818 hub_route:
18819   driver = manualroute
18820   transport = remote_smtp
18821   route_list = *.rhodes.tvs.example  $domain
18822 .endd
18823 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18824 whose names are the same as the mail domains. A similar approach can be taken
18825 if the host name can be obtained from the domain name by a string manipulation
18826 that the expansion facilities can handle. Otherwise, a lookup based on the
18827 domain can be used to find the host:
18828 .code
18829 through_firewall:
18830   driver = manualroute
18831   transport = remote_smtp
18832   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18833 .endd
18834 The result of the lookup must be the name or IP address of the host (or
18835 hosts) to which the address is to be routed. If the lookup fails, the route
18836 data is empty, causing the router to decline. The address then passes to the
18837 next router.
18838
18839 .next
18840 .cindex "batched SMTP output example"
18841 .cindex "SMTP" "batched outgoing; example"
18842 You can use &(manualroute)& to deliver messages to pipes or files in batched
18843 SMTP format for onward transportation by some other means. This is one way of
18844 storing mail for a dial-up host when it is not connected. The route list entry
18845 can be as simple as a single domain name in a configuration like this:
18846 .code
18847 save_in_file:
18848   driver = manualroute
18849   transport = batchsmtp_appendfile
18850   route_list = saved.domain.example
18851 .endd
18852 though often a pattern is used to pick up more than one domain. If there are
18853 several domains or groups of domains with different transport requirements,
18854 different transports can be listed in the routing information:
18855 .code
18856 save_in_file:
18857   driver = manualroute
18858   route_list = \
18859     *.saved.domain1.example  $domain  batch_appendfile; \
18860     *.saved.domain2.example  \
18861       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18862       batch_pipe
18863 .endd
18864 .vindex "&$domain$&"
18865 .vindex "&$host$&"
18866 The first of these just passes the domain in the &$host$& variable, which
18867 doesn't achieve much (since it is also in &$domain$&), but the second does a
18868 file lookup to find a value to pass, causing the router to decline to handle
18869 the address if the lookup fails.
18870
18871 .next
18872 .cindex "UUCP" "example of router for"
18873 Routing mail directly to UUCP software is a specific case of the use of
18874 &(manualroute)& in a gateway to another mail environment. This is an example of
18875 one way it can be done:
18876 .code
18877 # Transport
18878 uucp:
18879   driver = pipe
18880   user = nobody
18881   command = /usr/local/bin/uux -r - \
18882     ${substr_-5:$host}!rmail ${local_part}
18883   return_fail_output = true
18884
18885 # Router
18886 uucphost:
18887   transport = uucp
18888   driver = manualroute
18889   route_data = \
18890     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18891 .endd
18892 The file &_/usr/local/exim/uucphosts_& contains entries like
18893 .code
18894 darksite.ethereal.example:           darksite.UUCP
18895 .endd
18896 It can be set up more simply without adding and removing &".UUCP"& but this way
18897 makes clear the distinction between the domain name
18898 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18899 .endlist
18900 .ecindex IIDmanrou1
18901 .ecindex IIDmanrou2
18902
18903
18904
18905
18906
18907
18908
18909
18910 . ////////////////////////////////////////////////////////////////////////////
18911 . ////////////////////////////////////////////////////////////////////////////
18912
18913 .chapter "The queryprogram router" "CHAPdriverlast"
18914 .scindex IIDquerou1 "&(queryprogram)& router"
18915 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18916 .cindex "routing" "by external program"
18917 The &(queryprogram)& router routes an address by running an external command
18918 and acting on its output. This is an expensive way to route, and is intended
18919 mainly for use in lightly-loaded systems, or for performing experiments.
18920 However, if it is possible to use the precondition options (&%domains%&,
18921 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18922 be used in special cases, even on a busy host. There are the following private
18923 options:
18924 .cindex "options" "&(queryprogram)& router"
18925
18926 .option command queryprogram string&!! unset
18927 This option must be set. It specifies the command that is to be run. The
18928 command is split up into a command name and arguments, and then each is
18929 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18930 &<<CHAPpipetransport>>&).
18931
18932
18933 .option command_group queryprogram string unset
18934 .cindex "gid (group id)" "in &(queryprogram)& router"
18935 This option specifies a gid to be set when running the command while routing an
18936 address for deliver. It must be set if &%command_user%& specifies a numerical
18937 uid. If it begins with a digit, it is interpreted as the numerical value of the
18938 gid. Otherwise it is looked up using &[getgrnam()]&.
18939
18940
18941 .option command_user queryprogram string unset
18942 .cindex "uid (user id)" "for &(queryprogram)&"
18943 This option must be set. It specifies the uid which is set when running the
18944 command while routing an address for delivery. If the value begins with a digit,
18945 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18946 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18947 not set, a value for the gid also.
18948
18949 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18950 root, which it does during a normal delivery in a conventional configuration.
18951 However, when an address is being verified during message reception, Exim is
18952 usually running as the Exim user, not as root. If the &(queryprogram)& router
18953 is called from a non-root process, Exim cannot change uid or gid before running
18954 the command. In this circumstance the command runs under the current uid and
18955 gid.
18956
18957
18958 .option current_directory queryprogram string /
18959 This option specifies an absolute path which is made the current directory
18960 before running the command.
18961
18962
18963 .option timeout queryprogram time 1h
18964 If the command does not complete within the timeout period, its process group
18965 is killed and the message is frozen. A value of zero time specifies no
18966 timeout.
18967
18968
18969 The standard output of the command is connected to a pipe, which is read when
18970 the command terminates. It should consist of a single line of output,
18971 containing up to five fields, separated by white space. The maximum length of
18972 the line is 1023 characters. Longer lines are silently truncated. The first
18973 field is one of the following words (case-insensitive):
18974
18975 .ilist
18976 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18977 below).
18978 .next
18979 &'Decline'&: the router declines; pass the address to the next router, unless
18980 &%no_more%& is set.
18981 .next
18982 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18983 subsequent text on the line is an error message. If the router is run as part
18984 of address verification during an incoming SMTP message, the message is
18985 included in the SMTP response.
18986 .next
18987 &'Defer'&: routing could not be completed at this time; try again later. Any
18988 subsequent text on the line is an error message which is logged. It is not
18989 included in any SMTP response.
18990 .next
18991 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18992 .next
18993 &'Pass'&: pass the address to the next router (or the router specified by
18994 &%pass_router%&), overriding &%no_more%&.
18995 .next
18996 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18997 new addresses, which are routed independently, starting with the first router,
18998 or the router specified by &%redirect_router%&, if set.
18999 .endlist
19000
19001 When the first word is &'accept'&, the remainder of the line consists of a
19002 number of keyed data values, as follows (split into two lines here, to fit on
19003 the page):
19004 .code
19005 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19006 LOOKUP=byname|bydns DATA=<text>
19007 .endd
19008 The data items can be given in any order, and all are optional. If no transport
19009 is included, the transport specified by the generic &%transport%& option is
19010 used. The list of hosts and the lookup type are needed only if the transport is
19011 an &(smtp)& transport that does not itself supply a list of hosts.
19012
19013 The format of the list of hosts is the same as for the &(manualroute)& router.
19014 As well as host names and IP addresses with optional port numbers, as described
19015 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19016 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19017 (see section &<<SECThostshowused>>&).
19018
19019 If the lookup type is not specified, Exim behaves as follows when trying to
19020 find an IP address for each host: First, a DNS lookup is done. If this yields
19021 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19022 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19023 result of the lookup is the result of that call.
19024
19025 .vindex "&$address_data$&"
19026 If the DATA field is set, its value is placed in the &$address_data$&
19027 variable. For example, this return line
19028 .code
19029 accept hosts=x1.y.example:x2.y.example data="rule1"
19030 .endd
19031 routes the address to the default transport, passing a list of two hosts. When
19032 the transport runs, the string &"rule1"& is in &$address_data$&.
19033 .ecindex IIDquerou1
19034 .ecindex IIDquerou2
19035
19036
19037
19038
19039 . ////////////////////////////////////////////////////////////////////////////
19040 . ////////////////////////////////////////////////////////////////////////////
19041
19042 .chapter "The redirect router" "CHAPredirect"
19043 .scindex IIDredrou1 "&(redirect)& router"
19044 .scindex IIDredrou2 "routers" "&(redirect)&"
19045 .cindex "alias file" "in a &(redirect)& router"
19046 .cindex "address redirection" "&(redirect)& router"
19047 The &(redirect)& router handles several kinds of address redirection. Its most
19048 common uses are for resolving local part aliases from a central alias file
19049 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19050 files, but it has many other potential uses. The incoming address can be
19051 redirected in several different ways:
19052
19053 .ilist
19054 It can be replaced by one or more new addresses which are themselves routed
19055 independently.
19056 .next
19057 It can be routed to be delivered to a given file or directory.
19058 .next
19059 It can be routed to be delivered to a specified pipe command.
19060 .next
19061 It can cause an automatic reply to be generated.
19062 .next
19063 It can be forced to fail, optionally with a custom error message.
19064 .next
19065 It can be temporarily deferred, optionally with a custom message.
19066 .next
19067 It can be discarded.
19068 .endlist
19069
19070 The generic &%transport%& option must not be set for &(redirect)& routers.
19071 However, there are some private options which define transports for delivery to
19072 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19073 &%pipe_transport%& and &%reply_transport%& descriptions below.
19074
19075 .new
19076 If success DSNs have been requested
19077 .cindex "DSN" "success"
19078 .cindex "Delivery Status Notification" "success"
19079 redirection triggers one and the DSN options are not passed any further.
19080 .wen
19081
19082
19083
19084 .section "Redirection data" "SECID124"
19085 The router operates by interpreting a text string which it obtains either by
19086 expanding the contents of the &%data%& option, or by reading the entire
19087 contents of a file whose name is given in the &%file%& option. These two
19088 options are mutually exclusive. The first is commonly used for handling system
19089 aliases, in a configuration like this:
19090 .code
19091 system_aliases:
19092   driver = redirect
19093   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19094 .endd
19095 If the lookup fails, the expanded string in this example is empty. When the
19096 expansion of &%data%& results in an empty string, the router declines. A forced
19097 expansion failure also causes the router to decline; other expansion failures
19098 cause delivery to be deferred.
19099
19100 A configuration using &%file%& is commonly used for handling users'
19101 &_.forward_& files, like this:
19102 .code
19103 userforward:
19104   driver = redirect
19105   check_local_user
19106   file = $home/.forward
19107   no_verify
19108 .endd
19109 If the file does not exist, or causes no action to be taken (for example, it is
19110 empty or consists only of comments), the router declines. &*Warning*&: This
19111 is not the case when the file contains syntactically valid items that happen to
19112 yield empty addresses, for example, items containing only RFC 2822 address
19113 comments.
19114
19115
19116
19117 .section "Forward files and address verification" "SECID125"
19118 .cindex "address redirection" "while verifying"
19119 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19120 &_.forward_& files, as in the example above. There are two reasons for this:
19121
19122 .ilist
19123 When Exim is receiving an incoming SMTP message from a remote host, it is
19124 running under the Exim uid, not as root. Exim is unable to change uid to read
19125 the file as the user, and it may not be able to read it as the Exim user. So in
19126 practice the router may not be able to operate.
19127 .next
19128 However, even when the router can operate, the existence of a &_.forward_& file
19129 is unimportant when verifying an address. What should be checked is whether the
19130 local part is a valid user name or not. Cutting out the redirection processing
19131 saves some resources.
19132 .endlist
19133
19134
19135
19136
19137
19138
19139 .section "Interpreting redirection data" "SECID126"
19140 .cindex "Sieve filter" "specifying in redirection data"
19141 .cindex "filter" "specifying in redirection data"
19142 The contents of the data string, whether obtained from &%data%& or &%file%&,
19143 can be interpreted in two different ways:
19144
19145 .ilist
19146 If the &%allow_filter%& option is set true, and the data begins with the text
19147 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19148 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19149 respectively. Details of the syntax and semantics of filter files are described
19150 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19151 document is intended for use by end users.
19152 .next
19153 Otherwise, the data must be a comma-separated list of redirection items, as
19154 described in the next section.
19155 .endlist
19156
19157 When a message is redirected to a file (a &"mail folder"&), the file name given
19158 in a non-filter redirection list must always be an absolute path. A filter may
19159 generate a relative path &-- how this is handled depends on the transport's
19160 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19161 for the &(appendfile)& transport.
19162
19163
19164
19165 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19166 .cindex "address redirection" "non-filter list items"
19167 When the redirection data is not an Exim or Sieve filter, for example, if it
19168 comes from a conventional alias or forward file, it consists of a list of
19169 addresses, file names, pipe commands, or certain special items (see section
19170 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19171 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19172 depending on their default values. The items in the list are separated by
19173 commas or newlines.
19174 If a comma is required in an item, the entire item must be enclosed in double
19175 quotes.
19176
19177 Lines starting with a # character are comments, and are ignored, and # may
19178 also appear following a comma, in which case everything between the # and the
19179 next newline character is ignored.
19180
19181 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19182 double quotes are retained because some forms of mail address require their use
19183 (but never to enclose the entire address). In the following description,
19184 &"item"& refers to what remains after any surrounding double quotes have been
19185 removed.
19186
19187 .vindex "&$local_part$&"
19188 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19189 and the expansion contains a reference to &$local_part$&, you should make use
19190 of the &%quote_local_part%& expansion operator, in case the local part contains
19191 special characters. For example, to redirect all mail for the domain
19192 &'obsolete.example'&, retaining the existing local part, you could use this
19193 setting:
19194 .code
19195 data = ${quote_local_part:$local_part}@newdomain.example
19196 .endd
19197
19198
19199 .section "Redirecting to a local mailbox" "SECTredlocmai"
19200 .cindex "routing" "loops in"
19201 .cindex "loop" "while routing, avoidance of"
19202 .cindex "address redirection" "to local mailbox"
19203 A redirection item may safely be the same as the address currently under
19204 consideration. This does not cause a routing loop, because a router is
19205 automatically skipped if any ancestor of the address that is being processed
19206 is the same as the current address and was processed by the current router.
19207 Such an address is therefore passed to the following routers, so it is handled
19208 as if there were no redirection. When making this loop-avoidance test, the
19209 complete local part, including any prefix or suffix, is used.
19210
19211 .cindex "address redirection" "local part without domain"
19212 Specifying the same local part without a domain is a common usage in personal
19213 filter files when the user wants to have messages delivered to the local
19214 mailbox and also forwarded elsewhere. For example, the user whose login is
19215 &'cleo'& might have a &_.forward_& file containing this:
19216 .code
19217 cleo, cleopatra@egypt.example
19218 .endd
19219 .cindex "backslash in alias file"
19220 .cindex "alias file" "backslash in"
19221 For compatibility with other MTAs, such unqualified local parts may be
19222 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19223 it does make a difference if more than one domain is being handled
19224 synonymously.
19225
19226 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19227 2822 address that does not include a domain, the item is qualified using the
19228 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19229 addresses are qualified using the value in &%qualify_recipient%&, but you can
19230 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19231
19232 Care must be taken if there are alias names for local users.
19233 Consider an MTA handling a single local domain where the system alias file
19234 contains:
19235 .code
19236 Sam.Reman: spqr
19237 .endd
19238 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19239 messages in the local mailbox, and also forward copies elsewhere. He creates
19240 this forward file:
19241 .code
19242 Sam.Reman, spqr@reme.elsewhere.example
19243 .endd
19244 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19245 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19246 second time round, because it has previously routed it,
19247 and the following routers presumably cannot handle the alias. The forward file
19248 should really contain
19249 .code
19250 spqr, spqr@reme.elsewhere.example
19251 .endd
19252 but because this is such a common error, the &%check_ancestor%& option (see
19253 below) exists to provide a way to get round it. This is normally set on a
19254 &(redirect)& router that is handling users' &_.forward_& files.
19255
19256
19257
19258 .section "Special items in redirection lists" "SECTspecitredli"
19259 In addition to addresses, the following types of item may appear in redirection
19260 lists (that is, in non-filter redirection data):
19261
19262 .ilist
19263 .cindex "pipe" "in redirection list"
19264 .cindex "address redirection" "to pipe"
19265 An item is treated as a pipe command if it begins with &"|"& and does not parse
19266 as a valid RFC 2822 address that includes a domain. A transport for running the
19267 command must be specified by the &%pipe_transport%& option.
19268 Normally, either the router or the transport specifies a user and a group under
19269 which to run the delivery. The default is to use the Exim user and group.
19270
19271 Single or double quotes can be used for enclosing the individual arguments of
19272 the pipe command; no interpretation of escapes is done for single quotes. If
19273 the command contains a comma character, it is necessary to put the whole item
19274 in double quotes, for example:
19275 .code
19276 "|/some/command ready,steady,go"
19277 .endd
19278 since items in redirection lists are terminated by commas. Do not, however,
19279 quote just the command. An item such as
19280 .code
19281 |"/some/command ready,steady,go"
19282 .endd
19283 is interpreted as a pipe with a rather strange command name, and no arguments.
19284
19285 Note that the above example assumes that the text comes from a lookup source
19286 of some sort, so that the quotes are part of the data.  If composing a
19287 redirect router with a &%data%& option directly specifying this command, the
19288 quotes will be used by the configuration parser to define the extent of one
19289 string, but will not be passed down into the redirect router itself.  There
19290 are two main approaches to get around this: escape quotes to be part of the
19291 data itself, or avoid using this mechanism and instead create a custom
19292 transport with the &%command%& option set and reference that transport from
19293 an &%accept%& router.
19294
19295 .next
19296 .cindex "file" "in redirection list"
19297 .cindex "address redirection" "to file"
19298 An item is interpreted as a path name if it begins with &"/"& and does not
19299 parse as a valid RFC 2822 address that includes a domain. For example,
19300 .code
19301 /home/world/minbari
19302 .endd
19303 is treated as a file name, but
19304 .code
19305 /s=molari/o=babylon/@x400gate.way
19306 .endd
19307 is treated as an address. For a file name, a transport must be specified using
19308 the &%file_transport%& option. However, if the generated path name ends with a
19309 forward slash character, it is interpreted as a directory name rather than a
19310 file name, and &%directory_transport%& is used instead.
19311
19312 Normally, either the router or the transport specifies a user and a group under
19313 which to run the delivery. The default is to use the Exim user and group.
19314
19315 .cindex "&_/dev/null_&"
19316 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19317 bypassed at a high level, and the log entry shows &"**bypassed**"&
19318 instead of a transport name. In this case the user and group are not used.
19319
19320 .next
19321 .cindex "included address list"
19322 .cindex "address redirection" "included external list"
19323 If an item is of the form
19324 .code
19325 :include:<path name>
19326 .endd
19327 a list of further items is taken from the given file and included at that
19328 point. &*Note*&: Such a file can not be a filter file; it is just an
19329 out-of-line addition to the list. The items in the included list are separated
19330 by commas or newlines and are not subject to expansion. If this is the first
19331 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19332 the alias name. This example is incorrect:
19333 .code
19334 list1    :include:/opt/lists/list1
19335 .endd
19336 It must be given as
19337 .code
19338 list1:   :include:/opt/lists/list1
19339 .endd
19340 .next
19341 .cindex "address redirection" "to black hole"
19342 Sometimes you want to throw away mail to a particular local part. Making the
19343 &%data%& option expand to an empty string does not work, because that causes
19344 the router to decline. Instead, the alias item
19345 .cindex "black hole"
19346 .cindex "abandoning mail"
19347 &':blackhole:'& can be used. It does what its name implies. No delivery is
19348 done, and no error message is generated. This has the same effect as specifing
19349 &_/dev/null_& as a destination, but it can be independently disabled.
19350
19351 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19352 delivery is done for the original local part, even if other redirection items
19353 are present. If you are generating a multi-item list (for example, by reading a
19354 database) and need the ability to provide a no-op item, you must use
19355 &_/dev/null_&.
19356
19357 .next
19358 .cindex "delivery" "forcing failure"
19359 .cindex "delivery" "forcing deferral"
19360 .cindex "failing delivery" "forcing"
19361 .cindex "deferred delivery, forcing"
19362 .cindex "customizing" "failure message"
19363 An attempt to deliver a particular address can be deferred or forced to fail by
19364 redirection items of the form
19365 .code
19366 :defer:
19367 :fail:
19368 .endd
19369 respectively. When a redirection list contains such an item, it applies
19370 to the entire redirection; any other items in the list are ignored. Any
19371 text following &':fail:'& or &':defer:'& is placed in the error text
19372 associated with the failure. For example, an alias file might contain:
19373 .code
19374 X.Employee:  :fail: Gone away, no forwarding address
19375 .endd
19376 In the case of an address that is being verified from an ACL or as the subject
19377 of a
19378 .cindex "VRFY" "error text, display of"
19379 VRFY command, the text is included in the SMTP error response by
19380 default.
19381 .cindex "EXPN" "error text, display of"
19382 The text is not included in the response to an EXPN command. In non-SMTP cases
19383 the text is included in the error message that Exim generates.
19384
19385 .cindex "SMTP" "error codes"
19386 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19387 &':fail:'&. However, if the message starts with three digits followed by a
19388 space, optionally followed by an extended code of the form &'n.n.n'&, also
19389 followed by a space, and the very first digit is the same as the default error
19390 code, the code from the message is used instead. If the very first digit is
19391 incorrect, a panic error is logged, and the default code is used. You can
19392 suppress the use of the supplied code in a redirect router by setting the
19393 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19394 ignored.
19395
19396 .vindex "&$acl_verify_message$&"
19397 In an ACL, an explicitly provided message overrides the default, but the
19398 default message is available in the variable &$acl_verify_message$& and can
19399 therefore be included in a custom message if this is desired.
19400
19401 Normally the error text is the rest of the redirection list &-- a comma does
19402 not terminate it &-- but a newline does act as a terminator. Newlines are not
19403 normally present in alias expansions. In &(lsearch)& lookups they are removed
19404 as part of the continuation process, but they may exist in other kinds of
19405 lookup and in &':include:'& files.
19406
19407 During routing for message delivery (as opposed to verification), a redirection
19408 containing &':fail:'& causes an immediate failure of the incoming address,
19409 whereas &':defer:'& causes the message to remain on the queue so that a
19410 subsequent delivery attempt can happen at a later time. If an address is
19411 deferred for too long, it will ultimately fail, because the normal retry
19412 rules still apply.
19413
19414 .next
19415 .cindex "alias file" "exception to default"
19416 Sometimes it is useful to use a single-key search type with a default (see
19417 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19418 for exceptions to the default. These can be handled by aliasing them to
19419 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19420 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19421 results in an empty redirection list has the same effect.
19422 .endlist
19423
19424
19425 .section "Duplicate addresses" "SECTdupaddr"
19426 .cindex "duplicate addresses"
19427 .cindex "address duplicate, discarding"
19428 .cindex "pipe" "duplicated"
19429 Exim removes duplicate addresses from the list to which it is delivering, so as
19430 to deliver just one copy to each address. This does not apply to deliveries
19431 routed to pipes by different immediate parent addresses, but an indirect
19432 aliasing scheme of the type
19433 .code
19434 pipe:       |/some/command $local_part
19435 localpart1: pipe
19436 localpart2: pipe
19437 .endd
19438 does not work with a message that is addressed to both local parts, because
19439 when the second is aliased to the intermediate local part &"pipe"& it gets
19440 discarded as being the same as a previously handled address. However, a scheme
19441 such as
19442 .code
19443 localpart1: |/some/command $local_part
19444 localpart2: |/some/command $local_part
19445 .endd
19446 does result in two different pipe deliveries, because the immediate parents of
19447 the pipes are distinct.
19448
19449
19450
19451 .section "Repeated redirection expansion" "SECID128"
19452 .cindex "repeated redirection expansion"
19453 .cindex "address redirection" "repeated for each delivery attempt"
19454 When a message cannot be delivered to all of its recipients immediately,
19455 leading to two or more delivery attempts, redirection expansion is carried out
19456 afresh each time for those addresses whose children were not all previously
19457 delivered. If redirection is being used as a mailing list, this can lead to new
19458 members of the list receiving copies of old messages. The &%one_time%& option
19459 can be used to avoid this.
19460
19461
19462 .section "Errors in redirection lists" "SECID129"
19463 .cindex "address redirection" "errors"
19464 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19465 error is skipped, and an entry is written to the main log. This may be useful
19466 for mailing lists that are automatically managed. Otherwise, if an error is
19467 detected while generating the list of new addresses, the original address is
19468 deferred. See also &%syntax_errors_to%&.
19469
19470
19471
19472 .section "Private options for the redirect router" "SECID130"
19473
19474 .cindex "options" "&(redirect)& router"
19475 The private options for the &(redirect)& router are as follows:
19476
19477
19478 .option allow_defer redirect boolean false
19479 Setting this option allows the use of &':defer:'& in non-filter redirection
19480 data, or the &%defer%& command in an Exim filter file.
19481
19482
19483 .option allow_fail redirect boolean false
19484 .cindex "failing delivery" "from filter"
19485 If this option is true, the &':fail:'& item can be used in a redirection list,
19486 and the &%fail%& command may be used in an Exim filter file.
19487
19488
19489 .option allow_filter redirect boolean false
19490 .cindex "filter" "enabling use of"
19491 .cindex "Sieve filter" "enabling use of"
19492 Setting this option allows Exim to interpret redirection data that starts with
19493 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19494 are some features of Exim filter files that some administrators may wish to
19495 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19496
19497 It is also possible to lock out Exim filters or Sieve filters while allowing
19498 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19499
19500
19501 The filter is run using the uid and gid set by the generic &%user%& and
19502 &%group%& options. These take their defaults from the password data if
19503 &%check_local_user%& is set, so in the normal case of users' personal filter
19504 files, the filter is run as the relevant user. When &%allow_filter%& is set
19505 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19506
19507
19508
19509 .option allow_freeze redirect boolean false
19510 .cindex "freezing messages" "allowing in filter"
19511 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19512 This command is more normally encountered in system filters, and is disabled by
19513 default for redirection filters because it isn't something you usually want to
19514 let ordinary users do.
19515
19516
19517
19518 .option check_ancestor redirect boolean false
19519 This option is concerned with handling generated addresses that are the same
19520 as some address in the list of redirection ancestors of the current address.
19521 Although it is turned off by default in the code, it is set in the default
19522 configuration file for handling users' &_.forward_& files. It is recommended
19523 for this use of the &(redirect)& router.
19524
19525 When &%check_ancestor%& is set, if a generated address (including the domain)
19526 is the same as any ancestor of the current address, it is replaced by a copy of
19527 the current address. This helps in the case where local part A is aliased to B,
19528 and B has a &_.forward_& file pointing back to A. For example, within a single
19529 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19530 &_&~jb/.forward_& contains:
19531 .code
19532 \Joe.Bloggs, <other item(s)>
19533 .endd
19534 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19535 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19536 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19537 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19538 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19539 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19540 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19541 original address. See also the &%repeat_use%& option below.
19542
19543
19544 .option check_group redirect boolean "see below"
19545 When the &%file%& option is used, the group owner of the file is checked only
19546 when this option is set. The permitted groups are those listed in the
19547 &%owngroups%& option, together with the user's default group if
19548 &%check_local_user%& is set. If the file has the wrong group, routing is
19549 deferred. The default setting for this option is true if &%check_local_user%&
19550 is set and the &%modemask%& option permits the group write bit, or if the
19551 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19552
19553
19554
19555 .option check_owner redirect boolean "see below"
19556 When the &%file%& option is used, the owner of the file is checked only when
19557 this option is set. If &%check_local_user%& is set, the local user is
19558 permitted; otherwise the owner must be one of those listed in the &%owners%&
19559 option. The default value for this option is true if &%check_local_user%& or
19560 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19561
19562
19563 .option data redirect string&!! unset
19564 This option is mutually exclusive with &%file%&. One or other of them must be
19565 set, but not both. The contents of &%data%& are expanded, and then used as the
19566 list of forwarding items, or as a set of filtering instructions. If the
19567 expansion is forced to fail, or the result is an empty string or a string that
19568 has no effect (consists entirely of comments), the router declines.
19569
19570 When filtering instructions are used, the string must begin with &"#Exim
19571 filter"&, and all comments in the string, including this initial one, must be
19572 terminated with newline characters. For example:
19573 .code
19574 data = #Exim filter\n\
19575        if $h_to: contains Exim then save $home/mail/exim endif
19576 .endd
19577 If you are reading the data from a database where newlines cannot be included,
19578 you can use the &${sg}$& expansion item to turn the escape string of your
19579 choice into a newline.
19580
19581
19582 .option directory_transport redirect string&!! unset
19583 A &(redirect)& router sets up a direct delivery to a directory when a path name
19584 ending with a slash is specified as a new &"address"&. The transport used is
19585 specified by this option, which, after expansion, must be the name of a
19586 configured transport. This should normally be an &(appendfile)& transport.
19587
19588
19589 .option file redirect string&!! unset
19590 This option specifies the name of a file that contains the redirection data. It
19591 is mutually exclusive with the &%data%& option. The string is expanded before
19592 use; if the expansion is forced to fail, the router declines. Other expansion
19593 failures cause delivery to be deferred. The result of a successful expansion
19594 must be an absolute path. The entire file is read and used as the redirection
19595 data. If the data is an empty string or a string that has no effect (consists
19596 entirely of comments), the router declines.
19597
19598 .cindex "NFS" "checking for file existence"
19599 If the attempt to open the file fails with a &"does not exist"& error, Exim
19600 runs a check on the containing directory,
19601 unless &%ignore_enotdir%& is true (see below).
19602 If the directory does not appear to exist, delivery is deferred. This can
19603 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19604 is a mount problem. If the containing directory does exist, but the file does
19605 not, the router declines.
19606
19607
19608 .option file_transport redirect string&!! unset
19609 .vindex "&$address_file$&"
19610 A &(redirect)& router sets up a direct delivery to a file when a path name not
19611 ending in a slash is specified as a new &"address"&. The transport used is
19612 specified by this option, which, after expansion, must be the name of a
19613 configured transport. This should normally be an &(appendfile)& transport. When
19614 it is running, the file name is in &$address_file$&.
19615
19616
19617 .option filter_prepend_home redirect boolean true
19618 When this option is true, if a &(save)& command in an Exim filter specifies a
19619 relative path, and &$home$& is defined, it is automatically prepended to the
19620 relative path. If this option is set false, this action does not happen. The
19621 relative path is then passed to the transport unmodified.
19622
19623
19624 .option forbid_blackhole redirect boolean false
19625 If this option is true, the &':blackhole:'& item may not appear in a
19626 redirection list.
19627
19628
19629 .option forbid_exim_filter redirect boolean false
19630 If this option is set true, only Sieve filters are permitted when
19631 &%allow_filter%& is true.
19632
19633
19634
19635
19636 .option forbid_file redirect boolean false
19637 .cindex "delivery" "to file; forbidding"
19638 .cindex "Sieve filter" "forbidding delivery to a file"
19639 .cindex "Sieve filter" "&""keep""& facility; disabling"
19640 If this option is true, this router may not generate a new address that
19641 specifies delivery to a local file or directory, either from a filter or from a
19642 conventional forward file. This option is forced to be true if &%one_time%& is
19643 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19644 locks out the Sieve's &"keep"& facility.
19645
19646
19647 .option forbid_filter_dlfunc redirect boolean false
19648 .cindex "filter" "locking out certain features"
19649 If this option is true, string expansions in Exim filters are not allowed to
19650 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19651 functions.
19652
19653 .option forbid_filter_existstest redirect boolean false
19654 .cindex "expansion" "statting a file"
19655 If this option is true, string expansions in Exim filters are not allowed to
19656 make use of the &%exists%& condition or the &%stat%& expansion item.
19657
19658 .option forbid_filter_logwrite redirect boolean false
19659 If this option is true, use of the logging facility in Exim filters is not
19660 permitted. Logging is in any case available only if the filter is being run
19661 under some unprivileged uid (which is normally the case for ordinary users'
19662 &_.forward_& files).
19663
19664
19665 .option forbid_filter_lookup redirect boolean false
19666 If this option is true, string expansions in Exim filter files are not allowed
19667 to make use of &%lookup%& items.
19668
19669
19670 .option forbid_filter_perl redirect boolean false
19671 This option has an effect only if Exim is built with embedded Perl support. If
19672 it is true, string expansions in Exim filter files are not allowed to make use
19673 of the embedded Perl support.
19674
19675
19676 .option forbid_filter_readfile redirect boolean false
19677 If this option is true, string expansions in Exim filter files are not allowed
19678 to make use of &%readfile%& items.
19679
19680
19681 .option forbid_filter_readsocket redirect boolean false
19682 If this option is true, string expansions in Exim filter files are not allowed
19683 to make use of &%readsocket%& items.
19684
19685
19686 .option forbid_filter_reply redirect boolean false
19687 If this option is true, this router may not generate an automatic reply
19688 message. Automatic replies can be generated only from Exim or Sieve filter
19689 files, not from traditional forward files. This option is forced to be true if
19690 &%one_time%& is set.
19691
19692
19693 .option forbid_filter_run redirect boolean false
19694 If this option is true, string expansions in Exim filter files are not allowed
19695 to make use of &%run%& items.
19696
19697
19698 .option forbid_include redirect boolean false
19699 If this option is true, items of the form
19700 .code
19701 :include:<path name>
19702 .endd
19703 are not permitted in non-filter redirection lists.
19704
19705
19706 .option forbid_pipe redirect boolean false
19707 .cindex "delivery" "to pipe; forbidding"
19708 If this option is true, this router may not generate a new address which
19709 specifies delivery to a pipe, either from an Exim filter or from a conventional
19710 forward file. This option is forced to be true if &%one_time%& is set.
19711
19712
19713 .option forbid_sieve_filter redirect boolean false
19714 If this option is set true, only Exim filters are permitted when
19715 &%allow_filter%& is true.
19716
19717
19718 .cindex "SMTP" "error codes"
19719 .option forbid_smtp_code redirect boolean false
19720 If this option is set true, any SMTP error codes that are present at the start
19721 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19722 the default codes (451 and 550, respectively) are always used.
19723
19724
19725
19726
19727 .option hide_child_in_errmsg redirect boolean false
19728 .cindex "bounce message" "redirection details; suppressing"
19729 If this option is true, it prevents Exim from quoting a child address if it
19730 generates a bounce or delay message for it. Instead it says &"an address
19731 generated from <&'the top level address'&>"&. Of course, this applies only to
19732 bounces generated locally. If a message is forwarded to another host, &'its'&
19733 bounce may well quote the generated address.
19734
19735
19736 .option ignore_eacces redirect boolean false
19737 .cindex "EACCES"
19738 If this option is set and an attempt to open a redirection file yields the
19739 EACCES error (permission denied), the &(redirect)& router behaves as if the
19740 file did not exist.
19741
19742
19743 .option ignore_enotdir redirect boolean false
19744 .cindex "ENOTDIR"
19745 If this option is set and an attempt to open a redirection file yields the
19746 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19747 router behaves as if the file did not exist.
19748
19749 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19750 router that has the &%file%& option set discovers that the file does not exist
19751 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19752 against unmounted NFS directories. If the parent can not be statted, delivery
19753 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19754 is set, because that option tells Exim to ignore &"something on the path is not
19755 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19756 that some operating systems give ENOENT where others give ENOTDIR.
19757
19758
19759
19760 .option include_directory redirect string unset
19761 If this option is set, the path names of any &':include:'& items in a
19762 redirection list must start with this directory.
19763
19764
19765 .option modemask redirect "octal integer" 022
19766 This specifies mode bits which must not be set for a file specified by the
19767 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19768
19769
19770 .option one_time redirect boolean false
19771 .cindex "one-time aliasing/forwarding expansion"
19772 .cindex "alias file" "one-time expansion"
19773 .cindex "forward file" "one-time expansion"
19774 .cindex "mailing lists" "one-time expansion"
19775 .cindex "address redirection" "one-time expansion"
19776 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19777 files each time it tries to deliver a message causes a problem when one or more
19778 of the generated addresses fails be delivered at the first attempt. The problem
19779 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19780 but of what happens when the redirection list changes during the time that the
19781 message is on Exim's queue. This is particularly true in the case of mailing
19782 lists, where new subscribers might receive copies of messages that were posted
19783 before they subscribed.
19784
19785 If &%one_time%& is set and any addresses generated by the router fail to
19786 deliver at the first attempt, the failing addresses are added to the message as
19787 &"top level"& addresses, and the parent address that generated them is marked
19788 &"delivered"&. Thus, redirection does not happen again at the next delivery
19789 attempt.
19790
19791 &*Warning 1*&: Any header line addition or removal that is specified by this
19792 router would be lost if delivery did not succeed at the first attempt. For this
19793 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19794 permitted when &%one_time%& is set.
19795
19796 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19797 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19798 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19799
19800 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19801 &%one_time%&.
19802
19803 The original top-level address is remembered with each of the generated
19804 addresses, and is output in any log messages. However, any intermediate parent
19805 addresses are not recorded. This makes a difference to the log only if
19806 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19807 typically be used for mailing lists, where there is normally just one level of
19808 expansion.
19809
19810
19811 .option owners redirect "string list" unset
19812 .cindex "ownership" "alias file"
19813 .cindex "ownership" "forward file"
19814 .cindex "alias file" "ownership"
19815 .cindex "forward file" "ownership"
19816 This specifies a list of permitted owners for the file specified by &%file%&.
19817 This list is in addition to the local user when &%check_local_user%& is set.
19818 See &%check_owner%& above.
19819
19820
19821 .option owngroups redirect "string list" unset
19822 This specifies a list of permitted groups for the file specified by &%file%&.
19823 The list is in addition to the local user's primary group when
19824 &%check_local_user%& is set. See &%check_group%& above.
19825
19826
19827 .option pipe_transport redirect string&!! unset
19828 .vindex "&$address_pipe$&"
19829 A &(redirect)& router sets up a direct delivery to a pipe when a string
19830 starting with a vertical bar character is specified as a new &"address"&. The
19831 transport used is specified by this option, which, after expansion, must be the
19832 name of a configured transport. This should normally be a &(pipe)& transport.
19833 When the transport is run, the pipe command is in &$address_pipe$&.
19834
19835
19836 .option qualify_domain redirect string&!! unset
19837 .vindex "&$qualify_recipient$&"
19838 If this option is set, and an unqualified address (one without a domain) is
19839 generated, and that address would normally be qualified by the global setting
19840 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19841 expanding this string. If the expansion fails, the router declines. If you want
19842 to revert to the default, you can have the expansion generate
19843 &$qualify_recipient$&.
19844
19845 This option applies to all unqualified addresses generated by Exim filters,
19846 but for traditional &_.forward_& files, it applies only to addresses that are
19847 not preceded by a backslash. Sieve filters cannot generate unqualified
19848 addresses.
19849
19850 .option qualify_preserve_domain redirect boolean false
19851 .cindex "domain" "in redirection; preserving"
19852 .cindex "preserving domain in redirection"
19853 .cindex "address redirection" "domain; preserving"
19854 If this option is set, the router's local &%qualify_domain%& option must not be
19855 set (a configuration error occurs if it is). If an unqualified address (one
19856 without a domain) is generated, it is qualified with the domain of the parent
19857 address (the immediately preceding ancestor) instead of the global
19858 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19859 this applies whether or not the address is preceded by a backslash.
19860
19861
19862 .option repeat_use redirect boolean true
19863 If this option is set false, the router is skipped for a child address that has
19864 any ancestor that was routed by this router. This test happens before any of
19865 the other preconditions are tested. Exim's default anti-looping rules skip
19866 only when the ancestor is the same as the current address. See also
19867 &%check_ancestor%& above and the generic &%redirect_router%& option.
19868
19869
19870 .option reply_transport redirect string&!! unset
19871 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19872 &%vacation%& command is used in a filter file. The transport used is specified
19873 by this option, which, after expansion, must be the name of a configured
19874 transport. This should normally be an &(autoreply)& transport. Other transports
19875 are unlikely to do anything sensible or useful.
19876
19877
19878 .option rewrite redirect boolean true
19879 .cindex "address redirection" "disabling rewriting"
19880 If this option is set false, addresses generated by the router are not
19881 subject to address rewriting. Otherwise, they are treated like new addresses
19882 and are rewritten according to the global rewriting rules.
19883
19884
19885 .option sieve_subaddress redirect string&!! unset
19886 The value of this option is passed to a Sieve filter to specify the
19887 :subaddress part of an address.
19888
19889 .option sieve_useraddress redirect string&!! unset
19890 The value of this option is passed to a Sieve filter to specify the :user part
19891 of an address. However, if it is unset, the entire original local part
19892 (including any prefix or suffix) is used for :user.
19893
19894
19895 .option sieve_vacation_directory redirect string&!! unset
19896 .cindex "Sieve filter" "vacation directory"
19897 To enable the &"vacation"& extension for Sieve filters, you must set
19898 &%sieve_vacation_directory%& to the directory where vacation databases are held
19899 (do not put anything else in that directory), and ensure that the
19900 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19901 needs their own directory; Exim will create it if necessary.
19902
19903
19904
19905 .option skip_syntax_errors redirect boolean false
19906 .cindex "forward file" "broken"
19907 .cindex "address redirection" "broken files"
19908 .cindex "alias file" "broken"
19909 .cindex "broken alias or forward files"
19910 .cindex "ignoring faulty addresses"
19911 .cindex "skipping faulty addresses"
19912 .cindex "error" "skipping bad syntax"
19913 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19914 non-filter redirection data are skipped, and each failing address is logged. If
19915 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19916 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19917 are expanded and placed at the head of the error message generated by
19918 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19919 be the same address as the generic &%errors_to%& option. The
19920 &%skip_syntax_errors%& option is often used when handling mailing lists.
19921
19922 If all the addresses in a redirection list are skipped because of syntax
19923 errors, the router declines to handle the original address, and it is passed to
19924 the following routers.
19925
19926 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19927 error in the filter causes filtering to be abandoned without any action being
19928 taken. The incident is logged, and the router declines to handle the address,
19929 so it is passed to the following routers.
19930
19931 .cindex "Sieve filter" "syntax errors in"
19932 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19933 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19934 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19935
19936 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19937 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19938 option, used with an address that does not get redirected, can be used to
19939 notify users of these errors, by means of a router like this:
19940 .code
19941 userforward:
19942   driver = redirect
19943   allow_filter
19944   check_local_user
19945   file = $home/.forward
19946   file_transport = address_file
19947   pipe_transport = address_pipe
19948   reply_transport = address_reply
19949   no_verify
19950   skip_syntax_errors
19951   syntax_errors_to = real-$local_part@$domain
19952   syntax_errors_text = \
19953    This is an automatically generated message. An error has\n\
19954    been found in your .forward file. Details of the error are\n\
19955    reported below. While this error persists, you will receive\n\
19956    a copy of this message for every message that is addressed\n\
19957    to you. If your .forward file is a filter file, or if it is\n\
19958    a non-filter file containing no valid forwarding addresses,\n\
19959    a copy of each incoming message will be put in your normal\n\
19960    mailbox. If a non-filter file contains at least one valid\n\
19961    forwarding address, forwarding to the valid addresses will\n\
19962    happen, and those will be the only deliveries that occur.
19963 .endd
19964 You also need a router to ensure that local addresses that are prefixed by
19965 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19966 put this immediately before the &(userforward)& router:
19967 .code
19968 real_localuser:
19969   driver = accept
19970   check_local_user
19971   local_part_prefix = real-
19972   transport = local_delivery
19973 .endd
19974 For security, it would probably be a good idea to restrict the use of this
19975 router to locally-generated messages, using a condition such as this:
19976 .code
19977   condition = ${if match {$sender_host_address}\
19978                          {\N^(|127\.0\.0\.1)$\N}}
19979 .endd
19980
19981
19982 .option syntax_errors_text redirect string&!! unset
19983 See &%skip_syntax_errors%& above.
19984
19985
19986 .option syntax_errors_to redirect string unset
19987 See &%skip_syntax_errors%& above.
19988 .ecindex IIDredrou1
19989 .ecindex IIDredrou2
19990
19991
19992
19993
19994
19995
19996 . ////////////////////////////////////////////////////////////////////////////
19997 . ////////////////////////////////////////////////////////////////////////////
19998
19999 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20000          "Environment for local transports"
20001 .scindex IIDenvlotra1 "local transports" "environment for"
20002 .scindex IIDenvlotra2 "environment for local transports"
20003 .scindex IIDenvlotra3 "transport" "local; environment for"
20004 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20005 transport can be thought of as similar to a pipe.) Exim always runs transports
20006 in subprocesses, under specified uids and gids. Typical deliveries to local
20007 mailboxes run under the uid and gid of the local user.
20008
20009 Exim also sets a specific current directory while running the transport; for
20010 some transports a home directory setting is also relevant. The &(pipe)&
20011 transport is the only one that sets up environment variables; see section
20012 &<<SECTpipeenv>>& for details.
20013
20014 The values used for the uid, gid, and the directories may come from several
20015 different places. In many cases, the router that handles the address associates
20016 settings with that address as a result of its &%check_local_user%&, &%group%&,
20017 or &%user%& options. However, values may also be given in the transport's own
20018 configuration, and these override anything that comes from the router.
20019
20020
20021
20022 .section "Concurrent deliveries" "SECID131"
20023 .cindex "concurrent deliveries"
20024 .cindex "simultaneous deliveries"
20025 If two different messages for the same local recipient arrive more or less
20026 simultaneously, the two delivery processes are likely to run concurrently. When
20027 the &(appendfile)& transport is used to write to a file, Exim applies locking
20028 rules to stop concurrent processes from writing to the same file at the same
20029 time.
20030
20031 However, when you use a &(pipe)& transport, it is up to you to arrange any
20032 locking that is needed. Here is a silly example:
20033 .code
20034 my_transport:
20035   driver = pipe
20036   command = /bin/sh -c 'cat >>/some/file'
20037 .endd
20038 This is supposed to write the message at the end of the file. However, if two
20039 messages arrive at the same time, the file will be scrambled. You can use the
20040 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20041 file using the same algorithm that Exim itself uses.
20042
20043
20044
20045
20046 .section "Uids and gids" "SECTenvuidgid"
20047 .cindex "local transports" "uid and gid"
20048 .cindex "transport" "local; uid and gid"
20049 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20050 overrides any group that the router set in the address, even if &%user%& is not
20051 set for the transport. This makes it possible, for example, to run local mail
20052 delivery under the uid of the recipient (set by the router), but in a special
20053 group (set by the transport). For example:
20054 .code
20055 # Routers ...
20056 # User/group are set by check_local_user in this router
20057 local_users:
20058   driver = accept
20059   check_local_user
20060   transport = group_delivery
20061
20062 # Transports ...
20063 # This transport overrides the group
20064 group_delivery:
20065   driver = appendfile
20066   file = /var/spool/mail/$local_part
20067   group = mail
20068 .endd
20069 If &%user%& is set for a transport, its value overrides what is set in the
20070 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20071 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20072 set.
20073
20074 .oindex "&%initgroups%&"
20075 When the uid is taken from the transport's configuration, the &[initgroups()]&
20076 function is called for the groups associated with that uid if the
20077 &%initgroups%& option is set for the transport. When the uid is not specified
20078 by the transport, but is associated with the address by a router, the option
20079 for calling &[initgroups()]& is taken from the router configuration.
20080
20081 .cindex "&(pipe)& transport" "uid for"
20082 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20083 is set and &%user%& is not set, the uid of the process that called Exim to
20084 receive the message is used, and if &%group%& is not set, the corresponding
20085 original gid is also used.
20086
20087 This is the detailed preference order for obtaining a gid; the first of the
20088 following that is set is used:
20089
20090 .ilist
20091 A &%group%& setting of the transport;
20092 .next
20093 A &%group%& setting of the router;
20094 .next
20095 A gid associated with a user setting of the router, either as a result of
20096 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20097 .next
20098 The group associated with a non-numeric &%user%& setting of the transport;
20099 .next
20100 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20101 the uid is the creator's uid;
20102 .next
20103 The Exim gid if the Exim uid is being used as a default.
20104 .endlist
20105
20106 If, for example, the user is specified numerically on the router and there are
20107 no group settings, no gid is available. In this situation, an error occurs.
20108 This is different for the uid, for which there always is an ultimate default.
20109 The first of the following that is set is used:
20110
20111 .ilist
20112 A &%user%& setting of the transport;
20113 .next
20114 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20115 .next
20116 A &%user%& setting of the router;
20117 .next
20118 A &%check_local_user%& setting of the router;
20119 .next
20120 The Exim uid.
20121 .endlist
20122
20123 Of course, an error will still occur if the uid that is chosen is on the
20124 &%never_users%& list.
20125
20126
20127
20128
20129
20130 .section "Current and home directories" "SECID132"
20131 .cindex "current directory for local transport"
20132 .cindex "home directory" "for local transport"
20133 .cindex "transport" "local; home directory for"
20134 .cindex "transport" "local; current directory for"
20135 Routers may set current and home directories for local transports by means of
20136 the &%transport_current_directory%& and &%transport_home_directory%& options.
20137 However, if the transport's &%current_directory%& or &%home_directory%& options
20138 are set, they override the router's values. In detail, the home directory
20139 for a local transport is taken from the first of these values that is set:
20140
20141 .ilist
20142 The &%home_directory%& option on the transport;
20143 .next
20144 The &%transport_home_directory%& option on the router;
20145 .next
20146 The password data if &%check_local_user%& is set on the router;
20147 .next
20148 The &%router_home_directory%& option on the router.
20149 .endlist
20150
20151 The current directory is taken from the first of these values that is set:
20152
20153 .ilist
20154 The &%current_directory%& option on the transport;
20155 .next
20156 The &%transport_current_directory%& option on the router.
20157 .endlist
20158
20159
20160 If neither the router nor the transport sets a current directory, Exim uses the
20161 value of the home directory, if it is set. Otherwise it sets the current
20162 directory to &_/_& before running a local transport.
20163
20164
20165
20166 .section "Expansion variables derived from the address" "SECID133"
20167 .vindex "&$domain$&"
20168 .vindex "&$local_part$&"
20169 .vindex "&$original_domain$&"
20170 Normally a local delivery is handling a single address, and in that case the
20171 variables such as &$domain$& and &$local_part$& are set during local
20172 deliveries. However, in some circumstances more than one address may be handled
20173 at once (for example, while writing batch SMTP for onward transmission by some
20174 other means). In this case, the variables associated with the local part are
20175 never set, &$domain$& is set only if all the addresses have the same domain,
20176 and &$original_domain$& is never set.
20177 .ecindex IIDenvlotra1
20178 .ecindex IIDenvlotra2
20179 .ecindex IIDenvlotra3
20180
20181
20182
20183
20184
20185
20186
20187 . ////////////////////////////////////////////////////////////////////////////
20188 . ////////////////////////////////////////////////////////////////////////////
20189
20190 .chapter "Generic options for transports" "CHAPtransportgeneric"
20191 .scindex IIDgenoptra1 "generic options" "transport"
20192 .scindex IIDgenoptra2 "options" "generic; for transports"
20193 .scindex IIDgenoptra3 "transport" "generic options for"
20194 The following generic options apply to all transports:
20195
20196
20197 .option body_only transports boolean false
20198 .cindex "transport" "body only"
20199 .cindex "message" "transporting body only"
20200 .cindex "body of message" "transporting"
20201 If this option is set, the message's headers are not transported. It is
20202 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20203 or &(pipe)& transports, the settings of &%message_prefix%& and
20204 &%message_suffix%& should be checked, because this option does not
20205 automatically suppress them.
20206
20207
20208 .option current_directory transports string&!! unset
20209 .cindex "transport" "current directory for"
20210 This specifies the current directory that is to be set while running the
20211 transport, overriding any value that may have been set by the router.
20212 If the expansion fails for any reason, including forced failure, an error is
20213 logged, and delivery is deferred.
20214
20215
20216 .option disable_logging transports boolean false
20217 If this option is set true, nothing is logged for any
20218 deliveries by the transport or for any
20219 transport errors. You should not set this option unless you really, really know
20220 what you are doing.
20221
20222
20223 .option debug_print transports string&!! unset
20224 .cindex "testing" "variables in drivers"
20225 If this option is set and debugging is enabled (see the &%-d%& command line
20226 option), the string is expanded and included in the debugging output when the
20227 transport is run.
20228 If expansion of the string fails, the error message is written to the debugging
20229 output, and Exim carries on processing.
20230 This facility is provided to help with checking out the values of variables and
20231 so on when debugging driver configurations. For example, if a &%headers_add%&
20232 option is not working properly, &%debug_print%& could be used to output the
20233 variables it references. A newline is added to the text if it does not end with
20234 one.
20235 The variables &$transport_name$& and &$router_name$& contain the name of the
20236 transport and the router that called it.
20237
20238 .option delivery_date_add transports boolean false
20239 .cindex "&'Delivery-date:'& header line"
20240 If this option is true, a &'Delivery-date:'& header is added to the message.
20241 This gives the actual time the delivery was made. As this is not a standard
20242 header, Exim has a configuration option (&%delivery_date_remove%&) which
20243 requests its removal from incoming messages, so that delivered messages can
20244 safely be resent to other recipients.
20245
20246
20247 .option driver transports string unset
20248 This specifies which of the available transport drivers is to be used.
20249 There is no default, and this option must be set for every transport.
20250
20251
20252 .option envelope_to_add transports boolean false
20253 .cindex "&'Envelope-to:'& header line"
20254 If this option is true, an &'Envelope-to:'& header is added to the message.
20255 This gives the original address(es) in the incoming envelope that caused this
20256 delivery to happen. More than one address may be present if the transport is
20257 configured to handle several addresses at once, or if more than one original
20258 address was redirected to the same final address. As this is not a standard
20259 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20260 its removal from incoming messages, so that delivered messages can safely be
20261 resent to other recipients.
20262
20263
20264 .option group transports string&!! "Exim group"
20265 .cindex "transport" "group; specifying"
20266 This option specifies a gid for running the transport process, overriding any
20267 value that the router supplies, and also overriding any value associated with
20268 &%user%& (see below).
20269
20270
20271 .option headers_add transports list&!! unset
20272 .cindex "header lines" "adding in transport"
20273 .cindex "transport" "header lines; adding"
20274 This option specifies a list of text headers,
20275 .new
20276 newline-separated (by default, changeable in the usual way),
20277 .wen
20278 which are (separately) expanded and added to the header
20279 portion of a message as it is transported, as described in section
20280 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20281 routers. If the result of the expansion is an empty string, or if the expansion
20282 is forced to fail, no action is taken. Other expansion failures are treated as
20283 errors and cause the delivery to be deferred.
20284
20285 Unlike most options, &%headers_add%& can be specified multiple times
20286 for a transport; all listed headers are added.
20287
20288
20289 .option headers_only transports boolean false
20290 .cindex "transport" "header lines only"
20291 .cindex "message" "transporting headers only"
20292 .cindex "header lines" "transporting"
20293 If this option is set, the message's body is not transported. It is mutually
20294 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20295 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20296 checked, since this option does not automatically suppress them.
20297
20298
20299 .option headers_remove transports list&!! unset
20300 .cindex "header lines" "removing"
20301 .cindex "transport" "header lines; removing"
20302 This option specifies a list of header names,
20303 .new
20304 colon-separated (by default, changeable in the usual way);
20305 .wen
20306 these headers are omitted from the message as it is transported, as described
20307 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20308 routers.
20309 Each list item is separately expanded.
20310 If the result of the expansion is an empty string, or if the expansion
20311 is forced to fail, no action is taken. Other expansion failures are treated as
20312 errors and cause the delivery to be deferred.
20313
20314 Unlike most options, &%headers_remove%& can be specified multiple times
20315 for a router; all listed headers are removed.
20316
20317
20318
20319 .option headers_rewrite transports string unset
20320 .cindex "transport" "header lines; rewriting"
20321 .cindex "rewriting" "at transport time"
20322 This option allows addresses in header lines to be rewritten at transport time,
20323 that is, as the message is being copied to its destination. The contents of the
20324 option are a colon-separated list of rewriting rules. Each rule is in exactly
20325 the same form as one of the general rewriting rules that are applied when a
20326 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20327 example,
20328 .code
20329 headers_rewrite = a@b c@d f : \
20330                   x@y w@z
20331 .endd
20332 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20333 &'w@z'& in all address-bearing header lines. The rules are applied to the
20334 header lines just before they are written out at transport time, so they affect
20335 only those copies of the message that pass through the transport. However, only
20336 the message's original header lines, and any that were added by a system
20337 filter, are rewritten. If a router or transport adds header lines, they are not
20338 affected by this option. These rewriting rules are &'not'& applied to the
20339 envelope. You can change the return path using &%return_path%&, but you cannot
20340 change envelope recipients at this time.
20341
20342
20343 .option home_directory transports string&!! unset
20344 .cindex "transport" "home directory for"
20345 .vindex "&$home$&"
20346 This option specifies a home directory setting for a local transport,
20347 overriding any value that may be set by the router. The home directory is
20348 placed in &$home$& while expanding the transport's private options. It is also
20349 used as the current directory if no current directory is set by the
20350 &%current_directory%& option on the transport or the
20351 &%transport_current_directory%& option on the router. If the expansion fails
20352 for any reason, including forced failure, an error is logged, and delivery is
20353 deferred.
20354
20355
20356 .option initgroups transports boolean false
20357 .cindex "additional groups"
20358 .cindex "groups" "additional"
20359 .cindex "transport" "group; additional"
20360 If this option is true and the uid for the delivery process is provided by the
20361 transport, the &[initgroups()]& function is called when running the transport
20362 to ensure that any additional groups associated with the uid are set up.
20363
20364
20365 .option message_size_limit transports string&!! 0
20366 .cindex "limit" "message size per transport"
20367 .cindex "size" "of message, limit"
20368 .cindex "transport" "message size; limiting"
20369 This option controls the size of messages passed through the transport. It is
20370 expanded before use; the result of the expansion must be a sequence of decimal
20371 digits, optionally followed by K or M. If the expansion fails for any reason,
20372 including forced failure, or if the result is not of the required form,
20373 delivery is deferred. If the value is greater than zero and the size of a
20374 message exceeds this limit, the address is failed. If there is any chance that
20375 the resulting bounce message could be routed to the same transport, you should
20376 ensure that &%return_size_limit%& is less than the transport's
20377 &%message_size_limit%&, as otherwise the bounce message will fail to get
20378 delivered.
20379
20380
20381
20382 .option rcpt_include_affixes transports boolean false
20383 .cindex "prefix" "for local part, including in envelope"
20384 .cindex "suffix for local part" "including in envelope"
20385 .cindex "local part" "prefix"
20386 .cindex "local part" "suffix"
20387 When this option is false (the default), and an address that has had any
20388 affixes (prefixes or suffixes) removed from the local part is delivered by any
20389 form of SMTP or LMTP, the affixes are not included. For example, if a router
20390 that contains
20391 .code
20392 local_part_prefix = *-
20393 .endd
20394 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20395 is delivered with
20396 .code
20397 RCPT TO:<xyz@some.domain>
20398 .endd
20399 This is also the case when an ACL-time callout is being used to verify a
20400 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20401 whole local part is included in the RCPT command. This option applies to BSMTP
20402 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20403 &(lmtp)& and &(smtp)& transports.
20404
20405
20406 .option retry_use_local_part transports boolean "see below"
20407 .cindex "hints database" "retry keys"
20408 When a delivery suffers a temporary failure, a retry record is created
20409 in Exim's hints database. For remote deliveries, the key for the retry record
20410 is based on the name and/or IP address of the failing remote host. For local
20411 deliveries, the key is normally the entire address, including both the local
20412 part and the domain. This is suitable for most common cases of local delivery
20413 temporary failure &-- for example, exceeding a mailbox quota should delay only
20414 deliveries to that mailbox, not to the whole domain.
20415
20416 However, in some special cases you may want to treat a temporary local delivery
20417 as a failure associated with the domain, and not with a particular local part.
20418 (For example, if you are storing all mail for some domain in files.) You can do
20419 this by setting &%retry_use_local_part%& false.
20420
20421 For all the local transports, its default value is true. For remote transports,
20422 the default value is false for tidiness, but changing the value has no effect
20423 on a remote transport in the current implementation.
20424
20425
20426 .option return_path transports string&!! unset
20427 .cindex "envelope sender"
20428 .cindex "transport" "return path; changing"
20429 .cindex "return path" "changing in transport"
20430 If this option is set, the string is expanded at transport time and replaces
20431 the existing return path (envelope sender) value in the copy of the message
20432 that is being delivered. An empty return path is permitted. This feature is
20433 designed for remote deliveries, where the value of this option is used in the
20434 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20435 only effect is to change the address that is placed in the &'Return-path:'&
20436 header line, if one is added to the message (see the next option).
20437
20438 &*Note:*& A changed return path is not logged unless you add
20439 &%return_path_on_delivery%& to the log selector.
20440
20441 .vindex "&$return_path$&"
20442 The expansion can refer to the existing value via &$return_path$&. This is
20443 either the message's envelope sender, or an address set by the
20444 &%errors_to%& option on a router. If the expansion is forced to fail, no
20445 replacement occurs; if it fails for another reason, delivery is deferred. This
20446 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20447 section &<<SECTverp>>&.
20448
20449 &*Note*&: If a delivery error is detected locally, including the case when a
20450 remote server rejects a message at SMTP time, the bounce message is not sent to
20451 the value of this option. It is sent to the previously set errors address.
20452 This defaults to the incoming sender address, but can be changed by setting
20453 &%errors_to%& in a router.
20454
20455
20456
20457 .option return_path_add transports boolean false
20458 .cindex "&'Return-path:'& header line"
20459 If this option is true, a &'Return-path:'& header is added to the message.
20460 Although the return path is normally available in the prefix line of BSD
20461 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20462 have easy access to it.
20463
20464 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20465 the delivery SMTP server makes the final delivery"&. This implies that this
20466 header should not be present in incoming messages. Exim has a configuration
20467 option, &%return_path_remove%&, which requests removal of this header from
20468 incoming messages, so that delivered messages can safely be resent to other
20469 recipients.
20470
20471
20472 .option shadow_condition transports string&!! unset
20473 See &%shadow_transport%& below.
20474
20475
20476 .option shadow_transport transports string unset
20477 .cindex "shadow transport"
20478 .cindex "transport" "shadow"
20479 A local transport may set the &%shadow_transport%& option to the name of
20480 another local transport. Shadow remote transports are not supported.
20481
20482 Whenever a delivery to the main transport succeeds, and either
20483 &%shadow_condition%& is unset, or its expansion does not result in the empty
20484 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20485 passed to the shadow transport, with the same delivery address or addresses. If
20486 expansion fails, no action is taken except that non-forced expansion failures
20487 cause a log line to be written.
20488
20489 The result of the shadow transport is discarded and does not affect the
20490 subsequent processing of the message. Only a single level of shadowing is
20491 provided; the &%shadow_transport%& option is ignored on any transport when it
20492 is running as a shadow. Options concerned with output from pipes are also
20493 ignored. The log line for the successful delivery has an item added on the end,
20494 of the form
20495 .code
20496 ST=<shadow transport name>
20497 .endd
20498 If the shadow transport did not succeed, the error message is put in
20499 parentheses afterwards. Shadow transports can be used for a number of different
20500 purposes, including keeping more detailed log information than Exim normally
20501 provides, and implementing automatic acknowledgment policies based on message
20502 headers that some sites insist on.
20503
20504
20505 .option transport_filter transports string&!! unset
20506 .cindex "transport" "filter"
20507 .cindex "filter" "transport filter"
20508 This option sets up a filtering (in the Unix shell sense) process for messages
20509 at transport time. It should not be confused with mail filtering as set up by
20510 individual users or via a system filter.
20511
20512 When the message is about to be written out, the command specified by
20513 &%transport_filter%& is started up in a separate, parallel process, and
20514 the entire message, including the header lines, is passed to it on its standard
20515 input (this in fact is done from a third process, to avoid deadlock). The
20516 command must be specified as an absolute path.
20517
20518 The lines of the message that are written to the transport filter are
20519 terminated by newline (&"\n"&). The message is passed to the filter before any
20520 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20521 lines beginning with a dot, and also before any processing implied by the
20522 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20523 &(pipe)& transports.
20524
20525 The standard error for the filter process is set to the same destination as its
20526 standard output; this is read and written to the message's ultimate
20527 destination. The process that writes the message to the filter, the
20528 filter itself, and the original process that reads the result and delivers it
20529 are all run in parallel, like a shell pipeline.
20530
20531 The filter can perform any transformations it likes, but of course should take
20532 care not to break RFC 2822 syntax. Exim does not check the result, except to
20533 test for a final newline when SMTP is in use. All messages transmitted over
20534 SMTP must end with a newline, so Exim supplies one if it is missing.
20535
20536 .cindex "content scanning" "per user"
20537 A transport filter can be used to provide content-scanning on a per-user basis
20538 at delivery time if the only required effect of the scan is to modify the
20539 message. For example, a content scan could insert a new header line containing
20540 a spam score. This could be interpreted by a filter in the user's MUA. It is
20541 not possible to discard a message at this stage.
20542
20543 .cindex "SMTP" "SIZE"
20544 A problem might arise if the filter increases the size of a message that is
20545 being sent down an SMTP connection. If the receiving SMTP server has indicated
20546 support for the SIZE parameter, Exim will have sent the size of the message
20547 at the start of the SMTP session. If what is actually sent is substantially
20548 more, the server might reject the message. This can be worked round by setting
20549 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20550 additions to the message, or to disable the use of SIZE altogether.
20551
20552 .vindex "&$pipe_addresses$&"
20553 The value of the &%transport_filter%& option is the command string for starting
20554 the filter, which is run directly from Exim, not under a shell. The string is
20555 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20556 Exim breaks it up into arguments and then expands each argument separately (see
20557 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20558 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20559 of arguments, one for each address that applies to this delivery. (This isn't
20560 an ideal name for this feature here, but as it was already implemented for the
20561 &(pipe)& transport, it seemed sensible not to change it.)
20562
20563 .vindex "&$host$&"
20564 .vindex "&$host_address$&"
20565 The expansion variables &$host$& and &$host_address$& are available when the
20566 transport is a remote one. They contain the name and IP address of the host to
20567 which the message is being sent. For example:
20568 .code
20569 transport_filter = /some/directory/transport-filter.pl \
20570   $host $host_address $sender_address $pipe_addresses
20571 .endd
20572
20573 Two problems arise if you want to use more complicated expansion items to
20574 generate transport filter commands, both of which due to the fact that the
20575 command is split up &'before'& expansion.
20576 .ilist
20577 If an expansion item contains white space, you must quote it, so that it is all
20578 part of the same command item. If the entire option setting is one such
20579 expansion item, you have to take care what kind of quoting you use. For
20580 example:
20581 .code
20582 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20583 .endd
20584 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20585 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20586 stripped by Exim when it read the option's value. When the value is used, if
20587 the single quotes were missing, the line would be split into two items,
20588 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20589 Exim tried to expand the first one.
20590 .next
20591 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20592 expansion cannot generate multiple arguments, or a command name followed by
20593 arguments. Consider this example:
20594 .code
20595 transport_filter = ${lookup{$host}lsearch{/a/file}\
20596                     {$value}{/bin/cat}}
20597 .endd
20598 The result of the lookup is interpreted as the name of the command, even
20599 if it contains white space. The simplest way round this is to use a shell:
20600 .code
20601 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20602                                {$value}{/bin/cat}}
20603 .endd
20604 .endlist
20605
20606 The filter process is run under the same uid and gid as the normal delivery.
20607 For remote deliveries this is the Exim uid/gid by default. The command should
20608 normally yield a zero return code. Transport filters are not supposed to fail.
20609 A non-zero code is taken to mean that the transport filter encountered some
20610 serious problem. Delivery of the message is deferred; the message remains on
20611 the queue and is tried again later. It is not possible to cause a message to be
20612 bounced from a transport filter.
20613
20614 If a transport filter is set on an autoreply transport, the original message is
20615 passed through the filter as it is being copied into the newly generated
20616 message, which happens if the &%return_message%& option is set.
20617
20618
20619 .option transport_filter_timeout transports time 5m
20620 .cindex "transport" "filter, timeout"
20621 When Exim is reading the output of a transport filter, it applies a timeout
20622 that can be set by this option. Exceeding the timeout is normally treated as a
20623 temporary delivery failure. However, if a transport filter is used with a
20624 &(pipe)& transport, a timeout in the transport filter is treated in the same
20625 way as a timeout in the pipe command itself. By default, a timeout is a hard
20626 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20627 becomes a temporary error.
20628
20629
20630 .option user transports string&!! "Exim user"
20631 .cindex "uid (user id)" "local delivery"
20632 .cindex "transport" "user, specifying"
20633 This option specifies the user under whose uid the delivery process is to be
20634 run, overriding any uid that may have been set by the router. If the user is
20635 given as a name, the uid is looked up from the password data, and the
20636 associated group is taken as the value of the gid to be used if the &%group%&
20637 option is not set.
20638
20639 For deliveries that use local transports, a user and group are normally
20640 specified explicitly or implicitly (for example, as a result of
20641 &%check_local_user%&) by the router or transport.
20642
20643 .cindex "hints database" "access by remote transport"
20644 For remote transports, you should leave this option unset unless you really are
20645 sure you know what you are doing. When a remote transport is running, it needs
20646 to be able to access Exim's hints databases, because each host may have its own
20647 retry data.
20648 .ecindex IIDgenoptra1
20649 .ecindex IIDgenoptra2
20650 .ecindex IIDgenoptra3
20651
20652
20653
20654
20655
20656
20657 . ////////////////////////////////////////////////////////////////////////////
20658 . ////////////////////////////////////////////////////////////////////////////
20659
20660 .chapter "Address batching in local transports" "CHAPbatching" &&&
20661          "Address batching"
20662 .cindex "transport" "local; address batching in"
20663 The only remote transport (&(smtp)&) is normally configured to handle more than
20664 one address at a time, so that when several addresses are routed to the same
20665 remote host, just one copy of the message is sent. Local transports, however,
20666 normally handle one address at a time. That is, a separate instance of the
20667 transport is run for each address that is routed to the transport. A separate
20668 copy of the message is delivered each time.
20669
20670 .cindex "batched local delivery"
20671 .oindex "&%batch_max%&"
20672 .oindex "&%batch_id%&"
20673 In special cases, it may be desirable to handle several addresses at once in a
20674 local transport, for example:
20675
20676 .ilist
20677 In an &(appendfile)& transport, when storing messages in files for later
20678 delivery by some other means, a single copy of the message with multiple
20679 recipients saves space.
20680 .next
20681 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20682 a single copy saves time, and is the normal way LMTP is expected to work.
20683 .next
20684 In a &(pipe)& transport, when passing the message
20685 to a scanner program or
20686 to some other delivery mechanism such as UUCP, multiple recipients may be
20687 acceptable.
20688 .endlist
20689
20690 These three local transports all have the same options for controlling multiple
20691 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20692 repeating the information for each transport, these options are described here.
20693
20694 The &%batch_max%& option specifies the maximum number of addresses that can be
20695 delivered together in a single run of the transport. Its default value is one
20696 (no batching). When more than one address is routed to a transport that has a
20697 &%batch_max%& value greater than one, the addresses are delivered in a batch
20698 (that is, in a single run of the transport with multiple recipients), subject
20699 to certain conditions:
20700
20701 .ilist
20702 .vindex "&$local_part$&"
20703 If any of the transport's options contain a reference to &$local_part$&, no
20704 batching is possible.
20705 .next
20706 .vindex "&$domain$&"
20707 If any of the transport's options contain a reference to &$domain$&, only
20708 addresses with the same domain are batched.
20709 .next
20710 .cindex "customizing" "batching condition"
20711 If &%batch_id%& is set, it is expanded for each address, and only those
20712 addresses with the same expanded value are batched. This allows you to specify
20713 customized batching conditions. Failure of the expansion for any reason,
20714 including forced failure, disables batching, but it does not stop the delivery
20715 from taking place.
20716 .next
20717 Batched addresses must also have the same errors address (where to send
20718 delivery errors), the same header additions and removals, the same user and
20719 group for the transport, and if a host list is present, the first host must
20720 be the same.
20721 .endlist
20722
20723 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20724 both when the file or pipe command is specified in the transport, and when it
20725 is specified by a &(redirect)& router, but all the batched addresses must of
20726 course be routed to the same file or pipe command. These two transports have an
20727 option called &%use_bsmtp%&, which causes them to deliver the message in
20728 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20729 &%check_string%& and &%escape_string%& options are forced to the values
20730 .code
20731 check_string = "."
20732 escape_string = ".."
20733 .endd
20734 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20735 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20736 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20737
20738 .cindex "&'Envelope-to:'& header line"
20739 If the generic &%envelope_to_add%& option is set for a batching transport, the
20740 &'Envelope-to:'& header that is added to the message contains all the addresses
20741 that are being processed together. If you are using a batching &(appendfile)&
20742 transport without &%use_bsmtp%&, the only way to preserve the recipient
20743 addresses is to set the &%envelope_to_add%& option.
20744
20745 .cindex "&(pipe)& transport" "with multiple addresses"
20746 .vindex "&$pipe_addresses$&"
20747 If you are using a &(pipe)& transport without BSMTP, and setting the
20748 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20749 the command. This is not a true variable; it is a bit of magic that causes each
20750 of the recipient addresses to be inserted into the command as a separate
20751 argument. This provides a way of accessing all the addresses that are being
20752 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20753 are specified by a &(redirect)& router.
20754
20755
20756
20757
20758 . ////////////////////////////////////////////////////////////////////////////
20759 . ////////////////////////////////////////////////////////////////////////////
20760
20761 .chapter "The appendfile transport" "CHAPappendfile"
20762 .scindex IIDapptra1 "&(appendfile)& transport"
20763 .scindex IIDapptra2 "transports" "&(appendfile)&"
20764 .cindex "directory creation"
20765 .cindex "creating directories"
20766 The &(appendfile)& transport delivers a message by appending it to an existing
20767 file, or by creating an entirely new file in a specified directory. Single
20768 files to which messages are appended can be in the traditional Unix mailbox
20769 format, or optionally in the MBX format supported by the Pine MUA and
20770 University of Washington IMAP daemon, &'inter alia'&. When each message is
20771 being delivered as a separate file, &"maildir"& format can optionally be used
20772 to give added protection against failures that happen part-way through the
20773 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20774 supported. For all file formats, Exim attempts to create as many levels of
20775 directory as necessary, provided that &%create_directory%& is set.
20776
20777 The code for the optional formats is not included in the Exim binary by
20778 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20779 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20780 included.
20781
20782 .cindex "quota" "system"
20783 Exim recognizes system quota errors, and generates an appropriate message. Exim
20784 also supports its own quota control within the transport, for use when the
20785 system facility is unavailable or cannot be used for some reason.
20786
20787 If there is an error while appending to a file (for example, quota exceeded or
20788 partition filled), Exim attempts to reset the file's length and last
20789 modification time back to what they were before. If there is an error while
20790 creating an entirely new file, the new file is removed.
20791
20792 Before appending to a file, a number of security checks are made, and the
20793 file is locked. A detailed description is given below, after the list of
20794 private options.
20795
20796 The &(appendfile)& transport is most commonly used for local deliveries to
20797 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20798 putting messages into files for remote delivery by some means other than Exim.
20799 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20800 option).
20801
20802
20803
20804 .section "The file and directory options" "SECTfildiropt"
20805 The &%file%& option specifies a single file, to which the message is appended;
20806 the &%directory%& option specifies a directory, in which a new file containing
20807 the message is created. Only one of these two options can be set, and for
20808 normal deliveries to mailboxes, one of them &'must'& be set.
20809
20810 .vindex "&$address_file$&"
20811 .vindex "&$local_part$&"
20812 However, &(appendfile)& is also used for delivering messages to files or
20813 directories whose names (or parts of names) are obtained from alias,
20814 forwarding, or filtering operations (for example, a &%save%& command in a
20815 user's Exim filter). When such a transport is running, &$local_part$& contains
20816 the local part that was aliased or forwarded, and &$address_file$& contains the
20817 name (or partial name) of the file or directory generated by the redirection
20818 operation. There are two cases:
20819
20820 .ilist
20821 If neither &%file%& nor &%directory%& is set, the redirection operation
20822 must specify an absolute path (one that begins with &`/`&). This is the most
20823 common case when users with local accounts use filtering to sort mail into
20824 different folders. See for example, the &(address_file)& transport in the
20825 default configuration. If the path ends with a slash, it is assumed to be the
20826 name of a directory. A delivery to a directory can also be forced by setting
20827 &%maildir_format%& or &%mailstore_format%&.
20828 .next
20829 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20830 used to determine the file or directory name for the delivery. Normally, the
20831 contents of &$address_file$& are used in some way in the string expansion.
20832 .endlist
20833
20834
20835 .cindex "Sieve filter" "configuring &(appendfile)&"
20836 .cindex "Sieve filter" "relative mailbox path handling"
20837 As an example of the second case, consider an environment where users do not
20838 have home directories. They may be permitted to use Exim filter commands of the
20839 form:
20840 .code
20841 save folder23
20842 .endd
20843 or Sieve filter commands of the form:
20844 .code
20845 require "fileinto";
20846 fileinto "folder23";
20847 .endd
20848 In this situation, the expansion of &%file%& or &%directory%& in the transport
20849 must transform the relative path into an appropriate absolute file name. In the
20850 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20851 is used as a result of a &"keep"& action in the filter. This example shows one
20852 way of handling this requirement:
20853 .code
20854 file = ${if eq{$address_file}{inbox} \
20855             {/var/mail/$local_part} \
20856             {${if eq{${substr_0_1:$address_file}}{/} \
20857                   {$address_file} \
20858                   {$home/mail/$address_file} \
20859             }} \
20860        }
20861 .endd
20862 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20863 location, absolute paths are used without change, and other folders are in the
20864 &_mail_& directory within the home directory.
20865
20866 &*Note 1*&: While processing an Exim filter, a relative path such as
20867 &_folder23_& is turned into an absolute path if a home directory is known to
20868 the router. In particular, this is the case if &%check_local_user%& is set. If
20869 you want to prevent this happening at routing time, you can set
20870 &%router_home_directory%& empty. This forces the router to pass the relative
20871 path to the transport.
20872
20873 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20874 the &%file%& or &%directory%& option is still used if it is set.
20875
20876
20877
20878
20879 .section "Private options for appendfile" "SECID134"
20880 .cindex "options" "&(appendfile)& transport"
20881
20882
20883
20884 .option allow_fifo appendfile boolean false
20885 .cindex "fifo (named pipe)"
20886 .cindex "named pipe (fifo)"
20887 .cindex "pipe" "named (fifo)"
20888 Setting this option permits delivery to named pipes (FIFOs) as well as to
20889 regular files. If no process is reading the named pipe at delivery time, the
20890 delivery is deferred.
20891
20892
20893 .option allow_symlink appendfile boolean false
20894 .cindex "symbolic link" "to mailbox"
20895 .cindex "mailbox" "symbolic link"
20896 By default, &(appendfile)& will not deliver if the path name for the file is
20897 that of a symbolic link. Setting this option relaxes that constraint, but there
20898 are security issues involved in the use of symbolic links. Be sure you know
20899 what you are doing if you set this. Details of exactly what this option affects
20900 are included in the discussion which follows this list of options.
20901
20902
20903 .option batch_id appendfile string&!! unset
20904 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20905 However, batching is automatically disabled for &(appendfile)& deliveries that
20906 happen as a result of forwarding or aliasing or other redirection directly to a
20907 file.
20908
20909
20910 .option batch_max appendfile integer 1
20911 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20912
20913
20914 .option check_group appendfile boolean false
20915 When this option is set, the group owner of the file defined by the &%file%&
20916 option is checked to see that it is the same as the group under which the
20917 delivery process is running. The default setting is false because the default
20918 file mode is 0600, which means that the group is irrelevant.
20919
20920
20921 .option check_owner appendfile boolean true
20922 When this option is set, the owner of the file defined by the &%file%& option
20923 is checked to ensure that it is the same as the user under which the delivery
20924 process is running.
20925
20926
20927 .option check_string appendfile string "see below"
20928 .cindex "&""From""& line"
20929 As &(appendfile)& writes the message, the start of each line is tested for
20930 matching &%check_string%&, and if it does, the initial matching characters are
20931 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20932 a literal string, not a regular expression, and the case of any letters it
20933 contains is significant.
20934
20935 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20936 are forced to &"."& and &".."& respectively, and any settings in the
20937 configuration are ignored. Otherwise, they default to &"From&~"& and
20938 &">From&~"& when the &%file%& option is set, and unset when any of the
20939 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20940
20941 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20942 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20943 &"From&~"& indicates the start of a new message. All four options need changing
20944 if another format is used. For example, to deliver to mailboxes in MMDF format:
20945 .cindex "MMDF format mailbox"
20946 .cindex "mailbox" "MMDF format"
20947 .code
20948 check_string = "\1\1\1\1\n"
20949 escape_string = "\1\1\1\1 \n"
20950 message_prefix = "\1\1\1\1\n"
20951 message_suffix = "\1\1\1\1\n"
20952 .endd
20953 .option create_directory appendfile boolean true
20954 .cindex "directory creation"
20955 When this option is true, Exim attempts to create any missing superior
20956 directories for the file that it is about to write. A created directory's mode
20957 is given by the &%directory_mode%& option.
20958
20959 The group ownership of a newly created directory is highly dependent on the
20960 operating system (and possibly the file system) that is being used. For
20961 example, in Solaris, if the parent directory has the setgid bit set, its group
20962 is propagated to the child; if not, the currently set group is used. However,
20963 in FreeBSD, the parent's group is always used.
20964
20965
20966
20967 .option create_file appendfile string anywhere
20968 This option constrains the location of files and directories that are created
20969 by this transport. It applies to files defined by the &%file%& option and
20970 directories defined by the &%directory%& option. In the case of maildir
20971 delivery, it applies to the top level directory, not the maildir directories
20972 beneath.
20973
20974 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20975 &"belowhome"&. In the second and third cases, a home directory must have been
20976 set for the transport. This option is not useful when an explicit file name is
20977 given for normal mailbox deliveries. It is intended for the case when file
20978 names are generated from users' &_.forward_& files. These are usually handled
20979 by an &(appendfile)& transport called &%address_file%&. See also
20980 &%file_must_exist%&.
20981
20982
20983 .option directory appendfile string&!! unset
20984 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20985 or &%directory%& must be set, unless the delivery is the direct result of a
20986 redirection (see section &<<SECTfildiropt>>&).
20987
20988 When &%directory%& is set, the string is expanded, and the message is delivered
20989 into a new file or files in or below the given directory, instead of being
20990 appended to a single mailbox file. A number of different formats are provided
20991 (see &%maildir_format%& and &%mailstore_format%&), and see section
20992 &<<SECTopdir>>& for further details of this form of delivery.
20993
20994
20995 .option directory_file appendfile string&!! "see below"
20996 .cindex "base62"
20997 .vindex "&$inode$&"
20998 When &%directory%& is set, but neither &%maildir_format%& nor
20999 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21000 whose name is obtained by expanding this string. The default value is:
21001 .code
21002 q${base62:$tod_epoch}-$inode
21003 .endd
21004 This generates a unique name from the current time, in base 62 form, and the
21005 inode of the file. The variable &$inode$& is available only when expanding this
21006 option.
21007
21008
21009 .option directory_mode appendfile "octal integer" 0700
21010 If &(appendfile)& creates any directories as a result of the
21011 &%create_directory%& option, their mode is specified by this option.
21012
21013
21014 .option escape_string appendfile string "see description"
21015 See &%check_string%& above.
21016
21017
21018 .option file appendfile string&!! unset
21019 This option is mutually exclusive with the &%directory%& option, but one of
21020 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21021 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21022 specifies a single file, to which the message is appended. One or more of
21023 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21024 &%file%&.
21025
21026 .cindex "NFS" "lock file"
21027 .cindex "locking files"
21028 .cindex "lock files"
21029 If you are using more than one host to deliver over NFS into the same
21030 mailboxes, you should always use lock files.
21031
21032 The string value is expanded for each delivery, and must yield an absolute
21033 path. The most common settings of this option are variations on one of these
21034 examples:
21035 .code
21036 file = /var/spool/mail/$local_part
21037 file = /home/$local_part/inbox
21038 file = $home/inbox
21039 .endd
21040 .cindex "&""sticky""& bit"
21041 In the first example, all deliveries are done into the same directory. If Exim
21042 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21043 create a file in the directory, so the &"sticky"& bit must be turned on for
21044 deliveries to be possible, or alternatively the &%group%& option can be used to
21045 run the delivery under a group id which has write access to the directory.
21046
21047
21048
21049 .option file_format appendfile string unset
21050 .cindex "file" "mailbox; checking existing format"
21051 This option requests the transport to check the format of an existing file
21052 before adding to it. The check consists of matching a specific string at the
21053 start of the file. The value of the option consists of an even number of
21054 colon-separated strings. The first of each pair is the test string, and the
21055 second is the name of a transport. If the transport associated with a matched
21056 string is not the current transport, control is passed over to the other
21057 transport. For example, suppose the standard &(local_delivery)& transport has
21058 this added to it:
21059 .code
21060 file_format = "From       : local_delivery :\
21061                \1\1\1\1\n : local_mmdf_delivery"
21062 .endd
21063 Mailboxes that begin with &"From"& are still handled by this transport, but if
21064 a mailbox begins with four binary ones followed by a newline, control is passed
21065 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21066 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21067 is assumed to match the current transport. If the start of a mailbox doesn't
21068 match any string, or if the transport named for a given string is not defined,
21069 delivery is deferred.
21070
21071
21072 .option file_must_exist appendfile boolean false
21073 If this option is true, the file specified by the &%file%& option must exist.
21074 A temporary error occurs if it does not, causing delivery to be deferred.
21075 If this option is false, the file is created if it does not exist.
21076
21077
21078 .option lock_fcntl_timeout appendfile time 0s
21079 .cindex "timeout" "mailbox locking"
21080 .cindex "mailbox" "locking, blocking and non-blocking"
21081 .cindex "locking files"
21082 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21083 when locking an open mailbox file. If the call fails, the delivery process
21084 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21085 Non-blocking calls are used so that the file is not kept open during the wait
21086 for the lock; the reason for this is to make it as safe as possible for
21087 deliveries over NFS in the case when processes might be accessing an NFS
21088 mailbox without using a lock file. This should not be done, but
21089 misunderstandings and hence misconfigurations are not unknown.
21090
21091 On a busy system, however, the performance of a non-blocking lock approach is
21092 not as good as using a blocking lock with a timeout. In this case, the waiting
21093 is done inside the system call, and Exim's delivery process acquires the lock
21094 and can proceed as soon as the previous lock holder releases it.
21095
21096 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21097 timeout, are used. There may still be some retrying: the maximum number of
21098 retries is
21099 .code
21100 (lock_retries * lock_interval) / lock_fcntl_timeout
21101 .endd
21102 rounded up to the next whole number. In other words, the total time during
21103 which &(appendfile)& is trying to get a lock is roughly the same, unless
21104 &%lock_fcntl_timeout%& is set very large.
21105
21106 You should consider setting this option if you are getting a lot of delayed
21107 local deliveries because of errors of the form
21108 .code
21109 failed to lock mailbox /some/file (fcntl)
21110 .endd
21111
21112 .option lock_flock_timeout appendfile time 0s
21113 This timeout applies to file locking when using &[flock()]& (see
21114 &%use_flock%&); the timeout operates in a similar manner to
21115 &%lock_fcntl_timeout%&.
21116
21117
21118 .option lock_interval appendfile time 3s
21119 This specifies the time to wait between attempts to lock the file. See below
21120 for details of locking.
21121
21122
21123 .option lock_retries appendfile integer 10
21124 This specifies the maximum number of attempts to lock the file. A value of zero
21125 is treated as 1. See below for details of locking.
21126
21127
21128 .option lockfile_mode appendfile "octal integer" 0600
21129 This specifies the mode of the created lock file, when a lock file is being
21130 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21131
21132
21133 .option lockfile_timeout appendfile time 30m
21134 .cindex "timeout" "mailbox locking"
21135 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21136 exists and is older than this value, it is assumed to have been left behind by
21137 accident, and Exim attempts to remove it.
21138
21139
21140 .option mailbox_filecount appendfile string&!! unset
21141 .cindex "mailbox" "specifying size of"
21142 .cindex "size" "of mailbox"
21143 If this option is set, it is expanded, and the result is taken as the current
21144 number of files in the mailbox. It must be a decimal number, optionally
21145 followed by K or M. This provides a way of obtaining this information from an
21146 external source that maintains the data.
21147
21148
21149 .option mailbox_size appendfile string&!! unset
21150 .cindex "mailbox" "specifying size of"
21151 .cindex "size" "of mailbox"
21152 If this option is set, it is expanded, and the result is taken as the current
21153 size the mailbox. It must be a decimal number, optionally followed by K or M.
21154 This provides a way of obtaining this information from an external source that
21155 maintains the data. This is likely to be helpful for maildir deliveries where
21156 it is computationally expensive to compute the size of a mailbox.
21157
21158
21159
21160 .option maildir_format appendfile boolean false
21161 .cindex "maildir format" "specifying"
21162 If this option is set with the &%directory%& option, the delivery is into a new
21163 file, in the &"maildir"& format that is used by other mail software. When the
21164 transport is activated directly from a &(redirect)& router (for example, the
21165 &(address_file)& transport in the default configuration), setting
21166 &%maildir_format%& causes the path received from the router to be treated as a
21167 directory, whether or not it ends with &`/`&. This option is available only if
21168 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21169 &<<SECTmaildirdelivery>>& below for further details.
21170
21171
21172 .option maildir_quota_directory_regex appendfile string "See below"
21173 .cindex "maildir format" "quota; directories included in"
21174 .cindex "quota" "maildir; directories included in"
21175 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21176 a regular expression for specifying directories, relative to the quota
21177 directory (see &%quota_directory%&), that should be included in the quota
21178 calculation. The default value is:
21179 .code
21180 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21181 .endd
21182 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21183 (directories whose names begin with a dot). If you want to exclude the
21184 &_Trash_&
21185 folder from the count (as some sites do), you need to change this setting to
21186 .code
21187 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21188 .endd
21189 This uses a negative lookahead in the regular expression to exclude the
21190 directory whose name is &_.Trash_&. When a directory is excluded from quota
21191 calculations, quota processing is bypassed for any messages that are delivered
21192 directly into that directory.
21193
21194
21195 .option maildir_retries appendfile integer 10
21196 This option specifies the number of times to retry when writing a file in
21197 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21198
21199
21200 .option maildir_tag appendfile string&!! unset
21201 This option applies only to deliveries in maildir format, and is described in
21202 section &<<SECTmaildirdelivery>>& below.
21203
21204
21205 .option maildir_use_size_file appendfile&!! boolean false
21206 .cindex "maildir format" "&_maildirsize_& file"
21207 The result of string expansion for this option must be a valid boolean value.
21208 If it is true, it enables support for &_maildirsize_& files. Exim
21209 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21210 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21211 value is zero. See &%maildir_quota_directory_regex%& above and section
21212 &<<SECTmaildirdelivery>>& below for further details.
21213
21214 .option maildirfolder_create_regex appendfile string unset
21215 .cindex "maildir format" "&_maildirfolder_& file"
21216 .cindex "&_maildirfolder_&, creating"
21217 The value of this option is a regular expression. If it is unset, it has no
21218 effect. Otherwise, before a maildir delivery takes place, the pattern is
21219 matched against the name of the maildir directory, that is, the directory
21220 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21221 delivery. If there is a match, Exim checks for the existence of a file called
21222 &_maildirfolder_& in the directory, and creates it if it does not exist.
21223 See section &<<SECTmaildirdelivery>>& for more details.
21224
21225
21226 .option mailstore_format appendfile boolean false
21227 .cindex "mailstore format" "specifying"
21228 If this option is set with the &%directory%& option, the delivery is into two
21229 new files in  &"mailstore"& format. The option is available only if
21230 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21231 below for further details.
21232
21233
21234 .option mailstore_prefix appendfile string&!! unset
21235 This option applies only to deliveries in mailstore format, and is described in
21236 section &<<SECTopdir>>& below.
21237
21238
21239 .option mailstore_suffix appendfile string&!! unset
21240 This option applies only to deliveries in mailstore format, and is described in
21241 section &<<SECTopdir>>& below.
21242
21243
21244 .option mbx_format appendfile boolean false
21245 .cindex "locking files"
21246 .cindex "file" "locking"
21247 .cindex "file" "MBX format"
21248 .cindex "MBX format, specifying"
21249 This option is available only if Exim has been compiled with SUPPORT_MBX
21250 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21251 the message is appended to the mailbox file in MBX format instead of
21252 traditional Unix format. This format is supported by Pine4 and its associated
21253 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21254
21255 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21256 automatically changed by the use of &%mbx_format%&. They should normally be set
21257 empty when using MBX format, so this option almost always appears in this
21258 combination:
21259 .code
21260 mbx_format = true
21261 message_prefix =
21262 message_suffix =
21263 .endd
21264 If none of the locking options are mentioned in the configuration,
21265 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21266 is possible to specify the other kinds of locking with &%mbx_format%&, but
21267 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21268 interworks with &'c-client'&, providing for shared access to the mailbox. It
21269 should not be used if any program that does not use this form of locking is
21270 going to access the mailbox, nor should it be used if the mailbox file is NFS
21271 mounted, because it works only when the mailbox is accessed from a single host.
21272
21273 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21274 the standard version of &'c-client'&, because as long as it has a mailbox open
21275 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21276 append messages to it.
21277
21278
21279 .option message_prefix appendfile string&!! "see below"
21280 .cindex "&""From""& line"
21281 The string specified here is expanded and output at the start of every message.
21282 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21283 in which case it is:
21284 .code
21285 message_prefix = "From ${if def:return_path{$return_path}\
21286   {MAILER-DAEMON}} $tod_bsdinbox\n"
21287 .endd
21288 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21289 &`\n`& to &`\r\n`& in &%message_prefix%&.
21290
21291 .option message_suffix appendfile string&!! "see below"
21292 The string specified here is expanded and output at the end of every message.
21293 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21294 in which case it is a single newline character. The suffix can be suppressed by
21295 setting
21296 .code
21297 message_suffix =
21298 .endd
21299 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21300 &`\n`& to &`\r\n`& in &%message_suffix%&.
21301
21302 .option mode appendfile "octal integer" 0600
21303 If the output file is created, it is given this mode. If it already exists and
21304 has wider permissions, they are reduced to this mode. If it has narrower
21305 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21306 if the delivery is the result of a &%save%& command in a filter file specifying
21307 a particular mode, the mode of the output file is always forced to take that
21308 value, and this option is ignored.
21309
21310
21311 .option mode_fail_narrower appendfile boolean true
21312 This option applies in the case when an existing mailbox file has a narrower
21313 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21314 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21315 continues with the delivery attempt, using the existing mode of the file.
21316
21317
21318 .option notify_comsat appendfile boolean false
21319 If this option is true, the &'comsat'& daemon is notified after every
21320 successful delivery to a user mailbox. This is the daemon that notifies logged
21321 on users about incoming mail.
21322
21323
21324 .option quota appendfile string&!! unset
21325 .cindex "quota" "imposed by Exim"
21326 This option imposes a limit on the size of the file to which Exim is appending,
21327 or to the total space used in the directory tree when the &%directory%& option
21328 is set. In the latter case, computation of the space used is expensive, because
21329 all the files in the directory (and any sub-directories) have to be
21330 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21331 &%maildir_use_size_file%& for ways to avoid this in environments where users
21332 have no shell access to their mailboxes).
21333
21334 As there is no interlock against two simultaneous deliveries into a
21335 multi-file mailbox, it is possible for the quota to be overrun in this case.
21336 For single-file mailboxes, of course, an interlock is a necessity.
21337
21338 A file's size is taken as its &'used'& value. Because of blocking effects, this
21339 may be a lot less than the actual amount of disk space allocated to the file.
21340 If the sizes of a number of files are being added up, the rounding effect can
21341 become quite noticeable, especially on systems that have large block sizes.
21342 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21343 the obvious value which users understand most easily.
21344
21345 The value of the option is expanded, and must then be a numerical value
21346 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21347 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21348 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21349 be handled.
21350
21351 &*Note*&: A value of zero is interpreted as &"no quota"&.
21352
21353 The expansion happens while Exim is running as root, before it changes uid for
21354 the delivery. This means that files that are inaccessible to the end user can
21355 be used to hold quota values that are looked up in the expansion. When delivery
21356 fails because this quota is exceeded, the handling of the error is as for
21357 system quota failures.
21358
21359 By default, Exim's quota checking mimics system quotas, and restricts the
21360 mailbox to the specified maximum size, though the value is not accurate to the
21361 last byte, owing to separator lines and additional headers that may get added
21362 during message delivery. When a mailbox is nearly full, large messages may get
21363 refused even though small ones are accepted, because the size of the current
21364 message is added to the quota when the check is made. This behaviour can be
21365 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21366 for exceeding the quota does not include the current message. Thus, deliveries
21367 continue until the quota has been exceeded; thereafter, no further messages are
21368 delivered. See also &%quota_warn_threshold%&.
21369
21370
21371 .option quota_directory appendfile string&!! unset
21372 This option defines the directory to check for quota purposes when delivering
21373 into individual files. The default is the delivery directory, or, if a file
21374 called &_maildirfolder_& exists in a maildir directory, the parent of the
21375 delivery directory.
21376
21377
21378 .option quota_filecount appendfile string&!! 0
21379 This option applies when the &%directory%& option is set. It limits the total
21380 number of files in the directory (compare the inode limit in system quotas). It
21381 can only be used if &%quota%& is also set. The value is expanded; an expansion
21382 failure causes delivery to be deferred. A value of zero is interpreted as
21383 &"no quota"&.
21384
21385
21386 .option quota_is_inclusive appendfile boolean true
21387 See &%quota%& above.
21388
21389
21390 .option quota_size_regex appendfile string unset
21391 This option applies when one of the delivery modes that writes a separate file
21392 for each message is being used. When Exim wants to find the size of one of
21393 these files in order to test the quota, it first checks &%quota_size_regex%&.
21394 If this is set to a regular expression that matches the file name, and it
21395 captures one string, that string is interpreted as a representation of the
21396 file's size. The value of &%quota_size_regex%& is not expanded.
21397
21398 This feature is useful only when users have no shell access to their mailboxes
21399 &-- otherwise they could defeat the quota simply by renaming the files. This
21400 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21401 the file length to the file name. For example:
21402 .code
21403 maildir_tag = ,S=$message_size
21404 quota_size_regex = ,S=(\d+)
21405 .endd
21406 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21407 number of lines in the message.
21408
21409 The regular expression should not assume that the length is at the end of the
21410 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21411 sometimes add other information onto the ends of message file names.
21412
21413 Section &<<SECID136>>& contains further information.
21414
21415
21416 .option quota_warn_message appendfile string&!! "see below"
21417 See below for the use of this option. If it is not set when
21418 &%quota_warn_threshold%& is set, it defaults to
21419 .code
21420 quota_warn_message = "\
21421   To: $local_part@$domain\n\
21422   Subject: Your mailbox\n\n\
21423   This message is automatically created \
21424   by mail delivery software.\n\n\
21425   The size of your mailbox has exceeded \
21426   a warning threshold that is\n\
21427   set by the system administrator.\n"
21428 .endd
21429
21430
21431 .option quota_warn_threshold appendfile string&!! 0
21432 .cindex "quota" "warning threshold"
21433 .cindex "mailbox" "size warning"
21434 .cindex "size" "of mailbox"
21435 This option is expanded in the same way as &%quota%& (see above). If the
21436 resulting value is greater than zero, and delivery of the message causes the
21437 size of the file or total space in the directory tree to cross the given
21438 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21439 may be specified as a percentage of it by following the value with a percent
21440 sign. For example:
21441 .code
21442 quota = 10M
21443 quota_warn_threshold = 75%
21444 .endd
21445 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21446 percent sign is ignored.
21447
21448 The warning message itself is specified by the &%quota_warn_message%& option,
21449 and it must start with a &'To:'& header line containing the recipient(s) of the
21450 warning message. These do not necessarily have to include the recipient(s) of
21451 the original message. A &'Subject:'& line should also normally be supplied. You
21452 can include any other header lines that you want. If you do not include a
21453 &'From:'& line, the default is:
21454 .code
21455 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21456 .endd
21457 .oindex &%errors_reply_to%&
21458 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21459 option.
21460
21461 The &%quota%& option does not have to be set in order to use this option; they
21462 are independent of one another except when the threshold is specified as a
21463 percentage.
21464
21465
21466 .option use_bsmtp appendfile boolean false
21467 .cindex "envelope sender"
21468 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21469 format, with the envelope sender and recipient(s) included as SMTP commands. If
21470 you want to include a leading HELO command with such messages, you can do
21471 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21472 for details of batch SMTP.
21473
21474
21475 .option use_crlf appendfile boolean false
21476 .cindex "carriage return"
21477 .cindex "linefeed"
21478 This option causes lines to be terminated with the two-character CRLF sequence
21479 (carriage return, linefeed) instead of just a linefeed character. In the case
21480 of batched SMTP, the byte sequence written to the file is then an exact image
21481 of what would be sent down a real SMTP connection.
21482
21483 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21484 (which are used to supply the traditional &"From&~"& and blank line separators
21485 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21486 carriage return characters if these are needed. In cases where these options
21487 have non-empty defaults, the values end with a single linefeed, so they must be
21488 changed to end with &`\r\n`& if &%use_crlf%& is set.
21489
21490
21491 .option use_fcntl_lock appendfile boolean "see below"
21492 This option controls the use of the &[fcntl()]& function to lock a file for
21493 exclusive use when a message is being appended. It is set by default unless
21494 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21495 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21496 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21497
21498
21499 .option use_flock_lock appendfile boolean false
21500 This option is provided to support the use of &[flock()]& for file locking, for
21501 the few situations where it is needed. Most modern operating systems support
21502 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21503 each other. Exim uses &[fcntl()]& locking by default.
21504
21505 This option is required only if you are using an operating system where
21506 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21507 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21508 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21509
21510 .cindex "Solaris" "&[flock()]& support"
21511 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21512 have it (and some, I think, provide a not quite right version built on top of
21513 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21514 the ability to use it, and any attempt to do so will cause a configuration
21515 error.
21516
21517 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21518 is just being mapped onto &[fcntl()]& by the OS).
21519
21520
21521 .option use_lockfile appendfile boolean "see below"
21522 If this option is turned off, Exim does not attempt to create a lock file when
21523 appending to a mailbox file. In this situation, the only locking is by
21524 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21525 sure that every MUA that is ever going to look at your users' mailboxes uses
21526 &[fcntl()]& rather than a lock file, and even then only when you are not
21527 delivering over NFS from more than one host.
21528
21529 .cindex "NFS" "lock file"
21530 In order to append to an NFS file safely from more than one host, it is
21531 necessary to take out a lock &'before'& opening the file, and the lock file
21532 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21533 file corruption.
21534
21535 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21536 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21537 except when &%mbx_format%& is set.
21538
21539
21540 .option use_mbx_lock appendfile boolean "see below"
21541 This option is available only if Exim has been compiled with SUPPORT_MBX
21542 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21543 locking rules be used. It is set by default if &%mbx_format%& is set and none
21544 of the locking options are mentioned in the configuration. The locking rules
21545 are the same as are used by the &'c-client'& library that underlies Pine and
21546 the IMAP4 and POP daemons that come with it (see the discussion below). The
21547 rules allow for shared access to the mailbox. However, this kind of locking
21548 does not work when the mailbox is NFS mounted.
21549
21550 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21551 &%use_flock_lock%& to control what kind of locking is used in implementing the
21552 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21553 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21554
21555
21556
21557
21558 .section "Operational details for appending" "SECTopappend"
21559 .cindex "appending to a file"
21560 .cindex "file" "appending"
21561 Before appending to a file, the following preparations are made:
21562
21563 .ilist
21564 If the name of the file is &_/dev/null_&, no action is taken, and a success
21565 return is given.
21566
21567 .next
21568 .cindex "directory creation"
21569 If any directories on the file's path are missing, Exim creates them if the
21570 &%create_directory%& option is set. A created directory's mode is given by the
21571 &%directory_mode%& option.
21572
21573 .next
21574 If &%file_format%& is set, the format of an existing file is checked. If this
21575 indicates that a different transport should be used, control is passed to that
21576 transport.
21577
21578 .next
21579 .cindex "file" "locking"
21580 .cindex "locking files"
21581 .cindex "NFS" "lock file"
21582 If &%use_lockfile%& is set, a lock file is built in a way that will work
21583 reliably over NFS, as follows:
21584
21585 .olist
21586 Create a &"hitching post"& file whose name is that of the lock file with the
21587 current time, primary host name, and process id added, by opening for writing
21588 as a new file. If this fails with an access error, delivery is deferred.
21589 .next
21590 Close the hitching post file, and hard link it to the lock file name.
21591 .next
21592 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21593 Unlink the hitching post name.
21594 .next
21595 Otherwise, use &[stat()]& to get information about the hitching post file, and
21596 then unlink hitching post name. If the number of links is exactly two, creation
21597 of the lock file succeeded but something (for example, an NFS server crash and
21598 restart) caused this fact not to be communicated to the &[link()]& call.
21599 .next
21600 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21601 up to &%lock_retries%& times. However, since any program that writes to a
21602 mailbox should complete its task very quickly, it is reasonable to time out old
21603 lock files that are normally the result of user agent and system crashes. If an
21604 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21605 it before trying again.
21606 .endlist olist
21607
21608 .next
21609 A call is made to &[lstat()]& to discover whether the main file exists, and if
21610 so, what its characteristics are. If &[lstat()]& fails for any reason other
21611 than non-existence, delivery is deferred.
21612
21613 .next
21614 .cindex "symbolic link" "to mailbox"
21615 .cindex "mailbox" "symbolic link"
21616 If the file does exist and is a symbolic link, delivery is deferred, unless the
21617 &%allow_symlink%& option is set, in which case the ownership of the link is
21618 checked, and then &[stat()]& is called to find out about the real file, which
21619 is then subjected to the checks below. The check on the top-level link
21620 ownership prevents one user creating a link for another's mailbox in a sticky
21621 directory, though allowing symbolic links in this case is definitely not a good
21622 idea. If there is a chain of symbolic links, the intermediate ones are not
21623 checked.
21624
21625 .next
21626 If the file already exists but is not a regular file, or if the file's owner
21627 and group (if the group is being checked &-- see &%check_group%& above) are
21628 different from the user and group under which the delivery is running,
21629 delivery is deferred.
21630
21631 .next
21632 If the file's permissions are more generous than specified, they are reduced.
21633 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21634 is set false, in which case the delivery is tried using the existing
21635 permissions.
21636
21637 .next
21638 The file's inode number is saved, and the file is then opened for appending.
21639 If this fails because the file has vanished, &(appendfile)& behaves as if it
21640 hadn't existed (see below). For any other failures, delivery is deferred.
21641
21642 .next
21643 If the file is opened successfully, check that the inode number hasn't
21644 changed, that it is still a regular file, and that the owner and permissions
21645 have not changed. If anything is wrong, defer delivery and freeze the message.
21646
21647 .next
21648 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21649 option is set. Otherwise, check that the file is being created in a permitted
21650 directory if the &%create_file%& option is set (deferring on failure), and then
21651 open for writing as a new file, with the O_EXCL and O_CREAT options,
21652 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21653 set). In this case, which can happen if the link points to a non-existent file,
21654 the file is opened for writing using O_CREAT but not O_EXCL, because
21655 that prevents link following.
21656
21657 .next
21658 .cindex "loop" "while file testing"
21659 If opening fails because the file exists, obey the tests given above for
21660 existing files. However, to avoid looping in a situation where the file is
21661 being continuously created and destroyed, the exists/not-exists loop is broken
21662 after 10 repetitions, and the message is then frozen.
21663
21664 .next
21665 If opening fails with any other error, defer delivery.
21666
21667 .next
21668 .cindex "file" "locking"
21669 .cindex "locking files"
21670 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21671 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21672 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21673 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21674 file, and an exclusive lock on the file whose name is
21675 .code
21676 /tmp/.<device-number>.<inode-number>
21677 .endd
21678 using the device and inode numbers of the open mailbox file, in accordance with
21679 the MBX locking rules. This file is created with a mode that is specified by
21680 the &%lockfile_mode%& option.
21681
21682 If Exim fails to lock the file, there are two possible courses of action,
21683 depending on the value of the locking timeout. This is obtained from
21684 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21685
21686 If the timeout value is zero, the file is closed, Exim waits for
21687 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21688 to lock it again. This happens up to &%lock_retries%& times, after which the
21689 delivery is deferred.
21690
21691 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21692 &[flock()]& are used (with the given timeout), so there has already been some
21693 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21694 immediately. It retries up to
21695 .code
21696 (lock_retries * lock_interval) / <timeout>
21697 .endd
21698 times (rounded up).
21699 .endlist
21700
21701 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21702 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21703
21704
21705 .section "Operational details for delivery to a new file" "SECTopdir"
21706 .cindex "delivery" "to single file"
21707 .cindex "&""From""& line"
21708 When the &%directory%& option is set instead of &%file%&, each message is
21709 delivered into a newly-created file or set of files. When &(appendfile)& is
21710 activated directly from a &(redirect)& router, neither &%file%& nor
21711 &%directory%& is normally set, because the path for delivery is supplied by the
21712 router. (See for example, the &(address_file)& transport in the default
21713 configuration.) In this case, delivery is to a new file if either the path name
21714 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21715
21716 No locking is required while writing the message to a new file, so the various
21717 locking options of the transport are ignored. The &"From"& line that by default
21718 separates messages in a single file is not normally needed, nor is the escaping
21719 of message lines that start with &"From"&, and there is no need to ensure a
21720 newline at the end of each message. Consequently, the default values for
21721 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21722 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21723
21724 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21725 the files in the delivery directory by default. However, you can specify a
21726 different directory by setting &%quota_directory%&. Also, for maildir
21727 deliveries (see below) the &_maildirfolder_& convention is honoured.
21728
21729
21730 .cindex "maildir format"
21731 .cindex "mailstore format"
21732 There are three different ways in which delivery to individual files can be
21733 done, controlled by the settings of the &%maildir_format%& and
21734 &%mailstore_format%& options. Note that code to support maildir or mailstore
21735 formats is not included in the binary unless SUPPORT_MAILDIR or
21736 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21737
21738 .cindex "directory creation"
21739 In all three cases an attempt is made to create the directory and any necessary
21740 sub-directories if they do not exist, provided that the &%create_directory%&
21741 option is set (the default). The location of a created directory can be
21742 constrained by setting &%create_file%&. A created directory's mode is given by
21743 the &%directory_mode%& option. If creation fails, or if the
21744 &%create_directory%& option is not set when creation is required, delivery is
21745 deferred.
21746
21747
21748
21749 .section "Maildir delivery" "SECTmaildirdelivery"
21750 .cindex "maildir format" "description of"
21751 If the &%maildir_format%& option is true, Exim delivers each message by writing
21752 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21753 directory that is defined by the &%directory%& option (the &"delivery
21754 directory"&). If the delivery is successful, the file is renamed into the
21755 &_new_& subdirectory.
21756
21757 In the file name, <&'stime'&> is the current time of day in seconds, and
21758 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21759 Exim checks that the time-of-day clock has moved on by at least one microsecond
21760 before terminating the delivery process. This guarantees uniqueness for the
21761 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21762 opening it. If any response other than ENOENT (does not exist) is given,
21763 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21764
21765 Before Exim carries out a maildir delivery, it ensures that subdirectories
21766 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21767 do not exist, Exim tries to create them and any superior directories in their
21768 path, subject to the &%create_directory%& and &%create_file%& options. If the
21769 &%maildirfolder_create_regex%& option is set, and the regular expression it
21770 contains matches the delivery directory, Exim also ensures that a file called
21771 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21772 &_maildirfolder_& file cannot be created, delivery is deferred.
21773
21774 These features make it possible to use Exim to create all the necessary files
21775 and directories in a maildir mailbox, including subdirectories for maildir++
21776 folders. Consider this example:
21777 .code
21778 maildir_format = true
21779 directory = /var/mail/$local_part\
21780            ${if eq{$local_part_suffix}{}{}\
21781            {/.${substr_1:$local_part_suffix}}}
21782 maildirfolder_create_regex = /\.[^/]+$
21783 .endd
21784 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21785 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21786 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21787 not match this name, so Exim will not look for or create the file
21788 &_/var/mail/pimbo/maildirfolder_&, though it will create
21789 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21790
21791 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21792 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21793 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21794 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21795 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21796
21797 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21798 not inadvertently match the toplevel maildir directory, because a
21799 &_maildirfolder_& file at top level would completely break quota calculations.
21800
21801 .cindex "quota" "in maildir delivery"
21802 .cindex "maildir++"
21803 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21804 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21805 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21806 Exim assumes the directory is a maildir++ folder directory, which is one level
21807 down from the user's top level mailbox directory. This causes it to start at
21808 the parent directory instead of the current directory when calculating the
21809 amount of space used.
21810
21811 One problem with delivering into a multi-file mailbox is that it is
21812 computationally expensive to compute the size of the mailbox for quota
21813 checking. Various approaches have been taken to reduce the amount of work
21814 needed. The next two sections describe two of them. A third alternative is to
21815 use some external process for maintaining the size data, and use the expansion
21816 of the &%mailbox_size%& option as a way of importing it into Exim.
21817
21818
21819
21820
21821 .section "Using tags to record message sizes" "SECID135"
21822 If &%maildir_tag%& is set, the string is expanded for each delivery.
21823 When the maildir file is renamed into the &_new_& sub-directory, the
21824 tag is added to its name. However, if adding the tag takes the length of the
21825 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21826 the tag is dropped and the maildir file is created with no tag.
21827
21828
21829 .vindex "&$message_size$&"
21830 Tags can be used to encode the size of files in their names; see
21831 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21832 happens after the message has been written. The value of the &$message_size$&
21833 variable is set to the number of bytes actually written. If the expansion is
21834 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21835 be deferred. The expanded tag may contain any printing characters except &"/"&.
21836 Non-printing characters in the string are ignored; if the resulting string is
21837 empty, it is ignored. If it starts with an alphanumeric character, a leading
21838 colon is inserted; this default has not proven to be the path that popular
21839 maildir implementations have chosen (but changing it in Exim would break
21840 backwards compatibility).
21841
21842 For one common implementation, you might set:
21843 .code
21844 maildir_tag = ,S=${message_size}
21845 .endd
21846 but you should check the documentation of the other software to be sure.
21847
21848 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21849 as this allows Exim to extract the size from your tag, instead of having to
21850 &[stat()]& each message file.
21851
21852
21853 .section "Using a maildirsize file" "SECID136"
21854 .cindex "quota" "in maildir delivery"
21855 .cindex "maildir format" "&_maildirsize_& file"
21856 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21857 storing quota and message size information in a file called &_maildirsize_&
21858 within the toplevel maildir directory. If this file does not exist, Exim
21859 creates it, setting the quota from the &%quota%& option of the transport. If
21860 the maildir directory itself does not exist, it is created before any attempt
21861 to write a &_maildirsize_& file.
21862
21863 The &_maildirsize_& file is used to hold information about the sizes of
21864 messages in the maildir, thus speeding up quota calculations. The quota value
21865 in the file is just a cache; if the quota is changed in the transport, the new
21866 value overrides the cached value when the next message is delivered. The cache
21867 is maintained for the benefit of other programs that access the maildir and
21868 need to know the quota.
21869
21870 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21871 file is maintained (with a zero quota setting), but no quota is imposed.
21872
21873 A regular expression is available for controlling which directories in the
21874 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21875 See the description of the &%maildir_quota_directory_regex%& option above for
21876 details.
21877
21878
21879 .section "Mailstore delivery" "SECID137"
21880 .cindex "mailstore format" "description of"
21881 If the &%mailstore_format%& option is true, each message is written as two
21882 files in the given directory. A unique base name is constructed from the
21883 message id and the current delivery process, and the files that are written use
21884 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21885 contains the message's envelope, and the &_.msg_& file contains the message
21886 itself. The base name is placed in the variable &$mailstore_basename$&.
21887
21888 During delivery, the envelope is first written to a file with the suffix
21889 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21890 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21891 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21892 file before accessing either of them. An alternative approach is to wait for
21893 the absence of a &_.tmp_& file.
21894
21895 The envelope file starts with any text defined by the &%mailstore_prefix%&
21896 option, expanded and terminated by a newline if there isn't one. Then follows
21897 the sender address on one line, then all the recipient addresses, one per line.
21898 There can be more than one recipient only if the &%batch_max%& option is set
21899 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21900 appended to the file, followed by a newline if it does not end with one.
21901
21902 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21903 failure, it is ignored. Other expansion errors are treated as serious
21904 configuration errors, and delivery is deferred. The variable
21905 &$mailstore_basename$& is available for use during these expansions.
21906
21907
21908 .section "Non-special new file delivery" "SECID138"
21909 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21910 file is created directly in the named directory. For example, when delivering
21911 messages into files in batched SMTP format for later delivery to some host (see
21912 section &<<SECTbatchSMTP>>&), a setting such as
21913 .code
21914 directory = /var/bsmtp/$host
21915 .endd
21916 might be used. A message is written to a file with a temporary name, which is
21917 then renamed when the delivery is complete. The final name is obtained by
21918 expanding the contents of the &%directory_file%& option.
21919 .ecindex IIDapptra1
21920 .ecindex IIDapptra2
21921
21922
21923
21924
21925
21926
21927 . ////////////////////////////////////////////////////////////////////////////
21928 . ////////////////////////////////////////////////////////////////////////////
21929
21930 .chapter "The autoreply transport" "CHID8"
21931 .scindex IIDauttra1 "transports" "&(autoreply)&"
21932 .scindex IIDauttra2 "&(autoreply)& transport"
21933 The &(autoreply)& transport is not a true transport in that it does not cause
21934 the message to be transmitted. Instead, it generates a new mail message as an
21935 automatic reply to the incoming message. &'References:'& and
21936 &'Auto-Submitted:'& header lines are included. These are constructed according
21937 to the rules in RFCs 2822 and 3834, respectively.
21938
21939 If the router that passes the message to this transport does not have the
21940 &%unseen%& option set, the original message (for the current recipient) is not
21941 delivered anywhere. However, when the &%unseen%& option is set on the router
21942 that passes the message to this transport, routing of the address continues, so
21943 another router can set up a normal message delivery.
21944
21945
21946 The &(autoreply)& transport is usually run as the result of mail filtering, a
21947 &"vacation"& message being the standard example. However, it can also be run
21948 directly from a router like any other transport. To reduce the possibility of
21949 message cascades, messages created by the &(autoreply)& transport always have
21950 empty envelope sender addresses, like bounce messages.
21951
21952 The parameters of the message to be sent can be specified in the configuration
21953 by options described below. However, these are used only when the address
21954 passed to the transport does not contain its own reply information. When the
21955 transport is run as a consequence of a
21956 &%mail%&
21957 or &%vacation%& command in a filter file, the parameters of the message are
21958 supplied by the filter, and passed with the address. The transport's options
21959 that define the message are then ignored (so they are not usually set in this
21960 case). The message is specified entirely by the filter or by the transport; it
21961 is never built from a mixture of options. However, the &%file_optional%&,
21962 &%mode%&, and &%return_message%& options apply in all cases.
21963
21964 &(Autoreply)& is implemented as a local transport. When used as a result of a
21965 command in a user's filter file, &(autoreply)& normally runs under the uid and
21966 gid of the user, and with appropriate current and home directories (see chapter
21967 &<<CHAPenvironment>>&).
21968
21969 There is a subtle difference between routing a message to a &(pipe)& transport
21970 that generates some text to be returned to the sender, and routing it to an
21971 &(autoreply)& transport. This difference is noticeable only if more than one
21972 address from the same message is so handled. In the case of a pipe, the
21973 separate outputs from the different addresses are gathered up and returned to
21974 the sender in a single message, whereas if &(autoreply)& is used, a separate
21975 message is generated for each address that is passed to it.
21976
21977 Non-printing characters are not permitted in the header lines generated for the
21978 message that &(autoreply)& creates, with the exception of newlines that are
21979 immediately followed by white space. If any non-printing characters are found,
21980 the transport defers.
21981 Whether characters with the top bit set count as printing characters or not is
21982 controlled by the &%print_topbitchars%& global option.
21983
21984 If any of the generic options for manipulating headers (for example,
21985 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21986 of the original message that is included in the generated message when
21987 &%return_message%& is set. They do not apply to the generated message itself.
21988
21989 .vindex "&$sender_address$&"
21990 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21991 the message, indicating that there were no recipients, it does not treat this
21992 as an error. This means that autoreplies sent to &$sender_address$& when this
21993 is empty (because the incoming message is a bounce message) do not cause
21994 problems. They are just discarded.
21995
21996
21997
21998 .section "Private options for autoreply" "SECID139"
21999 .cindex "options" "&(autoreply)& transport"
22000
22001 .option bcc autoreply string&!! unset
22002 This specifies the addresses that are to receive &"blind carbon copies"& of the
22003 message when the message is specified by the transport.
22004
22005
22006 .option cc autoreply string&!! unset
22007 This specifies recipients of the message and the contents of the &'Cc:'& header
22008 when the message is specified by the transport.
22009
22010
22011 .option file autoreply string&!! unset
22012 The contents of the file are sent as the body of the message when the message
22013 is specified by the transport. If both &%file%& and &%text%& are set, the text
22014 string comes first.
22015
22016
22017 .option file_expand autoreply boolean false
22018 If this is set, the contents of the file named by the &%file%& option are
22019 subjected to string expansion as they are added to the message.
22020
22021
22022 .option file_optional autoreply boolean false
22023 If this option is true, no error is generated if the file named by the &%file%&
22024 option or passed with the address does not exist or cannot be read.
22025
22026
22027 .option from autoreply string&!! unset
22028 This specifies the contents of the &'From:'& header when the message is
22029 specified by the transport.
22030
22031
22032 .option headers autoreply string&!! unset
22033 This specifies additional RFC 2822 headers that are to be added to the message
22034 when the message is specified by the transport. Several can be given by using
22035 &"\n"& to separate them. There is no check on the format.
22036
22037
22038 .option log autoreply string&!! unset
22039 This option names a file in which a record of every message sent is logged when
22040 the message is specified by the transport.
22041
22042
22043 .option mode autoreply "octal integer" 0600
22044 If either the log file or the &"once"& file has to be created, this mode is
22045 used.
22046
22047
22048 .option never_mail autoreply "address list&!!" unset
22049 If any run of the transport creates a message with a recipient that matches any
22050 item in the list, that recipient is quietly discarded. If all recipients are
22051 discarded, no message is created. This applies both when the recipients are
22052 generated by a filter and when they are specified in the transport.
22053
22054
22055
22056 .option once autoreply string&!! unset
22057 This option names a file or DBM database in which a record of each &'To:'&
22058 recipient is kept when the message is specified by the transport. &*Note*&:
22059 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22060
22061 If &%once%& is unset, or is set to an empty string, the message is always sent.
22062 By default, if &%once%& is set to a non-empty file name, the message
22063 is not sent if a potential recipient is already listed in the database.
22064 However, if the &%once_repeat%& option specifies a time greater than zero, the
22065 message is sent if that much time has elapsed since a message was last sent to
22066 this recipient. A setting of zero time for &%once_repeat%& (the default)
22067 prevents a message from being sent a second time &-- in this case, zero means
22068 infinity.
22069
22070 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22071 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22072 greater than zero, it changes the way Exim implements the &%once%& option.
22073 Instead of using a DBM file to record every recipient it sends to, it uses a
22074 regular file, whose size will never get larger than the given value.
22075
22076 In the file, Exim keeps a linear list of recipient addresses and the times at
22077 which they were sent messages. If the file is full when a new address needs to
22078 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22079 means that a given recipient may receive multiple messages, but at
22080 unpredictable intervals that depend on the rate of turnover of addresses in the
22081 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22082
22083
22084 .option once_file_size autoreply integer 0
22085 See &%once%& above.
22086
22087
22088 .option once_repeat autoreply time&!! 0s
22089 See &%once%& above.
22090 After expansion, the value of this option must be a valid time value.
22091
22092
22093 .option reply_to autoreply string&!! unset
22094 This specifies the contents of the &'Reply-To:'& header when the message is
22095 specified by the transport.
22096
22097
22098 .option return_message autoreply boolean false
22099 If this is set, a copy of the original message is returned with the new
22100 message, subject to the maximum size set in the &%return_size_limit%& global
22101 configuration option.
22102
22103
22104 .option subject autoreply string&!! unset
22105 This specifies the contents of the &'Subject:'& header when the message is
22106 specified by the transport. It is tempting to quote the original subject in
22107 automatic responses. For example:
22108 .code
22109 subject = Re: $h_subject:
22110 .endd
22111 There is a danger in doing this, however. It may allow a third party to
22112 subscribe your users to an opt-in mailing list, provided that the list accepts
22113 bounce messages as subscription confirmations. Well-managed lists require a
22114 non-bounce message to confirm a subscription, so the danger is relatively
22115 small.
22116
22117
22118
22119 .option text autoreply string&!! unset
22120 This specifies a single string to be used as the body of the message when the
22121 message is specified by the transport. If both &%text%& and &%file%& are set,
22122 the text comes first.
22123
22124
22125 .option to autoreply string&!! unset
22126 This specifies recipients of the message and the contents of the &'To:'& header
22127 when the message is specified by the transport.
22128 .ecindex IIDauttra1
22129 .ecindex IIDauttra2
22130
22131
22132
22133
22134 . ////////////////////////////////////////////////////////////////////////////
22135 . ////////////////////////////////////////////////////////////////////////////
22136
22137 .chapter "The lmtp transport" "CHAPLMTP"
22138 .cindex "transports" "&(lmtp)&"
22139 .cindex "&(lmtp)& transport"
22140 .cindex "LMTP" "over a pipe"
22141 .cindex "LMTP" "over a socket"
22142 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22143 specified command
22144 or by interacting with a Unix domain socket.
22145 This transport is something of a cross between the &(pipe)& and &(smtp)&
22146 transports. Exim also has support for using LMTP over TCP/IP; this is
22147 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22148 to be of minority interest, the default build-time configure in &_src/EDITME_&
22149 has it commented out. You need to ensure that
22150 .code
22151 TRANSPORT_LMTP=yes
22152 .endd
22153 .cindex "options" "&(lmtp)& transport"
22154 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22155 included in the Exim binary. The private options of the &(lmtp)& transport are
22156 as follows:
22157
22158 .option batch_id lmtp string&!! unset
22159 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22160
22161
22162 .option batch_max lmtp integer 1
22163 This limits the number of addresses that can be handled in a single delivery.
22164 Most LMTP servers can handle several addresses at once, so it is normally a
22165 good idea to increase this value. See the description of local delivery
22166 batching in chapter &<<CHAPbatching>>&.
22167
22168
22169 .option command lmtp string&!! unset
22170 This option must be set if &%socket%& is not set. The string is a command which
22171 is run in a separate process. It is split up into a command name and list of
22172 arguments, each of which is separately expanded (so expansion cannot change the
22173 number of arguments). The command is run directly, not via a shell. The message
22174 is passed to the new process using the standard input and output to operate the
22175 LMTP protocol.
22176
22177 .option ignore_quota lmtp boolean false
22178 .cindex "LMTP" "ignoring quota errors"
22179 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22180 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22181 in its response to the LHLO command.
22182
22183 .option socket lmtp string&!! unset
22184 This option must be set if &%command%& is not set. The result of expansion must
22185 be the name of a Unix domain socket. The transport connects to the socket and
22186 delivers the message to it using the LMTP protocol.
22187
22188
22189 .option timeout lmtp time 5m
22190 The transport is aborted if the created process or Unix domain socket does not
22191 respond to LMTP commands or message input within this timeout. Delivery
22192 is deferred, and will be tried again later. Here is an example of a typical
22193 LMTP transport:
22194 .code
22195 lmtp:
22196   driver = lmtp
22197   command = /some/local/lmtp/delivery/program
22198   batch_max = 20
22199   user = exim
22200 .endd
22201 This delivers up to 20 addresses at a time, in a mixture of domains if
22202 necessary, running as the user &'exim'&.
22203
22204
22205
22206 . ////////////////////////////////////////////////////////////////////////////
22207 . ////////////////////////////////////////////////////////////////////////////
22208
22209 .chapter "The pipe transport" "CHAPpipetransport"
22210 .scindex IIDpiptra1 "transports" "&(pipe)&"
22211 .scindex IIDpiptra2 "&(pipe)& transport"
22212 The &(pipe)& transport is used to deliver messages via a pipe to a command
22213 running in another process. One example is the use of &(pipe)& as a
22214 pseudo-remote transport for passing messages to some other delivery mechanism
22215 (such as UUCP). Another is the use by individual users to automatically process
22216 their incoming messages. The &(pipe)& transport can be used in one of the
22217 following ways:
22218
22219 .ilist
22220 .vindex "&$local_part$&"
22221 A router routes one address to a transport in the normal way, and the
22222 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22223 contains the local part of the address (as usual), and the command that is run
22224 is specified by the &%command%& option on the transport.
22225 .next
22226 .vindex "&$pipe_addresses$&"
22227 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22228 transport can handle more than one address in a single run. In this case, when
22229 more than one address is routed to the transport, &$local_part$& is not set
22230 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22231 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22232 that are routed to the transport.
22233 .next
22234 .vindex "&$address_pipe$&"
22235 A router redirects an address directly to a pipe command (for example, from an
22236 alias or forward file). In this case, &$address_pipe$& contains the text of the
22237 pipe command, and the &%command%& option on the transport is ignored unless
22238 &%force_command%& is set. If only one address is being transported
22239 (&%batch_max%& is not greater than one, or only one address was redirected to
22240 this pipe command), &$local_part$& contains the local part that was redirected.
22241 .endlist
22242
22243
22244 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22245 deliver messages over pipes using the LMTP interactive protocol. This is
22246 implemented by the &(lmtp)& transport.
22247
22248 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22249 &_.forward_& file, the command runs under the uid and gid of that user. In
22250 other cases, the uid and gid have to be specified explicitly, either on the
22251 transport or on the router that handles the address. Current and &"home"&
22252 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22253 details of the local delivery environment and chapter &<<CHAPbatching>>&
22254 for a discussion of local delivery batching.
22255
22256
22257 .section "Concurrent delivery" "SECID140"
22258 If two messages arrive at almost the same time, and both are routed to a pipe
22259 delivery, the two pipe transports may be run concurrently. You must ensure that
22260 any pipe commands you set up are robust against this happening. If the commands
22261 write to a file, the &%exim_lock%& utility might be of use.
22262
22263
22264
22265
22266 .section "Returned status and data" "SECID141"
22267 .cindex "&(pipe)& transport" "returned data"
22268 If the command exits with a non-zero return code, the delivery is deemed to
22269 have failed, unless either the &%ignore_status%& option is set (in which case
22270 the return code is treated as zero), or the return code is one of those listed
22271 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22272 later"&. In this case, delivery is deferred. Details of a permanent failure are
22273 logged, but are not included in the bounce message, which merely contains
22274 &"local delivery failed"&.
22275
22276 If the command exits on a signal and the &%freeze_signal%& option is set then
22277 the message will be frozen in the queue. If that option is not set, a bounce
22278 will be sent as normal.
22279
22280 If the return code is greater than 128 and the command being run is a shell
22281 script, it normally means that the script was terminated by a signal whose
22282 value is the return code minus 128. The &%freeze_signal%& option does not
22283 apply in this case.
22284
22285 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22286 return code is set to 127. This is the value that a shell returns if it is
22287 asked to run a non-existent command. The wording for the log line suggests that
22288 a non-existent command may be the problem.
22289
22290 The &%return_output%& option can affect the result of a pipe delivery. If it is
22291 set and the command produces any output on its standard output or standard
22292 error streams, the command is considered to have failed, even if it gave a zero
22293 return code or if &%ignore_status%& is set. The output from the command is
22294 included as part of the bounce message. The &%return_fail_output%& option is
22295 similar, except that output is returned only when the command exits with a
22296 failure return code, that is, a value other than zero or a code that matches
22297 &%temp_errors%&.
22298
22299
22300
22301 .section "How the command is run" "SECThowcommandrun"
22302 .cindex "&(pipe)& transport" "path for command"
22303 The command line is (by default) broken down into a command name and arguments
22304 by the &(pipe)& transport itself. The &%allow_commands%& and
22305 &%restrict_to_path%& options can be used to restrict the commands that may be
22306 run.
22307
22308 .cindex "quoting" "in pipe command"
22309 Unquoted arguments are delimited by white space. If an argument appears in
22310 double quotes, backslash is interpreted as an escape character in the usual
22311 way. If an argument appears in single quotes, no escaping is done.
22312
22313 String expansion is applied to the command line except when it comes from a
22314 traditional &_.forward_& file (commands from a filter file are expanded). The
22315 expansion is applied to each argument in turn rather than to the whole line.
22316 For this reason, any string expansion item that contains white space must be
22317 quoted so as to be contained within a single argument. A setting such as
22318 .code
22319 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22320 .endd
22321 will not work, because the expansion item gets split between several
22322 arguments. You have to write
22323 .code
22324 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22325 .endd
22326 to ensure that it is all in one argument. The expansion is done in this way,
22327 argument by argument, so that the number of arguments cannot be changed as a
22328 result of expansion, and quotes or backslashes in inserted variables do not
22329 interact with external quoting. However, this leads to problems if you want to
22330 generate multiple arguments (or the command name plus arguments) from a single
22331 expansion. In this situation, the simplest solution is to use a shell. For
22332 example:
22333 .code
22334 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22335 .endd
22336
22337 .cindex "transport" "filter"
22338 .cindex "filter" "transport filter"
22339 .vindex "&$pipe_addresses$&"
22340 Special handling takes place when an argument consists of precisely the text
22341 &`$pipe_addresses`&. This is not a general expansion variable; the only
22342 place this string is recognized is when it appears as an argument for a pipe or
22343 transport filter command. It causes each address that is being handled to be
22344 inserted in the argument list at that point &'as a separate argument'&. This
22345 avoids any problems with spaces or shell metacharacters, and is of use when a
22346 &(pipe)& transport is handling groups of addresses in a batch.
22347
22348 If &%force_command%& is enabled on the transport, Special handling takes place
22349 for an argument that consists of precisely the text &`$address_pipe`&.  It
22350 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22351 argument is inserted in the argument list at that point
22352 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22353 the only item in the argument; in fact, if it were then &%force_command%&
22354 should behave as a no-op.  Rather, it should be used to adjust the command
22355 run while preserving the argument vector separation.
22356
22357 After splitting up into arguments and expansion, the resulting command is run
22358 in a subprocess directly from the transport, &'not'& under a shell. The
22359 message that is being delivered is supplied on the standard input, and the
22360 standard output and standard error are both connected to a single pipe that is
22361 read by Exim. The &%max_output%& option controls how much output the command
22362 may produce, and the &%return_output%& and &%return_fail_output%& options
22363 control what is done with it.
22364
22365 Not running the command under a shell (by default) lessens the security risks
22366 in cases when a command from a user's filter file is built out of data that was
22367 taken from an incoming message. If a shell is required, it can of course be
22368 explicitly specified as the command to be run. However, there are circumstances
22369 where existing commands (for example, in &_.forward_& files) expect to be run
22370 under a shell and cannot easily be modified. To allow for these cases, there is
22371 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22372 works. Instead of breaking up the command line as just described, it expands it
22373 as a single string and passes the result to &_/bin/sh_&. The
22374 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22375 with &%use_shell%&, and the whole mechanism is inherently less secure.
22376
22377
22378
22379 .section "Environment variables" "SECTpipeenv"
22380 .cindex "&(pipe)& transport" "environment for command"
22381 .cindex "environment for pipe transport"
22382 The environment variables listed below are set up when the command is invoked.
22383 This list is a compromise for maximum compatibility with other MTAs. Note that
22384 the &%environment%& option can be used to add additional variables to this
22385 environment.
22386 .display
22387 &`DOMAIN            `&   the domain of the address
22388 &`HOME              `&   the home directory, if set
22389 &`HOST              `&   the host name when called from a router (see below)
22390 &`LOCAL_PART        `&   see below
22391 &`LOCAL_PART_PREFIX `&   see below
22392 &`LOCAL_PART_SUFFIX `&   see below
22393 &`LOGNAME           `&   see below
22394 &`MESSAGE_ID        `&   Exim's local ID for the message
22395 &`PATH              `&   as specified by the &%path%& option below
22396 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22397 &`RECIPIENT         `&   the complete recipient address
22398 &`SENDER            `&   the sender of the message (empty if a bounce)
22399 &`SHELL             `&   &`/bin/sh`&
22400 &`TZ                `&   the value of the &%timezone%& option, if set
22401 &`USER              `&   see below
22402 .endd
22403 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22404 router, LOCAL_PART is set to the local part of the address. When it is
22405 called as a result of a forward or alias expansion, LOCAL_PART is set to
22406 the local part of the address that was expanded. In both cases, any affixes are
22407 removed from the local part, and made available in LOCAL_PART_PREFIX and
22408 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22409 same value as LOCAL_PART for compatibility with other MTAs.
22410
22411 .cindex "HOST"
22412 HOST is set only when a &(pipe)& transport is called from a router that
22413 associates hosts with an address, typically when using &(pipe)& as a
22414 pseudo-remote transport. HOST is set to the first host name specified by
22415 the router.
22416
22417 .cindex "HOME"
22418 If the transport's generic &%home_directory%& option is set, its value is used
22419 for the HOME environment variable. Otherwise, a home directory may be set
22420 by the router's &%transport_home_directory%& option, which defaults to the
22421 user's home directory if &%check_local_user%& is set.
22422
22423
22424 .section "Private options for pipe" "SECID142"
22425 .cindex "options" "&(pipe)& transport"
22426
22427
22428
22429 .option allow_commands pipe "string list&!!" unset
22430 .cindex "&(pipe)& transport" "permitted commands"
22431 The string is expanded, and is then interpreted as a colon-separated list of
22432 permitted commands. If &%restrict_to_path%& is not set, the only commands
22433 permitted are those in the &%allow_commands%& list. They need not be absolute
22434 paths; the &%path%& option is still used for relative paths. If
22435 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22436 in the &%allow_commands%& list, or a name without any slashes that is found on
22437 the path. In other words, if neither &%allow_commands%& nor
22438 &%restrict_to_path%& is set, there is no restriction on the command, but
22439 otherwise only commands that are permitted by one or the other are allowed. For
22440 example, if
22441 .code
22442 allow_commands = /usr/bin/vacation
22443 .endd
22444 and &%restrict_to_path%& is not set, the only permitted command is
22445 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22446 &%use_shell%& is set.
22447
22448
22449 .option batch_id pipe string&!! unset
22450 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22451
22452
22453 .option batch_max pipe integer 1
22454 This limits the number of addresses that can be handled in a single delivery.
22455 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22456
22457
22458 .option check_string pipe string unset
22459 As &(pipe)& writes the message, the start of each line is tested for matching
22460 &%check_string%&, and if it does, the initial matching characters are replaced
22461 by the contents of &%escape_string%&, provided both are set. The value of
22462 &%check_string%& is a literal string, not a regular expression, and the case of
22463 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22464 of &%check_string%& and &%escape_string%& are forced to values that implement
22465 the SMTP escaping protocol. Any settings made in the configuration file are
22466 ignored.
22467
22468
22469 .option command pipe string&!! unset
22470 This option need not be set when &(pipe)& is being used to deliver to pipes
22471 obtained directly from address redirections. In other cases, the option must be
22472 set, to provide a command to be run. It need not yield an absolute path (see
22473 the &%path%& option below). The command is split up into separate arguments by
22474 Exim, and each argument is separately expanded, as described in section
22475 &<<SECThowcommandrun>>& above.
22476
22477
22478 .option environment pipe string&!! unset
22479 .cindex "&(pipe)& transport" "environment for command"
22480 .cindex "environment for &(pipe)& transport"
22481 This option is used to add additional variables to the environment in which the
22482 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22483 a string which is expanded, and then interpreted as a colon-separated list of
22484 environment settings of the form <&'name'&>=<&'value'&>.
22485
22486
22487 .option escape_string pipe string unset
22488 See &%check_string%& above.
22489
22490
22491 .option freeze_exec_fail pipe boolean false
22492 .cindex "exec failure"
22493 .cindex "failure of exec"
22494 .cindex "&(pipe)& transport" "failure of exec"
22495 Failure to exec the command in a pipe transport is by default treated like
22496 any other failure while running the command. However, if &%freeze_exec_fail%&
22497 is set, failure to exec is treated specially, and causes the message to be
22498 frozen, whatever the setting of &%ignore_status%&.
22499
22500
22501 .option freeze_signal pipe boolean false
22502 .cindex "signal exit"
22503 .cindex "&(pipe)& transport", "signal exit"
22504 Normally if the process run by a command in a pipe transport exits on a signal,
22505 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22506 frozen in Exim's queue instead.
22507
22508
22509 .option force_command pipe boolean false
22510 .cindex "force command"
22511 .cindex "&(pipe)& transport", "force command"
22512 Normally when a router redirects an address directly to a pipe command
22513 the &%command%& option on the transport is ignored.  If &%force_command%&
22514 is set, the &%command%& option will used. This is especially
22515 useful for forcing a wrapper or additional argument to be added to the
22516 command. For example:
22517 .code
22518 command = /usr/bin/remote_exec myhost -- $address_pipe
22519 force_command
22520 .endd
22521
22522 Note that &$address_pipe$& is handled specially in &%command%& when
22523 &%force_command%& is set, expanding out to the original argument vector as
22524 separate items, similarly to a Unix shell &`"$@"`& construct.
22525
22526 .option ignore_status pipe boolean false
22527 If this option is true, the status returned by the subprocess that is set up to
22528 run the command is ignored, and Exim behaves as if zero had been returned.
22529 Otherwise, a non-zero status or termination by signal causes an error return
22530 from the transport unless the status value is one of those listed in
22531 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22532
22533 &*Note*&: This option does not apply to timeouts, which do not return a status.
22534 See the &%timeout_defer%& option for how timeouts are handled.
22535
22536 .option log_defer_output pipe boolean false
22537 .cindex "&(pipe)& transport" "logging output"
22538 If this option is set, and the status returned by the command is
22539 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22540 and any output was produced, the first line of it is written to the main log.
22541
22542
22543 .option log_fail_output pipe boolean false
22544 If this option is set, and the command returns any output, and also ends with a
22545 return code that is neither zero nor one of the return codes listed in
22546 &%temp_errors%& (that is, the delivery failed), the first line of output is
22547 written to the main log. This option and &%log_output%& are mutually exclusive.
22548 Only one of them may be set.
22549
22550
22551
22552 .option log_output pipe boolean false
22553 If this option is set and the command returns any output, the first line of
22554 output is written to the main log, whatever the return code. This option and
22555 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22556
22557
22558
22559 .option max_output pipe integer 20K
22560 This specifies the maximum amount of output that the command may produce on its
22561 standard output and standard error file combined. If the limit is exceeded, the
22562 process running the command is killed. This is intended as a safety measure to
22563 catch runaway processes. The limit is applied independently of the settings of
22564 the options that control what is done with such output (for example,
22565 &%return_output%&). Because of buffering effects, the amount of output may
22566 exceed the limit by a small amount before Exim notices.
22567
22568
22569 .option message_prefix pipe string&!! "see below"
22570 The string specified here is expanded and output at the start of every message.
22571 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22572 .code
22573 message_prefix = \
22574   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22575   ${tod_bsdinbox}\n
22576 .endd
22577 .cindex "Cyrus"
22578 .cindex "&%tmail%&"
22579 .cindex "&""From""& line"
22580 This is required by the commonly used &_/usr/bin/vacation_& program.
22581 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22582 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22583 setting
22584 .code
22585 message_prefix =
22586 .endd
22587 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22588 &`\n`& to &`\r\n`& in &%message_prefix%&.
22589
22590
22591 .option message_suffix pipe string&!! "see below"
22592 The string specified here is expanded and output at the end of every message.
22593 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22594 The suffix can be suppressed by setting
22595 .code
22596 message_suffix =
22597 .endd
22598 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22599 &`\n`& to &`\r\n`& in &%message_suffix%&.
22600
22601
22602 .option path pipe string "see below"
22603 This option specifies the string that is set up in the PATH environment
22604 variable of the subprocess. The default is:
22605 .code
22606 /bin:/usr/bin
22607 .endd
22608 If the &%command%& option does not yield an absolute path name, the command is
22609 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22610 apply to a command specified as a transport filter.
22611
22612
22613 .option permit_coredump pipe boolean false
22614 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22615 a core-dump of a pipe command, enable this command.  This enables core-dumps
22616 during delivery and affects both the Exim binary and the pipe command run.
22617 It is recommended that this option remain off unless and until you have a need
22618 for it and that this only be enabled when needed, as the risk of excessive
22619 resource consumption can be quite high.  Note also that Exim is typically
22620 installed as a setuid binary and most operating systems will inhibit coredumps
22621 of these by default, so further OS-specific action may be required.
22622
22623
22624 .option pipe_as_creator pipe boolean false
22625 .cindex "uid (user id)" "local delivery"
22626 If the generic &%user%& option is not set and this option is true, the delivery
22627 process is run under the uid that was in force when Exim was originally called
22628 to accept the message. If the group id is not otherwise set (via the generic
22629 &%group%& option), the gid that was in force when Exim was originally called to
22630 accept the message is used.
22631
22632
22633 .option restrict_to_path pipe boolean false
22634 When this option is set, any command name not listed in &%allow_commands%& must
22635 contain no slashes. The command is searched for only in the directories listed
22636 in the &%path%& option. This option is intended for use in the case when a pipe
22637 command has been generated from a user's &_.forward_& file. This is usually
22638 handled by a &(pipe)& transport called &%address_pipe%&.
22639
22640
22641 .option return_fail_output pipe boolean false
22642 If this option is true, and the command produced any output and ended with a
22643 return code other than zero or one of the codes listed in &%temp_errors%& (that
22644 is, the delivery failed), the output is returned in the bounce message.
22645 However, if the message has a null sender (that is, it is itself a bounce
22646 message), output from the command is discarded. This option and
22647 &%return_output%& are mutually exclusive. Only one of them may be set.
22648
22649
22650
22651 .option return_output pipe boolean false
22652 If this option is true, and the command produced any output, the delivery is
22653 deemed to have failed whatever the return code from the command, and the output
22654 is returned in the bounce message. Otherwise, the output is just discarded.
22655 However, if the message has a null sender (that is, it is a bounce message),
22656 output from the command is always discarded, whatever the setting of this
22657 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22658 of them may be set.
22659
22660
22661
22662 .option temp_errors pipe "string list" "see below"
22663 .cindex "&(pipe)& transport" "temporary failure"
22664 This option contains either a colon-separated list of numbers, or a single
22665 asterisk. If &%ignore_status%& is false
22666 and &%return_output%& is not set,
22667 and the command exits with a non-zero return code, the failure is treated as
22668 temporary and the delivery is deferred if the return code matches one of the
22669 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22670 codes are treated as permanent errors. The default setting contains the codes
22671 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22672 compiled on a system that does not define these macros, it assumes values of 75
22673 and 73, respectively.
22674
22675
22676 .option timeout pipe time 1h
22677 If the command fails to complete within this time, it is killed. This normally
22678 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22679 specifies no timeout. In order to ensure that any subprocesses created by the
22680 command are also killed, Exim makes the initial process a process group leader,
22681 and kills the whole process group on a timeout. However, this can be defeated
22682 if one of the processes starts a new process group.
22683
22684 .option timeout_defer pipe boolean false
22685 A timeout in a &(pipe)& transport, either in the command that the transport
22686 runs, or in a transport filter that is associated with it, is by default
22687 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22688 is set true, both kinds of timeout become temporary errors, causing the
22689 delivery to be deferred.
22690
22691 .option umask pipe "octal integer" 022
22692 This specifies the umask setting for the subprocess that runs the command.
22693
22694
22695 .option use_bsmtp pipe boolean false
22696 .cindex "envelope sender"
22697 If this option is set true, the &(pipe)& transport writes messages in &"batch
22698 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22699 commands. If you want to include a leading HELO command with such messages,
22700 you can do so by setting the &%message_prefix%& option. See section
22701 &<<SECTbatchSMTP>>& for details of batch SMTP.
22702
22703 .option use_classresources pipe boolean false
22704 .cindex "class resources (BSD)"
22705 This option is available only when Exim is running on FreeBSD, NetBSD, or
22706 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22707 resource limits when a &(pipe)& transport is run to perform a delivery. The
22708 limits for the uid under which the pipe is to run are obtained from the login
22709 class database.
22710
22711
22712 .option use_crlf pipe boolean false
22713 .cindex "carriage return"
22714 .cindex "linefeed"
22715 This option causes lines to be terminated with the two-character CRLF sequence
22716 (carriage return, linefeed) instead of just a linefeed character. In the case
22717 of batched SMTP, the byte sequence written to the pipe is then an exact image
22718 of what would be sent down a real SMTP connection.
22719
22720 The contents of the &%message_prefix%& and &%message_suffix%& options are
22721 written verbatim, so must contain their own carriage return characters if these
22722 are needed. When &%use_bsmtp%& is not set, the default values for both
22723 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22724 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22725
22726
22727 .option use_shell pipe boolean false
22728 .vindex "&$pipe_addresses$&"
22729 If this option is set, it causes the command to be passed to &_/bin/sh_&
22730 instead of being run directly from the transport, as described in section
22731 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22732 where the command is expected to be run under a shell and cannot easily be
22733 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22734 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22735 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22736 its &%-c%& option.
22737
22738
22739
22740 .section "Using an external local delivery agent" "SECID143"
22741 .cindex "local delivery" "using an external agent"
22742 .cindex "&'procmail'&"
22743 .cindex "external local delivery"
22744 .cindex "delivery" "&'procmail'&"
22745 .cindex "delivery" "by external agent"
22746 The &(pipe)& transport can be used to pass all messages that require local
22747 delivery to a separate local delivery agent such as &%procmail%&. When doing
22748 this, care must be taken to ensure that the pipe is run under an appropriate
22749 uid and gid. In some configurations one wants this to be a uid that is trusted
22750 by the delivery agent to supply the correct sender of the message. It may be
22751 necessary to recompile or reconfigure the delivery agent so that it trusts an
22752 appropriate user. The following is an example transport and router
22753 configuration for &%procmail%&:
22754 .code
22755 # transport
22756 procmail_pipe:
22757   driver = pipe
22758   command = /usr/local/bin/procmail -d $local_part
22759   return_path_add
22760   delivery_date_add
22761   envelope_to_add
22762   check_string = "From "
22763   escape_string = ">From "
22764   umask = 077
22765   user = $local_part
22766   group = mail
22767
22768 # router
22769 procmail:
22770   driver = accept
22771   check_local_user
22772   transport = procmail_pipe
22773 .endd
22774 In this example, the pipe is run as the local user, but with the group set to
22775 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22776 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22777 user to supply a correct sender address. If you do not specify either a
22778 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22779 home directory is the user's home directory by default.
22780
22781 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22782 .code
22783 IFS=" "
22784 .endd
22785 as shown in some &%procmail%& documentation, because Exim does not by default
22786 use a shell to run pipe commands.
22787
22788 .cindex "Cyrus"
22789 The next example shows a transport and a router for a system where local
22790 deliveries are handled by the Cyrus IMAP server.
22791 .code
22792 # transport
22793 local_delivery_cyrus:
22794   driver = pipe
22795   command = /usr/cyrus/bin/deliver \
22796             -m ${substr_1:$local_part_suffix} -- $local_part
22797   user = cyrus
22798   group = mail
22799   return_output
22800   log_output
22801   message_prefix =
22802   message_suffix =
22803
22804 # router
22805 local_user_cyrus:
22806   driver = accept
22807   check_local_user
22808   local_part_suffix = .*
22809   transport = local_delivery_cyrus
22810 .endd
22811 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22812 &%return_output%& to cause any text written by Cyrus to be returned to the
22813 sender.
22814 .ecindex IIDpiptra1
22815 .ecindex IIDpiptra2
22816
22817
22818 . ////////////////////////////////////////////////////////////////////////////
22819 . ////////////////////////////////////////////////////////////////////////////
22820
22821 .chapter "The smtp transport" "CHAPsmtptrans"
22822 .scindex IIDsmttra1 "transports" "&(smtp)&"
22823 .scindex IIDsmttra2 "&(smtp)& transport"
22824 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22825 or LMTP protocol. The list of hosts to try can either be taken from the address
22826 that is being processed (having been set up by the router), or specified
22827 explicitly for the transport. Timeout and retry processing (see chapter
22828 &<<CHAPretry>>&) is applied to each IP address independently.
22829
22830
22831 .section "Multiple messages on a single connection" "SECID144"
22832 The sending of multiple messages over a single TCP/IP connection can arise in
22833 two ways:
22834
22835 .ilist
22836 If a message contains more than &%max_rcpt%& (see below) addresses that are
22837 routed to the same host, more than one copy of the message has to be sent to
22838 that host. In this situation, multiple copies may be sent in a single run of
22839 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22840 does when it has too many addresses to send in one message also depends on the
22841 value of the global &%remote_max_parallel%& option. Details are given in
22842 section &<<SECToutSMTPTCP>>&.)
22843 .next
22844 .cindex "hints database" "remembering routing"
22845 When a message has been successfully delivered over a TCP/IP connection, Exim
22846 looks in its hints database to see if there are any other messages awaiting a
22847 connection to the same host. If there are, a new delivery process is started
22848 for one of them, and the current TCP/IP connection is passed on to it. The new
22849 process may in turn send multiple copies and possibly create yet another
22850 process.
22851 .endlist
22852
22853
22854 For each copy sent over the same TCP/IP connection, a sequence counter is
22855 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22856 no further messages are sent over that connection.
22857
22858
22859
22860 .section "Use of the $host and $host_address variables" "SECID145"
22861 .vindex "&$host$&"
22862 .vindex "&$host_address$&"
22863 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22864 &$host_address$& are the name and IP address of the first host on the host list
22865 passed by the router. However, when the transport is about to connect to a
22866 specific host, and while it is connected to that host, &$host$& and
22867 &$host_address$& are set to the values for that host. These are the values
22868 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22869 &%serialize_hosts%&, and the various TLS options are expanded.
22870
22871
22872 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22873 .vindex &$tls_bits$&
22874 .vindex &$tls_cipher$&
22875 .vindex &$tls_peerdn$&
22876 .vindex &$tls_sni$&
22877 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22878 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22879 are the values that were set when the message was received.
22880 These are the values that are used for options that are expanded before any
22881 SMTP connections are made. Just before each connection is made, these four
22882 variables are emptied. If TLS is subsequently started, they are set to the
22883 appropriate values for the outgoing connection, and these are the values that
22884 are in force when any authenticators are run and when the
22885 &%authenticated_sender%& option is expanded.
22886
22887 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22888 and will be removed in a future release.
22889
22890
22891 .section "Private options for smtp" "SECID146"
22892 .cindex "options" "&(smtp)& transport"
22893 The private options of the &(smtp)& transport are as follows:
22894
22895
22896 .option address_retry_include_sender smtp boolean true
22897 .cindex "4&'xx'& responses" "retrying after"
22898 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22899 is the combination of sender and recipient that is delayed in subsequent queue
22900 runs until the retry time is reached. You can delay the recipient without
22901 reference to the sender (which is what earlier versions of Exim did), by
22902 setting &%address_retry_include_sender%& false. However, this can lead to
22903 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22904
22905 .option allow_localhost smtp boolean false
22906 .cindex "local host" "sending to"
22907 .cindex "fallback" "hosts specified on transport"
22908 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22909 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22910 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22911 the delivery anyway. This should be used only in special cases when the
22912 configuration ensures that no looping will result (for example, a differently
22913 configured Exim is listening on the port to which the message is sent).
22914
22915
22916 .option authenticated_sender smtp string&!! unset
22917 .cindex "Cyrus"
22918 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22919 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22920 overriding any existing authenticated sender value. If the string expansion is
22921 forced to fail, the option is ignored. Other expansion failures cause delivery
22922 to be deferred. If the result of expansion is an empty string, that is also
22923 ignored.
22924
22925 The expansion happens after the outgoing connection has been made and TLS
22926 started, if required. This means that the &$host$&, &$host_address$&,
22927 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22928 particular connection.
22929
22930 If the SMTP session is not authenticated, the expansion of
22931 &%authenticated_sender%& still happens (and can cause the delivery to be
22932 deferred if it fails), but no AUTH= item is added to MAIL commands
22933 unless &%authenticated_sender_force%& is true.
22934
22935 This option allows you to use the &(smtp)& transport in LMTP mode to
22936 deliver mail to Cyrus IMAP and provide the proper local part as the
22937 &"authenticated sender"&, via a setting such as:
22938 .code
22939 authenticated_sender = $local_part
22940 .endd
22941 This removes the need for IMAP subfolders to be assigned special ACLs to
22942 allow direct delivery to those subfolders.
22943
22944 Because of expected uses such as that just described for Cyrus (when no
22945 domain is involved), there is no checking on the syntax of the provided
22946 value.
22947
22948
22949 .option authenticated_sender_force smtp boolean false
22950 If this option is set true, the &%authenticated_sender%& option's value
22951 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22952 authenticated as a client.
22953
22954
22955 .option command_timeout smtp time 5m
22956 This sets a timeout for receiving a response to an SMTP command that has been
22957 sent out. It is also used when waiting for the initial banner line from the
22958 remote host. Its value must not be zero.
22959
22960
22961 .option connect_timeout smtp time 5m
22962 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22963 to a remote host. A setting of zero allows the system timeout (typically
22964 several minutes) to act. To have any effect, the value of this option must be
22965 less than the system timeout. However, it has been observed that on some
22966 systems there is no system timeout, which is why the default value for this
22967 option is 5 minutes, a value recommended by RFC 1123.
22968
22969
22970 .option connection_max_messages smtp integer 500
22971 .cindex "SMTP" "passed connection"
22972 .cindex "SMTP" "multiple deliveries"
22973 .cindex "multiple SMTP deliveries"
22974 This controls the maximum number of separate message deliveries that are sent
22975 over a single TCP/IP connection. If the value is zero, there is no limit.
22976 For testing purposes, this value can be overridden by the &%-oB%& command line
22977 option.
22978
22979
22980 .option data_timeout smtp time 5m
22981 This sets a timeout for the transmission of each block in the data portion of
22982 the message. As a result, the overall timeout for a message depends on the size
22983 of the message. Its value must not be zero. See also &%final_timeout%&.
22984
22985
22986 .option delay_after_cutoff smtp boolean true
22987 This option controls what happens when all remote IP addresses for a given
22988 domain have been inaccessible for so long that they have passed their retry
22989 cutoff times.
22990
22991 In the default state, if the next retry time has not been reached for any of
22992 them, the address is bounced without trying any deliveries. In other words,
22993 Exim delays retrying an IP address after the final cutoff time until a new
22994 retry time is reached, and can therefore bounce an address without ever trying
22995 a delivery, when machines have been down for a long time. Some people are
22996 unhappy at this prospect, so...
22997
22998 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22999 addresses are past their final cutoff time, Exim tries to deliver to those
23000 IP addresses that have not been tried since the message arrived. If there are
23001 none, of if they all fail, the address is bounced. In other words, it does not
23002 delay when a new message arrives, but immediately tries those expired IP
23003 addresses that haven't been tried since the message arrived. If there is a
23004 continuous stream of messages for the dead hosts, unsetting
23005 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23006 to them.
23007
23008
23009 .option dns_qualify_single smtp boolean true
23010 If the &%hosts%& or &%fallback_hosts%& option is being used,
23011 and the &%gethostbyname%& option is false,
23012 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23013 in chapter &<<CHAPdnslookup>>& for more details.
23014
23015
23016 .option dns_search_parents smtp boolean false
23017 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23018 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23019 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23020 details.
23021
23022
23023 .option dnssec_request_domains smtp "domain list&!!" unset
23024 .cindex "MX record" "security"
23025 .cindex "DNSSEC" "MX lookup"
23026 .cindex "security" "MX lookup"
23027 .cindex "DNS" "DNSSEC"
23028 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23029 the dnssec request bit set.
23030 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23031
23032
23033
23034 .option dnssec_require_domains smtp "domain list&!!" unset
23035 .cindex "MX record" "security"
23036 .cindex "DNSSEC" "MX lookup"
23037 .cindex "security" "MX lookup"
23038 .cindex "DNS" "DNSSEC"
23039 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23040 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23041 (AD bit) set wil be ignored and logged as a host-lookup failure.
23042 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23043
23044
23045
23046 .option dscp smtp string&!! unset
23047 .cindex "DCSP" "outbound"
23048 This option causes the DSCP value associated with a socket to be set to one
23049 of a number of fixed strings or to numeric value.
23050 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23051 Common values include &`throughput`&, &`mincost`&, and on newer systems
23052 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23053
23054 The outbound packets from Exim will be marked with this value in the header
23055 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23056 that these values will have any effect, not be stripped by networking
23057 equipment, or do much of anything without cooperation with your Network
23058 Engineer and those of all network operators between the source and destination.
23059
23060
23061 .option fallback_hosts smtp "string list" unset
23062 .cindex "fallback" "hosts specified on transport"
23063 String expansion is not applied to this option. The argument must be a
23064 colon-separated list of host names or IP addresses, optionally also including
23065 port numbers, though the separator can be changed, as described in section
23066 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23067 item in a &%route_list%& setting for the &(manualroute)& router, as described
23068 in section &<<SECTformatonehostitem>>&.
23069
23070 Fallback hosts can also be specified on routers, which associate them with the
23071 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23072 &%fallback_hosts%& specified on the transport is used only if the address does
23073 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23074 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23075 However, &%hosts_randomize%& does apply to fallback host lists.
23076
23077 If Exim is unable to deliver to any of the hosts for a particular address, and
23078 the errors are not permanent rejections, the address is put on a separate
23079 transport queue with its host list replaced by the fallback hosts, unless the
23080 address was routed via MX records and the current host was in the original MX
23081 list. In that situation, the fallback host list is not used.
23082
23083 Once normal deliveries are complete, the fallback queue is delivered by
23084 re-running the same transports with the new host lists. If several failing
23085 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23086 copy of the message is sent.
23087
23088 The resolution of the host names on the fallback list is controlled by the
23089 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23090 both to cases when the host list comes with the address and when it is taken
23091 from &%hosts%&. This option provides a &"use a smart host only if delivery
23092 fails"& facility.
23093
23094
23095 .option final_timeout smtp time 10m
23096 This is the timeout that applies while waiting for the response to the final
23097 line containing just &"."& that terminates a message. Its value must not be
23098 zero.
23099
23100 .option gethostbyname smtp boolean false
23101 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23102 being used, names are looked up using &[gethostbyname()]&
23103 (or &[getipnodebyname()]& when available)
23104 instead of using the DNS. Of course, that function may in fact use the DNS, but
23105 it may also consult other sources of information such as &_/etc/hosts_&.
23106
23107 .option gnutls_compat_mode smtp boolean unset
23108 This option controls whether GnuTLS is used in compatibility mode in an Exim
23109 server. This reduces security slightly, but improves interworking with older
23110 implementations of TLS.
23111
23112 .option helo_data smtp string&!! "see below"
23113 .cindex "HELO" "argument, setting"
23114 .cindex "EHLO" "argument, setting"
23115 .cindex "LHLO argument setting"
23116 The value of this option is expanded after a connection to a another host has
23117 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23118 command that starts the outgoing SMTP or LMTP session. The default value of the
23119 option is:
23120 .code
23121 $primary_hostname
23122 .endd
23123 During the expansion, the variables &$host$& and &$host_address$& are set to
23124 the identity of the remote host, and the variables &$sending_ip_address$& and
23125 &$sending_port$& are set to the local IP address and port number that are being
23126 used. These variables can be used to generate different values for different
23127 servers or different local IP addresses. For example, if you want the string
23128 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23129 interface address, you could use this:
23130 .code
23131 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23132   {$primary_hostname}}
23133 .endd
23134 The use of &%helo_data%& applies both to sending messages and when doing
23135 callouts.
23136
23137 .option hosts smtp "string list&!!" unset
23138 Hosts are associated with an address by a router such as &(dnslookup)&, which
23139 finds the hosts by looking up the address domain in the DNS, or by
23140 &(manualroute)&, which has lists of hosts in its configuration. However,
23141 email addresses can be passed to the &(smtp)& transport by any router, and not
23142 all of them can provide an associated list of hosts.
23143
23144 The &%hosts%& option specifies a list of hosts to be used if the address being
23145 processed does not have any hosts associated with it. The hosts specified by
23146 &%hosts%& are also used, whether or not the address has its own hosts, if
23147 &%hosts_override%& is set.
23148
23149 The string is first expanded, before being interpreted as a colon-separated
23150 list of host names or IP addresses, possibly including port numbers. The
23151 separator may be changed to something other than colon, as described in section
23152 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23153 item in a &%route_list%& setting for the &(manualroute)& router, as described
23154 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23155 of the &(manualroute)& router is not available here.
23156
23157 If the expansion fails, delivery is deferred. Unless the failure was caused by
23158 the inability to complete a lookup, the error is logged to the panic log as
23159 well as the main log. Host names are looked up either by searching directly for
23160 address records in the DNS or by calling &[gethostbyname()]& (or
23161 &[getipnodebyname()]& when available), depending on the setting of the
23162 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23163 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23164 address are used.
23165
23166 During delivery, the hosts are tried in order, subject to their retry status,
23167 unless &%hosts_randomize%& is set.
23168
23169
23170 .option hosts_avoid_esmtp smtp "host list&!!" unset
23171 .cindex "ESMTP, avoiding use of"
23172 .cindex "HELO" "forcing use of"
23173 .cindex "EHLO" "avoiding use of"
23174 .cindex "PIPELINING" "avoiding the use of"
23175 This option is for use with broken hosts that announce ESMTP facilities (for
23176 example, PIPELINING) and then fail to implement them properly. When a host
23177 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23178 start of the SMTP session. This means that it cannot use any of the ESMTP
23179 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23180
23181
23182 .option hosts_avoid_pipelining smtp "host list&!!" unset
23183 .cindex "PIPELINING" "avoiding the use of"
23184 Exim will not use the SMTP PIPELINING extension when delivering to any host
23185 that matches this list, even if the server host advertises PIPELINING support.
23186
23187
23188 .option hosts_avoid_tls smtp "host list&!!" unset
23189 .cindex "TLS" "avoiding for certain hosts"
23190 Exim will not try to start a TLS session when delivering to any host that
23191 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23192
23193 .new
23194 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23195 .cindex "TLS" "avoiding for certain hosts"
23196 Exim will not try to start a TLS session for a verify callout,
23197 or when delivering in cutthrough mode,
23198 to any host that matches this list.
23199 .wen
23200
23201
23202 .option hosts_max_try smtp integer 5
23203 .cindex "host" "maximum number to try"
23204 .cindex "limit" "number of hosts tried"
23205 .cindex "limit" "number of MX tried"
23206 .cindex "MX record" "maximum tried"
23207 This option limits the number of IP addresses that are tried for any one
23208 delivery in cases where there are temporary delivery errors. Section
23209 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23210
23211
23212 .option hosts_max_try_hardlimit smtp integer 50
23213 This is an additional check on the maximum number of IP addresses that Exim
23214 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23215 why it exists.
23216
23217
23218
23219 .option hosts_nopass_tls smtp "host list&!!" unset
23220 .cindex "TLS" "passing connection"
23221 .cindex "multiple SMTP deliveries"
23222 .cindex "TLS" "multiple message deliveries"
23223 For any host that matches this list, a connection on which a TLS session has
23224 been started will not be passed to a new delivery process for sending another
23225 message on the same connection. See section &<<SECTmulmessam>>& for an
23226 explanation of when this might be needed.
23227
23228
23229 .option hosts_override smtp boolean false
23230 If this option is set and the &%hosts%& option is also set, any hosts that are
23231 attached to the address are ignored, and instead the hosts specified by the
23232 &%hosts%& option are always used. This option does not apply to
23233 &%fallback_hosts%&.
23234
23235
23236 .option hosts_randomize smtp boolean false
23237 .cindex "randomized host list"
23238 .cindex "host" "list of; randomized"
23239 .cindex "fallback" "randomized hosts"
23240 If this option is set, and either the list of hosts is taken from the
23241 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23242 were not obtained from MX records (this includes fallback hosts from the
23243 router), and were not randomized by the router, the order of trying the hosts
23244 is randomized each time the transport runs. Randomizing the order of a host
23245 list can be used to do crude load sharing.
23246
23247 When &%hosts_randomize%& is true, a host list may be split into groups whose
23248 order is separately randomized. This makes it possible to set up MX-like
23249 behaviour. The boundaries between groups are indicated by an item that is just
23250 &`+`& in the host list. For example:
23251 .code
23252 hosts = host1:host2:host3:+:host4:host5
23253 .endd
23254 The order of the first three hosts and the order of the last two hosts is
23255 randomized for each use, but the first three always end up before the last two.
23256 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23257
23258 .option hosts_require_auth smtp "host list&!!" unset
23259 .cindex "authentication" "required by client"
23260 This option provides a list of servers for which authentication must succeed
23261 before Exim will try to transfer a message. If authentication fails for
23262 servers which are not in this list, Exim tries to send unauthenticated. If
23263 authentication fails for one of these servers, delivery is deferred. This
23264 temporary error is detectable in the retry rules, so it can be turned into a
23265 hard failure if required. See also &%hosts_try_auth%&, and chapter
23266 &<<CHAPSMTPAUTH>>& for details of authentication.
23267
23268
23269 .option hosts_request_ocsp smtp "host list&!!" *
23270 .cindex "TLS" "requiring for certain servers"
23271 Exim will request a Certificate Status on a
23272 TLS session for any host that matches this list.
23273 &%tls_verify_certificates%& should also be set for the transport.
23274
23275 .option hosts_require_ocsp smtp "host list&!!" unset
23276 .cindex "TLS" "requiring for certain servers"
23277 Exim will request, and check for a valid Certificate Status being given, on a
23278 TLS session for any host that matches this list.
23279 &%tls_verify_certificates%& should also be set for the transport.
23280
23281 .option hosts_require_tls smtp "host list&!!" unset
23282 .cindex "TLS" "requiring for certain servers"
23283 Exim will insist on using a TLS session when delivering to any host that
23284 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23285 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23286 incoming messages, use an appropriate ACL.
23287
23288 .option hosts_try_auth smtp "host list&!!" unset
23289 .cindex "authentication" "optional in client"
23290 This option provides a list of servers to which, provided they announce
23291 authentication support, Exim will attempt to authenticate as a client when it
23292 connects. If authentication fails, Exim will try to transfer the message
23293 unauthenticated. See also &%hosts_require_auth%&, and chapter
23294 &<<CHAPSMTPAUTH>>& for details of authentication.
23295
23296 .new
23297 .option hosts_try_prdr smtp "host list&!!" *
23298 .cindex "PRDR" "enabling, optional in client"
23299 This option provides a list of servers to which, provided they announce
23300 PRDR support, Exim will attempt to negotiate PRDR
23301 for multi-recipient messages.
23302 The option can usually be left as default.
23303 .wen
23304
23305 .option interface smtp "string list&!!" unset
23306 .cindex "bind IP address"
23307 .cindex "IP address" "binding"
23308 .vindex "&$host$&"
23309 .vindex "&$host_address$&"
23310 This option specifies which interface to bind to when making an outgoing SMTP
23311 call. The value is an IP address, not an interface name such as
23312 &`eth0`&. Do not confuse this with the interface address that was used when a
23313 message was received, which is in &$received_ip_address$&, formerly known as
23314 &$interface_address$&. The name was changed to minimize confusion with the
23315 outgoing interface address. There is no variable that contains an outgoing
23316 interface address because, unless it is set by this option, its value is
23317 unknown.
23318
23319 During the expansion of the &%interface%& option the variables &$host$& and
23320 &$host_address$& refer to the host to which a connection is about to be made
23321 during the expansion of the string. Forced expansion failure, or an empty
23322 string result causes the option to be ignored. Otherwise, after expansion, the
23323 string must be a list of IP addresses, colon-separated by default, but the
23324 separator can be changed in the usual way. For example:
23325 .code
23326 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23327 .endd
23328 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23329 connection. If none of them are the correct type, the option is ignored. If
23330 &%interface%& is not set, or is ignored, the system's IP functions choose which
23331 interface to use if the host has more than one.
23332
23333
23334 .option keepalive smtp boolean true
23335 .cindex "keepalive" "on outgoing connection"
23336 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23337 connections. When set, it causes the kernel to probe idle connections
23338 periodically, by sending packets with &"old"& sequence numbers. The other end
23339 of the connection should send a acknowledgment if the connection is still okay
23340 or a reset if the connection has been aborted. The reason for doing this is
23341 that it has the beneficial effect of freeing up certain types of connection
23342 that can get stuck when the remote host is disconnected without tidying up the
23343 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23344 unreachable hosts.
23345
23346
23347 .option lmtp_ignore_quota smtp boolean false
23348 .cindex "LMTP" "ignoring quota errors"
23349 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23350 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23351 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23352
23353 .option max_rcpt smtp integer 100
23354 .cindex "RCPT" "maximum number of outgoing"
23355 This option limits the number of RCPT commands that are sent in a single
23356 SMTP message transaction. Each set of addresses is treated independently, and
23357 so can cause parallel connections to the same host if &%remote_max_parallel%&
23358 permits this.
23359
23360
23361 .option multi_domain smtp boolean&!! true
23362 .vindex "&$domain$&"
23363 When this option is set, the &(smtp)& transport can handle a number of
23364 addresses containing a mixture of different domains provided they all resolve
23365 to the same list of hosts. Turning the option off restricts the transport to
23366 handling only one domain at a time. This is useful if you want to use
23367 &$domain$& in an expansion for the transport, because it is set only when there
23368 is a single domain involved in a remote delivery.
23369
23370 .new
23371 It is expanded per-address and can depend on any of
23372 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23373 &$host$&, &$host_address$& and &$host_port$&.
23374 .wen
23375
23376 .option port smtp string&!! "see below"
23377 .cindex "port" "sending TCP/IP"
23378 .cindex "TCP/IP" "setting outgoing port"
23379 This option specifies the TCP/IP port on the server to which Exim connects.
23380 &*Note:*& Do not confuse this with the port that was used when a message was
23381 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23382 The name was changed to minimize confusion with the outgoing port. There is no
23383 variable that contains an outgoing port.
23384
23385 If the value of this option begins with a digit it is taken as a port number;
23386 otherwise it is looked up using &[getservbyname()]&. The default value is
23387 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23388 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23389 is deferred.
23390
23391
23392
23393 .option protocol smtp string smtp
23394 .cindex "LMTP" "over TCP/IP"
23395 .cindex "ssmtp protocol" "outbound"
23396 .cindex "TLS" "SSL-on-connect outbound"
23397 .vindex "&$port$&"
23398 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23399 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23400 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23401 deliveries into closed message stores. Exim also has support for running LMTP
23402 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23403
23404 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23405 changes to &"smtps"&, and the transport initiates TLS immediately after
23406 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23407 The Internet standards bodies strongly discourage use of this mode.
23408
23409
23410 .option retry_include_ip_address smtp boolean&!! true
23411 Exim normally includes both the host name and the IP address in the key it
23412 constructs for indexing retry data after a temporary delivery failure. This
23413 means that when one of several IP addresses for a host is failing, it gets
23414 tried periodically (controlled by the retry rules), but use of the other IP
23415 addresses is not affected.
23416
23417 However, in some dialup environments hosts are assigned a different IP address
23418 each time they connect. In this situation the use of the IP address as part of
23419 the retry key leads to undesirable behaviour. Setting this option false causes
23420 Exim to use only the host name.
23421 .new
23422 Since it is expanded it can be made to depend on the host or domain.
23423 .wen
23424
23425
23426 .option serialize_hosts smtp "host list&!!" unset
23427 .cindex "serializing connections"
23428 .cindex "host" "serializing connections"
23429 Because Exim operates in a distributed manner, if several messages for the same
23430 host arrive at around the same time, more than one simultaneous connection to
23431 the remote host can occur. This is not usually a problem except when there is a
23432 slow link between the hosts. In that situation it may be helpful to restrict
23433 Exim to one connection at a time. This can be done by setting
23434 &%serialize_hosts%& to match the relevant hosts.
23435
23436 .cindex "hints database" "serializing deliveries to a host"
23437 Exim implements serialization by means of a hints database in which a record is
23438 written whenever a process connects to one of the restricted hosts. The record
23439 is deleted when the connection is completed. Obviously there is scope for
23440 records to get left lying around if there is a system or program crash. To
23441 guard against this, Exim ignores any records that are more than six hours old.
23442
23443 If you set up this kind of serialization, you should also arrange to delete the
23444 relevant hints database whenever your system reboots. The names of the files
23445 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23446 may be one or two files, depending on the type of DBM in use. The same files
23447 are used for ETRN serialization.
23448
23449
23450 .option size_addition smtp integer 1024
23451 .cindex "SMTP" "SIZE"
23452 .cindex "message" "size issue for transport filter"
23453 .cindex "size" "of message"
23454 .cindex "transport" "filter"
23455 .cindex "filter" "transport filter"
23456 If a remote SMTP server indicates that it supports the SIZE option of the
23457 MAIL command, Exim uses this to pass over the message size at the start of
23458 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23459 sends, to allow for headers and other text that may be added during delivery by
23460 configuration options or in a transport filter. It may be necessary to increase
23461 this if a lot of text is added to messages.
23462
23463 Alternatively, if the value of &%size_addition%& is set negative, it disables
23464 the use of the SIZE option altogether.
23465
23466
23467 .option tls_certificate smtp string&!! unset
23468 .cindex "TLS" "client certificate, location of"
23469 .cindex "certificate" "client, location of"
23470 .vindex "&$host$&"
23471 .vindex "&$host_address$&"
23472 The value of this option must be the absolute path to a file which contains the
23473 client's certificate, for possible use when sending a message over an encrypted
23474 connection. The values of &$host$& and &$host_address$& are set to the name and
23475 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23476 details of TLS.
23477
23478 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23479 certificate when sending messages as a client. The global option of the same
23480 name specifies the certificate for Exim as a server; it is not automatically
23481 assumed that the same certificate should be used when Exim is operating as a
23482 client.
23483
23484
23485 .option tls_crl smtp string&!! unset
23486 .cindex "TLS" "client certificate revocation list"
23487 .cindex "certificate" "revocation list for client"
23488 This option specifies a certificate revocation list. The expanded value must
23489 be the name of a file that contains a CRL in PEM format.
23490
23491
23492 .option tls_dh_min_bits smtp integer 1024
23493 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23494 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23495 key agreement is negotiated, the server will provide a large prime number
23496 for use.  This option establishes the minimum acceptable size of that number.
23497 If the parameter offered by the server is too small, then the TLS handshake
23498 will fail.
23499
23500 Only supported when using GnuTLS.
23501
23502
23503 .option tls_privatekey smtp string&!! unset
23504 .cindex "TLS" "client private key, location of"
23505 .vindex "&$host$&"
23506 .vindex "&$host_address$&"
23507 The value of this option must be the absolute path to a file which contains the
23508 client's private key. This is used when sending a message over an encrypted
23509 connection using a client certificate. The values of &$host$& and
23510 &$host_address$& are set to the name and address of the server during the
23511 expansion. If this option is unset, or the expansion is forced to fail, or the
23512 result is an empty string, the private key is assumed to be in the same file as
23513 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23514
23515
23516 .option tls_require_ciphers smtp string&!! unset
23517 .cindex "TLS" "requiring specific ciphers"
23518 .cindex "cipher" "requiring specific"
23519 .vindex "&$host$&"
23520 .vindex "&$host_address$&"
23521 The value of this option must be a list of permitted cipher suites, for use
23522 when setting up an outgoing encrypted connection. (There is a global option of
23523 the same name for controlling incoming connections.) The values of &$host$& and
23524 &$host_address$& are set to the name and address of the server during the
23525 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23526 is used in different ways by OpenSSL and GnuTLS (see sections
23527 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23528 ciphers is a preference order.
23529
23530
23531
23532 .option tls_sni smtp string&!! unset
23533 .cindex "TLS" "Server Name Indication"
23534 .vindex "&$tls_sni$&"
23535 If this option is set then it sets the $tls_out_sni variable and causes any
23536 TLS session to pass this value as the Server Name Indication extension to
23537 the remote side, which can be used by the remote side to select an appropriate
23538 certificate and private key for the session.
23539
23540 See &<<SECTtlssni>>& for more information.
23541
23542 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23543 TLS extensions.
23544
23545
23546
23547
23548 .option tls_tempfail_tryclear smtp boolean true
23549 .cindex "4&'xx'& responses" "to STARTTLS"
23550 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23551 setting up a TLS session, this option determines whether or not Exim should try
23552 to deliver the message unencrypted. If it is set false, delivery to the
23553 current host is deferred; if there are other hosts, they are tried. If this
23554 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23555 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23556 TLS negotiation fails, Exim closes the current connection (because it is in an
23557 unknown state), opens a new one to the same host, and then tries the delivery
23558 in clear.
23559
23560
23561 .new
23562 .option tls_try_verify_hosts smtp "host list&!!" *
23563 .wen
23564 .cindex "TLS" "server certificate verification"
23565 .cindex "certificate" "verification of server"
23566 This option gives a list of hosts for which, on encrypted connections,
23567 certificate verification will be tried but need not succeed.
23568 The &%tls_verify_certificates%& option must also be set.
23569 Note that unless the host is in this list
23570 TLS connections will be denied to hosts using self-signed certificates
23571 when &%tls_verify_certificates%& is matched.
23572 The &$tls_out_certificate_verified$& variable is set when
23573 certificate verification succeeds.
23574
23575
23576 .new
23577 .option tls_verify_cert_hostnames smtp "host list&!!" *
23578 .cindex "TLS" "server certificate hostname verification"
23579 .cindex "certificate" "verification of server"
23580 This option give a list of hosts for which,
23581 while verifying the server certificate,
23582 checks will be included on the host name
23583 (note that this will generally be the result of a DNS MX lookup)
23584 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23585 limited to being the initial component of a 3-or-more component FQDN.
23586
23587 There is no equivalent checking on client certificates.
23588 .wen
23589
23590
23591 .new
23592 .option tls_verify_certificates smtp string&!! system
23593 .cindex "TLS" "server certificate verification"
23594 .cindex "certificate" "verification of server"
23595 .vindex "&$host$&"
23596 .vindex "&$host_address$&"
23597 The value of this option must be either the
23598 word "system"
23599 or the absolute path to
23600 a file or directory containing permitted certificates for servers,
23601 for use when setting up an encrypted connection.
23602
23603 The "system" value for the option will use a location compiled into the SSL library.
23604 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23605 is taken as empty and an explicit location
23606 must be specified.
23607
23608 The use of a directory for the option value is not avilable for GnuTLS versions
23609 preceding 3.3.6 and a single file must be used.
23610 .wen
23611
23612 With OpenSSL the certificates specified
23613 explicitly
23614 either by file or directory
23615 are added to those given by the system default location.
23616
23617 The values of &$host$& and
23618 &$host_address$& are set to the name and address of the server during the
23619 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23620
23621 For back-compatability,
23622 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23623 (a single-colon empty list counts as being set)
23624 and certificate verification fails the TLS connection is closed.
23625
23626
23627 .option tls_verify_hosts smtp "host list&!!" unset
23628 .cindex "TLS" "server certificate verification"
23629 .cindex "certificate" "verification of server"
23630 This option gives a list of hosts for which. on encrypted connections,
23631 certificate verification must succeed.
23632 The &%tls_verify_certificates%& option must also be set.
23633 If both this option and &%tls_try_verify_hosts%& are unset
23634 operation is as if this option selected all hosts.
23635
23636
23637
23638
23639 .section "How the limits for the number of hosts to try are used" &&&
23640          "SECTvalhosmax"
23641 .cindex "host" "maximum number to try"
23642 .cindex "limit" "hosts; maximum number tried"
23643 There are two options that are concerned with the number of hosts that are
23644 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23645 &%hosts_max_try_hardlimit%&.
23646
23647
23648 The &%hosts_max_try%& option limits the number of hosts that are tried
23649 for a single delivery. However, despite the term &"host"& in its name, the
23650 option actually applies to each IP address independently. In other words, a
23651 multihomed host is treated as several independent hosts, just as it is for
23652 retrying.
23653
23654 Many of the larger ISPs have multiple MX records which often point to
23655 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23656 created as a result of routing one of these domains.
23657
23658 Trying every single IP address on such a long list does not seem sensible; if
23659 several at the top of the list fail, it is reasonable to assume there is some
23660 problem that is likely to affect all of them. Roughly speaking, the value of
23661 &%hosts_max_try%& is the maximum number that are tried before deferring the
23662 delivery. However, the logic cannot be quite that simple.
23663
23664 Firstly, IP addresses that are skipped because their retry times have not
23665 arrived do not count, and in addition, addresses that are past their retry
23666 limits are also not counted, even when they are tried. This means that when
23667 some IP addresses are past their retry limits, more than the value of
23668 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23669 that all IP addresses are considered before timing out an email address (but
23670 see below for an exception).
23671
23672 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23673 list to see if there is a subsequent host with a different (higher valued) MX.
23674 If there is, that host is considered next, and the current IP address is used
23675 but not counted. This behaviour helps in the case of a domain with a retry rule
23676 that hardly ever delays any hosts, as is now explained:
23677
23678 Consider the case of a long list of hosts with one MX value, and a few with a
23679 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23680 hosts at the top of the list are tried at first. With the default retry rule,
23681 which specifies increasing retry times, the higher MX hosts are eventually
23682 tried when those at the top of the list are skipped because they have not
23683 reached their retry times.
23684
23685 However, it is common practice to put a fixed short retry time on domains for
23686 large ISPs, on the grounds that their servers are rarely down for very long.
23687 Unfortunately, these are exactly the domains that tend to resolve to long lists
23688 of hosts. The short retry time means that the lowest MX hosts are tried every
23689 time. The attempts may be in a different order because of random sorting, but
23690 without the special MX check, the higher MX hosts would never be tried until
23691 all the lower MX hosts had timed out (which might be several days), because
23692 there are always some lower MX hosts that have reached their retry times. With
23693 the special check, Exim considers at least one IP address from each MX value at
23694 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23695 reached.
23696
23697 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23698 particular, Exim normally eventually tries all the IP addresses before timing
23699 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23700 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23701 been set up with hundreds of IP addresses for some domains. It can
23702 take a very long time indeed for an address to time out in these cases.
23703
23704 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23705 Exim never tries more than this number of IP addresses; if it hits this limit
23706 and they are all timed out, the email address is bounced, even though not all
23707 possible IP addresses have been tried.
23708 .ecindex IIDsmttra1
23709 .ecindex IIDsmttra2
23710
23711
23712
23713
23714
23715 . ////////////////////////////////////////////////////////////////////////////
23716 . ////////////////////////////////////////////////////////////////////////////
23717
23718 .chapter "Address rewriting" "CHAPrewrite"
23719 .scindex IIDaddrew "rewriting" "addresses"
23720 There are some circumstances in which Exim automatically rewrites domains in
23721 addresses. The two most common are when an address is given without a domain
23722 (referred to as an &"unqualified address"&) or when an address contains an
23723 abbreviated domain that is expanded by DNS lookup.
23724
23725 Unqualified envelope addresses are accepted only for locally submitted
23726 messages, or for messages that are received from hosts matching
23727 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23728 appropriate. Unqualified addresses in header lines are qualified if they are in
23729 locally submitted messages, or messages from hosts that are permitted to send
23730 unqualified envelope addresses. Otherwise, unqualified addresses in header
23731 lines are neither qualified nor rewritten.
23732
23733 One situation in which Exim does &'not'& automatically rewrite a domain is
23734 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23735 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23736 do this. The new RFCs do not contain this suggestion.
23737
23738
23739 .section "Explicitly configured address rewriting" "SECID147"
23740 This chapter describes the rewriting rules that can be used in the
23741 main rewrite section of the configuration file, and also in the generic
23742 &%headers_rewrite%& option that can be set on any transport.
23743
23744 Some people believe that configured address rewriting is a Mortal Sin.
23745 Others believe that life is not possible without it. Exim provides the
23746 facility; you do not have to use it.
23747
23748 The main rewriting rules that appear in the &"rewrite"& section of the
23749 configuration file are applied to addresses in incoming messages, both envelope
23750 addresses and addresses in header lines. Each rule specifies the types of
23751 address to which it applies.
23752
23753 Whether or not addresses in header lines are rewritten depends on the origin of
23754 the headers and the type of rewriting. Global rewriting, that is, rewriting
23755 rules from the rewrite section of the configuration file, is applied only to
23756 those headers that were received with the message. Header lines that are added
23757 by ACLs or by a system filter or by individual routers or transports (which
23758 are specific to individual recipient addresses) are not rewritten by the global
23759 rules.
23760
23761 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23762 applies all headers except those added by routers and transports. That is, as
23763 well as the headers that were received with the message, it also applies to
23764 headers that were added by an ACL or a system filter.
23765
23766
23767 In general, rewriting addresses from your own system or domain has some
23768 legitimacy. Rewriting other addresses should be done only with great care and
23769 in special circumstances. The author of Exim believes that rewriting should be
23770 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23771 Although it can sometimes be used as a routing tool, this is very strongly
23772 discouraged.
23773
23774 There are two commonly encountered circumstances where rewriting is used, as
23775 illustrated by these examples:
23776
23777 .ilist
23778 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23779 exchange mail with each other behind a firewall, but there is only a single
23780 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23781 &'hitch.fict.example'& when sending mail off-site.
23782 .next
23783 A host rewrites the local parts of its own users so that, for example,
23784 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23785 .endlist
23786
23787
23788
23789 .section "When does rewriting happen?" "SECID148"
23790 .cindex "rewriting" "timing of"
23791 .cindex "&ACL;" "rewriting addresses in"
23792 Configured address rewriting can take place at several different stages of a
23793 message's processing.
23794
23795 .vindex "&$sender_address$&"
23796 At the start of an ACL for MAIL, the sender address may have been rewritten
23797 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23798 ordinary rewrite rules have yet been applied. If, however, the sender address
23799 is verified in the ACL, it is rewritten before verification, and remains
23800 rewritten thereafter. The subsequent value of &$sender_address$& is the
23801 rewritten address. This also applies if sender verification happens in a
23802 RCPT ACL. Otherwise, when the sender address is not verified, it is
23803 rewritten as soon as a message's header lines have been received.
23804
23805 .vindex "&$domain$&"
23806 .vindex "&$local_part$&"
23807 Similarly, at the start of an ACL for RCPT, the current recipient's address
23808 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23809 rewrite rules have yet been applied to it. However, the behaviour is different
23810 from the sender address when a recipient is verified. The address is rewritten
23811 for the verification, but the rewriting is not remembered at this stage. The
23812 value of &$local_part$& and &$domain$& after verification are always the same
23813 as they were before (that is, they contain the unrewritten &-- except for
23814 SMTP-time rewriting &-- address).
23815
23816 As soon as a message's header lines have been received, all the envelope
23817 recipient addresses are permanently rewritten, and rewriting is also applied to
23818 the addresses in the header lines (if configured). This happens before adding
23819 any header lines that were specified in MAIL or RCPT ACLs, and
23820 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23821 before the DATA ACL and &[local_scan()]& functions are run.
23822
23823 When an address is being routed, either for delivery or for verification,
23824 rewriting is applied immediately to child addresses that are generated by
23825 redirection, unless &%no_rewrite%& is set on the router.
23826
23827 .cindex "envelope sender" "rewriting at transport time"
23828 .cindex "rewriting" "at transport time"
23829 .cindex "header lines" "rewriting at transport time"
23830 At transport time, additional rewriting of addresses in header lines can be
23831 specified by setting the generic &%headers_rewrite%& option on a transport.
23832 This option contains rules that are identical in form to those in the rewrite
23833 section of the configuration file. They are applied to the original message
23834 header lines and any that were added by ACLs or a system filter. They are not
23835 applied to header lines that are added by routers or the transport.
23836
23837 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23838 transport option. However, it is not possible to rewrite envelope recipients at
23839 transport time.
23840
23841
23842
23843
23844 .section "Testing the rewriting rules that apply on input" "SECID149"
23845 .cindex "rewriting" "testing"
23846 .cindex "testing" "rewriting"
23847 Exim's input rewriting configuration appears in a part of the run time
23848 configuration file headed by &"begin rewrite"&. It can be tested by the
23849 &%-brw%& command line option. This takes an address (which can be a full RFC
23850 2822 address) as its argument. The output is a list of how the address would be
23851 transformed by the rewriting rules for each of the different places it might
23852 appear in an incoming message, that is, for each different header and for the
23853 envelope sender and recipient fields. For example,
23854 .code
23855 exim -brw ph10@exim.workshop.example
23856 .endd
23857 might produce the output
23858 .code
23859 sender: Philip.Hazel@exim.workshop.example
23860 from: Philip.Hazel@exim.workshop.example
23861 to: ph10@exim.workshop.example
23862 cc: ph10@exim.workshop.example
23863 bcc: ph10@exim.workshop.example
23864 reply-to: Philip.Hazel@exim.workshop.example
23865 env-from: Philip.Hazel@exim.workshop.example
23866 env-to: ph10@exim.workshop.example
23867 .endd
23868 which shows that rewriting has been set up for that address when used in any of
23869 the source fields, but not when it appears as a recipient address. At the
23870 present time, there is no equivalent way of testing rewriting rules that are
23871 set for a particular transport.
23872
23873
23874 .section "Rewriting rules" "SECID150"
23875 .cindex "rewriting" "rules"
23876 The rewrite section of the configuration file consists of lines of rewriting
23877 rules in the form
23878 .display
23879 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23880 .endd
23881 Rewriting rules that are specified for the &%headers_rewrite%& generic
23882 transport option are given as a colon-separated list. Each item in the list
23883 takes the same form as a line in the main rewriting configuration (except that
23884 any colons must be doubled, of course).
23885
23886 The formats of source patterns and replacement strings are described below.
23887 Each is terminated by white space, unless enclosed in double quotes, in which
23888 case normal quoting conventions apply inside the quotes. The flags are single
23889 characters which may appear in any order. Spaces and tabs between them are
23890 ignored.
23891
23892 For each address that could potentially be rewritten, the rules are scanned in
23893 order, and replacements for the address from earlier rules can themselves be
23894 replaced by later rules (but see the &"q"& and &"R"& flags).
23895
23896 The order in which addresses are rewritten is undefined, may change between
23897 releases, and must not be relied on, with one exception: when a message is
23898 received, the envelope sender is always rewritten first, before any header
23899 lines are rewritten. For example, the replacement string for a rewrite of an
23900 address in &'To:'& must not assume that the message's address in &'From:'& has
23901 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23902 that the envelope sender has already been rewritten.
23903
23904 .vindex "&$domain$&"
23905 .vindex "&$local_part$&"
23906 The variables &$local_part$& and &$domain$& can be used in the replacement
23907 string to refer to the address that is being rewritten. Note that lookup-driven
23908 rewriting can be done by a rule of the form
23909 .code
23910 *@*   ${lookup ...
23911 .endd
23912 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23913 refer to the address that is being rewritten.
23914
23915
23916 .section "Rewriting patterns" "SECID151"
23917 .cindex "rewriting" "patterns"
23918 .cindex "address list" "in a rewriting pattern"
23919 The source pattern in a rewriting rule is any item which may appear in an
23920 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23921 single-item address list, which means that it is expanded before being tested
23922 against the address. As always, if you use a regular expression as a pattern,
23923 you must take care to escape dollar and backslash characters, or use the &`\N`&
23924 facility to suppress string expansion within the regular expression.
23925
23926 Domains in patterns should be given in lower case. Local parts in patterns are
23927 case-sensitive. If you want to do case-insensitive matching of local parts, you
23928 can use a regular expression that starts with &`^(?i)`&.
23929
23930 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23931 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23932 depending on the type of match which occurred. These can be used in the
23933 replacement string to insert portions of the incoming address. &$0$& always
23934 refers to the complete incoming address. When a regular expression is used, the
23935 numerical variables are set from its capturing subexpressions. For other types
23936 of pattern they are set as follows:
23937
23938 .ilist
23939 If a local part or domain starts with an asterisk, the numerical variables
23940 refer to the character strings matched by asterisks, with &$1$& associated with
23941 the first asterisk, and &$2$& with the second, if present. For example, if the
23942 pattern
23943 .code
23944 *queen@*.fict.example
23945 .endd
23946 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23947 .code
23948 $0 = hearts-queen@wonderland.fict.example
23949 $1 = hearts-
23950 $2 = wonderland
23951 .endd
23952 Note that if the local part does not start with an asterisk, but the domain
23953 does, it is &$1$& that contains the wild part of the domain.
23954
23955 .next
23956 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23957 of the domain are placed in the next available numerical variables. Suppose,
23958 for example, that the address &'foo@bar.baz.example'& is processed by a
23959 rewriting rule of the form
23960 .display
23961 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23962 .endd
23963 and the key in the file that matches the domain is &`*.baz.example`&. Then
23964 .code
23965 $1 = foo
23966 $2 = bar
23967 $3 = baz.example
23968 .endd
23969 If the address &'foo@baz.example'& is looked up, this matches the same
23970 wildcard file entry, and in this case &$2$& is set to the empty string, but
23971 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23972 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23973 whole domain. For non-partial domain lookups, no numerical variables are set.
23974 .endlist
23975
23976
23977 .section "Rewriting replacements" "SECID152"
23978 .cindex "rewriting" "replacements"
23979 If the replacement string for a rule is a single asterisk, addresses that
23980 match the pattern and the flags are &'not'& rewritten, and no subsequent
23981 rewriting rules are scanned. For example,
23982 .code
23983 hatta@lookingglass.fict.example  *  f
23984 .endd
23985 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23986 &'From:'& headers.
23987
23988 .vindex "&$domain$&"
23989 .vindex "&$local_part$&"
23990 If the replacement string is not a single asterisk, it is expanded, and must
23991 yield a fully qualified address. Within the expansion, the variables
23992 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23993 Any letters they contain retain their original case &-- they are not lower
23994 cased. The numerical variables are set up according to the type of pattern that
23995 matched the address, as described above. If the expansion is forced to fail by
23996 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23997 current rule is abandoned, but subsequent rules may take effect. Any other
23998 expansion failure causes the entire rewriting operation to be abandoned, and an
23999 entry written to the panic log.
24000
24001
24002
24003 .section "Rewriting flags" "SECID153"
24004 There are three different kinds of flag that may appear on rewriting rules:
24005
24006 .ilist
24007 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24008 c, f, h, r, s, t.
24009 .next
24010 A flag that specifies rewriting at SMTP time: S.
24011 .next
24012 Flags that control the rewriting process: Q, q, R, w.
24013 .endlist
24014
24015 For rules that are part of the &%headers_rewrite%& generic transport option,
24016 E, F, T, and S are not permitted.
24017
24018
24019
24020 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24021          "SECID154"
24022 .cindex "rewriting" "flags"
24023 If none of the following flag letters, nor the &"S"& flag (see section
24024 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24025 and to both the sender and recipient fields of the envelope, whereas a
24026 transport-time rewriting rule just applies to all headers. Otherwise, the
24027 rewriting rule is skipped unless the relevant addresses are being processed.
24028 .display
24029 &`E`&       rewrite all envelope fields
24030 &`F`&       rewrite the envelope From field
24031 &`T`&       rewrite the envelope To field
24032 &`b`&       rewrite the &'Bcc:'& header
24033 &`c`&       rewrite the &'Cc:'& header
24034 &`f`&       rewrite the &'From:'& header
24035 &`h`&       rewrite all headers
24036 &`r`&       rewrite the &'Reply-To:'& header
24037 &`s`&       rewrite the &'Sender:'& header
24038 &`t`&       rewrite the &'To:'& header
24039 .endd
24040 "All headers" means all of the headers listed above that can be selected
24041 individually, plus their &'Resent-'& versions. It does not include
24042 other headers such as &'Subject:'& etc.
24043
24044 You should be particularly careful about rewriting &'Sender:'& headers, and
24045 restrict this to special known cases in your own domains.
24046
24047
24048 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24049 .cindex "SMTP" "rewriting malformed addresses"
24050 .cindex "RCPT" "rewriting argument of"
24051 .cindex "MAIL" "rewriting argument of"
24052 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24053 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24054 before any other processing; even before syntax checking. The pattern is
24055 required to be a regular expression, and it is matched against the whole of the
24056 data for the command, including any surrounding angle brackets.
24057
24058 .vindex "&$domain$&"
24059 .vindex "&$local_part$&"
24060 This form of rewrite rule allows for the handling of addresses that are not
24061 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24062 input). Because the input is not required to be a syntactically valid address,
24063 the variables &$local_part$& and &$domain$& are not available during the
24064 expansion of the replacement string. The result of rewriting replaces the
24065 original address in the MAIL or RCPT command.
24066
24067
24068 .section "Flags controlling the rewriting process" "SECID155"
24069 There are four flags which control the way the rewriting process works. These
24070 take effect only when a rule is invoked, that is, when the address is of the
24071 correct type (matches the flags) and matches the pattern:
24072
24073 .ilist
24074 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24075 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24076 absence of &"Q"& the rewritten address must always include a domain.
24077 .next
24078 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24079 even if no rewriting actually takes place because of a &"fail"& in the
24080 expansion. The &"q"& flag is not effective if the address is of the wrong type
24081 (does not match the flags) or does not match the pattern.
24082 .next
24083 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24084 address, up to ten times. It can be combined with the &"q"& flag, to stop
24085 rewriting once it fails to match (after at least one successful rewrite).
24086 .next
24087 .cindex "rewriting" "whole addresses"
24088 When an address in a header is rewritten, the rewriting normally applies only
24089 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24090 left unchanged. For example, rewriting might change
24091 .code
24092 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24093 .endd
24094 into
24095 .code
24096 From: Ford Prefect <prefectf@hitch.fict.example>
24097 .endd
24098 .cindex "RFC 2047"
24099 Sometimes there is a need to replace the whole address item, and this can be
24100 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24101 causes an address in a header line to be rewritten, the entire address is
24102 replaced, not just the working part. The replacement must be a complete RFC
24103 2822 address, including the angle brackets if necessary. If text outside angle
24104 brackets contains a character whose value is greater than 126 or less than 32
24105 (except for tab), the text is encoded according to RFC 2047. The character set
24106 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24107
24108 When the &"w"& flag is set on a rule that causes an envelope address to be
24109 rewritten, all but the working part of the replacement address is discarded.
24110 .endlist
24111
24112
24113 .section "Rewriting examples" "SECID156"
24114 Here is an example of the two common rewriting paradigms:
24115 .code
24116 *@*.hitch.fict.example  $1@hitch.fict.example
24117 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24118                      {$value}fail}@hitch.fict.example bctfrF
24119 .endd
24120 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24121 the string expansion to fail if the lookup does not succeed. In this context it
24122 has the effect of leaving the original address unchanged, but Exim goes on to
24123 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24124 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24125 explicitly, which would cause the rewritten address to be the same as before,
24126 at the cost of a small bit of processing. Not supplying either of these is an
24127 error, since the rewritten address would then contain no local part.
24128
24129 The first example above replaces the domain with a superior, more general
24130 domain. This may not be desirable for certain local parts. If the rule
24131 .code
24132 root@*.hitch.fict.example  *
24133 .endd
24134 were inserted before the first rule, rewriting would be suppressed for the
24135 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24136
24137 Rewriting can be made conditional on a number of tests, by making use of
24138 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24139 messages that originate outside the local host:
24140 .code
24141 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24142                          {$1@hitch.fict.example}fail}"
24143 .endd
24144 The replacement string is quoted in this example because it contains white
24145 space.
24146
24147 .cindex "rewriting" "bang paths"
24148 .cindex "bang paths" "rewriting"
24149 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24150 an address it treats it as an unqualified local part which it qualifies with
24151 the local qualification domain (if the source of the message is local or if the
24152 remote host is permitted to send unqualified addresses). Rewriting can
24153 sometimes be used to handle simple bang paths with a fixed number of
24154 components. For example, the rule
24155 .code
24156 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24157 .endd
24158 rewrites a two-component bang path &'host.name!user'& as the domain address
24159 &'user@host.name'&. However, there is a security implication in using this as
24160 a global rewriting rule for envelope addresses. It can provide a backdoor
24161 method for using your system as a relay, because the incoming addresses appear
24162 to be local. If the bang path addresses are received via SMTP, it is safer to
24163 use the &"S"& flag to rewrite them as they are received, so that relay checking
24164 can be done on the rewritten addresses.
24165 .ecindex IIDaddrew
24166
24167
24168
24169
24170
24171 . ////////////////////////////////////////////////////////////////////////////
24172 . ////////////////////////////////////////////////////////////////////////////
24173
24174 .chapter "Retry configuration" "CHAPretry"
24175 .scindex IIDretconf1 "retry" "configuration, description of"
24176 .scindex IIDregconf2 "configuration file" "retry section"
24177 The &"retry"& section of the runtime configuration file contains a list of
24178 retry rules that control how often Exim tries to deliver messages that cannot
24179 be delivered at the first attempt. If there are no retry rules (the section is
24180 empty or not present), there are no retries. In this situation, temporary
24181 errors are treated as permanent. The default configuration contains a single,
24182 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24183 line option can be used to test which retry rule will be used for a given
24184 address, domain and error.
24185
24186 The most common cause of retries is temporary failure to deliver to a remote
24187 host because the host is down, or inaccessible because of a network problem.
24188 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24189 address) basis, not on a per-message basis. Thus, if one message has recently
24190 been delayed, delivery of a new message to the same host is not immediately
24191 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24192 log selector is set, the message
24193 .cindex "retry" "time not reached"
24194 &"retry time not reached"& is written to the main log whenever a delivery is
24195 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24196 the handling of errors during remote deliveries.
24197
24198 Retry processing applies to routing as well as to delivering, except as covered
24199 in the next paragraph. The retry rules do not distinguish between these
24200 actions. It is not possible, for example, to specify different behaviour for
24201 failures to route the domain &'snark.fict.example'& and failures to deliver to
24202 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24203 added complication, so did not implement it. However, although they share the
24204 same retry rule, the actual retry times for routing and transporting a given
24205 domain are maintained independently.
24206
24207 When a delivery is not part of a queue run (typically an immediate delivery on
24208 receipt of a message), the routers are always run, and local deliveries are
24209 always attempted, even if retry times are set for them. This makes for better
24210 behaviour if one particular message is causing problems (for example, causing
24211 quota overflow, or provoking an error in a filter file). If such a delivery
24212 suffers a temporary failure, the retry data is updated as normal, and
24213 subsequent delivery attempts from queue runs occur only when the retry time for
24214 the local address is reached.
24215
24216 .section "Changing retry rules" "SECID157"
24217 If you change the retry rules in your configuration, you should consider
24218 whether or not to delete the retry data that is stored in Exim's spool area in
24219 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24220 always safe; that is why they are called &"hints"&.
24221
24222 The hints retry data contains suggested retry times based on the previous
24223 rules. In the case of a long-running problem with a remote host, it might
24224 record the fact that the host has timed out. If your new rules increase the
24225 timeout time for such a host, you should definitely remove the old retry data
24226 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24227 messages that it should now be retaining.
24228
24229
24230
24231 .section "Format of retry rules" "SECID158"
24232 .cindex "retry" "rules"
24233 Each retry rule occupies one line and consists of three or four parts,
24234 separated by white space: a pattern, an error name, an optional list of sender
24235 addresses, and a list of retry parameters. The pattern and sender lists must be
24236 enclosed in double quotes if they contain white space. The rules are searched
24237 in order until one is found where the pattern, error name, and sender list (if
24238 present) match the failing host or address, the error that occurred, and the
24239 message's sender, respectively.
24240
24241
24242 The pattern is any single item that may appear in an address list (see section
24243 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24244 which means that it is expanded before being tested against the address that
24245 has been delayed. A negated address list item is permitted. Address
24246 list processing treats a plain domain name as if it were preceded by &"*@"&,
24247 which makes it possible for many retry rules to start with just a domain. For
24248 example,
24249 .code
24250 lookingglass.fict.example        *  F,24h,30m;
24251 .endd
24252 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24253 whereas
24254 .code
24255 alice@lookingglass.fict.example  *  F,24h,30m;
24256 .endd
24257 applies only to temporary failures involving the local part &%alice%&.
24258 In practice, almost all rules start with a domain name pattern without a local
24259 part.
24260
24261 .cindex "regular expressions" "in retry rules"
24262 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24263 must match a complete address, not just a domain, because that is how regular
24264 expressions work in address lists.
24265 .display
24266 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24267 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24268 .endd
24269
24270
24271 .section "Choosing which retry rule to use for address errors" "SECID159"
24272 When Exim is looking for a retry rule after a routing attempt has failed (for
24273 example, after a DNS timeout), each line in the retry configuration is tested
24274 against the complete address only if &%retry_use_local_part%& is set for the
24275 router. Otherwise, only the domain is used, except when matching against a
24276 regular expression, when the local part of the address is replaced with &"*"&.
24277 A domain on its own can match a domain pattern, or a pattern that starts with
24278 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24279 &%check_local_user%& is true, and false for other routers.
24280
24281 Similarly, when Exim is looking for a retry rule after a local delivery has
24282 failed (for example, after a mailbox full error), each line in the retry
24283 configuration is tested against the complete address only if
24284 &%retry_use_local_part%& is set for the transport (it defaults true for all
24285 local transports).
24286
24287 .cindex "4&'xx'& responses" "retry rules for"
24288 However, when Exim is looking for a retry rule after a remote delivery attempt
24289 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24290 whole address is always used as the key when searching the retry rules. The
24291 rule that is found is used to create a retry time for the combination of the
24292 failing address and the message's sender. It is the combination of sender and
24293 recipient that is delayed in subsequent queue runs until its retry time is
24294 reached. You can delay the recipient without regard to the sender by setting
24295 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24296 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24297 commands.
24298
24299
24300
24301 .section "Choosing which retry rule to use for host and message errors" &&&
24302          "SECID160"
24303 For a temporary error that is not related to an individual address (for
24304 example, a connection timeout), each line in the retry configuration is checked
24305 twice. First, the name of the remote host is used as a domain name (preceded by
24306 &"*@"& when matching a regular expression). If this does not match the line,
24307 the domain from the email address is tried in a similar fashion. For example,
24308 suppose the MX records for &'a.b.c.example'& are
24309 .code
24310 a.b.c.example  MX  5  x.y.z.example
24311                MX  6  p.q.r.example
24312                MX  7  m.n.o.example
24313 .endd
24314 and the retry rules are
24315 .code
24316 p.q.r.example    *      F,24h,30m;
24317 a.b.c.example    *      F,4d,45m;
24318 .endd
24319 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24320 first rule matches neither the host nor the domain, so Exim looks at the second
24321 rule. This does not match the host, but it does match the domain, so it is used
24322 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24323 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24324 first retry rule is used, because it matches the host.
24325
24326 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24327 first rule to determine retry times, but for all the other hosts for the domain
24328 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24329 routing to &'a.b.c.example'& suffers a temporary failure.
24330
24331 &*Note*&: The host name is used when matching the patterns, not its IP address.
24332 However, if a message is routed directly to an IP address without the use of a
24333 host name, for example, if a &(manualroute)& router contains a setting such as:
24334 .code
24335 route_list = *.a.example  192.168.34.23
24336 .endd
24337 then the &"host name"& that is used when searching for a retry rule is the
24338 textual form of the IP address.
24339
24340 .section "Retry rules for specific errors" "SECID161"
24341 .cindex "retry" "specific errors; specifying"
24342 The second field in a retry rule is the name of a particular error, or an
24343 asterisk, which matches any error. The errors that can be tested for are:
24344
24345 .vlist
24346 .vitem &%auth_failed%&
24347 Authentication failed when trying to send to a host in the
24348 &%hosts_require_auth%& list in an &(smtp)& transport.
24349
24350 .vitem &%data_4xx%&
24351 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24352 after the command, or after sending the message's data.
24353
24354 .vitem &%mail_4xx%&
24355 A 4&'xx'& error was received for an outgoing MAIL command.
24356
24357 .vitem &%rcpt_4xx%&
24358 A 4&'xx'& error was received for an outgoing RCPT command.
24359 .endlist
24360
24361 For the three 4&'xx'& errors, either the first or both of the x's can be given
24362 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24363 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24364 and have retries every ten minutes with a one-hour timeout, you could set up a
24365 retry rule of this form:
24366 .code
24367 the.domain.name  rcpt_452   F,1h,10m
24368 .endd
24369 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24370 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24371
24372 .vlist
24373 .vitem &%lost_connection%&
24374 A server unexpectedly closed the SMTP connection. There may, of course,
24375 legitimate reasons for this (host died, network died), but if it repeats a lot
24376 for the same host, it indicates something odd.
24377
24378 .vitem &%lookup%&
24379 A DNS lookup for a host failed.
24380 Note that a &%dnslookup%& router will need to have matched
24381 its &%fail_defer_domains%& option for this retry type to be usable.
24382 Also note that a &%manualroute%& router will probably need
24383 its &%host_find_failed%& option set to &%defer%&.
24384
24385 .vitem &%refused_MX%&
24386 A connection to a host obtained from an MX record was refused.
24387
24388 .vitem &%refused_A%&
24389 A connection to a host not obtained from an MX record was refused.
24390
24391 .vitem &%refused%&
24392 A connection was refused.
24393
24394 .vitem &%timeout_connect_MX%&
24395 A connection attempt to a host obtained from an MX record timed out.
24396
24397 .vitem &%timeout_connect_A%&
24398 A connection attempt to a host not obtained from an MX record timed out.
24399
24400 .vitem &%timeout_connect%&
24401 A connection attempt timed out.
24402
24403 .vitem &%timeout_MX%&
24404 There was a timeout while connecting or during an SMTP session with a host
24405 obtained from an MX record.
24406
24407 .vitem &%timeout_A%&
24408 There was a timeout while connecting or during an SMTP session with a host not
24409 obtained from an MX record.
24410
24411 .vitem &%timeout%&
24412 There was a timeout while connecting or during an SMTP session.
24413
24414 .vitem &%tls_required%&
24415 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24416 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24417 to STARTTLS, or there was a problem setting up the TLS connection.
24418
24419 .vitem &%quota%&
24420 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24421 transport.
24422
24423 .vitem &%quota_%&<&'time'&>
24424 .cindex "quota" "error testing in retry rule"
24425 .cindex "retry" "quota error testing"
24426 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24427 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24428 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24429 for four days.
24430 .endlist
24431
24432 .cindex "mailbox" "time of last read"
24433 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24434 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24435 it should be based on the last time that the user accessed the mailbox.
24436 However, it is not always possible to determine this. Exim uses the following
24437 heuristic rules:
24438
24439 .ilist
24440 If the mailbox is a single file, the time of last access (the &"atime"&) is
24441 used. As no new messages are being delivered (because the mailbox is over
24442 quota), Exim does not access the file, so this is the time of last user access.
24443 .next
24444 .cindex "maildir format" "time of last read"
24445 For a maildir delivery, the time of last modification of the &_new_&
24446 subdirectory is used. As the mailbox is over quota, no new files are created in
24447 the &_new_& subdirectory, because no new messages are being delivered. Any
24448 change to the &_new_& subdirectory is therefore assumed to be the result of an
24449 MUA moving a new message to the &_cur_& directory when it is first read. The
24450 time that is used is therefore the last time that the user read a new message.
24451 .next
24452 For other kinds of multi-file mailbox, the time of last access cannot be
24453 obtained, so a retry rule that uses this type of error field is never matched.
24454 .endlist
24455
24456 The quota errors apply both to system-enforced quotas and to Exim's own quota
24457 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24458 when a local delivery is deferred because a partition is full (the ENOSPC
24459 error).
24460
24461
24462
24463 .section "Retry rules for specified senders" "SECID162"
24464 .cindex "retry" "rules; sender-specific"
24465 You can specify retry rules that apply only when the failing message has a
24466 specific sender. In particular, this can be used to define retry rules that
24467 apply only to bounce messages. The third item in a retry rule can be of this
24468 form:
24469 .display
24470 &`senders=`&<&'address list'&>
24471 .endd
24472 The retry timings themselves are then the fourth item. For example:
24473 .code
24474 *   rcpt_4xx   senders=:   F,1h,30m
24475 .endd
24476 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24477 host. If the address list contains white space, it must be enclosed in quotes.
24478 For example:
24479 .code
24480 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24481 .endd
24482 &*Warning*&: This facility can be unhelpful if it is used for host errors
24483 (which do not depend on the recipient). The reason is that the sender is used
24484 only to match the retry rule. Once the rule has been found for a host error,
24485 its contents are used to set a retry time for the host, and this will apply to
24486 all messages, not just those with specific senders.
24487
24488 When testing retry rules using &%-brt%&, you can supply a sender using the
24489 &%-f%& command line option, like this:
24490 .code
24491 exim -f "" -brt user@dom.ain
24492 .endd
24493 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24494 list is never matched.
24495
24496
24497
24498
24499
24500 .section "Retry parameters" "SECID163"
24501 .cindex "retry" "parameters in rules"
24502 The third (or fourth, if a senders list is present) field in a retry rule is a
24503 sequence of retry parameter sets, separated by semicolons. Each set consists of
24504 .display
24505 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24506 .endd
24507 The letter identifies the algorithm for computing a new retry time; the cutoff
24508 time is the time beyond which this algorithm no longer applies, and the
24509 arguments vary the algorithm's action. The cutoff time is measured from the
24510 time that the first failure for the domain (combined with the local part if
24511 relevant) was detected, not from the time the message was received.
24512
24513 .cindex "retry" "algorithms"
24514 .cindex "retry" "fixed intervals"
24515 .cindex "retry" "increasing intervals"
24516 .cindex "retry" "random intervals"
24517 The available algorithms are:
24518
24519 .ilist
24520 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24521 the interval.
24522 .next
24523 &'G'&: retry at geometrically increasing intervals. The first argument
24524 specifies a starting value for the interval, and the second a multiplier, which
24525 is used to increase the size of the interval at each retry.
24526 .next
24527 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24528 retry, the previous interval is multiplied by the factor in order to get a
24529 maximum for the next interval. The minimum interval is the first argument of
24530 the parameter, and an actual interval is chosen randomly between them. Such a
24531 rule has been found to be helpful in cluster configurations when all the
24532 members of the cluster restart at once, and may therefore synchronize their
24533 queue processing times.
24534 .endlist
24535
24536 When computing the next retry time, the algorithm definitions are scanned in
24537 order until one whose cutoff time has not yet passed is reached. This is then
24538 used to compute a new retry time that is later than the current time. In the
24539 case of fixed interval retries, this simply means adding the interval to the
24540 current time. For geometrically increasing intervals, retry intervals are
24541 computed from the rule's parameters until one that is greater than the previous
24542 interval is found. The main configuration variable
24543 .cindex "limit" "retry interval"
24544 .cindex "retry" "interval, maximum"
24545 .oindex "&%retry_interval_max%&"
24546 &%retry_interval_max%& limits the maximum interval between retries. It
24547 cannot be set greater than &`24h`&, which is its default value.
24548
24549 A single remote domain may have a number of hosts associated with it, and each
24550 host may have more than one IP address. Retry algorithms are selected on the
24551 basis of the domain name, but are applied to each IP address independently. If,
24552 for example, a host has two IP addresses and one is unusable, Exim will
24553 generate retry times for it and will not try to use it until its next retry
24554 time comes. Thus the good IP address is likely to be tried first most of the
24555 time.
24556
24557 .cindex "hints database" "use for retrying"
24558 Retry times are hints rather than promises. Exim does not make any attempt to
24559 run deliveries exactly at the computed times. Instead, a queue runner process
24560 starts delivery processes for delayed messages periodically, and these attempt
24561 new deliveries only for those addresses that have passed their next retry time.
24562 If a new message arrives for a deferred address, an immediate delivery attempt
24563 occurs only if the address has passed its retry time. In the absence of new
24564 messages, the minimum time between retries is the interval between queue runner
24565 processes. There is not much point in setting retry times of five minutes if
24566 your queue runners happen only once an hour, unless there are a significant
24567 number of incoming messages (which might be the case on a system that is
24568 sending everything to a smart host, for example).
24569
24570 The data in the retry hints database can be inspected by using the
24571 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24572 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24573 &'exinext'& utility script can be used to find out what the next retry times
24574 are for the hosts associated with a particular mail domain, and also for local
24575 deliveries that have been deferred.
24576
24577
24578 .section "Retry rule examples" "SECID164"
24579 Here are some example retry rules:
24580 .code
24581 alice@wonderland.fict.example quota_5d  F,7d,3h
24582 wonderland.fict.example       quota_5d
24583 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24584 lookingglass.fict.example     *         F,24h,30m;
24585 *                 refused_A   F,2h,20m;
24586 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24587 .endd
24588 The first rule sets up special handling for mail to
24589 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24590 mailbox has not been read for at least 5 days. Retries continue every three
24591 hours for 7 days. The second rule handles over-quota errors for all other local
24592 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24593 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24594 fail are bounced immediately if the mailbox has not been read for at least 5
24595 days.
24596
24597 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24598 happen every 15 minutes for an hour, then with geometrically increasing
24599 intervals until two days have passed since a delivery first failed. After the
24600 first hour there is a delay of one hour, then two hours, then four hours, and
24601 so on (this is a rather extreme example).
24602
24603 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24604 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24605 all other domains, with special action for connection refusal from hosts that
24606 were not obtained from an MX record.
24607
24608 The final rule in a retry configuration should always have asterisks in the
24609 first two fields so as to provide a general catch-all for any addresses that do
24610 not have their own special handling. This example tries every 15 minutes for 2
24611 hours, then with intervals starting at one hour and increasing by a factor of
24612 1.5 up to 16 hours, then every 8 hours up to 5 days.
24613
24614
24615
24616 .section "Timeout of retry data" "SECID165"
24617 .cindex "timeout" "of retry data"
24618 .oindex "&%retry_data_expire%&"
24619 .cindex "hints database" "data expiry"
24620 .cindex "retry" "timeout of data"
24621 Exim timestamps the data that it writes to its retry hints database. When it
24622 consults the data during a delivery it ignores any that is older than the value
24623 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24624 been tried for 7 days, Exim will try to deliver to it immediately a message
24625 arrives, and if that fails, it will calculate a retry time as if it were
24626 failing for the first time.
24627
24628 This improves the behaviour for messages routed to rarely-used hosts such as MX
24629 backups. If such a host was down at one time, and happens to be down again when
24630 Exim tries a month later, using the old retry data would imply that it had been
24631 down all the time, which is not a justified assumption.
24632
24633 If a host really is permanently dead, this behaviour causes a burst of retries
24634 every now and again, but only if messages routed to it are rare. If there is a
24635 message at least once every 7 days the retry data never expires.
24636
24637
24638
24639
24640 .section "Long-term failures" "SECID166"
24641 .cindex "delivery failure, long-term"
24642 .cindex "retry" "after long-term failure"
24643 Special processing happens when an email address has been failing for so long
24644 that the cutoff time for the last algorithm is reached. For example, using the
24645 default retry rule:
24646 .code
24647 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24648 .endd
24649 the cutoff time is four days. Reaching the retry cutoff is independent of how
24650 long any specific message has been failing; it is the length of continuous
24651 failure for the recipient address that counts.
24652
24653 When the cutoff time is reached for a local delivery, or for all the IP
24654 addresses associated with a remote delivery, a subsequent delivery failure
24655 causes Exim to give up on the address, and a bounce message is generated.
24656 In order to cater for new messages that use the failing address, a next retry
24657 time is still computed from the final algorithm, and is used as follows:
24658
24659 For local deliveries, one delivery attempt is always made for any subsequent
24660 messages. If this delivery fails, the address fails immediately. The
24661 post-cutoff retry time is not used.
24662
24663 If the delivery is remote, there are two possibilities, controlled by the
24664 .oindex "&%delay_after_cutoff%&"
24665 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24666 default. Until the post-cutoff retry time for one of the IP addresses is
24667 reached, the failing email address is bounced immediately, without a delivery
24668 attempt taking place. After that time, one new delivery attempt is made to
24669 those IP addresses that are past their retry times, and if that still fails,
24670 the address is bounced and new retry times are computed.
24671
24672 In other words, when all the hosts for a given email address have been failing
24673 for a long time, Exim bounces rather then defers until one of the hosts' retry
24674 times is reached. Then it tries once, and bounces if that attempt fails. This
24675 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24676 to a broken destination, but if the host does recover, Exim will eventually
24677 notice.
24678
24679 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24680 addresses are past their final cutoff time, Exim tries to deliver to those IP
24681 addresses that have not been tried since the message arrived. If there are
24682 no suitable IP addresses, or if they all fail, the address is bounced. In other
24683 words, it does not delay when a new message arrives, but tries the expired
24684 addresses immediately, unless they have been tried since the message arrived.
24685 If there is a continuous stream of messages for the failing domains, setting
24686 &%delay_after_cutoff%& false means that there will be many more attempts to
24687 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24688 true.
24689
24690 .section "Deliveries that work intermittently" "SECID167"
24691 .cindex "retry" "intermittently working deliveries"
24692 Some additional logic is needed to cope with cases where a host is
24693 intermittently available, or when a message has some attribute that prevents
24694 its delivery when others to the same address get through. In this situation,
24695 because some messages are successfully delivered, the &"retry clock"& for the
24696 host or address keeps getting reset by the successful deliveries, and so
24697 failing messages remain on the queue for ever because the cutoff time is never
24698 reached.
24699
24700 Two exceptional actions are applied to prevent this happening. The first
24701 applies to errors that are related to a message rather than a remote host.
24702 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24703 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24704 commands, and quota failures. For this type of error, if a message's arrival
24705 time is earlier than the &"first failed"& time for the error, the earlier time
24706 is used when scanning the retry rules to decide when to try next and when to
24707 time out the address.
24708
24709 The exceptional second action applies in all cases. If a message has been on
24710 the queue for longer than the cutoff time of any applicable retry rule for a
24711 given address, a delivery is attempted for that address, even if it is not yet
24712 time, and if this delivery fails, the address is timed out. A new retry time is
24713 not computed in this case, so that other messages for the same address are
24714 considered immediately.
24715 .ecindex IIDretconf1
24716 .ecindex IIDregconf2
24717
24718
24719
24720
24721
24722
24723 . ////////////////////////////////////////////////////////////////////////////
24724 . ////////////////////////////////////////////////////////////////////////////
24725
24726 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24727 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24728 .scindex IIDauthconf2 "authentication"
24729 The &"authenticators"& section of Exim's run time configuration is concerned
24730 with SMTP authentication. This facility is an extension to the SMTP protocol,
24731 described in RFC 2554, which allows a client SMTP host to authenticate itself
24732 to a server. This is a common way for a server to recognize clients that are
24733 permitted to use it as a relay. SMTP authentication is not of relevance to the
24734 transfer of mail between servers that have no managerial connection with each
24735 other.
24736
24737 .cindex "AUTH" "description of"
24738 Very briefly, the way SMTP authentication works is as follows:
24739
24740 .ilist
24741 The server advertises a number of authentication &'mechanisms'& in response to
24742 the client's EHLO command.
24743 .next
24744 The client issues an AUTH command, naming a specific mechanism. The command
24745 may, optionally, contain some authentication data.
24746 .next
24747 The server may issue one or more &'challenges'&, to which the client must send
24748 appropriate responses. In simple authentication mechanisms, the challenges are
24749 just prompts for user names and passwords. The server does not have to issue
24750 any challenges &-- in some mechanisms the relevant data may all be transmitted
24751 with the AUTH command.
24752 .next
24753 The server either accepts or denies authentication.
24754 .next
24755 If authentication succeeds, the client may optionally make use of the AUTH
24756 option on the MAIL command to pass an authenticated sender in subsequent
24757 mail transactions. Authentication lasts for the remainder of the SMTP
24758 connection.
24759 .next
24760 If authentication fails, the client may give up, or it may try a different
24761 authentication mechanism, or it may try transferring mail over the
24762 unauthenticated connection.
24763 .endlist
24764
24765 If you are setting up a client, and want to know which authentication
24766 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24767 SMTP port) on the server, and issue an EHLO command. The response to this
24768 includes the list of supported mechanisms. For example:
24769 .display
24770 &`$ `&&*&`telnet server.example 25`&*&
24771 &`Trying 192.168.34.25...`&
24772 &`Connected to server.example.`&
24773 &`Escape character is &#x0027;^]&#x0027;.`&
24774 &`220 server.example ESMTP Exim 4.20 ...`&
24775 &*&`ehlo client.example`&*&
24776 &`250-server.example Hello client.example [10.8.4.5]`&
24777 &`250-SIZE 52428800`&
24778 &`250-PIPELINING`&
24779 &`250-AUTH PLAIN`&
24780 &`250 HELP`&
24781 .endd
24782 The second-last line of this example output shows that the server supports
24783 authentication using the PLAIN mechanism. In Exim, the different authentication
24784 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24785 routers and transports, which authenticators are included in the binary is
24786 controlled by build-time definitions. The following are currently available,
24787 included by setting
24788 .code
24789 AUTH_CRAM_MD5=yes
24790 AUTH_CYRUS_SASL=yes
24791 AUTH_DOVECOT=yes
24792 AUTH_GSASL=yes
24793 AUTH_HEIMDAL_GSSAPI=yes
24794 AUTH_PLAINTEXT=yes
24795 AUTH_SPA=yes
24796 .endd
24797 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24798 authentication mechanism (RFC 2195), and the second provides an interface to
24799 the Cyrus SASL authentication library.
24800 The third is an interface to Dovecot's authentication system, delegating the
24801 work via a socket interface.
24802 The fourth provides an interface to the GNU SASL authentication library, which
24803 provides mechanisms but typically not data sources.
24804 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24805 supporting setting a server keytab.
24806 The sixth can be configured to support
24807 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24808 not formally documented, but used by several MUAs. The seventh authenticator
24809 supports Microsoft's &'Secure Password Authentication'& mechanism.
24810
24811 The authenticators are configured using the same syntax as other drivers (see
24812 section &<<SECTfordricon>>&). If no authenticators are required, no
24813 authentication section need be present in the configuration file. Each
24814 authenticator can in principle have both server and client functions. When Exim
24815 is receiving SMTP mail, it is acting as a server; when it is sending out
24816 messages over SMTP, it is acting as a client. Authenticator configuration
24817 options are provided for use in both these circumstances.
24818
24819 To make it clear which options apply to which situation, the prefixes
24820 &%server_%& and &%client_%& are used on option names that are specific to
24821 either the server or the client function, respectively. Server and client
24822 functions are disabled if none of their options are set. If an authenticator is
24823 to be used for both server and client functions, a single definition, using
24824 both sets of options, is required. For example:
24825 .code
24826 cram:
24827   driver = cram_md5
24828   public_name = CRAM-MD5
24829   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24830   client_name = ph10
24831   client_secret = secret2
24832 .endd
24833 The &%server_%& option is used when Exim is acting as a server, and the
24834 &%client_%& options when it is acting as a client.
24835
24836 Descriptions of the individual authenticators are given in subsequent chapters.
24837 The remainder of this chapter covers the generic options for the
24838 authenticators, followed by general discussion of the way authentication works
24839 in Exim.
24840
24841 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24842 per-mechanism basis.  Please read carefully to determine which variables hold
24843 account labels such as usercodes and which hold passwords or other
24844 authenticating data.
24845
24846 Note that some mechanisms support two different identifiers for accounts: the
24847 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24848 and &'authz'& are commonly encountered.  The American spelling is standard here.
24849 Conceptually, authentication data such as passwords are tied to the identifier
24850 used to authenticate; servers may have rules to permit one user to act as a
24851 second user, so that after login the session is treated as though that second
24852 user had logged in.  That second user is the &'authorization id'&.  A robust
24853 configuration might confirm that the &'authz'& field is empty or matches the
24854 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24855 as verified data, the &'authz'& as an unverified request which the server might
24856 choose to honour.
24857
24858 A &'realm'& is a text string, typically a domain name, presented by a server
24859 to a client to help it select an account and credentials to use.  In some
24860 mechanisms, the client and server provably agree on the realm, but clients
24861 typically can not treat the realm as secure data to be blindly trusted.
24862
24863
24864
24865 .section "Generic options for authenticators" "SECID168"
24866 .cindex "authentication" "generic options"
24867 .cindex "options" "generic; for authenticators"
24868
24869 .option client_condition authenticators string&!! unset
24870 When Exim is authenticating as a client, it skips any authenticator whose
24871 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24872 used, for example, to skip plain text authenticators when the connection is not
24873 encrypted by a setting such as:
24874 .code
24875 client_condition = ${if !eq{$tls_out_cipher}{}}
24876 .endd
24877
24878
24879 .option client_set_id authenticators string&!! unset
24880 When client authentication succeeds, this condition is expanded; the
24881 result is used in the log lines for outbound messasges.
24882 Typically it will be the user name used for authentication.
24883
24884
24885 .option driver authenticators string unset
24886 This option must always be set. It specifies which of the available
24887 authenticators is to be used.
24888
24889
24890 .option public_name authenticators string unset
24891 This option specifies the name of the authentication mechanism that the driver
24892 implements, and by which it is known to the outside world. These names should
24893 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24894 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24895 defaults to the driver's instance name.
24896
24897
24898 .option server_advertise_condition authenticators string&!! unset
24899 When a server is about to advertise an authentication mechanism, the condition
24900 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24901 mechanism is not advertised.
24902 If the expansion fails, the mechanism is not advertised. If the failure was not
24903 forced, and was not caused by a lookup defer, the incident is logged.
24904 See section &<<SECTauthexiser>>& below for further discussion.
24905
24906
24907 .option server_condition authenticators string&!! unset
24908 This option must be set for a &%plaintext%& server authenticator, where it
24909 is used directly to control authentication. See section &<<SECTplainserver>>&
24910 for details.
24911
24912 For the &(gsasl)& authenticator, this option is required for various
24913 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24914
24915 For the other authenticators, &%server_condition%& can be used as an additional
24916 authentication or authorization mechanism that is applied after the other
24917 authenticator conditions succeed. If it is set, it is expanded when the
24918 authenticator would otherwise return a success code. If the expansion is forced
24919 to fail, authentication fails. Any other expansion failure causes a temporary
24920 error code to be returned. If the result of a successful expansion is an empty
24921 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24922 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24923 other result, a temporary error code is returned, with the expanded string as
24924 the error text.
24925
24926
24927 .option server_debug_print authenticators string&!! unset
24928 If this option is set and authentication debugging is enabled (see the &%-d%&
24929 command line option), the string is expanded and included in the debugging
24930 output when the authenticator is run as a server. This can help with checking
24931 out the values of variables.
24932 If expansion of the string fails, the error message is written to the debugging
24933 output, and Exim carries on processing.
24934
24935
24936 .option server_set_id authenticators string&!! unset
24937 .vindex "&$authenticated_id$&"
24938 When an Exim server successfully authenticates a client, this string is
24939 expanded using data from the authentication, and preserved for any incoming
24940 messages in the variable &$authenticated_id$&. It is also included in the log
24941 lines for incoming messages. For example, a user/password authenticator
24942 configuration might preserve the user name that was used to authenticate, and
24943 refer to it subsequently during delivery of the message.
24944 If expansion fails, the option is ignored.
24945
24946
24947 .option server_mail_auth_condition authenticators string&!! unset
24948 This option allows a server to discard authenticated sender addresses supplied
24949 as part of MAIL commands in SMTP connections that are authenticated by the
24950 driver on which &%server_mail_auth_condition%& is set. The option is not used
24951 as part of the authentication process; instead its (unexpanded) value is
24952 remembered for later use.
24953 How it is used is described in the following section.
24954
24955
24956
24957
24958
24959 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24960 .cindex "authentication" "sender; authenticated"
24961 .cindex "AUTH" "on MAIL command"
24962 When a client supplied an AUTH= item on a MAIL command, Exim applies
24963 the following checks before accepting it as the authenticated sender of the
24964 message:
24965
24966 .ilist
24967 If the connection is not using extended SMTP (that is, HELO was used rather
24968 than EHLO), the use of AUTH= is a syntax error.
24969 .next
24970 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24971 .next
24972 .vindex "&$authenticated_sender$&"
24973 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24974 running, the value of &$authenticated_sender$& is set to the value obtained
24975 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24976 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24977 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24978 given for the MAIL command.
24979 .next
24980 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24981 is accepted and placed in &$authenticated_sender$& only if the client has
24982 authenticated.
24983 .next
24984 If the AUTH= value was accepted by either of the two previous rules, and
24985 the client has authenticated, and the authenticator has a setting for the
24986 &%server_mail_auth_condition%&, the condition is checked at this point. The
24987 valued that was saved from the authenticator is expanded. If the expansion
24988 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24989 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24990 the value of &$authenticated_sender$& is retained and passed on with the
24991 message.
24992 .endlist
24993
24994
24995 When &$authenticated_sender$& is set for a message, it is passed on to other
24996 hosts to which Exim authenticates as a client. Do not confuse this value with
24997 &$authenticated_id$&, which is a string obtained from the authentication
24998 process, and which is not usually a complete email address.
24999
25000 .vindex "&$sender_address$&"
25001 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25002 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25003 therefore make use of &$authenticated_sender$&. The converse is not true: the
25004 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25005 ACL is run.
25006
25007
25008
25009 .section "Authentication on an Exim server" "SECTauthexiser"
25010 .cindex "authentication" "on an Exim server"
25011 When Exim receives an EHLO command, it advertises the public names of those
25012 authenticators that are configured as servers, subject to the following
25013 conditions:
25014
25015 .ilist
25016 The client host must match &%auth_advertise_hosts%& (default *).
25017 .next
25018 It the &%server_advertise_condition%& option is set, its expansion must not
25019 yield the empty string, &"0"&, &"no"&, or &"false"&.
25020 .endlist
25021
25022 The order in which the authenticators are defined controls the order in which
25023 the mechanisms are advertised.
25024
25025 Some mail clients (for example, some versions of Netscape) require the user to
25026 provide a name and password for authentication whenever AUTH is advertised,
25027 even though authentication may not in fact be needed (for example, Exim may be
25028 set up to allow unconditional relaying from the client by an IP address check).
25029 You can make such clients more friendly by not advertising AUTH to them.
25030 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25031 that runs for RCPT) to relay without authentication, you should set
25032 .code
25033 auth_advertise_hosts = ! 10.9.8.0/24
25034 .endd
25035 so that no authentication mechanisms are advertised to them.
25036
25037 The &%server_advertise_condition%& controls the advertisement of individual
25038 authentication mechanisms. For example, it can be used to restrict the
25039 advertisement of a particular mechanism to encrypted connections, by a setting
25040 such as:
25041 .code
25042 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25043 .endd
25044 .vindex "&$tls_in_cipher$&"
25045 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25046 yields &"yes"&, which allows the advertisement to happen.
25047
25048 When an Exim server receives an AUTH command from a client, it rejects it
25049 immediately if AUTH was not advertised in response to an earlier EHLO
25050 command. This is the case if
25051
25052 .ilist
25053 The client host does not match &%auth_advertise_hosts%&; or
25054 .next
25055 No authenticators are configured with server options; or
25056 .next
25057 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25058 server authenticators.
25059 .endlist
25060
25061
25062 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25063 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25064 AUTH is accepted from any client host.
25065
25066 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25067 server authentication mechanism that was advertised in response to EHLO and
25068 that matches the one named in the AUTH command. If it finds one, it runs
25069 the appropriate authentication protocol, and authentication either succeeds or
25070 fails. If there is no matching advertised mechanism, the AUTH command is
25071 rejected with a 504 error.
25072
25073 .vindex "&$received_protocol$&"
25074 .vindex "&$sender_host_authenticated$&"
25075 When a message is received from an authenticated host, the value of
25076 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25077 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25078 public name) of the authenticator driver that successfully authenticated the
25079 client from which the message was received. This variable is empty if there was
25080 no successful authentication.
25081
25082
25083
25084
25085 .section "Testing server authentication" "SECID169"
25086 .cindex "authentication" "testing a server"
25087 .cindex "AUTH" "testing a server"
25088 .cindex "base64 encoding" "creating authentication test data"
25089 Exim's &%-bh%& option can be useful for testing server authentication
25090 configurations. The data for the AUTH command has to be sent using base64
25091 encoding. A quick way to produce such data for testing is the following Perl
25092 script:
25093 .code
25094 use MIME::Base64;
25095 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25096 .endd
25097 .cindex "binary zero" "in authentication data"
25098 This interprets its argument as a Perl string, and then encodes it. The
25099 interpretation as a Perl string allows binary zeros, which are required for
25100 some kinds of authentication, to be included in the data. For example, a
25101 command line to run this script on such data might be
25102 .code
25103 encode '\0user\0password'
25104 .endd
25105 Note the use of single quotes to prevent the shell interpreting the
25106 backslashes, so that they can be interpreted by Perl to specify characters
25107 whose code value is zero.
25108
25109 &*Warning 1*&: If either of the user or password strings starts with an octal
25110 digit, you must use three zeros instead of one after the leading backslash. If
25111 you do not, the octal digit that starts your string will be incorrectly
25112 interpreted as part of the code for the first character.
25113
25114 &*Warning 2*&: If there are characters in the strings that Perl interprets
25115 specially, you must use a Perl escape to prevent them being misinterpreted. For
25116 example, a command such as
25117 .code
25118 encode '\0user@domain.com\0pas$$word'
25119 .endd
25120 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25121
25122 If you have the &%mimencode%& command installed, another way to do produce
25123 base64-encoded strings is to run the command
25124 .code
25125 echo -e -n `\0user\0password' | mimencode
25126 .endd
25127 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25128 in the argument, and the &%-n%& option specifies no newline at the end of its
25129 output. However, not all versions of &%echo%& recognize these options, so you
25130 should check your version before relying on this suggestion.
25131
25132
25133
25134 .section "Authentication by an Exim client" "SECID170"
25135 .cindex "authentication" "on an Exim client"
25136 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25137 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25138 announces support for authentication, and the host matches an entry in either
25139 of these options, Exim (as a client) tries to authenticate as follows:
25140
25141 .ilist
25142 For each authenticator that is configured as a client, in the order in which
25143 they are defined in the configuration, it searches the authentication
25144 mechanisms announced by the server for one whose name matches the public name
25145 of the authenticator.
25146 .next
25147 .vindex "&$host$&"
25148 .vindex "&$host_address$&"
25149 When it finds one that matches, it runs the authenticator's client code. The
25150 variables &$host$& and &$host_address$& are available for any string expansions
25151 that the client might do. They are set to the server's name and IP address. If
25152 any expansion is forced to fail, the authentication attempt is abandoned, and
25153 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25154 delivery to be deferred.
25155 .next
25156 If the result of the authentication attempt is a temporary error or a timeout,
25157 Exim abandons trying to send the message to the host for the moment. It will
25158 try again later. If there are any backup hosts available, they are tried in the
25159 usual way.
25160 .next
25161 If the response to authentication is a permanent error (5&'xx'& code), Exim
25162 carries on searching the list of authenticators and tries another one if
25163 possible. If all authentication attempts give permanent errors, or if there are
25164 no attempts because no mechanisms match (or option expansions force failure),
25165 what happens depends on whether the host matches &%hosts_require_auth%& or
25166 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25167 delivery is deferred. The error can be detected in the retry rules, and thereby
25168 turned into a permanent error if you wish. In the second case, Exim tries to
25169 deliver the message unauthenticated.
25170 .endlist
25171
25172 .cindex "AUTH" "on MAIL command"
25173 When Exim has authenticated itself to a remote server, it adds the AUTH
25174 parameter to the MAIL commands it sends, if it has an authenticated sender for
25175 the message. If the message came from a remote host, the authenticated sender
25176 is the one that was receiving on an incoming MAIL command, provided that the
25177 incoming connection was authenticated and the &%server_mail_auth%& condition
25178 allowed the authenticated sender to be retained. If a local process calls Exim
25179 to send a message, the sender address that is built from the login name and
25180 &%qualify_domain%& is treated as authenticated. However, if the
25181 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25182 the authenticated sender that was received with the message.
25183 .ecindex IIDauthconf1
25184 .ecindex IIDauthconf2
25185
25186
25187
25188
25189
25190
25191 . ////////////////////////////////////////////////////////////////////////////
25192 . ////////////////////////////////////////////////////////////////////////////
25193
25194 .chapter "The plaintext authenticator" "CHAPplaintext"
25195 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25196 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25197 The &(plaintext)& authenticator can be configured to support the PLAIN and
25198 LOGIN authentication mechanisms, both of which transfer authentication data as
25199 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25200 security risk; you are strongly advised to insist on the use of SMTP encryption
25201 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25202 use unencrypted plain text, you should not use the same passwords for SMTP
25203 connections as you do for login accounts.
25204
25205 .section "Plaintext options" "SECID171"
25206 .cindex "options" "&(plaintext)& authenticator (server)"
25207 When configured as a server, &(plaintext)& uses the following options:
25208
25209 .option server_condition authenticators string&!! unset
25210 This is actually a global authentication option, but it must be set in order to
25211 configure the &(plaintext)& driver as a server. Its use is described below.
25212
25213 .option server_prompts plaintext string&!! unset
25214 The contents of this option, after expansion, must be a colon-separated list of
25215 prompt strings. If expansion fails, a temporary authentication rejection is
25216 given.
25217
25218 .section "Using plaintext in a server" "SECTplainserver"
25219 .cindex "AUTH" "in &(plaintext)& authenticator"
25220 .cindex "binary zero" "in &(plaintext)& authenticator"
25221 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25222         "in &(plaintext)& authenticator"
25223 .vindex "&$auth1$&, &$auth2$&, etc"
25224 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25225
25226 When running as a server, &(plaintext)& performs the authentication test by
25227 expanding a string. The data sent by the client with the AUTH command, or in
25228 response to subsequent prompts, is base64 encoded, and so may contain any byte
25229 values when decoded. If any data is supplied with the command, it is treated as
25230 a list of strings, separated by NULs (binary zeros), the first three of which
25231 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25232 (neither LOGIN nor PLAIN uses more than three strings).
25233
25234 For compatibility with previous releases of Exim, the values are also placed in
25235 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25236 variables for this purpose is now deprecated, as it can lead to confusion in
25237 string expansions that also use them for other things.
25238
25239 If there are more strings in &%server_prompts%& than the number of strings
25240 supplied with the AUTH command, the remaining prompts are used to obtain more
25241 data. Each response from the client may be a list of NUL-separated strings.
25242
25243 .vindex "&$authenticated_id$&"
25244 Once a sufficient number of data strings have been received,
25245 &%server_condition%& is expanded. If the expansion is forced to fail,
25246 authentication fails. Any other expansion failure causes a temporary error code
25247 to be returned. If the result of a successful expansion is an empty string,
25248 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25249 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25250 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25251 For any other result, a temporary error code is returned, with the expanded
25252 string as the error text
25253
25254 &*Warning*&: If you use a lookup in the expansion to find the user's
25255 password, be sure to make the authentication fail if the user is unknown.
25256 There are good and bad examples at the end of the next section.
25257
25258
25259
25260 .section "The PLAIN authentication mechanism" "SECID172"
25261 .cindex "PLAIN authentication mechanism"
25262 .cindex "authentication" "PLAIN mechanism"
25263 .cindex "binary zero" "in &(plaintext)& authenticator"
25264 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25265 sent as one item of data (that is, one combined string containing two NUL
25266 separators). The data is sent either as part of the AUTH command, or
25267 subsequently in response to an empty prompt from the server.
25268
25269 The second and third strings are a user name and a corresponding password.
25270 Using a single fixed user name and password as an example, this could be
25271 configured as follows:
25272 .code
25273 fixed_plain:
25274   driver = plaintext
25275   public_name = PLAIN
25276   server_prompts = :
25277   server_condition = \
25278     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25279   server_set_id = $auth2
25280 .endd
25281 Note that the default result strings from &%if%& (&"true"& or an empty string)
25282 are exactly what we want here, so they need not be specified. Obviously, if the
25283 password contains expansion-significant characters such as dollar, backslash,
25284 or closing brace, they have to be escaped.
25285
25286 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25287 the end of a string list are ignored). If all the data comes as part of the
25288 AUTH command, as is commonly the case, the prompt is not used. This
25289 authenticator is advertised in the response to EHLO as
25290 .code
25291 250-AUTH PLAIN
25292 .endd
25293 and a client host can authenticate itself by sending the command
25294 .code
25295 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25296 .endd
25297 As this contains three strings (more than the number of prompts), no further
25298 data is required from the client. Alternatively, the client may just send
25299 .code
25300 AUTH PLAIN
25301 .endd
25302 to initiate authentication, in which case the server replies with an empty
25303 prompt. The client must respond with the combined data string.
25304
25305 The data string is base64 encoded, as required by the RFC. This example,
25306 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25307 represents a zero byte. This is split up into three strings, the first of which
25308 is empty. The &%server_condition%& option in the authenticator checks that the
25309 second two are &`username`& and &`mysecret`& respectively.
25310
25311 Having just one fixed user name and password, as in this example, is not very
25312 realistic, though for a small organization with only a handful of
25313 authenticating clients it could make sense.
25314
25315 A more sophisticated instance of this authenticator could use the user name in
25316 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25317 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25318 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25319 This is an incorrect example:
25320 .code
25321 server_condition = \
25322   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25323 .endd
25324 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25325 which it then compares to the supplied password (&$auth3$&). Why is this example
25326 incorrect? It works fine for existing users, but consider what happens if a
25327 non-existent user name is given. The lookup fails, but as no success/failure
25328 strings are given for the lookup, it yields an empty string. Thus, to defeat
25329 the authentication, all a client has to do is to supply a non-existent user
25330 name and an empty password. The correct way of writing this test is:
25331 .code
25332 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25333   {${if eq{$value}{$auth3}}} {false}}
25334 .endd
25335 In this case, if the lookup succeeds, the result is checked; if the lookup
25336 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25337 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25338 always fails if its second argument is empty. However, the second way of
25339 writing the test makes the logic clearer.
25340
25341
25342 .section "The LOGIN authentication mechanism" "SECID173"
25343 .cindex "LOGIN authentication mechanism"
25344 .cindex "authentication" "LOGIN mechanism"
25345 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25346 in a number of programs. No data is sent with the AUTH command. Instead, a
25347 user name and password are supplied separately, in response to prompts. The
25348 plaintext authenticator can be configured to support this as in this example:
25349 .code
25350 fixed_login:
25351   driver = plaintext
25352   public_name = LOGIN
25353   server_prompts = User Name : Password
25354   server_condition = \
25355     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25356   server_set_id = $auth1
25357 .endd
25358 Because of the way plaintext operates, this authenticator accepts data supplied
25359 with the AUTH command (in contravention of the specification of LOGIN), but
25360 if the client does not supply it (as is the case for LOGIN clients), the prompt
25361 strings are used to obtain two data items.
25362
25363 Some clients are very particular about the precise text of the prompts. For
25364 example, Outlook Express is reported to recognize only &"Username:"& and
25365 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25366 strings. It uses the &%ldapauth%& expansion condition to check the user
25367 name and password by binding to an LDAP server:
25368 .code
25369 login:
25370   driver = plaintext
25371   public_name = LOGIN
25372   server_prompts = Username:: : Password::
25373   server_condition = ${if and{{ \
25374     !eq{}{$auth1} }{ \
25375     ldapauth{\
25376       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25377       pass=${quote:$auth2} \
25378       ldap://ldap.example.org/} }} }
25379   server_set_id = uid=$auth1,ou=people,o=example.org
25380 .endd
25381 We have to check that the username is not empty before using it, because LDAP
25382 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25383 operator to correctly quote the DN for authentication. However, the basic
25384 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25385 correct one to use for the password, because quoting is needed only to make
25386 the password conform to the Exim syntax. At the LDAP level, the password is an
25387 uninterpreted string.
25388
25389
25390 .section "Support for different kinds of authentication" "SECID174"
25391 A number of string expansion features are provided for the purpose of
25392 interfacing to different ways of user authentication. These include checking
25393 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25394 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25395 &<<SECTexpcond>>&.
25396
25397
25398
25399
25400 .section "Using plaintext in a client" "SECID175"
25401 .cindex "options" "&(plaintext)& authenticator (client)"
25402 The &(plaintext)& authenticator has two client options:
25403
25404 .option client_ignore_invalid_base64 plaintext boolean false
25405 If the client receives a server prompt that is not a valid base64 string,
25406 authentication is abandoned by default. However, if this option is set true,
25407 the error in the challenge is ignored and the client sends the response as
25408 usual.
25409
25410 .option client_send plaintext string&!! unset
25411 The string is a colon-separated list of authentication data strings. Each
25412 string is independently expanded before being sent to the server. The first
25413 string is sent with the AUTH command; any more strings are sent in response
25414 to prompts from the server. Before each string is expanded, the value of the
25415 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25416 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25417 way. Thus, the prompt that is received in response to sending the first string
25418 (with the AUTH command) can be used in the expansion of the second string, and
25419 so on. If an invalid base64 string is received when
25420 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25421 &$auth$&<&'n'&> variable.
25422
25423 &*Note*&: You cannot use expansion to create multiple strings, because
25424 splitting takes priority and happens first.
25425
25426 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25427 the data, further processing is applied to each string before it is sent. If
25428 there are any single circumflex characters in the string, they are converted to
25429 NULs. Should an actual circumflex be required as data, it must be doubled in
25430 the string.
25431
25432 This is an example of a client configuration that implements the PLAIN
25433 authentication mechanism with a fixed user name and password:
25434 .code
25435 fixed_plain:
25436   driver = plaintext
25437   public_name = PLAIN
25438   client_send = ^username^mysecret
25439 .endd
25440 The lack of colons means that the entire text is sent with the AUTH
25441 command, with the circumflex characters converted to NULs. A similar example
25442 that uses the LOGIN mechanism is:
25443 .code
25444 fixed_login:
25445   driver = plaintext
25446   public_name = LOGIN
25447   client_send = : username : mysecret
25448 .endd
25449 The initial colon means that the first string is empty, so no data is sent with
25450 the AUTH command itself. The remaining strings are sent in response to
25451 prompts.
25452 .ecindex IIDplaiauth1
25453 .ecindex IIDplaiauth2
25454
25455
25456
25457
25458 . ////////////////////////////////////////////////////////////////////////////
25459 . ////////////////////////////////////////////////////////////////////////////
25460
25461 .chapter "The cram_md5 authenticator" "CHID9"
25462 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25463 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25464 .cindex "CRAM-MD5 authentication mechanism"
25465 .cindex "authentication" "CRAM-MD5 mechanism"
25466 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25467 sends a challenge string to the client, and the response consists of a user
25468 name and the CRAM-MD5 digest of the challenge string combined with a secret
25469 string (password) which is known to both server and client. Thus, the secret
25470 is not sent over the network as plain text, which makes this authenticator more
25471 secure than &(plaintext)&. However, the downside is that the secret has to be
25472 available in plain text at either end.
25473
25474
25475 .section "Using cram_md5 as a server" "SECID176"
25476 .cindex "options" "&(cram_md5)& authenticator (server)"
25477 This authenticator has one server option, which must be set to configure the
25478 authenticator as a server:
25479
25480 .option server_secret cram_md5 string&!! unset
25481 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25482 When the server receives the client's response, the user name is placed in
25483 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25484 obtain the password for that user. The server then computes the CRAM-MD5 digest
25485 that the client should have sent, and checks that it received the correct
25486 string. If the expansion of &%server_secret%& is forced to fail, authentication
25487 fails. If the expansion fails for some other reason, a temporary error code is
25488 returned to the client.
25489
25490 For compatibility with previous releases of Exim, the user name is also placed
25491 in &$1$&. However, the use of this variables for this purpose is now
25492 deprecated, as it can lead to confusion in string expansions that also use
25493 numeric variables for other things.
25494
25495 For example, the following authenticator checks that the user name given by the
25496 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25497 user name, authentication fails.
25498 .code
25499 fixed_cram:
25500   driver = cram_md5
25501   public_name = CRAM-MD5
25502   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25503   server_set_id = $auth1
25504 .endd
25505 .vindex "&$authenticated_id$&"
25506 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25507 name in &$authenticated_id$&. A more typical configuration might look up the
25508 secret string in a file, using the user name as the key. For example:
25509 .code
25510 lookup_cram:
25511   driver = cram_md5
25512   public_name = CRAM-MD5
25513   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25514                   {$value}fail}
25515   server_set_id = $auth1
25516 .endd
25517 Note that this expansion explicitly forces failure if the lookup fails
25518 because &$auth1$& contains an unknown user name.
25519
25520 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25521 using the relevant libraries, you need to know the realm to specify in the
25522 lookup and then ask for the &"userPassword"& attribute for that user in that
25523 realm, with:
25524 .code
25525 cyrusless_crammd5:
25526   driver = cram_md5
25527   public_name = CRAM-MD5
25528   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25529                   dbmjz{/etc/sasldb2}}
25530   server_set_id = $auth1
25531 .endd
25532
25533 .section "Using cram_md5 as a client" "SECID177"
25534 .cindex "options" "&(cram_md5)& authenticator (client)"
25535 When used as a client, the &(cram_md5)& authenticator has two options:
25536
25537
25538
25539 .option client_name cram_md5 string&!! "the primary host name"
25540 This string is expanded, and the result used as the user name data when
25541 computing the response to the server's challenge.
25542
25543
25544 .option client_secret cram_md5 string&!! unset
25545 This option must be set for the authenticator to work as a client. Its value is
25546 expanded and the result used as the secret string when computing the response.
25547
25548
25549 .vindex "&$host$&"
25550 .vindex "&$host_address$&"
25551 Different user names and secrets can be used for different servers by referring
25552 to &$host$& or &$host_address$& in the options. Forced failure of either
25553 expansion string is treated as an indication that this authenticator is not
25554 prepared to handle this case. Exim moves on to the next configured client
25555 authenticator. Any other expansion failure causes Exim to give up trying to
25556 send the message to the current server.
25557
25558 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25559 strings, is:
25560 .code
25561 fixed_cram:
25562   driver = cram_md5
25563   public_name = CRAM-MD5
25564   client_name = ph10
25565   client_secret = secret
25566 .endd
25567 .ecindex IIDcramauth1
25568 .ecindex IIDcramauth2
25569
25570
25571
25572 . ////////////////////////////////////////////////////////////////////////////
25573 . ////////////////////////////////////////////////////////////////////////////
25574
25575 .chapter "The cyrus_sasl authenticator" "CHID10"
25576 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25577 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25578 .cindex "Cyrus" "SASL library"
25579 .cindex "Kerberos"
25580 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25581 Digital Ltd (&url(http://www.aldigital.co.uk)).
25582
25583 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25584 library implementation of the RFC 2222 (&"Simple Authentication and Security
25585 Layer"&). This library supports a number of authentication mechanisms,
25586 including PLAIN and LOGIN, but also several others that Exim does not support
25587 directly. In particular, there is support for Kerberos authentication.
25588
25589 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25590 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25591 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25592 name of the driver to determine which mechanism to support.
25593
25594 Where access to some kind of secret file is required, for example in GSSAPI
25595 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25596 user, and that the Cyrus SASL library has no way of escalating privileges
25597 by default. You may also find you need to set environment variables,
25598 depending on the driver you are using.
25599
25600 The application name provided by Exim is &"exim"&, so various SASL options may
25601 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25602 Kerberos, note that because of limitations in the GSSAPI interface,
25603 changing the server keytab might need to be communicated down to the Kerberos
25604 layer independently. The mechanism for doing so is dependent upon the Kerberos
25605 implementation.
25606
25607 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25608 may be set to point to an alternative keytab file. Exim will pass this
25609 variable through from its own inherited environment when started as root or the
25610 Exim user. The keytab file needs to be readable by the Exim user.
25611 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25612 environment variable.  In practice, for those releases, the Cyrus authenticator
25613 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25614 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25615
25616
25617 .section "Using cyrus_sasl as a server" "SECID178"
25618 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25619 (on a successful authentication) into &$auth1$&. For compatibility with
25620 previous releases of Exim, the username is also placed in &$1$&. However, the
25621 use of this variable for this purpose is now deprecated, as it can lead to
25622 confusion in string expansions that also use numeric variables for other
25623 things.
25624
25625
25626 .option server_hostname cyrus_sasl string&!! "see below"
25627 This option selects the hostname that is used when communicating with the
25628 library. The default value is &`$primary_hostname`&. It is up to the underlying
25629 SASL plug-in what it does with this data.
25630
25631
25632 .option server_mech cyrus_sasl string "see below"
25633 This option selects the authentication mechanism this driver should use. The
25634 default is the value of the generic &%public_name%& option. This option allows
25635 you to use a different underlying mechanism from the advertised name. For
25636 example:
25637 .code
25638 sasl:
25639   driver = cyrus_sasl
25640   public_name = X-ANYTHING
25641   server_mech = CRAM-MD5
25642   server_set_id = $auth1
25643 .endd
25644
25645 .option server_realm cyrus_sasl string&!! unset
25646 This specifies the SASL realm that the server claims to be in.
25647
25648
25649 .option server_service cyrus_sasl string &`smtp`&
25650 This is the SASL service that the server claims to implement.
25651
25652
25653 For straightforward cases, you do not need to set any of the authenticator's
25654 private options. All you need to do is to specify an appropriate mechanism as
25655 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25656 PLAIN, you could have two authenticators as follows:
25657 .code
25658 sasl_cram_md5:
25659   driver = cyrus_sasl
25660   public_name = CRAM-MD5
25661   server_set_id = $auth1
25662
25663 sasl_plain:
25664   driver = cyrus_sasl
25665   public_name = PLAIN
25666   server_set_id = $auth2
25667 .endd
25668 Cyrus SASL does implement the LOGIN authentication method, even though it is
25669 not a standard method. It is disabled by default in the source distribution,
25670 but it is present in many binary distributions.
25671 .ecindex IIDcyrauth1
25672 .ecindex IIDcyrauth2
25673
25674
25675
25676
25677 . ////////////////////////////////////////////////////////////////////////////
25678 . ////////////////////////////////////////////////////////////////////////////
25679 .chapter "The dovecot authenticator" "CHAPdovecot"
25680 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25681 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25682 This authenticator is an interface to the authentication facility of the
25683 Dovecot POP/IMAP server, which can support a number of authentication methods.
25684 Note that Dovecot must be configured to use auth-client not auth-userdb.
25685 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25686 to use the same mechanisms for SMTP authentication. This is a server
25687 authenticator only. There is only one option:
25688
25689 .option server_socket dovecot string unset
25690
25691 This option must specify the socket that is the interface to Dovecot
25692 authentication. The &%public_name%& option must specify an authentication
25693 mechanism that Dovecot is configured to support. You can have several
25694 authenticators for different mechanisms. For example:
25695 .code
25696 dovecot_plain:
25697   driver = dovecot
25698   public_name = PLAIN
25699   server_socket = /var/run/dovecot/auth-client
25700   server_set_id = $auth1
25701
25702 dovecot_ntlm:
25703   driver = dovecot
25704   public_name = NTLM
25705   server_socket = /var/run/dovecot/auth-client
25706   server_set_id = $auth1
25707 .endd
25708 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25709 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25710 option is passed in the Dovecot authentication command. If, for a TLS
25711 connection, a client certificate has been verified, the &"valid-client-cert"&
25712 option is passed. When authentication succeeds, the identity of the user
25713 who authenticated is placed in &$auth1$&.
25714 .ecindex IIDdcotauth1
25715 .ecindex IIDdcotauth2
25716
25717
25718 . ////////////////////////////////////////////////////////////////////////////
25719 . ////////////////////////////////////////////////////////////////////////////
25720 .chapter "The gsasl authenticator" "CHAPgsasl"
25721 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25722 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25723 .cindex "authentication" "GNU SASL"
25724 .cindex "authentication" "SASL"
25725 .cindex "authentication" "EXTERNAL"
25726 .cindex "authentication" "ANONYMOUS"
25727 .cindex "authentication" "PLAIN"
25728 .cindex "authentication" "LOGIN"
25729 .cindex "authentication" "DIGEST-MD5"
25730 .cindex "authentication" "CRAM-MD5"
25731 .cindex "authentication" "SCRAM-SHA-1"
25732 The &(gsasl)& authenticator provides server integration for the GNU SASL
25733 library and the mechanisms it provides.  This is new as of the 4.80 release
25734 and there are a few areas where the library does not let Exim smoothly
25735 scale to handle future authentication mechanisms, so no guarantee can be
25736 made that any particular new authentication mechanism will be supported
25737 without code changes in Exim.
25738
25739
25740 .option server_channelbinding gsasl boolean false
25741 Some authentication mechanisms are able to use external context at both ends
25742 of the session to bind the authentication to that context, and fail the
25743 authentication process if that context differs.  Specifically, some TLS
25744 ciphersuites can provide identifying information about the cryptographic
25745 context.
25746
25747 This means that certificate identity and verification becomes a non-issue,
25748 as a man-in-the-middle attack will cause the correct client and server to
25749 see different identifiers and authentication will fail.
25750
25751 This is currently only supported when using the GnuTLS library.  This is
25752 only usable by mechanisms which support "channel binding"; at time of
25753 writing, that's the SCRAM family.
25754
25755 This defaults off to ensure smooth upgrade across Exim releases, in case
25756 this option causes some clients to start failing.  Some future release
25757 of Exim may switch the default to be true.
25758
25759
25760 .option server_hostname gsasl string&!! "see below"
25761 This option selects the hostname that is used when communicating with the
25762 library. The default value is &`$primary_hostname`&.
25763 Some mechanisms will use this data.
25764
25765
25766 .option server_mech gsasl string "see below"
25767 This option selects the authentication mechanism this driver should use. The
25768 default is the value of the generic &%public_name%& option. This option allows
25769 you to use a different underlying mechanism from the advertised name. For
25770 example:
25771 .code
25772 sasl:
25773   driver = gsasl
25774   public_name = X-ANYTHING
25775   server_mech = CRAM-MD5
25776   server_set_id = $auth1
25777 .endd
25778
25779
25780 .option server_password gsasl string&!! unset
25781 Various mechanisms need access to the cleartext password on the server, so
25782 that proof-of-possession can be demonstrated on the wire, without sending
25783 the password itself.
25784
25785 The data available for lookup varies per mechanism.
25786 In all cases, &$auth1$& is set to the &'authentication id'&.
25787 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25788 if available, else the empty string.
25789 The &$auth3$& variable will always be the &'realm'& if available,
25790 else the empty string.
25791
25792 A forced failure will cause authentication to defer.
25793
25794 If using this option, it may make sense to set the &%server_condition%&
25795 option to be simply "true".
25796
25797
25798 .option server_realm gsasl string&!! unset
25799 This specifies the SASL realm that the server claims to be in.
25800 Some mechanisms will use this data.
25801
25802
25803 .option server_scram_iter gsasl string&!! unset
25804 This option provides data for the SCRAM family of mechanisms.
25805 &$auth1$& is not available at evaluation time.
25806 (This may change, as we receive feedback on use)
25807
25808
25809 .option server_scram_salt gsasl string&!! unset
25810 This option provides data for the SCRAM family of mechanisms.
25811 &$auth1$& is not available at evaluation time.
25812 (This may change, as we receive feedback on use)
25813
25814
25815 .option server_service gsasl string &`smtp`&
25816 This is the SASL service that the server claims to implement.
25817 Some mechanisms will use this data.
25818
25819
25820 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25821 .vindex "&$auth1$&, &$auth2$&, etc"
25822 These may be set when evaluating specific options, as detailed above.
25823 They will also be set when evaluating &%server_condition%&.
25824
25825 Unless otherwise stated below, the &(gsasl)& integration will use the following
25826 meanings for these variables:
25827
25828 .ilist
25829 .vindex "&$auth1$&"
25830 &$auth1$&: the &'authentication id'&
25831 .next
25832 .vindex "&$auth2$&"
25833 &$auth2$&: the &'authorization id'&
25834 .next
25835 .vindex "&$auth3$&"
25836 &$auth3$&: the &'realm'&
25837 .endlist
25838
25839 On a per-mechanism basis:
25840
25841 .ilist
25842 .cindex "authentication" "EXTERNAL"
25843 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25844 the &%server_condition%& option must be present.
25845 .next
25846 .cindex "authentication" "ANONYMOUS"
25847 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25848 the &%server_condition%& option must be present.
25849 .next
25850 .cindex "authentication" "GSSAPI"
25851 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25852 &$auth2$& will be set to the &'authorization id'&,
25853 the &%server_condition%& option must be present.
25854 .endlist
25855
25856 An &'anonymous token'& is something passed along as an unauthenticated
25857 identifier; this is analogous to FTP anonymous authentication passing an
25858 email address, or software-identifier@, as the "password".
25859
25860
25861 An example showing the password having the realm specified in the callback
25862 and demonstrating a Cyrus SASL to GSASL migration approach is:
25863 .code
25864 gsasl_cyrusless_crammd5:
25865   driver = gsasl
25866   public_name = CRAM-MD5
25867   server_realm = imap.example.org
25868   server_password = ${lookup{$auth1:$auth3:userPassword}\
25869                     dbmjz{/etc/sasldb2}{$value}fail}
25870   server_set_id = ${quote:$auth1}
25871   server_condition = yes
25872 .endd
25873
25874
25875 . ////////////////////////////////////////////////////////////////////////////
25876 . ////////////////////////////////////////////////////////////////////////////
25877
25878 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25879 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25880 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25881 .cindex "authentication" "GSSAPI"
25882 .cindex "authentication" "Kerberos"
25883 The &(heimdal_gssapi)& authenticator provides server integration for the
25884 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25885 reliably.
25886
25887 .option server_hostname heimdal_gssapi string&!! "see below"
25888 This option selects the hostname that is used, with &%server_service%&,
25889 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25890 identifier.  The default value is &`$primary_hostname`&.
25891
25892 .option server_keytab heimdal_gssapi string&!! unset
25893 If set, then Heimdal will not use the system default keytab (typically
25894 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25895 The value should be a pathname, with no &"file:"& prefix.
25896
25897 .option server_service heimdal_gssapi string&!! "smtp"
25898 This option specifies the service identifier used, in conjunction with
25899 &%server_hostname%&, for building the identifer for finding credentials
25900 from the keytab.
25901
25902
25903 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25904 Beware that these variables will typically include a realm, thus will appear
25905 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25906 not verified, so a malicious client can set it to anything.
25907
25908 The &$auth1$& field should be safely trustable as a value from the Key
25909 Distribution Center.  Note that these are not quite email addresses.
25910 Each identifier is for a role, and so the left-hand-side may include a
25911 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25912
25913 .vindex "&$auth1$&, &$auth2$&, etc"
25914 .ilist
25915 .vindex "&$auth1$&"
25916 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25917 .next
25918 .vindex "&$auth2$&"
25919 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25920 authentication.  If that was empty, this will also be set to the
25921 GSS Display Name.
25922 .endlist
25923
25924
25925 . ////////////////////////////////////////////////////////////////////////////
25926 . ////////////////////////////////////////////////////////////////////////////
25927
25928 .chapter "The spa authenticator" "CHAPspa"
25929 .scindex IIDspaauth1 "&(spa)& authenticator"
25930 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25931 .cindex "authentication" "Microsoft Secure Password"
25932 .cindex "authentication" "NTLM"
25933 .cindex "Microsoft Secure Password Authentication"
25934 .cindex "NTLM authentication"
25935 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25936 Password Authentication'& mechanism,
25937 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25938 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25939 taken from the Samba project (&url(http://www.samba.org)). The code for the
25940 server side was subsequently contributed by Tom Kistner. The mechanism works as
25941 follows:
25942
25943 .ilist
25944 After the AUTH command has been accepted, the client sends an SPA
25945 authentication request based on the user name and optional domain.
25946 .next
25947 The server sends back a challenge.
25948 .next
25949 The client builds a challenge response which makes use of the user's password
25950 and sends it to the server, which then accepts or rejects it.
25951 .endlist
25952
25953 Encryption is used to protect the password in transit.
25954
25955
25956
25957 .section "Using spa as a server" "SECID179"
25958 .cindex "options" "&(spa)& authenticator (server)"
25959 The &(spa)& authenticator has just one server option:
25960
25961 .option server_password spa string&!! unset
25962 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25963 This option is expanded, and the result must be the cleartext password for the
25964 authenticating user, whose name is at this point in &$auth1$&. For
25965 compatibility with previous releases of Exim, the user name is also placed in
25966 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25967 it can lead to confusion in string expansions that also use numeric variables
25968 for other things. For example:
25969 .code
25970 spa:
25971   driver = spa
25972   public_name = NTLM
25973   server_password = \
25974     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25975 .endd
25976 If the expansion is forced to fail, authentication fails. Any other expansion
25977 failure causes a temporary error code to be returned.
25978
25979
25980
25981
25982
25983 .section "Using spa as a client" "SECID180"
25984 .cindex "options" "&(spa)& authenticator (client)"
25985 The &(spa)& authenticator has the following client options:
25986
25987
25988
25989 .option client_domain spa string&!! unset
25990 This option specifies an optional domain for the authentication.
25991
25992
25993 .option client_password spa string&!! unset
25994 This option specifies the user's password, and must be set.
25995
25996
25997 .option client_username spa string&!! unset
25998 This option specifies the user name, and must be set. Here is an example of a
25999 configuration of this authenticator for use with the mail servers at
26000 &'msn.com'&:
26001 .code
26002 msn:
26003   driver = spa
26004   public_name = MSN
26005   client_username = msn/msn_username
26006   client_password = msn_plaintext_password
26007   client_domain = DOMAIN_OR_UNSET
26008 .endd
26009 .ecindex IIDspaauth1
26010 .ecindex IIDspaauth2
26011
26012
26013
26014
26015
26016 . ////////////////////////////////////////////////////////////////////////////
26017 . ////////////////////////////////////////////////////////////////////////////
26018
26019 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26020          "Encrypted SMTP connections"
26021 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26022 .scindex IIDencsmtp2 "SMTP" "encryption"
26023 .cindex "TLS" "on SMTP connection"
26024 .cindex "OpenSSL"
26025 .cindex "GnuTLS"
26026 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26027 Sockets Layer), is implemented by making use of the OpenSSL library or the
26028 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26029 cryptographic code in the Exim distribution itself for implementing TLS. In
26030 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26031 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26032 You also need to understand the basic concepts of encryption at a managerial
26033 level, and in particular, the way that public keys, private keys, and
26034 certificates are used.
26035
26036 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26037 connection is established, the client issues a STARTTLS command. If the
26038 server accepts this, the client and the server negotiate an encryption
26039 mechanism. If the negotiation succeeds, the data that subsequently passes
26040 between them is encrypted.
26041
26042 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26043 and if so, what cipher suite is in use, whether the client supplied a
26044 certificate, and whether or not that certificate was verified. This makes it
26045 possible for an Exim server to deny or accept certain commands based on the
26046 encryption state.
26047
26048 &*Warning*&: Certain types of firewall and certain anti-virus products can
26049 disrupt TLS connections. You need to turn off SMTP scanning for these products
26050 in order to get TLS to work.
26051
26052
26053
26054 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26055          "SECID284"
26056 .cindex "ssmtp protocol"
26057 .cindex "smtps protocol"
26058 .cindex "SMTP" "ssmtp protocol"
26059 .cindex "SMTP" "smtps protocol"
26060 Early implementations of encrypted SMTP used a different TCP port from normal
26061 SMTP, and expected an encryption negotiation to start immediately, instead of
26062 waiting for a STARTTLS command from the client using the standard SMTP
26063 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26064 allocated for this purpose.
26065
26066 This approach was abandoned when encrypted SMTP was standardized, but there are
26067 still some legacy clients that use it. Exim supports these clients by means of
26068 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26069 numbers; the most common use is expected to be:
26070 .code
26071 tls_on_connect_ports = 465
26072 .endd
26073 The port numbers specified by this option apply to all SMTP connections, both
26074 via the daemon and via &'inetd'&. You still need to specify all the ports that
26075 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26076 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26077 an extra port &-- rather, it specifies different behaviour on a port that is
26078 defined elsewhere.
26079
26080 There is also a &%-tls-on-connect%& command line option. This overrides
26081 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26082
26083
26084
26085
26086
26087
26088 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26089 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26090 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26091 followed later, when the first versions of GnuTLS were released. To build Exim
26092 to use GnuTLS, you need to set
26093 .code
26094 USE_GNUTLS=yes
26095 .endd
26096 in Local/Makefile, in addition to
26097 .code
26098 SUPPORT_TLS=yes
26099 .endd
26100 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26101 include files and libraries for GnuTLS can be found.
26102
26103 There are some differences in usage when using GnuTLS instead of OpenSSL:
26104
26105 .ilist
26106 The &%tls_verify_certificates%& option
26107 cannot be the path of a directory
26108 for GnuTLS versions before 3.3.6
26109 (for later versions, or OpenSSL, it can be either).
26110 .next
26111 The default value for &%tls_dhparam%& differs for historical reasons.
26112 .next
26113 .vindex "&$tls_in_peerdn$&"
26114 .vindex "&$tls_out_peerdn$&"
26115 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26116 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26117 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26118 .next
26119 OpenSSL identifies cipher suites using hyphens as separators, for example:
26120 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26121 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26122 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26123 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26124 to handle its own older variants) when processing lists of cipher suites in the
26125 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26126 option).
26127 .next
26128 The &%tls_require_ciphers%& options operate differently, as described in the
26129 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26130 .next
26131 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26132 When using OpenSSL, this option is ignored.
26133 (If an API is found to let OpenSSL be configured in this way,
26134 let the Exim Maintainers know and we'll likely use it).
26135 .next
26136 Some other recently added features may only be available in one or the other.
26137 This should be documented with the feature.  If the documentation does not
26138 explicitly state that the feature is infeasible in the other TLS
26139 implementation, then patches are welcome.
26140 .endlist
26141
26142
26143 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26144 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26145 an explicit path; if the latter, then the text about generation still applies,
26146 but not the chosen filename.
26147 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26148 See the documentation of &%tls_dhparam%& for more information.
26149
26150 GnuTLS uses D-H parameters that may take a substantial amount of time
26151 to compute. It is unreasonable to re-compute them for every TLS session.
26152 Therefore, Exim keeps this data in a file in its spool directory, called
26153 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26154 of bits requested.
26155 The file is owned by the Exim user and is readable only by
26156 its owner. Every Exim process that start up GnuTLS reads the D-H
26157 parameters from this file. If the file does not exist, the first Exim process
26158 that needs it computes the data and writes it to a temporary file which is
26159 renamed once it is complete. It does not matter if several Exim processes do
26160 this simultaneously (apart from wasting a few resources). Once a file is in
26161 place, new Exim processes immediately start using it.
26162
26163 For maximum security, the parameters that are stored in this file should be
26164 recalculated periodically, the frequency depending on your paranoia level.
26165 If you are avoiding using the fixed D-H primes published in RFCs, then you
26166 are concerned about some advanced attacks and will wish to do this; if you do
26167 not regenerate then you might as well stick to the standard primes.
26168
26169 Arranging this is easy in principle; just delete the file when you want new
26170 values to be computed. However, there may be a problem. The calculation of new
26171 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26172 If the system is not very active, &_/dev/random_& may delay returning data
26173 until enough randomness (entropy) is available. This may cause Exim to hang for
26174 a substantial amount of time, causing timeouts on incoming connections.
26175
26176 The solution is to generate the parameters externally to Exim. They are stored
26177 in &_gnutls-params-N_& in PEM format, which means that they can be
26178 generated externally using the &(certtool)& command that is part of GnuTLS.
26179
26180 To replace the parameters with new ones, instead of deleting the file
26181 and letting Exim re-create it, you can generate new parameters using
26182 &(certtool)& and, when this has been done, replace Exim's cache file by
26183 renaming. The relevant commands are something like this:
26184 .code
26185 # ls
26186 [ look for file; assume gnutls-params-2236 is the most recent ]
26187 # rm -f new-params
26188 # touch new-params
26189 # chown exim:exim new-params
26190 # chmod 0600 new-params
26191 # certtool --generate-dh-params --bits 2236 >>new-params
26192 # openssl dhparam -noout -text -in new-params | head
26193 [ check the first line, make sure it's not more than 2236;
26194   if it is, then go back to the start ("rm") and repeat
26195   until the size generated is at most the size requested ]
26196 # chmod 0400 new-params
26197 # mv new-params gnutls-params-2236
26198 .endd
26199 If Exim never has to generate the parameters itself, the possibility of
26200 stalling is removed.
26201
26202 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26203 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26204 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26205 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26206 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26207 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26208 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26209 which applies to all D-H usage, client or server.  If the value returned by
26210 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26211 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26212 limit, which is still much higher than Exim historically used.
26213
26214 The filename and bits used will change as the GnuTLS maintainers change the
26215 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26216 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26217 2432 bits, while NSS is limited to 2236 bits.
26218
26219 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26220 increase the chance of the generated prime actually being within acceptable
26221 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26222 procedure above.  There is no sane procedure available to Exim to double-check
26223 the size of the generated prime, so it might still be too large.
26224
26225
26226 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26227 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26228 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26229 There is a function in the OpenSSL library that can be passed a list of cipher
26230 suites before the cipher negotiation takes place. This specifies which ciphers
26231 are acceptable. The list is colon separated and may contain names like
26232 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26233 directly to this function call.
26234 Many systems will install the OpenSSL manual-pages, so you may have
26235 &'ciphers(1)'& available to you.
26236 The following quotation from the OpenSSL
26237 documentation specifies what forms of item are allowed in the cipher string:
26238
26239 .ilist
26240 It can consist of a single cipher suite such as RC4-SHA.
26241 .next
26242 It can represent a list of cipher suites containing a certain algorithm,
26243 or cipher suites of a certain type. For example SHA1 represents all
26244 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26245 SSL v3 algorithms.
26246 .next
26247 Lists of cipher suites can be combined in a single cipher string using
26248 the + character. This is used as a logical and operation. For example
26249 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26250 algorithms.
26251 .endlist
26252
26253 Each cipher string can be optionally preceded by one of the characters &`!`&,
26254 &`-`& or &`+`&.
26255 .ilist
26256 If &`!`& is used, the ciphers are permanently deleted from the list. The
26257 ciphers deleted can never reappear in the list even if they are explicitly
26258 stated.
26259 .next
26260 If &`-`& is used, the ciphers are deleted from the list, but some or all
26261 of the ciphers can be added again by later options.
26262 .next
26263 If &`+`& is used, the ciphers are moved to the end of the list. This
26264 option does not add any new ciphers; it just moves matching existing ones.
26265 .endlist
26266
26267 If none of these characters is present, the string is interpreted as
26268 a list of ciphers to be appended to the current preference list. If the list
26269 includes any ciphers already present they will be ignored: that is, they will
26270 not be moved to the end of the list.
26271 .endlist
26272
26273 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26274 string:
26275 .code
26276 # note single-quotes to get ! past any shell history expansion
26277 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26278 .endd
26279
26280 This example will let the library defaults be permitted on the MX port, where
26281 there's probably no identity verification anyway, but ups the ante on the
26282 submission ports where the administrator might have some influence on the
26283 choice of clients used:
26284 .code
26285 # OpenSSL variant; see man ciphers(1)
26286 tls_require_ciphers = ${if =={$received_port}{25}\
26287                            {DEFAULT}\
26288                            {HIGH:!MD5:!SHA1}}
26289 .endd
26290
26291
26292
26293 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26294          "SECTreqciphgnu"
26295 .cindex "GnuTLS" "specifying parameters for"
26296 .cindex "TLS" "specifying ciphers (GnuTLS)"
26297 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26298 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26299 .cindex "TLS" "specifying protocols (GnuTLS)"
26300 .cindex "TLS" "specifying priority string (GnuTLS)"
26301 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26302 The GnuTLS library allows the caller to provide a "priority string", documented
26303 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26304 ciphersuite specification in OpenSSL.
26305
26306 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26307 and controls both protocols and ciphers.
26308
26309 The &%tls_require_ciphers%& option is available both as an global option,
26310 controlling how Exim behaves as a server, and also as an option of the
26311 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26312 the value is string expanded.  The resulting string is not an Exim list and
26313 the string is given to the GnuTLS library, so that Exim does not need to be
26314 aware of future feature enhancements of GnuTLS.
26315
26316 Documentation of the strings accepted may be found in the GnuTLS manual, under
26317 "Priority strings".  This is online as
26318 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26319 but beware that this relates to GnuTLS 3, which may be newer than the version
26320 installed on your system.  If you are using GnuTLS 3,
26321 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26322 on that site can be used to test a given string.
26323
26324 For example:
26325 .code
26326 # Disable older versions of protocols
26327 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26328 .endd
26329
26330 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26331 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26332 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26333
26334 This example will let the library defaults be permitted on the MX port, where
26335 there's probably no identity verification anyway, and lowers security further
26336 by increasing compatibility; but this ups the ante on the submission ports
26337 where the administrator might have some influence on the choice of clients
26338 used:
26339 .code
26340 # GnuTLS variant
26341 tls_require_ciphers = ${if =={$received_port}{25}\
26342                            {NORMAL:%COMPAT}\
26343                            {SECURE128}}
26344 .endd
26345
26346
26347 .section "Configuring an Exim server to use TLS" "SECID182"
26348 .cindex "TLS" "configuring an Exim server"
26349 When Exim has been built with TLS support, it advertises the availability of
26350 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26351 but not to any others. The default value of this option is unset, which means
26352 that STARTTLS is not advertised at all. This default is chosen because you
26353 need to set some other options in order to make TLS available, and also it is
26354 sensible for systems that want to use TLS only as a client.
26355
26356 If a client issues a STARTTLS command and there is some configuration
26357 problem in the server, the command is rejected with a 454 error. If the client
26358 persists in trying to issue SMTP commands, all except QUIT are rejected
26359 with the error
26360 .code
26361 554 Security failure
26362 .endd
26363 If a STARTTLS command is issued within an existing TLS session, it is
26364 rejected with a 554 error code.
26365
26366 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26367 match some hosts. You can, of course, set it to * to match all hosts.
26368 However, this is not all you need to do. TLS sessions to a server won't work
26369 without some further configuration at the server end.
26370
26371 It is rumoured that all existing clients that support TLS/SSL use RSA
26372 encryption. To make this work you need to set, in the server,
26373 .code
26374 tls_certificate = /some/file/name
26375 tls_privatekey = /some/file/name
26376 .endd
26377 These options are, in fact, expanded strings, so you can make them depend on
26378 the identity of the client that is connected if you wish. The first file
26379 contains the server's X509 certificate, and the second contains the private key
26380 that goes with it. These files need to be
26381 PEM format and readable by the Exim user, and must
26382 always be given as full path names.
26383 The key must not be password-protected.
26384 They can be the same file if both the
26385 certificate and the key are contained within it. If &%tls_privatekey%& is not
26386 set, or if its expansion is forced to fail or results in an empty string, this
26387 is assumed to be the case. The certificate file may also contain intermediate
26388 certificates that need to be sent to the client to enable it to authenticate
26389 the server's certificate.
26390
26391 If you do not understand about certificates and keys, please try to find a
26392 source of this background information, which is not Exim-specific. (There are a
26393 few comments below in section &<<SECTcerandall>>&.)
26394
26395 &*Note*&: These options do not apply when Exim is operating as a client &--
26396 they apply only in the case of a server. If you need to use a certificate in an
26397 Exim client, you must set the options of the same names in an &(smtp)&
26398 transport.
26399
26400 With just these options, an Exim server will be able to use TLS. It does not
26401 require the client to have a certificate (but see below for how to insist on
26402 this). There is one other option that may be needed in other situations. If
26403 .code
26404 tls_dhparam = /some/file/name
26405 .endd
26406 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26407 with the parameters contained in the file.
26408 Set this to &`none`& to disable use of DH entirely, by making no prime
26409 available:
26410 .code
26411 tls_dhparam = none
26412 .endd
26413 This may also be set to a string identifying a standard prime to be used for
26414 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26415 used is &`ike23`&.  There are a few standard primes available, see the
26416 documentation for &%tls_dhparam%& for the complete list.
26417
26418 See the command
26419 .code
26420 openssl dhparam
26421 .endd
26422 for a way of generating file data.
26423
26424 The strings supplied for these three options are expanded every time a client
26425 host connects. It is therefore possible to use different certificates and keys
26426 for different hosts, if you so wish, by making use of the client's IP address
26427 in &$sender_host_address$& to control the expansion. If a string expansion is
26428 forced to fail, Exim behaves as if the option is not set.
26429
26430 .cindex "cipher" "logging"
26431 .cindex "log" "TLS cipher"
26432 .vindex "&$tls_in_cipher$&"
26433 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26434 an incoming TLS connection. It is included in the &'Received:'& header of an
26435 incoming message (by default &-- you can, of course, change this), and it is
26436 also included in the log line that records a message's arrival, keyed by
26437 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26438 condition can be used to test for specific cipher suites in ACLs.
26439
26440 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26441 can check the name of the cipher suite and vary their actions accordingly. The
26442 cipher suite names vary, depending on which TLS library is being used. For
26443 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26444 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26445 documentation for more details.
26446
26447 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26448 (again depending on the &%tls_cipher%& log selector).
26449
26450
26451 .section "Requesting and verifying client certificates" "SECID183"
26452 .cindex "certificate" "verification of client"
26453 .cindex "TLS" "client certificate verification"
26454 If you want an Exim server to request a certificate when negotiating a TLS
26455 session with a client, you must set either &%tls_verify_hosts%& or
26456 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26457 apply to all TLS connections. For any host that matches one of these options,
26458 Exim requests a certificate as part of the setup of the TLS session. The
26459 contents of the certificate are verified by comparing it with a list of
26460 expected certificates.
26461 .new
26462 These may be the system default set (depending on library version),
26463 .wen
26464 an explicit file or,
26465 depending on library version, a directory, identified by
26466 &%tls_verify_certificates%&.
26467
26468 A file can contain multiple certificates, concatenated end to end. If a
26469 directory is used
26470 (OpenSSL only),
26471 each certificate must be in a separate file, with a name (or a symbolic link)
26472 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26473 certificate. You can compute the relevant hash by running the command
26474 .code
26475 openssl x509 -hash -noout -in /cert/file
26476 .endd
26477 where &_/cert/file_& contains a single certificate.
26478
26479 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26480 what happens if the client does not supply a certificate, or if the certificate
26481 does not match any of the certificates in the collection named by
26482 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26483 attempt to set up a TLS session is aborted, and the incoming connection is
26484 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26485 session continues. ACLs that run for subsequent SMTP commands can detect the
26486 fact that no certificate was verified, and vary their actions accordingly. For
26487 example, you can insist on a certificate before accepting a message for
26488 relaying, but not when the message is destined for local delivery.
26489
26490 .vindex "&$tls_in_peerdn$&"
26491 When a client supplies a certificate (whether it verifies or not), the value of
26492 the Distinguished Name of the certificate is made available in the variable
26493 &$tls_in_peerdn$& during subsequent processing of the message.
26494
26495 .cindex "log" "distinguished name"
26496 Because it is often a long text string, it is not included in the log line or
26497 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26498 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26499 &%received_header_text%& to change the &'Received:'& header. When no
26500 certificate is supplied, &$tls_in_peerdn$& is empty.
26501
26502
26503 .section "Revoked certificates" "SECID184"
26504 .cindex "TLS" "revoked certificates"
26505 .cindex "revocation list"
26506 .cindex "certificate" "revocation list"
26507 .cindex "OCSP" "stapling"
26508 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26509 certificates are revoked. If you have such a list, you can pass it to an Exim
26510 server using the global option called &%tls_crl%& and to an Exim client using
26511 an identically named option for the &(smtp)& transport. In each case, the value
26512 of the option is expanded and must then be the name of a file that contains a
26513 CRL in PEM format.
26514 The downside is that clients have to periodically re-download a potentially huge
26515 file from every certificate authority they know of.
26516
26517 The way with most moving parts at query time is Online Certificate
26518 Status Protocol (OCSP), where the client verifies the certificate
26519 against an OCSP server run by the CA.  This lets the CA track all
26520 usage of the certs.  It requires running software with access to the
26521 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26522 is based on HTTP and can be proxied accordingly.
26523
26524 The only widespread OCSP server implementation (known to this writer)
26525 comes as part of OpenSSL and aborts on an invalid request, such as
26526 connecting to the port and then disconnecting.  This requires
26527 re-entering the passphrase each time some random client does this.
26528
26529 The third way is OCSP Stapling; in this, the server using a certificate
26530 issued by the CA periodically requests an OCSP proof of validity from
26531 the OCSP server, then serves it up inline as part of the TLS
26532 negotiation.   This approach adds no extra round trips, does not let the
26533 CA track users, scales well with number of certs issued by the CA and is
26534 resilient to temporary OCSP server failures, as long as the server
26535 starts retrying to fetch an OCSP proof some time before its current
26536 proof expires.  The downside is that it requires server support.
26537
26538 Unless Exim is built with the support disabled,
26539 or with GnuTLS earlier than version 3.1.3,
26540 support for OCSP stapling is included.
26541
26542 There is a global option called &%tls_ocsp_file%&.
26543 The file specified therein is expected to be in DER format, and contain
26544 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26545 option will be re-expanded for SNI, if the &%tls_certificate%& option
26546 contains &`tls_in_sni`&, as per other TLS options.
26547
26548 Exim does not at this time implement any support for fetching a new OCSP
26549 proof.  The burden is on the administrator to handle this, outside of
26550 Exim.  The file specified should be replaced atomically, so that the
26551 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26552 on each connection, so a new file will be handled transparently on the
26553 next connection.
26554
26555 When built with OpenSSL Exim will check for a valid next update timestamp
26556 in the OCSP proof; if not present, or if the proof has expired, it will be
26557 ignored.
26558
26559 For the client to be able to verify the stapled OCSP the server must
26560 also supply, in its stapled information, any intermediate
26561 certificates for the chain leading to the OCSP proof from the signer
26562 of the server certificate.  There may be zero or one such. These
26563 intermediate certificates should be added to the server OCSP stapling
26564 file named by &%tls_ocsp_file%&.
26565
26566 Note that the proof only covers the terminal server certificate,
26567 not any of the chain from CA to it.
26568
26569 There is no current way to staple a proof for a client certificate.
26570
26571 .code
26572   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26573   OCSP server is supplied.  The server URL may be included in the
26574   server certificate, if the CA is helpful.
26575
26576   One failure mode seen was the OCSP Signer cert expiring before the end
26577   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26578   noted this as invalid overall, but the re-fetch script did not.
26579 .endd
26580
26581
26582
26583
26584 .section "Configuring an Exim client to use TLS" "SECID185"
26585 .cindex "cipher" "logging"
26586 .cindex "log" "TLS cipher"
26587 .cindex "log" "distinguished name"
26588 .cindex "TLS" "configuring an Exim client"
26589 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26590 deliveries as well as to incoming, the latter one causing logging of the
26591 server certificate's DN. The remaining client configuration for TLS is all
26592 within the &(smtp)& transport.
26593
26594 It is not necessary to set any options to have TLS work in the &(smtp)&
26595 transport. If Exim is built with TLS support, and TLS is advertised by a
26596 server, the &(smtp)& transport always tries to start a TLS session. However,
26597 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26598 transport) to a list of server hosts for which TLS should not be used.
26599
26600 If you do not want Exim to attempt to send messages unencrypted when an attempt
26601 to set up an encrypted connection fails in any way, you can set
26602 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26603 those hosts, delivery is always deferred if an encrypted connection cannot be
26604 set up. If there are any other hosts for the address, they are tried in the
26605 usual way.
26606
26607 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26608 the message unencrypted. It always does this if the response to STARTTLS is
26609 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26610 session after a success response code, what happens is controlled by the
26611 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26612 delivery to this host is deferred, and other hosts (if available) are tried. If
26613 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26614 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26615 negotiation fails, Exim closes the current connection (because it is in an
26616 unknown state), opens a new one to the same host, and then tries the delivery
26617 unencrypted.
26618
26619 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26620 transport provide the client with a certificate, which is passed to the server
26621 if it requests it. If the server is Exim, it will request a certificate only if
26622 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26623
26624 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26625 specifies a collection of expected server certificates.
26626 .new
26627 These may be the system default set (depending on library version),
26628 .wen
26629 a file or,
26630 depnding on liibrary version, a directory,
26631 must name a file or,
26632 for OpenSSL only (not GnuTLS), a directory.
26633 The client verifies the server's certificate
26634 against this collection, taking into account any revoked certificates that are
26635 in the list defined by &%tls_crl%&.
26636 Failure to verify fails the TLS connection unless either of the
26637 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26638
26639 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26640 certificate verification to the listed servers.  Verification either must
26641 or need not succeed respectively.
26642
26643 The &(smtp)& transport has two OCSP-related options:
26644 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26645 is requested and required for the connection to proceed.  The default
26646 value is empty.
26647 &%hosts_request_ocsp%&; a host-list for which (additionally)
26648 a Certificate Status is requested (but not necessarily verified).  The default
26649 value is "*" meaning that requests are made unless configured
26650 otherwise.
26651
26652 The host(s) should also be in &%hosts_require_tls%&, and
26653 &%tls_verify_certificates%& configured for the transport,
26654 for OCSP to be relevant.
26655
26656 If
26657 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26658 list of permitted cipher suites. If either of these checks fails, delivery to
26659 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26660 alternative hosts, if any.
26661
26662  &*Note*&:
26663 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26664 is operating as a client. Exim does not assume that a server certificate (set
26665 by the global options of the same name) should also be used when operating as a
26666 client.
26667
26668 .vindex "&$host$&"
26669 .vindex "&$host_address$&"
26670 All the TLS options in the &(smtp)& transport are expanded before use, with
26671 &$host$& and &$host_address$& containing the name and address of the server to
26672 which the client is connected. Forced failure of an expansion causes Exim to
26673 behave as if the relevant option were unset.
26674
26675 .vindex &$tls_out_bits$&
26676 .vindex &$tls_out_cipher$&
26677 .vindex &$tls_out_peerdn$&
26678 .vindex &$tls_out_sni$&
26679 Before an SMTP connection is established, the
26680 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26681 variables are emptied. (Until the first connection, they contain the values
26682 that were set when the message was received.) If STARTTLS is subsequently
26683 successfully obeyed, these variables are set to the relevant values for the
26684 outgoing connection.
26685
26686
26687
26688 .section "Use of TLS Server Name Indication" "SECTtlssni"
26689 .cindex "TLS" "Server Name Indication"
26690 .vindex "&$tls_in_sni$&"
26691 .oindex "&%tls_in_sni%&"
26692 With TLS1.0 or above, there is an extension mechanism by which extra
26693 information can be included at various points in the protocol.  One of these
26694 extensions, documented in RFC 6066 (and before that RFC 4366) is
26695 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26696 client in the initial handshake, so that the server can examine the servername
26697 within and possibly choose to use different certificates and keys (and more)
26698 for this session.
26699
26700 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26701 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26702 address.
26703
26704 With SMTP to MX, there are the same problems here as in choosing the identity
26705 against which to validate a certificate: you can't rely on insecure DNS to
26706 provide the identity which you then cryptographically verify.  So this will
26707 be of limited use in that environment.
26708
26709 With SMTP to Submission, there is a well-defined hostname which clients are
26710 connecting to and can validate certificates against.  Thus clients &*can*&
26711 choose to include this information in the TLS negotiation.  If this becomes
26712 wide-spread, then hosters can choose to present different certificates to
26713 different clients.  Or even negotiate different cipher suites.
26714
26715 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26716 if not empty, will be sent on a TLS session as part of the handshake.  There's
26717 nothing more to it.  Choosing a sensible value not derived insecurely is the
26718 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26719 for the lifetime of the client connection (including during authentication).
26720
26721 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26722 received from a client.
26723 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26724
26725 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26726 option (prior to expansion) then the following options will be re-expanded
26727 during TLS session handshake, to permit alternative values to be chosen:
26728
26729 .ilist
26730 .vindex "&%tls_certificate%&"
26731 &%tls_certificate%&
26732 .next
26733 .vindex "&%tls_crl%&"
26734 &%tls_crl%&
26735 .next
26736 .vindex "&%tls_privatekey%&"
26737 &%tls_privatekey%&
26738 .next
26739 .vindex "&%tls_verify_certificates%&"
26740 &%tls_verify_certificates%&
26741 .next
26742 .vindex "&%tls_ocsp_file%&"
26743 &%tls_ocsp_file%&
26744 .endlist
26745
26746 Great care should be taken to deal with matters of case, various injection
26747 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26748 can always be referenced; it is important to remember that &$tls_sni$& is
26749 arbitrary unverified data provided prior to authentication.
26750
26751 The Exim developers are proceeding cautiously and so far no other TLS options
26752 are re-expanded.
26753
26754 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26755 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26756 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26757 see &`-servername`& in the output, then OpenSSL has support.
26758
26759 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26760 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26761 built, then you have SNI support).
26762
26763
26764
26765 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26766          "SECTmulmessam"
26767 .cindex "multiple SMTP deliveries with TLS"
26768 .cindex "TLS" "multiple message deliveries"
26769 Exim sends multiple messages down the same TCP/IP connection by starting up
26770 an entirely new delivery process for each message, passing the socket from
26771 one process to the next. This implementation does not fit well with the use
26772 of TLS, because there is quite a lot of state information associated with a TLS
26773 connection, not just a socket identification. Passing all the state information
26774 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26775 session before passing the socket to a new process. The new process may then
26776 try to start a new TLS session, and if successful, may try to re-authenticate
26777 if AUTH is in use, before sending the next message.
26778
26779 The RFC is not clear as to whether or not an SMTP session continues in clear
26780 after TLS has been shut down, or whether TLS may be restarted again later, as
26781 just described. However, if the server is Exim, this shutdown and
26782 reinitialization works. It is not known which (if any) other servers operate
26783 successfully if the client closes a TLS session and continues with unencrypted
26784 SMTP, but there are certainly some that do not work. For such servers, Exim
26785 should not pass the socket to another process, because the failure of the
26786 subsequent attempt to use it would cause Exim to record a temporary host error,
26787 and delay other deliveries to that host.
26788
26789 To test for this case, Exim sends an EHLO command to the server after
26790 closing down the TLS session. If this fails in any way, the connection is
26791 closed instead of being passed to a new delivery process, but no retry
26792 information is recorded.
26793
26794 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26795 &(smtp)& transport to match those hosts for which Exim should not pass
26796 connections to new processes if TLS has been used.
26797
26798
26799
26800
26801 .section "Certificates and all that" "SECTcerandall"
26802 .cindex "certificate" "references to discussion"
26803 In order to understand fully how TLS works, you need to know about
26804 certificates, certificate signing, and certificate authorities. This is not the
26805 place to give a tutorial, especially as I do not know very much about it
26806 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26807 to Apache, currently at
26808 .display
26809 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26810 .endd
26811 Other parts of the &'modssl'& documentation are also helpful, and have
26812 links to further files.
26813 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26814 0-201-61598-3), contains both introductory and more in-depth descriptions.
26815 Some sample programs taken from the book are available from
26816 .display
26817 &url(http://www.rtfm.com/openssl-examples/)
26818 .endd
26819
26820
26821 .section "Certificate chains" "SECID186"
26822 The file named by &%tls_certificate%& may contain more than one
26823 certificate. This is useful in the case where the certificate that is being
26824 sent is validated by an intermediate certificate which the other end does
26825 not have. Multiple certificates must be in the correct order in the file.
26826 First the host's certificate itself, then the first intermediate
26827 certificate to validate the issuer of the host certificate, then the next
26828 intermediate certificate to validate the issuer of the first intermediate
26829 certificate, and so on, until finally (optionally) the root certificate.
26830 The root certificate must already be trusted by the recipient for
26831 validation to succeed, of course, but if it's not preinstalled, sending the
26832 root certificate along with the rest makes it available for the user to
26833 install if the receiving end is a client MUA that can interact with a user.
26834
26835 Note that certificates using MD5 are unlikely to work on today's Internet;
26836 even if your libraries allow loading them for use in Exim when acting as a
26837 server, increasingly clients will not accept such certificates.  The error
26838 diagnostics in such a case can be frustratingly vague.
26839
26840
26841
26842 .section "Self-signed certificates" "SECID187"
26843 .cindex "certificate" "self-signed"
26844 You can create a self-signed certificate using the &'req'& command provided
26845 with OpenSSL, like this:
26846 . ==== Do not shorten the duration here without reading and considering
26847 . ==== the text below.  Please leave it at 9999 days.
26848 .code
26849 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26850             -days 9999 -nodes
26851 .endd
26852 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26853 delimited and so can be identified independently. The &%-days%& option
26854 specifies a period for which the certificate is valid. The &%-nodes%& option is
26855 important: if you do not set it, the key is encrypted with a passphrase
26856 that you are prompted for, and any use that is made of the key causes more
26857 prompting for the passphrase. This is not helpful if you are going to use
26858 this certificate and key in an MTA, where prompting is not possible.
26859
26860 . ==== I expect to still be working 26 years from now.  The less technical
26861 . ==== debt I create, in terms of storing up trouble for my later years, the
26862 . ==== happier I will be then.  We really have reached the point where we
26863 . ==== should start, at the very least, provoking thought and making folks
26864 . ==== pause before proceeding, instead of leaving all the fixes until two
26865 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26866 . ==== -pdp, 2012
26867 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26868 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26869 the above command might produce a date in the past.  Think carefully about
26870 the lifetime of the systems you're deploying, and either reduce the duration
26871 of the certificate or reconsider your platform deployment.  (At time of
26872 writing, reducing the duration is the most likely choice, but the inexorable
26873 progression of time takes us steadily towards an era where this will not
26874 be a sensible resolution).
26875
26876 A self-signed certificate made in this way is sufficient for testing, and
26877 may be adequate for all your requirements if you are mainly interested in
26878 encrypting transfers, and not in secure identification.
26879
26880 However, many clients require that the certificate presented by the server be a
26881 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26882 certificate. In this situation, the self-signed certificate described above
26883 must be installed on the client host as a trusted root &'certification
26884 authority'& (CA), and the certificate used by Exim must be a user certificate
26885 signed with that self-signed certificate.
26886
26887 For information on creating self-signed CA certificates and using them to sign
26888 user certificates, see the &'General implementation overview'& chapter of the
26889 Open-source PKI book, available online at
26890 &url(http://ospkibook.sourceforge.net/).
26891 .ecindex IIDencsmtp1
26892 .ecindex IIDencsmtp2
26893
26894
26895
26896 . ////////////////////////////////////////////////////////////////////////////
26897 . ////////////////////////////////////////////////////////////////////////////
26898
26899 .chapter "Access control lists" "CHAPACL"
26900 .scindex IIDacl "&ACL;" "description"
26901 .cindex "control of incoming mail"
26902 .cindex "message" "controlling incoming"
26903 .cindex "policy control" "access control lists"
26904 Access Control Lists (ACLs) are defined in a separate section of the run time
26905 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26906 name, terminated by a colon. Here is a complete ACL section that contains just
26907 one very small ACL:
26908 .code
26909 begin acl
26910 small_acl:
26911   accept   hosts = one.host.only
26912 .endd
26913 You can have as many lists as you like in the ACL section, and the order in
26914 which they appear does not matter. The lists are self-terminating.
26915
26916 The majority of ACLs are used to control Exim's behaviour when it receives
26917 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26918 when a local process submits a message using SMTP by specifying the &%-bs%&
26919 option. The most common use is for controlling which recipients are accepted
26920 in incoming messages. In addition, you can define an ACL that is used to check
26921 local non-SMTP messages. The default configuration file contains an example of
26922 a realistic ACL for checking RCPT commands. This is discussed in chapter
26923 &<<CHAPdefconfil>>&.
26924
26925
26926 .section "Testing ACLs" "SECID188"
26927 The &%-bh%& command line option provides a way of testing your ACL
26928 configuration locally by running a fake SMTP session with which you interact.
26929 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26930 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26931
26932
26933
26934 .section "Specifying when ACLs are used" "SECID189"
26935 .cindex "&ACL;" "options for specifying"
26936 In order to cause an ACL to be used, you have to name it in one of the relevant
26937 options in the main part of the configuration. These options are:
26938 .cindex "AUTH" "ACL for"
26939 .cindex "DATA" "ACLs for"
26940 .cindex "ETRN" "ACL for"
26941 .cindex "EXPN" "ACL for"
26942 .cindex "HELO" "ACL for"
26943 .cindex "EHLO" "ACL for"
26944 .cindex "MAIL" "ACL for"
26945 .cindex "QUIT, ACL for"
26946 .cindex "RCPT" "ACL for"
26947 .cindex "STARTTLS, ACL for"
26948 .cindex "VRFY" "ACL for"
26949 .cindex "SMTP" "connection, ACL for"
26950 .cindex "non-SMTP messages" "ACLs for"
26951 .cindex "MIME content scanning" "ACL for"
26952 .cindex "PRDR" "ACL for"
26953
26954 .table2 140pt
26955 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26956 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26957 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26958 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26959 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26960 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26961 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26962 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26963 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26964 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26965 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26966 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26967 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26968 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26969 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26970 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26971 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26972 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26973 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26974 .endtable
26975
26976 For example, if you set
26977 .code
26978 acl_smtp_rcpt = small_acl
26979 .endd
26980 the little ACL defined above is used whenever Exim receives a RCPT command
26981 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26982 done when RCPT commands arrive. A rejection of RCPT should cause the
26983 sending MTA to give up on the recipient address contained in the RCPT
26984 command, whereas rejection at other times may cause the client MTA to keep on
26985 trying to deliver the message. It is therefore recommended that you do as much
26986 testing as possible at RCPT time.
26987
26988
26989 .section "The non-SMTP ACLs" "SECID190"
26990 .cindex "non-SMTP messages" "ACLs for"
26991 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26992 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26993 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26994 the state of the SMTP connection such as encryption and authentication) are not
26995 relevant and are forbidden in these ACLs. However, the sender and recipients
26996 are known, so the &%senders%& and &%sender_domains%& conditions and the
26997 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26998 &$authenticated_sender$& are also available. You can specify added header lines
26999 in any of these ACLs.
27000
27001 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27002 non-SMTP message, before any of the message has been read. (This is the
27003 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27004 batched SMTP input, it runs after the DATA command has been reached. The
27005 result of this ACL is ignored; it cannot be used to reject a message. If you
27006 really need to, you could set a value in an ACL variable here and reject based
27007 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27008 controls, and in particular, it can be used to set
27009 .code
27010 control = suppress_local_fixups
27011 .endd
27012 This cannot be used in the other non-SMTP ACLs because by the time they are
27013 run, it is too late.
27014
27015 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27016 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27017
27018 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27019 kind of rejection is treated as permanent, because there is no way of sending a
27020 temporary error for these kinds of message.
27021
27022
27023 .section "The SMTP connect ACL" "SECID191"
27024 .cindex "SMTP" "connection, ACL for"
27025 .oindex &%smtp_banner%&
27026 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27027 session, after the test specified by &%host_reject_connection%& (which is now
27028 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27029 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27030 the message override the banner message that is otherwise specified by the
27031 &%smtp_banner%& option.
27032
27033
27034 .section "The EHLO/HELO ACL" "SECID192"
27035 .cindex "EHLO" "ACL for"
27036 .cindex "HELO" "ACL for"
27037 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27038 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27039 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27040 Note that a client may issue more than one EHLO or HELO command in an SMTP
27041 session, and indeed is required to issue a new EHLO or HELO after successfully
27042 setting up encryption following a STARTTLS command.
27043
27044 If the command is accepted by an &%accept%& verb that has a &%message%&
27045 modifier, the message may not contain more than one line (it will be truncated
27046 at the first newline and a panic logged if it does). Such a message cannot
27047 affect the EHLO options that are listed on the second and subsequent lines of
27048 an EHLO response.
27049
27050
27051 .section "The DATA ACLs" "SECID193"
27052 .cindex "DATA" "ACLs for"
27053 Two ACLs are associated with the DATA command, because it is two-stage
27054 command, with two responses being sent to the client.
27055 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27056 is obeyed. This gives you control after all the RCPT commands, but before
27057 the message itself is received. It offers the opportunity to give a negative
27058 response to the DATA command before the data is transmitted. Header lines
27059 added by MAIL or RCPT ACLs are not visible at this time, but any that
27060 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27061
27062 You cannot test the contents of the message, for example, to verify addresses
27063 in the headers, at RCPT time or when the DATA command is received. Such
27064 tests have to appear in the ACL that is run after the message itself has been
27065 received, before the final response to the DATA command is sent. This is
27066 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27067 associated with the DATA command.
27068
27069 For both of these ACLs, it is not possible to reject individual recipients. An
27070 error response rejects the entire message. Unfortunately, it is known that some
27071 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27072 before or after the data) correctly &-- they keep the message on their queues
27073 and try again later, but that is their problem, though it does waste some of
27074 your resources.
27075
27076 The &%acl_smtp_data%& ACL is run after
27077 the &%acl_smtp_data_prdr%&,
27078 the &%acl_smtp_dkim%&
27079 and the &%acl_smtp_mime%& ACLs.
27080
27081 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27082 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27083 enabled (which is the default).
27084
27085 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27086 received, and is executed for each DKIM signature found in a message.  If not
27087 otherwise specified, the default action is to accept.
27088
27089 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27090
27091 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27092
27093
27094 .section "The SMTP MIME ACL" "SECID194"
27095 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27096 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27097
27098 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27099
27100
27101 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27102 .cindex "PRDR" "ACL for"
27103 .oindex "&%prdr_enable%&"
27104 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27105 with PRDR support enabled (which is the default).
27106 It becomes active only when the PRDR feature is negotiated between
27107 client and server for a message, and more than one recipient
27108 has been accepted.
27109
27110 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27111 has been recieved, and is executed once for each recipient of the message
27112 with &$local_part$& and &$domain$& valid.
27113 The test may accept, defer or deny for inividual recipients.
27114 The &%acl_smtp_data%& will still be called after this ACL and
27115 can reject the message overall, even if this ACL has accepted it
27116 for some or all recipients.
27117
27118 PRDR may be used to support per-user content filtering.  Without it
27119 one must defer any recipient after the first that has a different
27120 content-filter configuration.  With PRDR, the RCPT-time check
27121 for this can be disabled when the MAIL-time $smtp_command included
27122 "PRDR".  Any required difference in behaviour of the main DATA-time
27123 ACL should however depend on the PRDR-time ACL having run, as Exim
27124 will avoid doing so in some situations (eg.  single-recipient mails).
27125
27126 See also the &%prdr_enable%& global option
27127 and the &%hosts_try_prdr%& smtp transport option.
27128
27129 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27130 If the ACL is not defined, processing completes as if
27131 the feature was not requested by the client.
27132
27133 .section "The QUIT ACL" "SECTQUITACL"
27134 .cindex "QUIT, ACL for"
27135 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27136 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27137 does not in fact control any access. For this reason, it may only accept
27138 or warn as its final result.
27139
27140 This ACL can be used for tasks such as custom logging at the end of an SMTP
27141 session. For example, you can use ACL variables in other ACLs to count
27142 messages, recipients, etc., and log the totals at QUIT time using one or
27143 more &%logwrite%& modifiers on a &%warn%& verb.
27144
27145 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27146 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27147
27148 You do not need to have a final &%accept%&, but if you do, you can use a
27149 &%message%& modifier to specify custom text that is sent as part of the 221
27150 response to QUIT.
27151
27152 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27153 failure (for example, failure to open a log file, or when Exim is bombing out
27154 because it has detected an unrecoverable error), all SMTP commands from the
27155 client are given temporary error responses until QUIT is received or the
27156 connection is closed. In these special cases, the QUIT ACL does not run.
27157
27158
27159 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27160 .vindex &$acl_smtp_notquit$&
27161 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27162 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27163 trouble, such as being unable to write to its log files, this ACL is not run,
27164 because it might try to do things (such as write to log files) that make the
27165 situation even worse.
27166
27167 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27168 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27169 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27170 and &%warn%&.
27171
27172 .vindex &$smtp_notquit_reason$&
27173 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27174 to a string that indicates the reason for the termination of the SMTP
27175 connection. The possible values are:
27176 .table2
27177 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27178 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27179 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27180 .irow &`connection-lost`&          "The SMTP connection has been lost"
27181 .irow &`data-timeout`&             "Timeout while reading message data"
27182 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27183 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27184 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27185 .irow &`synchronization-error`&    "SMTP synchronization error"
27186 .irow &`tls-failed`&               "TLS failed to start"
27187 .endtable
27188 In most cases when an SMTP connection is closed without having received QUIT,
27189 Exim sends an SMTP response message before actually closing the connection.
27190 With the exception of the &`acl-drop`& case, the default message can be
27191 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27192 &%drop%& verb in another ACL, it is the message from the other ACL that is
27193 used.
27194
27195
27196 .section "Finding an ACL to use" "SECID195"
27197 .cindex "&ACL;" "finding which to use"
27198 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27199 you can use different ACLs in different circumstances. For example,
27200 .code
27201 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27202                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27203 .endd
27204 In the default configuration file there are some example settings for
27205 providing an RFC 4409 message submission service on port 587 and a
27206 non-standard &"smtps"& service on port 465. You can use a string
27207 expansion like this to choose an ACL for MUAs on these ports which is
27208 more appropriate for this purpose than the default ACL on port 25.
27209
27210 The expanded string does not have to be the name of an ACL in the
27211 configuration file; there are other possibilities. Having expanded the
27212 string, Exim searches for an ACL as follows:
27213
27214 .ilist
27215 If the string begins with a slash, Exim uses it as a file name, and reads its
27216 contents as an ACL. The lines are processed in the same way as lines in the
27217 Exim configuration file. In particular, continuation lines are supported, blank
27218 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27219 If the file does not exist or cannot be read, an error occurs (typically
27220 causing a temporary failure of whatever caused the ACL to be run). For example:
27221 .code
27222 acl_smtp_data = /etc/acls/\
27223   ${lookup{$sender_host_address}lsearch\
27224   {/etc/acllist}{$value}{default}}
27225 .endd
27226 This looks up an ACL file to use on the basis of the host's IP address, falling
27227 back to a default if the lookup fails. If an ACL is successfully read from a
27228 file, it is retained in memory for the duration of the Exim process, so that it
27229 can be re-used without having to re-read the file.
27230 .next
27231 If the string does not start with a slash, and does not contain any spaces,
27232 Exim searches the ACL section of the configuration for an ACL whose name
27233 matches the string.
27234 .next
27235 If no named ACL is found, or if the string contains spaces, Exim parses
27236 the string as an inline ACL. This can save typing in cases where you just
27237 want to have something like
27238 .code
27239 acl_smtp_vrfy = accept
27240 .endd
27241 in order to allow free use of the VRFY command. Such a string may contain
27242 newlines; it is processed in the same way as an ACL that is read from a file.
27243 .endlist
27244
27245
27246
27247
27248 .section "ACL return codes" "SECID196"
27249 .cindex "&ACL;" "return codes"
27250 Except for the QUIT ACL, which does not affect the SMTP return code (see
27251 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27252 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27253 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27254 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27255 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27256 This also causes a 4&'xx'& return code.
27257
27258 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27259 &"deny"&, because there is no mechanism for passing temporary errors to the
27260 submitters of non-SMTP messages.
27261
27262
27263 ACLs that are relevant to message reception may also return &"discard"&. This
27264 has the effect of &"accept"&, but causes either the entire message or an
27265 individual recipient address to be discarded. In other words, it is a
27266 blackholing facility. Use it with care.
27267
27268 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27269 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27270 RCPT ACL is to discard just the one recipient address. If there are no
27271 recipients left when the message's data is received, the DATA ACL is not
27272 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27273 remaining recipients. The &"discard"& return is not permitted for the
27274 &%acl_smtp_predata%& ACL.
27275
27276
27277 .cindex "&[local_scan()]& function" "when all recipients discarded"
27278 The &[local_scan()]& function is always run, even if there are no remaining
27279 recipients; it may create new recipients.
27280
27281
27282
27283 .section "Unset ACL options" "SECID197"
27284 .cindex "&ACL;" "unset options"
27285 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27286 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27287 not defined at all. For any defined ACL, the default action when control
27288 reaches the end of the ACL statements is &"deny"&.
27289
27290 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27291 these two are ACLs that are used only for their side effects. They cannot be
27292 used to accept or reject anything.
27293
27294 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27295 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27296 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27297 when the ACL is not defined is &"accept"&.
27298
27299 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27300 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27301 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27302 messages over an SMTP connection. For an example, see the ACL in the default
27303 configuration file.
27304
27305
27306
27307
27308 .section "Data for message ACLs" "SECID198"
27309 .cindex "&ACL;" "data for message ACL"
27310 .vindex &$domain$&
27311 .vindex &$local_part$&
27312 .vindex &$sender_address$&
27313 .vindex &$sender_host_address$&
27314 .vindex &$smtp_command$&
27315 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27316 that contain information about the host and the message's sender (for example,
27317 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27318 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27319 &$local_part$& are set from the argument address. The entire SMTP command
27320 is available in &$smtp_command$&.
27321
27322 When an ACL for the AUTH parameter of MAIL is running, the variables that
27323 contain information about the host are set, but &$sender_address$& is not yet
27324 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27325 how it is used.
27326
27327 .vindex "&$message_size$&"
27328 The &$message_size$& variable is set to the value of the SIZE parameter on
27329 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27330 that parameter is not given. The value is updated to the true message size by
27331 the time the final DATA ACL is run (after the message data has been
27332 received).
27333
27334 .vindex "&$rcpt_count$&"
27335 .vindex "&$recipients_count$&"
27336 The &$rcpt_count$& variable increases by one for each RCPT command received.
27337 The &$recipients_count$& variable increases by one each time a RCPT command is
27338 accepted, so while an ACL for RCPT is being processed, it contains the number
27339 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27340 &$rcpt_count$& contains the total number of RCPT commands, and
27341 &$recipients_count$& contains the total number of accepted recipients.
27342
27343
27344
27345
27346
27347 .section "Data for non-message ACLs" "SECTdatfornon"
27348 .cindex "&ACL;" "data for non-message ACL"
27349 .vindex &$smtp_command_argument$&
27350 .vindex &$smtp_command$&
27351 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27352 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27353 and the entire SMTP command is available in &$smtp_command$&.
27354 These variables can be tested using a &%condition%& condition. For example,
27355 here is an ACL for use with AUTH, which insists that either the session is
27356 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27357 does not permit authentication methods that use cleartext passwords on
27358 unencrypted connections.
27359 .code
27360 acl_check_auth:
27361   accept encrypted = *
27362   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27363                      {CRAM-MD5}}
27364   deny   message   = TLS encryption or CRAM-MD5 required
27365 .endd
27366 (Another way of applying this restriction is to arrange for the authenticators
27367 that use cleartext passwords not to be advertised when the connection is not
27368 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27369 option to do this.)
27370
27371
27372
27373 .section "Format of an ACL" "SECID199"
27374 .cindex "&ACL;" "format of"
27375 .cindex "&ACL;" "verbs, definition of"
27376 An individual ACL consists of a number of statements. Each statement starts
27377 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27378 Modifiers can change the way the verb operates, define error and log messages,
27379 set variables, insert delays, and vary the processing of accepted messages.
27380
27381 If all the conditions are met, the verb is obeyed. The same condition may be
27382 used (with different arguments) more than once in the same statement. This
27383 provides a means of specifying an &"and"& conjunction between conditions. For
27384 example:
27385 .code
27386 deny  dnslists = list1.example
27387 dnslists = list2.example
27388 .endd
27389 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27390 the conditions and modifiers when it reaches a condition that fails. What
27391 happens then depends on the verb (and in one case, on a special modifier). Not
27392 all the conditions make sense at every testing point. For example, you cannot
27393 test a sender address in the ACL that is run for a VRFY command.
27394
27395
27396 .section "ACL verbs" "SECID200"
27397 The ACL verbs are as follows:
27398
27399 .ilist
27400 .cindex "&%accept%& ACL verb"
27401 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27402 of the conditions are not met, what happens depends on whether &%endpass%&
27403 appears among the conditions (for syntax see below). If the failing condition
27404 is before &%endpass%&, control is passed to the next ACL statement; if it is
27405 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27406 check a RCPT command:
27407 .code
27408 accept domains = +local_domains
27409 endpass
27410 verify = recipient
27411 .endd
27412 If the recipient domain does not match the &%domains%& condition, control
27413 passes to the next statement. If it does match, the recipient is verified, and
27414 the command is accepted if verification succeeds. However, if verification
27415 fails, the ACL yields &"deny"&, because the failing condition is after
27416 &%endpass%&.
27417
27418 The &%endpass%& feature has turned out to be confusing to many people, so its
27419 use is not recommended nowadays. It is always possible to rewrite an ACL so
27420 that &%endpass%& is not needed, and it is no longer used in the default
27421 configuration.
27422
27423 .cindex "&%message%& ACL modifier" "with &%accept%&"
27424 If a &%message%& modifier appears on an &%accept%& statement, its action
27425 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27426 (when an &%accept%& verb either accepts or passes control to the next
27427 statement), &%message%& can be used to vary the message that is sent when an
27428 SMTP command is accepted. For example, in a RCPT ACL you could have:
27429 .display
27430 &`accept  `&<&'some conditions'&>
27431 &`        message = OK, I will allow you through today`&
27432 .endd
27433 You can specify an SMTP response code, optionally followed by an &"extended
27434 response code"& at the start of the message, but the first digit must be the
27435 same as would be sent by default, which is 2 for an &%accept%& verb.
27436
27437 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27438 an error message that is used when access is denied. This behaviour is retained
27439 for backward compatibility, but current &"best practice"& is to avoid the use
27440 of &%endpass%&.
27441
27442
27443 .next
27444 .cindex "&%defer%& ACL verb"
27445 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27446 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27447 &%defer%& is the same as &%deny%&, because there is no way of sending a
27448 temporary error. For a RCPT command, &%defer%& is much the same as using a
27449 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27450 be used in any ACL, and even for a recipient it might be a simpler approach.
27451
27452
27453 .next
27454 .cindex "&%deny%& ACL verb"
27455 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27456 the conditions are not met, control is passed to the next ACL statement. For
27457 example,
27458 .code
27459 deny dnslists = blackholes.mail-abuse.org
27460 .endd
27461 rejects commands from hosts that are on a DNS black list.
27462
27463
27464 .next
27465 .cindex "&%discard%& ACL verb"
27466 &%discard%&: This verb behaves like &%accept%&, except that it returns
27467 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27468 that are concerned with receiving messages. When all the conditions are true,
27469 the sending entity receives a &"success"& response. However, &%discard%& causes
27470 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27471 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27472 message's recipients are discarded. Recipients that are discarded before DATA
27473 do not appear in the log line when the &%received_recipients%& log selector is set.
27474
27475 If the &%log_message%& modifier is set when &%discard%& operates,
27476 its contents are added to the line that is automatically written to the log.
27477 The &%message%& modifier operates exactly as it does for &%accept%&.
27478
27479
27480 .next
27481 .cindex "&%drop%& ACL verb"
27482 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27483 forcibly closed after the 5&'xx'& error message has been sent. For example:
27484 .code
27485 drop   message   = I don't take more than 20 RCPTs
27486        condition = ${if > {$rcpt_count}{20}}
27487 .endd
27488 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27489 The connection is always dropped after sending a 550 response.
27490
27491 .next
27492 .cindex "&%require%& ACL verb"
27493 &%require%&: If all the conditions are met, control is passed to the next ACL
27494 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27495 example, when checking a RCPT command,
27496 .code
27497 require message = Sender did not verify
27498         verify  = sender
27499 .endd
27500 passes control to subsequent statements only if the message's sender can be
27501 verified. Otherwise, it rejects the command. Note the positioning of the
27502 &%message%& modifier, before the &%verify%& condition. The reason for this is
27503 discussed in section &<<SECTcondmodproc>>&.
27504
27505 .next
27506 .cindex "&%warn%& ACL verb"
27507 &%warn%&: If all the conditions are true, a line specified by the
27508 &%log_message%& modifier is written to Exim's main log. Control always passes
27509 to the next ACL statement. If any condition is false, the log line is not
27510 written. If an identical log line is requested several times in the same
27511 message, only one copy is actually written to the log. If you want to force
27512 duplicates to be written, use the &%logwrite%& modifier instead.
27513
27514 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27515 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27516 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27517 first failing condition. There is more about adding header lines in section
27518 &<<SECTaddheadacl>>&.
27519
27520 If any condition on a &%warn%& statement cannot be completed (that is, there is
27521 some sort of defer), the log line specified by &%log_message%& is not written.
27522 This does not include the case of a forced failure from a lookup, which
27523 is considered to be a successful completion. After a defer, no further
27524 conditions or modifiers in the &%warn%& statement are processed. The incident
27525 is logged, and the ACL continues to be processed, from the next statement
27526 onwards.
27527
27528
27529 .vindex "&$acl_verify_message$&"
27530 When one of the &%warn%& conditions is an address verification that fails, the
27531 text of the verification failure message is in &$acl_verify_message$&. If you
27532 want this logged, you must set it up explicitly. For example:
27533 .code
27534 warn   !verify = sender
27535        log_message = sender verify failed: $acl_verify_message
27536 .endd
27537 .endlist
27538
27539 At the end of each ACL there is an implicit unconditional &%deny%&.
27540
27541 As you can see from the examples above, the conditions and modifiers are
27542 written one to a line, with the first one on the same line as the verb, and
27543 subsequent ones on following lines. If you have a very long condition, you can
27544 continue it onto several physical lines by the usual backslash continuation
27545 mechanism. It is conventional to align the conditions vertically.
27546
27547
27548
27549 .section "ACL variables" "SECTaclvariables"
27550 .cindex "&ACL;" "variables"
27551 There are some special variables that can be set during ACL processing. They
27552 can be used to pass information between different ACLs, different invocations
27553 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27554 transports, and filters that are used to deliver a message. The names of these
27555 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27556 an underscore, but the remainder of the name can be any sequence of
27557 alphanumeric characters and underscores that you choose. There is no limit on
27558 the number of ACL variables. The two sets act as follows:
27559 .ilist
27560 The values of those variables whose names begin with &$acl_c$& persist
27561 throughout an SMTP connection. They are never reset. Thus, a value that is set
27562 while receiving one message is still available when receiving the next message
27563 on the same SMTP connection.
27564 .next
27565 The values of those variables whose names begin with &$acl_m$& persist only
27566 while a message is being received. They are reset afterwards. They are also
27567 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27568 .endlist
27569
27570 When a message is accepted, the current values of all the ACL variables are
27571 preserved with the message and are subsequently made available at delivery
27572 time. The ACL variables are set by a modifier called &%set%&. For example:
27573 .code
27574 accept hosts = whatever
27575        set acl_m4 = some value
27576 accept authenticated = *
27577        set acl_c_auth = yes
27578 .endd
27579 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27580 be set. If you want to set a variable without taking any action, you can use a
27581 &%warn%& verb without any other modifiers or conditions.
27582
27583 .oindex &%strict_acl_vars%&
27584 What happens if a syntactically valid but undefined ACL variable is
27585 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27586 false (the default), an empty string is substituted; if it is true, an
27587 error is generated.
27588
27589 Versions of Exim before 4.64 have a limited set of numbered variables, but
27590 their names are compatible, so there is no problem with upgrading.
27591
27592
27593 .section "Condition and modifier processing" "SECTcondmodproc"
27594 .cindex "&ACL;" "conditions; processing"
27595 .cindex "&ACL;" "modifiers; processing"
27596 An exclamation mark preceding a condition negates its result. For example:
27597 .code
27598 deny   domains = *.dom.example
27599       !verify  = recipient
27600 .endd
27601 causes the ACL to return &"deny"& if the recipient domain ends in
27602 &'dom.example'& and the recipient address cannot be verified. Sometimes
27603 negation can be used on the right-hand side of a condition. For example, these
27604 two statements are equivalent:
27605 .code
27606 deny  hosts = !192.168.3.4
27607 deny !hosts =  192.168.3.4
27608 .endd
27609 However, for many conditions (&%verify%& being a good example), only left-hand
27610 side negation of the whole condition is possible.
27611
27612 The arguments of conditions and modifiers are expanded. A forced failure
27613 of an expansion causes a condition to be ignored, that is, it behaves as if the
27614 condition is true. Consider these two statements:
27615 .code
27616 accept  senders = ${lookup{$host_name}lsearch\
27617                   {/some/file}{$value}fail}
27618 accept  senders = ${lookup{$host_name}lsearch\
27619                   {/some/file}{$value}{}}
27620 .endd
27621 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27622 the returned list is searched, but if the lookup fails the behaviour is
27623 different in the two cases. The &%fail%& in the first statement causes the
27624 condition to be ignored, leaving no further conditions. The &%accept%& verb
27625 therefore succeeds. The second statement, however, generates an empty list when
27626 the lookup fails. No sender can match an empty list, so the condition fails,
27627 and therefore the &%accept%& also fails.
27628
27629 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27630 specify actions that are taken as the conditions for a statement are checked;
27631 others specify text for messages that are used when access is denied or a
27632 warning is generated. The &%control%& modifier affects the way an incoming
27633 message is handled.
27634
27635 The positioning of the modifiers in an ACL statement is important, because the
27636 processing of a verb ceases as soon as its outcome is known. Only those
27637 modifiers that have already been encountered will take effect. For example,
27638 consider this use of the &%message%& modifier:
27639 .code
27640 require message = Can't verify sender
27641         verify  = sender
27642         message = Can't verify recipient
27643         verify  = recipient
27644         message = This message cannot be used
27645 .endd
27646 If sender verification fails, Exim knows that the result of the statement is
27647 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27648 so its text is used as the error message. If sender verification succeeds, but
27649 recipient verification fails, the second message is used. If recipient
27650 verification succeeds, the third message becomes &"current"&, but is never used
27651 because there are no more conditions to cause failure.
27652
27653 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27654 modifier that is used, because all the conditions must be true for rejection to
27655 happen. Specifying more than one &%message%& modifier does not make sense, and
27656 the message can even be specified after all the conditions. For example:
27657 .code
27658 deny   hosts = ...
27659       !senders = *@my.domain.example
27660        message = Invalid sender from client host
27661 .endd
27662 The &"deny"& result does not happen until the end of the statement is reached,
27663 by which time Exim has set up the message.
27664
27665
27666
27667 .section "ACL modifiers" "SECTACLmodi"
27668 .cindex "&ACL;" "modifiers; list of"
27669 The ACL modifiers are as follows:
27670
27671 .vlist
27672 .vitem &*add_header*&&~=&~<&'text'&>
27673 This modifier specifies one or more header lines that are to be added to an
27674 incoming message, assuming, of course, that the message is ultimately
27675 accepted. For details, see section &<<SECTaddheadacl>>&.
27676
27677 .vitem &*continue*&&~=&~<&'text'&>
27678 .cindex "&%continue%& ACL modifier"
27679 .cindex "database" "updating in ACL"
27680 This modifier does nothing of itself, and processing of the ACL always
27681 continues with the next condition or modifier. The value of &%continue%& is in
27682 the side effects of expanding its argument. Typically this could be used to
27683 update a database. It is really just a syntactic tidiness, to avoid having to
27684 write rather ugly lines like this:
27685 .display
27686 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27687 .endd
27688 Instead, all you need is
27689 .display
27690 &`continue = `&<&'some expansion'&>
27691 .endd
27692
27693 .vitem &*control*&&~=&~<&'text'&>
27694 .cindex "&%control%& ACL modifier"
27695 This modifier affects the subsequent processing of the SMTP connection or of an
27696 incoming message that is accepted. The effect of the first type of control
27697 lasts for the duration of the connection, whereas the effect of the second type
27698 lasts only until the current message has been received. The message-specific
27699 controls always apply to the whole message, not to individual recipients,
27700 even if the &%control%& modifier appears in a RCPT ACL.
27701
27702 As there are now quite a few controls that can be applied, they are described
27703 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27704 in several different ways. For example:
27705
27706 . ==== As this is a nested list, any displays it contains must be indented
27707 . ==== as otherwise they are too far to the left. That comment applies only
27708 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27709 . ==== way.
27710
27711 .ilist
27712 It can be at the end of an &%accept%& statement:
27713 .code
27714     accept  ...some conditions
27715             control = queue_only
27716 .endd
27717 In this case, the control is applied when this statement yields &"accept"&, in
27718 other words, when the conditions are all true.
27719
27720 .next
27721 It can be in the middle of an &%accept%& statement:
27722 .code
27723     accept  ...some conditions...
27724             control = queue_only
27725             ...some more conditions...
27726 .endd
27727 If the first set of conditions are true, the control is applied, even if the
27728 statement does not accept because one of the second set of conditions is false.
27729 In this case, some subsequent statement must yield &"accept"& for the control
27730 to be relevant.
27731
27732 .next
27733 It can be used with &%warn%& to apply the control, leaving the
27734 decision about accepting or denying to a subsequent verb. For
27735 example:
27736 .code
27737     warn    ...some conditions...
27738             control = freeze
27739     accept  ...
27740 .endd
27741 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27742 &%logwrite%&, so it does not add anything to the message and does not write a
27743 log entry.
27744
27745 .next
27746 If you want to apply a control unconditionally, you can use it with a
27747 &%require%& verb. For example:
27748 .code
27749     require  control = no_multiline_responses
27750 .endd
27751 .endlist
27752
27753 .vitem &*delay*&&~=&~<&'time'&>
27754 .cindex "&%delay%& ACL modifier"
27755 .oindex "&%-bh%&"
27756 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27757 the time interval before proceeding. However, when testing Exim using the
27758 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27759 output instead). The time is given in the usual Exim notation, and the delay
27760 happens as soon as the modifier is processed. In an SMTP session, pending
27761 output is flushed before the delay is imposed.
27762
27763 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27764 example:
27765 .code
27766 deny    ...some conditions...
27767         delay = 30s
27768 .endd
27769 The delay happens if all the conditions are true, before the statement returns
27770 &"deny"&. Compare this with:
27771 .code
27772 deny    delay = 30s
27773         ...some conditions...
27774 .endd
27775 which waits for 30s before processing the conditions. The &%delay%& modifier
27776 can also be used with &%warn%& and together with &%control%&:
27777 .code
27778 warn    ...some conditions...
27779         delay = 2m
27780         control = freeze
27781 accept  ...
27782 .endd
27783
27784 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27785 responses to several commands are no longer buffered and sent in one packet (as
27786 they would normally be) because all output is flushed before imposing the
27787 delay. This optimization is disabled so that a number of small delays do not
27788 appear to the client as one large aggregated delay that might provoke an
27789 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27790 using a &%control%& modifier to set &%no_delay_flush%&.
27791
27792
27793 .vitem &*endpass*&
27794 .cindex "&%endpass%& ACL modifier"
27795 This modifier, which has no argument, is recognized only in &%accept%& and
27796 &%discard%& statements. It marks the boundary between the conditions whose
27797 failure causes control to pass to the next statement, and the conditions whose
27798 failure causes the ACL to return &"deny"&. This concept has proved to be
27799 confusing to some people, so the use of &%endpass%& is no longer recommended as
27800 &"best practice"&. See the description of &%accept%& above for more details.
27801
27802
27803 .vitem &*log_message*&&~=&~<&'text'&>
27804 .cindex "&%log_message%& ACL modifier"
27805 This modifier sets up a message that is used as part of the log message if the
27806 ACL denies access or a &%warn%& statement's conditions are true. For example:
27807 .code
27808 require log_message = wrong cipher suite $tls_in_cipher
27809         encrypted   = DES-CBC3-SHA
27810 .endd
27811 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27812 example:
27813 .display
27814 &`discard `&<&'some conditions'&>
27815 &`        log_message = Discarded $local_part@$domain because...`&
27816 .endd
27817 When access is denied, &%log_message%& adds to any underlying error message
27818 that may exist because of a condition failure. For example, while verifying a
27819 recipient address, a &':fail:'& redirection might have already set up a
27820 message.
27821
27822 The message may be defined before the conditions to which it applies, because
27823 the string expansion does not happen until Exim decides that access is to be
27824 denied. This means that any variables that are set by the condition are
27825 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27826 variables are set after a DNS black list lookup succeeds. If the expansion of
27827 &%log_message%& fails, or if the result is an empty string, the modifier is
27828 ignored.
27829
27830 .vindex "&$acl_verify_message$&"
27831 If you want to use a &%warn%& statement to log the result of an address
27832 verification, you can use &$acl_verify_message$& to include the verification
27833 error message.
27834
27835 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27836 the start of the logged message. If the same warning log message is requested
27837 more than once while receiving  a single email message, only one copy is
27838 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27839 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27840 is logged for a successful &%warn%& statement.
27841
27842 If &%log_message%& is not present and there is no underlying error message (for
27843 example, from the failure of address verification), but &%message%& is present,
27844 the &%message%& text is used for logging rejections. However, if any text for
27845 logging contains newlines, only the first line is logged. In the absence of
27846 both &%log_message%& and &%message%&, a default built-in message is used for
27847 logging rejections.
27848
27849
27850 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27851 .cindex "&%log_reject_target%& ACL modifier"
27852 .cindex "logging in ACL" "specifying which log"
27853 This modifier makes it possible to specify which logs are used for messages
27854 about ACL rejections. Its argument is a colon-separated list of words that can
27855 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27856 may be empty, in which case a rejection is not logged at all. For example, this
27857 ACL fragment writes no logging information when access is denied:
27858 .display
27859 &`deny `&<&'some conditions'&>
27860 &`     log_reject_target =`&
27861 .endd
27862 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27863 permanent and temporary rejections. Its effect lasts for the rest of the
27864 current ACL.
27865
27866
27867 .vitem &*logwrite*&&~=&~<&'text'&>
27868 .cindex "&%logwrite%& ACL modifier"
27869 .cindex "logging in ACL" "immediate"
27870 This modifier writes a message to a log file as soon as it is encountered when
27871 processing an ACL. (Compare &%log_message%&, which, except in the case of
27872 &%warn%& and &%discard%&, is used only if the ACL statement denies
27873 access.) The &%logwrite%& modifier can be used to log special incidents in
27874 ACLs. For example:
27875 .display
27876 &`accept `&<&'some special conditions'&>
27877 &`       control  = freeze`&
27878 &`       logwrite = froze message because ...`&
27879 .endd
27880 By default, the message is written to the main log. However, it may begin
27881 with a colon, followed by a comma-separated list of log names, and then
27882 another colon, to specify exactly which logs are to be written. For
27883 example:
27884 .code
27885 logwrite = :main,reject: text for main and reject logs
27886 logwrite = :panic: text for panic log only
27887 .endd
27888
27889
27890 .vitem &*message*&&~=&~<&'text'&>
27891 .cindex "&%message%& ACL modifier"
27892 This modifier sets up a text string that is expanded and used as a response
27893 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27894 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27895 there is some complication if &%endpass%& is involved; see the description of
27896 &%accept%& for details.)
27897
27898 The expansion of the message happens at the time Exim decides that the ACL is
27899 to end, not at the time it processes &%message%&. If the expansion fails, or
27900 generates an empty string, the modifier is ignored. Here is an example where
27901 &%message%& must be specified first, because the ACL ends with a rejection if
27902 the &%hosts%& condition fails:
27903 .code
27904 require  message = Host not recognized
27905          hosts = 10.0.0.0/8
27906 .endd
27907 (Once a condition has failed, no further conditions or modifiers are
27908 processed.)
27909
27910 .cindex "SMTP" "error codes"
27911 .oindex "&%smtp_banner%&
27912 For ACLs that are triggered by SMTP commands, the message is returned as part
27913 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27914 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27915 is accepted. In the case of the connect ACL, accepting with a message modifier
27916 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27917 accept message may not contain more than one line (otherwise it will be
27918 truncated at the first newline and a panic logged), and it cannot affect the
27919 EHLO options.
27920
27921 When SMTP is involved, the message may begin with an overriding response code,
27922 consisting of three digits optionally followed by an &"extended response code"&
27923 of the form &'n.n.n'&, each code being followed by a space. For example:
27924 .code
27925 deny  message = 599 1.2.3 Host not welcome
27926       hosts = 192.168.34.0/24
27927 .endd
27928 The first digit of the supplied response code must be the same as would be sent
27929 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27930 access, but for the predata ACL, note that the default success code is 354, not
27931 2&'xx'&.
27932
27933 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27934 the message modifier cannot override the 221 response code.
27935
27936 The text in a &%message%& modifier is literal; any quotes are taken as
27937 literals, but because the string is expanded, backslash escapes are processed
27938 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27939 response.
27940
27941 .vindex "&$acl_verify_message$&"
27942 For ACLs that are called by an &%acl =%& ACL condition, the message is
27943 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27944
27945 If &%message%& is used on a statement that verifies an address, the message
27946 specified overrides any message that is generated by the verification process.
27947 However, the original message is available in the variable
27948 &$acl_verify_message$&, so you can incorporate it into your message if you
27949 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27950 routers to be passed back as part of the SMTP response, you should either not
27951 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27952
27953 For compatibility with previous releases of Exim, a &%message%& modifier that
27954 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27955 modifier, but this usage is now deprecated. However, &%message%& acts only when
27956 all the conditions are true, wherever it appears in an ACL command, whereas
27957 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27958 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27959 effect.
27960
27961
27962 .vitem &*remove_header*&&~=&~<&'text'&>
27963 This modifier specifies one or more header names in a colon-separated list
27964  that are to be removed from an incoming message, assuming, of course, that
27965 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27966
27967
27968 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27969 .cindex "&%set%& ACL modifier"
27970 This modifier puts a value into one of the ACL variables (see section
27971 &<<SECTaclvariables>>&).
27972
27973
27974 .vitem &*udpsend*&&~=&~<&'parameters'&>
27975 This modifier sends a UDP packet, for purposes such as statistics
27976 collection or behaviour monitoring. The parameters are expanded, and
27977 the result of the expansion must be a colon-separated list consisting
27978 of a destination server, port number, and the packet contents. The
27979 server can be specified as a host name or IPv4 or IPv6 address. The
27980 separator can be changed with the usual angle bracket syntax. For
27981 example, you might want to collect information on which hosts connect
27982 when:
27983 .code
27984 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27985              $tod_zulu $sender_host_address
27986 .endd
27987 .endlist
27988
27989
27990
27991
27992 .section "Use of the control modifier" "SECTcontrols"
27993 .cindex "&%control%& ACL modifier"
27994 The &%control%& modifier supports the following settings:
27995
27996 .vlist
27997 .vitem &*control&~=&~allow_auth_unadvertised*&
27998 This modifier allows a client host to use the SMTP AUTH command even when it
27999 has not been advertised in response to EHLO. Furthermore, because there are
28000 apparently some really broken clients that do this, Exim will accept AUTH after
28001 HELO (rather than EHLO) when this control is set. It should be used only if you
28002 really need it, and you should limit its use to those broken clients that do
28003 not work without it. For example:
28004 .code
28005 warn hosts   = 192.168.34.25
28006      control = allow_auth_unadvertised
28007 .endd
28008 Normally, when an Exim server receives an AUTH command, it checks the name of
28009 the authentication mechanism that is given in the command to ensure that it
28010 matches an advertised mechanism. When this control is set, the check that a
28011 mechanism has been advertised is bypassed. Any configured mechanism can be used
28012 by the client. This control is permitted only in the connection and HELO ACLs.
28013
28014
28015 .vitem &*control&~=&~caseful_local_part*& &&&
28016        &*control&~=&~caselower_local_part*&
28017 .cindex "&ACL;" "case of local part in"
28018 .cindex "case of local parts"
28019 .vindex "&$local_part$&"
28020 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28021 (that is, during RCPT processing). By default, the contents of &$local_part$&
28022 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28023 any uppercase letters in the original local part are restored in &$local_part$&
28024 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28025 is encountered.
28026
28027 These controls affect only the current recipient. Moreover, they apply only to
28028 local part handling that takes place directly in the ACL (for example, as a key
28029 in lookups). If a test to verify the recipient is obeyed, the case-related
28030 handling of the local part during the verification is controlled by the router
28031 configuration (see the &%caseful_local_part%& generic router option).
28032
28033 This facility could be used, for example, to add a spam score to local parts
28034 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28035 spam score:
28036 .code
28037 warn  control = caseful_local_part
28038       set acl_m4 = ${eval:\
28039                      $acl_m4 + \
28040                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28041                     }
28042       control = caselower_local_part
28043 .endd
28044 Notice that we put back the lower cased version afterwards, assuming that
28045 is what is wanted for subsequent tests.
28046
28047
28048 .vitem &*control&~=&~cutthrough_delivery*&
28049 .cindex "&ACL;" "cutthrough routing"
28050 .cindex "cutthrough" "requesting"
28051 This option requests delivery be attempted while the item is being received.
28052
28053 The option is usable in the RCPT ACL.
28054 If enabled for a message recieved via smtp and routed to an smtp transport,
28055 and only one transport, interface, destination host and port combination
28056 is used for all recipients of the message,
28057 then the delivery connection is made while the receiving connection is open
28058 and data is copied from one to the other.
28059
28060 An attempt to set this option for any recipient but the first
28061 for a mail will be quietly ignored.
28062 If a recipient-verify callout connection is subsequently
28063 requested in the same ACL it is held open and used for
28064 any subsequent receipients and the data,
28065 otherwise one is made after the initial RCPT ACL completes.
28066
28067 Note that routers are used in verify mode,
28068 and cannot depend on content of received headers.
28069 Note also that headers cannot be
28070 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28071 Headers may be modified by routers (subject to the above) and transports.
28072
28073 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28074 of outgoing messages is done, because it sends data to the ultimate destination
28075 before the entire message has been received from the source.
28076 It is not supported for messages recieved with the SMTP PRDR option in use.
28077
28078 Should the ultimate destination system positively accept or reject the mail,
28079 a corresponding indication is given to the source system and nothing is queued.
28080 If there is a temporary error the item is queued for later delivery in the
28081 usual fashion. If the item is successfully delivered in cutthrough mode
28082 the delivery log lines are tagged with ">>" rather than "=>" and appear
28083 before the acceptance "<=" line.
28084
28085 Delivery in this mode avoids the generation of a bounce mail to a
28086 (possibly faked)
28087 sender when the destination system is doing content-scan based rejection.
28088
28089
28090 .vitem &*control&~=&~debug/*&<&'options'&>
28091 .cindex "&ACL;" "enabling debug logging"
28092 .cindex "debugging" "enabling from an ACL"
28093 This control turns on debug logging, almost as though Exim had been invoked
28094 with &`-d`&, with the output going to a new logfile, by default called
28095 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28096 may access any variables already defined.  The logging may be adjusted with
28097 the &'opts'& option, which takes the same values as the &`-d`& command-line
28098 option.  Some examples (which depend on variables that don't exist in all
28099 contexts):
28100 .code
28101       control = debug
28102       control = debug/tag=.$sender_host_address
28103       control = debug/opts=+expand+acl
28104       control = debug/tag=.$message_exim_id/opts=+expand
28105 .endd
28106
28107
28108 .vitem &*control&~=&~dkim_disable_verify*&
28109 .cindex "disable DKIM verify"
28110 .cindex "DKIM" "disable verify"
28111 This control turns off DKIM verification processing entirely.  For details on
28112 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28113
28114
28115 .vitem &*control&~=&~dscp/*&<&'value'&>
28116 .cindex "&ACL;" "setting DSCP value"
28117 .cindex "DSCP" "inbound"
28118 This option causes the DSCP value associated with the socket for the inbound
28119 connection to be adjusted to a given value, given as one of a number of fixed
28120 strings or to numeric value.
28121 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28122 Common values include &`throughput`&, &`mincost`&, and on newer systems
28123 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28124
28125 The outbound packets from Exim will be marked with this value in the header
28126 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28127 that these values will have any effect, not be stripped by networking
28128 equipment, or do much of anything without cooperation with your Network
28129 Engineer and those of all network operators between the source and destination.
28130
28131
28132 .vitem &*control&~=&~enforce_sync*& &&&
28133        &*control&~=&~no_enforce_sync*&
28134 .cindex "SMTP" "synchronization checking"
28135 .cindex "synchronization checking in SMTP"
28136 These controls make it possible to be selective about when SMTP synchronization
28137 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28138 state of the switch (it is true by default). See the description of this option
28139 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28140
28141 The effect of these two controls lasts for the remainder of the SMTP
28142 connection. They can appear in any ACL except the one for the non-SMTP
28143 messages. The most straightforward place to put them is in the ACL defined by
28144 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28145 before the first synchronization check. The expected use is to turn off the
28146 synchronization checks for badly-behaved hosts that you nevertheless need to
28147 work with.
28148
28149
28150 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28151 .cindex "fake defer"
28152 .cindex "defer, fake"
28153 This control works in exactly the same way as &%fakereject%& (described below)
28154 except that it causes an SMTP 450 response after the message data instead of a
28155 550 response. You must take care when using &%fakedefer%& because it causes the
28156 messages to be duplicated when the sender retries. Therefore, you should not
28157 use &%fakedefer%& if the message is to be delivered normally.
28158
28159 .vitem &*control&~=&~fakereject/*&<&'message'&>
28160 .cindex "fake rejection"
28161 .cindex "rejection, fake"
28162 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28163 words, only when an SMTP message is being received. If Exim accepts the
28164 message, instead the final 250 response, a 550 rejection message is sent.
28165 However, Exim proceeds to deliver the message as normal. The control applies
28166 only to the current message, not to any subsequent ones that may be received in
28167 the same SMTP connection.
28168
28169 The text for the 550 response is taken from the &%control%& modifier. If no
28170 message is supplied, the following is used:
28171 .code
28172 550-Your message has been rejected but is being
28173 550-kept for evaluation.
28174 550-If it was a legitimate message, it may still be
28175 550 delivered to the target recipient(s).
28176 .endd
28177 This facility should be used with extreme caution.
28178
28179 .vitem &*control&~=&~freeze*&
28180 .cindex "frozen messages" "forcing in ACL"
28181 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28182 other words, only when a message is being received. If the message is accepted,
28183 it is placed on Exim's queue and frozen. The control applies only to the
28184 current message, not to any subsequent ones that may be received in the same
28185 SMTP connection.
28186
28187 This modifier can optionally be followed by &`/no_tell`&. If the global option
28188 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28189 is told about the freezing), provided all the &*control=freeze*& modifiers that
28190 are obeyed for the current message have the &`/no_tell`& option.
28191
28192 .vitem &*control&~=&~no_delay_flush*&
28193 .cindex "SMTP" "output flushing, disabling for delay"
28194 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28195 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28196 use. This control, as long as it is encountered before the &%delay%& modifier,
28197 disables such output flushing.
28198
28199 .vitem &*control&~=&~no_callout_flush*&
28200 .cindex "SMTP" "output flushing, disabling for callout"
28201 Exim normally flushes SMTP output before performing a callout in an ACL, to
28202 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28203 use. This control, as long as it is encountered before the &%verify%& condition
28204 that causes the callout, disables such output flushing.
28205
28206 .vitem &*control&~=&~no_mbox_unspool*&
28207 This control is available when Exim is compiled with the content scanning
28208 extension. Content scanning may require a copy of the current message, or parts
28209 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28210 or spam scanner. Normally, such copies are deleted when they are no longer
28211 needed. If this control is set, the copies are not deleted. The control applies
28212 only to the current message, not to any subsequent ones that may be received in
28213 the same SMTP connection. It is provided for debugging purposes and is unlikely
28214 to be useful in production.
28215
28216 .vitem &*control&~=&~no_multiline_responses*&
28217 .cindex "multiline responses, suppressing"
28218 This control is permitted for any ACL except the one for non-SMTP messages.
28219 It seems that there are broken clients in use that cannot handle multiline
28220 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28221
28222 If this control is set, multiline SMTP responses from ACL rejections are
28223 suppressed. One way of doing this would have been to put out these responses as
28224 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28225 (&"use multiline responses for more"& it says &-- ha!), and some of the
28226 responses might get close to that. So this facility, which is after all only a
28227 sop to broken clients, is implemented by doing two very easy things:
28228
28229 .ilist
28230 Extra information that is normally output as part of a rejection caused by
28231 sender verification failure is omitted. Only the final line (typically &"sender
28232 verification failed"&) is sent.
28233 .next
28234 If a &%message%& modifier supplies a multiline response, only the first
28235 line is output.
28236 .endlist
28237
28238 The setting of the switch can, of course, be made conditional on the
28239 calling host. Its effect lasts until the end of the SMTP connection.
28240
28241 .vitem &*control&~=&~no_pipelining*&
28242 .cindex "PIPELINING" "suppressing advertising"
28243 This control turns off the advertising of the PIPELINING extension to SMTP in
28244 the current session. To be useful, it must be obeyed before Exim sends its
28245 response to an EHLO command. Therefore, it should normally appear in an ACL
28246 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28247 &%pipelining_advertise_hosts%&.
28248
28249 .vitem &*control&~=&~queue_only*&
28250 .oindex "&%queue_only%&"
28251 .cindex "queueing incoming messages"
28252 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28253 other words, only when a message is being received. If the message is accepted,
28254 it is placed on Exim's queue and left there for delivery by a subsequent queue
28255 runner. No immediate delivery process is started. In other words, it has the
28256 effect as the &%queue_only%& global option. However, the control applies only
28257 to the current message, not to any subsequent ones that may be received in the
28258 same SMTP connection.
28259
28260 .vitem &*control&~=&~submission/*&<&'options'&>
28261 .cindex "message" "submission"
28262 .cindex "submission mode"
28263 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28264 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28265 the current message is a submission from a local MUA. In this case, Exim
28266 operates in &"submission mode"&, and applies certain fixups to the message if
28267 necessary. For example, it adds a &'Date:'& header line if one is not present.
28268 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28269 late (the message has already been created).
28270
28271 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28272 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28273 submission mode; the available options for this control are described there.
28274 The control applies only to the current message, not to any subsequent ones
28275 that may be received in the same SMTP connection.
28276
28277 .vitem &*control&~=&~suppress_local_fixups*&
28278 .cindex "submission fixups, suppressing"
28279 This control applies to locally submitted (non TCP/IP) messages, and is the
28280 complement of &`control = submission`&. It disables the fixups that are
28281 normally applied to locally-submitted messages. Specifically:
28282
28283 .ilist
28284 Any &'Sender:'& header line is left alone (in this respect, it is a
28285 dynamic version of &%local_sender_retain%&).
28286 .next
28287 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28288 .next
28289 There is no check that &'From:'& corresponds to the actual sender.
28290 .endlist ilist
28291
28292 This control may be useful when a remotely-originated message is accepted,
28293 passed to some scanning program, and then re-submitted for delivery. It can be
28294 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28295 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28296 data is read.
28297
28298 &*Note:*& This control applies only to the current message, not to any others
28299 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28300 .endlist vlist
28301
28302
28303 .section "Summary of message fixup control" "SECTsummesfix"
28304 All four possibilities for message fixups can be specified:
28305
28306 .ilist
28307 Locally submitted, fixups applied: the default.
28308 .next
28309 Locally submitted, no fixups applied: use
28310 &`control = suppress_local_fixups`&.
28311 .next
28312 Remotely submitted, no fixups applied: the default.
28313 .next
28314 Remotely submitted, fixups applied: use &`control = submission`&.
28315 .endlist
28316
28317
28318
28319 .section "Adding header lines in ACLs" "SECTaddheadacl"
28320 .cindex "header lines" "adding in an ACL"
28321 .cindex "header lines" "position of added lines"
28322 .cindex "&%add_header%& ACL modifier"
28323 The &%add_header%& modifier can be used to add one or more extra header lines
28324 to an incoming message, as in this example:
28325 .code
28326 warn dnslists = sbl.spamhaus.org : \
28327                 dialup.mail-abuse.org
28328      add_header = X-blacklisted-at: $dnslist_domain
28329 .endd
28330 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28331 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28332 receiving a message). The message must ultimately be accepted for
28333 &%add_header%& to have any significant effect. You can use &%add_header%& with
28334 any ACL verb, including &%deny%& (though this is potentially useful only in a
28335 RCPT ACL).
28336
28337 Headers will not be added to the message if the modifier is used in
28338 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28339
28340 Leading and trailing newlines are removed from
28341 the data for the &%add_header%& modifier; if it then
28342 contains one or more newlines that
28343 are not followed by a space or a tab, it is assumed to contain multiple header
28344 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28345 front of any line that is not a valid header line.
28346
28347 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28348 They are added to the message before processing the DATA and MIME ACLs.
28349 However, if an identical header line is requested more than once, only one copy
28350 is actually added to the message. Further header lines may be accumulated
28351 during the DATA and MIME ACLs, after which they are added to the message, again
28352 with duplicates suppressed. Thus, it is possible to add two identical header
28353 lines to an SMTP message, but only if one is added before DATA and one after.
28354 In the case of non-SMTP messages, new headers are accumulated during the
28355 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28356 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28357 are included in the entry that is written to the reject log.
28358
28359 .cindex "header lines" "added; visibility of"
28360 Header lines are not visible in string expansions
28361 of message headers
28362 until they are added to the
28363 message. It follows that header lines defined in the MAIL, RCPT, and predata
28364 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28365 header lines that are added by the DATA or MIME ACLs are not visible in those
28366 ACLs. Because of this restriction, you cannot use header lines as a way of
28367 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28368 this, you can use ACL variables, as described in section
28369 &<<SECTaclvariables>>&.
28370
28371 The list of headers yet to be added is given by the &%$headers_added%& variable.
28372
28373 The &%add_header%& modifier acts immediately as it is encountered during the
28374 processing of an ACL. Notice the difference between these two cases:
28375 .display
28376 &`accept add_header = ADDED: some text`&
28377 &`       `&<&'some condition'&>
28378
28379 &`accept `&<&'some condition'&>
28380 &`       add_header = ADDED: some text`&
28381 .endd
28382 In the first case, the header line is always added, whether or not the
28383 condition is true. In the second case, the header line is added only if the
28384 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28385 ACL statement. All those that are encountered before a condition fails are
28386 honoured.
28387
28388 .cindex "&%warn%& ACL verb"
28389 For compatibility with previous versions of Exim, a &%message%& modifier for a
28390 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28391 effect only if all the conditions are true, even if it appears before some of
28392 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28393 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28394 are present on a &%warn%& verb, both are processed according to their
28395 specifications.
28396
28397 By default, new header lines are added to a message at the end of the existing
28398 header lines. However, you can specify that any particular header line should
28399 be added right at the start (before all the &'Received:'& lines), immediately
28400 after the first block of &'Received:'& lines, or immediately before any line
28401 that is not a &'Received:'& or &'Resent-something:'& header.
28402
28403 This is done by specifying &":at_start:"&, &":after_received:"&, or
28404 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28405 header line, respectively. (Header text cannot start with a colon, as there has
28406 to be a header name first.) For example:
28407 .code
28408 warn add_header = \
28409        :after_received:X-My-Header: something or other...
28410 .endd
28411 If more than one header line is supplied in a single &%add_header%& modifier,
28412 each one is treated independently and can therefore be placed differently. If
28413 you add more than one line at the start, or after the Received: block, they end
28414 up in reverse order.
28415
28416 &*Warning*&: This facility currently applies only to header lines that are
28417 added in an ACL. It does NOT work for header lines that are added in a
28418 system filter or in a router or transport.
28419
28420
28421
28422 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28423 .cindex "header lines" "removing in an ACL"
28424 .cindex "header lines" "position of removed lines"
28425 .cindex "&%remove_header%& ACL modifier"
28426 The &%remove_header%& modifier can be used to remove one or more header lines
28427 from an incoming message, as in this example:
28428 .code
28429 warn   message        = Remove internal headers
28430        remove_header  = x-route-mail1 : x-route-mail2
28431 .endd
28432 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28433 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28434 receiving a message). The message must ultimately be accepted for
28435 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28436 with any ACL verb, including &%deny%&, though this is really not useful for
28437 any verb that doesn't result in a delivered message.
28438
28439 Headers will not be removed to the message if the modifier is used in
28440 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28441
28442 More than one header can be removed at the same time by using a colon separated
28443 list of header names. The header matching is case insensitive. Wildcards are
28444 not permitted, nor is list expansion performed, so you cannot use hostlists to
28445 create a list of headers, however both connection and message variable expansion
28446 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28447 .code
28448 warn   hosts           = +internal_hosts
28449        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28450 warn   message         = Remove internal headers
28451        remove_header   = $acl_c_ihdrs
28452 .endd
28453 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28454 They are removed from the message before processing the DATA and MIME ACLs.
28455 There is no harm in attempting to remove the same header twice nor is removing
28456 a non-existent header. Further header lines to be removed may be accumulated
28457 during the DATA and MIME ACLs, after which they are removed from the message,
28458 if present. In the case of non-SMTP messages, headers to be removed are
28459 accumulated during the non-SMTP ACLs, and are removed from the message after
28460 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28461 ACL, there really is no effect because there is no logging of what headers
28462 would have been removed.
28463
28464 .cindex "header lines" "removed; visibility of"
28465 Header lines are not visible in string expansions until the DATA phase when it
28466 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28467 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28468 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28469 this restriction, you cannot use header lines as a way of controlling data
28470 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28471 you should instead use ACL variables, as described in section
28472 &<<SECTaclvariables>>&.
28473
28474 The &%remove_header%& modifier acts immediately as it is encountered during the
28475 processing of an ACL. Notice the difference between these two cases:
28476 .display
28477 &`accept remove_header = X-Internal`&
28478 &`       `&<&'some condition'&>
28479
28480 &`accept `&<&'some condition'&>
28481 &`       remove_header = X-Internal`&
28482 .endd
28483 In the first case, the header line is always removed, whether or not the
28484 condition is true. In the second case, the header line is removed only if the
28485 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28486 same ACL statement. All those that are encountered before a condition fails
28487 are honoured.
28488
28489 &*Warning*&: This facility currently applies only to header lines that are
28490 present during ACL processing. It does NOT remove header lines that are added
28491 in a system filter or in a router or transport.
28492
28493
28494
28495
28496 .section "ACL conditions" "SECTaclconditions"
28497 .cindex "&ACL;" "conditions; list of"
28498 Some of the conditions listed in this section are available only when Exim is
28499 compiled with the content-scanning extension. They are included here briefly
28500 for completeness. More detailed descriptions can be found in the discussion on
28501 content scanning in chapter &<<CHAPexiscan>>&.
28502
28503 Not all conditions are relevant in all circumstances. For example, testing
28504 senders and recipients does not make sense in an ACL that is being run as the
28505 result of the arrival of an ETRN command, and checks on message headers can be
28506 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28507 can use the same condition (with different parameters) more than once in the
28508 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28509 The conditions are as follows:
28510
28511
28512 .vlist
28513 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28514 .cindex "&ACL;" "nested"
28515 .cindex "&ACL;" "indirect"
28516 .cindex "&ACL;" "arguments"
28517 .cindex "&%acl%& ACL condition"
28518 The possible values of the argument are the same as for the
28519 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28520 &"accept"& the condition is true; if it returns &"deny"& the condition is
28521 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28522 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28523 condition false. This means that further processing of the &%warn%& verb
28524 ceases, but processing of the ACL continues.
28525
28526 If the argument is a named ACL, up to nine space-separated optional values
28527 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28528 and $acl_narg is set to the count of values.
28529 Previous values of these variables are restored after the call returns.
28530 The name and values are expanded separately.
28531 Note that spaces in complex expansions which are used as arguments
28532 will act as argument separators.
28533
28534 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28535 the connection is dropped. If it returns &"discard"&, the verb must be
28536 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28537 conditions are tested.
28538
28539 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28540 loops. This condition allows you to use different ACLs in different
28541 circumstances. For example, different ACLs can be used to handle RCPT commands
28542 for different local users or different local domains.
28543
28544 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28545 .cindex "&%authenticated%& ACL condition"
28546 .cindex "authentication" "ACL checking"
28547 .cindex "&ACL;" "testing for authentication"
28548 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28549 the name of the authenticator is tested against the list. To test for
28550 authentication by any authenticator, you can set
28551 .code
28552 authenticated = *
28553 .endd
28554
28555 .vitem &*condition&~=&~*&<&'string'&>
28556 .cindex "&%condition%& ACL condition"
28557 .cindex "customizing" "ACL condition"
28558 .cindex "&ACL;" "customized test"
28559 .cindex "&ACL;" "testing, customized"
28560 This feature allows you to make up custom conditions. If the result of
28561 expanding the string is an empty string, the number zero, or one of the strings
28562 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28563 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28564 any other value, some error is assumed to have occurred, and the ACL returns
28565 &"defer"&. However, if the expansion is forced to fail, the condition is
28566 ignored. The effect is to treat it as true, whether it is positive or
28567 negative.
28568
28569 .vitem &*decode&~=&~*&<&'location'&>
28570 .cindex "&%decode%& ACL condition"
28571 This condition is available only when Exim is compiled with the
28572 content-scanning extension, and it is allowed only in the ACL defined by
28573 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28574 If all goes well, the condition is true. It is false only if there are
28575 problems such as a syntax error or a memory shortage. For more details, see
28576 chapter &<<CHAPexiscan>>&.
28577
28578 .vitem &*demime&~=&~*&<&'extension&~list'&>
28579 .cindex "&%demime%& ACL condition"
28580 This condition is available only when Exim is compiled with the
28581 content-scanning extension. Its use is described in section
28582 &<<SECTdemimecond>>&.
28583
28584 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28585 .cindex "&%dnslists%& ACL condition"
28586 .cindex "DNS list" "in ACL"
28587 .cindex "black list (DNS)"
28588 .cindex "&ACL;" "testing a DNS list"
28589 This condition checks for entries in DNS black lists. These are also known as
28590 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28591 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28592 different variants of this condition to describe briefly here. See sections
28593 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28594
28595 .vitem &*domains&~=&~*&<&'domain&~list'&>
28596 .cindex "&%domains%& ACL condition"
28597 .cindex "domain" "ACL checking"
28598 .cindex "&ACL;" "testing a recipient domain"
28599 .vindex "&$domain_data$&"
28600 This condition is relevant only after a RCPT command. It checks that the domain
28601 of the recipient address is in the domain list. If percent-hack processing is
28602 enabled, it is done before this test is done. If the check succeeds with a
28603 lookup, the result of the lookup is placed in &$domain_data$& until the next
28604 &%domains%& test.
28605
28606 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28607 use &%domains%& in a DATA ACL.
28608
28609
28610 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28611 .cindex "&%encrypted%& ACL condition"
28612 .cindex "encryption" "checking in an ACL"
28613 .cindex "&ACL;" "testing for encryption"
28614 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28615 name of the cipher suite in use is tested against the list. To test for
28616 encryption without testing for any specific cipher suite(s), set
28617 .code
28618 encrypted = *
28619 .endd
28620
28621
28622 .vitem &*hosts&~=&~*&<&'host&~list'&>
28623 .cindex "&%hosts%& ACL condition"
28624 .cindex "host" "ACL checking"
28625 .cindex "&ACL;" "testing the client host"
28626 This condition tests that the calling host matches the host list. If you have
28627 name lookups or wildcarded host names and IP addresses in the same host list,
28628 you should normally put the IP addresses first. For example, you could have:
28629 .code
28630 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28631 .endd
28632 The lookup in this example uses the host name for its key. This is implied by
28633 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28634 and it wouldn't matter which way round you had these two items.)
28635
28636 The reason for the problem with host names lies in the left-to-right way that
28637 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28638 but when it reaches an item that requires a host name, it fails if it cannot
28639 find a host name to compare with the pattern. If the above list is given in the
28640 opposite order, the &%accept%& statement fails for a host whose name cannot be
28641 found, even if its IP address is 10.9.8.7.
28642
28643 If you really do want to do the name check first, and still recognize the IP
28644 address even if the name lookup fails, you can rewrite the ACL like this:
28645 .code
28646 accept hosts = dbm;/etc/friendly/hosts
28647 accept hosts = 10.9.8.7
28648 .endd
28649 The default action on failing to find the host name is to assume that the host
28650 is not in the list, so the first &%accept%& statement fails. The second
28651 statement can then check the IP address.
28652
28653 .vindex "&$host_data$&"
28654 If a &%hosts%& condition is satisfied by means of a lookup, the result
28655 of the lookup is made available in the &$host_data$& variable. This
28656 allows you, for example, to set up a statement like this:
28657 .code
28658 deny  hosts = net-lsearch;/some/file
28659 message = $host_data
28660 .endd
28661 which gives a custom error message for each denied host.
28662
28663 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28664 .cindex "&%local_parts%& ACL condition"
28665 .cindex "local part" "ACL checking"
28666 .cindex "&ACL;" "testing a local part"
28667 .vindex "&$local_part_data$&"
28668 This condition is relevant only after a RCPT command. It checks that the local
28669 part of the recipient address is in the list. If percent-hack processing is
28670 enabled, it is done before this test. If the check succeeds with a lookup, the
28671 result of the lookup is placed in &$local_part_data$&, which remains set until
28672 the next &%local_parts%& test.
28673
28674 .vitem &*malware&~=&~*&<&'option'&>
28675 .cindex "&%malware%& ACL condition"
28676 .cindex "&ACL;" "virus scanning"
28677 .cindex "&ACL;" "scanning for viruses"
28678 This condition is available only when Exim is compiled with the
28679 content-scanning extension. It causes the incoming message to be scanned for
28680 viruses. For details, see chapter &<<CHAPexiscan>>&.
28681
28682 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28683 .cindex "&%mime_regex%& ACL condition"
28684 .cindex "&ACL;" "testing by regex matching"
28685 This condition is available only when Exim is compiled with the
28686 content-scanning extension, and it is allowed only in the ACL defined by
28687 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28688 with any of the regular expressions. For details, see chapter
28689 &<<CHAPexiscan>>&.
28690
28691 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28692 .cindex "rate limiting"
28693 This condition can be used to limit the rate at which a user or host submits
28694 messages. Details are given in section &<<SECTratelimiting>>&.
28695
28696 .vitem &*recipients&~=&~*&<&'address&~list'&>
28697 .cindex "&%recipients%& ACL condition"
28698 .cindex "recipient" "ACL checking"
28699 .cindex "&ACL;" "testing a recipient"
28700 This condition is relevant only after a RCPT command. It checks the entire
28701 recipient address against a list of recipients.
28702
28703 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28704 .cindex "&%regex%& ACL condition"
28705 .cindex "&ACL;" "testing by regex matching"
28706 This condition is available only when Exim is compiled with the
28707 content-scanning extension, and is available only in the DATA, MIME, and
28708 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28709 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28710
28711 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28712 .cindex "&%sender_domains%& ACL condition"
28713 .cindex "sender" "ACL checking"
28714 .cindex "&ACL;" "testing a sender domain"
28715 .vindex "&$domain$&"
28716 .vindex "&$sender_address_domain$&"
28717 This condition tests the domain of the sender of the message against the given
28718 domain list. &*Note*&: The domain of the sender address is in
28719 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28720 of this condition. This is an exception to the general rule for testing domain
28721 lists. It is done this way so that, if this condition is used in an ACL for a
28722 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28723 influence the sender checking.
28724
28725 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28726 relaying, because sender addresses are easily, and commonly, forged.
28727
28728 .vitem &*senders&~=&~*&<&'address&~list'&>
28729 .cindex "&%senders%& ACL condition"
28730 .cindex "sender" "ACL checking"
28731 .cindex "&ACL;" "testing a sender"
28732 This condition tests the sender of the message against the given list. To test
28733 for a bounce message, which has an empty sender, set
28734 .code
28735 senders = :
28736 .endd
28737 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28738 relaying, because sender addresses are easily, and commonly, forged.
28739
28740 .vitem &*spam&~=&~*&<&'username'&>
28741 .cindex "&%spam%& ACL condition"
28742 .cindex "&ACL;" "scanning for spam"
28743 This condition is available only when Exim is compiled with the
28744 content-scanning extension. It causes the incoming message to be scanned by
28745 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28746
28747 .vitem &*verify&~=&~certificate*&
28748 .cindex "&%verify%& ACL condition"
28749 .cindex "TLS" "client certificate verification"
28750 .cindex "certificate" "verification of client"
28751 .cindex "&ACL;" "certificate verification"
28752 .cindex "&ACL;" "testing a TLS certificate"
28753 This condition is true in an SMTP session if the session is encrypted, and a
28754 certificate was received from the client, and the certificate was verified. The
28755 server requests a certificate only if the client matches &%tls_verify_hosts%&
28756 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28757
28758 .vitem &*verify&~=&~csa*&
28759 .cindex "CSA verification"
28760 This condition checks whether the sending host (the client) is authorized to
28761 send email. Details of how this works are given in section
28762 &<<SECTverifyCSA>>&.
28763
28764 .vitem &*verify&~=&~header_names_ascii*&
28765 .cindex "&%verify%& ACL condition"
28766 .cindex "&ACL;" "verifying header names only ASCII"
28767 .cindex "header lines" "verifying header names only ASCII"
28768 .cindex "verifying" "header names only ASCII"
28769 This condition is relevant only in an ACL that is run after a message has been
28770 received, that is, in an ACL specified by &%acl_smtp_data%& or
28771 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28772 there are no non-ASCII characters, also excluding control characters.  The
28773 allowable characters are decimal ASCII values 33 through 126.
28774
28775 Exim itself will handle headers with non-ASCII characters, but it can cause
28776 problems for downstream applications, so this option will allow their
28777 detection and rejection in the DATA ACL's.
28778
28779 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28780 .cindex "&%verify%& ACL condition"
28781 .cindex "&ACL;" "verifying sender in the header"
28782 .cindex "header lines" "verifying the sender in"
28783 .cindex "sender" "verifying in header"
28784 .cindex "verifying" "sender in header"
28785 This condition is relevant only in an ACL that is run after a message has been
28786 received, that is, in an ACL specified by &%acl_smtp_data%& or
28787 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28788 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28789 is loosely thought of as a &"sender"& address (hence the name of the test).
28790 However, an address that appears in one of these headers need not be an address
28791 that accepts bounce messages; only sender addresses in envelopes are required
28792 to accept bounces. Therefore, if you use the callout option on this check, you
28793 might want to arrange for a non-empty address in the MAIL command.
28794
28795 Details of address verification and the options are given later, starting at
28796 section &<<SECTaddressverification>>& (callouts are described in section
28797 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28798 condition to restrict it to bounce messages only:
28799 .code
28800 deny    senders = :
28801         message = A valid sender header is required for bounces
28802        !verify  = header_sender
28803 .endd
28804
28805 .vitem &*verify&~=&~header_syntax*&
28806 .cindex "&%verify%& ACL condition"
28807 .cindex "&ACL;" "verifying header syntax"
28808 .cindex "header lines" "verifying syntax"
28809 .cindex "verifying" "header syntax"
28810 This condition is relevant only in an ACL that is run after a message has been
28811 received, that is, in an ACL specified by &%acl_smtp_data%& or
28812 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28813 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28814 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28815 permitted only in locally generated messages and from hosts that match
28816 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28817 appropriate.
28818
28819 Note that this condition is a syntax check only. However, a common spamming
28820 ploy used to be to send syntactically invalid headers such as
28821 .code
28822 To: @
28823 .endd
28824 and this condition can be used to reject such messages, though they are not as
28825 common as they used to be.
28826
28827 .vitem &*verify&~=&~helo*&
28828 .cindex "&%verify%& ACL condition"
28829 .cindex "&ACL;" "verifying HELO/EHLO"
28830 .cindex "HELO" "verifying"
28831 .cindex "EHLO" "verifying"
28832 .cindex "verifying" "EHLO"
28833 .cindex "verifying" "HELO"
28834 This condition is true if a HELO or EHLO command has been received from the
28835 client host, and its contents have been verified. If there has been no previous
28836 attempt to verify the HELO/EHLO contents, it is carried out when this
28837 condition is encountered. See the description of the &%helo_verify_hosts%& and
28838 &%helo_try_verify_hosts%& options for details of how to request verification
28839 independently of this condition.
28840
28841 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28842 option), this condition is always true.
28843
28844
28845 .vitem &*verify&~=&~not_blind*&
28846 .cindex "verifying" "not blind"
28847 .cindex "bcc recipients, verifying none"
28848 This condition checks that there are no blind (bcc) recipients in the message.
28849 Every envelope recipient must appear either in a &'To:'& header line or in a
28850 &'Cc:'& header line for this condition to be true. Local parts are checked
28851 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28852 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28853 used only in a DATA or non-SMTP ACL.
28854
28855 There are, of course, many legitimate messages that make use of blind (bcc)
28856 recipients. This check should not be used on its own for blocking messages.
28857
28858
28859 .vitem &*verify&~=&~recipient/*&<&'options'&>
28860 .cindex "&%verify%& ACL condition"
28861 .cindex "&ACL;" "verifying recipient"
28862 .cindex "recipient" "verifying"
28863 .cindex "verifying" "recipient"
28864 .vindex "&$address_data$&"
28865 This condition is relevant only after a RCPT command. It verifies the current
28866 recipient. Details of address verification are given later, starting at section
28867 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28868 of &$address_data$& is the last value that was set while routing the address.
28869 This applies even if the verification fails. When an address that is being
28870 verified is redirected to a single address, verification continues with the new
28871 address, and in that case, the subsequent value of &$address_data$& is the
28872 value for the child address.
28873
28874 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
28875 .cindex "&%verify%& ACL condition"
28876 .cindex "&ACL;" "verifying host reverse lookup"
28877 .cindex "host" "verifying reverse lookup"
28878 This condition ensures that a verified host name has been looked up from the IP
28879 address of the client host. (This may have happened already if the host name
28880 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28881 Verification ensures that the host name obtained from a reverse DNS lookup, or
28882 one of its aliases, does, when it is itself looked up in the DNS, yield the
28883 original IP address.
28884
28885 There is one possible option, &`defer_ok`&.  If this is present and a
28886 DNS operation returns a temporary error, the verify condition succeeds.
28887
28888 If this condition is used for a locally generated message (that is, when there
28889 is no client host involved), it always succeeds.
28890
28891 .vitem &*verify&~=&~sender/*&<&'options'&>
28892 .cindex "&%verify%& ACL condition"
28893 .cindex "&ACL;" "verifying sender"
28894 .cindex "sender" "verifying"
28895 .cindex "verifying" "sender"
28896 This condition is relevant only after a MAIL or RCPT command, or after a
28897 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28898 the message's sender is empty (that is, this is a bounce message), the
28899 condition is true. Otherwise, the sender address is verified.
28900
28901 .vindex "&$address_data$&"
28902 .vindex "&$sender_address_data$&"
28903 If there is data in the &$address_data$& variable at the end of routing, its
28904 value is placed in &$sender_address_data$& at the end of verification. This
28905 value can be used in subsequent conditions and modifiers in the same ACL
28906 statement. It does not persist after the end of the current statement. If you
28907 want to preserve the value for longer, you can save it in an ACL variable.
28908
28909 Details of verification are given later, starting at section
28910 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28911 to avoid doing it more than once per message.
28912
28913 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28914 .cindex "&%verify%& ACL condition"
28915 This is a variation of the previous option, in which a modified address is
28916 verified as a sender.
28917 .endlist
28918
28919
28920
28921 .section "Using DNS lists" "SECTmorednslists"
28922 .cindex "DNS list" "in ACL"
28923 .cindex "black list (DNS)"
28924 .cindex "&ACL;" "testing a DNS list"
28925 In its simplest form, the &%dnslists%& condition tests whether the calling host
28926 is on at least one of a number of DNS lists by looking up the inverted IP
28927 address in one or more DNS domains. (Note that DNS list domains are not mail
28928 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28929 special options instead.) For example, if the calling host's IP
28930 address is 192.168.62.43, and the ACL statement is
28931 .code
28932 deny dnslists = blackholes.mail-abuse.org : \
28933                 dialups.mail-abuse.org
28934 .endd
28935 the following records are looked up:
28936 .code
28937 43.62.168.192.blackholes.mail-abuse.org
28938 43.62.168.192.dialups.mail-abuse.org
28939 .endd
28940 As soon as Exim finds an existing DNS record, processing of the list stops.
28941 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28942 to test that a host is on more than one list (an &"and"& conjunction), you can
28943 use two separate conditions:
28944 .code
28945 deny dnslists = blackholes.mail-abuse.org
28946      dnslists = dialups.mail-abuse.org
28947 .endd
28948 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28949 behaves as if the host does not match the list item, that is, as if the DNS
28950 record does not exist. If there are further items in the DNS list, they are
28951 processed.
28952
28953 This is usually the required action when &%dnslists%& is used with &%deny%&
28954 (which is the most common usage), because it prevents a DNS failure from
28955 blocking mail. However, you can change this behaviour by putting one of the
28956 following special items in the list:
28957 .display
28958 &`+include_unknown `&   behave as if the item is on the list
28959 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28960 &`+defer_unknown   `&   give a temporary error
28961 .endd
28962 .cindex "&`+include_unknown`&"
28963 .cindex "&`+exclude_unknown`&"
28964 .cindex "&`+defer_unknown`&"
28965 Each of these applies to any subsequent items on the list. For example:
28966 .code
28967 deny dnslists = +defer_unknown : foo.bar.example
28968 .endd
28969 Testing the list of domains stops as soon as a match is found. If you want to
28970 warn for one list and block for another, you can use two different statements:
28971 .code
28972 deny  dnslists = blackholes.mail-abuse.org
28973 warn  message  = X-Warn: sending host is on dialups list
28974       dnslists = dialups.mail-abuse.org
28975 .endd
28976 DNS list lookups are cached by Exim for the duration of the SMTP session,
28977 so a lookup based on the IP address is done at most once for any incoming
28978 connection. Exim does not share information between multiple incoming
28979 connections (but your local name server cache should be active).
28980
28981
28982
28983 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28984 .cindex "DNS list" "keyed by explicit IP address"
28985 By default, the IP address that is used in a DNS list lookup is the IP address
28986 of the calling host. However, you can specify another IP address by listing it
28987 after the domain name, introduced by a slash. For example:
28988 .code
28989 deny dnslists = black.list.tld/192.168.1.2
28990 .endd
28991 This feature is not very helpful with explicit IP addresses; it is intended for
28992 use with IP addresses that are looked up, for example, the IP addresses of the
28993 MX hosts or nameservers of an email sender address. For an example, see section
28994 &<<SECTmulkeyfor>>& below.
28995
28996
28997
28998
28999 .section "DNS lists keyed on domain names" "SECID202"
29000 .cindex "DNS list" "keyed by domain name"
29001 There are some lists that are keyed on domain names rather than inverted IP
29002 addresses (see for example the &'domain based zones'& link at
29003 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29004 with these lists. You can change the name that is looked up in a DNS list by
29005 listing it after the domain name, introduced by a slash. For example,
29006 .code
29007 deny  message  = Sender's domain is listed at $dnslist_domain
29008       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29009 .endd
29010 This particular example is useful only in ACLs that are obeyed after the
29011 RCPT or DATA commands, when a sender address is available. If (for
29012 example) the message's sender is &'user@tld.example'& the name that is looked
29013 up by this example is
29014 .code
29015 tld.example.dsn.rfc-ignorant.org
29016 .endd
29017 A single &%dnslists%& condition can contain entries for both names and IP
29018 addresses. For example:
29019 .code
29020 deny dnslists = sbl.spamhaus.org : \
29021                 dsn.rfc-ignorant.org/$sender_address_domain
29022 .endd
29023 The first item checks the sending host's IP address; the second checks a domain
29024 name. The whole condition is true if either of the DNS lookups succeeds.
29025
29026
29027
29028
29029 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29030 .cindex "DNS list" "multiple keys for"
29031 The syntax described above for looking up explicitly-defined values (either
29032 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29033 name for the DNS list, what follows the slash can in fact be a list of items.
29034 As with all lists in Exim, the default separator is a colon. However, because
29035 this is a sublist within the list of DNS blacklist domains, it is necessary
29036 either to double the separators like this:
29037 .code
29038 dnslists = black.list.tld/name.1::name.2
29039 .endd
29040 or to change the separator character, like this:
29041 .code
29042 dnslists = black.list.tld/<;name.1;name.2
29043 .endd
29044 If an item in the list is an IP address, it is inverted before the DNS
29045 blacklist domain is appended. If it is not an IP address, no inversion
29046 occurs. Consider this condition:
29047 .code
29048 dnslists = black.list.tld/<;192.168.1.2;a.domain
29049 .endd
29050 The DNS lookups that occur are:
29051 .code
29052 2.1.168.192.black.list.tld
29053 a.domain.black.list.tld
29054 .endd
29055 Once a DNS record has been found (that matches a specific IP return
29056 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29057 are done. If there is a temporary DNS error, the rest of the sublist of domains
29058 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29059 only if no other DNS lookup in this sublist succeeds. In other words, a
29060 successful lookup for any of the items in the sublist overrides a temporary
29061 error for a previous item.
29062
29063 The ability to supply a list of items after the slash is in some sense just a
29064 syntactic convenience. These two examples have the same effect:
29065 .code
29066 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29067 dnslists = black.list.tld/a.domain::b.domain
29068 .endd
29069 However, when the data for the list is obtained from a lookup, the second form
29070 is usually much more convenient. Consider this example:
29071 .code
29072 deny message  = The mail servers for the domain \
29073                 $sender_address_domain \
29074                 are listed at $dnslist_domain ($dnslist_value); \
29075                 see $dnslist_text.
29076      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29077                                    ${lookup dnsdb {>|mxh=\
29078                                    $sender_address_domain} }} }
29079 .endd
29080 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29081 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29082 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29083 of expanding the condition might be something like this:
29084 .code
29085 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29086 .endd
29087 Thus, this example checks whether or not the IP addresses of the sender
29088 domain's mail servers are on the Spamhaus black list.
29089
29090 The key that was used for a successful DNS list lookup is put into the variable
29091 &$dnslist_matched$& (see section &<<SECID204>>&).
29092
29093
29094
29095
29096 .section "Data returned by DNS lists" "SECID203"
29097 .cindex "DNS list" "data returned from"
29098 DNS lists are constructed using address records in the DNS. The original RBL
29099 just used the address 127.0.0.1 on the right hand side of each record, but the
29100 RBL+ list and some other lists use a number of values with different meanings.
29101 The values used on the RBL+ list are:
29102 .display
29103 127.1.0.1  RBL
29104 127.1.0.2  DUL
29105 127.1.0.3  DUL and RBL
29106 127.1.0.4  RSS
29107 127.1.0.5  RSS and RBL
29108 127.1.0.6  RSS and DUL
29109 127.1.0.7  RSS and DUL and RBL
29110 .endd
29111 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29112 different values. Some DNS lists may return more than one address record;
29113 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29114
29115
29116 .section "Variables set from DNS lists" "SECID204"
29117 .cindex "expansion" "variables, set from DNS list"
29118 .cindex "DNS list" "variables set from"
29119 .vindex "&$dnslist_domain$&"
29120 .vindex "&$dnslist_matched$&"
29121 .vindex "&$dnslist_text$&"
29122 .vindex "&$dnslist_value$&"
29123 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29124 the name of the overall domain that matched (for example,
29125 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29126 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29127 the DNS record. When the key is an IP address, it is not reversed in
29128 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29129 cases, for example:
29130 .code
29131 deny dnslists = spamhaus.example
29132 .endd
29133 the key is also available in another variable (in this case,
29134 &$sender_host_address$&). In more complicated cases, however, this is not true.
29135 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29136 might generate a dnslists lookup like this:
29137 .code
29138 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29139 .endd
29140 If this condition succeeds, the value in &$dnslist_matched$& might be
29141 &`192.168.6.7`& (for example).
29142
29143 If more than one address record is returned by the DNS lookup, all the IP
29144 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29145 The variable &$dnslist_text$& contains the contents of any associated TXT
29146 record. For lists such as RBL+ the TXT record for a merged entry is often not
29147 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29148 information.
29149
29150 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29151 &-- although these appear before the condition in the ACL, they are not
29152 expanded until after it has failed. For example:
29153 .code
29154 deny    hosts = !+local_networks
29155         message = $sender_host_address is listed \
29156                   at $dnslist_domain
29157         dnslists = rbl-plus.mail-abuse.example
29158 .endd
29159
29160
29161
29162 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29163 .cindex "DNS list" "matching specific returned data"
29164 You can add an equals sign and an IP address after a &%dnslists%& domain name
29165 in order to restrict its action to DNS records with a matching right hand side.
29166 For example,
29167 .code
29168 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29169 .endd
29170 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29171 any address record is considered to be a match. For the moment, we assume
29172 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29173 describes how multiple records are handled.
29174
29175 More than one IP address may be given for checking, using a comma as a
29176 separator. These are alternatives &-- if any one of them matches, the
29177 &%dnslists%& condition is true. For example:
29178 .code
29179 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29180 .endd
29181 If you want to specify a constraining address list and also specify names or IP
29182 addresses to be looked up, the constraining address list must be specified
29183 first. For example:
29184 .code
29185 deny dnslists = dsn.rfc-ignorant.org\
29186                 =127.0.0.2/$sender_address_domain
29187 .endd
29188
29189 If the character &`&&`& is used instead of &`=`&, the comparison for each
29190 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29191 In other words, the listed addresses are used as bit masks. The comparison is
29192 true if all the bits in the mask are present in the address that is being
29193 tested. For example:
29194 .code
29195 dnslists = a.b.c&0.0.0.3
29196 .endd
29197 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29198 want to test whether one bit or another bit is present (as opposed to both
29199 being present), you must use multiple values. For example:
29200 .code
29201 dnslists = a.b.c&0.0.0.1,0.0.0.2
29202 .endd
29203 matches if the final component of the address is an odd number or two times
29204 an odd number.
29205
29206
29207
29208 .section "Negated DNS matching conditions" "SECID205"
29209 You can supply a negative list of IP addresses as part of a &%dnslists%&
29210 condition. Whereas
29211 .code
29212 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29213 .endd
29214 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29215 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29216 .code
29217 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29218 .endd
29219 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29220 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29221 words, the result of the test is inverted if an exclamation mark appears before
29222 the &`=`& (or the &`&&`&) sign.
29223
29224 &*Note*&: This kind of negation is not the same as negation in a domain,
29225 host, or address list (which is why the syntax is different).
29226
29227 If you are using just one list, the negation syntax does not gain you much. The
29228 previous example is precisely equivalent to
29229 .code
29230 deny  dnslists = a.b.c
29231      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29232 .endd
29233 However, if you are using multiple lists, the negation syntax is clearer.
29234 Consider this example:
29235 .code
29236 deny  dnslists = sbl.spamhaus.org : \
29237                  list.dsbl.org : \
29238                  dnsbl.njabl.org!=127.0.0.3 : \
29239                  relays.ordb.org
29240 .endd
29241 Using only positive lists, this would have to be:
29242 .code
29243 deny  dnslists = sbl.spamhaus.org : \
29244                  list.dsbl.org
29245 deny  dnslists = dnsbl.njabl.org
29246      !dnslists = dnsbl.njabl.org=127.0.0.3
29247 deny  dnslists = relays.ordb.org
29248 .endd
29249 which is less clear, and harder to maintain.
29250
29251
29252
29253
29254 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29255 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29256 thereby providing more than one IP address. When an item in a &%dnslists%& list
29257 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29258 the match to specific results from the DNS lookup, there are two ways in which
29259 the checking can be handled. For example, consider the condition:
29260 .code
29261 dnslists = a.b.c=127.0.0.1
29262 .endd
29263 What happens if the DNS lookup for the incoming IP address yields both
29264 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29265 condition true because at least one given value was found, or is it false
29266 because at least one of the found values was not listed? And how does this
29267 affect negated conditions? Both possibilities are provided for with the help of
29268 additional separators &`==`& and &`=&&`&.
29269
29270 .ilist
29271 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29272 IP addresses matches one of the listed addresses. For the example above, the
29273 condition is true because 127.0.0.1 matches.
29274 .next
29275 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29276 looked up IP addresses matches one of the listed addresses. If the condition is
29277 changed to:
29278 .code
29279 dnslists = a.b.c==127.0.0.1
29280 .endd
29281 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29282 false because 127.0.0.2 is not listed. You would need to have:
29283 .code
29284 dnslists = a.b.c==127.0.0.1,127.0.0.2
29285 .endd
29286 for the condition to be true.
29287 .endlist
29288
29289 When &`!`& is used to negate IP address matching, it inverts the result, giving
29290 the precise opposite of the behaviour above. Thus:
29291 .ilist
29292 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29293 addresses matches one of the listed addresses. Consider:
29294 .code
29295 dnslists = a.b.c!&0.0.0.1
29296 .endd
29297 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29298 false because 127.0.0.1 matches.
29299 .next
29300 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29301 looked up IP address that does not match. Consider:
29302 .code
29303 dnslists = a.b.c!=&0.0.0.1
29304 .endd
29305 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29306 true, because 127.0.0.2 does not match. You would need to have:
29307 .code
29308 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29309 .endd
29310 for the condition to be false.
29311 .endlist
29312 When the DNS lookup yields only a single IP address, there is no difference
29313 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29314
29315
29316
29317
29318 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29319 .cindex "DNS list" "information from merged"
29320 When the facility for restricting the matching IP values in a DNS list is used,
29321 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29322 the true reason for rejection. This happens when lists are merged and the IP
29323 address in the A record is used to distinguish them; unfortunately there is
29324 only one TXT record. One way round this is not to use merged lists, but that
29325 can be inefficient because it requires multiple DNS lookups where one would do
29326 in the vast majority of cases when the host of interest is not on any of the
29327 lists.
29328
29329 A less inefficient way of solving this problem is available. If
29330 two domain names, comma-separated, are given, the second is used first to
29331 do an initial check, making use of any IP value restrictions that are set.
29332 If there is a match, the first domain is used, without any IP value
29333 restrictions, to get the TXT record. As a byproduct of this, there is also
29334 a check that the IP being tested is indeed on the first list. The first
29335 domain is the one that is put in &$dnslist_domain$&. For example:
29336 .code
29337 reject message  = \
29338          rejected because $sender_host_address is blacklisted \
29339          at $dnslist_domain\n$dnslist_text
29340        dnslists = \
29341          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29342          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29343 .endd
29344 For the first blacklist item, this starts by doing a lookup in
29345 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29346 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29347 value, and as long as something is found, it looks for the corresponding TXT
29348 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29349 The second blacklist item is processed similarly.
29350
29351 If you are interested in more than one merged list, the same list must be
29352 given several times, but because the results of the DNS lookups are cached,
29353 the DNS calls themselves are not repeated. For example:
29354 .code
29355 reject dnslists = \
29356          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29357          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29358          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29359          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29360 .endd
29361 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29362 values matches (or if no record is found), this is the only lookup that is
29363 done. Only if there is a match is one of the more specific lists consulted.
29364
29365
29366
29367 .section "DNS lists and IPv6" "SECTmorednslistslast"
29368 .cindex "IPv6" "DNS black lists"
29369 .cindex "DNS list" "IPv6 usage"
29370 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29371 nibble by nibble. For example, if the calling host's IP address is
29372 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29373 .code
29374 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29375   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29376 .endd
29377 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29378 lists contain wildcard records, intended for IPv4, that interact badly with
29379 IPv6. For example, the DNS entry
29380 .code
29381 *.3.some.list.example.    A    127.0.0.1
29382 .endd
29383 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29384 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29385
29386 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29387 &%condition%& condition, as in this example:
29388 .code
29389 deny   condition = ${if isip4{$sender_host_address}}
29390        dnslists  = some.list.example
29391 .endd
29392
29393 If an explicit key is being used for a DNS lookup and it may be an IPv6
29394 address you should specify alternate list separators for both the outer
29395 (DNS list name) list and inner (lookup keys) list:
29396 .code
29397        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29398 .endd
29399
29400 .section "Rate limiting incoming messages" "SECTratelimiting"
29401 .cindex "rate limiting" "client sending"
29402 .cindex "limiting client sending rates"
29403 .oindex "&%smtp_ratelimit_*%&"
29404 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29405 which clients can send email. This is more powerful than the
29406 &%smtp_ratelimit_*%& options, because those options control the rate of
29407 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29408 works across all connections (concurrent and sequential) from the same client
29409 host. The syntax of the &%ratelimit%& condition is:
29410 .display
29411 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29412 .endd
29413 If the average client sending rate is less than &'m'& messages per time
29414 period &'p'& then the condition is false; otherwise it is true.
29415
29416 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29417 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29418 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29419 of &'p'&.
29420
29421 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29422 time interval, for example, &`8h`& for eight hours. A larger time constant
29423 means that it takes Exim longer to forget a client's past behaviour. The
29424 parameter &'m'& is the maximum number of messages that a client is permitted to
29425 send in each time interval. It also specifies the number of messages permitted
29426 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29427 constant, you can allow a client to send more messages in a burst without
29428 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29429 both small, messages must be sent at an even rate.
29430
29431 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29432 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29433 when deploying the &%ratelimit%& ACL condition. The script prints usage
29434 instructions when it is run with no arguments.
29435
29436 The key is used to look up the data for calculating the client's average
29437 sending rate. This data is stored in Exim's spool directory, alongside the
29438 retry and other hints databases. The default key is &$sender_host_address$&,
29439 which means Exim computes the sending rate of each client host IP address.
29440 By changing the key you can change how Exim identifies clients for the purpose
29441 of ratelimiting. For example, to limit the sending rate of each authenticated
29442 user, independent of the computer they are sending from, set the key to
29443 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29444 example, &$authenticated_id$& is only meaningful if the client has
29445 authenticated (which you can check with the &%authenticated%& ACL condition).
29446
29447 The lookup key does not have to identify clients: If you want to limit the
29448 rate at which a recipient receives messages, you can use the key
29449 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29450 ACL.
29451
29452 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29453 specifies what Exim measures the rate of, for example messages or recipients
29454 or bytes. You can adjust the measurement using the &%unique=%& and/or
29455 &%count=%& options. You can also control when Exim updates the recorded rate
29456 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29457 separated by a slash, like the other parameters. They may appear in any order.
29458
29459 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29460 any options that alter the meaning of the stored data. The limit &'m'& is not
29461 stored, so you can alter the configured maximum rate and Exim will still
29462 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29463 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29464 behaviour. The lookup key is not affected by changes to the update mode and
29465 the &%count=%& option.
29466
29467
29468 .section "Ratelimit options for what is being measured" "ratoptmea"
29469 .cindex "rate limiting" "per_* options"
29470 The &%per_conn%& option limits the client's connection rate. It is not
29471 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29472 &%acl_not_smtp_start%& ACLs.
29473
29474 The &%per_mail%& option limits the client's rate of sending messages. This is
29475 the default if none of the &%per_*%& options is specified. It can be used in
29476 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29477 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29478
29479 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29480 the same ACLs as the &%per_mail%& option, though it is best to use this option
29481 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29482 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29483 in its MAIL command, which may be inaccurate or completely missing. You can
29484 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29485 in kilobytes, megabytes, or gigabytes, respectively.
29486
29487 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29488 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29489 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29490 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29491 ACLs the rate is updated with the total recipient count in one go. Note that
29492 in either case the rate limiting engine will see a message with many
29493 recipients as a large high-speed burst.
29494
29495 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29496 number of different recipients that the client has sent messages to in the
29497 last time period. That is, if the client repeatedly sends messages to the same
29498 recipient, its measured rate is not increased. This option can only be used in
29499 &%acl_smtp_rcpt%&.
29500
29501 The &%per_cmd%& option causes Exim to recompute the rate every time the
29502 condition is processed. This can be used to limit the rate of any SMTP
29503 command. If it is used in multiple ACLs it can limit the aggregate rate of
29504 multiple different commands.
29505
29506 The &%count=%& option can be used to alter how much Exim adds to the client's
29507 measured rate. For example, the &%per_byte%& option is equivalent to
29508 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29509 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29510 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29511
29512 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29513
29514
29515 .section "Ratelimit update modes" "ratoptupd"
29516 .cindex "rate limiting" "reading data without updating"
29517 You can specify one of three options with the &%ratelimit%& condition to
29518 control when its database is updated. This section describes the &%readonly%&
29519 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29520
29521 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29522 previously-computed rate to check against the limit.
29523
29524 For example, you can test the client's sending rate and deny it access (when
29525 it is too fast) in the connect ACL. If the client passes this check then it
29526 can go on to send a message, in which case its recorded rate will be updated
29527 in the MAIL ACL. Subsequent connections from the same client will check this
29528 new rate.
29529 .code
29530 acl_check_connect:
29531  deny ratelimit = 100 / 5m / readonly
29532     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29533                   (max $sender_rate_limit)
29534 # ...
29535 acl_check_mail:
29536  warn ratelimit = 100 / 5m / strict
29537     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29538                   (max $sender_rate_limit)
29539 .endd
29540
29541 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29542 processing a message then it may increase the client's measured rate more than
29543 it should. For example, this will happen if you check the &%per_rcpt%& option
29544 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29545 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29546 multiple update problems by using the &%readonly%& option on later ratelimit
29547 checks.
29548
29549 The &%per_*%& options described above do not make sense in some ACLs. If you
29550 use a &%per_*%& option in an ACL where it is not normally permitted then the
29551 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29552 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29553 next section) so you must specify the &%readonly%& option explicitly.
29554
29555
29556 .section "Ratelimit options for handling fast clients" "ratoptfast"
29557 .cindex "rate limiting" "strict and leaky modes"
29558 If a client's average rate is greater than the maximum, the rate limiting
29559 engine can react in two possible ways, depending on the presence of the
29560 &%strict%& or &%leaky%& update modes. This is independent of the other
29561 counter-measures (such as rejecting the message) that may be specified by the
29562 rest of the ACL.
29563
29564 The &%leaky%& (default) option means that the client's recorded rate is not
29565 updated if it is above the limit. The effect of this is that Exim measures the
29566 client's average rate of successfully sent email, which cannot be greater than
29567 the maximum allowed. If the client is over the limit it may suffer some
29568 counter-measures (as specified in the ACL), but it will still be able to send
29569 email at the configured maximum rate, whatever the rate of its attempts. This
29570 is generally the better choice if you have clients that retry automatically.
29571 For example, it does not prevent a sender with an over-aggressive retry rate
29572 from getting any email through.
29573
29574 The &%strict%& option means that the client's recorded rate is always
29575 updated. The effect of this is that Exim measures the client's average rate
29576 of attempts to send email, which can be much higher than the maximum it is
29577 actually allowed. If the client is over the limit it may be subjected to
29578 counter-measures by the ACL. It must slow down and allow sufficient time to
29579 pass that its computed rate falls below the maximum before it can send email
29580 again. The time (the number of smoothing periods) it must wait and not
29581 attempt to send mail can be calculated with this formula:
29582 .code
29583         ln(peakrate/maxrate)
29584 .endd
29585
29586
29587 .section "Limiting the rate of different events" "ratoptuniq"
29588 .cindex "rate limiting" "counting unique events"
29589 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29590 rate of different events. For example, the &%per_addr%& option uses this
29591 mechanism to count the number of different recipients that the client has
29592 sent messages to in the last time period; it is equivalent to
29593 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29594 measure the rate that a client uses different sender addresses with the
29595 options &`per_mail/unique=$sender_address`&.
29596
29597 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29598 has seen for that key. The whole set is thrown away when it is older than the
29599 rate smoothing period &'p'&, so each different event is counted at most once
29600 per period. In the &%leaky%& update mode, an event that causes the client to
29601 go over the limit is not added to the set, in the same way that the client's
29602 recorded rate is not updated in the same situation.
29603
29604 When you combine the &%unique=%& and &%readonly%& options, the specific
29605 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29606 rate.
29607
29608 The &%unique=%& mechanism needs more space in the ratelimit database than the
29609 other &%ratelimit%& options in order to store the event set. The number of
29610 unique values is potentially as large as the rate limit, so the extra space
29611 required increases with larger limits.
29612
29613 The uniqueification is not perfect: there is a small probability that Exim
29614 will think a new event has happened before. If the sender's rate is less than
29615 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29616 the measured rate can go above the limit, in which case Exim may under-count
29617 events by a significant margin. Fortunately, if the rate is high enough (2.7
29618 times the limit) that the false positive rate goes above 9%, then Exim will
29619 throw away the over-full event set before the measured rate falls below the
29620 limit. Therefore the only harm should be that exceptionally high sending rates
29621 are logged incorrectly; any countermeasures you configure will be as effective
29622 as intended.
29623
29624
29625 .section "Using rate limiting" "useratlim"
29626 Exim's other ACL facilities are used to define what counter-measures are taken
29627 when the rate limit is exceeded. This might be anything from logging a warning
29628 (for example, while measuring existing sending rates in order to define
29629 policy), through time delays to slow down fast senders, up to rejecting the
29630 message. For example:
29631 .code
29632 # Log all senders' rates
29633 warn ratelimit = 0 / 1h / strict
29634      log_message = Sender rate $sender_rate / $sender_rate_period
29635
29636 # Slow down fast senders; note the need to truncate $sender_rate
29637 # at the decimal point.
29638 warn ratelimit = 100 / 1h / per_rcpt / strict
29639      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29640                    $sender_rate_limit }s
29641
29642 # Keep authenticated users under control
29643 deny authenticated = *
29644      ratelimit = 100 / 1d / strict / $authenticated_id
29645
29646 # System-wide rate limit
29647 defer message = Sorry, too busy. Try again later.
29648      ratelimit = 10 / 1s / $primary_hostname
29649
29650 # Restrict incoming rate from each host, with a default
29651 # set using a macro and special cases looked up in a table.
29652 defer message = Sender rate exceeds $sender_rate_limit \
29653                messages per $sender_rate_period
29654      ratelimit = ${lookup {$sender_host_address} \
29655                    cdb {DB/ratelimits.cdb} \
29656                    {$value} {RATELIMIT} }
29657 .endd
29658 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29659 especially with the &%per_rcpt%& option, you may suffer from a performance
29660 bottleneck caused by locking on the ratelimit hints database. Apart from
29661 making your ACLs less complicated, you can reduce the problem by using a
29662 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29663 this means that Exim will lose its hints data after a reboot (including retry
29664 hints, the callout cache, and ratelimit data).
29665
29666
29667
29668 .section "Address verification" "SECTaddressverification"
29669 .cindex "verifying address" "options for"
29670 .cindex "policy control" "address verification"
29671 Several of the &%verify%& conditions described in section
29672 &<<SECTaclconditions>>& cause addresses to be verified. Section
29673 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29674 The verification conditions can be followed by options that modify the
29675 verification process. The options are separated from the keyword and from each
29676 other by slashes, and some of them contain parameters. For example:
29677 .code
29678 verify = sender/callout
29679 verify = recipient/defer_ok/callout=10s,defer_ok
29680 .endd
29681 The first stage of address verification, which always happens, is to run the
29682 address through the routers, in &"verify mode"&. Routers can detect the
29683 difference between verification and routing for delivery, and their actions can
29684 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29685 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29686 The available options are as follows:
29687
29688 .ilist
29689 If the &%callout%& option is specified, successful routing to one or more
29690 remote hosts is followed by a &"callout"& to those hosts as an additional
29691 check. Callouts and their sub-options are discussed in the next section.
29692 .next
29693 If there is a defer error while doing verification routing, the ACL
29694 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29695 options, the condition is forced to be true instead. Note that this is a main
29696 verification option as well as a suboption for callouts.
29697 .next
29698 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29699 discusses the reporting of sender address verification failures.
29700 .next
29701 The &%success_on_redirect%& option causes verification always to succeed
29702 immediately after a successful redirection. By default, if a redirection
29703 generates just one address, that address is also verified. See further
29704 discussion in section &<<SECTredirwhilveri>>&.
29705 .endlist
29706
29707 .cindex "verifying address" "differentiating failures"
29708 .vindex "&$recipient_verify_failure$&"
29709 .vindex "&$sender_verify_failure$&"
29710 .vindex "&$acl_verify_message$&"
29711 After an address verification failure, &$acl_verify_message$& contains the
29712 error message that is associated with the failure. It can be preserved by
29713 coding like this:
29714 .code
29715 warn  !verify = sender
29716        set acl_m0 = $acl_verify_message
29717 .endd
29718 If you are writing your own custom rejection message or log message when
29719 denying access, you can use this variable to include information about the
29720 verification failure.
29721
29722 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29723 appropriate) contains one of the following words:
29724
29725 .ilist
29726 &%qualify%&: The address was unqualified (no domain), and the message
29727 was neither local nor came from an exempted host.
29728 .next
29729 &%route%&: Routing failed.
29730 .next
29731 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29732 occurred at or before the MAIL command (that is, on initial
29733 connection, HELO, or MAIL).
29734 .next
29735 &%recipient%&: The RCPT command in a callout was rejected.
29736 .next
29737 &%postmaster%&: The postmaster check in a callout was rejected.
29738 .endlist
29739
29740 The main use of these variables is expected to be to distinguish between
29741 rejections of MAIL and rejections of RCPT in callouts.
29742
29743
29744
29745
29746 .section "Callout verification" "SECTcallver"
29747 .cindex "verifying address" "by callout"
29748 .cindex "callout" "verification"
29749 .cindex "SMTP" "callout verification"
29750 For non-local addresses, routing verifies the domain, but is unable to do any
29751 checking of the local part. There are situations where some means of verifying
29752 the local part is desirable. One way this can be done is to make an SMTP
29753 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29754 a subsequent host for a recipient address, to see if the host accepts the
29755 address. We use the term &'callout'& to cover both cases. Note that for a
29756 sender address, the callback is not to the client host that is trying to
29757 deliver the message, but to one of the hosts that accepts incoming mail for the
29758 sender's domain.
29759
29760 Exim does not do callouts by default. If you want them to happen, you must
29761 request them by setting appropriate options on the &%verify%& condition, as
29762 described below. This facility should be used with care, because it can add a
29763 lot of resource usage to the cost of verifying an address. However, Exim does
29764 cache the results of callouts, which helps to reduce the cost. Details of
29765 caching are in section &<<SECTcallvercache>>&.
29766
29767 Recipient callouts are usually used only between hosts that are controlled by
29768 the same administration. For example, a corporate gateway host could use
29769 callouts to check for valid recipients on an internal mailserver. A successful
29770 callout does not guarantee that a real delivery to the address would succeed;
29771 on the other hand, a failing callout does guarantee that a delivery would fail.
29772
29773 If the &%callout%& option is present on a condition that verifies an address, a
29774 second stage of verification occurs if the address is successfully routed to
29775 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29776 &(manualroute)& router, where the router specifies the hosts. However, if a
29777 router that does not set up hosts routes to an &(smtp)& transport with a
29778 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29779 &%hosts_override%& set, its hosts are always used, whether or not the router
29780 supplies a host list.
29781 Callouts are only supported on &(smtp)& transports.
29782
29783 The port that is used is taken from the transport, if it is specified and is a
29784 remote transport. (For routers that do verification only, no transport need be
29785 specified.) Otherwise, the default SMTP port is used. If a remote transport
29786 specifies an outgoing interface, this is used; otherwise the interface is not
29787 specified. Likewise, the text that is used for the HELO command is taken from
29788 the transport's &%helo_data%& option; if there is no transport, the value of
29789 &$smtp_active_hostname$& is used.
29790
29791 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29792 test whether a bounce message could be delivered to the sender address. The
29793 following SMTP commands are sent:
29794 .display
29795 &`HELO `&<&'local host name'&>
29796 &`MAIL FROM:<>`&
29797 &`RCPT TO:`&<&'the address to be tested'&>
29798 &`QUIT`&
29799 .endd
29800 LHLO is used instead of HELO if the transport's &%protocol%& option is
29801 set to &"lmtp"&.
29802
29803 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29804 settings.
29805
29806 A recipient callout check is similar. By default, it also uses an empty address
29807 for the sender. This default is chosen because most hosts do not make use of
29808 the sender address when verifying a recipient. Using the same address means
29809 that a single cache entry can be used for each recipient. Some sites, however,
29810 do make use of the sender address when verifying. These are catered for by the
29811 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29812
29813 If the response to the RCPT command is a 2&'xx'& code, the verification
29814 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29815 Exim tries the next host, if any. If there is a problem with all the remote
29816 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29817 &%callout%& option is given, in which case the condition is forced to succeed.
29818
29819 .cindex "SMTP" "output flushing, disabling for callout"
29820 A callout may take a little time. For this reason, Exim normally flushes SMTP
29821 output before performing a callout in an ACL, to avoid unexpected timeouts in
29822 clients when the SMTP PIPELINING extension is in use. The flushing can be
29823 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29824
29825
29826
29827
29828 .section "Additional parameters for callouts" "CALLaddparcall"
29829 .cindex "callout" "additional parameters for"
29830 The &%callout%& option can be followed by an equals sign and a number of
29831 optional parameters, separated by commas. For example:
29832 .code
29833 verify = recipient/callout=10s,defer_ok
29834 .endd
29835 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29836 separate verify options, is retained for backwards compatibility, but is now
29837 deprecated. The additional parameters for &%callout%& are as follows:
29838
29839
29840 .vlist
29841 .vitem <&'a&~time&~interval'&>
29842 .cindex "callout" "timeout, specifying"
29843 This specifies the timeout that applies for the callout attempt to each host.
29844 For example:
29845 .code
29846 verify = sender/callout=5s
29847 .endd
29848 The default is 30 seconds. The timeout is used for each response from the
29849 remote host. It is also used for the initial connection, unless overridden by
29850 the &%connect%& parameter.
29851
29852
29853 .vitem &*connect&~=&~*&<&'time&~interval'&>
29854 .cindex "callout" "connection timeout, specifying"
29855 This parameter makes it possible to set a different (usually smaller) timeout
29856 for making the SMTP connection. For example:
29857 .code
29858 verify = sender/callout=5s,connect=1s
29859 .endd
29860 If not specified, this timeout defaults to the general timeout value.
29861
29862 .vitem &*defer_ok*&
29863 .cindex "callout" "defer, action on"
29864 When this parameter is present, failure to contact any host, or any other kind
29865 of temporary error, is treated as success by the ACL. However, the cache is not
29866 updated in this circumstance.
29867
29868 .vitem &*fullpostmaster*&
29869 .cindex "callout" "full postmaster check"
29870 This operates like the &%postmaster%& option (see below), but if the check for
29871 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29872 accordance with the specification in RFC 2821. The RFC states that the
29873 unqualified address &'postmaster'& should be accepted.
29874
29875
29876 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29877 .cindex "callout" "sender when verifying header"
29878 When verifying addresses in header lines using the &%header_sender%&
29879 verification option, Exim behaves by default as if the addresses are envelope
29880 sender addresses from a message. Callout verification therefore tests to see
29881 whether a bounce message could be delivered, by using an empty address in the
29882 MAIL command. However, it is arguable that these addresses might never be used
29883 as envelope senders, and could therefore justifiably reject bounce messages
29884 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29885 address to use in the MAIL command. For example:
29886 .code
29887 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29888 .endd
29889 This parameter is available only for the &%header_sender%& verification option.
29890
29891
29892 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29893 .cindex "callout" "overall timeout, specifying"
29894 This parameter sets an overall timeout for performing a callout verification.
29895 For example:
29896 .code
29897 verify = sender/callout=5s,maxwait=30s
29898 .endd
29899 This timeout defaults to four times the callout timeout for individual SMTP
29900 commands. The overall timeout applies when there is more than one host that can
29901 be tried. The timeout is checked before trying the next host. This prevents
29902 very long delays if there are a large number of hosts and all are timing out
29903 (for example, when network connections are timing out).
29904
29905
29906 .vitem &*no_cache*&
29907 .cindex "callout" "cache, suppressing"
29908 .cindex "caching callout, suppressing"
29909 When this parameter is given, the callout cache is neither read nor updated.
29910
29911 .vitem &*postmaster*&
29912 .cindex "callout" "postmaster; checking"
29913 When this parameter is set, a successful callout check is followed by a similar
29914 check for the local part &'postmaster'& at the same domain. If this address is
29915 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29916 the postmaster check is recorded in a cache record; if it is a failure, this is
29917 used to fail subsequent callouts for the domain without a connection being
29918 made, until the cache record expires.
29919
29920 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29921 The postmaster check uses an empty sender in the MAIL command by default.
29922 You can use this parameter to do a postmaster check using a different address.
29923 For example:
29924 .code
29925 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29926 .endd
29927 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29928 one overrides. The &%postmaster%& parameter is equivalent to this example:
29929 .code
29930 require  verify = sender/callout=postmaster_mailfrom=
29931 .endd
29932 &*Warning*&: The caching arrangements for postmaster checking do not take
29933 account of the sender address. It is assumed that either the empty address or
29934 a fixed non-empty address will be used. All that Exim remembers is that the
29935 postmaster check for the domain succeeded or failed.
29936
29937
29938 .vitem &*random*&
29939 .cindex "callout" "&""random""& check"
29940 When this parameter is set, before doing the normal callout check, Exim does a
29941 check for a &"random"& local part at the same domain. The local part is not
29942 really random &-- it is defined by the expansion of the option
29943 &%callout_random_local_part%&, which defaults to
29944 .code
29945 $primary_hostname-$tod_epoch-testing
29946 .endd
29947 The idea here is to try to determine whether the remote host accepts all local
29948 parts without checking. If it does, there is no point in doing callouts for
29949 specific local parts. If the &"random"& check succeeds, the result is saved in
29950 a cache record, and used to force the current and subsequent callout checks to
29951 succeed without a connection being made, until the cache record expires.
29952
29953 .vitem &*use_postmaster*&
29954 .cindex "callout" "sender for recipient check"
29955 This parameter applies to recipient callouts only. For example:
29956 .code
29957 deny  !verify = recipient/callout=use_postmaster
29958 .endd
29959 .vindex "&$qualify_domain$&"
29960 It causes a non-empty postmaster address to be used in the MAIL command when
29961 performing the callout for the recipient, and also for a &"random"& check if
29962 that is configured. The local part of the address is &`postmaster`& and the
29963 domain is the contents of &$qualify_domain$&.
29964
29965 .vitem &*use_sender*&
29966 This option applies to recipient callouts only. For example:
29967 .code
29968 require  verify = recipient/callout=use_sender
29969 .endd
29970 It causes the message's actual sender address to be used in the MAIL
29971 command when performing the callout, instead of an empty address. There is no
29972 need to use this option unless you know that the called hosts make use of the
29973 sender when checking recipients. If used indiscriminately, it reduces the
29974 usefulness of callout caching.
29975 .endlist
29976
29977 If you use any of the parameters that set a non-empty sender for the MAIL
29978 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29979 &%use_sender%&), you should think about possible loops. Recipient checking is
29980 usually done between two hosts that are under the same management, and the host
29981 that receives the callouts is not normally configured to do callouts itself.
29982 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29983 these circumstances.
29984
29985 However, if you use a non-empty sender address for a callout to an arbitrary
29986 host, there is the likelihood that the remote host will itself initiate a
29987 callout check back to your host. As it is checking what appears to be a message
29988 sender, it is likely to use an empty address in MAIL, thus avoiding a
29989 callout loop. However, to be on the safe side it would be best to set up your
29990 own ACLs so that they do not do sender verification checks when the recipient
29991 is the address you use for header sender or postmaster callout checking.
29992
29993 Another issue to think about when using non-empty senders for callouts is
29994 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29995 by the sender/recipient combination; thus, for any given recipient, many more
29996 actual callouts are performed than when an empty sender or postmaster is used.
29997
29998
29999
30000
30001 .section "Callout caching" "SECTcallvercache"
30002 .cindex "hints database" "callout cache"
30003 .cindex "callout" "cache, description of"
30004 .cindex "caching" "callout"
30005 Exim caches the results of callouts in order to reduce the amount of resources
30006 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30007 option. A hints database called &"callout"& is used for the cache. Two
30008 different record types are used: one records the result of a callout check for
30009 a specific address, and the other records information that applies to the
30010 entire domain (for example, that it accepts the local part &'postmaster'&).
30011
30012 When an original callout fails, a detailed SMTP error message is given about
30013 the failure. However, for subsequent failures use the cache data, this message
30014 is not available.
30015
30016 The expiry times for negative and positive address cache records are
30017 independent, and can be set by the global options &%callout_negative_expire%&
30018 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30019
30020 If a host gives a negative response to an SMTP connection, or rejects any
30021 commands up to and including
30022 .code
30023 MAIL FROM:<>
30024 .endd
30025 (but not including the MAIL command with a non-empty address),
30026 any callout attempt is bound to fail. Exim remembers such failures in a
30027 domain cache record, which it uses to fail callouts for the domain without
30028 making new connections, until the domain record times out. There are two
30029 separate expiry times for domain cache records:
30030 &%callout_domain_negative_expire%& (default 3h) and
30031 &%callout_domain_positive_expire%& (default 7d).
30032
30033 Domain records expire when the negative expiry time is reached if callouts
30034 cannot be made for the domain, or if the postmaster check failed.
30035 Otherwise, they expire when the positive expiry time is reached. This
30036 ensures that, for example, a host that stops accepting &"random"& local parts
30037 will eventually be noticed.
30038
30039 The callout caching mechanism is based on the domain of the address that is
30040 being tested. If the domain routes to several hosts, it is assumed that their
30041 behaviour will be the same.
30042
30043
30044
30045 .section "Sender address verification reporting" "SECTsenaddver"
30046 .cindex "verifying" "suppressing error details"
30047 See section &<<SECTaddressverification>>& for a general discussion of
30048 verification. When sender verification fails in an ACL, the details of the
30049 failure are given as additional output lines before the 550 response to the
30050 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30051 you might see:
30052 .code
30053 MAIL FROM:<xyz@abc.example>
30054 250 OK
30055 RCPT TO:<pqr@def.example>
30056 550-Verification failed for <xyz@abc.example>
30057 550-Called:   192.168.34.43
30058 550-Sent:     RCPT TO:<xyz@abc.example>
30059 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30060 550 Sender verification failed
30061 .endd
30062 If more than one RCPT command fails in the same way, the details are given
30063 only for the first of them. However, some administrators do not want to send
30064 out this much information. You can suppress the details by adding
30065 &`/no_details`& to the ACL statement that requests sender verification. For
30066 example:
30067 .code
30068 verify = sender/no_details
30069 .endd
30070
30071 .section "Redirection while verifying" "SECTredirwhilveri"
30072 .cindex "verifying" "redirection while"
30073 .cindex "address redirection" "while verifying"
30074 A dilemma arises when a local address is redirected by aliasing or forwarding
30075 during verification: should the generated addresses themselves be verified,
30076 or should the successful expansion of the original address be enough to verify
30077 it? By default, Exim takes the following pragmatic approach:
30078
30079 .ilist
30080 When an incoming address is redirected to just one child address, verification
30081 continues with the child address, and if that fails to verify, the original
30082 verification also fails.
30083 .next
30084 When an incoming address is redirected to more than one child address,
30085 verification does not continue. A success result is returned.
30086 .endlist
30087
30088 This seems the most reasonable behaviour for the common use of aliasing as a
30089 way of redirecting different local parts to the same mailbox. It means, for
30090 example, that a pair of alias entries of the form
30091 .code
30092 A.Wol:   aw123
30093 aw123:   :fail: Gone away, no forwarding address
30094 .endd
30095 work as expected, with both local parts causing verification failure. When a
30096 redirection generates more than one address, the behaviour is more like a
30097 mailing list, where the existence of the alias itself is sufficient for
30098 verification to succeed.
30099
30100 It is possible, however, to change the default behaviour so that all successful
30101 redirections count as successful verifications, however many new addresses are
30102 generated. This is specified by the &%success_on_redirect%& verification
30103 option. For example:
30104 .code
30105 require verify = recipient/success_on_redirect/callout=10s
30106 .endd
30107 In this example, verification succeeds if a router generates a new address, and
30108 the callout does not occur, because no address was routed to a remote host.
30109
30110 When verification is being tested via the &%-bv%& option, the treatment of
30111 redirections is as just described, unless the &%-v%& or any debugging option is
30112 also specified. In that case, full verification is done for every generated
30113 address and a report is output for each of them.
30114
30115
30116
30117 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30118 .cindex "CSA" "verifying"
30119 Client SMTP Authorization is a system that allows a site to advertise
30120 which machines are and are not permitted to send email. This is done by placing
30121 special SRV records in the DNS; these are looked up using the client's HELO
30122 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30123 Authorization checks in Exim are performed by the ACL condition:
30124 .code
30125 verify = csa
30126 .endd
30127 This fails if the client is not authorized. If there is a DNS problem, or if no
30128 valid CSA SRV record is found, or if the client is authorized, the condition
30129 succeeds. These three cases can be distinguished using the expansion variable
30130 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30131 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30132 be likely to cause problems for legitimate email.
30133
30134 The error messages produced by the CSA code include slightly more
30135 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30136 looking up the CSA SRV record, or problems looking up the CSA target
30137 address record. There are four reasons for &$csa_status$& being &"fail"&:
30138
30139 .ilist
30140 The client's host name is explicitly not authorized.
30141 .next
30142 The client's IP address does not match any of the CSA target IP addresses.
30143 .next
30144 The client's host name is authorized but it has no valid target IP addresses
30145 (for example, the target's addresses are IPv6 and the client is using IPv4).
30146 .next
30147 The client's host name has no CSA SRV record but a parent domain has asserted
30148 that all subdomains must be explicitly authorized.
30149 .endlist
30150
30151 The &%csa%& verification condition can take an argument which is the domain to
30152 use for the DNS query. The default is:
30153 .code
30154 verify = csa/$sender_helo_name
30155 .endd
30156 This implementation includes an extension to CSA. If the query domain
30157 is an address literal such as [192.0.2.95], or if it is a bare IP
30158 address, Exim searches for CSA SRV records in the reverse DNS as if
30159 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30160 meaningful to say:
30161 .code
30162 verify = csa/$sender_host_address
30163 .endd
30164 In fact, this is the check that Exim performs if the client does not say HELO.
30165 This extension can be turned off by setting the main configuration option
30166 &%dns_csa_use_reverse%& to be false.
30167
30168 If a CSA SRV record is not found for the domain itself, a search
30169 is performed through its parent domains for a record which might be
30170 making assertions about subdomains. The maximum depth of this search is limited
30171 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30172 default. Exim does not look for CSA SRV records in a top level domain, so the
30173 default settings handle HELO domains as long as seven
30174 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30175 of legitimate HELO domains.
30176
30177 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30178 direct SRV lookups, this is not sufficient because of the extra parent domain
30179 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30180 addresses into lookups in the reverse DNS space. The result of a successful
30181 lookup such as:
30182 .code
30183 ${lookup dnsdb {csa=$sender_helo_name}}
30184 .endd
30185 has two space-separated fields: an authorization code and a target host name.
30186 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30187 authorization required but absent, or &"?"& for unknown.
30188
30189
30190
30191
30192 .section "Bounce address tag validation" "SECTverifyPRVS"
30193 .cindex "BATV, verifying"
30194 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30195 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30196 Genuine incoming bounce messages should therefore always be addressed to
30197 recipients that have a valid tag. This scheme is a way of detecting unwanted
30198 bounce messages caused by sender address forgeries (often called &"collateral
30199 spam"&), because the recipients of such messages do not include valid tags.
30200
30201 There are two expansion items to help with the implementation of the BATV
30202 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30203 the original envelope sender address by using a simple key to add a hash of the
30204 address and some time-based randomizing information. The &%prvs%& expansion
30205 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30206 The syntax of these expansion items is described in section
30207 &<<SECTexpansionitems>>&.
30208
30209 As an example, suppose the secret per-address keys are stored in an MySQL
30210 database. A query to look up the key for an address could be defined as a macro
30211 like this:
30212 .code
30213 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30214                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30215                 }{$value}}
30216 .endd
30217 Suppose also that the senders who make use of BATV are defined by an address
30218 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30219 use this:
30220 .code
30221 # Bounces: drop unsigned addresses for BATV senders
30222 deny message = This address does not send an unsigned reverse path
30223      senders = :
30224      recipients = +batv_senders
30225
30226 # Bounces: In case of prvs-signed address, check signature.
30227 deny message = Invalid reverse path signature.
30228      senders = :
30229      condition  = ${prvscheck {$local_part@$domain}\
30230                   {PRVSCHECK_SQL}{1}}
30231      !condition = $prvscheck_result
30232 .endd
30233 The first statement rejects recipients for bounce messages that are addressed
30234 to plain BATV sender addresses, because it is known that BATV senders do not
30235 send out messages with plain sender addresses. The second statement rejects
30236 recipients that are prvs-signed, but with invalid signatures (either because
30237 the key is wrong, or the signature has timed out).
30238
30239 A non-prvs-signed address is not rejected by the second statement, because the
30240 &%prvscheck%& expansion yields an empty string if its first argument is not a
30241 prvs-signed address, thus causing the &%condition%& condition to be false. If
30242 the first argument is a syntactically valid prvs-signed address, the yield is
30243 the third string (in this case &"1"&), whether or not the cryptographic and
30244 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30245 of the checks (empty for failure, &"1"& for success).
30246
30247 There is one more issue you must consider when implementing prvs-signing:
30248 you have to ensure that the routers accept prvs-signed addresses and
30249 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30250 router to remove the signature with a configuration along these lines:
30251 .code
30252 batv_redirect:
30253   driver = redirect
30254   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30255 .endd
30256 This works because, if the third argument of &%prvscheck%& is empty, the result
30257 of the expansion of a prvs-signed address is the decoded value of the original
30258 address. This router should probably be the first of your routers that handles
30259 local addresses.
30260
30261 To create BATV-signed addresses in the first place, a transport of this form
30262 can be used:
30263 .code
30264 external_smtp_batv:
30265   driver = smtp
30266   return_path = ${prvs {$return_path} \
30267                        {${lookup mysql{SELECT \
30268                        secret FROM batv_prvs WHERE \
30269                        sender='${quote_mysql:$sender_address}'} \
30270                        {$value}fail}}}
30271 .endd
30272 If no key can be found for the existing return path, no signing takes place.
30273
30274
30275
30276 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30277 .cindex "&ACL;" "relay control"
30278 .cindex "relaying" "control by ACL"
30279 .cindex "policy control" "relay control"
30280 An MTA is said to &'relay'& a message if it receives it from some host and
30281 delivers it directly to another host as a result of a remote address contained
30282 within it. Redirecting a local address via an alias or forward file and then
30283 passing the message on to another host is not relaying,
30284 .cindex "&""percent hack""&"
30285 but a redirection as a result of the &"percent hack"& is.
30286
30287 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30288 A host which is acting as a gateway or an MX backup is concerned with incoming
30289 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30290 a host which is acting as a smart host for a number of clients is concerned
30291 with outgoing relaying from those clients to the Internet at large. Often the
30292 same host is fulfilling both functions,
30293 . ///
30294 . as illustrated in the diagram below,
30295 . ///
30296 but in principle these two kinds of relaying are entirely independent. What is
30297 not wanted is the transmission of mail from arbitrary remote hosts through your
30298 system to arbitrary domains.
30299
30300
30301 You can implement relay control by means of suitable statements in the ACL that
30302 runs for each RCPT command. For convenience, it is often easiest to use
30303 Exim's named list facility to define the domains and hosts involved. For
30304 example, suppose you want to do the following:
30305
30306 .ilist
30307 Deliver a number of domains to mailboxes on the local host (or process them
30308 locally in some other way). Let's say these are &'my.dom1.example'& and
30309 &'my.dom2.example'&.
30310 .next
30311 Relay mail for a number of other domains for which you are the secondary MX.
30312 These might be &'friend1.example'& and &'friend2.example'&.
30313 .next
30314 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30315 Suppose your LAN is 192.168.45.0/24.
30316 .endlist
30317
30318
30319 In the main part of the configuration, you put the following definitions:
30320 .code
30321 domainlist local_domains    = my.dom1.example : my.dom2.example
30322 domainlist relay_to_domains = friend1.example : friend2.example
30323 hostlist   relay_from_hosts = 192.168.45.0/24
30324 .endd
30325 Now you can use these definitions in the ACL that is run for every RCPT
30326 command:
30327 .code
30328 acl_check_rcpt:
30329   accept domains = +local_domains : +relay_to_domains
30330   accept hosts   = +relay_from_hosts
30331 .endd
30332 The first statement accepts any RCPT command that contains an address in
30333 the local or relay domains. For any other domain, control passes to the second
30334 statement, which accepts the command only if it comes from one of the relay
30335 hosts. In practice, you will probably want to make your ACL more sophisticated
30336 than this, for example, by including sender and recipient verification. The
30337 default configuration includes a more comprehensive example, which is described
30338 in chapter &<<CHAPdefconfil>>&.
30339
30340
30341
30342 .section "Checking a relay configuration" "SECTcheralcon"
30343 .cindex "relaying" "checking control of"
30344 You can check the relay characteristics of your configuration in the same way
30345 that you can test any ACL behaviour for an incoming SMTP connection, by using
30346 the &%-bh%& option to run a fake SMTP session with which you interact.
30347
30348 For specifically testing for unwanted relaying, the host
30349 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30350 host from the host on which Exim is running, using the normal telnet port, you
30351 will see a normal telnet connection message and then quite a long delay. Be
30352 patient. The remote host is making an SMTP connection back to your host, and
30353 trying a number of common probes to test for open relay vulnerability. The
30354 results of the tests will eventually appear on your terminal.
30355 .ecindex IIDacl
30356
30357
30358
30359 . ////////////////////////////////////////////////////////////////////////////
30360 . ////////////////////////////////////////////////////////////////////////////
30361
30362 .chapter "Content scanning at ACL time" "CHAPexiscan"
30363 .scindex IIDcosca "content scanning" "at ACL time"
30364 The extension of Exim to include content scanning at ACL time, formerly known
30365 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30366 was integrated into the main source for Exim release 4.50, and Tom continues to
30367 maintain it. Most of the wording of this chapter is taken from Tom's
30368 specification.
30369
30370 It is also possible to scan the content of messages at other times. The
30371 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30372 scanning after all the ACLs have run. A transport filter can be used to scan
30373 messages at delivery time (see the &%transport_filter%& option, described in
30374 chapter &<<CHAPtransportgeneric>>&).
30375
30376 If you want to include the ACL-time content-scanning features when you compile
30377 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30378 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30379
30380 .ilist
30381 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30382 for all MIME parts for SMTP and non-SMTP messages, respectively.
30383 .next
30384 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30385 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30386 run at the end of message reception (the &%acl_smtp_data%& ACL).
30387 .next
30388 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30389 of messages, or parts of messages, for debugging purposes.
30390 .next
30391 Additional expansion variables that are set in the new ACL and by the new
30392 conditions.
30393 .next
30394 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30395 .endlist
30396
30397 There is another content-scanning configuration option for &_Local/Makefile_&,
30398 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30399 condition is compiled, in addition to all the other content-scanning features.
30400
30401 Content-scanning is continually evolving, and new features are still being
30402 added. While such features are still unstable and liable to incompatible
30403 changes, they are made available in Exim by setting options whose names begin
30404 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30405 this manual. You can find out about them by reading the file called
30406 &_doc/experimental.txt_&.
30407
30408 All the content-scanning facilities work on a MBOX copy of the message that is
30409 temporarily created in a file called:
30410 .display
30411 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30412 .endd
30413 The &_.eml_& extension is a friendly hint to virus scanners that they can
30414 expect an MBOX-like structure inside that file. The file is created when the
30415 first content scanning facility is called. Subsequent calls to content
30416 scanning conditions open the same file again. The directory is recursively
30417 removed when the &%acl_smtp_data%& ACL has finished running, unless
30418 .code
30419 control = no_mbox_unspool
30420 .endd
30421 has been encountered. When the MIME ACL decodes files, they are put into the
30422 same directory by default.
30423
30424
30425
30426 .section "Scanning for viruses" "SECTscanvirus"
30427 .cindex "virus scanning"
30428 .cindex "content scanning" "for viruses"
30429 .cindex "content scanning" "the &%malware%& condition"
30430 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30431 It supports a &"generic"& interface to scanners called via the shell, and
30432 specialized interfaces for &"daemon"& type virus scanners, which are resident
30433 in memory and thus are much faster.
30434
30435 .new
30436 A timeout of 2 minutes is applied to a scanner call (by default);
30437 if it expires then a defer action is taken.
30438 .wen
30439
30440 .oindex "&%av_scanner%&"
30441 You can set the &%av_scanner%& option in the main part of the configuration
30442 to specify which scanner to use, together with any additional options that
30443 are needed. The basic syntax is as follows:
30444 .display
30445 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30446 .endd
30447 If you do not set &%av_scanner%&, it defaults to
30448 .code
30449 av_scanner = sophie:/var/run/sophie
30450 .endd
30451 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30452 before use.
30453 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30454 The following scanner types are supported in this release:
30455
30456 .vlist
30457 .new
30458 .vitem &%avast%&
30459 .cindex "virus scanners" "avast"
30460 This is the scanner daemon of Avast. It has been tested with Avast Core
30461 Security (currenty at version 1.1.7).
30462 You can get a trial version at &url(http://www.avast.com) or for Linux
30463 at &url(http://www.avast.com/linux-server-antivirus).
30464 This scanner type takes one option,
30465 which can be either a full path to a UNIX socket,
30466 or host and port specifiers separated by white space.
30467 The host may be a name or an IP address; the port is either a
30468 single number or a pair of numbers with a dash between.
30469 Any further options are given, on separate lines,
30470 to the daemon as options before the main scan command.
30471 For example:
30472 .code
30473 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30474 av_scanner = avast:192.168.2.22 5036
30475 .endd
30476 If you omit the argument, the default path
30477 &_/var/run/avast/scan.sock_&
30478 is used.
30479 If you use a remote host,
30480 you need to make Exim's spool directory available to it,
30481 as the scanner is passed a file path, not file contents.
30482 For information about available commands and their options you may use 
30483 .code
30484 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30485     FLAGS
30486     SENSITIVITY
30487     PACK
30488 .endd
30489 .wen
30490
30491
30492 .vitem &%aveserver%&
30493 .cindex "virus scanners" "Kaspersky"
30494 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30495 at &url(http://www.kaspersky.com). This scanner type takes one option,
30496 which is the path to the daemon's UNIX socket. The default is shown in this
30497 example:
30498 .code
30499 av_scanner = aveserver:/var/run/aveserver
30500 .endd
30501
30502
30503 .vitem &%clamd%&
30504 .cindex "virus scanners" "clamd"
30505 This daemon-type scanner is GPL and free. You can get it at
30506 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30507 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30508 in the MIME ACL. This is no longer believed to be necessary.
30509
30510 The options are a list of server specifiers, which may be
30511 a UNIX socket specification,
30512 a TCP socket specification,
30513 or a (global) option.
30514
30515 A socket specification consists of a space-separated list.
30516 For a Unix socket the first element is a full path for the socket,
30517 for a TCP socket the first element is the IP address
30518 and the second a port number,
30519 Any further elements are per-server (non-global) options.
30520 These per-server options are supported:
30521 .code
30522 retry=<timespec>        Retry on connect fail
30523 .endd
30524
30525 The &`retry`& option specifies a time after which a single retry for
30526 a failed connect is made.  The default is to not retry.
30527
30528 If a Unix socket file is specified, only one server is supported.
30529
30530 Examples:
30531 .code
30532 av_scanner = clamd:/opt/clamd/socket
30533 av_scanner = clamd:192.0.2.3 1234
30534 av_scanner = clamd:192.0.2.3 1234:local
30535 av_scanner = clamd:192.0.2.3 1234 retry=10s
30536 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30537 .endd
30538 If the value of av_scanner points to a UNIX socket file or contains the
30539 &`local`&
30540 option, then the ClamAV interface will pass a filename containing the data
30541 to be scanned, which will should normally result in less I/O happening and be
30542 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30543 Exim does not assume that there is a common filesystem with the remote host.
30544 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30545 you be running a version of ClamAV prior to 0.95.
30546
30547 The final example shows that multiple TCP targets can be specified.  Exim will
30548 randomly use one for each incoming email (i.e. it load balances them).  Note
30549 that only TCP targets may be used if specifying a list of scanners; a UNIX
30550 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30551 unavailable, Exim will try the remaining one(s) until it finds one that works.
30552 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30553 not keep track of scanner state between multiple messages, and the scanner
30554 selection is random, so the message will get logged in the mainlog for each
30555 email that the down scanner gets chosen first (message wrapped to be readable):
30556 .code
30557 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30558    clamd: connection to localhost, port 3310 failed
30559    (Connection refused)
30560 .endd
30561
30562 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30563 contributing the code for this scanner.
30564
30565 .vitem &%cmdline%&
30566 .cindex "virus scanners" "command line interface"
30567 This is the keyword for the generic command line scanner interface. It can be
30568 used to attach virus scanners that are invoked from the shell. This scanner
30569 type takes 3 mandatory options:
30570
30571 .olist
30572 The full path and name of the scanner binary, with all command line options,
30573 and a placeholder (&`%s`&) for the directory to scan.
30574
30575 .next
30576 A regular expression to match against the STDOUT and STDERR output of the
30577 virus scanner. If the expression matches, a virus was found. You must make
30578 absolutely sure that this expression matches on &"virus found"&. This is called
30579 the &"trigger"& expression.
30580
30581 .next
30582 Another regular expression, containing exactly one pair of parentheses, to
30583 match the name of the virus found in the scanners output. This is called the
30584 &"name"& expression.
30585 .endlist olist
30586
30587 For example, Sophos Sweep reports a virus on a line like this:
30588 .code
30589 Virus 'W32/Magistr-B' found in file ./those.bat
30590 .endd
30591 For the trigger expression, we can match the phrase &"found in file"&. For the
30592 name expression, we want to extract the W32/Magistr-B string, so we can match
30593 for the single quotes left and right of it. Altogether, this makes the
30594 configuration setting:
30595 .code
30596 av_scanner = cmdline:\
30597              /path/to/sweep -ss -all -rec -archive %s:\
30598              found in file:'(.+)'
30599 .endd
30600 .vitem &%drweb%&
30601 .cindex "virus scanners" "DrWeb"
30602 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30603 takes one option,
30604 either a full path to a UNIX socket,
30605 or host and port specifiers separated by white space.
30606 The host may be a name or an IP address; the port is either a
30607 single number or a pair of numbers with a dash between.
30608 For example:
30609 .code
30610 av_scanner = drweb:/var/run/drwebd.sock
30611 av_scanner = drweb:192.168.2.20 31337
30612 .endd
30613 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30614 is used. Thanks to Alex Miller for contributing the code for this scanner.
30615
30616 .vitem &%f-protd%&
30617 .cindex "virus scanners" "f-protd"
30618 The f-protd scanner is accessed via HTTP over TCP.
30619 One argument is taken, being a space-separated hostname and port number
30620 (or port-range).
30621 For example:
30622 .code
30623 av_scanner = f-protd:localhost 10200-10204
30624 .endd
30625 If you omit the argument, the default values show above are used.
30626
30627 .vitem &%fsecure%&
30628 .cindex "virus scanners" "F-Secure"
30629 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30630 argument which is the path to a UNIX socket. For example:
30631 .code
30632 av_scanner = fsecure:/path/to/.fsav
30633 .endd
30634 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30635 Thelmen for contributing the code for this scanner.
30636
30637 .vitem &%kavdaemon%&
30638 .cindex "virus scanners" "Kaspersky"
30639 This is the scanner daemon of Kaspersky Version 4. This version of the
30640 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30641 scanner type takes one option, which is the path to the daemon's UNIX socket.
30642 For example:
30643 .code
30644 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30645 .endd
30646 The default path is &_/var/run/AvpCtl_&.
30647
30648 .vitem &%mksd%&
30649 .cindex "virus scanners" "mksd"
30650 This is a daemon type scanner that is aimed mainly at Polish users, though some
30651 parts of documentation are now available in English. You can get it at
30652 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30653 the maximum number of processes used simultaneously to scan the attachments,
30654 provided that the demime facility is employed and also provided that mksd has
30655 been run with at least the same number of child processes. For example:
30656 .code
30657 av_scanner = mksd:2
30658 .endd
30659 You can safely omit this option (the default value is 1).
30660
30661 .vitem &%sock%&
30662 .cindex "virus scanners" "simple socket-connected"
30663 This is a general-purpose way of talking to simple scanner daemons
30664 running on the local machine.
30665 There are four options:
30666 an address (which may be an IP addres and port, or the path of a Unix socket),
30667 a commandline to send (may include a single %s which will be replaced with
30668 the path to the mail file to be scanned),
30669 an RE to trigger on from the returned data,
30670 an RE to extract malware_name from the returned data.
30671 For example:
30672 .code
30673 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30674 .endd
30675 Default for the socket specifier is &_/tmp/malware.sock_&.
30676 Default for the commandline is &_%s\n_&.
30677 Both regular-expressions are required.
30678
30679 .vitem &%sophie%&
30680 .cindex "virus scanners" "Sophos and Sophie"
30681 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30682 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30683 for this scanner type is the path to the UNIX socket that Sophie uses for
30684 client communication. For example:
30685 .code
30686 av_scanner = sophie:/tmp/sophie
30687 .endd
30688 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30689 the option.
30690 .endlist
30691
30692 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30693 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30694 ACL.
30695
30696 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30697 makes it possible to use different scanners. See further below for an example.
30698 The &%malware%& condition caches its results, so when you use it multiple times
30699 for the same message, the actual scanning process is only carried out once.
30700 However, using expandable items in &%av_scanner%& disables this caching, in
30701 which case each use of the &%malware%& condition causes a new scan of the
30702 message.
30703
30704 The &%malware%& condition takes a right-hand argument that is expanded before
30705 .new
30706 use and taken as a list, slash-separated by default.
30707 .wen
30708 The first element can then be one of
30709
30710 .ilist
30711 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30712 The condition succeeds if a virus was found, and fail otherwise. This is the
30713 recommended usage.
30714 .next
30715 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30716 the condition fails immediately.
30717 .next
30718 A regular expression, in which case the message is scanned for viruses. The
30719 condition succeeds if a virus is found and its name matches the regular
30720 expression. This allows you to take special actions on certain types of virus.
30721 .new
30722 Note that &"/"& characters in the RE must be doubled due to the list-processing,
30723 unless the separator is changed (in the usual way).
30724 .wen
30725 .endlist
30726
30727 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
30728 messages even if there is a problem with the virus scanner.
30729 Otherwise, such a problem causes the ACL to defer.
30730
30731 .new
30732 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
30733 specify a non-default timeout.  The default is two minutes.
30734 For example:
30735 .code
30736 malware = * / defer_ok / tmo=10s
30737 .endd
30738 A timeout causes the ACL to defer.
30739 .wen
30740
30741 .vindex "&$malware_name$&"
30742 When a virus is found, the condition sets up an expansion variable called
30743 &$malware_name$& that contains the name of the virus. You can use it in a
30744 &%message%& modifier that specifies the error returned to the sender, and/or in
30745 logging data.
30746
30747 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30748 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30749 &%malware%& condition.
30750
30751 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30752 imposed by your anti-virus scanner.
30753
30754 Here is a very simple scanning example:
30755 .code
30756 deny message = This message contains malware ($malware_name)
30757      demime = *
30758      malware = *
30759 .endd
30760 The next example accepts messages when there is a problem with the scanner:
30761 .code
30762 deny message = This message contains malware ($malware_name)
30763      demime = *
30764      malware = */defer_ok
30765 .endd
30766 The next example shows how to use an ACL variable to scan with both sophie and
30767 aveserver. It assumes you have set:
30768 .code
30769 av_scanner = $acl_m0
30770 .endd
30771 in the main Exim configuration.
30772 .code
30773 deny message = This message contains malware ($malware_name)
30774      set acl_m0 = sophie
30775      malware = *
30776
30777 deny message = This message contains malware ($malware_name)
30778      set acl_m0 = aveserver
30779      malware = *
30780 .endd
30781
30782
30783 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
30784 .cindex "content scanning" "for spam"
30785 .cindex "spam scanning"
30786 .cindex "SpamAssassin"
30787 .cindex "Rspamd"
30788 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30789 score and a report for the message.
30790 .new
30791 Support is also provided for Rspamd.
30792
30793 For more information about installation and configuration of SpamAssassin or 
30794 Rspamd refer to their respective websites at
30795 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
30796 .wen
30797
30798 SpamAssassin can be installed with CPAN by running:
30799 .code
30800 perl -MCPAN -e 'install Mail::SpamAssassin'
30801 .endd
30802 SpamAssassin has its own set of configuration files. Please review its
30803 documentation to see how you can tweak it. The default installation should work
30804 nicely, however.
30805
30806 .oindex "&%spamd_address%&"
30807 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you 
30808 intend to use an instance running on the local host you do not need to set
30809 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
30810 you must set the &%spamd_address%& option in the global part of the Exim
30811 configuration as follows (example):
30812 .code
30813 spamd_address = 192.168.99.45 387
30814 .endd
30815
30816 .new
30817 To use Rspamd (which by default listens on all local addresses
30818 on TCP port 11333)
30819 you should add &%variant=rspamd%& after the address/port pair, for example:
30820 .code
30821 spamd_address = 127.0.0.1 11333 variant=rspamd
30822 .endd
30823 .wen
30824
30825 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
30826 sockets. If you want to us these, supply &%spamd_address%& with an absolute
30827 file name instead of an address/port pair:
30828 .code
30829 spamd_address = /var/run/spamd_socket
30830 .endd
30831 You can have multiple &%spamd%& servers to improve scalability. These can
30832 reside on other hardware reachable over the network. To specify multiple
30833 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30834 option, separated with colons (the separator can be changed in the usual way):
30835 .code
30836 spamd_address = 192.168.2.10 783 : \
30837                 192.168.2.11 783 : \
30838                 192.168.2.12 783
30839 .endd
30840 Up to 32 &%spamd%& servers are supported.
30841 When a server fails to respond to the connection attempt, all other
30842 servers are tried until one succeeds. If no server responds, the &%spam%&
30843 condition defers.
30844
30845 .new
30846 Unix and TCP socket specifications may be mixed in any order.
30847 Each element of the list is a list itself, space-separated by default
30848 and changeable in the usual way.
30849
30850 For TCP socket specifications a host name or IP (v4 or v6, but
30851 subject to list-separator quoting rules) address can be used,
30852 and the port can be one or a dash-separated pair.
30853 In the latter case, the range is tried in strict order.
30854
30855 Elements after the first for Unix sockets, or second for TCP socket,
30856 are options.
30857 The supported option are:
30858 .code
30859 pri=<priority>      Selection priority
30860 weight=<value>      Selection bias
30861 time=<start>-<end>  Use only between these times of day
30862 retry=<timespec>    Retry on connect fail
30863 tmo=<timespec>      Connection time limit
30864 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
30865 .endd
30866
30867 The &`pri`& option specifies a priority for the server within the list,
30868 higher values being tried first.
30869 The deafult priority is 1.
30870
30871 The &`weight`& option specifies a selection bias.
30872 Within a priority set
30873 servers are queried in a random fashion, weighted by this value.
30874 The default value for selection bias is 1.
30875
30876 Time specifications for the &`time`& option are <hour>.<minute>.<second>
30877 in the local time zone; each element being one or more digits.
30878 Either the seconds or both minutes and seconds, plus the leading &`.`&
30879 characters, may be omitted and will be taken as zero.
30880
30881 Timeout specifications for the &`retry`& and &`tmo`& options
30882 are the usual Exim time interval standard, eg. &`20s`& or &`1m`&.
30883
30884 The &`tmo`& option specifies an overall timeout for communication.
30885 The default value is two minutes.
30886
30887 The &`retry`& option specifies a time after which a single retry for
30888 a failed connect is made.
30889 The default is to not retry.
30890 .wen
30891
30892 The &%spamd_address%& variable is expanded before use if it starts with
30893 a dollar sign. In this case, the expansion may return a string that is
30894 used as the list so that multiple spamd servers can be the result of an
30895 expansion.
30896
30897 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30898 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30899 .code
30900 deny message = This message was classified as SPAM
30901      spam = joe
30902 .endd
30903 The right-hand side of the &%spam%& condition specifies a name. This is
30904 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30905 to scan using a specific profile, but rather use the SpamAssassin system-wide
30906 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30907 .new
30908 Rspamd does not use this setting. However, you must put something on the
30909 right-hand side.
30910 .wen
30911
30912 The name allows you to use per-domain or per-user antispam profiles in
30913 principle, but this is not straightforward in practice, because a message may
30914 have multiple recipients, not necessarily all in the same domain. Because the
30915 &%spam%& condition has to be called from a DATA ACL in order to be able to
30916 read the contents of the message, the variables &$local_part$& and &$domain$&
30917 are not set.
30918 Careful enforcement of single-recipient messages
30919 (eg. by responding with defer in the recipient ACL for all recipients
30920 after the first),
30921 or the use of PRDR,
30922 .cindex "PRDR" "use for per-user SpamAssassin profiles"
30923 are needed to use this feature.
30924
30925 The right-hand side of the &%spam%& condition is expanded before being used, so
30926 you can put lookups or conditions there. When the right-hand side evaluates to
30927 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30928
30929
30930 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30931 large ones may cause significant performance degradation. As most spam messages
30932 are quite small, it is recommended that you do not scan the big ones. For
30933 example:
30934 .code
30935 deny message = This message was classified as SPAM
30936      condition = ${if < {$message_size}{10K}}
30937      spam = nobody
30938 .endd
30939
30940 The &%spam%& condition returns true if the threshold specified in the user's
30941 SpamAssassin profile has been matched or exceeded. If you want to use the
30942 &%spam%& condition for its side effects (see the variables below), you can make
30943 it always return &"true"& by appending &`:true`& to the username.
30944
30945 .cindex "spam scanning" "returned variables"
30946 When the &%spam%& condition is run, it sets up a number of expansion
30947 variables. These variables are saved with the received message, thus they are
30948 available for use at delivery time.
30949
30950 .vlist
30951 .vitem &$spam_score$&
30952 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30953 for inclusion in log or reject messages.
30954
30955 .vitem &$spam_score_int$&
30956 The spam score of the message, multiplied by ten, as an integer value. For
30957 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30958 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30959 The integer value is useful for numeric comparisons in conditions.
30960
30961 .vitem &$spam_bar$&
30962 A string consisting of a number of &"+"& or &"-"& characters, representing the
30963 integer part of the spam score value. A spam score of 4.4 would have a
30964 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30965 headers, since MUAs can match on such strings.
30966
30967 .vitem &$spam_report$&
30968 A multiline text table, containing the full SpamAssassin report for the
30969 message. Useful for inclusion in headers or reject messages.
30970
30971 .new
30972 .vitem &$spam_action$&
30973 For SpamAssassin either 'reject' or 'no action' depending on the
30974 spam score versus threshold.
30975 For Rspamd, the recommended action.
30976 .wen
30977
30978 .endlist
30979
30980 The &%spam%& condition caches its results unless expansion in
30981 spamd_address was used. If you call it again with the same user name, it
30982 does not scan again, but rather returns the same values as before.
30983
30984 The &%spam%& condition returns DEFER if there is any error while running
30985 the message through SpamAssassin or if the expansion of spamd_address
30986 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30987 statement block), append &`/defer_ok`& to the right-hand side of the
30988 spam condition, like this:
30989 .code
30990 deny message = This message was classified as SPAM
30991      spam    = joe/defer_ok
30992 .endd
30993 This causes messages to be accepted even if there is a problem with &%spamd%&.
30994
30995 Here is a longer, commented example of the use of the &%spam%&
30996 condition:
30997 .code
30998 # put headers in all messages (no matter if spam or not)
30999 warn  spam = nobody:true
31000       add_header = X-Spam-Score: $spam_score ($spam_bar)
31001       add_header = X-Spam-Report: $spam_report
31002
31003 # add second subject line with *SPAM* marker when message
31004 # is over threshold
31005 warn  spam = nobody
31006       add_header = Subject: *SPAM* $h_Subject:
31007
31008 # reject spam at high scores (> 12)
31009 deny  message = This message scored $spam_score spam points.
31010       spam = nobody:true
31011       condition = ${if >{$spam_score_int}{120}{1}{0}}
31012 .endd
31013
31014
31015
31016 .section "Scanning MIME parts" "SECTscanmimepart"
31017 .cindex "content scanning" "MIME parts"
31018 .cindex "MIME content scanning"
31019 .oindex "&%acl_smtp_mime%&"
31020 .oindex "&%acl_not_smtp_mime%&"
31021 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31022 each MIME part of an SMTP message, including multipart types, in the sequence
31023 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31024 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31025 options may both refer to the same ACL if you want the same processing in both
31026 cases.
31027
31028 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31029 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31030 the case of a non-SMTP message. However, a MIME ACL is called only if the
31031 message contains a &'Content-Type:'& header line. When a call to a MIME
31032 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31033 result code is sent to the client. In the case of an SMTP message, the
31034 &%acl_smtp_data%& ACL is not called when this happens.
31035
31036 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31037 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31038 condition to match against the raw MIME part. You can also use the
31039 &%mime_regex%& condition to match against the decoded MIME part (see section
31040 &<<SECTscanregex>>&).
31041
31042 At the start of a MIME ACL, a number of variables are set from the header
31043 information for the relevant MIME part. These are described below. The contents
31044 of the MIME part are not by default decoded into a disk file except for MIME
31045 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31046 part into a disk file, you can use the &%decode%& condition. The general
31047 syntax is:
31048 .display
31049 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31050 .endd
31051 The right hand side is expanded before use. After expansion,
31052 the value can be:
31053
31054 .olist
31055 &"0"& or &"false"&, in which case no decoding is done.
31056 .next
31057 The string &"default"&. In that case, the file is put in the temporary
31058 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31059 a sequential file name consisting of the message id and a sequence number. The
31060 full path and name is available in &$mime_decoded_filename$& after decoding.
31061 .next
31062 A full path name starting with a slash. If the full name is an existing
31063 directory, it is used as a replacement for the default directory. The filename
31064 is then sequentially assigned. If the path does not exist, it is used as
31065 the full path and file name.
31066 .next
31067 If the string does not start with a slash, it is used as the
31068 filename, and the default path is then used.
31069 .endlist
31070 The &%decode%& condition normally succeeds. It is only false for syntax
31071 errors or unusual circumstances such as memory shortages. You can easily decode
31072 a file with its original, proposed filename using
31073 .code
31074 decode = $mime_filename
31075 .endd
31076 However, you should keep in mind that &$mime_filename$& might contain
31077 anything. If you place files outside of the default path, they are not
31078 automatically unlinked.
31079
31080 For RFC822 attachments (these are messages attached to messages, with a
31081 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31082 as for the primary message, only that the &$mime_is_rfc822$& expansion
31083 variable is set (see below). Attached messages are always decoded to disk
31084 before being checked, and the files are unlinked once the check is done.
31085
31086 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31087 used to match regular expressions against raw and decoded MIME parts,
31088 respectively. They are described in section &<<SECTscanregex>>&.
31089
31090 .cindex "MIME content scanning" "returned variables"
31091 The following list describes all expansion variables that are
31092 available in the MIME ACL:
31093
31094 .vlist
31095 .vitem &$mime_boundary$&
31096 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31097 have a boundary string, which is stored in this variable. If the current part
31098 has no boundary parameter in the &'Content-Type:'& header, this variable
31099 contains the empty string.
31100
31101 .vitem &$mime_charset$&
31102 This variable contains the character set identifier, if one was found in the
31103 &'Content-Type:'& header. Examples for charset identifiers are:
31104 .code
31105 us-ascii
31106 gb2312 (Chinese)
31107 iso-8859-1
31108 .endd
31109 Please note that this value is not normalized, so you should do matches
31110 case-insensitively.
31111
31112 .vitem &$mime_content_description$&
31113 This variable contains the normalized content of the &'Content-Description:'&
31114 header. It can contain a human-readable description of the parts content. Some
31115 implementations repeat the filename for attachments here, but they are usually
31116 only used for display purposes.
31117
31118 .vitem &$mime_content_disposition$&
31119 This variable contains the normalized content of the &'Content-Disposition:'&
31120 header. You can expect strings like &"attachment"& or &"inline"& here.
31121
31122 .vitem &$mime_content_id$&
31123 This variable contains the normalized content of the &'Content-ID:'& header.
31124 This is a unique ID that can be used to reference a part from another part.
31125
31126 .vitem &$mime_content_size$&
31127 This variable is set only after the &%decode%& modifier (see above) has been
31128 successfully run. It contains the size of the decoded part in kilobytes. The
31129 size is always rounded up to full kilobytes, so only a completely empty part
31130 has a &$mime_content_size$& of zero.
31131
31132 .vitem &$mime_content_transfer_encoding$&
31133 This variable contains the normalized content of the
31134 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31135 type. Typical values are &"base64"& and &"quoted-printable"&.
31136
31137 .vitem &$mime_content_type$&
31138 If the MIME part has a &'Content-Type:'& header, this variable contains its
31139 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31140 are some examples of popular MIME types, as they may appear in this variable:
31141 .code
31142 text/plain
31143 text/html
31144 application/octet-stream
31145 image/jpeg
31146 audio/midi
31147 .endd
31148 If the MIME part has no &'Content-Type:'& header, this variable contains the
31149 empty string.
31150
31151 .vitem &$mime_decoded_filename$&
31152 This variable is set only after the &%decode%& modifier (see above) has been
31153 successfully run. It contains the full path and file name of the file
31154 containing the decoded data.
31155 .endlist
31156
31157 .cindex "RFC 2047"
31158 .vlist
31159 .vitem &$mime_filename$&
31160 This is perhaps the most important of the MIME variables. It contains a
31161 proposed filename for an attachment, if one was found in either the
31162 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31163 RFC2047 decoded, but no additional sanity checks are done. If no filename was
31164 found, this variable contains the empty string.
31165
31166 .vitem &$mime_is_coverletter$&
31167 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31168 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31169 content in the cover letter, while not restricting attachments at all.
31170
31171 The variable contains 1 (true) for a MIME part believed to be part of the
31172 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31173 follows:
31174
31175 .olist
31176 The outermost MIME part of a message is always a cover letter.
31177
31178 .next
31179 If a multipart/alternative or multipart/related MIME part is a cover letter,
31180 so are all MIME subparts within that multipart.
31181
31182 .next
31183 If any other multipart is a cover letter, the first subpart is a cover letter,
31184 and the rest are attachments.
31185
31186 .next
31187 All parts contained within an attachment multipart are attachments.
31188 .endlist olist
31189
31190 As an example, the following will ban &"HTML mail"& (including that sent with
31191 alternative plain text), while allowing HTML files to be attached. HTML
31192 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31193 .code
31194 deny message = HTML mail is not accepted here
31195 !condition = $mime_is_rfc822
31196 condition = $mime_is_coverletter
31197 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31198 .endd
31199 .vitem &$mime_is_multipart$&
31200 This variable has the value 1 (true) when the current part has the main type
31201 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31202 Since multipart entities only serve as containers for other parts, you may not
31203 want to carry out specific actions on them.
31204
31205 .vitem &$mime_is_rfc822$&
31206 This variable has the value 1 (true) if the current part is not a part of the
31207 checked message itself, but part of an attached message. Attached message
31208 decoding is fully recursive.
31209
31210 .vitem &$mime_part_count$&
31211 This variable is a counter that is raised for each processed MIME part. It
31212 starts at zero for the very first part (which is usually a multipart). The
31213 counter is per-message, so it is reset when processing RFC822 attachments (see
31214 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31215 complete, so you can use it in the DATA ACL to determine the number of MIME
31216 parts of a message. For non-MIME messages, this variable contains the value -1.
31217 .endlist
31218
31219
31220
31221 .section "Scanning with regular expressions" "SECTscanregex"
31222 .cindex "content scanning" "with regular expressions"
31223 .cindex "regular expressions" "content scanning with"
31224 You can specify your own custom regular expression matches on the full body of
31225 the message, or on individual MIME parts.
31226
31227 The &%regex%& condition takes one or more regular expressions as arguments and
31228 matches them against the full message (when called in the DATA ACL) or a raw
31229 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31230 linewise, with a maximum line length of 32K characters. That means you cannot
31231 have multiline matches with the &%regex%& condition.
31232
31233 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31234 to 32K of decoded content (the whole content at once, not linewise). If the
31235 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31236 is decoded automatically when &%mime_regex%& is executed (using default path
31237 and filename values). If the decoded data is larger than  32K, only the first
31238 32K characters are checked.
31239
31240 The regular expressions are passed as a colon-separated list. To include a
31241 literal colon, you must double it. Since the whole right-hand side string is
31242 expanded before being used, you must also escape dollar signs and backslashes
31243 with more backslashes, or use the &`\N`& facility to disable expansion.
31244 Here is a simple example that contains two regular expressions:
31245 .code
31246 deny message = contains blacklisted regex ($regex_match_string)
31247      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31248 .endd
31249 The conditions returns true if any one of the regular expressions matches. The
31250 &$regex_match_string$& expansion variable is then set up and contains the
31251 matching regular expression.
31252
31253 &*Warning*&: With large messages, these conditions can be fairly
31254 CPU-intensive.
31255
31256
31257
31258
31259 .section "The demime condition" "SECTdemimecond"
31260 .cindex "content scanning" "MIME checking"
31261 .cindex "MIME content scanning"
31262 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31263 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31264 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31265 ACL functionality, but provides no additional facilities. Please note that this
31266 condition is deprecated and kept only for backward compatibility. You must set
31267 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31268 use the &%demime%& condition.
31269
31270 The &%demime%& condition unpacks MIME containers in the message. It detects
31271 errors in MIME containers and can match file extensions found in the message
31272 against a list. Using this facility produces files containing the unpacked MIME
31273 parts of the message in the temporary scan directory. If you do antivirus
31274 scanning, it is recommended that you use the &%demime%& condition before the
31275 antivirus (&%malware%&) condition.
31276
31277 On the right-hand side of the &%demime%& condition you can pass a
31278 colon-separated list of file extensions that it should match against. For
31279 example:
31280 .code
31281 deny message = Found blacklisted file attachment
31282      demime  = vbs:com:bat:pif:prf:lnk
31283 .endd
31284 If one of the file extensions is found, the condition is true, otherwise it is
31285 false. If there is a temporary error while demimeing (for example, &"disk
31286 full"&), the condition defers, and the message is temporarily rejected (unless
31287 the condition is on a &%warn%& verb).
31288
31289 The right-hand side is expanded before being treated as a list, so you can have
31290 conditions and lookups there. If it expands to an empty string, &"false"&, or
31291 zero (&"0"&), no demimeing is done and the condition is false.
31292
31293 The &%demime%& condition set the following variables:
31294
31295 .vlist
31296 .vitem &$demime_errorlevel$&
31297 .vindex "&$demime_errorlevel$&"
31298 When an error is detected in a MIME container, this variable contains the
31299 severity of the error, as an integer number. The higher the value, the more
31300 severe the error (the current maximum value is 3). If this variable is unset or
31301 zero, no error occurred.
31302
31303 .vitem &$demime_reason$&
31304 .vindex "&$demime_reason$&"
31305 When &$demime_errorlevel$& is greater than zero, this variable contains a
31306 human-readable text string describing the MIME error that occurred.
31307 .endlist
31308
31309 .vlist
31310 .vitem &$found_extension$&
31311 .vindex "&$found_extension$&"
31312 When the &%demime%& condition is true, this variable contains the file
31313 extension it found.
31314 .endlist
31315
31316 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31317 the &%demime%& condition, and are not changed on subsequent calls.
31318
31319 If you do not want to check for file extensions, but rather use the &%demime%&
31320 condition for unpacking or error checking purposes, pass &"*"& as the
31321 right-hand side value. Here is a more elaborate example of how to use this
31322 facility:
31323 .code
31324 # Reject messages with serious MIME container errors
31325 deny  message = Found MIME error ($demime_reason).
31326       demime = *
31327       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31328
31329 # Reject known virus spreading file extensions.
31330 # Accepting these is pretty much braindead.
31331 deny  message = contains $found_extension file (blacklisted).
31332       demime  = com:vbs:bat:pif:scr
31333
31334 # Freeze .exe and .doc files. Postmaster can
31335 # examine them and eventually thaw them.
31336 deny  log_message = Another $found_extension file.
31337       demime = exe:doc
31338       control = freeze
31339 .endd
31340 .ecindex IIDcosca
31341
31342
31343
31344
31345 . ////////////////////////////////////////////////////////////////////////////
31346 . ////////////////////////////////////////////////////////////////////////////
31347
31348 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31349          "Local scan function"
31350 .scindex IIDlosca "&[local_scan()]& function" "description of"
31351 .cindex "customizing" "input scan using C function"
31352 .cindex "policy control" "by local scan function"
31353 In these days of email worms, viruses, and ever-increasing spam, some sites
31354 want to apply a lot of checking to messages before accepting them.
31355
31356 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31357 passing messages to external virus and spam scanning software. You can also do
31358 a certain amount in Exim itself through string expansions and the &%condition%&
31359 condition in the ACL that runs after the SMTP DATA command or the ACL for
31360 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31361
31362 To allow for further customization to a site's own requirements, there is the
31363 possibility of linking Exim with a private message scanning function, written
31364 in C. If you want to run code that is written in something other than C, you
31365 can of course use a little C stub to call it.
31366
31367 The local scan function is run once for every incoming message, at the point
31368 when Exim is just about to accept the message.
31369 It can therefore be used to control non-SMTP messages from local processes as
31370 well as messages arriving via SMTP.
31371
31372 Exim applies a timeout to calls of the local scan function, and there is an
31373 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31374 Zero means &"no timeout"&.
31375 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31376 before calling the local scan function, so that the most common types of crash
31377 are caught. If the timeout is exceeded or one of those signals is caught, the
31378 incoming message is rejected with a temporary error if it is an SMTP message.
31379 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31380 code. The incident is logged on the main and reject logs.
31381
31382
31383
31384 .section "Building Exim to use a local scan function" "SECID207"
31385 .cindex "&[local_scan()]& function" "building Exim to use"
31386 To make use of the local scan function feature, you must tell Exim where your
31387 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31388 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31389 directory, so you might set
31390 .code
31391 LOCAL_SCAN_SOURCE=Local/local_scan.c
31392 .endd
31393 for example. The function must be called &[local_scan()]&. It is called by
31394 Exim after it has received a message, when the success return code is about to
31395 be sent. This is after all the ACLs have been run. The return code from your
31396 function controls whether the message is actually accepted or not. There is a
31397 commented template function (that just accepts the message) in the file
31398 _src/local_scan.c_.
31399
31400 If you want to make use of Exim's run time configuration file to set options
31401 for your &[local_scan()]& function, you must also set
31402 .code
31403 LOCAL_SCAN_HAS_OPTIONS=yes
31404 .endd
31405 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31406
31407
31408
31409
31410 .section "API for local_scan()" "SECTapiforloc"
31411 .cindex "&[local_scan()]& function" "API description"
31412 You must include this line near the start of your code:
31413 .code
31414 #include "local_scan.h"
31415 .endd
31416 This header file defines a number of variables and other values, and the
31417 prototype for the function itself. Exim is coded to use unsigned char values
31418 almost exclusively, and one of the things this header defines is a shorthand
31419 for &`unsigned char`& called &`uschar`&.
31420 It also contains the following macro definitions, to simplify casting character
31421 strings and pointers to character strings:
31422 .code
31423 #define CS   (char *)
31424 #define CCS  (const char *)
31425 #define CSS  (char **)
31426 #define US   (unsigned char *)
31427 #define CUS  (const unsigned char *)
31428 #define USS  (unsigned char **)
31429 .endd
31430 The function prototype for &[local_scan()]& is:
31431 .code
31432 extern int local_scan(int fd, uschar **return_text);
31433 .endd
31434 The arguments are as follows:
31435
31436 .ilist
31437 &%fd%& is a file descriptor for the file that contains the body of the message
31438 (the -D file). The file is open for reading and writing, but updating it is not
31439 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31440
31441 The descriptor is positioned at character 19 of the file, which is the first
31442 character of the body itself, because the first 19 characters are the message
31443 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31444 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31445 case this changes in some future version.
31446 .next
31447 &%return_text%& is an address which you can use to return a pointer to a text
31448 string at the end of the function. The value it points to on entry is NULL.
31449 .endlist
31450
31451 The function must return an &%int%& value which is one of the following macros:
31452
31453 .vlist
31454 .vitem &`LOCAL_SCAN_ACCEPT`&
31455 .vindex "&$local_scan_data$&"
31456 The message is accepted. If you pass back a string of text, it is saved with
31457 the message, and made available in the variable &$local_scan_data$&. No
31458 newlines are permitted (if there are any, they are turned into spaces) and the
31459 maximum length of text is 1000 characters.
31460
31461 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31462 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31463 queued without immediate delivery, and is frozen.
31464
31465 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31466 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31467 queued without immediate delivery.
31468
31469 .vitem &`LOCAL_SCAN_REJECT`&
31470 The message is rejected; the returned text is used as an error message which is
31471 passed back to the sender and which is also logged. Newlines are permitted &--
31472 they cause a multiline response for SMTP rejections, but are converted to
31473 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31474 used.
31475
31476 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31477 The message is temporarily rejected; the returned text is used as an error
31478 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31479 problem"& is used.
31480
31481 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31482 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31483 message is not written to the reject log. It has the effect of unsetting the
31484 &%rejected_header%& log selector for just this rejection. If
31485 &%rejected_header%& is already unset (see the discussion of the
31486 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31487 same as LOCAL_SCAN_REJECT.
31488
31489 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31490 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31491 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31492 .endlist
31493
31494 If the message is not being received by interactive SMTP, rejections are
31495 reported by writing to &%stderr%& or by sending an email, as configured by the
31496 &%-oe%& command line options.
31497
31498
31499
31500 .section "Configuration options for local_scan()" "SECTconoptloc"
31501 .cindex "&[local_scan()]& function" "configuration options"
31502 It is possible to have option settings in the main configuration file
31503 that set values in static variables in the &[local_scan()]& module. If you
31504 want to do this, you must have the line
31505 .code
31506 LOCAL_SCAN_HAS_OPTIONS=yes
31507 .endd
31508 in your &_Local/Makefile_& when you build Exim. (This line is in
31509 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31510 file, you must define static variables to hold the option values, and a table
31511 to define them.
31512
31513 The table must be a vector called &%local_scan_options%&, of type
31514 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31515 and a pointer to the variable that holds the value. The entries must appear in
31516 alphabetical order. Following &%local_scan_options%& you must also define a
31517 variable called &%local_scan_options_count%& that contains the number of
31518 entries in the table. Here is a short example, showing two kinds of option:
31519 .code
31520 static int my_integer_option = 42;
31521 static uschar *my_string_option = US"a default string";
31522
31523 optionlist local_scan_options[] = {
31524   { "my_integer", opt_int,       &my_integer_option },
31525   { "my_string",  opt_stringptr, &my_string_option }
31526 };
31527
31528 int local_scan_options_count =
31529   sizeof(local_scan_options)/sizeof(optionlist);
31530 .endd
31531 The values of the variables can now be changed from Exim's runtime
31532 configuration file by including a local scan section as in this example:
31533 .code
31534 begin local_scan
31535 my_integer = 99
31536 my_string = some string of text...
31537 .endd
31538 The available types of option data are as follows:
31539
31540 .vlist
31541 .vitem &*opt_bool*&
31542 This specifies a boolean (true/false) option. The address should point to a
31543 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31544 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31545 whether such a variable has been set at all, you can initialize it to
31546 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31547 values.)
31548
31549 .vitem &*opt_fixed*&
31550 This specifies a fixed point number, such as is used for load averages.
31551 The address should point to a variable of type &`int`&. The value is stored
31552 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31553
31554 .vitem &*opt_int*&
31555 This specifies an integer; the address should point to a variable of type
31556 &`int`&. The value may be specified in any of the integer formats accepted by
31557 Exim.
31558
31559 .vitem &*opt_mkint*&
31560 This is the same as &%opt_int%&, except that when such a value is output in a
31561 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31562 printed with the suffix K or M.
31563
31564 .vitem &*opt_octint*&
31565 This also specifies an integer, but the value is always interpreted as an
31566 octal integer, whether or not it starts with the digit zero, and it is
31567 always output in octal.
31568
31569 .vitem &*opt_stringptr*&
31570 This specifies a string value; the address must be a pointer to a
31571 variable that points to a string (for example, of type &`uschar *`&).
31572
31573 .vitem &*opt_time*&
31574 This specifies a time interval value. The address must point to a variable of
31575 type &`int`&. The value that is placed there is a number of seconds.
31576 .endlist
31577
31578 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31579 out the values of all the &[local_scan()]& options.
31580
31581
31582
31583 .section "Available Exim variables" "SECID208"
31584 .cindex "&[local_scan()]& function" "available Exim variables"
31585 The header &_local_scan.h_& gives you access to a number of C variables. These
31586 are the only ones that are guaranteed to be maintained from release to release.
31587 Note, however, that you can obtain the value of any Exim expansion variable,
31588 including &$recipients$&, by calling &'expand_string()'&. The exported
31589 C variables are as follows:
31590
31591 .vlist
31592 .vitem &*int&~body_linecount*&
31593 This variable contains the number of lines in the message's body.
31594
31595 .vitem &*int&~body_zerocount*&
31596 This variable contains the number of binary zero bytes in the message's body.
31597
31598 .vitem &*unsigned&~int&~debug_selector*&
31599 This variable is set to zero when no debugging is taking place. Otherwise, it
31600 is a bitmap of debugging selectors. Two bits are identified for use in
31601 &[local_scan()]&; they are defined as macros:
31602
31603 .ilist
31604 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31605 testing option that is not privileged &-- any caller may set it. All the
31606 other selector bits can be set only by admin users.
31607
31608 .next
31609 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31610 by the &`+local_scan`& debug selector. It is not included in the default set
31611 of debugging bits.
31612 .endlist ilist
31613
31614 Thus, to write to the debugging output only when &`+local_scan`& has been
31615 selected, you should use code like this:
31616 .code
31617 if ((debug_selector & D_local_scan) != 0)
31618   debug_printf("xxx", ...);
31619 .endd
31620 .vitem &*uschar&~*expand_string_message*&
31621 After a failing call to &'expand_string()'& (returned value NULL), the
31622 variable &%expand_string_message%& contains the error message, zero-terminated.
31623
31624 .vitem &*header_line&~*header_list*&
31625 A pointer to a chain of header lines. The &%header_line%& structure is
31626 discussed below.
31627
31628 .vitem &*header_line&~*header_last*&
31629 A pointer to the last of the header lines.
31630
31631 .vitem &*uschar&~*headers_charset*&
31632 The value of the &%headers_charset%& configuration option.
31633
31634 .vitem &*BOOL&~host_checking*&
31635 This variable is TRUE during a host checking session that is initiated by the
31636 &%-bh%& command line option.
31637
31638 .vitem &*uschar&~*interface_address*&
31639 The IP address of the interface that received the message, as a string. This
31640 is NULL for locally submitted messages.
31641
31642 .vitem &*int&~interface_port*&
31643 The port on which this message was received. When testing with the &%-bh%&
31644 command line option, the value of this variable is -1 unless a port has been
31645 specified via the &%-oMi%& option.
31646
31647 .vitem &*uschar&~*message_id*&
31648 This variable contains Exim's message id for the incoming message (the value of
31649 &$message_exim_id$&) as a zero-terminated string.
31650
31651 .vitem &*uschar&~*received_protocol*&
31652 The name of the protocol by which the message was received.
31653
31654 .vitem &*int&~recipients_count*&
31655 The number of accepted recipients.
31656
31657 .vitem &*recipient_item&~*recipients_list*&
31658 .cindex "recipient" "adding in local scan"
31659 .cindex "recipient" "removing in local scan"
31660 The list of accepted recipients, held in a vector of length
31661 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31662 can add additional recipients by calling &'receive_add_recipient()'& (see
31663 below). You can delete recipients by removing them from the vector and
31664 adjusting the value in &%recipients_count%&. In particular, by setting
31665 &%recipients_count%& to zero you remove all recipients. If you then return the
31666 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31667 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31668 and then call &'receive_add_recipient()'& as often as needed.
31669
31670 .vitem &*uschar&~*sender_address*&
31671 The envelope sender address. For bounce messages this is the empty string.
31672
31673 .vitem &*uschar&~*sender_host_address*&
31674 The IP address of the sending host, as a string. This is NULL for
31675 locally-submitted messages.
31676
31677 .vitem &*uschar&~*sender_host_authenticated*&
31678 The name of the authentication mechanism that was used, or NULL if the message
31679 was not received over an authenticated SMTP connection.
31680
31681 .vitem &*uschar&~*sender_host_name*&
31682 The name of the sending host, if known.
31683
31684 .vitem &*int&~sender_host_port*&
31685 The port on the sending host.
31686
31687 .vitem &*BOOL&~smtp_input*&
31688 This variable is TRUE for all SMTP input, including BSMTP.
31689
31690 .vitem &*BOOL&~smtp_batched_input*&
31691 This variable is TRUE for BSMTP input.
31692
31693 .vitem &*int&~store_pool*&
31694 The contents of this variable control which pool of memory is used for new
31695 requests. See section &<<SECTmemhanloc>>& for details.
31696 .endlist
31697
31698
31699 .section "Structure of header lines" "SECID209"
31700 The &%header_line%& structure contains the members listed below.
31701 You can add additional header lines by calling the &'header_add()'& function
31702 (see below). You can cause header lines to be ignored (deleted) by setting
31703 their type to *.
31704
31705
31706 .vlist
31707 .vitem &*struct&~header_line&~*next*&
31708 A pointer to the next header line, or NULL for the last line.
31709
31710 .vitem &*int&~type*&
31711 A code identifying certain headers that Exim recognizes. The codes are printing
31712 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31713 Notice in particular that any header line whose type is * is not transmitted
31714 with the message. This flagging is used for header lines that have been
31715 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31716 lines.) Effectively, * means &"deleted"&.
31717
31718 .vitem &*int&~slen*&
31719 The number of characters in the header line, including the terminating and any
31720 internal newlines.
31721
31722 .vitem &*uschar&~*text*&
31723 A pointer to the text of the header. It always ends with a newline, followed by
31724 a zero byte. Internal newlines are preserved.
31725 .endlist
31726
31727
31728
31729 .section "Structure of recipient items" "SECID210"
31730 The &%recipient_item%& structure contains these members:
31731
31732 .vlist
31733 .vitem &*uschar&~*address*&
31734 This is a pointer to the recipient address as it was received.
31735
31736 .vitem &*int&~pno*&
31737 This is used in later Exim processing when top level addresses are created by
31738 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31739 and must always contain -1 at this stage.
31740
31741 .vitem &*uschar&~*errors_to*&
31742 If this value is not NULL, bounce messages caused by failing to deliver to the
31743 recipient are sent to the address it contains. In other words, it overrides the
31744 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31745 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31746 an unqualified address, Exim qualifies it using the domain from
31747 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31748 is NULL for all recipients.
31749 .endlist
31750
31751
31752
31753 .section "Available Exim functions" "SECID211"
31754 .cindex "&[local_scan()]& function" "available Exim functions"
31755 The header &_local_scan.h_& gives you access to a number of Exim functions.
31756 These are the only ones that are guaranteed to be maintained from release to
31757 release:
31758
31759 .vlist
31760 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31761        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31762
31763 This function creates a child process that runs the command specified by
31764 &%argv%&. The environment for the process is specified by &%envp%&, which can
31765 be NULL if no environment variables are to be passed. A new umask is supplied
31766 for the process in &%newumask%&.
31767
31768 Pipes to the standard input and output of the new process are set up
31769 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31770 standard error is cloned to the standard output. If there are any file
31771 descriptors &"in the way"& in the new process, they are closed. If the final
31772 argument is TRUE, the new process is made into a process group leader.
31773
31774 The function returns the pid of the new process, or -1 if things go wrong.
31775
31776 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31777 This function waits for a child process to terminate, or for a timeout (in
31778 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31779 return value is as follows:
31780
31781 .ilist
31782 >= 0
31783
31784 The process terminated by a normal exit and the value is the process
31785 ending status.
31786
31787 .next
31788 < 0 and > &--256
31789
31790 The process was terminated by a signal and the value is the negation of the
31791 signal number.
31792
31793 .next
31794 &--256
31795
31796 The process timed out.
31797 .next
31798 &--257
31799
31800 The was some other error in wait(); &%errno%& is still set.
31801 .endlist
31802
31803 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31804 This function provide you with a means of submitting a new message to
31805 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31806 want, but this packages it all up for you.) The function creates a pipe,
31807 forks a subprocess that is running
31808 .code
31809 exim -t -oem -oi -f <>
31810 .endd
31811 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31812 that is connected to the standard input. The yield of the function is the PID
31813 of the subprocess. You can then write a message to the file descriptor, with
31814 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31815
31816 When you have finished, call &'child_close()'& to wait for the process to
31817 finish and to collect its ending status. A timeout value of zero is usually
31818 fine in this circumstance. Unless you have made a mistake with the recipient
31819 addresses, you should get a return code of zero.
31820
31821
31822 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31823        *sender_authentication)*&
31824 This function is a more sophisticated version of &'child_open()'&. The command
31825 that it runs is:
31826 .display
31827 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31828 .endd
31829 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31830
31831
31832 .vitem &*void&~debug_printf(char&~*,&~...)*&
31833 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31834 output is written to the standard error stream. If no debugging is selected,
31835 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31836 conditional on the &`local_scan`& debug selector by coding like this:
31837 .code
31838 if ((debug_selector & D_local_scan) != 0)
31839   debug_printf("xxx", ...);
31840 .endd
31841
31842 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31843 This is an interface to Exim's string expansion code. The return value is the
31844 expanded string, or NULL if there was an expansion failure.
31845 The C variable &%expand_string_message%& contains an error message after an
31846 expansion failure. If expansion does not change the string, the return value is
31847 the pointer to the input string. Otherwise, the return value points to a new
31848 block of memory that was obtained by a call to &'store_get()'&. See section
31849 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31850
31851 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31852 This function allows you to an add additional header line at the end of the
31853 existing ones. The first argument is the type, and should normally be a space
31854 character. The second argument is a format string and any number of
31855 substitution arguments as for &[sprintf()]&. You may include internal newlines
31856 if you want, and you must ensure that the string ends with a newline.
31857
31858 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31859         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31860 This function adds a new header line at a specified point in the header
31861 chain. The header itself is specified as for &'header_add()'&.
31862
31863 If &%name%& is NULL, the new header is added at the end of the chain if
31864 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31865 NULL, the header lines are searched for the first non-deleted header that
31866 matches the name. If one is found, the new header is added before it if
31867 &%after%& is false. If &%after%& is true, the new header is added after the
31868 found header and any adjacent subsequent ones with the same name (even if
31869 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31870 option controls where the header is added. If it is true, addition is at the
31871 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31872 headers, or at the top if there are no &'Received:'& headers, you could use
31873 .code
31874 header_add_at_position(TRUE, US"Received", TRUE,
31875   ' ', "X-xxx: ...");
31876 .endd
31877 Normally, there is always at least one non-deleted &'Received:'& header, but
31878 there may not be if &%received_header_text%& expands to an empty string.
31879
31880
31881 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31882 This function removes header lines. If &%occurrence%& is zero or negative, all
31883 occurrences of the header are removed. If occurrence is greater than zero, that
31884 particular instance of the header is removed. If no header(s) can be found that
31885 match the specification, the function does nothing.
31886
31887
31888 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31889         int&~length,&~BOOL&~notdel)*&"
31890 This function tests whether the given header has the given name. It is not just
31891 a string comparison, because white space is permitted between the name and the
31892 colon. If the &%notdel%& argument is true, a false return is forced for all
31893 &"deleted"& headers; otherwise they are not treated specially. For example:
31894 .code
31895 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31896 .endd
31897 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31898 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31899 This function base64-encodes a string, which is passed by address and length.
31900 The text may contain bytes of any value, including zero. The result is passed
31901 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31902 zero-terminated.
31903
31904 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31905 This function decodes a base64-encoded string. Its arguments are a
31906 zero-terminated base64-encoded string and the address of a variable that is set
31907 to point to the result, which is in dynamic memory. The length of the decoded
31908 string is the yield of the function. If the input is invalid base64 data, the
31909 yield is -1. A zero byte is added to the end of the output string to make it
31910 easy to interpret as a C string (assuming it contains no zeros of its own). The
31911 added zero byte is not included in the returned count.
31912
31913 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31914 This function checks for a match in a domain list. Domains are always
31915 matched caselessly. The return value is one of the following:
31916 .display
31917 &`OK     `& match succeeded
31918 &`FAIL   `& match failed
31919 &`DEFER  `& match deferred
31920 .endd
31921 DEFER is usually caused by some kind of lookup defer, such as the
31922 inability to contact a database.
31923
31924 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31925         BOOL&~caseless)*&"
31926 This function checks for a match in a local part list. The third argument
31927 controls case-sensitivity. The return values are as for
31928 &'lss_match_domain()'&.
31929
31930 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31931         BOOL&~caseless)*&"
31932 This function checks for a match in an address list. The third argument
31933 controls the case-sensitivity of the local part match. The domain is always
31934 matched caselessly. The return values are as for &'lss_match_domain()'&.
31935
31936 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31937         uschar&~*list)*&"
31938 This function checks for a match in a host list. The most common usage is
31939 expected to be
31940 .code
31941 lss_match_host(sender_host_name, sender_host_address, ...)
31942 .endd
31943 .vindex "&$sender_host_address$&"
31944 An empty address field matches an empty item in the host list. If the host name
31945 is NULL, the name corresponding to &$sender_host_address$& is automatically
31946 looked up if a host name is required to match an item in the list. The return
31947 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31948 returns ERROR in the case when it had to look up a host name, but the lookup
31949 failed.
31950
31951 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31952         *format,&~...)*&"
31953 This function writes to Exim's log files. The first argument should be zero (it
31954 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31955 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31956 them. It specifies to which log or logs the message is written. The remaining
31957 arguments are a format and relevant insertion arguments. The string should not
31958 contain any newlines, not even at the end.
31959
31960
31961 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31962 This function adds an additional recipient to the message. The first argument
31963 is the recipient address. If it is unqualified (has no domain), it is qualified
31964 with the &%qualify_recipient%& domain. The second argument must always be -1.
31965
31966 This function does not allow you to specify a private &%errors_to%& address (as
31967 described with the structure of &%recipient_item%& above), because it pre-dates
31968 the addition of that field to the structure. However, it is easy to add such a
31969 value afterwards. For example:
31970 .code
31971  receive_add_recipient(US"monitor@mydom.example", -1);
31972  recipients_list[recipients_count-1].errors_to =
31973    US"postmaster@mydom.example";
31974 .endd
31975
31976 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31977 This is a convenience function to remove a named recipient from the list of
31978 recipients. It returns true if a recipient was removed, and false if no
31979 matching recipient could be found. The argument must be a complete email
31980 address.
31981 .endlist
31982
31983
31984 .cindex "RFC 2047"
31985 .vlist
31986 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31987   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31988 This function decodes strings that are encoded according to RFC 2047. Typically
31989 these are the contents of header lines. First, each &"encoded word"& is decoded
31990 from the Q or B encoding into a byte-string. Then, if provided with the name of
31991 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31992 made  to translate the result to the named character set. If this fails, the
31993 binary string is returned with an error message.
31994
31995 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31996 maximum MIME word length is enforced. The third argument is the target
31997 encoding, or NULL if no translation is wanted.
31998
31999 .cindex "binary zero" "in RFC 2047 decoding"
32000 .cindex "RFC 2047" "binary zero in"
32001 If a binary zero is encountered in the decoded string, it is replaced by the
32002 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32003 not be 0 because header lines are handled as zero-terminated strings.
32004
32005 The function returns the result of processing the string, zero-terminated; if
32006 &%lenptr%& is not NULL, the length of the result is set in the variable to
32007 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32008
32009 If an error is encountered, the function returns NULL and uses the &%error%&
32010 argument to return an error message. The variable pointed to by &%error%& is
32011 set to NULL if there is no error; it may be set non-NULL even when the function
32012 returns a non-NULL value if decoding was successful, but there was a problem
32013 with translation.
32014
32015
32016 .vitem &*int&~smtp_fflush(void)*&
32017 This function is used in conjunction with &'smtp_printf()'&, as described
32018 below.
32019
32020 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32021 The arguments of this function are like &[printf()]&; it writes to the SMTP
32022 output stream. You should use this function only when there is an SMTP output
32023 stream, that is, when the incoming message is being received via interactive
32024 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32025 is FALSE. If you want to test for an incoming message from another host (as
32026 opposed to a local process that used the &%-bs%& command line option), you can
32027 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32028 is involved.
32029
32030 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32031 output function, so it can be used for all forms of SMTP connection.
32032
32033 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32034 must start with an appropriate response code: 550 if you are going to return
32035 LOCAL_SCAN_REJECT, 451 if you are going to return
32036 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32037 initial lines of a multi-line response, the code must be followed by a hyphen
32038 to indicate that the line is not the final response line. You must also ensure
32039 that the lines you write terminate with CRLF. For example:
32040 .code
32041 smtp_printf("550-this is some extra info\r\n");
32042 return LOCAL_SCAN_REJECT;
32043 .endd
32044 Note that you can also create multi-line responses by including newlines in
32045 the data returned via the &%return_text%& argument. The added value of using
32046 &'smtp_printf()'& is that, for instance, you could introduce delays between
32047 multiple output lines.
32048
32049 The &'smtp_printf()'& function does not return any error indication, because it
32050 does not automatically flush pending output, and therefore does not test
32051 the state of the stream. (In the main code of Exim, flushing and error
32052 detection is done when Exim is ready for the next SMTP input command.) If
32053 you want to flush the output and check for an error (for example, the
32054 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32055 arguments. It flushes the output stream, and returns a non-zero value if there
32056 is an error.
32057
32058 .vitem &*void&~*store_get(int)*&
32059 This function accesses Exim's internal store (memory) manager. It gets a new
32060 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32061 runs out of memory. See the next section for a discussion of memory handling.
32062
32063 .vitem &*void&~*store_get_perm(int)*&
32064 This function is like &'store_get()'&, but it always gets memory from the
32065 permanent pool. See the next section for a discussion of memory handling.
32066
32067 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32068 See below.
32069
32070 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32071 See below.
32072
32073 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32074 These three functions create strings using Exim's dynamic memory facilities.
32075 The first makes a copy of an entire string. The second copies up to a maximum
32076 number of characters, indicated by the second argument. The third uses a format
32077 and insertion arguments to create a new string. In each case, the result is a
32078 pointer to a new string in the current memory pool. See the next section for
32079 more discussion.
32080 .endlist
32081
32082
32083
32084 .section "More about Exim's memory handling" "SECTmemhanloc"
32085 .cindex "&[local_scan()]& function" "memory handling"
32086 No function is provided for freeing memory, because that is never needed.
32087 The dynamic memory that Exim uses when receiving a message is automatically
32088 recycled if another message is received by the same process (this applies only
32089 to incoming SMTP connections &-- other input methods can supply only one
32090 message at a time). After receiving the last message, a reception process
32091 terminates.
32092
32093 Because it is recycled, the normal dynamic memory cannot be used for holding
32094 data that must be preserved over a number of incoming messages on the same SMTP
32095 connection. However, Exim in fact uses two pools of dynamic memory; the second
32096 one is not recycled, and can be used for this purpose.
32097
32098 If you want to allocate memory that remains available for subsequent messages
32099 in the same SMTP connection, you should set
32100 .code
32101 store_pool = POOL_PERM
32102 .endd
32103 before calling the function that does the allocation. There is no need to
32104 restore the value if you do not need to; however, if you do want to revert to
32105 the normal pool, you can either restore the previous value of &%store_pool%& or
32106 set it explicitly to POOL_MAIN.
32107
32108 The pool setting applies to all functions that get dynamic memory, including
32109 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32110 There is also a convenience function called &'store_get_perm()'& that gets a
32111 block of memory from the permanent pool while preserving the value of
32112 &%store_pool%&.
32113 .ecindex IIDlosca
32114
32115
32116
32117
32118 . ////////////////////////////////////////////////////////////////////////////
32119 . ////////////////////////////////////////////////////////////////////////////
32120
32121 .chapter "System-wide message filtering" "CHAPsystemfilter"
32122 .scindex IIDsysfil1 "filter" "system filter"
32123 .scindex IIDsysfil2 "filtering all mail"
32124 .scindex IIDsysfil3 "system filter"
32125 The previous chapters (on ACLs and the local scan function) describe checks
32126 that can be applied to messages before they are accepted by a host. There is
32127 also a mechanism for checking messages once they have been received, but before
32128 they are delivered. This is called the &'system filter'&.
32129
32130 The system filter operates in a similar manner to users' filter files, but it
32131 is run just once per message (however many recipients the message has).
32132 It should not normally be used as a substitute for routing, because &%deliver%&
32133 commands in a system router provide new envelope recipient addresses.
32134 The system filter must be an Exim filter. It cannot be a Sieve filter.
32135
32136 The system filter is run at the start of a delivery attempt, before any routing
32137 is done. If a message fails to be completely delivered at the first attempt,
32138 the system filter is run again at the start of every retry.
32139 If you want your filter to do something only once per message, you can make use
32140 of the &%first_delivery%& condition in an &%if%& command in the filter to
32141 prevent it happening on retries.
32142
32143 .vindex "&$domain$&"
32144 .vindex "&$local_part$&"
32145 &*Warning*&: Because the system filter runs just once, variables that are
32146 specific to individual recipient addresses, such as &$local_part$& and
32147 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32148 you want to run a centrally-specified filter for each recipient address
32149 independently, you can do so by setting up a suitable &(redirect)& router, as
32150 described in section &<<SECTperaddfil>>& below.
32151
32152
32153 .section "Specifying a system filter" "SECID212"
32154 .cindex "uid (user id)" "system filter"
32155 .cindex "gid (group id)" "system filter"
32156 The name of the file that contains the system filter must be specified by
32157 setting &%system_filter%&. If you want the filter to run under a uid and gid
32158 other than root, you must also set &%system_filter_user%& and
32159 &%system_filter_group%& as appropriate. For example:
32160 .code
32161 system_filter = /etc/mail/exim.filter
32162 system_filter_user = exim
32163 .endd
32164 If a system filter generates any deliveries directly to files or pipes (via the
32165 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32166 specified by setting &%system_filter_file_transport%& and
32167 &%system_filter_pipe_transport%&, respectively. Similarly,
32168 &%system_filter_reply_transport%& must be set to handle any messages generated
32169 by the &%reply%& command.
32170
32171
32172 .section "Testing a system filter" "SECID213"
32173 You can run simple tests of a system filter in the same way as for a user
32174 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32175 are permitted only in system filters are recognized.
32176
32177 If you want to test the combined effect of a system filter and a user filter,
32178 you can use both &%-bF%& and &%-bf%& on the same command line.
32179
32180
32181
32182 .section "Contents of a system filter" "SECID214"
32183 The language used to specify system filters is the same as for users' filter
32184 files. It is described in the separate end-user document &'Exim's interface to
32185 mail filtering'&. However, there are some additional features that are
32186 available only in system filters; these are described in subsequent sections.
32187 If they are encountered in a user's filter file or when testing with &%-bf%&,
32188 they cause errors.
32189
32190 .cindex "frozen messages" "manual thaw; testing in filter"
32191 There are two special conditions which, though available in users' filter
32192 files, are designed for use in system filters. The condition &%first_delivery%&
32193 is true only for the first attempt at delivering a message, and
32194 &%manually_thawed%& is true only if the message has been frozen, and
32195 subsequently thawed by an admin user. An explicit forced delivery counts as a
32196 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32197
32198 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32199 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32200 succeed, it will not be tried again.
32201 If you want Exim to retry an unseen delivery until it succeeds, you should
32202 arrange to set it up every time the filter runs.
32203
32204 When a system filter finishes running, the values of the variables &$n0$& &--
32205 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32206 users' filter files. Thus a system filter can, for example, set up &"scores"&
32207 to which users' filter files can refer.
32208
32209
32210
32211 .section "Additional variable for system filters" "SECID215"
32212 .vindex "&$recipients$&"
32213 The expansion variable &$recipients$&, containing a list of all the recipients
32214 of the message (separated by commas and white space), is available in system
32215 filters. It is not available in users' filters for privacy reasons.
32216
32217
32218
32219 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32220 .cindex "freezing messages"
32221 .cindex "message" "freezing"
32222 .cindex "message" "forced failure"
32223 .cindex "&%fail%&" "in system filter"
32224 .cindex "&%freeze%& in system filter"
32225 .cindex "&%defer%& in system filter"
32226 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32227 always available in system filters, but are not normally enabled in users'
32228 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32229 for the &(redirect)& router.) These commands can optionally be followed by the
32230 word &%text%& and a string containing an error message, for example:
32231 .code
32232 fail text "this message looks like spam to me"
32233 .endd
32234 The keyword &%text%& is optional if the next character is a double quote.
32235
32236 The &%defer%& command defers delivery of the original recipients of the
32237 message. The &%fail%& command causes all the original recipients to be failed,
32238 and a bounce message to be created. The &%freeze%& command suspends all
32239 delivery attempts for the original recipients. In all cases, any new deliveries
32240 that are specified by the filter are attempted as normal after the filter has
32241 run.
32242
32243 The &%freeze%& command is ignored if the message has been manually unfrozen and
32244 not manually frozen since. This means that automatic freezing by a system
32245 filter can be used as a way of checking out suspicious messages. If a message
32246 is found to be all right, manually unfreezing it allows it to be delivered.
32247
32248 .cindex "log" "&%fail%& command log line"
32249 .cindex "&%fail%&" "log line; reducing"
32250 The text given with a fail command is used as part of the bounce message as
32251 well as being written to the log. If the message is quite long, this can fill
32252 up a lot of log space when such failures are common. To reduce the size of the
32253 log message, Exim interprets the text in a special way if it starts with the
32254 two characters &`<<`& and contains &`>>`& later. The text between these two
32255 strings is written to the log, and the rest of the text is used in the bounce
32256 message. For example:
32257 .code
32258 fail "<<filter test 1>>Your message is rejected \
32259      because it contains attachments that we are \
32260      not prepared to receive."
32261 .endd
32262
32263 .cindex "loop" "caused by &%fail%&"
32264 Take great care with the &%fail%& command when basing the decision to fail on
32265 the contents of the message, because the bounce message will of course include
32266 the contents of the original message and will therefore trigger the &%fail%&
32267 command again (causing a mail loop) unless steps are taken to prevent this.
32268 Testing the &%error_message%& condition is one way to prevent this. You could
32269 use, for example
32270 .code
32271 if $message_body contains "this is spam" and not error_message
32272 then fail text "spam is not wanted here" endif
32273 .endd
32274 though of course that might let through unwanted bounce messages. The
32275 alternative is clever checking of the body and/or headers to detect bounces
32276 generated by the filter.
32277
32278 The interpretation of a system filter file ceases after a
32279 &%defer%&,
32280 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32281 set up earlier in the filter file are honoured, so you can use a sequence such
32282 as
32283 .code
32284 mail ...
32285 freeze
32286 .endd
32287 to send a specified message when the system filter is freezing (or deferring or
32288 failing) a message. The normal deliveries for the message do not, of course,
32289 take place.
32290
32291
32292
32293 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32294 .cindex "header lines" "adding; in system filter"
32295 .cindex "header lines" "removing; in system filter"
32296 .cindex "filter" "header lines; adding/removing"
32297 Two filter commands that are available only in system filters are:
32298 .code
32299 headers add <string>
32300 headers remove <string>
32301 .endd
32302 The argument for the &%headers add%& is a string that is expanded and then
32303 added to the end of the message's headers. It is the responsibility of the
32304 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32305 space is ignored, and if the string is otherwise empty, or if the expansion is
32306 forced to fail, the command has no effect.
32307
32308 You can use &"\n"& within the string, followed by white space, to specify
32309 continued header lines. More than one header may be added in one command by
32310 including &"\n"& within the string without any following white space. For
32311 example:
32312 .code
32313 headers add "X-header-1: ....\n  \
32314              continuation of X-header-1 ...\n\
32315              X-header-2: ...."
32316 .endd
32317 Note that the header line continuation white space after the first newline must
32318 be placed before the backslash that continues the input string, because white
32319 space after input continuations is ignored.
32320
32321 The argument for &%headers remove%& is a colon-separated list of header names.
32322 This command applies only to those headers that are stored with the message;
32323 those that are added at delivery time (such as &'Envelope-To:'& and
32324 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32325 header with the same name, they are all removed.
32326
32327 The &%headers%& command in a system filter makes an immediate change to the set
32328 of header lines that was received with the message (with possible additions
32329 from ACL processing). Subsequent commands in the system filter operate on the
32330 modified set, which also forms the basis for subsequent message delivery.
32331 Unless further modified during routing or transporting, this set of headers is
32332 used for all recipients of the message.
32333
32334 During routing and transporting, the variables that refer to the contents of
32335 header lines refer only to those lines that are in this set. Thus, header lines
32336 that are added by a system filter are visible to users' filter files and to all
32337 routers and transports. This contrasts with the manipulation of header lines by
32338 routers and transports, which is not immediate, but which instead is saved up
32339 until the message is actually being written (see section
32340 &<<SECTheadersaddrem>>&).
32341
32342 If the message is not delivered at the first attempt, header lines that were
32343 added by the system filter are stored with the message, and so are still
32344 present at the next delivery attempt. Header lines that were removed are still
32345 present, but marked &"deleted"& so that they are not transported with the
32346 message. For this reason, it is usual to make the &%headers%& command
32347 conditional on &%first_delivery%& so that the set of header lines is not
32348 modified more than once.
32349
32350 Because header modification in a system filter acts immediately, you have to
32351 use an indirect approach if you want to modify the contents of a header line.
32352 For example:
32353 .code
32354 headers add "Old-Subject: $h_subject:"
32355 headers remove "Subject"
32356 headers add "Subject: new subject (was: $h_old-subject:)"
32357 headers remove "Old-Subject"
32358 .endd
32359
32360
32361
32362 .section "Setting an errors address in a system filter" "SECID217"
32363 .cindex "envelope sender"
32364 In a system filter, if a &%deliver%& command is followed by
32365 .code
32366 errors_to <some address>
32367 .endd
32368 in order to change the envelope sender (and hence the error reporting) for that
32369 delivery, any address may be specified. (In a user filter, only the current
32370 user's address can be set.) For example, if some mail is being monitored, you
32371 might use
32372 .code
32373 unseen deliver monitor@spying.example errors_to root@local.example
32374 .endd
32375 to take a copy which would not be sent back to the normal error reporting
32376 address if its delivery failed.
32377
32378
32379
32380 .section "Per-address filtering" "SECTperaddfil"
32381 .vindex "&$domain$&"
32382 .vindex "&$local_part$&"
32383 In contrast to the system filter, which is run just once per message for each
32384 delivery attempt, it is also possible to set up a system-wide filtering
32385 operation that runs once for each recipient address. In this case, variables
32386 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32387 filter file could be made dependent on them. This is an example of a router
32388 which implements such a filter:
32389 .code
32390 central_filter:
32391   check_local_user
32392   driver = redirect
32393   domains = +local_domains
32394   file = /central/filters/$local_part
32395   no_verify
32396   allow_filter
32397   allow_freeze
32398 .endd
32399 The filter is run in a separate process under its own uid. Therefore, either
32400 &%check_local_user%& must be set (as above), in which case the filter is run as
32401 the local user, or the &%user%& option must be used to specify which user to
32402 use. If both are set, &%user%& overrides.
32403
32404 Care should be taken to ensure that none of the commands in the filter file
32405 specify a significant delivery if the message is to go on to be delivered to
32406 its intended recipient. The router will not then claim to have dealt with the
32407 address, so it will be passed on to subsequent routers to be delivered in the
32408 normal way.
32409 .ecindex IIDsysfil1
32410 .ecindex IIDsysfil2
32411 .ecindex IIDsysfil3
32412
32413
32414
32415
32416
32417
32418 . ////////////////////////////////////////////////////////////////////////////
32419 . ////////////////////////////////////////////////////////////////////////////
32420
32421 .chapter "Message processing" "CHAPmsgproc"
32422 .scindex IIDmesproc "message" "general processing"
32423 Exim performs various transformations on the sender and recipient addresses of
32424 all messages that it handles, and also on the messages' header lines. Some of
32425 these are optional and configurable, while others always take place. All of
32426 this processing, except rewriting as a result of routing, and the addition or
32427 removal of header lines while delivering, happens when a message is received,
32428 before it is placed on Exim's queue.
32429
32430 Some of the automatic processing takes place by default only for
32431 &"locally-originated"& messages. This adjective is used to describe messages
32432 that are not received over TCP/IP, but instead are passed to an Exim process on
32433 its standard input. This includes the interactive &"local SMTP"& case that is
32434 set up by the &%-bs%& command line option.
32435
32436 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32437 or ::1) are not considered to be locally-originated. Exim does not treat the
32438 loopback interface specially in any way.
32439
32440 If you want the loopback interface to be treated specially, you must ensure
32441 that there are appropriate entries in your ACLs.
32442
32443
32444
32445
32446 .section "Submission mode for non-local messages" "SECTsubmodnon"
32447 .cindex "message" "submission"
32448 .cindex "submission mode"
32449 Processing that happens automatically for locally-originated messages (unless
32450 &%suppress_local_fixups%& is set) can also be requested for messages that are
32451 received over TCP/IP. The term &"submission mode"& is used to describe this
32452 state. Submission mode is set by the modifier
32453 .code
32454 control = submission
32455 .endd
32456 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32457 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32458 a local submission, and is normally used when the source of the message is
32459 known to be an MUA running on a client host (as opposed to an MTA). For
32460 example, to set submission mode for messages originating on the IPv4 loopback
32461 interface, you could include the following in the MAIL ACL:
32462 .code
32463 warn  hosts = 127.0.0.1
32464       control = submission
32465 .endd
32466 .cindex "&%sender_retain%& submission option"
32467 There are some options that can be used when setting submission mode. A slash
32468 is used to separate options. For example:
32469 .code
32470 control = submission/sender_retain
32471 .endd
32472 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32473 true and &%local_from_check%& false for the current incoming message. The first
32474 of these allows an existing &'Sender:'& header in the message to remain, and
32475 the second suppresses the check to ensure that &'From:'& matches the
32476 authenticated sender. With this setting, Exim still fixes up messages by adding
32477 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32478 attempt to check sender authenticity in header lines.
32479
32480 When &%sender_retain%& is not set, a submission mode setting may specify a
32481 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32482 example:
32483 .code
32484 control = submission/domain=some.domain
32485 .endd
32486 The domain may be empty. How this value is used is described in sections
32487 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32488 that allows you to specify the user's full name for inclusion in a created
32489 &'Sender:'& or &'From:'& header line. For example:
32490 .code
32491 accept authenticated = *
32492        control = submission/domain=wonderland.example/\
32493                             name=${lookup {$authenticated_id} \
32494                                    lsearch {/etc/exim/namelist}}
32495 .endd
32496 Because the name may contain any characters, including slashes, the &%name%&
32497 option must be given last. The remainder of the string is used as the name. For
32498 the example above, if &_/etc/exim/namelist_& contains:
32499 .code
32500 bigegg:  Humpty Dumpty
32501 .endd
32502 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32503 line would be:
32504 .code
32505 Sender: Humpty Dumpty <bigegg@wonderland.example>
32506 .endd
32507 .cindex "return path" "in submission mode"
32508 By default, submission mode forces the return path to the same address as is
32509 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32510 specified, the return path is also left unchanged.
32511
32512 &*Note*&: The changes caused by submission mode take effect after the predata
32513 ACL. This means that any sender checks performed before the fix-ups use the
32514 untrusted sender address specified by the user, not the trusted sender address
32515 specified by submission mode. Although this might be slightly unexpected, it
32516 does mean that you can configure ACL checks to spot that a user is trying to
32517 spoof another's address.
32518
32519 .section "Line endings" "SECTlineendings"
32520 .cindex "line endings"
32521 .cindex "carriage return"
32522 .cindex "linefeed"
32523 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32524 linefeed) is the line ending for messages transmitted over the Internet using
32525 SMTP over TCP/IP. However, within individual operating systems, different
32526 conventions are used. For example, Unix-like systems use just LF, but others
32527 use CRLF or just CR.
32528
32529 Exim was designed for Unix-like systems, and internally, it stores messages
32530 using the system's convention of a single LF as a line terminator. When
32531 receiving a message, all line endings are translated to this standard format.
32532 Originally, it was thought that programs that passed messages directly to an
32533 MTA within an operating system would use that system's convention. Experience
32534 has shown that this is not the case; for example, there are Unix applications
32535 that use CRLF in this circumstance. For this reason, and for compatibility with
32536 other MTAs, the way Exim handles line endings for all messages is now as
32537 follows:
32538
32539 .ilist
32540 LF not preceded by CR is treated as a line ending.
32541 .next
32542 CR is treated as a line ending; if it is immediately followed by LF, the LF
32543 is ignored.
32544 .next
32545 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32546 nor a local message in the state where a line containing only a dot is a
32547 terminator.
32548 .next
32549 If a bare CR is encountered within a header line, an extra space is added after
32550 the line terminator so as not to end the header line. The reasoning behind this
32551 is that bare CRs in header lines are most likely either to be mistakes, or
32552 people trying to play silly games.
32553 .next
32554 If the first header line received in a message ends with CRLF, a subsequent
32555 bare LF in a header line is treated in the same way as a bare CR in a header
32556 line.
32557 .endlist
32558
32559
32560
32561
32562
32563 .section "Unqualified addresses" "SECID218"
32564 .cindex "unqualified addresses"
32565 .cindex "address" "qualification"
32566 By default, Exim expects every envelope address it receives from an external
32567 host to be fully qualified. Unqualified addresses cause negative responses to
32568 SMTP commands. However, because SMTP is used as a means of transporting
32569 messages from MUAs running on personal workstations, there is sometimes a
32570 requirement to accept unqualified addresses from specific hosts or IP networks.
32571
32572 Exim has two options that separately control which hosts may send unqualified
32573 sender or recipient addresses in SMTP commands, namely
32574 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32575 cases, if an unqualified address is accepted, it is qualified by adding the
32576 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32577
32578 .oindex "&%qualify_domain%&"
32579 .oindex "&%qualify_recipient%&"
32580 Unqualified addresses in header lines are automatically qualified for messages
32581 that are locally originated, unless the &%-bnq%& option is given on the command
32582 line. For messages received over SMTP, unqualified addresses in header lines
32583 are qualified only if unqualified addresses are permitted in SMTP commands. In
32584 other words, such qualification is also controlled by
32585 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32586
32587
32588
32589
32590 .section "The UUCP From line" "SECID219"
32591 .cindex "&""From""& line"
32592 .cindex "UUCP" "&""From""& line"
32593 .cindex "sender" "address"
32594 .oindex "&%uucp_from_pattern%&"
32595 .oindex "&%uucp_from_sender%&"
32596 .cindex "envelope sender"
32597 .cindex "Sendmail compatibility" "&""From""& line"
32598 Messages that have come from UUCP (and some other applications) often begin
32599 with a line containing the envelope sender and a timestamp, following the word
32600 &"From"&. Examples of two common formats are:
32601 .code
32602 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32603 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32604 .endd
32605 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32606 Exim recognizes such lines at the start of messages that are submitted to it
32607 via the command line (that is, on the standard input). It does not recognize
32608 such lines in incoming SMTP messages, unless the sending host matches
32609 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32610 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32611 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32612 default value matches the two common cases shown above and puts the address
32613 that follows &"From"& into &$1$&.
32614
32615 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32616 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32617 a trusted user, the message's sender address is constructed by expanding the
32618 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32619 then parsed as an RFC 2822 address. If there is no domain, the local part is
32620 qualified with &%qualify_domain%& unless it is the empty string. However, if
32621 the command line &%-f%& option is used, it overrides the &"From"& line.
32622
32623 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32624 sender address is not changed. This is also the case for incoming SMTP messages
32625 that are permitted to contain &"From"& lines.
32626
32627 Only one &"From"& line is recognized. If there is more than one, the second is
32628 treated as a data line that starts the body of the message, as it is not valid
32629 as a header line. This also happens if a &"From"& line is present in an
32630 incoming SMTP message from a source that is not permitted to send them.
32631
32632
32633
32634 .section "Resent- header lines" "SECID220"
32635 .cindex "&%Resent-%& header lines"
32636 RFC 2822 makes provision for sets of header lines starting with the string
32637 &`Resent-`& to be added to a message when it is resent by the original
32638 recipient to somebody else. These headers are &'Resent-Date:'&,
32639 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32640 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32641
32642 .blockquote
32643 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32644 processing of replies or other such automatic actions on messages.'&
32645 .endblockquote
32646
32647 This leaves things a bit vague as far as other processing actions such as
32648 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32649 follows:
32650
32651 .ilist
32652 A &'Resent-From:'& line that just contains the login id of the submitting user
32653 is automatically rewritten in the same way as &'From:'& (see below).
32654 .next
32655 If there's a rewriting rule for a particular header line, it is also applied to
32656 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32657 &'From:'& also rewrites &'Resent-From:'&.
32658 .next
32659 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32660 also removed.
32661 .next
32662 For a locally-submitted message,
32663 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32664 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32665 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32666 included in log lines in this case.
32667 .next
32668 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32669 &%Resent-%& header lines are present.
32670 .endlist
32671
32672
32673
32674
32675 .section "The Auto-Submitted: header line" "SECID221"
32676 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32677 includes the header line:
32678 .code
32679 Auto-Submitted: auto-replied
32680 .endd
32681
32682 .section "The Bcc: header line" "SECID222"
32683 .cindex "&'Bcc:'& header line"
32684 If Exim is called with the &%-t%& option, to take recipient addresses from a
32685 message's header, it removes any &'Bcc:'& header line that may exist (after
32686 extracting its addresses). If &%-t%& is not present on the command line, any
32687 existing &'Bcc:'& is not removed.
32688
32689
32690 .section "The Date: header line" "SECID223"
32691 .cindex "&'Date:'& header line"
32692 If a locally-generated or submission-mode message has no &'Date:'& header line,
32693 Exim adds one, using the current date and time, unless the
32694 &%suppress_local_fixups%& control has been specified.
32695
32696 .section "The Delivery-date: header line" "SECID224"
32697 .cindex "&'Delivery-date:'& header line"
32698 .oindex "&%delivery_date_remove%&"
32699 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32700 set. Exim can be configured to add them to the final delivery of messages. (See
32701 the generic &%delivery_date_add%& transport option.) They should not be present
32702 in messages in transit. If the &%delivery_date_remove%& configuration option is
32703 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32704 messages.
32705
32706
32707 .section "The Envelope-to: header line" "SECID225"
32708 .cindex "&'Envelope-to:'& header line"
32709 .oindex "&%envelope_to_remove%&"
32710 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32711 Exim can be configured to add them to the final delivery of messages. (See the
32712 generic &%envelope_to_add%& transport option.) They should not be present in
32713 messages in transit. If the &%envelope_to_remove%& configuration option is set
32714 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32715 messages.
32716
32717
32718 .section "The From: header line" "SECTthefrohea"
32719 .cindex "&'From:'& header line"
32720 .cindex "Sendmail compatibility" "&""From""& line"
32721 .cindex "message" "submission"
32722 .cindex "submission mode"
32723 If a submission-mode message does not contain a &'From:'& header line, Exim
32724 adds one if either of the following conditions is true:
32725
32726 .ilist
32727 The envelope sender address is not empty (that is, this is not a bounce
32728 message). The added header line copies the envelope sender address.
32729 .next
32730 .vindex "&$authenticated_id$&"
32731 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32732 .olist
32733 .vindex "&$qualify_domain$&"
32734 If no domain is specified by the submission control, the local part is
32735 &$authenticated_id$& and the domain is &$qualify_domain$&.
32736 .next
32737 If a non-empty domain is specified by the submission control, the local
32738 part is &$authenticated_id$&, and the domain is the specified domain.
32739 .next
32740 If an empty domain is specified by the submission control,
32741 &$authenticated_id$& is assumed to be the complete address.
32742 .endlist
32743 .endlist
32744
32745 A non-empty envelope sender takes precedence.
32746
32747 If a locally-generated incoming message does not contain a &'From:'& header
32748 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32749 containing the sender's address. The calling user's login name and full name
32750 are used to construct the address, as described in section &<<SECTconstr>>&.
32751 They are obtained from the password data by calling &[getpwuid()]& (but see the
32752 &%unknown_login%& configuration option). The address is qualified with
32753 &%qualify_domain%&.
32754
32755 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32756 &'From:'& header line containing just the unqualified login name of the calling
32757 user, this is replaced by an address containing the user's login name and full
32758 name as described in section &<<SECTconstr>>&.
32759
32760
32761 .section "The Message-ID: header line" "SECID226"
32762 .cindex "&'Message-ID:'& header line"
32763 .cindex "message" "submission"
32764 .oindex "&%message_id_header_text%&"
32765 If a locally-generated or submission-mode incoming message does not contain a
32766 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32767 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32768 to the message. If there are any &'Resent-:'& headers in the message, it
32769 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32770 message id, preceded by the letter E to ensure it starts with a letter, and
32771 followed by @ and the primary host name. Additional information can be included
32772 in this header line by setting the &%message_id_header_text%& and/or
32773 &%message_id_header_domain%& options.
32774
32775
32776 .section "The Received: header line" "SECID227"
32777 .cindex "&'Received:'& header line"
32778 A &'Received:'& header line is added at the start of every message. The
32779 contents are defined by the &%received_header_text%& configuration option, and
32780 Exim automatically adds a semicolon and a timestamp to the configured string.
32781
32782 The &'Received:'& header is generated as soon as the message's header lines
32783 have been received. At this stage, the timestamp in the &'Received:'& header
32784 line is the time that the message started to be received. This is the value
32785 that is seen by the DATA ACL and by the &[local_scan()]& function.
32786
32787 Once a message is accepted, the timestamp in the &'Received:'& header line is
32788 changed to the time of acceptance, which is (apart from a small delay while the
32789 -H spool file is written) the earliest time at which delivery could start.
32790
32791
32792 .section "The References: header line" "SECID228"
32793 .cindex "&'References:'& header line"
32794 Messages created by the &(autoreply)& transport include a &'References:'&
32795 header line. This is constructed according to the rules that are described in
32796 section 3.64 of RFC 2822 (which states that replies should contain such a
32797 header line), and section 3.14 of RFC 3834 (which states that automatic
32798 responses are not different in this respect). However, because some mail
32799 processing software does not cope well with very long header lines, no more
32800 than 12 message IDs are copied from the &'References:'& header line in the
32801 incoming message. If there are more than 12, the first one and then the final
32802 11 are copied, before adding the message ID of the incoming message.
32803
32804
32805
32806 .section "The Return-path: header line" "SECID229"
32807 .cindex "&'Return-path:'& header line"
32808 .oindex "&%return_path_remove%&"
32809 &'Return-path:'& header lines are defined as something an MTA may insert when
32810 it does the final delivery of messages. (See the generic &%return_path_add%&
32811 transport option.) Therefore, they should not be present in messages in
32812 transit. If the &%return_path_remove%& configuration option is set (the
32813 default), Exim removes &'Return-path:'& header lines from incoming messages.
32814
32815
32816
32817 .section "The Sender: header line" "SECTthesenhea"
32818 .cindex "&'Sender:'& header line"
32819 .cindex "message" "submission"
32820 For a locally-originated message from an untrusted user, Exim may remove an
32821 existing &'Sender:'& header line, and it may add a new one. You can modify
32822 these actions by setting the &%local_sender_retain%& option true, the
32823 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32824 control setting.
32825
32826 When a local message is received from an untrusted user and
32827 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32828 control has not been set, a check is made to see if the address given in the
32829 &'From:'& header line is the correct (local) sender of the message. The address
32830 that is expected has the login name as the local part and the value of
32831 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32832 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32833 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32834 line is added to the message.
32835
32836 If you set &%local_from_check%& false, this checking does not occur. However,
32837 the removal of an existing &'Sender:'& line still happens, unless you also set
32838 &%local_sender_retain%& to be true. It is not possible to set both of these
32839 options true at the same time.
32840
32841 .cindex "submission mode"
32842 By default, no processing of &'Sender:'& header lines is done for messages
32843 received over TCP/IP or for messages submitted by trusted users. However, when
32844 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32845 not specified on the submission control, the following processing takes place:
32846
32847 .vindex "&$authenticated_id$&"
32848 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32849 authenticated, and &$authenticated_id$& is not empty, a sender address is
32850 created as follows:
32851
32852 .ilist
32853 .vindex "&$qualify_domain$&"
32854 If no domain is specified by the submission control, the local part is
32855 &$authenticated_id$& and the domain is &$qualify_domain$&.
32856 .next
32857 If a non-empty domain is specified by the submission control, the local part
32858 is &$authenticated_id$&, and the domain is the specified domain.
32859 .next
32860 If an empty domain is specified by the submission control,
32861 &$authenticated_id$& is assumed to be the complete address.
32862 .endlist
32863
32864 This address is compared with the address in the &'From:'& header line. If they
32865 are different, a &'Sender:'& header line containing the created address is
32866 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32867 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32868
32869 .cindex "return path" "created from &'Sender:'&"
32870 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32871 the message (the envelope sender address) is changed to be the same address,
32872 except in the case of submission mode when &%sender_retain%& is specified.
32873
32874
32875
32876 .section "Adding and removing header lines in routers and transports" &&&
32877          "SECTheadersaddrem"
32878 .cindex "header lines" "adding; in router or transport"
32879 .cindex "header lines" "removing; in router or transport"
32880 When a message is delivered, the addition and removal of header lines can be
32881 specified in a system filter, or on any of the routers and transports that
32882 process the message. Section &<<SECTaddremheasys>>& contains details about
32883 modifying headers in a system filter. Header lines can also be added in an ACL
32884 as a message is received (see section &<<SECTaddheadacl>>&).
32885
32886 In contrast to what happens in a system filter, header modifications that are
32887 specified on routers and transports apply only to the particular recipient
32888 addresses that are being processed by those routers and transports. These
32889 changes do not actually take place until a copy of the message is being
32890 transported. Therefore, they do not affect the basic set of header lines, and
32891 they do not affect the values of the variables that refer to header lines.
32892
32893 &*Note*&: In particular, this means that any expansions in the configuration of
32894 the transport cannot refer to the modified header lines, because such
32895 expansions all occur before the message is actually transported.
32896
32897 For both routers and transports, the argument of a &%headers_add%&
32898 option must be in the form of one or more RFC 2822 header lines, separated by
32899 newlines (coded as &"\n"&). For example:
32900 .code
32901 headers_add = X-added-header: added by $primary_hostname\n\
32902               X-added-second: another added header line
32903 .endd
32904 Exim does not check the syntax of these added header lines.
32905
32906 Multiple &%headers_add%& options for a single router or transport can be
32907 specified; the values will append to a single list of header lines.
32908 Each header-line is separately expanded.
32909
32910 The argument of a &%headers_remove%& option must consist of a colon-separated
32911 list of header names. This is confusing, because header names themselves are
32912 often terminated by colons. In this case, the colons are the list separators,
32913 not part of the names. For example:
32914 .code
32915 headers_remove = return-receipt-to:acknowledge-to
32916 .endd
32917
32918 Multiple &%headers_remove%& options for a single router or transport can be
32919 specified; the arguments will append to a single header-names list.
32920 Each item is separately expanded.
32921 Note that colons in complex expansions which are used to
32922 form all or part of a &%headers_remove%& list
32923 will act as list separators.
32924
32925 When &%headers_add%& or &%headers_remove%& is specified on a router,
32926 items are expanded at routing time,
32927 and then associated with all addresses that are
32928 accepted by that router, and also with any new addresses that it generates. If
32929 an address passes through several routers as a result of aliasing or
32930 forwarding, the changes are cumulative.
32931
32932 .oindex "&%unseen%&"
32933 However, this does not apply to multiple routers that result from the use of
32934 the &%unseen%& option. Any header modifications that were specified by the
32935 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32936
32937 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32938 settings cannot be delivered together in a batch, so a transport is always
32939 dealing with a set of addresses that have the same header-processing
32940 requirements.
32941
32942 The transport starts by writing the original set of header lines that arrived
32943 with the message, possibly modified by the system filter. As it writes out
32944 these lines, it consults the list of header names that were attached to the
32945 recipient address(es) by &%headers_remove%& options in routers, and it also
32946 consults the transport's own &%headers_remove%& option. Header lines whose
32947 names are on either of these lists are not written out. If there are multiple
32948 instances of any listed header, they are all skipped.
32949
32950 After the remaining original header lines have been written, new header
32951 lines that were specified by routers' &%headers_add%& options are written, in
32952 the order in which they were attached to the address. These are followed by any
32953 header lines specified by the transport's &%headers_add%& option.
32954
32955 This way of handling header line modifications in routers and transports has
32956 the following consequences:
32957
32958 .ilist
32959 The original set of header lines, possibly modified by the system filter,
32960 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32961 to it, at all times.
32962 .next
32963 Header lines that are added by a router's
32964 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32965 expansion syntax in subsequent routers or the transport.
32966 .next
32967 Conversely, header lines that are specified for removal by &%headers_remove%&
32968 in a router remain visible to subsequent routers and the transport.
32969 .next
32970 Headers added to an address by &%headers_add%& in a router cannot be removed by
32971 a later router or by a transport.
32972 .next
32973 An added header can refer to the contents of an original header that is to be
32974 removed, even it has the same name as the added header. For example:
32975 .code
32976 headers_remove = subject
32977 headers_add = Subject: new subject (was: $h_subject:)
32978 .endd
32979 .endlist
32980
32981 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32982 for a &(redirect)& router that has the &%one_time%& option set.
32983
32984
32985
32986
32987
32988 .section "Constructed addresses" "SECTconstr"
32989 .cindex "address" "constructed"
32990 .cindex "constructed address"
32991 When Exim constructs a sender address for a locally-generated message, it uses
32992 the form
32993 .display
32994 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32995 .endd
32996 For example:
32997 .code
32998 Zaphod Beeblebrox <zaphod@end.univ.example>
32999 .endd
33000 The user name is obtained from the &%-F%& command line option if set, or
33001 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33002 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33003 ampersand character, this is replaced by the login name with the first letter
33004 upper cased, as is conventional in a number of operating systems. See the
33005 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33006 The &%unknown_username%& option can be used to specify user names in cases when
33007 there is no password file entry.
33008
33009 .cindex "RFC 2047"
33010 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33011 parts of it if necessary. In addition, if it contains any non-printing
33012 characters, it is encoded as described in RFC 2047, which defines a way of
33013 including non-ASCII characters in header lines. The value of the
33014 &%headers_charset%& option specifies the name of the encoding that is used (the
33015 characters are assumed to be in this encoding). The setting of
33016 &%print_topbitchars%& controls whether characters with the top bit set (that
33017 is, with codes greater than 127) count as printing characters or not.
33018
33019
33020
33021 .section "Case of local parts" "SECID230"
33022 .cindex "case of local parts"
33023 .cindex "local part" "case of"
33024 RFC 2822 states that the case of letters in the local parts of addresses cannot
33025 be assumed to be non-significant. Exim preserves the case of local parts of
33026 addresses, but by default it uses a lower-cased form when it is routing,
33027 because on most Unix systems, usernames are in lower case and case-insensitive
33028 routing is required. However, any particular router can be made to use the
33029 original case for local parts by setting the &%caseful_local_part%& generic
33030 router option.
33031
33032 .cindex "mixed-case login names"
33033 If you must have mixed-case user names on your system, the best way to proceed,
33034 assuming you want case-independent handling of incoming email, is to set up
33035 your first router to convert incoming local parts in your domains to the
33036 correct case by means of a file lookup. For example:
33037 .code
33038 correct_case:
33039   driver = redirect
33040   domains = +local_domains
33041   data = ${lookup{$local_part}cdb\
33042               {/etc/usercased.cdb}{$value}fail}\
33043               @$domain
33044 .endd
33045 For this router, the local part is forced to lower case by the default action
33046 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33047 up a new local part in the correct case. If you then set &%caseful_local_part%&
33048 on any subsequent routers which process your domains, they will operate on
33049 local parts with the correct case in a case-sensitive manner.
33050
33051
33052
33053 .section "Dots in local parts" "SECID231"
33054 .cindex "dot" "in local part"
33055 .cindex "local part" "dots in"
33056 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33057 part may not begin or end with a dot, nor have two consecutive dots in the
33058 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33059 empty components for compatibility.
33060
33061
33062
33063 .section "Rewriting addresses" "SECID232"
33064 .cindex "rewriting" "addresses"
33065 Rewriting of sender and recipient addresses, and addresses in headers, can
33066 happen automatically, or as the result of configuration options, as described
33067 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33068 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33069
33070 Automatic rewriting includes qualification, as mentioned above. The other case
33071 in which it can happen is when an incomplete non-local domain is given. The
33072 routing process may cause this to be expanded into the full domain name. For
33073 example, a header such as
33074 .code
33075 To: hare@teaparty
33076 .endd
33077 might get rewritten as
33078 .code
33079 To: hare@teaparty.wonderland.fict.example
33080 .endd
33081 Rewriting as a result of routing is the one kind of message processing that
33082 does not happen at input time, as it cannot be done until the address has
33083 been routed.
33084
33085 Strictly, one should not do &'any'& deliveries of a message until all its
33086 addresses have been routed, in case any of the headers get changed as a
33087 result of routing. However, doing this in practice would hold up many
33088 deliveries for unreasonable amounts of time, just because one address could not
33089 immediately be routed. Exim therefore does not delay other deliveries when
33090 routing of one or more addresses is deferred.
33091 .ecindex IIDmesproc
33092
33093
33094
33095 . ////////////////////////////////////////////////////////////////////////////
33096 . ////////////////////////////////////////////////////////////////////////////
33097
33098 .chapter "SMTP processing" "CHAPSMTP"
33099 .scindex IIDsmtpproc1 "SMTP" "processing details"
33100 .scindex IIDsmtpproc2 "LMTP" "processing details"
33101 Exim supports a number of different ways of using the SMTP protocol, and its
33102 LMTP variant, which is an interactive protocol for transferring messages into a
33103 closed mail store application. This chapter contains details of how SMTP is
33104 processed. For incoming mail, the following are available:
33105
33106 .ilist
33107 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33108 .next
33109 SMTP over the standard input and output (the &%-bs%& option);
33110 .next
33111 Batched SMTP on the standard input (the &%-bS%& option).
33112 .endlist
33113
33114 For mail delivery, the following are available:
33115
33116 .ilist
33117 SMTP over TCP/IP (the &(smtp)& transport);
33118 .next
33119 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33120 &"lmtp"&);
33121 .next
33122 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33123 transport);
33124 .next
33125 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33126 the &%use_bsmtp%& option set).
33127 .endlist
33128
33129 &'Batched SMTP'& is the name for a process in which batches of messages are
33130 stored in or read from files (or pipes), in a format in which SMTP commands are
33131 used to contain the envelope information.
33132
33133
33134
33135 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33136 .cindex "SMTP" "outgoing over TCP/IP"
33137 .cindex "outgoing SMTP over TCP/IP"
33138 .cindex "LMTP" "over TCP/IP"
33139 .cindex "outgoing LMTP over TCP/IP"
33140 .cindex "EHLO"
33141 .cindex "HELO"
33142 .cindex "SIZE option on MAIL command"
33143 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33144 The &%protocol%& option selects which protocol is to be used, but the actual
33145 processing is the same in both cases.
33146
33147 If, in response to its EHLO command, Exim is told that the SIZE
33148 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33149 command. The value of <&'n'&> is the message size plus the value of the
33150 &%size_addition%& option (default 1024) to allow for additions to the message
33151 such as per-transport header lines, or changes made in a
33152 .cindex "transport" "filter"
33153 .cindex "filter" "transport filter"
33154 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33155 suppressed.
33156
33157 If the remote server advertises support for PIPELINING, Exim uses the
33158 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33159 required for the transaction.
33160
33161 If the remote server advertises support for the STARTTLS command, and Exim
33162 was built to support TLS encryption, it tries to start a TLS session unless the
33163 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33164 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33165 is called for verification.
33166
33167 If the remote server advertises support for the AUTH command, Exim scans
33168 the authenticators configuration for any suitable client settings, as described
33169 in chapter &<<CHAPSMTPAUTH>>&.
33170
33171 .cindex "carriage return"
33172 .cindex "linefeed"
33173 Responses from the remote host are supposed to be terminated by CR followed by
33174 LF. However, there are known to be hosts that do not send CR characters, so in
33175 order to be able to interwork with such hosts, Exim treats LF on its own as a
33176 line terminator.
33177
33178 If a message contains a number of different addresses, all those with the same
33179 characteristics (for example, the same envelope sender) that resolve to the
33180 same set of hosts, in the same order, are sent in a single SMTP transaction,
33181 even if they are for different domains, unless there are more than the setting
33182 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33183 they are split into groups containing no more than &%max_rcpt%&s addresses
33184 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33185 in parallel sessions. The order of hosts with identical MX values is not
33186 significant when checking whether addresses can be batched in this way.
33187
33188 When the &(smtp)& transport suffers a temporary failure that is not
33189 message-related, Exim updates its transport-specific database, which contains
33190 records indexed by host name that remember which messages are waiting for each
33191 particular host. It also updates the retry database with new retry times.
33192
33193 .cindex "hints database" "retry keys"
33194 Exim's retry hints are based on host name plus IP address, so if one address of
33195 a multi-homed host is broken, it will soon be skipped most of the time.
33196 See the next section for more detail about error handling.
33197
33198 .cindex "SMTP" "passed connection"
33199 .cindex "SMTP" "batching over TCP/IP"
33200 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33201 looks in the hints database for the transport to see if there are any queued
33202 messages waiting for the host to which it is connected. If it finds one, it
33203 creates a new Exim process using the &%-MC%& option (which can only be used by
33204 a process running as root or the Exim user) and passes the TCP/IP socket to it
33205 so that it can deliver another message using the same socket. The new process
33206 does only those deliveries that are routed to the connected host, and may in
33207 turn pass the socket on to a third process, and so on.
33208
33209 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33210 limit the number of messages sent down a single TCP/IP connection.
33211
33212 .cindex "asterisk" "after IP address"
33213 The second and subsequent messages delivered down an existing connection are
33214 identified in the main log by the addition of an asterisk after the closing
33215 square bracket of the IP address.
33216
33217
33218
33219
33220 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33221 .cindex "error" "in outgoing SMTP"
33222 .cindex "SMTP" "errors in outgoing"
33223 .cindex "host" "error"
33224 Three different kinds of error are recognized for outgoing SMTP: host errors,
33225 message errors, and recipient errors.
33226
33227 .vlist
33228 .vitem "&*Host errors*&"
33229 A host error is not associated with a particular message or with a
33230 particular recipient of a message. The host errors are:
33231
33232 .ilist
33233 Connection refused or timed out,
33234 .next
33235 Any error response code on connection,
33236 .next
33237 Any error response code to EHLO or HELO,
33238 .next
33239 Loss of connection at any time, except after &"."&,
33240 .next
33241 I/O errors at any time,
33242 .next
33243 Timeouts during the session, other than in response to MAIL, RCPT or
33244 the &"."& at the end of the data.
33245 .endlist ilist
33246
33247 For a host error, a permanent error response on connection, or in response to
33248 EHLO, causes all addresses routed to the host to be failed. Any other host
33249 error causes all addresses to be deferred, and retry data to be created for the
33250 host. It is not tried again, for any message, until its retry time arrives. If
33251 the current set of addresses are not all delivered in this run (to some
33252 alternative host), the message is added to the list of those waiting for this
33253 host, so if it is still undelivered when a subsequent successful delivery is
33254 made to the host, it will be sent down the same SMTP connection.
33255
33256 .vitem "&*Message errors*&"
33257 .cindex "message" "error"
33258 A message error is associated with a particular message when sent to a
33259 particular host, but not with a particular recipient of the message. The
33260 message errors are:
33261
33262 .ilist
33263 Any error response code to MAIL, DATA, or the &"."& that terminates
33264 the data,
33265 .next
33266 Timeout after MAIL,
33267 .next
33268 Timeout or loss of connection after the &"."& that terminates the data. A
33269 timeout after the DATA command itself is treated as a host error, as is loss of
33270 connection at any other time.
33271 .endlist ilist
33272
33273 For a message error, a permanent error response (5&'xx'&) causes all addresses
33274 to be failed, and a delivery error report to be returned to the sender. A
33275 temporary error response (4&'xx'&), or one of the timeouts, causes all
33276 addresses to be deferred. Retry data is not created for the host, but instead,
33277 a retry record for the combination of host plus message id is created. The
33278 message is not added to the list of those waiting for this host. This ensures
33279 that the failing message will not be sent to this host again until the retry
33280 time arrives. However, other messages that are routed to the host are not
33281 affected, so if it is some property of the message that is causing the error,
33282 it will not stop the delivery of other mail.
33283
33284 If the remote host specified support for the SIZE parameter in its response
33285 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33286 over-large message will cause a message error because the error arrives as a
33287 response to MAIL.
33288
33289 .vitem "&*Recipient errors*&"
33290 .cindex "recipient" "error"
33291 A recipient error is associated with a particular recipient of a message. The
33292 recipient errors are:
33293
33294 .ilist
33295 Any error response to RCPT,
33296 .next
33297 Timeout after RCPT.
33298 .endlist
33299
33300 For a recipient error, a permanent error response (5&'xx'&) causes the
33301 recipient address to be failed, and a bounce message to be returned to the
33302 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33303 address to be deferred, and routing retry data to be created for it. This is
33304 used to delay processing of the address in subsequent queue runs, until its
33305 routing retry time arrives. This applies to all messages, but because it
33306 operates only in queue runs, one attempt will be made to deliver a new message
33307 to the failing address before the delay starts to operate. This ensures that,
33308 if the failure is really related to the message rather than the recipient
33309 (&"message too big for this recipient"& is a possible example), other messages
33310 have a chance of getting delivered. If a delivery to the address does succeed,
33311 the retry information gets cleared, so all stuck messages get tried again, and
33312 the retry clock is reset.
33313
33314 The message is not added to the list of those waiting for this host. Use of the
33315 host for other messages is unaffected, and except in the case of a timeout,
33316 other recipients are processed independently, and may be successfully delivered
33317 in the current SMTP session. After a timeout it is of course impossible to
33318 proceed with the session, so all addresses get deferred. However, those other
33319 than the one that failed do not suffer any subsequent retry delays. Therefore,
33320 if one recipient is causing trouble, the others have a chance of getting
33321 through when a subsequent delivery attempt occurs before the failing
33322 recipient's retry time.
33323 .endlist
33324
33325 In all cases, if there are other hosts (or IP addresses) available for the
33326 current set of addresses (for example, from multiple MX records), they are
33327 tried in this run for any undelivered addresses, subject of course to their
33328 own retry data. In other words, recipient error retry data does not take effect
33329 until the next delivery attempt.
33330
33331 Some hosts have been observed to give temporary error responses to every
33332 MAIL command at certain times (&"insufficient space"& has been seen). It
33333 would be nice if such circumstances could be recognized, and defer data for the
33334 host itself created, but this is not possible within the current Exim design.
33335 What actually happens is that retry data for every (host, message) combination
33336 is created.
33337
33338 The reason that timeouts after MAIL and RCPT are treated specially is that
33339 these can sometimes arise as a result of the remote host's verification
33340 procedures. Exim makes this assumption, and treats them as if a temporary error
33341 response had been received. A timeout after &"."& is treated specially because
33342 it is known that some broken implementations fail to recognize the end of the
33343 message if the last character of the last line is a binary zero. Thus, it is
33344 helpful to treat this case as a message error.
33345
33346 Timeouts at other times are treated as host errors, assuming a problem with the
33347 host, or the connection to it. If a timeout after MAIL, RCPT,
33348 or &"."& is really a connection problem, the assumption is that at the next try
33349 the timeout is likely to occur at some other point in the dialogue, causing it
33350 then to be treated as a host error.
33351
33352 There is experimental evidence that some MTAs drop the connection after the
33353 terminating &"."& if they do not like the contents of the message for some
33354 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33355 should be given. That is why Exim treats this case as a message rather than a
33356 host error, in order not to delay other messages to the same host.
33357
33358
33359
33360
33361 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33362 .cindex "SMTP" "incoming over TCP/IP"
33363 .cindex "incoming SMTP over TCP/IP"
33364 .cindex "inetd"
33365 .cindex "daemon"
33366 Incoming SMTP messages can be accepted in one of two ways: by running a
33367 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33368 &_/etc/inetd.conf_& should be like this:
33369 .code
33370 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33371 .endd
33372 Exim distinguishes between this case and the case of a locally running user
33373 agent using the &%-bs%& option by checking whether or not the standard input is
33374 a socket. When it is, either the port must be privileged (less than 1024), or
33375 the caller must be root or the Exim user. If any other user passes a socket
33376 with an unprivileged port number, Exim prints a message on the standard error
33377 stream and exits with an error code.
33378
33379 By default, Exim does not make a log entry when a remote host connects or
33380 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33381 unexpected. It can be made to write such log entries by setting the
33382 &%smtp_connection%& log selector.
33383
33384 .cindex "carriage return"
33385 .cindex "linefeed"
33386 Commands from the remote host are supposed to be terminated by CR followed by
33387 LF. However, there are known to be hosts that do not send CR characters. In
33388 order to be able to interwork with such hosts, Exim treats LF on its own as a
33389 line terminator.
33390 Furthermore, because common code is used for receiving messages from all
33391 sources, a CR on its own is also interpreted as a line terminator. However, the
33392 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33393
33394 .cindex "EHLO" "invalid data"
33395 .cindex "HELO" "invalid data"
33396 One area that sometimes gives rise to problems concerns the EHLO or
33397 HELO commands. Some clients send syntactically invalid versions of these
33398 commands, which Exim rejects by default. (This is nothing to do with verifying
33399 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33400 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33401 match the broken hosts that send invalid commands.
33402
33403 .cindex "SIZE option on MAIL command"
33404 .cindex "MAIL" "SIZE option"
33405 The amount of disk space available is checked whenever SIZE is received on
33406 a MAIL command, independently of whether &%message_size_limit%& or
33407 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33408 false. A temporary error is given if there is not enough space. If
33409 &%check_spool_space%& is set, the check is for that amount of space plus the
33410 value given with SIZE, that is, it checks that the addition of the incoming
33411 message will not reduce the space below the threshold.
33412
33413 When a message is successfully received, Exim includes the local message id in
33414 its response to the final &"."& that terminates the data. If the remote host
33415 logs this text it can help with tracing what has happened to a message.
33416
33417 The Exim daemon can limit the number of simultaneous incoming connections it is
33418 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33419 number of simultaneous incoming connections from a single remote host (see the
33420 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33421 rejected using the SMTP temporary error code 421.
33422
33423 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33424 subprocess has finished, as this can get lost at busy times. Instead, it looks
33425 for completed subprocesses every time it wakes up. Provided there are other
33426 things happening (new incoming calls, starts of queue runs), completed
33427 processes will be noticed and tidied away. On very quiet systems you may
33428 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33429 it will be noticed when the daemon next wakes up.
33430
33431 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33432 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33433 high system load &-- for details see the &%smtp_accept_reserve%&,
33434 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33435 applies in both the daemon and &'inetd'& cases.
33436
33437 Exim normally starts a delivery process for each message received, though this
33438 can be varied by means of the &%-odq%& command line option and the
33439 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33440 number of simultaneously running delivery processes started in this way from
33441 SMTP input can be limited by the &%smtp_accept_queue%& and
33442 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33443 subsequently received messages are just put on the input queue without starting
33444 a delivery process.
33445
33446 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33447 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33448 started up from the &'inetd'& daemon, because in that case each connection is
33449 handled by an entirely independent Exim process. Control by load average is,
33450 however, available with &'inetd'&.
33451
33452 Exim can be configured to verify addresses in incoming SMTP commands as they
33453 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33454 to rewrite addresses at this time &-- before any syntax checking is done. See
33455 section &<<SECTrewriteS>>&.
33456
33457 Exim can also be configured to limit the rate at which a client host submits
33458 MAIL and RCPT commands in a single SMTP session. See the
33459 &%smtp_ratelimit_hosts%& option.
33460
33461
33462
33463 .section "Unrecognized SMTP commands" "SECID234"
33464 .cindex "SMTP" "unrecognized commands"
33465 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33466 commands during a single SMTP connection, it drops the connection after sending
33467 the error response to the last command. The default value for
33468 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33469 abuse that subvert web servers into making connections to SMTP ports; in these
33470 circumstances, a number of non-SMTP lines are sent first.
33471
33472
33473 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33474 .cindex "SMTP" "syntax errors"
33475 .cindex "SMTP" "protocol errors"
33476 A syntax error is detected if an SMTP command is recognized, but there is
33477 something syntactically wrong with its data, for example, a malformed email
33478 address in a RCPT command. Protocol errors include invalid command
33479 sequencing such as RCPT before MAIL. If Exim receives more than
33480 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33481 drops the connection after sending the error response to the last command. The
33482 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33483 broken clients that loop sending bad commands (yes, it has been seen).
33484
33485
33486
33487 .section "Use of non-mail SMTP commands" "SECID236"
33488 .cindex "SMTP" "non-mail commands"
33489 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33490 DATA. Exim counts such commands, and drops the connection if there are too
33491 many of them in a single SMTP session. This action catches some
33492 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33493 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33494 defines what &"too many"& means. Its default value is 10.
33495
33496 When a new message is expected, one occurrence of RSET is not counted. This
33497 allows a client to send one RSET between messages (this is not necessary,
33498 but some clients do it). Exim also allows one uncounted occurrence of HELO
33499 or EHLO, and one occurrence of STARTTLS between messages. After
33500 starting up a TLS session, another EHLO is expected, and so it too is not
33501 counted.
33502
33503 The first occurrence of AUTH in a connection, or immediately following
33504 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33505 RCPT, DATA, and QUIT are counted.
33506
33507 You can control which hosts are subject to the limit set by
33508 &%smtp_accept_max_nonmail%& by setting
33509 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33510 the limit apply to all hosts. This option means that you can exclude any
33511 specific badly-behaved hosts that you have to live with.
33512
33513
33514
33515
33516 .section "The VRFY and EXPN commands" "SECID237"
33517 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33518 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33519 appropriate) in order to decide whether the command should be accepted or not.
33520 If no ACL is defined, the command is rejected.
33521
33522 .cindex "VRFY" "processing"
33523 When VRFY is accepted, it runs exactly the same code as when Exim is
33524 called with the &%-bv%& option.
33525
33526 .cindex "EXPN" "processing"
33527 When EXPN is accepted, a single-level expansion of the address is done.
33528 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33529 than a verification (the &%-bv%& option). If an unqualified local part is given
33530 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33531 of VRFY and EXPN commands are logged on the main and reject logs, and
33532 VRFY verification failures are logged on the main log for consistency with
33533 RCPT failures.
33534
33535
33536
33537 .section "The ETRN command" "SECTETRN"
33538 .cindex "ETRN" "processing"
33539 RFC 1985 describes an SMTP command called ETRN that is designed to
33540 overcome the security problems of the TURN command (which has fallen into
33541 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33542 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33543 should be accepted or not. If no ACL is defined, the command is rejected.
33544
33545 The ETRN command is concerned with &"releasing"& messages that are awaiting
33546 delivery to certain hosts. As Exim does not organize its message queue by host,
33547 the only form of ETRN that is supported by default is the one where the
33548 text starts with the &"#"& prefix, in which case the remainder of the text is
33549 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33550 the &%-R%& option to happen, with the remainder of the ETRN text as its
33551 argument. For example,
33552 .code
33553 ETRN #brigadoon
33554 .endd
33555 runs the command
33556 .code
33557 exim -R brigadoon
33558 .endd
33559 which causes a delivery attempt on all messages with undelivered addresses
33560 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33561 default), Exim prevents the simultaneous execution of more than one queue run
33562 for the same argument string as a result of an ETRN command. This stops
33563 a misbehaving client from starting more than one queue runner at once.
33564
33565 .cindex "hints database" "ETRN serialization"
33566 Exim implements the serialization by means of a hints database in which a
33567 record is written whenever a process is started by ETRN, and deleted when
33568 the process completes. However, Exim does not keep the SMTP session waiting for
33569 the ETRN process to complete. Once ETRN is accepted, the client is sent
33570 a &"success"& return code. Obviously there is scope for hints records to get
33571 left lying around if there is a system or program crash. To guard against this,
33572 Exim ignores any records that are more than six hours old.
33573
33574 .oindex "&%smtp_etrn_command%&"
33575 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33576 used. This specifies a command that is run whenever ETRN is received,
33577 whatever the form of its argument. For
33578 example:
33579 .code
33580 smtp_etrn_command = /etc/etrn_command $domain \
33581                     $sender_host_address
33582 .endd
33583 .vindex "&$domain$&"
33584 The string is split up into arguments which are independently expanded. The
33585 expansion variable &$domain$& is set to the argument of the ETRN command,
33586 and no syntax checking is done on the contents of this argument. Exim does not
33587 wait for the command to complete, so its status code is not checked. Exim runs
33588 under its own uid and gid when receiving incoming SMTP, so it is not possible
33589 for it to change them before running the command.
33590
33591
33592
33593 .section "Incoming local SMTP" "SECID238"
33594 .cindex "SMTP" "local incoming"
33595 Some user agents use SMTP to pass messages to their local MTA using the
33596 standard input and output, as opposed to passing the envelope on the command
33597 line and writing the message to the standard input. This is supported by the
33598 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33599 messages over TCP/IP (including the use of ACLs), except that the envelope
33600 sender given in a MAIL command is ignored unless the caller is trusted. In
33601 an ACL you can detect this form of SMTP input by testing for an empty host
33602 identification. It is common to have this as the first line in the ACL that
33603 runs for RCPT commands:
33604 .code
33605 accept hosts = :
33606 .endd
33607 This accepts SMTP messages from local processes without doing any other tests.
33608
33609
33610
33611 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33612 .cindex "SMTP" "batched outgoing"
33613 .cindex "batched SMTP output"
33614 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33615 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33616 be output in BSMTP format. No SMTP responses are possible for this form of
33617 delivery. All it is doing is using SMTP commands as a way of transmitting the
33618 envelope along with the message.
33619
33620 The message is written to the file or pipe preceded by the SMTP commands
33621 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33622 the message that start with a dot have an extra dot added. The SMTP command
33623 HELO is not normally used. If it is required, the &%message_prefix%& option
33624 can be used to specify it.
33625
33626 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33627 one recipient address at a time by default. However, you can arrange for them
33628 to handle several addresses at once by setting the &%batch_max%& option. When
33629 this is done for BSMTP, messages may contain multiple RCPT commands. See
33630 chapter &<<CHAPbatching>>& for more details.
33631
33632 .vindex "&$host$&"
33633 When one or more addresses are routed to a BSMTP transport by a router that
33634 sets up a host list, the name of the first host on the list is available to the
33635 transport in the variable &$host$&. Here is an example of such a transport and
33636 router:
33637 .code
33638 begin routers
33639 route_append:
33640   driver = manualroute
33641   transport = smtp_appendfile
33642   route_list = domain.example  batch.host.example
33643
33644 begin transports
33645 smtp_appendfile:
33646   driver = appendfile
33647   directory = /var/bsmtp/$host
33648   batch_max = 1000
33649   use_bsmtp
33650   user = exim
33651 .endd
33652 This causes messages addressed to &'domain.example'& to be written in BSMTP
33653 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33654 message (unless there are more than 1000 recipients).
33655
33656
33657
33658 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33659 .cindex "SMTP" "batched incoming"
33660 .cindex "batched SMTP input"
33661 The &%-bS%& command line option causes Exim to accept one or more messages by
33662 reading SMTP on the standard input, but to generate no responses. If the caller
33663 is trusted, the senders in the MAIL commands are believed; otherwise the
33664 sender is always the caller of Exim. Unqualified senders and receivers are not
33665 rejected (there seems little point) but instead just get qualified. HELO
33666 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33667 as NOOP; QUIT quits.
33668
33669 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33670 ACL is run in the same way as for non-SMTP local input.
33671
33672 If an error is detected while reading a message, including a missing &"."& at
33673 the end, Exim gives up immediately. It writes details of the error to the
33674 standard output in a stylized way that the calling program should be able to
33675 make some use of automatically, for example:
33676 .code
33677 554 Unexpected end of file
33678 Transaction started in line 10
33679 Error detected in line 14
33680 .endd
33681 It writes a more verbose version, for human consumption, to the standard error
33682 file, for example:
33683 .code
33684 An error was detected while processing a file of BSMTP input.
33685 The error message was:
33686
33687 501 '>' missing at end of address
33688
33689 The SMTP transaction started in line 10.
33690 The error was detected in line 12.
33691 The SMTP command at fault was:
33692
33693 rcpt to:<malformed@in.com.plete
33694
33695 1 previous message was successfully processed.
33696 The rest of the batch was abandoned.
33697 .endd
33698 The return code from Exim is zero only if there were no errors. It is 1 if some
33699 messages were accepted before an error was detected, and 2 if no messages were
33700 accepted.
33701 .ecindex IIDsmtpproc1
33702 .ecindex IIDsmtpproc2
33703
33704
33705
33706 . ////////////////////////////////////////////////////////////////////////////
33707 . ////////////////////////////////////////////////////////////////////////////
33708
33709 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33710          "Customizing messages"
33711 When a message fails to be delivered, or remains on the queue for more than a
33712 configured amount of time, Exim sends a message to the original sender, or
33713 to an alternative configured address. The text of these messages is built into
33714 the code of Exim, but it is possible to change it, either by adding a single
33715 string, or by replacing each of the paragraphs by text supplied in a file.
33716
33717 The &'From:'& and &'To:'& header lines are automatically generated; you can
33718 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33719 option. Exim also adds the line
33720 .code
33721 Auto-Submitted: auto-generated
33722 .endd
33723 to all warning and bounce messages,
33724
33725
33726 .section "Customizing bounce messages" "SECID239"
33727 .cindex "customizing" "bounce message"
33728 .cindex "bounce message" "customizing"
33729 If &%bounce_message_text%& is set, its contents are included in the default
33730 message immediately after &"This message was created automatically by mail
33731 delivery software."& The string is not expanded. It is not used if
33732 &%bounce_message_file%& is set.
33733
33734 When &%bounce_message_file%& is set, it must point to a template file for
33735 constructing error messages. The file consists of a series of text items,
33736 separated by lines consisting of exactly four asterisks. If the file cannot be
33737 opened, default text is used and a message is written to the main and panic
33738 logs. If any text item in the file is empty, default text is used for that
33739 item.
33740
33741 .vindex "&$bounce_recipient$&"
33742 .vindex "&$bounce_return_size_limit$&"
33743 Each item of text that is read from the file is expanded, and there are two
33744 expansion variables which can be of use here: &$bounce_recipient$& is set to
33745 the recipient of an error message while it is being created, and
33746 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33747 option, rounded to a whole number.
33748
33749 The items must appear in the file in the following order:
33750
33751 .ilist
33752 The first item is included in the headers, and should include at least a
33753 &'Subject:'& header. Exim does not check the syntax of these headers.
33754 .next
33755 The second item forms the start of the error message. After it, Exim lists the
33756 failing addresses with their error messages.
33757 .next
33758 The third item is used to introduce any text from pipe transports that is to be
33759 returned to the sender. It is omitted if there is no such text.
33760 .next
33761 .new
33762 The fourth, fifth and sixth items will be ignored and may be empty.
33763 The fields exist for back-compatibility
33764 .wen
33765 .endlist
33766
33767 The default state (&%bounce_message_file%& unset) is equivalent to the
33768 following file, in which the sixth item is empty. The &'Subject:'& and some
33769 other lines have been split in order to fit them on the page:
33770 .code
33771 Subject: Mail delivery failed
33772   ${if eq{$sender_address}{$bounce_recipient}
33773   {: returning message to sender}}
33774 ****
33775 This message was created automatically by mail delivery software.
33776
33777 A message ${if eq{$sender_address}{$bounce_recipient}
33778   {that you sent }{sent by
33779
33780 <$sender_address>
33781
33782 }}could not be delivered to all of its recipients.
33783 This is a permanent error. The following address(es) failed:
33784 ****
33785 The following text was generated during the delivery attempt(s):
33786 ****
33787 ------ This is a copy of the message, including all the headers.
33788   ------
33789 ****
33790 ------ The body of the message is $message_size characters long;
33791   only the first
33792 ------ $bounce_return_size_limit or so are included here.
33793 ****
33794 .endd
33795 .section "Customizing warning messages" "SECTcustwarn"
33796 .cindex "customizing" "warning message"
33797 .cindex "warning of delay" "customizing the message"
33798 The option &%warn_message_file%& can be pointed at a template file for use when
33799 warnings about message delays are created. In this case there are only three
33800 text sections:
33801
33802 .ilist
33803 The first item is included in the headers, and should include at least a
33804 &'Subject:'& header. Exim does not check the syntax of these headers.
33805 .next
33806 The second item forms the start of the warning message. After it, Exim lists
33807 the delayed addresses.
33808 .next
33809 The third item then ends the message.
33810 .endlist
33811
33812 The default state is equivalent to the following file, except that some lines
33813 have been split here, in order to fit them on the page:
33814 .code
33815 Subject: Warning: message $message_exim_id delayed
33816   $warn_message_delay
33817 ****
33818 This message was created automatically by mail delivery software.
33819
33820 A message ${if eq{$sender_address}{$warn_message_recipients}
33821 {that you sent }{sent by
33822
33823 <$sender_address>
33824
33825 }}has not been delivered to all of its recipients after
33826 more than $warn_message_delay on the queue on $primary_hostname.
33827
33828 The message identifier is:     $message_exim_id
33829 The subject of the message is: $h_subject
33830 The date of the message is:    $h_date
33831
33832 The following address(es) have not yet been delivered:
33833 ****
33834 No action is required on your part. Delivery attempts will
33835 continue for some time, and this warning may be repeated at
33836 intervals if the message remains undelivered. Eventually the
33837 mail delivery software will give up, and when that happens,
33838 the message will be returned to you.
33839 .endd
33840 .vindex "&$warn_message_delay$&"
33841 .vindex "&$warn_message_recipients$&"
33842 However, in the default state the subject and date lines are omitted if no
33843 appropriate headers exist. During the expansion of this file,
33844 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33845 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33846 of recipients for the warning message. There may be more than one if there are
33847 multiple addresses with different &%errors_to%& settings on the routers that
33848 handled them.
33849
33850
33851
33852
33853 . ////////////////////////////////////////////////////////////////////////////
33854 . ////////////////////////////////////////////////////////////////////////////
33855
33856 .chapter "Some common configuration settings" "CHAPcomconreq"
33857 This chapter discusses some configuration settings that seem to be fairly
33858 common. More examples and discussion can be found in the Exim book.
33859
33860
33861
33862 .section "Sending mail to a smart host" "SECID240"
33863 .cindex "smart host" "example router"
33864 If you want to send all mail for non-local domains to a &"smart host"&, you
33865 should replace the default &(dnslookup)& router with a router which does the
33866 routing explicitly:
33867 .code
33868 send_to_smart_host:
33869   driver = manualroute
33870   route_list = !+local_domains smart.host.name
33871   transport = remote_smtp
33872 .endd
33873 You can use the smart host's IP address instead of the name if you wish.
33874 If you are using Exim only to submit messages to a smart host, and not for
33875 receiving incoming messages, you can arrange for it to do the submission
33876 synchronously by setting the &%mua_wrapper%& option (see chapter
33877 &<<CHAPnonqueueing>>&).
33878
33879
33880
33881
33882 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33883 .cindex "mailing lists"
33884 Exim can be used to run simple mailing lists, but for large and/or complicated
33885 requirements, the use of additional specialized mailing list software such as
33886 Majordomo or Mailman is recommended.
33887
33888 The &(redirect)& router can be used to handle mailing lists where each list
33889 is maintained in a separate file, which can therefore be managed by an
33890 independent manager. The &%domains%& router option can be used to run these
33891 lists in a separate domain from normal mail. For example:
33892 .code
33893 lists:
33894   driver = redirect
33895   domains = lists.example
33896   file = /usr/lists/$local_part
33897   forbid_pipe
33898   forbid_file
33899   errors_to = $local_part-request@lists.example
33900   no_more
33901 .endd
33902 This router is skipped for domains other than &'lists.example'&. For addresses
33903 in that domain, it looks for a file that matches the local part. If there is no
33904 such file, the router declines, but because &%no_more%& is set, no subsequent
33905 routers are tried, and so the whole delivery fails.
33906
33907 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33908 expanded into a file name or a pipe delivery, which is usually inappropriate in
33909 a mailing list.
33910
33911 .oindex "&%errors_to%&"
33912 The &%errors_to%& option specifies that any delivery errors caused by addresses
33913 taken from a mailing list are to be sent to the given address rather than the
33914 original sender of the message. However, before acting on this, Exim verifies
33915 the error address, and ignores it if verification fails.
33916
33917 For example, using the configuration above, mail sent to
33918 &'dicts@lists.example'& is passed on to those addresses contained in
33919 &_/usr/lists/dicts_&, with error reports directed to
33920 &'dicts-request@lists.example'&, provided that this address can be verified.
33921 There could be a file called &_/usr/lists/dicts-request_& containing
33922 the address(es) of this particular list's manager(s), but other approaches,
33923 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33924 or &%local_part_suffix%& options) to handle addresses of the form
33925 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33926
33927
33928
33929 .section "Syntax errors in mailing lists" "SECID241"
33930 .cindex "mailing lists" "syntax errors in"
33931 If an entry in redirection data contains a syntax error, Exim normally defers
33932 delivery of the original address. That means that a syntax error in a mailing
33933 list holds up all deliveries to the list. This may not be appropriate when a
33934 list is being maintained automatically from data supplied by users, and the
33935 addresses are not rigorously checked.
33936
33937 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33938 entries that fail to parse, noting the incident in the log. If in addition
33939 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33940 whenever a broken address is skipped. It is usually appropriate to set
33941 &%syntax_errors_to%& to the same address as &%errors_to%&.
33942
33943
33944
33945 .section "Re-expansion of mailing lists" "SECID242"
33946 .cindex "mailing lists" "re-expansion of"
33947 Exim remembers every individual address to which a message has been delivered,
33948 in order to avoid duplication, but it normally stores only the original
33949 recipient addresses with a message. If all the deliveries to a mailing list
33950 cannot be done at the first attempt, the mailing list is re-expanded when the
33951 delivery is next tried. This means that alterations to the list are taken into
33952 account at each delivery attempt, so addresses that have been added to
33953 the list since the message arrived will therefore receive a copy of the
33954 message, even though it pre-dates their subscription.
33955
33956 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33957 on the &(redirect)& router. If this is done, any addresses generated by the
33958 router that fail to deliver at the first attempt are added to the message as
33959 &"top level"& addresses, and the parent address that generated them is marked
33960 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33961 subsequent delivery attempts. The disadvantage of this is that if any of the
33962 failing addresses are incorrect, correcting them in the file has no effect on
33963 pre-existing messages.
33964
33965 The original top-level address is remembered with each of the generated
33966 addresses, and is output in any log messages. However, any intermediate parent
33967 addresses are not recorded. This makes a difference to the log only if the
33968 &%all_parents%& selector is set, but for mailing lists there is normally only
33969 one level of expansion anyway.
33970
33971
33972
33973 .section "Closed mailing lists" "SECID243"
33974 .cindex "mailing lists" "closed"
33975 The examples so far have assumed open mailing lists, to which anybody may
33976 send mail. It is also possible to set up closed lists, where mail is accepted
33977 from specified senders only. This is done by making use of the generic
33978 &%senders%& option to restrict the router that handles the list.
33979
33980 The following example uses the same file as a list of recipients and as a list
33981 of permitted senders. It requires three routers:
33982 .code
33983 lists_request:
33984   driver = redirect
33985   domains = lists.example
33986   local_part_suffix = -request
33987   file = /usr/lists/$local_part$local_part_suffix
33988   no_more
33989
33990 lists_post:
33991   driver = redirect
33992   domains = lists.example
33993   senders = ${if exists {/usr/lists/$local_part}\
33994              {lsearch;/usr/lists/$local_part}{*}}
33995   file = /usr/lists/$local_part
33996   forbid_pipe
33997   forbid_file
33998   errors_to = $local_part-request@lists.example
33999   no_more
34000
34001 lists_closed:
34002   driver = redirect
34003   domains = lists.example
34004   allow_fail
34005   data = :fail: $local_part@lists.example is a closed mailing list
34006 .endd
34007 All three routers have the same &%domains%& setting, so for any other domains,
34008 they are all skipped. The first router runs only if the local part ends in
34009 &%-request%&. It handles messages to the list manager(s) by means of an open
34010 mailing list.
34011
34012 The second router runs only if the &%senders%& precondition is satisfied. It
34013 checks for the existence of a list that corresponds to the local part, and then
34014 checks that the sender is on the list by means of a linear search. It is
34015 necessary to check for the existence of the file before trying to search it,
34016 because otherwise Exim thinks there is a configuration error. If the file does
34017 not exist, the expansion of &%senders%& is *, which matches all senders. This
34018 means that the router runs, but because there is no list, declines, and
34019 &%no_more%& ensures that no further routers are run. The address fails with an
34020 &"unrouteable address"& error.
34021
34022 The third router runs only if the second router is skipped, which happens when
34023 a mailing list exists, but the sender is not on it. This router forcibly fails
34024 the address, giving a suitable error message.
34025
34026
34027
34028
34029 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34030 .cindex "VERP"
34031 .cindex "Variable Envelope Return Paths"
34032 .cindex "envelope sender"
34033 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34034 are a way of helping mailing list administrators discover which subscription
34035 address is the cause of a particular delivery failure. The idea is to encode
34036 the original recipient address in the outgoing envelope sender address, so that
34037 if the message is forwarded by another host and then subsequently bounces, the
34038 original recipient can be extracted from the recipient address of the bounce.
34039
34040 .oindex &%errors_to%&
34041 .oindex &%return_path%&
34042 Envelope sender addresses can be modified by Exim using two different
34043 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34044 list examples), or the &%return_path%& option on a transport. The second of
34045 these is effective only if the message is successfully delivered to another
34046 host; it is not used for errors detected on the local host (see the description
34047 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34048 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34049 .code
34050 verp_smtp:
34051   driver = smtp
34052   max_rcpt = 1
34053   return_path = \
34054     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34055       {$1-request+$local_part=$domain@your.dom.example}fail}
34056 .endd
34057 This has the effect of rewriting the return path (envelope sender) on outgoing
34058 SMTP messages, if the local part of the original return path ends in
34059 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34060 local part and domain of the recipient into the return path. Suppose, for
34061 example, that a message whose return path has been set to
34062 &'somelist-request@your.dom.example'& is sent to
34063 &'subscriber@other.dom.example'&. In the transport, the return path is
34064 rewritten as
34065 .code
34066 somelist-request+subscriber=other.dom.example@your.dom.example
34067 .endd
34068 .vindex "&$local_part$&"
34069 For this to work, you must tell Exim to send multiple copies of messages that
34070 have more than one recipient, so that each copy has just one recipient. This is
34071 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34072 might be sent to several different recipients in the same domain, in which case
34073 &$local_part$& is not available in the transport, because it is not unique.
34074
34075 Unless your host is doing nothing but mailing list deliveries, you should
34076 probably use a separate transport for the VERP deliveries, so as not to use
34077 extra resources in making one-per-recipient copies for other deliveries. This
34078 can easily be done by expanding the &%transport%& option in the router:
34079 .code
34080 dnslookup:
34081   driver = dnslookup
34082   domains = ! +local_domains
34083   transport = \
34084     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34085       {verp_smtp}{remote_smtp}}
34086   no_more
34087 .endd
34088 If you want to change the return path using &%errors_to%& in a router instead
34089 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34090 routers that handle mailing list addresses. This will ensure that all delivery
34091 errors, including those detected on the local host, are sent to the VERP
34092 address.
34093
34094 On a host that does no local deliveries and has no manual routing, only the
34095 &(dnslookup)& router needs to be changed. A special transport is not needed for
34096 SMTP deliveries. Every mailing list recipient has its own return path value,
34097 and so Exim must hand them to the transport one at a time. Here is an example
34098 of a &(dnslookup)& router that implements VERP:
34099 .code
34100 verp_dnslookup:
34101   driver = dnslookup
34102   domains = ! +local_domains
34103   transport = remote_smtp
34104   errors_to = \
34105     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34106      {$1-request+$local_part=$domain@your.dom.example}fail}
34107   no_more
34108 .endd
34109 Before you start sending out messages with VERPed return paths, you must also
34110 configure Exim to accept the bounce messages that come back to those paths.
34111 Typically this is done by setting a &%local_part_suffix%& option for a
34112 router, and using this to route the messages to wherever you want to handle
34113 them.
34114
34115 The overhead incurred in using VERP depends very much on the size of the
34116 message, the number of recipient addresses that resolve to the same remote
34117 host, and the speed of the connection over which the message is being sent. If
34118 a lot of addresses resolve to the same host and the connection is slow, sending
34119 a separate copy of the message for each address may take substantially longer
34120 than sending a single copy with many recipients (for which VERP cannot be
34121 used).
34122
34123
34124
34125
34126
34127
34128 .section "Virtual domains" "SECTvirtualdomains"
34129 .cindex "virtual domains"
34130 .cindex "domain" "virtual"
34131 The phrase &'virtual domain'& is unfortunately used with two rather different
34132 meanings:
34133
34134 .ilist
34135 A domain for which there are no real mailboxes; all valid local parts are
34136 aliases for other email addresses. Common examples are organizational
34137 top-level domains and &"vanity"& domains.
34138 .next
34139 One of a number of independent domains that are all handled by the same host,
34140 with mailboxes on that host, but where the mailbox owners do not necessarily
34141 have login accounts on that host.
34142 .endlist
34143
34144 The first usage is probably more common, and does seem more &"virtual"& than
34145 the second. This kind of domain can be handled in Exim with a straightforward
34146 aliasing router. One approach is to create a separate alias file for each
34147 virtual domain. Exim can test for the existence of the alias file to determine
34148 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34149 to a router of this form:
34150 .code
34151 virtual:
34152   driver = redirect
34153   domains = dsearch;/etc/mail/virtual
34154   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34155   no_more
34156 .endd
34157 The &%domains%& option specifies that the router is to be skipped, unless there
34158 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34159 domain that is being processed. When the router runs, it looks up the local
34160 part in the file to find a new address (or list of addresses). The &%no_more%&
34161 setting ensures that if the lookup fails (leading to &%data%& being an empty
34162 string), Exim gives up on the address without trying any subsequent routers.
34163
34164 This one router can handle all the virtual domains because the alias file names
34165 follow a fixed pattern. Permissions can be arranged so that appropriate people
34166 can edit the different alias files. A successful aliasing operation results in
34167 a new envelope recipient address, which is then routed from scratch.
34168
34169 The other kind of &"virtual"& domain can also be handled in a straightforward
34170 way. One approach is to create a file for each domain containing a list of
34171 valid local parts, and use it in a router like this:
34172 .code
34173 my_domains:
34174   driver = accept
34175   domains = dsearch;/etc/mail/domains
34176   local_parts = lsearch;/etc/mail/domains/$domain
34177   transport = my_mailboxes
34178 .endd
34179 The address is accepted if there is a file for the domain, and the local part
34180 can be found in the file. The &%domains%& option is used to check for the
34181 file's existence because &%domains%& is tested before the &%local_parts%&
34182 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34183 because that option is tested after &%local_parts%&. The transport is as
34184 follows:
34185 .code
34186 my_mailboxes:
34187   driver = appendfile
34188   file = /var/mail/$domain/$local_part
34189   user = mail
34190 .endd
34191 This uses a directory of mailboxes for each domain. The &%user%& setting is
34192 required, to specify which uid is to be used for writing to the mailboxes.
34193
34194 The configuration shown here is just one example of how you might support this
34195 requirement. There are many other ways this kind of configuration can be set
34196 up, for example, by using a database instead of separate files to hold all the
34197 information about the domains.
34198
34199
34200
34201 .section "Multiple user mailboxes" "SECTmulbox"
34202 .cindex "multiple mailboxes"
34203 .cindex "mailbox" "multiple"
34204 .cindex "local part" "prefix"
34205 .cindex "local part" "suffix"
34206 Heavy email users often want to operate with multiple mailboxes, into which
34207 incoming mail is automatically sorted. A popular way of handling this is to
34208 allow users to use multiple sender addresses, so that replies can easily be
34209 identified. Users are permitted to add prefixes or suffixes to their local
34210 parts for this purpose. The wildcard facility of the generic router options
34211 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34212 example, consider this router:
34213 .code
34214 userforward:
34215   driver = redirect
34216   check_local_user
34217   file = $home/.forward
34218   local_part_suffix = -*
34219   local_part_suffix_optional
34220   allow_filter
34221 .endd
34222 .vindex "&$local_part_suffix$&"
34223 It runs a user's &_.forward_& file for all local parts of the form
34224 &'username-*'&. Within the filter file the user can distinguish different
34225 cases by testing the variable &$local_part_suffix$&. For example:
34226 .code
34227 if $local_part_suffix contains -special then
34228 save /home/$local_part/Mail/special
34229 endif
34230 .endd
34231 If the filter file does not exist, or does not deal with such addresses, they
34232 fall through to subsequent routers, and, assuming no subsequent use of the
34233 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34234 control over which suffixes are valid.
34235
34236 Alternatively, a suffix can be used to trigger the use of a different
34237 &_.forward_& file &-- which is the way a similar facility is implemented in
34238 another MTA:
34239 .code
34240 userforward:
34241   driver = redirect
34242   check_local_user
34243   file = $home/.forward$local_part_suffix
34244   local_part_suffix = -*
34245   local_part_suffix_optional
34246   allow_filter
34247 .endd
34248 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34249 example, &_.forward-special_& is used. Once again, if the appropriate file
34250 does not exist, or does not deal with the address, it is passed on to
34251 subsequent routers, which could, if required, look for an unqualified
34252 &_.forward_& file to use as a default.
34253
34254
34255
34256 .section "Simplified vacation processing" "SECID244"
34257 .cindex "vacation processing"
34258 The traditional way of running the &'vacation'& program is for a user to set up
34259 a pipe command in a &_.forward_& file
34260 (see section &<<SECTspecitredli>>& for syntax details).
34261 This is prone to error by inexperienced users. There are two features of Exim
34262 that can be used to make this process simpler for users:
34263
34264 .ilist
34265 A local part prefix such as &"vacation-"& can be specified on a router which
34266 can cause the message to be delivered directly to the &'vacation'& program, or
34267 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34268 &_.forward_& file are then much simpler. For example:
34269 .code
34270 spqr, vacation-spqr
34271 .endd
34272 .next
34273 The &%require_files%& generic router option can be used to trigger a
34274 vacation delivery by checking for the existence of a certain file in the
34275 user's home directory. The &%unseen%& generic option should also be used, to
34276 ensure that the original delivery also proceeds. In this case, all the user has
34277 to do is to create a file called, say, &_.vacation_&, containing a vacation
34278 message.
34279 .endlist
34280
34281 Another advantage of both these methods is that they both work even when the
34282 use of arbitrary pipes by users is locked out.
34283
34284
34285
34286 .section "Taking copies of mail" "SECID245"
34287 .cindex "message" "copying every"
34288 Some installations have policies that require archive copies of all messages to
34289 be made. A single copy of each message can easily be taken by an appropriate
34290 command in a system filter, which could, for example, use a different file for
34291 each day's messages.
34292
34293 There is also a shadow transport mechanism that can be used to take copies of
34294 messages that are successfully delivered by local transports, one copy per
34295 delivery. This could be used, &'inter alia'&, to implement automatic
34296 notification of delivery by sites that insist on doing such things.
34297
34298
34299
34300 .section "Intermittently connected hosts" "SECID246"
34301 .cindex "intermittently connected hosts"
34302 It has become quite common (because it is cheaper) for hosts to connect to the
34303 Internet periodically rather than remain connected all the time. The normal
34304 arrangement is that mail for such hosts accumulates on a system that is
34305 permanently connected.
34306
34307 Exim was designed for use on permanently connected hosts, and so it is not
34308 particularly well-suited to use in an intermittently connected environment.
34309 Nevertheless there are some features that can be used.
34310
34311
34312 .section "Exim on the upstream server host" "SECID247"
34313 It is tempting to arrange for incoming mail for the intermittently connected
34314 host to remain on Exim's queue until the client connects. However, this
34315 approach does not scale very well. Two different kinds of waiting message are
34316 being mixed up in the same queue &-- those that cannot be delivered because of
34317 some temporary problem, and those that are waiting for their destination host
34318 to connect. This makes it hard to manage the queue, as well as wasting
34319 resources, because each queue runner scans the entire queue.
34320
34321 A better approach is to separate off those messages that are waiting for an
34322 intermittently connected host. This can be done by delivering these messages
34323 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34324 format, from where they are transmitted by other software when their
34325 destination connects. This makes it easy to collect all the mail for one host
34326 in a single directory, and to apply local timeout rules on a per-message basis
34327 if required.
34328
34329 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34330 you are doing this, you should configure Exim with a long retry period for the
34331 intermittent host. For example:
34332 .code
34333 cheshire.wonderland.fict.example    *   F,5d,24h
34334 .endd
34335 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34336 which messages it has queued up for that host. Once the intermittent host comes
34337 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34338 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34339 causes all the queued up messages to be delivered, often down a single SMTP
34340 connection. While the host remains connected, any new messages get delivered
34341 immediately.
34342
34343 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34344 issued with a different IP address each time it connects, Exim's retry
34345 mechanisms on the holding host get confused, because the IP address is normally
34346 used as part of the key string for holding retry information. This can be
34347 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34348 Since this has disadvantages for permanently connected hosts, it is best to
34349 arrange a separate transport for the intermittently connected ones.
34350
34351
34352
34353 .section "Exim on the intermittently connected client host" "SECID248"
34354 The value of &%smtp_accept_queue_per_connection%& should probably be
34355 increased, or even set to zero (that is, disabled) on the intermittently
34356 connected host, so that all incoming messages down a single connection get
34357 delivered immediately.
34358
34359 .cindex "SMTP" "passed connection"
34360 .cindex "SMTP" "multiple deliveries"
34361 .cindex "multiple SMTP deliveries"
34362 Mail waiting to be sent from an intermittently connected host will probably
34363 not have been routed, because without a connection DNS lookups are not
34364 possible. This means that if a normal queue run is done at connection time,
34365 each message is likely to be sent in a separate SMTP session. This can be
34366 avoided by starting the queue run with a command line option beginning with
34367 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34368 first pass, routing is done but no deliveries take place. The second pass is a
34369 normal queue run; since all the messages have been previously routed, those
34370 destined for the same host are likely to get sent as multiple deliveries in a
34371 single SMTP connection.
34372
34373
34374
34375 . ////////////////////////////////////////////////////////////////////////////
34376 . ////////////////////////////////////////////////////////////////////////////
34377
34378 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34379          "Exim as a non-queueing client"
34380 .cindex "client, non-queueing"
34381 .cindex "smart host" "suppressing queueing"
34382 On a personal computer, it is a common requirement for all
34383 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34384 configured to operate that way, for all the popular operating systems.
34385 However, there are some MUAs for Unix-like systems that cannot be so
34386 configured: they submit messages using the command line interface of
34387 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34388 messages this way.
34389
34390 If the personal computer runs continuously, there is no problem, because it can
34391 run a conventional MTA that handles delivery to the smart host, and deal with
34392 any delays via its queueing mechanism. However, if the computer does not run
34393 continuously or runs different operating systems at different times, queueing
34394 email is not desirable.
34395
34396 There is therefore a requirement for something that can provide the
34397 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34398 any queueing or retrying facilities. Furthermore, the delivery to the smart
34399 host should be synchronous, so that if it fails, the sending MUA is immediately
34400 informed. In other words, we want something that extends an MUA that submits
34401 to a local MTA via the command line so that it behaves like one that submits
34402 to a remote smart host using TCP/SMTP.
34403
34404 There are a number of applications (for example, there is one called &'ssmtp'&)
34405 that do this job. However, people have found them to be lacking in various
34406 ways. For instance, you might want to allow aliasing and forwarding to be done
34407 before sending a message to the smart host.
34408
34409 Exim already had the necessary infrastructure for doing this job. Just a few
34410 tweaks were needed to make it behave as required, though it is somewhat of an
34411 overkill to use a fully-featured MTA for this purpose.
34412
34413 .oindex "&%mua_wrapper%&"
34414 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34415 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34416 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34417 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34418 compatible router and transport configuration. Typically there will be just one
34419 router and one transport, sending everything to a smart host.
34420
34421 When run in MUA wrapping mode, the behaviour of Exim changes in the
34422 following ways:
34423
34424 .ilist
34425 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34426 In other words, the only way to submit messages is via the command line.
34427 .next
34428 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34429 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34430 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34431 does not finish until the delivery attempt is complete. If the delivery is
34432 successful, a zero return code is given.
34433 .next
34434 Address redirection is permitted, but the final routing for all addresses must
34435 be to the same remote transport, and to the same list of hosts. Furthermore,
34436 the return address (envelope sender) must be the same for all recipients, as
34437 must any added or deleted header lines. In other words, it must be possible to
34438 deliver the message in a single SMTP transaction, however many recipients there
34439 are.
34440 .next
34441 If these conditions are not met, or if routing any address results in a
34442 failure or defer status, or if Exim is unable to deliver all the recipients
34443 successfully to one of the smart hosts, delivery of the entire message fails.
34444 .next
34445 Because no queueing is allowed, all failures are treated as permanent; there
34446 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34447 smart host. Furthermore, because only a single yes/no response can be given to
34448 the caller, it is not possible to deliver to some recipients and not others. If
34449 there is an error (temporary or permanent) for any recipient, all are failed.
34450 .next
34451 If more than one smart host is listed, Exim will try another host after a
34452 connection failure or a timeout, in the normal way. However, if this kind of
34453 failure happens for all the hosts, the delivery fails.
34454 .next
34455 When delivery fails, an error message is written to the standard error stream
34456 (as well as to Exim's log), and Exim exits to the caller with a return code
34457 value 1. The message is expunged from Exim's spool files. No bounce messages
34458 are ever generated.
34459 .next
34460 No retry data is maintained, and any retry rules are ignored.
34461 .next
34462 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34463 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34464 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34465 .endlist
34466
34467 The overall effect is that Exim makes a single synchronous attempt to deliver
34468 the message, failing if there is any kind of problem. Because no local
34469 deliveries are done and no daemon can be run, Exim does not need root
34470 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34471 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34472 the advantages and disadvantages of running without root privilege.
34473
34474
34475
34476
34477 . ////////////////////////////////////////////////////////////////////////////
34478 . ////////////////////////////////////////////////////////////////////////////
34479
34480 .chapter "Log files" "CHAPlog"
34481 .scindex IIDloggen "log" "general description"
34482 .cindex "log" "types of"
34483 Exim writes three different logs, referred to as the main log, the reject log,
34484 and the panic log:
34485
34486 .ilist
34487 .cindex "main log"
34488 The main log records the arrival of each message and each delivery in a single
34489 line in each case. The format is as compact as possible, in an attempt to keep
34490 down the size of log files. Two-character flag sequences make it easy to pick
34491 out these lines. A number of other events are recorded in the main log. Some of
34492 them are optional, in which case the &%log_selector%& option controls whether
34493 they are included or not. A Perl script called &'eximstats'&, which does simple
34494 analysis of main log files, is provided in the Exim distribution (see section
34495 &<<SECTmailstat>>&).
34496 .next
34497 .cindex "reject log"
34498 The reject log records information from messages that are rejected as a result
34499 of a configuration option (that is, for policy reasons).
34500 The first line of each rejection is a copy of the line that is also written to
34501 the main log. Then, if the message's header has been read at the time the log
34502 is written, its contents are written to this log. Only the original header
34503 lines are available; header lines added by ACLs are not logged. You can use the
34504 reject log to check that your policy controls are working correctly; on a busy
34505 host this may be easier than scanning the main log for rejection messages. You
34506 can suppress the writing of the reject log by setting &%write_rejectlog%&
34507 false.
34508 .next
34509 .cindex "panic log"
34510 .cindex "system log"
34511 When certain serious errors occur, Exim writes entries to its panic log. If the
34512 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34513 are usually written to the main log as well, but can get lost amid the mass of
34514 other entries. The panic log should be empty under normal circumstances. It is
34515 therefore a good idea to check it (or to have a &'cron'& script check it)
34516 regularly, in order to become aware of any problems. When Exim cannot open its
34517 panic log, it tries as a last resort to write to the system log (syslog). This
34518 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34519 message itself is written at priority LOG_CRIT.
34520 .endlist
34521
34522 Every log line starts with a timestamp, in the format shown in the following
34523 example. Note that many of the examples shown in this chapter are line-wrapped.
34524 In the log file, this would be all on one line:
34525 .code
34526 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34527   by QUIT
34528 .endd
34529 By default, the timestamps are in the local timezone. There are two
34530 ways of changing this:
34531
34532 .ilist
34533 You can set the &%timezone%& option to a different time zone; in particular, if
34534 you set
34535 .code
34536 timezone = UTC
34537 .endd
34538 the timestamps will be in UTC (aka GMT).
34539 .next
34540 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34541 example:
34542 .code
34543 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34544 .endd
34545 .endlist
34546
34547 .cindex "log" "process ids in"
34548 .cindex "pid (process id)" "in log lines"
34549 Exim does not include its process id in log lines by default, but you can
34550 request that it does so by specifying the &`pid`& log selector (see section
34551 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34552 brackets, immediately after the time and date.
34553
34554
34555
34556
34557 .section "Where the logs are written" "SECTwhelogwri"
34558 .cindex "log" "destination"
34559 .cindex "log" "to file"
34560 .cindex "log" "to syslog"
34561 .cindex "syslog"
34562 The logs may be written to local files, or to syslog, or both. However, it
34563 should be noted that many syslog implementations use UDP as a transport, and
34564 are therefore unreliable in the sense that messages are not guaranteed to
34565 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34566 It has also been reported that on large log files (tens of megabytes) you may
34567 need to tweak syslog to prevent it syncing the file with each write &-- on
34568 Linux this has been seen to make syslog take 90% plus of CPU time.
34569
34570 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34571 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34572 configuration. This latter string is expanded, so it can contain, for example,
34573 references to the host name:
34574 .code
34575 log_file_path = /var/log/$primary_hostname/exim_%slog
34576 .endd
34577 It is generally advisable, however, to set the string in &_Local/Makefile_&
34578 rather than at run time, because then the setting is available right from the
34579 start of Exim's execution. Otherwise, if there's something it wants to log
34580 before it has read the configuration file (for example, an error in the
34581 configuration file) it will not use the path you want, and may not be able to
34582 log at all.
34583
34584 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34585 list, currently limited to at most two items. This is one option where the
34586 facility for changing a list separator may not be used. The list must always be
34587 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34588 otherwise the item must either be an absolute path, containing &`%s`& at the
34589 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34590 implying the use of a default path.
34591
34592 When Exim encounters an empty item in the list, it searches the list defined by
34593 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34594 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34595 mean &"use the path specified at build time"&. It no such item exists, log
34596 files are written in the &_log_& subdirectory of the spool directory. This is
34597 equivalent to the setting:
34598 .code
34599 log_file_path = $spool_directory/log/%slog
34600 .endd
34601 If you do not specify anything at build time or run time, that is where the
34602 logs are written.
34603
34604 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34605 are in use &-- see section &<<SECTdatlogfil>>& below.
34606
34607 Here are some examples of possible settings:
34608 .display
34609 &`LOG_FILE_PATH=syslog                    `& syslog only
34610 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34611 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34612 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34613 .endd
34614 If there are more than two paths in the list, the first is used and a panic
34615 error is logged.
34616
34617
34618
34619 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34620 .cindex "log" "cycling local files"
34621 .cindex "cycling logs"
34622 .cindex "&'exicyclog'&"
34623 .cindex "log" "local files; writing to"
34624 Some operating systems provide centralized and standardized methods for cycling
34625 log files. For those that do not, a utility script called &'exicyclog'& is
34626 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34627 main and reject logs each time it is called. The maximum number of old logs to
34628 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34629
34630 An Exim delivery process opens the main log when it first needs to write to it,
34631 and it keeps the file open in case subsequent entries are required &-- for
34632 example, if a number of different deliveries are being done for the same
34633 message. However, remote SMTP deliveries can take a long time, and this means
34634 that the file may be kept open long after it is renamed if &'exicyclog'& or
34635 something similar is being used to rename log files on a regular basis. To
34636 ensure that a switch of log files is noticed as soon as possible, Exim calls
34637 &[stat()]& on the main log's name before reusing an open file, and if the file
34638 does not exist, or its inode has changed, the old file is closed and Exim
34639 tries to open the main log from scratch. Thus, an old log file may remain open
34640 for quite some time, but no Exim processes should write to it once it has been
34641 renamed.
34642
34643
34644
34645 .section "Datestamped log files" "SECTdatlogfil"
34646 .cindex "log" "datestamped files"
34647 Instead of cycling the main and reject log files by renaming them
34648 periodically, some sites like to use files whose names contain a datestamp,
34649 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34650 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34651 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34652 point where the datestamp is required. For example:
34653 .code
34654 log_file_path = /var/spool/exim/log/%slog-%D
34655 log_file_path = /var/log/exim-%s-%D.log
34656 log_file_path = /var/spool/exim/log/%D-%slog
34657 log_file_path = /var/log/exim/%s.%M
34658 .endd
34659 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34660 examples of names generated by the above examples:
34661 .code
34662 /var/spool/exim/log/mainlog-20021225
34663 /var/log/exim-reject-20021225.log
34664 /var/spool/exim/log/20021225-mainlog
34665 /var/log/exim/main.200212
34666 .endd
34667 When this form of log file is specified, Exim automatically switches to new
34668 files at midnight. It does not make any attempt to compress old logs; you
34669 will need to write your own script if you require this. You should not
34670 run &'exicyclog'& with this form of logging.
34671
34672 The location of the panic log is also determined by &%log_file_path%&, but it
34673 is not datestamped, because rotation of the panic log does not make sense.
34674 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34675 the string. In addition, if it immediately follows a slash, a following
34676 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34677 character is removed. Thus, the four examples above would give these panic
34678 log names:
34679 .code
34680 /var/spool/exim/log/paniclog
34681 /var/log/exim-panic.log
34682 /var/spool/exim/log/paniclog
34683 /var/log/exim/panic
34684 .endd
34685
34686
34687 .section "Logging to syslog" "SECID249"
34688 .cindex "log" "syslog; writing to"
34689 The use of syslog does not change what Exim logs or the format of its messages,
34690 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34691 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34692 that, the same strings are written to syslog as to log files. The syslog
34693 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34694 by default, but you can change these by setting the &%syslog_facility%& and
34695 &%syslog_processname%& options, respectively. If Exim was compiled with
34696 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34697 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34698 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34699 the time and host name to each line.
34700 The three log streams are mapped onto syslog priorities as follows:
34701
34702 .ilist
34703 &'mainlog'& is mapped to LOG_INFO
34704 .next
34705 &'rejectlog'& is mapped to LOG_NOTICE
34706 .next
34707 &'paniclog'& is mapped to LOG_ALERT
34708 .endlist
34709
34710 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34711 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34712 these are routed by syslog to the same place. You can suppress this duplication
34713 by setting &%syslog_duplication%& false.
34714
34715 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34716 entries contain multiple lines when headers are included. To cope with both
34717 these cases, entries written to syslog are split into separate &[syslog()]&
34718 calls at each internal newline, and also after a maximum of
34719 870 data characters. (This allows for a total syslog line length of 1024, when
34720 additions such as timestamps are added.) If you are running a syslog
34721 replacement that can handle lines longer than the 1024 characters allowed by
34722 RFC 3164, you should set
34723 .code
34724 SYSLOG_LONG_LINES=yes
34725 .endd
34726 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34727 lines, but it still splits at internal newlines in &'reject'& log entries.
34728
34729 To make it easy to re-assemble split lines later, each component of a split
34730 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34731 where <&'n'&> is the component number and <&'m'&> is the total number of
34732 components in the entry. The / delimiter is used when the line was split
34733 because it was too long; if it was split because of an internal newline, the \
34734 delimiter is used. For example, supposing the length limit to be 50 instead of
34735 870, the following would be the result of a typical rejection message to
34736 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34737 name, and pid as added by syslog:
34738 .code
34739 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34740 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34741 [3/5]  when scanning for sender: missing or malformed lo
34742 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34743 [5/5] mple>)
34744 .endd
34745 The same error might cause the following lines to be written to &"rejectlog"&
34746 (LOG_NOTICE):
34747 .code
34748 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34749 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34750 [3/18] er when scanning for sender: missing or malformed
34751 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34752 [5\18] .example>)
34753 [6\18] Recipients: ph10@some.domain.cam.example
34754 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34755 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34756 [9\18]        id 16RdAL-0006pc-00
34757 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34758 [11\18] 09:43 +0100
34759 [12\18] F From: <>
34760 [13\18]   Subject: this is a test header
34761 [18\18]   X-something: this is another header
34762 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34763 [16\18] le>
34764 [17\18] B Bcc:
34765 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34766 .endd
34767 Log lines that are neither too long nor contain newlines are written to syslog
34768 without modification.
34769
34770 If only syslog is being used, the Exim monitor is unable to provide a log tail
34771 display, unless syslog is routing &'mainlog'& to a file on the local host and
34772 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34773 where it is.
34774
34775
34776
34777 .section "Log line flags" "SECID250"
34778 One line is written to the main log for each message received, and for each
34779 successful, unsuccessful, and delayed delivery. These lines can readily be
34780 picked out by the distinctive two-character flags that immediately follow the
34781 timestamp. The flags are:
34782 .display
34783 &`<=`&     message arrival
34784 &`=>`&     normal message delivery
34785 &`->`&     additional address in same delivery
34786 &`>>`&     cutthrough message delivery
34787 &`*>`&     delivery suppressed by &%-N%&
34788 &`**`&     delivery failed; address bounced
34789 &`==`&     delivery deferred; temporary problem
34790 .endd
34791
34792
34793 .section "Logging message reception" "SECID251"
34794 .cindex "log" "reception line"
34795 The format of the single-line entry in the main log that is written for every
34796 message received is shown in the basic example below, which is split over
34797 several lines in order to fit it on the page:
34798 .code
34799 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34800   H=mailer.fict.example [192.168.123.123] U=exim
34801   P=smtp S=5678 id=<incoming message id>
34802 .endd
34803 The address immediately following &"<="& is the envelope sender address. A
34804 bounce message is shown with the sender address &"<>"&, and if it is locally
34805 generated, this is followed by an item of the form
34806 .code
34807 R=<message id>
34808 .endd
34809 which is a reference to the message that caused the bounce to be sent.
34810
34811 .cindex "HELO"
34812 .cindex "EHLO"
34813 For messages from other hosts, the H and U fields identify the remote host and
34814 record the RFC 1413 identity of the user that sent the message, if one was
34815 received. The number given in square brackets is the IP address of the sending
34816 host. If there is a single, unparenthesized  host name in the H field, as
34817 above, it has been verified to correspond to the IP address (see the
34818 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34819 by the remote host in the SMTP HELO or EHLO command, and has not been
34820 verified. If verification yields a different name to that given for HELO or
34821 EHLO, the verified name appears first, followed by the HELO or EHLO
34822 name in parentheses.
34823
34824 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34825 without brackets, in the HELO or EHLO command, leading to entries in
34826 the log containing text like these examples:
34827 .code
34828 H=(10.21.32.43) [192.168.8.34]
34829 H=([10.21.32.43]) [192.168.8.34]
34830 .endd
34831 This can be confusing. Only the final address in square brackets can be relied
34832 on.
34833
34834 For locally generated messages (that is, messages not received over TCP/IP),
34835 the H field is omitted, and the U field contains the login name of the caller
34836 of Exim.
34837
34838 .cindex "authentication" "logging"
34839 .cindex "AUTH" "logging"
34840 For all messages, the P field specifies the protocol used to receive the
34841 message. This is the value that is stored in &$received_protocol$&. In the case
34842 of incoming SMTP messages, the value indicates whether or not any SMTP
34843 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34844 session was encrypted, there is an additional X field that records the cipher
34845 suite that was used.
34846
34847 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34848 hosts that have authenticated themselves using the SMTP AUTH command. The first
34849 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34850 there is an additional item A= followed by the name of the authenticator that
34851 was used. If an authenticated identification was set up by the authenticator's
34852 &%server_set_id%& option, this is logged too, separated by a colon from the
34853 authenticator name.
34854
34855 .cindex "size" "of message"
34856 The id field records the existing message id, if present. The size of the
34857 received message is given by the S field. When the message is delivered,
34858 headers may be removed or added, so that the size of delivered copies of the
34859 message may not correspond with this value (and indeed may be different to each
34860 other).
34861
34862 The &%log_selector%& option can be used to request the logging of additional
34863 data when a message is received. See section &<<SECTlogselector>>& below.
34864
34865
34866
34867 .section "Logging deliveries" "SECID252"
34868 .cindex "log" "delivery line"
34869 The format of the single-line entry in the main log that is written for every
34870 delivery is shown in one of the examples below, for local and remote
34871 deliveries, respectively. Each example has been split into two lines in order
34872 to fit it on the page:
34873 .code
34874 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34875   <marv@hitch.fict.example> R=localuser T=local_delivery
34876 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34877   monk@holistic.fict.example R=dnslookup T=remote_smtp
34878   H=holistic.fict.example [192.168.234.234]
34879 .endd
34880 For ordinary local deliveries, the original address is given in angle brackets
34881 after the final delivery address, which might be a pipe or a file. If
34882 intermediate address(es) exist between the original and the final address, the
34883 last of these is given in parentheses after the final address. The R and T
34884 fields record the router and transport that were used to process the address.
34885
34886 If SMTP AUTH was used for the delivery there is an additional item A=
34887 followed by the name of the authenticator that was used.
34888 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34889 option, this is logged too, separated by a colon from the authenticator name.
34890
34891 If a shadow transport was run after a successful local delivery, the log line
34892 for the successful delivery has an item added on the end, of the form
34893 .display
34894 &`ST=<`&&'shadow transport name'&&`>`&
34895 .endd
34896 If the shadow transport did not succeed, the error message is put in
34897 parentheses afterwards.
34898
34899 .cindex "asterisk" "after IP address"
34900 When more than one address is included in a single delivery (for example, two
34901 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34902 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34903 down a single SMTP connection, an asterisk follows the IP address in the log
34904 lines for the second and subsequent messages.
34905
34906 .cindex "delivery" "cutthrough; logging"
34907 .cindex "cutthrough" "logging"
34908 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34909 line precedes the reception line, since cutthrough waits for a possible
34910 rejection from the destination in case it can reject the sourced item.
34911
34912 The generation of a reply message by a filter file gets logged as a
34913 &"delivery"& to the addressee, preceded by &">"&.
34914
34915 The &%log_selector%& option can be used to request the logging of additional
34916 data when a message is delivered. See section &<<SECTlogselector>>& below.
34917
34918
34919 .section "Discarded deliveries" "SECID253"
34920 .cindex "discarded messages"
34921 .cindex "message" "discarded"
34922 .cindex "delivery" "discarded; logging"
34923 When a message is discarded as a result of the command &"seen finish"& being
34924 obeyed in a filter file which generates no deliveries, a log entry of the form
34925 .code
34926 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34927   <low.club@bridge.example> R=userforward
34928 .endd
34929 is written, to record why no deliveries are logged. When a message is discarded
34930 because it is aliased to &":blackhole:"& the log line is like this:
34931 .code
34932 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34933   <hole@nowhere.example> R=blackhole_router
34934 .endd
34935
34936
34937 .section "Deferred deliveries" "SECID254"
34938 When a delivery is deferred, a line of the following form is logged:
34939 .code
34940 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34941   R=dnslookup T=smtp defer (146): Connection refused
34942 .endd
34943 In the case of remote deliveries, the error is the one that was given for the
34944 last IP address that was tried. Details of individual SMTP failures are also
34945 written to the log, so the above line would be preceded by something like
34946 .code
34947 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34948   mail1.endrest.example [192.168.239.239]: Connection refused
34949 .endd
34950 When a deferred address is skipped because its retry time has not been reached,
34951 a message is written to the log, but this can be suppressed by setting an
34952 appropriate value in &%log_selector%&.
34953
34954
34955
34956 .section "Delivery failures" "SECID255"
34957 .cindex "delivery" "failure; logging"
34958 If a delivery fails because an address cannot be routed, a line of the
34959 following form is logged:
34960 .code
34961 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34962   <jim@trek99.example>: unknown mail domain
34963 .endd
34964 If a delivery fails at transport time, the router and transport are shown, and
34965 the response from the remote host is included, as in this example:
34966 .code
34967 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34968   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34969   after pipelined RCPT TO:<ace400@pb.example>: host
34970   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34971   <ace400@pb.example>...Addressee unknown
34972 .endd
34973 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34974 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34975 disabling PIPELINING. The log lines for all forms of delivery failure are
34976 flagged with &`**`&.
34977
34978
34979
34980 .section "Fake deliveries" "SECID256"
34981 .cindex "delivery" "fake; logging"
34982 If a delivery does not actually take place because the &%-N%& option has been
34983 used to suppress it, a normal delivery line is written to the log, except that
34984 &"=>"& is replaced by &"*>"&.
34985
34986
34987
34988 .section "Completion" "SECID257"
34989 A line of the form
34990 .code
34991 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34992 .endd
34993 is written to the main log when a message is about to be removed from the spool
34994 at the end of its processing.
34995
34996
34997
34998
34999 .section "Summary of Fields in Log Lines" "SECID258"
35000 .cindex "log" "summary of fields"
35001 A summary of the field identifiers that are used in log lines is shown in
35002 the following table:
35003 .display
35004 &`A   `&        authenticator name (and optional id and sender)
35005 &`C   `&        SMTP confirmation on delivery
35006 &`    `&        command list for &"no mail in SMTP session"&
35007 &`CV  `&        certificate verification status
35008 &`D   `&        duration of &"no mail in SMTP session"&
35009 &`DN  `&        distinguished name from peer certificate
35010 &`DT  `&        on &`=>`& lines: time taken for a delivery
35011 &`F   `&        sender address (on delivery lines)
35012 &`H   `&        host name and IP address
35013 &`I   `&        local interface used
35014 &`id  `&        message id for incoming message
35015 &`P   `&        on &`<=`& lines: protocol used
35016 &`    `&        on &`=>`& and &`**`& lines: return path
35017 &`QT  `&        on &`=>`& lines: time spent on queue so far
35018 &`    `&        on &"Completed"& lines: time spent on queue
35019 &`R   `&        on &`<=`& lines: reference for local bounce
35020 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
35021 &`S   `&        size of message
35022 &`SNI `&        server name indication from TLS client hello
35023 &`ST  `&        shadow transport name
35024 &`T   `&        on &`<=`& lines: message subject (topic)
35025 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35026 &`U   `&        local user or RFC 1413 identity
35027 &`X   `&        TLS cipher suite
35028 .endd
35029
35030
35031 .section "Other log entries" "SECID259"
35032 Various other types of log entry are written from time to time. Most should be
35033 self-explanatory. Among the more common are:
35034
35035 .ilist
35036 .cindex "retry" "time not reached"
35037 &'retry time not reached'&&~&~An address previously suffered a temporary error
35038 during routing or local delivery, and the time to retry has not yet arrived.
35039 This message is not written to an individual message log file unless it happens
35040 during the first delivery attempt.
35041 .next
35042 &'retry time not reached for any host'&&~&~An address previously suffered
35043 temporary errors during remote delivery, and the retry time has not yet arrived
35044 for any of the hosts to which it is routed.
35045 .next
35046 .cindex "spool directory" "file locked"
35047 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35048 some other Exim process is already working on the message. This can be quite
35049 common if queue running processes are started at frequent intervals. The
35050 &'exiwhat'& utility script can be used to find out what Exim processes are
35051 doing.
35052 .next
35053 .cindex "error" "ignored"
35054 &'error ignored'&&~&~There are several circumstances that give rise to this
35055 message:
35056 .olist
35057 Exim failed to deliver a bounce message whose age was greater than
35058 &%ignore_bounce_errors_after%&. The bounce was discarded.
35059 .next
35060 A filter file set up a delivery using the &"noerror"& option, and the delivery
35061 failed. The delivery was discarded.
35062 .next
35063 A delivery set up by a router configured with
35064 . ==== As this is a nested list, any displays it contains must be indented
35065 . ==== as otherwise they are too far to the left.
35066 .code
35067     errors_to = <>
35068 .endd
35069 failed. The delivery was discarded.
35070 .endlist olist
35071 .endlist ilist
35072
35073
35074
35075
35076
35077 .section "Reducing or increasing what is logged" "SECTlogselector"
35078 .cindex "log" "selectors"
35079 By setting the &%log_selector%& global option, you can disable some of Exim's
35080 default logging, or you can request additional logging. The value of
35081 &%log_selector%& is made up of names preceded by plus or minus characters. For
35082 example:
35083 .code
35084 log_selector = +arguments -retry_defer
35085 .endd
35086 The list of optional log items is in the following table, with the default
35087 selection marked by asterisks:
35088 .display
35089 &` 8bitmime                   `&  received 8BITMIME status
35090 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35091 &` address_rewrite            `&  address rewriting
35092 &` all_parents                `&  all parents in => lines
35093 &` arguments                  `&  command line arguments
35094 &`*connection_reject          `&  connection rejections
35095 &`*delay_delivery             `&  immediate delivery delayed
35096 &` deliver_time               `&  time taken to perform delivery
35097 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35098 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35099 &`*etrn                       `&  ETRN commands
35100 &`*host_lookup_failed         `&  as it says
35101 &` ident_timeout              `&  timeout for ident connection
35102 &` incoming_interface         `&  local interface on <= and => lines
35103 &` incoming_port              `&  remote port on <= lines
35104 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35105 &` outgoing_port              `&  add remote port to => lines
35106 &`*queue_run                  `&  start and end queue runs
35107 &` queue_time                 `&  time on queue for one recipient
35108 &` queue_time_overall         `&  time on queue for whole message
35109 &` pid                        `&  Exim process id
35110 &` received_recipients        `&  recipients on <= lines
35111 &` received_sender            `&  sender on <= lines
35112 &`*rejected_header            `&  header contents on reject log
35113 &`*retry_defer                `&  &"retry time not reached"&
35114 &` return_path_on_delivery    `&  put return path on => and ** lines
35115 &` sender_on_delivery         `&  add sender to => lines
35116 &`*sender_verify_fail         `&  sender verification failures
35117 &`*size_reject                `&  rejection because too big
35118 &`*skip_delivery              `&  delivery skipped in a queue run
35119 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35120 &` smtp_connection            `&  SMTP connections
35121 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35122 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35123 &` smtp_no_mail               `&  session with no MAIL commands
35124 &` smtp_protocol_error        `&  SMTP protocol errors
35125 &` smtp_syntax_error          `&  SMTP syntax errors
35126 &` subject                    `&  contents of &'Subject:'& on <= lines
35127 .new
35128 &`*tls_certificate_verified   `&  certificate verification status
35129 .wen
35130 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35131 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35132 &` tls_sni                    `&  TLS SNI on <= lines
35133 &` unknown_in_list            `&  DNS lookup failed in list match
35134
35135 &` all                        `&  all of the above
35136 .endd
35137 More details on each of these items follows:
35138
35139 .ilist
35140 .cindex "8BITMIME"
35141 .cindex "log" "8BITMIME"
35142 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35143 which may help in tracking down interoperability issues with ancient MTAs
35144 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35145 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35146 &`7BIT`& and &`8BITMIME`& respectively.
35147 .next
35148 .cindex "&%warn%& ACL verb" "log when skipping"
35149 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35150 its conditions cannot be evaluated, a log line to this effect is written if
35151 this log selector is set.
35152 .next
35153 .cindex "log" "rewriting"
35154 .cindex "rewriting" "logging"
35155 &%address_rewrite%&: This applies both to global rewrites and per-transport
35156 rewrites, but not to rewrites in filters run as an unprivileged user (because
35157 such users cannot access the log).
35158 .next
35159 .cindex "log" "full parentage"
35160 &%all_parents%&: Normally only the original and final addresses are logged on
35161 delivery lines; with this selector, intermediate parents are given in
35162 parentheses between them.
35163 .next
35164 .cindex "log" "Exim arguments"
35165 .cindex "Exim arguments, logging"
35166 &%arguments%&: This causes Exim to write the arguments with which it was called
35167 to the main log, preceded by the current working directory. This is a debugging
35168 feature, added to make it easier to find out how certain MUAs call
35169 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35170 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35171 that are empty or that contain white space are quoted. Non-printing characters
35172 are shown as escape sequences. This facility cannot log unrecognized arguments,
35173 because the arguments are checked before the configuration file is read. The
35174 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35175 between the caller and Exim.
35176 .next
35177 .cindex "log" "connection rejections"
35178 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35179 connection is rejected, for whatever reason.
35180 .next
35181 .cindex "log" "delayed delivery"
35182 .cindex "delayed delivery, logging"
35183 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35184 started for an incoming message because the load is too high or too many
35185 messages were received on one connection. Logging does not occur if no delivery
35186 process is started because &%queue_only%& is set or &%-odq%& was used.
35187 .next
35188 .cindex "log" "delivery duration"
35189 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35190 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35191 .next
35192 .cindex "log" "message size on delivery"
35193 .cindex "size" "of message"
35194 &%delivery_size%&: For each delivery, the size of message delivered is added to
35195 the &"=>"& line, tagged with S=.
35196 .next
35197 .cindex "log" "dnslist defer"
35198 .cindex "DNS list" "logging defer"
35199 .cindex "black list (DNS)"
35200 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35201 DNS black list suffers a temporary error.
35202 .next
35203 .cindex "log" "ETRN commands"
35204 .cindex "ETRN" "logging"
35205 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35206 is run to determine whether or not it is actually accepted. An invalid ETRN
35207 command, or one received within a message transaction is not logged by this
35208 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35209 .next
35210 .cindex "log" "host lookup failure"
35211 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35212 any addresses, or when a lookup of an IP address fails to find a host name, a
35213 log line is written. This logging does not apply to direct DNS lookups when
35214 routing email addresses, but it does apply to &"byname"& lookups.
35215 .next
35216 .cindex "log" "ident timeout"
35217 .cindex "RFC 1413" "logging timeout"
35218 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35219 client's ident port times out.
35220 .next
35221 .cindex "log" "incoming interface"
35222 .cindex "log" "local interface"
35223 .cindex "log" "local address and port"
35224 .cindex "TCP/IP" "logging local address and port"
35225 .cindex "interface" "logging"
35226 &%incoming_interface%&: The interface on which a message was received is added
35227 to the &"<="& line as an IP address in square brackets, tagged by I= and
35228 followed by a colon and the port number. The local interface and port are also
35229 added to other SMTP log lines, for example &"SMTP connection from"& and to
35230 rejection lines
35231 and (despite the name) the local interface is added to &"=>"& lines..
35232 .next
35233 .cindex "log" "incoming remote port"
35234 .cindex "port" "logging remote"
35235 .cindex "TCP/IP" "logging incoming remote port"
35236 .vindex "&$sender_fullhost$&"
35237 .vindex "&$sender_rcvhost$&"
35238 &%incoming_port%&: The remote port number from which a message was received is
35239 added to log entries and &'Received:'& header lines, following the IP address
35240 in square brackets, and separated from it by a colon. This is implemented by
35241 changing the value that is put in the &$sender_fullhost$& and
35242 &$sender_rcvhost$& variables. Recording the remote port number has become more
35243 important with the widening use of NAT (see RFC 2505).
35244 .next
35245 .cindex "log" "dropped connection"
35246 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35247 connection is unexpectedly dropped.
35248 .next
35249 .cindex "log" "outgoing remote port"
35250 .cindex "port" "logging outgoint remote"
35251 .cindex "TCP/IP" "logging ougtoing remote port"
35252 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35253 containing => tags) following the IP address. This option is not included in
35254 the default setting, because for most ordinary configurations, the remote port
35255 number is always 25 (the SMTP port).
35256 .next
35257 .cindex "log" "process ids in"
35258 .cindex "pid (process id)" "in log lines"
35259 &%pid%&: The current process id is added to every log line, in square brackets,
35260 immediately after the time and date.
35261 .next
35262 .cindex "log" "queue run"
35263 .cindex "queue runner" "logging"
35264 &%queue_run%&: The start and end of every queue run are logged.
35265 .next
35266 .cindex "log" "queue time"
35267 &%queue_time%&: The amount of time the message has been in the queue on the
35268 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35269 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35270 includes reception time as well as the delivery time for the current address.
35271 This means that it may be longer than the difference between the arrival and
35272 delivery log line times, because the arrival log line is not written until the
35273 message has been successfully received.
35274 .next
35275 &%queue_time_overall%&: The amount of time the message has been in the queue on
35276 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35277 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35278 message, so it includes reception time as well as the total delivery time.
35279 .next
35280 .cindex "log" "recipients"
35281 &%received_recipients%&: The recipients of a message are listed in the main log
35282 as soon as the message is received. The list appears at the end of the log line
35283 that is written when a message is received, preceded by the word &"for"&. The
35284 addresses are listed after they have been qualified, but before any rewriting
35285 has taken place.
35286 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35287 in the list.
35288 .next
35289 .cindex "log" "sender reception"
35290 &%received_sender%&: The unrewritten original sender of a message is added to
35291 the end of the log line that records the message's arrival, after the word
35292 &"from"& (before the recipients if &%received_recipients%& is also set).
35293 .next
35294 .cindex "log" "header lines for rejection"
35295 &%rejected_header%&: If a message's header has been received at the time a
35296 rejection is written to the reject log, the complete header is added to the
35297 log. Header logging can be turned off individually for messages that are
35298 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35299 .next
35300 .cindex "log" "retry defer"
35301 &%retry_defer%&: A log line is written if a delivery is deferred because a
35302 retry time has not yet been reached. However, this &"retry time not reached"&
35303 message is always omitted from individual message logs after the first delivery
35304 attempt.
35305 .next
35306 .cindex "log" "return path"
35307 &%return_path_on_delivery%&: The return path that is being transmitted with
35308 the message is included in delivery and bounce lines, using the tag P=.
35309 This is omitted if no delivery actually happens, for example, if routing fails,
35310 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35311 .next
35312 .cindex "log" "sender on delivery"
35313 &%sender_on_delivery%&: The message's sender address is added to every delivery
35314 and bounce line, tagged by F= (for &"from"&).
35315 This is the original sender that was received with the message; it is not
35316 necessarily the same as the outgoing return path.
35317 .next
35318 .cindex "log" "sender verify failure"
35319 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35320 gives details of a sender verification failure is not written. Log lines for
35321 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35322 detail is lost.
35323 .next
35324 .cindex "log" "size rejection"
35325 &%size_reject%&: A log line is written whenever a message is rejected because
35326 it is too big.
35327 .next
35328 .cindex "log" "frozen messages; skipped"
35329 .cindex "frozen messages" "logging skipping"
35330 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35331 queue run because it is frozen or because another process is already delivering
35332 it.
35333 .cindex "&""spool file is locked""&"
35334 The message that is written is &"spool file is locked"&.
35335 .next
35336 .cindex "log" "smtp confirmation"
35337 .cindex "SMTP" "logging confirmation"
35338 .cindex "LMTP" "logging confirmation"
35339 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35340 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35341 A number of MTAs (including Exim) return an identifying string in this
35342 response.
35343 .next
35344 .cindex "log" "SMTP connections"
35345 .cindex "SMTP" "logging connections"
35346 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35347 established or closed, unless the connection is from a host that matches
35348 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35349 only when the closure is unexpected.) This applies to connections from local
35350 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35351 dropped in the middle of a message, a log line is always written, whether or
35352 not this selector is set, but otherwise nothing is written at the start and end
35353 of connections unless this selector is enabled.
35354
35355 For TCP/IP connections to an Exim daemon, the current number of connections is
35356 included in the log message for each new connection, but note that the count is
35357 reset if the daemon is restarted.
35358 Also, because connections are closed (and the closure is logged) in
35359 subprocesses, the count may not include connections that have been closed but
35360 whose termination the daemon has not yet noticed. Thus, while it is possible to
35361 match up the opening and closing of connections in the log, the value of the
35362 logged counts may not be entirely accurate.
35363 .next
35364 .cindex "log" "SMTP transaction; incomplete"
35365 .cindex "SMTP" "logging incomplete transactions"
35366 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35367 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35368 and the message sender plus any accepted recipients are included in the log
35369 line. This can provide evidence of dictionary attacks.
35370 .next
35371 .cindex "log" "non-MAIL SMTP sessions"
35372 .cindex "MAIL" "logging session without"
35373 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35374 connection terminates without having issued a MAIL command. This includes both
35375 the case when the connection is dropped, and the case when QUIT is used. It
35376 does not include cases where the connection is rejected right at the start (by
35377 an ACL, or because there are too many connections, or whatever). These cases
35378 already have their own log lines.
35379
35380 The log line that is written contains the identity of the client in the usual
35381 way, followed by D= and a time, which records the duration of the connection.
35382 If the connection was authenticated, this fact is logged exactly as it is for
35383 an incoming message, with an A= item. If the connection was encrypted, CV=,
35384 DN=, and X= items may appear as they do for an incoming message, controlled by
35385 the same logging options.
35386
35387 Finally, if any SMTP commands were issued during the connection, a C= item
35388 is added to the line, listing the commands that were used. For example,
35389 .code
35390 C=EHLO,QUIT
35391 .endd
35392 shows that the client issued QUIT straight after EHLO. If there were fewer
35393 than 20 commands, they are all listed. If there were more than 20 commands,
35394 the last 20 are listed, preceded by &"..."&. However, with the default
35395 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35396 have been aborted before 20 non-mail commands are processed.
35397 .next
35398 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35399 colon-separated, is appended to the A= item for a message arrival or delivery
35400 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35401 was accepted or used.
35402 .next
35403 .cindex "log" "SMTP protocol error"
35404 .cindex "SMTP" "logging protocol error"
35405 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35406 encountered. Exim does not have perfect detection of all protocol errors
35407 because of transmission delays and the use of pipelining. If PIPELINING has
35408 been advertised to a client, an Exim server assumes that the client will use
35409 it, and therefore it does not count &"expected"& errors (for example, RCPT
35410 received after rejecting MAIL) as protocol errors.
35411 .next
35412 .cindex "SMTP" "logging syntax errors"
35413 .cindex "SMTP" "syntax errors; logging"
35414 .cindex "SMTP" "unknown command; logging"
35415 .cindex "log" "unknown SMTP command"
35416 .cindex "log" "SMTP syntax error"
35417 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35418 encountered. An unrecognized command is treated as a syntax error. For an
35419 external connection, the host identity is given; for an internal connection
35420 using &%-bs%& the sender identification (normally the calling user) is given.
35421 .next
35422 .cindex "log" "subject"
35423 .cindex "subject, logging"
35424 &%subject%&: The subject of the message is added to the arrival log line,
35425 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35426 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35427 specifies whether characters with values greater than 127 should be logged
35428 unchanged, or whether they should be rendered as escape sequences.
35429 .next
35430 .cindex "log" "certificate verification"
35431 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35432 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35433 verified, and &`CV=no`& if not.
35434 .next
35435 .cindex "log" "TLS cipher"
35436 .cindex "TLS" "logging cipher"
35437 &%tls_cipher%&: When a message is sent or received over an encrypted
35438 connection, the cipher suite used is added to the log line, preceded by X=.
35439 .next
35440 .cindex "log" "TLS peer DN"
35441 .cindex "TLS" "logging peer DN"
35442 &%tls_peerdn%&: When a message is sent or received over an encrypted
35443 connection, and a certificate is supplied by the remote host, the peer DN is
35444 added to the log line, preceded by DN=.
35445 .next
35446 .cindex "log" "TLS SNI"
35447 .cindex "TLS" "logging SNI"
35448 &%tls_sni%&: When a message is received over an encrypted connection, and
35449 the remote host provided the Server Name Indication extension, the SNI is
35450 added to the log line, preceded by SNI=.
35451 .next
35452 .cindex "log" "DNS failure in list"
35453 &%unknown_in_list%&: This setting causes a log entry to be written when the
35454 result of a list match is failure because a DNS lookup failed.
35455 .endlist
35456
35457
35458 .section "Message log" "SECID260"
35459 .cindex "message" "log file for"
35460 .cindex "log" "message log; description of"
35461 .cindex "&_msglog_& directory"
35462 .oindex "&%preserve_message_logs%&"
35463 In addition to the general log files, Exim writes a log file for each message
35464 that it handles. The names of these per-message logs are the message ids, and
35465 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35466 message log contains copies of the log lines that apply to the message. This
35467 makes it easier to inspect the status of an individual message without having
35468 to search the main log. A message log is deleted when processing of the message
35469 is complete, unless &%preserve_message_logs%& is set, but this should be used
35470 only with great care because they can fill up your disk very quickly.
35471
35472 On a heavily loaded system, it may be desirable to disable the use of
35473 per-message logs, in order to reduce disk I/O. This can be done by setting the
35474 &%message_logs%& option false.
35475 .ecindex IIDloggen
35476
35477
35478
35479
35480 . ////////////////////////////////////////////////////////////////////////////
35481 . ////////////////////////////////////////////////////////////////////////////
35482
35483 .chapter "Exim utilities" "CHAPutils"
35484 .scindex IIDutils "utilities"
35485 A number of utility scripts and programs are supplied with Exim and are
35486 described in this chapter. There is also the Exim Monitor, which is covered in
35487 the next chapter. The utilities described here are:
35488
35489 .itable none 0 0 3  7* left  15* left  40* left
35490 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35491   "list what Exim processes are doing"
35492 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35493 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35494 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35495 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35496                                                 various criteria"
35497 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35498 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35499   "extract statistics from the log"
35500 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35501   "check address acceptance from given IP"
35502 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35503 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35504 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35505 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35506 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35507 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35508 .endtable
35509
35510 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35511 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35512 &url(http://duncanthrax.net/exilog/) for details.
35513
35514
35515
35516
35517 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35518 .cindex "&'exiwhat'&"
35519 .cindex "process, querying"
35520 .cindex "SIGUSR1"
35521 On operating systems that can restart a system call after receiving a signal
35522 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35523 a line describing what it is doing to the file &_exim-process.info_& in the
35524 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35525 processes it can find, having first emptied the file. It then waits for one
35526 second to allow the Exim processes to react before displaying the results. In
35527 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35528 send the signal to the Exim processes, so it is normally run as root.
35529
35530 &*Warning*&: This is not an efficient process. It is intended for occasional
35531 use by system administrators. It is not sensible, for example, to set up a
35532 script that sends SIGUSR1 signals to Exim processes at short intervals.
35533
35534
35535 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35536 varies in different operating systems. Not only are different options used,
35537 but the format of the output is different. For this reason, there are some
35538 system configuration options that configure exactly how &'exiwhat'& works. If
35539 it doesn't seem to be working for you, check the following compile-time
35540 options:
35541 .display
35542 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35543 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35544 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35545 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35546 .endd
35547 An example of typical output from &'exiwhat'& is
35548 .code
35549 164 daemon: -q1h, listening on port 25
35550 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35551 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35552   [10.19.42.42] (editor@ref.example)
35553 10592 handling incoming call from [192.168.243.242]
35554 10628 accepting a local non-SMTP message
35555 .endd
35556 The first number in the output line is the process number. The third line has
35557 been split here, in order to fit it on the page.
35558
35559
35560
35561 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35562 .cindex "&'exiqgrep'&"
35563 .cindex "queue" "grepping"
35564 This utility is a Perl script contributed by Matt Hubbard. It runs
35565 .code
35566 exim -bpu
35567 .endd
35568 or (in case &*-a*& switch is specified)
35569 .code
35570 exim -bp
35571 .endd
35572 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35573 contain alternate exim configuration the queue management might be using.
35574
35575 to obtain a queue listing, and then greps the output to select messages 
35576 that match given criteria. The following selection options are available:
35577
35578 .vlist
35579 .vitem &*-f*&&~<&'regex'&>
35580 Match the sender address using a case-insensitive search. The field that is
35581 tested is enclosed in angle brackets, so you can test for bounce messages with
35582 .code
35583 exiqgrep -f '^<>$'
35584 .endd
35585 .vitem &*-r*&&~<&'regex'&>
35586 Match a recipient address using a case-insensitve search. The field that is
35587 tested is not enclosed in angle brackets.
35588
35589 .vitem &*-s*&&~<&'regex'&>
35590 Match against the size field.
35591
35592 .vitem &*-y*&&~<&'seconds'&>
35593 Match messages that are younger than the given time.
35594
35595 .vitem &*-o*&&~<&'seconds'&>
35596 Match messages that are older than the given time.
35597
35598 .vitem &*-z*&
35599 Match only frozen messages.
35600
35601 .vitem &*-x*&
35602 Match only non-frozen messages.
35603 .endlist
35604
35605 The following options control the format of the output:
35606
35607 .vlist
35608 .vitem &*-c*&
35609 Display only the count of matching messages.
35610
35611 .vitem &*-l*&
35612 Long format &-- display the full message information as output by Exim. This is
35613 the default.
35614
35615 .vitem &*-i*&
35616 Display message ids only.
35617
35618 .vitem &*-b*&
35619 Brief format &-- one line per message.
35620
35621 .vitem &*-R*&
35622 Display messages in reverse order.
35623
35624 .vitem &*-a*&
35625 Include delivered recipients in queue listing.
35626 .endlist
35627
35628 There is one more option, &%-h%&, which outputs a list of options.
35629
35630
35631
35632 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35633 .cindex "&'exiqsumm'&"
35634 .cindex "queue" "summary"
35635 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35636 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35637 running a command such as
35638 .code
35639 exim -bp | exiqsumm
35640 .endd
35641 The output consists of one line for each domain that has messages waiting for
35642 it, as in the following example:
35643 .code
35644 3   2322   74m   66m  msn.com.example
35645 .endd
35646 Each line lists the number of pending deliveries for a domain, their total
35647 volume, and the length of time that the oldest and the newest messages have
35648 been waiting. Note that the number of pending deliveries is greater than the
35649 number of messages when messages have more than one recipient.
35650
35651 A summary line is output at the end. By default the output is sorted on the
35652 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35653 the output to be sorted by oldest message and by count of messages,
35654 respectively. There are also three options that split the messages for each
35655 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35656 separates frozen messages, and &%-s%& separates messages according to their
35657 sender.
35658
35659 The output of &'exim -bp'& contains the original addresses in the message, so
35660 this also applies to the output from &'exiqsumm'&. No domains from addresses
35661 generated by aliasing or forwarding are included (unless the &%one_time%&
35662 option of the &(redirect)& router has been used to convert them into &"top
35663 level"& addresses).
35664
35665
35666
35667
35668 .section "Extracting specific information from the log (exigrep)" &&&
35669          "SECTextspeinf"
35670 .cindex "&'exigrep'&"
35671 .cindex "log" "extracts; grepping for"
35672 The &'exigrep'& utility is a Perl script that searches one or more main log
35673 files for entries that match a given pattern. When it finds a match, it
35674 extracts all the log entries for the relevant message, not just those that
35675 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35676 given message, or all mail for a given user, or for a given host, for example.
35677 The input files can be in Exim log format or syslog format.
35678 If a matching log line is not associated with a specific message, it is
35679 included in &'exigrep'&'s output without any additional lines. The usage is:
35680 .display
35681 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35682 .endd
35683 If no log file names are given on the command line, the standard input is read.
35684
35685 The &%-t%& argument specifies a number of seconds. It adds an additional
35686 condition for message selection. Messages that are complete are shown only if
35687 they spent more than <&'n'&> seconds on the queue.
35688
35689 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35690 makes it case-sensitive. This may give a performance improvement when searching
35691 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35692 option; with &%-I%& they do not. In both cases it is possible to change the
35693 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35694
35695 The &%-l%& option means &"literal"&, that is, treat all characters in the
35696 pattern as standing for themselves. Otherwise the pattern must be a Perl
35697 regular expression.
35698
35699 The &%-v%& option inverts the matching condition. That is, a line is selected
35700 if it does &'not'& match the pattern.
35701
35702 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35703 that are generated as a result/response to a message that &'exigrep'& matched
35704 normally.
35705
35706 Example of &%-M%&:
35707 user_a sends a message to user_b, which generates a bounce back to user_b. If
35708 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35709 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35710 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35711 when searching for &"user_a"& will show both messages since the bounce is
35712 &"related"& to or a &"result"& of the first message that was found by the
35713 search term.
35714
35715 If the location of a &'zcat'& command is known from the definition of
35716 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35717 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35718
35719
35720 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35721 .cindex "&'exipick'&"
35722 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35723 lists messages from the queue according to a variety of criteria. For details
35724 of &'exipick'&'s facilities, visit the web page at
35725 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35726 the &%--help%& option.
35727
35728
35729 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35730 .cindex "log" "cycling local files"
35731 .cindex "cycling logs"
35732 .cindex "&'exicyclog'&"
35733 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35734 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35735 you are using log files with datestamps in their names (see section
35736 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35737 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35738 There are two command line options for &'exicyclog'&:
35739 .ilist
35740 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35741 default that is set when Exim is built. The default default is 10.
35742 .next
35743 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35744 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35745 overriding the script's default, which is to find the setting from Exim's
35746 configuration.
35747 .endlist
35748
35749 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35750 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35751 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35752 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35753 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35754 logs are handled similarly.
35755
35756 If the limit is greater than 99, the script uses 3-digit numbers such as
35757 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35758 to one that is greater, or &'vice versa'&, you will have to fix the names of
35759 any existing log files.
35760
35761 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35762 the end are deleted. All files with numbers greater than 01 are compressed,
35763 using a compression command which is configured by the COMPRESS_COMMAND
35764 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35765 root &%crontab%& entry of the form
35766 .code
35767 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35768 .endd
35769 assuming you have used the name &"exim"& for the Exim user. You can run
35770 &'exicyclog'& as root if you wish, but there is no need.
35771
35772
35773
35774 .section "Mail statistics (eximstats)" "SECTmailstat"
35775 .cindex "statistics"
35776 .cindex "&'eximstats'&"
35777 A Perl script called &'eximstats'& is provided for extracting statistical
35778 information from log files. The output is either plain text, or HTML.
35779 Exim log files are also supported by the &'Lire'& system produced by the
35780 LogReport Foundation &url(http://www.logreport.org).
35781
35782 The &'eximstats'& script has been hacked about quite a bit over time. The
35783 latest version is the result of some extensive revision by Steve Campbell. A
35784 lot of information is given by default, but there are options for suppressing
35785 various parts of it. Following any options, the arguments to the script are a
35786 list of files, which should be main log files. For example:
35787 .code
35788 eximstats -nr /var/spool/exim/log/mainlog.01
35789 .endd
35790 By default, &'eximstats'& extracts information about the number and volume of
35791 messages received from or delivered to various hosts. The information is sorted
35792 both by message count and by volume, and the top fifty hosts in each category
35793 are listed on the standard output. Similar information, based on email
35794 addresses or domains instead of hosts can be requested by means of various
35795 options. For messages delivered and received locally, similar statistics are
35796 also produced per user.
35797
35798 The output also includes total counts and statistics about delivery errors, and
35799 histograms showing the number of messages received and deliveries made in each
35800 hour of the day. A delivery with more than one address in its envelope (for
35801 example, an SMTP transaction with more than one RCPT command) is counted
35802 as a single delivery by &'eximstats'&.
35803
35804 Though normally more deliveries than receipts are reported (as messages may
35805 have multiple recipients), it is possible for &'eximstats'& to report more
35806 messages received than delivered, even though the queue is empty at the start
35807 and end of the period in question. If an incoming message contains no valid
35808 recipients, no deliveries are recorded for it. A bounce message is handled as
35809 an entirely separate message.
35810
35811 &'eximstats'& always outputs a grand total summary giving the volume and number
35812 of messages received and deliveries made, and the number of hosts involved in
35813 each case. It also outputs the number of messages that were delayed (that is,
35814 not completely delivered at the first attempt), and the number that had at
35815 least one address that failed.
35816
35817 The remainder of the output is in sections that can be independently disabled
35818 or modified by various options. It consists of a summary of deliveries by
35819 transport, histograms of messages received and delivered per time interval
35820 (default per hour), information about the time messages spent on the queue,
35821 a list of relayed messages, lists of the top fifty sending hosts, local
35822 senders, destination hosts, and destination local users by count and by volume,
35823 and a list of delivery errors that occurred.
35824
35825 The relay information lists messages that were actually relayed, that is, they
35826 came from a remote host and were directly delivered to some other remote host,
35827 without being processed (for example, for aliasing or forwarding) locally.
35828
35829 There are quite a few options for &'eximstats'& to control exactly what it
35830 outputs. These are documented in the Perl script itself, and can be extracted
35831 by running the command &(perldoc)& on the script. For example:
35832 .code
35833 perldoc /usr/exim/bin/eximstats
35834 .endd
35835
35836 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35837 .cindex "&'exim_checkaccess'&"
35838 .cindex "policy control" "checking access"
35839 .cindex "checking access"
35840 The &%-bh%& command line argument allows you to run a fake SMTP session with
35841 debugging output, in order to check what Exim is doing when it is applying
35842 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35843 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35844 sometimes you just want to answer the question &"Does this address have
35845 access?"& without bothering with any further details.
35846
35847 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35848 two arguments, an IP address and an email address:
35849 .code
35850 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35851 .endd
35852 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35853 given email address would be accepted in a RCPT command in a TCP/IP
35854 connection from the host with the given IP address. The output of the utility
35855 is either the word &"accepted"&, or the SMTP error response, for example:
35856 .code
35857 Rejected:
35858 550 Relay not permitted
35859 .endd
35860 When running this test, the utility uses &`<>`& as the envelope sender address
35861 for the MAIL command, but you can change this by providing additional
35862 options. These are passed directly to the Exim command. For example, to specify
35863 that the test is to be run with the sender address &'himself@there.example'&
35864 you can use:
35865 .code
35866 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35867                  -f himself@there.example
35868 .endd
35869 Note that these additional Exim command line items must be given after the two
35870 mandatory arguments.
35871
35872 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35873 while running its checks. You can run checks that include callouts by using
35874 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35875
35876
35877
35878 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35879 .cindex "DBM" "building dbm files"
35880 .cindex "building DBM files"
35881 .cindex "&'exim_dbmbuild'&"
35882 .cindex "lower casing"
35883 .cindex "binary zero" "in lookup key"
35884 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35885 the format used by the &(lsearch)& lookup (see section
35886 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35887 names as keys and the remainder of the information as data. The lower-casing
35888 can be prevented by calling the program with the &%-nolc%& option.
35889
35890 A terminating zero is included as part of the key string. This is expected by
35891 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35892 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35893 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35894 files.
35895
35896 The program requires two arguments: the name of the input file (which can be a
35897 single hyphen to indicate the standard input), and the name of the output file.
35898 It creates the output under a temporary name, and then renames it if all went
35899 well.
35900
35901 .cindex "USE_DB"
35902 If the native DB interface is in use (USE_DB is set in a compile-time
35903 configuration file &-- this is common in free versions of Unix) the two file
35904 names must be different, because in this mode the Berkeley DB functions create
35905 a single output file using exactly the name given. For example,
35906 .code
35907 exim_dbmbuild /etc/aliases /etc/aliases.db
35908 .endd
35909 reads the system alias file and creates a DBM version of it in
35910 &_/etc/aliases.db_&.
35911
35912 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35913 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35914 environment, the suffixes are added to the second argument of
35915 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35916 when the Berkeley functions are used in compatibility mode (though this is not
35917 recommended), because in that case it adds a &_.db_& suffix to the file name.
35918
35919 If a duplicate key is encountered, the program outputs a warning, and when it
35920 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35921 option is used. By default, only the first of a set of duplicates is used &--
35922 this makes it compatible with &(lsearch)& lookups. There is an option
35923 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35924 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35925 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35926 return code is 2.
35927
35928
35929
35930
35931 .section "Finding individual retry times (exinext)" "SECTfinindret"
35932 .cindex "retry" "times"
35933 .cindex "&'exinext'&"
35934 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35935 fish specific information out of the retry database. Given a mail domain (or a
35936 complete address), it looks up the hosts for that domain, and outputs any retry
35937 information for the hosts or for the domain. At present, the retry information
35938 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35939 output. For example:
35940 .code
35941 $ exinext piglet@milne.fict.example
35942 kanga.milne.example:192.168.8.1 error 146: Connection refused
35943   first failed: 21-Feb-1996 14:57:34
35944   last tried:   21-Feb-1996 14:57:34
35945   next try at:  21-Feb-1996 15:02:34
35946 roo.milne.example:192.168.8.3 error 146: Connection refused
35947   first failed: 20-Jan-1996 13:12:08
35948   last tried:   21-Feb-1996 11:42:03
35949   next try at:  21-Feb-1996 19:42:03
35950   past final cutoff time
35951 .endd
35952 You can also give &'exinext'& a local part, without a domain, and it
35953 will give any retry information for that local part in your default domain.
35954 A message id can be used to obtain retry information pertaining to a specific
35955 message. This exists only when an attempt to deliver a message to a remote host
35956 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35957 &'exinext'& is not particularly efficient, but then it is not expected to be
35958 run very often.
35959
35960 The &'exinext'& utility calls Exim to find out information such as the location
35961 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35962 passed on to the &'exim'& commands. The first specifies an alternate Exim
35963 configuration file, and the second sets macros for use within the configuration
35964 file. These features are mainly to help in testing, but might also be useful in
35965 environments where more than one configuration file is in use.
35966
35967
35968
35969 .section "Hints database maintenance" "SECThindatmai"
35970 .cindex "hints database" "maintenance"
35971 .cindex "maintaining Exim's hints database"
35972 Three utility programs are provided for maintaining the DBM files that Exim
35973 uses to contain its delivery hint information. Each program requires two
35974 arguments. The first specifies the name of Exim's spool directory, and the
35975 second is the name of the database it is to operate on. These are as follows:
35976
35977 .ilist
35978 &'retry'&: the database of retry information
35979 .next
35980 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35981 for remote hosts
35982 .next
35983 &'callout'&: the callout cache
35984 .next
35985 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35986 .next
35987 &'misc'&: other hints data
35988 .endlist
35989
35990 The &'misc'& database is used for
35991
35992 .ilist
35993 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35994 .next
35995 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35996 &(smtp)& transport)
35997 .endlist
35998
35999
36000
36001 .section "exim_dumpdb" "SECID261"
36002 .cindex "&'exim_dumpdb'&"
36003 The entire contents of a database are written to the standard output by the
36004 &'exim_dumpdb'& program, which has no options or arguments other than the
36005 spool and database names. For example, to dump the retry database:
36006 .code
36007 exim_dumpdb /var/spool/exim retry
36008 .endd
36009 Two lines of output are produced for each entry:
36010 .code
36011 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36012 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36013 .endd
36014 The first item on the first line is the key of the record. It starts with one
36015 of the letters R, or T, depending on whether it refers to a routing or
36016 transport retry. For a local delivery, the next part is the local address; for
36017 a remote delivery it is the name of the remote host, followed by its failing IP
36018 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36019 transport). If the remote port is not the standard one (port 25), it is added
36020 to the IP address. Then there follows an error code, an additional error code,
36021 and a textual description of the error.
36022
36023 The three times on the second line are the time of first failure, the time of
36024 the last delivery attempt, and the computed time for the next attempt. The line
36025 ends with an asterisk if the cutoff time for the last retry rule has been
36026 exceeded.
36027
36028 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36029 consists of a host name followed by a list of ids for messages that are or were
36030 waiting to be delivered to that host. If there are a very large number for any
36031 one host, continuation records, with a sequence number added to the host name,
36032 may be seen. The data in these records is often out of date, because a message
36033 may be routed to several alternative hosts, and Exim makes no effort to keep
36034 cross-references.
36035
36036
36037
36038 .section "exim_tidydb" "SECID262"
36039 .cindex "&'exim_tidydb'&"
36040 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36041 database. If run with no options, it removes all records that are more than 30
36042 days old. The age is calculated from the date and time that the record was last
36043 updated. Note that, in the case of the retry database, it is &'not'& the time
36044 since the first delivery failure. Information about a host that has been down
36045 for more than 30 days will remain in the database, provided that the record is
36046 updated sufficiently often.
36047
36048 The cutoff date can be altered by means of the &%-t%& option, which must be
36049 followed by a time. For example, to remove all records older than a week from
36050 the retry database:
36051 .code
36052 exim_tidydb -t 7d /var/spool/exim retry
36053 .endd
36054 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36055 message ids. In the former these appear as data in records keyed by host &--
36056 they were messages that were waiting for that host &-- and in the latter they
36057 are the keys for retry information for messages that have suffered certain
36058 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36059 message ids in database records are those of messages that are still on the
36060 queue. Message ids for messages that no longer exist are removed from
36061 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36062 For the &'retry'& database, records whose keys are non-existent message ids are
36063 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36064 whenever it removes information from the database.
36065
36066 Certain records are automatically removed by Exim when they are no longer
36067 needed, but others are not. For example, if all the MX hosts for a domain are
36068 down, a retry record is created for each one. If the primary MX host comes back
36069 first, its record is removed when Exim successfully delivers to it, but the
36070 records for the others remain because Exim has not tried to use those hosts.
36071
36072 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36073 hints databases. You should do this at a quiet time of day, because it requires
36074 a database to be locked (and therefore inaccessible to Exim) while it does its
36075 work. Removing records from a DBM file does not normally make the file smaller,
36076 but all the common DBM libraries are able to re-use the space that is released.
36077 After an initial phase of increasing in size, the databases normally reach a
36078 point at which they no longer get any bigger, as long as they are regularly
36079 tidied.
36080
36081 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36082 databases is likely to keep on increasing.
36083
36084
36085
36086
36087 .section "exim_fixdb" "SECID263"
36088 .cindex "&'exim_fixdb'&"
36089 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36090 Its main use is for testing Exim, but it might also be occasionally useful for
36091 getting round problems in a live system. It has no options, and its interface
36092 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36093 key of a database record can then be entered, and the data for that record is
36094 displayed.
36095
36096 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36097 except the &'retry'& database, that is the only operation that can be carried
36098 out. For the &'retry'& database, each field is output preceded by a number, and
36099 data for individual fields can be changed by typing the field number followed
36100 by new data, for example:
36101 .code
36102 > 4 951102:1000
36103 .endd
36104 resets the time of the next delivery attempt. Time values are given as a
36105 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36106 used as optional separators.
36107
36108
36109
36110
36111 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36112 .cindex "mailbox" "maintenance"
36113 .cindex "&'exim_lock'&"
36114 .cindex "locking mailboxes"
36115 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36116 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36117 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36118 a user agent while investigating a problem. The utility requires the name of
36119 the file as its first argument. If the locking is successful, the second
36120 argument is run as a command (using C's &[system()]& function); if there is no
36121 second argument, the value of the SHELL environment variable is used; if this
36122 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36123 is unlocked and the utility ends. The following options are available:
36124
36125 .vlist
36126 .vitem &%-fcntl%&
36127 Use &[fcntl()]& locking on the open mailbox.
36128
36129 .vitem &%-flock%&
36130 Use &[flock()]& locking on the open mailbox, provided the operating system
36131 supports it.
36132
36133 .vitem &%-interval%&
36134 This must be followed by a number, which is a number of seconds; it sets the
36135 interval to sleep between retries (default 3).
36136
36137 .vitem &%-lockfile%&
36138 Create a lock file before opening the mailbox.
36139
36140 .vitem &%-mbx%&
36141 Lock the mailbox using MBX rules.
36142
36143 .vitem &%-q%&
36144 Suppress verification output.
36145
36146 .vitem &%-retries%&
36147 This must be followed by a number; it sets the number of times to try to get
36148 the lock (default 10).
36149
36150 .vitem &%-restore_time%&
36151 This option causes &%exim_lock%& to restore the modified and read times to the
36152 locked file before exiting. This allows you to access a locked mailbox (for
36153 example, to take a backup copy) without disturbing the times that the user
36154 subsequently sees.
36155
36156 .vitem &%-timeout%&
36157 This must be followed by a number, which is a number of seconds; it sets a
36158 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36159 default), a non-blocking call is used.
36160
36161 .vitem &%-v%&
36162 Generate verbose output.
36163 .endlist
36164
36165 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36166 default is to create a lock file and also to use &[fcntl()]& locking on the
36167 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36168 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36169 requires that the directory containing the file be writeable. Locking by lock
36170 file does not last for ever; Exim assumes that a lock file is expired if it is
36171 more than 30 minutes old.
36172
36173 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36174 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36175 to be taken out on the open mailbox, and an exclusive lock on the file
36176 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36177 number of the mailbox file. When the locking is released, if an exclusive lock
36178 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36179
36180 The default output contains verification of the locking that takes place. The
36181 &%-v%& option causes some additional information to be given. The &%-q%& option
36182 suppresses all output except error messages.
36183
36184 A command such as
36185 .code
36186 exim_lock /var/spool/mail/spqr
36187 .endd
36188 runs an interactive shell while the file is locked, whereas
36189 .display
36190 &`exim_lock -q /var/spool/mail/spqr <<End`&
36191 <&'some commands'&>
36192 &`End`&
36193 .endd
36194 runs a specific non-interactive sequence of commands while the file is locked,
36195 suppressing all verification output. A single command can be run by a command
36196 such as
36197 .code
36198 exim_lock -q /var/spool/mail/spqr \
36199   "cp /var/spool/mail/spqr /some/where"
36200 .endd
36201 Note that if a command is supplied, it must be entirely contained within the
36202 second argument &-- hence the quotes.
36203 .ecindex IIDutils
36204
36205
36206 . ////////////////////////////////////////////////////////////////////////////
36207 . ////////////////////////////////////////////////////////////////////////////
36208
36209 .chapter "The Exim monitor" "CHAPeximon"
36210 .scindex IIDeximon "Exim monitor" "description"
36211 .cindex "X-windows"
36212 .cindex "&'eximon'&"
36213 .cindex "Local/eximon.conf"
36214 .cindex "&_exim_monitor/EDITME_&"
36215 The Exim monitor is an application which displays in an X window information
36216 about the state of Exim's queue and what Exim is doing. An admin user can
36217 perform certain operations on messages from this GUI interface; however all
36218 such facilities are also available from the command line, and indeed, the
36219 monitor itself makes use of the command line to perform any actions requested.
36220
36221
36222
36223 .section "Running the monitor" "SECID264"
36224 The monitor is started by running the script called &'eximon'&. This is a shell
36225 script that sets up a number of environment variables, and then runs the
36226 binary called &_eximon.bin_&. The default appearance of the monitor window can
36227 be changed by editing the &_Local/eximon.conf_& file created by editing
36228 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36229 parameters are for.
36230
36231 The parameters that get built into the &'eximon'& script can be overridden for
36232 a particular invocation by setting up environment variables of the same names,
36233 preceded by &`EXIMON_`&. For example, a shell command such as
36234 .code
36235 EXIMON_LOG_DEPTH=400 eximon
36236 .endd
36237 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36238 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36239 overrides the Exim log file configuration. This makes it possible to have
36240 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36241 syslog messages are routed to a file on the local host.
36242
36243 X resources can be used to change the appearance of the window in the normal
36244 way. For example, a resource setting of the form
36245 .code
36246 Eximon*background: gray94
36247 .endd
36248 changes the colour of the background to light grey rather than white. The
36249 stripcharts are drawn with both the data lines and the reference lines in
36250 black. This means that the reference lines are not visible when on top of the
36251 data. However, their colour can be changed by setting a resource called
36252 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36253 For example, if your X server is running Unix, you could set up lighter
36254 reference lines in the stripcharts by obeying
36255 .code
36256 xrdb -merge <<End
36257 Eximon*highlight: gray
36258 End
36259 .endd
36260 .cindex "admin user"
36261 In order to see the contents of messages on the queue, and to operate on them,
36262 &'eximon'& must either be run as root or by an admin user.
36263
36264 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36265 contain X11 resource parameters interpreted by the X11 library.  In addition,
36266 if the first parameter starts with the string "gdb" then it is removed and the
36267 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36268 versioned variants of gdb can be invoked).
36269
36270 The monitor's window is divided into three parts. The first contains one or
36271 more stripcharts and two action buttons, the second contains a &"tail"& of the
36272 main log file, and the third is a display of the queue of messages awaiting
36273 delivery, with two more action buttons. The following sections describe these
36274 different parts of the display.
36275
36276
36277
36278
36279 .section "The stripcharts" "SECID265"
36280 .cindex "stripchart"
36281 The first stripchart is always a count of messages on the queue. Its name can
36282 be configured by setting QUEUE_STRIPCHART_NAME in the
36283 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36284 configuration script by regular expression matches on log file entries, making
36285 it possible to display, for example, counts of messages delivered to certain
36286 hosts or using certain transports. The supplied defaults display counts of
36287 received and delivered messages, and of local and SMTP deliveries. The default
36288 period between stripchart updates is one minute; this can be adjusted by a
36289 parameter in the &_Local/eximon.conf_& file.
36290
36291 The stripchart displays rescale themselves automatically as the value they are
36292 displaying changes. There are always 10 horizontal lines in each chart; the
36293 title string indicates the value of each division when it is greater than one.
36294 For example, &"x2"& means that each division represents a value of 2.
36295
36296 It is also possible to have a stripchart which shows the percentage fullness of
36297 a particular disk partition, which is useful when local deliveries are confined
36298 to a single partition.
36299
36300 .cindex "&%statvfs%& function"
36301 This relies on the availability of the &[statvfs()]& function or equivalent in
36302 the operating system. Most, but not all versions of Unix that support Exim have
36303 this. For this particular stripchart, the top of the chart always represents
36304 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36305 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36306 &_Local/eximon.conf_& file.
36307
36308
36309
36310
36311 .section "Main action buttons" "SECID266"
36312 .cindex "size" "of monitor window"
36313 .cindex "Exim monitor" "window size"
36314 .cindex "window size"
36315 Below the stripcharts there is an action button for quitting the monitor. Next
36316 to this is another button marked &"Size"&. They are placed here so that
36317 shrinking the window to its default minimum size leaves just the queue count
36318 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36319 the window to expand to its maximum size, unless it is already at the maximum,
36320 in which case it is reduced to its minimum.
36321
36322 When expanding to the maximum, if the window cannot be fully seen where it
36323 currently is, it is moved back to where it was the last time it was at full
36324 size. When it is expanding from its minimum size, the old position is
36325 remembered, and next time it is reduced to the minimum it is moved back there.
36326
36327 The idea is that you can keep a reduced window just showing one or two
36328 stripcharts at a convenient place on your screen, easily expand it to show
36329 the full window when required, and just as easily put it back to what it was.
36330 The idea is copied from what the &'twm'& window manager does for its
36331 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36332 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36333
36334 Normally, the monitor starts up with the window at its full size, but it can be
36335 built so that it starts up with the window at its smallest size, by setting
36336 START_SMALL=yes in &_Local/eximon.conf_&.
36337
36338
36339
36340 .section "The log display" "SECID267"
36341 .cindex "log" "tail of; in monitor"
36342 The second section of the window is an area in which a display of the tail of
36343 the main log is maintained.
36344 To save space on the screen, the timestamp on each log line is shortened by
36345 removing the date and, if &%log_timezone%& is set, the timezone.
36346 The log tail is not available when the only destination for logging data is
36347 syslog, unless the syslog lines are routed to a local file whose name is passed
36348 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36349
36350 The log sub-window has a scroll bar at its lefthand side which can be used to
36351 move back to look at earlier text, and the up and down arrow keys also have a
36352 scrolling effect. The amount of log that is kept depends on the setting of
36353 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36354 to use. When this is full, the earlier 50% of data is discarded &-- this is
36355 much more efficient than throwing it away line by line. The sub-window also has
36356 a horizontal scroll bar for accessing the ends of long log lines. This is the
36357 only means of horizontal scrolling; the right and left arrow keys are not
36358 available. Text can be cut from this part of the window using the mouse in the
36359 normal way. The size of this subwindow is controlled by parameters in the
36360 configuration file &_Local/eximon.conf_&.
36361
36362 Searches of the text in the log window can be carried out by means of the ^R
36363 and ^S keystrokes, which default to a reverse and a forward search,
36364 respectively. The search covers only the text that is displayed in the window.
36365 It cannot go further back up the log.
36366
36367 The point from which the search starts is indicated by a caret marker. This is
36368 normally at the end of the text in the window, but can be positioned explicitly
36369 by pointing and clicking with the left mouse button, and is moved automatically
36370 by a successful search. If new text arrives in the window when it is scrolled
36371 back, the caret remains where it is, but if the window is not scrolled back,
36372 the caret is moved to the end of the new text.
36373
36374 Pressing ^R or ^S pops up a window into which the search text can be typed.
36375 There are buttons for selecting forward or reverse searching, for carrying out
36376 the search, and for cancelling. If the &"Search"& button is pressed, the search
36377 happens and the window remains so that further searches can be done. If the
36378 &"Return"& key is pressed, a single search is done and the window is closed. If
36379 ^C is typed the search is cancelled.
36380
36381 The searching facility is implemented using the facilities of the Athena text
36382 widget. By default this pops up a window containing both &"search"& and
36383 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36384 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36385 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36386 provided version of &%TextPop%& when the remaining parts of the text widget
36387 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36388 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36389 on these systems, at the expense of having unwanted items in the search popup
36390 window.
36391
36392
36393
36394 .section "The queue display" "SECID268"
36395 .cindex "queue" "display in monitor"
36396 The bottom section of the monitor window contains a list of all messages that
36397 are on the queue, which includes those currently being received or delivered,
36398 as well as those awaiting delivery. The size of this subwindow is controlled by
36399 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36400 at which it is updated is controlled by another parameter in the same file &--
36401 the default is 5 minutes, since queue scans can be quite expensive. However,
36402 there is an &"Update"& action button just above the display which can be used
36403 to force an update of the queue display at any time.
36404
36405 When a host is down for some time, a lot of pending mail can build up for it,
36406 and this can make it hard to deal with other messages on the queue. To help
36407 with this situation there is a button next to &"Update"& called &"Hide"&. If
36408 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36409 type anything in here and press &"Return"&, the text is added to a chain of
36410 such texts, and if every undelivered address in a message matches at least one
36411 of the texts, the message is not displayed.
36412
36413 If there is an address that does not match any of the texts, all the addresses
36414 are displayed as normal. The matching happens on the ends of addresses so, for
36415 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36416 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36417 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36418 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36419 a hide request is automatically cancelled after one hour.
36420
36421 While the dialogue box is displayed, you can't press any buttons or do anything
36422 else to the monitor window. For this reason, if you want to cut text from the
36423 queue display to use in the dialogue box, you have to do the cutting before
36424 pressing the &"Hide"& button.
36425
36426 The queue display contains, for each unhidden queued message, the length of
36427 time it has been on the queue, the size of the message, the message id, the
36428 message sender, and the first undelivered recipient, all on one line. If it is
36429 a bounce message, the sender is shown as &"<>"&. If there is more than one
36430 recipient to which the message has not yet been delivered, subsequent ones are
36431 listed on additional lines, up to a maximum configured number, following which
36432 an ellipsis is displayed. Recipients that have already received the message are
36433 not shown.
36434
36435 .cindex "frozen messages" "display"
36436 If a message is frozen, an asterisk is displayed at the left-hand side.
36437
36438 The queue display has a vertical scroll bar, and can also be scrolled by means
36439 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36440 The text searching facilities, as described above for the log window, are also
36441 available, but the caret is always moved to the end of the text when the queue
36442 display is updated.
36443
36444
36445
36446 .section "The queue menu" "SECID269"
36447 .cindex "queue" "menu in monitor"
36448 If the &%shift%& key is held down and the left button is clicked when the mouse
36449 pointer is over the text for any message, an action menu pops up, and the first
36450 line of the queue display for the message is highlighted. This does not affect
36451 any selected text.
36452
36453 If you want to use some other event for popping up the menu, you can set the
36454 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36455 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36456 value set in this parameter is a standard X event description. For example, to
36457 run eximon using &%ctrl%& rather than &%shift%& you could use
36458 .code
36459 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36460 .endd
36461 The title of the menu is the message id, and it contains entries which act as
36462 follows:
36463
36464 .ilist
36465 &'message log'&: The contents of the message log for the message are displayed
36466 in a new text window.
36467 .next
36468 &'headers'&: Information from the spool file that contains the envelope
36469 information and headers is displayed in a new text window. See chapter
36470 &<<CHAPspool>>& for a description of the format of spool files.
36471 .next
36472 &'body'&: The contents of the spool file containing the body of the message are
36473 displayed in a new text window. There is a default limit of 20,000 bytes to the
36474 amount of data displayed. This can be changed by setting the BODY_MAX
36475 option at compile time, or the EXIMON_BODY_MAX option at run time.
36476 .next
36477 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36478 delivery of the message. This causes an automatic thaw if the message is
36479 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36480 a new text window. The delivery is run in a separate process, to avoid holding
36481 up the monitor while the delivery proceeds.
36482 .next
36483 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36484 that the message be frozen.
36485 .next
36486 .cindex "thawing messages"
36487 .cindex "unfreezing messages"
36488 .cindex "frozen messages" "thawing"
36489 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36490 that the message be thawed.
36491 .next
36492 .cindex "delivery" "forcing failure"
36493 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36494 that Exim gives up trying to deliver the message. A bounce message is generated
36495 for any remaining undelivered addresses.
36496 .next
36497 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36498 that the message be deleted from the system without generating a bounce
36499 message.
36500 .next
36501 &'add recipient'&: A dialog box is displayed into which a recipient address can
36502 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36503 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36504 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36505 causes a call to Exim to be made using the &%-Mar%& option to request that an
36506 additional recipient be added to the message, unless the entry box is empty, in
36507 which case no action is taken.
36508 .next
36509 &'mark delivered'&: A dialog box is displayed into which a recipient address
36510 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36511 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36512 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36513 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36514 recipient address as already delivered, unless the entry box is empty, in which
36515 case no action is taken.
36516 .next
36517 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36518 mark all recipient addresses as already delivered.
36519 .next
36520 &'edit sender'&: A dialog box is displayed initialized with the current
36521 sender's address. Pressing RETURN causes a call to Exim to be made using the
36522 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36523 in which case no action is taken. If you want to set an empty sender (as in
36524 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36525 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36526 the address is qualified with that domain.
36527 .endlist
36528
36529 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36530 other cases when a call to Exim is made, if there is any output from Exim (in
36531 particular, if the command fails) a window containing the command and the
36532 output is displayed. Otherwise, the results of the action are normally apparent
36533 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36534 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36535 if no output is generated.
36536
36537 The queue display is automatically updated for actions such as freezing and
36538 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36539 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36540 force an update of the display after one of these actions.
36541
36542 In any text window that is displayed as result of a menu action, the normal
36543 cut-and-paste facility is available, and searching can be carried out using ^R
36544 and ^S, as described above for the log tail window.
36545 .ecindex IIDeximon
36546
36547
36548
36549
36550
36551 . ////////////////////////////////////////////////////////////////////////////
36552 . ////////////////////////////////////////////////////////////////////////////
36553
36554 .chapter "Security considerations" "CHAPsecurity"
36555 .scindex IIDsecurcon "security" "discussion of"
36556 This chapter discusses a number of issues concerned with security, some of
36557 which are also covered in other parts of this manual.
36558
36559 For reasons that this author does not understand, some people have promoted
36560 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36561 existence of this chapter in the documentation. However, the intent of the
36562 chapter is simply to describe the way Exim works in relation to certain
36563 security concerns, not to make any specific claims about the effectiveness of
36564 its security as compared with other MTAs.
36565
36566 What follows is a description of the way Exim is supposed to be. Best efforts
36567 have been made to try to ensure that the code agrees with the theory, but an
36568 absence of bugs can never be guaranteed. Any that are reported will get fixed
36569 as soon as possible.
36570
36571
36572 .section "Building a more &""hardened""& Exim" "SECID286"
36573 .cindex "security" "build-time features"
36574 There are a number of build-time options that can be set in &_Local/Makefile_&
36575 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36576 Exim administrator who does not have the root password, or by someone who has
36577 penetrated the Exim (but not the root) account. These options are as follows:
36578
36579 .ilist
36580 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36581 start of any file names used with the &%-C%& option. When it is set, these file
36582 names are also not allowed to contain the sequence &"/../"&. (However, if the
36583 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36584 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36585 default setting for &%ALT_CONFIG_PREFIX%&.
36586
36587 If the permitted configuration files are confined to a directory to
36588 which only root has access, this guards against someone who has broken
36589 into the Exim account from running a privileged Exim with an arbitrary
36590 configuration file, and using it to break into other accounts.
36591 .next
36592
36593 If a non-trusted configuration file (i.e. not the default configuration file
36594 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36595 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36596 the next item), then root privilege is retained only if the caller of Exim is
36597 root. This locks out the possibility of testing a configuration using &%-C%&
36598 right through message reception and delivery, even if the caller is root. The
36599 reception works, but by that time, Exim is running as the Exim user, so when
36600 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36601 privilege to be lost. However, root can test reception and delivery using two
36602 separate commands.
36603
36604 .next
36605 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36606 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36607 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36608 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36609 the restrictive side.  Requiring build-time selection of safe macros is onerous
36610 but this option is intended solely as a transition mechanism to permit
36611 previously-working configurations to continue to work after release 4.73.
36612 .next
36613 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36614 is disabled.
36615 .next
36616 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36617 never to be used for any deliveries. This is like the &%never_users%& runtime
36618 option, but it cannot be overridden; the runtime option adds additional users
36619 to the list. The default setting is &"root"&; this prevents a non-root user who
36620 is permitted to modify the runtime file from using Exim as a way to get root.
36621 .endlist
36622
36623
36624
36625 .section "Root privilege" "SECID270"
36626 .cindex "setuid"
36627 .cindex "root privilege"
36628 The Exim binary is normally setuid to root, which means that it gains root
36629 privilege (runs as root) when it starts execution. In some special cases (for
36630 example, when the daemon is not in use and there are no local deliveries), it
36631 may be possible to run Exim setuid to some user other than root. This is
36632 discussed in the next section. However, in most installations, root privilege
36633 is required for two things:
36634
36635 .ilist
36636 To set up a socket connected to the standard SMTP port (25) when initialising
36637 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36638 not required.
36639 .next
36640 To be able to change uid and gid in order to read users' &_.forward_& files and
36641 perform local deliveries as the receiving user or as specified in the
36642 configuration.
36643 .endlist
36644
36645 It is not necessary to be root to do any of the other things Exim does, such as
36646 receiving messages and delivering them externally over SMTP, and it is
36647 obviously more secure if Exim does not run as root except when necessary.
36648 For this reason, a user and group for Exim to use must be defined in
36649 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36650 group"&. Their values can be changed by the run time configuration, though this
36651 is not recommended. Often a user called &'exim'& is used, but some sites use
36652 &'mail'& or another user name altogether.
36653
36654 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36655 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36656 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36657
36658 After a new Exim process has interpreted its command line options, it changes
36659 uid and gid in the following cases:
36660
36661 .ilist
36662 .oindex "&%-C%&"
36663 .oindex "&%-D%&"
36664 If the &%-C%& option is used to specify an alternate configuration file, or if
36665 the &%-D%& option is used to define macro values for the configuration, and the
36666 calling process is not running as root, the uid and gid are changed to those of
36667 the calling process.
36668 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36669 option may not be used at all.
36670 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36671 can be supplied if the calling process is running as root, the Exim run-time
36672 user or CONFIGURE_OWNER, if defined.
36673 .next
36674 .oindex "&%-be%&"
36675 .oindex "&%-bf%&"
36676 .oindex "&%-bF%&"
36677 If the expansion test option (&%-be%&) or one of the filter testing options
36678 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36679 calling process.
36680 .next
36681 If the process is not a daemon process or a queue runner process or a delivery
36682 process or a process for testing address routing (started with &%-bt%&), the
36683 uid and gid are changed to the Exim user and group. This means that Exim always
36684 runs under its own uid and gid when receiving messages. This also applies when
36685 testing address verification
36686 .oindex "&%-bv%&"
36687 .oindex "&%-bh%&"
36688 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36689 option).
36690 .next
36691 For a daemon, queue runner, delivery, or address testing process, the uid
36692 remains as root at this stage, but the gid is changed to the Exim group.
36693 .endlist
36694
36695 The processes that initially retain root privilege behave as follows:
36696
36697 .ilist
36698 A daemon process changes the gid to the Exim group and the uid to the Exim
36699 user after setting up one or more listening sockets. The &[initgroups()]&
36700 function is called, so that if the Exim user is in any additional groups, they
36701 will be used during message reception.
36702 .next
36703 A queue runner process retains root privilege throughout its execution. Its
36704 job is to fork a controlled sequence of delivery processes.
36705 .next
36706 A delivery process retains root privilege throughout most of its execution,
36707 but any actual deliveries (that is, the transports themselves) are run in
36708 subprocesses which always change to a non-root uid and gid. For local
36709 deliveries this is typically the uid and gid of the owner of the mailbox; for
36710 remote deliveries, the Exim uid and gid are used. Once all the delivery
36711 subprocesses have been run, a delivery process changes to the Exim uid and gid
36712 while doing post-delivery tidying up such as updating the retry database and
36713 generating bounce and warning messages.
36714
36715 While the recipient addresses in a message are being routed, the delivery
36716 process runs as root. However, if a user's filter file has to be processed,
36717 this is done in a subprocess that runs under the individual user's uid and
36718 gid. A system filter is run as root unless &%system_filter_user%& is set.
36719 .next
36720 A process that is testing addresses (the &%-bt%& option) runs as root so that
36721 the routing is done in the same environment as a message delivery.
36722 .endlist
36723
36724
36725
36726
36727 .section "Running Exim without privilege" "SECTrunexiwitpri"
36728 .cindex "privilege, running without"
36729 .cindex "unprivileged running"
36730 .cindex "root privilege" "running without"
36731 Some installations like to run Exim in an unprivileged state for more of its
36732 operation, for added security. Support for this mode of operation is provided
36733 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36734 gid are changed to the Exim user and group at the start of a delivery process
36735 (and also queue runner and address testing processes). This means that address
36736 routing is no longer run as root, and the deliveries themselves cannot change
36737 to any other uid.
36738
36739 .cindex SIGHUP
36740 .cindex "daemon" "restarting"
36741 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36742 that the daemon can still be started in the usual way, and it can respond
36743 correctly to SIGHUP because the re-invocation regains root privilege.
36744
36745 An alternative approach is to make Exim setuid to the Exim user and also setgid
36746 to the Exim group. If you do this, the daemon must be started from a root
36747 process. (Calling Exim from a root process makes it behave in the way it does
36748 when it is setuid root.) However, the daemon cannot restart itself after a
36749 SIGHUP signal because it cannot regain privilege.
36750
36751 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36752 stops Exim from trying to re-invoke itself to do a delivery after a message has
36753 been received. Such a re-invocation is a waste of resources because it has no
36754 effect.
36755
36756 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36757 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36758 to the Exim user seems a clean approach, but there is one complication:
36759
36760 In this style of operation, Exim is running with the real uid and gid set to
36761 those of the calling process, and the effective uid/gid set to Exim's values.
36762 Ideally, any association with the calling process' uid/gid should be dropped,
36763 that is, the real uid/gid should be reset to the effective values so as to
36764 discard any privileges that the caller may have. While some operating systems
36765 have a function that permits this action for a non-root effective uid, quite a
36766 number of them do not. Because of this lack of standardization, Exim does not
36767 address this problem at this time.
36768
36769 For this reason, the recommended approach for &"mostly unprivileged"& running
36770 is to keep the Exim binary setuid to root, and to set
36771 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36772 be used in the most straightforward way.
36773
36774 If you configure Exim not to run delivery processes as root, there are a
36775 number of restrictions on what you can do:
36776
36777 .ilist
36778 You can deliver only as the Exim user/group. You should  explicitly use the
36779 &%user%& and &%group%& options to override routers or local transports that
36780 normally deliver as the recipient. This makes sure that configurations that
36781 work in this mode function the same way in normal mode. Any implicit or
36782 explicit specification of another user causes an error.
36783 .next
36784 Use of &_.forward_& files is severely restricted, such that it is usually
36785 not worthwhile to include them in the configuration.
36786 .next
36787 Users who wish to use &_.forward_& would have to make their home directory and
36788 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36789 and their equivalents in Exim filters, cannot be used. While they could be
36790 enabled in the Exim user's name, that would be insecure and not very useful.
36791 .next
36792 Unless the local user mailboxes are all owned by the Exim user (possible in
36793 some POP3 or IMAP-only environments):
36794
36795 .olist
36796 They must be owned by the Exim group and be writeable by that group. This
36797 implies you must set &%mode%& in the appendfile configuration, as well as the
36798 mode of the mailbox files themselves.
36799 .next
36800 You must set &%no_check_owner%&, since most or all of the files will not be
36801 owned by the Exim user.
36802 .next
36803 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36804 on a newly created mailbox when unprivileged. This also implies that new
36805 mailboxes need to be created manually.
36806 .endlist olist
36807 .endlist ilist
36808
36809
36810 These restrictions severely restrict what can be done in local deliveries.
36811 However, there are no restrictions on remote deliveries. If you are running a
36812 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36813 gives more security at essentially no cost.
36814
36815 If you are using the &%mua_wrapper%& facility (see chapter
36816 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36817
36818
36819
36820
36821 .section "Delivering to local files" "SECID271"
36822 Full details of the checks applied by &(appendfile)& before it writes to a file
36823 are given in chapter &<<CHAPappendfile>>&.
36824
36825
36826
36827 .section "Running local commands" "SECTsecconslocalcmds"
36828 .cindex "security" "local commands"
36829 .cindex "security" "command injection attacks"
36830 There are a number of ways in which an administrator can configure Exim to run
36831 commands based upon received, untrustworthy, data. Further, in some
36832 configurations a user who can control a &_.forward_& file can also arrange to
36833 run commands. Configuration to check includes, but is not limited to:
36834
36835 .ilist
36836 Use of &%use_shell%& in the pipe transport: various forms of shell command
36837 injection may be possible with this option present. It is dangerous and should
36838 be used only with considerable caution. Consider constraints which whitelist
36839 allowed characters in a variable which is to be used in a pipe transport that
36840 has &%use_shell%& enabled.
36841 .next
36842 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36843 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36844 &_.forward_& files in a redirect router. If Exim is running on a central mail
36845 hub to which ordinary users do not have shell access, but home directories are
36846 NFS mounted (for instance) then administrators should review the list of these
36847 forbid options available, and should bear in mind that the options that may
36848 need forbidding can change as new features are added between releases.
36849 .next
36850 The &%${run...}%& expansion item does not use a shell by default, but
36851 administrators can configure use of &_/bin/sh_& as part of the command.
36852 Such invocations should be viewed with prejudicial suspicion.
36853 .next
36854 Administrators who use embedded Perl are advised to explore how Perl's
36855 taint checking might apply to their usage.
36856 .next
36857 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36858 administrators are well advised to view its use with suspicion, in case (for
36859 instance) it allows a local-part to contain embedded Exim directives.
36860 .next
36861 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36862 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36863 each can reference arbitrary lists and files, rather than just being a list
36864 of opaque strings.
36865 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36866 real-world security vulnerabilities caused by its use with untrustworthy data
36867 injected in, for SQL injection attacks.
36868 Consider the use of the &%inlisti%& expansion condition instead.
36869 .endlist
36870
36871
36872
36873
36874 .section "Trust in configuration data" "SECTsecconfdata"
36875 .cindex "security" "data sources"
36876 .cindex "security" "regular expressions"
36877 .cindex "regular expressions" "security"
36878 .cindex "PCRE" "security"
36879 If configuration data for Exim can come from untrustworthy sources, there
36880 are some issues to be aware of:
36881
36882 .ilist
36883 Use of &%${expand...}%& may provide a path for shell injection attacks.
36884 .next
36885 Letting untrusted data provide a regular expression is unwise.
36886 .next
36887 Using &%${match...}%& to apply a fixed regular expression against untrusted
36888 data may result in pathological behaviour within PCRE.  Be aware of what
36889 "backtracking" means and consider options for being more strict with a regular
36890 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36891 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36892 possessive quantifiers or just not using regular expressions against untrusted
36893 data.
36894 .next
36895 It can be important to correctly use &%${quote:...}%&,
36896 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36897 items to ensure that data is correctly constructed.
36898 .next
36899 Some lookups might return multiple results, even though normal usage is only
36900 expected to yield one result.
36901 .endlist
36902
36903
36904
36905
36906 .section "IPv4 source routing" "SECID272"
36907 .cindex "source routing" "in IP packets"
36908 .cindex "IP source routing"
36909 Many operating systems suppress IP source-routed packets in the kernel, but
36910 some cannot be made to do this, so Exim does its own check. It logs incoming
36911 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36912 IPv6. No special checking is currently done.
36913
36914
36915
36916 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36917 Support for these SMTP commands is disabled by default. If required, they can
36918 be enabled by defining suitable ACLs.
36919
36920
36921
36922
36923 .section "Privileged users" "SECID274"
36924 .cindex "trusted users"
36925 .cindex "admin user"
36926 .cindex "privileged user"
36927 .cindex "user" "trusted"
36928 .cindex "user" "admin"
36929 Exim recognizes two sets of users with special privileges. Trusted users are
36930 able to submit new messages to Exim locally, but supply their own sender
36931 addresses and information about a sending host. For other users submitting
36932 local messages, Exim sets up the sender address from the uid, and doesn't
36933 permit a remote host to be specified.
36934
36935 .oindex "&%-f%&"
36936 However, an untrusted user is permitted to use the &%-f%& command line option
36937 in the special form &%-f <>%& to indicate that a delivery failure for the
36938 message should not cause an error report. This affects the message's envelope,
36939 but it does not affect the &'Sender:'& header. Untrusted users may also be
36940 permitted to use specific forms of address with the &%-f%& option by setting
36941 the &%untrusted_set_sender%& option.
36942
36943 Trusted users are used to run processes that receive mail messages from some
36944 other mail domain and pass them on to Exim for delivery either locally, or over
36945 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36946 as any user listed in the &%trusted_users%& configuration option, or under any
36947 group listed in the &%trusted_groups%& option.
36948
36949 Admin users are permitted to do things to the messages on Exim's queue. They
36950 can freeze or thaw messages, cause them to be returned to their senders, remove
36951 them entirely, or modify them in various ways. In addition, admin users can run
36952 the Exim monitor and see all the information it is capable of providing, which
36953 includes the contents of files on the spool.
36954
36955 .oindex "&%-M%&"
36956 .oindex "&%-q%&"
36957 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36958 delivery of messages on its queue is restricted to admin users. This
36959 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36960 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36961 queue is also restricted to admin users. This restriction can be relaxed by
36962 setting &%no_queue_list_requires_admin%&.
36963
36964 Exim recognizes an admin user if the calling process is running as root or as
36965 the Exim user or if any of the groups associated with the calling process is
36966 the Exim group. It is not necessary actually to be running under the Exim
36967 group. However, if admin users who are not root or the Exim user are to access
36968 the contents of files on the spool via the Exim monitor (which runs
36969 unprivileged), Exim must be built to allow group read access to its spool
36970 files.
36971
36972
36973
36974 .section "Spool files" "SECID275"
36975 .cindex "spool directory" "files"
36976 Exim's spool directory and everything it contains is owned by the Exim user and
36977 set to the Exim group. The mode for spool files is defined in the
36978 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36979 any user who is a member of the Exim group can access these files.
36980
36981
36982
36983 .section "Use of argv[0]" "SECID276"
36984 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36985 of specific strings, Exim assumes certain options. For example, calling Exim
36986 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36987 to calling it with the option &%-bS%&. There are no security implications in
36988 this.
36989
36990
36991
36992 .section "Use of %f formatting" "SECID277"
36993 The only use made of &"%f"& by Exim is in formatting load average values. These
36994 are actually stored in integer variables as 1000 times the load average.
36995 Consequently, their range is limited and so therefore is the length of the
36996 converted output.
36997
36998
36999
37000 .section "Embedded Exim path" "SECID278"
37001 Exim uses its own path name, which is embedded in the code, only when it needs
37002 to re-exec in order to regain root privilege. Therefore, it is not root when it
37003 does so. If some bug allowed the path to get overwritten, it would lead to an
37004 arbitrary program's being run as exim, not as root.
37005
37006
37007
37008 .section "Dynamic module directory" "SECTdynmoddir"
37009 Any dynamically loadable modules must be installed into the directory
37010 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37011 loading it.
37012
37013
37014 .section "Use of sprintf()" "SECID279"
37015 .cindex "&[sprintf()]&"
37016 A large number of occurrences of &"sprintf"& in the code are actually calls to
37017 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37018 The intermediate formatting is done into a large fixed buffer by a function
37019 that runs through the format string itself, and checks the length of each
37020 conversion before performing it, thus preventing buffer overruns.
37021
37022 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37023 the output buffer is known to be sufficiently long to contain the converted
37024 string.
37025
37026
37027
37028 .section "Use of debug_printf() and log_write()" "SECID280"
37029 Arbitrary strings are passed to both these functions, but they do their
37030 formatting by calling the function &'string_vformat()'&, which runs through
37031 the format string itself, and checks the length of each conversion.
37032
37033
37034
37035 .section "Use of strcat() and strcpy()" "SECID281"
37036 These are used only in cases where the output buffer is known to be large
37037 enough to hold the result.
37038 .ecindex IIDsecurcon
37039
37040
37041
37042
37043 . ////////////////////////////////////////////////////////////////////////////
37044 . ////////////////////////////////////////////////////////////////////////////
37045
37046 .chapter "Format of spool files" "CHAPspool"
37047 .scindex IIDforspo1 "format" "spool files"
37048 .scindex IIDforspo2 "spool directory" "format of files"
37049 .scindex IIDforspo3 "spool files" "format of"
37050 .cindex "spool files" "editing"
37051 A message on Exim's queue consists of two files, whose names are the message id
37052 followed by -D and -H, respectively. The data portion of the message is kept in
37053 the -D file on its own. The message's envelope, status, and headers are all
37054 kept in the -H file, whose format is described in this chapter. Each of these
37055 two files contains the final component of its own name as its first line. This
37056 is insurance against disk crashes where the directory is lost but the files
37057 themselves are recoverable.
37058
37059 Some people are tempted into editing -D files in order to modify messages. You
37060 need to be extremely careful if you do this; it is not recommended and you are
37061 on your own if you do it. Here are some of the pitfalls:
37062
37063 .ilist
37064 You must ensure that Exim does not try to deliver the message while you are
37065 fiddling with it. The safest way is to take out a write lock on the -D file,
37066 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37067 place, the lock will be retained. If you write a new file and rename it, the
37068 lock will be lost at the instant of rename.
37069 .next
37070 .vindex "&$body_linecount$&"
37071 If you change the number of lines in the file, the value of
37072 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37073 present, this value is not used by Exim, but there is no guarantee that this
37074 will always be the case.
37075 .next
37076 If the message is in MIME format, you must take care not to break it.
37077 .next
37078 If the message is cryptographically signed, any change will invalidate the
37079 signature.
37080 .endlist
37081 All in all, modifying -D files is fraught with danger.
37082
37083 Files whose names end with -J may also be seen in the &_input_& directory (or
37084 its subdirectories when &%split_spool_directory%& is set). These are journal
37085 files, used to record addresses to which the message has been delivered during
37086 the course of a delivery attempt. If there are still undelivered recipients at
37087 the end, the -H file is updated, and the -J file is deleted. If, however, there
37088 is some kind of crash (for example, a power outage) before this happens, the -J
37089 file remains in existence. When Exim next processes the message, it notices the
37090 -J file and uses it to update the -H file before starting the next delivery
37091 attempt.
37092
37093 .section "Format of the -H file" "SECID282"
37094 .cindex "uid (user id)" "in spool file"
37095 .cindex "gid (group id)" "in spool file"
37096 The second line of the -H file contains the login name for the uid of the
37097 process that called Exim to read the message, followed by the numerical uid and
37098 gid. For a locally generated message, this is normally the user who sent the
37099 message. For a message received over TCP/IP via the daemon, it is
37100 normally the Exim user.
37101
37102 The third line of the file contains the address of the message's sender as
37103 transmitted in the envelope, contained in angle brackets. The sender address is
37104 empty for bounce messages. For incoming SMTP mail, the sender address is given
37105 in the MAIL command. For locally generated mail, the sender address is
37106 created by Exim from the login name of the current user and the configured
37107 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37108 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37109 &"<>"& or an address that matches &%untrusted_set_senders%&.
37110
37111 The fourth line contains two numbers. The first is the time that the message
37112 was received, in the conventional Unix form &-- the number of seconds since the
37113 start of the epoch. The second number is a count of the number of messages
37114 warning of delayed delivery that have been sent to the sender.
37115
37116 There follow a number of lines starting with a hyphen. These can appear in any
37117 order, and are omitted when not relevant:
37118
37119 .vlist
37120 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37121 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37122 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37123 recognized, to provide backward compatibility. In the old format, a line of
37124 this form is present for every ACL variable that is not empty. The number
37125 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37126 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37127 the data string for the variable. The string itself starts at the beginning of
37128 the next line, and is followed by a newline character. It may contain internal
37129 newlines.
37130
37131 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37132 A line of this form is present for every ACL connection variable that is
37133 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37134 The length is the length of the data string for the variable. The string itself
37135 starts at the beginning of the next line, and is followed by a newline
37136 character. It may contain internal newlines.
37137
37138 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37139 A line of this form is present for every ACL message variable that is defined.
37140 Note that there is a space between &%-aclm%& and the rest of the name. The
37141 length is the length of the data string for the variable. The string itself
37142 starts at the beginning of the next line, and is followed by a newline
37143 character. It may contain internal newlines.
37144
37145 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37146 This is present if, when the message was received over SMTP, the value of
37147 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37148
37149 .vitem &%-allow_unqualified_recipient%&
37150 This is present if unqualified recipient addresses are permitted in header
37151 lines (to stop such addresses from being qualified if rewriting occurs at
37152 transport time). Local messages that were input using &%-bnq%& and remote
37153 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37154
37155 .vitem &%-allow_unqualified_sender%&
37156 This is present if unqualified sender addresses are permitted in header lines
37157 (to stop such addresses from being qualified if rewriting occurs at transport
37158 time). Local messages that were input using &%-bnq%& and remote messages from
37159 hosts that match &%sender_unqualified_hosts%& set this flag.
37160
37161 .vitem "&%-auth_id%&&~<&'text'&>"
37162 The id information for a message received on an authenticated SMTP connection
37163 &-- the value of the &$authenticated_id$& variable.
37164
37165 .vitem "&%-auth_sender%&&~<&'address'&>"
37166 The address of an authenticated sender &-- the value of the
37167 &$authenticated_sender$& variable.
37168
37169 .vitem "&%-body_linecount%&&~<&'number'&>"
37170 This records the number of lines in the body of the message, and is always
37171 present.
37172
37173 .vitem "&%-body_zerocount%&&~<&'number'&>"
37174 This records the number of binary zero bytes in the body of the message, and is
37175 present if the number is greater than zero.
37176
37177 .vitem &%-deliver_firsttime%&
37178 This is written when a new message is first added to the spool. When the spool
37179 file is updated after a deferral, it is omitted.
37180
37181 .vitem "&%-frozen%&&~<&'time'&>"
37182 .cindex "frozen messages" "spool data"
37183 The message is frozen, and the freezing happened at <&'time'&>.
37184
37185 .vitem "&%-helo_name%&&~<&'text'&>"
37186 This records the host name as specified by a remote host in a HELO or EHLO
37187 command.
37188
37189 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37190 This records the IP address of the host from which the message was received and
37191 the remote port number that was used. It is omitted for locally generated
37192 messages.
37193
37194 .vitem "&%-host_auth%&&~<&'text'&>"
37195 If the message was received on an authenticated SMTP connection, this records
37196 the name of the authenticator &-- the value of the
37197 &$sender_host_authenticated$& variable.
37198
37199 .vitem &%-host_lookup_failed%&
37200 This is present if an attempt to look up the sending host's name from its IP
37201 address failed. It corresponds to the &$host_lookup_failed$& variable.
37202
37203 .vitem "&%-host_name%&&~<&'text'&>"
37204 .cindex "reverse DNS lookup"
37205 .cindex "DNS" "reverse lookup"
37206 This records the name of the remote host from which the message was received,
37207 if the host name was looked up from the IP address when the message was being
37208 received. It is not present if no reverse lookup was done.
37209
37210 .vitem "&%-ident%&&~<&'text'&>"
37211 For locally submitted messages, this records the login of the originating user,
37212 unless it was a trusted user and the &%-oMt%& option was used to specify an
37213 ident value. For messages received over TCP/IP, this records the ident string
37214 supplied by the remote host, if any.
37215
37216 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37217 This records the IP address of the local interface and the port number through
37218 which a message was received from a remote host. It is omitted for locally
37219 generated messages.
37220
37221 .vitem &%-local%&
37222 The message is from a local sender.
37223
37224 .vitem &%-localerror%&
37225 The message is a locally-generated bounce message.
37226
37227 .vitem "&%-local_scan%&&~<&'string'&>"
37228 This records the data string that was returned by the &[local_scan()]& function
37229 when the message was received &-- the value of the &$local_scan_data$&
37230 variable. It is omitted if no data was returned.
37231
37232 .vitem &%-manual_thaw%&
37233 The message was frozen but has been thawed manually, that is, by an explicit
37234 Exim command rather than via the auto-thaw process.
37235
37236 .vitem &%-N%&
37237 A testing delivery process was started using the &%-N%& option to suppress any
37238 actual deliveries, but delivery was deferred. At any further delivery attempts,
37239 &%-N%& is assumed.
37240
37241 .vitem &%-received_protocol%&
37242 This records the value of the &$received_protocol$& variable, which contains
37243 the name of the protocol by which the message was received.
37244
37245 .vitem &%-sender_set_untrusted%&
37246 The envelope sender of this message was set by an untrusted local caller (used
37247 to ensure that the caller is displayed in queue listings).
37248
37249 .vitem "&%-spam_score_int%&&~<&'number'&>"
37250 If a message was scanned by SpamAssassin, this is present. It records the value
37251 of &$spam_score_int$&.
37252
37253 .vitem &%-tls_certificate_verified%&
37254 A TLS certificate was received from the client that sent this message, and the
37255 certificate was verified by the server.
37256
37257 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37258 When the message was received over an encrypted connection, this records the
37259 name of the cipher suite that was used.
37260
37261 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37262 When the message was received over an encrypted connection, and a certificate
37263 was received from the client, this records the Distinguished Name from that
37264 certificate.
37265 .endlist
37266
37267 Following the options there is a list of those addresses to which the message
37268 is not to be delivered. This set of addresses is initialized from the command
37269 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37270 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37271 the address is added to this set. The addresses are kept internally as a
37272 balanced binary tree, and it is a representation of that tree which is written
37273 to the spool file. If an address is expanded via an alias or forward file, the
37274 original address is added to the tree when deliveries to all its child
37275 addresses are complete.
37276
37277 If the tree is empty, there is a single line in the spool file containing just
37278 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37279 Y or N, followed by an address. The address is the value for the node of the
37280 tree, and the letters indicate whether the node has a left branch and/or a
37281 right branch attached to it, respectively. If branches exist, they immediately
37282 follow. Here is an example of a three-node tree:
37283 .code
37284 YY darcy@austen.fict.example
37285 NN alice@wonderland.fict.example
37286 NN editor@thesaurus.ref.example
37287 .endd
37288 After the non-recipients tree, there is a list of the message's recipients.
37289 This is a simple list, preceded by a count. It includes all the original
37290 recipients of the message, including those to whom the message has already been
37291 delivered. In the simplest case, the list contains one address per line. For
37292 example:
37293 .code
37294 4
37295 editor@thesaurus.ref.example
37296 darcy@austen.fict.example
37297 rdo@foundation
37298 alice@wonderland.fict.example
37299 .endd
37300 However, when a child address has been added to the top-level addresses as a
37301 result of the use of the &%one_time%& option on a &(redirect)& router, each
37302 line is of the following form:
37303 .display
37304 <&'top-level address'&> <&'errors_to address'&> &&&
37305   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37306 .endd
37307 The 01 flag bit indicates the presence of the three other fields that follow
37308 the top-level address. Other bits may be used in future to support additional
37309 fields. The <&'parent number'&> is the offset in the recipients list of the
37310 original parent of the &"one time"& address. The first two fields are the
37311 envelope sender that is associated with this address and its length. If the
37312 length is zero, there is no special envelope sender (there are then two space
37313 characters in the line). A non-empty field can arise from a &(redirect)& router
37314 that has an &%errors_to%& setting.
37315
37316
37317 A blank line separates the envelope and status information from the headers
37318 which follow. A header may occupy several lines of the file, and to save effort
37319 when reading it in, each header is preceded by a number and an identifying
37320 character. The number is the number of characters in the header, including any
37321 embedded newlines and the terminating newline. The character is one of the
37322 following:
37323
37324 .table2 50pt
37325 .row <&'blank'&>         "header in which Exim has no special interest"
37326 .row &`B`&               "&'Bcc:'& header"
37327 .row &`C`&               "&'Cc:'& header"
37328 .row &`F`&               "&'From:'& header"
37329 .row &`I`&               "&'Message-id:'& header"
37330 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37331 .row &`R`&               "&'Reply-To:'& header"
37332 .row &`S`&               "&'Sender:'& header"
37333 .row &`T`&               "&'To:'& header"
37334 .row &`*`&               "replaced or deleted header"
37335 .endtable
37336
37337 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37338 purposes. They are not transmitted when the message is delivered. Here is a
37339 typical set of headers:
37340 .code
37341 111P Received: by hobbit.fict.example with local (Exim 4.00)
37342 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37343 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37344 038* X-rewrote-sender: bb@hobbit.fict.example
37345 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37346 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37347 099* To: alice@wonderland.fict.example, rdo@foundation,
37348 darcy@austen.fict.example, editor@thesaurus.ref.example
37349 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37350 darcy@austen.fict.example, editor@thesaurus.ref.example
37351 038  Date: Fri, 11 May 2001 10:28:59 +0100
37352 .endd
37353 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37354 &'To:'& header have been rewritten, the last one because routing expanded the
37355 unqualified domain &'foundation'&.
37356 .ecindex IIDforspo1
37357 .ecindex IIDforspo2
37358 .ecindex IIDforspo3
37359
37360 . ////////////////////////////////////////////////////////////////////////////
37361 . ////////////////////////////////////////////////////////////////////////////
37362
37363 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37364          "DKIM Support"
37365 .cindex "DKIM"
37366
37367 DKIM is a mechanism by which messages sent by some entity can be provably
37368 linked to a domain which that entity controls.  It permits reputation to
37369 be tracked on a per-domain basis, rather than merely upon source IP address.
37370 DKIM is documented in RFC 4871.
37371
37372 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37373 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37374
37375 Exim's DKIM implementation allows to
37376 .olist
37377 Sign outgoing messages: This function is implemented in the SMTP transport.
37378 It can co-exist with all other Exim features
37379 (including transport filters)
37380 except cutthrough delivery.
37381 .next
37382 Verify signatures in incoming messages: This is implemented by an additional
37383 ACL (acl_smtp_dkim), which can be called several times per message, with
37384 different signature contexts.
37385 .endlist
37386
37387 In typical Exim style, the verification implementation does not include any
37388 default "policy". Instead it enables you to build your own policy using
37389 Exim's standard controls.
37390
37391 Please note that verification of DKIM signatures in incoming mail is turned
37392 on by default for logging purposes. For each signature in incoming email,
37393 exim will log a line displaying the most important signature details, and the
37394 signature status. Here is an example (with line-breaks added for clarity):
37395 .code
37396 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37397     d=facebookmail.com s=q1-2009b
37398     c=relaxed/relaxed a=rsa-sha1
37399     i=@facebookmail.com t=1252484542 [verification succeeded]
37400 .endd
37401 You might want to turn off DKIM verification processing entirely for internal
37402 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37403 control modifier. This should typically be done in the RCPT ACL, at points
37404 where you accept mail from relay sources (internal hosts or authenticated
37405 senders).
37406
37407
37408 .section "Signing outgoing messages" "SECID513"
37409 .cindex "DKIM" "signing"
37410
37411 Signing is implemented by setting private options on the SMTP transport.
37412 These options take (expandable) strings as arguments.
37413
37414 .option dkim_domain smtp string&!! unset
37415 MANDATORY:
37416 The domain you want to sign with. The result of this expanded
37417 option is put into the &%$dkim_domain%& expansion variable.
37418
37419 .option dkim_selector smtp string&!! unset
37420 MANDATORY:
37421 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37422 variable to look up a matching selector. The result is put in the expansion
37423 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37424 option along with &%$dkim_domain%&.
37425
37426 .option dkim_private_key smtp string&!! unset
37427 MANDATORY:
37428 This sets the private key to use. You can use the &%$dkim_domain%& and
37429 &%$dkim_selector%& expansion variables to determine the private key to use.
37430 The result can either
37431 .ilist
37432 be a valid RSA private key in ASCII armor, including line breaks.
37433 .next
37434 start with a slash, in which case it is treated as a file that contains
37435 the private key.
37436 .next
37437 be "0", "false" or the empty string, in which case the message will not
37438 be signed. This case will not result in an error, even if &%dkim_strict%&
37439 is set.
37440 .endlist
37441
37442 .option dkim_canon smtp string&!! unset
37443 OPTIONAL:
37444 This option sets the canonicalization method used when signing a message.
37445 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37446 The option defaults to "relaxed" when unset. Note: the current implementation
37447 only supports using the same canonicalization method for both headers and body.
37448
37449 .option dkim_strict smtp string&!! unset
37450 OPTIONAL:
37451 This  option  defines  how  Exim  behaves  when  signing a message that
37452 should be signed fails for some reason.  When the expansion evaluates to
37453 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37454 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37455 variables here.
37456
37457 .option dkim_sign_headers smtp string&!! unset
37458 OPTIONAL:
37459 When set, this option must expand to (or be specified as) a colon-separated
37460 list of header names. Headers with these names will be included in the message
37461 signature. When unspecified, the header names recommended in RFC4871 will be
37462 used.
37463
37464
37465 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37466 .cindex "DKIM" "verification"
37467
37468 Verification of DKIM signatures in incoming email is implemented via the
37469 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37470 syntactically(!) correct signature in the incoming message.
37471 A missing ACL definition defaults to accept.
37472 If any ACL call does not acccept, the message is not accepted.
37473 If a cutthrough delivery was in progress for the message it is
37474 summarily dropped (having wasted the transmission effort).
37475
37476 To evaluate the signature in the ACL a large number of expansion variables
37477 containing the signature status and its details are set up during the
37478 runtime of the ACL.
37479
37480 Calling the ACL only for existing signatures is not sufficient to build
37481 more advanced policies. For that reason, the global option
37482 &%dkim_verify_signers%&, and a global expansion variable
37483 &%$dkim_signers%& exist.
37484
37485 The global option &%dkim_verify_signers%& can be set to a colon-separated
37486 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37487 called. It is expanded when the message has been received. At this point,
37488 the expansion variable &%$dkim_signers%& already contains a colon-separated
37489 list of signer domains and identities for the message. When
37490 &%dkim_verify_signers%& is not specified in the main configuration,
37491 it defaults as:
37492 .code
37493 dkim_verify_signers = $dkim_signers
37494 .endd
37495 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37496 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37497 call the ACL for known domains or identities. This would be achieved as follows:
37498 .code
37499 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37500 .endd
37501 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37502 and "ebay.com", plus all domains and identities that have signatures in the message.
37503 You can also be more creative in constructing your policy. For example:
37504 .code
37505 dkim_verify_signers = $sender_address_domain:$dkim_signers
37506 .endd
37507
37508 If a domain or identity is listed several times in the (expanded) value of
37509 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37510
37511
37512 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37513 available (from most to least important):
37514
37515
37516 .vlist
37517 .vitem &%$dkim_cur_signer%&
37518 The signer that is being evaluated in this ACL run. This can be a domain or
37519 an identity. This is one of the list items from the expanded main option
37520 &%dkim_verify_signers%& (see above).
37521 .vitem &%$dkim_verify_status%&
37522 A string describing the general status of the signature. One of
37523 .ilist
37524 &%none%&: There is no signature in the message for the current domain or
37525 identity (as reflected by &%$dkim_cur_signer%&).
37526 .next
37527 &%invalid%&: The signature could not be verified due to a processing error.
37528 More detail is available in &%$dkim_verify_reason%&.
37529 .next
37530 &%fail%&: Verification of the signature failed.  More detail is
37531 available in &%$dkim_verify_reason%&.
37532 .next
37533 &%pass%&: The signature passed verification. It is valid.
37534 .endlist
37535 .vitem &%$dkim_verify_reason%&
37536 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37537 "fail" or "invalid". One of
37538 .ilist
37539 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37540 key for the domain could not be retrieved. This may be a temporary problem.
37541 .next
37542 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37543 record for the domain is syntactically invalid.
37544 .next
37545 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37546 body hash does not match the one specified in the signature header. This
37547 means that the message body was modified in transit.
37548 .next
37549 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37550 could not be verified. This may mean that headers were modified,
37551 re-written or otherwise changed in a way which is incompatible with
37552 DKIM verification. It may of course also mean that the signature is forged.
37553 .endlist
37554 .vitem &%$dkim_domain%&
37555 The signing domain. IMPORTANT: This variable is only populated if there is
37556 an actual signature in the message for the current domain or identity (as
37557 reflected by &%$dkim_cur_signer%&).
37558 .vitem &%$dkim_identity%&
37559 The signing identity, if present. IMPORTANT: This variable is only populated
37560 if there is an actual signature in the message for the current domain or
37561 identity (as reflected by &%$dkim_cur_signer%&).
37562 .vitem &%$dkim_selector%&
37563 The key record selector string.
37564 .vitem &%$dkim_algo%&
37565 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37566 .vitem &%$dkim_canon_body%&
37567 The body canonicalization method. One of 'relaxed' or 'simple'.
37568 .vitem &%dkim_canon_headers%&
37569 The header canonicalization method. One of 'relaxed' or 'simple'.
37570 .vitem &%$dkim_copiedheaders%&
37571 A transcript of headers and their values which are included in the signature
37572 (copied from the 'z=' tag of the signature).
37573 .vitem &%$dkim_bodylength%&
37574 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37575 limit was set by the signer, "9999999999999" is returned. This makes sure
37576 that this variable always expands to an integer value.
37577 .vitem &%$dkim_created%&
37578 UNIX timestamp reflecting the date and time when the signature was created.
37579 When this was not specified by the signer, "0" is returned.
37580 .vitem &%$dkim_expires%&
37581 UNIX timestamp reflecting the date and time when the signer wants the
37582 signature to be treated as "expired". When this was not specified by the
37583 signer, "9999999999999" is returned. This makes it possible to do useful
37584 integer size comparisons against this value.
37585 .vitem &%$dkim_headernames%&
37586 A colon-separated list of names of headers included in the signature.
37587 .vitem &%$dkim_key_testing%&
37588 "1" if the key record has the "testing" flag set, "0" if not.
37589 .vitem &%$dkim_key_nosubdomains%&
37590 "1" if the key record forbids subdomaining, "0" otherwise.
37591 .vitem &%$dkim_key_srvtype%&
37592 Service type (tag s=) from the key record. Defaults to "*" if not specified
37593 in the key record.
37594 .vitem &%$dkim_key_granularity%&
37595 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37596 in the key record.
37597 .vitem &%$dkim_key_notes%&
37598 Notes from the key record (tag n=).
37599 .endlist
37600
37601 In addition, two ACL conditions are provided:
37602
37603 .vlist
37604 .vitem &%dkim_signers%&
37605 ACL condition that checks a colon-separated list of domains or identities
37606 for a match against the domain or identity that the ACL is currently verifying
37607 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37608 verb to a group of domains or identities. For example:
37609
37610 .code
37611 # Warn when Mail purportedly from GMail has no signature at all
37612 warn log_message = GMail sender without DKIM signature
37613      sender_domains = gmail.com
37614      dkim_signers = gmail.com
37615      dkim_status = none
37616 .endd
37617
37618 .vitem &%dkim_status%&
37619 ACL condition that checks a colon-separated list of possible DKIM verification
37620 results against the actual result of verification. This is typically used
37621 to restrict an ACL verb to a list of verification outcomes, for example:
37622
37623 .code
37624 deny message = Mail from Paypal with invalid/missing signature
37625      sender_domains = paypal.com:paypal.de
37626      dkim_signers = paypal.com:paypal.de
37627      dkim_status = none:invalid:fail
37628 .endd
37629
37630 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37631 see the documentation of the &%$dkim_verify_status%& expansion variable above
37632 for more information of what they mean.
37633 .endlist
37634
37635 . ////////////////////////////////////////////////////////////////////////////
37636 . ////////////////////////////////////////////////////////////////////////////
37637
37638 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37639          "Adding drivers or lookups"
37640 .cindex "adding drivers"
37641 .cindex "new drivers, adding"
37642 .cindex "drivers" "adding new"
37643 The following actions have to be taken in order to add a new router, transport,
37644 authenticator, or lookup type to Exim:
37645
37646 .olist
37647 Choose a name for the driver or lookup type that does not conflict with any
37648 existing name; I will use &"newdriver"& in what follows.
37649 .next
37650 Add to &_src/EDITME_& the line:
37651 .display
37652 <&'type'&>&`_NEWDRIVER=yes`&
37653 .endd
37654 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37655 code is not to be included in the binary by default, comment this line out. You
37656 should also add any relevant comments about the driver or lookup type.
37657 .next
37658 Add to &_src/config.h.defaults_& the line:
37659 .code
37660 #define <type>_NEWDRIVER
37661 .endd
37662 .next
37663 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37664 and create a table entry as is done for all the other drivers and lookup types.
37665 .next
37666 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37667 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37668 Add your &`NEWDRIVER`& to that list.
37669 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37670 simple form that most lookups have.
37671 .next
37672 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37673 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37674 driver or lookup type and add it to the definition of OBJ.
37675 .next
37676 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37677 &_src_&.
37678 .next
37679 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37680 as for other drivers and lookups.
37681 .endlist
37682
37683 Then all you need to do is write the code! A good way to start is to make a
37684 proforma by copying an existing module of the same type, globally changing all
37685 occurrences of the name, and cutting out most of the code. Note that any
37686 options you create must be listed in alphabetical order, because the tables are
37687 searched using a binary chop procedure.
37688
37689 There is a &_README_& file in each of the sub-directories of &_src_& describing
37690 the interface that is expected.
37691
37692
37693
37694
37695 . ////////////////////////////////////////////////////////////////////////////
37696 . ////////////////////////////////////////////////////////////////////////////
37697
37698 . /////////////////////////////////////////////////////////////////////////////
37699 . These lines are processing instructions for the Simple DocBook Processor that
37700 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37701 . PDFs than using xmlto and fop. They will be ignored by all other XML
37702 . processors.
37703 . /////////////////////////////////////////////////////////////////////////////
37704
37705 .literal xml
37706 <?sdop
37707   format="newpage"
37708   foot_right_recto="&chaptertitle;"
37709   foot_right_verso="&chaptertitle;"
37710 ?>
37711 .literal off
37712
37713 .makeindex "Options index"   "option"
37714 .makeindex "Variables index" "variable"
37715 .makeindex "Concept index"   "concept"
37716
37717
37718 . /////////////////////////////////////////////////////////////////////////////
37719 . /////////////////////////////////////////////////////////////////////////////